Name

OpenXPKI::Server::Workflow::Activity::Tools::SearchWorkflow

Description

Search the workflow table based on given conditions. The default is to search for a single workflow and get its ID back. If you want to search for multiple workflows or need extra information you can pass the mode parameter. The running workflow is always removed from the result.

If no result is found, the targer_key is set to undef.

Also check the documentation of the search_workflow_instances API method.

Search Modes

id: Expect a single (or no) result from the query. If the given query returns more than one item, the search fails with a configuration error.
list: Return the ids of the workflows as list.

Activity Parameter

mode: One of id, list, see description.
realm: The realm to search in, the default is the current realm. You can use the special word _any to search in all realms. Use this with caution!
order: Order the result set by this column
limit: Integer, limit the size of the result set to max items
target_key: Context key to write the search result to, default is search_result.
wf_type, wf_state, wf_creator, wf_proc_state: Values are passed as arguments for the respective workflow properties.
tenant: The tenant to search for, the default is to use the tenant of the current workflow.
attr_*: Any parameter starting with the prefix attr_ is used as query condition to the workflow attributes table, the prefixed is stripped, the remainder is used as attribute key. Values are passed as full text match.