![]() |
T4S4
18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API 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... | |
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.
object_tag | Unique identifier (tag) of the object instance. |
prop_name | A property name of the object instance. |
value | Actual value being set on the property. |
autocreated by createClient
ITKCO::AOM_unload | args | ||
Removes an object from your local POM memory You can reload the object later with the same tag if necessary.
object_tag | Unique identifier (tag) of the object instance. |
autocreated by createClient
ITKCO::ASMAINTAINED_gen_phystruc | args | ||
ITK function to generate AsMaintained Structure.
inLine | Neutral BOM line |
inParam | Generate Asm Structure Params in a dict containing the following values:
|
ITKCO::ASMAINTAINED_get_physical_part_children_list | args | ||
Retrieves the physical part children list from a Physical BOM Line.
physical_bom_line | Physical part BOM Line Tag |
ITKCO::ASMAINTAINED_install_physical_part | args | ||
ITK function to install Physical Part in AsMaintained Structure.
selectedAsMaintainedLine | Selected AsMaintainedBOMLine on which installation happens |
copiedPhysicalPart | Child Physical Part which needs to be installed |
usageBOMLineImpl | BOMLine with a PSOccurrence - Position on which the installation happens |
inParams | Dialog Input as a dict containing the following values:
|
ITKCO::ASMAINTAINED_move_physical_part | args | ||
ITK function to change Physical Part location.
physPart | Physical part or physical part revision tag |
location | Location tag |
inTime | Date 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" |
ITKCO::ASMAINTAINED_replace_physical_part | args | ||
ITK function to replace Physical Part in AsMaintained Structure.
selectedAsMaintainedLine | Selected AsMaintainedBOMLine tag on which installation happens |
copiedPhysicalPart | Child Physical Part tag which needs to be installed |
inParams | Dialog Input as a dict containing the following values:
|
ITKCO::ASMAINTAINED_search_installable_physical_part_revisions | args | ||
ITK function to search installable physical part revisions.
selParentPhysBOMLine | Selected parent physical BOM line tag. |
selectedBOMLineImpl | Tag of BOMLine with a PSOccurrence - Position on which the installation/replace happens. |
attrCount | Total 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. |
ITKCO::BOM_line_look_up_attribute | args | ||
ITKCO::BOM_line_set_attribute_string | args | ||
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.
window | Window for which Revision Rule is to be set |
config_rule | Revision Rule to apply to window |
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
window | Window for which Revision Rule is to be set config_rule Revision Rule to apply to window |
autocreated by createClient
ITKCO::BOM_window_set_absocc_context | args | ||
ITKCO::BOM_window_set_effectivity_grprevs | args | ||
This function sets effectivity group revisions on the BOMWindow.
window | Window for which EffectivityGroup Revs are to be set |
n_effrevs | Number of effectivity group revisions to be set |
effGrpRevList | EffectivityGroup Revs to be set on BOMWindow |
autocreated by createClient
ITKCO::BOP_line_add | args | ||
Adds a new component to given line.
bom_line | Bomline to add to |
item_folder | Item to add, ignored if rev specified |
item_revision_folder | Item rev to add. For specifying the revision when adding to precise bvrs, if null the item's configured revision is used. |
bv | The child's bom view, if any, to be shown if the new child is expanded. Optional |
ITKCO::BOP_line_add_with_occ_type | args | ||
Adds a new component to given line.
bom_line | Bomline to add to |
item_folder | Item to add, ignored if rev specified |
item_revision_folder | Item rev to add. For specifying the revision when adding to precise bvrs, if null the item's configured revision is used. |
bv | The child's bom view, if any, to be shown if the new child is expanded. Optional. |
occType | occType |
autocreated by createClient
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.
reuse_de_tag | Reuse Design Element Tag |
item_rev_tag | Optional Tag of the Item Revision for the source Item Assembly needed if new Source Assembly is selected for update |
sync_effectivity_expressions | Flag set to true to update Variant Expressions on Reuse Design Element structure |
update_subordinates | Flag set to true to update Subordinate Design Elements else set to false |
autocreated by createClient
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.
target_object | Target object on which the jobs are to be searched |
count | Expected number of jobs |
jobs | List of count jobs in which target_object is one of the targets |
autocreated by createClient
ITKCO::EPM_set_task_result | args | ||
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.
theKeyLOVId | The unique identifier of the KeyLOV |
theCount | The number of keys to be added to the KeyLOV |
theKeys | The KeyLOV keys to be set into the KeyLOV |
theValues | The values for the keys to be set |
theDeprecateStatus | The deprecation statuses corresponding to KeyLOV keys |
autocreated by createClient
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.
n_file_tags | The number of file_tags in the array pointed to by file_tags |
file_tags | A pointer to an array of file tags |
application | A 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 |
autocreated by createClient
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.
item | Tag of an Item |
autocreated by createClient
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.
rev | Item Revision that needs to be Baselined |
new_rev_id | The Revision Id of the Baseline Item Revision |
desc | Description that needs to be set on the Baseline Item Revision |
rel_proc_name | Name of the Release Procedure through which the Baseline Revision should under go |
jobName | Name of the Job |
jobDescription | Description of the Job |
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 |
ITKCO::ITEM_list_bom_views | args | ||
This function will return the tags of all bom views related to the Item.
item | Tag of an existing Item |
autocreated by createClient
ITKCO::ITEM_rev_list_all_bom_view_revs | args | ||
This function will return the tags of all bom views related to the Item.
rev | Tag of the item revision under which the GDE BomViewRevision should be created |
ITKCO::ME_create_bop_window | args | ||
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.
id | operation identification number - system will assign automatically if empty |
revid | revision id for the first rev - can be empty - automatically assigned |
type | type name - can be empty - will take default type |
name | Name of the operation |
desc | Description for new 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.
id | operation identification number - system will assign automatically if empty |
revid | revision id for the first rev - can be empty - automatically assigned |
type | type name - can be empty - will take default type |
name | Name of the operation |
desc | Description for new operation |
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.
id | process identification number - system will assign automatically if empty |
revid | revision id for the first rev - can be empty - automatically assigned |
type | type name - can be empty - will take default type |
name | Name of the process |
desc | Description of 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.
id | process identification number - system will assign automatically if empty |
revid | revision id for the first rev - can be empty - automatically assigned |
type | type name - can be empty - will take default type |
name | Name of the process |
desc | Description of process |
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.
physical_bom_line | Tag of Physical BOM Line. |
physical_part_revision | Tag of Physical Part Revision. |
lot | Tag of Lot. |
quantity | Quantity that will be deducted on lot assignment. |
autocreated by createClient
physical_bom_line | Tag of Physical BOM Line. |
physical_part_revision | Tag of Physical Part Revision. |
lot | Tag of Lot. |
quantity | Quantity that will be deducted on lot assignment. |
autocreated by createClient
ITKCO::MROCORE_rebase_physical_part | args | ||
ITK function to rebase Physical Part to Neutral Part.
physicalBOMLine | Tag of Physical BOM Line. |
neutralBOMLine | Tag of Neutral BOM Line. |
rebaseDate | Rebase 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" |
structureContext | Structure Context Name. |
autocreated by createClient
ITKCO::MROCORE_record_utilization | args | ||
ITK function for record utilization.
physBOMLine | Physical BOMLine Tag. |
logBook | Log Book Tag. |
in_param | Contains the utilization data to record for physical part. Utilization data is a dict containig the following values:
|
charValueParams | List containing the Characteristics value for physical part. List entries are dicts containig the following values:
|
count | Number of list entries, i. e. Characteristic values for physical part |
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.
attr_name | Name of attribute |
class_name | Name of class |
Sample code sequence
autocreated by createClient
attr_name | Name of attribute |
class_name | Name of class |
Sample code sequence
autocreated by createClient
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.
instance | Tag of the object |
autocreated by createClient
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.
n_instances | Number of instances to set |
instance_tags | Array of n_instances tags of these instances |
attr_id | Attribute ID |
Sample code sequence
n_instances | Number of instances to set |
instance_tags | Array of n_instances tags of these instances |
attr_id | Attribute ID |
Sample code sequence
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.
n_instances | Number of instances to set |
instance_tags | Array of n_instances tags of these instances |
attr_id | Attribute ID |
start | Position in the VLA to start setting values |
n_values | Number of values to be set |
Sample code sequence
autocreated by createClient
n_instances | Number of instances to set |
instance_tags | Array of n_instances tags of these instances |
attr_id | Attribute ID |
start | Position in the VLA to start setting values |
n_values | Number of values to be set |
Sample code sequence
autocreated by createClient
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.
n_instances | Number of instances to set |
instance_tags | Array of n_instances tags of these instances |
attr_id | Attribute ID |
value | New attribute value |
Sample code sequence
autocreated by createClient
n_instances | Number of instances to set |
instance_tags | Array of n_instances tags of these instances |
attr_id | Attribute ID |
value | New attribute value |
Sample code sequence
autocreated by createClient
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.
n_instances | Number of instances to set |
instance_tags | Array of n_instances tags of these instances |
attr_id | Attribute ID |
start | Position in the VLA to start setting values |
n_values | Number of values to be set |
values | Array of n_values of the appropriate type |
Sample code sequence
autocreated by createClient
n_instances | Number of instances to set |
instance_tags | Array of n_instances tags of these instances |
attr_id | Attribute ID |
start | Position in the VLA to start setting values |
n_values | Number of values to be set |
values | Array of n_values of the appropriate type |
Sample code sequence
autocreated by createClient
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.
instance | Tag of instance in which to set the creation date |
creation_date | New 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" |
ITKCO::POM_set_env_info | args | ||
Sets the specified environmental information.
Currently it can be used to:
Token | Type | POM Initial Value | ITK Initial Value |
POM_rollback_switch | logical | false (OFF) | false (OFF) |
POM_ds_checking_switch | logical | false (OFF) | false (OFF) |
POM_error_traceback_switch | logical | true (ON) | true (ON) |
POM_log_sql_switch | logical | OFF | OFF |
POM_journaling_switch | logical | true (ON) | true (ON) |
POM_arg_checking_switch | logical | true (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 | logical | false (OFF) | false (OFF) |
POM_bypass_attr_update | logical | true (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 | logical | false (POM enabled) | false (POM enabled) |
POM_enable_set_attr_callbacks | logical | false (POM enabled) | false (POM enabled)- true |
POM_check_private_uniqueness_switch | logical | true (ON) | true (ON) |
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_linear | On 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. |
what_to_set | token to be set |
logical_value_to_set | |
int_value_to_set | |
double_value_to_set | |
tag_value_to_set | |
string_value_to_set |
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.
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.
instance | Tag of instance in which to set the last-mod-date |
modification_date | New 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" |
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.
Supports rollback using markpoints: YES.
instance | Tag of instance in which to set the last-mod-date |
modification_user | New user to be set in instance |
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.
instance | Tag of instance in which to set the last-mod-date |
modification_date | New 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" |
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:
The user/role/group are the ones for the current logged-in user.
preference_count | Number of preferences to export |
preference_names | Name of the preferences to export |
location | Location of the preferences to export |
output_file_name | Output export file name |
autocreated by createClient
ITKCO::PS_ask_bom_view_type | args | ||
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).
view_type | Site-specific identifier for the type of view (e.g., DESIGN, Assembly) |
view_name | Name of the view. If NULL or empty string is specified, the default name is used. |
view_desc | Optional description text (NULL if not required) |
parent_item | Makes the new BOMView a view of this Item |
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.
view_type | Site-specific identifier for the type of view (e.g., DESIGN, Assembly) |
view_name | Name of the view. If NULL or empty string is specified, the default name is used. |
view_desc | Optional description text (NULL if not required) |
parent_item | Makes the new BOMView a view of this Item |
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.
bom_view | Tag of the BOMView for which the first revision is to be created |
revision_name | Revision name. If NULL or empty string "" is specified, the default name is used. See also PS_default_bvr_name. |
revision_desc | A description of the revision (can be NULL) |
precise | If true the BOMView Revision can have precise occurrences of child Item Revisions. If false it can have imprecise occurrence of child Items. |
parent_ir | The tag of the parent Item Revision of the BOMView Revision |
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.
bom_view | Tag of the BOMView for which the first revision is to be created |
revision_name | Revision name. If NULL or empty string "" is specified, the default name is used. See also PS_default_bvr_name. |
revision_desc | A description of the revision (can be NULL) |
precise | If true the BOMView Revision can have precise occurrences of child Item Revisions. If false it can have imprecise occurrence of child Items. |
parent_ir | The tag of the parent Item Revision of the BOMView Revision |
ITKCO::PS_list_occurrences_of_bvr | args | ||
ITKCO::SA_ask_site_info_ex2 | args | ||
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.
object | The tag of the top-level object being revised or saved |
operation_input | The operation type; this can be the full name like e.g. TCTYPE_OPERATIONINPUT_CREATE or a shortcut like OPERATIONINPUT_CREATE or just CREATE |
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.
target_object_type | Business Object type tag |
operation_input | The operation type; this can be the full name like e.g. TCTYPE_OPERATIONINPUT_CREATE or a shortcut like OPERATIONINPUT_CREATE or just CREATE |
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.
number_target_objects | The number of objects to be revised |
target_object_tags | Array of target objects (objects being revised) |
revise_input_tags | Array of ReviseInput tags for the target objects, containing user input |
number_attached_objs | Array 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_tags | Array of DeepCopyData tags for the attached objects |
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:
number_target_objects | The number of objects to be revised |
target_object_tags | Array of target objects (objects being revised) |
revise_input_tags | Array of ReviseInput tags for the target objects, containing user input |
number_attached_objs | Array 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_tags | Array of DeepCopyData tags for the attached objects |
autocreated by createClient
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.
target_object_tag | The tag of the target object (objects being saved) |
save_as_input_tag | The tag of the SaveAsInput for the target object, containing user input |
number_of_attached_objects | The number of objects attached to the target object |
deep_copy_data_tags | Array of DeepCopyData tags for the attached objects |
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.
target_object_tag | The tag of the target object (objects being saved) |
save_as_input_tag | The tag of the SaveAsInput for the target object, containing user input |
number_of_attached_objects | The number of objects attached to the target object |
deep_copy_data_tags | Array of DeepCopyData tags for the attached objects |
autocreated by createClient
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.
vrule | Tag of variant rule to query |
bom_window | Tag of BOM Window that supplies variant option values |
autocreated by createClient
vrule | Tag of variant rule to query |
bom_window | Tag of BOM Window that supplies variant option values |
autocreated by createClient
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.
name | Name for the new variant rule |
description | Description for the new variant rule |
bom_window | Tag of BOM Window that supplies variant option values |
n_options | Number of variant options in the supplied option list. |
options | List of variant options to save to the new Rule. |
autocreated by createClient
name | Name for the new variant rule |
description | Description for the new variant rule |
bom_window | Tag of BOM Window that supplies variant option values |
n_options | Number of variant options in the supplied option list. |
options | List of variant options to save to the new Rule. |
autocreated by createClient
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.
name | Name for the new variant rule |
description | Description for the new variant rule |
bomvariantrule | Tag of the BOM variant rule that supplies the variant option values |
n_options | Number of variant options in the supplied option list. |
options | List of variant options to save to the new Rule. |
autocreated by createClient
name | Name for the new variant rule |
description | Description for the new variant rule |
bomvariantrule | Tag of the BOM variant rule that supplies the variant option values |
n_options | Number of variant options in the supplied option list. |
options | List of variant options to save to the new Rule. |
autocreated by createClient
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.
vrule | Tag of variant rule to save the values to |
bom_window | Tag of BOM Window that supplies variant option values |
update_only | Boolean value to control whether the supplied option values will replace |
n_options | Number of variant options in the supplied option list. |
options | List of variant options to save to the new Rule. |
autocreated by createClient
vrule | Tag of variant rule to save the values to |
bom_window | Tag of BOM Window that supplies variant option values |
update_only | Boolean value to control whether the supplied option values will replace |
n_options | Number of variant options in the supplied option list. |
options | List of variant options to save to the new Rule. |
autocreated by createClient
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.
vrule | Tag of variant rule to save the values to |
bomvariantrule | Tag of the BOM variant rule that supplies the variant option values |
update_only | Boolean value to control whether the supplied option values will replace |
n_options | Number of variant options in the supplied option list. |
options | List of variant options to save to the new Rule. |
autocreated by createClient
vrule | Tag of variant rule to save the values to |
bomvariantrule | Tag of the BOM variant rule that supplies the variant option values |
update_only | Boolean value to control whether the supplied option values will replace |
n_options | Number of variant options in the supplied option list. |
options | List of variant options to save to the new Rule. |
autocreated by createClient
ITKCO::WSOM_ask_object_type2 | args | ||
ITKCO::WSOM_ask_revision | args | ||
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.
a_WSO_tag | Tag of the object |
new_name | The 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. |
autocreated by createClient
a_WSO_tag | Tag of the object |
new_name | The 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. |
autocreated by createClient
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.
release_status | Tag of the release status to which the effectivity belongs |
effectivity | Tag of the effectivity |
range_text | Range text |
append | Append value |
autocreated by createClient
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:
release_status | Tag of the release status to which the effectivity belongs |
effectivity | Tag of the effectivity |
n_units | The size of the array or start-end values |
start_end_values | The 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_out | One of the following constants: EFFECTIVITY_open_ended, EFFECTIVITY_stock_out or EFFECTIVITY_closed. |
append | If set to true, the values in the array will be added to the unit range, otherwise they will replace them. |
autocreated by createClient