Define Transfer Success with an Assurance Contract

Judge a run by whether the job succeeded, not just whether files moved. Set the success conditions of an Assurance Contract and read the result.

IT Engineers

What this solves#

A run can finish Completed and still fail the job.

  • An overnight rollout had to finish by 06:00, before branches opened. It finished at 06:12. Every file arrived, and every branch opened on the old version.
  • 998 of 1,000 devices received the file. The two that did not were the reference machines.
  • The file count matched, but one file was corrupted in flight.

An Assurance Contract is where you write down what has to be true for the job to count as successful. Once it is written, INNORIX judges every run against it and records Satisfied or Violated separately from the transfer status.

This document covers defining the conditions, reading the result, and what to look at when a contract is violated.

Who this is for#

Role When
Operations A daily rollout or collection has to finish by a fixed time
System administrator Certain devices must receive the file, no exceptions
Quality and audit You need evidence of integrity, not just completion

Three typical situations:

  1. A rollout with a deadline — before opening hours, before a shift change, before broadcast
  2. A rollout with mandatory devices — reference machines, primary servers, control terminals
  3. A transfer that needs integrity evidence — medical imaging, inspection data, financial records

Before you start#

  • A Flow with steps and targets already set. A Flow with no steps is rejected on save.
  • Permission to edit the Flow.
  • Target devices do not need to be Connected now. Conditions are judged when the run happens.

Where to set it#

  1. In Flows, open the Flow and press Edit flow.

  2. Press the Assurance badge in the editor toolbar. The badge shows the current state.

    Badge Meaning
    Recommended INNORIX recommended values, unchanged
    Workspace defaults Inherited from the workspace
    Custom · N N values changed from what this Flow inherited
    Defaults apply The settings could not be loaded. The run uses the recommended values

    Custom · N on the badge counts against what this Flow inherited. Where workspace defaults exist, those are part of the baseline, so anything the workspace set is not in this number.

    The N custom on the Error handling row inside the dialog uses a different baseline. It compares against INNORIX's own values, so it does count what the workspace set. The two numbers on one screen can disagree, and that is correct. See Decide in Advance What Happens When a Transfer Goes Wrong.

    Under the badge the current values are summarised in two lines - the Success conditions summary line joins the conditions with a middle dot (All targets · No deadline · Hash verified (MD5)), and below it an Error handling line gives that side's state. You can read what a run will be judged by without opening the dialog.

  3. The Assurance dialog opens. Success conditions is on top, Error handling below. This document covers the top half. The lower half is in Decide in Advance What Happens When a Transfer Goes Wrong.

  4. Set the conditions and press Apply. Close the dialog and press Save & activate on the Flow for the change to take effect. The editor's top bar has four buttons - Cancel (drop), Save draft (save without activating), Start now (run it once now) and Save & activate. Saving as a draft keeps the conditions, but the Flow does not run.

  5. The first time you activate, a review step appears once, showing what the run will be judged against.

Two ways to undo, and they differ. Reset to defaults, at the right end of the Success conditions row, returns to what this Flow inherited: the workspace defaults where they exist, INNORIX's recommended values otherwise. It resets Error handling below as well, not just the success conditions. Cancel puts back whatever was there when the dialog opened.

The conditions, and how to choose#

Target completion — how many devices must receive it#

Option Meaning When
All targets Every device must complete Few targets, none may be missed
Percentage Opens a Percent field, 1 to 100, with a % suffix Many targets, some offline is normal
Number of devices Opens a Devices field with a devices suffix The job needs "at least N" to be useful

Setting All targets on thousands of field devices means one or two are always powered off and every run is Violated. The alarm then stops meaning anything. Use a percentage, and pin the machines that truly matter under Required devices.

Deadline — by when#

Option Meaning
None Time is not judged
After start Opens a Minutes field, 1 to 10080, with a min suffix, counted from when the run started
Time of day Opens a Time field, a clock time of day

For a scheduled run, Time of day matches the business rule. If manual runs are mixed in, After start is safer.

File check — what counts as the right file#

Option Meaning
Hash (MD5) Every received file is compared with the source by MD5
Size and count Size and count only

The dialog says it directly: "Each received file is compared with the source by its MD5 hash."

Hashing is conclusive but costs time per file. If you move millions of small files daily and do not need integrity evidence, Size and count is enough. For medical, financial and inspection data, use Hash (MD5).

Required devices — the ones that may not be missed#

Press Change to open the list and Done to close it. With many devices, Search devices finds one. With nothing picked the value reads None.

If the Flow has no target devices, there is nothing to pick. The dialog then says "Add target devices to the flow first." Put targets on the step first.

Pick them from the list. The dialog states the rule:

The contract is violated if any of these does not complete, whatever the target completion says.

So even with At least 95% of targets, if one device listed here fails, the contract is Violated. Using it alongside a percentage is the point.

Advanced conditions — folded, and Off to begin with#

Unfold it and there are three:

Field Meaning
Maximum retries A ceiling on retry attempts
Maximum interruption (minutes) A ceiling on time spent interrupted
No unresolved issues at the end Nothing may be left unrecovered when the run ends

The note in the dialog matters:

Empty fields are off. Retries continue past a limit; only the contract result changes.

A retry ceiling does not stop retrying. Past the limit, only the contract verdict turns to violated. It does not mean "try three times then give up"; it means "if it took more than three, this job did not go well". To actually stop retrying, change the action in Decide in Advance What Happens When a Transfer Goes Wrong away from Keep retrying.

Empty fields count as off. Use this only when the four above are not enough.

Mandatory conditions — what you cannot switch off#

The dialog states: "Always checked: stored at destination, required policies and run record."

Whether the file really landed at the destination, and whether the required policies and run record exist, are always checked. They cannot be removed.

Worked settings#

Situation Target completion Deadline File check Required devices
Overnight rollout to 1,200 stores, opening at 06:00 Percentage 98% Time of day 05:30 Size and count 4 distribution hub servers
Recipe rollout to 20 production machines, before shift All targets After start 20 min Hash (MD5) empty, all are required
Nightly collection from 300 inspection machines Percentage 95% Time of day 07:00 Hash (MD5) 3 reference machines
Daily log collection from 12 branch servers Number of devices 10 After start 60 min Size and count the HQ aggregation server

Reading the result#

When a run finishes, Runs and the Assurance screen show three separate things.

Column What it says
Transfer Status Did the files move — Success, Partial, Failed, In Progress, Pending
Recovery How the run handled its issues — Verified, Recovered, Recovering, Needs Attention, Failed, Not evaluated
Contract Status Did the job succeed — Satisfied, Violated, Indeterminate, At Risk, Pending

The middle one is labelled Recovery on the report's three pills and Assurance as a column in the run list. It is the same value.

They can differ. That is the point of the feature.

A real example. Nightly backup runs daily with a 30-minute deadline.

Transfer Status   Success    100 / 100
Contract Status   Violated   1 condition failed
All files were delivered, but the deadline was missed by 12 min.

Every one of the 100 devices got the files. The 10:00 deadline was missed by 12 minutes, so the contract is violated.

The Assurance Report#

Opening the report from the run shows each condition and whether it passed.

A condition row ends one of four ways, not two.

Marker Verdict When
✓ Passed It was checked and met
✕ Failed It was checked and missed
! Not verified It could be checked in principle, but the answer never arrived
– Not checked There was nothing to check, as when nothing was delivered

Not verified and Not checked both leave Contract Status at Indeterminate, which is neither a pass nor a failure.

Conditions                                      1 condition failed
  ✕  Completion deadline    10:12 (+12m)  by 10:00   Failed
  ✓  Target completion      100 / 100 targets  all   Passed
  ✓  File accuracy          100 passed  MD5          Passed
  ✓  Stored at destination  100 / 100               Passed
  ✓  Security & evidence    no violations           Passed

A sixth row appears when you set Required devices. It is not in the block above because that run had none. With them set the report adds:

  ✕  Required devices   1 / 2   missing Edge 0020 (failed)   2 devices   Failed

This is what "the contract is violated whatever the percentage says" looks like. In that run Target completion read 19 / 20 targets ≥ 90% Passed while this row failed, and the contract was Violated. The failed device is also marked required in the device table.

Above it, the cause and the next action:

Primary Cause        Branch-0100 · finished 12m late · +28 more devices
Recommended Action   Find what slowed the transfer under Devices and Activity,
                     or give the flow more time in its Assurance settings.

Below it, the device spread (Late 29, On time 71) and Issues & Recovery, whose own line joins the recorded events, the recovery attempts and how many devices were involved with ·, and reads No issues when there were none.

What a clean run looks like#

Transfer Status Success and Contract Status Satisfied means the job succeeded too. The Contract compliance rate at the top of the Assurance screen accumulates the pass rate.

Errors and exceptions#

What you see Meaning What to do
Badge reads Defaults apply and does not open The settings could not be loaded. The run uses recommended values Check the server connection. Transfers keep running normally meanwhile
Save rejected, invalid value A condition value is out of range Check the percentage and deadline values
Save rejected, required device is not a final target A device under Required devices is not a target of the Flow's last step Add it as a target, or remove it from required
Save rejected, version conflict Someone else saved first Close and reopen the dialog, then edit on top of the current values
Save rejected, no steps The Flow has no steps Build the steps first
Contract Status is Indeterminate Not enough information to judge The report shows which condition could not be confirmed. An older agent not reporting integrity is a common cause
Contract Status is At Risk Still running and likely to miss the deadline You can still act before it ends

Operating notes#

  • Set the deadline earlier than the business deadline. If branches open at 06:00, set 05:30. A violation then still leaves 30 minutes to act.
  • Do not set All targets across thousands of devices. Constant violations train people to ignore the alarm. A percentage plus Required devices is the workable combination.
  • Hashing costs time. With millions of small files it lengthens the run. Turn it on for the Flows that need evidence.
  • Changing conditions applies from the next run. Past judgements do not change.
  • Set workspace defaults once and Flows inherit them. The badge then reads Workspace defaults.
  • Do not report "done" from the transfer status alone. That is the reason this feature exists.

By industry#

Industry How it is used
Manufacturing Deadline before the shift, line reference machines as Required devices, Hash (MD5) for recipes
Finance Deadline before opening, branch servers by percentage plus core servers as required, hashing for evidence
Retail Deadline before opening, distribution hubs required, store terminals by percentage
Healthcare Hashing required for imaging, the reading server as a required device
Public sector and defense The run record under Mandatory conditions becomes audit evidence
Broadcast Air time as the deadline, the playout server as required