T4EA  18.1 C7177 A20283
Teamcenter Gateway for Enterprise Applications API Reference
T4EA::CONNECTION2EA::CUSTOM::MAPPING Namespace Reference

Functions

 checkActiveEASystemForTargetTypeName TargetTypeName
 Customer specific procedure to connect to the EA system. This procedure may either check the connection, login with the given credentials or just return LOGON_OK. More...
 
 checkConnection2EA4Session SessionId ?Mode? ?TargetTypeName? ?Action? args
 Customer specific userexit to overwrite the current stored EA login info's for a given Teamcenter Session and tests the connection. This function is used by the T4EA-validate-EALogon handler. More...
 
 checkConnection2EA4Transaction SessionId TransactionId ?Mode? ?TargetTypeName? ?Action? args
 Customer specific userexit to overwrite the current stored EA login info's for a given Teamcenter Session Id and tests the connection. More...
 
 connectEA ?User? ?Password? ?System? ?ConnectString? ?Language? args
 Customer specific procedure to connect to the EA system. This procedure may either check the connection, login with the given credentials or just return LOGON_OK. More...
 
 getTargetTypeNames4Connection EASystemId
 returns the valid TargetTypeNames for a connection identifier. More...
 
 isIgnoredTargetTypeName TargetTypeName
 Customer specific procedure to identify connections that do not require an active connection. More...
 
 JMSDummyConnect User Password System ConnectString Language args
 a dummy procedure fulfilling the need to have a ConnectProcedure More...
 

Variables

 EASystemMap
 Maps an EA connection identifier (may contain the wildcard "*") to the connection information. More...
 
 IgnoredTargetTypeNames
 TargetTypeNames for EA connections with hard coded connection parameters and credentials (e.g. file import/export) More...
 

Function Documentation

◆ checkActiveEASystemForTargetTypeName()

T4EA::CONNECTION2EA::CUSTOM::MAPPING::checkActiveEASystemForTargetTypeName   TargetTypeName  

Customer specific procedure to connect to the EA system. This procedure may either check the connection, login with the given credentials or just return LOGON_OK.

Parameters
TargetTypeNamename to check if it is allowed on the active connection
Returns
OK (TargetTypeName is allowed for the active connection) or ERROR and explanatory message or ERROR_NO_ACTIVE_CONNECTION if no preferred connection can be found

References T4EA::CONNECTION2EA::getCurrentEAInfo(), T4X::CORE::getSessionLogChannel(), isIgnoredTargetTypeName(), and tpwrite().

Referenced by checkConnection2EA4Session().

◆ checkConnection2EA4Session()

T4EA::CONNECTION2EA::CUSTOM::MAPPING::checkConnection2EA4Session   SessionId ?Mode? ?TargetTypeName? ?Action? args  

Customer specific userexit to overwrite the current stored EA login info's for a given Teamcenter Session and tests the connection. This function is used by the T4EA-validate-EALogon handler.

Parameters
SessionIdunique session ID for the users teamcenter session
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeNameEA target object type like MM, ECM, ... default = "*" for all.
Actiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
argsadditional arguments, currently unused
Returns

References checkActiveEASystemForTargetTypeName(), T4EA::CONNECTION2EA::checkConnection2EA4Session(), T4X::CORE::getSessionLogChannel(), isIgnoredTargetTypeName(), and tpwrite().

Referenced by T4EA::CONNECTION2EA::checkConnection2EA4Batchjob(), T4EA::PROP::MAPPING::checkConnection2EA4Session(), checkConnection2EA4Transaction(), and T4EA::CONNECTION2EA::verifyConnection2EA4Workflow().

◆ checkConnection2EA4Transaction()

T4EA::CONNECTION2EA::CUSTOM::MAPPING::checkConnection2EA4Transaction   SessionId TransactionId ?Mode? ?TargetTypeName? ?Action? args  

Customer specific userexit to overwrite 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
TransactionIdunique logfile name to log messages in the trans log file
ModeTransfer mode like WORKFLOW, PORTAL, BATCH, RTP, LOV, ... default = "*" for all.
TargetTypeNameEA target object type like MM, ECM, ... default = "*" for all.
Actiontransfer action in the GUI like CREATE, CHANGE, ... default = "*" for all.
argsadditional arguments, currently unused
Returns

References checkConnection2EA4Session(), T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by T4EA::GENOBJ::CUSTOM::MAPPING::checkConnection2EA4Transaction(), and T4EA::CONNECTION2EA::checkConnection2EA4Transaction().

◆ connectEA()

T4EA::CONNECTION2EA::CUSTOM::MAPPING::connectEA   ?User? ?Password? ?System? ?ConnectString? ?Language? args  

Customer specific procedure to connect to the EA system. This procedure may either check the connection, login with the given credentials or just return LOGON_OK.

Parameters
UserUser name
Passwordclear text password
SystemSystem Identifier
ConnectStringtechnical connection endpoint (e.g. a URL for a web service, a database connect string, a file name, etc.)
Languagelanguage to use for session
argsadditional arguments (unused)
Returns
LOGON_OK|LOGON_ERROR|MISSING_LOGIN_DATA

References T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by T4EA::CONNECTION2EA::connectEA().

◆ getTargetTypeNames4Connection()

T4EA::CONNECTION2EA::CUSTOM::MAPPING::getTargetTypeNames4Connection   EASystemId  

returns the valid TargetTypeNames for a connection identifier.

Parameters
EASystemIda connection identifier
Returns
list of valid TargetTypeNames

References T4X::CORE::getSessionLogChannel(), and tpwrite().

◆ isIgnoredTargetTypeName()

T4EA::CONNECTION2EA::CUSTOM::MAPPING::isIgnoredTargetTypeName   TargetTypeName  

Customer specific procedure to identify connections that do not require an active connection.

Parameters
TargetTypeNamename to check
Returns
TRUE (TargetTypeName should be ignored for connection checks) or FALSE (TargetTypeName should be checked by connection handling)

Referenced by checkActiveEASystemForTargetTypeName(), and checkConnection2EA4Session().

◆ JMSDummyConnect()

T4EA::CONNECTION2EA::CUSTOM::MAPPING::JMSDummyConnect   User Password System ConnectString Language args  

a dummy procedure fulfilling the need to have a ConnectProcedure

Returns
LOGON_OK

Variable Documentation

◆ EASystemMap

EASystemMap
static

Maps an EA connection identifier (may contain the wildcard "*") to the connection information.

Keys in the sub-dictionaries can be:

  • TargetTypeNameList a list of valid TaretTypeNames for this connection(s)
  • ConnectProcedure a TCL procedure implementing the login at the remote EA system

This dictionary is only important for automatic EA connection handling.

◆ IgnoredTargetTypeNames

IgnoredTargetTypeNames
static

TargetTypeNames for EA connections with hard coded connection parameters and credentials (e.g. file import/export)