T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
CONFIGURATION::MANAGER::CommunicationChannels Namespace 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...
 

Detailed Description

Commands to edit the communication channels configuration.

Function Documentation

◆ addCommunicationChannel()

CONFIGURATION::MANAGER::CommunicationChannels::addCommunicationChannel   CommunicationChannelConfiguration  

Adds a new communication channel configuration to the list of communication channels.

Parameters
CommunicationChannelConfigurationlist containing all required settings (key value pairs) for the communication channel configuration
Returns
nothing
1 set myCommunicationChannel [dict create IDSTR myCommunicationChannel
2  # HOST myHost \
3  # PORT 11330 \
4  # IPSTACK IP4 \
5  # TRANSPORT SOCKET \
6  # SERVERCERT "" \
7  # CLIENTCERT "" \
8  # PROXY "" \
9  # SHAREDSECRET "" \
10  # ]

References checkCommunicationChannelConfiguration(), getCommunicationChannelList(), isInstalled(), and setCommunicationChannelList().

◆ checkCommunicationChannelConfiguration()

CONFIGURATION::MANAGER::CommunicationChannels::checkCommunicationChannelConfiguration   CommunicationChannelConfiguration  

Checks if a communication channel configuration defines all required settings.

Parameters
CommunicationChannelConfigurationlist containing all required settings (key value pairs) for the communication channel configuration
Returns
raises an error if a key value pair is missing, otherwise nothing
1 set myIncompleteChannel [dict create IDSTR incompleteChannel PORT 11340]
3  puts "An error was raised: $::errorInfo"
4 }

Referenced by addCommunicationChannel(), setCommunicationChannelList(), and updateCommunicationChannel().

◆ getCommunicationChannel()

CONFIGURATION::MANAGER::CommunicationChannels::getCommunicationChannel   CommunicationChannelId  

Returns the settings of a communication channel.

Parameters
CommunicationChannelIdID of the communication channel to be received
Returns
list of settings for the given communication channel
2  puts "$key is set to $value"
3 }

References getCommunicationChannelList().

Referenced by setHost(), setPortNumber(), and updateCommunicationChannel().

◆ getCommunicationChannelList()

CONFIGURATION::MANAGER::CommunicationChannels::getCommunicationChannelList

Returns a list of all configured communication channels including their attributes.

Parameters
none
Returns
list of communication channels
2  puts "communincation channel ID and port: [dict get $communicationChannel IDSTR] [dict get $communicationChannel PORT]"
3 }

References CONFIGURATION::MANAGER::Util::getConfigKey().

Referenced by addCommunicationChannel(), getCommunicationChannel(), isInstalled(), removeCommunicationChannel(), and updateCommunicationChannel().

◆ isInstalled()

CONFIGURATION::MANAGER::CommunicationChannels::isInstalled   CommunicationChannelId  

Checks if a certain communication channel id and hence communication channel configuration is already existing.

Parameters
CommunicationChannelIdID of the communication channel to be checked
Returns
true if it is already existing, false otherwise
2  puts "DEFAULT_WEB communication channel configuration is missing!"
3 }

References getCommunicationChannelList().

Referenced by addCommunicationChannel(), removeCommunicationChannel(), and updateCommunicationChannel().

◆ removeCommunicationChannel()

CONFIGURATION::MANAGER::CommunicationChannels::removeCommunicationChannel   CommunicationChannelId  

Removes an existing communication channel configuration.

Parameters
CommunicationChannelIdID of the communication channel to be removed
Returns
nothing

References getCommunicationChannelList(), isInstalled(), and setCommunicationChannelList().

◆ setCommunicationChannelList()

CONFIGURATION::MANAGER::CommunicationChannels::setCommunicationChannelList   ListOfCommunicationChannelConfigurations  

Sets a the list of communication channels. Any existing list will be overwritten.

Parameters
ListOfCommunicationChannelConfigurationslist containing all required settings (key value pairs) for the communication channel configuration
Returns
nothing
2 set myChannel [dict create IDSTR myChannel
3  # HOST myHost \
4  # PORT 11330 \
5  # IPSTACK IP4 \
6  # TRANSPORT SOCKET \
7  # SERVERCERT "" \
8  # CLIENTCERT "" \
9  # PROXY "" \
10  # SHAREDSECRET "" \
11  # ]
12 set extendedChannels [lappend existingChannels $myChannel]

References checkCommunicationChannelConfiguration(), and CONFIGURATION::MANAGER::Util::setConfigKey().

Referenced by addCommunicationChannel(), removeCommunicationChannel(), and updateCommunicationChannel().

◆ setHost()

CONFIGURATION::MANAGER::CommunicationChannels::setHost   CommunicationChannelId Host  

Sets the host of a certain communication channel.

Parameters
CommunicationChannelIdID of the communication channel to be edited
Hostnew host for this communication channel
Returns
nothing
1 ::CONFIGURATION::MANAGER::CommunicationChannels::setHost myCommunicationChannel 111.222.333.444

References getCommunicationChannel(), and updateCommunicationChannel().

◆ setPortNumber()

CONFIGURATION::MANAGER::CommunicationChannels::setPortNumber   CommunicationChannelId PortNumber  

Sets the port number of a certain communication channel.

Parameters
CommunicationChannelIdID of the communication channel to be edited
PortNumbernew port number for this communication channel
Returns
nothing

References getCommunicationChannel(), and updateCommunicationChannel().

◆ updateCommunicationChannel()

CONFIGURATION::MANAGER::CommunicationChannels::updateCommunicationChannel   CommunicationChannelConfiguration  

Replaces or updates an existing communication channel configuration.

Parameters
CommunicationChannelConfigurationlist containing all required settings (key value pairs) for the communication channel configuration
Returns
nothing
1 set myUpdatedChannel [dict create IDSTR myCommunicationChannel
2  # HOST myHost \
3  # PORT 11330 \
4  # IPSTACK IP4 \
5  # TRANSPORT SOCKET \
6  # SERVERCERT "C:/my/path/to/cert.pem" \
7  # CLIENTCERT "" \
8  # PROXY "" \
9  # SHAREDSECRET "" \
10  # ]

References checkCommunicationChannelConfiguration(), getCommunicationChannel(), getCommunicationChannelList(), isInstalled(), and setCommunicationChannelList().

Referenced by setHost(), and setPortNumber().