T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
ITK::MULTI::CONNECT Namespace Reference

Functions

 setCredentialsAlias4Job CredentialsAlias ?JobAgentId? ?AttrName? ?AttrVal?
 Defines the (technical) users credentials alias for a given job agent or job attribute pattern that is needed to execute ITK related steps like reading or updating Teamcenter data. The credentials alias needs to be stored with the corresponding mode in the Teamcenter Connect script. More...
 
 setCredentialsAlias4Workflow UserName CredentialsAlias
 This function defines the credentials alias that should be used in the workflow job for a given user id. The credentials alias needs to be stored via the corresponding mode in the Teamcenter Connect script. More...
 

Function Documentation

◆ setCredentialsAlias4Job()

ITK::MULTI::CONNECT::setCredentialsAlias4Job   CredentialsAlias ?JobAgentId? ?AttrName? ?AttrVal?  

Defines the (technical) users credentials alias for a given job agent or job attribute pattern that is needed to execute ITK related steps like reading or updating Teamcenter data. The credentials alias needs to be stored with the corresponding mode in the Teamcenter Connect script.

Parameters
CredentialsAliasTeamcenter symbolic name used for the connection parameters stored in the secure storage.
JobAgentIdJob agent id default "*"
use the "internal job agent (batch client) Id" = "external job agent (batch client) Id" - 1
AttrNameJobAttributeName - default "*"
AttrValJobAttributeValue - default "*"
Returns
None
Precondition
The credentials alias needs to be stored via the corresponding mode in the Teamcenter Connect script.
Warning
If no credentials alias is defined the default alias "Default@Teamcenter" will be used for the connection to Teamcenter. If that is not available the system will use the normal Teamcenter auto connection of the actual operating system user.

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::setCredentialsAlias4Job JobAgentCredentialsAlias 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

1 ::ITK::MULTI::CONNECT::setCredentialsAlias4Job JobAgentCredentialsAlias 0 PRIO 30

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::setCredentialsAlias4Job JobAgentCredentialsAlias 1 DESC "^T4S_TRANSFER_.*"

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

1 ::ITK::MULTI::CONNECT::setCredentialsAlias4Job JobAgentCredentialsAlias * PRIO 20
Returns
None

◆ setCredentialsAlias4Workflow()

ITK::MULTI::CONNECT::setCredentialsAlias4Workflow   UserName CredentialsAlias  

This function defines the credentials alias that should be used in the workflow job for a given user id. The credentials alias needs to be stored via the corresponding mode in the Teamcenter Connect script.

Parameters
UserNameThis is not a Teamcenter user id, but the name of a workflow task responsible party. The two can and probably should be different!
CredentialsAliasTeamcenter symbolic name used for the connection parameters stored in the secure storage.
Precondition
The credentials alias needs to be stored via the corresponding mode in the Teamcenter Connect script.
Warning
If no credentials alias is defined the default alias "Default@Teamcenter" will be used for the connection to Teamcenter. If that is not available the system will use the normal Teamcenter auto connection of the actual operating system user.

Sample configuration for the user testuser and the corresponding credentials alias in this case testuser@Teamcenter

1 ::ITK::MULTI::CONNECT::setCredentialsAlias4Workflow "testuser" testuser@Teamcenter
Returns
None