Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 2.68 KB

File metadata and controls

23 lines (15 loc) · 2.68 KB

StepOperationConfig

Configuration for one operation the step's connector handles. The operation arrives on the screening request; the connector decides how to handle it. Two rule sets govern the step, and both are configured here rather than sent per request, so the same call behaves differently across workflows. Trigger rules decide whether the connector runs at all; outcome rules turn the provider's response into the step's verdict. With neither configured the step runs under the connector's own defaults, which for kyt_trmlabs are permissive: the screening completes without consulting the provider. The four parameter lists are the contract for writing those rules: a rule naming a field outside triggerRuleParameters or outcomeEvaluationParameters is rejected. They are derived from the connector registry rather than stored, so a connector gaining a field is reflected here without a migration.

Properties

Name Type Description Notes
operation ScreeningOperationEnum [optional]
requiredParameters List<String> Resolved server-side on every `GetWorkflow` call from the step's connector definition for this operation. Read-only: ignored on write. [optional]
optionalParameters List<String> Like `requiredParameters`, but optional inputs to the operation. [optional]
triggerRuleParameters List<String> Fields a condition in `triggerRuleSetStruct` may reference. [optional]
outcomeEvaluationParameters List<String> Provider response fields a condition in `outcomeRuleSetStruct` may reference. [optional]
outcomeMetaParameters List<String> Additional provider response fields returned with the result; not usable in `outcomeRuleSetStruct` conditions. [optional]
triggerRuleSetStruct RuleSet [optional]
triggerRuleSetJson String The tenant's trigger rules, as a JSON-encoded string. Set for steps whose rules are still defined as a legacy screening policy rather than natively in Compliance Orchestrator, and refreshed on every read. Mutually exclusive with `triggerRuleSetStruct`. [optional]
outcomeRuleSetStruct RuleSet [optional]
outcomeRuleSetJson String The tenant's outcome rules, as a JSON-encoded string. Set for steps whose rules are still defined as a legacy screening policy rather than natively in Compliance Orchestrator, and refreshed on every read. Mutually exclusive with `outcomeRuleSetStruct`. [optional]