ListMaintenanceOrder schema, example, validation rules, validation stylesheet

ListMaintenanceOrder type: ListMaintenanceOrder

The purpose of the ListMaintenanceOrder is to publish one or more summary listings of Maintenance Order information to other business application component. This may be in response to a GetListMaintenanceOrder request or to proactively publish a listing of summary Maintenance Order information for a business event. When a receiving application receives this BOD, the information can be used as is or it may be used to initiate a selection of a specific Maintenance Order through the GetMaintenanceOrder request. The processing is designed to provide multiple occurrences of summary data.

ListMaintenanceOrder extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea ListMaintenanceOrderDataArea

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

ListMaintenanceOrderDataArea extends: DataArea
Structure:
Elements:
Name Type Description
List reference
MaintenanceOrder reference

ListMaintenanceOrder Scenario Diagram

List schema

List type: List

The purpose of the LIST verb is to enable a business software component to respond to a GETLIST request or to proactively send a listing of summary information containing many instances of occurrences of data for a noun to one or more other business software components.The results of a LIST may then be used as is, or they may be used to select a specific instance of a document or entity in order to issue a detail GET request.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the LIST decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the LIST verb is quite straight forward with a few exceptions. The LIST response to any GETLIST request needs to read the request carefully to ensure the response is returning the requested Data Types. The LIST needs to ensure the response to the GETLIST does not exceed the maxItems value.The LIST needs to find the specific Field Identifiers that are used for the Field-Based Selection or Range-Based Selection and process them accordingly. The attributes associated with the LIST BODs are as follows: o rsstart attribute is a number that idicates the starting record for the section of the resulting set returned in the list message. This value should always match the rsstart value in the originating GetList BOD. o rscount attribute is a number that indicates the number of records returned in the message. The subsequent request for additional records should have a rsstart value of rscount + 1. o rstotal attribute is a number that indicates the total number of records in the result set. o rscomplete attribute is a Boolean that indicates that the list provided exhaust the possible values. o rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests.

List extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
rsComplete xs:boolean optional
rsCount xs:positiveInteger optional
rsRef xs:string optional
rsStart xs:positiveInteger optional
rsTotal xs:positiveInteger optional

MaintenanceOrder schema

MaintenanceOrder type: MaintenanceOrder

A Maintenance Order is an order for a machine, building, tooling or fixed asset to be repaired or for preventitive maintenance to be performed.

Header type: MaintenanceOrderHeader

Information that generally describes the maintenance order

MaintenanceOperation type: MaintenanceOperation

Inspector type: Someone

Is the person that inspected the wotk performed by the MaintenanceOrder Operation.

Measurement type: MeasurementType

Indicates the measurement and when it was taken.

FailureNote type: FailureNote

Information on failure, cause or remedy. This Component could be very complex depending on the level of detailed failure analysis required. That is, this Component itself could be a hierarchical document in itself. Failure class identifies unique categories of failures. Within a category, failure types determine levels of failure analysis. Failure type provides the hierarchical structure of the failure analysis. In the simplest form, failures are reported only at one level, e.g., just failures. Causes and/or remedies could be reported against a failure in a multi-level hierarchical reporting. For example, failure analysis could be recorded as follows; for failure A, causes P and Q are the factors and remedies X, Y and Z are to be taken. The information here is more for failure analysis reporting. This may occur at the maintenance order header or at the operation level.

Requestor type: Someone

Is the person that requested the MaintenanceOrder.

Is the person that requested the MaintenanceOrder.

Supervisor type: Employee

Is the person supervising/managing the maintenance work being performed/requested.

FailureNote
Structure:
Elements:
Name Type Description
Classification Classification

Is a further classification of failures beyond type.

Description Description

A free-form description of the failure.

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

Id Id

Is the unique identifier of the Failure Note.

Generic identifier type with open qualifyingAgency.

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.

Type Type

Indicates different types of Failures.

UserArea reference

MaintenanceOperation
Structure:
Elements:
Name Type Description
ActualWorkTime Duration

Is the total time spent working on the MaintenanceOrder. Is all of the sum of all the occurances of the ActualTimePeriod.

Attachments reference
CompletionDateTime DateTime

Is the timestamp that indicates when the MaintenanceOrder was completed.

Description Description

Free-form description of the operation.

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

Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

EstimatedWorkTime Time

Is an estimate as to how long it will take to complete the MaintenanceOrder.

FailureNote reference
Hazard reference
Inspector reference
Measurement reference
OperationId Id

Is the operation identifier.

Generic identifier type with open qualifyingAgency.

RemainingWorkTime Duration

Time needed to complete the MaintenanceOrder.

Requestor Someone

Is the person that requested the MaintenanceOrder.

Resources reference

AW: In the future xs:All would be very helpful; still unbounded works here

AW: not using Subs group with Resource so names can be local

Status reference
UserArea reference

MaintenanceOrder extends: Noun
Structure:
Elements:
Name Type Description
Header reference
MaintenanceOperation reference

MaintenanceOrderHeader
Structure:
Elements:
Name Type Description
ActualAmount Amount

Is the ActualAmount of the MaintenanceOrder.

Simple content with the currency as an attrbute

ActualPeriod TimePeriod

Is the TimePeriod in which the work was actually done. There maybe multiple occurances of this compound if part of the work was completed and the remainder performed at another time. This may happen when a part needs to be ordered.

ActualWorkTime Duration

Is the total time spent working on the MaintenanceOrder. Is all of the sum of all the occurances of the ActualTimePeriod.

Attachments reference
BudgetedAmount Amount

Is the monatary amount budgeted for the MaintenanceOrder.

Simple content with the currency as an attrbute

CalendarId Id

Identifies the maintenance calendar used when scheduling this maintenance order

Generic identifier type with open qualifyingAgency.

ChangeDateTime DateTime

Timestamp in which the maintenance order was changed.

Description Description

Description of the mainternance order.

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

Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

DocumentDateTime DateTime

Is the timestamp of when the Maintenance order was created in the integrated system.

DocumentId PartyGenericIdType
DocumentReferences reference
EstimatedAmount Amount

Is the EstimatedAmouint of the MaintenanceOrder.

Simple content with the currency as an attrbute

EstimatedWorkTime Time

Is an estimate as to how long it will take to complete the MaintenanceOrder.

FailureDateTime DateTime

Indicates the timestamp when the machine failed or broke down such that it was no longer useable.

FailureNote reference
Hazard reference
JobPlanId Id

Is a identifier that describes the specific type of job sequence being performed/requested.

Generic identifier type with open qualifyingAgency.

Machine reference

Indicates the status of the machine.

ParentMaintenanceOrderId PartyGenericIdType

Indicates the maintenance order that proceeded this order or from which this maintenance order originated after further investigation or work was performed.

PlannedPeriod TimePeriod

Indicates the Planned TimePeriod in which the maintenance order is planned to be performed.

Planner Employee

Indicates who planner of the Maintenance Order.

PreventitiveMaintenanceId Id

Describes the specific type of preventive maintenance sequence being performed/requested.

Generic identifier type with open qualifyingAgency.

Priority Priority

Identifies the priority of the MaintenanceOrder

RemainingWorkTime Duration

Time needed to complete the MaintenanceOrder.

ReportedDateTime DateTime

Identifies when the work to be done in this work order was reported

Requestor reference
Resources reference

AW: In the future xs:All would be very helpful; still unbounded works here

AW: not using Subs group with Resource so names can be local

RespondByDateTime DateTime

Indicates the date by which a response is expected for this maintenance order

ResponsePeriod TimePeriod

Indicates the Time Period in which a response can be expected for the MaintenanceOrder. When the MaintenanceOrder is initially created the Start response date should be the DocumentDateTime. Subsequent updates may cause this to be modified.

ScheduledPeriod TimePeriod

Is the TimePeriod in which the work is Scheduled to be performed.

Site reference
SplitOperationsInd Indicator

Indicates whether an operation in a maintenance order have to be performed all at once or can be split into non-contiguous work segments.

Indicates if the semantic name is needed or not.

Status reference
Supervisor reference

MeasurementType
Structure:
Elements:
Name Type Description
RecordedDateTime DateTime

Is the timestamp in which the measurement was recorded.

UserArea reference
ValueQuantity Quantity

Is the measurement value of the maintenance operation.

A decimal value.

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