Gateway Management Application
The Gateway Management UI is very similar to the Connexion UI, with functionality being very similar between the two platforms. You can think of the Remote Integrator platform as being numerous remote Connexion instances which are managed by a single UI (although the Remote Integrator is not a Connexion instance).
In order to facilitate many remote instances, the Gateway UI requires you to select a Remote Integrator to manage. Once selected, the UI feels very similar to managing a Connexion instance. You use the Remote Integrator selection bar to select and view Remote Integrators. Other toolbar areas are the same as Connexion.
Enterprise Bar: Manage & view Gateway enterprise features, including Gateway Connections, Dashboards, Groups, Configuration, and Events. Unlike Connexion, the enterprise features are hosted and run by the Gateway (and not by Remote Integrators).
Selected Gateway: The Gateway the UI is currently connected to (multiple Gateway clusters can be managed from one UI).
Remote Integrator Bar: Select a Remote Integrator and view its connection status, connected Gateway, and events.
Application Bar: Application-level functionality - adding and importing Remote Integrators, Bulk connection management, bulk deployment of packages and installers, etc.
Tabs: The currently selected Remote Integrator tabs. The left-most tab with the chart graphic is a channel dashboard for the currently selected Remote Integrator.
The two main differences between the Connexion UI and the Gateway UI are the following bars:
The RI information bar allows you to select a Remote Integrator (and view status information), and the Context bar switches what the bottom pane is showing.
Other sections of the UI operate in the same fashion as Connexion:
Right-click on tabs to view tab-level operations and bulk-channel operations.
Right-click on a channel bar to view channel-level operations.
Right-click on a device for device-level operatons
Creating / Provisioning Remote Agents
View the Create & Deploy Remote Integrators page.
Locking
Locking is done at the Remote Integrator level - ie, you lock an entire Remote Integrator to make changes (and unlock when complete). Use the lock icon (or ctrl + enter) to toggle between lock states. Locking is done to ensure multiple people cannot edit a Remote Integrator concurrently.
Context Bar - Device Configuration
The left-most option on the context bar is for viewing and editing the currently selected channel and device configuration.
Context Bar - File Browser
The file browser lets you manage files within specific directories. The directories are:
The remote agent sandbox (
%programdata%\Connexion.Integrator)x:\%Integrator%(any root folder which contains the word 'integrator').x:\YourGatewayCertificateHostName- for example, if your gateway uses the certificate "us1.integrator.mycompany.com", then x:\mycompany will also be browsable. If you are ingesting or depositing files on the remote file system, we recommend you use a well-known folder in this manner.The remote agent install folder (
%PROGRAMFILES(x86)%\Connexion.Integrator)
The file browser also contains shortcut links to common files and folders.
The file system structure is available to browse (read-only), and the above listed special folders are read/write (except for the install folder, which is read-only). Files in the special folders can be downloaded, uploaded, deleted, sorted, etc. Most operations (like upload and download) support multi-select. Sub-directories can be created within the special folders.
Users must have specific permissions (within the UI) in order to browse and interact with files.
Context Bar - Remote Integrator Configuration & Authorization
The remote integrator configuration, metadata, and general status can be viewed and edited in this area. This is also where the authorization state can be modified.
Use the toolbar to De-authorize a remote agent if:
the original install is no longer needed.
a re-install is needed due to changing hosts or host failure.
A de-authorized Remote Integrator must be re-keyed in order be re-installed. This will generate a new key file and password which can be distributed to the customer. Re-keying a remote integrator may render any existing message data inaccessible. If the message database becomes inaccessible after re-keying, you must delete or move any existing database files.
You can Toggle EFS (default at-rest encryption) on or off depending if you have other at-rest encryption technology enabled (bitlocker). You can also view the location of the message database by clicking the Query Folder button.
Context Bar - Deploy Packages
Connexion supports multiple different versions of a custom device (plugin) concurrently - ie, you can have multiple different channels using different versions of the same custom device. This is important, as Connexion may host channels for many different customers and products - and not everyone will use the same version.
A Remote Agent, by contrast, only hosts channels for a single customer, and therefore only supports one version of a custom device. Custom devices are typically managed in bulk - a specific version of a custom device is deployed to many Remote Agents in one go. You can also manage custom devices on a per-Remote Agent-basis using this UI.
The Gateway platform only supports deploying custom devices (plugins) as nuget packages (unlike Connexion, where you can select a collection of assemblies or a nuget package).
Check out a detailed view at deploying packages.
Deploy Installers
Specific installers can be deployed via the Bulk Deploy Installer dialog. This includes new versions of the Remote Agent, UpdaterA, and UpdaterB installers. 3rd party installers can also be deployed, under special circumstances.
View the Deploy Installers Page for more information.
Groups & Tabs
The Gateway supports a similar hierarchy as Connexion:
Group > Remote Agents > Tabs > Channels
A Group contains one or more Remote Integrators, where a group can be a customer, product, region, etc. Each Remote Integrator contains one or more tabs, which in turn contain zero or more channels.
Groups are managed via the Groups icon on the enterprise toolbar. Use the Add/Remove buttons to curate your groups.
If multiple groups exist, the group containing the selected Remote Integrator is displayed.
Each Remote Integrator starts with a Default tab. You can manage tabs by right-clicking on any tab and choosing the desired command (exactly the same as Connexion). Use the Manage Tabs option to bring up the Manage Tabs dialog.
Channels
Channels work in the same fashion as Connexion. You can interact with the channel toolbar buttons as well as the channel context menu.
Create new channels by using the tab context menu, or, the Create Channel button if the tab is empty. You can also use the ctrl + N command.
You can also copy and paste channels from other UIs (either Connexion or Gateway).
Channel Management
The Gateway UI has a Channel Management dialog similar to Connexion. Use the Channel Management command on the tab context menu (or ctrl + M) to launch it.
This dialog lets you perform bulk channel operations, including:
Starting, stopping, and pausing.
Bulk move and clone.
Bulk re-order, delete, message reprocess (admin mode), and message purge (admin mode).
Export arbitrary channels (to a file or Nuget package).
Channels Dashboard
Each Remote Agent has a dedicated Channels Dashboard tab. This is very similar to the Connexion channels dashboard which shows throughput and state for all channels within the Remote Agent. This information is also available via the Remote Agent Metrics.
Remote Agent Commands
There is a specialized set of commands available for management of Remote Agents - accessible via the Remote Agent context menu. These commands are covered in detail here.
Enterprise Features
The Gateway has a set of enterprise features, including:
Event Logs
Alerting
Authorization
Monitoring
Auditing
Change History
Metrics
Gateway Connections
Dashboards
These features are discussed in detail in the Enterprise Features section.
Additional Functionality
The application toolbar has some additional useful functionality:
Generate Bug Report: Generates an encrypted bug report file which includes information to help Conevity diagnose issues. No PHI is included in this report.Obfuscate UI: Obfuscates specific sections of the queue UI in case your screen is visible to others (screen sharing or in-office). This feature attempts to hide potentially sensitive information (although it is a best-effort feature). Details.View / Clear Remote Agent Locks: Displays a list of remote agents locked by you, with the option to clear the locks.