Skip to main content

Intake Agent Core

Every Intake Agent is built on a shared base, the DCH.IntakeAgentCore package. It provides the parts that all agents have in common: the contract they use to talk to DCH, Keycloak single sign-on, and a small admin UI (built with Blazor and Radzen) with the screens described on this page. Each agent then adds its own source-specific configuration on top.

So whichever Intake Agent you open, you will find the same Home, Data Preview, and Data Jobs screens in the sidebar, plus any screens the individual agent adds (for example, the File Intake Agent adds an Upload screen). The rest of this section documents each agent's own configuration; this page documents the shared screens.

Authentication​

Intake Agents use the same Keycloak authentication as the rest of DCH, with single sign-on across the whole instance. If you are already logged in to another DCH application, that session is reused automatically, and the other way around. If no session exists, opening an agent redirects you to the Keycloak login.

To log out, open the user menu from the user icon at the bottom of the sidebar.

Home​

The Home screen (titled Overview) shows a key/value table with the information you need when reporting a problem with an agent:

  • Agent name: The display name of this Intake Agent.
  • Service name: The service identifier. Use it to find this agent's log messages in OpenSearch.
  • Version: The version of the Intake Agent itself.
  • Core Version: The version of the shared DCH.IntakeAgentCore package it runs on.
  • License module key: The license module the agent reports to DCH.

Below it, a Third Party Licenses table lists the open-source packages the agent bundles, with their versions, authors, licenses, and links.

The Home screen, titled Overview: a key/value table showing the agent name, service name, version, core version, and license module key, above the Third Party Licenses table

Data Preview​

Data Preview lets you inspect the data behind an agent's stored configurations without running an import.

  1. Select a Data Source Configuration from the dropdown. The configuration's Source Entities are listed, each with its Title and its Properties.
  2. Tick the Preview checkbox next to an entity to load its data. The data appears below in a table.

The Data Preview screen with a Data Source Configuration selected, its source entities listed with their titles and properties, and one entity ticked for preview

The preview is cached: it stays loaded until you pick a different Data Source Configuration. To fetch fresh data straight from the source instead of the cached copy, use Bypass cached preview on an entity.

How many rows a preview shows, and how current they are, is up to the individual agent. An agent that caches a fixed number of rows when a configuration is stored shows those rows; one without caching requests the latest few rows each time.

info

Some Intake Agents do not support Data Preview, so this screen may show no results for them.

Data Jobs​

Whenever DCH requests data from an agent, the agent creates a Data Job. The Data Jobs screen tracks these jobs and lets you cancel one that is still running (which also cancels the corresponding import in DCH). Each row shows:

  • Job Id: The job's unique identifier.
  • Source Configuration: The Data Source Configuration the job reads from.
  • Status: The job's current state.
  • Created At and Completed At: When the job started and finished.
  • Triggered By: What started the job.
  • Error: The error message, if the job failed.

Use Cancel in the Actions column to stop a job while its status is running, and Refresh to reload the list.

The Data Jobs screen listing jobs with their id, source configuration, status, created and completed times, and trigger source

info

Data Jobs are held in memory only, so they are all lost if the Intake Agent restarts.