BPCMSG Ref Guide RPT

Aspen
™
EnterpriseConnect
BPC Messages
UML Reference Guide
Schema Definition Files
BPCAliasing.xsd
BPCAllocation.xsd
BPCAttributes.xsd
BPCClass.xsd
BPCCommon.xsd
BPCConfiguration.xsd
BPCDynamicData.xsd
BPCEquipment.xsd
BPCGenericObject.xsd
BPCHierarchy.xsd
BPCLocation.xsd
BPCMaterial.xsd
BPCMaterialLots.xsd
BPCPersonnel.xsd
BPCPhysicalProperty.xsd
BPCUnitOfMeasure.xsd
BPCVersion.xsd
Version Number: 2004.1
May 2005
Copyright (c) 1998-2005 by Aspen Technology, Inc. All rights reserved.
EnterpriseConnect, the aspen leaf logo and Plantelligence and Enterprise Optimization are trademarks or registered
trademarks of Aspen Technology, Inc., Cambridge, MA.
All other brand and product names are trademarks or registered trademarks of their respective companies.
This document is intended as a guide to using AspenTech’s software. This documentation contains AspenTech
proprietary and confidential information and may not be disclosed, used, or copied without the prior consent of
AspenTech or as set forth in the applicable license agreement. Users are solely responsible for the proper use of the
software and the application of the results obtained.
Although AspenTech has tested the software and reviewed the documentation, the sole warranty for the software
may be found in the applicable license agreement between AspenTech and the user. ASPENTECH MAKES NO
WARRANTY OR REPRESENTATION, EITHER EXPRESSED OR IMPLIED, WITH RESPECT TO THIS
DOCUMENTATION, ITS QUALITY, PERFORMANCE, MERCHANTABILITY, OR FITNESS FOR A
PARTICULAR PURPOSE.
Aspen Technology, Inc.
Ten Canal Park
Cambridge, MA 02141-2201
USA
Phone: (1) (617) 949-1000
Toll Free: (1) (888) 996-7001
Fax: (1) (617) 949-1030
URL: http://www.aspentech.com
Table of Contents
1. Introduction 8
1.1 Purpose 8
1.2 Scope 8
1.3 Definitions, Acronyms, and Abbreviations 8
1.4 References 8
1.5 Overview 8
1.5.1 Class Descriptions 9
1.6 Revision History 10
2. BPCAliasing.xsd 11
2.1 Alias Configuration Message 11
2.1.1 Diagrams 12
2.1.2 AliasConfiguration 12
2.1.3 AliasConfigurationBody 13
2.1.4 AliasConfigurationDetails 13
2.1.5 AliasConfigurationProperties 14
2.1.6 AliasKey 14
2.1.7 BPCAliasData 15
2.1.8 BPCAliasType 15
2.2 Alias Configuration types 16
2.2.1 Diagrams 16
2.2.2 AliasNameType 16
3. BPCAllocation.xsd 17
3.1 Allocation Configuration Message 17
3.1.1 Diagrams 18
3.1.2 AllocationConfiguration 18
3.1.3 AllocationConfigurationBody 19
3.1.4 AllocationConfigurationDetails 19
3.1.5 AllocationConfigurationProperties 20
3.1.6 AllocationDefinition 20
3.1.7 AllocationDefinitionHistorizedInstance 21
3.1.8 AllocationValue 22
4. BPCAttributes.xsd 24
4.1 Attributes configuration Message 24
4.1.1 Diagrams 25
4.1.2 AttributeConfiguration 27
4.1.3 AttributeConfigurationBody 27
4.1.4 AttributeConfigurationDetails 27
4.1.5 AttributeConfigurationProperties 28
4.1.6 AttributeDefinition 28
4.1.7 AttributeDefinitionHistorizedInstance 29
4.1.8 EnumAttributeDefinition 30
5. BPCClass.xsd 32
5.1 Class Configuration 32
5.1.1 Diagrams 33
5.1.2 ClassAttributeDefinition 35
5.1.3 ClassAttributeDefinitionBase 36
5.1.4 ClassAttributeMapEntry 36
5.1.5 ClassConfiguration 37
5.1.6 ClassConfigurationBody 37
5.1.7 ClassConfigurationDetails 38
5.1.8 ClassConfigurationProperties 38
5.1.9 ClassDefinition 39
5.1.10 ClassDefinitionHistorizedInstance 39
6. BPCCommon.xsd 41
6.1 BPC Common Classes 41
6.1.1 Diagrams 42
6.1.2 AttributeInstance 42
6.1.3 AttributeRefCategory 43
6.1.4 BPCComponentReferenceType 44
6.1.5 BPCHistoricalProperties 44
6.1.6 BPCKey 47
6.1.7 BPCQuantity 47
6.1.8 BPCVersionInformation 48
6.1.9 ClassAttributeInstance 50
6.1.10 ClassRefCategory 52
6.1.11 DefinitionBase 53
6.1.12 DisplayInformation 53
6.1.13 PhysicalPropertyInstance 55
7. BPCConfiguration.xsd 56
7.1 BPC Configuration Message 56
7.1.1 Diagrams 56
7.1.2 BPCConfiguration 58
7.1.3 BPCConfigurationBody 59
7.1.4 BPCConfigurationDetails 59
7.1.5 BPCConfigurationProperties 60
7.1.6 BusinessProcessDefinition 60
7.1.7 BusinessProcessDefinitionHistorizedInstance 61
7.1.8 GlobalDataDefinition 61
7.1.9 GlobalDataDefinitionHistorizedInstance 62
7.1.10 LocaleDefinition 62
7.1.11 LocaleDefinitionHistorizedInstance 63
8. BPCDynamicData.xsd 65
8.1 Dynamic Data Configuration Message 65
8.1.1 Diagrams 66
8.1.2 CommunicationLayer 66
8.1.3 DynamicDataConfiguration 67
8.1.4 DynamicDataConfigurationBody 67
8.1.5 DynamicDataConfigurationDetails 68
8.1.6 DynamicDataConfigurationProperties 68
8.1.7 DynamicDataSourceDefinition 69
8.1.8 DynamicDataSourceDefinitionHistorizedInstance 69
9. BPCEquipment.xsd 71
9.1 BPC Equipment Configuration 71
9.1.1 Diagrams 71
9.1.2 EquipmentConfiguration 73
9.1.3 EquipmentConfigurationBody 73
9.1.4 EquipmentConfigurationDetails 74
9.1.5 EquipmentConfigurationProperties 75
9.1.6 EquipmentDefinition 75
9.1.7 EquipmentDefinitionHistorizedInstance 76
9.1.8 EquipmentTypeDefinition 76
9.1.9 EquipmentTypeDefinitionHistorizedInstance 77
10. BPCGenericObject.xsd 78
10.1 Generic Object Configuration 78
10.1.1 Diagrams 78
10.1.2 GenericObjectConfiguration 80
10.1.3 GenericObjectConfigurationBody 81
10.1.4 GenericObjectConfigurationDetails 81
10.1.5 GenericObjectConfigurationProperties 82
10.1.6 GenericObjectDefinition 82
10.1.7 GenericObjectDefinitionHistorizedInstance 83
10.1.8 GenericObjectTypeDefinition 84
10.1.9 GenericObjectTypeDefinitionHistorizedInstance 84
11. BPCHierarchy.xsd 86
11.1 Hierarchy Configuration Message 86
11.1.1 Diagrams 86
11.1.2 ApplicableBPCType 89
11.1.3 BPCNodeDefinition 89
11.1.4 BPCObjectDefinition 90
11.1.5 HierarchyConfiguration 90
11.1.6 HierarchyConfigurationBody 91
11.1.7 HierarchyConfigurationDetails 91
11.1.8 HierarchyConfigurationProperties 92
11.1.9 HierarchyDefinition 92
11.1.10 HierarchyDefinitionHistorizedInstance 93
11.1.11 HierarchyDefinitionHistorizedInstanceNode 94
11.1.12 HierarchyLevelContentTypes 94
11.1.13 HierarchyLevelDefinition 95
11.1.14 HierarchyLevelDefinitionHistorizedInstance 95
11.1.15 HierarchyLevelHistorizedInstanceHeader 96
11.1.16 HierarchyLevelParentIDs 97
11.1.17 HierarchyNode 97
11.1.18 HierarchyNodeHeader 98
11.1.19 NodeChildren 98
12. BPCLocation.xsd 99
12.1 Location Configuration Message 99
12.1.1 Diagrams 99
12.1.2 LocationConfiguration 101
12.1.3 LocationConfigurationBody 101
12.1.4 LocationConfigurationDetails 102
12.1.5 LocationConfigurationProperties 103
12.1.6 LocationDefinition 103
12.1.7 LocationDefinitionHistorizedInstance 103
12.1.8 LocationTypeDefinition 104
12.1.9 LocationTypeDefinitionHistorizedInstance 105
13. BPCMaterial.xsd 106
13.1 Material Configuration Message 106
13.1.1 Diagrams 106
13.1.2 MaterialConfiguration 108
13.1.3 MaterialConfigurationBody 108
13.1.4 MaterialConfigurationDetails 109
13.1.5 MaterialConfigurationProperties 110
13.1.6 MaterialDefinition 110
13.1.7 MaterialDefinitionHistorizedInstance 111
13.1.8 MaterialTypeDefinition 111
13.1.9 MaterialTypeDefinitionHistorizedInstance 112
14. BPCMaterialLots.xsd 113

14.1 Material Lot Configuration Message 113
14.1.1 Diagrams 113
14.1.2 MaterialLotConfiguration 115
14.1.3 MaterialLotConfigurationBody 116
14.1.4 MaterialLotConfigurationDetails 116
14.1.5 MaterialLotConfigurationProperties 117
14.1.6 MaterialLotDefinition 117
14.1.7 MaterialLotDefinitionHistorizedInstance 118
14.1.8 MaterialSubLotDefinition 119
14.1.9 MaterialSubLotDefinitionHistorizedInstance 119
15. BPCPersonnel.xsd 121

15.1 Personnel Configuration Message 121
15.1.1 Diagrams 121
15.1.2 PersonnelConfiguration 122
15.1.3 PersonnelConfigurationBody 122
15.1.4 PersonnelConfigurationDetails 122
15.1.5 PersonnelConfigurationProperties 123
15.1.6 PersonnelDefinition 123
15.1.7 PersonnelDefinitionHistorizedInstance 124
16. BPCPhysicalProperty.xsd 126

16.1 Physical Property Configuration Message 126
16.1.1 Diagrams 127
16.1.2 EnumPhysicalPropertyDefinition 127
16.1.3 PhysicalPropertyConfiguration 128
16.1.4 PhysicalPropertyConfigurationBody 128
16.1.5 PhysicalPropertyConfigurationDetails 129
16.1.6 PhysicalPropertyConfigurationProperties 129
16.1.7 PhysicalPropertyDefinition 130
16.1.8 PhysicalPropertyDefinitionHistorizedInstance 130
17. BPCUnitOfMeasure.xsd 132

17.1 Unit Of Measure configuration Message 132
17.1.1 Diagrams 133
17.1.2 PseudoQuantityType 133
17.1.3 QuantityType 134
17.1.4 QuantityTypeInSet 135
17.1.5 UnitOfMeasureConfiguration 135
17.1.6 UnitOfMeasureConfigurationBody 136
17.1.7 UnitOfMeasureConfigurationDetails 136
17.1.8 UnitOfMeasureConfigurationProperties 137
17.1.9 UnitOfMeasureDefinition 138
17.1.10 UNStd20UOMNameType 138
17.1.11 UOMDefinitionBase 139
17.1.12 UOMList 139
17.1.13 UOMSet 139
18. BPCVersion.xsd 141

18.1 Version Message 141
18.1.1 Diagrams 142
18.1.2 VersionConfiguration 143
18.1.3 VersionConfigurationBody 143
18.1.4 VersionConfigurationDetails 143
18.1.5 VersionDefinition 144
18.1.6 VersionDefinitionHistorizedInstance 144
1. Introduction
1.1 Purpose
The purpose of this document is to provide a reference document that describes the UML classes that form
the basis for the BPC message schema definitions. These schema definitions support the publication of
configuration information consumed by Client Business Process Components (BPC).
This document should be used by Developers and Services/Support personnel to understand the purpose of
a particular schema, to understand how to fill out a valid payload for a message generated using the schema
definition and to determine the applicability of a given schema to a specific implementation.
In order to promote consistency across Aspentech offerings, it is essential that message schema
development follow the rules and guidelines described in the BPD Modeling Reference and Design
Guidelines.
1.2 Scope
The scope of this release of the document covers the reference descriptions for those schemas that support
the publication of BPC configuration data.
1.3 Definitions, Acronyms, and Abbreviations

Refer to the BPD Glossary.
1.4 References
1) BPD Glossary (BPD Glossary.doc)
2) BPD Modeling Reference and Design Guidelines (BPDMdlDgnGuide.doc)
3) BPD Developers Kit Reference Guide (BPDDevKitRefGuideRpt.doc)
1.5 Overview
The remaining sections of this document describe each message schema definition provided by the
following schema files.
• BPCAliasing.xsd
• BPCAllocation.xsd
• BPCAttributes.xsd
• BPCClass.xsd
• BPCCommon.xsd
• BPCConfiguration.xsd
• BPCDynamicData.xsd
• BPCEquipment.xsd
• BPCGenericObject.xsd
• BPCHierarchy.xsd
• BPCLocation.xsd
• BPCMaterial.xsd
• BPCMaterialLots.xsd
• BPCPersonnel.xsd
• BPCPhysicalProperty.xsd
• BPCUnitOfMeasure.xsd
• BPCVersion.xsd
•
Each subsection for a given schema file will describe a message schema or a set of common classes and
data types used by several of the schema contained within the same schema file namespace.
1.5.1 Class Descriptions

The message structures are described in terms of UML classes. A series of subsections within the
document are devoted to various aspects of the class. In particular, the following documentation should be
provided at the class level: -
DEFINITION:
A definition of the class.
PURPOSE:
A description of the purpose of the class including any special behavior.
COMMENTS:
This section will provide any additional information about the class including references to standards
materials, urls for sites on the Internet that contain relevant information.
ATTRIBUTES & RELATIONS

In addition, a list of attributes is provided for the class. Where re-useable class building blocks have been
used in the creation of these classes, a relation section will describe the relationship and any cardinality
rules for describing the relationship.
1.6 Revision History
The revision history of each schema definition file is summarized in the relevant sections of this document.
Details of the changes at the class level will be described as part of the class definition.
2. BPCAliasing.xsd
This package contains all message definitions associated with the Alias BPC. This namespace contains a
single message, "AliasConfiguration", which is primarily used by the BPC components to supply aliasing
information to the Messaging infrastructure and the BPC Client components.
CHANGE LOG
v2.0.0.4 - Added wild card extensions to all classes to allow for extension of schema definitions in the field
by services.
v1.4.0.0 - Added Copyright Information to the Schema File.
v1.0.0.0 - Initial release
2.1 Alias Configuration Message

The AliasConfiguration message will be used to reload/load(hydrate) BPC aliasing component with data for
aliasing. Once loaded, the aliasing component will be able to make conversions from one alias to another.
2.1.1 Diagrams
2.1.1.1 AliasConfiguration Class Diagram
BPDHeader
AliasConfiguration
(f rom Header Classes)
1
BPCVersionInformation
(f rom BPC Co mmon Cl as ses )
1 BPCNamespace : NamespaceID...
Validation : String
AliasConfigurationBody AliasConfigurationProperties
PublishedDateTime : DateTimeT...
1 1 PublishedBy : HumanIDType
Major : Integer
Minor : Integer
<<optional>> SchemaVersion : S...
1 BPCKey
0..n BPCAliasType
AliasC on figura tionDetails BPCAli asData (f rom BPC Common Classes)
BPCType : Str...
1 0..n 1 ID : CDMIDType
Name : BPCNa meTy...
GUID : GUIDType
AliasKe y
ID : CDMIDType
0..n AliasN am espace : Nam espaceID...
<<Enumeration>> <<DataType>> <<optio nal>> Name : Ali asName...
BPCTypeType AliasNameType
(f rom Common Data Ty pes) (f rom Alias Conf iguration ty pes)
Material : String Bas eDa taType : Stri ng

PhysicalProperty : String Mi nLength : Intege r = 1
Equipment : String MaxLength : Integer = 200
UnitOfMeasure : String
GeographicLocation : String
Hierarchy : String <<Da taType>>
MixedComponents : String BPCNameType
(f rom Common Data Ty pes)
Ba seDataType : Stri ng
Mi nLength : Integ er = 1
MaxLength : In teger = 50
Diagram : Structure for the AliasConfiguration message.
2.1.2 AliasConfiguration
DEFINITION:
Root element of the AliasConfiguration message. The AliasConfiguration message will be used to
reload/load(hydrate) BPC aliasing component with data for aliasing. Once loaded, the aliasing component
will be able to make conversions from one alias to another.
CHANGE LOG:

2.1.2.1 Relations
This section describes the relationships between the class described by this section and other classes in the
BPD Common Messages UML model. NOTE: The other classes listed in the table may be defined in other
Reference Guides
Container Role A Cardinality Role B Cardinality Description/Sequence
BPDHeader AliasConfiguration @xml:sequence 10
(1) ()
AliasConfigurationBod AliasConfiguration @xml:sequence 20
y ()
(1)
2.1.3 AliasConfigurationBody
DEFINITION:
The root element of the body of the message.
PURPOSE:
Segregates the Properties of the message body from the line item details.
CHANGE LOG:
2.1.3.1 Relations
Reference Guides
AliasConfigurationBod AliasConfiguration @xml:sequence 20
y ()
(1)
AliasConfigurationProp AliasConfigurationBody @xml:sequence 10
erties ()
(1)
AliasConfigurationDeta AliasConfigurationBody @xml:sequence 20
ils ()
(1)
2.1.4 AliasConfigurationDetails
DEFINITION:
The root element of the details section of the message.
PURPOSE:
Acts as a container for all of the detailed line items for the message. In this case, the details section contains
alias data.
CHANGE LOG:
2.1.4.1 Relations
Reference Guides
BPCAliasType AliasConfigurationDetails @xml:sequence 20
(0..n) ()
AliasConfigurationDeta AliasConfigurationBody @xml:sequence 20
ils ()
(1)
2.1.5 AliasConfigurationProperties
DEFINITION:
The root element of the properties section of the message.
PURPOSE:
The purpose is to act as a container for the business context information that relates to the message.
CHANGE LOG:
2.1.5.1 Relations
Reference Guides
BPCVersionInformatio AliasConfigurationProper @xml:sequence 10
n ties
(1) ()
AliasConfigurationProp AliasConfigurationBody @xml:sequence 10
erties ()
(1)
2.1.6 AliasKey
DEFINITION:
The alias key corresponding to the BPCType in the same BPCAliasData element
CHANGE LOG:
2.1.6.1 Attributes
Name Type Description
ID CDMIDType The identifier for the alias key.
AliasNamespace NamespaceIDType namespace of the alias key
Name AliasNameType name of the alias key

2.1.6.2 Relations
Reference Guides
AliasKey BPCAliasData @xml:sequence 20
(0..n) ()
2.1.7 BPCAliasData
DEFINITION:
Container element for one instance of a component type
CHANGE LOG:
2.1.7.1 Relations
Reference Guides
BPCKey BPCAliasData @xml:sequence 10
(1) ()
AliasKey BPCAliasData @xml:sequence 20
(0..n) ()
BPCAliasData BPCAliasType
(0..n) (1)
2.1.8 BPCAliasType
DEFINITION:
Identifies the BPC object type for which the aliasing information contained in the message is maintained e.g.
Material.
CHANGE LOG:
2.1.8.1 Attributes
BPCType String The BPC key corresponding to the alias types in the
same BPCAliasData element
2.1.8.2 Relations
Reference Guides
BPCAliasType AliasConfigurationDetails @xml:sequence 20
(0..n) ()
BPCAliasData BPCAliasType
(0..n) (1)
2.2 Alias Configuration types

The Data Types specific to this namespace.
2.2.1 Diagrams
2.2.2 AliasNameType
DEFINITION
This type identifies the type of BPC object that the alias data refers to.
CHANGE LOG
v1.0.0.0 - Initially created DataType class
2.2.2.1 Attributes
BaseDataType String String data type.
MinLength Integer 1
MaxLength Integer 200

3. BPCAllocation.xsd
This package contains all message definitions associated with the Allocation BPC component. This
namespace contains a single message, "AllocationConfiguration", which is primarily used by the BPC
components to supply allocation information to the BPC Client components.
CHANGE LOG
3.1 Allocation Configuration Message

The Allocation Configuration message will be used to reload/load(hydrate) BPC Allocation component with
data for the allocation of resources.
3.1.1 Diagrams
3.1.1.1 Allocation Configuration Message

Key:
All ocationConfiguration BPDHeade r For Deta ils of cla sses mar ked in ye llow, refer to
(f rom He ade r Cl asses ) the BPD Developers Kit Refer ence Guide
1 1
1
For Details of c lass es mar ked in Pale yellow,
r efer to this docum ent
1 BPCVersionInformation
(f rom BPC Co mmon Clas ses)
AllocationConfigurationBody AllocationConfigurationProperties
BPCNamespace : NamespaceIDType
1 1 1 1 0..n Validation : String
PublishedDateTime : DateTimeType
1 PublishedBy : HumanIDType
AllocationConfigurationDetails Major : Integer
Minor : Integer
1 <<optional>> SchemaVersion : String
1
0..n BPCKey
(f rom BPC Common Classes)
AllocationDefinition
CreatedBy : HumanIDType DefinitionBase ID : CDMIDType
CreationDateTime : DateTimeType (from BPC Common Classes) Name : BPCNameType
1 1 GUID : GUIDType
AllocationDefinitionHistorizedInstance BPCHistoricalProperties
1
AllocationValueSlices : Integer (f rom BPC Common Classes)
1..n
1 StartDa teTi me : DateTimeType
EndDateTim e : DateTimeType
1 1
<<optio nal>> La stModi fied By : Human IDType
AllocationValue <<optio nal>> La stModi fied DateTi me : Da teTi meType
ID : CDMIDType <<optio nal>> Ap provedBy : HumanIDType
<<optional>> Description : DescriptionType <<optio nal>> Ap provedDateTim e : DateTim eType
AllocationDefinitionID : CDMIDType <<optio nal>> D escription : D escripti onType
StartDateTime : DateTimeType
EndDateTime : DateTimeType
0..n UsagePercentage : Double DisplayInformation
ExternalKey : String +DisplayNames (f rom BPC Common Classes)
CreatedBy : HumanIDType LocaleID : CDMIDType
CreationDateTime : DateTimeType 0..n
BusinessProcessID : CDMIDType
LastModifiedBy : HumanIDType Name : BPCNameType
LastModifiedDateTime : DateTimeType Description : DescriptionType
AllocationStatusID : CDMIDType
ClassAttributeInstance
+ClassAttributes
BPCQuantity
0..n ClassID : CDMIDType
UniqueID : CDMIDType 1..n
ParentHashCode : Long <<optional>> Val ueStri ng : Stri ng
<<optional>> In dex : Inte ger
DataTyp e : Da taTypeType
<<optional>> Othe rDataType : String
<<optional>> U nitOfMe asure : CDMIDType
<<optional>> Minim umValue : Dou ble
<<optional>> Maximu mValue : Double
Diagram : Structure for the AliasConfiguration message.
3.1.2 AllocationConfiguration
DEFINITION:
Root element of the AllocationConfiguration message. The AllocationConfiguration message will be used to
reload/load(hydrate) BPC allocation component.
CHANGE LOG:

3.1.2.1 Relations
Reference Guides
BPDHeader AllocationConfiguration @xml:sequence 10
(1) (1)
AllocationConfiguratio AllocationConfiguration @xml:sequence 20
nBody (1)
(1)
3.1.3 AllocationConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
3.1.3.1 Relations
Reference Guides
AllocationConfiguratio AllocationConfiguration @xml:sequence 20
nBody (1)
(1)
AllocationConfiguratio AllocationConfigurationB @xml:sequence 10
nProperties ody
(1) (1)
nDetails ody
(1) (1)
3.1.4 AllocationConfigurationDetails
DEFINITION:
PURPOSE:
alias data.
CHANGE LOG:
3.1.4.1 Relations
Reference Guides
nDetails ody
(1) (1)
AllocationDefinition AllocationConfigurationD @xml:sequence 10
(0..n) etails
(1)
AllocationValue AllocationConfigurationD @xml:sequence 20
(0..n) etails
(1)
3.1.5 AllocationConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
3.1.5.1 Relations
Reference Guides
nProperties ody
(1) (1)
BPCVersionInformatio AllocationConfigurationP @xml:sequence 10
n roperties
(0..n) (1)
3.1.6 AllocationDefinition
DEFINITION
This class defines the structure that holds a resource allocation definition.
CHANGE LOG:
3.1.6.1 Attributes
CreatedBy HumanIDType Uniquely identifies the user who created the object
CreationDateTime DateTimeType Data and time when the object was created
3.1.6.2 Relations
Reference Guides
AllocationDefinition AllocationConfigurationD @xml:sequence 10
(0..n) etails
(1)
AllocationDefinitionHi AllocationDefinition @xml:sequence 10
storizedInstance (1)
(1..n)
3.1.7 AllocationDefinitionHistorizedInstance
DEFINITION:
Container element used to separate the historized portion of the message from the remainder of the message.
CHANGE LOG:
3.1.7.1 Attributes
AllocationValueSlices Integer To be defined
3.1.7.2 Relations
Reference Guides
AllocationDefinitionHi AllocationDefinition @xml:sequence 10
storizedInstance (1)
(1..n)
BPCHistoricalPropertie AllocationDefinitionHisto @xml:sequence 10
s rizedInstance
(1) (1)
DisplayNames DisplayInformation AllocationDefinitionHisto @xml:sequence 20
(0..n) rizedInstance
(1)
ClassAttributes AllocationDefinitionHi ClassAttributeInstance @xml:sequence 30
storizedInstance (0..n)
(1)
3.1.8 AllocationValue
DEFINITION
This class defines the structure that holds actual resource allocation information.
CHANGE LOG:
3.1.8.1 Attributes
ID CDMIDType Identification of a specific resource allocation
instance.
Description DescriptionType additional information describing the allocation.
AllocationDefinitionID CDMIDType A reference back to the Allocation Definition with

which this instance data is associated.
StartDateTime DateTimeType Start of the resource allocation period.
EndDateTime DateTimeType End of the resource allocation period.
UsagePercentage Double Percent usage of the resource being allocated for the
defined period.
ExternalKey String can be used by applications to store some meaningful

value with the Allocation Value that can be used for
filtering or selecting the value later. An example
would be a Batch number that the allocation value
was associated with.
CreatedBy HumanIDType User that created the resource allocation.
CreationDateTime DateTimeType timestamp of when resource allocation was made.
LastModifiedBy HumanIDType User that last modified the resource allocation.
LastModifiedDateTime DateTimeType timestamp of when resource allocation was last

modified.
AllocationStatusID CDMIDType Status of the resource allocation.
3.1.8.2 Relations
Reference Guides
AllocationValue AllocationConfigurationD @xml:sequence 20
(0..n) etails
(1)
4. BPCAttributes.xsd
This package contains all message definitions associated with the Attributes BPC. This namespace contains a
single message, "AttributeConfiguration", which is primarily used by the BPC components to supply
attribute definition information to all attributed BPC components e.g. Material, Equipment, Location etc.
CHANGE LOG
v5.0.0.14 - Added ClassAttributeInstance structure.
v5.0.0.14 - Added DisplayNames structure.
by services.
4.1 Attributes configuration Message

The Attribute Configuration contains the definition of all the CDM attributes.
4.1.1 Diagrams
4.1.1.1 AttributeConfigurationClassDiagram
Key:
For Details of classes marked in yellow, refer to
AttributeConfiguration BPDHeader the BPD Developers Kit Reference Guide
1
For Details of classes marked in Pale yellow,
refer to this document
(f rom BP C Co mmon Clas ses)
1 BPCNamespace : NamespaceIDType
Attri buteConfiguration Body AttributeConfigurationProperties Validation : String
1 PublishedDateTime : DateTimeType
1 PublishedBy : HumanIDType
Major : Integer
1 Minor : Integer
Attri buteConfigu ratio nDetail s <<optional>> SchemaVersion : String
BPCKey
0..n ID : CDMIDType
Attri buteDefini tion DefinitionBase
(from BPC Common Classes) Name : BPCNameType
CreatedBy : HumanIDType 1 1 GUID : GUIDType
CreationDateTime : DateTimeType
BPCHistoricalProperties
1..n StartDateTime : DateTimeType

AttributeDefinitionHistorizedInstance EndDateTime : DateTimeType
QuantityTypeID : CDMIDType <<optional>> LastModifiedBy : HumanIDType
1 1 <<optional>> LastModifiedDateTime : DateTimeType
<<optional>> DefaultUOM : CDMIDType
1 <<optional>> ApprovedBy : HumanIDType
<<optional>> ApprovedDateTime : DateTimeType
<<optional>> Description : DescriptionType
1
1
1 DisplayInformation
+DisplayNames (f rom BPC Common Classes)
Local eID : CD MIDType

0..n BusinessProcessID : CDMIDType
Name : BPC NameTyp e
Description : DescriptionType
+Cla ssAttribu tes
BPCQuantity
0..n ClassID : CDMIDType
UniqueID : CDMIDType 1..n
ParentHashCode : Long <<o ptional>> Val ueStri ng : Stri ng
<<o ptional>> In dex : Inte ger
<<o ptional>> Othe rDataType : String
BPCQuantity
<<o ptional>> U nitOfMe asure : CDMIDType
(f rom BPC Common Cla sses)
<<o ptional>> Minim umValue : Dou ble
0..1 <<optional>> ValueString : String <<o ptional>> Maximu mValue : Double
0..1 <<optional>> Index : Integer
EnumAttributeDefinition DataType : DataTypeType
Nomi nalVa lue : string <<optional>> OtherDataType : String
<<optional>> UnitOfMeasure : CDMIDType
<<optional>> MinimumValue : Double
<<optional>> MaximumValue : Double
1..n
EnumerationItem BPCQu anti ty
(f rom Miscellaneous Classes) (f rom BPC Common Classes)
ID : IDType <<optional>> ValueString : String

Text : EnumerationTextType +Attributes <<optional>> Index : Integer
AttributeInstance
DataType : DataTypeType
0..n <<optional>> OtherDataType : String
AttributeID : CDMIDType 1 <<optional>> UnitOfMeasure : CDMIDType
BPCCompo nentReferenceType
+ValueCategory
(from BPC Common Classes)
AttributeRefCategory ItemComponentID : CDMIDType
0..1
(f rom BPC Common Classes) ItemCollectionID : CDMIDType
<<optional>> ClassifierPropertyName : String
<<optional>> ClassifierPropertyValue : String
BPCCompo nentReferenceType
+ApplicableCateg ories AttributeRefCategory (from BPC Common Classes)
(f rom BPC Common Classes) ItemComponentID : CDMIDType

0..n ItemCollectionID : CDMIDType
<<optional>> ClassifierPropertyValue : String
Diagram : structure for the AttributeConfiguration message.

4.1.2 AttributeConfiguration
DEFINITION:
Root element of the AttributeConfiguration message. The Attribute Configuration contains the definition of
all the CDM attributes.
CHANGE LOG:
4.1.2.1 Relations
Reference Guides
BPDHeader AttributeConfiguration @xml:sequence 10
(1) ()
AttributeConfiguration AttributeConfiguration @xml:sequence 20
Body ()
(1)
4.1.3 AttributeConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
4.1.3.1 Relations
Reference Guides
AttributeConfiguration AttributeConfiguration @xml:sequence 20
Body ()
(1)
AttributeConfiguration AttributeConfigurationBo @xml:sequence 10
Properties dy
(1) ()
Details dy
(1) ()
4.1.4 AttributeConfigurationDetails
DEFINITION:
PURPOSE:
alias data.
CHANGE LOG:
4.1.4.1 Relations
Reference Guides
Details dy
(1) ()
AttributeDefinition AttributeConfigurationDe
(0..n) tails
()
4.1.5 AttributeConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
4.1.5.1 Relations
Reference Guides
Properties dy
(1) ()
BPCVersionInformatio AttributeConfigurationPr
n operties
(1) ()
4.1.6 AttributeDefinition
DEFINITION
This class defines the structure that holds an attribute definition. An attribute can be used to describe a
characteristic of a CDM BPC configuration object. An attribute definition defines an attribute for reuse by
other CDM BPC components.
CHANGE LOG:
4.1.6.1 Attributes
CreatedBy HumanIDType User that created the Attribute definition
CreationDateTime DateTimeType Date and time the attribute definition was created.
4.1.6.2 Relations
Reference Guides
AttributeDefinition AttributeConfigurationDe
(0..n) tails
()
AttributeDefinitionHist AttributeDefinition
orizedInstance ()
(1..n)
4.1.7 AttributeDefinitionHistorizedInstance
DEFINITION:
Container element used to separate the historized portion of the message from the remainder of the message.
CHANGE LOG:
4.1.7.1 Attributes
QuantityTypeID CDMIDType Identifier of the quantity type to which the attribute
relates.
DefaultUOM CDMIDType This is the default UOM set by the original attribute
definition. There is a possibility that no UOM will
exist for an attribute, such as Color.
4.1.7.2 Relations
Reference Guides
AttributeDefinitionHist AttributeDefinition
orizedInstance ()
(1..n)
EnumAttributeDefinitio AttributeDefinitionHistori @xml:sequence 40
n zedInstance
(0..1) ()
ValueCategory AttributeRefCategory AttributeDefinitionHistori @xml:sequence 40
(0..1) zedInstance
(1)
ApplicableCategori AttributeRefCategory AttributeDefinitionHistori @xml:sequence 50
es (0..n) zedInstance
(1)
AttributeDefinitionHist BPCHistoricalProperties @xml:sequence 10
orizedInstance (1)
(1)
AttributeDefinitionHist BPCQuantity @xml:sequence 25
orizedInstance (0..1)
()
Attributes AttributeDefinitionHist AttributeInstance @xml:sequence 30
orizedInstance (0..n)
()
ClassAttributes AttributeDefinitionHist ClassAttributeInstance @xml:sequence 20
(1)
DisplayNames DisplayInformation AttributeDefinitionHistori @xml:sequence 15
(0..n) zedInstance
(1)
4.1.8 EnumAttributeDefinition
DEFINITION:
Container element for enumerations.
CHANGE LOG:
4.1.8.1 Attributes
NominalValue string Attribute default value
4.1.8.2 Relations
Reference Guides
EnumAttributeDefinitio AttributeDefinitionHistori @xml:sequence 40
n zedInstance
(0..1) ()
EnumerationItem EnumAttributeDefinition
(1..n) ()
5. BPCClass.xsd
This package contains all message definitions associated with the Class BPC component. This namespace
contains a single message, "ClassConfiguration", which is primarily used by the BPC components to supply
class information to any BPC Client components that contain classed items.
CHANGE LOG
5.1 Class Configuration

The ClassConfiguration message will be used to reload/load(hydrate) BPC class component with data for the
definition of class structures.
5.1.1 Diagrams
5.1.1.1 ClassConfiguration
BPDHeade r
ClassConfiguration
(f rom He ade r Cl asses )
1 1 BPCVersionInformation
1
1 BPCNamespace : NamespaceIDType
ClassConfigurationBody ClassConfigurationProperties Validation : String
1 1 1 1 1 PublishedBy : HumanIDType
Major : Integer
Minor : Integer
ClassConfigurationDetails
1
BPCKey
0..n
DefinitionBase ID : CDMIDType
ClassDefinition
CreatedBy : HumanIDType GUID : GUIDType
1 1
0..n BPCHistoricalProperties
ClassDefinitionHistorizedInstance (f rom BPC Common Classes)
ParentClassID : CDMIDType 1 0..1 StartDateTime : DateTimeType

Required : Boolean EndDateTime : DateTimeType
<<optional>> LastModifiedBy : HumanIDType
<<optional>> LastModifiedDateTime : DateTimeType
<<optional>> ApprovedBy : HumanIDType
1 1 1 <<optional>> ApprovedDateTime : DateTimeType
1 <<optional>> Description : DescriptionType
1
DisplayInformation
+Displ ayNames (f rom BPC Common Classes)
L ocal eID : CD MIDType

0..n
Bu sine ssProcessID : CDMIDType
Name : BPC Name Type
Des cri ption : Descri ptionType
BPCQuantity
Cl assAttri buteInstan ce
+ClassAttributes (f ro m B PC Common Cla sse s) <<optional>> ValueString : String
ClassID : CDMIDType <<optional>> Index : Integer
0..n UniqueID : CDMIDType 1..n DataType : DataTypeType
ParentHashCode : Long <<optional>> OtherDataType : String
Cl assAttrib uteDefi niti on
Uniq ueID : CDMIDType BPCKey
<<optional>> D efaultValue : String
Required : Boo lean ID : CDMIDType
IsArray : Boolean Name : BPCNameType
+ClassAttributeDefinitions ClassAttrib uteDefinitionBase
Data Type : DataType Type GUID : GUIDType
<<optional>> OtherDa taType : String 1 1
0..n
<<optional>> R eferenceClassID : CDMIDType
<<optional>> QuantityType ID : CDMIDTyp e BPCComponentReferenceType
<<optional>> D efaultU ni tOfMeasu reID : C DMIDType (from BPC Common Classes)
ItemComponen tID : CDMIDType
1 ItemColl ectionID : CDMID Type
<<optional>> C la ssifi erPropertyNa me : Stri ng
<<optional>> C la ssifi erPropertyValu e : String
Cl assAttri bute Map Entry

Paren tID : CDMIDType +ValueCategory
Class ID : CDMIDType ClassRefCategory
Class Attri buteID : C DMIDType (f rom BPC Common Classes)
+ClassAttributeMap Embe ddedClassID : CDMIDType 0..1
0..n <<optio nal>> OtherDataType : String
Uniqu eID : CDMIDType
BPCComponentReferenceType
ItemCo mpone ntID : CDMIDType

ItemCo ll ection ID : CDMID Typ e
<<optiona l>> C lassifi erPropertyName : Stri ng
<<optiona l>> C lassifi erPropertyValue : String
+ApplicableCategories
ClassRefCategory
0..n
Diagram : Structure for the ClassConfiguration message.

5.1.2 ClassAttributeDefinition
DEFINITION:
Defines the details of an attribute of a class.
CHANGE LOG:
5.1.2.1 Attributes
UniqueID CDMIDType Unique ID assigned to the Class Attribute definition.
This UniqueID is different than the ID assigned to
the definition itself because if one Class Definition
defines one of its Class Attributes as being an
instance of another Class Definition, the unique ID
used to identify that Class.
DefaultValue String the default value for this attribute.
Required Boolean When applying this attribute, is a value optional or

required.
IsArray Boolean Is the attribute an array of values
DataType DataTypeType The data type of the attribute as defined by

DataTypeType.
OtherDataType String A string defining a custom data type not defined in

the standard enumerated list of DataTypeType. Note
the DataType field will need to be set to Other.
ReferenceClassID CDMIDType The ID of a Class Definition that being used to

define this Class Attribute. All of the Class
Attributes defined on the referenced class
are embedded. (Equivalent to defining a variable to
by based on a structure).
QuantityTypeID CDMIDType Quantity type of the attribute
DefaultUnitOfMeasureID CDMIDType Default unit of measure of the attribute
MinimumValue Double Attribute minimum value
MaximumValue Double Attribute maximum value

5.1.2.2 Relations
Reference Guides
ClassAttributeDefi ClassAttributeDefinitio ClassDefinitionHistorized @xml:sequence 25
nitions n Instance
(0..n) (1)
ValueCategory ClassRefCategory ClassAttributeDefinition @xml:sequence 10
(0..1) (1)
5.1.3 ClassAttributeDefinitionBase
DEFINITION:
Abstract class used to ensure BPCKey is the first set of elements in ClassDefinition.
CHANGE LOG:
5.1.3.1 Relations
Reference Guides
BPCKey ClassAttributeDefinitionB @xml:sequence 10
(1) ase
(1)
5.1.4 ClassAttributeMapEntry
DEFINITION
Because a Class Definition can embed other classes which can embed other classes, a map is created that
represents the expended structure of the resulting class definition with the unique IDs assigned to the Class
Attributes for this Class Definition
CHANGE LOG:
5.1.4.1 Attributes
ParentID CDMIDType ID of the Parent Class this class is derived from (0 =
no parent)
ClassID CDMIDType ID of the Class Definition that this map entry is

associated with
ClassAttributeID CDMIDType ID of the Class Attribute this map entry represents
EmbeddedClassID CDMIDType ID of the Class Definition if this Class Attribute is

based on a Class Definition
DataType DataTypeType DataType of the Class Attribute
OtherDataType String Extended DataType field
UniqueID CDMIDType UniqueID assigned to this Class Attribute for this

Class Definition
5.1.4.2 Relations
Reference Guides
ClassAttributeMap ClassAttributeMapEntr ClassDefinitionHistorized @xml:sequence 30
y Instance
(0..n) (1)
5.1.5 ClassConfiguration
DEFINITION:
Root element of the ClassConfiguration message. The ClassConfiguration message will be used to
reload/load(hydrate) BPC class component.
CHANGE LOG:
5.1.5.1 Relations
Reference Guides
ClassConfigurationBod ClassConfiguration @xml:sequence 20
y (1)
(1)
BPDHeader ClassConfiguration @xml:sequence 10
(1) (1)
5.1.6 ClassConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
5.1.6.1 Relations
Reference Guides
ClassConfigurationBod ClassConfiguration @xml:sequence 20
y (1)
(1)
ClassConfigurationDeta ClassConfigurationBody @xml:sequence 20
ils (1)
(1)
ClassConfigurationProp ClassConfigurationBody @xml:sequence 10
erties (1)
(1)
5.1.7 ClassConfigurationDetails
DEFINITION:
PURPOSE:
alias data.
CHANGE LOG:
5.1.7.1 Relations
Reference Guides
ClassConfigurationDeta ClassConfigurationBody @xml:sequence 20
ils (1)
(1)
ClassDefinition ClassConfigurationDetail @xml:sequence 10
(0..n) s
(1)
5.1.8 ClassConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
5.1.8.1 Relations
Reference Guides
ClassConfigurationProp ClassConfigurationBody @xml:sequence 10
erties (1)
(1)
BPCVersionInformatio ClassConfigurationProper @xml:sequence 10
n ties
(1) (1)
5.1.9 ClassDefinition
DEFINITION:
Encompasses the definition of a class which includes class attribute definitions as well as actual value
instances.
CHANGE LOG:
5.1.9.1 Attributes
5.1.9.2 Relations
Reference Guides
ClassDefinition ClassConfigurationDetail @xml:sequence 10
(0..n) s
(1)
ClassDefinitionHistoriz ClassDefinition @xml:sequence 10
edInstance (1)
(0..n)
5.1.10 ClassDefinitionHistorizedInstance
DEFINITION:
The elements of a ClassDefinition that are required to contain a history.
CHANGE LOG:
5.1.10.1 Attributes
ParentClassID CDMIDType ID of the parent class, if applicable. This is used to
implement an inheritance hierarchy.
Required Boolean Identifies whether the class is required for all

instances created for a specific class category.
5.1.10.2 Relations
Reference Guides
ClassDefinitionHistoriz ClassDefinition @xml:sequence 10
edInstance (1)
(0..n)
ClassAttributeDefi ClassAttributeDefinitio ClassDefinitionHistorized @xml:sequence 25
nitions n Instance
(0..n) (1)
BPCHistoricalPropertie ClassDefinitionHistorized @xml:sequence 10
s Instance
(0..1) (1)
ClassAttributeMap ClassAttributeMapEntr ClassDefinitionHistorized @xml:sequence 30
y Instance
(0..n) (1)
ApplicableCategori ClassRefCategory ClassDefinitionHistorized @xml:sequence 50
es (0..n) Instance
(1)
DisplayNames DisplayInformation ClassDefinitionHistorized @xml:sequence 15
(0..n) Instance
(1)
ClassAttributes ClassAttributeInstance ClassDefinitionHistorized @xml:sequence 20
(0..n) Instance
(1)
6. BPCCommon.xsd
This package contains all message definitions used by several of the BPC message schema files.
CHANGE LOG
v5.0.0.14 - Added ClassRefCategory structure and DefinitionBase.
by services.
The namespace for the BPD messages is defined as follows: -

@xml:namespace http://www.aspentech.com/namespace/bpc/Common
@xml:prefix BPCCmn
6.1 BPC Common Classes

This contains class definitions used by several of the BPC namespaces.
6.1.1 Diagrams
6.1.1.1 Common Classes

BPCNamespace : NamespaceID...
Validation : String
BPCKey PublishedDateTime : DateTimeT...
ID : CDMIDType PublishedBy : HumanIDType
Defi niti onBase Name : BPCNameT... Major : Integer
GUID : GUIDType Minor : Integer
1 1
DisplayInformation
LocaleID : CDMIDType
BusinessProcessID : CDMID... BPCHi stori cal Pro pertie s
Name : BPCNameType StartDateTime : DateTimeType
Description : DescriptionType EndDateTime : DateTimeType
<<optional>> LastModifiedDateTime : DateTime...
<<optional>> ApprovedDateTime : DateTimeTyp...
AttributeInstance PhysicalPropertyInstance
AttributeID : CDMIDT... PropertyID : CDMIDType
BPCComponentRe ferenceType
ItemComponentID : CDMIDType
ItemCollectionID : CDMIDType ClassRefCategory
<<optional>> ClassifierPropertyName : S ...
1 <<optional>> ClassifierPropertyValue : S...
BPCQuantity 1
<<optional>> Val ueStri ng : Stri ng
<<optional>> Index : Inte ger
<<optional>> Oth erDataType : String
<<optional>> U ni tOfMe asure : CDMIDT... AttributeRefCategory
<<optional>> Min im umValue : Dou ble
<<optional>> Maximu mValue : Double 1..n
Cl assID : CDMIDType
UniqueID : CDMID Typ...
ParentHashCode : Lo...
Diagram : This diagram provides graphical representation of the common classes used in multiple BPC
messages.
6.1.2 AttributeInstance
DEFINITION
Instance data for a specific attribute associated with a specific BPC object.
This class defines the structure that holds attribute value for a CDM BPC configuration object.
CHANGE LOG:
6.1.2.1 Attributes
AttributeID CDMIDType The identifier that relates the instance back to the
original attrubute definition.
6.1.2.2 Relations
Reference Guides
BPCQuantity AttributeInstance @xml:sequence 30
(1) ()
Attributes AttributeInstance GenericObjectTypeDefini @xml:sequence 30
(0..n) tionHistorizedInstance
(1)
Attributes AttributeInstance GenericObjectDefinition @xml:sequence 40
(0..n) HistorizedInstance
(1)
Attributes AttributeInstance MaterialLotDefinitionHist @xml:sequence 50
(0..n) orizedInstance
(1)
Attributes AttributeInstance MaterialSubLotDefinition @xml:sequence 50
(1)
Attributes VersionDefinitionHisto AttributeInstance @xml:sequence 40
rizedInstance (0..n)
()
Attributes AttributeDefinitionHist AttributeInstance @xml:sequence 30
()
Attributes AttributeInstance EquipmentDefinitionHist @xml:sequence 30
()
Attributes HierarchyLevelDefiniti AttributeInstance @xml:sequence 30
onHistorizedInstance (0..n)
(1)
Attributes HierarchyDefinitionHis AttributeInstance @xml:sequence 90
torizedInstance (0..n)
(1)
Attributes AttributeInstance LocationDefinitionHistori @xml:sequence 40
(0..n) zedInstance
()
Attributes AttributeInstance MaterialDefinitionHistori @xml:sequence 50
(0..n) zedInstance
()
Attributes AttributeInstance PhysicalPropertyDefinitio @xml:sequence 50
(0..n) nHistorizedInstance
()
6.1.3 AttributeRefCategory
DEFINITION
The category of reference that must be used when populating an instance of a BPC attribute e.g. a Material
ID, Equipment ID etc.
CHANGE LOG:
6.1.3.1 Relations
Reference Guides
ValueCategory AttributeRefCategory AttributeDefinitionHistori @xml:sequence 40
(0..1) zedInstance
(1)
ApplicableCategori AttributeRefCategory AttributeDefinitionHistori @xml:sequence 50
es (0..n) zedInstance
(1)
6.1.4 BPCComponentReferenceType
DEFINITION
Abstract class used to define the elements of a category of reference that must be used when populating an
instance of a BPC either an Attribute or ClassAttribute e.g. a Material ID, Equipment ID etc.
PURPOSE
This information is used to identify a specific BPC component type or instance. If all that is supplied is the
ItemComponentID and ItemCollectionID then a BPC component type has been selected. An example would
be (30000, 1) would select an Equipment Definition. If the Property Name and Property value were defined
then this would be selecting the instance of the specific component type where the Reflected Property was
equal to the specifies value.
CHANGE LOG:
6.1.4.1 Attributes
ItemComponentID CDMIDType All BPC components have a unique ID assigned to
them
ItemCollectionID CDMIDType All BPC collections in a Component have a unique

ID assigned to them.
ClassifierPropertyName String Name of a Property on an object that can be accessed

using .NET Reflections
ClassifierPropertyValue String Filter Value used to select objects where the

Classifier Property Name is equal to this value
6.1.5 BPCHistoricalProperties
DEFINITION:
Structural class that adds version attributes to the BPCConfigurationID class.
CHANGE LOG:
6.1.5.1 Attributes
StartDateTime DateTimeType A DateTime value that specifies the starting valid
date and time when the CDM configuration data
object becomes valid.
EndDateTime DateTimeType A DateTime value that specifies the expiration date

and time of the CDM configuration data object.
LastModifiedBy HumanIDType The name of the user who last modified the CDM
configuration data object.
LastModifiedDateTime DateTimeType A DateTime value that specifies the date and time
when the CDM configuration data object is last
modified.
ApprovedBy HumanIDType The name of the user who approved the CDM
ApprovedDateTime DateTimeType A DateTime value when the CDM configuration data

object is approved
Description DescriptionType Additional historical documentation.
6.1.5.2 Relations
Reference Guides
BPCHistoricalPropertie GenericObjectTypeDefini @xml:sequence 10
s tionHistorizedInstance
(1) (1)
BPCHistoricalPropertie GenericObjectDefinition @xml:sequence 10
s HistorizedInstance
(1) (1)
BPCHistoricalPropertie ClassDefinitionHistorized @xml:sequence 10
s Instance
(0..1) (1)
BPCHistoricalPropertie PersonnelDefinitionHistor @xml:sequence 10
s izedInstance
(1) (1)
BPCHistoricalPropertie DynamicDataSourceDefi @xml:sequence 10
s nitionHistorizedInstance
(1) (1)
BPCHistoricalPropertie MaterialLotDefinitionHist @xml:sequence 10
s orizedInstance
(1) (1)
BPCHistoricalPropertie MaterialSubLotDefinition @xml:sequence 10
(1) (1)
BPCHistoricalPropertie AllocationDefinitionHisto @xml:sequence 10
s rizedInstance
(1) (1)
BPCHistoricalPropertie BusinessProcessDefinitio @xml:sequence 10
s nHistorizedInstance
(1) (1)
BPCHistoricalPropertie LocaleDefinitionHistorize @xml:sequence 10
s dInstance
(1) (1)
GlobalDataDefinitionH BPCHistoricalProperties @xml:sequence 10
istorizedInstance (1)
(1)
BPCHistoricalPropertie VersionDefinitionHistoriz @xml:sequence 10
s edInstance
(1) (1)
AttributeDefinitionHist BPCHistoricalProperties @xml:sequence 10
orizedInstance (1)
(1)
BPCHistoricalPropertie EquipmentDefinitionHist @xml:sequence 10
s orizedInstance
(1) ()
EquipmentTypeDefiniti BPCHistoricalProperties @xml:sequence 10
onHistorizedInstance (1)
()
BPCHistoricalPropertie HierarchyDefinitionHisto @xml:sequence 10
s rizedInstanceNode
(0..1) ()
BPCHistoricalPropertie HierarchyLevelHistorized @xml:sequence 10
s InstanceHeader
(0..1) ()
BPCHistoricalPropertie LocationDefinitionHistori @xml:sequence 10
s zedInstance
(1) ()
LocationTypeDefinitio BPCHistoricalProperties @xml:sequence 10
nHistorizedInstance (1)
()
BPCHistoricalPropertie MaterialDefinitionHistori @xml:sequence 10
s zedInstance
(1) ()
MaterialTypeDefinition BPCHistoricalProperties @xml:sequence 10
HistorizedInstance (1)
()
BPCHistoricalPropertie PhysicalPropertyDefinitio @xml:sequence 10
(1) ()
6.1.6 BPCKey
DEFINITION
This class defines the structure that holds the unique key for all CDM BPC configuration objects.
CHANGE LOG:
6.1.6.1 Attributes
ID CDMIDType Attribute that holds the unique key of a BPC
configuration object within a CDM BPC component.
Name BPCNameType An optional attribute that holds the name of a BPC

configuration object within a CDM BPC component.
Note: For release 1, some foundation applications
use name as unique BPC configuration object key,
this requires this name attribute to be fixed.
GUID GUIDType An optional attribute that holds a global unique

identification string for a BPC configuration object
to ensure its universal uniqueness.
6.1.6.2 Relations
Reference Guides
BPCKey DefinitionBase @xml:sequence 10
(1) (1)
BPCKey ClassAttributeDefinitionB @xml:sequence 10
(1) ase
(1)
BPCKey BPCAliasData @xml:sequence 10
(1) ()
BPCKey UOMDefinitionBase @xml:sequence 10
(1) (1)
6.1.7 BPCQuantity
DEFINITION:
This class defines the structure that holds the value for an attribute or a property.
CHANGE LOG:
v5.0.0.17 - Added the OtherType field to allow custom data types to be defined.

6.1.7.1 Attributes
ValueString String String containing the value of the attribute. The
DataType field indicates the actual type of the value.
Index Integer optional index for data where the data for an attribute
or property is an array.
DataType DataTypeType Actual data type of the value
OtherDataType String A string defining a custom data type not defined in

the standard enumerated list of DataTypeType. Note
the DataType field will need to be set to Other.
UnitOfMeasure CDMIDType ID of the UOM in which the value is expressed.
MinimumValue Double Attribute minimum value
MaximumValue Double Attribute maximum value
6.1.7.2 Relations
Reference Guides
BPCQuantity AttributeInstance @xml:sequence 30
(1) ()
BPCQuantity PhysicalPropertyInstance
(1) ()
BPCQuantity ClassAttributeInstance @xml:sequence 10
(1..n) ()
AttributeDefinitionHist BPCQuantity @xml:sequence 25
orizedInstance (0..1)
()
BPCQuantity PhysicalPropertyDefinitio @xml:sequence 40
(0..1) nHistorizedInstance
()
6.1.8 BPCVersionInformation
DEFINITION:
Structural class that holds information for defining the version of the configuration dataset for a business
process component. This date and time will serve as the unique identifier for the version of the dataset.
Major and minor may also be used to further identify the version, as well as who published the version
(PublishedBy).
CHANGE LOG:
6.1.8.1 Attributes
BPCNamespace NamespaceIDType The current namespace this component is being run
in.
Validation String String to verify the correctness of the information.
PublishedDateTime DateTimeType The date and time at which the current version of the
configuration dataset was published. This date and
time will serve as the unique identifier for the
version of the dataset. Major and minor may also be
used to further identify the version.
PublishedBy HumanIDType The name of the user who published the CDM
Major Integer This is the publish-level versioning of the

configuration dataset, which follows a company-
wide release. Versioning is done at a major
increment level, as well as a minor increment level,
which is based on incremental sub-releases.
Minor Integer This is the incremental versioning of the

configuration dataset, which occurs on an as-needed
basis. Versioning is done at a major increment level
(which follows a company-wide release schedule), as
well as a minor increment level, which is based on
incremental sub-releases.
SchemaVersion String Version of the BPC schema
6.1.8.2 Relations
Reference Guides
BPCVersionInformatio GenericObjectConfigurati @xml:sequence 10
n onProperties
(1) (1)
BPCVersionInformatio ClassConfigurationProper @xml:sequence 10
n ties
(1) (1)
BPCVersionInformatio PersonnelConfigurationPr @xml:sequence 10
n operties
(1) (1)
BPCVersionInformatio DynamicDataConfigurati @xml:sequence 10
n onProperties
(1) (1)
BPCVersionInformatio MaterialLotConfiguration @xml:sequence 10
n Properties
(1) (1)
BPCVersionInformatio AllocationConfigurationP @xml:sequence 10
n roperties
(0..n) (1)
BPCVersionInformatio BPCConfigurationPropert @xml:sequence 10
n ies
(1) (1)
BPCVersionInformatio AliasConfigurationProper @xml:sequence 10
n ties
(1) ()
BPCVersionInformatio AttributeConfigurationPr
n operties
(1) ()
BPCVersionInformatio PhysicalPropertyConfigur @xml:sequence 10
n ationProperties
(1) ()
EquipmentConfiguratio BPCVersionInformation @xml:sequence 10
nProperties (1)
()
BPCVersionInformatio HierarchyConfigurationPr @xml:sequence 10
n operties
(0..1) ()
BPCVersionInformatio LocationConfigurationPro
n perties
(1) ()
MaterialConfigurationP BPCVersionInformation @xml:sequence 10
roperties (1)
()
UnitOfMeasureConfigu BPCVersionInformation
rationProperties (1)
(1)
6.1.9 ClassAttributeInstance
DEFINITION
Instance data for a specific class attribute associated with a specific BPC object through the assignment of a
specific class to that object.
PURPOSE
This data is the actual values stored for a component instance for a specific Class Definition.
This class defines the structure that holds attribute value for a CDM BPC configuration object.
CHANGE LOG:
6.1.9.1 Attributes
ClassID CDMIDType ID of the Class Definition
UniqueID CDMIDType UniqueID used to match the value up to the Class

Attribute Map entry.
ParentHashCode Long Unique Hash Code (ID) used to match the value up
to the Class Attribute Map. This hash code is used to
resolve ambiguity caused by arrayed class attributes.
6.1.9.2 Relations
Reference Guides
BPCQuantity ClassAttributeInstance @xml:sequence 10
(1..n) ()
ClassAttributes ClassAttributeInstance GenericObjectDefinition @xml:sequence 30
(1)
ClassAttributes ClassAttributeInstance GenericObjectTypeDefini @xml:sequence 20
(1)
ClassAttributes ClassAttributeInstance ClassDefinitionHistorized @xml:sequence 20
(0..n) Instance
(1)
ClassAttributes ClassAttributeInstance PersonnelDefinitionHistor @xml:sequence 30
(0..n) izedInstance
(1)
ClassAttributes DynamicDataSourceDe ClassAttributeInstance @xml:sequence 30
finitionHistorizedInstan (0..n)
ce
(1)
ClassAttributes ClassAttributeInstance MaterialLotDefinitionHist @xml:sequence 30
(1)
ClassAttributes ClassAttributeInstance MaterialSubLotDefinition @xml:sequence 30
(1)
ClassAttributes AllocationDefinitionHi ClassAttributeInstance @xml:sequence 30
storizedInstance (0..n)
(1)
ClassAttributes BusinessProcessDefinit ClassAttributeInstance @xml:sequence 30
ionHistorizedInstance (0..n)
(1)
ClassAttributes LocaleDefinitionHistori ClassAttributeInstance @xml:sequence 30
zedInstance (0..n)
(1)
ClassAttributes VersionDefinitionHisto ClassAttributeInstance @xml:sequence 30
(1)
ClassAttributes AttributeDefinitionHist ClassAttributeInstance @xml:sequence 20
(1)
ClassAttributes ClassAttributeInstance EquipmentDefinitionHist @xml:sequence20
(1)
ClassAttributes EquipmentTypeDefiniti ClassAttributeInstance @xml:sequence 20
(1)
ClassAttributes HierarchyLevelHistoriz ClassAttributeInstance @xml:sequence 30
edInstanceHeader (0..n)
(1)
ClassAttributes HierarchyDefinitionHis ClassAttributeInstance @xml:sequence 30
torizedInstanceNode (0..n)
(1)
ClassAttributes ClassAttributeInstance LocationDefinitionHistori @xml:sequence 30
(0..n) zedInstance
(1)
ClassAttributes LocationTypeDefinitio ClassAttributeInstance @xml:sequence 20
nHistorizedInstance (0..n)
(1)
ClassAttributes ClassAttributeInstance MaterialDefinitionHistori @xml:sequence 30
(0..n) zedInstance
(1)
ClassAttributes MaterialTypeDefinition ClassAttributeInstance @xml:sequence 20
HistorizedInstance (0..n)
(1)
ClassAttributes ClassAttributeInstance PhysicalPropertyDefinitio @xml:sequence 30
(1)
6.1.10 ClassRefCategory
DEFINITION:
To be defined
CHANGE LOG:
6.1.10.1 Relations
Reference Guides
ApplicableCategori ClassRefCategory ClassDefinitionHistorized @xml:sequence 50
es (0..n) Instance
(1)
ValueCategory ClassRefCategory ClassAttributeDefinition @xml:sequence 10
(0..1) (1)
6.1.11 DefinitionBase
DEFINITION
Abstract class that allows a BPC definition structure to ensure that BPCKey is placed before all other
attributes in the definition structure.
CHANGE LOG:
6.1.11.1 Relations
Reference Guides
BPCKey DefinitionBase @xml:sequence 10
(1) (1)
6.1.12 DisplayInformation
DEFINITION
Display information specifying the display name for a specific locale and business process.
CHANGE LOG:
6.1.12.1 Attributes
LocaleID CDMIDType ID of the locale associated with the display
information
BusinessProcessID CDMIDType ID of the business process associated with the

display information
Name BPCNameType Display name for a specific locale and business

process
Description DescriptionType description
6.1.12.2 Relations
Reference Guides
DisplayNames DisplayInformation GenericObjectTypeDefini @xml:sequence 15
(1)
DisplayNames DisplayInformation GenericObjectDefinition @xml:sequence 15
(1)
DisplayNames DisplayInformation ClassDefinitionHistorized @xml:sequence 15
(0..n) Instance
(1)
DisplayNames DisplayInformation PersonnelDefinitionHistor @xml:sequence 20
(0..n) izedInstance
(1)
DisplayNames DisplayInformation DynamicDataSourceDefi @xml:sequence 20
(0..n) nitionHistorizedInstance
(1)
DisplayNames DisplayInformation MaterialSubLotDefinition @xml:sequence 20
(1)
DisplayNames DisplayInformation MaterialLotDefinitionHist @xml:sequence 20
(1)
DisplayNames DisplayInformation AllocationDefinitionHisto @xml:sequence 20
(1)
DisplayNames DisplayInformation LocaleDefinitionHistorize @xml:sequence 20
(0..n) dInstance
(1)
DisplayNames DisplayInformation BusinessProcessDefinitio @xml:sequence 20
(1)
DisplayNames DisplayInformation VersionDefinitionHistoriz @xml:sequence 20
(0..n) edInstance
(1)
DisplayNames DisplayInformation AttributeDefinitionHistori @xml:sequence 15
(0..n) zedInstance
(1)
DisplayNames DisplayInformation EquipmentDefinitionHist @xml:sequence 15
(1)
DisplayNames EquipmentTypeDefiniti DisplayInformation @xml:sequence 15
(1)
DisplayNames DisplayInformation HierarchyDefinitionHisto @xml:sequence 15
(0..n) rizedInstanceNode
(1)
DisplayNames DisplayInformation HierarchyLevelHistorized @xml:sequence 20
() InstanceHeader
()
DisplayNames DisplayInformation LocationDefinitionHistori @xml:sequence 15
(0..n) zedInstance
(1)
DisplayNames LocationTypeDefinitio DisplayInformation @xml:sequence 15
(1)
DisplayNames DisplayInformation MaterialDefinitionHistori @xml:sequence 20
(0..n) zedInstance
(1)
DisplayNames MaterialTypeDefinition DisplayInformation @xml:sequence 15
(1)
DisplayNames PhysicalPropertyDefinit DisplayInformation @xml:sequence 20
(1)
DisplayNames DisplayInformation UOMDefinitionBase @xml:sequence 20
(0..n) (1)
6.1.13 PhysicalPropertyInstance
DEFINITION:
This class defines the structure that holds a physical property value for a CDM BPC configuration object.
CHANGE LOG:
6.1.13.1 Attributes
PropertyID CDMIDType ID of property instance which contains the property
value.
6.1.13.2 Relations
Reference Guides
BPCQuantity PhysicalPropertyInstance
(1) ()
PhysicalProperties PhysicalPropertyInstan MaterialLotDefinitionHist @xml:sequence 40
ce orizedInstance
(0..n) (1)
PhysicalProperties PhysicalPropertyInstan MaterialSubLotDefinition @xml:sequence 40
ce HistorizedInstance
(0..n) (1)
PhysicalProperties PhysicalPropertyInstan MaterialDefinitionHistori @xml:sequence 40
ce zedInstance
(0..n) ()
7. BPCConfiguration.xsd
This package contains all message definitions associated with the BPC component configuration. This
namespace contains a single message, "BPCConfiguration", which is primarily used to communicate locale,
business process and global data information to the client BPC components.
CHANGE LOG
7.1 BPC Configuration Message

The BPCConfiguration message will be used to reload/load(hydrate) BPC configuration information general
to all BPC components.
7.1.1 Diagrams
7.1.1.1 BPC Configuration Message

BPDHeader Key:
BPCConfiguration (f rom Header Classes)
1 1 the BPD Developers Kit Reference Guide
1

1
BPCConfigurationBody BPCConfigu ratio nProperties
BPCNamespace : NamespaceID...
1 1 1 1 Validation : String
1
PublishedBy : HumanIDType
Major : Integer
Minor : Integer
1
BPCConfigurationDetails BusinessProcessDefinition
Create dBy : H uma nIDType
1 1 0..n
CreationDateTi me : DateTi me...
1
Globa lDataDefi niti on

0..n CreationDateTi me : DateTi me...
LocaleDefi niti on
0..n CreationDateTi me : DateTi me...
Diagram : Overall structure for the BPCConfiguration message.

7.1.1.2 BusinessProcessDefinition
BusinessProcessDefinition BPCKey
DefinitionBase (f rom BPC Co mmon Clas ses)
Cre ated By : Huma nIDType (from BPC Common Classes)
Cre ationDateTime : DateTime... ID : CDMIDType
1 1 Name : BPCNameTy...
1 GUID : GUIDType
1..n
BusinessProcessD efinitionHistorizedInsta nce
1 1
StartDateTi me : Da teTi meType
1 1
EndDateTim e : DateTim eType
<<optional>> Las tModi fiedBy : Hu manID Typ e
<<optional>> Las tModi fiedDateTi me : DateTi me...
<<optional>> App rovedBy : HumanIDType
<<optional>> App rovedDateTim e : Date Tim eTyp...
<<optional>> D escripti on : D escripti onType
+Displ ayNames
DisplayInformation
0..n (f rom BPC Common Classes)
BusinessProcessID : CDMID...
Name : BPCNameType
BPCQuantity
ClassAttributeInstance (f rom BPC Co mmon Clas ses)
+ClassAttributes
(f rom BPC Common Classes) <<optio nal>> Va lueString : Stri ng
ClassID : CDMIDType <<optio nal>> Index : Integer
0..n 1..n
UniqueID : CDMIDTy... DataType : DataTypeType
ParentHashCode : L... <<optio nal>> OtherDa taType : String
<<optio nal>> U ni tOfMeasure : CDMIDT...
<<optio nal>> Minimum Value : Double
<<optio nal>> Maxim umValue : Double
Diagram : BusinessProcessDefinition structure

7.1.1.3 GlobalDataDefintion
BPCKey
(f ro m B PC Common C la sse s)
Glob alDataDefini tion Definiti onBase ID : CDMIDType
CreatedBy : HumanIDType (from BPC Common Classes) Name : BPCNameType
CreationDateTime : DateTimeType 1 1 GUID : GUIDType
1..n
GlobalDataDefinitionHistorizedInstance
(f ro m BP C C ommon Cla sse s)
GlobalDataValue : String
1 1 EndDateTime : DateTimeType
Diagram : GlobalDataDefinition structure

7.1.1.4 LocaleDefinition
BPCKey
L ocal eDefini tion DefinitionBase ID : CDMIDType
CreatedBy : Hum anIDType (from BPC Common Classes) Name : BPCNameTy...
Creatio nDateTim e : DateTim e... 1 1 GUID : GUIDType
BPCHi stori cal Pro pertie s

Lo cale De fini tionHi stori zedInstance
Culture : String EndDateTime : DateTimeType
UICulture : String <<optional>> LastModifiedBy : HumanIDType
1 1
1 <<optional>> ApprovedDateTime : DateTimeTyp...
+DisplayNames
DisplayInformation
0..n (f ro m B PC C ommon Cla sse s)
Name : BPCNameType
BPCQu anti ty
+ClassAttri butes ClassAttributeInstance (f rom BPC Common Classes)
(f rom BPC Common Classes) <<optional>> ValueString : String
0..n Cl assID : CDMIDType <<optional>> Index : Integer
Un ique ID : CDMID Typ... 1..n DataType : DataTypeType
ParentHashCode : Lo... <<optional>> OtherDataType : String
<<optional>> UnitOfMeasure : CDMIDT...
Diagram : LocaleDefinition structure
7.1.2 BPCConfiguration
DEFINITION:
Root element of the BPCConfiguration message. The BPCConfiguration message will be used to
reload/load(hydrate) BPC configuration general to all BPC components.
CHANGE LOG:
7.1.2.1 Relations
Reference Guides
BPCConfigurationBody BPCConfiguration @xml:sequence 20
(1) (1)
BPDHeader BPCConfiguration @xml:sequence 10
(1) (1)
7.1.3 BPCConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
7.1.3.1 Relations
Reference Guides
BPCConfigurationBody BPCConfiguration @xml:sequence 20
(1) (1)
BPCConfigurationDetai BPCConfigurationBody @xml:sequence 20
ls (1)
(1)
BPCConfigurationProp BPCConfigurationBody @xml:sequence 10
erties (1)
(1)
7.1.4 BPCConfigurationDetails
DEFINITION:
PURPOSE:
alias data.
CHANGE LOG:
7.1.4.1 Relations
Reference Guides
BPCConfigurationDetai BPCConfigurationBody @xml:sequence 20
ls (1)
(1)
BusinessProcessDefinit BPCConfigurationDetails @xml:sequence 10
ion (1)
(0..n)
LocaleDefinition BPCConfigurationDetails @xml:sequence 30
(0..n) (1)
GlobalDataDefinition BPCConfigurationDetails @xml:sequence 20
(0..n) (1)
7.1.5 BPCConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
7.1.5.1 Relations
Reference Guides
BPCConfigurationProp BPCConfigurationBody @xml:sequence 10
erties (1)
(1)
BPCVersionInformatio BPCConfigurationPropert @xml:sequence 10
n ies
(1) (1)
7.1.6 BusinessProcessDefinition
DEFINITION:
Defines the details of a BPC business process.
CHANGE LOG:
7.1.6.1 Attributes
7.1.6.2 Relations
Reference Guides
BusinessProcessDefinit BPCConfigurationDetails @xml:sequence 10
ion (1)
(0..n)
BusinessProcessDefinit BusinessProcessDefinitio @xml:sequence 10
ionHistorizedInstance n
(1..n) (1)
7.1.7 BusinessProcessDefinitionHistorizedInstance
DEFINITION:
The elements of a BusinessProcessDefinition that are required to contain a history.
CHANGE LOG:
7.1.7.1 Relations
Reference Guides
BusinessProcessDefinit BusinessProcessDefinitio @xml:sequence 10
(1..n) (1)
BPCHistoricalPropertie BusinessProcessDefinitio @xml:sequence 10
(1) (1)
DisplayNames DisplayInformation BusinessProcessDefinitio @xml:sequence 20
(1)
ClassAttributes BusinessProcessDefinit ClassAttributeInstance @xml:sequence 30
(1)
7.1.8 GlobalDataDefinition
DEFINITION:
Defines the details of a global data value.
CHANGE LOG:
7.1.8.1 Attributes
7.1.8.2 Relations
Reference Guides
GlobalDataDefinition BPCConfigurationDetails @xml:sequence 20
(0..n) (1)
GlobalDataDefinition GlobalDataDefinitionHist @xml:sequence 10
(1) orizedInstance
(1..n)
7.1.9 GlobalDataDefinitionHistorizedInstance
DEFINITION:
The elements of an GlobalDataDefinition that are required to contain a history.
CHANGE LOG:
7.1.9.1 Attributes
GlobalDataValue String There is a table of name value pairs that can be
defined as global data that is persisted in the BPC
environment. This is the value part of one of those
name value pairs.
7.1.9.2 Relations
Reference Guides
GlobalDataDefinition GlobalDataDefinitionHist @xml:sequence 10
(1) orizedInstance
(1..n)
GlobalDataDefinitionH BPCHistoricalProperties @xml:sequence 10
(1)
7.1.10 LocaleDefinition
DEFINITION:
Defines the details of a locale.
CHANGE LOG:
7.1.10.1 Attributes
7.1.10.2 Relations
Reference Guides
LocaleDefinition BPCConfigurationDetails @xml:sequence 30
(0..n) (1)
LocaleDefinitionHistori LocaleDefinition @xml:sequence 10
zedInstance (1)
(1..n)
7.1.11 LocaleDefinitionHistorizedInstance
DEFINITION:
The elements of an LocaleDefinition that are required to contain a history.
CHANGE LOG:
7.1.11.1 Attributes
Culture String Uniquely identifies the user who created the object
UICulture String Data and time when the object was created
7.1.11.2 Relations
Reference Guides
LocaleDefinitionHistori LocaleDefinition @xml:sequence 10
zedInstance (1)
(1..n)
BPCHistoricalPropertie LocaleDefinitionHistorize @xml:sequence 10
s dInstance
(1) (1)
DisplayNames DisplayInformation LocaleDefinitionHistorize @xml:sequence 20
(0..n) dInstance
(1)
ClassAttributes LocaleDefinitionHistori ClassAttributeInstance @xml:sequence 30
zedInstance (0..n)
(1)
8. BPCDynamicData.xsd
This package contains all message definitions associated with the BPC Dynamic Data component. This
namespace contains a single message, "DynamicDataConfiguration", which is primarily used to
communicate data source configuration and communication layer information.
CHANGE LOG
8.1 Dynamic Data Configuration Message

The DynamicDataConfiguration message will be used to reload/load(hydrate) Dynamic Data configuration
information general to many BPC components.
8.1.1 Diagrams
8.1.1.1 Dynamic Data Configuration Message

Key:
DynamicDataConfiguration BPDHeader For Details of classes marked in yellow, refer to
(f rom Header Classes) the BPD Developers Kit Reference Guide
1 1 1

1 BPCVersionInformation
DynamicDataConfigurationBody DynamicDataConfigurationProperties
1 1 1 1 1 Validation : String
Major : Integer
1 Minor : Integer
DynamicDataConfigurationDetails <<optional>> SchemaVersion : String
0..n BPCKey
DynamicDataSourceDefinition DefinitionBase ID : CDMIDType

DynamicDataSourceD efinition Hi stori zed Instance
SourceTypeID : CDMIDType EndDateTime : DateTimeType
1 1 <<optional>> LastModifiedBy : HumanIDType
1 1
Displ ayInform atio n

+DisplayNames LocaleID : CDMIDType
0..n Name : BPCNameType
BPCQuantity
Cl assAttrib uteInstance (f rom B PC Common C lasse s)
+ClassAttributes (f rom BPC Co mmon Clas ses )
<<optional>> ValueString : String
Clas sID : CDMIDTyp e <<optional>> Index : Integer
0..n 1..n
Uniq ueID : CDMIDType DataType : DataTypeType
Pare ntHashC ode : L ong <<optional>> OtherDataType : String
Comm unicationLa yer
+Comm unicatio nLayers
Name : BPCNameType
CommTypeID : CDMIDType
0..n ConnectionString : String
ConnectionTimeout : Integer
Diagram : structure for the BPCConfiguration message.
8.1.2 CommunicationLayer
DEFINITION
The DynamicDataSource configuration represents a connection to some dynamic data storage. The types of
data storage are defined as Historian, BPC, BPD and Database. A DynamicDataSource definition can be
configured with one or more communication links to this dynamic storage.
8.1.2.1 Attributes
Name BPCNameType Name of the Communication Link
CommTypeID CDMIDType Communication Link type. (Process Data, BPC,

Enterprise Connect)
ConnectionString String Connection string used to initialize the data storage

connection
ConnectionTimeout Integer Timeout value for the Connection.
8.1.2.2 Relations
Reference Guides
CommunicationLay CommunicationLayer DynamicDataSourceDefi @xml:sequence 40
ers (0..n) nitionHistorizedInstance
(1)
8.1.3 DynamicDataConfiguration
DEFINITION:
Root element of the DynamicDataConfiguration message. The DynamicDataConfiguration message will be
used to reload/load(hydrate) BPC DynamicData configuration information general to all BPC components.
CHANGE LOG:
8.1.3.1 Relations
Reference Guides
DynamicDataConfigura DynamicDataConfigurati @xml:sequence 20
tionBody on
(1) (1)
BPDHeader DynamicDataConfigurati @xml:sequence 10
(1) on
(1)
8.1.4 DynamicDataConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
8.1.4.1 Relations
Reference Guides
tionBody on
(1) (1)
tionDetails onBody
(1) (1)
tionProperties onBody
(1) (1)
8.1.5 DynamicDataConfigurationDetails
DEFINITION:
PURPOSE:
alias data.
CHANGE LOG:
8.1.5.1 Relations
Reference Guides
tionDetails onBody
(1) (1)
DynamicDataSourceDe DynamicDataConfigurati @xml:sequence 10
finition onDetails
(0..n) (1)
8.1.6 DynamicDataConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
8.1.6.1 Relations
Reference Guides
tionProperties onBody
(1) (1)
BPCVersionInformatio DynamicDataConfigurati @xml:sequence 10
n onProperties
(1) (1)
8.1.7 DynamicDataSourceDefinition
DEFINITION:
Defines the details of a data source.
CHANGE LOG:
8.1.7.1 Attributes
8.1.7.2 Relations
Reference Guides
DynamicDataSourceDe DynamicDataConfigurati @xml:sequence 10
finition onDetails
(0..n) (1)
DynamicDataSourceDe DynamicDataSourceDefi @xml:sequence 10
finitionHistorizedInstan nition
ce (1)
(1..n)
8.1.8 DynamicDataSourceDefinitionHistorizedInstance
DEFINITION:
The elements of a DataSource that are required to contain a history.
CHANGE LOG:
8.1.8.1 Attributes
SourceTypeID CDMIDType ID of the DynamicSource Type. (Historian, BPC,
BPD, Database)
8.1.8.2 Relations
Reference Guides
DynamicDataSourceDe DynamicDataSourceDefi @xml:sequence 10
finitionHistorizedInstan nition
ce (1)
(1..n)
BPCHistoricalPropertie DynamicDataSourceDefi @xml:sequence 10
s nitionHistorizedInstance
(1) (1)
CommunicationLay CommunicationLayer DynamicDataSourceDefi @xml:sequence 40
ers (0..n) nitionHistorizedInstance
(1)
DisplayNames DisplayInformation DynamicDataSourceDefi @xml:sequence 20
(0..n) nitionHistorizedInstance
(1)
ClassAttributes DynamicDataSourceDe ClassAttributeInstance @xml:sequence 30
finitionHistorizedInstan (0..n)
ce
(1)
9. BPCEquipment.xsd
This package contains all message definitions associated with the Equipment BPC.
CHANGE LOG
v5.0.0.18 - Added EquipmentTypeDefinition structure.
v5.0.0.14 - Added Class Attributes and DisplayNames structure to the

EquipmentDefinitionHistorizedInstance structure.
by services.
9.1 BPC Equipment Configuration

The Equipment Configuration message is used to publish latest version of the equipment configuration data.
9.1.1 Diagrams
9.1.1.1 Equipment Configuration Class Diagram

BPDHeader Key:
EquipmentConfiguration
(f rom Header Class es) For Details of classes marked in yellow, refer to
the BPD Developers Kit Reference Guide
1
EquipmentConfigurationBody Validation : String
EquipmentConfigurationProperties
1 1 PublishedBy : HumanIDType
Major : Integer
1 Minor : Integer
EquipmentConfigurationDetails <<optional>> SchemaVersion : S...
1
EquipmentType De fi niti on
CreatedBy : HumanIDType
CreationDateTime : DateTime...
0..n
Equipme ntDefin itio n

0..n CreationDateTime : DateTime...
Diagram : Overall structure for the EquipmentConfiguration message.

9.1.1.2 Equipment Definition
BPCKey
Defi niti onBase ID : CDMIDType

EquipmentDefinition (from BPC Common Classes) Name : BPCNameType
BPCHistorica lProperties

EquipmentDefinitionHistorizedInstance EndDateTime : DateTimeType
EquipmentTypeID : CDMIDType
LocationID : CDMIDType
1 1 <<optional>> Description : DescriptionType
+DisplayNames DisplayInformation
0..n LocaleID : CDMIDType
Name : BPCNameType
(f rom BPC Common Classes) BPCQuantity
+ClassAttributes
ClassID : CDMIDType (f rom BPC Common Classes)
UniqueID : CDMIDType <<option al>> Val ueStri ng : Stri ng
0..n
ParentHashCode : Long <<option al>> Index : Integer
1..n
Da taType : DataTypeType
<<option al>> OtherDataType : Strin g
<<option al>> U ni tOfMeasure : CDMIDType
<<option al>> Minim um Value : Double
<<option al>> Maxim umValu e : Dou ble
BPCQuantity
(f ro m B PC Common C la sses)
1 <<o ptional>> Val ueStri ng : Strin g
AttributeInstance <<o ptional>> In dex : Inte ger
Attribu teID : CDMIDType <<o ptional>> Othe rDataType : String
+Attributes
<<o ptional>> U nitOfMe asure : CDMIDType
<<o ptional>> Minim umValue : Doub le
<<o ptional>> Maximu mValue : Double
Diagram : EquipmentDefinition structure

9.1.1.3 Equipment Type
BPCKey
EquipmentTypeDefi niti on Defi niti onBase (f ro m BP C C ommon Cla sse s)
CreatedBy : HumanIDType (from BPC Commo n Classes)
ID : CDMIDType
CreationDateTime : DateTime... 1 1 Name : BPCNameTy...
1 GUID : GUIDType
BPCHi stori cal Prop ertie s

1..n
Equip mentTypeDefi ni ti onH isto rizedInstance StartDateTime : DateTimeType
1 <<optional>> LastModifiedBy : HumanIDType
1 1 <<optional>> LastModifiedDateTime : DateTime...
+DisplayNames
DisplayInformation
0..n
Name : BPCNameType
Class Attri buteInstance

+ClassAttributes (f rom BPC Common Classes) BPCQuantity
ClassID : CDMIDType
0..n UniqueID : CDMIDTyp... <<op tional>> ValueString : String
ParentHashCode : Lo... 1..n <<op tional>> Index : Intege r
<<op tional>> OtherDataType : String
<<op tional>> UnitOfMeas ure : CDMIDT...
<<op tional>> MinimumValue : Double
<<op tional>> MaximumValue : Double
Diagram : EquipmentType structure
9.1.2 EquipmentConfiguration
DEFINITION:
The root element of the EquipmentConfiguration message.
CHANGE LOG:
9.1.2.1 Relations
Reference Guides
BPDHeader EquipmentConfiguration @xml:sequence 10
(1) ()
EquipmentConfiguratio EquipmentConfiguration
nBody ()
(1)
9.1.3 EquipmentConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
9.1.3.1 Relations
Reference Guides
EquipmentConfiguratio EquipmentConfiguration @xml:sequence 20
nDetails Body
(1) ()
EquipmentConfiguratio EquipmentConfiguration
nBody ()
(1)
nProperties Body
(1) ()
9.1.4 EquipmentConfigurationDetails
DEFINITION:
PURPOSE:
equipment data, including physical properties and attributes.
CHANGE LOG:
v5.0.0.18 - Added EquipmentTypeDefinition structure.
9.1.4.1 Relations
Reference Guides
nDetails Body
(1) ()
EquipmentDefinition EquipmentConfiguration @xml:sequence 20
(0..n) Details
()
EquipmentTypeDefiniti EquipmentConfiguration @xml:sequence 10
on Details
(0..n) (1)
9.1.5 EquipmentConfigurationProperties
DEFINITION:
CHANGE LOG:
9.1.5.1 Relations
Reference Guides
EquipmentConfiguratio BPCVersionInformation @xml:sequence 10
nProperties (1)
()
nProperties Body
(1) ()
9.1.6 EquipmentDefinition
DEFINITION:
The equipment line items for the EquipmentConfiguration message.
CHANGE LOG:
9.1.6.1 Attributes
9.1.6.2 Relations
Reference Guides
EquipmentDefinition EquipmentConfiguration @xml:sequence 20
(0..n) Details
()
EquipmentDefinitionHi EquipmentDefinition @xml:sequence 20
storizedInstance ()
(1..n)
9.1.7 EquipmentDefinitionHistorizedInstance
DEFINITION:
The elements of an EquipmentDefinition that are required to contain a history.
CHANGE LOG:
v5.0.0.14 - Added Class Attributes structure to the EquipmentDefinitionHistorizedInstance structure.
9.1.7.1 Attributes
EquipmentTypeID CDMIDType Uniquely identifies the type of this particular piece of
equipment
LocationID CDMIDType Uniquely identifies the location of this particular

piece of equipment.
9.1.7.2 Relations
Reference Guides
BPCHistoricalPropertie EquipmentDefinitionHist @xml:sequence 10
s orizedInstance
(1) ()
Attributes AttributeInstance EquipmentDefinitionHist @xml:sequence 30
()
EquipmentDefinitionHi EquipmentDefinition @xml:sequence 20
storizedInstance ()
(1..n)
ClassAttributes ClassAttributeInstance EquipmentDefinitionHist @xml:sequence20
(1)
DisplayNames DisplayInformation EquipmentDefinitionHist @xml:sequence 15
(1)
9.1.8 EquipmentTypeDefinition
DEFINITION:
The equipment type line items for the EquipmentConfiguration message.
CHANGE LOG:
9.1.8.1 Attributes
9.1.8.2 Relations
Reference Guides
EquipmentTypeDefiniti EquipmentConfiguration @xml:sequence 10
on Details
(0..n) (1)
EquipmentTypeDefiniti EquipmentTypeDefinition @xml:sequence 10
(1..n)
9.1.9 EquipmentTypeDefinitionHistorizedInstance
DEFINITION:
The elements of an EquipmentTypeDefinition that are required to contain a history.
CHANGE LOG:
9.1.9.1 Relations
Reference Guides
EquipmentTypeDefiniti BPCHistoricalProperties @xml:sequence 10
()
DisplayNames EquipmentTypeDefiniti DisplayInformation @xml:sequence 15
(1)
ClassAttributes EquipmentTypeDefiniti ClassAttributeInstance @xml:sequence 20
(1)
EquipmentTypeDefiniti EquipmentTypeDefinition @xml:sequence 10
(1..n)
10. BPCGenericObject.xsd
This package contains all message definitions associated with the Generic BPC.
CHANGE LOG
GenericObjectDefinitionHistorizedInstance structure.
by services.
10.1 Generic Object Configuration

The Generic Object Configuration message is used to publish latest version of the Generic Object
configuration data. The Generic Object component is provided by the BPC components to handle user
defined objects.
10.1.1 Diagrams
10.1.1.1 Generic Component Configuration
BPDHeade
GenericObjectConfiguration
r
1 1 1 (f rom Head...)
1 (f rom BPC Common Classes)
Gene ri cObje ctCon fi gurationBody Generi cObje ctConfi gura tionPro perti es BPCNamespace : NamespaceID...
Validation : String
1 1 1 1 1 PublishedDateTime : DateTimeT...
Major : Integer
1 Minor : Integer
Gen eri cObj ectCo nfi gurationDetai ls <<optional>> SchemaVersion : S...
1 1
GenericObjectTypeDefinition
0..n CreationDateTime : DateTime...
0..n
GenericObjectDefin itio n
Diagram : Overall structure for the GenericConfiguration message.

10.1.1.2 GenericObjectDefinition
BPCKey
GenericObjectDefinition DefinitionBase
ID : CDMIDType
Create dBy : H uma nIDType Name : BPCNameType
1 1 GUID : GUIDType
CreationDateTi me : DateTimeType
GenericObjectDefinitionHistorizedInstance 1 1 StartDateTime : DateTimeType
Gen eri cTypeID : C DMIDType EndDateTime : DateTimeType
1..n <<optional>> LastModifiedBy : HumanIDType
1 1 <<optional>> ApprovedBy : HumanIDType
1 <<optional>> ApprovedDateTime : DateTimeType
DisplayInformation
+DisplayNames
Name : BPCNameType
ClassAttributeInstance BPCQuanti ty
+Clas sAttributes (f rom BPC Common Classes)
ClassID : CDMIDType <<optional>> ValueString : String
0..n UniqueID : CDMIDType 1..n <<optional>> Index : Integer
ParentHashCode : Long DataType : DataTypeType
<<optional>> OtherDataType : String
BPCQuantity
<<option al>> Val ueStri ng : String
+Attributes AttributeInstance 1 <<option al>> Index : Integer
(f rom BPC Common Classes) DataType : DataTypeType
0..n AttributeID : CDMIDType <<option al>> OtherDataType : String
<<option al>> UnitOfMeasure : CDMIDType
<<option al>> Minim umValue : Double
<<option al>> MaximumValue : Doub le
Diagram : GenericObjectDefinition structure

10.1.1.3 GenericObjectTypeDefinition
BPCKey
GenericObjectTypeDefinition (f ro m BP C Co mmon Cl as ses )
CreatedBy : HumanIDType DefinitionBase ID : CDMIDType
CreationDateTime : DateTime... (from BPC Common Classes) Name : BPCNameTy...
1 1 1 GUID : GUIDType
1..n
GenericObjectTypeDefinitionHistorizedInstance 1 1 (f ro m BP C Co mmon Cl as ses )
<<optional>> BaseTypeID : CDMIDType StartDateTime : DateTimeType
1 1
1 <<optional>> LastModifiedDateTime : DateTime...
DisplayInformation
+DisplayNames (f ro m B PC Common Cl as ses)
0..n
Name : BPCNameType
Class Attri buteInstan ce BPCQuantity

+ClassAttributes (f rom BPC Common Classes) (f rom BPC Common Classes)
0..n UniqueID : CDMIDTyp... <<optional>> Index : Integer
ParentHashCode : Lo... 1..n DataType : DataTypeType
AttributeInstance BPCQuantity
0..n
(f rom BPC Common Classes) 1 (f rom BPC Common Classes)
AttributeID : CDMIDT... <<optional>> ValueString : String

+Attributes <<optional>> Index : Integer
Diagram : GenericObjectTypeDefinition structure
10.1.2 GenericObjectConfiguration
DEFINITION:
The root element of the GenericObjectConfiguration message.
CHANGE LOG:

10.1.2.1 Relations
Reference Guides
BPDHeader GenericObjectConfigurati @xml:sequence 10
(1) on
(1)
GenericObjectConfigur GenericObjectConfigurati @xml:sequence 20
ationBody on
(1) (1)
10.1.3 GenericObjectConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
10.1.3.1 Relations
Reference Guides
ationBody on
(1) (1)
ationDetails onBody
(1) (1)
ationProperties onBody
(1) (1)
10.1.4 GenericObjectConfigurationDetails
DEFINITION:
PURPOSE:
equipment data, including physical properties and attributes.
CHANGE LOG:
10.1.4.1 Relations
Reference Guides
ationDetails onBody
(1) (1)
GenericObjectTypeDefi GenericObjectConfigurati @xml:sequence 10
nition onDetails
(0..n) (1)
GenericObjectDefinitio GenericObjectConfigurati @xml:sequence 20
n onDetails
(0..n) (1)
10.1.5 GenericObjectConfigurationProperties
DEFINITION:
CHANGE LOG:
10.1.5.1 Relations
Reference Guides
ationProperties onBody
(1) (1)
BPCVersionInformatio GenericObjectConfigurati @xml:sequence 10
n onProperties
(1) (1)
10.1.6 GenericObjectDefinition
DEFINITION:
The generic object defines a user defined BPC object.
CHANGE LOG:
v2.0.0.6 - Initially Created

10.1.6.1 Attributes
10.1.6.2 Relations
Reference Guides
GenericObjectDefinitio GenericObjectDefinition @xml:sequence 10
(1..n)
GenericObjectDefinitio GenericObjectConfigurati @xml:sequence 20
n onDetails
(0..n) (1)
10.1.7 GenericObjectDefinitionHistorizedInstance
DEFINITION:
Holds the historized versions of the Generic Object instances attributes.
CHANGE LOG:
10.1.7.1 Attributes
GenericTypeID CDMIDType The generic type ID points to a BaseTypeID of a
GenericObjectType.
10.1.7.2 Relations
Reference Guides
Attributes AttributeInstance GenericObjectDefinition @xml:sequence 40
(1)
BPCHistoricalPropertie GenericObjectDefinition @xml:sequence 10
(1) (1)
GenericObjectDefinitio GenericObjectDefinition @xml:sequence 10
(1..n)
ClassAttributes ClassAttributeInstance GenericObjectDefinition @xml:sequence 30
(1)
DisplayNames DisplayInformation GenericObjectDefinition @xml:sequence 15
(1)
10.1.8 GenericObjectTypeDefinition
DEFINITION:
The generic object type defines the characteristics of a type of user defined BPC object.
CHANGE LOG:
10.1.8.1 Attributes
10.1.8.2 Relations
Reference Guides
GenericObjectTypeDefi GenericObjectTypeDefini @xml:sequence 10
nitionHistorizedInstanc tion
e (1)
(1..n)
GenericObjectTypeDefi GenericObjectConfigurati @xml:sequence 10
nition onDetails
(0..n) (1)
10.1.9 GenericObjectTypeDefinitionHistorizedInstance
DEFINITION:
Holds the historized versions of the Generic Object Types attributes.
CHANGE LOG:

10.1.9.1 Attributes
BaseTypeID CDMIDType Identification of the Base Type that this type inherits
from (for future use).
10.1.9.2 Relations
Reference Guides
BPCHistoricalPropertie GenericObjectTypeDefini @xml:sequence 10
s tionHistorizedInstance
(1) (1)
GenericObjectTypeDefi GenericObjectTypeDefini @xml:sequence 10
nitionHistorizedInstanc tion
e (1)
(1..n)
Attributes AttributeInstance GenericObjectTypeDefini @xml:sequence 30
(1)
ClassAttributes ClassAttributeInstance GenericObjectTypeDefini @xml:sequence 20
(1)
DisplayNames DisplayInformation GenericObjectTypeDefini @xml:sequence 15
(1)
11. BPCHierarchy.xsd
This package contains all message definitions associated with the Hierarchy BPC.
CHANGE LOG
v5.0.0.18 - deprecated ParentID and ChildID

HierarchyDefinitionHistorizedInstance structure.
v5.0.0.14 -
by services.
11.1 Hierarchy Configuration Message

The HierarchyConfiguration message is used to publish the grouping and classification of configuration data.
11.1.1 Diagrams
11.1.1.1 1) Hierarchy Configuration Class Diagram

Key:
BPDHea der For Details of classes marked in yellow, refer to
HierarchyConfiguration
(f rom Heade r Clas ses ) the BPD Developers Kit Reference Guide
1
(f ro m B PC Common Cla sse s)
1 Validation : String
HierarchyConfigurationBody Hi erarchyCon figura tionProperti es PublishedDateTime : DateTimeType
1 0..1
Major : Integer
Minor : Integer
<<optional>> SchemaVersion : String
1
HierarchyLevelDefinition
Hi erarchyCo nfigurationDetails
+HierarchyLevels CreatedBy : HumanIDType
0..n
HierarchyDefinition
0..n
+Hierarchies CreatedBy : HumanIDType
Diagram : This diagram displays the structure for the HierarchyConfiguration message.
11.1.1.2 2) Hierarchy Definition
BPCKey
HierarchyDefinition
DefinitionBase ID : CDMID Type
CreatedBy : HumanIDType (from BPC Common Classes) Name : BPC NameType
CreationDateTime : DateTimeType GUID : GUIDTyp e
1 1
1..n
HierarchyDefinitionHi storizedInstanceNode BPCHistoricalProperties
0..1 StartDateTime : DateTimeType
1 EndDateTime : DateTimeType
1
DisplayInformation <<optional>> LastModifiedBy : HumanIDType
+DisplayNames
(f rom BPC Common Classes) <<optional>> LastModifiedDateTime : DateTimeType
LocaleID : CDMIDType <<optional>> ApprovedBy : HumanIDType
0..n <<optional>> ApprovedDateTime : DateTimeType
Name : BPCNameType <<optional>> Description : DescriptionType
Cl assAttri buteIns tance BPCQuantity

+ClassAttributes
(f ro m BPC C ommon Clas se s) (f rom BPC Common Classes)
0..n
UniqueID : CDMIDType <<optional>> Index : Integer
ParentHashCode : Long 1..n DataType : DataTypeType
HierarchyDefinitionHistorizedInstance
<<optional>> IsMixed : Boolean
<<optional>> LevelRootID : CDMIDType
<<DataType>> <<Enumeration>>
BPCNameType BPCTypeType
(f rom Common Data Ty pes) (f rom Common Data Ty pes)
BPCKey
+HierarchyNodes BaseDataType : Strin g Material : String
1 Mi nLength : Integer = 1 PhysicalProperty : String
0..n DefinitionBase ID : CDMIDType
HierarchyNodeHeader (from BPC Common Classes)
MaxL ength : Integer = 50 Equipment : String
Name : BPCNameType
UnitOfMeasure : String
1 1 GUID : GUIDType
GeographicLocation : String
Hierarchy : String
1 MixedComponents : String
BPCComponentReferenceType
ItemComponentID : CDMIDType
ItemCollectionID : CDMIDType
BPCObjectDefinition <<optional>> ClassifierPropertyValue : String
<<optio nal>> ComponentID : C DMIDType
<<optio nal>> Colle cti onID : CDMIDType
1 <<optio nal>> InstanceID : CDMIDType
BPCNodeDefiniti on
Hi erarchyNodeType : HierarchyN odeTyp e
<<optional>> HierarchyLevelID : C DMIDType +ApplicableBPCTypes
<<optional>> ImageName : Stri ng ApplicableBPCType
0..1 <<optional>> Reference dNodeID : CDMIDType 1 0 ..n
<<optional>> Query : String
<<optional>> Class De fi ni ti onID : CDMIDType
HierarchyNode NodeChil dren

<<optional>> ParentID : CDMIDType <<li st>> Ch il dID : CD MIDType
1
BPCQuantity
0..n AttributeInstance (f rom BPC Common Classes)
(f rom BPC Common Cla sses) 1
+Attributes AttributeID : CDMIDType <<optional>> Index : Integer
Diagram : structure of the hierarchy definition

11.1.1.3 3) Hierarchy Levels
BPCKey
HierarchyLevelDefinition
CreationDateTime : DateTimeType GUID : GUIDType
1 1
1..n StartDateTime : Date TimeType
HierarchyLevelHistorizedInstanceHeader
0..1 <<optional>> LastModifiedBy : HumanIDType
<<optional>> LastModifiedDateTime : Da teTimeType
+DisplayNames
DisplayInformation
(f rom BPC Common Cla sse s)
Name : BPCNameType
Clas sAttributeInstance BPCQuan ti ty

+ClassAttri butes (f rom BPC Common Classes) (f rom BPC Common Classes)
0..n UniqueID : CDMIDType <<optional>> Index : Integer
ParentHashCode : Long 1..n DataType : DataTypeType
Hi erarchyLevelDefinitionHisto ri zedInstance
<<optional>> IsComplexLevel : Boolean
<<optional>> ImageName : String
<<optional>> ParentID : CDMIDType HierarchyLevelParentIDs
<<optional>> ChildID : CDMIDType <<list>> ParentID : CDMIDType
1 0..1
1 1
HierarchyLevelContentTypes
<<list>> ContentType : AttributeRefCategory
0..1
BPCQuantity
(f rom BPC Common Classes) 1
AttributeID : CDMIDType <<optional>> Index : Integer
+Attributes
Diagram : structure of the hierarchy levels

11.1.2 ApplicableBPCType
DEFINITION
To be defined
11.1.2.1 Relations
Reference Guides
ApplicableBPCTyp ApplicableBPCType BPCNodeDefinition @xml:sequence 10
es (0..n) (1)
11.1.3 BPCNodeDefinition
DEFINITION:
To be defined
11.1.3.1 Attributes
HierarchyNodeType HierarchyNodeType Node Type
EmptyNode = Simple Place Holder
IdentifierNode = Node that references another BPC
component
HierarchyReferenceNode = Node that references
another Hierarchy that is to be displayed at this point
QueryNode =
Node that is based on a Query that selects the items
to be included in the hierarchy
ClassHierarchyNode = Node that used a Class
definition to dynamically build a Hierarchy based on
the hierarchy of the referenced Class Definition.
HierarchyLevelID CDMIDType
ImageName String Name of the GIF file to represent the node type
ReferencedNodeID CDMIDType ID of the referenced Hierarchy of the node type is

HierarchyReferenceNode
Query String Query definition if the node type is a QueryNode
ClassDefinitionID CDMIDType ID of the Class Definition if the node type id

ClassHierarchyNode
11.1.3.2 Relations
Reference Guides
BPCNodeDefinition HierarchyNodeHeader @xml:sequence 30
(0..1) (1)
ApplicableBPCTyp ApplicableBPCType BPCNodeDefinition @xml:sequence 10
es (0..n) (1)
11.1.4 BPCObjectDefinition
DEFINITION:
Contains the necessary fields to uniquely identify a CDM object.
CHANGE LOG:
11.1.4.1 Attributes
ComponentID CDMIDType Uniquely identifies the type of the component to
which the object belongs (UOM, Material, Location,
Equipment, etc…)
CollectionID CDMIDType A component can contain different type of

collections. For example, the UOM component
contains the quantity types collection, the sets
collection, the UOMs collection. This field uniquely
identifies the Collection to which the object belongs.
InstanceID CDMIDType Uniquely identifies this particular object within the

collection within the component.
11.1.4.2 Relations
Reference Guides
BPCObjectDefinition HierarchyNodeHeader @xml:sequence 20
(1) ()
11.1.5 HierarchyConfiguration
DEFINITION
A tree structured organization of the members of a dimension of a cube. A hierarchy is organized into several
levels.
This class defines a tree structure that holds a classification hierarchy. A hierarchy can have optional multiple
levels and multiple nodes. Each node identifies a classification.
CHANGE LOG:
11.1.5.1 Relations
Reference Guides
BPDHeader HierarchyConfiguration @xml:sequence 10
(1) ()
HierarchyConfiguration HierarchyConfiguration @xml:sequence 20

Body ()
(1)
11.1.6 HierarchyConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
11.1.6.1 Relations
Reference Guides
HierarchyConfiguration HierarchyConfiguration @xml:sequence 20
Body ()
(1)
HierarchyConfiguration HierarchyConfigurationB @xml:sequence 10
Properties ody
(1) ()
Details ody
(1) ()
11.1.7 HierarchyConfigurationDetails
DEFINITION:
PURPOSE:
hierarchical node
CHANGE LOG:
11.1.7.1 Relations
Reference Guides
Details ody
(1) ()
Hierarchies HierarchyDefinition HierarchyConfigurationD @xml:sequence 20
(0..n) etails
()
HierarchyLevels HierarchyLevelDefiniti HierarchyConfigurationD @xml:sequence 10
on etails
(0..n) ()
11.1.8 HierarchyConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
11.1.8.1 Relations
Reference Guides
Properties ody
(1) ()
BPCVersionInformatio HierarchyConfigurationPr @xml:sequence 10
n operties
(0..1) ()
11.1.9 HierarchyDefinition
DEFINITION
Container for Hierarchy Nodes
CHANGE LOG:
11.1.9.1 Attributes
11.1.9.2 Relations
Reference Guides
Hierarchies HierarchyDefinition HierarchyConfigurationD @xml:sequence 20
(0..n) etails
()
HierarchyDefinitionHis HierarchyDefinition @xml:sequence 20
torizedInstanceNode ()
(1..n)
11.1.10 HierarchyDefinitionHistorizedInstance
DEFINITION:
Container element used to separate the historized definitions from the remainder of the message.
CHANGE LOG:
11.1.10.1 Attributes
IsMixed Boolean Field to determine if the hierarchy contains a single
component (False) or multiple components (True).
LevelRootID CDMIDType Identifier for the root level.
11.1.10.2 Relations
Reference Guides
HierarchyNodes HierarchyNodeHeader HierarchyDefinitionHisto @xml:sequence 30
()
Attributes HierarchyDefinitionHis AttributeInstance @xml:sequence 90
torizedInstance (0..n)
(1)
11.1.11 HierarchyDefinitionHistorizedInstanceNode
DEFINITION:
The hierarchy nodes in the HierarchyConfiguration message. They are required to contain a history.
CHANGE LOG:
11.1.11.1 Relations
Reference Guides
BPCHistoricalPropertie HierarchyDefinitionHisto @xml:sequence 10
s rizedInstanceNode
(0..1) ()
HierarchyDefinitionHis HierarchyDefinition @xml:sequence 20
torizedInstanceNode ()
(1..n)
DisplayNames DisplayInformation HierarchyDefinitionHisto @xml:sequence 15
(0..n) rizedInstanceNode
(1)
ClassAttributes HierarchyDefinitionHis ClassAttributeInstance @xml:sequence 30
torizedInstanceNode (0..n)
(1)
11.1.12 HierarchyLevelContentTypes
DEFINITION
To be defined
ContentType AttributeRefCategory BPC Category definition for the type of BPC
components that Hierarchy Nodes at this level can
point to. It us used with Complex Level definitions to
support S95 type Hierarchies.
11.1.12.2 Relations
Reference Guides
HierarchyLevelContent HierarchyLevelDefinition @xml:sequence 20
Types HistorizedInstance
(0..1) (1)
11.1.13 HierarchyLevelDefinition
DEFINITION:
This class defines a level in a hierarchy. Level is identifies "generation" of nodes in a hierarchy. Level is a
collection of the same "generation" nodes. E.g. in a location and region hierarchy, the following are
examples of levels: region, cities, stores.
CHANGE LOG:
11.1.13.2 Relations
Reference Guides
HierarchyLevels HierarchyLevelDefiniti HierarchyConfigurationD @xml:sequence 10
on etails
(0..n) ()
HierarchyLevelHistoriz HierarchyLevelDefinition @xml:sequence 20
edInstanceHeader ()
(1..n)
11.1.14 HierarchyLevelDefinitionHistorizedInstance
DEFINITION:
Container element used to separate the historized levels from the remainder of the message.
CHANGE LOG:
v5.0.0.18 - deprecated ParentID and ChildID
IsComplexLevel Boolean Flag indicating that the Level definition is Complex
Level definition. This means that it can have multiple
parents and needs to have a ContentType defined.
ImageName String Name of a GIF file that is used to represent the node
type.
ParentID CDMIDType Parent object in the hierarchy.
NOTE: This element is DEPRECATED from v5.0
ChildID CDMIDType Uniquely identifies the child level of this particular

level.
NOTE: This element is DEPRECATED from v5.0
11.1.14.2 Relations
Reference Guides
HierarchyLevelParentI HierarchyLevelDefinition @xml:sequence 10
Ds HistorizedInstance
(0..1) (1)
HierarchyLevelContent HierarchyLevelDefinition @xml:sequence 20
Types HistorizedInstance
(0..1) (1)
Attributes HierarchyLevelDefiniti AttributeInstance @xml:sequence 30
(1)
11.1.15 HierarchyLevelHistorizedInstanceHeader
DEFINITION:
Abstract class used to allow for proper sequencing in the message.
CHANGE LOG:
11.1.15.1 Relations
Reference Guides
HierarchyLevelHistoriz HierarchyLevelDefinition @xml:sequence 20
edInstanceHeader ()
(1..n)
BPCHistoricalPropertie HierarchyLevelHistorized @xml:sequence 10
s InstanceHeader
(0..1) ()
ClassAttributes HierarchyLevelHistoriz ClassAttributeInstance @xml:sequence 30
edInstanceHeader (0..n)
(1)
DisplayNames DisplayInformation HierarchyLevelHistorized @xml:sequence 20
() InstanceHeader
()
11.1.16 HierarchyLevelParentIDs
DEFINITION:
To be defined
ParentID CDMIDType ID of a Parent Hierarchy Level. A complex level
definition can have multiple parents.
11.1.16.2 Relations
Reference Guides
HierarchyLevelParentI HierarchyLevelDefinition @xml:sequence 10
Ds HistorizedInstance
(0..1) (1)
11.1.17 HierarchyNode
DEFINITION:
This class defines a node in a hierarchy. As Node is a overloaded term, HierarchyNode is used.
HierarchyNode can have one parent and a number of children hierarchyNodes. If there is no children, it is
the leaf. A HierarchyNode specifies a classification and can be associated with a CDM BPC configuration.
CHANGE LOG:
ParentID CDMIDType Parent Node ID of the current Hierarchy Node
11.1.17.2 Relations
Reference Guides
NodeChildren HierarchyNode @xml:sequence 20
(1) ()
11.1.18 HierarchyNodeHeader
DEFINITION:
Abstract class used to allow for proper sequencing in the message.
CHANGE LOG:
11.1.18.1 Relations
Reference Guides
HierarchyNodes HierarchyNodeHeader HierarchyDefinitionHisto @xml:sequence 30
()
BPCObjectDefinition HierarchyNodeHeader @xml:sequence 20
(1) ()
BPCNodeDefinition HierarchyNodeHeader @xml:sequence 30
(0..1) (1)
11.1.19 NodeChildren
DEFINITION:
Container for the list of ChildNodes to the current node.
CHANGE LOG:
ChildID CDMIDType List of values for child nodes of the current node
11.1.19.2 Relations
Reference Guides
NodeChildren HierarchyNode @xml:sequence 20
(1) ()
12. BPCLocation.xsd
This package contains all message definitions associated with the Location BPC.
CHANGE LOG
v5.0.0.18 - Added LocationTypeDefinition structure.
v5.0.0.14 - Added Class Attributes and DisplayNames structure to the LocationDefinitionHistorizedInstance

structure.
by services.
12.1 Location Configuration Message

Defines all the information related to the Location component and all the objects it contains.
12.1.1 Diagrams
12.1.1.1 Location ConfigurationClassDiagram

BPDHeader Key:
LocationConfi gurati on
(f rom Header Classes) For Details of classes marked in yellow, refer to
1 the BPD Developers Kit Reference Guide

LocationConfigurationBody LocationConfigurationProperties Validation : String
1 1
Major : Integer
Minor : Integer
1
LocationConfig uratio nD etail s
1 LocationTypeDefinition
1
CreatedBy : H um anIDType
Creatio nDateTi me : Da teTi me...
0..n
0..n LocationDefinition
Creatio nDateTi me : Da teTi me...
Diagram : Structure for the LocationConfiguration message.

12.1.1.2 Location Definition
BPCKey
Locatio nDe fi niti on DefinitionBase ID : CDMIDType

CreatedBy : Hum anIDType
1 1 GUID : GUIDType
CreationDateTime : DateTim eType
1..n
LocationDefinitionHistorizedInstance BPCHistoricalProperties
LocationTypeID : CDMIDType (f rom BPC Common Classes)
1
1 1 <<optional>> LastModifiedBy : HumanIDType
DisplayInformation
+DisplayName s (f rom BPC Common Classes)
Name : BPCNameType
ClassAttributeInstance BPCQuantity
+ClassAttributes (f rom BPC Common Classes)
ClassID : CDMIDType <<optiona l>> Val ueStri ng : Stri ng
0..n UniqueID : CDMIDType <<optiona l>> Index : Integer
1..n DataType : Data TypeType
ParentHashCode : Long
<<optiona l>> OtherDataType : Strin g
<<optiona l>> U ni tOfMeasure : CDMIDType
<<optiona l>> Minim um Value : Double
<<optiona l>> Maxim umValue : Dou ble
BPCQuantity
(f rom BPC Common Classes) 1 <<optional>> Value String : String
AttributeID : CDMIDType <<optional>> Index : Integer
+Attributes Data Type : DataTyp eType
<<optional>> U ni tOfMeasu re : CDMIDType
<<optional>> Minimum Value : Double
<<optional>> Maxim umValue : Double
Diagram : LocationDefinition structure

12.1.1.3 Location type
LocationTypeDefinition BPCKey
Defi niti onBase (f ro m BP C C ommon Cla sse s)
Create dBy : Hum anIDType
(from BPC Commo n Classes)
CreationDateTime : DateTime... ID : CDMIDType
1 1 Name : BPCNameTy...
1 GUID : GUIDType
BPCHi stori cal Prop ertie s

1..n
Lo cationTypeDefin itio nHistorize dIns tance
1 1 <<optional>> ApprovedDateTime : DateTimeTyp...
+Displ ayNames
DisplayInformation
0..n
Name : BPCNameType

+ClassAttri butes (f rom BPC Common Classes) BPCQuantity
ClassID : CDMIDType
Diagram : LocationTypeDefinition structure
12.1.2 LocationConfiguration
DEFINITION:
The root element of the LocationConfiguration message.
CHANGE LOG:
12.1.2.1 Relations
Reference Guides
BPDHeader LocationConfiguration @xml:sequence 10
(1) ()
LocationConfiguration LocationConfiguration @xml:sequence 20
Body ()
(1)
12.1.3 LocationConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
12.1.3.1 Relations
Reference Guides
LocationConfiguration LocationConfiguration @xml:sequence 20
Body ()
(1)
LocationConfiguration LocationConfigurationBo @xml:sequence 10
Properties dy
(1) ()
Details dy
(1) ()
12.1.4 LocationConfigurationDetails
DEFINITION:
PURPOSE:
Acts as a container for all of the detailed line items for the message.
CHANGE LOG:
v5.0.0.18 - Added LocationTypeDefinition structure.
12.1.4.1 Relations
Reference Guides
Details dy
(1) ()
LocationDefinition LocationConfigurationDe @xml:sequence 20
(0..n) tails
(1)
LocationTypeDefinitio LocationConfigurationDe @xml:sequence 10
n tails
(0..n) (1)
12.1.5 LocationConfigurationProperties
DEFINITION:
CHANGE LOG:
12.1.5.1 Relations
Reference Guides
Properties dy
(1) ()
BPCVersionInformatio LocationConfigurationPro
n perties
(1) ()
12.1.6 LocationDefinition
DEFINITION:
Container class for each location declaration and definition that is included in the message.
CHANGE LOG:
12.1.6.1 Attributes
12.1.6.2 Relations
Reference Guides
LocationDefinition LocationConfigurationDe @xml:sequence 20
(0..n) tails
(1)
LocationDefinitionHist LocationDefinition
orizedInstance ()
(1..n)
12.1.7 LocationDefinitionHistorizedInstance
DEFINITION:
Container element used to separate the historized definitions from the remainder of the message.
CHANGE LOG:
v5.0.0.14 - Added Class Attributes structure to the LocationDefinitionHistorizedInstance structure.
12.1.7.1 Attributes
LocationTypeID CDMIDType Uniquely identifies the type of location this
particular location is.
12.1.7.2 Relations
Reference Guides
LocationDefinitionHist LocationDefinition
orizedInstance ()
(1..n)
BPCHistoricalPropertie LocationDefinitionHistori @xml:sequence 10
s zedInstance
(1) ()
Attributes AttributeInstance LocationDefinitionHistori @xml:sequence 40
(0..n) zedInstance
()
ClassAttributes ClassAttributeInstance LocationDefinitionHistori @xml:sequence 30
(0..n) zedInstance
(1)
DisplayNames DisplayInformation LocationDefinitionHistori @xml:sequence 15
(0..n) zedInstance
(1)
12.1.8 LocationTypeDefinition
DEFINITION:
Container class for each location type declaration that is included in the message.
CHANGE LOG:
12.1.8.1 Attributes
12.1.8.2 Relations
Reference Guides
LocationTypeDefinitio LocationConfigurationDe @xml:sequence 10
n tails
(0..n) (1)
LocationTypeDefinitio LocationTypeDefinitionH @xml:sequence 10
n istorizedInstance
(1) (1..n)
12.1.9 LocationTypeDefinitionHistorizedInstance
DEFINITION:
The elements of an LocationTypeDefinition that are required to contain a history.
CHANGE LOG:
12.1.9.1 Relations
Reference Guides
LocationTypeDefinitio LocationTypeDefinitionH @xml:sequence 10
n istorizedInstance
(1) (1..n)
LocationTypeDefinitio BPCHistoricalProperties @xml:sequence 10
()
DisplayNames LocationTypeDefinitio DisplayInformation @xml:sequence 15
(1)
ClassAttributes LocationTypeDefinitio ClassAttributeInstance @xml:sequence 20
(1)
13. BPCMaterial.xsd
This package contains all message definitions associated with the Material BPC.
CHANGE LOG
v5.0.0.18 - Added MaterialTypeDefinition structure.
v5.0.0.14 - Added Class Attributes and DisplayNames structure to the MaterialDefinitionHistorizedInstance

structure.
by services.
13.1 Material Configuration Message

Material Configuration defines a tree structure that holds a classification hierarchy. A hierarchy can have
optional multiple levels and multiple nodes. Each node identifies a classification.
13.1.1 Diagrams
13.1.1.1 Material Configuration Class Diagram

Key:
BPDHeader For Details of classes marked in yellow, refer to
MaterialConfiguration (f rom Heade r Cl ass es) the BPD Developers Kit Reference Guide
1
1
Ma teria lC onfig uratio nBody MaterialConfigurationProperties BPCNamespace : NamespaceID...
Validation : String
1
Major : Integer
1 Minor : Integer
MaterialC onfigurationDeta ils <<optional>> SchemaVersion : S...
1
MaterialTypeDefinition
Cre atedBy : H umanIDType
Cre ationDateTime : DateTime...
0..n
MaterialDefinition
0..n
Diagram : Overall structure for the MaterialConfiguration message.

13.1.1.2 Material Definition
BPCKey
(f rom BPC Co mmon Clas ses)
MaterialDefinition (f ro m BPC Co mmo n Class es) Name : BPCNameTy...

MaterialDefinitionHistorizedInstance EndDateTime : DateTimeType
MaterialTypeID : CDMIDType <<optional>> LastModifiedBy : HumanIDType
1 1 <<optional>> ApprovedDateTime : DateTimeTyp...
DisplayInformation
+DisplayNames
0..n
Name : BPCNameType
BPCQuantity
<<o ptional>> Val ueStri ng : Stri ng

Cl assAttri buteIn stan ce
<<o ptional>> In dex : Inte ger
+ClassAttri bute s DataTyp e : Da taTypeType
ClassID : CDMIDType <<o ptional>> Othe rDataType : String
0..n UniqueID : CDMIDTyp... <<o ptional>> U nitOfMe asure : CDMIDT...
1..n
ParentHashCode : Lo... <<o ptional>> Minim umValue : Dou ble
<<o ptional>> Maximu mValue : Double
BPCQuantity
0..n PhysicalPropertyInstance 1 <<optional>> ValueString : String
<<optional>> Index : Integer
+Ph ysi cal Prope rties PropertyID : CDMIDType DataType : DataTypeType
BPCQuantity
0..n
AttributeInstance <<option al>> Val ueStri ng : Stri ng

+Attributes
(f rom BPC Common Classes) 1 <<option al>> Index : Integer
AttributeID : CDMIDT... Da taType : DataTypeType
<<option al>> OtherDataType : String
<<option al>> U ni tOfMeasure : CDMIDT...
<<option al>> Minim um Value : Double
<<option al>> Maxim umValu e : Do uble
Diagram : MaterialDefinition structure

13.1.1.3 Material Type
BPCKey
MaterialTyp eDefini tion Defi niti onBase (f ro m BP C C ommon Cla sse s)
CreatedBy : Hum anIDType (from BPC Commo n Classes)
ID : CDMIDType
Creation Da teTim e : Da teTim e... 1 1 Name : BPCNameTy...
1 GUID : GUIDType
1..n
Mate rialTypeDefin itio nHi stori ze dIns tance BPCHi stori cal Prop ertie s
1 StartDateTime : DateTimeType
1 1 EndDateTime : DateTimeType
+DisplayNames
DisplayInformation
0..n
Name : BPCNameType

+ClassAttributes (f rom BPC Common Classes) BPCQuantity
ClassID : CDMIDType
Diagram : MaterialType structure
13.1.2 MaterialConfiguration
DEFINITION:
The root element of the MaterialConfiguration message.
CHANGE LOG:
13.1.2.1 Relations
Reference Guides
BPDHeader MaterialConfiguration @xml:sequence 10
(1) ()
MaterialConfigurationB MaterialConfiguration @xml:sequence 20
ody ()
(1)
13.1.3 MaterialConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
13.1.3.1 Relations
Reference Guides
MaterialConfiguration MaterialConfigurationBo @xml:sequence 20
Details dy
(1) ()
MaterialConfigurationB MaterialConfiguration @xml:sequence 20
ody ()
(1)
MaterialConfigurationP MaterialConfigurationBo @xml:sequence 10
roperties dy
(1) ()
13.1.4 MaterialConfigurationDetails
DEFINITION:
PURPOSE:
material data, including physical properties and attributes.
CHANGE LOG:
v5.0.0.18 - Added MaterialTypeDefinition structure.
13.1.4.1 Relations
Reference Guides
MaterialConfiguration MaterialConfigurationBo @xml:sequence 20
Details dy
(1) ()
MaterialDefinition MaterialConfigurationDet @xml:sequence 20
(0..n) ails
()
MaterialTypeDefinition MaterialConfigurationDet @xml:sequence 10
(0..n) ails
(1)
13.1.5 MaterialConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
13.1.5.1 Relations
Reference Guides
MaterialConfigurationP BPCVersionInformation @xml:sequence 10
roperties (1)
()
MaterialConfigurationP MaterialConfigurationBo @xml:sequence 10
roperties dy
(1) ()
13.1.6 MaterialDefinition
DEFINITION:
The material line items for the MaterialConfiguration message.
CHANGE LOG:
13.1.6.1 Attributes
13.1.6.2 Relations
Reference Guides
MaterialDefinition MaterialConfigurationDet @xml:sequence 20
(0..n) ails
()
MaterialDefinitionHisto MaterialDefinition @xml:sequence 20
rizedInstance ()
(1..n)
13.1.7 MaterialDefinitionHistorizedInstance
DEFINITION:
The physical properties and attributes of the MaterialConfiguration message that are required to contain a
history.
CHANGE LOG:
v5.0.0.14 - Added Class Attributes structure to the MaterialDefinitionHistorizedInstance structure.
13.1.7.1 Attributes
MaterialTypeID CDMIDType Uniquely identifies the type of material of which this
particular material is.
13.1.7.2 Relations
Reference Guides
BPCHistoricalPropertie MaterialDefinitionHistori @xml:sequence 10
s zedInstance
(1) ()
PhysicalProperties PhysicalPropertyInstan MaterialDefinitionHistori @xml:sequence 40
ce zedInstance
(0..n) ()
Attributes AttributeInstance MaterialDefinitionHistori @xml:sequence 50
(0..n) zedInstance
()
MaterialDefinitionHisto MaterialDefinition @xml:sequence 20
rizedInstance ()
(1..n)
ClassAttributes ClassAttributeInstance MaterialDefinitionHistori @xml:sequence 30
(0..n) zedInstance
(1)
DisplayNames DisplayInformation MaterialDefinitionHistori @xml:sequence 20
(0..n) zedInstance
(1)
13.1.8 MaterialTypeDefinition
DEFINITION:
The material type line items for the MaterialConfiguration message.
CHANGE LOG:
13.1.8.1 Attributes
13.1.8.2 Relations
Reference Guides
MaterialTypeDefinition MaterialConfigurationDet @xml:sequence 10
(0..n) ails
(1)
MaterialTypeDefinition MaterialTypeDefinitionHi @xml:sequence 10
(1) storizedInstance
(1..n)
13.1.9 MaterialTypeDefinitionHistorizedInstance
13.1.9.1 Relations
Reference Guides
MaterialTypeDefinition MaterialTypeDefinitionHi @xml:sequence 10
(1) storizedInstance
(1..n)
MaterialTypeDefinition BPCHistoricalProperties @xml:sequence 10
HistorizedInstance (1)
()
DisplayNames MaterialTypeDefinition DisplayInformation @xml:sequence 15
(1)
ClassAttributes MaterialTypeDefinition ClassAttributeInstance @xml:sequence 20
(1)
14. BPCMaterialLots.xsd
This package contains all message definitions associated with the Material Lots BPC component. This
namespace contains a single message, "MaterialLotsConfiguration", which is primarily used by the BPC
components to supply lot information.
CHANGE LOG
14.1 Material Lot Configuration Message

The MaterialLotsConfiguration message will be used to reload/load(hydrate) BPC lot component with data
for the definition of lot structures.
14.1.1 Diagrams
14.1.1.1 Material Lot Configuration Message

Key:
BPDHeader For Details of classes marked in yellow, refer to
MaterialLotConfiguration
(f rom Header Classes) the BPD Developers Kit Reference Guide
1 1
1
1 BPCVersi onInformation
MaterialLotConfigurationBod y MaterialLotConfigurationProperties (f rom BPC Common Classes)
1 1 1 1
Publish edDateTime : DateTimeType
Publish edBy : HumanIDType
Major : Integer
Minor : Integer
MaterialLotConfigurationDetails
1
1
MaterialLotDefinition
0..n
MaterialSubLotDefinition
0 ..n
Diagram : Overall structure for the MaterialLot Configuration message.

14.1.1.2 Material Lots
BPCKey
ID : CDMIDType
MaterialLotDefinition DefinitionBase Name : BPCNameType
Create dBy : H uma nIDType GUID : GUIDType
CreationDateTi me : DateTi meType 1 1
1
BPCHi stori cal Properties
(f rom B PC Common C lasse s)
1..n
MaterialLotDefinitionHistorizedInstance StartDateTime : DateTimeType
ActualQuantity : NumericalQuantityNoRange EndDateTime : DateTimeType
StatusID : Integer 1 1 <<optional>> LastModifiedBy : HumanIDType
EquipmentID : CDMIDType <<optional>> LastModifiedDateTime : DateTimeType
MaterialID : CDMIDType <<optional>> ApprovedBy : HumanIDType
1 1
1
1 DisplayInformation
+DisplayNames
Name : BPCNameType
BPCQuantity
ClassAttributeInstance <<optional>> Val ueStri ng : String

<<optional>> Index : Inte ger
+ClassAttributes DataType : DataTypeType
ClassID : CDMIDType <<optional>> Oth erDataType : String
UniqueID : CDMIDType <<optional>> UnitOfMe asure : CDMIDType
0..n ParentHashCode : Long 1..n
<<optional>> Min im umValue : Doub le
<<optional>> Maxi mu mValue : Double
BPCQuantity
PhysicalPropertyInstance 1 <<optional>> ValueString : String
+PhysicalProperties (f rom BPC Common Classes)
PropertyID : C DMIDType DataType : DataTypeType
0..n <<optional>> OtherDataType : String
BPCQuantity
(f rom BP C Co mmon Clas ses )
+Attributes <<op tional>> Valu eString : String
AttributeInstance
<<op tional>> Inde x : Integer
0..n DataType : DataTypeType
Attri bute ID : CD MIDTyp e <<op tional>> OtherDataType : String
<<op tional>> Un itOfMeasu re : CDMIDType
<<op tional>> Ma xi mumValue : Double
Diagram : Material Lots structure

14.1.1.3 Material Sublots
BPCKey
MaterialSubLotDefinition (f rom BPC Common Classes)
CreatedBy : HumanIDType Defin itio nBase ID : CDMIDType
CreationDateTime : DateTimeType (f ro m BPC Co mmon Cla sse s) Name : BPCNameType
1 1 GUID : GUIDType
1
1..n
MaterialSubLotDefinitionHistorizedInstance
ActualQuantity : NumericalQuantityNoRange BPCHi stori cal Pro perties
StatusID : Integer
EquipmentID : CDMIDType 1 1 StartDateTime : DateTimeType
MaterialLotID : CDMIDType EndDateTime : DateTimeType
<<optional>> ParentSubLotID : CDMIDType <<optional>> LastModifiedBy : HumanIDType
1 <<optional>> ApprovedDateTime : DateTimeType
1
1 <<optional>> Description : DescriptionType
1
0..n
L ocal eID : CD MIDType
Bu sine ssProcessID : CDMIDType
Name : BPC Name Type
Des cri ption : Descri ptionType
BPCQuanti ty
ClassAttributeInstance <<optional>> ValueString : String

+ClassAttributes (f rom BPC Common Classes)
Cl assID : CDMIDType <<optional>> OtherDataType : String
0..n UniqueID : CDMIDType <<optional>> UnitOfMeasure : CDMIDType
Pa rentHashCode : Lon g 1..n
BPCQuantity
(f ro m BPC C ommon Clas se s)
+PhysicalProperties PhysicalPropertyInstance 1 <<o ptional>> Val ueStrin g : String
<<o ptional>> Ind ex : In tege r
0..n Prop ertyID : CD MIDType DataType : DataTypeType
<<o ptional>> OtherData Type : String
<<o ptional>> U nitOfMeas ure : CDMIDType
<<o ptional>> Minimu mValue : Double
<<o ptional>> Maxi mumValue : Double
BPCQuantity
(f ro m BPC C ommon Clas se s)
AttributeInstance <<o ptional>> Val ueStrin g : String

+Attributes
<<o ptional>> Ind ex : In tege r
0..n Attri buteID : CD MIDType <<o ptional>> OtherData Type : String
<<o ptional>> U nitOfMeas ure : CDMIDType
<<o ptional>> Minimu mValue : Double
<<o ptional>> Maxi mumValue : Double
Diagram : Material Sublots structure
14.1.2 MaterialLotConfiguration
DEFINITION:
Root element of the MaterialLotConfiguration message.
CHANGE LOG:
14.1.2.1 Relations
Reference Guides
MaterialLotConfigurati MaterialLotConfiguration @xml:sequence 20
onBody (1)
(1)
BPDHeader MaterialLotConfiguration @xml:sequence 10
(1) (1)
14.1.3 MaterialLotConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
14.1.3.1 Relations
Reference Guides
onBody (1)
(1)
onDetails Body
(1) (1)
onProperties Body
(1) (1)
14.1.4 MaterialLotConfigurationDetails
DEFINITION:
PURPOSE:
alias data.
CHANGE LOG:
14.1.4.1 Relations
Reference Guides
onDetails Body
(1) (1)
MaterialLotDefinition MaterialLotConfiguration @xml:sequence 10
(0..n) Details
(1)
MaterialSubLotDefiniti MaterialLotConfiguration @xml:sequence 30
on Details
(0..n) (1)
14.1.5 MaterialLotConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
14.1.5.1 Relations
Reference Guides
onProperties Body
(1) (1)
BPCVersionInformatio MaterialLotConfiguration @xml:sequence 10
n Properties
(1) (1)
14.1.6 MaterialLotDefinition
DEFINITION:
The elements of a MaterialLotDefinition that are required to contain a history.
CHANGE LOG:
14.1.6.1 Attributes
14.1.6.2 Relations
Reference Guides
MaterialLotDefinition MaterialLotConfiguration @xml:sequence 10
(0..n) Details
(1)
MaterialLotDefinitionH MaterialLotDefinition @xml:sequence 20
(1..n)
14.1.7 MaterialLotDefinitionHistorizedInstance
14.1.7.1 Attributes
ActualQuantity NumericalQuantityN The amount of material that this Material Lot
oRange represents
StatusID Integer Current status of the Material Lot (Released,

Approved, Blocked, In Process, In Quality Check,
Reserved, Committed)
EquipmentID CDMIDType ID of the Equipment where this material is located
MaterialID CDMIDType ID of the Material definition that this Material Lot

represents an amount of.
14.1.7.2 Relations
Reference Guides
MaterialLotDefinitionH MaterialLotDefinition @xml:sequence 20
(1..n)
BPCHistoricalPropertie MaterialLotDefinitionHist @xml:sequence 10
s orizedInstance
(1) (1)
DisplayNames DisplayInformation MaterialLotDefinitionHist @xml:sequence 20
(1)
ClassAttributes ClassAttributeInstance MaterialLotDefinitionHist @xml:sequence 30
(1)
Attributes AttributeInstance MaterialLotDefinitionHist @xml:sequence 50
(1)
PhysicalProperties PhysicalPropertyInstan MaterialLotDefinitionHist @xml:sequence 40
ce orizedInstance
(0..n) (1)
14.1.8 MaterialSubLotDefinition
DEFINITION:
Encompasses the definition of a Material Sublot.
CHANGE LOG:
14.1.8.1 Attributes
14.1.8.2 Relations
Reference Guides
MaterialSubLotDefiniti MaterialLotConfiguration @xml:sequence 30
on Details
(0..n) (1)
MaterialSubLotDefiniti MaterialSubLotDefinition @xml:sequence 10
(1..n)
14.1.9 MaterialSubLotDefinitionHistorizedInstance
DEFINITION:
The elements of a MaterialSublotDefinition that are required to contain a history.
CHANGE LOG:
14.1.9.1 Attributes
ActualQuantity NumericalQuantityN The amount of material that this Material Lot
oRange represents
StatusID Integer Current status of the Material Lot (Released,

Approved, Blocked, In Process, In Quality Check,
Reserved, Committed)
EquipmentID CDMIDType ID of the Equipment where this material is located

MaterialLotID CDMIDType ID of the Material Lot that this Material Sublot is
part of
ParentSubLotID CDMIDType ID of the Material Sublot that this Material Sublot is

a child of.
14.1.9.2 Relations
Reference Guides
MaterialSubLotDefiniti MaterialSubLotDefinition @xml:sequence 10
(1..n)
BPCHistoricalPropertie MaterialSubLotDefinition @xml:sequence 10
(1) (1)
DisplayNames DisplayInformation MaterialSubLotDefinition @xml:sequence 20
(1)
ClassAttributes ClassAttributeInstance MaterialSubLotDefinition @xml:sequence 30
(1)
Attributes AttributeInstance MaterialSubLotDefinition @xml:sequence 50
(1)
PhysicalProperties PhysicalPropertyInstan MaterialSubLotDefinition @xml:sequence 40
ce HistorizedInstance
(0..n) (1)
15. BPCPersonnel.xsd
This package contains all message definitions associated with the Personnel BPC component. This
namespace contains a single message, "PersonnelConfiguration".
CHANGE LOG
15.1 Personnel Configuration Message

The PersonnelConfiguration message will be used to reload/load(hydrate) BPC personnel component with
data for the definition of personnel structures.
15.1.1 Diagrams
15.1.1.1 Personnel Configuration Message
BPDHeader
PersonnelConfiguration (f rom Header Classes)
1 1 1
1
PersonnelConfigurationBody PersonnelConfigurationProperties BPCNamespace : NamespaceIDType
Validation : String
1 1 1 1 1 PublishedDateTime : DateTimeType
Major : Integer
Minor : Integer
PersonnelConfigurationDetails
BPCKey
0..n (f ro m BP C C ommon Clas se s)
PersonnelDefinition
CreatedBy : H umanIDTyp e (from BPC Common Classes) Name : BPCNameType
1
0..n
PersonnelDefinitionHistorizedInstance
FirstName : Stri ng BPCHistorical Properties
Mi ddl eName : String
LastName : Stri ng StartDateTime : DateTimeType
Domai nName : String 1 1 EndDateTime : DateTimeType
Domai nUserName : Stri ng <<optional>> LastModifiedBy : HumanIDType
Bu sine ssProcessID : CD MIDType <<optional>> LastModifiedDateTime : DateTimeType
Local eID : C DMIDType <<optional>> ApprovedBy : HumanIDType
1 1
DisplayInformation
+DisplayNames
Name : BPCNameType
ClassAttributeInstance BPCQuantity

0..n UniqueID : CDMIDType <<optional>> Index : Integer
ParentHashCode : Long 1..n
Diagram : structure for the personnelConfiguration message.

15.1.2 PersonnelConfiguration
DEFINITION:
Root element of the PersonnelConfiguration message.
CHANGE LOG:
15.1.2.1 Relations
Reference Guides
PersonnelConfiguration PersonnelConfiguration @xml:sequence 20
Body (1)
(1)
BPDHeader PersonnelConfiguration @xml:sequence 10
(1) (1)
15.1.3 PersonnelConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
15.1.3.1 Relations
Reference Guides
PersonnelConfiguration PersonnelConfiguration @xml:sequence 20
Body (1)
(1)
PersonnelConfiguration PersonnelConfigurationB @xml:sequence 20
Details ody
(1) (1)
Properties ody
(1) (1)
15.1.4 PersonnelConfigurationDetails
DEFINITION:
PURPOSE:
alias data.
CHANGE LOG:
15.1.4.1 Relations
Reference Guides
Details ody
(1) (1)
PersonnelDefinition PersonnelConfigurationD @xml:sequence 10
(0..n) etails
(1)
15.1.5 PersonnelConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
15.1.5.1 Relations
Reference Guides
Properties ody
(1) (1)
BPCVersionInformatio PersonnelConfigurationPr @xml:sequence 10
n operties
(1) (1)
15.1.6 PersonnelDefinition
DEFINITION:
Encompasses the definition of a Personnel record.
CHANGE LOG:
15.1.6.1 Attributes
15.1.6.2 Relations
Reference Guides
PersonnelDefinition PersonnelConfigurationD @xml:sequence 10
(0..n) etails
(1)
PersonnelDefinitionHis PersonnelDefinition @xml:sequence 10
torizedInstance (1)
(0..n)
15.1.7 PersonnelDefinitionHistorizedInstance
DEFINITION:
The elements of a PersonnelDefinition that are required to contain a history.
CHANGE LOG:
15.1.7.1 Attributes
FirstName String first name of person
MiddleName String middle name of person
LastName String last name of person
DomainName String Name of the Network Domain that this person

belongs to
DomainUserName String Network Login name that this person used to connect
to the BPC components with
BusinessProcessID CDMIDType ID of the Business Process definition that should be

used as the for this person
LocaleID CDMIDType ID of the Locale that should be used as the default

Locale for this person.
15.1.7.2 Relations
Reference Guides
PersonnelDefinitionHis PersonnelDefinition @xml:sequence 10
torizedInstance (1)
(0..n)
BPCHistoricalPropertie PersonnelDefinitionHistor @xml:sequence 10
s izedInstance
(1) (1)
ClassAttributes ClassAttributeInstance PersonnelDefinitionHistor @xml:sequence 30
(0..n) izedInstance
(1)
DisplayNames DisplayInformation PersonnelDefinitionHistor @xml:sequence 20
(0..n) izedInstance
(1)
16. BPCPhysicalProperty.xsd
This package contains all message definitions associated with the Physical Property BPC.
CHANGE LOG
PhysicalPropertyDefinitionHistorizedInstance structure.
by services.
16.1 Physical Property Configuration Message

The Physical PropertyConfiguration message contains Physical Property definitions. It is used for
publication of the latest version of the physical property definitions.
16.1.1 Diagrams
16.1.1.1 PhysicalPropertyConfiguration Class Diagram

BPDHeader Key:
Physi cal PropertyConfiguration
1
the BPD Developers Kit Reference Guide

1
PhysicalPropertyConfigurationBody
Physi cal Prop ertyConfigu ratio nProperties BPCVersionInformation
1
PhysicalPropertyConfigurationDetails
Major : Integer
Minor : Integer
<<optional>> SchemaVersion : String
0 ..n
Physi cal PropertyDefini tion
CreatedBy : H um anIDType BPCKey
Creation Da teTi me : Da teTi meType (f rom BPC Common Classes)
DefinitionBase ID : CDMIDType
(from BPC Common Classes) 1 1
Name : BPCNameType
GUID : GUIDType
BPCHi stori calProperties

(f rom B PC Common C lasse s)

Ph ysi cal PropertyDefini tionHi sto ri zedInstance EndDateTime : DateTimeType
PhysicalPropertyTypeID : CDMIDType
QuantityTypeID : CDMIDType
1 1 <<optional>> Description : DescriptionType
0..1 (f rom BPC Common Classes)
EnumPhysicalPropertyDefinition 0..n Lo cal eID : C DMIDTyp e
Nomi nalValue : ID Type Bus ines sProce ssID : CD MIDType
Name : BPCNameType
1 Descri ption : Descri ptionType
BPCQuanti ty
Cl assID : CDMIDType
UniqueID : CDMIDType <<optional>> ValueString : String
0..n
ParentHas hC ode : Long <<optional>> Index : Integer
1..n DataType : DataTypeType
1..n <<optional>> UnitOfMeasure : CDMIDType
EnumerationItem <<optional>> MinimumValue : Double
(f rom Miscellaneous Classes) BPCQuantity <<optional>> MaximumValue : Double
ID : IDType
Te xt : Enu merationTe xtType <<optional>> Va lueString : String
0..1
<<optional>> OtherDataType : Strin g
<<optional>> MaximumValu e : Dou ble
BPCQuantity
(f rom BPC Co mmon Clas ses )
AttributeInstance
(f rom B PC Common Cla sse s) <<op tional>> Value String : String
0..n <<op tional>> Index : Integer
AttributeID : CDMIDType
1 DataType : DataTyp eType
+Attributes <<op tional>> OtherD ataType : String
<<op tional>> UnitOfMeasure : CDMIDTyp e
<<op tional>> MaximumValue : D ouble
Diagram : This diagram displays the structure for the PhysicalPropertyConfiguration message.
16.1.2 EnumPhysicalPropertyDefinition
DEFINITION
A subclass of PhysicalPropertyDefinition that defines physical property that has enumeration values.
CHANGE LOG:
16.1.2.1 Attributes
NominalValue IDType Default value for the property.
16.1.2.2 Relations
Reference Guides
EnumerationItem EnumPhysicalPropertyDe @xml:sequence 10
(1..n) finition
(1)
EnumPhysicalProperty PhysicalPropertyDefinitio @xml:sequence 60
Definition nHistorizedInstance
(0..1) ()
16.1.3 PhysicalPropertyConfiguration
DEFINITION:
The root element of the PhysicalPropertyConfiguration message.
CHANGE LOG:
16.1.3.1 Relations
Reference Guides
PhysicalPropertyConfig PhysicalPropertyConfigur @xml:sequence 20
urationBody ation
(1) ()
BPDHeader PhysicalPropertyConfigur @xml:sequence 10
(1) ation
()
16.1.4 PhysicalPropertyConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
16.1.4.1 Relations
Reference Guides
urationDetails ationBody
(1) ()
urationProperties ationBody
(1) ()
urationBody ation
(1) ()
16.1.5 PhysicalPropertyConfigurationDetails
DEFINITION:
PURPOSE:
physical property data, pertaining to quantity and enumerations.
CHANGE LOG:
16.1.5.1 Relations
Reference Guides
PhysicalPropertyDefinit PhysicalPropertyConfigur @xml:sequence 30
ion ationDetails
(0..n) ()
urationDetails ationBody
(1) ()
16.1.6 PhysicalPropertyConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
16.1.6.1 Relations
Reference Guides
urationProperties ationBody
(1) ()
BPCVersionInformatio PhysicalPropertyConfigur @xml:sequence 10
n ationProperties
(1) ()
16.1.7 PhysicalPropertyDefinition
DEFINITION:
The physical property line items for the PhysicalPropertyConfiguration message.
CHANGE LOG:
16.1.7.1 Attributes
16.1.7.2 Relations
Reference Guides
PhysicalPropertyDefinit PhysicalPropertyConfigur @xml:sequence 30
ion ationDetails
(0..n) ()
PhysicalPropertyDefinit PhysicalPropertyDefinitio @xml:sequence 20
(1..n) ()
16.1.8 PhysicalPropertyDefinitionHistorizedInstance
DEFINITION:
The quantity and enumerations of the PhysicalPropertyConfiguration message that are required to contain a
history.
CHANGE LOG:
16.1.8.1 Attributes
PhysicalPropertyTypeID CDMIDType Uniquely identifies the type of property of which this
property is.
QuantityTypeID CDMIDType Identifier of the quantity type to which this property

relates.
16.1.8.2 Relations
Reference Guides
Attributes AttributeInstance PhysicalPropertyDefinitio @xml:sequence 50
()
EnumPhysicalProperty PhysicalPropertyDefinitio @xml:sequence 60
Definition nHistorizedInstance
(0..1) ()
PhysicalPropertyDefinit PhysicalPropertyDefinitio @xml:sequence 20
(1..n) ()
BPCQuantity PhysicalPropertyDefinitio @xml:sequence 40
(0..1) nHistorizedInstance
()
BPCHistoricalPropertie PhysicalPropertyDefinitio @xml:sequence 10
(1) ()
ClassAttributes ClassAttributeInstance PhysicalPropertyDefinitio @xml:sequence 30
(1)
DisplayNames PhysicalPropertyDefinit DisplayInformation @xml:sequence 20
(1)
17. BPCUnitOfMeasure.xsd
This package contains all message definitions associated with the Unit Of Measure BPC.
CHANGE LOG
v5.0.0.21 - Added UN Standard UOM name field to the UnitOfMeasureDefinition
by services.
17.1 Unit Of Measure configuration Message

The UnitOfMeasureConfiguration message contains both predefined and user added unit of measures
published by the UOM server component.
17.1.1 Diagrams
17.1.1.1 UnitOfMeasureConfiguration Class Diagram

UnitOfMeasureConfiguration BPDHeader BPCNamespace : NamespaceIDType

(f rom Header Classes) Validation : String
1 1 1 PublishedDateTime : DateTimeType
Major : Integer
Minor : Integer
1 UnitOfMeasureConfigurationProperties <<optional>> SchemaVersion : String
UnitOfMeasureConfigurationBody Defaul tUOMSet : CDMIDType 1 1
1 1
1 UnitOfMeasureDefinition
BPCKe y
Description : DescriptionType (f rom BPC Common Classes)
QuantityTypeID : CDMIDType
0..n ID : CDMID Type
Factor : Double Name : BPC NameType
UOMD efinitionBase
Offset : Double GUID : GUIDType
ConversionType : Integer 1 1
<<optional>> UNStandard20Name : UNStd20UOMNameType 1
DisplayInformation
+Displ ayNa mes
Name : BPCNameType
BPCKe y
Qu anti tyType
BaseUOMID : CDMIDType ID : CDMID Type
0..n
DefaultUOMID : CDMIDType UOMD efinitionBase Name : BPC NameType
GUID : GUIDType
DimensionIndex : Integer
1 1
<<optional>> Formula : String 1
DisplayInformation
+Displ ayNa mes
Name : BPCNameType
1
1
1 UOMSet
UnitOfMeasureConfigurationDetails Des cri ption : Descri ptionType BPCKey
(f ro m BP C Common Clas se s)
1 0..n
1 ID : CDMIDType
QuantityTypeInSet UOMD efinitionBase Name : BPCNameTy...
ID : CDMIDType GUID : GUIDType
1 1
0..n Defa ultUOMID : CDMIDTyp e
1
1 Displ ayInformatio n
0..1 +DisplayNames
UOMList LocaleID : CDMIDType
<<list>> UOMID : CDMIDType
Name : BPCNameType
BPCKey
ID : CDMIDType
PseudoQuantityType UOMDefinitionBase Name : BPCNameType
Description : DescriptionType GUID : GUIDType
ParentID : CDMIDType 1 1
0..n 1
DefaultUOMID : CDMIDType
DisplayInformation
1
(f ro m B PC Common Cla sse s)
+DisplayNames
Lo cal eID : CD MIDType
0..n Bus ines sProcessID : CDMIDType
UOMList Name : BPC NameType
<<list>> UOMID : CDMIDType Descri ption : Descri ptionType
0..1
Diagram : structure for the UnitOfMeasureConfiguration message.
17.1.2 PseudoQuantityType
DEFINITION:
Some products have created groups of UOMs that are not really pure quantity types but have the same
characteristics as a pure quantity type. These groups are defined as Pseudo Quantity Types in the Common
Domain Model. An example of a pseudo quantity type is "small length". "small length" is the same
dimension as " length" but only UOMs used to describe relatively small lengths like millimeter or
centimeter, might be associated to the type "small length" as opposed to kilometer . a pseudo quantity type
has the same formula as its associated pure quantity type e.g. "Length" and "Small Length".
CHANGE LOG:
17.1.2.1 Attributes
Description DescriptionType Description of the pseudo quantity type
ParentID CDMIDType ID of the quantity type it belongs to
DefaultUOMID CDMIDType Default UOM ID of the pseudo quantity type
17.1.2.2 Relations
Reference Guides
PseudoQuantityType UOMList
(1) (0..1)
UnitOfMeasureConfigu PseudoQuantityType @xml:sequence 30
rationDetails (0..n)
()
17.1.3 QuantityType
DEFINITION:
The term quantity type is used in this document to refer indifferently to a pure quantity type or a pseudo
quantity type.
CHANGE LOG:
17.1.3.1 Attributes
Description DescriptionType Description of the quantity type
BaseUOMID CDMIDType ID of base UOM of the quantity type
DefaultUOMID CDMIDType Default UOM ID of the pseudo quantity type
DimensionIndex Integer Index that indicate whether the quantity type is a

fundamental dimension
Formula String Formula of fundamental dimensions of the quantity

type
17.1.3.2 Relations
Reference Guides
UnitOfMeasureConfigu QuantityType @xml:sequence 20
(1)
17.1.4 QuantityTypeInSet
DEFINITION
A class that holds a quantity type ID and a default UOM that is used as an entry in a UOM set.
CHANGE LOG:
17.1.4.1 Attributes
ID CDMIDType The common domain model assigns an internal
identifier to each object that is in the data base. This
identifier is sometimes called DBINDEX sometimes
called ID. It will be called ID throughout this
document. The ID is only unique within a data base.
DefaultUOMID CDMIDType ID of default UOM of the quantity type in the UOM

set
17.1.4.2 Relations
Reference Guides
QuantityTypeInSet UOMSet @xml:sequence 10
(0..n) (1)
QuantityTypeInSet UOMList
(1) (0..1)
17.1.5 UnitOfMeasureConfiguration
DEFINITION:
The root element of the UnitOfMeasureConfiguration message.
CHANGE LOG:
17.1.5.1 Relations
Reference Guides
UnitOfMeasureConfigu UnitOfMeasureConfigura @xml:sequence 20
ration tionBody
(1) (1)
UnitOfMeasureConfigu BPDHeader @xml:sequence 10
ration (1)
(1)
17.1.6 UnitOfMeasureConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
17.1.6.1 Relations
Reference Guides
rationBody tionProperties
(1) (1)
rationBody tionDetails
(1) (1)
ration tionBody
(1) (1)
17.1.7 UnitOfMeasureConfigurationDetails
DEFINITION:
PURPOSE:
information pertaining to unit of measure.
CHANGE LOG:
17.1.7.1 Relations
Reference Guides
UnitOfMeasureConfigu UnitOfMeasureDefinition @xml:sequence 10
(1)
rationBody tionDetails
(1) (1)
UnitOfMeasureConfigu UOMSet @xml:sequence 40
(1)
UnitOfMeasureConfigu PseudoQuantityType @xml:sequence 30
()
UnitOfMeasureConfigu QuantityType @xml:sequence 20
(1)
17.1.8 UnitOfMeasureConfigurationProperties
DEFINITION:
PURPOSE:
CHANGE LOG:
17.1.8.1 Attributes
DefaultUOMSet CDMIDType The default UOM set is the set that is assumed to be
in use for a particular CDM configuration.
17.1.8.2 Relations
Reference Guides
rationBody tionProperties
(1) (1)
UnitOfMeasureConfigu BPCVersionInformation
rationProperties (1)
(1)
17.1.9 UnitOfMeasureDefinition
DEFINITION
This class defines the basic information about a unit of measure. It is a subclass of Version.
CHANGE LOG:
17.1.9.1 Attributes
Description DescriptionType Description of the unit of measure
QuantityTypeID CDMIDType ID of the quantity type the UOM belongs to
Factor Double Conversion factor of the UOM to its base UOM of

the quantity type
Offset Double Conversion offset of the UOM to the base UOM of

the quantity type
ConversionType Integer Indicator of linear conversion or not.
UNStandard20Name UNStd20UOMName Standard United Nations name assigned to this Unit

Type of Measure.
17.1.9.2 Relations
Reference Guides
UnitOfMeasureConfigu UnitOfMeasureDefinition @xml:sequence 10
(1)
17.1.10 UNStd20UOMNameType
DEFINITION
Type used to size the UN20 unit of measure field.
CHANGE LOG:
BaseDataType String
MinLength Long Minimum length of the string 0
MaxLength Long Maximum length of the string 20
17.1.11 UOMDefinitionBase
17.1.11.1 Relations
Reference Guides
BPCKey UOMDefinitionBase @xml:sequence 10
(1) (1)
DisplayNames DisplayInformation UOMDefinitionBase @xml:sequence 20
(0..n) (1)
17.1.12 UOMList
List of all the UOMs defined by the CDM
CHANGE LOG:
UOMID CDMIDType ID of UOMs in the list
17.1.12.2 Relations
Reference Guides
QuantityTypeInSet UOMList
(1) (0..1)
PseudoQuantityType UOMList
(1) (0..1)
17.1.13 UOMSet
DEFINITION:
A Set is a group of quantity types and UOMs. The UOM component is distributed with several predefined
sets, one is the group of quantity types and UOMs defined in the international system (SI). Users can create
their own sets through the UOM Administrator. The UOM Administrator is part of the UOM Server
component and is not described in this document.
CHANGE LOG:
Description DescriptionType Description of the UOMSet
17.1.13.2 Relations
Reference Guides
QuantityTypeInSet UOMSet @xml:sequence 10
(0..n) (1)
UnitOfMeasureConfigu UOMSet @xml:sequence 40
(1)
18. BPCVersion.xsd
This package contains all message definitions associated with the Version BPC component. This namespace
contains a single message, "VersionConfiguration".
CHANGE LOG
18.1 Version Message

The VersionConfiguration message will be used to reload/load(hydrate) BPC version component with data
for the definition of version structures.
18.1.1 Diagrams
18.1.1.1 Version Message
BPDHeader
VersionConfiguration
1 1 1
1
VersionConfigurationBody
VersionConfigurationDetails
1
1
0..n BPCKey
Version De finition
CreationDateTime : DateTime... (from BPC Common Classes) Name : BPC NameTy...
1 1 GUID : GUIDType
1
1..n BPCHis toricalProperties

Versi onDefinitionHistorized Instance (f ro m B PC Common C la sse s)
MajorVersion : Integer StartDateTime : DateTimeType
MinorVersion : Integer EndDateTime : DateTimeType
ReleaseVersion : Integer 1 1 <<optional>> LastModifiedBy : HumanIDType
BranchVersion : Integer <<optional>> LastModifiedDateTime : DateTime...
Approved : CDMIDType <<optional>> ApprovedBy : HumanIDType
Status : CDMIDType <<optional>> ApprovedDateTime : DateTimeTyp...
1 1
DisplayInformation
(f rom BPC Co mmon Classes)
+DisplayNames Local eID : CD MIDType
Busin essPro cessID : CDMID...
0..n Na me : BPC NameType
De scri ptio n : Des cri ption Type
Cl assAttrib uteInstance
(f rom BPC Co mmon Clas ses) BPCQuantity
+ClassAttributes
ClassID : CDMIDType (f rom BPC Common Classes)
0..n UniqueID : CDMIDTyp... <<optional>> ValueString : String
ParentHashCode : Lo... 1..n <<optional>> Index : Integer
BPCQuantity
1
Attri buteInsta nce <<optional>> ValueString : String
0..n
(f rom BPC Common Classes) <<optional>> Index : Integer
+Attributes AttributeID : CDMIDT... DataType : DataTypeType
Diagram : structure for the VersionConfiguration message.

18.1.2 VersionConfiguration
DEFINITION:
Root element of the VersionConfiguration message.
CHANGE LOG:
18.1.2.1 Relations
Reference Guides
VersionConfigurationB VersionConfiguration @xml:sequence 20
ody (1)
(1)
BPDHeader VersionConfiguration @xml:sequence
(1) (1) 10@xml:sequence 10
18.1.3 VersionConfigurationBody
DEFINITION:
PURPOSE:
CHANGE LOG:
18.1.3.1 Relations
Reference Guides
VersionConfigurationB VersionConfiguration @xml:sequence 20
ody (1)
(1)
VersionConfigurationD VersionConfigurationBod @xml:sequence 20
etails y
(1) (1)
18.1.4 VersionConfigurationDetails
DEFINITION:
PURPOSE:
alias data.
CHANGE LOG:
18.1.4.1 Relations
Reference Guides
VersionDefinition VersionConfigurationDet @xml:sequence 10
(0..n) ails
(1)
VersionConfigurationD VersionConfigurationBod @xml:sequence 20
etails y
(1) (1)
18.1.5 VersionDefinition
DEFINITION:
Encompasses the definition of a version of the BPC component configuration.
CHANGE LOG:
18.1.5.1 Attributes
18.1.5.2 Relations
Reference Guides
VersionDefinitionHisto VersionDefinition @xml:sequence 10
rizedInstance (1)
(1..n)
VersionDefinition VersionConfigurationDet @xml:sequence 10
(0..n) ails
(1)
18.1.6 VersionDefinitionHistorizedInstance
DEFINITION:
The elements of a VersionDefinition that are required to contain a history.
CHANGE LOG:
18.1.6.1 Attributes
MajorVersion Integer Uniquely identifies the user who created the object
MinorVersion Integer Data and time when the object was created
ReleaseVersion Integer Release number associated with the published data
BranchVersion Integer Branch number associated with the published data.

(Same idea as branches in clearcase)
Approved CDMIDType Approved state of the data (NotApproved, Validated,

Approved)
Status CDMIDType Status of the data (Pending, Published, Obsolete)
18.1.6.2 Relations
Reference Guides
DisplayNames DisplayInformation VersionDefinitionHistoriz @xml:sequence 20
(0..n) edInstance
(1)
BPCHistoricalPropertie VersionDefinitionHistoriz @xml:sequence 10
s edInstance
(1) (1)
VersionDefinitionHisto VersionDefinition @xml:sequence 10
rizedInstance (1)
(1..n)
ClassAttributes VersionDefinitionHisto ClassAttributeInstance @xml:sequence 30
(1)
Attributes VersionDefinitionHisto AttributeInstance @xml:sequence 40
()

BPCMSG Ref Guide RPT

Încărcat de

Informații document

Descriere originală:

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

BPCMSG Ref Guide RPT

Încărcat de

Drepturi de autor:

Formate disponibile

Aspen

14. BPCMaterialLots.xsd 113

15. BPCPersonnel.xsd 121

16. BPCPhysicalProperty.xsd 126

17. BPCUnitOfMeasure.xsd 132

18. BPCVersion.xsd 141

1.3 Definitions, Acronyms, and Abbreviations

1.5.1 Class Descriptions

ATTRIBUTES & RELATIONS

v1.4.0.0 - Added Copyright Information to the Schema File.

v1.0.0.0 - Initial release

2.1 Alias Configuration Message

2.1.1.1 AliasConfiguration Class Diagram

Material : String Bas eDa taType : Stri ng

Diagram : Structure for the AliasConfiguration message.

v1.0.0.0 - Initial release

AliasNamespace NamespaceIDType namespace of the alias key

Name AliasNameType name of the alias key

2.2 Alias Configuration types

MaxLength Integer 200

3.1 Allocation Configuration Message

3.1.1.1 Allocation Configuration Message

Diagram : Structure for the AliasConfiguration message.

v5.0.0.14 - Initial release

Description DescriptionType additional information describing the allocation.

AllocationDefinitionID CDMIDType A reference back to the Allocation Definition with

StartDateTime DateTimeType Start of the resource allocation period.

EndDateTime DateTimeType End of the resource allocation period.

ExternalKey String can be used by applications to store some meaningful

CreatedBy HumanIDType User that created the resource allocation.

CreationDateTime DateTimeType timestamp of when resource allocation was made.

LastModifiedBy HumanIDType User that last modified the resource allocation.

LastModifiedDateTime DateTimeType timestamp of when resource allocation was last

AllocationStatusID CDMIDType Status of the resource allocation.

v5.0.0.14 - Added DisplayNames structure.

v1.4.0.0 - Added Copyright Information to the Schema File.

v1.0.0.0 - Initial release

4.1 Attributes configuration Message

1..n StartDateTime : DateTimeType

Local eID : CD MIDType

ID : IDType <<optional>> ValueString : String

(f rom BPC Common Classes) ItemComponentID : CDMIDType

Diagram : structure for the AttributeConfiguration message.

5.1 Class Configuration

ParentClassID : CDMIDType 1 0..1 StartDateTime : DateTimeType

L ocal eID : CD MIDType

Cl assAttri bute Map Entry

ItemCo mpone ntID : CDMIDType

Diagram : Structure for the ClassConfiguration message.

DefaultValue String the default value for this attribute.

Required Boolean When applying this attribute, is a value optional or

IsArray Boolean Is the attribute an array of values

DataType DataTypeType The data type of the attribute as defined by

OtherDataType String A string defining a custom data type not defined in

ReferenceClassID CDMIDType The ID of a Class Definition that being used to

QuantityTypeID CDMIDType Quantity type of the attribute

DefaultUnitOfMeasureID CDMIDType Default unit of measure of the attribute

MinimumValue Double Attribute minimum value

MaximumValue Double Attribute maximum value

ClassID CDMIDType ID of the Class Definition that this map entry is

ClassAttributeID CDMIDType ID of the Class Attribute this map entry represents

EmbeddedClassID CDMIDType ID of the Class Definition if this Class Attribute is