Difference between revisions of "Edge Server Publication"

From Fusion Registry Wiki
Jump to navigation Jump to search
(Created blank page)
 
Line 1: Line 1:
 +
= Overview =
 +
<p>By design, the Fusion Registry does not diretly integrate with the Fusion Edge server, instead it is capable of generating content that can be published to it.  The genearted content consists of a single zip file, as required by the Fusion Edge Server for ingestion.</p>
 +
<p>Edge Server 'environments' can be described in the Fusion Registry, the puspose for describing an environment is to enable the Fusion Registry to know what content is should include/exclude from the published content.  There is no direct or indirect relationship between the Fusion Registry and the Fusion Edge Server, so the 'environment' definition is simply to help administrators maintain a packaging definition.</p>
 +
<p>The Fusion Registry User Interface supports the creation of an environment definition, and can be used to generate the publication file for the Fusion Edge Server.  It is also possible to drive both processes using the Fusion Registry web services.</p>
 +
<p>The process of publishing the generated content to the Fusion Edge server is beyond the remit of the Fusion Registry, and therefore is either a manual process, or an automated task using scripts which are external to, and not goverened by, the Fusion Registry</p>
  
 +
= Environment Definition =
 +
The Fusion Edge Server Environment Definition consists of the following properties
 +
 +
{| class="wikitable"
 +
|-
 +
! Property !! Purpose
 +
|-
 +
| Id || Unique Identifier. This is used when performing operations such as changing definitions, or generating a publication
 +
|-
 +
| Description || Human readable description of the environment
 +
|-
 +
| Include Data || whether to include datasets in the publication (or structural metadata only) (yes/no/or a specific list)
 +
|-
 +
| Include Reference Metadata || true/false - whether to include reference metadata in the publication
 +
|-
 +
| Include Provisions || true/false - related to the inclusion of data, whether to include Provision Agreements in the publication, or just the Dataflows
 +
|-
 +
| Edge Organisation || optional.  This can be set to any Data Provider,Data Consumer, or Agency in the Fusion Registry.  When generating content for the Fusion Edge Server, the environment will be treated as a user, with the same security rules applied as if the linked Organisation were requesting structures or data.  The default setting is anonymous user.
 +
|-
 +
| Enforce Embargo || if set to true, then an Embargo date/time must be set when generating the Edge Server content
 +
|}
 +
 +
 +
= Generating Edge Content =
 +
The generation of Edge content requires the following information
 +
 +
{| class="wikitable"
 +
|-
 +
! Property !! Purpose
 +
|-
 +
| Publication Type || <ul><li><b>Full Replace</b> - this is the default behaviour.  The generated zip file contains the full contents (data/structures/reference metadata) for the Fusion Edge Server.  When loading this zip to the Fusion Edge Server all existing content will be replaced.</li>
 +
<li><b>Delta</b> - only relevant for datasets.  The generated zip file contains only datasets that have changed since the last publication.  Only the data that has been changed will be included.  When loading the file to the Fusion Edge Server, all existing content will be preserved, and the new data will be merged into the existing datasets</li>
 +
</ol>
 +
|-
 +
| Embargo || Optional.  If an embargo time is supplied, this information is put into the zip's file name as a timestamp.  The Fusion Edge Server uses the file name to determine if there is an embargo time, and will not publish the environment until the embargo time has passed
 +
|}

Revision as of 09:31, 10 February 2020

Overview

By design, the Fusion Registry does not diretly integrate with the Fusion Edge server, instead it is capable of generating content that can be published to it. The genearted content consists of a single zip file, as required by the Fusion Edge Server for ingestion.

Edge Server 'environments' can be described in the Fusion Registry, the puspose for describing an environment is to enable the Fusion Registry to know what content is should include/exclude from the published content. There is no direct or indirect relationship between the Fusion Registry and the Fusion Edge Server, so the 'environment' definition is simply to help administrators maintain a packaging definition.

The Fusion Registry User Interface supports the creation of an environment definition, and can be used to generate the publication file for the Fusion Edge Server. It is also possible to drive both processes using the Fusion Registry web services.

The process of publishing the generated content to the Fusion Edge server is beyond the remit of the Fusion Registry, and therefore is either a manual process, or an automated task using scripts which are external to, and not goverened by, the Fusion Registry

Environment Definition

The Fusion Edge Server Environment Definition consists of the following properties

Property Purpose
Id Unique Identifier. This is used when performing operations such as changing definitions, or generating a publication
Description Human readable description of the environment
Include Data whether to include datasets in the publication (or structural metadata only) (yes/no/or a specific list)
Include Reference Metadata true/false - whether to include reference metadata in the publication
Include Provisions true/false - related to the inclusion of data, whether to include Provision Agreements in the publication, or just the Dataflows
Edge Organisation optional. This can be set to any Data Provider,Data Consumer, or Agency in the Fusion Registry. When generating content for the Fusion Edge Server, the environment will be treated as a user, with the same security rules applied as if the linked Organisation were requesting structures or data. The default setting is anonymous user.
Enforce Embargo if set to true, then an Embargo date/time must be set when generating the Edge Server content


Generating Edge Content

The generation of Edge content requires the following information

Property Purpose
Publication Type
  • Full Replace - this is the default behaviour. The generated zip file contains the full contents (data/structures/reference metadata) for the Fusion Edge Server. When loading this zip to the Fusion Edge Server all existing content will be replaced.
  • Delta - only relevant for datasets. The generated zip file contains only datasets that have changed since the last publication. Only the data that has been changed will be included. When loading the file to the Fusion Edge Server, all existing content will be preserved, and the new data will be merged into the existing datasets
Embargo Optional. If an embargo time is supplied, this information is put into the zip's file name as a timestamp. The Fusion Edge Server uses the file name to determine if there is an embargo time, and will not publish the environment until the embargo time has passed