UI Methods

action_index

instance creation

If you pass wf_type, a new workflow instance of this type is created, the inital action is executed and the resulting state is passed to __render_from_workflow.

generic action

The generic action is the default when sending a workflow generated form back to the server. You need to setup the handler from the rendering step, direct posting is not allowed. The cgi environment must present the key wf_token which is a reference to a session based config hash. The config can be created using __register_wf_token, recognized keys are:

wf_fields

An arrayref of fields, that are accepted by the handler. This is usually a copy of the field list send to the browser but also allows to specify additional validators. At minimum, each field must be a hashref with the name of the field:

    [{ name => fieldname1 }, { name => fieldname2 }]
    

Each input field is mapped to the contextvalue of the same name. Keys ending with empty square brackets "fieldname[]" are considered to form an array, keys having curly brackets "fieldname{subname}" are merged into a hash. Non scalar values are serialized before they are submitted.

wf_action

The name of the workflow action that should be executed with the input parameters.

wf_handler

Can hold the full name of a method which is called to handle the current request instead of running the generic handler. See the __delegate_call method for details.

If there are errors, an error message is send back to the browser, if the workflow execution succeeds, the new workflow state is rendered using __render_from_workflow.

action_handle

Execute a workflow internal action (fail, resume, wakeup, archive). Requires the workflow and action to be set in the wf_token info.

action_load

Load a workflow given by wf_id, redirects to init_load

action_select

Handle requests to states that have more than one action. Needs to reference an exisiting workflow either via "wf_token" or "wf_id" and the action to choose with "wf_action". If the selected action does not require any input parameters (has no fields) and does not have an ui override set, the action is executed immediately and the resulting state is used. Otherwise, the selected action is preset and the current state is passed to the __render_from_workflow method.

action_search

Handler for the workflow search dialog, consumes the data from the search form and displays the matches as a grid.

action_bulk

Receive a list of workflow serials (wf_id) plus a workflow action (wf_action) to execute on those workflows. For each given serial the given action is executed. The resulting state for each workflow is shown in a grid table. Methods that require additional parameters are not supported yet.

__check_for_validation_error

Uses last_reply to check if there was a validation error. If a validation error occured, the field_errors hash is returned and the status variable is set to render the errors in the form view. Returns undef otherwise.