T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
OBJECT ITK functions

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

Functions

 OBJECT_processReverseMappingData SelectedObjectTag TransactionId PreferencePrefix ReverseMappingBuffer
 This function calls the ITK pipe server function OBJECT_processReverseMappingData, so that it is possible to use the same behaviour of the reverse mapping like in the work-flow or interactive transfer in the context of the batch transfer. More...
 
 OBJECT_set_attribute_value TcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function OBJECT_set_attribute_value to update a attribute of an object. The function uses also AOM_save und AOM_refresh functions after the object was updated. More...
 
 OBJECT_set_attribute_value2 TcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function OBJECT_set_attribute_value2 to update an attribute of an object. AOM_save and AOM_refresh have to be called after this call. More...
 
 OBJECT_set_attribute_value_forcemode TcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function OBJECT_set_attribute_value_forcemode to update a attribute of an object with a force mode for the attributes without write access. The function uses also AOM_save and AOM_unload functions after the object was updated. More...
 
 OBJECT_set_attribute_value_forcemode2 TcObjectTag PropertyName NewPropertyValue
 This function calls the ITK pipe server function OBJECT_set_attribute_value_forcemode2 to update a attribute of an object with a force mode for the attributes without write access. The function is not saving the object to the database this requires an extra call of AOM_save and AOM_unload. More...
 
 OBJECT_set_localized_attribute_value TcObjectTag PropertyName NewPropertyValue Mode Locale State
 This function calls the ITK pipe server function OBJECT_set_localized_attribute_value to update a attribute of an object. More...
 
 OBJECT_set_status ObjectTag StatusName
 This function calls the ITK pipe server function OBJECT_set_status to modify status of a given object. More...
 

Detailed Description

All ITK functions of group OBJECT supported by T4x.

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

Function Documentation

◆ OBJECT_processReverseMappingData()

ITK::OBJECT_processReverseMappingData   SelectedObjectTag TransactionId PreferencePrefix ReverseMappingBuffer  

This function calls the ITK pipe server function OBJECT_processReverseMappingData, so that it is possible to use the same behaviour of the reverse mapping like in the work-flow or interactive transfer in the context of the batch transfer.

Parameters
SelectedObjectTagStart object for the reverse mapping function
TransactionIdTransaction log-file name
PreferencePrefixReverseMapping Preference Prefix
ReverseMappingBufferString buffer that contains the StatusInfo array content (name value pairs for the reverse mapping).
Returns
ITK_ok (=0) or list of ITK status and error message

Referenced by T4X::TC::MAPPING::storeReverseMapping2TcObject2(), and T4X::TC::MAPPING::storeReverseMapping2TcObject3().

◆ OBJECT_set_attribute_value()

ITK::OBJECT_set_attribute_value   TcObjectTag PropertyName NewPropertyValue  

This function calls the ITK pipe server function OBJECT_set_attribute_value to update a attribute of an object. The function uses also AOM_save und AOM_refresh functions after the object was updated.

Parameters
TcObjectTagTc object tag in the Tcl string format
PropertyName
NewPropertyValueSupports single or multiple value 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")
Returns
ITK_ok (=0) or list of ITK status and error message

◆ OBJECT_set_attribute_value2()

ITK::OBJECT_set_attribute_value2   TcObjectTag PropertyName NewPropertyValue  

This function calls the ITK pipe server function OBJECT_set_attribute_value2 to update an attribute of an object. AOM_save and AOM_refresh have to be called after this call.

Parameters
TcObjectTag,Tcobject tag in the Tcl string format
PropertyName
NewPropertyValueSupports single or multiple value 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")
Returns
ITK_ok (=0) or list of ITK status and error message

◆ OBJECT_set_attribute_value_forcemode()

ITK::OBJECT_set_attribute_value_forcemode   TcObjectTag PropertyName NewPropertyValue  

This function calls the ITK pipe server function OBJECT_set_attribute_value_forcemode to update a attribute of an object with a force mode for the attributes without write access. The function uses also AOM_save and AOM_unload functions after the object was updated.

Deprecated:
The functionality deprecated and no replacement function available.
Warning
The functionality not supported anymore due to BMIDE constrains, so it behaves like the ITK::OBJECT_set_attribute_value.
Parameters
TcObjectTagTc object tag in the Tcl string format
PropertyName
NewPropertyValueSupports single or multiple value 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")
Returns
ITK_ok (=0) or list of ITK status and error message

◆ OBJECT_set_attribute_value_forcemode2()

ITK::OBJECT_set_attribute_value_forcemode2   TcObjectTag PropertyName NewPropertyValue  

This function calls the ITK pipe server function OBJECT_set_attribute_value_forcemode2 to update a attribute of an object with a force mode for the attributes without write access. The function is not saving the object to the database this requires an extra call of AOM_save and AOM_unload.

Deprecated:
The functionality deprecated and no replacement function available.
Warning
The functionality not supported anymore due to BMIDE constrains, so it behaves like the ITK::OBJECT_set_attribute_value2.
Parameters
TcObjectTagTc object tag in the Tcl string format
PropertyName
NewPropertyValueSupports single or multiple value 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")
Returns
ITK_ok (=0) or list of ITK status and error message

◆ OBJECT_set_localized_attribute_value()

ITK::OBJECT_set_localized_attribute_value   TcObjectTag PropertyName NewPropertyValue Mode Locale State  

This function calls the ITK pipe server function OBJECT_set_localized_attribute_value to update a attribute of an object.

Parameters
TcObjectTagTc object tag in the Tcl string format
PropertyName
NewPropertyValueSupports single or multiple value 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")
Mode- FORCE - set attributes without write access FORCE_AND_SAVE - set attributes without write access, use AOM_refresh ahead and AOM_save after SAVE - use AOM_refresh ahead and AOM_save after any other string is validated as no force no save
Locale- language string (de_DE, it_IT, us_EN ...)
State- Approved / Invalid / Pending
Returns
ITK_ok (=0) or list of ITK status and error message

◆ OBJECT_set_status()

ITK::OBJECT_set_status   ObjectTag StatusName  

This function calls the ITK pipe server function OBJECT_set_status to modify status of a given object.

Parameters
ObjectTagItem tag in the Tcl string format
StatusNametarget status name
Returns
ITK_ok (=0) or list of ITK status and error message