GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
OpenXPKI::Server::API2::Plugin::Workflow::start_workflow(3) User Contributed Perl Documentation OpenXPKI::Server::API2::Plugin::Workflow::start_workflow(3)

OpenXPKI::Server::API2::Plugin::Workflow::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.

2022-05-14 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.