ruleset

simetrik ruleset create

Create a reconciliation rule set.

Creates a rule set on a reconciliation — a named, ordered group of matching rules. Each rule in the --rules JSON array needs name, column_a_id, column_b_id, and operator, where the column IDs are the reconciliation's already-resolved columns. Both --name and --rules are required; malformed --rules or --robustness JSON exits 2 before any API call.

Use this when you have concrete column IDs to match on. Prefer simetrik recon cross-create instead when you'd rather reference raw source column IDs and let the reconciliator resolve chained columns. Set --position to order rule sets by priority (default 1) and --robustness as a JSON array of two floats (e.g. [0.8,1.0]).

See also: ruleset update, ruleset describe, recon cross-create. Writes use reconciliations · create_edit_configure. See permissions.

Arguments

• recon_id — Reconciliation ID

Flags

• -n, --name <n> — Rule set name
• --rules <json> — JSON array of rules. Each rule requires name, column_a_id, column_b_id, operator.
• --position <n> — Rule set position
• --robustness <json> — Robustness thresholds as JSON array of 2 floats: "[0.8, 1.0]"
• -f, --format <fmt> — Output format

Examples

simetrik ruleset create 4567 --name "Amount + date" --rules '[{"name":"amount","column_a_id":11,"column_b_id":21,"operator":"="}]'
simetrik ruleset create 4567 --name "Fallback" --position 2 --rules '[{"name":"ref","column_a_id":13,"column_b_id":23,"operator":"="}]' --robustness '[0.8,1.0]'

Exit codes

simetrik ruleset update

Update a rule set (optionally replaces all rules).

Updates an existing rule set, identified by its rule set ID (not the reconciliation ID). You can change --name, --position, --robustness, and the rules themselves. Passing --rules replaces all rules in the set with the array you supply — it is not a merge — so include every rule you want to keep. Malformed --rules or --robustness JSON exits 2 before any API call.

Use this to tune an existing rule set; use simetrik ruleset create to add a new one to the reconciliation, and simetrik ruleset describe first if you need to see the current rules before replacing them.

See also: ruleset create, ruleset describe, ruleset delete. Writes use reconciliations · create_edit_configure. See permissions.

Arguments

• rule_set_id — Rule set ID

Flags

• -n, --name <n> — New rule set name
• --rules <json> — JSON array of rules (replaces all)
• --position <n> — Rule set position
• --robustness <json> — Robustness thresholds as JSON
• -f, --format <fmt> — Output format

Examples

simetrik ruleset update 8901 --name "Amount + date (v2)"
simetrik ruleset update 8901 --rules '[{"name":"amount","column_a_id":11,"column_b_id":21,"operator":"="}]'
simetrik ruleset update 8901 --position 1 --robustness '[0.9,1.0]'

Exit codes

simetrik ruleset delete

Delete a rule set.

Deletes a rule set from its reconciliation, identified by rule set ID. The reconciliation will no longer apply that set's matching rules on its next run. By default the command prompts for confirmation before deleting; pass --yes to skip the prompt in scripts and non-interactive contexts.

Use this to remove a rule set you no longer need. To change a rule set's rules without removing it, use simetrik ruleset update (note that passing --rules there replaces all rules rather than deleting the set).

See also: ruleset update, ruleset describe, ruleset create. Writes use reconciliations · create_edit_configure. See permissions.

Arguments

• rule_set_id — Rule set ID

Flags

• -y, --yes — Skip confirmation
• -f, --format <fmt> — Output format

Examples

simetrik ruleset delete 8901
simetrik ruleset delete 8901 --yes

Exit codes

simetrik ruleset describe

Describe a rule set with matching rules inline.

Returns a single rule set with its matching rules listed inline, identified by rule set ID. Use this to inspect exactly how a rule set matches — its rules, their columns, and operators — before editing it with simetrik ruleset update or removing it with simetrik ruleset delete.

This is read-only and narrower than simetrik recon describe, which lists all of a reconciliation's rule sets at once. Reach for recon describe to discover rule set IDs, then this to drill into one.

See also: recon describe, ruleset update, ruleset delete. Requires CLI access to the workspace. See permissions.

Arguments

• ruleset_id — RuleSet ID

Flags

• -f, --format <fmt> — Output format: json|table

Examples

simetrik ruleset describe 8901
simetrik ruleset describe 8901 --format table

Exit codes