T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
TPSAP::CSAI_BOM Namespace Reference

Functions

 createBillOfMaterial BOMType args
 This function creates a BOM via the CSAI_BOM_CREATE function based on the content of the corresponding ::SAPDat(BOMType:*) array attributes provided after the mapping. More...
 
 deleteBillOfMaterial BOMType args
 Deletes an existing SAP BOM object. More...
 
 maintainBillOfMaterial BOMType args
 This function changes a BOM via the CSAI_BOM_MAINTAIN function based on the content of the corresponding ::SAPDat(BOMType:*) array attributes provided after the mapping. More...
 
 readBillOfMaterial BOMType args
 Retrieves information about an existing SAP BOM. More...
 

Function Documentation

◆ createBillOfMaterial()

TPSAP::CSAI_BOM::createBillOfMaterial   BOMType args  

This function creates a BOM via the CSAI_BOM_CREATE function based on the content of the corresponding ::SAPDat(BOMType:*) array attributes provided after the mapping.

Parameters
BOMTypearray value prefix (e.g. EQUIBOM, WBS_BOM, ...)
argsnone
Returns
List of Status CREATED and ObjectId or ERROR, ObjectId and list or error messages

References TPSAP::doCommitOrRollBackBasedOnStatus(), TPSAP::EQUI::getInternalNumber(), TPSAP::getSessionLogChannel(), and tpco_scanHEX16().

◆ deleteBillOfMaterial()

TPSAP::CSAI_BOM::deleteBillOfMaterial   BOMType args  

Deletes an existing SAP BOM object.

All import parameters are transferred via the global ::SAPDat TCL array within the section OrderBom. Check function readBillOfMaterial within this namespace for more details on how to transfer the import parameters.

Parameters
BOMTypearray value prefix (e.g. EQUIBOM, WBS_BOM, ...)
argsnone
Returns
DELETED or ERROR

Sample code sequence for a equipment bom

1 ::TPSAP::CSAI_BOM::initSAPBomHeaderStructure EQUIBOM
2 
3 set ::SAPDat(EQUIBOM:ECSIN:EQUNR) $EquipmentNumber
4 set ::SAPDat(EQUIBOM:ECSIN:WERKS) $Plant
5 set ::SAPDat(EQUIBOM:ECSIN:STLAL) $BomUsage
6 

References TPSAP::doCommitOrRollBackBasedOnStatus(), TPSAP::EQUI::getInternalNumber(), TPSAP::getSessionLogChannel(), and tpwrite().

Referenced by TPSAP::ORDERBOM::deleteBillOfMaterial().

◆ maintainBillOfMaterial()

TPSAP::CSAI_BOM::maintainBillOfMaterial   BOMType args  

This function changes a BOM via the CSAI_BOM_MAINTAIN function based on the content of the corresponding ::SAPDat(BOMType:*) array attributes provided after the mapping.

Parameters
BOMTypearray value prefix (e.g. EQUIBOM, WBS_BOM, ...)
argsnone
Returns
List of Status CHANGED and ObjectId or ERROR, ObjectId and list or error messages

References TPSAP::doCommitOrRollBackBasedOnStatus(), TPSAP::EQUI::getInternalNumber(), TPSAP::getSessionLogChannel(), and tpco_scanHEX16().

◆ readBillOfMaterial()

TPSAP::CSAI_BOM::readBillOfMaterial   BOMType args  

Retrieves information about an existing SAP BOM.

All import parameters are transferred via the global ::SAPDat TCL array within the section ${BOMType}:ECSIN

Parameters
BOMTypearray value prefix (e.g. EQUIBOM, WBS_BOM, ...)
argsnone
Returns
TCL list with BOM_FOUND or BOM_NOT_FOUND, object ID (like EquipmentNo) and error message (empty if no such message does exist) and global TCL array ::BOMResultDat

References TPSAP::EQUI::getInternalNumber(), TPSAP::getSessionLogChannel(), and tpwrite().

Referenced by TPSAP::ORDERBOM::readBillOfMaterial().