UI Methods

init_index

Requires parameter wf_type and shows the intro page of the workflow. The headline is the value of type followed by an intro text as given as workflow description. At the end of the page a button names "start" is shown.

This is usually used to start a workflow from the menu or link, e.g.

    workflow!index!wf_type!change_metadata

init_start

Same as init_index but directly creates the workflow and displays the result of the initial action. Normal workflows will result in a redirect using the workflow id, volatile workflows are displayed directly. This works only with workflows that do not require any initial parameters.

init_load

Requires parameter wf_id which is the id of an existing workflow. It loads the workflow at the current state and tries to render it using the __render_from_workflow method. In states with multiple actions wf_action can be set to select one of them. If those arguments are not set from the CGI environment, they can be passed as method arguments.

init_context

Requires parameter wf_id which is the id of an existing workflow. Shows the context as plain key/value pairs - usually called in a popup.

init_attribute

Requires parameter wf_id which is the id of an existing workflow. Shows the assigned attributes as plain key/value pairs - usually called in a popup.

init_info

Requires parameter wf_id which is the id of an existing workflow. It loads the process information to be displayed in a modal popup, used mainly from the workflow search / result lists.

Render form for the workflow search. #TODO: Preset parameters

init_result

Load the result of a query, based on a query id and paging information

init_export

Like init_result but send the data as CSV download, default limit is 500!

init_pager

Similar to init_result but returns only the data portion of the table as partial result.

init_history

Render the history as grid view (state/action/user/time)

init_mine

Filter workflows where the current user is the creator, similar to workflow search.

init_task

Outstanding tasks, filter definitions are read from the uicontrol file

init_log

Load and display the technical log file of the workflow

__render_task_list

Expects a hash that defines a workflow query and output rules for a tasklist as defined in the uicontrol section.