Note

For a description of the style convention and how JSON structures are documented see section JSON Data Structures.

Named JSON structures are indicated as {JSON}.

FITS Receivers Schema

Warning

Schemas are still work-in-progress and may change between versions.

Once Data Product is merged the daqDpmServer can be configured to release the FITS file to a list of receivers, as specified in DpSpecification {JSON}.

ReceiverList {JSON}

(List[Union[OlasReceiver]])

Specifies a list of receivers, to where the Data Product will be released.

Example:

[
  {
    "type": "olasReceiver",
    "host": "10.10.125.1",
    "path": "/olas/incoming"
  }
]

OlasReceiver {JSON}

(Object)

Release Data Product to OLAS on a Data Handling Server (DHS). OlasReceiver always transfer the Data Product using the Archive File Name.

Important

If host is left empty or unspecified daqDpmServer will try to deliver file by first creating a hard link, secondly by creating a symlink and lastly by copy. If a symlink is created in path to the Data Product this might be a broken link if OLAS is running on a different host. To ensure a copy is made in this case disable symlink with the option noSymlink.

type (“olasReceiver”)

This is a union discriminator and must have the literal string value "olasReceiver".

path (str)

Absolute file ingestion directory path where OLAS receives new files (see RD7).

Important

The path must be a directory and it must exist and be writable.

host (Optional[str])

DHS host. This can be left empty ("") or unspecified if daqDpmServer has local access to the file ingestion directory specified in path e.g. because daqDpmServer is running on DHS or because path is a network file system.

options (Optional[object])

Options to allow tuning of behaviour. If not present default values for all options are used.

allowSymlink (Optional[boolean]) [default: true]

Allow the optimization of creating symlink from Data Product to path. This is mainly useful to ensure Data Product is delivered as a regular file using hard link or copy which avoids possiblity of broken links.