Search



Versions Compared

Key

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

The effectiveTime

Specref
RefType(field)
andfields in theenable
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 informat in
Gloss
PreSpacefalse
tRF1
format in 2002.

In order to change the properties of a current (and, therefore, to create a new version of it), a new row is added to the applicable file, containing the updated fields, with thefield

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 effectiveTime
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 thefield the
Gloss
PreSpacefalse
tactive
field set to false and the timestamp in the effectiveTime
Specref
RefType(field)
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 ato a

Gloss
PreSpacefalse
tcomponent
to be changed whilst keeping the same , theas
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 effectiveTime
Specref
RefType(field)
teffectiveTime
set to the nominal date of the release in which this version of thebecame the
Gloss
PreSpacefalse
tcomponent
became valid, and thefield the
Gloss
PreSpacefalse
tactive
field set to true.

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

Gloss
PreSpacefalse
tcomponent
at any point in time.

Content will not be future dated with respect to New content, changes and inactivations must have the

Specref
RefType(field)
teffectiveTime
 for 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
PreSpacefalse
tcomponents,
this may be modeled usingrepresented using
Gloss
PreSpacefalse
treference sets.

The following example demonstrates how the history mechanism works on the Concept file

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

A new

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

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


Table 4. History Example - Concept Added

Id

Specref
RefType(field)
teffectiveTime

 

Gloss
PreSpacefalse
tactive
 

Specref
RefType(field)
tmoduleId

Specref
RefType(field)
tdefinitionStatusId

Anchor
_5d98c53f-d493-4e95-b096-c42ccaf12d93__e_5d98c53f-d493-4e95-b096-c42ccaf12d93__e

 

 

 

 

Id

effectiveTime (field)

  

moduleId (field)

definitionStatusId (field)

101291009

20070701

1

scg-expression

Concept
ShowParts
t
term
|Module
1|
scg-expression

Concept
ShowParts
t
id+term
900000000000074008|Primitive|

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

Gloss
PreSpacefalse
tconcept
is moved from |Module 1| to |Module 2|. Because the moduleIdfield moduleId field is not immutable, themay 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


Table 5. History Example - Module Change

Id

Specref
RefType(field)
teffectiveTime

 

Gloss
PreSpacefalse
tactive
 

Specref
RefType(field)
tmoduleId

Specref
RefType(field)
tdefinitionStatusId

Anchor
_5d98c53f-d493-4e95-b096-c42ccaf12d93__a_5d98c53f-d493-4e95-b096-c42ccaf12d93__a

 

 

 

 

Id

effectiveTime (field)

  

moduleId (field)

definitionStatusId (field)

101291009

20070701

1

scg-expression

Concept
ShowParts
t
term
|Module
1|
scg-expression

Concept
ShowParts
t
id+term
900000000000074008|Primitive|

101291009

20080101

1

scg-expression

Concept
ShowParts
t
term
|Module
2|
scg-expression

Concept
ShowParts
t
id+term
900000000000074008|Primitive|

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

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

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


Table 6. History Example - Definition Status Changed

Id

Specref
RefType(field)
teffectiveTime

 

Gloss
PreSpacefalse
tactive
 

Specref
RefType(field)
tmoduleId

Specref
RefType(field)
tdefinitionStatusId

Anchor
_5d98c53f-d493-4e95-b096-c42ccaf12d93__0_5d98c53f-d493-4e95-b096-c42ccaf12d93__0

 

 

 

 

Id

effectiveTime (field)

  

moduleId (field)

definitionStatusId (field)

 

101291009

20070701

1

scg-expression

Concept
ShowParts
t
term
|Module
1|

  Scg expressionShowPartsid+term

Concept
t900000000000074008|Primitive|

 

 

101291009

20080101

1

scg-expression

Concept
ShowParts
t
term
|Module
2|
Scg expressionShowPartsid+term

Concept
t900000000000074008|Primitive|

 

101291009

20080701

1

Concept
t
Scg expressionShowPartsterm
|Module
2|
Scg expressionShowPartsid+term

Concept
t900000000000073002|Defined|

 

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

Gloss
PreSpacefalse
tconcept
is deactivated:

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


Table 7. History Example - Concept Made Inactive

Id

Specref
RefType(field)
teffectiveTime

 

Gloss
PreSpacefalse
tactive
 

Specref
RefType(field)
tmoduleId

Specref
RefType(field)
tdefinitionStatusId

Anchor
_5d98c53f-d493-4e95-b096-c42ccaf12d93__5_5d98c53f-d493-4e95-b096-c42ccaf12d93__5

 

 

 

 

Id

effectiveTime (field)

  

moduleId (field)

definitionStatusId (field)

 

101291009

20070701

1

scg-expression

Concept
ShowParts
t
term
|Module
1|
Scg expressionShowPartsid+term

Concept
t900000000000074008|Primitive|

 

101291009

20080101

1

Concept
t
Scg expressionShowPartsterm
|Module
2|
scg-expression

Concept
ShowParts
t
id+term
900000000000074008|Primitive|

 

101291009

20080701

1

scg-expression

Concept
ShowParts
t
term
|Module
2|
Scg expressionShowPartsid+term

Concept
t900000000000073002|Defined|

 

101291009

20090101

0

Concept
t
Scg expressionShowPartsterm
|Module
2|
scg-expression

Concept
ShowParts
t
id+term
900000000000074008|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 arecord
    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 definitionStatusId

    Specref
    RefType(field)
    tdefinitionStatusId
    is changed from scg-expression
    Concept
    ShowParts
    t
    id+term
    900000000000073002|Defined|
    to Scg expressionShowPartsid+term
    ShowFormatinline
     to
    Concept
    t900000000000074008|Primitive|
    . In practice this change is not essential since the value of data columns is ignored when ais 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 id+term
    Scg expression
    ShowParts
    Concept
    t900000000000073002|Defined|
    .

Related Links

...