Search



Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The

Specref
RefType(field)
teffectiveTime
and
Gloss
PreSpacefalse
tactive
fields in the
Gloss
PreSpacefalse
trelease file
enable the use of a "log style" append-only data model to track all changes to each
Gloss
PreSpacefalse
tcomponent
, providing full traceability. Once released, a row in any of these files will always remain unchanged. Historic data is supplied in the
Gloss
PreSpacefalse
tRF2
Gloss
PreSpacefalse
trelease files,
dating back to the first release in
Gloss
PreSpacefalse
tRF1
format in 2002.

In order to change the properties of a current

Gloss
PreSpacefalse
tcomponent
 a new version of that component is created with the same identifier. This done by adding a new row to the relevant release file, with the column values updated to represent the changes. The
Gloss
PreSpacefalse
tactive
field must be set to true and the timestamp in the
Specref
RefType(field)
teffectiveTime
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
PreSpacefalse
tcomponent,
a new row is added, containing the same data as the final valid version of the
Gloss
PreSpacefalse
tcomponent,
but with the
Gloss
PreSpacefalse
tactive
field set to false and the timestamp in the
Specref
RefType(field)
teffectiveTime
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
PreSpacefalse
tcomponent
to be changed whilst keeping the same
Gloss
PreSpacefalse
tIdentifier,
the
Gloss
PreSpacefalse
tcomponent
as a whole is inactivated (as described above), and a new row added with a new id, the
Specref
RefType(field)
teffectiveTime
set to the nominal date of the release in which this version of the
Gloss
PreSpacefalse
tcomponent
became valid, and the
Gloss
PreSpacefalse
tactive
field set to true.

It is thus possible to see both the current values and any historical values of a

Gloss
PreSpacefalse
tcomponent
at any point in time.

New content, changes and inactivations must have the

Specref
RefType(field)
teffectiveTime
 for the release that it appears in. 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
PreSpacefalse
tcomponents,
this may be represented using
Gloss
PreSpacefalse
treference sets.

The following example demonstrates how the history mechanism works on the

Specref
RefTypefile
tConcept
, but the same rules apply equally well to the
Gloss
PreSpacefalse
tDescription,
Gloss
PreSpacefalse
tRelationship
and
Gloss
PreSpacefalse
tReference set
member files. In this example, the
Gloss
PreSpacefalse
tdescriptions
associated with the
Specref
RefType(field)
tmoduleId
and
Specref
RefType(field)
tdefinitionStatusId
have been shown in place of their
Specref
RefType(data type)
tSCTID
values.

A new

Gloss
PreSpacefalse
tconcept
 (101291009) is ad ded on the 1st July 2007:

Caption label
CapId-history-example-concept-added
CapTypeTable
 History Example - Concept Added

Id

Specref
RefType(field)
teffectiveTime

 

Gloss
PreSpacefalse
tactive
 

Specref
RefType(field)
tmoduleId

Specref
RefType(field)
tdefinitionStatusId

101291009

20070701

1

Concept
t|Module 1|

Concept
t900000000000074008|Primitive|

In the following release (on 1st January 2008), the

Gloss
PreSpacefalse
tconcept
is moved from |Module 1| to |Module 2|. Because the moduleId field is not immutable, the
Gloss
PreSpacefalse
tconcept
may be updated simply by adding a new record with the same Id.

Caption label
CapIdhistory-example-module-change
CapTypeTable
History Example - Module Change

Id

Specref
RefType(field)
teffectiveTime

 

Gloss
PreSpacefalse
tactive
 

Specref
RefType(field)
tmoduleId

Specref
RefType(field)
tdefinitionStatusId

101291009

20070701

1

Concept
t|Module 1|

Concept
t900000000000074008|Primitive|

101291009

20080101

1

Concept
t|Module 2|

Concept
t900000000000074008|Primitive|

In the following release (on 1st July 2008), the

Gloss
PreSpacefalse
tconcept
is changed from being
Gloss
PreSpacefalse
tPrimitive
to being
Gloss
PreSpacefalse
tFully defined.

Caption label
CapIdhistory-example-definition-status-changed
CapTypeTable
History Example - Definition Status Changed

Id

Specref
RefType(field)
teffectiveTime

 

Gloss
PreSpacefalse
tactive
 

Specref
RefType(field)
tmoduleId

Specref
RefType(field)
tdefinitionStatusId

101291009

20070701

1

Concept
t|Module 1|

Concept
t900000000000074008|Primitive|

101291009

20080101

1

Concept
t|Module 2|

Concept
t900000000000074008|Primitive|

101291009

20080701

1

Concept
t|Module 2|

Concept
t900000000000073002|Defined|

In the following release (on 1st January 2009), the

Gloss
PreSpacefalse
tconcept
is deactivated:

Caption label
CapIdhistory-example-concept-made-inactive-
CapTypeTable
History Example - Concept Made Inactive 

Id

Specref
RefType(field)
teffectiveTime

 

Gloss
PreSpacefalse
tactive
 

Specref
RefType(field)
tmoduleId

Specref
RefType(field)
tdefinitionStatusId

101291009

20070701

1

Concept
t|Module 1|

Concept
t900000000000074008|Primitive|

101291009

20080101

1

Concept
t|Module 2|

Concept
t900000000000074008|Primitive|

101291009

20080701

1

Concept
t|Module 2|

Concept
t900000000000073002|Defined|

101291009

20090101

0

Concept
t|Module 2|

Concept
t900000000000074008|Primitive|

Notes

  1. At no stage in this process are previously written records ever amended. Once a record has been released in a

    Gloss
    PreSpacefalse
    trelease file,
    it will continue to be released in exactly the same form in future
    Gloss
    PreSpacefalse
    trelease files.

  2. Changes are only recorded at the point of release in the

    Gloss
    PreSpacefalse
    tRF2
    Gloss
    PreSpacefalse
    trelease files.
    If a
    Gloss
    PreSpacefalse
    tcomponent
    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
    PreSpacefalse
    trelease file,
    not individual records showing each separate edit to the released
    Gloss
    PreSpacefalse
    tcomponent.

  3. In the last example, as well as inactivating the concept (active=0), the

    Specref
    RefType(field)
    tdefinitionStatusId
    is changed from
    Concept
    t900000000000073002|Defined|
    ShowFormatinline
     to
    Concept
    t900000000000074008|Primitive|
    . In practice this change is not essential since the value of data columns is ignored when a
    Gloss
    PreSpacefalse
    tcomponent
    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
    t900000000000073002|Defined|
    .

Related Links