OpenXPKI::Server::API2::Plugin::Workflow::Util(3)

validate_input_params

Validates the given parameters against the field spec of the current activity and returns

Currently NO check is performed on data types or required fields to not break old code.

Currently returns the input parameter HashRef on success. Throws an exception on error.

Positional parameters

$workflow (Str) - workflow type / name
$activity (Str) - workflow activity
$params (HashRef) - parameters to validate

execute_activity

Executes the named activity on the given workflow object.

See API command "execute_workflow_activity" for more details.

Returns an OpenXPKI::Workflow object.

Positional parameters

$workflow Str - workflow type / name
$activity Str - workflow activity
$async Bool - "background" execution: forks a new process.
$wait Bool - wait for background execution to start (max. 15 seconds).
$role Str - run as role (implies async)

_execute_activity_sync

Executes the named activity on the given workflow object.

Returns 0 on success and throws exceptions on errors.

Positional parameters

$workflow (Str) - workflow type / name
$activity (Str) - workflow activity

_execute_activity_async

Execute the named activity on the given workflow object ASYNCHRONOUSLY, i.e. forks off a child process.

Returns the PID of the forked child.

Positional parameters

$workflow (Str) - workflow type / name
$activity (Str) - workflow activity
$role (Str) - role to run as

get_wf_info

Returns informations about a workflow from the workflow engine and the config as a HashRef:

    {
        workflow => {
            type        => ...,
            id          => ...,
            state       => ...,
            label       => ...,
            description => ...,
            last_update => ...,
            proc_state  => ...,
            count_try   => ...,
            wake_up_at  => ...,
            reap_at     => ...,
            archive_at  => ...,
            context     => { ... },
            attribute   => { ... },   # only if "with_attributes => 1"
        },

        # only if "with_ui_info => 1":
        handles  => [ ... ],          # global actions currently allowed: "wakeup", "resume", "fail" etc.
        activity => { ... },          # currently available actions
        state => {
            button => { ... },
            option => [ ... ],
            output => [ ... ],
        },
    }

The workflow can be specified using an ID or an OpenXPKI::Server::Workflow object.

Named parameters:

"id" Int - numeric workflow id
"workflow" OpenXPKI::Server::Workflow - workflow object
"activity" Str - only return informations about this workflow action. Default: all actions available in the current state.
Note: you have to prepend the workflow prefix to the action separated by an underscore.
"with_attributes" Bool - set to 1 to get the extra attribute informations
"with_ui_info" Bool - set to 1 to get the extra UI informations about workflow actions and state

watch

Watch a workflow for changes based on the "workflow_state", "workflow_proc_state" and "workflow_last_update" columns.

Expects the workflow object as parameter.

The method returns the changed workflow object if a change was detected or the initial workflow object if no change happened after 15 seconds.