Recommended Reading:
MaintenanceOrderHeader
Information that generally describes the maintenance order
See http://www.openapplications.org/oagis/9.
Element information
Namespace: http://www.openapplications.org/oagis/9
Schema document: org_openapplications_oagis/9_4_1/Developer/Nouns/MaintenanceOrder.xsd
Type: MaintenanceOrderHeaderType
Properties: Global, Qualified
Content
- Sequence
[1..1]
- Sequence
[0..1]
- DocumentID [0..1] Is the primary document id for the document associated.
- AlternateDocumentID [0..*] Is the alternate document id for the associated document.
- LastModificationDateTime [0..1] The datetime on which the object was last modified
- DocumentDateTime [0..1] The date that document was created within the system of record.
- Sequence
[0..1]
- Description [0..*]
- Note [0..*]
- Sequence
[0..1]
- DocumentReference [0..*]
- Attachment [0..*] The Attachment represents binary data files that may be included within a BOD. These files replace the paper specifications and drawings attached to a BOD definition to clearly communicate design requirements. This Data Type is optional. Attachment usage is further defined by its position.
- PriorityCode [0..1] Identifies the priority of the MaintenanceOrder
- ParentMaintenanceOrderID [0..*] Indicates the maintenance order that proceeded this order or from which this maintenance order originated after further investigation or work was performed.
- ReportedDateTime [0..1] Identifies when the work to be done in this work order was reported
- RespondByDateTime [0..1] Indicates the date by which a response is expected for this maintenance order
- ChangeDateTime [0..*] Timestamp in which the maintenance order was changed.
- FailureDateTime [0..1] Indicates the timestamp when the machine failed or broke down such that it was no longer useable.
- PlannedTimePeriod [0..1] Indicates the Planned TimePeriod in which the maintenance order is planned to be performed.
- ScheduledTimePeriod [0..1] Is the TimePeriod in which the work is Scheduled to be performed.
- ActualTimePeriod [0..1] 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.
- BudgetedAmount [0..1] Is the monetary amount budgeted for the MaintenanceOrder.
- EstimatedAmount [0..1] Is the EstimatedAmount of the MaintenanceOrder.
- ActualAmount [0..1] Is the ActualAmount of the MaintenanceOrder.
- EstimatedDuration [0..1] Is an estimate as to how long it will take to complete the MaintenanceOrder.
- ActualDuration [0..1] Is the total time spent working on the MaintenanceOrder. Is all of the sum of all the occurances of the ActualTimePeriod.
- RemainingDuration [0..1] Time needed to complete the MaintenanceOrder.
- Machine [0..1] Indicates the status of the machine.
- Facility [0..1] A Facility identifies a location within an entity. The facility may have sub-locators identified using a sequenced identification notation e.g. Warehouse A100 Sub-Location 11, Row R10 would be represented as an array of three Facility elements with values as A100, 11, R10, name attribute as Warehouse, Sub-Location and Row and sequence attribute as 1,2 and 3 respectively.
- JobPlanID [0..1] Is a identifier that describes the specific type of job sequence being performed/requested.
- PreventiveMaintenanceID [0..1] Describes the specific type of preventive maintenance sequence being performed/requested.
- CalendarID [0..1] Identifies the maintenance calendar used when scheduling this maintenance order
- SplitOperationsIndicator [0..1] Indicates whether an operation in a maintenance order have to be performed all at once or can be split into non-contiguous work segments.
- PlannerID [0..1] Indicates the planner of the Maintenance Order.
- SupervisorID [0..1] Is the person supervising/managing the maintenance work being performed/requested.
- RequesterID [0..1]
- ProjectReference [0..1] Identifies a project that is associated with the given component.
- Distribution [0..*] The accounting distribution information associated with a Business Object Document. The position of the Distribution within a Business Object Document provides the context and additional meaning.
- EstimatedResourceRequirements [0..1] This identifies resources that are required to perform the maintenance operation. Resource Requirements can be specified for the entire maintenance order or for each operation within the order
- ActualResources [0..1] This identifies the actual usage of resources against the requirements estimated for the work order
- Safety [0..1] Identifies the safety related information associated with a machine, location or any other entity, or with performing an activity on any of the above entities
- Failure [0..1] Information on the problem, possible symptoms that may lead to the problem, and the cause and remedy for the problem. 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.
- UserArea [0..1] Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The USERAREA is always the last element in all components, except where the component has been extended inline.
from type HeaderTypefrom group DocumentIDsGroupfrom group FreeFormTextGroupfrom group ReferencesGroup - Sequence
[0..1]
Attributes
None
Used in
- Type MaintenanceOrderType (Element MaintenanceOrder)
Sample instance
<MaintenanceOrderHeader> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <LastModificationDateTime>2000-01-01</LastModificationDateTime> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <DocumentReference> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <LineNumber>normalizedString</LineNumber> <ItemIDs> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> </ItemIDs> <Facility> <IDs>... </IDs> <Name>string</Name> <Description>string</Description> <Note>string</Note> <Address>... </Address> <Coordinate>... </Coordinate> <UserArea> <!--any element--> </UserArea> </Facility> <SerializedLot> <ItemQuantity>1.0</ItemQuantity> <Lot>... </Lot> <Disposition>... </Disposition> <SerialNumber>normalizedString</SerialNumber> <ParentSerialNumber>normalizedString</ParentSerialNumber> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </SerializedLot> <SalesOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </SalesOrderReference> <PurchaseOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </PurchaseOrderReference> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <IssuingParty> <PartyIDs>... </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location>... </Location> <Contact>... </Contact> <UserArea> <!--any element--> </UserArea> </IssuingParty> <OperationReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <UserArea> <!--any element--> </UserArea> </OperationReference> <ReleaseNumber>normalizedString</ReleaseNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <ShipUnitReference> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <UserArea> <!--any element--> </UserArea> </ShipUnitReference> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </EffectiveTimePeriod> <Item> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <ServiceIndicator>true</ServiceIndicator> <Description>string</Description> <Note>string</Note> <Classification>... </Classification> <Specification>... </Specification> <HazardousMaterial>... </HazardousMaterial> <Packaging>... </Packaging> <CountryOfOriginCode>normalizedString</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumber>normalizedString</SerialNumber> <Lot>... </Lot> <UserArea> <!--any element--> </UserArea> </Item> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <Quantity>1.0</Quantity> <UserArea> <!--any element--> </UserArea> </DocumentReference> <Attachment> <EmbeddedData mimeCode="normalizedString">GpM7</EmbeddedData> <URI>http://www.example.com/</URI> <ISBN>normalizedString</ISBN> <FileName>string</FileName> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <FileType>normalizedString</FileType> <FileSizeQuantity>1.0</FileSizeQuantity> <Title>string</Title> <UserArea> <!--any element--> </UserArea> </Attachment> <PriorityCode>normalizedString</PriorityCode> <ParentMaintenanceOrderID>normalizedString</ParentMaintenanceOrderID> <ReportedDateTime>2000-01-01</ReportedDateTime> <RespondByDateTime>2000-01-01</RespondByDateTime> <ChangeDateTime>2000-01-01</ChangeDateTime> <FailureDateTime>2000-01-01</FailureDateTime> <PlannedTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </PlannedTimePeriod> <ScheduledTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </ScheduledTimePeriod> <ActualTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </ActualTimePeriod> <BudgetedAmount currencyID="AED">1.0</BudgetedAmount> <EstimatedAmount currencyID="AED">1.0</EstimatedAmount> <ActualAmount currencyID="AED">1.0</ActualAmount> <EstimatedDuration>P1Y2M3DT10H</EstimatedDuration> <ActualDuration>P1Y2M3DT10H</ActualDuration> <RemainingDuration>P1Y2M3DT10H</RemainingDuration> <Machine> <ID>normalizedString</ID> <Description>string</Description> <Note>string</Note> <Property> <NameValue name="normalizedString">string</NameValue> <Description>string</Description> <Note>string</Note> <EffectiveTimePeriod>... </EffectiveTimePeriod> <UserArea> <!--any element--> </UserArea> </Property> <Classification> <Codes> </Codes> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </Classification> <MachineID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </MachineID> <SerialNumber>normalizedString</SerialNumber> <FixedAssetCode>normalizedString</FixedAssetCode> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <UserArea> <!--any element--> </UserArea> </Machine> <Facility> <IDs> <ID>normalizedString</ID> </IDs> <Name>string</Name> <Description>string</Description> <Note>string</Note> <Address> <ID>normalizedString</ID> <FormatCode>normalizedString</FormatCode> <AttentionOfName>string</AttentionOfName> <CareOfName>string</CareOfName> <AddressLine>string</AddressLine> <CitySubDivisionName>string</CitySubDivisionName> <CityName>string</CityName> <CountrySubDivisionCode>normalizedString</CountrySubDivisionCode> <CountryCode>normalizedString</CountryCode> <PostalCode>normalizedString</PostalCode> <Status>... </Status> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </Address> <Coordinate> <Latitude>... </Latitude> <Longitude>... </Longitude> <AltitudeMeasure unitCode="normalizedString">1.0</AltitudeMeasure> <UserArea> <!--any element--> </UserArea> </Coordinate> <UserArea> <!--any element--> </UserArea> </Facility> <JobPlanID>normalizedString</JobPlanID> <PreventiveMaintenanceID>normalizedString</PreventiveMaintenanceID> <CalendarID>normalizedString</CalendarID> <SplitOperationsIndicator>true</SplitOperationsIndicator> <PlannerID>normalizedString</PlannerID> <SupervisorID>normalizedString</SupervisorID> <RequesterID>normalizedString</RequesterID> <ProjectReference> <ID>normalizedString</ID> <ResourceCodes> <Code>normalizedString</Code> </ResourceCodes> <Description>string</Description> <Amount currencyID="AED">1.0</Amount> <Location> <ID>normalizedString</ID> <Name>string</Name> <Directions>string</Directions> <Coordinate>... </Coordinate> <Address>... </Address> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </Location> <TimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </TimePeriod> <ActivityID>normalizedString</ActivityID> <UserArea> <!--any element--> </UserArea> </ProjectReference> <Distribution> <LedgerID>normalizedString</LedgerID> <DocumentReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <LineNumber>normalizedString</LineNumber> <ItemIDs>... </ItemIDs> <Facility>... </Facility> <SerializedLot>... </SerializedLot> <SalesOrderReference>... </SalesOrderReference> <PurchaseOrderReference>... </PurchaseOrderReference> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <IssuingParty>... </IssuingParty> <OperationReference>... </OperationReference> <ReleaseNumber>normalizedString</ReleaseNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <ShipUnitReference>... </ShipUnitReference> <EffectiveTimePeriod>... </EffectiveTimePeriod> <Item>... </Item> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <Quantity>1.0</Quantity> <UserArea> <!--any element--> </UserArea> </DocumentReference> <Attachment> <EmbeddedData mimeCode="normalizedString">GpM7</EmbeddedData> <URI>http://www.example.com/</URI> <ISBN>normalizedString</ISBN> <FileName>string</FileName> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <FileType>normalizedString</FileType> <FileSizeQuantity>1.0</FileSizeQuantity> <Title>string</Title> <UserArea> <!--any element--> </UserArea> </Attachment> <Percentage>1.0</Percentage> <Quantity>1.0</Quantity> <Amount currencyID="AED">1.0</Amount> <GLNominalAccount>normalizedString</GLNominalAccount> <GLElement> <Element>string</Element> </GLElement> <EnterpriseUnit> <CostCenterID>normalizedString</CostCenterID> <ProfitCenterID>normalizedString</ProfitCenterID> <GLEntityID>normalizedString</GLEntityID> <GLElement> </GLElement> <UserArea> <!--any element--> </UserArea> </EnterpriseUnit> <ProjectReference> <ID>normalizedString</ID> <ResourceCodes> </ResourceCodes> <Description>string</Description> <Amount currencyID="AED">1.0</Amount> <Location>... </Location> <TimePeriod>... </TimePeriod> <ActivityID>normalizedString</ActivityID> <UserArea> <!--any element--> </UserArea> </ProjectReference> <UserArea> <!--any element--> </UserArea> </Distribution> <EstimatedResourceRequirements> <Allocation> <Resource>... </Resource> <UnitCost>... </UnitCost> <RequiredQuantity>1.0</RequiredQuantity> <RequiredDuration>P1Y2M3DT10H</RequiredDuration> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </Allocation> <InventoryAllocation> <Item>... </Item> <ItemInstance>... </ItemInstance> <UnitCost>... </UnitCost> <RequiredQuantity>1.0</RequiredQuantity> <RequiredDuration>P1Y2M3DT10H</RequiredDuration> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </InventoryAllocation> <LabourAllocation> <Labour>... </Labour> <UnitCost>... </UnitCost> <RequiredQuantity>1.0</RequiredQuantity> <RequiredDuration>P1Y2M3DT10H</RequiredDuration> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </LabourAllocation> <MachineAllocation> <Machine>... </Machine> <UnitCost>... </UnitCost> <RequiredQuantity>1.0</RequiredQuantity> <RequiredDuration>P1Y2M3DT10H</RequiredDuration> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </MachineAllocation> <OperationAllocation> <OperationReference>... </OperationReference> <UnitCost>... </UnitCost> <RequiredQuantity>1.0</RequiredQuantity> <RequiredDuration>P1Y2M3DT10H</RequiredDuration> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </OperationAllocation> <ToolAllocation> <Tool>... </Tool> <UnitCost>... </UnitCost> <RequiredQuantity>1.0</RequiredQuantity> <RequiredDuration>P1Y2M3DT10H</RequiredDuration> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </ToolAllocation> <UserArea> <!--any element--> </UserArea> </EstimatedResourceRequirements> <ActualResources> <Actual> <Resource>... </Resource> <UnitCost>... </UnitCost> <Quantity>1.0</Quantity> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </Actual> <InventoryActual> <Item>... </Item> <ItemInstance>... </ItemInstance> <UnitCost>... </UnitCost> <Quantity>1.0</Quantity> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </InventoryActual> <LabourActual> <Labour>... </Labour> <UnitCost>... </UnitCost> <Quantity>1.0</Quantity> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <BreakTimeDuration>P1Y2M3DT10H</BreakTimeDuration> <WorkTimePeriod>... </WorkTimePeriod> <UserArea> <!--any element--> </UserArea> </LabourActual> <MachineActual> <Machine>... </Machine> <UnitCost>... </UnitCost> <Quantity>1.0</Quantity> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <DownTimeDuration>P1Y2M3DT10H</DownTimeDuration> <DownTimePeriod>... </DownTimePeriod> <UserArea> <!--any element--> </UserArea> </MachineActual> <OperationActual> <OperationReference>... </OperationReference> <UnitCost>... </UnitCost> <Quantity>1.0</Quantity> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </OperationActual> <ToolActual> <Tool>... </Tool> <UnitCost>... </UnitCost> <Quantity>1.0</Quantity> <TotalCostAmount currencyID="AED">1.0</TotalCostAmount> <Description>string</Description> <Note>string</Note> <DownTimeDuration>P1Y2M3DT10H</DownTimeDuration> <UserArea> <!--any element--> </UserArea> </ToolActual> </ActualResources> <Safety> <Hazard> <ID>normalizedString</ID> <Type>normalizedString</Type> <Description>string</Description> <Note>string</Note> <Precaution>... </Precaution> <UserArea> <!--any element--> </UserArea> </Hazard> </Safety> <Failure> <Problem> <ID>normalizedString</ID> <Type>normalizedString</Type> <Description>string</Description> <Note>string</Note> <Symptom>... </Symptom> <Cause>... </Cause> <Remedy>... </Remedy> <UserArea> <!--any element--> </UserArea> </Problem> </Failure> <UserArea> <!--any element--> </UserArea> </MaintenanceOrderHeader>