NAME

OpenXPKI::Server::API2::Plugin::Workflow::start_workflow

COMMANDS

start_workflow

Start a workflow by running the initial action for an instance that was persisted earlier with create_workflow_instance(norun = persit)>.

By default, the activity is executed "inline", all actions are handled and the method returns a HashRef with the UI control structure of the new workflow state. Use parameters "async" and/or "wait" for "background" execution using a newly spawned process (see below).

"id" Int - workflow id
"ui_info" Bool - set to 1 to have full information HashRef returned, otherwise only workflow state information is returned. Default: 0
"async" Bool - "background" execution (asynchronously): forks a new process. Optional.
Return HashRef contains the UI control structure of the OLD workflow state.
"wait" Bool - wait for background execution to start (monitors the database, max. 15 seconds). Optional.
Return HashRef contains the UI control structure of the current state of the running workflow. Please note that this might be the next step or any following step as this depends on random timing, i.e. when the monitoring loop happens to check the database again.