Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductionSupplyArea" of service "API_PRODUCTIONSUPPLYAREA_SRV". This service is part of the following communication scenarios: Production Supply Area Integration (SAP_COM_0328). See https://api.sap.com/api/API_PRODUCTIONSUPPLYAREA_SRV for more information.

Hierarchy

  • Entity
    • ProductionSupplyArea

Implements

Index

Constructors

constructor

  • Returns ProductionSupplyArea

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 factoryCalendar

factoryCalendar: string

Factory calendar key. Key that uniquely identifies the factory calendar that is valid for this plant. Maximum length: 2.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Last Change Timestamp.

nullable

plant

plant: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

productionSupplyArea

productionSupplyArea: string

Production Supply Area. The production supply area (PSA) serves as a place for interim storage on the shop floor and is used to make material directly available for production purposes. The PSA is used in Kanban and JIT Outbound processing and in Extended Warehouse Management. Maximum length: 10.

Optional productionSupplyAreaAddressId

productionSupplyAreaAddressId: string

Address for Supply Area. Maximum length: 10.

nullable

Optional productionSupplyAreaRespPerson

productionSupplyAreaRespPerson: string

Person responsible for one or more supply areas. Person responsible for processing materials and for monitoring stocks at the supply area. You define the key for the person responsible in Customizing for MRP, under, Master data -> Define MRP controllers. Maximum length: 3.

nullable

Optional pullIntervalInMinutes

pullIntervalInMinutes: BigNumber

Pull Interval in Minutes. Time interval between the transfer of requirements from the consumer (demand source) to the supply source or the interval between the times of delivery by the supply source to the consumer. You can enter the minutes up to the maximum value 59999999. The pull interval is used as a buffer in the control cycle calculation. It increases the number of kanban containers in the control cycle.The pull interval in minutes takes priority over the pull interval in days, i.e. the system uses the pull interval in minutes as soon as you specify this value, irrespective of what you have specified for the pull interval in days.To enable the pull interval in minutes to be used in the kanban calculation, it is necessary to define a factory calendar and shift sequences for the control cycle calculation.You can specify the pull interval in the calculation profile, in the PSA, and in control cycle maintenance. If you have specified the pull interval more than once, at different points, the system takes this interval into account with the following priorities:1: Control cycle maintenance2: PSA3: Calculation profileYour production works on a single-shift basis from 8.00 hrs to 16.00 hrs. This information in stored in the shift sequence.The person who replenishes the PSA arrives at 8 hrs and 12 hrs every day to pick up empty kanbans (kanban cards) and leave behind full ones. In this case, the pull interval amounts to 4 hours.

nullable

Optional pullIntervalInWorkdays

pullIntervalInWorkdays: BigNumber

Pull Interval in Workdays. Time interval between the transfer of requirements from the consumer (demand source) to the supply source or the interval between the times of delivery by the supply source to the consumer. The pull interval is used as a buffer in the control cycle calculation. It increases the number of kanban containers in the control cycle.The pull interval in hours/minutes takes priority over the pull interval in days, i.e. the system uses the pull interval in hours/minutes as soon as you specify this value, irrespective of what you have specified for the pull interval in days.You can specify the pull interval in the calculation profile, in the PSA, and in control cycle maintenance. If you have specified the pull interval more than once, at different points, the system takes this interval into account with the following priorities:1: Control cycle maintenance2: PSA3: Calculation profileThe person who replenishes the PSA arrives at 8 a.m. every day to pick up empty kanbans (kanban cards) and leave behind full ones. In this case, the pull interval amounts to 1 day.

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 shiftGrouping

shiftGrouping: string

Grouping for Shift Definition and Sequences (Consumer). Gibt die Indicates the shift grouping of the consuming work center. You use the shift grouping and the shift sequence to specify the working times of the consuming work center in detail. The system calculates the calendar buffer from this information.You can specify the shift grouping in the calculation profile and in the PSA. The shift grouping you specify in the PSA overrides the shift grouping you may have entered in the calculation profile.If you do not specify any data for the working time for the consuming work center, the system uses the data that you have maintained for the supplier (supply source). In this case, the calendar buffer calculated by the system is 0. Maximum length: 2.

nullable

Optional shiftSequence

shiftSequence: string

Key for Shift Sequence (Consumer). Shows the key of the shift sequence that you have created for the consuming work center. You use the shift grouping and the shift sequence to specify the working times of the consuming work center in detail. The system calculates the calendar buffer from this information.You can specify the shift sequence in the calculation profile and in the PSA. The shift sequence you specify in the PVB overrides one that you may have entered in the calculation profile.If you do not specify any data for the working time for the consuming work center, the system uses the data that you have maintained for the supplier (supply source). In this case, the calendar buffer calculated by the system is 0. Maximum length: 4.

nullable

Optional storageLocation

storageLocation: string

Storage Location. Maximum length: 4.

nullable

toProductionSupplyAreaAddress

toProductionSupplyAreaAddress: ProductionSupplyAreaAddress

One-to-one navigation property to the ProductionSupplyAreaAddress entity.

toProductionSupplyAreaText

toProductionSupplyAreaText: ProductionSupplyAreaText[]

One-to-many navigation property to the ProductionSupplyAreaText entity.

Optional unloadingPointName

unloadingPointName: string

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

nullable

Optional unloadingWarehouseStagingArea

unloadingWarehouseStagingArea: string

(Automotive) Unloading Point. Describes the unloading point that is communicated to the vendor in the corresponding release order (forecast delivery schedule, JIT delivery schedule, or kanban summarized JIT call). Unloading points in the goods receipt process are understood to be the place where delivered goods are physically unloaded.The unloading point entered is transmitted to the vendor in the forecast delivery schedule, the JIT delivery schedule, or the kanban summarized JIT call.The unloading point is copied from the referenced scheduling agreement or summarized JIT call for the (Automotive) goods receipt process. You can use it as a selection criterion.You must enter the plant and the storage location before you can enter the Automotive unloading point in an MM scheduling agreement item.The permissible (Automotive) unloading points are determined from the staging areas, which you can maintain in Customizing for Logistics Execution.Staging areas were originally organizational units for Logistics Execution. They are now used - described as (Automotive) unloading point - to represent unloading points in the Automotive environment.NoteThe following terms are used synonymously:Unloading point (Automotive) <-> Staging area (Logistics Execution)Unloading zone (Automotive) <-> Door (WM/Logistics Execution)For further information on the use of (Automotive) unloading zones, see the SAP Library under SAP Automotive -> MM Scheduling Agreement Enhancements.The following example describes how you can use (Automotive) unloading points in MM scheduling agreement items:Warehouse number 001 is assigned to the combination plant 0001/storage location 0001 in Customizing for the Enterprise Structure, under Assignment -> Logistics Execution -> Assign warehouse number to plant/storage location.The staging areas (or Automotive unloading points) A1, A2, and A3 have been created in Customizing for Logistics Execution, under Warehouse Management -> Master Data -> Define material staging areas.Plant 0001 and storage location 0001 have been entered in the MM scheduling agreement item.ResultThe system determines the warehouse number and then the corresponding staging areas (or Automotive unloading points) from the plant/storage location combination.Unloading points A1, A2, and A3 are proposed when you use the input help when editing scheduling agreements.The unloading point selected is transmitted to the vendor in the delivery schedule. Maximum length: 10.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static FACTORY_CALENDAR

FACTORY_CALENDAR: StringField<ProductionSupplyArea> = new StringField('FactoryCalendar', ProductionSupplyArea, 'Edm.String')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<ProductionSupplyArea> = new DateField('LastChangeDateTime', ProductionSupplyArea, 'Edm.DateTimeOffset')

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 PLANT

PLANT: StringField<ProductionSupplyArea> = new StringField('Plant', ProductionSupplyArea, 'Edm.String')

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 PRODUCTION_SUPPLY_AREA

PRODUCTION_SUPPLY_AREA: StringField<ProductionSupplyArea> = new StringField('ProductionSupplyArea', ProductionSupplyArea, 'Edm.String')

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

Static PRODUCTION_SUPPLY_AREA_ADDRESS_ID

PRODUCTION_SUPPLY_AREA_ADDRESS_ID: StringField<ProductionSupplyArea> = new StringField('ProductionSupplyAreaAddressID', ProductionSupplyArea, 'Edm.String')

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

Static PRODUCTION_SUPPLY_AREA_RESP_PERSON

PRODUCTION_SUPPLY_AREA_RESP_PERSON: StringField<ProductionSupplyArea> = new StringField('ProductionSupplyAreaRespPerson', ProductionSupplyArea, 'Edm.String')

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

Static PULL_INTERVAL_IN_MINUTES

PULL_INTERVAL_IN_MINUTES: BigNumberField<ProductionSupplyArea> = new BigNumberField('PullIntervalInMinutes', ProductionSupplyArea, 'Edm.Decimal')

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

Static PULL_INTERVAL_IN_WORKDAYS

PULL_INTERVAL_IN_WORKDAYS: BigNumberField<ProductionSupplyArea> = new BigNumberField('PullIntervalInWorkdays', ProductionSupplyArea, 'Edm.Decimal')

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

Static SHIFT_GROUPING

SHIFT_GROUPING: StringField<ProductionSupplyArea> = new StringField('ShiftGrouping', ProductionSupplyArea, 'Edm.String')

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

Static SHIFT_SEQUENCE

SHIFT_SEQUENCE: StringField<ProductionSupplyArea> = new StringField('ShiftSequence', ProductionSupplyArea, 'Edm.String')

Static representation of the shiftSequence 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<ProductionSupplyArea> = new StringField('StorageLocation', ProductionSupplyArea, '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 TO_PRODUCTION_SUPPLY_AREA_ADDRESS

TO_PRODUCTION_SUPPLY_AREA_ADDRESS: OneToOneLink<ProductionSupplyArea, ProductionSupplyAreaAddress> = new OneToOneLink('to_ProductionSupplyAreaAddress', ProductionSupplyArea, ProductionSupplyAreaAddress)

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

Static TO_PRODUCTION_SUPPLY_AREA_TEXT

TO_PRODUCTION_SUPPLY_AREA_TEXT: Link<ProductionSupplyArea, ProductionSupplyAreaText> = new Link('to_ProductionSupplyAreaText', ProductionSupplyArea, ProductionSupplyAreaText)

Static representation of the one-to-many navigation property toProductionSupplyAreaText 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<ProductionSupplyArea> = new StringField('UnloadingPointName', ProductionSupplyArea, '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 UNLOADING_WAREHOUSE_STAGING_AREA

UNLOADING_WAREHOUSE_STAGING_AREA: StringField<ProductionSupplyArea> = new StringField('UnloadingWarehouseStagingArea', ProductionSupplyArea, 'Edm.String')

Static representation of the unloadingWarehouseStagingArea 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<ProductionSupplyArea> | BigNumberField<ProductionSupplyArea> | DateField<ProductionSupplyArea> | OneToOneLink<ProductionSupplyArea, ProductionSupplyAreaAddress> | Link<ProductionSupplyArea, ProductionSupplyAreaText>> = [ProductionSupplyArea.PRODUCTION_SUPPLY_AREA,ProductionSupplyArea.PLANT,ProductionSupplyArea.STORAGE_LOCATION,ProductionSupplyArea.PRODUCTION_SUPPLY_AREA_RESP_PERSON,ProductionSupplyArea.UNLOADING_POINT_NAME,ProductionSupplyArea.FACTORY_CALENDAR,ProductionSupplyArea.SHIFT_GROUPING,ProductionSupplyArea.SHIFT_SEQUENCE,ProductionSupplyArea.PULL_INTERVAL_IN_WORKDAYS,ProductionSupplyArea.PULL_INTERVAL_IN_MINUTES,ProductionSupplyArea.UNLOADING_WAREHOUSE_STAGING_AREA,ProductionSupplyArea.PRODUCTION_SUPPLY_AREA_ADDRESS_ID,ProductionSupplyArea.LAST_CHANGE_DATE_TIME,ProductionSupplyArea.TO_PRODUCTION_SUPPLY_AREA_ADDRESS,ProductionSupplyArea.TO_PRODUCTION_SUPPLY_AREA_TEXT]

All fields of the ProductionSupplyArea entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductionSupplyArea"

Technical entity name for ProductionSupplyArea.

Static _keyFields

_keyFields: Array<Selectable<ProductionSupplyArea>> = [ProductionSupplyArea.PRODUCTION_SUPPLY_AREA, ProductionSupplyArea.PLANT]

All key fields of the ProductionSupplyArea entity.

Static _keys

_keys: any = ProductionSupplyArea._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_PRODUCTIONSUPPLYAREA_SRV"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      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 ProductionSupplyArea.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductionSupplyArea>

    A builder that constructs instances of entity type ProductionSupplyArea.

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, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns ProductionSupplyAreaRequestBuilder

    A ProductionSupplyArea request builder.