The effectiveTime
| Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
and
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | active |
|---|
|
fields in the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | release file |
|---|
|
enable the use of a "log style" append-only data model to track all changes to each
, providing full traceability. Once released, a row in any of these files will always remain unchanged. Historic data is supplied in the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | RF2 |
|---|
|
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | release files, |
|---|
|
dating back to the first release in
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | RF1 |
|---|
|
format in 2002.
In order to change the properties of a current
(and, therefore, to create a a new version of
it), that component is created with the same identifier. This done by adding a new row
is added to the
applicable relevant release file,
containing with the
updated fields, with the column values updated to represent the changes. The | Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | active |
|---|
|
field
must be set to true and the timestamp in the
effectiveTime | Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
field indicating the nominal date on which the new version was released
. Note that the existing row is not changed in any way.
To inactivate a
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | component, |
|---|
|
a new row is added, containing the same data as the final valid version of the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | component, |
|---|
|
but with the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | active |
|---|
|
field set to false and the timestamp in the
effectiveTime | Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
fi eld indicating the nominal date of the release in which the final version ceased being valid.
Note again that the existing row is not changed in any way.Where editorial policy does not allow a particular property of a
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | component |
|---|
|
to be changed whilst keeping the same
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | Identifier, |
|---|
|
the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | component |
|---|
|
as a whole is inactivated (as described above), and a new row added with a new id, the
effectiveTime | Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
set to the nominal date of the release in which this version of the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | component |
|---|
|
became valid, and the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | active |
|---|
|
field set to true.
It is thus possible to see both the current values and any historical values of a
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | component |
|---|
|
at any point in time.
New content, changes and inactivations must have the
| Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
for Content will not be future dated with respect to the release that it appears in
, although a release itself may be released a few days before its nominal release date. . Pre-releases for testing may set the effectiveTime as the date of the future scheduled release but in general the effectiveTime must not be later that the scheduled release data, Where there is a business requirement for specifying a future activation date for some
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | components, |
|---|
|
this may be
modeled represented using
| Gloss |
|---|
| PreSpace | false |
|---|
| t | reference sets. |
|---|
|
The following example demonstrates how the history mechanism works on the Concept file
, but the same rules apply equally well to the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | Description, |
|---|
|
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | Relationship |
|---|
|
and
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | Reference set |
|---|
|
member files. In this example, the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | descriptions |
|---|
|
associated with the
moduleId and definitionStatusId and | Specref |
|---|
| RefType | (field) |
|---|
| t | definitionStatusId |
|---|
|
have been shown in place of their
SCTID values.
A new
(101291009) is ad ded on the 1st July 2007:
| Caption label |
|---|
| CapId | -history-example-concept-added |
|---|
| CapType | Table |
|---|
|
History Example - Concept Added |
Id | effectiveTime | | moduleId | definitionStatusId | (field) | | t | definitionStatusId |
|---|
|
|
|---|
101291009 | 20070701 | 1 | | | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
|
In the next following release (on 1st January 2008), the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | concept |
|---|
|
is moved from |Module 1| to |Module 2|. Because the moduleId field is not immutable, the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | concept |
|---|
|
may be updated simply by adding a new record with the same Id.
| Caption label |
|---|
| CapId | history-example-module-change |
|---|
| CapType | Table |
|---|
|
History Example - Module Change |
Id | effectiveTime | | moduleId | definitionStatusId | (field) | | t | definitionStatusId |
|---|
|
|
|---|
101291009 | 20070701 | 1 | | | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
|
101291009 | 20080101 | 1 | | | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
|
In the next following release (on 1st July 2008), the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | concept |
|---|
|
is changed from being
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | Primitive |
|---|
|
to being
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | Fully defined. |
|---|
|
| Caption label |
|---|
| CapId | history-example-definition-status-changed |
|---|
| CapType | Table |
|---|
|
History Example - Definition Status Changed |
Id | Id | effectiveTime | | moduleId | definitionStatusId | (field) | | t | definitionStatusId |
|---|
|
|
|---|
101291009 | 20070701 | 1 | | | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
|
101291009 | 20080101 | 1 | | | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
|
101291009 | 20080701 | 1 | | | Concept |
|---|
| t | 900000000000073002|Defined| |
|---|
|
|
In the next following release (on 1st January 2009), the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | concept |
|---|
|
is deactivated:
| Caption label |
|---|
| CapId | history-example-concept-made-inactive- |
|---|
| CapType | Table |
|---|
|
History Example - Concept Made Inactive |
Id | effectiveTime | | moduleId | definitionStatusId | (field) | | t | definitionStatusId |
|---|
|
|
|---|
101291009 | 20070701 | 1 | | | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
|
101291009 | 20080101 | 1 | | | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
|
101291009 | 20080701 | 1 | | | Concept |
|---|
| t | 900000000000073002|Defined| |
|---|
|
|
101291009 | 20090101 | 0 | | | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
|
Notes
At no stage in this process are previously written records ever amended. Once a record has been released in a
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | release file, |
|---|
|
it will continue to be released in exactly the same form in future | Gloss |
|---|
| PreSpace | false |
|---|
| t | release files. |
|---|
|
Changes are only recorded at the point of release in the
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | RF2 |
|---|
|
| Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | release files. |
|---|
|
If a | Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | component |
|---|
|
record is changed a number of times between releases (during an edit and review process), only the most recently amended record will be appended to the | Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | release file, |
|---|
|
not individual records showing each separate edit to the released In the last example, as well as inactivating the concept (active=0), the definitionStatusId
| Specref |
|---|
| RefType | (field) |
|---|
| t | definitionStatusId |
|---|
|
is changed from | Concept |
|---|
| t | 900000000000073002|Defined| |
|---|
| ShowFormat | inline |
|---|
|
to to | Concept |
|---|
| t | 900000000000074008|Primitive| |
|---|
|
. In practice this change is not essential since the value of data columns is ignored when a | Gloss |
|---|
| SpacePreSpace | truefalse |
|---|
| t | component |
|---|
|
is inactive. Although the change is unnecessary and insignificant, it typically occurs since all the relationships of an inactive concept must also be inactive, and as a result, from the perspective of the authoring environment the concept cannot be regarded as | Concept |
|---|
| t | 900000000000073002|Defined| |
|---|
|
.
Related Links
...
.
...