Component

Warning

This is a draft claim field set currently in development. The format described in this documentation is a proposed format which may change with further research and development.

The Component claim type captures how Materiel may include other Materiel, for example the targeting system in a particular type of aircraft.

Component: Summary of claim attributes

The table below summarizes the following dimensions of Component claims:

Attribute label: a human readable label for the attribute

Status: whether the attribute is optional or required in a claim

Data type: the sort of data that can be entered into the attribute

Key name: a standardized name that simplifies attribute use in SFM databases

Attribute label	Status	Data type	Key name
type:claim	required	string	`:claim/type`
status:meta	required	string	`:claim/statuses`
researcher:meta	required	string	`:meta/researchers`
internal_comments:meta	optional	string	`:meta/internal-comments`
citation:refs:claim	required	strings<->uuids	`:claim/citation:refs`
about_entity:ref:claim	required	string<->uuid	`:claim/about-entity:ref`
about_entity:name:qa	optional	string	n/a
component:materiel:refs:assertion	required	uuid-string	proposed
component:materiel:names:qa	optional	string	n/a
component:types:assertion	required	string	proposed
component:aggregate_materiel:refs:assertion	required	string<->uuid	proposed
component:aggregate_materiel:names:qa	optional	string	n/a
first_precise:range	optional	string-date	`:range-precise/first`
last_precise:range	optional	string-date	`:range-precise/last`
first_imprecise:range	optional	string-date	`:range-imprecise/first`
last_imprecise:range	optional	string-date	`:range-imprecise/last`
starting:range	required	YN<->bool	`:range/starting?`
ending:range	required	YN<->bool	`:range/ending?`
starting_context:range	optional	string	`:range/starting-context`
ending_context:range	optional	string	`:range/ending-context`
public_notes:meta	optional	string	`:meta/public-notes`
type:entity	required	string	`:entity/type`

Component: Details of claim attributes

This section contains further information about each attribute, including descriptions, examples of use, and Guidance on use.

type:claim

Description

A field that defines what type of claim is being made.

Attribute type

Text string

Status

This attribute is required.

Key name

:claim/type

Example of use

materiel, equipment, component

Guidance on use

Entering component defines the claim and defines the relevant fields to be used in further data entry about a Component. For quality assurance purposes, entering component should create an error if there is any entry for fields tied to other claim types, such as Materiel or Equipment.

status:meta

Description

A field that classifies the data in the claim.

Attribute type

Text string

Status

This attribute is required.

Key name

:claim/statuses

Example of use

accepted, conflict, work_needed, issue

Guidance on use

Claims are marked accepted when all of the data can be entered in accordance with the guidance of this handbook. The conflict flag is used whenever a claim conflicts with another claim (or claims) and a review of citations show it to be the incorrect or false claim (see Citations with both Accepted and Conflicted Information for guidance when one claim from a citation contains both accepted and conflict information). A public_notes:meta should always accompany any conflict claim.

If the data itself cannot be brought into the SFM standard the flag issue should be used. Finally, if the current citations cannot establish whether a claim should be flagged as accepted or conflict then the flag work_needed should be used as additional research is needed.

researcher:meta

Description

Field for initials or other identifier of researcher who last entered data for the claim.

Attribute type

Text string

Status

This attribute is required.

Key name

:meta/researchers

Example of use

TW, Jane_Doe, G1

Guidance on use

Every researcher should use this field to mark the claims that they have entered. Anytime a researcher modifies any data for an existing claim they should update this field so that any questions can be directed to the right person and the flow of work can be better tracked.

internal_comments:meta

Description

A field for temporary comments or notes for the researcher or research team working on the claim.

Attribute type

Text string

Status

This attribute is optional.

Key name

:meta/internal-comments

Example of use

Come back to this to determine date for claim

Guidance on use

Researchers may use this field to make temporary notes or leave temporary comments intended for others in the research team about a claim. These should eventually be addressed and the field cleared by the researcher or research team. If the claim needs an explanatory note or comment to be better understood, then that should be entered in the public_notes:meta field.

citation:refs:claim

Description

Field unique 32 character code assigned to citation(s) evidencing the claim.

Attribute type

String in UUID format

Status

This attribute is required.

Key name

:claim/citation:refs

Example of use

69dba35b-2b70-47cf-bfda-f80225f652c6, 4e99308c-f9c0-49e8-b97b-14c1e7bcb99d;bedf57b2-c20b-41e3-9dcf-b7b065eaa3b7

Guidance on use

Every claim must have at least one citation to evidence the data in the claim. When two or more citations are needed to evidence a claim then a corresponding explanatory note should be entered in the public_notes:meta field. This field is for the Universally Unique Identifier (UUID) for each citation, found in the source:access_point_id:admin field in the Sources sheet. When multiple citations are needed every UUID should be semi-colon separated.

about_entity:ref:claim

Description

A unique 32 character code assigned to each entity in the dataset.

Attribute type

String in UUID format

Status

This attribute is required.

Key name

:claim/about-entity:ref

Example of use

521ebf18-f161-4ac9-8c72-5a246efa0458

Guidance on use

Every entity has a Universally Unique Identifier (UUID) to distinguish it from any other entity. For a Component this UUID distinguishes them from any other Component in the dataset.

about_entity:name:qa

Description

Field that provides human readable name for claim.

Attribute type

Text string

Status

This attribute is optional.

Key name

n/a

Example of use

n/a - proposed field

Guidance on use

This field provides a human readable counterpart to the about_entity:ref:claim which combines the various elements of the claim into a single text field. This field can be manually added by a researcher or automatically populated by the system after import.

component:materiel:refs:assertion

Description

The unique 32 character code of the materiel which is a component of other materiel.

Attribute type

String in UUID format.

Status

This attribute is required.

Key name

n/a - proposed field

Example of use

b00ff36f-f367-4a48-9497-897d77decb8ad

Guidance on use

The UUID used in component:materiel:refs:assertion must be for Materiel that already exists in the dataset.

component:materiel:names:qa

Description

The human readable name of the materiel which is a component of other materiel.

Attribute type

Text string.

Status

This attribute is optional.

Key name

n/a - proposed field

Example of use

GBU-12

Guidance on use

This field provides a human readable counterpart to the component:materiel:refs:assertion field. This field can be manually added by a researcher or automatically populated by the system after import. Best practice for this field is to use the name:annotation of the Materiel in the component:materiel:refs:assertion field.

component:types:assertion

Description

The type of relationship that exists between the materiel.

Attribute type

String from controlled list.

Status

This attribute is required.

Key name

n/a - proposed field

Example of use

component-of

Guidance on use

We use this field to define the nature of the relationship between the Materiel that is the subject of the claim (as described in component:materiel:refs:assertion) and the other Materiel described in component:aggregate_materiel:refs:assertion. The only value that can be used by the researcher in this attribute is component-of. As this is a draft field the number of possible entries in this field may increase. The field may also prove redundant and be removed in future updates.

component:aggregate_materiel:refs:assertion

Description

The unique 32 character code of the materiel which is made up of the component.

Attribute type

String in UUID format.

Status

This attribute is required.

Key name

n/a - proposed field

Example of use

ca19cc03-1180-469d-b87a-94fb54d657fb

Guidance on use

The UUID used in component:aggregate_materiel:refs:assertion must be for Materiel which already exists in the dataset.

component:aggregate_materiel:names:qa

Description

The human readable name of the materiel which is made up of the component materiel.

Attribute type

Text string.

Status

This attribute is optional.

Key name

n/a

Example of use

MiG-21UM

Guidance on use

This field provides a human readable counterpart to the component:aggregate_materiel:refs:assertion field. This field can be manually added by a researcher or automatically populated by the system after import. Best practice for this field is to use the name:annotation of the Materiel in the component:aggregate_materiel:refs:assertio field.