Purpose
The
900000000000456007 |Reference set descriptor|
is a
that used to specify the format of all
included in a release. The data type and meaning of the referenced component and
each additional field within each
is described by this
.
descriptor can be used to define
- The order of appearance of additional attributes (other than those mandatory for all
); - The name and purpose of the additional attributes;
- The data types for the additional attributes.
This allows for a
to be validated using the metadata embedded within the
descriptor in the following ways:
- the data type of its attributes may be validated against the data type declared in
the
descriptor; - the column order can be checked against the
descriptor.
Data structure
The
is a
-
- Integer
that specifies the structure of reference sets. Its structure is shown in the following
table.
|
Table 17. Reference set descriptor reference set - Data structure |
|
|
|---|---|---|
|
Field |
Data type |
Purpose |
|
A 128 bit unsigned
Integer (data type), uniquely identifying this
Different versions of a reference set member share the same id (field) but have different effectiveTime (field). This allows a reference set member to be modified or made active (field) (i.e. removed from the active set) at a specified time. |
||
|
The inclusive date or time at which this version of the identified
The current version of this
|
||
|
The state of the identified
If
active (field) = 1 (true) the
|
||
|
Identifies the
The value must be a
|
||
|
Identifies the
In this case, set to 900000000000456007 |Reference set descriptor| |
||
|
Identifies the
Set to a
|
||
|
Specifies the name of an attribute that is used in the
Set to a
|
||
|
Specifies the data type of this attribute in the
Set to a
|
||
|
Specifies the position of this attribute in the
An unsigned
Integer (data type), providing an ordering for the additional attributes extending the
|
At least one row must exist for each
included in a release. This row must have an
attributeOrder (field) value of '0' and an
attributeType (field) of '
type' (or one of its
). The
referencedComponentId (field) identifies the
defined by the descriptor.
There is one additional row for each additional column present in the specified
.
Creation of
descriptor data is mandatory when creating a new
in the
or in a
.
Creation of a
descriptor is optional when creating a
in another
. If a descriptor is not created, the descriptor of the closest
of the
is used when validating
member records.
Metadata
The following metadata in the |Foundation metadata
|
supports the
descriptor
.
The
Descriptor
is specified by the
900000000000456007 |Reference set descriptor|
in the metadata hierarchy.
Figure 6. Reference Set Descriptor Concept in the Metadata Hierarchy
Values in the
are populated from:
Figure 7. Reference Set Attribute Metadata Hierarchy
Descriptor
The table below shows the descriptor that defines the structure of the 900000000000456007 |Reference set descriptor| .
|
Table 18. Refset Descriptor rows for 900000000000456007 |Reference set descriptor| . |
|
|
|
|
|
|---|---|---|---|---|---|
|
refsetId |
referencedComponentId (Referenced component) |
attributeDescription (Attribute description) |
attributeType (Attribute type) |
attributeOrder (Attribute order) |
|
|
0 |
|
||||
|
1 |
|
||||
|
2 |
|
||||
|
3 |
|
Note: The table above omits the initial four columns of data present in the release
file. These follow the standards versioning pattern
id (field),
effectiveTime (field),
active (field),
active (field). Additionally, to aid understanding, the table above also includes the
from one of the
associated with each of the identified
. The release file only contains the
.
Feedback
Overview
Content Tools
Apps