GetShipmentSchedule schema, example, validation rules, validation stylesheet

GetShipmentSchedule type: GetShipmentSchedule

Commonly, the ship schedule is generated by a material planning application and transmitted to an order or material planning application. The purpose of the GetShipmentSchedule is to enable a business applications module to request this ShipmentSchedule information from another business application. The response to this BOD is ShowShipmentSchedule.

GetShipmentSchedule extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetShipmentScheduleDataArea

Is where the information that the BOD message carries is provided, in this case GetShipmentSchedule. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (ShipmentSchedule).

GetShipmentScheduleDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
ShipmentSchedule reference

GetShipmentSchedule 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:
Name Type Usage Description
show xs:string

ShipmentSchedule schema

ShipmentSchedule type: ShipmentSchedule

Commonly, the ship schedule is generated by a material planning application and transmitted to an order or material planning application.

Header type: ShipmentScheduleHeader

Header level information for the schedule.

Line type: ShipmentScheduleLine

Line level information for the schedule.

Exception type: ShipmentPlanningScheduleException

Exception detail for Line information.

ShipmentSchedule extends: Noun

Represents shipment schedule information.

Structure:
Elements:
Name Type Description
Header reference
Line reference

ShipmentScheduleHeader extends: ShipmentPlanningScheduleHeader

Information that applies to the entire shipment schedule.

Structure:
Elements:
Name Type Description
UserArea reference

ShipmentScheduleLine extends: ShipmentPlanningScheduleLine

The item ordered along with quantity, delivery date and other schedule information.

Structure:
Elements:
Name Type Description
RequiredDateTime DateTimeAny
UserArea reference

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

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:
Name Type Description
ActionCode Code

Represents a list of codes that specify action to fix the exceptions. Examples of values for this field include: Reduce demand quantity Increase production.

Base type for a Code of any kind

Description Description

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

EffectivePeriod TimePeriodAny

The effective dates for the schedule represents the schedule horizon dates and times . This is derived based on demand contained within the schedule if not specified. This can be a date or a time depending on the granularity of the manufacturing process.

ExceptionCode Code

Represents a list of codes of the possible most common exceptions. Examples of values for this field include: - Late Sales Order or Forecast Demand - Shortage - Exceeds Capacity

Base type for a Code of any kind

LineNumber LineNumber

Indicates the exception line number within a schedule. This is used for communicating exception errors

Identifies the instance of a Line within a given document.

ReasonCode ReasonCode

Represents a list of codes that specify reason for the exception. Examples of values for this field include: Out of stock Rejected due to lead time compression

Used as a reason indicator for any type of business event or activity.

UserArea reference

ShipmentPlanningScheduleHeader extends: DocumentHeader

Information that applies to the entire planning schedule.

Structure:
Elements:
Name Type Description
DateType Type

Indicates whether the dates specified on the schedule are delivery based or shipment based. Valid values for this field include: - Ship - Deliver

EffectivePeriod TimePeriodAny

The effective dates for the schedule represents the schedule horizon dates and times . This is derived based on demand contained within the schedule if not specified. This can be a date or a time depending on the granularity of the manufacturing process.

Parties reference
RespondingScheduleReference reference
ScheduleType Type

Iidentifier that describes the specific schedule and can be used in a variety of contexts. When used in the context of employee, ScheduleType refers to the specific schedule for the employee or worker. When used in the context of a Schedule, ScheduleType indicates whether the Schedule is a demand schedule from a customer or a supply schedule from a supplier. Valid values for this context are: - Demand - Supplier

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:
Name Type Description
ActualDeliveryDateTime DateTimeAny

The actual delivery date reported by?

Attachments reference
Authorization AuthorizationId

Represents a list of codes that specify status values for the acknowledgment. Valid codes are: - Purchase Release - Manufacturing Release - Shipment Release

Commodity Commodity

Are codes that identify user-defined groupings of items.

DeliveredQuantity Quantity

Indicates the quantity delivered.

A decimal value.

Description Description

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentReferences reference
EffectivePeriod TimePeriodAny

The effective dates for the schedule represents the schedule horizon dates and times . This is derived based on demand contained within the schedule if not specified. This can be a date or a time depending on the granularity of the manufacturing process.

EngineeringChangeDateTime DateTimeAny

identifies the date on which engineering changes to the item or product is effective.

HazardousMaterial reference

Provides the Hazardous Material Code and description.

Item reference
ItemQuantity Quantity

The customer’s actual requested amount of the item to be shipped.

A decimal value.

Kanban Kanban

Indicates the reference number associated with in-plant routing information. Typically routing information specified on customer’s Kanban ship label includes and could be specified in the user area: facility/dock location build area part description first delivery location empty container location beginning kanban serial ending kanban serial pickup date/time · delivery date/time

Is the reference number associated with in-plant routing information.

LineType Type

Indicates the type of demand requested. Examples of values for this field include: - Forecast - Firm - Authorization - Past Due - Shipment/Receipt - Other

LoadingDock LoadingDockCode

Itentifies the loading dock.

Note reference

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

Packing Packaging

Represents the secondary packing code used to further identify the package of the product. Hmmm, where is the primary packing code?

Identifies the Packaging information for a given item. Note: The UPC here is the UPC of the packaging for a given item.

PackingDescription Description

Contains information about the packing material, such as dimensions and description. Examples include Bubble pack and Styrofoam peanuts

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Parties reference
Priority xs:string

Priority of a document, task, or activity. Could be used for production orders, sales orders, purchase orders, etc. When used within the context of Schedules, priorities specify the urgency of the demand schedule, the higher the number the lower the priority. Examples of values for this field include: 1, 2, 3 or Highest Priority, Lower, Least.

PriorQuantity Quantity

Indicates the quantity recieved.

A decimal value.

Project Project

Identifies a set of tasks with the following attributes: a singular purpose, a start and end date, those that accumulate costs, and those that may have materials and overhead.

A set of tasks with the following attributes: a singular purpose, a start and end date, those that accumulate costs, and those that may have materials and overhead. SYNONYMS: Job, Process Model, Program, Work Breakdown Structure (WBS) element

ReceivedDateTime DateTimeAny

The recieved date reported by?

ReceivedQuantity Quantity

Indicates the quantity recieved.

A decimal value.

RespondingScheduleReference DocumentReference

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.

Identifies another document within the scope of the OAGIS specification, such as a PurchaseOrder or Invoice that maybe associated with a particular Business Object Document.

ShipmentDateTime DateTimeAny

Indicates the date and time an item was shipped.

ShippedQuantity Quantity

Indicates the quantity recieved.

A decimal value.

ShipperNumber Id

Generic identifier type with open qualifyingAgency.

Task Task

Document.xsd schema

Document extends: Noun
Structure:
Elements:
Name Type Description
Header reference
Line reference

DocumentHeader
Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Is a description of the document.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentDateTime DateTime

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

DocumentIds reference

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

DocumentReferences reference
LastModificationDateTime DateTime

Is the date and time the document was last modified. This is not the date and time that the BOD message was sent.

Note Note

Is Note for the document in which it is contained.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

Status reference

DocumentLine
Structure:
Elements:
Name Type Description
LineNumber LineNumber

Is the Line Number of the given Line Coponent within the document. LineNumbers are assigned by the sending system.

Identifies the instance of a Line within a given document.

DocumentOrderHeader restricts: DocumentHeader
Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Is a description of the document.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentDateTime DateTime

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

DocumentIds reference

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

DocumentReferences reference
LastModificationDateTime DateTime

Is the date and time the document was last modified. This is not the date and time that the BOD message was sent.

Note Note

Is Note for the document in which it is contained.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.