FilterActor

The FilterActor (filter actor) is a Coral Actor that emits the received JSON when all the defined filter(s) match. Filters match on a defined field in the JSON and can be either include (received JSON is emitted when filter applies) or exclude (received JSON is emitted when the filter doesn’t apply).

Creating a FilterActor

The creation JSON of the filter actor (see Coral Actor) has type: "filter". The params value is a JSON array with at least one filter. Each filter is a JSON object with the following fields:

field	type		description
`type`	string	required	only `startswith` is currently supported.
`function`	string	required	`exclude` or `include`.
`field`	string	required	the field in the trigger JSON to which the filter is applied.
`param`	string	required	the parameter for the given type, for `startswith` the start of the field.

Example

{
  "data": {
    "type": "actors",
    "attributes": {
      "type": "filter",
      "params": [{
        "type": "startswith",
        "function": "include",
        "field": "url",
        "param": "/site/"
      }]
    }
  }
}

This will create a filter actor for the field url. Only when the trigger JSON has a field url and this field starts with “/site/”, the trigger JSON is emitted.

Trigger

The FilterActor only does useful work if the trigger is connected.

Emit

The FilterActor emits the received JSON when all the filters match. Otherwise, nothing is emitted.

State

The FilterActor doesn’t keep state.

Collect

The FilterActor does not collect state from other actors.

Timer

The FilterActor does not provide timer actions.

CORAL WIKI

Actors

Getting started

Overview