![]() |
T4S4
18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
|
All ITK functions of group AOM supported by T4x. More...
Functions | |
AOM_ask_displayable_values HexTcObjectTag PropertyName | |
This function calls the ITK pipe server function AOM_ask_displayable_values and returns the displayable property value information. More... | |
AOM_ask_max_num_elements HexTcObjectTag PropertyName | |
This function calls the ITK pipe server function AOM_ask_max_num_elements to get the maximum number of values in a multi-valued property of an object. More... | |
AOM_ask_num_elements HexTcObjectTag PropertyName | |
This function calls the ITK pipe server function AOM_ask_num_elements to get the number of values in a multi-valued property of an object. More... | |
AOM_ask_owner HexTcObjectTag | |
This function calls the ITK pipe server function AOM_ask_owner to find the owning user of the given tc object. More... | |
AOM_ask_property_master_locale HexTcObjectTag PropertyName | |
This function calls the ITK pipe server function AOM_ask_property_master_locale to get the master locale of a property of an object. More... | |
AOM_ask_property_type HexPropertyTag PropertyName | |
This function calls the ITK pipe server function AOM_ask_property_type and returns the property type name. More... | |
AOM_ask_table_rows OwningObjectTag TablePropertyName | |
This function calls the ITK pipe server function AOM_ask_table_rows. More... | |
AOM_ask_value_type HexTcObjectTag PropertyName | |
This function calls the ITK pipe server function AOM_ask_value_type and returns the type name of the value. More... | |
AOM_ask_values HexTcObjectTag PropertyName | |
This function calls the ITK pipe server function AOM_ask_values and returns the internal property value information. More... | |
AOM_delete ObjectTag | |
This function calls the ITK pipe server function AOM_delete. More... | |
AOM_delete_from_parent ObjectTag ParentTag | |
This function calls the ITK pipe server function AOM_delete_from_parent. More... | |
AOM_delete_table_rows OwningObjectTag TablePropertyName DeleteFromRowIndex NumberOfTableRows2Delete | |
This function calls the ITK pipe server function AOM_delete_table_rows to delete the table row objects starting at the specified index. AOM_save and AOM_refresh have to be called after this call. More... | |
AOM_is_null_empty HexTcObjectTag PropertyName CheckZeroLengthFlag | |
This function calls the ITK pipe server function AOM_is_null_empty and returns the IsNull flag. More... | |
AOM_refresh_lock HexTcObjectTag | |
This function calls the ITK pipe server function AOM_refresh_lock to refresh and lock a given Teamcenter object. More... | |
AOM_refresh_unlock HexTcObjectTag | |
This function calls the ITK pipe server function AOM_refresh_unlock to refresh and unlock a given Teamcenter object. More... | |
AOM_save HexTcObjectTag | |
This function calls the ITK pipe server function AOM_save to commit the changes of a given Teamcenter object. More... | |
AOM_save_with_extensions HexTcObjectTag | |
This function calls the ITK pipe server function AOM_save_with_extensions that saves the object and executes the PreCondition, PreAction and PostAction extensions if TC_save_msg is implemented on the type of the object; For example, this generic ITK will execute TC_save_msg on Item in the same way as ITEM_save_item does. More... | |
AOM_set_table_rows OwningObjectTag TablePropertyName TableRowTag1 ... TableRowTagn | |
This function calls the ITK pipe server function AOM_set_table_rows to set the table row object tags for the table property. The input list of objects are stored for the current property and existing objects that are not available in the input are deleted. AOM_save and AOM_refresh have to be called after this call. More... | |
AOM_set_value TclRepresentationOfTheTag PropertyName NewPropertyValue | |
This function calls the ITK pipe server function AOM_set_value to update an attribute of an object, the function also works for RuntimeObjects like BOMlines. Based on the Property type the corresponding AOM_set_value_<type> function is used for the update of the property. AOM_save and AOM_refresh have to be called after this call. More... | |
AOM_UIF_ask_translations HexTcObjectTag PropertyName Index | |
This function calls the ITK pipe server function AOM_UIF_ask_translations to get all translations for a single- or multi-valued property of an ApplicationObject Only available in Teamcenter 8.3 and later! The Property must be localizable (else error 38300 appears) More... | |
AOM_UIF_set_translations HexTcObjectTag PropertyName Index args | |
This function calls the ITK pipe server function AOM_UIF_set_translations to set all(!) translations for a single- or multi-valued property of an ApplicationObject Only available in Teamcenter 8.3 and later! The Property must be localizable (else error 38300 appears) More... | |
AOM_unlock HexTcObjectTag | |
This function calls the ITK pipe server function AOM_refresh_unlock to unlock a given Teamcenter object. More... | |
All ITK functions of group AOM supported by T4x.
This group specifies all ITK functions of group AOM for which wrappers have been defined in T4x
ITK::AOM_ask_displayable_values | HexTcObjectTag PropertyName | ||
This function calls the ITK pipe server function AOM_ask_displayable_values and returns the displayable property value information.
HexTcObjectTag | Teamcenter object tag in the Tcl string format |
PropertyName | Name of the Teamcenter object property |
Sample code sequence
If the AttributeName is set to owning_user the output will look like this
XXXX XXXX Call to ITK function 'AOM_ask_displayable_values' returns: {infodba (infodba)} XXXX
ITK::AOM_ask_max_num_elements | HexTcObjectTag PropertyName | ||
This function calls the ITK pipe server function AOM_ask_max_num_elements to get the maximum number of values in a multi-valued property of an object.
HexTcObjectTag | the ApplicationObject Puid, hexed |
PropertyName | name of the property |
ITK::AOM_ask_num_elements | HexTcObjectTag PropertyName | ||
This function calls the ITK pipe server function AOM_ask_num_elements to get the number of values in a multi-valued property of an object.
HexTcObjectTag | the ApplicationObject Puid, hexed |
PropertyName | name of the property |
ITK::AOM_ask_owner | HexTcObjectTag | ||
This function calls the ITK pipe server function AOM_ask_owner to find the owning user of the given tc object.
HexTcObjectTag |
Referenced by T4X::WORKFLOW::BATCHJOB::CUSTOM::sendTC_InfoEMail().
ITK::AOM_ask_property_master_locale | HexTcObjectTag PropertyName | ||
This function calls the ITK pipe server function AOM_ask_property_master_locale to get the master locale of a property of an object.
HexTcObjectTag | the ApplicationObject Puid, hexed |
PropertyName | name of the property |
ITK::AOM_ask_property_type | HexPropertyTag PropertyName | ||
ITK::AOM_ask_table_rows | OwningObjectTag TablePropertyName | ||
This function calls the ITK pipe server function AOM_ask_table_rows.
OwningObjectTag | Tcl representation of the Tag |
TablePropertyName |
Sample code sequence
ITK::AOM_ask_value_type | HexTcObjectTag PropertyName | ||
ITK::AOM_ask_values | HexTcObjectTag PropertyName | ||
This function calls the ITK pipe server function AOM_ask_values and returns the internal property value information.
HexTcObjectTag | Teamcenter object tag in the Tcl string format |
PropertyName | Name of the Teamcenter object property |
Sample code sequence
Referenced by findStartedSuccessorTask().
ITK::AOM_delete | ObjectTag | ||
ITK::AOM_delete_from_parent | ObjectTag ParentTag | ||
ITK::AOM_delete_table_rows | OwningObjectTag TablePropertyName DeleteFromRowIndex NumberOfTableRows2Delete | ||
This function calls the ITK pipe server function AOM_delete_table_rows to delete the table row objects starting at the specified index. AOM_save and AOM_refresh have to be called after this call.
OwningObjectTag | Tcl representation of the Tag |
TablePropertyName | |
DeleteFromRowIndex | Table row objects to be deleted from this row index. |
NumberOfTableRows2Delete | The number of table row objects to be deleted. |
ITK::AOM_is_null_empty | HexTcObjectTag PropertyName CheckZeroLengthFlag | ||
This function calls the ITK pipe server function AOM_is_null_empty and returns the IsNull flag.
HexTcObjectTag | hexed |
PropertyName | string |
CheckZeroLengthFlag | Indicates if also to check out 0-length string (true|false) |
Sample code sequence
ITK::AOM_refresh_lock | HexTcObjectTag | ||
This function calls the ITK pipe server function AOM_refresh_lock to refresh and lock a given Teamcenter object.
HexTcObjectTag |
Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::importNamedReference(), and T4S::MM::CUSTOM::ITEM::IMPORT::updateTC_Object().
ITK::AOM_refresh_unlock | HexTcObjectTag | ||
This function calls the ITK pipe server function AOM_refresh_unlock to refresh and unlock a given Teamcenter object.
HexTcObjectTag |
Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::importNamedReference().
ITK::AOM_save | HexTcObjectTag | ||
This function calls the ITK pipe server function AOM_save to commit the changes of a given Teamcenter object.
HexTcObjectTag |
Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::importNamedReference(), and T4X::TC::MAPPING::save_unlockTcObject().
ITK::AOM_save_with_extensions | HexTcObjectTag | ||
This function calls the ITK pipe server function AOM_save_with_extensions that saves the object and executes the PreCondition, PreAction and PostAction extensions if TC_save_msg is implemented on the type of the object; For example, this generic ITK will execute TC_save_msg on Item in the same way as ITEM_save_item does.
HexTcObjectTag |
Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::createTC_Object2(), and T4X::WORKFLOW::BATCHJOB::CUSTOM::sendTC_InfoEMail().
ITK::AOM_set_table_rows | OwningObjectTag TablePropertyName TableRowTag1 ... TableRowTagn | ||
This function calls the ITK pipe server function AOM_set_table_rows to set the table row object tags for the table property. The input list of objects are stored for the current property and existing objects that are not available in the input are deleted. AOM_save and AOM_refresh have to be called after this call.
OwningObjectTag | Tcl representation of the Tag |
TablePropertyName | |
TableRowTag1 | ... TableRowTagn List of table row objects |
Sample code sequence
ITK::AOM_set_value | TclRepresentationOfTheTag PropertyName NewPropertyValue | ||
This function calls the ITK pipe server function AOM_set_value to update an attribute of an object, the function also works for RuntimeObjects like BOMlines. Based on the Property type the corresponding AOM_set_value_<type> function is used for the update of the property. AOM_save and AOM_refresh have to be called after this call.
TclRepresentationOfTheTag | |
PropertyName | |
NewPropertyValue | Supports single (or multiple value string) properties updates with a new property value. To update multi value properties the value has to be provided as a single string each value needs to be separated by a separator (e.g. "value1\nvalue2\nvalue3") |
ITK::AOM_UIF_ask_translations | HexTcObjectTag PropertyName Index | ||
This function calls the ITK pipe server function AOM_UIF_ask_translations to get all translations for a single- or multi-valued property of an ApplicationObject Only available in Teamcenter 8.3 and later! The Property must be localizable (else error 38300 appears)
HexTcObjectTag | the ApplicationObject Puid, hexed |
PropertyName | name of the property |
Index | the index of the value (0 if single-valued) |
ITK::AOM_UIF_set_translations | HexTcObjectTag PropertyName Index args | ||
This function calls the ITK pipe server function AOM_UIF_set_translations to set all(!) translations for a single- or multi-valued property of an ApplicationObject Only available in Teamcenter 8.3 and later! The Property must be localizable (else error 38300 appears)
HexTcObjectTag | the ApplicationObject Puid, hexed |
PropertyName | name of the property |
Index | the index of the value (0 if single-valued) |
args | arbitrary number of triples of locale, value and status (each hexed, all flat, no list) |
ITK::AOM_unlock | HexTcObjectTag | ||
This function calls the ITK pipe server function AOM_refresh_unlock to unlock a given Teamcenter object.
HexTcObjectTag |
Referenced by T4X::TC::MAPPING::save_unlockTcObject(), and T4X::CUSTOM::MAPPING::TOOLBOX::saveItemWithUnlock().