T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
ITK::MULTI::CONNECT Namespace Reference

Functions

 setConnectParameters4Batch ?User? ?Password? ?Group? ?BatchClient? ?AttrName? ?AttrVal? ?EncryptFlag?
 Defines the (technical) users credential information for a given job agent or job attribute pattern that is needed to execute ITK related steps like reading or updating Teamcenter data. More...
 
 setConnectParameters4WF ?UserName? ?UserId? ?Password? ?Group? ?EncryptFlag?
 Defines the credential information for a given responsible party user name, so that it is possible for the job agent to execute a workflow task in the corresponding inbox. More...
 

Variables

 ItkConnectMatrix
 

Function Documentation

◆ setConnectParameters4Batch()

ITK::MULTI::CONNECT::setConnectParameters4Batch   ?User? ?Password? ?Group? ?BatchClient? ?AttrName? ?AttrVal? ?EncryptFlag?  

Defines the (technical) users credential information for a given job agent or job attribute pattern that is needed to execute ITK related steps like reading or updating Teamcenter data.

Parameters
UserTeamcenter User Id
PasswordTeamcenter Password
GroupTeamcenter Group Id
BatchClientNameJob agent id default "*"
use the "internal job agent (batch client) Id" = "external job agent (batch client) Id" - 1
AttrNameJobAttributeName - default "*"
AttrValJobAttributeValue - default "*"
EncryptFlag(optional), enables (default TRUE) and disables (FALSE) the automatic encryption of the User, Password and Group, so that the function could also be called with already encrypted strings. Default is TRUE.
Returns
None
Warning
Make sure that before you define a specific connection you specify a default connection via the ITK::setConnectionParameters API. This will avoid missing credentials for not matching credential definitions.

Default connect data sample

connect data for all jobs on the batch client 1 = 0 (use the "internal batch client Id" = "external batch client Id" - 1), unless no more specific settings found sample

1 ::ITK::MULTI::CONNECT::setConnectParameters4Batch batchuser batchuser Engineering 0

connect data for jobs on the batch client 1 = 0 (use the "internal batch client Id" = "external batch client Id" - 1) and PRIO = 30 sample

connect data for jobs on the batch client 2 = 1 (use the "internal batch client Id" = "external batch client Id" - 1) and DESC = ^T4S_TRANSFER_.* - starting with T4S_TRANSFER_ sample

1 ::ITK::MULTI::CONNECT::setConnectParameters4Batch testuser password dba 1 DESC "^T4S_TRANSFER_.*"

Connect data for jobs on all batch clients and PRIO=20 sample

1 ::ITK::MULTI::CONNECT::setConnectParameters4Batch batchuser password Engineering * PRIO 20

References ITK::getConnectionParameters(), tpco_encrypt(), tpco_scanHEX16(), and tpwrite().

◆ setConnectParameters4WF()

ITK::MULTI::CONNECT::setConnectParameters4WF   ?UserName? ?UserId? ?Password? ?Group? ?EncryptFlag?  

Defines the credential information for a given responsible party user name, so that it is possible for the job agent to execute a workflow task in the corresponding inbox.

Warning
Make sure that before you define a specific connection you specify a default connection via the ITK::setConnectionParameters API. This will avoid missing credentials for not matching credential definitions.
Parameters
UserNameWorkflow task responsible party user name
UserIdTeamcenter User Id
PasswordTeamcenter Password
GroupTeamcenter Group Id
EncryptFlag(optional), enables (default TRUE) and disables (FALSE) the automatic encryption of the User, Password and Group, so that the function could also be called with alreday encrypted strings. Default is TRUE.
Returns
None

Sample code sequence

1 # define the Teamcenter credentials that are linked to the responsible party user testuser
2 ::ITK::MULTI::CONNECT::setConnectParameters4WF "testuser" "testuser" "" "Engineering"

References ITK::getConnectionParameters(), tpco_encrypt(), tpco_scanHEX16(), and tpwrite().

Variable Documentation

◆ ItkConnectMatrix

ItkConnectMatrix
static