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

Functions

 cleanUp Function ObjectKeyDict BatchJobStatus AdditionalInfo args
 Customer specific function to start an additional customer specific cleanUp after the normal update. More...
 
 createTC_ProjectObject Function ObjectKeyDict AdditionalInfo args
 Customer specific function for the creation of a Tc item based on a network number. More...
 
 getProjectInfo ObjectKeyDict AdditionalInfo args
 Customer specific Mapping function for the project infos. More...
 
 getTargetRevisionFromList ItemRevisionTagList args
 Customer specific Mapping function for the selection of the correct IR from a given list of IRs. More...
 
 SAP_ProjectMapping2TC_Object Function ItemType ItemRevisionType ObjectKeyDict AdditionalInfo args
 Customer specific Mapping function for the import/update of SAP network info to a tc object. More...
 
 selectTC_ProjectObject Function ObjectKeyDict AdditionalInfo args
 Customer specific select function to identify the corresponding target item revision. More...
 
 updateTC_ProjectObject Function ItemTag ItemRevisionTag ItemType ItemRevisionType ObjectKeyDict AdditionalInfo args
 Customer specific function to start an additional customer specific post-action after the normal update. More...
 

Variables

 ProjectItemData
 

Function Documentation

◆ cleanUp()

T4S::PROJECT_ITEM::CUSTOM::IMPORT::cleanUp   Function ObjectKeyDict 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 name-space for different customer imports
ObjectKeyDictdict containing at least the key PROJECT_DEFINITION for the external project definition Id
BatchJobStatusend status f the import batch job
AdditionalInfoadditional information
Returns

◆ createTC_ProjectObject()

T4S::PROJECT_ITEM::CUSTOM::IMPORT::createTC_ProjectObject   Function ObjectKeyDict AdditionalInfo args  

Customer specific function for the creation of a Tc item based on a network number.

Parameters
FunctionImport function name, supports using same procedures and same name-space for different customer imports
ObjectKeyDictdict containing at least the key PROJECT_DEFINITION for the external project definition Id
AdditionalInfoadditional information
Returns

◆ getProjectInfo()

T4S::PROJECT_ITEM::CUSTOM::IMPORT::getProjectInfo   ObjectKeyDict AdditionalInfo args  

Customer specific Mapping function for the project infos.

Parameters
ObjectKeyDictdict containing at least the key PROJECT_DEFINITION for the external project definition Id
AdditionalInfoadditional information
Returns

◆ getTargetRevisionFromList()

T4S::PROJECT_ITEM::CUSTOM::IMPORT::getTargetRevisionFromList   ItemRevisionTagList args  

Customer specific Mapping function for the selection of the correct IR from a given list of IRs.

Parameters
ItemRevisionTagListlist of tags found by selectTC_ProjectObject
Returns

◆ SAP_ProjectMapping2TC_Object()

T4S::PROJECT_ITEM::CUSTOM::IMPORT::SAP_ProjectMapping2TC_Object   Function ItemType ItemRevisionType ObjectKeyDict AdditionalInfo args  

Customer specific Mapping function for the import/update of SAP network info to a tc object.

Parameters
FunctionImport function name, supports using same procedures and same name-space for different customer imports
ItemTypeimport item type name
ItemRevisionTypeimport item revision type name
ObjectKeyDictdict containing at least the key PROJECT_DEFINITION for the external project definition Id
AdditionalInfoadditional information
Returns

◆ selectTC_ProjectObject()

T4S::PROJECT_ITEM::CUSTOM::IMPORT::selectTC_ProjectObject   Function ObjectKeyDict AdditionalInfo args  

Customer specific select function to identify the corresponding target item revision.

Parameters
FunctionImport function name, supports using same procedures and same name-space for different customer imports
ObjectKeyDictdict containing at least the key PROJECT_DEFINITION for the external project definition Id
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 SAP_PROJECT_ITEMElementMapping2TC_Object
  • OK $ItemRevisionTag -> T4X will continue the import execution with proc SAP_PROJECT_ITEMElementMapping2TC_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 occurred are supported

◆ updateTC_ProjectObject()

T4S::PROJECT_ITEM::CUSTOM::IMPORT::updateTC_ProjectObject   Function ItemTag ItemRevisionTag ItemType ItemRevisionType ObjectKeyDict AdditionalInfo args  

Customer specific function to start an additional customer specific post-action after the normal update.

Parameters
FunctionImport function name, supports using same procedures and same name-space for different customer imports
ItemTaghexed import item tag
ItemRevisionTaghexed import item revision tag
ItemTypeimport item type name
ItemRevisionTypeimport item revision type name
ObjectKeyDictdict containing at least the key PROJECT_DEFINITION for the external project definition Id
AdditionalInfoadditional information
Returns

Variable Documentation

◆ ProjectItemData

ProjectItemData
static