T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
T4S::GENERIC::CUSTOM::OBJECT::IMPORT Namespace Reference

Functions

 cleanUp Function ObjectId BatchJobStatus AdditionalInfo args
 Customer specific function to start an additional customer specific cleanUp after the normal update. More...
 
 createTC_Object Function ObjectId AdditionalInfo args
 Customer specific function for the creation of the Tc object based on a given objectId. More...
 
 getObjectInfo ObjectId AdditionalInfo args
 Customer specific Mapping function for retrieving the object information. More...
 
 initImportInfo args
 
 selectTC_Object Function ObjectId AdditionalInfo args
 Customer specific select function to identify the corresponding target object. More...
 
 updateTC_Object Function ObjectTag ObjectRevisionTag ObjectType ObjectRevisionType ObjectId AdditionalInfo args
 Customer specific function to update the selected Tc target object. More...
 

Variables

 ImportInfo
 

Function Documentation

◆ cleanUp()

T4S::GENERIC::CUSTOM::OBJECT::IMPORT::cleanUp   Function ObjectId BatchJobStatus AdditionalInfo args  

Customer specific function to start an additional customer specific cleanUp after the normal update.

Parameters
FunctionImport function name, supports using same procedures and same namespace for different customer imports
ObjectIdobject key
BatchJobStatusend status f the import batch job
AdditionalInfoadditional information
Returns

◆ createTC_Object()

T4S::GENERIC::CUSTOM::OBJECT::IMPORT::createTC_Object   Function ObjectId AdditionalInfo args  

Customer specific function for the creation of the Tc object based on a given objectId.

Parameters
FunctionImport function name, supports using same procedures and same namespace for different customer imports
ObjectIdobject key
AdditionalInfoadditional information
Returns

◆ getObjectInfo()

T4S::GENERIC::CUSTOM::OBJECT::IMPORT::getObjectInfo   ObjectId AdditionalInfo args  

Customer specific Mapping function for retrieving the object information.

Parameters
ObjectIdobject key
AdditionalInfoadditional information
Returns

◆ initImportInfo()

T4S::GENERIC::CUSTOM::OBJECT::IMPORT::initImportInfo   args  

◆ selectTC_Object()

T4S::GENERIC::CUSTOM::OBJECT::IMPORT::selectTC_Object   Function ObjectId AdditionalInfo args  

Customer specific select function to identify the corresponding target object.

Parameters
FunctionImport function name, supports using same procedures and same namespace for different customer imports
ObjectIdobject key
AdditionalInfoadditional information
Returns
Return code used by the following import function. The following values are valid:
FOUND $ItemRevisionTag -> T4X will continue the import execution with proc updateTC_Object


OK $ItemRevisionTag -> T4X will continue the import execution with proc updateTC_Object
NOT_FOUND $ErrorMessage -> T4X will continue the import execution with proc createTC_Object (using search query)
ITEMID_DOESNT_EXIST $ErrorMessage -> T4X will continue the import execution with proc createTC_Object (using ITK::ITEM_exists)
SKIPPED -> T4X will stop the import execution successfully without an error
any other return value -> T4X treats it as an error, there by customised error returns with info when/why the error occured are supported

◆ updateTC_Object()

T4S::GENERIC::CUSTOM::OBJECT::IMPORT::updateTC_Object   Function ObjectTag ObjectRevisionTag ObjectType ObjectRevisionType ObjectId AdditionalInfo args  

Customer specific function to update the selected Tc target object.

Parameters
FunctionImport function name, supports using same procedures and same namespace for different customer imports
ObjectTaghexed import object tag
ObjectRevisionTaghexed import object revision tag
ObjectTypeimport object type name
ObjectRevisionTypeimport object revision type name
ObjectIdobject key
AdditionalInfoadditional information
Returns

Variable Documentation

◆ ImportInfo

ImportInfo
static