Version: 1.13.0

REGARDS OAIS implementation

OAIS recommendation

REGARDS allows to populate its catalog with products by following the OAIS recommendation. You can send your SIP (Submission Information Package) using the web HMI, the REST API or directly throught the bus message of the Ingest microservice.

Overview

To do so, administrator can provide a Json file containing :

metadata information about how to handle features to acquire
features list of SIP to acquire, with geographical features and metadata

Exemple :

{
  "type": "FeatureCollection",
  "metadata": {
    "sessionOwner": "ISS Mission #1",
    "session": "Monday acquisition",
    "ingestChain": "DefaultProcessingChain",
    "categories": ["ISS_MISSION1_DATA"],
    "versioningMode": "INC_VERSION",
    "storages": [
      {
        "pluginBusinessId": "Local",
        "storePath" : "/demo/exemple-1",
        "targetTypes": []
      }
    ]
  },
  "features": [
    {
      "type": "Feature",
      "id": "regards-2296-data-1",
      "ipType": "DATA",
      "geometry": null,
      "properties": {
        "contentInformations": [
          {
            "dataObject": {
               "regardsDataType": "RAWDATA",
               "filename": "data-1.dat",
               "locations": [
                 {
                   "url": "file:///regards/demo/data-1.dat"
                 }
                ],
                "checksum": "9a964ed3be0e2e2786d82ace9d971e90",
                "algorithm": "MD5"
            },
            "representationInformation": {
              "syntax": {
                "name": "TEXT",
                "mimeType": "text/plain"
              }
            }
          }
        ],
        "pdi": {
          "contextInformation": {
             "tags": ["KEYWORD"]
          },
          "provenanceInformation": { "history": [] },
          "accessRightInformation": {}
        },
        "descriptiveInformation": {
          "longValue": 11056,
          "creationdate": "2018-01-20T17:22:48Z",
          "doubleValue": 35.56598,
          "dataSetType": "type_01",
          "label": "REGARDS 2296 generated data -1"
        }
      }
    }
  ]
}

FeatureCollection structure

Metadata

  "metadata": {
    "sessionOwner": "ISS Mission #1",
    "session": "Monday acquisition",
    "ingestChain": "DefaultProcessingChain",
    "categories": ["ISS_MISSION1_DATA"],
    "storages": [
      {
        "pluginBusinessId": "Local",
        "storePath" : "/demo/exemple-1",
        "targetTypes": [],
        "size": {
          "min": 10,
          "max" : 10000,
        }
      }
    ]
  }

Property	Mandatory	Description	Possible values
sessionOwner	x	Identifier of the data provider. Used to monitor all products of a same provider	any text, max 128 characters
session	x	Identifier of the current group of data. Used to monitor a subset of the session products.	any text, max 128 characters
ingestChain	x	Name of the configured ingest chain. This chain can be configured through administration HMI and contains all the configuration to generate the final product, the AIP, from the provided SIP.	Any chain name configured
categories		List of keywords. Thoses keywords can be used lately to select products to add in the metacatalog	any text
versioningMode	x	How to handle new version of same product (same feature id)	IGNORE, INC_VERSION, MANUAL, REPLACE
storages	x	List of storage configuration that define how to store physical files associated to the provided list of features	-

Versionning mode values :

IGNORE : New version of same feature are not ingested.
INC_VERSION : New version of same feature are ingested with version incremented.
MANUAL : Wait for project administrator to choose how to handle new version.
REPLACE : New version of same feature are ingested with version incremented and previous versions are deleted.

storages

Property	Mandatory	Description	Possible values
pluginBusinessId	x	Name of the configured storage. Each storage have to be configured though the administrator HMI	Any configured storage label
storePath		Optional property to define a directory into the storage location to store each files	subdirectory path
targetTypes		Optional property to define which REGARDS type of files need to be stored in the current storage. If empty all files are stored in the storage	`RAWDATA` , `QUICKLOOK_SD`, `QUICKLOOK_MD`, `QUICKLOOK_HD`, `DOCUMENT`, `THUMBNAIL`, `AIP`, `DESCRIPTION`
size		Optional property to define accepted file sizes on this storage location. At least one property among min and max is mandatory to limit the size, otherwise all sizes will be accepted.

Features

{
      "type": "Feature",
      "id": "regards-2296-data-1",
      "ipType": "DATA",
      "geometry": {
        "crs" : "WGS84",
        "type" : "Point",
        "coordinates": [30, 10]
      },
      "properties": {
        "contentInformations": [
          {
            "dataObject": {
               "regardsDataType": "RAWDATA",
               "filename": "regards-2296-data-1.dat",
               "locations": [
                 {
                   "url": "file:///regards-input/validation/data/2296/regards-2296-data-1.dat"
                 }
                ],
                "checksum": "9a964ed3be0e2e2786d82ace9d971e90",
                "algorithm": "MD5"
            },
            "representationInformation": {
              "syntax": {
                "name": "TEXT",
                "mimeType": "text/plain"
              }
            }
          }
        ],
        "pdi": {
          "contextInformation": {
             "tags": ["KEYWORD"]
          },
          "provenanceInformation": { "history": [] },
          "accessRightInformation": {}
        },
        "descriptiveInformation": {
          "property1": 11056,
          "date": "2018-01-20T17:22:48Z",
          "property2": 35.56598,
          "property3": ["type_01", "type_02"],
          "property4": "REGARDS demo",
          "property5": [ 10, 20 ],
        }
      }
    }

A feature is a product to acquire in REGARDS.

Feature

Property	Mandatory	Description	Possible values
type	x	Feature type. Fixed value	`Feature`
id	x	(Your) Identifier of the product to acquire. This identifier must be unique. If two features have the same id then we consider there is two different versions of the same product	any text
ipType	x	REGARDS type of feature	`COLLECTION`, `DATA`, `DATASET`
geometry		Standard GeoJson geometry of the feature	RFC7946 `Point`, `LineString`, `Polygon`, `MultiPoint`, `MultiLineString`, `MultiPolygon`
contentInformations	x	Feature associated files	Can be empty
pdi	x	Preservation Description Information	-
descriptiveInformation	x	A group key/value containing all specific information about the product	-

ContentInformation

dataObject

"dataObject": {
  "regardsDataType": "RAWDATA",
  "filename": "regards-2296-data-1.dat",
  "locations": [
     {
        "url": "file:///regards-input/validation/data/2296/regards-2296-data-1.dat"
      }
   ],
   "checksum": "9a964ed3be0e2e2786d82ace9d971e90",
   "algorithm": "MD5"
},

Property	Mandatory	Description	Possible values
regardsDataType	x	REGARDS type of file	`RAWDATA` , `QUICKLOOK_SD`, `QUICKLOOK_MD`, `QUICKLOOK_HD`, `DOCUMENT`, `THUMBNAIL`, `AIP`, `DESCRIPTION`
filename	x	Name of the file to acquire	-
locations	x	Location of the file to acquire. Locations are described under this table.	-
checksum	x	Checksum of the file to acquire	-
algorithm	x	Algorithm used to generate file checksum	`MD5`...
fileSize		Size in bytes of the file to acquire. This property will be automaticaly calculated if the file to acquire is directly accessible	-

dataObject locations

"locations": [
     {
        "url": "file:///regards/demo/data-1.dat"
     },
     {
        "storage": "FTP Server",
        "url": "ftp:/172.125.10.1/regards/demo/ftp/data-1.dat"
     },
   ],

Property	Mandatory	Description	Possible values
storage		Storage location of the file. If this property is provided, then the file is already stored and REGARDS will only keep the reference to the file. There will be no move file operation. If the storage is a configured storage in REGARDS system so the file can be accessed, if not the file will be considered as offline.	Any text
url	x	Location of the file. If previous property `storage` is not provided, then the file will be copyed from this url to the storages defined in the metadata bloc, so ensure this url must be an accessible `file:///` url protocol from the Storage microservice. If a storage has been provided then this url can be any text that can be a known url for the given storage.	any text

NOTE : To reference an online file accessible through HTTP protocol, you have have to use the reference system as the exemple bellow. With this reference the file will be known by REGARDS as an online referenced file and will be accessible without any needs to configure a storage location associated. With this type of reference, the file url provided by regards catalog will be the original provided url.

"locations": [
     {
        "storage": "web",
        "url": "https://regardsoss.github.io/appendices/oais"
     }
   ],

representationInformation

"representationInformation": {
  "semantic": {},
  "syntax": {
    "name": "TEXT",
    "mimeType": "text/plain"
  }
}

Property	Mandatory	Description	Possible values
semantic			-
name	x	Name of the mime type of the file
mimeType	x	Mime type of the file to acquire
height		Optional property to define in pixel the height of an image. This property will be automaticaly fill if the file to acquire is an image and is directly accessible	Number in pixel
width		Optional property to define in pixel the height of an image. This property will be automaticaly fill if the file to acquire is an image and is directly accessible	Number in pixel

Preservation Description Information (pdi)

"pdi": {
  "contextInformation": {
    "tags": ["KEYWORD"]
  },
  "provenanceInformation": { "history": [] },
  "accessRightInformation": {}
},

Property	Description	Possible values
tags	keywords to add to each feature	any text
provenanceInformation	Description of the origine and history of the feature
accessRightInformation	Description of the feature access rights

REGARDS Data types

Type	Description
`RAWDATA`	Type to reference a data file.
`QUICKLOOK_SD`	Type to reference a small resolution image of the product preview
`QUICKLOOK_MD`	Type to reference a medium resolution image of the product preview
`QUICKLOOK_HD`	Type to reference a large resolution image of the product preview
`DOCUMENT`	Type to reference a document associated to the product
`THUMBNAIL`	Type to reference a thumbnail of the product
`AIP`	Type to reference the matadata file of the product
`DESCRIPTION`	Type to reference a description of the product

OAIS recommendation​

Overview​

FeatureCollection structure​

Metadata​

Features​

ContentInformation​

Preservation Description Information (pdi)​

REGARDS Data types​