Skip to content

connector/datasets

Step Summary
connector/datasets/select Let the operator choose one asset and one of its offers out of a catalog's datasets.

connector/datasets/select

Let the operator choose one asset and one of its offers out of a catalog's datasets.

Checkpoint — internal: you choose in the Test Suite; nothing is called. Every use of the step is one; a test switches it off with checkpoint: false.

Does not query the catalog: give it the datasets of the catalog step before it. Each asset and offer pair is one option; a dataset with no offer cannot be negotiated and is left out. Read asset_id and policy to negotiate the pair.

Inputs

Parameter Type Required Default Also accepts Description
auto_select_single boolean no True — Take the only option without asking when there is just one. False asks the operator even then.
timeout_s number no 300.0 — Seconds to wait for the choice before failing.
action WaitAction no None — What the choice is for, shown to the operator with the options: 'label', 'description', 'recommendation' and 'fields'.
datasets list of object yes — — The datasets a catalog query returned, e.g. '${{ execution..datasets }}' of query_catalog_with_filters.

Output — the value assertions and returns: read

Output contract of connector/datasets/select.

Field Type Description
selected_by operator | single 'operator' when the operator chose, 'single' when it was the only option.
asset_id string The id of the chosen asset.
offer_id string The '@id' of the chosen offer.
policy object The chosen offer, as the provider wrote it — what 'negotiate' takes as 'policy'.
dataset object The chosen asset's dataset, every offer included.

Nested objects

ActionField

One labelled value the person driving the system under test copies.

Field Type Required Default Also accepts Description
label string yes — — What the value is, e.g. header.receiverBpn.
value string | integer | number | boolean yes — — The value to copy.

WaitAction

The action the system under test has to take while a step waits — written by the test author on the wait step (with.action) and shown in place of what a viewer would otherwise derive from the listener.

Field Type Required Default Also accepts Description
label string no None — The action's name, e.g. 'Send a certificate push'.
description string no None — What is being asked of the system under test, and why.
recommendation list of string no [] — How to do it: the steps to take, in order. A single string is one step.
fields list of ActionField no [] — Values to copy, shown beside the steps, in order.