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

Namespaces

 MULTI
 

Functions

 ADMIN_set_bypass OnOffFlag
 This function calls the ITK pipe server function ADMIN_set_bypass to modify the bypass flag. More...
 
 AE_ask_all_dataset_named_refs HexDatasetTag ReferenceName
 Get all named references of a dataset. More...
 
 AE_delete_all_dataset_revs HexDatasetTag
 Delete all named references from a dataset. More...
 
 AE_remove_dataset_named_ref_by_tag HexDatasetTag ReferenceName HexReferencedObjectTag
 Delete named references from a dataset. More...
 
 AM_check_privilege ObjectTag PrivilegeString
 This function calls the ITK pipe server function AM_check_privilege to check the defined privilege for an object of the current user. Checks if the current user has the specified privilege on the specified object. The rule tree is traversed to determine whether the privilege is granted or not. The verdict is set to true if the privilege is granted and to false if the privilege is revoked. Note that the union of all the user's groups and roles is used and if the user is granted the privilege via any of these groups or roles, the verdict is specified as true. More...
 
 AM_check_users_privilege UserTag ObjectTag PrivilegeString
 This function calls the ITK pipe server function AM_check_users_privilege to check the defined privilege for an object of a given user. Checks if the specified user has the specified privilege on the specified object. The rule tree is traversed to determine whether the privilege is granted or not. The verdict is set to true if the privilege is granted and to false if the privilege is revoked. Note that the union of all the user's groups and roles is used and if the user is granted the privilege via any of these groups or roles, the verdict is specified as true. More...
 
 AOM_ask_displayable_values HexTcObjectTag PropertyName
 This function calls the ITK pipe server function AOM_ask_displayable_values and returns the displayable property value information. More...
 
 AOM_ask_max_num_elements HexTcObjectTag PropertyName
 This function calls the ITK pipe server function AOM_ask_max_num_elements to get the maximum number of values in a multi-valued property of an object. More...
 
 AOM_ask_num_elements HexTcObjectTag PropertyName
 This function calls the ITK pipe server function AOM_ask_num_elements to get the number of values in a multi-valued property of an object. More...
 
 AOM_ask_owner HexTcObjectTag
 This function calls the ITK pipe server function AOM_ask_owner to find the owning user of the given tc object. More...
 
 AOM_ask_property_master_locale HexTcObjectTag PropertyName
 This function calls the ITK pipe server function AOM_ask_property_master_locale to get the master locale of a property of an object. More...
 
 AOM_ask_property_type HexPropertyTag PropertyName
 This function calls the ITK pipe server function AOM_ask_property_type and returns the property type name. More...
 
 AOM_ask_table_rows OwningObjectTag TablePropertyName
 This function calls the ITK pipe server function AOM_ask_table_rows. More...
 
 AOM_ask_value_type HexTcObjectTag PropertyName
 This function calls the ITK pipe server function AOM_ask_value_type and returns the type name of the value. More...
 
 AOM_ask_values HexTcObjectTag PropertyName
 This function calls the ITK pipe server function AOM_ask_values and returns the internal property value information. More...
 
 AOM_delete ObjectTag
 This function calls the ITK pipe server function AOM_delete. More...
 
 AOM_delete_from_parent ObjectTag ParentTag
 This function calls the ITK pipe server function AOM_delete_from_parent. More...
 
 AOM_delete_table_rows OwningObjectTag TablePropertyName DeleteFromRowIndex NumberOfTableRows2Delete
 This function calls the ITK pipe server function AOM_delete_table_rows to delete the table row objects starting at the specified index. AOM_save and AOM_refresh have to be called after this call. More...
 
 AOM_is_null_empty HexTcObjectTag PropertyName CheckZeroLengthFlag
 This function calls the ITK pipe server function AOM_is_null_empty and returns the IsNull flag. More...
 
 AOM_refresh_lock HexTcObjectTag
 This function calls the ITK pipe server function AOM_refresh_lock to refresh and lock a given Teamcenter object. More...
 
 AOM_refresh_unlock HexTcObjectTag
 This function calls the ITK pipe server function AOM_refresh_unlock to refresh and unlock a given Teamcenter object. More...
 
 AOM_save HexTcObjectTag
 This function calls the ITK pipe server function AOM_save to commit the changes of a given Teamcenter object. More...
 
 AOM_save_with_extensions HexTcObjectTag
 This function calls the ITK pipe server function AOM_save_with_extensions that saves the object and executes the PreCondition, PreAction and PostAction extensions if TC_save_msg is implemented on the type of the object; For example, this generic ITK will execute TC_save_msg on Item in the same way as ITEM_save_item does. More...
 
 AOM_set_table_rows OwningObjectTag TablePropertyName TableRowTag1 ... TableRowTagn
 This function calls the ITK pipe server function AOM_set_table_rows to set the table row object tags for the table property. The input list of objects are stored for the current property and existing objects that are not available in the input are deleted. AOM_save and AOM_refresh have to be called after this call. More...
 
 AOM_set_value TclRepresentationOfTheTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function AOM_set_value to update an attribute of an object, the function also works for RuntimeObjects like BOMlines. Based on the Property type the corresponding AOM_set_value_<type> function is used for the update of the property. AOM_save and AOM_refresh have to be called after this call. More...
 
 AOM_UIF_ask_translations HexTcObjectTag PropertyName Index
 This function calls the ITK pipe server function AOM_UIF_ask_translations to get all translations for a single- or multi-valued property of an ApplicationObject Only available in Teamcenter 8.3 and later! The Property must be localizable (else error 38300 appears) More...
 
 AOM_UIF_set_translations HexTcObjectTag PropertyName Index args
 This function calls the ITK pipe server function AOM_UIF_set_translations to set all(!) translations for a single- or multi-valued property of an ApplicationObject Only available in Teamcenter 8.3 and later! The Property must be localizable (else error 38300 appears) More...
 
 AOM_unlock HexTcObjectTag
 This function calls the ITK pipe server function AOM_refresh_unlock to unlock a given Teamcenter object. More...
 
 ASBUILT_bom_compare_no_context hexSourceLineTag hexTargetLineTag compareMode outputMode
 ITK function for AsBuilt BOM Compare. More...
 
 ASBUILT_build_physical_part_revision hexPhysicalPartRevTag EffectiveFromDate
 ITK function to revise As-Built Physical Part Revision Tag of new Physical Element Revision. More...
 
 ASBUILT_create_compare_desc
 ITK function to create compare descriptor for BOM Compare. More...
 
 ASBUILT_create_missing_part_structure hexSelectBOMLineTag
 ITK function to create missing part AsBuilt structure. More...
 
 ASBUILT_gen_phystruc hexNeutralBOMLineTag attributeName1
 ITK function to generate AsBuilt Structure. More...
 
 ASBUILT_get_all_open_usages hexInLineTag hexPhysicalPartRevTag
 ITK function to get all open usage values. More...
 
 ASBUILT_get_all_open_usages_2 hexInLineTag hexPhysicalPartRevTag
 ITK function to get all open usage values. More...
 
 ASBUILT_init_module
 Initializes the as-built module. Must be called before calling any other ASBUILT functions. More...
 
 ASBUILT_install_asbuilt_part_revision hexInLineTag hexPhysicalPartRevTag hexSelectBOMLineImplTag UsageName InstallationDate
 ITK function to install AsBuilt Physical Part Revision in AsBuilt Structure. More...
 
 ASBUILT_install_asbuilt_part_revision_2 hexInLineTag hexPhysicalPartRevTag hexChildPhysicalPartRevTag hexSelectBOMLineImplTag UsageName InstallationDate
 ITK function to install AsBuilt Physical Part Revision in AsBuilt Structure. More...
 
 ASBUILT_line_ask_all_child_lines hexBOMLineTag
 ITK function to get Child Lines for selected Physical BOM Line. More...
 
 ASBUILT_line_set_window_top WindowTag hexPhysicalPartTag hexPhysicalPartRevisionTag
 ITK function to set top AsBuilt BOM Line in MRO BOM Window. More...
 
 ASBUILT_rebuild_asbuilt_structure hexSelectBOMLineTag RebuildDate
 ITK function to rebuild AsBuilt Structure. More...
 
 ASBUILT_replace_physical_part hexSelectBOMLineTag hexPhysicalPartRevision UsageName InstallationDate
 ITK function to replace Physical Part in an AsBuilt structure. More...
 
 ASBUILT_search_installable_physical_part_revisions hexParentPhysBOMLineTag hexUsageBOMLineTag attributeName1
 ITK function to search installable physical part revisions. More...
 
 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 HexBomWindowTag
 This function calls the ITK pipe server function BOM_ask_window_top to get the top BOM line tag. More...
 
 BOM_close_window HexBomWindowTag
 This function calls the ITK pipe server function BOM_close_window to close the BOM window. 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 HexBomWindowTag
 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 HexBomWindowTag
 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 HexBomWindowTag 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...
 
 buildTcDataArray ItkStatusInfo
 This function builds the ::TcData array structure based on the previous ITK::getObjectData call. More...
 
 CE_ask_condition HexConditionTag
 This function calls the ITK pipe server function ITK_CE_ask_condition to get a condition name. More...
 
 CE_current_user_session_tag
 This function calls the ITK pipe server function POM_get_user to retrieve the current user session object tag. More...
 
 CE_evaluate_condition HexConditionTag NoOfObjects ObjectTag1 ... ObjectTagX
 This function calls the ITK pipe server function ITK_CE_evaluate_condition to check if condition is met. More...
 
 CE_evaluate_condition_by_name HexConditionName NoOfObjects NoOfObjects ObjectTag1 ... ObjectTag
 This function calls the ITK pipe server function ITK_CE_evaluate_condition_by_name finds the condition tag and checks if conditions for targets are met. More...
 
 CE_find_condition HexConditionName
 This function calls the ITK pipe server function ITK_CE_find_condition to find a condition tag. More...
 
 CFM_create_intent IntentName IntentDescriptions
 This function calls the ITK pipe server function CFM_create_intent to create a new intent. More...
 
 CFM_effectivity_ask_date_ranges HexEffectivityTag
 This function calls the ITK pipe server function CFM_effectivity_ask_date_ranges to return the effectivity date for the given effectivity. More...
 
 CFM_effectivity_create EffectivityId
 This function calls the ITK pipe server function CFM_effectivity_create to create a new effectivity for the given Id. More...
 
 CFM_effectivity_find EffectivityId
 This function calls the ITK pipe server function CFM_effectivity_find to find the effectivity for the given Id. More...
 
 CFM_effectivity_set_date_ranges HexEffectivityTag NumberOfRanges args
 This function calls the ITK pipe server function CFM_effectivity_set_date_ranges to set the effectivity dates for the given effectivity. More...
 
 CFM_find RuleName
 This function calls the ITK pipe server function CFM_find to finds the revision rule tag of the rule name. More...
 
 CFM_item_ask_configured HexRuleTag HexItemTag
 This function calls the ITK pipe server function CFM_item_ask_configured to finds the revision of the given item that is configured when the given revision rule is used to configure the given item. More...
 
 CFM_rule_add_entry_by_name HexRevisionRuleTag RuleType
 This function calls the ITK pipe server function CFM_rule_add_entry_by_name to add rule entry to the revision rule. More...
 
 CFM_rule_add_intent HexRuleTag HexIntentTag
 This function calls the ITK pipe server function CFM_rule_add_intent to add an intent to the given rule. More...
 
 CFM_rule_copy RevisionRuleTag NewRevisionRuleName
 This function calls the ITK pipe server function CFM_rule_copy to create a new revision rule based on a given revision rule tag. More...
 
 CFM_rule_create RevisionRuleName RevisionRuleDesc
 This function calls the ITK pipe server function CFM_rule_create to create a new revision rule. More...
 
 CFM_rule_list_intents HexRuleTag
 This function calls the ITK pipe server function CFM_rule_list_intents to get all intents of the given rule. More...
 
 CFM_rule_remove_intent HexRuleTag HexIntentTag
 This function calls the ITK pipe server function CFM_rule_remove_intent to remove an intent from the given rule. More...
 
 CFM_rule_set_date HexRevisionRuleTag DateString
 This function calls the ITK pipe server function CFM_rule_set_date to sets the date entry into the Revision Rule. If a date entry already exists with the revision rule it will be updated. More...
 
 checkValuesIfMatch HexMatchString args
 This function calls the ITK pipe server function ITK_checkValuesIfMatch to compare or match the given values. More...
 
 closeTeamcenterConnection
 This function closes the Teamcenter session of the ITK pipe server and automatically stops the ITK pipe. More...
 
 COLLABCTX_add_structure_context HexCCObjectTag HexSCObjectTag
 This function calls the ITK pipe server function COLLABCTX_add_structure_context to add an additional structure context to the given CCObject instance. More...
 
 COLLABCTX_ask_structure_contexts HexTcObjectTag
 This function calls the ITK pipe server function COLLABCTX_ask_structure_contexts to return all available structure contexts for the given CCObject instance. More...
 
 COLLABCTX_ccobj_ask_config_context HexTcObjectTag
 This function calls the ITK pipe server function COLLABCTX_ccobj_ask_config_context to return the ConfigurationContext for the given CCObject instance. More...
 
 COLLABCTX_ccobj_set_config_context HexTcObjectTag
 This function calls the ITK pipe server function COLLABCTX_ccobj_set_config_context to set the ConfigurationContext for the given CCObject instance. More...
 
 COLLABCTX_configuration_set_revisionrule HexContextContObjectTag
 This function calls the ITK pipe server function COLLABCTX_configuration_set_revisionrule to set the RevisionRule to ConfigurationContext. If Rule is a run time revision rule, we will: More...
 
 COLLABCTX_configuration_set_variantrule HexContextContObjectTag HexRuleTag
 This function calls the ITK pipe server function COLLABCTX_configuration_set_variantrule to set the BOMVariantRule to ConfigurationContext. More...
 
 COLLABCTX_context_add_content HexStructContObjectTag HexContextContObjectTag args
 This function calls the ITK pipe server function COLLABCTX_context_add_content to add content to the structure context instance. More...
 
 COLLABCTX_context_ask_config_context HexStructContObjectTag
 This function calls the ITK pipe server function COLLABCTX_context_ask_config_context to returns the configuration context used by the structure context instance. More...
 
 COLLABCTX_context_ask_contents HexStructContObjectTag
 This function calls the ITK pipe server function COLLABCTX_context_ask_contents to returns all the components used by the structure context instance. More...
 
 COLLABCTX_context_set_config_context HexSCObjectTag HexConfContObjectTag
 This function calls the ITK pipe server function COLLABCTX_context_set_config_context to set ConfigurationContext of the structure context instance. More...
 
 COLLABCTX_copy_ccobject CCTypeName NewName NewDescription
 This function calls the ITK pipe server function COLLABCTX_copy_ccobject to create a new CCObject instance based on an existing CCObject instance. More...
 
 COLLABCTX_create_ccobject CCTypeName NewName NewDescription
 This function calls the ITK pipe server function COLLABCTX_create_ccobject to create a new CCObject instance. More...
 
 COLLABCTX_create_configuration_context ConfConextTypeName NewName NewDescription
 This function calls the ITK pipe server function COLLABCTX_create_configuration_context to create a new configuration context instance. More...
 
 COLLABCTX_create_structure_context SCTypeName NewName NewDescription
 This function calls the ITK pipe server function COLLABCTX_create_structure_context to create a new structure context instance. More...
 
 conditionValidForObjectType PreferencePrefix ObjectTag -strict
 Check if a condition is valid for an object type. More...
 
 connect2TcDB args
 This function calls the corresponding ITK functions to login to Teamcenter based on the input of the setConnectionParameters function. If no connection parameters are defined, the function will try to use autologin. More...
 
 CONSTANTS_get_global_constant_value constant_name
 This function calls the ITK pipe server function CONSTANTS_get_global_constant_value to get a the value the global constant. More...
 
 CONSTANTS_get_property_constant_value constant_name type_name preference_name
 This function calls the ITK pipe server function CONSTANTS_get_property_constant_value to get a the value the property constant. More...
 
 CONSTANTS_get_type_constant_value constant_name type_name
 This function calls the ITK pipe server function CONSTANTS_get_type_constant_value to get a the value of an type constant. More...
 
 CR_ask_job HexTcObjectTag
 This function calls the ITK pipe server function CR_ask_job to searches for item revision work-flows. More...
 
 DATASET_exportNamedRefsOfDataset HexItemId HexItemRevId HexRelationTypeName HexDatasetTypeName HexNamedRefName HexDatasetCreationDate HexDatasetTag
 This function calls the ITK pipe server function DATASET_list_namedreferences to exports all named file references based on the given parameters. More...
 
 DATASET_exportNamedRefsOfDataset_WithoutDateCheck HexItemId HexItemRevId HexRelationTypeName HexDatasetTypeName HexNamedRefName HexDatasetTag
 This function calls the ITK pipe server function DATASET_list_namedreferences to exports all named file references based on the given parameters. More...
 
 DATASET_importNamedReference DatasetTag NamedRefName OriginalFileName FileName
 This function calls a set of ITK pipe server function to set / exchange the named reference for the given dataset. More...
 
 DATASET_importNamedRefOfDataset ItemId ItemRevId RelationTypeName DatasetTypeName HexDatasetTag NamedRefName OriginalFileName FileName DatasetName
 This function calls the ITK pipe server function DATASET_list_namedreferences to return a list of defined named references for a given Dataset type name. More...
 
 DATASET_list_namedreferences DatasetTypeName
 This function calls the ITK pipe server function DATASET_list_namedreferences to return a list of defined named references for a given Dataset type name. More...
 
 disconnectTcDB args
 
 EPM_add_attachment4JobTag JobTag AttachmentType TcObjectTag
 This function calls the ITK pipe server function EPM_add_attachment4JobTag to add a Teamcenter object tag to a given job tag. More...
 
 EPM_ask_assigned_tasks
 This function calls the ITK pipe server function EPM_ask_assigned_tasks to retrieve the content of the users in-box. More...
 
 EPM_ask_name TaskTag
 This function calls the ITK pipe server function EPM_ask_name to get the object name of a given task tag. More...
 
 EPM_ask_parent_processes SubProcessTag
 This function calls the ITK pipe server function EPM_ask_parent_processes to get parent processes tags. More...
 
 EPM_ask_procedure_name TaskTag
 This function calls the ITK pipe server function EPM_ask_procedure_name to get the procedure name of a given task tag. More...
 
 EPM_ask_process_template TaskTag
 This function calls the ITK pipe server function EPM_ask_process_template to get the process template of a given task tag. More...
 
 EPM_ask_root_task JobTag
 This function calls the ITK pipe server function EPM_ask_root_task to retrieve the root task of a given job tag. More...
 
 EPM_ask_sub_processes ParentProcessTag
 This function calls the ITK pipe server function EPM_ask_sub_processes to get sub processes tags. More...
 
 EPM_ask_task_state_string TaskTag
 This function calls the ITK pipe server function EPM_ask_task_state_string to get the state name of a given task tag. More...
 
 EPM_create_process JobName JobDescription ProcessTemplateName TcObjectTag1 AttachmentType1 ...
 This function calls the ITK pipe server function EPM_create_process to create a new Teamcenter work-flow job. More...
 
 EPM_create_process_deferred_start Name Description TemplateTag AttachementType1 AttachementTag1 ...
 This function calls the ITK pipe server function EPM_create_process_deferred_start to create a new process with the name, description, process template tag, and attachments the newly created process will NOT start. The attachment specification is optional and could be done in an extra step via the ITK::EPM_add_attachment4JobTag call. More...
 
 EPM_demote_task TaskTag Comment
 This function calls the ITK pipe server function EPM_demote_task to trigger the demote action for the given task. More...
 
 EPM_find_process_template ProcessTemplateName
 This function calls the ITK pipe server function EPM_find_process_template to get sub process template tag. More...
 
 EPM_get_person_email_addr HexUserName
 This function calls the ITK pipe server function EPM_get_person_email_addr to get the email address of a given user name. More...
 
 EPM_get_type_tasks TaskTag HexTaskType
 This function calls the ITK pipe server function EPM_get_type_tasks to get the object name of a given task tag. More...
 
 EPM_get_user_email_addr HexUserTag
 This function calls the ITK pipe server function EPM_get_user_email_addr to get the email address of a given userTag. More...
 
 EPM_is_valid_performer TaskTag
 This function calls the ITK pipe server function EPM_is_valid_performer to get the information that the current user is the valid performer of the given task tag. More...
 
 EPM_promote_task TaskTag Comment
 This function calls the ITK pipe server function EPM_promote_task to trigger the promote action for the given task. More...
 
 EPM_remove_task_hold TaskTag
 This function calls the ITK pipe server function EPM_remove_task_hold to remove the hold on the DoTask. More...
 
 EPM_set_decision TaskTag Decision DecisionComment AutoComplete
 This function calls the ITK pipe server function EPM_set_decision to set the decision of a perform sign-off or review task. More...
 
 EPM_trigger_action JobTag Action Comment
 This function calls the ITK pipe server function EPM_trigger_action to trigger a given work-flow job in the users in-box. More...
 
 executeQuery TcQueryName args
 This function calls the ITK pipe server function executeQuery to run a given Teamcenter query. More...
 
 FL_insert_instances HexFolderTag Position WSO
 add workspace objects to a folder More...
 
 flushLogChannel
 This function flushes the content of the log message buffer. More...
 
 FORM_initialize TcObjectTag FormName FormDesc FormType
 This function calls the ITK pipe server function FORM_initialize to initialize the Form attributes. More...
 
 formatStatusMessage MsgContextName ItkStatusInfo
 This function returns the error message from a previous ITK call in a readable format. More...
 
 GDE_create Name Description Type
 This function calls the ITK pipe server function GDE_create to create a new GDE object. More...
 
 GDE_set_attribute_value HexTcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function GDE_set_attribute_value to update a attribute of a GDE object. The function uses also AOM_save and AOM_refresh functions after the GDE object was updated. More...
 
 getBOMLinePropertyByName BOMLineTag PropertyName args
 This function calls the ITK pipe server function getBOMLinePropertyByName to retrieve the property value for a given Teamcenter object. The function has a build in translation of a user, group and release status tag to the corresponding string representation. More...
 
 getConnectionParameters args
 for internal use only! More...
 
 getEncodingAliasList
 This function calls the ITK pipe server function getEncodingAliasList to retrieve the list of encoding aliases used by the ITK process. More...
 
 getErrorMessage4Status ItkStatusInfo
 This function returns the error message from a previous ITK call. More...
 
 getITKStatusNumber ItkStatusInfo
 This function returns the status number information of a previous ITK call. More...
 
 getNextObjectTypeId HexTypeName
 gets with NR_next_item_id the next free itemId for the given type More...
 
 getObjectData args
 This function calls the ITK pipe server function getObjectData to retrieve the information for a given Teamcenter object into the ::TcData array. More...
 
 getObjectHashData args
 
 getObjectMetaData TcObjectTag
 This function calls the ITK pipe server function getObjectMetaData to retrieve some basic information for a given Teamcenter object. More...
 
 getObjectPropertyByName TcObjectTag PropertyName GroupSpecifier RefreshFlag
 This function calls the ITK pipe server function getObjectPropertyByName to retrieve the property value for a given Teamcenter object. The function has a build in translation of a user, group and release status tag to the corresponding string representation. More...
 
 getObjectTag ItkStatusInfo
 This function returns the object tag of the previous ITK call. More...
 
 getObjectValue ItkStatusInfo
 This function returns the object value of the a previous ITK call. More...
 
 getPreference PreferenceName
 This function calls the ITK pipe server function getPreference to read the value of a given preference name. More...
 
 getReleatedObjectTag2 HexObjectTag RelationName ObjectTypeName args
 Function returns the first matching related ObjectTag for a given Tag, RelationName and ObjectTypeName and returns en empty tag if no object was found. More...
 
 GRM_create_relation_only_by_name HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_create_relation_only_by_name to create a GRM relation between a primary and a secondary object for a given relation type name. More...
 
 GRM_delete_relation HexRelationTag
 This function calls the ITK pipe server function GRM_delete_relation to delete a GRM relation. More...
 
 GRM_delete_relation_only_by_name HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_delete_relation_only_by_name to delete a GRM relation between a primary and a secondary object for a given relation type name. More...
 
 GRM_find_relation_type RelationTypeName
 This function calls the ITK pipe server function GRM_find_relation_type to retrieve the type tag of a given GRM relation type name. More...
 
 GRM_list_primary_objects_by_name HexTcObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_list_primary_objects to get a list of all primary objects and relations For each object: relationTag primaryObjTag secondaryObjTag relationTypeTag userDataTag for a given secondary object and GRM relation type name. More...
 
 GRM_list_primary_objects_only HexSecondaryObjectTag RelationTypeTag
 This function calls the ITK pipe server function GRM_list_primary_objects_only to get a list of all primary objects for a given secondary object and GRM relation type tag. If an empty string is provided as relation type tag, then primary objects for any relation type are retrieved. More...
 
 GRM_list_primary_objects_only_by_name HexTcObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_list_primary_objects_only to get a list of all primary objects for a given secondary object and GRM relation type name. More...
 
 GRM_list_relation_types_names
 This function calls the ITK pipe server function GRM_list_relation_types_names to get a list of all GRM relation type names. More...
 
 GRM_list_relations HexPrimaryObjectTag HexSecondaryObjectTag HexRelationTypeTag HexUserDataTag
 This function calls the ITK pipe server function GRM_list_relations to get a list of all relations objects for a given primary object and/or secondary object and/or GRM relation type tag and/or user data tag. More...
 
 GRM_list_relations_by_name HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_list_relations_only_by_name to get a list of all relations objects for a given primary and/or secondary object and GRM relation type name. More...
 
 GRM_list_secondary_objects_only HexPrimaryObjectTag RelationTypeTag
 This function calls the ITK pipe server function GRM_list_secondary_objects_only to get a list of all secondary objects for a given primary object and GRM relation type tag. If an empty string is provided as relation type tag, then secodary objects for any relation type are retrieved. More...
 
 GRM_list_secondary_objects_only_by_name HexTcObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_list_secondary_objects_only_by_name to get a list of all secondary objects for a given primary object and GRM relation type name. More...
 
 ICS_class_ask_icos ClassId
 This function calls the ITK pipe server function ICS_class_ask_icos to get the ico tags. More...
 
 ICS_createClassificationObject HexTcObjectTag ClassId
 This function calls the ITK pipe server function ICS_createClassificationObject to create a classification (inClass) object for a given Teamcenter object. More...
 
 ICS_findClassificationObject HexTcObjectTag
 This function calls the ITK pipe server function ICS_findClassificationObject to find a classification (inClass) object for a given Teamcenter object. More...
 
 ICS_ico_remove HexTcObjectTag
 This function calls the ITK pipe server function ICS_ico_remove to remove the ico. More...
 
 ICS_ico_set_attribute_values_via_tparray HexTcObjectTag TpArray
 This function calls the ITK pipe server function ICS_ico_set_attribute_values_via_tparray to update a set attribute of a classification (inClass) object. More...
 
 ICS_ico_set_attributes HexTcObjectTag HexAttrId HexAtrributValue1 ...
 This function calls the ITK pipe server function ICS_ico_set_attributes to set the ico attributes. More...
 
 ICS_set_attribute_value HexTcObjectTag AttributeId NewAttributeValue
 This function calls the ITK pipe server function ICS_set_attribute_value to update an attribute of a classification (inClass) object. More...
 
 ID_getIdentifierObjectByContextName HexObjectTag IdContextName
 This function calls the ITK pipe server function ID_getIdentifierObjectByContextName to return a list of all identifiers for a given Item and ID context name. More...
 
 ID_getIdentifierObjects HexObjectTag
 This function calls the ITK pipe server function ID_getIdentifierObjects to return a list of all identifiers for a given Item. More...
 
 ID_setAlternateIDAttribute HexAlternateIDTag AttributeName NewAttributeValue
 This function calls the ITK pipe server function ID_setAlternateIDAttribute to update a attribute of a identifier. More...
 
 IDCXT_ask_name HexIdContextTag
 This function calls the ITK pipe server function IDCXT_ask_name to return the Id Context name of a given ID context tag. More...
 
 IDCXT_find_idcontext IdContextName
 This function calls the ITK pipe server function IDCXT_find_idcontext to find a IdContext tag for a given Id Context name. An error will be returned if more than one name is qualified in the search. More...
 
 IDFR_ask_id HexIdentifierTag
 This function calls the ITK pipe server function IDFR_ask_id to returns the Id of a given Identifier tag. More...
 
 IDFR_ask_idcontext HexIdentifierTag
 This function calls the ITK pipe server function IDFR_ask_idcontext to returns the reference to the idcontext object of a given Identifier tag. More...
 
 IDFR_create_altid IdentifierTypeName HexItemTag HexRevisionTag HexIDContextTag
 This function calls the ITK pipe server function IDFR_create_altid to create a alternate identifier of type <IdentifierTypeName> and <IdentifierTypeName>Rev for a given Item/ItemRevision tag. More...
 
 IDFR_find_identifiers AlternateId HexIDContextTag
 This function calls the ITK pipe server function IDFR_find_identifiers to return a list of all identifiers that have the given id in the given idcontext. More...
 
 IMF_ask_original_file_name HexFilePUID
 Calls IMF_ask_original_file_name on the server. More...
 
 IMF_stat HexFilePUID
 Calls the IMF_stat ServerFunktion (takes the file tag instead of the path) More...
 
 isITK_ok ItkStatusInfo
 This function tests the status information of a previous ITK call for the status and returns 1 (for Status==ITK_ok) or 0 (for Status!=ITK_ok). More...
 
 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...
 
 ITK_ask_version
 This function calls the ITK pipe server function ITK_ask_version to retrieve the version number of the current Teamcenter release. More...
 
 ITK_ask_version_string
 This function calls the ITK pipe server function ITK_ask_version_string to retrieve the version string of the current Teamcenter release as a string. More...
 
 LOV_ask_localized_descriptions HexLovTag LovLocale
 This function calls the ITK pipe server function LOV_ask_localized_descriptions to retrieve the localized descriptions of the specified LOV. Requires at least TC-11. More...
 
 LOV_ask_values_int HexLovTag
 This function calls the ITK pipe server function LOV_ask_values_int to retrieve the integer values of the specified LOV. Note that the LOV type should be "ListOfValuesInteger". More...
 
 LOV_find LovName
 This function calls the ITK pipe server function LOV_find to find LOVs having the specified name. Note that LOV names are not necessarily unique, so more than one LOV can be found potentially. More...
 
 MAIL_add_envelope_receiver EnvelopeTag UserTag
 This function calls the ITK pipe server function MAIL_add_envelope_receiver to add user to the receiver list. More...
 
 MAIL_add_external_receiver EnvelopeTag HexExternalAddr
 This function calls the ITK pipe server function MAIL_add_external_receiver to add external email address to the receiver list. More...
 
 MAIL_send_envelope EnvelopeTag
 This function calls the ITK pipe server function MAIL_send_envelope sends an email. More...
 
 modifyOwnership4Object TcObjectTag NewOwnerName NewOwnerGroupName
 This function calls the ITK pipe server function modifyOwnership4Object to change the onwership for a given Teamcenter object. The function has a build in translation of a user and group name. More...
 
 modifyOwnership4ObjectList TcObjectTag NewOwnerName NewOwnerGroupName
 This function calls the ITK pipe server function modifyOwnership4ObjectList to change the ownership for a given Teamcenter object and its related objects. The 'related objects' are handled at the moment for the following object types: Item, Item Rev, CC, ScheduleTask For all other TC object types, only the given object itself will be changed. The function has a build in translation of a user and group name. More...
 
 MROCORE_create_window WindowTag hexPhysicalPartTag hexPhysicalPartRevisionTag
 ITK function to create MRO BOM Window. More...
 
 MROCORE_set_physpartrev_mfg_id hexPhysicalPartRevisionTag MfgId
 ITK function to set Manufacturer Id on Physical Part Revision. More...
 
 MROCORE_set_physpartrev_serial_number hexPhysicalPartRevisionTag SerialNumber
 ITK function to set Serial Number on Physical Part Revision. More...
 
 MROCORE_set_window_top_line MroBomWindowTag hexItemTag hexItemRevisionTag BomViewTag
 ITK function to set Serial Number on Physical Part Revision. More...
 
 MROCORE_setup_deviation ParentPhysicalPartTag ChildPhysicalPartTag SelectedDeviationDocumentTag
 ITK function to set Serial Number on Physical Part Revision. More...
 
 MROCORE_update_relation_part_used_is2 hexPhysicalPartRevisionTag hexItemRevisionTag
 ITK function to set Part Used Is value on Physical Structure Relation. More...
 
 MV_is_module HexTcObjectTag
 This function calls the ITK pipe server function MV_is_module to return the value of the isModule flag. More...
 
 MV_setBomWindowOptionValues BOMWindowTag option_id1 option_name1 option_value1
 Sets the given option values (triples of item ID, Option name and value) in a given BOM window. Several options can be set in one call. More...
 
 NR_ask_rule_and_case type_name property_name
 This function calls the ITK pipe server function ITK_NR_ask_rule_and_case to get the Naming rule for a given object type and property. More...
 
 NR_next_value2 typeName propertyName itemTag dsId preferredTypeName defaultTypeName parentTag ruleSuffix baseRevId
 This function calls the ITK pipe server function ITK_NR_next_value2 to get the next Id for a given parameter set. Gets the next id generated for a particular pattern in the Naming Rule. This ITK is a generalized ITK for generating next id in case of :

  1. next item id
  2. next revision id
  3. next revision id generated from the pattern in the alt rule
  4. next alt id generated from the pattern in rule
  5. next dataset id
  6. next dataset revision id
  7. For any String attribute on a type.
More...
 
 NR_pattern_next_value typeName propertyName itemTag dsId preferredTypeName defaultTypeName parentTag ruleSuffix baseRevId pattern
 This function calls the ITK pipe server function ITK_NR_pattern_next_value to get the next Id for a given parameter set. Gets the next id generated for a particular input pattern in the Naming Rule This ITK is a generalized ITK for generating next id in case of :

  1. next item id
  2. next revision id
  3. next revision id generated from the pattern in the alt rule
  4. next alt id generated from the pattern in rule
  5. next dataset id
  6. next dataset revision id
  7. For any String attribute on a type.
More...
 
 NR_rule_desc_with_counters2 rule_tag
 This function calls the ITK pipe server function ITK_NR_rule_desc_with_counters2 to get the rule description of a given rule tag. More...
 
 OBJECT_processReverseMappingData SelectedObjectTag TransactionId PreferencePrefix ReverseMappingBuffer
 This function calls the ITK pipe server function OBJECT_processReverseMappingData, so that it is possible to use the same behaviour of the reverse mapping like in the work-flow or interactive transfer in the context of the batch transfer. More...
 
 OBJECT_set_attribute_value TcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function OBJECT_set_attribute_value to update a attribute of an object. The function uses also AOM_save und AOM_refresh functions after the object was updated. More...
 
 OBJECT_set_attribute_value2 TcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function OBJECT_set_attribute_value2 to update an attribute of an object. AOM_save and AOM_refresh have to be called after this call. More...
 
 OBJECT_set_attribute_value_forcemode TcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function OBJECT_set_attribute_value_forcemode to update a attribute of an object with a force mode for the attributes without write access. The function uses also AOM_save and AOM_unload functions after the object was updated. More...
 
 OBJECT_set_attribute_value_forcemode2 TcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function OBJECT_set_attribute_value_forcemode2 to update a attribute of an object with a force mode for the attributes without write access. The function is not saving the object to the database this requires an extra call of AOM_save and AOM_unload. More...
 
 OBJECT_set_localized_attribute_value TcObjectTag PropertyName NewPropertyValue Mode Locale State
 This function calls the ITK pipe server function OBJECT_set_localized_attribute_value to update a attribute of an object. More...
 
 OBJECT_set_status ObjectTag StatusName
 This function calls the ITK pipe server function OBJECT_set_status to modify status of a given object. More...
 
 PLMXML_exportObject TcObjectTag TransferModeName ContextName OutPutFileName LogFileName
 This function calls the ITK pipe server function ITK_PLMXML_exportObject that can create a PLMXML export for a given object via a set of PIE_sesion function. More...
 
 PLMXML_importObject DryRunFlag TransferModeName ContextName InPutFileName LogFileName
 This function calls the ITK pipe server function PLMXML_importObject to import an PLMXML and update the objects within the file. More...
 
 POM_ask_group
 This function calls the ITK pipe server function POM_ask_group to find the currently used group. More...
 
 POM_ask_group_name GroupTag
 This function calls the ITK pipe server function POM_ask_group_name to get group name. More...
 
 POM_ask_owner HexObjectTag
 This function calls the ITK pipe server function POM_ask_owner to get user and group tag of the object owner. More...
 
 POM_ask_session
 This function calls the ITK pipe server function POM_get_user to get the current session tag. More...
 
 POM_ask_user_default_group UserTag
 This function calls the ITK pipe server function POM_ask_user_default_group to get the default group tag. More...
 
 POM_ask_user_name HexUserTag
 This function calls the ITK pipe server function POM_ask_user_name to get user name. More...
 
 POM_combine_enquiries EnqIdTag1 Operation EnqIdTag2
 This function calls the ITK pipe server function POM_combine_enquiries. More...
 
 POM_create_enquiry_on_char_by_name ClassIdTag AttributeIdTag Operation Value
 This function calls the ITK pipe server function POM_create_enquiry_on_char_by_name. More...
 
 POM_create_enquiry_on_date_by_name ClassIdTag AttributeIdTag Operation Value
 This function calls the ITK pipe server function POM_create_enquiry_on_date_by_name. More...
 
 POM_create_enquiry_on_double_by_name ClassIdTag AttributeIdTag Operation Value
 This function calls the ITK pipe server function POM_create_enquiry_on_double_by_name. More...
 
 POM_create_enquiry_on_int_by_name ClassIdTag AttributeIdTag Operation Value
 This function calls the ITK pipe server function POM_create_enquiry_on_int_by_name. More...
 
 POM_create_enquiry_on_logical_by_name ClassIdTag AttributeIdTag Operation Value
 This function calls the ITK pipe server function POM_create_enquiry_on_logical_by_name. More...
 
 POM_create_enquiry_on_ref_by_name ClassIdTag AttributeIdTag Operation Value
 This function calls the ITK pipe server function POM_create_enquiry_on_ref_by_name. More...
 
 POM_create_enquiry_on_string_by_name ClassIdTag AttributeIdTag Operation Value
 This function calls the ITK pipe server function POM_create_enquiry_on_string_by_name. More...
 
 POM_create_enquiry_on_tag_by_name ClassIdTag AttributeIdTag Operation Value
 This function calls the ITK pipe server function POM_create_enquiry_on_tag_by_name. More...
 
 POM_delete_enquiries_via_list EnqIdTag1 EnqIdTag2
 This function calls the ITK pipe server function POM_delete_enquiries. More...
 
 POM_execute_enquiry EnqIdTag
 This function calls the ITK pipe server function POM_execute_enquiry. More...
 
 POM_get_user
 This function calls the ITK pipe server function POM_get_user to find the currently logged in user. More...
 
 POM_tag_to_uid HexObjectTag
 This function calls the ITK pipe server function POM_tag_to_uid to get the UID of the tag. More...
 
 PREF_ask_char_values Scope Preference
 This function calls the ITK pipe server function "PREF_ask_char_values" to read the values of a char-preference Note: starting from TC101 function "PREF_ask_char_values_at_location" should be preferred. More...
 
 PREF_ask_char_values_at_location Preference Location
 This function calls the ITK pipe server function "PREF_ask_char_values_at_location" to read the values of a char-preference Note: starting from TC101 this function should be preferred to function "PREF_ask_char_values". More...
 
 PREF_ask_environment_set_flag Preference
 This function calls the ITK pipe server function "PREF_ask_environment_set_flag" to read the value of the "environment set" flag. More...
 
 PREF_ask_environment_set_flag Preference Flag
 This function calls the ITK pipe server function "PREF_set_environment_set_flag" to write the value of the "environment set" flag. More...
 
 PREF_ask_logical_value_for_scope Scope Preference ValueIndex
 This function calls the ITK pipe server function "PREF_ask_logical_value" for a specific preference scope to read the logical value of a preference. More...
 
 PREF_delete_definition Count Preference1 ... PreferenceCount DeleteAllCustomDefinitions
 This function calls the ITK pipe server function "PREF_delete_definition" to delete the definition of a preference. More...
 
 PREF_delete_preference Scope Preference
 This function calls the ITK pipe server function "PREF_delete_preference" to delete a preference Note: starting from TC101 function "PREF_delete_preference_at_location" should be preferred. More...
 
 PREF_delete_preference_at_location Preference Location
 This function calls the ITK pipe server function "PREF_delete_preference_at_location" to delete a preference Note: starting from TC101 this function should be preferred to function "PREF_delete_preference". More...
 
 PREF_export_preferences Scope XmlFilePath
 This function calls the ITK pipe server function "PREF_export_preferences" to export an xml preference file. More...
 
 PREF_import_preferences Scope XmlFilePath Action
 This function calls the ITK pipe server function "PREF_import_preferences" to import an xml preference file. More...
 
 PREF_set_char_values_at_location Preference Location Count args
 This function calls the ITK pipe server function "PREF_set_char_values_at_location" to write the values of a char-preference Note: starting from TC101 this function should be preferred to function "PREF_set_char_values". More...
 
 PROJ__set_default_project HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ__set_default_project to set the project as the default for the given members. More...
 
 PROJ_activate_project HexProjectTag Flag
 This function calls the ITK pipe server function PROJ_activate_project to set the project active or inactive. More...
 
 PROJ_add_author_members HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ_add_author_members to add members the project. More...
 
 PROJ_add_members HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ_add_members to add members the project. More...
 
 PROJ_ask_assigned_objects ProjectId
 This function calls the ITK pipe server function PROJ_ask_assigned_objects to get the project objects. More...
 
 PROJ_ask_author_members HexProjectTag
 This function calls the ITK pipe server function PROJ_ask_author_members to get the project members. More...
 
 PROJ_ask_id HexProjectTag
 This function calls the ITK pipe server function PROJ_ask_id to get the project id. More...
 
 PROJ_ask_name HexProjectTag
 This function calls the ITK pipe server function PROJ_ask_name to get the project name. More...
 
 PROJ_assign_objects HexProjectTag args
 This function calls the ITK pipe server function PROJ_assign_objects to assign objects to the project. More...
 
 PROJ_assign_team_members HexProjectTag MembersCount HexMembersTag1,..., HexMembersTagN AdministratorsCount HexAdministratorsTag1 HexAdministratorsTag1 ... HexAdministratorsTagN PrivilegedUsersCount HexPrivilegedUsersTag1 ... HexPrivilegedUsersTagN
 This function calls the ITK pipe server function PROJ_assign_team_members to assign team members to the project. More...
 
 PROJ_create_project ProjectId ProjectName ProjectDescr
 This function calls the ITK pipe server function PROJ_create_project to create a project. More...
 
 PROJ_create_project_with_options ProjectId ProjectName ProjectDescr SecurityFlag
 This function calls the ITK pipe server function PROJ_create_project_with_options to create a project with program security level. More...
 
 PROJ_edit_project_options HexProjectTag SecurityFlag
 This function calls the ITK pipe server function PROJ_edit_project_options to edit the project security level. More...
 
 PROJ_find ProjectId
 This function calls the ITK pipe server function PROJ_find to find the project with the given Id. More...
 
 PROJ_find_user_project HexUserTag IncludeInactiveFlag
 This function calls the ITK pipe server function PROJ_find_user_project to find the users projects. More...
 
 PROJ_find_user_projects HexUserTag ActiveOnlyFlag PrivilegedOnlyFlag ProgramOnlyFlag
 This function calls the ITK pipe server function PROJ_find_user_projects to find the users projects. More...
 
 PROJ_initialize HexProjectTag ProjectId ProjectName ProjectDescr
 This function calls the ITK pipe server function PROJ_initialize to set projects id, name and description. More...
 
 PROJ_is_project_active HexProjectTag
 This function calls the ITK pipe server function PROJ_is_project_active to check if the project is activated. More...
 
 PROJ_is_user_a_member HexProjectTag HexUserTag
 This function calls the ITK pipe server function PROJ_is_user_a_member to check if the user is a member of the given project. More...
 
 PROJ_is_user_a_privileged_member HexProjectTag HexUserTag
 This function calls the ITK pipe server function PROJ_is_user_a_privileged_member to check if the user is a privileged member of the given project. More...
 
 PROJ_remove_members HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ_remove_members to remove the members from the project. More...
 
 PROJ_remove_objects HexProjectTag HexMemberTag1 ... HexMemberTagX
 This function calls the ITK pipe server function PROJ_remove_objects to remove the objects from the project. More...
 
 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...
 
 RELSTAT_add_release_status__single ReleaseStatusTag ObjectTag RetainReleasedDateFlag
 This function calls the ITK pipe server function ITK_RELSTAT_add_release_status__single to Adds the given release status to single ws_object, with an indicator to retain the released date or not. More...
 
 RELSTAT_create_release_status ReleaseStatusName
 This function calls the ITK pipe server function ITK_RELSTAT_create_release_status to Creates release status object for given input status type. The function initializes start and end effectivity dates and start and end serial numbers to NULL. This means that the released objects will be effective for all dates and all serial numbers. More...
 
 RELSTAT_set_date_effectivity ReleaseStatusTag StartDate EndDate
 This function calls the ITK pipe server function ITK_RELSTAT_set_date_effectivity to Sets the date effectivity on the given release_status. More...
 
 RELSTAT_set_release_status_type ReleaseStatusTag ReleaseStatusName
 This function calls the ITK pipe server function RELSTAT_set_release_status_type to sets the status_type for the given release status. More...
 
 RELSTAT_set_release_status_type__for_object ObjectTag ReleaseStatusName
 This function calls the ITK pipe server function RELSTAT_set_release_status_type__for_object to sets the status_type for an existing release status attached to a given object. More...
 
 renameAllObject4Item HexTcObjectTag NewId NewName NewDescription
 This function calls the ITK pipe server function renameAllObject4Item to rename all related object a given Teamcenter item. More...
 
 renameAllObject4ItemRevision HexTcObjectTag HexItemRevisionTag NewId NewName NewDescription
 This function calls the ITK pipe server function renameAllObject4ItemRevision to rename all related object a given Teamcenter Item/ItemRevision. More...
 
 RES_checkin HexObjectTag
 Check-in an object. More...
 
 RES_checkout HexObjectTag reason change_id dir_name reservation_type
 Checkout an object. More...
 
 SA_add_role_to_group HexGroupTag HexRoleTag
 adds a role to the group More...
 
 SA_ask_current_location_code
 This function calls return the the Current LocationCode for the session. More...
 
 SA_ask_current_organization
 This function calls return the Current Organization for the session. More...
 
 SA_ask_current_project
 gets with SA_ask_current_project the current project tag More...
 
 SA_ask_current_role
 gets the current role More...
 
 SA_ask_current_role_name
 gets with SA_ask_current_role the current role and asks its name with SA_ask_role_name More...
 
 SA_ask_current_user_context
 This function calls return the the Current LocationCode for the session. More...
 
 SA_ask_current_work_context
 This function calls return the the Current LocationCode for the session. More...
 
 SA_ask_group_full_name HexGroupTag
 gets the full group name More...
 
 SA_ask_group_parent HexGroupTag
 returns a parent of the group More...
 
 SA_ask_groupmember_role HexGroupMemberTag
 returns a role of the group member More...
 
 SA_ask_person_attr HexPersonTag HexAttributeName
 This function calls the ITK pipe server function SA_ask_person_attr to read the value of the person named attribute. More...
 
 SA_ask_role_name HexRoleTag
 gets the role name More...
 
 SA_ask_roles_from_group HexGroupTag
 gets all roles of the group More...
 
 SA_ask_user_login_group HexUserTag
 This function calls the ITK pipe server function SA_ask_user_login_group to get the default group for the given user. More...
 
 SA_ask_user_work_contexts
 This function calls the work contexts associated with the user's workflow tasks (Tasks to Perform) or their targets. More...
 
 SA_change_group_by_name GroupName RoleName
 This function calls the ITK pipe server function executeQuery to change the current group of the pipe server. More...
 
 SA_create_discipline HexDisciplineName
 This function calls the ITK pipe server function SA_create_discipline to create the disciplineTag with the given discipline name. AOM_save is called after creation. More...
 
 SA_create_groupmember HexGroupTag HexUserTag AdminFlag
 This function calls the ITK pipe server function SA_create_groupmember to create the group member for the given groupTag and userTag. AOM_save is called after creation. More...
 
 SA_create_h_group HexGroupName Privilege HexParentGroupTag HexVolumeName
 This function calls the ITK pipe server function SA_create_h_group to create the group with the given group name. AOM_save is called after creation. More...
 
 SA_create_person HexPersonName
 This function calls the ITK pipe server function SA_create_person to create the personTag with the given person name. AOM_save is called after creation. More...
 
 SA_create_role HexRoleName
 This function calls the ITK pipe server function SA_create_role to create the role with the given role name. AOM_save is called after creation. More...
 
 SA_create_user HexUserId HexPersonName HexUserPassword HexGroupTag HexVolumeName
 This function calls the ITK pipe server function SA_create_user to create the user with the given user name. AOM_save is called after creation. More...
 
 SA_create_user2 HexUserId HexPersonName HexUserPassword
 This function calls the ITK pipe server function SA_create_user to create the user with the given user name. More...
 
 SA_create_user2_x HexUserId HexPersonName HexUserPassword HexGroupTag HexVolumeName
 This function calls the ITK pipe server function SA_create_user to create the user with the given user name. AOM_save is called after creation. More...
 
 SA_find_discipline HexDisciplineName
 This function calls the ITK pipe server function SA_find_discipline to find the disciplineTag of the given discipline name. More...
 
 SA_find_group HexGroupName
 This function calls the ITK pipe server function SA_find_group to find the group tag of the given user name. More...
 
 SA_find_groupmember_by_role HexGroupTag HexRoleTag
 This function calls the ITK pipe server function SA_find_groupmember_by_role to find the memberTags of the given groupTag and roleTag. More...
 
 SA_find_groupmember_by_user HexUserTag
 This function calls the ITK pipe server function SA_find_groupmember_by_user to find the memberTags of the given userTag. More...
 
 SA_find_groupmembers HexGroupTag HexUserTag
 This function calls the ITK pipe server function SA_find_groupmembers to find the memberTags of the given groupTag. More...
 
 SA_find_groupmembers_by_group HexGroupTag
 This function calls the ITK pipe server function SA_find_groupmembers_by_group to find the memberTags of the given groupTag. More...
 
 SA_find_person HexPersonName
 This function calls the ITK pipe server function SA_find_person to find the personTag of the given person name. More...
 
 SA_find_role HexRoleName
 This function calls the ITK pipe server function SA_find_role to find the roleTag of the given role name. More...
 
 SA_find_user HexUserId
 This function calls the ITK pipe server function SA_find_user to find the userTag of the given user id. More...
 
 SA_find_user2
 This function calls the user tag for given userid. More...
 
 SA_remove_role_from_group HexGroupTag HexRoleTag
 removes a role from the group More...
 
 SA_set_current_project HexProjectTag
 set the given project as Current Project for the session. More...
 
 SA_set_default_role HexUserTag HexGroupTag HexRoletag
 This function calls the ITK pipe server function SA_set_default_role to set the default role with for the user in the group. More...
 
 SA_set_group_parent HexParentGroupTag HexChildGroupTag
 sets a parent for the group More...
 
 SA_set_groupmember_group HexGroupMemberTag HexGroupTag
 This function calls the ITK pipe server function SA_set_groupmember_group to set the userTag for the groupMemberTag. More...
 
 SA_set_groupmember_inactive HexGroupMemberTag InactiveFlag
 sets a group member active or inactive More...
 
 SA_set_groupmember_role HexGroupMemberTag HexRoleTag
 This function calls the ITK pipe server function SA_set_groupmember_role to set the roleTag for the groupMemberTag. More...
 
 SA_set_groupmember_user HexGroupMemberTag HexUserTag
 This function calls the ITK pipe server function SA_set_groupmember_user to set the userTag for the groupMemberTag. More...
 
 SA_set_user_login_group HexUserTag HexGroupTag
 This function calls the ITK pipe server function SA_set_user_login_group to set the given group as a default group for the user. More...
 
 SA_set_user_person HexUserTag HexPersonTag
 This function calls the ITK pipe server function SA_set_user_person to connect the userTag with the personTag. More...
 
 SA_set_user_status HexUserTag InactiveFlag
 sets user to active or inactive More...
 
 SCHMGT_claim_assignment HexTaskTag HexAssignmentTag
 Creates resource assignments to tasks in the schedule. More...
 
 SCHMGT_critical_tasks HexScheduletag
 Calculates the critical path of the schedule. More...
 
 SCHMGT_delete_assignments HexScheduletag HexAssignmentTag1...HexAssignmentTagX
 Deletes resource assignments in the schedule. More...
 
 SCHMGT_delete_dependency HexScheduletag HexDependencyTag1...HexDependencyTagX
 Deletes dependencies in the schedule. More...
 
 SCHMGT_delete_tasks_non_interactive HexScheduletag HexTaskTag1...HexTaskTagX
 Deletes tasks in the schedule. More...
 
 SCHMGT_initialize_actual_finish_date HexTaskTag
 initialises the actual finish date of the schedule task. More...
 
 SCHMGT_initialize_actual_start_date HexTaskTag
 initialises the actual start date of the schedule task. More...
 
 SCHMGT_launch_workflow HexTaskTag
 Launches the workflow on task. More...
 
 SCHMGT_recalculate_schedule_non_interactive HexScheduletag Type Asynchron
 Performs the recalculation operation on the schedule. More...
 
 SCHMGT_scale_schedule_non_interactive HexScheduletag ScaleFactor Type CheckState
 Performs the scale schedule operation on the schedule. More...
 
 SCHMGT_set_percent_complete HexTaskTag Percent
 sets the percent complete of the schedule task. More...
 
 SCHMGT_set_schedule_status HexScheduleTag StatusName
 sets the status of the schedule. More...
 
 SCHMGT_set_task_status HexTaskTag StatusName
 sets the status of the schedule task. More...
 
 SCHMGT_set_work_complete HexTaskTag WorkComplete
 sets the work complete of the schedule task. More...
 
 SCHMGT_shift_schedule_non_interactive HexScheduletag NewDate NewFinish
 Performs the recalculation operation on the schedule. More...
 
 setConnectionParameters ?User? ?Password? ?Group? ?EncryptFlag? ?LocalOnlyFlag? args
 This function defines the connection information for all ITK function calls in this namespace. More...
 
 setDefaultLogChannel LogChannelName
 This function modifies the default log-channel name of the ITK pipe server via a the server side setDefaultLogChannel function. More...
 
 stopPipeServer args
 This function stops the ITK pipe server via a the server side stopPipeServer function. More...
 
 TCTYPE_ask_name HexTypeTag
 This function calls the ITK pipe server function TCTYPE_ask_name to retrieve the type name of a given type tag. More...
 
 TCTYPE_ask_object_type ObjectTag
 This function calls the ITK pipe server function TCTYPE_ask_object_type to retrieve the object type tag of a given object tag. More...
 
 TCTYPE_construct_create_input ObjectTypeTag AttributeName1 AttributeValue1 ...
 This function calls the ITK pipe server function TCTYPE_construct_create_input to create a new create input tag. More...
 
 TCTYPE_copy_object HexTcObjectTag args
 This function calls the ITK pipe server function TCTYPE_copy_item to create a new Item based on a given Item. More...
 
 TCTYPE_create_object CreateInputTag
 This function calls the ITK pipe server function TCTYPE_create_object to create an object, which has been previously prepared with TCTYPE_construct_create_input. ATTENTION - do not forget to save the new object. More...
 
 TCTYPE_find_alltypes_for_class ClassName
 This function calls the ITK pipe server function TCTYPE_find_alltypes_for_class to get a list of type-names for the given class. More...
 
 TCTYPE_find_type TypeName
 This function calls the ITK pipe server function TCTYPE_find_type to find the typeTag for the given type name. More...
 
 TCTYPE_simplified_create_object2 ObjectTypeName AttributeName1 AttributeValue1 ...
 This function calls the ITK pipe server function TCTYPE_construct_create_input and TCTYPE_create_item to create a new Item based on a given object type. To store the object it is necessary to save the new object by using the ITK::AOM_save_with_extensions or ITK::AOM_save or ITK::ITEM_save_item. More...
 
 UOM_find_by_symbol UomSymbolName
 This function calls the ITK pipe server function UOM_find_by_symbol to retrieve the UOM tag for a given UOM symbol name. More...
 
 VMS_add_mfg_part_to_comm_part HexCPTag HexCPRevTag HexMPTag HexVendorTag
 This function calls the ITK pipe server function VMS_add_mfg_part_to_comm_part to Manufacturer Part to an existing Commercial Part. More...
 
 VMS_add_vendor_roles HexVendorRevTag VendorRoleTag1 ... VendorRoletagX
 This function calls the ITK pipe server function VMS_create_vendor_role to add a list of Vendor Roles to a given Vendor Revision. More...
 
 VMS_copy_vendor HexVendorTag args
 This function calls the ITK pipe server function VMS_copy_vendor to create a new Vendor based on a given Vendor. More...
 
 VMS_copy_vendor_rev HexVendorRevTag args
 This function calls the ITK pipe server function VMS_copy_vendor_rev to create a new Vendor Revision based on a given Vendor Revision tag. More...
 
 VMS_create_commercial_part2 CP_Id CP_Desc UoMTag CP_Name CP_PartTypeName CP_RevID DesReq MakeBuy VendorTag
 This function calls the ITK pipe server function VMS_create_commercial_part to create a new Commercial Part. More...
 
 VMS_create_manufacturer_part2 MP_Id MP_Desc UoMTag MP_Name MP_PartTypeName MP_RevID DesReq MakeBuy VendorTag CommPartTag CommPartRevTag
 This function calls the ITK pipe server function VMS_create_manufacturer_part to create a new Manufacturer Part. More...
 
 VMS_create_vendor V_Id V_Name V_RevId
 This function calls the ITK pipe server function VMS_create_vendor to create a new Teamcenter Vendor. More...
 
 VMS_create_vendor_role R_Name R_Description
 This function calls the ITK pipe server function VMS_create_vendor_role to create a new Teamcenter Vendor role. More...
 
 VMS_create_vendor_with_type V_Id V_Name V_RevId V_Type
 This function calls the ITK pipe server function VMS_create_vendor_with_type to create a new Teamcenter Vendor. More...
 
 VMS_delete_vendor HexVendorTag
 This function calls the ITK pipe server function VMS_delete_vendor to delete a given Vendor. More...
 
 VMS_delete_vendor_rev HexVendorRevTag
 This function calls the ITK pipe server function VMS_delete_vendor_rev to delete a given Vendor Revision. More...
 
 VMS_find_vendor V_Id
 This function calls the ITK pipe server function VMS_find_vendor to searches for an vendor id. More...
 
 VMS_get_vendor_roles HexVendorRevTag
 This function calls the ITK pipe server function VMS_get_vendor_roles to the list of VendorRole tags attached to a given Vendor Revision. More...
 
 VMS_remove_vendor_roles HexVendorRevTag
 This function calls the ITK pipe server function VMS_remove_vendor_roles to removes a list of Vendor Roles from a given Vendor Revision. More...
 
 VRULE_create RuleName RuleDescription
 This function calls the ITK pipe server function VRULE_create to create an an empty Variant Rule, with the given name and description. More...
 
 VRULE_create_from_bom_shortcut RuleName RuleDescription WindowTag
 This function calls the ITK pipe server function VRULE_create_from_bom_shortcut to create VariantRule object. More...
 
 VRULE_create_from_variant_rule_shortcut RuleName RuleDescription HexBomVariantRuleTag
 This function calls the ITK pipe server function VRULE_create_from_variant_rule_shortcut to create VariantRule object. More...
 
 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...
 

Variables

 ItkInfo
 Namespace array buffer to define the ITK pipe related configuration information
::ITK::ItkInfo(IdlePipeTimeOutMode) This variable defines the mode how the idle time-out is defined or calculated, "default" is the default value. The following values are allowed: More...
 

Detailed Description

Deprecated:
This procedure is deprecated. Instead use ITK::getObjectData with appropriate configuration and evaluate TcData array ^ using T4X::TC::MAPPING::IndexedFieldMapping.
Deprecated:
This procedure is deprecated. Instead use ITK::getObjectPropertyByName.

Function Documentation

◆ buildTcDataArray()

ITK::buildTcDataArray   ItkStatusInfo  

This function builds the ::TcData array structure based on the previous ITK::getObjectData call.

Parameters
ItkStatusInfostatus info list (element 1 is TcData content in a binary format)
Returns
OK ERROR

Sample code sequence

1 set StatusList [::ITK::::ITK::getObjectData "$MyTag" T4S MM MaterialMaster]
2 if {[::ITK::isITK_ok $StatusList]} {
3  #ITK_ok
4  ::ITK::buildTcDataArray $StatusList
5 } else {
6  # any error
7  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
8  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
9 }

References isITK_ok(), and tpco_formatHEX16().

◆ checkValuesIfMatch()

ITK::checkValuesIfMatch   HexMatchString args  

This function calls the ITK pipe server function ITK_checkValuesIfMatch to compare or match the given values.

Parameters
HexMatchString
args= list of match hex type and hex match-value(s) type=EQUAL,NOT_EQUAL,MATCH,NOT_MATCH,IN_LIST,RANGE
Returns
ITK_ok (=0) - ok or 1 - failed

◆ closeTeamcenterConnection()

ITK::closeTeamcenterConnection

This function closes the Teamcenter session of the ITK pipe server and automatically stops the ITK pipe.

Returns
None

Referenced by disconnectTcDB().

◆ conditionValidForObjectType()

ITK::conditionValidForObjectType   PreferencePrefix ObjectTag -strict  

Check if a condition is valid for an object type.

Parameters
PreferencePrefixprefix of the condition preference
ObjectTagobject tag to evaluate conditions for
-strictan option to treat preference existence as mandatory
Returns
{ITK_ok true} if the object should be transfered

◆ connect2TcDB()

ITK::connect2TcDB   args  

This function calls the corresponding ITK functions to login to Teamcenter based on the input of the setConnectionParameters function. If no connection parameters are defined, the function will try to use autologin.

Returns
ITK Status

References tpco_closeSrvSession(), tpco_connectTo(), tpco_decrypt(), and tpco_sendECMD().

Referenced by T4X::TEST::WORKFLOW::executeTcWorkflowJob(), and T4X::TEST::WORKFLOW::runTemplateTest().

◆ disconnectTcDB()

ITK::disconnectTcDB   args  

◆ executeQuery()

ITK::executeQuery   TcQueryName args  

This function calls the ITK pipe server function executeQuery to run a given Teamcenter query.

Parameters
TcQueryNamedefined in the Teamcenter query builder
argsdefines an optional list of query entry names and values pairs.
Returns
List of ITK_ok (ITK_ok=0)and tags of the query matches or list of ITK status and error message

Sample code sequence

1 set StatusList [::ITK::executeQuery "MyTcQuery" "EntryName1" "000*" "EntryName2" "123*"]
2 if {[lindex $StatusList 0] == 0} {
3  #ITK_ok: the query was successful
4  foreach Tag [lindex $StatusList 1] {
5  # do something with the found tag
6  }
7 } else {
8  # any error
9  set ErrorMesssage [tpco_formatHEX16 [lindex $StatusList 1]]
10 }

Referenced by T4S::MM::CUSTOM::ITEM::IMPORT::selectTC_Object().

◆ flushLogChannel()

ITK::flushLogChannel

This function flushes the content of the log message buffer.

Returns
None

◆ formatStatusMessage()

ITK::formatStatusMessage   MsgContextName ItkStatusInfo  

This function returns the error message from a previous ITK call in a readable format.

Parameters
MsgContextNameThe message context is used as a prefix to the original ITK error message, so that is easier to identify the corresponding source code line.
ItkStatusInfostatus info list (element 1 is always the ITK error message)
Returns
error message (if available) or empty string

Sample code sequence

1 set StatusList [::ITK::getObjectPropertyByName "$MyTag" "owning_group" "full_name"]
2 if {[::ITK::isITK_ok $StatusList]} {
3  #ITK_ok
4  set PropertyValue [::ITK::getObjectValue $StatusList]
5 } else {
6  # any error
7  set ErrorMesssage [::ITK::formatStatusMessage "::ITK::getObjectPropertyByName" $StatusList]
8  tpwrite -mtype ERROR $ErrorMesssage
9 }

References isITK_ok(), and tpco_formatHEX16().

◆ getBOMLinePropertyByName()

ITK::getBOMLinePropertyByName   BOMLineTag PropertyName args  

This function calls the ITK pipe server function getBOMLinePropertyByName to retrieve the property value for a given Teamcenter object. The function has a build in translation of a user, group and release status tag to the corresponding string representation.

Parameters
BOMLineTagTeamcenter object tag in the Tcl string format
PropertyNamename of the Teamcenter object property
args,optionalargument to define the translation of the group, supported values are: full_name display_name
Returns
List of ITK status and the property information of the Teamcenter object.

Sample code sequence

1 set StatusList [::ITK::getBOMLinePropertyByName $BOMLineTag "owning_group" "full_name"]
2 if {[lindex $StatusList 0] == 0} {
3  #ITK_ok
4  set PropertyValue [tpco_formatHEX16 [lindex $StatusList 1]]
5 } else {
6  # any error
7  set ErrorMesssage [tpco_formatHEX16 [lindex $StatusList 1]]
8 }

◆ getConnectionParameters()

◆ getEncodingAliasList()

ITK::getEncodingAliasList

This function calls the ITK pipe server function getEncodingAliasList to retrieve the list of encoding aliases used by the ITK process.

Returns
List of ITK_ok (ITK_ok=0) and encoding alias list or error code.

◆ getErrorMessage4Status()

ITK::getErrorMessage4Status   ItkStatusInfo  

This function returns the error message from a previous ITK call.

Parameters
ItkStatusInfostatus info list (element 1 is always the ITK error message)
Returns
error message (if available) or empty string

Sample code sequence

1 set StatusList [::ITK::getObjectPropertyByName "$MyTag" "owning_group" "full_name"]
2 if {[::ITK::isITK_ok $StatusList]} {
3  #ITK_ok
4  set PropertyValue [::ITK::getObjectValue $StatusList]
5 } else {
6  # any error
7  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
8  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
9 }

References isITK_ok(), and tpco_formatHEX16().

◆ getITKStatusNumber()

ITK::getITKStatusNumber   ItkStatusInfo  

This function returns the status number information of a previous ITK call.

Parameters
ItkStatusInfostatus info list (element 0 is always the ITK status)
Returns
ITK status (error number)

Sample code sequence

1 set StatusList [::ITK::getObjectPropertyByName "$MyTag" "owning_group" "full_name"]
2 if {[::ITK::isITK_ok $StatusList]} {
3  #ITK_ok
4  set PropertyValue [::ITK::getObjectValue $StatusList]
5 } else {
6  # any error
7  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
8  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
9 }

Referenced by isITK_ok().

◆ getNextObjectTypeId()

ITK::getNextObjectTypeId   HexTypeName  

gets with NR_next_item_id the next free itemId for the given type

Parameters
HexTypeName
Returns
0 and HexItemId or list of ITK status and error message

◆ getObjectData()

ITK::getObjectData   args  

This function calls the ITK pipe server function getObjectData to retrieve the information for a given Teamcenter object into the ::TcData array.

This ::TcData array is used as navigation information between the extracted objects and representation of a fast access memory buffer for the extracted Teamcenter objects attributes. A handle to this fast access memory buffer is store in the variable ::TcData(ObjectHashTable) and is used similar as a file handle in all mapping functions that retrieve information for an object from the buffer. The function is also cleaning the ::TcData array and an existing handle before the data of the new object is stored into the array.

Warning
The handle stored in ::TcData(ObjectHashTable) needs to be deleted after usage, this is typically done by the framework if the ::TcData buffer is filled during a work flow or a normal batch job transfer. If the ITK::getObjectData function is called additional time within a customer specific mapping it might be necessary to delete the fast access memory buffer manually via the tpco_tcddelete command.

Sample that shows how to read the data of an additional object within the normal work-flow, menu base or OOTB batch job transfer.

1 #
2 # ::TcData is already filled with first object by the OOTB functionality
3 #
4 #
5 # copy array into an extra buffer, so that we can use it late again
6 #
7 array set TcDatTmp [array get ::TcData]
8 #
9 # delete the ::TcData array otherwise the fast access memory buffer is deleted and you can't be used by the
10 # ::T4X::TC::MAPPING namespace functions
11 #
12 array unset ::TcData
13 #
14 # read the data of the second object
15 #
16 set ObjectStatus [::ITK::getObjectData $SecondObjectTag T4S MM MaterialMaster]
17 if {[::ITK::isITK_ok $ObjectStatus]} {
18  #
19  # do your mapping on the second object
20  #
21  if {[info exists ::TcData(ObjectHashTable)]} {
22  #
23  # clean up the fast access memory buffer for the second object
24  #
25  catch {
26  tpco_tcddelete $::TcData(ObjectHashTable)
27  }
28  }
29 }
30 #
31 # switch back ::TcData content to first object
32 #
33 array set ::TcData [array get TcDatTmp]
34 #
35 # delete the temporary TcDatTmp array to clean the memory
36 #
37 array unset TcDatTmp
38 #
39 # do your mapping on the first object
40 #

Sample of the correct usage of if the ITK::getObjectData is called once

1 #
2 # read the data of the object in a script or in a self defined batch job code
3 #
4 set ObjectStatus [::ITK::getObjectData $FirstObjectTag T4S MM MaterialMaster]
5 if {[::ITK::isITK_ok $ObjectStatus]} {
6  #
7  # do your mapping on the object with the ::T4X::TC::MAPPING namespace functions
8  #
9  if {[info exists ::TcData(ObjectHashTable)]} {
10  #
11  # clean up the fast access memory buffer for the first object
12  #
13  catch {
14  tpco_tcddelete $::TcData(ObjectHashTable)
15  }
16  }
17 }

Sample of the correct usage of if the ITK::getObjectData needs to be called several times within the mapping

1 #
2 # read the data of the first object
3 #
4 set ObjectStatus [::ITK::getObjectData $FirstObjectTag T4S MM MaterialMaster]
5 if {[::ITK::isITK_ok $ObjectStatus]} {
6  #
7  # copy array into an extra buffer, so that we can use it late again
8  #
9  array set TcDatTmp [array get ::TcData]
10  #
11  # delete the ::TcData array otherwise the fast access memory buffer is deleted and you can't be used by the
12  # ::T4X::TC::MAPPING namespace functions
13  #
14  array unset ::TcData
15  #
16  # read the data of the second object
17  #
18  set ObjectStatus [::ITK::getObjectData $SecondObjectTag T4S MM MaterialMaster]
19  if {[::ITK::isITK_ok $ObjectStatus]} {
20  #
21  # do your mapping on the second object with the ::T4X::TC::MAPPING namespace functions
22  #
23  if {[info exists ::TcData(ObjectHashTable)]} {
24  #
25  # clean up the fast access memory buffer for the second object
26  #
27  catch {
28  tpco_tcddelete $::TcData(ObjectHashTable)
29  }
30  }
31  }
32  #
33  # switch back ::TcData content to first object
34  #
35  array set ::TcData [array get TcDatTmp]
36  #
37  # delete the temporary TcDatTmp array to clean the memory
38  #
39  array unset TcDatTmp
40  #
41  # do your mapping on the first object with the ::T4X::TC::MAPPING namespace functions
42  #
43  if {[info exists ::TcData(ObjectHashTable)]} {
44  #
45  # clean up the fast access memory buffer for the first object
46  #
47  catch {
48  tpco_tcddelete $::TcData(ObjectHashTable)
49  }
50  array unset ::TcData
51  }
52 }

Sample of the correct usage of ITK::getObjectData in the BOM4Relation use case

1 #
2 # read the data of the object in a script or in a self defined batch job code
3 #
4 set ObjectStatus [::ITK::getObjectData $ItemRevisionTag T4S BOM4Relation BOM4Relation -use_related_objects=true]
5 if {[::ITK::isITK_ok $ObjectStatus]} {
6  #
7  # do your mapping on the object with the ::T4X::TC::MAPPING namespace functions
8  #
9  if {[info exists ::TcData(ObjectHashTable)]} {
10  #
11  # clean up the fast access memory buffer for the first object
12  #
13  catch {
14  tpco_tcddelete $::TcData(ObjectHashTable)
15  }
16  }
17 }

Sample of the correct usage of ITK::getObjectData in the BOM4Relation use case

1 #
2 # read the data of the object in a script or in a self defined batch job code
3 #
4 set ObjectStatus [::ITK::getObjectData $BomRevisionViewTag T4S BOM BillOfMaterial MaterialMaster -unpack_all_bomlines=false -bom_rev_rule="RevisionRule"]
5 if {[::ITK::isITK_ok $ObjectStatus]} {
6  #
7  # do your mapping on the object with the ::T4X::TC::MAPPING namespace functions
8  #
9  if {[info exists ::TcData(ObjectHashTable)]} {
10  #
11  # clean up the fast access memory buffer for the first object
12  #
13  catch {
14  tpco_tcddelete $::TcData(ObjectHashTable)
15  }
16  }
17 }
Parameters
TcObjectTag,Teamcenterobject tag in the Tcl string format
TargetSystemT4S (for SAP)| T4O (for Oracle EBS) | T4CPG (for the Integration to Interspec) | T4EA (for all others)
TargetTypeshort form for the target type name, this is used as part of the namespace in the mapping files (e.g. MM for MaterialMaster)
TargetTypeName,thisdefines the preference set of the data extraction function for the resulting Tcl data stream. Supported modes are:
  • MaterialMaster
  • ChangeMaster
  • DocumentInfoRecord
  • EquipmentMaster
  • FunctionalLocation
  • Vendor
  • BillOfMaterial
  • OrderBillOfMaterial
  • EquiBillOfMaterial
  • DocumentStructure
  • and more
TargetTypeName,thisdefines the preference set of the data extraction function
BomLineTargetTypeName(if the TcObjectTag is a BOMViewRevision tag) or DataExtractionMode (if the TcObjectTag is an ItemRevision tag)
  • BomLineTargetTypeName this defines the fall back preference set for the BOMLine data extraction configuration
  • DataExtractionMode: -use_related_objects=false|true (used by the BOM4relation data extraction)
BomWindowArgsoptional parameter that defines the how the BOMView data is extracted, Currently BomWindowArgs supported are:
  • -unpack_all_bomlines=false(default)|true
  • -no_transfer_of_empty_bom=false|true(default)
  • -hide_suppressed_bomlines=false(default)|true
  • -hide_variants_bomlines=false(default)|true
  • -hide_unconfigured_bomlines=false(default)|true
  • -skip_unconfigured_bomlines=false|true(default)
  • -hide_incremental_changes_bomlines=false(default)|true
  • -hide_substitutes=false(default)|true
  • -hide_GDELines=false(default)|true
  • -use_attached_rev_rule=false(default)|true
  • -bom_rev_rule="RevisionRule"
  • -add_related_objects=false(default)|true
  • -scan_max_bom_level=1(default)
Returns
List of ITK status and the information stored in the ::TcData array for the navigation information and in a fast access memory buffer that is represented by a buffer pointer in the variable ::TcData(ObjectHashTable). This handle is used in all mapping functions to to retrieve the requested information.

References getObjectHashData(), isITK_ok(), tpco_scanHEX16(), tpco_tcddelete(), and tpwrite().

◆ getObjectHashData()

ITK::getObjectHashData   args  

Referenced by getObjectData().

◆ getObjectMetaData()

ITK::getObjectMetaData   TcObjectTag  

This function calls the ITK pipe server function getObjectMetaData to retrieve some basic information for a given Teamcenter object.

Parameters
TcObjectTagTeamcenter object tag in the Tcl string format
Returns
List of ITK status and the found basic information of the Teamcenter object. The basic information are: for Item - list of HexClassTypeName HexItemTypeName HexItemId for ItemRevision - list of HexClassTypeName, HexItemRevisionTypeName, HexItemId, HexItemRevisionId for Dataset - list of HexClassTypeName, HexDatasetTypeName, HexDatasetId, HexDatasetRevisionId for all others - HexClassTypeName, HexTypeName not supported objects by T4S will return NOT_SUPPORTED_CLASS

Referenced by getReleatedObjectTag2(), and T4X::TEST::WORKFLOW::runTemplateTest().

◆ getObjectPropertyByName()

ITK::getObjectPropertyByName   TcObjectTag PropertyName GroupSpecifier RefreshFlag  

This function calls the ITK pipe server function getObjectPropertyByName to retrieve the property value for a given Teamcenter object. The function has a build in translation of a user, group and release status tag to the corresponding string representation.

Parameters
TcObjectTagTeamcenter object tag in the Tcl string format
PropertyNamename of the Teamcenter object property
GroupSpecifieroptional argument to define the translation of the group, supported values are: full_name display_name
RefreshFlagoptional argument, if T or t: refresh object before retrieving value (default), else: do not refresh.
Returns
List of ITK status and the property information of the Teamcenter object.

Sample code sequence

1 set StatusList [::ITK::getObjectPropertyByName "$MyTag" "owning_group" "full_name"]
2 if {[lindex $StatusList 0] == 0} {
3  #ITK_ok
4  set PropertyValue [tpco_formatHEX16 [lindex $StatusList 1]]
5 } else {
6  # any error
7  set ErrorMesssage [tpco_formatHEX16 [lindex $StatusList 1]]
8 }

Referenced by findStartedSuccessorTask().

◆ getObjectTag()

ITK::getObjectTag   ItkStatusInfo  

This function returns the object tag of the previous ITK call.

Parameters
ItkStatusInfostatus info list (element 1 is always the object tag)
Returns
object tag (if available) or empty string

Sample code sequence

1 set StatusList [::ITK::ITEM_ask_rev_by_revision_rule "$MyTag" "Latest Released"]
2 if {[::ITK::isITK_ok $StatusList]} {
3  #ITK_ok
4  set ItemRevisionTag [::ITK::getObjectTag $StatusList]
5 } else {
6  # any error
7  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
8  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
9 }

References isITK_ok().

Referenced by getReleatedObjectTag2().

◆ getObjectValue()

ITK::getObjectValue   ItkStatusInfo  

This function returns the object value of the a previous ITK call.

Parameters
ItkStatusInfostatus info list (element 1 is the object value)
Returns
ObjectValue (if available) or empty string

Sample code sequence

1 set StatusList [::ITK::getObjectPropertyByName "$MyTag" "owning_group" "full_name"]
2 if {[::ITK::isITK_ok $StatusList]} {
3  #ITK_ok
4  set PropertyValue [::ITK::getObjectValue $StatusList]
5 } else {
6  # any error
7  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
8  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
9 }

References isITK_ok().

Referenced by findStartedSuccessorTask().

◆ getPreference()

ITK::getPreference   PreferenceName  

This function calls the ITK pipe server function getPreference to read the value of a given preference name.

The current version of the function support only site preference

Parameters
PreferenceName
Returns
List of ITK status and preference value if found

Referenced by T4X::TEST::WORKFLOW::runTemplateTest().

◆ getReleatedObjectTag2()

ITK::getReleatedObjectTag2   HexObjectTag RelationName ObjectTypeName args  

Function returns the first matching related ObjectTag for a given Tag, RelationName and ObjectTypeName and returns en empty tag if no object was found.

Parameters
HexObjectTag,objecttag in the Tcl string format
RelationName
ObjectTypeName
Returns
List of ITK_ok (=0) and found object tag or list of ITK status and error message

References getObjectMetaData(), getObjectTag(), GRM_list_secondary_objects_only_by_name(), isITK_ok(), tpco_formatHEX16(), and tpwrite().

◆ isITK_ok()

ITK::isITK_ok   ItkStatusInfo  

This function tests the status information of a previous ITK call for the status and returns 1 (for Status==ITK_ok) or 0 (for Status!=ITK_ok).

Parameters
ItkStatusInfostatus info list (element 0 is always the ITK status)
Returns
1 (for Status==ITK_ok) or 0 (for Status!=ITK_ok).

Sample code sequence

1 set StatusList [::ITK::getObjectPropertyByName "$MyTag" "owning_group" "full_name"]
2 if {[::ITK::isITK_ok $StatusList]} {
3  #ITK_ok
4  set PropertyValue [::ITK::getObjectValue $StatusList]
5 } else {
6  # any error
7  set ErrorNumber [::ITK::getITKStatusNumber $StatusList]
8  set ErrorMesssage [::ITK::getErrorMessage4Status $StatusList]
9 }

References getITKStatusNumber().

Referenced by buildTcDataArray(), findStartedSuccessorTask(), formatStatusMessage(), getErrorMessage4Status(), getObjectData(), getObjectTag(), getObjectValue(), getReleatedObjectTag2(), and T4X::WORKFLOW::BATCHJOB::CUSTOM::sendTC_InfoEMail().

◆ ITK_ask_version()

ITK::ITK_ask_version

This function calls the ITK pipe server function ITK_ask_version to retrieve the version number of the current Teamcenter release.

Returns
List of ITK_ok (ITK_ok=0) and version string or list of ITK status and error message.

◆ ITK_ask_version_string()

ITK::ITK_ask_version_string

This function calls the ITK pipe server function ITK_ask_version_string to retrieve the version string of the current Teamcenter release as a string.

Returns
List of ITK_ok (ITK_ok=0) and version string or list of ITK status and error message.

◆ modifyOwnership4Object()

ITK::modifyOwnership4Object   TcObjectTag NewOwnerName NewOwnerGroupName  

This function calls the ITK pipe server function modifyOwnership4Object to change the onwership for a given Teamcenter object. The function has a build in translation of a user and group name.

Parameters
TcObjectTagTeamcenter object tag in the tcl string format
NewOwnerNamenew Teamcenter owner user name string
NewOwnerGroupNamenew Teamcenter owner group name string, this should be the full_name.
Returns
ITK_ok (=0) or list of ITK status and error message

◆ modifyOwnership4ObjectList()

ITK::modifyOwnership4ObjectList   TcObjectTag NewOwnerName NewOwnerGroupName  

This function calls the ITK pipe server function modifyOwnership4ObjectList to change the ownership for a given Teamcenter object and its related objects. The 'related objects' are handled at the moment for the following object types: Item, Item Rev, CC, ScheduleTask For all other TC object types, only the given object itself will be changed. The function has a build in translation of a user and group name.

Parameters
TcObjectTagTeamcenter object tag in the Tcl string format
NewOwnerNamenew Teamcenter owner user name string
NewOwnerGroupNamenew Teamcenter owner group name string, this should be the full_name. If the value is not specified or the string length is 0 we use the default login group of the user.
Returns
ITK_ok (=0) or list of ITK status and error message

◆ renameAllObject4Item()

ITK::renameAllObject4Item   HexTcObjectTag NewId NewName NewDescription  

This function calls the ITK pipe server function renameAllObject4Item to rename all related object a given Teamcenter item.

Parameters
HexTcObjectTag
NewIdnew Item Id
NewNamenew Item name
NewDescriptionnew Item description
Returns
ITK_ok (=0) or list of ITK status and error message

◆ renameAllObject4ItemRevision()

ITK::renameAllObject4ItemRevision   HexTcObjectTag HexItemRevisionTag NewId NewName NewDescription  

This function calls the ITK pipe server function renameAllObject4ItemRevision to rename all related object a given Teamcenter Item/ItemRevision.

Parameters
HexTcObjectTag
HexItemRevisionTag
NewIdnew Item Id
NewNamenew Item name
NewDescriptionnew Item description
Returns
ITK_ok (=0) or list of ITK status and error message

◆ setConnectionParameters()

ITK::setConnectionParameters   ?User? ?Password? ?Group? ?EncryptFlag? ?LocalOnlyFlag? args  

This function defines the connection information for all ITK function calls in this namespace.

Parameters
UserTeamcenter User Id
PasswordTeamcenter Password
GroupTeamcenter Group Id
EncryptFlag(optional), enables (default TRUE) and disables (FALSE) the automatic encryption of the User, Password and Group, so that the function could also be called with already encrypted strings. Default is TRUE.
LocalOnlyFlag(optional), if false: sets the connection parameters locally only and return them as a list, if true (default): sets the connection parameters on the BGS, too (returning 0).
Returns
None

References tpco_closeSrvSession(), tpco_connectTo(), tpco_encrypt(), and tpco_shmset().

◆ setDefaultLogChannel()

ITK::setDefaultLogChannel   LogChannelName  

This function modifies the default log-channel name of the ITK pipe server via a the server side setDefaultLogChannel function.

Parameters
LogChannelName
Returns
None

Referenced by T4X::BATCHJOB::EXPORT::executeExportJob(), T4X::BATCHJOB::IMPORT::executeImportJob(), and T4X::TEST::WORKFLOW::executeTcWorkflowJob().

◆ stopPipeServer()

ITK::stopPipeServer   args  

This function stops the ITK pipe server via a the server side stopPipeServer function.

Returns
none

References tpco_sendECMD().

Referenced by disconnectTcDB().

Variable Documentation

◆ ItkInfo

ItkInfo
static

Namespace array buffer to define the ITK pipe related configuration information
::ITK::ItkInfo(IdlePipeTimeOutMode) This variable defines the mode how the idle time-out is defined or calculated, "default" is the default value. The following values are allowed:

  • default In this case the time-out is specified by the CONFIG.APPSRV.PIPEIDLETO flag
  • IdlePipeTimeOut In this case the time-out value is taken from the ::ITK::ItkInfo(IdlePipeTimeOut) variable, if the value is not > 0 default value is taken
  • BatchJobTimeOut In this case the time-out value is taken from the batch job runtime, if the value is not > 0 default value is taken

::ITK::ItkInfo(IdlePipeTimeOut) specifies the ITK idle pipe time-out in seconds, default is -1