![]() |
T4S4
18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
|
Commands to edit the communication channels configuration. More...
Functions | |
addCommunicationChannel CommunicationChannelConfiguration | |
Adds a new communication channel configuration to the list of communication channels. More... | |
checkCommunicationChannelConfiguration CommunicationChannelConfiguration | |
Checks if a communication channel configuration defines all required settings. More... | |
getCommunicationChannel CommunicationChannelId | |
Returns the settings of a communication channel. More... | |
getCommunicationChannelList | |
Returns a list of all configured communication channels including their attributes. More... | |
isInstalled CommunicationChannelId | |
Checks if a certain communication channel id and hence communication channel configuration is already existing. More... | |
removeCommunicationChannel CommunicationChannelId | |
Removes an existing communication channel configuration. More... | |
setCommunicationChannelList ListOfCommunicationChannelConfigurations | |
Sets a the list of communication channels. Any existing list will be overwritten. More... | |
setHost CommunicationChannelId Host | |
Sets the host of a certain communication channel. More... | |
setPortNumber CommunicationChannelId PortNumber | |
Sets the port number of a certain communication channel. More... | |
updateCommunicationChannel CommunicationChannelConfiguration | |
Replaces or updates an existing communication channel configuration. More... | |
Commands to edit the communication channels configuration.
CONFIGURATION::MANAGER::CommunicationChannels::addCommunicationChannel | CommunicationChannelConfiguration | ||
Adds a new communication channel configuration to the list of communication channels.
CommunicationChannelConfiguration | list containing all required settings (key value pairs) for the communication channel configuration |
References checkCommunicationChannelConfiguration(), getCommunicationChannelList(), isInstalled(), and setCommunicationChannelList().
CONFIGURATION::MANAGER::CommunicationChannels::checkCommunicationChannelConfiguration | CommunicationChannelConfiguration | ||
Checks if a communication channel configuration defines all required settings.
CommunicationChannelConfiguration | list containing all required settings (key value pairs) for the communication channel configuration |
Referenced by addCommunicationChannel(), setCommunicationChannelList(), and updateCommunicationChannel().
CONFIGURATION::MANAGER::CommunicationChannels::getCommunicationChannel | CommunicationChannelId | ||
Returns the settings of a communication channel.
CommunicationChannelId | ID of the communication channel to be received |
References getCommunicationChannelList().
Referenced by setHost(), setPortNumber(), and updateCommunicationChannel().
CONFIGURATION::MANAGER::CommunicationChannels::getCommunicationChannelList |
Returns a list of all configured communication channels including their attributes.
none |
References CONFIGURATION::MANAGER::Util::getConfigKey().
Referenced by addCommunicationChannel(), getCommunicationChannel(), isInstalled(), removeCommunicationChannel(), and updateCommunicationChannel().
CONFIGURATION::MANAGER::CommunicationChannels::isInstalled | CommunicationChannelId | ||
Checks if a certain communication channel id and hence communication channel configuration is already existing.
CommunicationChannelId | ID of the communication channel to be checked |
References getCommunicationChannelList().
Referenced by addCommunicationChannel(), removeCommunicationChannel(), and updateCommunicationChannel().
CONFIGURATION::MANAGER::CommunicationChannels::removeCommunicationChannel | CommunicationChannelId | ||
Removes an existing communication channel configuration.
CommunicationChannelId | ID of the communication channel to be removed |
References getCommunicationChannelList(), isInstalled(), and setCommunicationChannelList().
CONFIGURATION::MANAGER::CommunicationChannels::setCommunicationChannelList | ListOfCommunicationChannelConfigurations | ||
Sets a the list of communication channels. Any existing list will be overwritten.
ListOfCommunicationChannelConfigurations | list containing all required settings (key value pairs) for the communication channel configuration |
References checkCommunicationChannelConfiguration(), and CONFIGURATION::MANAGER::Util::setConfigKey().
Referenced by addCommunicationChannel(), removeCommunicationChannel(), and updateCommunicationChannel().
CONFIGURATION::MANAGER::CommunicationChannels::setHost | CommunicationChannelId Host | ||
Sets the host of a certain communication channel.
CommunicationChannelId | ID of the communication channel to be edited |
Host | new host for this communication channel |
References getCommunicationChannel(), and updateCommunicationChannel().
CONFIGURATION::MANAGER::CommunicationChannels::setPortNumber | CommunicationChannelId PortNumber | ||
Sets the port number of a certain communication channel.
CommunicationChannelId | ID of the communication channel to be edited |
PortNumber | new port number for this communication channel |
References getCommunicationChannel(), and updateCommunicationChannel().
CONFIGURATION::MANAGER::CommunicationChannels::updateCommunicationChannel | CommunicationChannelConfiguration | ||
Replaces or updates an existing communication channel configuration.
CommunicationChannelConfiguration | list containing all required settings (key value pairs) for the communication channel configuration |
References checkCommunicationChannelConfiguration(), getCommunicationChannel(), getCommunicationChannelList(), isInstalled(), and setCommunicationChannelList().
Referenced by setHost(), and setPortNumber().