GetPlanningSchedule schema, example, validation rules, validation stylesheet |
GetPlanningSchedule type: GetPlanningSchedule | |
Since collaboration between a customer and a supplier can potentially go through several rounds of negotiations, both parties can use the same BOD to communicate their current demand or supply schedule in response to what they received from the other party. Either party can indicate detailed exception descriptions along with reason code and action code to the other party why the original demand/supply requirements need to be adjusted using the optional Data Type PlanningScheduleException. The purpose of the GetPlanningSchedule is to enable a business applications module to request this Planning Schedule information from another business application. The response to this BOD is ShowPlanningSchedule. |
GetPlanningSchedule extends: BusinessObjectDocument | |||||||
Structure: |
![]() |
||||||
Elements: |
|
GetPlanningScheduleDataArea extends: DataArea | ||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
GetPlanningSchedule Scenario Diagram |
Get schema |
Get type: Get | |
The GET verb is to communicate to a business software component a request for an existing piece of information to be returned. The GET may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the SHOW verb. The behavior of a BOD with a GET verb is quite predictable across most of the nouns it may be paired with.The GET is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The GET verb is not used to request several documents at once. The GETLIST verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the GET verb.1) The first selection capability is called Field-Based Selection. Within a GET-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for GET-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the GET verb. The Data Types are identified for retrieval within the GET instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the GET request and this will signify to the responding component that the Data Type is not to be returned. |
Get extends: RequestVerb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
PlanningSchedule schema |
PlanningSchedule type: PlanningSchedule | |
Indicates a demand forecast sent from a customer to a supplier, or a supply schedule sent from a supplier to a customer. |
Header type: PlanningScheduleHeader | |
Header level information for the schedule. |
Line type: PlanningScheduleLine | |
Line level information for the schedule. |
Detail type: PlanningScheduleDetail | |
Additional detail for each line item. |
Exception type: ShipmentPlanningScheduleException | |
Exception detail for Detail or Lline information. |
Bucket type: FlexibleBucket | |
All time bucket definitions used within the schedule. |
FlexibleBucket | |||||||||||||
This Data Type is used to communicate a flexible bucket definition. The value of Identifier can be taken from predefined values such as Day, Week, etc. or it can hold a user defined identifier with a specific time period. In any case the actual time period and Identifier must be used. |
|||||||||||||
Structure: |
![]() |
||||||||||||
Elements: |
|
PlanningSchedule extends: Noun | |||||||||||||
Indicates a demand forecast sent from a customer to a supplier, or a supply schedule sent from a supplier to a customer. Since collaboration between a customer and a supplier can potentially go through several rounds of negotiations, both parties can use the same BOD to communicate their current demand or supply schedule in response to what they received from the other party. Either party can indicate detailed exception descriptions along with reason code and action code to the other party why the original demand/supply requirements need to be adjusted using the optional Data Type PlanScheduleLineException. The purpose of the PlanningSchedule is to communicate requirement information (part number, quantity, etc.) between a customer and their supplier on a regular basis, for example daily, weekly etc, or for a user-defined time bucket type definition (Data Type PlanningScheduleFlexigleBucket) that is sent as part of this PlanningSchedule. |
|||||||||||||
Structure: |
![]() |
||||||||||||
Elements: |
|
PlanningScheduleDetail | |||||||||||||||||||||||||||||||||||||||||||
Detailed requirement information regarding the demand/supply schedule for the line item. It represents the additional details concerning the demand requirement or supply response on the Line. ScheduleDetail can be used to describe different quantity of the required item over various time periods as indicated by the specific time bucket type with various EffectivePeriods or quantity of the required item periodically for a specific time bucket type with an Effective period. |
|||||||||||||||||||||||||||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||||||||||||||||||||||||||
Elements: |
|
PlanningScheduleHeader extends: ShipmentPlanningScheduleHeader | ||||||||||
Information that applies to the entire planning schedule. |
||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
PlanningScheduleLine extends: ShipmentPlanningScheduleLine | ||||||||||||||||||||||
Represents the detail lines of the PlanningSchedule. It includes the demand/supply requirement with quantity, price and descriptive information. The requirement must be identified by one of the following levels: item, commodity code, or functional specifications. Attachment intended for Drawing. DocumentReferences intended to include PuchaseOrder and SalesOrder, Explicit RespondingScheduleReference used. |
||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||
Elements: |
|
Verb Common Files |
Verb.xsd schema |
AcknowledgableVerb extends: ConfirmableVerb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
AcknowledgementType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
ConfirmableVerb extends: Verb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
ConfirmType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
Expression restricts: xs:string | |
ExpressionCriteria | |||||||||
Structure: |
![]() |
||||||||
Elements: |
|
||||||||
Attributes: |
|
RequestVerb extends: ConfirmableVerb | |||||||
Structure: |
![]() |
||||||
Elements: |
|
VerbBase.xsd schema |
Verb type: Verb | |
Verb | |
Structure: |
![]() |
Noun Common Files |
ShipmentPlanningSchedule.xsd schema |
RespondingScheduleReference type: GenericDocumentReference | |
Identifies the previously received plan schedule that this new schedule is responding to as a reference. The typical scenario is a supplier uses a Sync PlanningSchedule or Sync ShipmentSchedule to respond to a customer demand schedule, and this will identify the customer demand schedule that this supplier previously received. The date and time is also used in identifying the previously received plan schedule that the new plan schedule is responding to. Note that the combination of document id, document date, and revision number can uniquely identify a plan schedule. DateType indicates whether the dates specified on the schedule are delivery based or shipment based. Dates specified on the schedule include FromDateTime and ToDateTime at Header and Line levels. ScheduleType indicates whether the PlanningSchedule is a demand schedule from a customer or a supply schedule from a supplier. For the supplier schedule to respond to the original demand schedule, the RespondingScheduleReference is used to identify the customer’s original demand schedule that it is responding to. |
ShipmentPlanningScheduleException | |||||||||||||||||||||||||
Line item exceptions based on predefined business rules or contract agreements. |
|||||||||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||||||||
Elements: |
|
ShipmentPlanningScheduleHeader extends: DocumentHeader | |||||||||||||||||||
Information that applies to the entire planning schedule. |
|||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||
Elements: |
|
ShipmentPlanningScheduleLine extends: DocumentLine | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Represents the detail lines of the PlanningSchedule. It includes the demand/supply requirement with quantity, price and descriptive information. The requirement must be identified by one of the following levels: item, commodity code, or functional specifications. Attachment intended for Drawing. DocumentReferences intended to include PuchaseOrder and SalesOrder Explicit RespondingScheduleReference used. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Elements: |
|
Document.xsd schema |
Document extends: Noun | ||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
DocumentHeader | ||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||
Elements: |
|
DocumentLine | |||||||
Structure: |
![]() |
||||||
Elements: |
|
DocumentOrderHeader restricts: DocumentHeader | |||||||||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||||||||
Elements: |
|