CheckMetricData

typed block

A shortcut single action to avoid using GetMetricData and Compare for a set of simple metrics. This action loads the specified metric data for the specified queue, and allows comparisons to the loaded value. For example, it loads number of contacts in queue, age of oldest contact in queue, number of agents staffed on the queue, number of agents available on the queue, or number of agents online on the queue.

Factories

`CheckMetricData`

CheckMetricData() -> CheckMetricDataHandle

Construct a fresh CheckMetricData block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

`CheckMetricData`

CheckMetricData(id: String) -> CheckMetricDataHandle

Construct a CheckMetricData block with an operator-supplied id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier, typically a Connect UUID restored by `decompile` so round-trips stay byte-stable.

Methods

`metric_type`

metric_type(value: String) -> CheckMetricDataHandle

Set the MetricType parameter. One of [NumberOfAgentsAvailable, NumberOfAgentsStaffed, NumberOfAgentsOnline, OldestContactInQueueAgeSeconds, NumberOfContactsInQueue]. Dynamic values are not supported,

Parameter	Type	Required	Description
`value`	`String`	yes	One of [NumberOfAgentsAvailable, NumberOfAgentsStaffed, NumberOfAgentsOnline, OldestContactInQueueAgeSeconds, NumberOfContactsInQueue]. Dynamic values are not supported,

`queue_id`

queue_id(value?: String) -> CheckMetricDataHandle

Set the QueueId parameter. A queue ID or queue ARN. If AgentId is specified, this may not be specified. Dynamic values are supported,

Parameter	Type	Required	Description
`value`	`String`	no	A queue ID or queue ARN. If AgentId is specified, this may not be specified. Dynamic values are supported,

`agent_id`

agent_id(value?: String) -> CheckMetricDataHandle

Set the AgentId parameter. An agent ID or agent ARN, representing an agent queue. If QueueId is specified, this may not be specified. Dynamic values are supported. If neither this nor QueueId are specified, the contact TargetQueue is used

Parameter	Type	Required	Description
`value`	`String`	no	An agent ID or agent ARN, representing an agent queue. If QueueId is specified, this may not be specified. Dynamic values are supported. If neither this nor QueueId are specified, the contact TargetQueue is used

`next`

next(target: Handle) -> CheckMetricDataHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

Parameter	Type	Required	Description
`target`	`Handle`	yes	The block to route to once this block completes successfully.

`when`

when(cond: ConditionHandle, target: Handle) -> CheckMetricDataHandle

Append a Conditions[] branch. Multiple .when(...) calls chain, evaluation runs in source order, first match wins.

Parameter	Type	Required	Description
`cond`	`ConditionHandle`	yes	Built from the `Cond::<op>(...)` namespace, e.g. `Cond::equals("42")`.
`target`	`Handle`	yes	Block to route to when the condition matches.

`on_no_matching`

on_no_matching(target: Handle) -> CheckMetricDataHandle

Wire an error transition for NoMatchingError: if no other Error matches.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. if no other Error matches.

`on_no_matching_condition`

on_no_matching_condition(target: Handle) -> CheckMetricDataHandle

Wire an error transition for NoMatchingCondition: if no other Condition matches (only supported if the MetricType is OldestContactInQueueAgeSeconds or NumberOfContactsInQueue).

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingCondition`. if no other Condition matches (only supported if the MetricType is OldestContactInQueueAgeSeconds or NumberOfContactsInQueue).

`set_id`

set_id(id: String) -> CheckMetricDataHandle

Override the auto-generated identifier with a specific wire id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

`meta_position`

meta_position(x: i64, y: i64) -> CheckMetricDataHandle

Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.

Parameter	Type	Required	Description
`x`	`i64`	yes	Canvas X coordinate.
`y`	`i64`	yes	Canvas Y coordinate.

`set_meta`

set_meta(key: String, value: Dynamic) -> CheckMetricDataHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

Parameter	Type	Required	Description
`key`	`String`	yes	Wire key name (under `Metadata.ActionMetadata[<id>]`).
`value`	`Dynamic`	yes	Any JSON-serializable Rhai value.

`overwrite_meta`

overwrite_meta(value: Map) -> CheckMetricDataHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement map for the entire ActionMetadata sub-object.

`set_meta_param`

set_meta_param(param: String, flag: String, value: Dynamic) -> CheckMetricDataHandle

Set a single per-parameter ActionMetadata flag.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name (e.g. `"Text"`).
`flag`	`String`	yes	Flag name (`"useDynamic"`, `"MFLAG_*"`, etc.).
`value`	`Dynamic`	yes	Flag value.

`overwrite_meta_param`

overwrite_meta_param(param: String, value: Map) -> CheckMetricDataHandle

Replace the entire flag map for one parameter.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name.
`value`	`Map`	yes	Replacement flag map for the parameter.

`overwrite_parameters`

overwrite_parameters(value: Map) -> CheckMetricDataHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement parameter map for the block.

`raw_transitions`

raw_transitions(value: Map) -> CheckMetricDataHandle

Wire-shape escape hatch for non-canonical transition objects.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement transitions map (raw JSON shape).