Trigger Object¶
The Trigger Object defines the pieces needed to create a work order to execute by a runner.
| Field | Definition |
|---|---|
| AllInFilter | AllInFilter if true cause a work_order created for all machines in the filter |
| Blueprint | Blueprint is template to apply |
| Description | Description is a string for providing a simple description |
| Documentation | Documentation is a string for providing additional in depth information. |
| Enabled | Enabled is this Trigger enabled |
| Filter | Filter is a "list"-style filter string to find machines to apply the cron too Filter is already assumed to have WorkOrderMode == true && Runnable == true |
| FilterCount | FilterCount defines the number of machines to apply the work_order to. Only one work_order per trigger fire. |
| MergeDataIntoParams | MergeDataIntoParams if true causes the data from the trigger to be merged into the Params of the work_order. |
| Meta | Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata |
| Name | Name is the key of this particular Trigger. required: true |
| Params | Params holds the values of parameters on the object. The field is a key / value store of the parameters. The key is the name of a parameter. The key is of type string. The value is the value of the parameter. The type of the value is defined by the parameter object. If the key doesn't reference a parameter, the type of the object can be anything. The system will enforce the named parameter's value's type. Go calls the "anything" parameters as "interface {}". Hence, the type of this field is a map[string]interface{}. |
| Profiles | Profiles is an array of profiles to apply to this object in order when looking for a parameter during rendering. |
| QueueMode | QueueMode if true causes work_orders to be created without a machine, but with a filter for delayed operation |
| StoreDataInParameter | StoreDataInParameter if set tells the triggers data to be stored in the parameter in the Params of the work_order. |
| TriggerProvider | TriggerProvider is the name of the method of this trigger |
| WorkOrderParams | WorkOrderParams that have been directly set on the Trigger and will be moved to the work order. |
| WorkOrderProfiles | WorkOrderProfiles to apply to this machine in order when looking for a parameter during rendering. |