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


Manual Reference Pages  -  OPENXPKI::SERVER::API::WORKFLOW (3)

.ds Aq ’

    get_workflow_ui_info

Return a hash with the information taken from the workflow engine plus additional information taken from the workflow config via connector. Expects one of:
ID numeric workflow id
TYPE workflow type
WORKFLOW workflow object

    create_workflow_instance

Limitations and Requirements:

Each workflow MUST start with a state called INITIAL and MUST have exactly one action. The factory presets the context value for creator with the current session user, the inital action SHOULD set the context value ’creator’ to the id of the (associated) user of this workflow if this differs from the system user. Note that the creator is afterwards attached to the workflow as attribtue and would not update if you set the context value later!

Workflows that fail on complete the inital action are NOT saved and can not be continued.

    get_workflow_instance_types

Load a list of workflow types present in the database for the current realm and add label and description from the configuration.

Return value is a hash with the type name as key and a hashref with label/description as value.

Name

OpenXPKI::Server::API::Workflow

CONTENTS

Description

This is the workflow interface which should be used by all user interfaces of OpenXPKI. A user interface MUST NOT access the server directly. The only allowed access is via this API. Any function which is not available in this API is not for public use. The API gets access to the server via the ’server’ context object. This object must be set before instantiating the API.

Functions

    new

Default constructor created by Class::Std.

    list_workflow_titles

Returns a hash ref containing all available workflow titles including a description.

Return structure: {
title => description,
... }

    search_workflow_instances

This function accesses the database directly in order to find Workflow instances matching the specified search criteria.

Returns an array reference of the database query result.

Named parameters:
o CONTEXT

The named parameter CONTEXT must be a hash reference. Apply search filter to search using the KEY/VALUE pair passed in CONTEXT and match all Workflow instances whose context contain all of the specified tuples. It is possible to use SQL wildcards such as % in the VALUE field.

Examples:



  my @workflow_ids = $api->search_workflow_instances(
      {
      CONTEXT =>
          {
          KEY   => SCEP_TID,
          VALUE => ECB001D912E2A357E6E813D87A72E641,
          },
      }



o TYPE (optional)

The named parameter TYPE can either be scalar or an array reference. Searches for workflows only of this type / these types.

o STATE (optional)

The named parameter TYPE can either be scalar or an array reference. Searches for workflows only in this state / these states.

o LIMIT (optional)

If given, limits the amount of workflows returned.

o START (optional)

If given, defines the offset of the returned workflow (use with LIMIT).

    search_workflow_instances_count

Works exactly the same as search_workflow_instances, but returns the number of results instead of the results themselves.

    __get_workflow_factory

Get a suitable factory from handler. If a workflow id is given, the config version and realm are extracted from the workflow system.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 OPENXPKI::SERVER::API::WORKFLOW (3) 2016-04-03

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