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 "*".
Higher-Level Assembly Material. Indicates the number of the assembly for which the component is required. Maximum length: 40.
Assembly Order Level. Maximum length: 2.
Assembly Order Path. Maximum length: 2.
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.
Bill of Material Category Code. Maximum length: 1.
Bill of Material. Number used in combination with the BOM category to uniquely identify a BOM or a BOM group. The system assigns this number internally. These numbers are irrelevant to the user. You access the BOM by entering the object (for example, material or equipment) to which the BOM belongs.The system stores the following information under this number:all alternatives in a multiple BOMall variants in a variant BOMBOMs that are allocated to more than one plant. Maximum length: 8.
BOM item number. Item number of the BOM components copied into the order. Maximum length: 4.
Alternative BOM. Identifies one BOM in a BOM group. One product or assembly can be described by a number of (alternative) BOMs that represent, for example, different manufacturing processes for different lot sizes. These alternative BOMs are grouped together as one multiple BOM.Alternatives are maintained separately for each BOM usage. Maximum length: 2.
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.
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.
Debit/Credit Code. Maximum length: 1.
Discontinuation Group. Maximum length: 2.
Unit of entry. Specifies the unit of measure in which the goods movement or inventory count is entered. Enter a unit of measure here only if it differs from the default unit of measure.There are the following default units of measure:the order unit for goods receipts with reference to purchase ordersthe production unit for goods receipts with reference to production ordersthe unit of issue for other goods movementsIf the default unit of measure has not been defined in the material master record, the system will suggest the stockkeeping unit. Maximum length: 3.
Follow-up Group. Maximum length: 2.
Follow-Up / Original Material. Maximum length: 40.
Indicator: Follow-Up Material is Active.
Quantity in Unit of Entry.
Last Change to Planned Order: Time Stamp.
Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.
Phantom Item Indicator.
Discontinuation Type. This indicator is used to identify that the material is a part to be discontinued and it activates the discontinuation procedure during the planning run. If the indicator is set, the system passes on the dependent requirements that are no longer covered by the warehouse stock of the material to the follow-up material during the planning run.Prerequisites:Materials and follow-up materials must by planned using one of the MRP procedures.The base unit of measure of the follow-up material must be the same as the base unit of measure of the material to be discontinued. Maximum length: 1.
Indicator: Component is Follow-Up Material.
Material Component Requirement Date.
MRP Controller. Maximum length: 3.
Order level. The order level or the order path are only relevant to planning with phantom assemblies. Order level and order path together define the exact position of a phantom assembly within the bill of material structure.A bill of material contains the following phantom assemblies (PhanAS) and materials:Material'A'___PhantAS'B' PhantAS'C' Material'D'_____ ___PhantAS'E' Material'F' Material'G' Material'H'Material'J'To retrace the position of individual phantom assemblies within the BOM structure, the order levels and order paths are given according to the following logic:per BOM level, a number is given for the order levelper BOM branch, a number is given for the order pathIn the following BOM, the first character displays the order level, and the second character displays the order path. Here, the following is valid: If the material is not a phantom assembly, the system gives it the character '0' for both level and path. However, if a material is a component of a phantom assembly, then it also receives the level and path of the phantom assembly.Material'A'(0/0)___PhantAS'B' PhantAS'C' Material'D'(1/1) (1/2) (0/0)_____ ___PhantAS'E' Material'F' Material'G' Material'H'(2/1) (1/1) (1/2) (1/2)Material'J'(2/1). Maximum length: 2.
Order path. The order level or the order path are only relevant for planning with phantom assemblies. Order levels and order paths together indicate the exact item of a phantom assembly within a bill of material.A bill of material contains the following phantom assemblies (PhantAs) and materials:Material'A'___PhantAs'B' PhantAs'C' Material'D'_____ ___PhantAs'E' Material'F' Material'G' Material'H'Material'J'To be able to trace individual phantom assemblies through the BOM structure, the order levels and paths are given according to the following logic:One number for the order level is given per BOM levelOne number for the order path is given per BOM pathIn the following BOM, the first number shows the order level and the second number shows the order path. Here, the following is valid: If a material is not a phantom assembly, the number '0' is given as level and path. However, if a material is a component of a phantom assembly, then the phantom assembly passes its level and path on to this component.Material'A'(0/0)___PhantAs'B' PhantAs'C' Material'D'(1/1) (1/2) (0/0)_____ ___PhantAs'E' Material'F' Material'G' Material'H'(2/1) (1/1) (1/2) (1/2)Material'J'(2/1). Maximum length: 2.
Planned Order. Number that specifically identifies a planned order for a material. Maximum length: 10.
Plant. Key uniquely identifying a plant. 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.
Number of reservation/dependent requirements. Alphanumeric key uniquely identifying the document. Maximum length: 10.
Reservation Item. Maximum length: 4.
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.
ETag version identifier accessor.
Withdrawn Quantity.
All fields selector.
Static representation of the assembly property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the assemblyOrderLevelValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the assemblyOrderPathValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 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 billOfMaterialInternalId 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 billOfMaterialVariant 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 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 debitCreditCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the discontinuationGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the entryUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the followUpGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the followUpMaterial property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the followUpMaterialIsNotActive property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the goodsMovementEntryQty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lastChangeDateTime 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 matlCompDiscontinuationType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the matlCompIsFollowUpMaterial 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 mrpController property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the orderLevelValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the orderPathValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the plannedOrder 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 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 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 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 withdrawnQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the PlannedOrderComponent entity.
Default url path for the according service.
Technical entity name for PlannedOrderComponent.
All key fields of the PlannedOrderComponent entity.
Mapping of all key field names to the respective static field property PlannedOrderComponent.
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 PlannedOrderComponent.
A builder that constructs instances of entity type PlannedOrderComponent.
Returns a selectable object that allows the selection of custom field in a get request for the entity PlannedOrderComponent.
Name of the custom field to select
A builder that constructs instances of entity type PlannedOrderComponent.
Returns a request builder to construct requests for operations on the PlannedOrderComponent entity type.
A PlannedOrderComponent request builder.
This class represents the entity "A_PlannedOrderComponent" of service "API_PLANNED_ORDERS". This service is part of the following communication scenarios: Production Planning Integration (SAP_COM_0104). See https://api.sap.com/api/API_PLANNED_ORDERS for more information.