Custom Rule Actions

Table of Contents

Configuration options

Custom rule actions allow you to define a unique action to take when certain conditions are met. They involve three primary components: a query pipeline, a custom rule type, and a rule that is triggered by conditions defined by the user.

For more information, see Custom Rule Actions Concepts. To learn use custom rule actions with the API, see Create Custom Rule Actions with the API.

Configuration options

Required Parameter Description Example

Required	Parameter	Description	Example
✓	`id`	A unique ID for the custom rule type. The `id` value must be unique across all apps in Fusion (global namespace).	`custom-rule-type`
✓	`pipeline_id`	The ID of the pipeline that is invoked during rule processing.	`custom-rule-pipeline`
✓	`display_type`	A user-friendly name for the custom rule type.	`My Custom Rule`
Rule properties, included as part of the `schema`, define the values required from the user to create a rule that uses the custom rule type.
✓	`custom_param1`	The ID of the rule’s parameter. This field is used in the API but is not visible in the Rules Editor.	`1st-rule-parameter`
✓	`type`	The type of user-input.	`string`
✓	`title`	A user-friendly name for the parameter.	`Manufacturer`
✓	`description`	A user-friendly description of what the field is used for. The `description` value is shown in the field’s tooltip in the Rules Editor.	`The manufacturer of the product this rule action applies to.`

✓

id

A unique ID for the custom rule type. The id value must be unique across all apps in Fusion (global namespace).

custom-rule-type

✓

pipeline_id

The ID of the pipeline that is invoked during rule processing.

custom-rule-pipeline

✓

display_type

A user-friendly name for the custom rule type.

My Custom Rule

Rule properties, included as part of the schema, define the values required from the user to create a rule that uses the custom rule type.

✓

custom_param1

The ID of the rule’s parameter. This field is used in the API but is not visible in the Rules Editor.

1st-rule-parameter

✓

type

The type of user-input.

string

✓

title

A user-friendly name for the parameter.

Manufacturer

✓

description

A user-friendly description of what the field is used for. The description value is shown in the field’s tooltip in the Rules Editor.

The manufacturer of the product this rule action applies to.