Gateway configuration

Overview

The Gateway configuration pages provide an overview of the resource files stored in Gateway Hub.

You can manage the allocation of centrally managed resources and upload binaries or setup files. However, setup of centralised configuration must be performed using the Gateway Setup Editor.

This section is composed of three pages:

  • Gateways — allows you to manage centrally configured Gateways.
  • Binaries — allows you to upload Gateway binaries. These can be used to perform schema validation.
  • Includes — allows you to upload Gateway setup files to a centralised store. These can be used as includes files by centrally configured Gateways.

For more information about centrally configured Gateways, see Connecting to Gateway Hub.

Gateways

This page shows a summary of the centrally configured Gateways and resources managed by Gateway Hub.

The Gateways page is composed of two sections:

  • Gateways— displays a list of all centrally configured Gateways.
  • Resources — displays a list of all Gateway setup files. These are uploaded by connected Gateways or added manually from the Includes page.

Gateways

Field Description
Name Name of the Gateway.
Version Full version number of the Gateway binary.

Selecting a Gateway from the list will filter the Resources to show only files currently used by that Gateway. You can undo this by clicking the Gateway a second time.

Gateway configuration

You can examine and modify a Gateway's configuration by clicking Edit . This opens the Gateway configuration page.

The Gateway configuration page has two sections. The Current configuration section shows the resources that the selected Gateway is currently using, the Available resources section shows the resources that can be added to the Gateway.

The Current configuration section shows:

Field Description
Name Name of the file.
Last changed On Time the file was last modified.
Last changed By Author of the last change to the file.
Version Identification code for this version.
Delete Remove the file from the Gateway configuration.

The Available resources section shows:

Field Description
Name Name of the file.
Last changed On Time the file was last modified.
Last changed By Author of the last change to the file.
Version Identification code for this version.

To add a file to a Gateway configuration:

  1. Click plus, next to the resource.
  2. Click Add.
  3. Click Save.

Resources

Field Description
Name Name of the file.
Last changed Time the file was last modified.
By Author of the last change to the file.
Comment Comment associated with the last change to the file.
Locked Indicates if the file has been locked. Locked setups cannot be edited from the Gateway Setup Editor.

Selecting a resource from the list filters the Gateways to show only the Gateways that are using the selected resource. You can undo this by clicking the resource a second time.

History

You can examine the revision history of the any resource by clicking History . This opens the Resource History page.

The History page shows the current status of the selected resource and a list of revisions that have been made to the file. Gateway Hub creates a new revision every time an operation is performed on a resource.

The Status section shows:

Field Description
Name Name of the file.
Type Resource type.
Last changed On Time the file was last modified.
Last changed By Author of the last change to the file.
Hash Unique hash associated with this version of the file.
State Change Id Cumulative tracker for state changes.

The Revision history section shows:

Field Description
Select Select the highlighted entry.
Last changed On Time the file was last modified.
Last changed By Author of the last change to the file.
Hash Unique hash associated with this revision of the file.
Version Identification code for this version.
State Change Id Cumulative tracker for state changes.
Show Display the contents of the file.

You can compare different revisions by selecting any two revisions of a resource and clicking Diff. This shows a side by side comparison view.

Binaries

This page allows you to upload Gateway binary files to Gateway Hub. Binary files are used to perform validation of Gateway setup files uploaded by centrally configured Gateways, or manually from the Includes page.

Note: You must upload any binaries you need. Gateway Hub does not provide any binaries by default, in order to minimise the size of the installer.

To upload a file:

  1. Click Add. This will open your file manager.
  2. Select a Gateway binary file.
  3. Click Save.

The Binaries page shows a list of uploaded files and their status.

Field Description
File Name of the file.
Status Displays the accepted or rejected status of the upload. Hover the cursor over a rejected status to show error messages.
Delete Click here to delete the binary file.

Includes

This page allows you to upload Gateway setup files to Gateway Hub. This is useful when you need to upload a large number of files.

To upload a file:

  1. Click Add. This opens your file manager.
  2. Select a Gateway setup file.
  3. Click Save.

The Includes page shows a list of uploaded files and their status.

Field Description
Contents Name of the file.
Name Specify a descriptive name for the resource. If no name is specified the file name will be used.
Status Displays the accepted or rejected status of the upload. Hover the cursor over a rejected status to show error messages.