T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
TPSAP::ORDERBOM Namespace Reference

Functions

 deleteBillOfMaterial args
 Deletes an existing SAP BOM object. More...
 
 deletePositionStructure Index args
 Removes all stored information for one BOM position out of the corresponding global TCL ::SAPDat array within the section OrderBom:T_STPO at a given index, so that this position will not be send to SAP within a future transfer. More...
 
 initLongTextStructure Index args
 Resets part the corresponding global TCL ::SAPDat array within the section OrderBom:T_LTX_LINE. More...
 
 initPositionDependencyDescrStructure Index args
 Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_DESCR. More...
 
 initPositionDependencyDocStructure Index args
 Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_DOC. More...
 
 initPositionDependencyOrderStructure Index args
 Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_ORDER. More...
 
 initPositionDependencySourceStructure Index args
 Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_SOURCE. More...
 
 initPositionDependencyStructure Index args
 Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_DATA. More...
 
 initPositionStructure Index args
 Resets part the corresponding global TCL ::SAPDat array within the section OrderBom:T_STPO. More...
 
 initSAPBomHeaderStructure args
 Resets the corresponding global TCL ::SAPDat array within the section OrderBom. More...
 
 initSubPositionStructure Index args
 Resets part the corresponding global TCL ::SAPDat array within the section OrderBom:T_STPU. More...
 
 readBillOfMaterial args
 Retrieves information about an existing SAP BOM. More...
 
 setSAPBomLPositionStructure Index BomPosition MaterialNumber Quantity ?SortInfo? ?RFPNT? ?ERSKZ? ?SCHGT? args
 Stores the given SAP BOM L position (stock item) params into the the global TCL ::SAPDat array for a future transfer. More...
 
 setSAPBomRPositionStructure Index BomPosition MaterialNumber Quantity SortInfo ROMS1 ROMS2 ROMS3 ?RFORM? ?ROANZ? ?ROMEN? ?ROMEI? args
 Stores the given SAP BOM R position (variable-size item) params into the the global TCL ::SAPDat array for a future transfer. More...
 
 setSAPBomTextPositionStructure Index BomPosition TextLine1 TextLine2 ?SortInfo? args
 Stores the given SAP BOM text item position params into the the global TCL ::SAPDat array for a future transfer. More...
 
 storeLongText2Structure LongTextList LongTextType ?Identifier? ?LineFormat? args
 Function fuellt das LangTextArray Gueltige Werte fuer den LongTextType sind 0 fuer den Bom Langtext 1 fuer den Bom Alt Langtext 2 fuer den Bom Position Langtext. More...
 

Function Documentation

◆ deleteBillOfMaterial()

TPSAP::ORDERBOM::deleteBillOfMaterial   args  

Deletes an existing SAP BOM object.

Parameters
argsnone
Returns
DELETED or ERROR

Sample code sequence

1 #
3 
4 set ::SAPDat(OrderBom:Parameter:ORDER) $Order
5 set ::SAPDat(OrderBom:Parameter:POSITION) $Position
6 set ::SAPDat(OrderBom:Parameter:MATERIAL) $MaterialNumber
7 set ::SAPDat(OrderBom:Parameter:PLANT) $Plant
8 set ::SAPDat(OrderBom:Parameter:BOM_USAGE) $BomUsage
9 

◆ deletePositionStructure()

TPSAP::ORDERBOM::deletePositionStructure   Index args  

Removes all stored information for one BOM position out of the corresponding global TCL ::SAPDat array within the section OrderBom:T_STPO at a given index, so that this position will not be send to SAP within a future transfer.

Parameters
Index- internal TCL array index
Returns
OK

◆ initLongTextStructure()

TPSAP::ORDERBOM::initLongTextStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section OrderBom:T_LTX_LINE.

Parameters
Index- internal TCL array index
Returns
OK

◆ initPositionDependencyDescrStructure()

TPSAP::ORDERBOM::initPositionDependencyDescrStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_DESCR.

Parameters
Index- internal TCL array index
Returns
OK

◆ initPositionDependencyDocStructure()

TPSAP::ORDERBOM::initPositionDependencyDocStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_DOC.

Parameters
Index- internal TCL array index
Returns
OK

◆ initPositionDependencyOrderStructure()

TPSAP::ORDERBOM::initPositionDependencyOrderStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_ORDER.

Parameters
Index- internal TCL array index
Returns
OK

◆ initPositionDependencySourceStructure()

TPSAP::ORDERBOM::initPositionDependencySourceStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_SOURCE.

Parameters
Index- internal TCL array index
Returns
OK

◆ initPositionDependencyStructure()

TPSAP::ORDERBOM::initPositionDependencyStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section BillOfMaterial:T_DEP_DATA.

Parameters
Index- internal TCL array index
Returns
OK

◆ initPositionStructure()

TPSAP::ORDERBOM::initPositionStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section OrderBom:T_STPO.

Parameters
Index- internal TCL array index
Returns
OK

◆ initSAPBomHeaderStructure()

TPSAP::ORDERBOM::initSAPBomHeaderStructure   args  

Resets the corresponding global TCL ::SAPDat array within the section OrderBom.

Parameters
none
Returns
OK

◆ initSubPositionStructure()

TPSAP::ORDERBOM::initSubPositionStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section OrderBom:T_STPU.

Parameters
Index- internal TCL array index
Returns
OK

◆ readBillOfMaterial()

TPSAP::ORDERBOM::readBillOfMaterial   args  

Retrieves information about an existing SAP BOM.

Parameters
argsnone
Returns
TCL list with BOM_FOUND or BOM_NOT_FOUND, material number and error message (empty if no such message does exist) and global TCL array ::BOMResultDat

Sample code sequence

1 #
3 
4 set ::SAPDat(OrderBom:Parameter:ORDER) $Order
5 set ::SAPDat(OrderBom:Parameter:POSITION) $Position
6 set ::SAPDat(OrderBom:Parameter:MATERIAL) $MaterialNumber
7 set ::SAPDat(OrderBom:Parameter:PLANT) $Plant
8 set ::SAPDat(OrderBom:Parameter:BOM_USAGE) $BomUsage
9 

◆ setSAPBomLPositionStructure()

TPSAP::ORDERBOM::setSAPBomLPositionStructure   Index BomPosition MaterialNumber Quantity ?SortInfo? ?RFPNT? ?ERSKZ? ?SCHGT? args  

Stores the given SAP BOM L position (stock item) params into the the global TCL ::SAPDat array for a future transfer.

Parameters
Index- internal TCL array index
BomPosition
MaterialNumber
Quantity
SortInfo(optional - empty)
RFPNT(optional - ' ' (blank))
ERSKZ(optional - ' ' (blank))
SCHGT(optional - ' ' (blank))
Returns
OK

◆ setSAPBomRPositionStructure()

TPSAP::ORDERBOM::setSAPBomRPositionStructure   Index BomPosition MaterialNumber Quantity SortInfo ROMS1 ROMS2 ROMS3 ?RFORM? ?ROANZ? ?ROMEN? ?ROMEI? args  

Stores the given SAP BOM R position (variable-size item) params into the the global TCL ::SAPDat array for a future transfer.

Parameters
Index- internal TCL array index
BomPosition
MaterialNumber
Quantity
SortInfo
ROMS1
ROMS2
ROMS3
RFORM(optional - empty)
ROANZ(optional - 1)
ROMEN(optional - 1)
ROMEI(optional - empty)
Returns
OK

◆ setSAPBomTextPositionStructure()

TPSAP::ORDERBOM::setSAPBomTextPositionStructure   Index BomPosition TextLine1 TextLine2 ?SortInfo? args  

Stores the given SAP BOM text item position params into the the global TCL ::SAPDat array for a future transfer.

Parameters
Index- internal TCL array index
BomPosition
TextLine1
TextLine2
SortInfo(optional - empty)
Returns
OK

◆ storeLongText2Structure()

TPSAP::ORDERBOM::storeLongText2Structure   LongTextList LongTextType ?Identifier? ?LineFormat? args  

Function fuellt das LangTextArray Gueltige Werte fuer den LongTextType sind 0 fuer den Bom Langtext 1 fuer den Bom Alt Langtext 2 fuer den Bom Position Langtext.

Der Parameter Identifier muss nur fuer BOM Positions uebergeben werden

Returns
OK