How to Specify the Creation of New SANA Registries

The procedures for SANA registry specifications are described in the CCSDS Yellow Book 313.2-Y-2.

The CCSDS document requesting the creation of a new registry must define which one of the following registration rules is to be used for adding new entries or for making changes to the registry:

1. Change requires a CCSDS approved document.
2. Change requires an engineering review by a designated expert. The expert for that registry is assigned by the CESG based on the WG recommendation.
3. Change requires no engineering review, but the request must come from the official representative of a space agency that is a member of the CCSDS. The official representative of an agency may differ for each registry.
4. Change requires no review; assignments are done on a first-come, first-served basis.

In the CCSDS document that defines the creation of a registry, the registration rule for that registry must be defined either within the above set of rules or by another rule. This restriction provides guidance to SANA on how to make assignments of new parameters for that registry. The identification of this rule is part of the template included in the SANA Considerations section of the document.

The following lists the suggested SANA Considerations section proposed for inclusion in CCSDS standards track documents.

NO SANA ACTION

When there are no SANA action, the following text is suggested to be included into the CCSDS standards track document.

SANA Considerations

The recommendations of this document do not require any action from SANA.

NEW REGISTRY TO BE CREATED

When a new registry is requested to be created by SANA, the following information should be included into the CCSDS standards track document.

A SANA Considerations section for each new registry should contain:

1. the name of the registry
2. the structure of the registry (column names, …)
3. a precise data type for each data, including boundaries
4. registration rule governing how SANA will assign new parameters to that registry.

This text below is an example and should be adapted to the appropriate context.

SANA Considerations

The recommendations of this document request SANA to create the following registry(ies).

The registry named FrameID consists of a table of parameters:

1. FrameID: an integer between 0 and 256
2. Description: a string of text describing the parameter

The initial registry should be filled with the following values:

The registration rule for new values of this registry requires no engineering review, but the request must come from the official representative of a space agency, member of the CCSDS.

CHANGES TO AN EXISTING REGISTRY

When a change to an existing registry is requested to SANA, the following information should be included into the CCSDS standards track document. The change may be adding new entries in the registry or a change in the structure of the registry. If a change in the structure of the registry is required, the SANA Considerations section should contain the same information needed to create a new registry, such as data types, boundaries, registration rule, etc.

The text below provides examples and should be adapted to the appropriate context. The first example shows the addition of new records to an existing registry. The second example shows a structural change of an existing registry.

SANA Considerations

The recommendations of this document request SANA to update the FrameID registry by adding the following two new records.

SANA Considerations

The recommendations of this document request SANA to update the FrameID registry by adding the new name column.

The registry named FrameID consists of a table of parameters:

1. FrameID: an integer between 0 and 256
2. Name: a string of [a-zA-Z0-9] characters, limited to 256 chars maximum
3. Description: a string of text describing the parameter

The current registered entries will have the value as empty in their respective Name column.

The registration rule is not changed.