A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.
The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".
Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.
Batch Number. Assigns a material that is manufactured in batches or production lots to a specific batch. Maximum length: 10.
Batch key. If a material is to be processed in batches, the component in the order is given a batch key. The key can have the following characteristics:X - batch permittedThis key indicates that the material component is processed in batches. However, no batch split takes place.1 - Batch totals recordThis key indicates that a batch split was carried out for the material component.On the component overview screen, a line with this key contains the total requirements quantity of the component or the quantity not yet assigned.2 - Individual batch recordThis key indicates that a batch split was carried out for the material component.On the component overview screen, a line with this key displays the proportion of the requirements quantity that was assigned to a particular batch. Maximum length: 1.
Bill of Material Category Code. Maximum length: 1.
BOM item number. Item number of the BOM components copied into the order. Maximum length: 4.
Bill of Material Item. Maximum length: 8.
Bill of Material Item Category. Maximum length: 1.
BOM Item Text (Line 1). Text of up to 40 characters, which forms the first of two lines of text describing the item. If this text length (two lines of 40 characters each) is not sufficient, you can also enter a long text by choosing menu option Extras -> Long text -> Item.When you create an item long text, the first 80 characters of the BOM item text are copied to the long text.If you change the BOM item text, the first 80 characters of long text are automatically changed, too. If you change the first two lines of the BOM item long text, the short text is automatically changed.Note:For text items, this text is copied to the component description field on the item overview. Maximum length: 40.
BOM Item Text (Line 2). Text of up to 40 characters, which forms the second of two lines of text describing the item. You can also enter a long text by choosing menu option Details --> Long text --> Item long text.If the text comprises less than three lines, it is stored in the BOM item. Otherwise, it is stored as a long text in the text database. Maximum length: 40.
Component Scrap in Percent. Percentage of scrap that occurs during production of the material if the material is a component. Component scrap is used in material requirements planning (MRP) to determine the quantities of components required. When exploding the bill of material (BOM), the system increases the required quantities of the components by the calculated scrap quantity.ExampleRequired quantity 200 piecesComponent scrap 10%Scrap quantity 20 piecesTherefore, 220 pieces are required.For examples of calculation in connection with the indicator for net scrap, see the documentation for this indicator.If there is also assembly scrap for a higher-level assembly, the system adds together the two types of scrap.If component scrap has been entered in the BOM, this value applies. Otherwise, the value specified in the material master record is used.
Available Quantity.
Currency Key. Currency key for amounts in the system. Maximum length: 5.
Goods Movement Type (Inventory Management). Specifies a key for the type of goods movement. Each goods movement (for example, purchase order to warehouse) is allocated to a movement type in the system. Maximum length: 3.
Goods Recipient. Maximum length: 12.
Indicator: Bulk Material. This indicator defines a BOM item as a bulk material, which is available directly at the work center (for example, washers or grease). The dependent requirements of bulk materials are not relevant to materials planning. This means they are not taken into account for net requirements calculation. Therefore planning for bulk materials should be consumption-based.If bulk materials are subject to material requirements planning, you must create planned independent requirements for them.Dependent requirements are only created in the planned order for information purposes and they can be displayed there. Dependent requirements for bulk material are not shown in the MRP list or the stock/req. list.You can maintain this indicator in both the material master record an the BOM item. The indicator in the material master record has higher priority.If a material is always used as a bulk material, set the indicator in the material master record.In this case, the Bulk material indicator in material master record is automatically set in the BOM item.If a material is only used as a bulk material in individual cases, set the indicator in the BOM item.To improve system performance, you can define in the IMG for MRP that no dependent requirements are to be created for bulk material items. However, this also means that you see no information on bulk material components in the planned order or production order.
Net Scrap Indicator. This indicator determines whether scrap for the component is calculated on the basis of the net required quantity (the required quantity without assembly scrap from the material master record). You must set this indicator if you want assembly scrap to be ignored.You must set this indicator if you enter operation scrap.You can set this indicator if you only enter component scrap, to calculate scrap on the basis of the net required quantity for the assembly.Bill of material:Assembly MAT-1:Required quantity 100 piecesAssembly scrap 2%Component MAT-2:Component quantity 100 piecesDepending on the applicable scrap and the net indicator, the following 6 quantities are required for component MAT-2 for a required quantity of 100 pieces of MAT-1:1 2 3 4 5 6 Comp 5% - 5% 5% - -Op. 6% 6% - - - -Net ind X X X - - X---------------------------------------------------------------------Qty 11130 10600 10500 10710 10200 10000KeyComp Component scrapOp. Operation scrapNet ind Net indicatorQty Quantity calculated for component MAT-2 in pieces.
Lead-Time Offset.
Manufacturing Order ID. Maximum length: 12.
Manufacturing Order Category. Maximum length: 2.
Manufacturing Order Operation. Maximum length: 4.
Sequence. Key which identifies a sequence of operations within a routing. Maximum length: 6.
Manufacturing Order Type. Maximum length: 4.
Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.
Indicator for Relevancy to Costing. Controls the extent to which a BOM item, operation, or suboperation in the routing is included in costing. For the Standard Cost Estimate and the calculation of planned costs for a Work Order, this indicator specifies whether the item is included in costing.A BOM item or operation for which the indicator for relevancy to costing is X is fully relevant to costing.A BOM item or operation without an indicator for relevancy to costing is not relevant to costing at all.For Inventory Costing, you can link relevancy to costing indicators to factors for the fixed and variable costs so that the item values can be adjusted in costing depending on the valuation variant. You do this in Customizing for Product Cost Controlling.A BOM item or operation has the indicator for relevancy to costing A, which you have linked in Customizing for Product Cost Controlling to a fixed factor of 0.8 and a variable factor of 0.8. The BOM item or operation is costed in inventory costing at 80% of the fixed costs and 80% of the variable costs.For output materials (that is, materials for which the co-product indicator has been set in the material master and that have a negative BOM item), the relevance to costing indicator has no effect on the BOM item.The BOM usage that you selected on the initial screen determines whether this field is ready for input. For more information, see Customizing under Production -> Basic Data -> Bill of Material -> General Data -> BOM Usage -> Define BOM Usages. Maximum length: 1.
Original Quantity of a Material Component.
Phantom Item Indicator.
Material Group. Key that you use to group together several materials or services with the same attributes, and to assign them to a particular material group. You can use material groups to:Restrict the scope of analysesSearch specifically for material master records via search helps. Maximum length: 9.
Indicator: Backflush. Indicator specifying that the material component is backflushed. Each material component is assigned to an operation in the production order. If a material component is backflushed, the system posts the withdrawal only upon confirmation of the operation. The withdrawal is then posted automatically.
Material Component Requirement Date.
Material Component Requirement Time.
Operation Scrap. Scrap that is expected in one operation for the quantity of a component to be processed. This entry is used to override the assembly scrap for materials of high value.If operation scrap is maintained, you avoid the situation whereby too much of the material is planned in MRP for the components of subsequent operations.If you make an entry for operation scrap, you must also select the operation scrap net indicator (Net field).You can find examples of scrap under net scrap.
Order Internal ID. Maximum length: 10.
Plant. Key uniquely identifying a plant. Maximum length: 4.
Production Plant in Planned Order. Plant in which the order quantity of the internally produced material is to be produced according to the planned order. Maximum length: 4.
Quantity is fixed. Determines that the quantity of an item is constant. Set this indicator if the quantity in a relational system does not change.If an item of a BOM is marked as being fixed and the quantity of the finished product to be manufactured is changed, the quantity of this item does not change.If a "materials to be provided" item is not marked as being fixed, and the quantity of the subcontracted item is changed, the quantity of the material to be provided to the subcontractor changes proportionately.
The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.
Requirement Quantity. Specifies the quantity in the base unit of measure, which can have various meanings, depending on the situation: In the case of a planned order or a production order, this is the quantity of the material component required to manufacture the planned order quantity.In the case of a reservation, this is the quantity reserved.
Number of reservation/dependent requirements. Alphanumeric key uniquely identifying the document. Maximum length: 10.
Final Issue for Reservation. Indicates that a reservation item is completed. Further goods movements in respect of this reservation item are not anticipated, although they are still possible.The indicator is set automatically for a goods movement when the total reserved quantity has been withdrawn or delivered. In the case of a partial delivery, you can manually set the indicator if no further goods movements are expected in respect of the relevant reservation item.
Reservation Item. Maximum length: 4.
Sales Order. Number of the sales order to which the order is to be settled. Maximum length: 10.
Sales Order Item. Item in the sales order to which the order is to be settled. Maximum length: 6.
Sort String. String which can be defined as required for sorting components for display. Maximum length: 10.
Storage Location. Maximum length: 4.
Production Supply Area. Maximum length: 10.
Unloading Point. Specifies the point at which the material is to be unloaded (for example, ramp 1). Maximum length: 25.
Withdrawn Quantity.
Value Withdrawn. Indicates the value of the quantity withdrawn from storage.
All fields selector.
Static representation of the baseUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the batch property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the batchSplitType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the billOfMaterialCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the billOfMaterialItemNumber property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the bomItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the bomItemCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the bomItemDescription property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the bomItemText2 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the componentScrapInPercent property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the confirmedAvailableQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the currency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the goodsMovementType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the goodsRecipientName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isBulkMaterialComponent property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isNetScrap property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the leadTimeOffset property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the manufacturingOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the manufacturingOrderCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the manufacturingOrderOperation property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the manufacturingOrderSequence property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the manufacturingOrderType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the material property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialComponentIsPhantomItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialCompIsCostRelevant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialCompOriginalQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the matlCompIsMarkedForBackflush property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the matlCompRequirementDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the matlCompRequirementTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the operationScrapInPercent property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the orderInternalBillOfOperations property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the plant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the productionPlant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the quantityIsFixed property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the requiredQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the reservation property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the reservationIsFinallyIssued property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the reservationItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesOrderItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the sortField property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the storageLocation property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the supplyArea property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the unloadingPointName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the withdrawnQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the withdrawnQuantityAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the ProcessOrderComponent entity.
Default url path for the according service.
Technical entity name for ProcessOrderComponent.
All key fields of the ProcessOrderComponent entity.
Mapping of all key field names to the respective static field property ProcessOrderComponent.
ETag version identifier accessor.
The ETag version identifier of the retrieved entity, returns undefined if not retrieved
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances ProcessOrderComponent.
A builder that constructs instances of entity type ProcessOrderComponent.
Returns a selectable object that allows the selection of custom field in a get request for the entity ProcessOrderComponent.
Name of the custom field to select
A builder that constructs instances of entity type ProcessOrderComponent.
Returns a request builder to construct requests for operations on the ProcessOrderComponent entity type.
A ProcessOrderComponent request builder.
This class represents the entity "A_ProcessOrderComponent" of service "API_PROCESS_ORDERS". This service is part of the following communication scenarios: Production Planning Integration (SAP_COM_0104), Manufacturing Execution - Order and Confirmation Integration (SAP_COM_0522). See https://api.sap.com/api/API_PROCESS_ORDERS for more information.