T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
TCTYPE ITK functions

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

Functions

 TCTYPE_ask_name HexTypeTag
 This function calls the ITK pipe server function TCTYPE_ask_name to retrieve the type name of a given type tag. More...
 
 TCTYPE_ask_object_type ObjectTag
 This function calls the ITK pipe server function TCTYPE_ask_object_type to retrieve the object type tag of a given object tag. More...
 
 TCTYPE_construct_create_input ObjectTypeTag AttributeName1 AttributeValue1 ...
 This function calls the ITK pipe server function TCTYPE_construct_create_input to create a new create input tag. More...
 
 TCTYPE_copy_object HexTcObjectTag args
 This function calls the ITK pipe server function TCTYPE_copy_item to create a new Item based on a given Item. More...
 
 TCTYPE_create_object CreateInputTag
 This function calls the ITK pipe server function TCTYPE_create_object to create an object, which has been previously prepared with TCTYPE_construct_create_input. ATTENTION - do not forget to save the new object. More...
 
 TCTYPE_find_alltypes_for_class ClassName
 This function calls the ITK pipe server function TCTYPE_find_alltypes_for_class to get a list of type-names for the given class. More...
 
 TCTYPE_find_type TypeName
 This function calls the ITK pipe server function TCTYPE_find_type to find the typeTag for the given type name. More...
 
 TCTYPE_simplified_create_object2 ObjectTypeName AttributeName1 AttributeValue1 ...
 This function calls the ITK pipe server function TCTYPE_construct_create_input and TCTYPE_create_item to create a new Item based on a given object type. To store the object it is necessary to save the new object by using the ITK::AOM_save_with_extensions or ITK::AOM_save or ITK::ITEM_save_item. More...
 

Detailed Description

All ITK functions of group TCTYPE supported by T4x.

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

Function Documentation

◆ TCTYPE_ask_name()

ITK::TCTYPE_ask_name   HexTypeTag  

This function calls the ITK pipe server function TCTYPE_ask_name to retrieve the type name of a given type tag.

Parameters
HexTypeTagTeamcenter type tag
Returns
List of ITK_ok (=0) and HexTypeName or list of ITK status and error message

◆ TCTYPE_ask_object_type()

ITK::TCTYPE_ask_object_type   ObjectTag  

This function calls the ITK pipe server function TCTYPE_ask_object_type to retrieve the object type tag of a given object tag.

Parameters
ObjectTagTeamcenter object tag
Returns
List of ITK_ok (=0) and HexObjectTypeTag or list of ITK status and error message

◆ TCTYPE_construct_create_input()

ITK::TCTYPE_construct_create_input   ObjectTypeTag AttributeName1 AttributeValue1 ...  

This function calls the ITK pipe server function TCTYPE_construct_create_input to create a new create input tag.

Parameters
ObjectTypeTagTeamcenter type tag in the Tcl string format
AttributeName1string = property name ex. item_id, items_tag, object_name,
AttributeValue1string = can contain date, hexStringTag, string, number, logical (true/false) in string form
...
AttributeNameXstring = property name ex. item_id, items_tag, object_name,
AttributeValueXstring = can contain date, hexStringTag, string, number, logical (true/false) in string form
                 Syntax: ::ITK::TCTYPE_construct_create_input <ObjectTypeTag> opt. <AttributeName1> <AttributeValue1> ... <AttributeNameX> <AttributeValueX>
                 AttributeName and Attribute Value must be given paarwise

                 property value can contain: date / string / hextag / number / boolean in string form
                                             logical : true /false
                                             date: format %Y.%m.%d %H:%M:%S

Sample code sequence

1 set ItkStatus [::ITK::TCTYPE_find_type "Item"]
2 if {[::ITK::isITK_ok $ItkStatus]} {
3  set TypeTag [lindex $ItkStatus 1]
4  set ItkStatus [::ITK::TCTYPE_construct_create_input $TypeTag "item_id" "1234" "object_name" "test"]
5  if {[::ITK::isITK_ok $ItkStatus]} {
6  set createInputTag [lindex $ItkStatus 1]
7  }
8 }
Returns
List of ITK_ok (=0) and create input tag or list of ITK status and error message

Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::createTC_Object2().

◆ TCTYPE_copy_object()

ITK::TCTYPE_copy_object   HexTcObjectTag args  

This function calls the ITK pipe server function TCTYPE_copy_item to create a new Item based on a given Item.

Parameters
HexTcObjectTag,Teamcenteritem tag in the Tcl string format
args(optional), list of the Id string and revision Id string of the new Item. if not specified, the the system will automatically generate an Item ID and Revision ID.
Returns
List of ITK_ok (=0) and Item tag, ItemRevision tag or list of ITK status and error message

◆ TCTYPE_create_object()

ITK::TCTYPE_create_object   CreateInputTag  

This function calls the ITK pipe server function TCTYPE_create_object to create an object, which has been previously prepared with TCTYPE_construct_create_input. ATTENTION - do not forget to save the new object.

Parameters
CreateInputTagTeamcenter create input tag in the Tcl string format

Sample code sequence

1 set ItkStatus [::ITK::TCTYPE_find_type "Item"]
2 if {[::ITK::isITK_ok $ItkStatus]} {
3  set TypeTag [lindex $ItkStatus 1]
4  set ItkStatus [::ITK::TCTYPE_construct_create_input $TypeTag "item_id" "1234" "object_name" "test"]
5  if {[::ITK::isITK_ok $ItkStatus]} {
6  set createInputTag [lindex $ItkStatus 1]
7  set ItkStatus [::ITK::TCTYPE_create_object $createInputTag]
8  if {[::ITK::isITK_ok $ItkStatus]} {
9  set newObjectTag [lindex $ItkStatus 1]
11  }
12  }
13 }
Returns
List of ITK_ok (=0) and object tag or list of ITK status and error message

◆ TCTYPE_find_alltypes_for_class()

ITK::TCTYPE_find_alltypes_for_class   ClassName  

This function calls the ITK pipe server function TCTYPE_find_alltypes_for_class to get a list of type-names for the given class.

Parameters
ClassNameTeamcenter object class name
Returns
List of ITK_ok (=0) and list of type names or list of ITK status and error message

◆ TCTYPE_find_type()

ITK::TCTYPE_find_type   TypeName  

This function calls the ITK pipe server function TCTYPE_find_type to find the typeTag for the given type name.

Parameters
TypeNameTeamcenter object type name

Sample code sequence

1 set ItkStatus [::ITK::TCTYPE_find_type "Item"]
2 if {[::ITK::isITK_ok $ItkStatus]} {
3  set TypeTag [lindex $ItkStatus 1]
4 }
Returns
List of ITK_ok (=0) and type tag or list of ITK status and error message

Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::createTC_Object2().

◆ TCTYPE_simplified_create_object2()

ITK::TCTYPE_simplified_create_object2   ObjectTypeName AttributeName1 AttributeValue1 ...  

This function calls the ITK pipe server function TCTYPE_construct_create_input and TCTYPE_create_item to create a new Item based on a given object type. To store the object it is necessary to save the new object by using the ITK::AOM_save_with_extensions or ITK::AOM_save or ITK::ITEM_save_item.

Parameters
ObjectTypeName
AttributeName1string = property name ex. item_id, items_tag, object_name,
AttributeValue1string = can contain date, hexStringTag, string, number, logical (true/false) in string form
...
AttributeNameXstring = property name ex. item_id, items_tag, object_name,
AttributeValueXstring = can contain date, hexStringTag, string, number, logical (true/false) in string form
                 Syntax: ::ITK::TCTYPE_simplified_create_object <ObjectType> <AttributeName1> <AttributeValue1> ... <AttributeNameX> <AttributeValueX>
                 at lease one pair of AttributeName and Attribute Value must be given

                 property value can contain: date / string / hextag / number / boolean in string form
                                             logical : true /false
                                             date: format %Y.%m.%d %H:%M:%S

Sample code sequence

1 set ItkStatus [::ITK::TCTYPE_simplified_create_object2 $ObjectType "item_id" $ItemId]
2 if {[::ITK::isITK_ok $ItkStatus]} {
3  set ObjectTag [lindex $ItkStatus 1]
4  set SaveStatus [::ITK::AOM_save_with_extensions $ObjectTag]
5 }
Returns
List of ITK_ok (=0) and Item tag, ItemRevision tag or list of ITK status and error message

Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::createTC_Object2(), T4X::CUSTOM::MAPPING::TOOLBOX::importNamedReference(), and T4X::WORKFLOW::BATCHJOB::CUSTOM::sendTC_InfoEMail().