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

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

Functions

 BOM_add_option_rev_value HexOptionRevTag OptionValue
 This function calls the ITK pipe server function BOM_add_option_rev_value to add a new allowed value to the option revision. More...
 
 BOM_ask_option_data HexOptionTag
 This function calls the ITK pipe server function BOM_ask_option_data Returns the data stored in an option. More...
 
 BOM_ask_option_rev_value HexOptionRevTag OptionIndex
 This function calls the ITK pipe server function BOM_ask_option_rev_value Translates the specified index value into the corresponding text. More...
 
 BOM_ask_window_top BomWindowTag
 This function calls the ITK pipe server function BOM_ask_window_top to get the top BOM line tag. More...
 
 BOM_close_window BomWindowTag
 This function calls the ITK pipe server function BOM_close_window to close the BOM window it also calls BOM_save_window if the optional parameter -nosave is not specified. More...
 
 BOM_create_bom_view_window HexItemRevisionTag args
 This function calls the ITK pipe server function BOM_create_bom_view_window to create a new BOM view revision for a given Item Revision. More...
 
 BOM_create_bomline_variant_config bom_line_tag
 This function calls the ITK pipe server function BOM_create_bomline_variant_config Used mode is BOM_option_set_by_user. More...
 
 BOM_create_window
 This function calls the ITK pipe server function BOM_create_window. More...
 
 BOM_create_window_configured HexItemRevTag HexRevRuleTag ViewName UnpackAllBOMLines
 calls the BOM_create_window_configured on the server More...
 
 BOM_declare_option HexItemRevTag HexOptionRevTag
 This function calls the ITK pipe server function BOM_declare_option to declare the given Option Revision against the given Item Revision. More...
 
 BOM_line_add BomLineTag HexItemTagTag HexItemRevisionTag HexBomViewTag
 This function calls the ITK pipe server function BOM_line_add to add new BOM line to a given BOM line. More...
 
 BOM_line_add_absocc_relation HexBomLineTag HexRelationTypeTag HexSecondaryObjectTag
 This function calls the ITK pipe server function BOM_line_add_absocc_relation to add a secondary object to a bomline. More...
 
 BOM_line_add_substitute BomLineTag HexSubstituteItemTag HexSubstituteItemRevisionTag HexSubstituteBomViewTag
 This function calls the ITK pipe server function BOM_line_add_substitute to add a BOM line substitute to a given BOM line. More...
 
 BOM_line_add_with_occ_type BomLineTag HexItemTagTag HexItemRevisionTag HexBomViewTag HexOCCType
 Adds a new component to a given line. Only enough of item, item_revision, bv and bvr need be given to identify the component. The window's configuration rules will be applied to determine the rest. If item_revision is given, then a precise occurrence will be created. More...
 
 BOM_line_ask_attribute HexBomLinePUID AttributeName
 calls the BOM_line_ask_attribute on the server More...
 
 BOM_line_ask_child_lines HexBomLinePUIDs
 calls BOM_line_ask_child_lines to list the lines below the specified parent line. The first time this function is called it will load the components from the database. More...
 
 BOM_line_ask_packed_lines BOMLineTag
 Lists any lines packed into this one. It is not an error to call this for a line that has no lines packed into it. More...
 
 BOM_line_ask_sos bom_line_tag
 This function calls the ITK pipe server function BOM_line_ask_sos Ask the BOM line for its current SOS - or selected option set. More...
 
 BOM_line_cut BomLineTag
 This function calls the ITK pipe server function BOM_line_cut to delete an existing BOM line. More...
 
 BOM_line_define_option TopLineTag HexOptionText
 This function calls the ITK pipe server function BOM_line_define_option Needs an open BOM window. Within this window, creates or updates a modular option with the option data specified as option text. More...
 
 BOM_line_delete_option TopLineTag OptionId
 This function calls the ITK pipe server function BOM_line_delete_option Needs an open BOM window. Within this window, deletes a modular option. More...
 
 BOM_line_hide_substitutes BomLinePUID
 calls BOM_line_hide_substitutes to sets the preferred substitute BOM line to hide its non-preferred substitutes More...
 
 BOM_line_is_packed BOMLineTag
 Checks if the BOM Line is packed. More...
 
 BOM_line_list_substitutes HexBomLinePUID
 calls BOM_line_list_substitutes to return a list of substitutes for a given BOMLine. More...
 
 BOM_line_pack BOMLineTag
 Scans all sibling BOM lines in the same parent to see if any can be packed with the specified line. If they are, they are packed into this line. Subsequent calls to BOM_line_ask_child_lines on the parent only list this line; none of the ones packed into it. It is not an error if no lines are found to pack into this one. Trying to pack the top line of a bill is not an error, but does nothing (it has no siblings). More...
 
 BOM_line_prefer_substitute BomLineTag
 This function calls the ITK pipe server function BOM_line_prefer_substitute to set the non-preferred substitute BOM line to be the preferred substitute. The current preferred substitute becomes non-preferred. More...
 
 BOM_line_replace BomLineTag HexItemTagTag HexItemRevisionTag HexBomViewTag
 This function calls the ITK pipe server function BOM_line_replace to replace the Item or ItemRevision to a given BOM line. More...
 
 BOM_line_set_precise HexBomLineTag OnOffFlag
 This function calls the ITK pipe server function BOM_line_set_precise to set modify the Precise/Imprecise flag of a BOM line. More...
 
 BOM_line_show_substitutes BomLinePUIDs
 calls BOM_line_show_substitutes to sets the preferred substitute BOM line to display its non-preferred substitutes More...
 
 BOM_line_unpack BOMLineTag
 Unpacks any lines packed into this line. It is not an error to call this for a line that has no lines packed into it. More...
 
 BOM_list_option_rev_values HexOptionTag
 This function calls the ITK pipe server function BOM_list_option_rev_values Returns the allowed index values for this option revision if option values get deleted then their index values do not get reused so the list of index values is the list of current ones. More...
 
 BOM_module_ask_option_text OptionId
 This function calls the ITK pipe server function BOM_module_ask_option_text Needs an open BOM window. Within this window, retrieves the data of a modular option as option text. More...
 
 BOM_module_list_options WindowTag ModuleId
 This function calls the ITK pipe server function BOM_module_list_options Needs an opened BOM window. Within this window, retrieves the modular options. More...
 
 BOM_new_option HexItemRevTag OptionName OptionDescription Mode
 This function calls the ITK pipe server function BOM_new_option to create a new classic (legacy) option with an initial empty revision, and declare the new option against the given Item Revision. More...
 
 BOM_new_variant_e_block
 This function calls the ITK pipe server function BOM_new_variant_e_block to return a newly-created variant expression block. More...
 
 BOM_option_ask_allowed_ints OptionId
 This function calls the ITK pipe server function BOM_option_ask_allowed_ints Needs an open BOM window. Within this window, retrieves the values of a modular integer option. More...
 
 BOM_option_ask_allowed_reals OptionId
 This function calls the ITK pipe server function BOM_option_ask_allowed_reals Needs an open BOM window. Within this window, retrieves the values of a modular real option. More...
 
 BOM_option_ask_allowed_strings OptionId
 This function calls the ITK pipe server function BOM_option_ask_allowed_strings Needs an open BOM window. Within this window, retrieves the values of a modular string option. More...
 
 BOM_option_describe OptionId
 This function calls the ITK pipe server function BOM_option_describe Needs an open BOM window. Within this window, retrieves the data of a modular option. More...
 
 BOM_refresh_window BomWindowTag
 This function calls the ITK pipe server function BOM_refresh_window to refresh the BOM window. More...
 
 BOM_remove_option_rev_value HexOptionRevTag OptionValueIndex
 This function calls the ITK pipe server function BOM_remove_option_rev_value to remove an allowed value from the option revision. More...
 
 BOM_revise_option HexOptionRevTag
 This function calls the ITK pipe server function BOM_declare_option to Copy an option revision to a new revision. More...
 
 BOM_save_window BomWindowTag
 This function calls the ITK pipe server function BOM_save_window to save the BOM window. More...
 
 BOM_set_option_data HexOptionTag OptionName HexOptionDescription
 This function calls the ITK pipe server function BOM_set_option_data Stores the data into an option. More...
 
 BOM_set_variant_e_block HexVariantExpressionBlockTag VariantExpressionTag1 ... VariantExpressionTagX
 This function calls the ITK pipe server function BOM_set_variant_e_block to set an variant expression block. More...
 
 BOM_set_window_pack_all WindowTag PackAll
 Sets a flag to say whether BOM lines are packed by default. By default all BOM lines are reported. If this function is called to set the default packing true, then packable lines will be reported as one BOM line. Individual lines can be packed or unpacked by calling BOM_line_pack or BOM_line_unpack, respectively. More...
 
 BOM_set_window_top_line bom_window_tag RevisionTag
 This function calls the ITK pipe server function BOM_set_window_top_line. More...
 
 BOM_sos_apply bom_sos_tag update
 This applies the SOS to its associated BOMLine. The structure will be evaluated and any changes will be reflected in this SOS. This also makes this SOS the current one for the bom line. More...
 
 BOM_sos_ask_entries sos_tag
 This function calls the ITK pipe server function BOM_sos_ask_entries. More...
 
 BOM_sos_ask_entry_display line_sos_tag option path
 This function calls the ITK pipe server function BOM_sos_ask_entry_display. More...
 
 BOM_sos_db_create db_sos_name bom_variant_config_tag
 This function calls the ITK pipe server function BOM_sos_db_create. More...
 
 BOM_sos_set_entry_string line_sos_tag option path value how_set
 This function calls the ITK pipe server function BOM_sos_set_entry_string. More...
 
 BOM_variant_clause_append HexClauseListTag HexOptionTag JoinFlag Comparison OptionValue
 This function calls the ITK pipe server function BOM_variant_clause_append to append a new clause onto the end of a clause list. More...
 
 BOM_variant_clause_list_size HexClauseListTag NumberOfClauses
 This function calls the ITK pipe server function BOM_variant_clause_list_size Returns the number of clauses in a clause list. More...
 
 BOM_variant_clause_toggle_brackets HexClauseListTag NumberOfClauses ListOfClausesPositions
 This function calls the ITK pipe server function BOM_variant_clause_toggle_brackets Toggles a pair of brackets around a given set of clauses in a clause list (i.e., if a matching pair of brackets already exists around the selected clauses, the brackets will be removed. Otherwise, a new set of brackets will be inserted). More...
 
 BOM_variant_delete_clause_list HexClauseListTag
 This function calls the ITK pipe server function BOM_variant_delete_clause_list to delete a clause_list. More...
 
 BOM_variant_delete_clause_list HexOccurenceTag HexVariantExpressionBlockTag
 This function calls the ITK pipe server function BOM_line_set_variant_e_block to set the variant condition for this occurrence to be the specified variant expression block. More...
 
 BOM_variant_expr_load_if HexConditionVariantExpressionTag
 This function calls the ITK pipe server function BOM_variant_expr_load_if to create a "load if" type Variant Expression which can be attached to a BOM Line. More...
 
 BOM_variant_join_clause_list HexClauseListTag
 This function calls the ITK pipe server function BOM_variant_join_clause_list to create a new condition Variant Expression from the clause list. More...
 
 BOM_variant_new_clause_list WindowTag
 This function calls the ITK pipe server function BOM_variant_new_clause_list to create a new empty clause list. This is used to create a new variant condition. More...
 
 BOM_variant_rule_apply HexBOMVariantListTag
 This function calls the ITK pipe server function BOM_variant_rule_apply Applies the given BOM variant rule to its owning BOM window. More...
 
 BOM_variant_rule_ask_option_rev HexBOMVariantListTag HexItemTag
 This function calls the ITK pipe server function BOM_variant_rule_ask_option_rev Returns the option revision for the given option as configured in the given BOM variant rule. More...
 
 BOM_variant_rule_ask_options HexBOMVariantListTag
 This function calls the ITK pipe server function BOM_variant_rule_ask_options Returns the list of options and their revisions referenced by the given BOM variant rule. More...
 
 BOM_variant_rule_clear_option_values HexBOMVariantListTag
 This function calls the ITK pipe server function BOM_variant_rule_clear_option_values Unsets all the option values in the given BOM variant rule, and unloads the saved variant rule if you have one loaded. More...
 
 BOM_variant_rule_evaluate HexBOMVariantListTag
 This function calls the ITK pipe server function BOM_variant_rule_evaluate Evaluates the given BOM variant rule. This will set option defaults, derived values and perform option rule checks. More...
 
 BOM_variant_rule_find_option HexBOMVariantListTag HexItemTag OptionName
 This function calls the ITK pipe server function BOM_variant_rule_find_option Searches for an option with the specified name. If an item is specified then it will search for the option attached to that item. If the hexitemtag is "", then it will search for the option in the specified BOM variant rule. If it cannot find the option in the rule, then it will search the entire database. If more than one option is found with the same name then an error will occur. More...
 
 BOM_variant_rule_find_options HexBOMVariantListTag HexItemTag OptionName
 This function calls the ITK pipe server function BOM_variant_rule_find_options If both an OptionName and an HexItemTag is specified then it will search for the named option attached to that item. If the HexItemTag is "", then it will search for the option in the specified BOM variant rule. If it cannot find the option in the rule (or if the rule is NULLTAG), then it will search the entire database. If the OptionName is "" then it will return all options attached to the given item, or rule if the item is NULLTAG. More...
 
 BOM_variant_rule_set_option_value HexBOMVariantListTag HexOptionTag OptionIndex
 This function calls the ITK pipe server function BOM_variant_rule_set_option_value Sets the option to the given value in the BOM variant rule (index into the enumerated list of allowed values) More...
 
 BOM_window_apply_full_vrule WindowTag VariantRuleTag
 This function calls the ITK pipe server function BOM_window_apply_full_vrule sets the given variant rule to be the current rule for the given BOM window. This call unsets all existing option values prior to loading the new values defined by the rule. More...
 
 BOM_window_ask_options WindowTag
 This function calls the ITK pipe server function BOM_window_ask_options Asks for the set of options referenced by the bill being displayed in the specified window. More...
 
 BOM_window_ask_variant_rule WindowTag
 This function calls the ITK pipe server function BOM_window_ask_variant_rule Returns the current BOM variant rule for the given BOM Window. More...
 
 BOM_window_ask_variant_rules BomWindowTag
 This function calls the ITK pipe server function BOM_window_ask_variant_rules Returns the list of configured BOM variant rule for the given BOM Window. More...
 
 BOM_window_find_option WindowTag HexItemTag OptionName
 This function calls the ITK pipe server function BOM_window_find_option to look in the database for an option with the specified name. More...
 
 BOM_window_hide_substitutes BomWindowPUID
 calls BOM_window_hide_substitutes to hide the substitutes of the given BOM window. More...
 
 BOM_window_set_absocc_edit_mode WindowTag absOccEditMode
 This function calls the ITK pipe server function BOM_window_set_absocc_edit_mode to set the absolute occurence context. More...
 
 BOM_window_set_option_value WindowTag HexOptionTag HexOptionValue
 This function calls the ITK pipe server function BOM_window_set_option_value Within this window, sets the option to said value. More...
 
 BOM_window_show_substitutes BomWindowPUID
 calls BOM_window_show_substitutes to display the substitutes of the given BOM window. More...
 
 BOMLINE_addbomline_occurrence_notes_with_window HexBomViewRevisionTag BomWindowTag HexItemRevisionTag args
 This function calls the ITK pipe server function BOMLINE_addbomline_occurrence_notes_with_window to add new BOM line to a given BOM window. More...
 
 BOMLINE_cutbomline HexBomLineTag
 This function calls the ITK pipe server function BOM_line_cut to delete an existing BOM line. More...
 
 BOMLINE_update_occurrence_notes BomLineTag args
 This function calls the ITK pipe server function BOMLINE_update_occurrence_notes to updates the occurrence for a given BOM line. More...
 

Detailed Description

All ITK functions of group BOM supported by T4x.

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

Function Documentation

◆ BOM_add_option_rev_value()

ITK::BOM_add_option_rev_value   HexOptionRevTag OptionValue  

This function calls the ITK pipe server function BOM_add_option_rev_value to add a new allowed value to the option revision.

Parameters
HexOptionRevTag
OptionValue
Returns
list of ITK_ok (=0) and OptionIndex or list of ITK status and error message

◆ BOM_ask_option_data()

ITK::BOM_ask_option_data   HexOptionTag  

This function calls the ITK pipe server function BOM_ask_option_data Returns the data stored in an option.

Parameters
HexOptionTag
Returns
list of ITK_ok (=0) and HexOwningItemTag HexOptionName HexOptionDescription (if Name or Descr are NULL they will be left out) or list of ITK status and error message

◆ BOM_ask_option_rev_value()

ITK::BOM_ask_option_rev_value   HexOptionRevTag OptionIndex  

This function calls the ITK pipe server function BOM_ask_option_rev_value Translates the specified index value into the corresponding text.

Parameters
HexOptionRevTag
OptionIndex- NOT hexed
Returns
list of ITK_ok (=0) hexed indexNumbers or list of ITK status and error message

◆ BOM_ask_window_top()

ITK::BOM_ask_window_top   BomWindowTag  

This function calls the ITK pipe server function BOM_ask_window_top to get the top BOM line tag.

Parameters
BomWindowTagTag representation of the BOM window
Returns
List of ITK_ok (=0) and tag of the top BOM line or list of ITK status and error message

◆ BOM_close_window()

ITK::BOM_close_window   BomWindowTag  

This function calls the ITK pipe server function BOM_close_window to close the BOM window it also calls BOM_save_window if the optional parameter -nosave is not specified.

Parameters
BomWindowTagTag representation of the BOM window
-nosaveoptional parameter that disables the automatic save of the BOM window
Returns
ITK_ok (=0) or list of ITK status and error message
Warning
The default behavior is use call a BOM_save_window before the BOM window is closed this will a have an impact on the performances if you just open the BOM window for reading the data. If you don't want to store changes on the BOM window you need to specify the -nosave parameter.

◆ BOM_create_bom_view_window()

ITK::BOM_create_bom_view_window   HexItemRevisionTag args  

This function calls the ITK pipe server function BOM_create_bom_view_window to create a new BOM view revision for a given Item Revision.

Parameters
HexItemRevisionTag
args(optional value), BOMviewTypeTag if this argument is not specified the function will create the default BOM view type.
Returns
List of ITK_ok (=0) and tag of the BOM window or list of ITK status and error message

◆ BOM_create_bomline_variant_config()

ITK::BOM_create_bomline_variant_config   bom_line_tag  

This function calls the ITK pipe server function BOM_create_bomline_variant_config Used mode is BOM_option_set_by_user.

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

◆ BOM_create_window()

ITK::BOM_create_window

This function calls the ITK pipe server function BOM_create_window.

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

◆ BOM_create_window_configured()

ITK::BOM_create_window_configured   HexItemRevTag HexRevRuleTag ViewName UnpackAllBOMLines  

calls the BOM_create_window_configured on the server

Parameters
HexItemRevTag
HexRevRuleTag
ViewName
UnpackAllBOMLines(unpack if 1st character is "t" or "T", else packed)
Returns
list of ITK_ok (=0) and list with BOM_window und top_bomline_tag or list of error code and error message

◆ BOM_declare_option()

ITK::BOM_declare_option   HexItemRevTag HexOptionRevTag  

This function calls the ITK pipe server function BOM_declare_option to declare the given Option Revision against the given Item Revision.

Parameters
HexItemRevTag
HexOptionRevTag
Returns
list of ITK_ok (=0) and HexVariantExprTag HexVariantExprRevTag or list of ITK status and error message

◆ BOM_line_add()

ITK::BOM_line_add   BomLineTag HexItemTagTag HexItemRevisionTag HexBomViewTag  

This function calls the ITK pipe server function BOM_line_add to add new BOM line to a given BOM line.

Parameters
BomLineTag
HexItemTagTag
HexItemRevisionTag
HexBomViewTag
Returns
ITK_ok (=0) and new BOM line tag or list of ITK status and error message

◆ BOM_line_add_absocc_relation()

ITK::BOM_line_add_absocc_relation   HexBomLineTag HexRelationTypeTag HexSecondaryObjectTag  

This function calls the ITK pipe server function BOM_line_add_absocc_relation to add a secondary object to a bomline.

Parameters
HexBomLineTagTag of bom top line
HexRelationTypeTagTag of relation type
HexSecondaryObjectTagTag of secondary object
Returns
list of ITK_ok (=0) and HexRelationTag or list of ITK status and error message

◆ BOM_line_add_substitute()

ITK::BOM_line_add_substitute   BomLineTag HexSubstituteItemTag HexSubstituteItemRevisionTag HexSubstituteBomViewTag  

This function calls the ITK pipe server function BOM_line_add_substitute to add a BOM line substitute to a given BOM line.

Parameters
BomLineTag
HexSubstituteItemTagUse "NULLTAG" if not needed
HexSubstituteItemRevisionTagUse "NULLTAG" if not needed
HexSubstituteBomViewTagUse "NULLTAG" if not needed
Returns
ITK_ok (=0) and BomSubstituteLineTag or list of ITK status and error message

◆ BOM_line_add_with_occ_type()

ITK::BOM_line_add_with_occ_type   BomLineTag HexItemTagTag HexItemRevisionTag HexBomViewTag HexOCCType  

Adds a new component to a given line. Only enough of item, item_revision, bv and bvr need be given to identify the component. The window's configuration rules will be applied to determine the rest. If item_revision is given, then a precise occurrence will be created.

Parameters
BomLineTag
HexItemTagTag
HexItemRevisionTag
HexBomViewTag
HexOCCType- String
Returns
ITK_ok (=0) and new BOM line tag or list of ITK status and error message

◆ BOM_line_ask_attribute()

ITK::BOM_line_ask_attribute   HexBomLinePUID AttributeName  

calls the BOM_line_ask_attribute on the server

Returns
list of ITK_ok (=0) and Value of the OccurrenceNote as hexed String or errorcode
Parameters
HexBomLinePUID
AttributeName

◆ BOM_line_ask_child_lines()

ITK::BOM_line_ask_child_lines   HexBomLinePUIDs  

calls BOM_line_ask_child_lines to list the lines below the specified parent line. The first time this function is called it will load the components from the database.

Returns
list of ITK_ok (=0) and list with child_bomline_tags or list of error code and error message
Parameters
HexBomLinePUID

◆ BOM_line_ask_packed_lines()

ITK::BOM_line_ask_packed_lines   BOMLineTag  

Lists any lines packed into this one. It is not an error to call this for a line that has no lines packed into it.

Parameters
BOMLineTagTag of the line to ask pack lines of
Returns
list of ITK_ok (=0) or list of error code and error message

◆ BOM_line_ask_sos()

ITK::BOM_line_ask_sos   bom_line_tag  

This function calls the ITK pipe server function BOM_line_ask_sos Ask the BOM line for its current SOS - or selected option set.

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

◆ BOM_line_cut()

ITK::BOM_line_cut   BomLineTag  

This function calls the ITK pipe server function BOM_line_cut to delete an existing BOM line.

Parameters
BomLineTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_line_define_option()

ITK::BOM_line_define_option   TopLineTag HexOptionText  

This function calls the ITK pipe server function BOM_line_define_option Needs an open BOM window. Within this window, creates or updates a modular option with the option data specified as option text.

Parameters
TopLineTag
HexOptionText
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_line_delete_option()

ITK::BOM_line_delete_option   TopLineTag OptionId  

This function calls the ITK pipe server function BOM_line_delete_option Needs an open BOM window. Within this window, deletes a modular option.

Parameters
TopLineTag
OptionId
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_line_hide_substitutes()

ITK::BOM_line_hide_substitutes   BomLinePUID  

calls BOM_line_hide_substitutes to sets the preferred substitute BOM line to hide its non-preferred substitutes

Returns
list of ITK_ok (=0) or list of error code and error message
Parameters
BomLinePUID

◆ BOM_line_is_packed()

ITK::BOM_line_is_packed   BOMLineTag  

Checks if the BOM Line is packed.

Parameters
BOMLineTagthe tag of the line to ask for state
Returns
list of ITK_ok (=0) and logical or list of error code and error message

◆ BOM_line_list_substitutes()

ITK::BOM_line_list_substitutes   HexBomLinePUID  

calls BOM_line_list_substitutes to return a list of substitutes for a given BOMLine.

Returns
list of ITK_ok (=0) and list with substitute_bomline_tags or list of error code and error message
Parameters
HexBomLinePUID

◆ BOM_line_pack()

ITK::BOM_line_pack   BOMLineTag  

Scans all sibling BOM lines in the same parent to see if any can be packed with the specified line. If they are, they are packed into this line. Subsequent calls to BOM_line_ask_child_lines on the parent only list this line; none of the ones packed into it. It is not an error if no lines are found to pack into this one. Trying to pack the top line of a bill is not an error, but does nothing (it has no siblings).

Parameters
BOMLineTagTag of the line, which will be asked for pack lines
Returns
list of ITK_ok (=0) list of error code and error message

◆ BOM_line_prefer_substitute()

ITK::BOM_line_prefer_substitute   BomLineTag  

This function calls the ITK pipe server function BOM_line_prefer_substitute to set the non-preferred substitute BOM line to be the preferred substitute. The current preferred substitute becomes non-preferred.

If the parent BOM View Revision cannot be modified, the change cannot be saved and the change is marked as temporary (Temporary=true). Else, the change is marked as non-temporary (Temporary=false).

Parameters
BomLineTag
Returns
ITK_ok (=0) and Temporary or list of ITK status and error message

◆ BOM_line_replace()

ITK::BOM_line_replace   BomLineTag HexItemTagTag HexItemRevisionTag HexBomViewTag  

This function calls the ITK pipe server function BOM_line_replace to replace the Item or ItemRevision to a given BOM line.

Parameters
BomLineTag
HexItemTagTag
HexItemRevisionTag
HexBomViewTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_line_set_precise()

ITK::BOM_line_set_precise   HexBomLineTag OnOffFlag  

This function calls the ITK pipe server function BOM_line_set_precise to set modify the Precise/Imprecise flag of a BOM line.

Parameters
HexBomLineTag
OnOffFlag,false/FALSE== off; true/TRUE == on
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_line_show_substitutes()

ITK::BOM_line_show_substitutes   BomLinePUIDs  

calls BOM_line_show_substitutes to sets the preferred substitute BOM line to display its non-preferred substitutes

Returns
list of ITK_ok (=0) or list of error code and error message
Parameters
BomLinePUID

◆ BOM_line_unpack()

ITK::BOM_line_unpack   BOMLineTag  

Unpacks any lines packed into this line. It is not an error to call this for a line that has no lines packed into it.

Parameters
BOMLineTagTag of the line to unpack lines from
Returns
list of ITK_ok (=0) or list of error code and error message

◆ BOM_list_option_rev_values()

ITK::BOM_list_option_rev_values   HexOptionTag  

This function calls the ITK pipe server function BOM_list_option_rev_values Returns the allowed index values for this option revision if option values get deleted then their index values do not get reused so the list of index values is the list of current ones.

Parameters
HexOptionRevTag
Returns
list of ITK_ok (=0) indexNumbers or list of ITK status and error message

◆ BOM_module_ask_option_text()

ITK::BOM_module_ask_option_text   OptionId  

This function calls the ITK pipe server function BOM_module_ask_option_text Needs an open BOM window. Within this window, retrieves the data of a modular option as option text.

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

◆ BOM_module_list_options()

ITK::BOM_module_list_options   WindowTag ModuleId  

This function calls the ITK pipe server function BOM_module_list_options Needs an opened BOM window. Within this window, retrieves the modular options.

Parameters
WindowTag
ModuleId
Returns
List of ITK_ok (=0) and OptionIdList or list of ITK status and error message

◆ BOM_new_option()

ITK::BOM_new_option   HexItemRevTag OptionName OptionDescription Mode  

This function calls the ITK pipe server function BOM_new_option to create a new classic (legacy) option with an initial empty revision, and declare the new option against the given Item Revision.

Parameters
HexItemRevTag
OptionName
OptionDescription
Mode- ENUM /INT
Returns
list of ITK_ok (=0) and HexOptionTag HexOptionRevTag HexVariantExprTag HexVariantExprRevTag or list of ITK status and error message

◆ BOM_new_variant_e_block()

ITK::BOM_new_variant_e_block

This function calls the ITK pipe server function BOM_new_variant_e_block to return a newly-created variant expression block.

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

◆ BOM_option_ask_allowed_ints()

ITK::BOM_option_ask_allowed_ints   OptionId  

This function calls the ITK pipe server function BOM_option_ask_allowed_ints Needs an open BOM window. Within this window, retrieves the values of a modular integer option.

Parameters
OptionId
Returns
List of ITK_ok (=0) and list of MinOptionValueList, MaxOptionValueList, RangeTypeOptionValueList, OptionDefaultValue or list of ITK status and error message

◆ BOM_option_ask_allowed_reals()

ITK::BOM_option_ask_allowed_reals   OptionId  

This function calls the ITK pipe server function BOM_option_ask_allowed_reals Needs an open BOM window. Within this window, retrieves the values of a modular real option.

Parameters
OptionId
Returns
List of ITK_ok (=0) and list of MinOptionValueList, MaxOptionValueList, RangeTypeOptionValueList, OptionDefaultValue or list of ITK status and error message

◆ BOM_option_ask_allowed_strings()

ITK::BOM_option_ask_allowed_strings   OptionId  

This function calls the ITK pipe server function BOM_option_ask_allowed_strings Needs an open BOM window. Within this window, retrieves the values of a modular string option.

Parameters
OptionId
Returns
List of ITK_ok (=0) and list of HexOptionValueList, HexOptionDefaultValue or list of ITK status and error message

◆ BOM_option_describe()

ITK::BOM_option_describe   OptionId  

This function calls the ITK pipe server function BOM_option_describe Needs an open BOM window. Within this window, retrieves the data of a modular option.

Parameters
OptionId
Returns
List of ITK_ok (=0) and list with ModuleId, HexOptionName, OptionVisibility, OptionType, OptionValueType, OptionBasedOn, OptionHasDefault, HexOptionDescription or list of ITK status and error message

◆ BOM_refresh_window()

ITK::BOM_refresh_window   BomWindowTag  

This function calls the ITK pipe server function BOM_refresh_window to refresh the BOM window.

Parameters
BomWindowTagTag representation of the BOM window
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_remove_option_rev_value()

ITK::BOM_remove_option_rev_value   HexOptionRevTag OptionValueIndex  

This function calls the ITK pipe server function BOM_remove_option_rev_value to remove an allowed value from the option revision.

Parameters
HexOptionRevTag
OptionValueIndex
Returns
ITK status or list of ITK status and error message

◆ BOM_revise_option()

ITK::BOM_revise_option   HexOptionRevTag  

This function calls the ITK pipe server function BOM_declare_option to Copy an option revision to a new revision.

Parameters
HexOptionRevTag
Returns
list of ITK_ok (=0) and HexOptionRevTag or list of ITK status and error message

◆ BOM_save_window()

ITK::BOM_save_window   BomWindowTag  

This function calls the ITK pipe server function BOM_save_window to save the BOM window.

Parameters
BomWindowTagTag representation of the BOM window
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_set_option_data()

ITK::BOM_set_option_data   HexOptionTag OptionName HexOptionDescription  

This function calls the ITK pipe server function BOM_set_option_data Stores the data into an option.

Parameters
HexOptionTag
OptionName
HexOptionDescription
Returns
ITK status or list of ITK status and error message

◆ BOM_set_variant_e_block()

ITK::BOM_set_variant_e_block   HexVariantExpressionBlockTag VariantExpressionTag1 ... VariantExpressionTagX  

This function calls the ITK pipe server function BOM_set_variant_e_block to set an variant expression block.

Parameters
HexVariantExpressionBlockTag
VariantExpressionTag1... VariantExpressionTagX
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_set_window_pack_all()

ITK::BOM_set_window_pack_all   WindowTag PackAll  

Sets a flag to say whether BOM lines are packed by default. By default all BOM lines are reported. If this function is called to set the default packing true, then packable lines will be reported as one BOM line. Individual lines can be packed or unpacked by calling BOM_line_pack or BOM_line_unpack, respectively.

Parameters
WindowTagWindow to have its default packing set
PackAlllogical true or false
Returns
list of ITK_ok (=0) or list of error code and error message

◆ BOM_set_window_top_line()

ITK::BOM_set_window_top_line   bom_window_tag RevisionTag  

This function calls the ITK pipe server function BOM_set_window_top_line.

Parameters
bom_window_tag
RevisionTag
Returns
List of ITK_ok (=0) and top_line_tag or list of ITK status and error message

◆ BOM_sos_apply()

ITK::BOM_sos_apply   bom_sos_tag update  

This applies the SOS to its associated BOMLine. The structure will be evaluated and any changes will be reflected in this SOS. This also makes this SOS the current one for the bom line.

Parameters
bom_sos_tag
update- T/t/TRUE/true/True are valid as update otherwise the value is set to false
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_sos_ask_entries()

ITK::BOM_sos_ask_entries   sos_tag  

This function calls the ITK pipe server function BOM_sos_ask_entries.

Parameters
sos_tag
Returns
List of ITK_ok (=0) and pair wise list of options and paths or list of ITK status and error message

◆ BOM_sos_ask_entry_display()

ITK::BOM_sos_ask_entry_display   line_sos_tag option path  

This function calls the ITK pipe server function BOM_sos_ask_entry_display.

Parameters
line_sos_tag
option- int
path- string
Returns
List of ITK_ok (=0), value and how_set mode or list of ITK status and error message

◆ BOM_sos_db_create()

ITK::BOM_sos_db_create   db_sos_name bom_variant_config_tag  

This function calls the ITK pipe server function BOM_sos_db_create.

Parameters
db_sos_name
bom_variant_config_tag
Returns
List of ITK_ok (=0) and db_sos_tag or list of ITK status and error message

◆ BOM_sos_set_entry_string()

ITK::BOM_sos_set_entry_string   line_sos_tag option path value how_set  

This function calls the ITK pipe server function BOM_sos_set_entry_string.

Parameters
line_sos_tag
option- int
path- string
value- string
how_set- BOM_option_unset BOM_option_unset_derivable BOM_option_derived BOM_option_defaulted BOM_option_set_by_user BOM_option_set_by_rule BOM_option_fixed BOM_option_fixed_by_user BOM_option_variant_item BOM_option_external
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_variant_clause_append()

ITK::BOM_variant_clause_append   HexClauseListTag HexOptionTag JoinFlag Comparison OptionValue  

This function calls the ITK pipe server function BOM_variant_clause_append to append a new clause onto the end of a clause list.

Parameters
HexClauseListTag
HexOptionTag
JoinFlag- AND /OR
Comparison-IS_EQUAL / NOT_EQUAL / LESS_THEN / MORE_THEN / EQUAL_OR_LESS_THEN / EQUAL_OR_MORE_THEN
OptionValue
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_variant_clause_list_size()

ITK::BOM_variant_clause_list_size   HexClauseListTag NumberOfClauses  

This function calls the ITK pipe server function BOM_variant_clause_list_size Returns the number of clauses in a clause list.

Parameters
HexClauseListTag
NumberOfClauses
Returns
list of ITK_ok (=0) and NumberOfClauses or list of ITK status and error message

◆ BOM_variant_clause_toggle_brackets()

ITK::BOM_variant_clause_toggle_brackets   HexClauseListTag NumberOfClauses ListOfClausesPositions  

This function calls the ITK pipe server function BOM_variant_clause_toggle_brackets Toggles a pair of brackets around a given set of clauses in a clause list (i.e., if a matching pair of brackets already exists around the selected clauses, the brackets will be removed. Otherwise, a new set of brackets will be inserted).

Parameters
HexClauseListTag
NumberOfClauses
ListOfClausesPositions
Returns
list of ITK_ok (=0) or list of ITK status and error message

◆ BOM_variant_delete_clause_list() [1/2]

ITK::BOM_variant_delete_clause_list   HexClauseListTag  

This function calls the ITK pipe server function BOM_variant_delete_clause_list to delete a clause_list.

Parameters
HexClauseListTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_variant_delete_clause_list() [2/2]

ITK::BOM_variant_delete_clause_list   HexOccurenceTag HexVariantExpressionBlockTag  

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

Parameters
HexOccurenceTag
HexVariantExpressionBlockTag- if equals "" the variant condition will be deleted
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_variant_expr_load_if()

ITK::BOM_variant_expr_load_if   HexConditionVariantExpressionTag  

This function calls the ITK pipe server function BOM_variant_expr_load_if to create a "load if" type Variant Expression which can be attached to a BOM Line.

Parameters
HexConditionVariantExpressionTag
Returns
list of ITK_ok (=0) and HexLoadIfVariantExpressionTag or list of ITK status and error message

◆ BOM_variant_join_clause_list()

ITK::BOM_variant_join_clause_list   HexClauseListTag  

This function calls the ITK pipe server function BOM_variant_join_clause_list to create a new condition Variant Expression from the clause list.

Parameters
HexClauseListTag
Returns
list of ITK_ok (=0) and HexConditionVariantExpressionTag or list of ITK status and error message

◆ BOM_variant_new_clause_list()

ITK::BOM_variant_new_clause_list   WindowTag  

This function calls the ITK pipe server function BOM_variant_new_clause_list to create a new empty clause list. This is used to create a new variant condition.

Parameters
WindowTag
Returns
list of ITK_ok (=0) and HexClauseListTag or list of ITK status and error message

◆ BOM_variant_rule_apply()

ITK::BOM_variant_rule_apply   HexBOMVariantListTag  

This function calls the ITK pipe server function BOM_variant_rule_apply Applies the given BOM variant rule to its owning BOM window.

Parameters
HexBOMVariantListTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_variant_rule_ask_option_rev()

ITK::BOM_variant_rule_ask_option_rev   HexBOMVariantListTag HexItemTag  

This function calls the ITK pipe server function BOM_variant_rule_ask_option_rev Returns the option revision for the given option as configured in the given BOM variant rule.

Parameters
HexBOMVariantListTag
HexItemTag
Returns
list of ITK_ok (=0) and HexOptionRevTag (if no option rev found only 0) or list of ITK status and error message

◆ BOM_variant_rule_ask_options()

ITK::BOM_variant_rule_ask_options   HexBOMVariantListTag  

This function calls the ITK pipe server function BOM_variant_rule_ask_options Returns the list of options and their revisions referenced by the given BOM variant rule.

Parameters
HexBOMVariantListTag
Returns
list of ITK_ok (=0) and list with HexOptionTag1 and HexOptionRevTag1 ... HexOptionTagX and HexOptionRevTagX (if no option found only 0) or list of ITK status and error message

◆ BOM_variant_rule_clear_option_values()

ITK::BOM_variant_rule_clear_option_values   HexBOMVariantListTag  

This function calls the ITK pipe server function BOM_variant_rule_clear_option_values Unsets all the option values in the given BOM variant rule, and unloads the saved variant rule if you have one loaded.

Parameters
HexBOMVariantListTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_variant_rule_evaluate()

ITK::BOM_variant_rule_evaluate   HexBOMVariantListTag  

This function calls the ITK pipe server function BOM_variant_rule_evaluate Evaluates the given BOM variant rule. This will set option defaults, derived values and perform option rule checks.

Parameters
HexBOMVariantListTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_variant_rule_find_option()

ITK::BOM_variant_rule_find_option   HexBOMVariantListTag HexItemTag OptionName  

This function calls the ITK pipe server function BOM_variant_rule_find_option Searches for an option with the specified name. If an item is specified then it will search for the option attached to that item. If the hexitemtag is "", then it will search for the option in the specified BOM variant rule. If it cannot find the option in the rule, then it will search the entire database. If more than one option is found with the same name then an error will occur.

Parameters
HexBOMVariantListTag
HexItemTag
OptionName
Returns
list of ITK_ok (=0) and list with HexOptionTag and HexOptionRevTag (if no option found only 0) or list of ITK status and error message

◆ BOM_variant_rule_find_options()

ITK::BOM_variant_rule_find_options   HexBOMVariantListTag HexItemTag OptionName  

This function calls the ITK pipe server function BOM_variant_rule_find_options If both an OptionName and an HexItemTag is specified then it will search for the named option attached to that item. If the HexItemTag is "", then it will search for the option in the specified BOM variant rule. If it cannot find the option in the rule (or if the rule is NULLTAG), then it will search the entire database. If the OptionName is "" then it will return all options attached to the given item, or rule if the item is NULLTAG.

Parameters
HexBOMVariantListTag
HexItemTag
OptionName
Returns
list of ITK_ok (=0) and HexOptionTag1 ... HexOptionTagX (if no option found only 0) or list of ITK status and error message

◆ BOM_variant_rule_set_option_value()

ITK::BOM_variant_rule_set_option_value   HexBOMVariantListTag HexOptionTag OptionIndex  

This function calls the ITK pipe server function BOM_variant_rule_set_option_value Sets the option to the given value in the BOM variant rule (index into the enumerated list of allowed values)

Parameters
HexBOMVariantListTag
HexOptionTag
OptionIndex
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_window_apply_full_vrule()

ITK::BOM_window_apply_full_vrule   WindowTag VariantRuleTag  

This function calls the ITK pipe server function BOM_window_apply_full_vrule sets the given variant rule to be the current rule for the given BOM window. This call unsets all existing option values prior to loading the new values defined by the rule.

Parameters
WindowTag
VariantRuleTag
Returns
list ITK_ok (=0) or ITK status and error message

◆ BOM_window_ask_options()

ITK::BOM_window_ask_options   WindowTag  

This function calls the ITK pipe server function BOM_window_ask_options Asks for the set of options referenced by the bill being displayed in the specified window.

Parameters
WindowTag
Returns
list of ITK_ok (=0) and list with HexOptionTag1 and HexOptionRevTag1 ... HexOptionTagX and HexOptionRevTagX (if no option found only 0) or list of ITK status and error message

◆ BOM_window_ask_variant_rule()

ITK::BOM_window_ask_variant_rule   WindowTag  

This function calls the ITK pipe server function BOM_window_ask_variant_rule Returns the current BOM variant rule for the given BOM Window.

Parameters
WindowTag
Returns
list ITK_ok (=0) and HexBOMVariantListTag or ITK status and error message

◆ BOM_window_ask_variant_rules()

ITK::BOM_window_ask_variant_rules   BomWindowTag  

This function calls the ITK pipe server function BOM_window_ask_variant_rules Returns the list of configured BOM variant rule for the given BOM Window.

Parameters
BomWindowTagTag representation of the BOM window
Returns
list ITK_ok (=0) and list of BOMVariantTagList or ITK status and error message

Sample code sequence

1 set ItkStatus [::ITK::BOM_window_ask_variant_rules $WindowTag]
2 if {[::ITK::isITK_ok $ItkStatus] && [llength $ItkStatus] == 2} {
3  set BOMVariantTagList [lindex $ItkStatus 1]
4  if {[llength $BOMVariantTagList] > 0} {
5  #
6  # variant rules found
7  #
8  foreach BOMVariantTag $BOMVariantTagList {
9  #
10  # process the variant rule, if needed
11  #
12  }
13  } else {
14  #
15  # no variant rules found
16  #
17  }
18 } else {
19  #
20  # BOM_window_ask_variant_rules is not ITK_ok
21  #
22 }

◆ BOM_window_find_option()

ITK::BOM_window_find_option   WindowTag HexItemTag OptionName  

This function calls the ITK pipe server function BOM_window_find_option to look in the database for an option with the specified name.

Parameters
WindowTag
HexItemTag
OptionName
Returns
list of ITK_ok (=0) and (HexOptionTag HexOptionRevTag or empty list if option was not found) or list of ITK status and error message

◆ BOM_window_hide_substitutes()

ITK::BOM_window_hide_substitutes   BomWindowPUID  

calls BOM_window_hide_substitutes to hide the substitutes of the given BOM window.

Returns
list of ITK_ok (=0) or list of error code and error message
Parameters
BomWindowPUID

◆ BOM_window_set_absocc_edit_mode()

ITK::BOM_window_set_absocc_edit_mode   WindowTag absOccEditMode  

This function calls the ITK pipe server function BOM_window_set_absocc_edit_mode to set the absolute occurence context.

Parameters
WindowTagTag of bom window
absOccEditModeStatus to set absocc edit mode, on or off
Returns
list of ITK_ok (=0) or list of ITK status and error message

◆ BOM_window_set_option_value()

ITK::BOM_window_set_option_value   WindowTag HexOptionTag HexOptionValue  

This function calls the ITK pipe server function BOM_window_set_option_value Within this window, sets the option to said value.

Parameters
WindowTag
HexOptionTag
HexOptionValue
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOM_window_show_substitutes()

ITK::BOM_window_show_substitutes   BomWindowPUID  

calls BOM_window_show_substitutes to display the substitutes of the given BOM window.

Returns
list of ITK_ok (=0) or list of error code and error message
Parameters
BomWindowPUID

◆ BOMLINE_addbomline_occurrence_notes_with_window()

ITK::BOMLINE_addbomline_occurrence_notes_with_window   HexBomViewRevisionTag BomWindowTag HexItemRevisionTag args  

This function calls the ITK pipe server function BOMLINE_addbomline_occurrence_notes_with_window to add new BOM line to a given BOM window.

Remarks
In the case of an error during the update of one of the occurrence notes, the function will stop the processing of the update and will return after the first error occurs.
Parameters
HexBomViewRevisionTag
BomWindowTagTag representation of the BOM window
HexItemRevisionTag
args(optional) list of occurrence notes and values pairs e.g. bl_sequence_no 11 bl_quantity 2
Returns
ITK_ok (=0) and new BOM line tag or list of ITK status and error message

◆ BOMLINE_cutbomline()

ITK::BOMLINE_cutbomline   HexBomLineTag  

This function calls the ITK pipe server function BOM_line_cut to delete an existing BOM line.

Deprecated:
ITK::BOMLINE_cutbomline is deprecated, please use ITK::BOM_line_cut
Parameters
HexBomLineTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ BOMLINE_update_occurrence_notes()

ITK::BOMLINE_update_occurrence_notes   BomLineTag args  

This function calls the ITK pipe server function BOMLINE_update_occurrence_notes to updates the occurrence for a given BOM line.

Remarks
In the case of an error during the update of one of the occurrence notes, the function will stop the processing of the update and will return after the first error occurs.
Parameters
BomLineTag
args(optional) list of occurrence notes and values pairs e.g. bl_sequence_no 11 bl_quantity 2
Returns
ITK_ok (=0) or list of ITK status and error message