Skip to main content

HrWorksSyncRun

The record of one synchronisation run of one module.

type HrWorksSyncRun {
  created: Int!
  failed: Int!
  failureMessage: String
  finishedAt: DateTime
  messages: [HrWorksSyncMessage!]!
  module: HrWorksSyncModule!
  residentialParkId: ResidentialParkID
  skipped: Int!
  startedAt: DateTime!
  status: HrWorksSyncStatus!
  suppressedMessageCount: Int!
  trigger: HrWorksSyncTrigger!
  updated: Int!
  windowFrom: Date
  windowTo: Date
}

Fields​

HrWorksSyncRun.created ● Int! non-null scalar​

How many records were created.

HrWorksSyncRun.failed ● Int! non-null scalar​

How many records could not be synchronised.

HrWorksSyncRun.failureMessage ● String scalar​

Why the run stopped, when it was stopped by an error rather than completing.

Carries the type of failure only. The underlying messages can contain the data that was being written, including personal data, so they are deliberately not surfaced here.

HrWorksSyncRun.finishedAt ● DateTime scalar​

When the run ended, in the tenant's timezone. Null while it is still running, and also when it was interrupted before it could record an end.

HrWorksSyncRun.messages ● [HrWorksSyncMessage!]! non-null object​

What is worth reporting from the run.

HrWorksSyncRun.module ● HrWorksSyncModule! non-null enum​

Which part of the synchronisation this run performed.

HrWorksSyncRun.residentialParkId ● ResidentialParkID scalar​

The residential park this run was confined to.

Every run names one, the nightly ones included — the scheduled pass works through the linked parks one at a time. null only on a run recorded by an earlier version, which reconciled the whole tenant at once.

HrWorksSyncRun.skipped ● Int! non-null scalar​

How many records needed no change or were deliberately left alone.

A run whose records are all skipped is the expected outcome of running twice over unchanged data, so this is the number to watch when checking that a re-run changes nothing.

HrWorksSyncRun.startedAt ● DateTime! non-null scalar​

When the run started, in the tenant's timezone.

HrWorksSyncRun.status ● HrWorksSyncStatus! non-null enum​

How far the run got.

HrWorksSyncRun.suppressedMessageCount ● Int! non-null scalar​

How many further messages the run produced beyond the number it keeps.

Messages are capped so a run against a misconfigured tenant cannot grow the record past what the database will store, which would lose the counters as well. A non-zero value here means the detail is incomplete, not that the counters are.

HrWorksSyncRun.trigger ● HrWorksSyncTrigger! non-null enum​

What caused the run to start.

HrWorksSyncRun.updated ● Int! non-null scalar​

How many existing records were changed.

HrWorksSyncRun.windowFrom ● Date scalar​

First day of the period reconciled. Null for the modules that do not work over a period.

HrWorksSyncRun.windowTo ● Date scalar​

Last day of the period reconciled. Null for the modules that do not work over a period.

Returned By​

hrWorksSyncRuns query