T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
T4S::PROJECT_SCHEDULE_STRUCTURE::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...
 
 createScheduleTask Function ObjectKeyDict AdditionalInfo args
 Customer specific function for the creation of a Tc project item based on a SAP project object (Project Definition, WBS Element or Network). More...
 
 createTC_ScheduleObject Function ObjectKeyDict AdditionalInfo args
 Customer specific function for the creation of a Tc project item based on a SAP project object (Project Definition, WBS Element or Network). More...
 
 getImportStructureInfo ObjectKeyDict AdditionalInfo args
 Reads the SAP project structure or sub-structure before the corresponding Teamcenter structure is updated. More...
 
 importStructure2TeamcenterStructure BomViewTag CurrentTcBomList SAPProjectItemList AdditionalInfo args
 The importStructure2TeamcenterStructure function uses the result of the getImportStructureInfo and getCurrentTcStructureInfo as an input to update the Teamcenter structure so that after the update it has the same content as the corresponding SAP project object structure. More...
 
 SAP_ProjectStructureMapping2TC_ScheduleObject Function ItemType ItemRevisionType ObjectKeyDict AdditionalInfo args
 Customer specific Mapping function for the import/update of SAP project structure info to a tc item. More...
 
 selectScheduleTask Function ObjectKeyDict AdditionalInfo args
 Customer specific select function to identify the corresponding target project item revision. More...
 
 selectTC_ScheduleObject Function ObjectKeyDict AdditionalInfo args
 Customer specific select function to identify the corresponding target project item revision. More...
 
 updateTC_ScheduleObject Function ItemTag ItemRevisionTag ItemType ItemRevisionType ObjectKeyDict AdditionalInfo args
 Customer specific function to start an additional customer specific post-action after the normal update. More...
 
 validateScheduleTaskList Function ObjectKeyDict AdditionalInfo args
 Customer specific validateScheduleTaskList verifies that all needed Schedule Tasks elements are already created before the structure of the Schedule is updated. More...
 

Variables

 ImportStructure
 

Function Documentation

◆ cleanUp()

T4S::PROJECT_SCHEDULE_STRUCTURE::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 namespace for different customer imports
ObjectKeyDictdict containing at least the key PROJECT_DEFINITION for the external project definition Id
BatchJobStatusend state of the import batch job
AdditionalInfoadditional information
Returns

◆ createScheduleTask()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::createScheduleTask   Function ObjectKeyDict AdditionalInfo args  

Customer specific function for the creation of a Tc project item based on a SAP project object (Project Definition, WBS Element or Network).

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

◆ createTC_ScheduleObject()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::createTC_ScheduleObject   Function ObjectKeyDict AdditionalInfo args  

Customer specific function for the creation of a Tc project item based on a SAP project object (Project Definition, WBS Element or Network).

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

◆ getImportStructureInfo()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::getImportStructureInfo   ObjectKeyDict AdditionalInfo args  

Reads the SAP project structure or sub-structure before the corresponding Teamcenter structure is updated.

The function support the following two different ways to share the structure information of the SAP project:

  • As a list of items as part of the return value
  • As the content of the name-space variable ImportStructure
Parameters
ObjectKeyDictdict containing at least the key PROJECT_DEFINITION for the external project definition Id
AdditionalInfoadditional information
Returns
StatusDict containing the following keys:
  • Status of the data retrieval from the SAP project system
  • ObjectKeyDict

◆ importStructure2TeamcenterStructure()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::importStructure2TeamcenterStructure   BomViewTag CurrentTcBomList SAPProjectItemList AdditionalInfo args  

The importStructure2TeamcenterStructure function uses the result of the getImportStructureInfo and getCurrentTcStructureInfo as an input to update the Teamcenter structure so that after the update it has the same content as the corresponding SAP project object structure.

Parameters
BomViewTag
CurrentTcBomListTeamcenter BOM lines data
SAPProjectItemListSAP BOM lines data
AdditionalInfoadditional information
Returns
Status of the action (OK or ERROR)

◆ SAP_ProjectStructureMapping2TC_ScheduleObject()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::SAP_ProjectStructureMapping2TC_ScheduleObject   Function ItemType ItemRevisionType ObjectKeyDict AdditionalInfo args  

Customer specific Mapping function for the import/update of SAP project structure info to a tc item.

Parameters
FunctionImport function name, supports using same procedures and same namespace 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
OK

◆ selectScheduleTask()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::selectScheduleTask   Function ObjectKeyDict AdditionalInfo args  

Customer specific select function to identify the corresponding target project 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 StatusDict with the following elements object_tag and Status The Status Element can have the following values:
  • FOUND \li NOT_FOUND \li ITEMID_DOESNT_EXIST \li SKIPPED \li any other return value -> T4X treats it as an error, there by customised error returns with info when/why the error occurred are supported

◆ selectTC_ScheduleObject()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::selectTC_ScheduleObject   Function ObjectKeyDict AdditionalInfo args  

Customer specific select function to identify the corresponding target project 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_ScheduleObject (using search query)
  • ITEMID_DOESNT_EXIST $ErrorMessage -> T4X will continue the import execution with proc createTC_ScheduleObject (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_ScheduleObject()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::updateTC_ScheduleObject   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 namespace 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
OK or errorMsg

◆ validateScheduleTaskList()

T4S::PROJECT_SCHEDULE_STRUCTURE::CUSTOM::IMPORT::validateScheduleTaskList   Function ObjectKeyDict AdditionalInfo args  

Customer specific validateScheduleTaskList verifies that all needed Schedule Tasks elements are already created before the structure of the Schedule is updated.

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_ScheduleObject (using search query)
  • ITEMID_DOESNT_EXIST $ErrorMessage -> T4X will continue the import execution with proc createTC_ScheduleObject (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

Variable Documentation

◆ ImportStructure

ImportStructure
static