T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
ITKCO Namespace Reference

Functions

 AOM_set_value_string args
 Sets value on a single-valued property.
This function uses PROP_set_value_string_msg. To customize the behavior of this function, register a method against this message name. More...
 
 AOM_unload args
 Removes an object from your local POM memory You can reload the object later with the same tag if necessary. More...
 
 ASMAINTAINED_gen_phystruc args
 ITK function to generate AsMaintained Structure. More...
 
 ASMAINTAINED_get_physical_part_children_list args
 Retrieves the physical part children list from a Physical BOM Line. More...
 
 ASMAINTAINED_install_physical_part args
 ITK function to install Physical Part in AsMaintained Structure. More...
 
 ASMAINTAINED_move_physical_part args
 ITK function to change Physical Part location. More...
 
 ASMAINTAINED_replace_physical_part args
 ITK function to replace Physical Part in AsMaintained Structure. More...
 
 ASMAINTAINED_search_installable_physical_part_revisions args
 ITK function to search installable physical part revisions. More...
 
 BOM_line_look_up_attribute args
 Specified the name of a BOM line attribute, this returns the attribute_id. More...
 
 BOM_line_set_attribute_string args
 Sets the value of some attribute of a BOM line. More...
 
 BOM_set_window_config_rule args
 Sets the Revision (configuration) Rule for the window. More...
 
 BOM_window_set_absocc_context args
 Set context bomline for absolute occurrence edit mode. More...
 
 BOM_window_set_effectivity_grprevs args
 This function sets effectivity group revisions on the BOMWindow. More...
 
 BOP_line_add args
 Adds a new component to given line. More...
 
 BOP_line_add_with_occ_type args
 Adds a new component to given line. More...
 
 CPD_update_item_realization2 args
 Updates the Reuse Design Element and optionally its Subordinates in a Collaborative Design using the provided source Item Assembly. More...
 
 EPM_ask_active_job_for_target args
 Gets list of jobs for which the given object is one of the target objects in the job. Only the jobs which are in process are returned. Those jobs that are already completed are not listed. More...
 
 EPM_set_task_result args
 Sets the result for a task, given the task tag. More...
 
 ICS_keylov_set_entries args
 Overwrites all existing values of the KeyLOV with the provided ones. Minimal required Teamcenter Version is 11.2.3. More...
 
 IMF_get_read_file_tickets args
 Obtains FMS read tickets to be used for retrieving files from a volume. Minimal required Teamcenter Version is 11.2.0. More...
 
 ITEM_ask_id2 args
 This function will get the Item ID of the Item. Id in Context = NO: Returns Item.item_id. Id in Context = YES: Returns Item.item_id. More...
 
 ITEM_baseline_rev args
 This ITK creates a Baseline Revision for the input Item Revision only. More...
 
 ITEM_list_bom_views args
 This function will return the tags of all bom views related to the Item. More...
 
 ITEM_rev_list_all_bom_view_revs args
 This function will return the tags of all bom views related to the Item. More...
 
 ME_create_bop_window args
 Creates BOP window for Process or Compositions. More...
 
 ME_create_operation args
 Creates a new Operation of a given type. It creates a Operation and Operation Revision. More...
 
 ME_create_process args
 Creates a new process of a given type. It creates a Process, Process Revision and BV/BVR. More...
 
 MROCORE_assign_lot args
 Assigns the specified Lot to the given Physical Part and deducts the quantity by the specified size. More...
 
 MROCORE_rebase_physical_part args
 ITK function to rebase Physical Part to Neutral Part. More...
 
 MROCORE_record_utilization args
 ITK function for record utilization. More...
 
 POM_attr_id_of_attr args
 Returns the attr_id for the specified attribute in the specified class. More...
 
 POM_is_loaded args
 Checks whether the given instance is loaded in the callers DS or not. Newly created instances are counted as loaded as they are already present in DS. More...
 
 POM_set_attr_null args
 Changes the specified attributes to NULL for the specified instances. The changes occur in the DS only. More...
 
 POM_set_attr_nulls args
 Changes (all or some of) the specified array-valued attribute to NULL for the specified instances. The changes occur in the DS only. More...
 
 POM_set_attr_string args
 Changes the specified attribute to the specified value for each of the specified instances (which must all be in the same class). The changes occur in the DS only. More...
 
 POM_set_attr_strings args
 Changes (all or some of) the specified array-valued attribute to the specified array of values for each of the specified instances (which must all be in the same class). More...
 
 POM_set_creation_utc_date args
 Sets the creation date using the GMT instead of the local time (as POM_set_creation_date does). More...
 
 POM_set_env_info args
 Sets the specified environmental information. More...
 
 POM_set_modification_date args
 Sets the modification date in a POM application object. More...
 
 POM_set_modification_user args
 Sets the last modifying user in a POM application object. More...
 
 POM_set_modification_utc_date args
 Sets the modification date using the GMT instead of the local time (as ITKCO::POM_set_modification_date does). More...
 
 PREF_export_preference_list args
 Exports the specified preferences from the specified location to the specified output file. More...
 
 PS_ask_bom_view_type args
 Returns the view type of a BOMView. More...
 
 PS_create_bom_view args
 Creates a new BOMView. More...
 
 PS_create_bvr args
 Creates an initial working revision of a BOMView, with no occurrences. More...
 
 PS_list_occurrences_of_bvr args
 Lists all of the occurrences of the specified BOMViewRevision. More...
 
 SA_ask_site_info_ex2 args
 Returns the name, ID and external app status of the specified site. More...
 
 TCTYPE_ask_deepcopydata args
 Retrieves the DeepCopyData tag(s) for the input object, a top-level object undergoing the operation type specified by opvar, such as SaveAs or Revise. More...
 
 TCTYPE_construct_operationinput args
 Constructs a SaveAsInput object for the input Business Object. Use this SaveAsInput object to hold input data for the creation of an object. More...
 
 TCTYPE_revise_objects args
 Revises the specified input objects according to the revise data in the ReviseInput objects and deep copies the attached objects based on the DeepCopyData provided. More...
 
 TCTYPE_saveas_object args
 Performs a SaveAs operation on the specified object according to the SaveAs data in the SaveAsInput objects and deep copies the attached objects based upon the DeepCopyData provided. More...
 
 VRULE_ask_rule_text args
 Retrieves the contents of a Variant Rule in text format. More...
 
 VRULE_create_from_bom args
 Creates a Variant Rule with the given name and description. More...
 
 VRULE_create_from_variant_rule args
 Creates a new variant rule and populates it using option values set in the given BOM variant rule. More...
 
 VRULE_set_from_bom args
 Saves a given set of option values to an existing variant rule. More...
 
 VRULE_set_from_variant_rule args
 Saves the given list of options (with their values being taken from the BOM Variant Rule) to the given existing Variant Rule. More...
 
 WSOM_ask_object_type2 args
 Returns the object type of the specified WorkspaceObject. More...
 
 WSOM_ask_revision args
 Returns the revision number of the WorkspaceObject. More...
 
 WSOM_copy args
 Creates a copy of the input WorkspaceObject. More...
 
 WSOM_eff_set_unit_range args
 Parses the range_text string and sets the effectivity range to the values extracted. More...
 
 WSOM_eff_set_units args
 Uses an array of integers to set the unit range for a given effectivity. More...
 

Function Documentation

◆ AOM_set_value_string()

ITKCO::AOM_set_value_string   args  

Sets value on a single-valued property.
This function uses PROP_set_value_string_msg. To customize the behavior of this function, register a method against this message name.

Parameters
object_tagUnique identifier (tag) of the object instance.
prop_nameA property name of the object instance.
valueActual value being set on the property.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ AOM_unload()

ITKCO::AOM_unload   args  

Removes an object from your local POM memory You can reload the object later with the same tag if necessary.

Parameters
object_tagUnique identifier (tag) of the object instance.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ ASMAINTAINED_gen_phystruc()

ITKCO::ASMAINTAINED_gen_phystruc   args  

ITK function to generate AsMaintained Structure.

Parameters
inLineNeutral BOM line
inParamGenerate Asm Structure Params in a dict containing the following values:
  • partNumber Item Id of Neutral Part
  • serialNumber Serial Number
  • lotNumber Lot Number
  • manufacturerId Manufacturer Id
  • structureContext Structure Context Name
  • locationName Location Name
  • dispositionType Disposition Type
  • installationDate Installation Date of Physical Part
  • manufactureDate Manufacturer Date of Physical Part
  • effectiveFromDate Effective From Date
  • effectiveToDate Effective To Date
    By default, the dates must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
    but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
  • useSrlNoGen Use Serial Number Generator flag
  • numberOfLevels Number of Levels for Structure Generation
  • physicalQuantity Physical Part Quantity
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
    – MROCORE_lot_usage_error if the Lot Size is exhausted for Lot Number. Please select another Lot.
    – MROCORE_lot_is_expired if the Lot expiration date is earlier than manufacturing date while assigning the Lot to Physical Part.
  • message_text ITK status message
  • phys_rev Created Physical Part Revision

◆ ASMAINTAINED_get_physical_part_children_list()

ITKCO::ASMAINTAINED_get_physical_part_children_list   args  

Retrieves the physical part children list from a Physical BOM Line.

Parameters
physical_bom_linePhysical part BOM Line Tag
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
  • message_text ITK status message
  • count_lines Number of child Physical BOM Lines
  • child_bom_lines Child Physical BOM Line tags
  • occurrence_tags Child Physical occurrence BOM Line tags

◆ ASMAINTAINED_install_physical_part()

ITKCO::ASMAINTAINED_install_physical_part   args  

ITK function to install Physical Part in AsMaintained Structure.

Parameters
selectedAsMaintainedLineSelected AsMaintainedBOMLine on which installation happens
copiedPhysicalPartChild Physical Part which needs to be installed
usageBOMLineImplBOMLine with a PSOccurrence - Position on which the installation happens
inParamsDialog Input as a dict containing the following values:
  • usagePropertyValue Usage Name
  • installationDate Installation Date of Physical Part
    By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
    but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
  • message_text ITK status message
  • asMaintainedStructure tag of created AsMaintainedStructure relation
  • installedLineTag tag of installed AsMaintainedBOMLine

◆ ASMAINTAINED_move_physical_part()

ITKCO::ASMAINTAINED_move_physical_part   args  

ITK function to change Physical Part location.

Parameters
physPartPhysical part or physical part revision tag
locationLocation tag
inTimeDate to move
By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
  • message_text ITK status message
  • relation relation tag

◆ ASMAINTAINED_replace_physical_part()

ITKCO::ASMAINTAINED_replace_physical_part   args  

ITK function to replace Physical Part in AsMaintained Structure.

Parameters
selectedAsMaintainedLineSelected AsMaintainedBOMLine tag on which installation happens
copiedPhysicalPartChild Physical Part tag which needs to be installed
inParamsDialog Input as a dict containing the following values:
  • dispositionName Disposition Value
  • locationName Location Name
  • unInstallDate Un-Installtion Date of Physical Part
    By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
    but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
  • message_text ITK status message
  • asMaintainedStructure Created AsMaintainedStructure relation tag
  • replacedLineTag Replaced AsMaintainedBOMLine tag

◆ ASMAINTAINED_search_installable_physical_part_revisions()

ITKCO::ASMAINTAINED_search_installable_physical_part_revisions   args  

ITK function to search installable physical part revisions.

Parameters
selParentPhysBOMLineSelected parent physical BOM line tag.
selectedBOMLineImplTag of BOMLine with a PSOccurrence - Position on which the installation/replace happens.
attrCountTotal number of attributes on which search will be performed. attributeNames List of attrCount attribute names for which search will be performed. attributeValues List of attCount attribute values for which search will be performed.
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
  • message_text ITK status message
  • Output dict with all physical part revisions found, containing the following values:
    – preferred List of preferred installable physical part revision objects.
    – deviated List of deviated installable physical part revision objects.
    – substitute List of substitute installable physical part revision objects.
    – alternate List of alternate installable physical part revision objects.

◆ BOM_line_look_up_attribute()

ITKCO::BOM_line_look_up_attribute   args  

Specified the name of a BOM line attribute, this returns the attribute_id.

Parameters
attribute_nameName of the attribute
attributeTag of the attribute
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ BOM_line_set_attribute_string()

ITKCO::BOM_line_set_attribute_string   args  

Sets the value of some attribute of a BOM line.

Parameters
bom_lineTag of bom line
attributeAttribute ID (numeric value)
valueNew attribute value
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ BOM_set_window_config_rule()

ITKCO::BOM_set_window_config_rule   args  

Sets the Revision (configuration) Rule for the window.

By default, the window will have been created with the user's default Revision Rule.
This function should be used to apply a different Revision Rule to the window.
All Items in the BOM will automatically be reconfigured using the new Rule.

Parameters
windowWindow for which Revision Rule is to be set
config_ruleRevision Rule to apply to window
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

By default, the window will have been created with the user's default Revision Rule. This function should be used to apply a different Revision Rule to the window. All Items in the BOM will automatically be reconfigured using the new Rule. Parameters

Parameters
windowWindow for which Revision Rule is to be set config_rule Revision Rule to apply to window
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ BOM_window_set_absocc_context()

ITKCO::BOM_window_set_absocc_context   args  

Set context bomline for absolute occurrence edit mode.

Parameters
windowTag of bom window
rootLineTag of higher level bom line.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ BOM_window_set_effectivity_grprevs()

ITKCO::BOM_window_set_effectivity_grprevs   args  

This function sets effectivity group revisions on the BOMWindow.

Parameters
windowWindow for which EffectivityGroup Revs are to be set
n_effrevsNumber of effectivity group revisions to be set
effGrpRevListEffectivityGroup Revs to be set on BOMWindow
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ BOP_line_add()

ITKCO::BOP_line_add   args  

Adds a new component to given line.

Parameters
bom_lineBomline to add to
item_folderItem to add, ignored if rev specified
item_revision_folderItem rev to add. For specifying the revision when adding to precise bvrs, if null the item's configured revision is used.
bvThe child's bom view, if any, to be shown if the new child is expanded. Optional
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • new_line: The new bomline

◆ BOP_line_add_with_occ_type()

ITKCO::BOP_line_add_with_occ_type   args  

Adds a new component to given line.

Parameters
bom_lineBomline to add to
item_folderItem to add, ignored if rev specified
item_revision_folderItem rev to add. For specifying the revision when adding to precise bvrs, if null
the item's configured revision is used.
bvThe child's bom view, if any, to be shown if the new child is expanded. Optional.
occTypeoccType
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • new_line The new bomline

autocreated by createClient

◆ CPD_update_item_realization2()

ITKCO::CPD_update_item_realization2   args  

Updates the Reuse Design Element and optionally its Subordinates in a Collaborative Design using the provided source Item Assembly.

Parameters
reuse_de_tagReuse Design Element Tag
item_rev_tagOptional Tag of the Item Revision for the source Item Assembly needed if new Source Assembly is selected for update
sync_effectivity_expressionsFlag set to true to update Variant Expressions on Reuse Design Element structure
update_subordinatesFlag set to true to update Subordinate Design Elements else set to false
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
    – MDL0MODEL_object_has_no_status in case where the source Item Revision is not having a release status.
  • message_text ITK status message
  • num_added_subordinates Number of added Subordinate Design Elements after update Realization
  • added_subordinates Added Subordinate Design Element tags after update Realization
  • num_updated_subordinates Number of updated Subordinate Design Elements after update Realization
  • updated_subordinates Updated Subordinate Design Element tags after update Realization
  • num_removed_subordinates Number of removed Subordinate Design Elements after update Realization
  • removed_subordinates Removed Subordinate Design Element tags after update Realization

autocreated by createClient

◆ EPM_ask_active_job_for_target()

ITKCO::EPM_ask_active_job_for_target   args  

Gets list of jobs for which the given object is one of the target objects in the job. Only the jobs which are in process are returned. Those jobs that are already completed are not listed.

Parameters
target_objectTarget object on which the jobs are to be searched
countExpected number of jobs
jobsList of count jobs in which target_object is one of the targets
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ EPM_set_task_result()

ITKCO::EPM_set_task_result   args  

Sets the result for a task, given the task tag.

Parameters
taskThe task tag
resultThe task's result value to be set.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ ICS_keylov_set_entries()

ITKCO::ICS_keylov_set_entries   args  

Overwrites all existing values of the KeyLOV with the provided ones. Minimal required Teamcenter Version is 11.2.3.

Parameters
theKeyLOVIdThe unique identifier of the KeyLOV
theCountThe number of keys to be added to the KeyLOV
theKeysThe KeyLOV keys to be set into the KeyLOV
theValuesThe values for the keys to be set
theDeprecateStatusThe deprecation statuses corresponding to KeyLOV keys
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ IMF_get_read_file_tickets()

ITKCO::IMF_get_read_file_tickets   args  

Obtains FMS read tickets to be used for retrieving files from a volume. Minimal required Teamcenter Version is 11.2.0.

Parameters
n_file_tagsThe number of file_tags in the array pointed to by file_tags
file_tagsA pointer to an array of file tags
applicationA string denoting whether the tickets are to be used in a multisite environment. If so, it should be set to a value of "Multisite". Otherwise, the value is arbitrary. It can be left blank, if desired
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • ifails An array of integers containing ifail codes for the corresponding element in each generated ticket in the ticket_infos array
  • ticket_infos A character array containing each ticket generated in this request. If a ticket request is in error the associated ifail will contain a value other than ITK_ok. ITK_ok will be returned for all tickets that are correct

autocreated by createClient

◆ ITEM_ask_id2()

ITKCO::ITEM_ask_id2   args  

This function will get the Item ID of the Item. Id in Context = NO: Returns Item.item_id. Id in Context = YES: Returns Item.item_id.

Parameters
itemTag of an Item
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • item_id ID of the Item

autocreated by createClient

◆ ITEM_baseline_rev()

ITKCO::ITEM_baseline_rev   args  

This ITK creates a Baseline Revision for the input Item Revision only.

This ITK creates a Baseline Revision for the input Item Revision only. BOMView Revisions attached to the ItemRevision will be copied forward to the new baseline Revision as per deep copy rules. If the baseline_rev_id is empty, then the ITK would generate a Baseline Revision ID using the USER_new_revision_id_from_alt_rule ("PDR", , , , ,) user_exit. The description entered would be set as the description of the Baseline Revision. Once the creation of the Baseline Revision is completed, the Baseline Revision would undergo the release process as given by the rel_proc_name.

BOMView Revisions attached to the ItemRevision will be copied forward to the new baseline Revision as per deep copy rules. If the baseline_rev_id is empty, then the ITK would generate a Baseline Revision ID using the USER_new_revision_id_from_alt_rule ("PDR", , , , ,) user_exit. The description entered would be set as the description of the Baseline Revision. Once the creation of the Baseline Revision is completed, the Baseline Revision would undergo the release process as given by the rel_proc_name.

Parameters
revItem Revision that needs to be Baselined
new_rev_idThe Revision Id of the Baseline Item Revision
descDescription that needs to be set on the Baseline Item Revision
rel_proc_nameName of the Release Procedure through which the Baseline Revision should under go
jobNameName of the Job
jobDescriptionDescription of the Job
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • new_rev_tag Item Revision Tag of the Baseline Revision created
    - deepCopiedObjCount number of copied objects
  • deepCopiedObjs list of copied objects
Parameters
rev(I) Item Revision that needs to be Baselined
new_rev_id(I) The Revision Id of the Baseline Item Revision
desc(I) Description that needs to be set on the Baseline Item Revision
rel_proc_name(I) Name of the Release Procedure through which the Baseline Revision should under go
jobName(I) Name of the Job
jobDescription(I) Description of the Job
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • new_rev_tag Item Revision Tag of the Baseline Revision created
    - deepCopiedObjCount number of copied objects
  • deepCopiedObjs list of copied objects

◆ ITEM_list_bom_views()

ITKCO::ITEM_list_bom_views   args  

This function will return the tags of all bom views related to the Item.

Parameters
itemTag of an existing Item
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • count Number of bom views found for the Item
  • bv_list Tag list of all the bom views for the Item

autocreated by createClient

◆ ITEM_rev_list_all_bom_view_revs()

ITKCO::ITEM_rev_list_all_bom_view_revs   args  

This function will return the tags of all bom views related to the Item.

Parameters
revTag of the item revision under which the GDE BomViewRevision should be created
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • count Number of BOM Views Revision attached to the above Item Revision
  • bvrs count Tags of BOMView Revisions (including GDE BOMViewRevisions) for the Item Revision

◆ ME_create_bop_window()

ITKCO::ME_create_bop_window   args  

Creates BOP window for Process or Compositions.

Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • window newly created BOP window

◆ ME_create_operation()

ITKCO::ME_create_operation   args  

Creates a new Operation of a given type. It creates a Operation and Operation Revision.

Restrictions:
For a type other than null to be specified, that type must be defined by the site. If type is null, the default type is MEOP. The name will be used as the revision's name.

Note
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters
idoperation identification number - system will assign automatically if empty
revidrevision id for the first rev - can be empty - automatically assigned
typetype name - can be empty - will take default type
nameName of the operation
descDescription for new operation
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • newProcOp tag of the newly created operation

Restrictions: For a type other than null to be specified, that type must be defined by the site. If type is null, the default type is MEOP. The name will be used as the revision's name.

Note: This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

Parameters
idoperation identification number - system will assign automatically if empty
revidrevision id for the first rev - can be empty - automatically assigned
typetype name - can be empty - will take default type
nameName of the operation
descDescription for new operation
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • newProcOp tag of the newly created operation

◆ ME_create_process()

ITKCO::ME_create_process   args  

Creates a new process of a given type. It creates a Process, Process Revision and BV/BVR.

Restrictions:
For a type other than null to be specified, that type must be defined by the site. If type is null, the default type is MEProcess. The name will be used as the revision's name.

Note
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters
idprocess identification number - system will assign automatically if empty
revidrevision id for the first rev - can be empty - automatically assigned
typetype name - can be empty - will take default type
nameName of the process
descDescription of process
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • newProc tag of newly created process

Restrictions: For a type other than null to be specified, that type must be defined by the site. If type is null, the default type is MEProcess. The name will be used as the revision's name. Note: This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

Parameters
idprocess identification number - system will assign automatically if empty
revidrevision id for the first rev - can be empty - automatically assigned
typetype name - can be empty - will take default type
nameName of the process
descDescription of process
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • newProc tag of newly created process

◆ MROCORE_assign_lot()

ITKCO::MROCORE_assign_lot   args  

Assigns the specified Lot to the given Physical Part and deducts the quantity by the specified size.

Assigns the specified Lot to the given Physical Part and deducts the quantity by the specified size.

If the quantity is greater than the Lot usage or the Physical Part quantity then the error is given.

If the specified size is less than the expected quantity then
the Physical Part with remaining quantity is created with the Missing usage.

If the quantity is greater than the Lot usage or the Physical Part quantity then the error is given.
If the specified size is less than the expected quantity then the Physical Part with remaining quantity is created with the Missing usage.

Parameters
physical_bom_lineTag of Physical BOM Line.
physical_part_revisionTag of Physical Part Revision.
lotTag of Lot.
quantityQuantity that will be deducted on lot assignment.
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
    – MROCORE_lot_usage_error if the Lot Size is exhausted for Lot Number. Please select another Lot.
    – MROCORE_lot_is_expired if the Lot expiration date is earlier than manufacturing date while assigning the Lot to Physical Part.
  • message_text ITK status message

autocreated by createClient

Parameters
physical_bom_lineTag of Physical BOM Line.
physical_part_revisionTag of Physical Part Revision.
lotTag of Lot.
quantityQuantity that will be deducted on lot assignment.
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e. – ITK_ok on success – MROCORE_lot_usage_error if the Lot Size is exhausted for Lot Number. Please select another Lot. – MROCORE_lot_is_expired if the Lot expiration date is earlier than manufacturing date while assigning the Lot to Physical Part.
  • message_text ITK status message

autocreated by createClient

◆ MROCORE_rebase_physical_part()

ITKCO::MROCORE_rebase_physical_part   args  

ITK function to rebase Physical Part to Neutral Part.

Parameters
physicalBOMLineTag of Physical BOM Line.
neutralBOMLineTag of Neutral BOM Line.
rebaseDateRebase date.
By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
structureContextStructure Context Name.
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
    – MROCORE_lot_usage_error if the Lot Size is exhausted for Lot Number. Please select another Lot.
    – MROCORE_lot_is_expired if the Lot expiration date is earlier than manufacturing date while assigning the Lot to Physical Part.
  • message_text ITK status message

autocreated by createClient

◆ MROCORE_record_utilization()

ITKCO::MROCORE_record_utilization   args  

ITK function for record utilization.

Parameters
physBOMLinePhysical BOMLine Tag.
logBookLog Book Tag.
in_paramContains the utilization data to record for physical part. Utilization data is a dict containig the following values:
  • description Description
  • recordingTime Recorded at
    By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
    but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
  • capturedBy Captured by
  • propagate Boolean to indicate Propagate the value to child physical part
charValueParamsList containing the Characteristics value for physical part. List entries are dicts containig the following values:
  • charDef Tag of Characteristics Definition
  • value Value for the Characteristic
  • dateValue Date Value for the Characteristic
    By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
    but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
countNumber of list entries, i. e. Characteristic values for physical part
Returns
Dictionary having the following fields:
  • itk ITK status code; i. e.
    – ITK_ok on success
    – MROCORE_lot_usage_error if the Lot Size is exhausted for Lot Number. Please select another Lot.
    – MROCORE_lot_is_expired if the Lot expiration date is earlier than manufacturing date while assigning the Lot to Physical Part.
  • message_text ITK status message
  • logEntry the log entry tag

◆ POM_attr_id_of_attr()

ITKCO::POM_attr_id_of_attr   args  

Returns the attr_id for the specified attribute in the specified class.

Returns the attr_id for the specified attribute in the specified class.
Supports rollback using markpoints.

Supports rollback using markpoints.

Parameters
attr_nameName of attribute
class_nameName of class
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • attr_id of the specified attribute

Sample code sequence

1 set ItkResult [::ITKCO::POM_attr_id_of_attr "object_desc" "ItemRevision"]
2 if {[dict get $ItkResult itk] == 0} {
3  set AttrId [dict get $ItkResult attr_id]
4 }

autocreated by createClient

Parameters
attr_nameName of attribute
class_nameName of class
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • attr_id of the specified attribute

Sample code sequence

1 set ItkResult [::ITKCO::POM_attr_id_of_attr "object_desc" "ItemRevision"]
2 if {[dict get $ItkResult itk] == 0} {
3  set AttrId [dict get $ItkResult attr_id]
4 }

autocreated by createClient

◆ POM_is_loaded()

ITKCO::POM_is_loaded   args  

Checks whether the given instance is loaded in the callers DS or not. Newly created instances are counted as loaded as they are already present in DS.

Parameters
instanceTag of the object
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • verdict true | false

autocreated by createClient

◆ POM_set_attr_null()

ITKCO::POM_set_attr_null   args  

Changes the specified attributes to NULL for the specified instances. The changes occur in the DS only.

Changes the specified attributes to NULL for the specified instances. The changes occur in the DS only. The attribute must exist for all the instances, therefore there must be a class with that attribute, and the instances must be in that class or a subclass of it.
Supports rollback using markpoints.

The attribute must exist for all the instances, therefore there must be a class with that attribute, and the instances must be in that class or a subclass of it.

Supports rollback using markpoints.

Parameters
n_instancesNumber of instances to set
instance_tagsArray of n_instances tags of these instances
attr_idAttribute ID
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

Sample code sequence

1 set ItkResult [::ITKCO::POM_attr_id_of_attr "object_desc" "ItemRevision"]
2 if {[dict get $ItkResult itk] == 0} {
3  set AttrId [dict get $ItkResult attr_id]
4  set ObjectList [list $ItemRevisionTag]
5 
6  # lock instances
7  foreach inst $ObjectList {
8  set ItkLockStatus [::ITK::AOM_refresh_lock $inst]
9  }
10 
11  set ItkResult [::ITKCO::POM_set_attr_null [llength $ObjectList] $ObjectList $AttrId]
12 
13  # save and unlock instances
14  foreach inst $ObjectList {
15  set ItkSaveStatus [::ITK::AOM_save $inst]
16  set ItkUnlockStatus [::ITK::AOM_refresh_unlock $inst]
17  }
18 }
Parameters
n_instancesNumber of instances to set
instance_tagsArray of n_instances tags of these instances
attr_idAttribute ID
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

Sample code sequence

1 set ItkResult [::ITKCO::POM_attr_id_of_attr "object_desc" "ItemRevision"]
2 if {[dict get $ItkResult itk] == 0} {
3  set AttrId [dict get $ItkResult attr_id]
4  set ObjectList [list $ItemRevisionTag]
5 
6  # lock instances
7  foreach inst $ObjectList {
8  set ItkLockStatus [::ITK::AOM_refresh_lock $inst]
9  }
10 
11  set ItkResult [::ITKCO::POM_set_attr_null [llength $ObjectList] $ObjectList $AttrId]
12 
13  # save and unlock instances
14  foreach inst $ObjectList {
15  set ItkSaveStatus [::ITK::AOM_save $inst]
16  set ItkUnlockStatus [::ITK::AOM_refresh_unlock $inst]
17  }
18 }

◆ POM_set_attr_nulls()

ITKCO::POM_set_attr_nulls   args  

Changes (all or some of) the specified array-valued attribute to NULL for the specified instances. The changes occur in the DS only.

Changes (all or some of) the specified array-valued attribute to NULL for the specified instances. The changes occur in the DS only.
Supports rollback using markpoints.

Supports rollback using markpoints.

Parameters
n_instancesNumber of instances to set
instance_tagsArray of n_instances tags of these instances
attr_idAttribute ID
startPosition in the VLA to start setting values
n_valuesNumber of values to be set
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

Sample code sequence

1 # set ArrayAttributeName to some attribute of array type
2 set ItkResult [::ITKCO::POM_attr_id_of_attr $ArrayAttributeName "ItemRevision"]
3 if {[dict get $ItkResult itk] == 0} {
4  set ArrAttrId [dict get $ItkResult attr_id]
5  set ObjectList [list $ItemRevisionTag]
6 
7  # lock object
8  foreach inst $ObjectList {
9  set ItkLockStatus [::ITK::AOM_refresh_lock $inst]
10  }
11 
12  # we set 2 entries to null beginning with index 3
13  set ItkResult [::ITKCO::POM_set_attr_nulls [llength $ObjectList] $ObjectList $ArrAttrId 3 2]
14  set ArrGetStatus [::ITK::AOM_ask_values $ObjectTag $ArrAttributeName]
15  puts "*** ::ITK::AOM_ask_values returns $ArrGetStatus"
16 
17  # save and unlock object
18  foreach inst $ObjectList {
19  set ItkSaveStatus [::ITK::AOM_save $inst]
20  set ItkUnlockStatus [::ITK::AOM_refresh_unlock $inst]
21  }
22 }

autocreated by createClient

Parameters
n_instancesNumber of instances to set
instance_tagsArray of n_instances tags of these instances
attr_idAttribute ID
startPosition in the VLA to start setting values
n_valuesNumber of values to be set
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

Sample code sequence

1 # set ArrayAttributeName to some attribute of array type
2 set ItkResult [::ITKCO::POM_attr_id_of_attr $ArrayAttributeName "ItemRevision"]
3 if {[dict get $ItkResult itk] == 0} {
4  set ArrAttrId [dict get $ItkResult attr_id]
5  set ObjectList [list $ItemRevisionTag]
6 
7  # lock object
8  foreach inst $ObjectList {
9  set ItkLockStatus [::ITK::AOM_refresh_lock $inst]
10  }
11 
12  # we set 2 entries to null beginning with index 3
13  set ItkResult [::ITKCO::POM_set_attr_nulls [llength $ObjectList] $ObjectList $ArrAttrId 3 2]
14  set ArrGetStatus [::ITK::AOM_ask_values $ObjectTag $ArrAttributeName]
15  puts "*** ::ITK::AOM_ask_values returns $ArrGetStatus"
16 
17  # save and unlock object
18  foreach inst $ObjectList {
19  set ItkSaveStatus [::ITK::AOM_save $inst]
20  set ItkUnlockStatus [::ITK::AOM_refresh_unlock $inst]
21  }
22 }

autocreated by createClient

◆ POM_set_attr_string()

ITKCO::POM_set_attr_string   args  

Changes the specified attribute to the specified value for each of the specified instances (which must all be in the same class). The changes occur in the DS only.

Changes the specified attribute to the specified value for each of the specified instances (which must all be in the same class). The changes occur in the DS only.
Supports rollback using markpoints.

Supports rollback using markpoints.

Parameters
n_instancesNumber of instances to set
instance_tagsArray of n_instances tags of these instances
attr_idAttribute ID
valueNew attribute value
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

Sample code sequence

1 set ItkResult [::ITKCO::POM_attr_id_of_attr "object_desc" "ItemRevision"]
2 if {[dict get $ItkResult itk] == 0} {
3  set AttrId [dict get $ItkResult attr_id]
4  set ObjectList [list $ItemRevisionTag]
5 
6  # lock object
7  foreach inst $ObjectList {
8  set ItkLockStatus [::ITK::AOM_refresh_lock $inst]
9  }
10 
11  set ItkResult [::ITKCO::POM_set_attr_string [llength $ObjectList] $ObjectList $AttrId "My new description"]
12 
13  # save and unlock object
14  foreach inst $ObjectList {
15  set ItkSaveStatus [::ITK::AOM_save $inst]
16  set ItkUnlockStatus [::ITK::AOM_refresh_unlock $inst]
17  }
18 }

autocreated by createClient

Parameters
n_instancesNumber of instances to set
instance_tagsArray of n_instances tags of these instances
attr_idAttribute ID
valueNew attribute value
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

Sample code sequence

1 set ItkResult [::ITKCO::POM_attr_id_of_attr "object_desc" "ItemRevision"]
2 if {[dict get $ItkResult itk] == 0} {
3  set AttrId [dict get $ItkResult attr_id]
4  set ObjectList [list $ItemRevisionTag]
5 
6  # lock object
7  foreach inst $ObjectList {
8  set ItkLockStatus [::ITK::AOM_refresh_lock $inst]
9  }
10 
11  set ItkResult [::ITKCO::POM_set_attr_string [llength $ObjectList] $ObjectList $AttrId "My new description"]
12 
13  # save and unlock object
14  foreach inst $ObjectList {
15  set ItkSaveStatus [::ITK::AOM_save $inst]
16  set ItkUnlockStatus [::ITK::AOM_refresh_unlock $inst]
17  }
18 }

autocreated by createClient

◆ POM_set_attr_strings()

ITKCO::POM_set_attr_strings   args  

Changes (all or some of) the specified array-valued attribute to the specified array of values for each of the specified instances (which must all be in the same class).

Changes (all or some of) the specified array-valued attribute to the specified array of values for each of the specified instances (which must all be in the same class). The changes occur in the DS only.
Supports rollback using markpoints.

The changes occur in the DS only.
Supports rollback using markpoints.

Parameters
n_instancesNumber of instances to set
instance_tagsArray of n_instances tags of these instances
attr_idAttribute ID
startPosition in the VLA to start setting values
n_valuesNumber of values to be set
valuesArray of n_values of the appropriate type
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

Sample code sequence

1 # set ArrayAttributeName to some attribute of type string array
2 set ItkResult [::ITKCO::POM_attr_id_of_attr $ArrayAttributeName "ItemRevision"]
3 if {[dict get $ItkResult itk] == 0} {
4  set ArrAttrId [dict get $ItkResult attr_id]
5  set ObjectList [list $ItemRevisionTag]
6 
7  # lock object
8  foreach inst $ObjectList {
9  set ItkLockStatus [::ITK::AOM_refresh_lock $inst]
10  }
11 
12  set NewValues [list "My new string0" "My new string1" "My new string2" "My new string3" "My new string4"]
13  set ItkResult [::ITKCO::POM_set_attr_strings [llength $ObjectList] $ObjectList $ArrAttrId 0 [llength $NewValues] $NewValues]
14  set ArrGetStatus [::ITK::AOM_ask_values $ObjectTag $ArrAttributeName]
15  puts "*** ::ITK::AOM_ask_values returns $ArrGetStatus"
16 
17  # save and unlock object
18  foreach inst $ObjectList {
19  set ItkSaveStatus [::ITK::AOM_save $inst]
20  set ItkUnlockStatus [::ITK::AOM_refresh_unlock $inst]
21  }
22 }

autocreated by createClient

Parameters
n_instancesNumber of instances to set
instance_tagsArray of n_instances tags of these instances
attr_idAttribute ID
startPosition in the VLA to start setting values
n_valuesNumber of values to be set
valuesArray of n_values of the appropriate type
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

Sample code sequence

1 # set ArrayAttributeName to some attribute of type string array
2 set ItkResult [::ITKCO::POM_attr_id_of_attr $ArrayAttributeName "ItemRevision"]
3 if {[dict get $ItkResult itk] == 0} {
4  set ArrAttrId [dict get $ItkResult attr_id]
5  set ObjectList [list $ItemRevisionTag]
6 
7  # lock object
8  foreach inst $ObjectList {
9  set ItkLockStatus [::ITK::AOM_refresh_lock $inst]
10  }
11 
12  set NewValues [list "My new string0" "My new string1" "My new string2" "My new string3" "My new string4"]
13  set ItkResult [::ITKCO::POM_set_attr_strings [llength $ObjectList] $ObjectList $ArrAttrId 0 [llength $NewValues] $NewValues]
14  set ArrGetStatus [::ITK::AOM_ask_values $ObjectTag $ArrAttributeName]
15  puts "*** ::ITK::AOM_ask_values returns $ArrGetStatus"
16 
17  # save and unlock object
18  foreach inst $ObjectList {
19  set ItkSaveStatus [::ITK::AOM_save $inst]
20  set ItkUnlockStatus [::ITK::AOM_refresh_unlock $inst]
21  }
22 }

autocreated by createClient

◆ POM_set_creation_utc_date()

ITKCO::POM_set_creation_utc_date   args  

Sets the creation date using the GMT instead of the local time (as POM_set_creation_date does).

Supports rollback using markpoints: YES.

Parameters
instanceTag of instance in which to set the creation date
creation_dateNew date to be set in instance.
By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
Returns
Dictionary having the following fields:
  • itk ITK status code. i. e POM_ok on success, POM_insufficient_privilege if a non-privileged user tries to reset a creation date
  • message_text ITK status message

◆ POM_set_env_info()

ITKCO::POM_set_env_info   args  

Sets the specified environmental information.

Currently it can be used to:

  • Enable/disable rollback
  • Enable/disable in-DS attribute-value-checking(for e.g. duplication of unique attributes, or for checking against upper/lower bounds)
  • Enable/disable POM journaling (writing functions and arguments to the system log - for debugging and bug reporting)
  • Enable/disable argument checking
  • Enable/disable logging the SQL processed to the file
  • Enable/disable creation of tracebacks from the ERROR system
  • Disable/enable access manager checks (value is "false" for AM bypass is disabled - AM checks are enabled by default).
    Requires Sys Admin privilege to change (intended for data migration utilities).
  • Disable/enable updating last modifying user and last modify dates when instances are saved (value is "true" for Attr bypass disabled (note: counter intuitive given AM bypass token). Requires Sys Admin privilege to change )intended for data migration utilities).
  • Setting pattern match characters for queries
    • the wildcard_one character will match any single character
    • the wildcard_any character will match a sequence of character
    • the wildcard_escape charcter flags the following character as "not being special"
    • By default these are _ % and ~ so the string Hello_world\% will match anything followed by Hello world% where the space between Hello and world can be any single character
  • Set the location of the directory where POM transmit files live (defaults to the POM_TRANSMIT_DIR environment variable)
  • Set the import mode (to one of POM_import_raise_error, POM_import_always_map, POM_import_default_to_map, POM_import_default_to_current or POM_import_default_as_apt
  • Set the importing user and group (if importing in a mapping mode)
  • Enable/disable automatic unique constraint checking for private versions
  • Set POM as disabled (this can be used if we have lost a database connexion, or run out of memory) - in this mode most POM functions will simply return POM_api_disabled
  • Select the action to be taken if a database operation requires retrying
    Token Type POM Initial Value ITK Initial Value
    POM_rollback_switch logicalfalse (OFF) false (OFF)
    POM_ds_checking_switch logicalfalse (OFF) false (OFF)
    POM_error_traceback_switch logicaltrue (ON) true (ON)
    POM_log_sql_switch logicalOFF OFF
    POM_journaling_switch logicaltrue (ON) true (ON)
    POM_arg_checking_switch logicaltrue (ON) true (ON)
    POM_timeout_strategy int 0 (don't retry) 0 (don't retry)
    POM_timeout_interval int 0 (don't retry) 0 (don't retry)
    POM_bypass_access_check logicalfalse (OFF) false (OFF)
    POM_bypass_attr_update logicaltrue (ON) true (ON)
    POM_wildcard_character_one int '_' 95, 0x5F '.' 46, 0x2E
    POM_wildcard_character_any int '' 37, 0x25 '*' 42, 0x2A
    POM_escape_character int '~' 126, 0x7E '~' 126, 0x7E </tr
    POM_transmit_directory string $POM_TRANSMIT_DIR $POM_TRANSMIT_DIR
    POM_import_mode int POM_import_default_to_current POM_import_default_to_current
    POM_import_to_user tag unset unset/nulltag
    POM_import_to_group tag unset unset/nulltag
    POM_disable_api logicalfalse (POM enabled) false (POM enabled)
    POM_enable_set_attr_callbackslogicalfalse (POM enabled) false (POM enabled)- true
    POM_check_private_uniqueness_switchlogicaltrue (ON) true (ON)

    Note
    Some ITK initial values may be changed by the login process. Only for use with SPLM guidance.
    The POM_timeout_strategy / POM_timeout_interval pair of "switches" determine the action that POM takes whenever a database operation requires to be retired (due to a deadlock detected by the database server, etc.).
    The "strategies" available are:
    0 Do not retry but return with an error code.
    POM_timeout_strategy_flat On each retry, wait for POM_timeout_interval seconds before retrying.
    POM_timeout_strategy_linearOn each retry, wait for a linearly increasing period of time, starting from POM_timeout_interval seconds.
    POM_timeout_strategy_exp Use an exponentially increasing delay between successive retries.

    When the amount of time spent retrying the operation exceeds that specified by POM_set_timeout, POM returns with an error code to indicate that the call failed.

    Supports rollback using markpoints: NO.
Parameters
what_to_settoken to be set
logical_value_to_set
int_value_to_set
double_value_to_set
tag_value_to_set
string_value_to_set
Returns
Dictionary having the following fields:
  • itk ITK status code. i. e POM_ok on success, POM_insufficient_privilege if a non-privileged user tries to set a modification date
  • message_text ITK status message

◆ POM_set_modification_date()

ITKCO::POM_set_modification_date   args  

Sets the modification date in a POM application object.

This is intended to be used in upgrade programs that wish to retain audit info.

This is only callable by a Teamcenter system administrator.

Note
By default, the POM will automatically update the modification date(and last modifying user) so upgrade programs that set these fields themselves should use ITKCO::POM_set_env_info to set the flag POM_bypass_attr_update in order to avoid the automatic update.
Note that this flag must be set to FALSE to avoid the last modification date being updated when you save the instance.

This function accepts the date in local time and must be later than minimum specified by POM_ask_earlier_date (currently 2nd Jan 1900).
Supports rollback using markpoints: YES.

Parameters
instanceTag of instance in which to set the last-mod-date
modification_dateNew date to be set in instance.
By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
Returns
Dictionary having the following fields:
  • itk ITK status code. i. e POM_ok on success, POM_insufficient_privilege if a non-privileged user tries to set a modification date
  • message_text ITK status message

◆ POM_set_modification_user()

ITKCO::POM_set_modification_user   args  

Sets the last modifying user in a POM application object.

This is intended to be used in upgrade programs that wish to retain audit info.
This is only callable by a Teamcenter system administrator.

Note
By default the POM will automatically update the last modifying user (and modification date) so upgrade programs that set these fields themselves should use ITKCO::POM_set_env_info to set POM_bypass_attr_update to avoid the automatic update.

Supports rollback using markpoints: YES.

Parameters
instanceTag of instance in which to set the last-mod-date
modification_userNew user to be set in instance
Returns
Dictionary having the following fields:
  • itk ITK status code. i. e POM_ok on success, POM_insufficient_privilege if a non-privileged user tries to set a modification date
  • message_text ITK status message

◆ POM_set_modification_utc_date()

ITKCO::POM_set_modification_utc_date   args  

Sets the modification date using the GMT instead of the local time (as ITKCO::POM_set_modification_date does).

Supports rollback using markpoints: YES.

Parameters
instanceTag of instance in which to set the last-mod-date
modification_dateNew date to be set in instance.
By default, the date must have the format Y-m-d H:M:S, e. g. "2016-02-18 5:10:20"
but a different format can be specified with the date string, separated by '@', e. g. "18.2.16 5:10:20@%d.%m.%y %H:%M:%S"
Returns
Dictionary having the following fields:
  • itk ITK status code. i. e POM_ok on success, POM_insufficient_privilege if a non-privileged user tries to set a modification date
  • message_text ITK status message

◆ PREF_export_preference_list()

ITKCO::PREF_export_preference_list   args  

Exports the specified preferences from the specified location to the specified output file.

Nothing will be exported if the named preferences are not found under the specified location.

The possible values for the location parameter are:

  • TC_preference_user Exports the specified preferences from the user location.
  • TC_preference_role Exports the specified preferences from the user location.
  • TC_preference_group Exports the specified preferences from the group location.
  • TC_preference_site Exports the specified preferences from the site location.

The user/role/group are the ones for the current logged-in user.

Parameters
preference_countNumber of preferences to export
preference_namesName of the preferences to export
locationLocation of the preferences to export
output_file_nameOutput export file name
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ PS_ask_bom_view_type()

ITKCO::PS_ask_bom_view_type   args  

Returns the view type of a BOMView.

Parameters
bom_viewTag of the BOMView
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • view_type Tag of the BOMView view type

◆ PS_create_bom_view()

ITKCO::PS_create_bom_view   args  

Creates a new BOMView.

Creates a new BOMView. No BOMView Revisions exist yet. The BOMView is made a view of the specified item. If view_type is NULLTAG, the default view type will be used (as given by PS_ask_default_view_type).

No BOMView Revisions exist yet. The BOMView is made a view of the specified item. If view_type is NULLTAG, the default view type will be used (as given by PS_ask_default_view_type).

Note
The new BOMView is not saved. It can be saved to the database using AOM_save. Note that the parent_item is modified and must also be saved. The new BOMView must be saved before the parent_item is saved. Failure to do so results in the BOMView not being added to the parent.
Parameters
view_typeSite-specific identifier for the type of view (e.g., DESIGN, Assembly)
view_nameName of the view. If NULL or empty string is specified, the default name is used.
view_descOptional description text (NULL if not required)
parent_itemMakes the new BOMView a view of this Item
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • bom_view Returns the tag of the new BOMView

    Note: The new BOMView is not saved. It can be saved to the database using AOM_save. Note that the parent_item is modified and must also be saved. The new BOMView must be saved before the parent_item is saved. Failure to do so results in the BOMView not being added to the parent.

Parameters
view_typeSite-specific identifier for the type of view (e.g., DESIGN, Assembly)
view_nameName of the view. If NULL or empty string is specified, the default name is used.
view_descOptional description text (NULL if not required)
parent_itemMakes the new BOMView a view of this Item
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • bom_view Returns the tag of the new BOMView

◆ PS_create_bvr()

ITKCO::PS_create_bvr   args  

Creates an initial working revision of a BOMView, with no occurrences.

Creates an initial working revision of a BOMView, with no occurrences. The BOMView Revision created is made an attribute of the specified parent Item Revision. This Item Revision must be a revision of the Item that is the parent of the BOMView.

The BOMView Revision created is made an attribute of the specified parent Item Revision. This Item Revision must be a revision of the Item that is the parent of the BOMView.

Note
The new BOMView Revision is not saved, it can be saved to the database using AOM_save. Note that the parent Item Revision is modified and must also be saved. The new BOMView Revision must be saved before the parent Item Revision is saved. Failure to do so results in the BOMView Revision not being added to the parent.
Parameters
bom_viewTag of the BOMView for which the first revision is to be created
revision_nameRevision name. If NULL or empty string "" is specified, the default name is used. See also PS_default_bvr_name.
revision_descA description of the revision (can be NULL)
preciseIf true the BOMView Revision can have precise occurrences of child Item Revisions. If false it can have imprecise occurrence of child Items.
parent_irThe tag of the parent Item Revision of the BOMView Revision
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • bvr Returns the tag of the newly created BOMView Revision

    Note: The new BOMView Revision is not saved, it can be saved to the database using AOM_save. Note that the parent Item Revision is modified and must also be saved. The new BOMView Revision must be saved before the parent Item Revision is saved. Failure to do so results in the BOMView Revision not being added to the parent.

Parameters
bom_viewTag of the BOMView for which the first revision is to be created
revision_nameRevision name. If NULL or empty string "" is specified, the default name is used. See also PS_default_bvr_name.
revision_descA description of the revision (can be NULL)
preciseIf true the BOMView Revision can have precise occurrences of child Item Revisions. If false it can have imprecise occurrence of child Items.
parent_irThe tag of the parent Item Revision of the BOMView Revision
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • bvr Returns the tag of the newly created BOMView Revision

◆ PS_list_occurrences_of_bvr()

ITKCO::PS_list_occurrences_of_bvr   args  

Lists all of the occurrences of the specified BOMViewRevision.

Parameters
bvrTag of the BOMView Revision
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • n_occurrences Number of occurrences returned
  • occurrences Returned list of occurrence tags

◆ SA_ask_site_info_ex2()

ITKCO::SA_ask_site_info_ex2   args  

Returns the name, ID and external app status of the specified site.

Parameters
site_tagSite tag
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • sitename Site name
  • site_id Site id
  • external_app External app of site

autocreated by createClient

◆ TCTYPE_ask_deepcopydata()

ITKCO::TCTYPE_ask_deepcopydata   args  

Retrieves the DeepCopyData tag(s) for the input object, a top-level object undergoing the operation type specified by opvar, such as SaveAs or Revise.

Parameters
objectThe tag of the top-level object being revised or saved
operation_inputThe operation type; this can be the full name like e.g. TCTYPE_OPERATIONINPUT_CREATE or a shortcut like OPERATIONINPUT_CREATE or just CREATE
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • number_of_attached_objects The number of objects related to the top-level object through a relation or reference property
  • deep_copy_data Array of the DeepCopyData tags

◆ TCTYPE_construct_operationinput()

ITKCO::TCTYPE_construct_operationinput   args  

Constructs a SaveAsInput object for the input Business Object. Use this SaveAsInput object to hold input data for the creation of an object.

Parameters
target_object_typeBusiness Object type tag
operation_inputThe operation type; this can be the full name like e.g. TCTYPE_OPERATIONINPUT_CREATE or a shortcut like OPERATIONINPUT_CREATE or just CREATE
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • target_save_as_input Resulting object tag

◆ TCTYPE_revise_objects()

ITKCO::TCTYPE_revise_objects   args  

Revises the specified input objects according to the revise data in the ReviseInput objects and deep copies the attached objects based on the DeepCopyData provided.

Note
It is necessary to check the returned array returned in the parameter ifails to determine the error status of a particular object.
Parameters
number_target_objectsThe number of objects to be revised
target_object_tagsArray of target objects (objects being revised)
revise_input_tagsArray of ReviseInput tags for the target objects, containing user input
number_attached_objsArray of ints in which the value of nth element in num_attached_objs is the number of the objects attached to nth element in target_object_tags
deep_copy_data_tagsArray of DeepCopyData tags for the attached objects
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • target_copy_tags Array of tags of the revised objects
  • ifails Array of ifail errors for the top-level target objects
    Possible values for the array in the parameter ifails are: – ITK_ok on success. – TCCORE_revise_not_supported if the target object is not configured to allow the revise operation. – ITEM_duplicate_rev if a revision with a requested revision id already exists.

autocreated by createClient

Note: It is necessary to check the returned array returned in the parameter ifails to determine the error status of a particular object. Possible values for the array in the parameter ifails are:

  • ITK_ok on success.
  • TCCORE_revise_not_supported if the target object is not configured to allow the revise operation.
  • ITEM_duplicate_rev if a revision with a requested revision id already exists.
Parameters
number_target_objectsThe number of objects to be revised
target_object_tagsArray of target objects (objects being revised)
revise_input_tagsArray of ReviseInput tags for the target objects, containing user input
number_attached_objsArray of ints in which the value of nth element in num_attached_objs is the number of the objects attached to nth element in target_object_tags
deep_copy_data_tagsArray of DeepCopyData tags for the attached objects
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • target_copy_tags Array of tags of the revised objects
  • ifails Array of ifail errors for the top-level target objects

autocreated by createClient

◆ TCTYPE_saveas_object()

ITKCO::TCTYPE_saveas_object   args  

Performs a SaveAs operation on the specified object according to the SaveAs data in the SaveAsInput objects and deep copies the attached objects based upon the DeepCopyData provided.

DeepCopyData for an object may be null if no Deep Copy Rule is defined for its type.

Note
An exception will be thrown if invalid tags are provided in the parameters target_object_tag or save_as_input_tag.
Parameters
target_object_tagThe tag of the target object (objects being saved)
save_as_input_tagThe tag of the SaveAsInput for the target object, containing user input
number_of_attached_objectsThe number of objects attached to the target object
deep_copy_data_tagsArray of DeepCopyData tags for the attached objects
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • target_copy_tag The tag of the copy of the top-level object saved

autocreated by createClient

DeepCopyData for an object may be null if no Deep Copy Rule is defined for its type. Note: An exception will be thrown if invalid tags are provided in the parameters target_object_tag or save_as_input_tag.

Parameters
target_object_tagThe tag of the target object (objects being saved)
save_as_input_tagThe tag of the SaveAsInput for the target object, containing user input
number_of_attached_objectsThe number of objects attached to the target object
deep_copy_data_tagsArray of DeepCopyData tags for the attached objects
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • target_copy_tag The tag of the copy of the top-level object saved

autocreated by createClient

◆ VRULE_ask_rule_text()

ITKCO::VRULE_ask_rule_text   args  

Retrieves the contents of a Variant Rule in text format.

Retrieves the contents of a Variant Rule in text format. The BOM Window can be used to context. If it is set to #NULLTAG, a BOM Window will be created with a default configuration.

The BOM Window can be used to context. If it is set to NULLTAG, a BOM Window will be created with a default configuration.

Parameters
vruleTag of variant rule to query
bom_windowTag of BOM Window that supplies variant option values
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • n_entries Number of options defined in the rule
  • items List of item IDs on which the options are defined
  • options List of names of the options stored in the rule
  • descriptions List of descriptions of the options stored in the rule
  • values List of values of the options stored in the rule

autocreated by createClient

Parameters
vruleTag of variant rule to query
bom_windowTag of BOM Window that supplies variant option values
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • n_entries Number of options defined in the rule
  • items List of item IDs on which the options are defined
  • options List of names of the options stored in the rule
  • descriptions List of descriptions of the options stored in the rule
  • values List of values of the options stored in the rule

autocreated by createClient

◆ VRULE_create_from_bom()

ITKCO::VRULE_create_from_bom   args  

Creates a Variant Rule with the given name and description.

Creates a Variant Rule with the given name and description. This new rule is populated with the supplied list of options, with the values being taken from the given BOM window. If n_options is set to zero, then all set options (by user or rule) are saved.

This new rule is populated with the supplied list of options, with the values being taken from the given BOM window. If n_options is set to zero, then all set options (by user or rule) are saved.

Parameters
nameName for the new variant rule
descriptionDescription for the new variant rule
bom_windowTag of BOM Window that supplies variant option values
n_optionsNumber of variant options in the supplied option list.
optionsList of variant options to save to the new Rule.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • vrule Tag of newly created variant rule

autocreated by createClient

Parameters
nameName for the new variant rule
descriptionDescription for the new variant rule
bom_windowTag of BOM Window that supplies variant option values
n_optionsNumber of variant options in the supplied option list.
optionsList of variant options to save to the new Rule.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • vrule Tag of newly created variant rule

autocreated by createClient

◆ VRULE_create_from_variant_rule()

ITKCO::VRULE_create_from_variant_rule   args  

Creates a new variant rule and populates it using option values set in the given BOM variant rule.

Creates a new variant rule and populates it using option values set in the given BOM variant rule. Only those options which have been manually set (either by the user or by another variant rule) are stored in the new rule.

Only those options which have been manually set (either by the user or by another variant rule) are stored in the new rule.

Parameters
nameName for the new variant rule
descriptionDescription for the new variant rule
bomvariantruleTag of the BOM variant rule that supplies the variant option values
n_optionsNumber of variant options in the supplied option list.
optionsList of variant options to save to the new Rule.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • vrule Tag of newly created variant rule

autocreated by createClient

Parameters
nameName for the new variant rule
descriptionDescription for the new variant rule
bomvariantruleTag of the BOM variant rule that supplies the variant option values
n_optionsNumber of variant options in the supplied option list.
optionsList of variant options to save to the new Rule.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • vrule Tag of newly created variant rule

autocreated by createClient

◆ VRULE_set_from_bom()

ITKCO::VRULE_set_from_bom   args  

Saves a given set of option values to an existing variant rule.

Saves a given set of option values to an existing variant rule. Only those options which have been manually set (either by the user or by another variant rule) are stored in the rule.

Only those options which have been manually set (either by the user or by another variant rule) are stored in the rule.

Parameters
vruleTag of variant rule to save the values to
bom_windowTag of BOM Window that supplies variant option values
update_onlyBoolean value to control whether the supplied option values will replace
n_optionsNumber of variant options in the supplied option list.
optionsList of variant options to save to the new Rule.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

Parameters
vruleTag of variant rule to save the values to
bom_windowTag of BOM Window that supplies variant option values
update_onlyBoolean value to control whether the supplied option values will replace
n_optionsNumber of variant options in the supplied option list.
optionsList of variant options to save to the new Rule.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ VRULE_set_from_variant_rule()

ITKCO::VRULE_set_from_variant_rule   args  

Saves the given list of options (with their values being taken from the BOM Variant Rule) to the given existing Variant Rule.

Saves the given list of options (with their values being taken from the BOM Variant Rule) to the given existing Variant Rule.
If n_options is zero, then all set options (by user or rule) are saved.
If update_only is set to TRUE, then only those options which are already in the rule are saved.

If n_options is zero, then all set options (by user or rule) are saved.
If update_only is set to TRUE, then only those options which are already in the rule are saved.

Parameters
vruleTag of variant rule to save the values to
bomvariantruleTag of the BOM variant rule that supplies the variant option values
update_onlyBoolean value to control whether the supplied option values will replace
n_optionsNumber of variant options in the supplied option list.
optionsList of variant options to save to the new Rule.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

Parameters
vruleTag of variant rule to save the values to
bomvariantruleTag of the BOM variant rule that supplies the variant option values
update_onlyBoolean value to control whether the supplied option values will replace
n_optionsNumber of variant options in the supplied option list.
optionsList of variant options to save to the new Rule.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ WSOM_ask_object_type2()

ITKCO::WSOM_ask_object_type2   args  

Returns the object type of the specified WorkspaceObject.

Parameters
a_WSO_tagTag of the object
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • object_type returned object type

autocreated by createClient

◆ WSOM_ask_revision()

ITKCO::WSOM_ask_revision   args  

Returns the revision number of the WorkspaceObject.

Parameters
a_WSO_tagTag of the object
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • rev_number Revision of the object

autocreated by createClient

◆ WSOM_copy()

ITKCO::WSOM_copy   args  

Creates a copy of the input WorkspaceObject.

Creates a copy of the input WorkspaceObject. No Deep Copy is performed. To copy the whole object (including its related objects), TCTYPE_saveas_object should be used.

No Deep Copy is performed. To copy the whole object (including its related objects), TCTYPE_saveas_object should be used.

Parameters
a_WSO_tagTag of the object
new_nameThe name of the copied object. A NULL pointer can be provided, in which case explain_what_happens_t Some subclasses may enforce unique names among instances of their class. In that case a new unique name is required or an error is returned.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • copied_wso The copied Workspace Object

autocreated by createClient

Parameters
a_WSO_tagTag of the object
new_nameThe name of the copied object. A NULL pointer can be provided, in which case explain_what_happens_t Some subclasses may enforce unique names among instances of their class. In that case a new unique name is required or an error is returned.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message
  • copied_wso The copied Workspace Object

autocreated by createClient

◆ WSOM_eff_set_unit_range()

ITKCO::WSOM_eff_set_unit_range   args  

Parses the range_text string and sets the effectivity range to the values extracted.

If append is true, the range values are added to the existing unit range, otherwise the range is replaced with the values specified.

Parameters
release_statusTag of the release status to which the effectivity belongs
effectivityTag of the effectivity
range_textRange text
appendAppend value
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient

◆ WSOM_eff_set_units()

ITKCO::WSOM_eff_set_units   args  

Uses an array of integers to set the unit range for a given effectivity.

The release status is locked by this call; call AOM_save to commit the changes to the database.

Restrictions:

  1. Values should be in ascending order.
  2. The value of open_ended_or_stock_out should be either EFFECTIVITY_open_ended, EFFECTIVITY_stock_out or EFFECTIVITY_closed. If the value is EFFECTIVITY_closed, then n_units has to be even, otherwise n_units has to be odd.
  3. Unit ranges must be qualified against an end item, i.e., they cannot have NULLTAG end item.
Parameters
release_statusTag of the release status to which the effectivity belongs
effectivityTag of the effectivity
n_unitsThe size of the array or start-end values
start_end_valuesThe array of start-end values of the discontinuous range. For example, consider a discontinuous range consisting of continuous ranges r1, r2, ..., rn where rx has start and end values, rx.start and rx.end. The array of start_end_vals for this discontinuous range will be constructed as { r1.start, r1.end, r2.start, r2.end, ..., rn.start, rn.end }. The last value, rn.end should be omitted if the discontinuous range is open ended.
open_ended_or_stock_outOne of the following constants: EFFECTIVITY_open_ended, EFFECTIVITY_stock_out or EFFECTIVITY_closed.
appendIf set to true, the values in the array will be added to the unit range, otherwise they will replace them.
Returns
Dictionary having the following fields:
  • itk ITK status code
  • message_text ITK status message

autocreated by createClient