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

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

Functions

 WSOM_ask_name HexTcObjectTag
 This function calls the ITK pipe server function WSOM_ask_name to ask the name of a given workspace object. More...
 
 WSOM_ask_object_id_string HexTcObjectTag
 This function calls the ITK pipe server function WSOM_ask_object_id_string to ask the id string of a given workspace object. More...
 
 WSOM_ask_object_type HexTcObjectTag
 This function calls the ITK pipe server function WSOM_ask_object_type to ask the type name of a given workspace object. More...
 
 WSOM_create_effectivity HexTcObjectTag
 This function calls the ITK pipe server function WSOM_create_effectivity and gives back the effecitivity tag. More...
 
 WSOM_delete_effectivity HexTcObjectTag HexTcEffTag
 This function calls the ITK pipe server function WSOM_delete_effectivity and gives the status. More...
 
 WSOM_eff_ask_end_item HexStatusTag HexEffTag
 This function calls the ITK pipe server function WSOM_eff_ask_end_item and gives back the effecitivity end item. More...
 
 WSOM_eff_ask_end_item_rev HexStatusTag HexEffTag
 This function calls the ITK pipe server function WSOM_eff_ask_end_item_rev and gives back the effecitivity end item rev. More...
 
 WSOM_eff_set_end_item HexStatusTag HexEffTag HexEndItemTag
 This function calls the ITK pipe server function WSOM_eff_set_end_item and sets the effecitivity end item. More...
 
 WSOM_eff_set_end_item_rev HexStatusTag HexEffTag HexEndItemRevTag
 This function calls the ITK pipe server function WSOM_eff_set_end_item_rev and sets the effecitivity end item rev. More...
 
 WSOM_find2 WorkspaceName
 This function calls the ITK pipe server function WSOM_find2 and returns list of tags of WorkspaceObjects, regardless of subclass, that have a particular name. ITK_ok returns if no error occurs during the query. This does not mean that hits will be greater than 0. That must be a separate check. More...
 
 WSOM_get_all_effectivities_dates HexTcObjectTag
 This function calls the ITK pipe server function WSOM_get_all_effectivities_dates and gives back dates of all the effecitivities of the status. More...
 
 WSOM_get_effectivities HexTcObjectTag
 This function calls the ITK pipe server function WSOM_get_effectivities and gives back the effecitivities of set the status. More...
 
 WSOM_get_effectivity_dates HexTcObjectTag HexTcEffTag
 This function calls the ITK pipe server function WSOM_get_effectivity_dates and gives back the effecitivity dates for the status. More...
 
 WSOM_get_item_rev_status_by_name HexTcObjectTag StatusName
 This function calls the ITK pipe server function WSOM_get_item_rev_status_by_name and looks for a status with given name. More...
 
 WSOM_set_description HexTcObjectTag NewDesc
 This function calls the ITK pipe server function WSOM_set_description to set the description of a given workspace object. More...
 
 WSOM_set_effectivity_dates HexTcObjectTag HexTcEffTag StartDate EndDate CreateNew
 This function calls the ITK pipe server function WSOM_set_effectivity_dates and sets the new effectivity dates for the status. More...
 
 WSOM_set_name HexTcObjectTag NewName
 This function calls the ITK pipe server function WSOM_set_name to set the name of a given workspace object. More...
 
 WSOM_where_referenced ObjectTag Level
 This function calls the ITK pipe server function WSOM_where_referenced and get the information about referenced objects. More...
 

Detailed Description

All ITK functions of group WSOM supported by T4x.

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

Function Documentation

◆ WSOM_ask_name()

ITK::WSOM_ask_name   HexTcObjectTag  

This function calls the ITK pipe server function WSOM_ask_name to ask the name of a given workspace object.

Parameters
HexTcObjectTagTeamcenter workspace object tag in the Tcl string format
Returns
ITK_ok (=0) and name or ITK status and error message

◆ WSOM_ask_object_id_string()

ITK::WSOM_ask_object_id_string   HexTcObjectTag  

This function calls the ITK pipe server function WSOM_ask_object_id_string to ask the id string of a given workspace object.

Parameters
HexTcObjectTagTeamcenter workspace object tag in the Tcl string format
Returns
ITK_ok (=0) and HexObjectId or ITK status and error message

◆ WSOM_ask_object_type()

ITK::WSOM_ask_object_type   HexTcObjectTag  

This function calls the ITK pipe server function WSOM_ask_object_type to ask the type name of a given workspace object.

Parameters
HexTcObjectTagTeamcenter workspace object tag in the Tcl string format
Returns
ITK_ok (=0) and type name or ITK status and error message

◆ WSOM_create_effectivity()

ITK::WSOM_create_effectivity   HexTcObjectTag  

This function calls the ITK pipe server function WSOM_create_effectivity and gives back the effecitivity tag.

Parameters
HexTcObjectTagTeamcenter status tag in the Tcl string format
Returns
List of ITK_ok (=0) and effectivity tag

◆ WSOM_delete_effectivity()

ITK::WSOM_delete_effectivity   HexTcObjectTag HexTcEffTag  

This function calls the ITK pipe server function WSOM_delete_effectivity and gives the status.

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

◆ WSOM_eff_ask_end_item()

ITK::WSOM_eff_ask_end_item   HexStatusTag HexEffTag  

This function calls the ITK pipe server function WSOM_eff_ask_end_item and gives back the effecitivity end item.

Parameters
HexStatusTagTeamcenter status tag in the Tcl string format
HexEffTagTeamcenter effectivity tag in the Tcl string format
Returns
List of ITK_ok (=0) and HexEndItemTag or list of ITK status and error message

◆ WSOM_eff_ask_end_item_rev()

ITK::WSOM_eff_ask_end_item_rev   HexStatusTag HexEffTag  

This function calls the ITK pipe server function WSOM_eff_ask_end_item_rev and gives back the effecitivity end item rev.

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

◆ WSOM_eff_set_end_item()

ITK::WSOM_eff_set_end_item   HexStatusTag HexEffTag HexEndItemTag  

This function calls the ITK pipe server function WSOM_eff_set_end_item and sets the effecitivity end item.

Parameters
HexStatusTagTeamcenter status tag in the Tcl string format
HexEffTagTeamcenter effectivity tag in the Tcl string format
HexEndItemTagTeamcenter end item tag in the Tcl string format
Returns
ITK_ok (=0) or list of ITK status and error message

◆ WSOM_eff_set_end_item_rev()

ITK::WSOM_eff_set_end_item_rev   HexStatusTag HexEffTag HexEndItemRevTag  

This function calls the ITK pipe server function WSOM_eff_set_end_item_rev and sets the effecitivity end item rev.

Parameters
HexStatusTagTeamcenter status tag in the Tcl string format
HexEffTagTeamcenter effectivity tag in the Tcl string format
HexEndItemRevTagTeamcenter end item revision tag in the Tcl string format
Returns
List of ITK_ok (=0) and HexEndItemRevTag or list of ITK status and error message

◆ WSOM_find2()

ITK::WSOM_find2   WorkspaceName  

This function calls the ITK pipe server function WSOM_find2 and returns list of tags of WorkspaceObjects, regardless of subclass, that have a particular name. ITK_ok returns if no error occurs during the query. This does not mean that hits will be greater than 0. That must be a separate check.

Parameters
WorkspaceName

Sample code sequence

1 set StatusInfo [::ITK::WSOM_find2 $Name]
2 if {[::ITK::isITK_ok $ITKStatus] && [llength $ITKStatus] == 1} {
3  tpwrite -mtype CONSOLE "No WorkspaceObject found!"
4 } elseif {[::ITK::isITK_ok $ITKStatus]} {
5  foreach ObjectTag [lindex $ITKStatus 1] {
6  #
7  # print-out the object_string information of the related workspace object
8  #
9  set WSOMStatus [::ITK::WSOM_ask_object_id_string $ObjectTag]
10  tpwrite -mtype CONSOLE "-> [tpco_formatHEX16 [lindex $WSOMStatus 1]]"
11  }
12 }
Returns
List of ITK_ok (=0) and list of found WorkspaceObject Tags or list of ITK status and error message

◆ WSOM_get_all_effectivities_dates()

ITK::WSOM_get_all_effectivities_dates   HexTcObjectTag  

This function calls the ITK pipe server function WSOM_get_all_effectivities_dates and gives back dates of all the effecitivities of the status.

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

◆ WSOM_get_effectivities()

ITK::WSOM_get_effectivities   HexTcObjectTag  

This function calls the ITK pipe server function WSOM_get_effectivities and gives back the effecitivities of set the status.

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

◆ WSOM_get_effectivity_dates()

ITK::WSOM_get_effectivity_dates   HexTcObjectTag HexTcEffTag  

This function calls the ITK pipe server function WSOM_get_effectivity_dates and gives back the effecitivity dates for the status.

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

◆ WSOM_get_item_rev_status_by_name()

ITK::WSOM_get_item_rev_status_by_name   HexTcObjectTag StatusName  

This function calls the ITK pipe server function WSOM_get_item_rev_status_by_name and looks for a status with given name.

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

◆ WSOM_set_description()

ITK::WSOM_set_description   HexTcObjectTag NewDesc  

This function calls the ITK pipe server function WSOM_set_description to set the description of a given workspace object.

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

◆ WSOM_set_effectivity_dates()

ITK::WSOM_set_effectivity_dates   HexTcObjectTag HexTcEffTag StartDate EndDate CreateNew  

This function calls the ITK pipe server function WSOM_set_effectivity_dates and sets the new effectivity dates for the status.

Parameters
HexTcObjectTagTeamcenter status tag in the Tcl string format
HexTcEffTagTeamcenter effectivity tag in the Tcl string format
StartDate- date format ddmmyyyy
EndDate- date format ddmmyyyy/ OPEN_END / STOCK_OUT
CreateNew= CREATE / UpdateExiting = UPDATE flag
Returns
List of ITK_ok (=0) and tag of the found status or list of ITK status and error message

◆ WSOM_set_name()

ITK::WSOM_set_name   HexTcObjectTag NewName  

This function calls the ITK pipe server function WSOM_set_name to set the name of a given workspace object.

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

◆ WSOM_where_referenced()

ITK::WSOM_where_referenced   ObjectTag Level  

This function calls the ITK pipe server function WSOM_where_referenced and get the information about referenced objects.

Parameters
ObjectTagTeamcenter status tag in the Tcl string format
Levelhow deep to check

Sample code sequence

1 set StatusInfo [::ITK::WSOM_where_referenced $ObjectTag $NoOfLevels]
2 if {[::ITK::isITK_ok $ITKStatus] && [llength $ITKStatus] == 1} {
3  tpwrite -mtype CONSOLE "No Reverences found!"
4 } elseif {[::ITK::isITK_ok $ITKStatus]} {
5  foreach ReferenceElement [lrange $ITKStatus 1 end] {
6  #
7  # print-out the level, relation and the object_string information of the related workspace object
8  #
9  set LevelId [lindex $ReferenceElement 0]
10  set ObjectTag [lindex $ReferenceElement 1]
11  set Relation [lindex $ReferenceElement 2]
12  set WSOMStatus [::ITK::WSOM_ask_object_id_string $ObjectTag]
13  tpwrite -mtype CONSOLE -stacklevel $LevelId "Level $LevelId - $Relation-> [tpco_formatHEX16 [lindex $WSOMStatus 1]]"
14  }
15 }
Returns
List of ITK_ok (=0) and for each referenced object a list with level, referencer Tag, relation name or list of ITK status and error message