T4EA  18.2 C7549 A21431
Teamcenter Gateway for Enterprise Applications API Reference
T4EA::CONNECTION2EA Namespace Reference

Namespaces

 CUSTOM
 

Functions

 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...
 
 deleteConnectionInfo System ?Mode? ?TargetType? ?TransAction?
 deleteConnectionInfo deletes the EA connection info from the internal shared memory buffer More...
 
 getCurrentEAInfo Key
 get connection info of given type for the current connection 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...
 
 testEALogin args
 testEALogin read the current stored EA login info for the testscript env 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...
 

Function Documentation

◆ checkConnection2EA()

T4EA::CONNECTION2EA::checkConnection2EA   ?Mode? ?TargetType? ?TransAction?  

Read the current stored EA login info's and tests the connection.

Deprecated:
Please use T4X::CONNECTION2EA::checkConnection2EA.
Parameters
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeEA target object type like Item, BOM, ... default = "*" for all.
TransActiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
Returns
LOGON_OK | LOGON_ERROR | MISSING_LOGIN_DATA

References T4X::CONNECTION2EA::checkConnection2EA().

◆ checkConnection2EA4Batchjob()

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.

Parameters
SessionIdunique session ID for the users teamcenter session
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeEA target object type like ITEM, BOM, ... default = "*" for all.
TransActiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
Returns
LOGON_OK | LOGON_ERROR | MISSING_LOGIN_DATA | ERROR_NO_ACTIVE_CONNECTION

References T4X::CONNECTION2EA::checkConnection2EA4Batchjob().

◆ 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.

Deprecated:
Please use T4X::CONNECTION2EA::checkConnection2EA4Session.
Parameters
SessionIdunique session ID for the users teamcenter session
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeEA target object type like Item, BOM, ... default = "*" for all.
TransActiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
Returns
LOGON_OK | LOGON_ERROR | MISSING_LOGIN_DATA

References T4X::CONNECTION2EA::checkConnection2EA4Session().

◆ checkConnection2EA4Transaction()

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.

Deprecated:
Please use T4X::CONNECTION2EA::checkConnection2EA4Transaction.
Parameters
TransactionIdunique logfile name to log messages in the trans log file
SessionIdunique session ID for the users teamcenter session
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeEA target object type like ITEM, BOM, ... default = "*" for all.
TransActiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
Returns
LOGON_OK | LOGON_ERROR | MISSING_LOGIN_DATA

References T4X::CONNECTION2EA::checkConnection2EA4Transaction().

◆ deleteConnectionInfo()

T4EA::CONNECTION2EA::deleteConnectionInfo   System ?Mode? ?TargetType? ?TransAction?  

deleteConnectionInfo deletes the EA connection info from the internal shared memory buffer

Deprecated:
Please use T4X::CONNECTION2EA::deleteConnectionInfo.
Parameters
System
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeEA target object type like Product, ... default = "*" for all.
TransActiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
Returns
None

References T4X::CONNECTION2EA::deleteConnectionInfo().

◆ getCurrentEAInfo()

T4EA::CONNECTION2EA::getCurrentEAInfo   Key  

get connection info of given type for the current connection

Parameters
KeyPossible values: EAConnectString EAUser EAPassword EASystem EALanguage.
Returns
decrypted value of the given key or empty if no connection is active.

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().

◆ selectActiveConnection2EA()

T4EA::CONNECTION2EA::selectActiveConnection2EA   SessionId EASystem ?Dummy? args  

defines given EA System as active

Deprecated:
Please use T4X::CONNECTION2EA::selectActiveConnection2EA.
Parameters
SessionIdUnique session ID for the users teamcenter session or if you specific "*" the default connection for all sessions.
EASystemname of the EA system to verify
Dummy- not used yet
argsunused
Returns
None

References T4X::CONNECTION2EA::selectActiveConnection2EA().

◆ setConnectionInfo()

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.

Parameters
SystemIdentifier (name for an EA system)
ConnectStringtechnical connection endpoint (e.g. a URL for a web service, a database connect string, a file name, etc.)
CryptUserUser name for authentication (encrypted)
CryptPasswdPassword for the user for authentication (encrypted)
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeEA target object type like Item, BOM, ... default = "*" for all.
TransActiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
Returns
None

References T4X::CONNECTION2EA::setConnectionInfo().

◆ 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

Parameters
SystemIdentifier (name for an EA system)
ConnectStringtechnical connection endpoint (e.g. a URL for a web service, a database connect string, a file name, etc.)
UserUser name for authentication in plain text
PasswdPassword for the user for authentication in plain text
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeEA target object type like Item, BOM, ... default = "*" for all.
TransActiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
Returns
None

References T4X::CONNECTION2EA::setConnectionInfo().

◆ setConnectString()

T4EA::CONNECTION2EA::setConnectString   System ConnectString  

setConnectString stores the connection info into the internal shared memory buffer

Deprecated:
Please use T4X::CONNECTION2EA::setConnectString.
Parameters
SystemIdentifier (name for an EA system)
ConnectStringtechnical connection endpoint (e.g. a URL for a web service, a database connect string, a file name, etc.)
Returns
None

References T4X::CONNECTION2EA::setConnectString().

◆ testEALogin()

T4EA::CONNECTION2EA::testEALogin   args  

testEALogin read the current stored EA login info for the testscript env and tests the connection

Deprecated:
Please use T4X::CONNECTION2EA::testEALogin.

This is a test procedure and should only be used in scripts!

Parameters
argsunused
Returns
OK|ERROR

References T4X::CONNECTION2EA::testEALogin().

◆ verifyConnection2EASytem4Session()

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.

Deprecated:
Please use T4X::CONNECTION2EA::verifyConnection2EASystem4Session.
Parameters
SessionIdunique session ID for the users teamcenter session
EASystemname of the EA system to verify
Dummy- not used yet
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeEA target object type like Item, BOM, ... default = "*" for all.
TransActiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all. (currently ignored by T4EA)
Returns
LOGON_OK | LOGON_OK_PARTIAL | LOGON_ERROR | MISSING_LOGIN_DATA

References T4X::CONNECTION2EA::verifyConnection2EASystem4Session().