T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
CE ITK functions

All ITK functions of group CE supported by T4x. More...

Functions

 CE_ask_condition HexConditionTag
 This function calls the ITK pipe server function ITK_CE_ask_condition to get a condition name. More...
 
 CE_current_user_session_tag
 This function calls the ITK pipe server function POM_get_user to retrieve the current user session object tag. More...
 
 CE_evaluate_condition HexConditionTag NoOfObjects ObjectTag1 ... ObjectTagX
 This function calls the ITK pipe server function ITK_CE_evaluate_condition to check if condition is met. More...
 
 CE_evaluate_condition_by_name HexConditionName NoOfObjects NoOfObjects ObjectTag1 ... ObjectTag
 This function calls the ITK pipe server function ITK_CE_evaluate_condition_by_name finds the condition tag and checks if conditions for targets are met. More...
 
 CE_find_condition HexConditionName
 This function calls the ITK pipe server function ITK_CE_find_condition to find a condition tag. More...
 

Detailed Description

All ITK functions of group CE supported by T4x.

This group specifies all ITK functions of group CE for which wrappers have been defined in T4x

Function Documentation

◆ CE_ask_condition()

ITK::CE_ask_condition   HexConditionTag  

This function calls the ITK pipe server function ITK_CE_ask_condition to get a condition name.

Parameters
HexConditionTag
Returns
list of ITK_ok (=0) - ok and condition name or 1 - failed and error message

◆ CE_current_user_session_tag()

ITK::CE_current_user_session_tag

This function calls the ITK pipe server function POM_get_user to retrieve the current user session object tag.

Returns
ITK_ok (=0) and Tcl representation of the SessionTag or list of ITK status and error message

◆ CE_evaluate_condition()

ITK::CE_evaluate_condition   HexConditionTag NoOfObjects ObjectTag1 ... ObjectTagX  

This function calls the ITK pipe server function ITK_CE_evaluate_condition to check if condition is met.

Parameters
HexConditionTag
NoOfObjects
ObjectTag1... ObjectTagX, list of ObjectTags to evaluate
Returns
list of ITK_ok (=0) - ok and evaluation 1-ok/0-failed or failed and error message

◆ CE_evaluate_condition_by_name()

ITK::CE_evaluate_condition_by_name   HexConditionName NoOfObjects NoOfObjects ObjectTag1 ... ObjectTag  

This function calls the ITK pipe server function ITK_CE_evaluate_condition_by_name finds the condition tag and checks if conditions for targets are met.

Parameters
HexConditionName
NoOfObjects
ObjectTag1... ObjectTagX, list of ObjectTags to evaluate
Returns
list of ITK_ok (=0) - ok and evaluation 1-ok/0-failed or failed and error message

Sample code sequence with current user session tag

1 #
2 # Get the current user tag
3 #
5 if {[::ITK::isITK_ok $ItkStatus]} {
6  set SessionTag [lindex $ItkStatus 1]
7  set ConditionName "isAuthor"
8  set HexName [tpco_scanHEX16 $ConditionName]
9  #
10  set ItkStatus [::ITK::CE_evaluate_condition_by_name $HexName 1 $SessionTag]
11  if {[::ITK::isITK_ok $ItkStatus]} {
12  # ITK_ok
13  #
14  puts "XXXX Call to ITK function 'CE_evaluate_condition_by_name' retruns condition value [lindex $ItkStatus 1]"
15  #
16  } else {
17  # any error
18  set ErrorNumber [::ITK::getITKStatusNumber $ItkStatusCode]
19  set ErrorMesssage [::ITK::getErrorMessage4Status $ItkStatusCode]
20  puts "XXXX"
21  puts "XXXX Call to ITK function 'CE_evaluate_condition_by_name' failed! Error code: $ErrorNumber - $ErrorMesssage"
22  puts "XXXX"
23  }
24 } else {
25  # any error
26  set ErrorNumber [::ITK::getITKStatusNumber $ItkStatusCode]
27  set ErrorMesssage [::ITK::getErrorMessage4Status $ItkStatusCode]
28  puts "XXXX"
29  puts "XXXX Call to ITK function 'CE_current_user_session_tag' failed! Error code: $ErrorNumber - $ErrorMesssage"
30  puts "XXXX"
31 }
32 #

◆ CE_find_condition()

ITK::CE_find_condition   HexConditionName  

This function calls the ITK pipe server function ITK_CE_find_condition to find a condition tag.

Parameters
HexConditionName
Returns
list of ITK_ok (=0) - ok and condition tag or 1 - failed and error message