LetsFlow
Search…
Advanced topics
Actor
An actor is an identity that participates on a process. The actors are defined in a scenario as JSON Schema and instantiated for the process.
Scenario actor
Items in the
actors property of the scenario aren't actor objects, but JSON schemas defining the properties available for the actor once instantiated in the process.The custom schema for actors should extend the basic actor schema, which means it must at least have a
title and identity and property.YAML
JSON
1
actors:
2
employer:
3
type: object
4
title: Employer
5
properties:
6
title:
7
type: string
8
name:
9
type: string
10
email:
11
type: string
12
format: email
13
identity:
14
$ref: "https://specs.letsflow.io/v0.2.0/identity/schema.json#"
15
employee:
16
$ref: "https://specs.letsflow.io/v0.2.0/actor/schema.json#employee"
Copied!
1
{
2
"actors": {
3
"employer": {
4
"type": "object",
5
"title": "Employer",
6
"properties": {
7
"name": {
8
"type": "string"
9
},
10
"identity": {
11
"$ref": "https://specs.letsflow.io/v0.2.0/identity/schema.json#"
12
}
13
}
14
},
15
"employee": {
16
"$ref": "https://workflow.example.com/actors/employee/schema.json#"
17
}
18
}
19
}
Copied!
Properties that aren't defined don't exist and can't be set, unless
additionalProperties is set in the actor definition.Actor schema
https://specs.letsflow.io/v0.2.0/actor/schema.json#$schema
title
The title of the actor. This is copied from the actor definition in the scenario.
identity
The identity links a person or organization to an actor.
If another party takes over a role, the
identity property of the actor in the process should change and not the keys of the identity. For instance if there is a change in supplier in the process, don't update the identity keys, but add an identity and switch the identity linked to the actor.Last modified 2yr ago
Copy link