Business To Manufacturing

Markup Language
Batch Production Record
Version 6.0 - March 2013
BatchML - Batch Production Record

MESA • 107 S. Southgate Drive • Chandler, AZ 85226 USA • 480-893-6110 • [email protected] • www.mesa.org
 BatchML-V0600-BatchProductionRecord.docx

IMPORTANT: While the information, data, and standards provided in this publication were developed and are presented
in good faith in accordance with a reasonable process that was subject to intellectual property and antitrust policies to
benefit the industry as a whole, the publication is provided “as is” for information and guidance only, and there is no
representation or warranty of any type or kind, including but not limited to warranties of merchantability or fitness for a
particular purpose, and no warranty that use of the information, data, or standards will not infringe patent, copyright,
trademark, trade secret, or other intellectual property rights of any party.

Copyright © 2013 MESA International

All Rights Reserved. http://www.mesa.org
This MESA Work (including specifications, documents, software, and related items) referred to as the
Business To Manufacturing Markup Language (B2MML) is provided by the copyright holders under the
following license.
Permission to use, copy, modify, or redistribute this Work and its documentation, with or without
modification, for any purpose and without fee or royalty is hereby granted provided MESA
International is acknowledged as the originator of this Work using the following statement:
"The Business To Manufacturing Markup Language (B2MML) is used courtesy of MESA International."
In no event shall MESA International, its members, or any third party be liable for any costs, expenses,
losses, damages or injuries incurred by use of the Work or as a result of this agreement.

Material from ANSI/ISA-88 and ANSI/ISA-95 series of standards used with permission of ISA - The Instrumentation,
Systems, and Automation Society, www.isa.org

Copyright © MESA 2013, All rights reserved. Page 1

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Table of Contents

CHANGE HISTORY .............................................................................. 3

1 SCHEMA SCOPE ........................................................................... 4
1.1 Referenced Schemas ................................................................. 4
1.2 Key Use Assumptions ................................................................ 4
1.3 Key Information Assumptions .................................................... 4
1.4 Common Data Types ................................................................. 4
1.5 Core Components ...................................................................... 4
2 SCHEMA ORGANIZATION ............................................................. 5
2.1 BatchProductionRecord Element ............................................... 5
2.2 Type Names .............................................................................. 5
2.3 User Element Extensibility ......................................................... 5
3 BATCH PRODUCTION RECORD MODELS ........................................ 6
3.1 Batch production record ............................................................ 6
3.2 Records with references to other records ................................... 8
3.3 Event model .............................................................................. 8
3.4 Sample model ........................................................................... 9
3.5 Data set model .......................................................................... 9
3.6 Master recipe, control recipes, and recipe procedure elements 10
3.7 Operations elements ............................................................... 10
3.8 Production elements ............................................................... 11
3.9 Work elements ........................................................................ 11
4 ELEMENT DEFINITIONS............................................................... 12
4.1 Transactions ............................................................................ 12
4.2 BatchProductionRecordEntryType Group ................................. 13
4.3 Batch Production Record Element ............................................ 15
4.4 Data Elements ......................................................................... 24
5 DIAGRAM CONVENTION ............................................................ 37

Copyright © MESA 2013, All rights reserved. 2

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

CHANGE HISTORY
Change Date Person Description
V0500 Mar 2011 Dennis Brandl Initial version
Includes elements from ANSI/ISA 95.02-
2010 for Operations Performance,
Operations Schedule, Operations
Definitions, and Physical Asset resources
V0600 Aug 2012 Dennis Brandl Change to MESA copyright

Copyright © MESA 2013, All rights reserved. Page

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

1 SCHEMA SCOPE
This document provides explanatory information about the referenced MESA XML schemas used to exchange
information about batch production records, called the Batch Markup Language, or BatchML.

This information is based on the data models and attributes defined in the ANSI/ISA 88.00.04 Batch Production Record
Information. Contact ISA (The Instrumentation, Systems, and Automation Society) for copies of the standard. Additional
information on the standard is available at www.isa.org.

1.1 Referenced Schemas

This document provides addresses the contents of the following MESA XML schema:

BatchML-V0600-BatchProductionRecord.xsd

1.2 Key Use Assumptions

The schemas define exchanged information and do not define the use of the information or encapsulation of the
information in any defining transactions. These schemas are intended to be used to create XML documents used to
exchange batch data as well as serve as the basis for corporate, system or application specific schemas that may be
derived from the BatchML schemas.

1.3 Key Information Assumptions

The schemas define simple and complex types and elements for recipe, equipment and batch list data commonly found
in batch applications. A set of data models is presented for recipes, equipment and batch lists. Each model also
illustrates the equivalent top-level XML elements that correspond to top-level objects identified in the ANSI/ISA-88
standard. The details of the schema element and attribute definitions are contained in later sections of this document.

1.4 Common Data Types

The BatchML BatchInformation schema used the B2MML Common schema to pick up common data types.
See the documentation for the Common Types in the file:

B2MML-V0600-Common.doc

1.5 Core Components

The BatchML BatchInformation schema used the B2MML Core Component schemas.
The base types for most elements are derived from core component types that are compatible with the UN/CEFACT core
component types. The UN/CEFACT core component types are a common set of types that define specific terms with
semantic meaning (e.g. the meaning of a quantity, currency, amount, identifier …). The UN/CEFACT core components
were defined in a Core Components Technical Specification (CCTS) developed by the ebXML project now organized by
UN/CEFACT and ISO TC 154.
The core components are defined in the schema file:

B2MML-V0600-CoreComponents.xsd

Copyright © MESA 2013, All rights reserved. 4

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

2 SCHEMA ORGANIZATION

2.1 BatchProductionRecord Element

The BatchML root element is BatchProductionRecord.

2.2 Type Names

The XML schema uses a model that defines simple and complex data types for each element. The data types all follow
the convention of a suffix of “Type” added to the element name.

Schema definition:

<xsd:element name = "ApprovalDate" type = "ApprovalDateType ==

<xsd:simpleType name="ApprovalDateType">
<xsd:restriction base="xsd:dateTime">
</xsd:restriction>
</xsd:simpleType>

2.3 User Element Extensibility

In order to make the schemas more useful, they include the ability for elements to be extended. The extended elements
are not defined in this standard and should not be considered understandable between applications without prior
agreement.

See the definition of user extensions in:

B2MML-V0600-Extensions.doc

Copyright © MESA 2013, All rights reserved. Page 5

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

3 BATCH PRODUCTION RECORD MODELS

The exchanged information is derived from the UML models below.
NOTE: This version has used the ANSI/ISA 95.02-2010 definition for the ISA 95 data elements. The data definitions in
ANSI/ISA 88.04 have been extended to include the following:

1. Addition of the OperationsDefinition schema definition.

2. Addition of the OperationsPerformance schema definition.
3. Addition of the OperationsSchedule schema definition.
4. Addition of PhysicalAssetIDs where ever EquipmentIDs are defined.
5. Addition of ResourceUse and ResourceType elements in a ResourceQualificationManifest to match the ISA 95
resource use and resource type definitions.
6. Addition of ANSI/ISA 95 Part 4 Work Masters, Work Directives, Work Schedule, and Work Response models

3.1 Batch production record

A batch production records is made up of multiple sub-records acting as container objects. These are represented as
XML elements. Each sub-record is a collection of similarly typed individual records.
A Batch Production Record may also contain another Batch Production Record.
Figure 1 is the UML model derived from ANSI/ISA-88.04 and ANSI/ISA95.02-2010. Each of the sub-record container
elements contains a collection of zero or more individual records. These are modeled in BatchML as XML elements
within the sub-record elements.
All of the individual records are specialized types derived from a Batch Production Record Entry abstract type. This is
modeled in BatchML using the “group” BatchProductionRecordEntryType element that is included as the initial element
in each of the individual records.

Copyright © MESA 2013, All rights reserved. 6

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

0..1 0..n
Events Event

0..1 0..n
Data Sets Data Set Batch Production
Batch
Production Record Entry
Record {abstract}
Is a collection of 0..1 0..n
Comments Comment

0..1 0..n
Change
Change
History

0..1 0..n Personnel

Personnel
Identification
Identification
Manifest

0..1 0..n
Samples Sample

0..1 0..n Resource

Resource
Qualification
Qualifications
Manifest

0..1 0..n
Master Master
Recipes Recipe

0..1 0..n
Recipe Recipe
Elements Element

0..1 0..n
Control Control
Recipes Recipe
Defined in BatchML Batch Information schema
0..1 0..n Defined in B2MML Schemas
Production Production
Performances Performance
Added in BatchML Batch Production Record schema
0..1 0..n
Production Production
Schedules Schedule

0..1 0..n
Product Product
Definitions Definition

0..1 0..n
Operations Operation
Performances Performance

0..1 0..n
Operation Operation
Schedules Schedule

0..1 0..n
Operation Operation
Definitions Definition

0..1 Work 0..n Work

Directives Directives

0..1 Work 0..n Work

Masters Masters

0..1 Work 0..n Work

Performances Performance

0..1 Work 0..n Work

Schedules Schedule

Figure 1 - Batch production record structure

Copyright © MESA 2013, All rights reserved. Page 7

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

3.2 Records with references to other records

The following four individual records may reference another records; comments, personnel identification manifest,
qualification manifest, and change history. These are modeled in UML as in Figure 2. These are modeled as a
RecordReference element, which is defined as a Core Component IdentifierType. This should contain the EntryID value
of the referenced value. Figure 2 is the UML model from ANSI/ISA-88.04.

Example 1: The EntryID contains an XPath specification string that identifies the element in the XML record.
Example 2: The EntryID contains a unique number that for each element.

Personnel Resource
Comment Change Identification Qualification
Manifest Manifest

references an other >

1..1
references an other > 1..1
references an other > Batch Production
1..1 Record Entry
references an other > 0..1 {abstract}

Figure 2 - Record with references to other records

3.3 Event model

An event is a discrete occurrence in time. There are different types of event objects and each event is identified by an
event type and subtype. Some event objects may be associated with other events, these are modeled as a
RecordReference element, which is defined as a Core Component IdentifierType. This should contain an XPath
specification string that identifies the element in the XML record.

Events contain user defined records, may contain alarm event information and a set of event associations. User defined
attributes are also derived from the Batch Production Record Entry type. Figure 3 is the UML model from ANSI/ISA-
88.04.

Copyright © MESA 2013, All rights reserved. 8

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

1 Associated with
Event

0..n 0..n

User Defined Event

Alarm Event
Attribute Association

Batch Production
Record Entry
{abstract}

Figure 3 - Event model

3.4 Sample model

Samples contain Sample Tests, and Sample Tests contain Sample Test Results. Sample Tests and Sample Test Results are
also derived from the Batch Production Record Entry type. Figure 4 is the UML model from ANSI/ISA-88.04.

Sample
0..n
Batch Production
Record Entry
{abstract} 0..n

Sample Test

0..n

Sample Test
Result

Figure 4 - Sample model

3.5 Data set model

Data sets are used to represent multivariable data sets or time based data sets. The sets contain ordered data sets.
Figure 5 is the UML model from ANSI/ISA-88.04. The ordered data set is modeled using a “choice” element as either:
1. A Delimited data block in which the data sets are recorded in a single delimited string, with the delimiting
characters defined in the DelimitedDataBlockType.
2. As a set of OrderedDataType elements. Each OrderedDataType contains an optional time element and a set of
data elements.

Copyright © MESA 2013, All rights reserved. Page 9

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Data Set

Contained an ordered collection of

0..1 1..n 1..n

Time Tag
Ordered data
Specification Specification

Contained an ordered collection of

1..1 1..n

Time Value Data Value

Figure 5 - Data sets

3.6 Master recipe, control recipes, and recipe procedure elements

The master recipe, control recipe, and recipe procedure elements are defined in ANSI/ISA-88.01 standard. The Batch
Production Record schema uses the element definitions defined in:

BatchML-V0600-BatchInformation.doc

The Batch Production Record schema uses the schema definitions from the BatchML file:

BatchML-V0600-BatchInformation.xsd

3.7 Operations elements

The production request, production response, and product definition elements are defined in the ANSI/ISA-95.02
standard. The Batch Production Record schema uses the element definitions defined in:

B2MML-V0600-OperationsDefinition.doc
B2MML-V0600-OperationsPerformance.doc
B2MML-V0600-OperationsSchedule.doc

The Batch Production Record schema uses the schema definitions from the B2MML files:

B2MML-V0600-OperationsDefinition.xsd
B2MML-V0600-OperationsPerformance.xsd
B2MML-V0600-OperationsSchedule.xsd

Copyright © MESA 2013, All rights reserved. 10

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

3.8 Production elements

The production request, production response, and product definition elements are defined in the ANSI/ISA-95.02
standard. The Batch Production Record schema uses the element definitions defined in:

B2MML-V0600-ProductDefinition.doc
B2MML-V0600-ProductionPerformance.doc
B2MML-V0600-ProductionSchedule.doc

The Batch Production Record schema uses the schema definitions from the B2MML files:

B2MML-V0600-ProductDefinition.xsd
B2MML-V0600-ProductionPerformance.xsd
B2MML-V0600-ProductionSchedule.xsd

3.9 Work elements

The production request, production response, and product definition elements are defined in the ANSI/ISA-95.04
standard. The Batch Production Record schema uses the element definitions defined in:

B2MML-V0600-WorkDefinition.doc
B2MML-V0600-WorkPerformance.doc
B2MML-V0600-WorkSchedule.doc

The Batch Production Record schema uses the schema definitions from the B2MML files:

B2MML-V0600-WorkDefinition.xsd
B2MML-V0600-WorkPerformance.xsd
B2MML-V0600-WorkSchedule.xsd

Copyright © MESA 2013, All rights reserved. Page 11

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

4 ELEMENT DEFINITIONS
The term BatchProductionRecord is shorted to BPR in the descriptions.

4.1 Transactions
The ANSI/ISA88-04 standard does not define transactions for Batch Production Records. BatchML defines a set of
standard transactions based on the ISA-95.05 Business to Manufacturing Transaction standards. See ANSI/ISA95.05 or
IEC 62264-5 for further details on transactions.

The following top level elements for transactions are defined:

Transaction Element Description

GetBatchProductionRecord Defines a message used to implement a GET action on a BPR.
• BPR ID specified: Defines a request that the receiver is to return, in a
SHOW message, all attributes and contained elements of the BPR that
matches the ID for the specified equipment scope.
• Wildcard BPR ID specified: Defines a request that the receiver is to
return, in a SHOW message, all attributes and contained elements of all
BPRs that match the ID wildcard for the specified equipment scope.
• No BPR ID Specified: Apply the additional constraints.
• One or more of the following constraints may apply:
o CreationDate specified: Defines a request that the receiver is
to return, in a SHOW message, BPRs with the specified
creation date for the specified equipment scope.
o BatchProductionRecordSpec specified: Defines a request
that the receiver is to return, in a SHOW message, BPRs
created with the BatchProductionRecordSpec for the specified
equipment scope.
o BatchID specified: Defines a request that the receiver is to
return, in a SHOW message, BPRs with the specified BatchID
for the specified equipment scope.
o CampaignID specified: Defines a request that the receiver is
to return, in a SHOW message, BPRs with the specified
CampaignID for the specified equipment scope.
o ExpirationDate specified: Defines a request that the receiver
is to return, in a SHOW message, BPRs with the specified
ExpirationDate for the specified equipment scope.
o LastChangedDate specified: Defines a request that the
receiver is to return, in a SHOW message, BPRs with the
specified LastChangedDate for the specified equipment scope.
o LotID specified: Defines a request that the receiver is to
return, in a SHOW message, BPRs with the specified LotID for
the specified equipment scope.
o MaterialDefinitionID specified: Defines a request that the
receiver is to return, in a SHOW message, BPRs with the
specified MaterialDefinitionID for the specified equipment
scope.
o RecordStatus specified: Defines a request that the receiver is
to return, in a SHOW message, BPRs with the specified
RecordStatus for the specified equipment scope.
o Version specified: Defines a request that the receiver is to
return, in a SHOW message, BPRs with the specified Version

Copyright © MESA 2013, All rights reserved. 12

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

for the specified equipment scope.

ShowBatchProductionRecord Response from a GetBatchProductionRecord transaction.

ProcessBatchProductionRecord Defines a request that the receiver is to add a new BPR. Any assigned IDs in
the BPR are returned in the AcknowledgeBatchProductionRecord
message.
AcknowledgeBatchProductionRecord Response to a ProcessBatchProductionRecord transaction.

ChangeBatchProductionRecord Defines a request to change information in a BPR, replacing the existing

information with the information in the transaction message.
RespondBatchProductionRecord Response to the ChangeBatchProductionRecord transaction.

CancelBatchProductionRecord Defines a request to cancel a BPR.

SyncBatchProductionRecord Defines a received message that may contain a new, changed, or deleted
BPR.

4.2 BatchProductionRecordEntryType Group

BatchProductuionRecordEntryType is a group definition that is included in most of the other BatchProductionRecord
elements.
EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

Description

0..∞

Figure 6 - Batch Production Record Entry Type - Group Definition

Element/Type Description
Entry ID A unique identification of the BPR individual element. This element is mandatory.
IdentifierType
ObjectType Identifies the type of object an entry is based upon. This element is mandatory.
RecordObjectTypeType This may be either a standard type or an application specific extended type. Standard
enumerations correspond to the BPR element types and are:
• Batch Production Record
• Change
• Comment
• Control Recipe
• Data Set
• Event
• Master Recipe
• Operations Definition
• Operations Performance
• Operations Schedule

Copyright © MESA 2013, All rights reserved. Page 13

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

• Product Definition
• Production Performance
• Production Schedule
• Personnel Identification Manifest
• Resource Definition Manifest
• Recipe Element
• Sample
• Sample Test
• Sample Test Result
• Work Directive
• Work Master
• Work Performance
• Work Schedule
• Other
If “Other” then the type is an application specific extension and the value is defined in
the attribute “OtherValue”.
TimeStamp The optional time stamp associated with the entry.
DateTimeType
ExternalReference Contains an optional reference to data which is stored external to the BPR.
IdentifierType
Description Additional optional additional information about the BPR.
DescriptionType

Copyright © MESA 2013, All rights reserved. 14

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

4.3 Batch Production Record Element

A top level element is a BatchProductionRecord element or type BatchProductionRecordType.
BatchProductionRecordType

ID

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

Description

0..∞

Equipm entScope

PublishedDate

CreationDate

BatchID

BatchProductionRecordSpec

Cam paignID

ChangeIndication

Delim iter

Equipm entID

ExpirationDate

Language

LastChangedDate

LotID

MaterialDefinitionID

PhysicalAssetID

RecordStatus

BatchProductionRecord
Version

ChangeHistory

Com ments

ControlRecipes

DataSets

Events

MasterRecipes

PersonnelIdentification

OperationsDefinitions

OperationsPerform ances

OperationsSchedules

ProductDefinitions

ProductionPerform ances

ProductionSchedules

RecipeElem ents

ResourceQualifications

Sam ples

WorkDirectives

WorkMasters

WorkPerform ances

WorkSchedules

BatchProductionRecord

Extended:BatchProductionRecord

Figure 7 - Batch Production Record Type

Copyright © MESA 2013, All rights reserved. Page 15

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
ID A unique identification of the BPR. This element is mandatory.
IdentifierType
ObjectType Identifies the type of object an entry is based upon.
RecordObjectTypeType
TimeStamp The time stamp associated with the entry.
DateTimeType
ExternalReference Contains a reference to data which is stored external to the BPR.
IdentifierType
Description Additional information about the BPR.
DescriptionType
EquipmentScope The equipment hierarchy scope of the data associated with BPR.
IdentifierType This information represents the physical structure of the BPR to identify its context
within the plant physical hierarchy
PublishedDate The date the BPR was published.
DateTimeType
CreationDate The date the BPR was created.
DateTimeType
BatchID The list of IDs of the batches associated with the BPR.
IdentifierType
BatchProductionRecordSpec An optional identification of the Batch Production Record Specification that was
used to generate the BPR. The format for this specification is not defined.
IdentifierType
CampaignID An optional identification of the campaign associated with the BPR.
IdentifierType
ChangeIndicator An optional indication enabling detection that the batch production record has not
been altered.
xsd:string
• Example 1: A string generated by an MD5 algorithm used as a hashing
algorithm.
• Example 2: A string representing a digital key of the entire batch production
record.
• Example 3: A string representing a checksum of the entire batch production
record.
Delimiter Delimiter character used to separate equipment elements in the EquipmentID and
PhysicalAssetID elements. Example: “\”
TextType
EquipmentID A definition of the equipment associated with the BPR.
IdentifierType
ExpirationDate The Date and time at which the batch production record is no longer relevant.
DateTimeType
Language The overall language used in the BPR. Note that and DescriptionType or
TextType have an optional Language attribute.
CodeType
Language codes should be specified using the ISO 639: 1988 specification.

Copyright © MESA 2013, All rights reserved. 16

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
LastChangedDate The date the BPR was last changed.
DateTimeType
LotID The list of IDs of the lots associated with the BPR.
IdentifierType
MaterialDefinitionID The list of IDs of the Material Definitions associated with the BPR.
IdentifierType
PhysicalAssetID A definition of the physical asset associated with the BPR.
IdentifierType
RecordStatus Specifies the current status of the BPR, reflecting the current position in the BPRs
life cycle. There are no standard codes defined.
CodeType
Example: In Process, In Review, Approved.
Version The current version of the BPR.
IdentifierType
ChangeHistory Container type for Change elements.
ChangeHistoryType ChangeHistoryType Change

0..∞

Comments Container type for Comment elements.

CommentsType Com m entsType Com m ent

0..∞

Com m entType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

Description

0..∞
Com m ent
RecordReference
0..∞

Com m entText

1..∞

PersonID

Copyright © MESA 2013, All rights reserved. Page 17

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
ControlRecipes Container type for Control Recipe elements.
ControlRecipeType See BatchML-V0600-BatchInformation for a specification of the ControlRecipe
element type.
ControlRecipesType ControlRecipeRecord

0..∞

ControlRecipeRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

ControlRecipeRecord
Description
0..∞
0..∞

ControlRecipe

DataSets Container type for DataSet elements.

DataSetsType DataSetsType DataSet

0..∞

DataSetType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

Description

0..∞

TrendSystem Reference

StartTim e
DataSet

0..∞ EndTim e

Tim eSpecification

TagSpecification

1..∞

Delim itedDataBlock

OrderedData

1..∞

Events Container type for Event elements.

EventsTypes EventsType Event

0..∞

Copyright © MESA 2013, All rights reserved. 18

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
MasterRecipes Container type for MasterRecipe elements.
MasterRecipesType See BatchML-V0600-BatchInformation for a specification of the MasterRecipe
element type.

MasterRecipesType MasterRecipeRecord

0..∞

MasterRecipeRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

MasterRecipeRecord
Description
0..∞
0..∞

MasterRecipe

PersonnelIdentification Container type for PersonnelIdentificationManifest elements.

PersonnelIdentificationType PersonnelIdentificationType PersonnelIdentificationManifest

0..∞

OperationsDefinitions Container type for OperationsDefinition elements.

OperationsDefinitionsType See B2MML-V0600-OperationsDefinition for a specification of the
OperationsDefinition element type.
OperationsDefinitionsType OperationsDefinitionRecord

0..∞

OperationsDefinitionRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

OperationsDefinitionRecord
Description
0..∞
0..∞

OperationsDefinition

Copyright © MESA 2013, All rights reserved. Page 19

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
OperationsPerformances Container type for OperationsPerformance elements.
OperationsPerformancesType See B2MML-V0600-OperationsPerformance for a specification of the
OperationsPerformance element type.
OperationsPerform ancesType OperationsPerform anceRecord

0..∞

OperationsPerform anceRecordType

EntryID

ObjectType

BatchProductionRecordEntryType TimeStam p

ExternalReference

OperationsPerform anceRecord
Description
0..∞
0..∞

ProductionPerform aance

OperationsSchedules Container type for OperationsSchedule elements.

OperationsSchedulesType See B2MML-V0600-OperationsSchedule for a specification of the
OperationsSchedule element type.
OperationsSchedulesType OperationsScheduleRecord

0..∞

OperationsScheduleRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

OperationsScheduleRecord
Description
0..∞
0..∞

OperationsSchedule

ProductDefinitions Container type for ProductDefinition elements.

ProductDefinitionsType See B2MML-V0600-ProductDefinition for a specification of the ProductDefinition
element type.
ProductDefinitionsType ProductDefinitionRecord

0..∞

ProductDefinitionRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

ProductDefinitionRecord
Description
0..∞
0..∞

ProductDefinition

Copyright © MESA 2013, All rights reserved. 20

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
ProductionPerformances Container type for ProductionPerformance elements.
ProductionPerformancesType See B2MML-V0600-ProductionPerformance for a specification of the
ProductionPerformance element type.
ProductionPerform ancesType ProductionPerform anceRecord

0..∞

ProductionPe rform anceRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim e Stam p

ExternalRefere nce

ProductionPe rform anceRe cord

Description
0..∞
0..∞

ProductionPerform aance

ProductionSchedules Container type for ProductionSchedule elements.

ProductionSchedulesType See B2MML-V0600-ProductionSchedulee for a specification of the
ProductionSchedule element type.
ProductionSchedulesType ProductionScheduleRecord

0..∞

ProductionScheduleRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

ProductionScheduleRecord
Description
0..∞
0..∞

ProductionSchedule

RecipeElements Container type for RecipeElement elements.

RecipeElementsType See BatchML-V0600-BatchInformation for a specification of the RecipeElement
element type.
RecipeElem entsType RecipeElem entRecord

0..∞

RecipeElem entRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

RecipeElem entRecord
Description
0..∞
0..∞

RecipeElem entType

Copyright © MESA 2013, All rights reserved. Page 21

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
ResourceQualifications Container type for ResourceQualificationManifest elements.
ResourceQualificationsType ResourceQualificationsType ResourceQualificationsManifest

0..∞

Samples Container type for Sample elements.

SamplesTypes Sam plesType Sam ple

0..∞

BatchProductionRecord Contained BPR.

BatchProductionRecordType
WorkMaster Container type for Work Master elements
WorkMasterRecordType WorkMastersType WorkMasterRecord

0..∞

WorkMasterRecordType

EntryID

ObjectType

BatchProductionRecordEntryType TimeStamp

ExternalReference

WorkMasterRecord
Description
0..∞
0..∞

WorkMaster

WorkDirective Container type for Work Directive elements

WorkDirectiveRecordType WorkDirectivesType WorkDirectiverRecord

0..∞

WorkDirectiveRecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

WorkDirectiverRecord
Description
0..∞
0..∞

WorkDirective

Copyright © MESA 2013, All rights reserved. 22

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
WorkSchedule Container type for Work Schedule elements
WorkSchedulerrRecordType WorkSchedulesType WorkScheduleRecord

0..∞

WorkScheduleRecordType

EntryID

ObjectType

BatchProductionRecordEntryType TimeStamp

ExternalReference

WorkScheduleRecord
Description
0..∞
0..∞

WorkSchedule

WorkPerformance Container type for Work Performance elements

WorkPerformanceRecordType WorkPerform ancesType WorkPerform anceRecord

0..∞

WorkPerform ance RecordType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

WorkPerform anceRecord
De scription
0..∞
0..∞

WorkPerform aance

Copyright © MESA 2013, All rights reserved. Page 23

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

4.4 Data Elements

Element/Type Description
AlarmData Defines additional alarm data for an event that is an alarm event.
AlarmDataType AlarmEvent (CodeType): Defines the type of alarm event. Standard identifiers
are not defined. Examples: Detected, Acknowledged, and Cleared.
AlarmType (CodeType): Defines the type of alarm. Standard identifiers are not
defined. Examples: High, Deviation, Rate of Change.
AlarmLimit (ValueType): Defines the value measurement that caused the
alarm event.
Priority (IdentifierType):Defines the importance of the event. Standard
identifiers are not defined. Examples: High, Low, 10, 9,8, 0 …
Alarm Event

Alarm Type

Alarm DataType
Alarm Lim it

0..∞

Priority

0..∞

Change A specification of a change to a BPR element. Each Change element contains:

ChangeType RecordReference (IdentifierType): The EntryID of a specific element in the
BPR.
PreChangeData (ValueType): A definition of the value of a data element prior
to change of the data element.
Reason (TextType): A text comment with the reason for the change.
ChangeType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStamp

ExternalReference

Description

0..∞
Change
RecordReference
0..∞

PrechangeData

1..∞

Reason

0..∞

Copyright © MESA 2013, All rights reserved. 24

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
Comment A comment related to a BPR element. Each Comment element contains:
CommentType RecordReference (IdentifierType): The EntryID of a specific element in the
BPR.
CommentText (TextType): The text comment.
PersonID (NameType): Defines the person associated with the comment.
CommentType

EntryID

ObjectType

BatchProductionRecordEntryType TimeStam p

ExternalReference

Description

0..∞
Comment
RecordReference
0..∞

CommentText

1..∞

PersonID

Copyright © MESA 2013, All rights reserved. Page 25

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
DataSet A data set defines arrays of related data values that can be used to represent
DataSetType time series or correlated data values.
Each DataSet element contains:
TrendSystemReference (IdentifierType): Specifies the location of the data set
if is stored on an external system.
StartTime (DateTimeType): Date and time of the start of data in the data set.
EndTime (DateTimeType): Date and time of the end of data in the data set.
TimeSpecification (TimeSpecificationType): Defines the attributes of the time
specification of the data.
TagSpecification (TagSpecificationType):
DelimitedDataBlock (DelimitedDataBlockType):
OrderedData (OrderedDataType):
DataSetType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStamp

ExternalReference

Description

0..∞

TrendSystemReference

StartTim e
DataSet

0..∞ EndTime

TimeSpecification

TagSpecification

1..∞

Delim itedDataBlock

OrderedData

1..∞

DataValue Defines the value for a data element in a data set.

DataValueType TagIndex (NumericType):Defines a numeric index value the Tag element.
NOTE: This is required because the order of repeating elements is not
guaranteed in XML.
Value (xsd:string): Defines the value of the data for a tag for a data set.
Quality (IdentifierType): Defines the quality of the value. This indicates the lack
or presence of problems associated with the collection of the data. There are
no standard identifiers defined. Example: Good, Uncertain, Out of Date.
TagIndex

Value
DataValueType
1..∞

Quality

Copyright © MESA 2013, All rights reserved. 26

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
DelimitedDataBlock Defines a data set in a single delimited string element. The string contains a set
DelimitedDataBlockType of substrings, delimited by the OrderDelimiter, and tag elements in the substring
delimited by the TagDelimiter. The selection of the TagDelimiter and
OrderDelimiter will be dependent on the data collected. The delimiter
characters cannot be part of the data.
Note: This data representation is not directly defined in ANSI/ISA 88.04, but is
provided to have a more compact form of data representation.
TagDelimiter (): Defines the character used to delimit the tag elements within
an Order substring. Example: “\”.
OrderDelimiter (): Defines the character used to delimit the order substrings.
Example “|”.
DelimitedData (): Defines the delimited string with tag elements. Example:
“09:10:21\23.4\57\76.2|09:10:25\23.3\57\76.1|09:10:27\23.2\57\76.0””
Empty tag data values are indicated by no spaces between TagDelimiters.
TagDelim iter

Delim itedDataBlockType OrderDelim iter

Delim itedData

Event Describes an event. The event contains an EventType, EventSubType,,and

SingleEventType value. The associated meaning of the event type, subtype, value, and previous
value are specified in ANSI/ISA 88.04 and IEC 61512-4.
Other elements include:
EquipmentID (IdentifierType): Defines the equipment associated with the
event.
MessageText (TextType): Defines text associated with the event.
PersonID (NameType): Defines an identification of the person associated with
the event.
ComputerID (IdentifierType): Defines the computer or automation system
associated with the event.
PhysicalAssetID (IdentifierType): Defines the physical asset associated with
the event.
ProceduralElementReference (IdentifierType): Defines a reference to a
procedural element associated with the event, such as a phase or an operation
in a control recipe.
Category (IdentifierType): Defines the use category of the event. No standard
identifiers are defined. Example; Informational, Critical.
AlarmData (AlarmDataType): Defines additional alarm data if the event is an
alarm type.
AssociatedEventID (IdentifierType): Defines the EntryID of any associated
event.
UserAttribute (UserAttributeType):Defines additional user defined attributes
associated with the event.

Copyright © MESA 2013, All rights reserved. Page 27

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
SingleEventType

EntryID

ObjectType

BatchProductionRecordEntryType Tim eStamp

ExternalReference

Description

0..∞

EventType

EventSubType

Equipm entID

0..∞

Value

0..∞

PreviousValue

0..∞

MessageText

0..∞
Event
PersonID
0..∞
0..∞

Com puterID

0..∞

PhysicalAssetID

0..∞

ProceduralElementReference

0..∞

Category

0..∞

Alarm Data

0..∞

AssociatedEventID

0..∞

UserAttribute

0..∞

Copyright © MESA 2013, All rights reserved. 28

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
EventSubType Defines an event subtype. The associated meaning of the event type, subtype,
EventSubTypeType value, and previous value are specified in ANSI/ISA 88.04 and IEC 61512-4.
This may be either a standard type or an application specific extended type.
Standard enumerations correspond to the BPR element types and are:
• Allocation
• Application
• Consume
• Deallocation
• Equipment
• Message
• Mode Change
• Mode Command
• Modification
• Movement
• Parameter Data
• Process
• Process Data
• Produce
• Prompt
• Prompt Response
• Property Value Change
• Reconciliation
• Security
• State Change
• State Command
• Status Change
• System
• Target End Time
• Target Start Time
• Other
If “Other” then the type is an application specific extension and the value is
defined in the attribute “OtherValue”.
EventType Defines an event type. The associated meaning of the event type, subtype,
EventTypeType value, and previous value are specified in ANSI/ISA 88.04 and IEC 61512-4.
This may be either a standard type or an application specific extended type.
Standard enumerations correspond to the BPR element types and are:
• Alarm
• Control Recipe
• Equipment
• General
• Material
• Message
• Operator
• Procedural Execution
• Other
If “Other” then the type is an application specific extension and the value is
defined in the attribute “OtherValue”.

Copyright © MESA 2013, All rights reserved. Page 29

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
OrderedData Defines a set of ordered data values.
OrderedDataType OrderIndex (NumericType): Defines a numeric index value the OrderedData
element if there is not TimeValue defined. NOTE: This is required because the
order of repeating elements is not guaranteed in XML.
TimeValue (DateTimeType): Defines the date and time of the OrderedData
element if it is time base.
DataValue (DataValueType): Defines the value of the data,
OrderIndex

OrderedDataType Tim eValue

DataValue

1..∞

PersonnelIdentificationManifest Defines the identification of a person associated with a BPR element.

RecordReference (IdentifierType): Defines the EntryID of a record in the BPR
that the personnel identification manifest is associated with, for example a
Change element.
Name (NameType): Defines the name of the person.
ChangeIndication (xsd:string): An indication enabling detection that the
PersonnelIdentificationManifest element has not been altered. Example: string
generated by an MD5 hash algorithm of the name, record reference, and
reason.
Reason (TextType): Defines the reason for the signature.
EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

Description

0..∞

PersonnelIdentificationManifest... RecordReference

Nam e

1..∞

ChangeIndication

Reason

Copyright © MESA 2013, All rights reserved. 30

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
ResourceQualificationManifest Defines the identification of a resource associated with a BPR element.
RecordReference (IdentifierType): Defines the EntryID of a record in the BPR
that the resource qualification manifest is associated with
ResourceID (IdentifierType): Defines the resource associated with the BPR
element.
QualificationStatus (CodeType): Defines the criteria of the resource that was
recorded. No standard codes are defined. Examples: Sterilized, Cleaned,
Services.
EffectiveTimeStamp (DateTimeType): Defines the date and time the
qualification became effective
ExpirationTimeStamp (DateTimeType): Defines the date and time the
qualification expired.
EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

Description

0..∞

RecordReference

ResourceID
ResourceQualificationsManifest...

ResourceUse

ResourceType

QualificationStatus

EffectiveTim eStam p

ExpirationTim eStam p

Sample Defines that a material was sampled and/or tested and results of the test
SampleType SampleSourceID (IdentifierType): Defines the lot, batch, or sample that the
sample material was pulled from.
SampleSize (QuantityValueType): Defines the amount of material taken for the
sample.
SampleType (CodeType): Defines the type of sample pulled. There are no
standard codes defined. Examples: Receiving Sample, Online Sample, Lab
Sample,
SamplePullReason (TextType): Defines the reason the sample was pulled.
SampleExpiration (DateTimeType): Defines the date the sample expires.
EquipmentID (IdentifierType): Defines a reference to an equipment element
that is associated with the sample. Example: The Unit the sample was pulled
from.
PhysicalAssetID (IdentifierType): Defines a reference to a physical asset
element that is associated with the sample.
ProceduralElementReference (IdentifierType): Defines a reference to
procedural element, such as the phase in a control recipe, which is associated
with the sample.
SOPReference (IdentifierType): Defines the standard operating procedure
(SOP) that is associated with the sample pull.
SampleTest (SampleTestType): Defines the tests on the sample.

Copyright © MESA 2013, All rights reserved. Page 31

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
EntryID

ObjectType

BatchProductionRecordEntryType Tim eStamp

ExternalReference

Description

0..∞

Sam pleSourceID

Sam pleSize

0..∞

Sam pleType

0..∞

Sam plePullReason
SampleType 0..∞

Sam pleExpiration

Equipm entID

0..∞

PhysicalAssetID

0..∞

ProceduralElementReference

0..∞

SOPReference

0..∞

Sam pleTest

0..∞

SampleTest Defines information on a test of a sample.

SampleTestType TestCode (CodeType): defines the test procedure used. Example: CHR3390
TestName (IdentifierType): Defines the name associated with the test
performed. Example: Bio Burden
SampleTestResult (SampleTestResultType):
EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

Description

SampleTestType 0..∞

TestCode

TestNam e

Sam pleTestResult

0..∞

Copyright © MESA 2013, All rights reserved. 32

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
SampleTestResult Defines the result from a sample test.
SampleTestResultType TestDisposition (IdentifierType):Defines an indication if the test results were
acceptable. No standard identifiers defined. Example: Pass, Fail
EquipmentID (IdentifierType): Defines the equipment used to perform the
tests.
PhysicalAssetID (IdentifierType): Defines the physical asset used to perform
the tests.
AnalysisUsed (CodeType): Defines the statistical sampling analysis used to
determine the result. No standard CodeType is defined. Example: Average,
Minimum, Maximum
Expiration (DateTimeType): Defines the date and time that the sample test
results expire.
Results (ValueType): Defines the actual value or values returned from the test.
ExpectedResults (ValueType): Defines the expected value or values returned
from the test.
EntryID

ObjectType

BatchProductionRecordEntryType Tim eStam p

ExternalReference

Description

0..∞

TestDisposition

Equipm entID

0..∞

Sam pleTestResultType
PhysicalAssetID

0..∞

AnalysisUsed

0..∞

Expiration

Results

0..∞

ExpectedResults

0..∞

TagSpecification Defines a unique identification of a data source. It contains the information to

TagSpecificationType identify a single data source (called a tag) and any data required to interpret the
data values, such as data compression information required to use the data.
TagIndex (NumericType): An internal number that is used to identify the
specific data value in a dataset. (Because the order of repeating elements in
XML is not guaranteed, this number is used to tie the data value to the tag
specification,)
DataType (DataTypeType): From the common elements, defines the data type
of the data. (Example: long, unsignedInt, float,…)
UnitOfmeasure (UnitOfMeasureType): From the Common elements, defines
the unit of measure as a CodeType.
DataSource (IdentifierType): Defines the data source for the data element,
typically the tag name or equivalent.
Alias (IdentifierType): Defines an alternate ID of the data source of the data
element.
Description (DescriptionType): Defines additional information about the data
source or the alias identification.
EquipmentID (IdentifierType): Defines a reference to equipment, This

Copyright © MESA 2013, All rights reserved. Page 33

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
information represents the physical structure above the referenced entity to
identify its context within the plant physical hierarchy.
PhysicalAssetID (IdentifierType): Defines a reference to a physical asset.
ProceduralElementReference (IdentifierType): Reference to the procedural
element, such as procedure, unit procedure, operation, recipe phase,
equipment phase, or equipment step associated with the data source ID for the
time period of the trend segment.
Deadband (ValueType): A deadband value used for collecting and storing data
values. If different high and low deadbands are specified, then they should be
separate values with keys of HIGH and LOW.
SignificantDigits (IdentifierType): Defines the significant digits used for
collecting and storing data. This is kept as an identifier type to allow
specification or formats for different data types,, such as F2.4 or F7.1 for
floating point information and I5 or I8 for integer information.
DataCompression (IdentifierType): An identification of the data compression
algorithm used when the data was collected. There are no standard identifiers
defined. Example; Boxcar Backslope, Change Delta, None.
SamplingType (IdentifierType): The type of sample stored. There are no
standard identifiers define. Example: Actual/Raw, Interpolated, Best Fit.

Copyright © MESA 2013, All rights reserved. 34

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

Element/Type Description
TagIndex

DataType

UnitOfMeasure

DataSource

0..∞

Alias

0..∞

Description

0..∞

Equipm entID

0..∞
TagSpecificationType

PhysicalAssetID

0..∞

ProceduralElem entReference

0..∞

Deadband

0..∞

SignificantDigits

0..∞

DataCom pression

0..∞

Sam plingType

0..∞

Copyright © MESA 2013, All rights reserved. Page 35

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

Element/Type Description
TimeSpecification Defines the attributes of the time specification of the data.
TimeSpecificationType Relative (IndicatorType): If TRUE then the date/time is relative time, if FALSE
then the date/time is absolute time.
OffsetTime (DateTimeType): If the time is relative, then the offset defines the
absolute time that may be added to the relative times to determine the absolute
times.
Relative
Tim eSpecificationType
OffsetTim e
.

DateTim eType

attributes
OffsetTim e
form at

UserAttribute Defines user defined attributes and values for events.

UserAttributeType
UserAttributeType

AttributeID

Description
UserAttribute
0..∞
0..∞
Value

0..∞

Copyright © MESA 2013, All rights reserved. 36

Revision 1, Saved March 16, 2013 at 14:03
 BatchML-V0600-BatchProductionRecord.docx

5 DIAGRAM CONVENTION
The schema diagrams using the following convention to illustrate the structure of the schema elements, the type of the
elements and attributes, and the rules for optional elements and repetition.

Name of an element

Indicates fixed order of elements

Indicates elements

Indicates 1 instance only

Indicates 1 to many instances

Indicates 0 or 1 instance only

Indicates 0 to many instances

Indicates selection of alternatives

Indicates contained elements

Indicates no contained elements

Copyright © MESA 2013, All rights reserved. Page 37

Revision 1, Saved March 16, 2013 at 14:03
 Batch Production Record

About MESA: MESA promotes the exchange of best practices, strategies and innovation
in managing manufacturing operations and in achieving operations excellence. MESA’s
industry events, symposiums, and publications help manufacturers achieve
manufacturing leadership by deploying practical solutions that combine information,
business, manufacturing and supply chain processes and technologies. Visit us online at
http://www.mesa.org.
About the XML Committee: The XML Committe was formed within MESA to provide a
forum for the development of the B2MML and BatchML specifications.

Copyright © MESA 2013, All rights reserved. 38

Revision 1, Saved March 16, 2013 at 14:03