Workflow reference: CfFlow Functions

CfFlow Functions

Preside registers several functions with the CfFlow library that can be used throughout your CfFlow workflow definitions, i.e.

actions:
  pre:
  - ref: coldbox.Handler
    args:
      event: my.custom.action

This page gives details of all the functions made available by Preside.

Functions

Coldbox functions

coldbox.Handler

The coldbox.Handler function allows you to trigger an arbitrary Coldbox handler.

In addition to the optionally provided args, your handler will receive the wfInstance on which the condition is operating.

Args

| Name | Description | |-------|--------| | event | Required. The coldbox event id to execute | | args | Optional. The args struct to send to the handler |

Example

actions:
  post:
    ref: coldbox.Handler
    args:
      event: email.Send
      args:
        template: registrationNotification

// /handlers/Email.cfc
component {

	// ...

	private void function send( event, rc, prc, args={}, wfInstance ) {
		var state = wfInstance.getState();

		sendEmail( template=args.template ?: "", args=state );
	}

}