T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
ITEM ITK functions

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

Functions

 ITEM_add_related_global_alternates HexTcObjectTag AlternateTag1 ... AlternateTagX
 This function calls the ITK pipe server function ITEM_add_related_global_alternates. More...
 
 ITEM_ask_has_global_alternates HexTcObjectTag
 This function calls the ITK pipe server function ITEM_ask_has_global_alternates. More...
 
 ITEM_ask_item_of_rev HexTcObjectTag
 This function calls the ITK pipe server function ITEM_ask_item_of_rev to retrieve the item tag of a given item revision tag. More...
 
 ITEM_ask_latest_rev HexTcObjectTag
 This function calls the ITK pipe server function ITEM_ask_latest_rev to retrieve the latest item revision tag of a given item tag. More...
 
 ITEM_ask_rev_by_revision_rule HexTcObjectTag RevisionRuleName
 This function calls the ITK pipe server function ITEM_ask_rev_by_revision_rule to retrieve the item revision tag via a given revision rule name of a given item tag. More...
 
 ITEM_ask_rev_variants HexItemRevTag
 This function calls the ITK pipe server function ITEM_ask_rev_variants Returns the variant expression block associated with the specified Item Revision. More...
 
 ITEM_ask_type HexTcObjectTag
 This function calls the ITK pipe server function ITEM_ask_type. More...
 
 ITEM_copy_item HexTcObjectTag args
 This function calls the ITK pipe server function ITEM_copy_item to create a new Item based on a given Item. More...
 
 ITEM_copy_rev HexTcObjectTag ItemRevisionID
 This function calls the ITK pipe server function ITEM_copy_rev to create a new item revision based on a given item revision tag. More...
 
 ITEM_exists AttributeList
 This function calls the ITK pipe server function ITEM_exists to check the existence of an item with given attributes in Teamcenter. More...
 
 ITEM_find ItemIdString
 This function calls the ITK pipe server function ITEM_find to searches for item revisions of a given item tag. More...
 
 ITEM_find_item_revs_by_key_attributes ItemRevisionId AttributeList
 This function calls the ITK pipe server function ITEM_find_item_revs_by_key_attributes to check the existence of an item revision with given attributes in Teamcenter. More...
 
 ITEM_find_item_revs_by_string AttributeList
 This function calls the ITK pipe server function ITEM_find_item_revs_by_string to check the existence of an item revision with given attributes in Teamcenter. More...
 
 ITEM_find_items_by_key_attributes AttributeList
 This function calls the ITK pipe server function ITEM_find_items_by_key_attributes to check the existence of an item with given attributes in Teamcenter. More...
 
 ITEM_find_items_by_string AttributeList
 This function calls the ITK pipe server function ITEM_find_items_by_string to check the existence of an item with given attributes in Teamcenter. More...
 
 ITEM_find_revision HexTcObjectTag ItemRevisionId
 This function calls the ITK pipe server function ITEM_find_revision to searches for item revision of a given item tag. More...
 
 ITEM_find_revisions HexTcObjectTag ItemRevisionId
 This function calls the ITK pipe server function ITEM_find_revisions to searches for item revisions of a given item tag. More...
 
 ITEM_list_related_global_alternates HexTcObjectTag
 This function calls the ITK pipe server function ITEM_list_related_global_alternates. More...
 
 ITEM_perform_deepcopy HexNewRevTag CopyOperation HexParentRevTag
 This function calls the ITK pipe server function ITEM_perform_deepcopy to run the deep-copy rules on a new item revision based on a given parent revision. More...
 
 ITEM_prefer_global_alternate HexTcObjectTag AlternateTag
 This function calls the ITK pipe server function ITEM_prefer_global_alternate. More...
 
 ITEM_remove_related_global_alternates HexTcObjectTag AlternateTag1 ... AlternateTagX
 This function calls the ITK pipe server function ITEM_remove_related_global_alternates. More...
 
 ITEM_rev_delete_bvr HexTcObjectTag HexBomViewTag
 This function calls the ITK pipe server function ITEM_rev_delete_bvr to delete BOM view revision from a the Item Revision. More...
 
 ITEM_rev_list_bom_view_revs HexTcObjectTag
 This function calls the ITK pipe server function ITEM_rev_list_bom_view_revs to return all attached BOM views for a given item revision. More...
 
 ITEM_save_item HexTcObjectTag
 This function calls the ITK pipe server function ITEM_save_item to save a given item. More...
 
 ITEM_save_rev HexTcObjectTag
 This function calls the ITK pipe server function ITEM_save_rev to save a given item revision. More...
 
 ITEM_set_description HexTcObjectTag ItemDesc
 This function calls the ITK pipe server function ITEM_set_description to set the description of a given item. More...
 
 ITEM_set_id HexTcObjectTag ItemID
 This function calls the ITK pipe server function ITEM_set_id to set the id of a given item. More...
 
 ITEM_set_name HexTcObjectTag ItemName
 This function calls the ITK pipe server function ITEM_set_name to set the item name of a given item. More...
 
 ITEM_set_rev_description HexTcObjectTag ItemRevisionDesc
 This function calls the ITK pipe server function ITEM_set_rev_description to set the description of a given item revision. More...
 
 ITEM_set_rev_id HexTcObjectTag ItemRevisionID
 This function calls the ITK pipe server function ITEM_set_rev_id to set the revision id of a given item revision. More...
 
 ITEM_set_rev_name HexTcObjectTag ItemRevisionName
 This function calls the ITK pipe server function ITEM_set_rev_name to set the revision name of a given item revision. More...
 
 ITEM_SetUnitOfMeasureByName HexTcObjectTag NewName
 This function calls the ITK pipe server function ITEM_set_unit_of_measure_by_name to set the unit of measure for a given item. More...
 

Detailed Description

All ITK functions of group ITEM supported by T4x.

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

Function Documentation

◆ ITEM_add_related_global_alternates()

ITK::ITEM_add_related_global_alternates   HexTcObjectTag AlternateTag1 ... AlternateTagX  

This function calls the ITK pipe server function ITEM_add_related_global_alternates.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
AlternateTag1Teamcenter item tag in the Tcl string format
...
AlternateTagXTeamcenter item tag in the Tcl string format
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_ask_has_global_alternates()

ITK::ITEM_ask_has_global_alternates   HexTcObjectTag  

This function calls the ITK pipe server function ITEM_ask_has_global_alternates.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and logical value(0/1) or list of ITK status and error message

◆ ITEM_ask_item_of_rev()

ITK::ITEM_ask_item_of_rev   HexTcObjectTag  

This function calls the ITK pipe server function ITEM_ask_item_of_rev to retrieve the item tag of a given item revision tag.

Parameters
HexTcObjectTagTeamcenter item revision tag in the Tcl string format
Returns
List ITK_ok (=0) and tag of the found Item or list of ITK status and error message

◆ ITEM_ask_latest_rev()

ITK::ITEM_ask_latest_rev   HexTcObjectTag  

This function calls the ITK pipe server function ITEM_ask_latest_rev to retrieve the latest item revision tag of a given item tag.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and tag of the found ItemRevision or list of ITK status and error message

◆ ITEM_ask_rev_by_revision_rule()

ITK::ITEM_ask_rev_by_revision_rule   HexTcObjectTag RevisionRuleName  

This function calls the ITK pipe server function ITEM_ask_rev_by_revision_rule to retrieve the item revision tag via a given revision rule name of a given item tag.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
RevisionRuleNameTeamcenter revision rule name (e.g. "Latest Working")
Returns
List of ITK_ok (=0) and tag of the found ItemRevision or list of ITK status and error message

Sample code sequence

1 set StatusList [::ITK::ITEM_ask_rev_by_revision_rule "$MyTag" "Latest Released"]
2 if {[lindex $StatusList 0] == 0} {
3  #ITK_ok
4  set ItemRevisionTag [tpco_formatHEX16 [lindex $StatusList 1]]
5 } else {
6  # any error
7  set ErrorMesssage [tpco_formatHEX16 [lindex $StatusList 1]]
8 }

◆ ITEM_ask_rev_variants()

ITK::ITEM_ask_rev_variants   HexItemRevTag  

This function calls the ITK pipe server function ITEM_ask_rev_variants Returns the variant expression block associated with the specified Item Revision.

Parameters
HexItemRevTagTeamcenter item revision tag in the Tcl string format
Returns
List ITK_ok (=0) and tag of the found VariantExpressionBlockTag or list of ITK status and error message

◆ ITEM_ask_type()

ITK::ITEM_ask_type   HexTcObjectTag  

This function calls the ITK pipe server function ITEM_ask_type.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and HexTypeName or list of ITK status and error message

◆ ITEM_copy_item()

ITK::ITEM_copy_item   HexTcObjectTag args  

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

Parameters
HexTcObjectTagTeamcenter item 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

◆ ITEM_copy_rev()

ITK::ITEM_copy_rev   HexTcObjectTag ItemRevisionID  

This function calls the ITK pipe server function ITEM_copy_rev to create a new item revision based on a given item revision tag.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
ItemRevisionID(optional) Defines the new Teamcenter item revision id string
Returns
List of ITK_ok (=0) and tag of the copied ItemRevision or list of ITK status and error message

◆ ITEM_exists()

ITK::ITEM_exists   AttributeList  

This function calls the ITK pipe server function ITEM_exists to check the existence of an item with given attributes in Teamcenter.

Parameters
AttributeList- attrName1 attrVal1 ... attrNameX attrValX.

Sample code sequence

1 set ItkStatus [::ITK::ITEM_exists "item_id" "1234567" "object_name" "TestItem" "object_desc" "Test"]
2 if {[lindex $ItkStatus 0] == 0 && [lindex $ItkStatus 1] == 1} {
3  puts "SUCCESS: item exists in TC"
4 } else {
5  puts "FAILURE: item doesn't exist in TC"
6 }
Returns
List of ITK Status and existence flag value (0=FALSE or 1=TRUE) or list of ITK status and error message

◆ ITEM_find()

ITK::ITEM_find   ItemIdString  

This function calls the ITK pipe server function ITEM_find to searches for item revisions of a given item tag.

Parameters
ItemIdString
Returns
List of ITK_ok (=0) and list of found Item tags or list of ITK status and error message

◆ ITEM_find_item_revs_by_key_attributes()

ITK::ITEM_find_item_revs_by_key_attributes   ItemRevisionId AttributeList  

This function calls the ITK pipe server function ITEM_find_item_revs_by_key_attributes to check the existence of an item revision with given attributes in Teamcenter.

This function searches the database for all ItemRevisions and returns a list of ItemRevision tags identified by the given attribute name/value pairs. The attributes must be the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant. For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.

Parameters
ItemRevisionId
AttributeListattrName1 attrVal1 ... attrNameX attrValX.

Sample code sequence

1 set ItkStatus [::ITK::ITEM_find_item_revs_by_key_attributes $ItemRevisionId "item_id" $ObjectId]
2 if {[lindex $ItkStatus 0] == 0 && [lindex $ItkStatus 1] == 1} {
3  set ItemRevisionTag [lindex [lindex $ItkStatus 2] 0]
4 }
Returns
List of ITK_ok (=0), number of found revisions and list of found item revision Tags or list of ITK status and error message

◆ ITEM_find_item_revs_by_string()

ITK::ITEM_find_item_revs_by_string   AttributeList  

This function calls the ITK pipe server function ITEM_find_item_revs_by_string to check the existence of an item revision with given attributes in Teamcenter.

This function searches the database for all ItemRevisions and returns a list of ItemRevision tags identified by the given input parameters.

All attributes in the attribute-value pair string must the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant. For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.

Also, the last attribute-value pair in the string must be: rev_id=<revision name>.

Parameters
AttributeListattrName1 attrVal1 ... attrNameX attrValX. The input parameter AttributeList contains Item attribute-value pairs, and must in the format of:
  attr_1 value1 attr_2 value2 ...

Sample code sequence

1 set ItkStatus [::ITK::ITEM_find_item_revs_by_string item_id 000019 rev_id A]
Returns
List of ITK_ok (=0), number of found revisions and list of found item revision Tags or list of ITK status and error message

◆ ITEM_find_items_by_key_attributes()

ITK::ITEM_find_items_by_key_attributes   AttributeList  

This function calls the ITK pipe server function ITEM_find_items_by_key_attributes to check the existence of an item with given attributes in Teamcenter.

This function searches the database for all Items and returns a list of item tags identified by the given attribute name/value pairs. The attributes must be the unique key attributes of the item class. Currently, only "item_id" attribute should be used.

Parameters
AttributeListattrName1 attrVal1 ... attrNameX attrValX.

Sample code sequence

1 set ItkStatus [::ITK::ITEM_find_items_by_key_attributes item_id $ObjectId]
2 if {[lindex $ItkStatus 0] == 0 && [lindex $ItkStatus 1] == 1} {
3  set ItemTag [lindex [lindex $ItkStatus 2] 0]
4 }
Returns
List of ITK_ok (=0),number of found items and list of found item Tags or list of ITK status and error message

◆ ITEM_find_items_by_string()

ITK::ITEM_find_items_by_string   AttributeList  

This function calls the ITK pipe server function ITEM_find_items_by_string to check the existence of an item with given attributes in Teamcenter.

This function searches the database for all Items and returns a list of Item tags identified by the given input parameters.

All attributes in the attribute-value pair string must the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant. For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.

Parameters
AttributeListattrName1 attrVal1 ... attrNameX attrValX. The input parameter AttributeList contains Item attribute-value pairs, and must in the format of:
  attr_1 value1 attr_2 value2 ...

Sample code sequence

1 set ItkStatus [::ITK::ITEM_find_items_by_string item_id "000019" object_type Item]
Returns
List of ITK_ok (=0), number of found items and list of found item Tags or list of ITK status and error message

◆ ITEM_find_revision()

ITK::ITEM_find_revision   HexTcObjectTag ItemRevisionId  

This function calls the ITK pipe server function ITEM_find_revision to searches for item revision of a given item tag.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
ItemRevisionId
Returns
List of ITK_ok (=0) and tag of the found ItemRevision or list of ITK status and error message

◆ ITEM_find_revisions()

ITK::ITEM_find_revisions   HexTcObjectTag ItemRevisionId  

This function calls the ITK pipe server function ITEM_find_revisions to searches for item revisions of a given item tag.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
ItemRevisionIdWild-cards may be used
Returns
List of ITK_ok (=0) and list of found ItemRevision tags or list of ITK status and error message

◆ ITEM_list_related_global_alternates()

ITK::ITEM_list_related_global_alternates   HexTcObjectTag  

This function calls the ITK pipe server function ITEM_list_related_global_alternates.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
Returns
List of ITK_ok (=0) and list of alternates tags or list of ITK status and error message

◆ ITEM_perform_deepcopy()

ITK::ITEM_perform_deepcopy   HexNewRevTag CopyOperation HexParentRevTag  

This function calls the ITK pipe server function ITEM_perform_deepcopy to run the deep-copy rules on a new item revision based on a given parent revision.

Parameters
HexNewRevTagTeamcenter target item revision tag in the Tcl string format
CopyOperationCopy operation type: ITEM_revise_operation or ITEM_saveas_operation
HexParentRevTagTeamcenter source item revision tag in the Tcl string format
Returns
List of ITK_ok (=0) and list of found DeepCopiedObject tags or list of ITK status and error message

◆ ITEM_prefer_global_alternate()

ITK::ITEM_prefer_global_alternate   HexTcObjectTag AlternateTag  

This function calls the ITK pipe server function ITEM_prefer_global_alternate.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
AlternateTagTeamcenter item tag in the Tcl string format
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_remove_related_global_alternates()

ITK::ITEM_remove_related_global_alternates   HexTcObjectTag AlternateTag1 ... AlternateTagX  

This function calls the ITK pipe server function ITEM_remove_related_global_alternates.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
AlternateTag1Teamcenter item tag in the Tcl string format
...
AlternateTagXTeamcenter item tag in the Tcl string format
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_rev_delete_bvr()

ITK::ITEM_rev_delete_bvr   HexTcObjectTag HexBomViewTag  

This function calls the ITK pipe server function ITEM_rev_delete_bvr to delete BOM view revision from a the Item Revision.

Parameters
HexTcObjectTagTeamcenter object tag in the Tcl string format
HexBomViewTagTeamcenter view tag in the Tcl string format
Returns
List of ITK_ok (=0) or list of ITK status and error message

◆ ITEM_rev_list_bom_view_revs()

ITK::ITEM_rev_list_bom_view_revs   HexTcObjectTag  

This function calls the ITK pipe server function ITEM_rev_list_bom_view_revs to return all attached BOM views for a given item revision.

Parameters
HexTcObjectTagTeamcenter item revision tag in the Tcl string format
Returns
List of ITK_ok (=0) and list of found BOM view revision tags or list of ITK status and error message

◆ ITEM_save_item()

ITK::ITEM_save_item   HexTcObjectTag  

This function calls the ITK pipe server function ITEM_save_item to save a given item.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_save_rev()

ITK::ITEM_save_rev   HexTcObjectTag  

This function calls the ITK pipe server function ITEM_save_rev to save a given item revision.

Parameters
HexTcObjectTagTeamcenter item revision tag in the Tcl string format
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_set_description()

ITK::ITEM_set_description   HexTcObjectTag ItemDesc  

This function calls the ITK pipe server function ITEM_set_description to set the description of a given item.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
ItemDescNew item description string
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_set_id()

ITK::ITEM_set_id   HexTcObjectTag ItemID  

This function calls the ITK pipe server function ITEM_set_id to set the id of a given item.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
ItemIDNew item id string
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_set_name()

ITK::ITEM_set_name   HexTcObjectTag ItemName  

This function calls the ITK pipe server function ITEM_set_name to set the item name of a given item.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
ItemNameNew item name string
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_set_rev_description()

ITK::ITEM_set_rev_description   HexTcObjectTag ItemRevisionDesc  

This function calls the ITK pipe server function ITEM_set_rev_description to set the description of a given item revision.

Parameters
HexTcObjectTagTeamcenter item revision tag in the Tcl string format
ItemRevisionDescNew item revision description string
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_set_rev_id()

ITK::ITEM_set_rev_id   HexTcObjectTag ItemRevisionID  

This function calls the ITK pipe server function ITEM_set_rev_id to set the revision id of a given item revision.

Parameters
HexTcObjectTag,Teamcenteritem revision tag in the Tcl string format
ItemRevisionID,Newitem revision id string
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_set_rev_name()

ITK::ITEM_set_rev_name   HexTcObjectTag ItemRevisionName  

This function calls the ITK pipe server function ITEM_set_rev_name to set the revision name of a given item revision.

Parameters
HexTcObjectTagTeamcenter item revision tag in the Tcl string format
ItemRevisionNameNew item revision name string
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ITEM_SetUnitOfMeasureByName()

ITK::ITEM_SetUnitOfMeasureByName   HexTcObjectTag NewName  

This function calls the ITK pipe server function ITEM_set_unit_of_measure_by_name to set the unit of measure for a given item.

Parameters
HexTcObjectTagTeamcenter item tag in the Tcl string format
NewNameNew unit of measure name string
Returns
ITK_ok (=0) or list of ITK status and error message