![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
checkConnection2EA ProductKey ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info's and tests the connection. More... | |
checkConnection2EA4Batchjob ProductKey SessionId ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info's for a given Teamcenter Session Id and tests the connection. More... | |
checkConnection2EA4Session ProductKey SessionId ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection. More... | |
checkConnection2EA4Transaction ProductKey SessionId TransactionId ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection. More... | |
deleteConnectionInfo ProdKey System ?SysArgs? ?Mode? ?TargetType? ?TransAction? | |
deleteConnectionInfo deletes the EA connection info from the internal shared memory buffer More... | |
getPreferredConnection2EA4Session ProductKey SessionId args | |
Return the currently active EA system. More... | |
readConnectionInfo4Session ProductKey SessionId ?Mode? ?TargetType? ?TransAction? args | |
Read the currently stored EA connection info for a given Teamcenter Session Id. More... | |
selectActiveConnection2EA ProductKey SessionId EASystem ?SysArgs? args | |
defines given EA System as active More... | |
setConnectString ProductKey System ConnectString | |
setConnectString stores the connection info into the internal shared memory buffer More... | |
setCredentialsAlias4UseCase ProductKey System CredentialsAlias ?Mode? ?TargetType? ?TransAction? | |
setCredentialsAlias4UseCase stores the CredentialsAlias that allows access to the actual connection info stored in the secure storage into an internal shared memory. More... | |
testEALogin ProductKey args | |
testEALogin reads the currently stored EA login info for the testscript env and tests the connection More... | |
verifyConnection2EASystem4Session ProductKey SessionId EASystem ?SysArgs? ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info's for a given Teamcenter Session Id, EA System and tests the connection. More... | |
T4X::CONNECTION2EA::checkConnection2EA | ProductKey ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info's and tests the connection.
ProductKey | product key (T4S, T4O, T4EA,...) |
Mode | Transfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all. |
TargetType | EA target object type like Item, BOM, ... default = "*" for all. |
TransAction | transfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. |
T4X::CONNECTION2EA::checkConnection2EA4Batchjob | ProductKey SessionId ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info's for a given Teamcenter Session Id and tests the connection.
ProductKey | product key (T4S, T4O, T4EA,...) |
SessionId | unique session ID for the users Teamcenter session |
Mode | Transfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all. |
TargetType | EA target object type like ITEM, BOM, ... default = "*" for all. |
TransAction | transfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. |
T4X::CONNECTION2EA::checkConnection2EA4Session | ProductKey SessionId ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection.
ProductKey | product key (T4S, T4O, T4EA,...) |
SessionId | unique session ID for the users Teamcenter session |
Mode | Transfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all. |
TargetType | EA target object type like Item, BOM, ... default = "*" for all. |
TransAction | transfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. |
T4X::CONNECTION2EA::checkConnection2EA4Transaction | ProductKey SessionId TransactionId ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection.
ProductKey | product key (T4S, T4O, T4EA,...) |
SessionId | unique session ID for the users Teamcenter session |
TransactionId | unique logfile name to log messages in the trans log file |
Mode | Transfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all. |
TargetType | EA target object type like ITEM, BOM, ... default = "*" for all. |
TransAction | transfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. |
T4X::CONNECTION2EA::deleteConnectionInfo | ProdKey System ?SysArgs? ?Mode? ?TargetType? ?TransAction? | ||
deleteConnectionInfo deletes the EA connection info from the internal shared memory buffer
ProdKey | product key (T4S, T4O, T4EA,...) |
System | |
SysArgs | additional system info |
Mode | Transfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all. |
TargetType | EA target object type like Product, ... default = "*" for all. |
TransAction | transfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. |
T4X::CONNECTION2EA::getPreferredConnection2EA4Session | ProductKey SessionId args | ||
Return the currently active EA system.
getPreferredConnection2EA4Session reads the EA connection info for a given Teamcenter session id from the internal shared memory buffer and returns the active (preferred) connection information. If no active (preferred) connection for the Session Id is found, an additional check for the wild card SessionId is done. In the case of an error NOT_STORED is returned.
ProductKey | product key (T4S, T4O, T4EA,...) |
SessionId | unique session ID for the users Teamcenter session |
args | unused |
T4X::CONNECTION2EA::readConnectionInfo4Session | ProductKey SessionId ?Mode? ?TargetType? ?TransAction? args | ||
Read the currently stored EA connection info for a given Teamcenter Session Id.
readConnectionInfo4Session reads the EA connection info for a given Teamcenter session id from the internal shared memory buffer, so that it can be used for the next EA transaction.
ProductKey | product key (T4S, T4O, T4EA,...) |
SessionId | unique session ID for the users teamcenter session |
Mode | Transfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all. |
TargetType | EA target object type like Item, BOM, ... default = "*" for all. |
TransAction | transfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. |
args | unused |
T4X::CONNECTION2EA::selectActiveConnection2EA | ProductKey SessionId EASystem ?SysArgs? args | ||
defines given EA System as active
ProductKey | product key (T4S, T4O, T4EA,...) |
SessionId | unique session ID for the users Teamcenter session or if you specific "*" the default connection for all sessions. |
EASystem | name of the EA system to verify |
SysArgs | |
args | unused |
T4X::CONNECTION2EA::setConnectString | ProductKey System ConnectString | ||
setConnectString stores the connection info into the internal shared memory buffer
ProductKey | product key (T4S, T4O, T4EA,...) |
System | Identifier (name for an EA system) |
ConnectString | technical connection endpoint (e.g. a URL for a web service, a database connect string, a file name, etc.) |
T4X::CONNECTION2EA::setCredentialsAlias4UseCase | ProductKey System CredentialsAlias ?Mode? ?TargetType? ?TransAction? | ||
setCredentialsAlias4UseCase stores the CredentialsAlias that allows access to the actual connection info stored in the secure storage into an internal shared memory.
ProductKey | product key (T4S, T4O, T4EA,...) |
System | Identifier (name for an EA system). Note that for SAP connections the system identifier is supposed to be <system name>@<client>. |
CredentialsAlias | symbolic name of the stored parameters for this connection in the secure storage |
Mode | Transfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, DATAVIEW, ... default = "*" for all except SCRIPTING. Use Mode "ALL" to store the ID for both "*" and SCRIPTING. Remark: The usage of the Mode value "ALL" is deprecated because it is mixing the transfer use case specific definition with the test-script based use cases. Best practice is to use the use case specific configuration approach. |
TargetType | EA target object type like Item, BOM, ... default = "*" for all. |
TransAction | transfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. |
T4X::CONNECTION2EA::testEALogin | ProductKey args | ||
testEALogin reads the currently stored EA login info for the testscript env and tests the connection
This is a test procedure and should only be used in scripts!
ProductKey | product key (T4S, T4O, T4EA,...) |
args | unused |
T4X::CONNECTION2EA::verifyConnection2EASystem4Session | ProductKey SessionId EASystem ?SysArgs? ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info's for a given Teamcenter Session Id, EA System and tests the connection.
ProductKey | product key (T4S, T4O, T4EA,...) |
SessionId | unique session ID for the users Teamcenter session |
EASystem | name of the EA system to verify |
SysArgs | - additional login info, e. g. SAP client |
Mode | Transfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all. |
TargetType | EA target object type like Item, BOM, ... default = "*" for all. |
TransAction | transfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. (currently ignored by T4EA) |