Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductionOrderItem" of service "API_PRODUCTION_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_PRODUCTION_ORDERS for more information.

Hierarchy

  • Entity
    • ProductionOrderItem

Implements

Index

Constructors

constructor

  • Returns ProductionOrderItem

Properties

Protected _customFields

_customFields: MapType<any>

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.

Protected _versionIdentifier

_versionIdentifier: string

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 "*".

Optional batch

batch: undefined | string

Batch Number. Assigns a material that is manufactured in batches or production lots to a specific batch. Maximum length: 10.

nullable

Optional goodsRecipientName

goodsRecipientName: undefined | string

Goods Recipient. Maximum length: 12.

nullable

Optional inventoryUsabilityCode

inventoryUsabilityCode: undefined | string

Inventory Usability Code. Maximum length: 1.

nullable

manufacturingOrder

manufacturingOrder: string

Manufacturing Order ID. Maximum length: 12.

Optional manufacturingOrderCategory

manufacturingOrderCategory: undefined | string

Manufacturing Order Category. Maximum length: 2.

nullable

manufacturingOrderItem

manufacturingOrderItem: string

Manufacturing Order Item ID. Maximum length: 4.

Optional manufacturingOrderType

manufacturingOrderType: undefined | string

Manufacturing Order Type. Maximum length: 4.

nullable

Optional material

material: undefined | string

Material Number for Order. Number of the material that is to be produced with this order. Maximum length: 40.

nullable

Optional materialGoodsReceiptDuration

materialGoodsReceiptDuration: BigNumber

Goods Receipt Processing Duration in Days. Number of working days required for checking the material and transferring it to the appropriate storage location after receipt of the goods.

nullable

Optional mfgOrderItemActualDeliveryDate

mfgOrderItemActualDeliveryDate: Moment

Actual Delivery/Finish Date. Specifies when the material was produced / delivered to stock. The system sets the date automatically.

nullable

Optional mfgOrderItemActualDeviationQty

mfgOrderItemActualDeviationQty: BigNumber

Expected Surplus/Deficit For Goods Receipt. This quantity indicates by how much the goods receipt of the finished product will probably deviate from the planned goods receipt. It is updated when the operations are finally confirmed as soon as an operation quantity that varies from the plan is confirmed as the yield.If a production order is to manufacture 100 pieces and a quantity of 5 pieces is displayed in this field then you can expect anen Lagerzugang von 95 Stück erwarten.If this value is negative that means that you have produced more than you originally planned. In this case you can expect a correspondingly high goods receipt for the finished product.

nullable

Optional mfgOrderItemGoodsReceiptQty

mfgOrderItemGoodsReceiptQty: BigNumber

Quantity of Goods Received for the Order Item. Quantity of the order item, which has so far been produced and posted to stock.

nullable

Optional mfgOrderItemPlannedScrapQty

mfgOrderItemPlannedScrapQty: BigNumber

Order Item Planned Scrap Quantity.

nullable

Optional mfgOrderItemPlannedTotalQty

mfgOrderItemPlannedTotalQty: BigNumber

Order Item Planned Total Quantity.

nullable

Optional mfgOrderItemPlndDeliveryDate

mfgOrderItemPlndDeliveryDate: Moment

Delivery Date From Planned Order. The delivery date of the planned order, as determined by MRP. This field only contains an entry if the production order was created by converting a planned order.

nullable

Optional mrpArea

mrpArea: undefined | string

MRP Area. Number of the MRP area for which material requirements planning should be carried out separately. Maximum length: 10.

nullable

Optional mrpPlant

mrpPlant: undefined | string

Planning Plant for an Order. Plant in which, after order execution, the goods receipt takes place for the material produced. If the planning plant and production plant are identical then you need not enter the planning plant as well. The production plant is copied automatically.The planning plant can be used, for example, if Sales and Distribution is to be organized as an independent plant. Maximum length: 4.

nullable

Optional productionPlant

productionPlant: undefined | string

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.

nullable

Optional productionUnit

productionUnit: undefined | string

Production Unit of Measure. Maximum length: 3.

nullable

Optional quantityDistributionKey

quantityDistributionKey: undefined | string

MRP Distribution Key. Repetitive manufacturing: Depending on the context, this may be the distribution key for the quantity produced or the distribution key for component consumption.Kanban:In the kanban calculation profile, you specify the distribution key for the smoothing of the dependent requirements. Maximum length: 4.

nullable

Protected remoteState

remoteState: object

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.

Type declaration

  • [keys: string]: any

Optional stockSegment

stockSegment: undefined | string

Stock Segment. Segment assigned to a stockable item. The valid stock segment is defined in the segmentation strategy and the strategy is assigned to the material in the material master. Maximum length: 40.

nullable

Optional storageLocation

storageLocation: undefined | string

Storage Location. Maximum length: 4.

nullable

Optional unloadingPointName

unloadingPointName: undefined | string

Unloading Point. Specifies the point at which the material is to be unloaded (for example, ramp 1). Maximum length: 25.

nullable

Static ALL_FIELDS

ALL_FIELDS: AllFields<ProductionOrderItem> = new AllFields('*', ProductionOrderItem)

All fields selector.

Static BATCH

BATCH: StringField<ProductionOrderItem> = new StringField('Batch', ProductionOrderItem, 'Edm.String')

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 GOODS_RECIPIENT_NAME

GOODS_RECIPIENT_NAME: StringField<ProductionOrderItem> = new StringField('GoodsRecipientName', ProductionOrderItem, 'Edm.String')

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 INVENTORY_USABILITY_CODE

INVENTORY_USABILITY_CODE: StringField<ProductionOrderItem> = new StringField('InventoryUsabilityCode', ProductionOrderItem, 'Edm.String')

Static representation of the inventoryUsabilityCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MANUFACTURING_ORDER

MANUFACTURING_ORDER: StringField<ProductionOrderItem> = new StringField('ManufacturingOrder', ProductionOrderItem, 'Edm.String')

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 MANUFACTURING_ORDER_CATEGORY

MANUFACTURING_ORDER_CATEGORY: StringField<ProductionOrderItem> = new StringField('ManufacturingOrderCategory', ProductionOrderItem, 'Edm.String')

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 MANUFACTURING_ORDER_ITEM

MANUFACTURING_ORDER_ITEM: StringField<ProductionOrderItem> = new StringField('ManufacturingOrderItem', ProductionOrderItem, 'Edm.String')

Static representation of the manufacturingOrderItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MANUFACTURING_ORDER_TYPE

MANUFACTURING_ORDER_TYPE: StringField<ProductionOrderItem> = new StringField('ManufacturingOrderType', ProductionOrderItem, 'Edm.String')

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 MATERIAL

MATERIAL: StringField<ProductionOrderItem> = new StringField('Material', ProductionOrderItem, 'Edm.String')

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 MATERIAL_GOODS_RECEIPT_DURATION

MATERIAL_GOODS_RECEIPT_DURATION: BigNumberField<ProductionOrderItem> = new BigNumberField('MaterialGoodsReceiptDuration', ProductionOrderItem, 'Edm.Decimal')

Static representation of the materialGoodsReceiptDuration property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MFG_ORDER_ITEM_ACTUAL_DELIVERY_DATE

MFG_ORDER_ITEM_ACTUAL_DELIVERY_DATE: DateField<ProductionOrderItem> = new DateField('MfgOrderItemActualDeliveryDate', ProductionOrderItem, 'Edm.DateTime')

Static representation of the mfgOrderItemActualDeliveryDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MFG_ORDER_ITEM_ACTUAL_DEVIATION_QTY

MFG_ORDER_ITEM_ACTUAL_DEVIATION_QTY: BigNumberField<ProductionOrderItem> = new BigNumberField('MfgOrderItemActualDeviationQty', ProductionOrderItem, 'Edm.Decimal')

Static representation of the mfgOrderItemActualDeviationQty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MFG_ORDER_ITEM_GOODS_RECEIPT_QTY

MFG_ORDER_ITEM_GOODS_RECEIPT_QTY: BigNumberField<ProductionOrderItem> = new BigNumberField('MfgOrderItemGoodsReceiptQty', ProductionOrderItem, 'Edm.Decimal')

Static representation of the mfgOrderItemGoodsReceiptQty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MFG_ORDER_ITEM_PLANNED_SCRAP_QTY

MFG_ORDER_ITEM_PLANNED_SCRAP_QTY: BigNumberField<ProductionOrderItem> = new BigNumberField('MfgOrderItemPlannedScrapQty', ProductionOrderItem, 'Edm.Decimal')

Static representation of the mfgOrderItemPlannedScrapQty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MFG_ORDER_ITEM_PLANNED_TOTAL_QTY

MFG_ORDER_ITEM_PLANNED_TOTAL_QTY: BigNumberField<ProductionOrderItem> = new BigNumberField('MfgOrderItemPlannedTotalQty', ProductionOrderItem, 'Edm.Decimal')

Static representation of the mfgOrderItemPlannedTotalQty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MFG_ORDER_ITEM_PLND_DELIVERY_DATE

MFG_ORDER_ITEM_PLND_DELIVERY_DATE: DateField<ProductionOrderItem> = new DateField('MfgOrderItemPlndDeliveryDate', ProductionOrderItem, 'Edm.DateTime')

Static representation of the mfgOrderItemPlndDeliveryDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MRP_AREA

MRP_AREA: StringField<ProductionOrderItem> = new StringField('MRPArea', ProductionOrderItem, 'Edm.String')

Static representation of the mrpArea property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MRP_PLANT

MRP_PLANT: StringField<ProductionOrderItem> = new StringField('MRPPlant', ProductionOrderItem, 'Edm.String')

Static representation of the mrpPlant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCTION_PLANT

PRODUCTION_PLANT: StringField<ProductionOrderItem> = new StringField('ProductionPlant', ProductionOrderItem, 'Edm.String')

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 PRODUCTION_UNIT

PRODUCTION_UNIT: StringField<ProductionOrderItem> = new StringField('ProductionUnit', ProductionOrderItem, 'Edm.String')

Static representation of the productionUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static QUANTITY_DISTRIBUTION_KEY

QUANTITY_DISTRIBUTION_KEY: StringField<ProductionOrderItem> = new StringField('QuantityDistributionKey', ProductionOrderItem, 'Edm.String')

Static representation of the quantityDistributionKey property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static STOCK_SEGMENT

STOCK_SEGMENT: StringField<ProductionOrderItem> = new StringField('StockSegment', ProductionOrderItem, 'Edm.String')

Static representation of the stockSegment property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static STORAGE_LOCATION

STORAGE_LOCATION: StringField<ProductionOrderItem> = new StringField('StorageLocation', ProductionOrderItem, 'Edm.String')

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 UNLOADING_POINT_NAME

UNLOADING_POINT_NAME: StringField<ProductionOrderItem> = new StringField('UnloadingPointName', ProductionOrderItem, 'Edm.String')

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 _allFields

_allFields: Array<StringField<ProductionOrderItem> | DateField<ProductionOrderItem> | BigNumberField<ProductionOrderItem>> = [ProductionOrderItem.MANUFACTURING_ORDER,ProductionOrderItem.MANUFACTURING_ORDER_ITEM,ProductionOrderItem.MANUFACTURING_ORDER_CATEGORY,ProductionOrderItem.MANUFACTURING_ORDER_TYPE,ProductionOrderItem.PRODUCTION_PLANT,ProductionOrderItem.MATERIAL,ProductionOrderItem.MRP_PLANT,ProductionOrderItem.MFG_ORDER_ITEM_ACTUAL_DELIVERY_DATE,ProductionOrderItem.MFG_ORDER_ITEM_PLANNED_TOTAL_QTY,ProductionOrderItem.MFG_ORDER_ITEM_PLANNED_SCRAP_QTY,ProductionOrderItem.MFG_ORDER_ITEM_GOODS_RECEIPT_QTY,ProductionOrderItem.MFG_ORDER_ITEM_ACTUAL_DEVIATION_QTY,ProductionOrderItem.PRODUCTION_UNIT,ProductionOrderItem.MRP_AREA,ProductionOrderItem.STORAGE_LOCATION,ProductionOrderItem.MFG_ORDER_ITEM_PLND_DELIVERY_DATE,ProductionOrderItem.GOODS_RECIPIENT_NAME,ProductionOrderItem.MATERIAL_GOODS_RECEIPT_DURATION,ProductionOrderItem.INVENTORY_USABILITY_CODE,ProductionOrderItem.UNLOADING_POINT_NAME,ProductionOrderItem.QUANTITY_DISTRIBUTION_KEY,ProductionOrderItem.STOCK_SEGMENT,ProductionOrderItem.BATCH]

All fields of the ProductionOrderItem entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_PRODUCTION_ORDERS"

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductionOrderItem"

Technical entity name for ProductionOrderItem.

Static _keyFields

_keyFields: Array<Selectable<ProductionOrderItem>> = [ProductionOrderItem.MANUFACTURING_ORDER, ProductionOrderItem.MANUFACTURING_ORDER_ITEM]

All key fields of the ProductionOrderItem entity.

Static _keys

_keys: object = ProductionOrderItem._keyFields.reduce((acc: { [keys: string]: Selectable<ProductionOrderItem> }, field: Selectable<ProductionOrderItem>) => {acc[field._fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property ProductionOrderItem.

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCTION_ORDERS"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for ProductionOrderItem.

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • 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.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • 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.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • 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.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ProductionOrderItem.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductionOrderItem>

    A builder that constructs instances of entity type ProductionOrderItem.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the ProductionOrderItem entity type.

    Returns ProductionOrderItemRequestBuilder

    A ProductionOrderItem request builder.