T4EA  AIG_19.2 C8891 A24697
Teamcenter Gateway for Enterprise Applications API Reference
T4EA::BOM::CUSTOM::ITEM::IMPORT Namespace Reference

Functions

 checkItemExists MaterialNumber
 check if an item for the given MaterialNumber exists in TC More...
 
 cleanUp Function MaterialNumber BatchJobStatus AdditionalInfo args
 Customer specific function to start an additional customer specific cleanUp after the normal update. More...
 
 createTC_Object Function MaterialNumber AdditionalInfo args
 Customer specific function for the creation of a Tc item based on a material number. More...
 
 createTCBOMview_Object ItemRevisionTag AdditionalInfo args
 Customer specific create function to create the corresponding target BOM view revision. More...
 
 dummy args
 Dummy procedure (returns "OK") necessary for backwards compatibility only. More...
 
 getCurrentTcBomInfo BomViewTag AdditionalInfo args
 get the bom information for the item from TC More...
 
 getImportBomInfo ObjectId AdditionalInfo args
 get the information on the bom for the item to import from the external source, in this case from the AdditionalInfo parameter More...
 
 getTargetRevisionFromList ItemRevisionTagList args
 Customer specific Mapping function for the selection of the correct IR from a given list of IR's. More...
 
 importBOM2TcBOM BomViewTag CurrentTcBomList ERPBOMList AdditionalInfo args
 integrate the TC BOM and the external BOM information into TC More...
 
 selectTC_Object Function ObjectKey AdditionalInfo args
 Customer specific select function to identify the corresponding target item revision. More...
 
 selectTCBOMview_Object ItemRevisionTag AdditionalInfo args
 Customer specific select function to identify the corresponding target BOM view revision. More...
 
 updateTC_Object Function ItemTag ItemRevisionTag ItemType ItemRevisionType MaterialNumber AdditionalInfo args
 Customer specific function to start an additional customer specific post-action after the normal update. More...
 

Variables

 ImportInfo
 Variable to store data to be imported. More...
 
 TcBomInfo
 This variable stores the TC BOM information for comparison with ImportInfo. More...
 

Function Documentation

◆ checkItemExists()

T4EA::BOM::CUSTOM::ITEM::IMPORT::checkItemExists   MaterialNumber  

check if an item for the given MaterialNumber exists in TC

Parameters
MaterialNumberthe external ID
Returns
OK if item exists, ERROR if not

◆ cleanUp()

T4EA::BOM::CUSTOM::ITEM::IMPORT::cleanUp   Function MaterialNumber BatchJobStatus AdditionalInfo args  

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

Parameters
Function
MaterialNumberID of the external object
BatchJobStatusstatus of previous procedure calls
AdditionalInfoinfos to be imported
argsunused
Returns
OK or ERROR

◆ createTC_Object()

T4EA::BOM::CUSTOM::ITEM::IMPORT::createTC_Object   Function MaterialNumber AdditionalInfo args  

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

Parameters
Function
MaterialNumbercan be used e.g. as the item ID to be created
AdditionalInfoinfos to be imported
argsunused
Returns
list of OK and the created Item and ItemRevision or ERROR

◆ createTCBOMview_Object()

T4EA::BOM::CUSTOM::ITEM::IMPORT::createTCBOMview_Object   ItemRevisionTag AdditionalInfo args  

Customer specific create function to create the corresponding target BOM view revision.

Parameters
ItemRevisionTagthe item revision tag for which to create the BOM view revision.
AdditionalInfoinfos to be imported
argsunused
Returns
list of OK and the BOM view revision tag or ERROR

◆ dummy()

T4EA::BOM::CUSTOM::ITEM::IMPORT::dummy   args  

Dummy procedure (returns "OK") necessary for backwards compatibility only.

Parameters
argscurrectly unused
Returns
always OK

◆ getCurrentTcBomInfo()

T4EA::BOM::CUSTOM::ITEM::IMPORT::getCurrentTcBomInfo   BomViewTag AdditionalInfo args  

get the bom information for the item from TC

Parameters
BomViewTagtag of the BOMView
AdditionalInfoinfos to be imported
argsunused
Returns
must return OK or ERROR and a list of the BOM line infos from TC

◆ getImportBomInfo()

T4EA::BOM::CUSTOM::ITEM::IMPORT::getImportBomInfo   ObjectId AdditionalInfo args  

get the information on the bom for the item to import from the external source, in this case from the AdditionalInfo parameter

Parameters
ObjectIdTC ID of the item
AdditionalInfolist of pairs (Parameter, Value), information to update the item
argsunused
Returns
must return OK and a list of the BOM line infos from the external system or ERROR and an error message

◆ getTargetRevisionFromList()

T4EA::BOM::CUSTOM::ITEM::IMPORT::getTargetRevisionFromList   ItemRevisionTagList args  

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

If there are several revisions for a given item item id, this procedure finds out the correct one.

Parameters
ItemRevisionTagListlist of matching item revisions
argsunused
Returns
list of OK and the correct revision tag or list of ERROR and error message

◆ importBOM2TcBOM()

T4EA::BOM::CUSTOM::ITEM::IMPORT::importBOM2TcBOM   BomViewTag CurrentTcBomList ERPBOMList AdditionalInfo args  

integrate the TC BOM and the external BOM information into TC

Parameters
BomViewTagtag of the BOMView
CurrentTcBomListBOM info from TC
ERPBOMListBOM info from the external system
AdditionalInfoinfos to be imported
argsunused
Returns
OK or ERROR

◆ selectTC_Object()

T4EA::BOM::CUSTOM::ITEM::IMPORT::selectTC_Object   Function ObjectKey AdditionalInfo args  

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

The procedure can identify the item by using a query or by ITK sequences, as needed. If it does not find anything, the framework will call createTC_Object.

Parameters
Function
ObjectKeyusually the Item ID of the requested item
AdditionalInfoinfos to be imported
argsunused
Returns
Return code used by the following import function. The following values are valid:
FOUND $ItemRevisionTag -> T4X will continue the import execution with proc selectTCBOMview_Object


OK $ItemRevisionTag -> T4X will continue the import execution with proc selectTCBOMview_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

◆ selectTCBOMview_Object()

T4EA::BOM::CUSTOM::ITEM::IMPORT::selectTCBOMview_Object   ItemRevisionTag AdditionalInfo args  

Customer specific select function to identify the corresponding target BOM view revision.

Parameters
ItemRevisionTagthe item revision tag from which to determine the BOM view revision.
AdditionalInfoinfos to be imported
argsunused
Returns
Return code used by the following import function. The following values are valid:
FOUND $BomViewRevisionTag -> T4X will continue the import execution with proc importBOM2TcBOM


OK $BomViewRevisionTag -> T4X will continue the import execution with proc importBOM2TcBOM
NOT_FOUND $ErrorMessage -> T4X will continue the import execution with proc createTCBOMview_Object
ITEMID_DOESNT_EXIST $ErrorMessage -> T4X will continue the import execution with proc createTCBOMview_Object
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()

T4EA::BOM::CUSTOM::ITEM::IMPORT::updateTC_Object   Function ItemTag ItemRevisionTag ItemType ItemRevisionType MaterialNumber AdditionalInfo args  

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

Parameters
Function
ItemTagthe item to be updated
ItemRevisionTagthe item revision to be updated
ItemTypetype name of the item
ItemRevisionTypetype name of the item revision
MaterialNumberID of the external object
AdditionalInfoinfos to be imported
argsunused
Returns
OK or ERROR

Variable Documentation

◆ ImportInfo

ImportInfo
static

Variable to store data to be imported.

This is just a proposal from the BOM import demo. The variable can be named as required. Use of such a variable is not required but recommended.

◆ TcBomInfo

TcBomInfo
static

This variable stores the TC BOM information for comparison with ImportInfo.

This variable is just a proposal from the BOM import demo. The variable can be named as required. Use of such a variable is not required but recommended.