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

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

Functions

 PS_ask_bom_view_of_bvr HexTcObjectTag
 This function calls the ITK pipe server function PS_ask_bom_view_of_bvr to returns the BOM view tag for the a given BOM view revision tag. More...
 
 PS_ask_view_type_name HexTcObjectTag
 This function calls the ITK pipe server function PS_ask_view_type_name to get the BOM view type name of a give view type tag. More...
 
 PS_find_view_type ViewTypeName
 This function calls the ITK pipe server function PS_find_view_type to find given BOM view type name. More...
 
 PS_list_owning_revs_of_bvr HexTcObjectTag
 This function calls the ITK pipe server function PS_list_owning_revs_of_bvr to retrieve the Item Revision tag of a given BOM view revision tag. More...
 
 PS_occ_eff_add_eff HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag
 This function calls the ITK pipe server function PS_occ_eff_add_eff to add an effectivity to the bom view revision occurrence. More...
 
 PS_occ_eff_ask_date_range HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag
 This function calls the ITK pipe server function PS_occ_eff_ask_date_range to retrieve the date range of an effectivity. More...
 
 PS_occ_eff_ask_dates HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag
 This function calls the ITK pipe server function PS_occ_eff_ask_dates to retrieve the date values of an effectivity See function "PS_occ_eff_set_dates" for possible values for EffectivityDatesType. More...
 
 PS_occ_eff_ask_effs HexBOMViewRevisionTag HexOccurrenceTag
 This function calls the ITK pipe server function PS_occ_eff_ask_effs to retrieve the effectivities of an occurrence. More...
 
 PS_occ_eff_ask_id HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag
 This function calls the ITK pipe server function PS_occ_eff_ask_id to retrieve the id of an effectivity. More...
 
 PS_occ_eff_create HexBOMViewRevisionTag HexOccurrenceTag
 This function calls the ITK pipe server function PS_occ_eff_create to create an effectivity to the bom view revision occurrence. More...
 
 PS_occ_eff_remove_eff HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag
 This function calls the ITK pipe server function PS_occ_eff_remove_eff to remove an effectivity from the bom view revision occurrence. More...
 
 PS_occ_eff_set_date_range HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityDateRange EffectivityDateAppend
 This function calls the ITK pipe server function PS_occ_eff_set_date_range to add a date range to an effectivity. Either a date range or a unit range can be assigned, not both. See function "PS_occ_eff_create" for an example. More...
 
 PS_occ_eff_set_dates HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityDatesCount EffectivityDates1 ... EffectivityDatesN
 This function calls the ITK pipe server function PS_occ_eff_set_dates to add date values to an effectivity. Either a unit range or dates can be assigned, not both. More...
 
 PS_occ_eff_set_enditemrev HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag HexEffectivityEndItemRevisionTag
 This function calls the ITK pipe server function PS_occ_eff_set_enditemrev to add an end item revision to an effectivity. See function "PS_occ_eff_create" for an example. More...
 
 PS_occ_eff_set_id HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityId
 This function calls the ITK pipe server function PS_occ_eff_set_id to add an id to an effectivity. See function "PS_occ_eff_create" for an example. More...
 
 PS_occ_eff_set_protection HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityUnitRange EffectivityProtection
 This function calls the ITK pipe server function PS_occ_eff_set_protection to change the protection setting of an effectivity. More...
 
 PS_occ_eff_set_unit_range HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityUnitRange EffectivityUnitAppend
 This function calls the ITK pipe server function PS_occ_eff_set_unit_range to add a unit range to an effectivity. Note that a unit range requires an assigned end item revision. Either a unit range or a date range can be assigned, not both. See function "PS_occ_eff_create" for an example. More...
 
 PS_replace_child HexParentBomViewRevisionTag HexOldRevisionTag HexNewRevisionTag
 This function calls the ITK pipe server function PS_replace_child to replace a item or revision in a given BOm view. More...
 
 PS_set_variant_data HexParentTag HexOccurenceTag HexVariantExpressionBlockTag
 This function calls the ITK pipe server function PS_set_variant_data to set the variant condition for this occurrence to be the specified variant expression block. More...
 
 PS_view_type_extent
 This function calls the ITK pipe server function PS_view_type_extent to get a list of all BOM view type-names. More...
 
 PS_where_used_all hex_item_rev n_levels
 This function calls the ITK pipe server function PS_where_used_all to retrieve a list of all "where used" Item Revision tags of a given Item Revision tag. More...
 
 PS_where_used_configured hex_item_rev hex_revision_rule n_levels
 This function calls the ITK pipe server function PS_where_used_configured to retrieve a list of all the Item Revisions having structure which references the specified Item Revision, in the context of the specified Revision Rule. NOTE: If preference PS_wu_configd_imprecise_only is set to true, and the specified Revision Rule contains only non-precise entries, referencing Item Revisions which are not themselves configured by the Revision Rule will be omitted. More...
 
 PS_where_used_precise hex_item_rev n_levels
 This function calls the ITK pipe server function PS_where_used_precise to retrieve a list of all the Item Revisions having structure with a precise reference to the specified Item Revision. More...
 

Detailed Description

All ITK functions of group PS supported by T4x.

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

Function Documentation

◆ PS_ask_bom_view_of_bvr()

ITK::PS_ask_bom_view_of_bvr   HexTcObjectTag  

This function calls the ITK pipe server function PS_ask_bom_view_of_bvr to returns the BOM view tag for the a given BOM view revision tag.

Parameters
HexTcObjectTag
Returns
List of ITK_ok (=0) and BOM view tag or list of ITK status and error message

◆ PS_ask_view_type_name()

ITK::PS_ask_view_type_name   HexTcObjectTag  

This function calls the ITK pipe server function PS_ask_view_type_name to get the BOM view type name of a give view type tag.

Parameters
HexTcObjectTag
Returns
List of ITK_ok (=0) and HexViewTypeName or list of ITK status and error message

Sample code sequence

1 set StatusList [::ITK::PS_ask_view_type_name $MyViewTypeTag]
2 if {[::ITK::isITK_ok $StatusList]} {
3  #ITK_ok
4  set MyViewTypeName [::ITK::getObjectValue $StatusList]
5 } else {
6  # any error
7  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
8  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
9 }

◆ PS_find_view_type()

ITK::PS_find_view_type   ViewTypeName  

This function calls the ITK pipe server function PS_find_view_type to find given BOM view type name.

Parameters
ViewTypeName
Returns
List of ITK_ok (=0) and tag of the BOM view type or list of ITK status and error message

◆ PS_list_owning_revs_of_bvr()

ITK::PS_list_owning_revs_of_bvr   HexTcObjectTag  

This function calls the ITK pipe server function PS_list_owning_revs_of_bvr to retrieve the Item Revision tag of a given BOM view revision tag.

Parameters
HexTcObjectTag
Returns
List of ITK_ok (=0) and found Item Revision tag or list of ITK status and error message

◆ PS_occ_eff_add_eff()

ITK::PS_occ_eff_add_eff   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag  

This function calls the ITK pipe server function PS_occ_eff_add_eff to add an effectivity to the bom view revision occurrence.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
Returns
OK=0 or list of ITK status and error message

◆ PS_occ_eff_ask_date_range()

ITK::PS_occ_eff_ask_date_range   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag  

This function calls the ITK pipe server function PS_occ_eff_ask_date_range to retrieve the date range of an effectivity.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
Returns
OK=0 and DateRange or list of ITK status and error message

◆ PS_occ_eff_ask_dates()

ITK::PS_occ_eff_ask_dates   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag  

This function calls the ITK pipe server function PS_occ_eff_ask_dates to retrieve the date values of an effectivity See function "PS_occ_eff_set_dates" for possible values for EffectivityDatesType.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
Returns
OK=0 and EffectivityDatesList and EffectivityDatesType or list of ITK status and error message

◆ PS_occ_eff_ask_effs()

ITK::PS_occ_eff_ask_effs   HexBOMViewRevisionTag HexOccurrenceTag  

This function calls the ITK pipe server function PS_occ_eff_ask_effs to retrieve the effectivities of an occurrence.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
Returns
OK=0 and HexEffectivityTagList or list of ITK status and error message

◆ PS_occ_eff_ask_id()

ITK::PS_occ_eff_ask_id   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag  

This function calls the ITK pipe server function PS_occ_eff_ask_id to retrieve the id of an effectivity.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
Returns
OK=0 and EffectivityId or list of ITK status and error message

◆ PS_occ_eff_create()

ITK::PS_occ_eff_create   HexBOMViewRevisionTag HexOccurrenceTag  

This function calls the ITK pipe server function PS_occ_eff_create to create an effectivity to the bom view revision occurrence.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
Returns
OK=0 and HexEffectivityTag or list of ITK status and error message

Sample code sequence

1 ...
2 
3 # Open bom window.
4 ::ITK::BOM_create_window_configured $HexItemRevisionTag $HexRevisionRuleTag $ViewType "true"
5 
6 # Set bom window to edit mode.
8 
9 # Get bom lines.
10 ::ITK::BOM_line_ask_child_lines $HexHeaderLineTag
11 
12 # Iterate on bom lines.
13 foreach BomLineTag $BomLineTagList {
14 
15  # Get data.
16  set BomLineFindNumber [string trim [tpco_formatHEX16 [lindex [::ITK::getBOMLinePropertyByName $BomLineTag "bl_sequence_no"] 1]]]
17  set HexBomLineOccurrenceTag [tpco_formatHEX16 [lindex [::ITK::getBOMLinePropertyByName $BomLineTag "bl_occurrence"] 1]]
18 
19  # Do some locks.
20  ::ITK::AOM_refresh_lock $HexBomViewTag
21  ::ITK::AOM_refresh_lock $HexBomLineOccurrenceTag
22 
23  # Create effectivity.
24  set ItkStatus [::ITK::PS_occ_eff_create $HexBomViewTag $HexBomLineOccurrenceTag]
25  set HexBomLineEffectivityTag [lindex $ItkStatus 1] ; # if call does not fail
26 
27  # Set effectivity id.
28  # - optional, but highly recommended
29  set ItkStatus [::ITK::PS_occ_eff_set_id $HexBomViewTag $HexBomLineOccurrenceTag $HexBomLineEffectivityTag $EffectivityId]
30 
31  # Set effectivity end item revision.
32  # - optional, but required when setting a unit range
33  set ItkStatus [::ITK::PS_occ_eff_set_enditemrev $HexBomViewTag $HexBomLineOccurrenceTag $HexBomLineEffectivityTag $HexEffectivityEndItemRevisionTag]
34 
35  # Set effectivity date range.
36  # - optional
37  # - either a date range or a unit range can be set, not both
38  set ItkStatus [::ITK::PS_occ_eff_set_date_range $HexBomViewTag $HexBomLineOccurrenceTag $HexBomLineEffectivityTag $EffectivityDateRange $EffectivityDateAppend]
39 
40  # Set effectivity unit range.
41  # - optional
42  # - either a date range or a unit range can be set, not both
43  # - a unit range requires an end item revision
44  set ItkStatus [::ITK::PS_occ_eff_set_unit_range $HexBomViewTag $HexBomLineOccurrenceTag $HexBomLineEffectivityTag $EffectivityUnitRange $EffectivityUnitAppend]
45 
46  # Do some saves.
47  ::ITK::AOM_save $HexBomLineEffectivityTag
48  ::ITK::AOM_save $HexBomLineOccurrenceTag
49  ::ITK::AOM_save $HexBomViewTag
50 
51  # Do some unlocks.
52  ::ITK::AOM_unlock $HexBomLineOccurrenceTag
53  ::ITK::AOM_unlock $HexBomViewTag
54 }
55 
56 # Close bom window.
57 ::ITK::BOM_close_window $BomWindowTag
58 
59 ...

◆ PS_occ_eff_remove_eff()

ITK::PS_occ_eff_remove_eff   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag  

This function calls the ITK pipe server function PS_occ_eff_remove_eff to remove an effectivity from the bom view revision occurrence.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
Returns
OK=0 or list of ITK status and error message

◆ PS_occ_eff_set_date_range()

ITK::PS_occ_eff_set_date_range   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityDateRange EffectivityDateAppend  

This function calls the ITK pipe server function PS_occ_eff_set_date_range to add a date range to an effectivity. Either a date range or a unit range can be assigned, not both. See function "PS_occ_eff_create" for an example.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
EffectivityDateRangeDate range to assign to the effectivity; example range: 16-Dec-2016 to 17-Dec-2016
EffectivityDateAppendIf "true" then the new range is added to any existing ranges, if "false" then the new range overwrites existing ranges
Returns
OK=0 or list of ITK status and error message

◆ PS_occ_eff_set_dates()

ITK::PS_occ_eff_set_dates   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityDatesCount EffectivityDates1 ... EffectivityDatesN  

This function calls the ITK pipe server function PS_occ_eff_set_dates to add date values to an effectivity. Either a unit range or dates can be assigned, not both.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
EffectivityDatesCountNumber of dates
[EffectivityDates1... EffectivityDatesN] Dates have to be specified as strings, where a "from-date" and a corresponding "to-date" have to be different date elements Examples: "2016-12-19 16:10:00", "2016-12-19 17:15:30"
EffectivityDatesTypeOne of the following integer values: 0 = EFFECTIVITY_closed 1 = EFFECTIVITY_open_ended 2 = EFFECTIVITY_stock_out If "open-ended" is used, then the number of date values should be odd, i.e. the last date should have no "closing" counterpart date
EffectivityDatesAppendIf "true" then the new ranges are added to any existing ranges, if "false" then the new ranges overwrite existing ranges
Returns
OK=0 or list of ITK status and error message

◆ PS_occ_eff_set_enditemrev()

ITK::PS_occ_eff_set_enditemrev   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag HexEffectivityEndItemRevisionTag  

This function calls the ITK pipe server function PS_occ_eff_set_enditemrev to add an end item revision to an effectivity. See function "PS_occ_eff_create" for an example.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
HexEffectivityEndItemRevisionTagEnd item revision tag to assign to the effectivity
Returns
OK=0 or list of ITK status and error message

◆ PS_occ_eff_set_id()

ITK::PS_occ_eff_set_id   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityId  

This function calls the ITK pipe server function PS_occ_eff_set_id to add an id to an effectivity. See function "PS_occ_eff_create" for an example.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
EffectivityIdId to assign to the effectivity
Returns
OK=0 or list of ITK status and error message

◆ PS_occ_eff_set_protection()

ITK::PS_occ_eff_set_protection   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityUnitRange EffectivityProtection  

This function calls the ITK pipe server function PS_occ_eff_set_protection to change the protection setting of an effectivity.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
EffectivityProtectionIf "true" then protection is set, if "false" then protection is unset
Returns
OK=0 or list of ITK status and error message

◆ PS_occ_eff_set_unit_range()

ITK::PS_occ_eff_set_unit_range   HexBOMViewRevisionTag HexOccurrenceTag HexEffectivityTag EffectivityUnitRange EffectivityUnitAppend  

This function calls the ITK pipe server function PS_occ_eff_set_unit_range to add a unit range to an effectivity. Note that a unit range requires an assigned end item revision. Either a unit range or a date range can be assigned, not both. See function "PS_occ_eff_create" for an example.

Parameters
HexBOMViewRevisionTagHexed BOM view revision tag
HexOccurrenceTagHexed occurrence tag
HexEffectivityTagHexed effectivity tag
EffectivityUnitRangeUnit range to assign to the effectivity; example range: 100-200
EffectivityUnitAppendIf "true" then the new range is added to any existing ranges, if "false" then the new range overwrites existing ranges
Returns
OK=0 or list of ITK status and error message

◆ PS_replace_child()

ITK::PS_replace_child   HexParentBomViewRevisionTag HexOldRevisionTag HexNewRevisionTag  

This function calls the ITK pipe server function PS_replace_child to replace a item or revision in a given BOm view.

Parameters
HexParentBomViewRevisionTag
HexOldRevisionTag
HexNewRevisionTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ PS_set_variant_data()

ITK::PS_set_variant_data   HexParentTag HexOccurenceTag HexVariantExpressionBlockTag  

This function calls the ITK pipe server function PS_set_variant_data to set the variant condition for this occurrence to be the specified variant expression block.

Parameters
HexParentTag
HexOccurenceTag
HexVariantExpressionBlockTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ PS_view_type_extent()

ITK::PS_view_type_extent

This function calls the ITK pipe server function PS_view_type_extent to get a list of all BOM view type-names.

Returns
List of ITK_ok (=0) and list of type names or list of ITK status and error message

Sample code sequence

1 set ViewTypeStatusInfo [::ITK::PS_view_type_extent]
2 if {[::ITK::isITK_ok $ViewTypeStatusInfo]} {
3  foreach MyViewTypeTag [lindex $ViewTypeStatusInfo 1] {
4  set StatusList [::ITK::PS_ask_view_type_name $MyViewTypeTag]
5  if {[::ITK::isITK_ok $StatusList]} {
6  #ITK_ok
7  puts "[::ITK::getObjectValue $StatusList]"
8  } else {
9  # any error
10  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
11  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
12  }
13  }
14 } else {
15  # any error
16  set ErrorNumber [::ITK::getITKStatusNumber $ViewTypeStatusInfo]
17  set ErrorMesssage [::ITK::getErrorMessage4Status $ViewTypeStatusInfo]
18 }

◆ PS_where_used_all()

ITK::PS_where_used_all   hex_item_rev n_levels  

This function calls the ITK pipe server function PS_where_used_all to retrieve a list of all "where used" Item Revision tags of a given Item Revision tag.

Parameters
hex_item_rev
n_levelsnumber of BOM levels to check
Returns
List of ITK_ok (=0) and a list of found Level/Item Revision tag or list of ITK status and error message e.g. 0 {{level tag} {level tag} {level tag} {level tag} ...}

◆ PS_where_used_configured()

ITK::PS_where_used_configured   hex_item_rev hex_revision_rule n_levels  

This function calls the ITK pipe server function PS_where_used_configured to retrieve a list of all the Item Revisions having structure which references the specified Item Revision, in the context of the specified Revision Rule. NOTE: If preference PS_wu_configd_imprecise_only is set to true, and the specified Revision Rule contains only non-precise entries, referencing Item Revisions which are not themselves configured by the Revision Rule will be omitted.

Parameters
hex_item_rev
hex_revision_rule
n_levels,numberof BOM levels to check
Returns
List of ITK_ok (=0) and a list of found Level/Item Revision tag or list of ITK status and error message e.g. 0 {{level tag} {level tag} {level tag} {level tag} ...}

◆ PS_where_used_precise()

ITK::PS_where_used_precise   hex_item_rev n_levels  

This function calls the ITK pipe server function PS_where_used_precise to retrieve a list of all the Item Revisions having structure with a precise reference to the specified Item Revision.

Parameters
hex_item_rev
n_levels,numberof BOM levels to check
Returns
List of ITK_ok (=0) and a list of found Level/Item Revision tag or list of ITK status and error message e.g. 0 {{level tag} {level tag} {level tag} {level tag} ...}