![]() |
T4EA
18.1 C7177 A20283
Teamcenter Gateway for Enterprise Applications API Reference
|
Namespaces | |
CUSTOM | |
Functions | |
addSystemInfo2List SystemId ?Mode? ?TargetType? ?TransAction? ?Connected? | |
addSystemInfo2List stores the EA connection info into the internal shared memory buffer More... | |
checkConnection2EA ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info's and tests the connection. More... | |
checkConnection2EA4Batchjob SessionId ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info's for a given Teamcenter Session Id and tests the connection. More... | |
checkConnection2EA4Session SessionId ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection. More... | |
checkConnection2EA4Transaction SessionId TransactionId ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection. More... | |
closeConnection2EA4Session SessionId ?System? args | |
This function removes the connect information for a given system. More... | |
connectEA ?User? ?Password? ?System? ?ConnectString? ?Language? args | |
connect to the EA system. If a custom connect function exists, call it, else assume connect is ok. More... | |
deleteConnectionInfo System ?Mode? ?TargetType? ?TransAction? | |
deleteConnectionInfo deletes the EA connection info from the internal shared memory buffer More... | |
formatSystemId EASystem args | |
returns given EA System in a defined string format (since we do not have a client with EA, it is only the system in hex format) More... | |
getCurrentEAInfo Key | |
get connection info of given type for the current connection More... | |
getListOfEAConnections2EA4Session SessionId args | |
getListOfEAConnections2EA4Session read all EA connection info for a given teamcenter session id from the internal shared memory buffer and return the list of the connections. More... | |
getPreferredConnection2EA4Session SessionId args | |
getPreferredConnection2EA4Session read the EA connection info for a given teamcenter session id from the internal shared memory buffer and return the active (preferred) connection information. More... | |
readConnectionInfo ?Mode? ?TargetType? ?TransAction? args | |
readConnectionInfo read the EA connection info from the internal shared memory buffer, so that it can be used for the next Orale transaction. More... | |
readConnectionInfo4Session SessionId ?Mode? ?TargetType? ?TransAction? args | |
readConnectionInfo4Session read 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. More... | |
selectActiveConnection2EA SessionId EASystem ?Dummy? args | |
defines given EA System as active More... | |
setConnectionInfo System ConnectString CryptUser CryptPasswd ?Mode? ?TargetType? ?TransAction? | |
setConnectionInfo stores the encrypted connection info into the internal shared memory buffer via the storeConnectionInfo function. More... | |
setConnectionInfoPlain System ConnectString User Passwd ?Mode? ?TargetType? ?TransAction? | |
setConnectionInfoPlain encrypts the user and password and stores the connection info into the internal shared memory buffer via the setEAPassword function More... | |
setConnectString System ConnectString | |
setConnectString stores the connection info into the internal shared memory buffer More... | |
setEAInfo SessionInfo | |
set product specific logon parameters More... | |
storeConnectionInfo System ConnectString User Passwd ?Mode? ?TargetType? ?TransAction? | |
storeConnectionInfo store the EA connection info into the internal shared memory buffer More... | |
storeConnectionInfo4Session SessionId System ConnectString User Passwd ?Language? | |
storeConnectionInfo4Session stores the EA connection info of the current Teamcenter session into the internal shared memory buffer More... | |
testEALogin args | |
testEALogin read the current stored EA login info for the testscript env and tests the connection More... | |
verifyConnection2EA4Session SessionId ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection. More... | |
verifyConnection2EA4Workflow SessionId TargetTypeName TclIntroStream | |
Read the current stored EA login info's for a given Teamcenter Session Id and tests the connection. More... | |
verifyConnection2EASytem4Session SessionId EASystem Dummy ?Mode? ?TargetType? ?TransAction? | |
Read the current stored EA login info's for a given Teamcenter Session Id, EA System and tests the connection. More... | |
T4EA::CONNECTION2EA::addSystemInfo2List | SystemId ?Mode? ?TargetType? ?TransAction? ?Connected? | ||
addSystemInfo2List stores the EA connection info into the internal shared memory buffer
SystemId | |
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. |
Connected | TRUE: this connection is connected. FALSE: not connected yet (no credentials) |
References tpco_shmget(), and tpco_shmset().
Referenced by setConnectString(), and storeConnectionInfo().
T4EA::CONNECTION2EA::checkConnection2EA | ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info's and tests the connection.
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. |
References connectEA(), T4EA::getLocalizationString(), T4X::CORE::getSessionLogChannel(), readConnectionInfo(), T4X::CORE::storeMessage2(), and tpwrite().
Referenced by testEALogin().
T4EA::CONNECTION2EA::checkConnection2EA4Batchjob | SessionId ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info's for a given Teamcenter Session Id and tests the connection.
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. |
References T4EA::CONNECTION2EA::CUSTOM::MAPPING::checkConnection2EA4Session(), and checkConnection2EA4Session().
T4EA::CONNECTION2EA::checkConnection2EA4Session | SessionId ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection.
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. |
References T4X::TC::MAPPING::getWorkflowArgumentValue3(), selectActiveConnection2EA(), and verifyConnection2EA4Session().
Referenced by checkConnection2EA4Batchjob(), T4EA::PROP::MAPPING::checkConnection2EA4Session(), T4EA::CONNECTION2EA::CUSTOM::MAPPING::checkConnection2EA4Session(), checkConnection2EA4Transaction(), and verifyConnection2EA4Workflow().
T4EA::CONNECTION2EA::checkConnection2EA4Transaction | SessionId TransactionId ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection.
TransactionId | unique logfile name to log messages in the trans log file |
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. |
References checkConnection2EA4Session(), and T4EA::CONNECTION2EA::CUSTOM::MAPPING::checkConnection2EA4Transaction().
T4EA::CONNECTION2EA::closeConnection2EA4Session | SessionId ?System? args | ||
This function removes the connect information for a given system.
SessionId | |
System | |
args |
References T4X::CORE::getSessionLogChannel(), and tpwrite().
T4EA::CONNECTION2EA::connectEA | ?User? ?Password? ?System? ?ConnectString? ?Language? args | ||
connect to the EA system. If a custom connect function exists, call it, else assume connect is ok.
User | User name |
Password | Password |
System | System Identifier |
ConnectString | technical connection endpoint (e.g. a URL for a web service, a database connect string, a file name, etc.) |
Language | language to use for session |
args | additional arguments (unused) |
References T4EA::CONNECTION2EA::CUSTOM::MAPPING::connectEA(), and tpco_decrypt().
Referenced by checkConnection2EA(), T4EA::checkEAPassword(), and verifyConnection2EA4Session().
T4EA::CONNECTION2EA::deleteConnectionInfo | System ?Mode? ?TargetType? ?TransAction? | ||
deleteConnectionInfo deletes the EA connection info from the internal shared memory buffer
System | |
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. |
References formatSystemId(), tpco_closeSrvSession(), tpco_connectTo(), and tpco_shmdelete().
T4EA::CONNECTION2EA::formatSystemId | EASystem args | ||
returns given EA System in a defined string format (since we do not have a client with EA, it is only the system in hex format)
Referenced by T4EA::checkEAPassword(), deleteConnectionInfo(), selectActiveConnection2EA(), setConnectString(), and storeConnectionInfo().
T4EA::CONNECTION2EA::getCurrentEAInfo | Key | ||
get connection info of given type for the current connection
Key | Possible values: EAConnectString EAUser EAPassword EASystem EALanguage. |
References tpco_decrypt().
Referenced by T4EA::CONNECTION2EA::CUSTOM::MAPPING::checkActiveEASystemForTargetTypeName(), T4EA::CUSTOM::SERVICES::DEMOERP::DemoERPService(), T4EA::JDBC::ORACLE::getConnectionHandle4ActiveSystem(), T4EA::JDBC::ORACLE::getConnectionHandle4System(), T4EA::PROP::CUSTOM::MAPPING::GetEAData_BillOfMaterial(), T4EA::QUERY::CUSTOM::MAPPING::importQueryRowViaBatch(), and T4EA::CUSTOM::SERVICES::ofBIZservice().
T4EA::CONNECTION2EA::getListOfEAConnections2EA4Session | SessionId args | ||
getListOfEAConnections2EA4Session read all EA connection info for a given teamcenter session id from the internal shared memory buffer and return the list of the connections.
In the case of an error NOT_STORED is returned.
SessionId | unique session ID for the users teamcenter session |
References T4X::CORE::getSessionLogChannel(), and tpwrite().
T4EA::CONNECTION2EA::getPreferredConnection2EA4Session | SessionId args | ||
getPreferredConnection2EA4Session read the EA connection info for a given teamcenter session id from the internal shared memory buffer and return the active (preferred) connection information.
If no active (preferred) connection for the Session Id is found, an additonal check for the wild card SessionId is done. In the case of an error NOT_STORED is returned.
SessionId | unique session ID for the users teamcenter session |
args | currently unused |
References T4X::CORE::getSessionLogChannel(), and tpwrite().
T4EA::CONNECTION2EA::readConnectionInfo | ?Mode? ?TargetType? ?TransAction? args | ||
readConnectionInfo read the EA connection info from the internal shared memory buffer, so that it can be used for the next Orale transaction.
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. |
References T4X::CORE::getSessionLogChannel(), tpco_closeSrvSession(), tpco_connectTo(), tpco_decrypt(), tpco_shmget(), and tpwrite().
Referenced by checkConnection2EA(), and readConnectionInfo4Session().
T4EA::CONNECTION2EA::readConnectionInfo4Session | SessionId ?Mode? ?TargetType? ?TransAction? args | ||
readConnectionInfo4Session read 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.
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. |
References T4X::CORE::getSessionLogChannel(), readConnectionInfo(), tpco_shmget(), and tpwrite().
Referenced by T4EA::checkEAPassword(), and verifyConnection2EA4Session().
T4EA::CONNECTION2EA::selectActiveConnection2EA | SessionId EASystem ?Dummy? args | ||
defines given EA System as active
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 |
Dummy | - not used yet |
args | unused |
References formatSystemId(), T4X::CORE::getSessionLogChannel(), tpco_shmset(), and tpwrite().
Referenced by checkConnection2EA4Session(), T4EA::checkEAPassword(), T4EA::PROP::MAPPING::getExternalDataView(), testEALogin(), and verifyConnection2EASytem4Session().
T4EA::CONNECTION2EA::setConnectionInfo | System ConnectString CryptUser CryptPasswd ?Mode? ?TargetType? ?TransAction? | ||
setConnectionInfo stores the encrypted connection info into the internal shared memory buffer via the storeConnectionInfo function.
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.) |
CryptUser | User name for authentication (encrypted) |
CryptPasswd | Password for the user for authentication (encrypted) |
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. |
References storeConnectionInfo().
Referenced by setConnectionInfoPlain().
T4EA::CONNECTION2EA::setConnectionInfoPlain | System ConnectString User Passwd ?Mode? ?TargetType? ?TransAction? | ||
setConnectionInfoPlain encrypts the user and password and stores the connection info into the internal shared memory buffer via the setEAPassword function
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.) |
User | User name for authentication in plain text |
Passwd | Password for the user for authentication in plain text |
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. |
References setConnectionInfo(), and tpco_encrypt().
T4EA::CONNECTION2EA::setConnectString | System ConnectString | ||
setConnectString stores the connection info into the internal shared memory buffer
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.) |
References addSystemInfo2List(), formatSystemId(), and tpco_shmset().
T4EA::CONNECTION2EA::setEAInfo | SessionInfo | ||
set product specific logon parameters
SessionInfo | list containing product specific logon values If the list is empty, all entries will be reset to empty string. |
T4EA::CONNECTION2EA::storeConnectionInfo | System ConnectString User Passwd ?Mode? ?TargetType? ?TransAction? | ||
storeConnectionInfo store the EA connection info into the internal shared memory buffer
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.) |
User | User name for authentication (encrypted) |
Passwd | Password for the user for authentication (encrypted) |
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. |
References addSystemInfo2List(), formatSystemId(), tpco_closeSrvSession(), tpco_connectTo(), tpco_encrypt(), and tpco_shmset().
Referenced by setConnectionInfo().
T4EA::CONNECTION2EA::storeConnectionInfo4Session | SessionId System ConnectString User Passwd ?Language? | ||
storeConnectionInfo4Session stores the EA connection info of the current Teamcenter session into the internal shared memory buffer
SessionId | |
System | |
ConnectString | technical connection endpoint (e.g. a URL for a web service, a database connect string, a file name, etc.) |
User | |
Passwd | |
Language | (optional) |
Referenced by T4EA::checkEAPassword().
T4EA::CONNECTION2EA::testEALogin | args | ||
testEALogin read the current stored EA login info for the testscript env and tests the connection
This is a test procedure and should only be used in scripts!
args | unused |
References checkConnection2EA(), and selectActiveConnection2EA().
T4EA::CONNECTION2EA::verifyConnection2EA4Session | SessionId ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info for a given Teamcenter Session Id and tests the connection.
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. |
References connectEA(), T4EA::getLocalizationString(), T4X::CORE::getSessionLogChannel(), readConnectionInfo4Session(), T4X::CORE::storeMessage2(), and tpwrite().
Referenced by checkConnection2EA4Session(), T4EA::QUERY::CUSTOM::MAPPING::executeQuery(), and verifyConnection2EASytem4Session().
T4EA::CONNECTION2EA::verifyConnection2EA4Workflow | SessionId TargetTypeName TclIntroStream | ||
Read the current stored EA login info's for a given Teamcenter Session Id and tests the connection.
SessionId | unique session ID for the users teamcenter session |
TargetTypeName | necessary to check if connection is applicable to TargetTypeName |
TclIntroStream |
References T4EA::CONNECTION2EA::CUSTOM::MAPPING::checkConnection2EA4Session(), checkConnection2EA4Session(), T4X::CORE::getSessionLogChannel(), T4X::CORE::initStatusInfo(), T4X::CORE::resetLastErrorMessage(), and tpwrite().
T4EA::CONNECTION2EA::verifyConnection2EASytem4Session | SessionId EASystem Dummy ?Mode? ?TargetType? ?TransAction? | ||
Read the current stored EA login info's for a given Teamcenter Session Id, EA System and tests the connection.
SessionId | unique session ID for the users teamcenter session |
EASystem | name of the EA system to verify |
Dummy | - not used yet |
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) |
References selectActiveConnection2EA(), and verifyConnection2EA4Session().