About the ActiveVOS Software Development Kit

The ActiveVOS Software Development Kit (SDK) provides application programming interfaces (API) for developing custom applications. Along with the APIs, the SDK project includes common libraries, resources, example code, and documentation to help you develop your application.

You can download the ActiveVOS SDK from:

http://www.activevos.com/dev/sdks/com.activevos.api.zip

When you unzip the SDK, it includes the following folders:

Directory	Description
.settings	Files required for using the Java project in Eclipse
AdminSDK	ActiveVOS Server Administration API. Contains operations to communicate with the Server.
common	Java dependencies for builds and runtime of jax-ws clients
Identity Service	Identity Service API. Contains operations to get users and groups stored in a member directory tied to ActiveVOS services.
orchestration	Contains two sample BPEL orchestration projects for use in ActiveVOS Designer as well as a deployment archive for a third sample project
src	Empty folder for your source code
WSHT4J	ActiveVOS Web Services Human Task (WS-HT) API. Contains operations for creating a custom BPEL for People application.
XML-JSON-Binding	ActiveVOS XML-JSON API. Contains documents and samples of HTML form building using the ActiveVOS Central technologies.

ActiveVOS Server Administration API

The ActiveVOS Server provides an administration interface that is accessible via WSDL-defined web service invocations or directly using Java classes. The AdminSDK folder includes projects and documentation describing how to interact with the API using both techniques. The contents of the folder was developed using version 7.x of ActiveVOS.

ActiveVOS Identity Service API

ActiveVOS Server provides an identity service to enable processes to look up users and groups in an enterprise directory service. The Identity Service folder describes the identity service API and includes a few examples on using the API via SOAP and indirectly via Java code using JAX-WS (ActiveVOS IdentityService4J api).

ActiveVOS WS-HumanTask API

ActiveVOS Server implements the operations described by the OASIS WS-HumanTask (WS-HT) API task client specifications to manage human tasks as well as interact with specific tasks. In addition to WS-HT API, the ActiveVOS Server also provides an extension API to the OASIS WS-HT API with enhanced functionality. The documents in the WSHT4J folder introduce you to the Active Endpoint implementation of the WS-HT specification and ActiveVOS Extension APIs. It also includes a few examples describing the use of the API via SOAP and indirectly via Java code using JAX-WS (ActiveVOS WSHT4J API)

We recommend that you read the WS-HumanTask Architecture PDF document in the docs folder to get an appreciation of WS-HT. This document will help you understand concepts necessary to the use of the API.

ActiveVOS XML-JSON-Binding API

ActiveVOS 7.1 or later exposes all its processes and services via simple XML and JavaScript Object Notation (JSON) bindings in addition to SOAP, REST and JMS. The XML (and JSON) binding makes it easy for application developers already familiar with XML/JSON-based REST application development to invoke processes and obtain responses from them.

Using XML or JSON bindings frees developers from the need to obtain and learn SOAP libraries to build applications that leverage ActiveVOS service-based processes. This approach allows JavaScript developers to use various libraries such as jQuery to build process-enabled applications.

ActiveVOS uses the JSON binding for ActiveVOS Central request and task forms. This implementation provides functions that are available for use by developers for process-enabled application projects.

ActiveVOS XML-JSON-Binding and ActiveVOS Central API

ActiveVOS Central is a client application packaged with ActiveVOS that contains Process Request Forms, Tasks, and Reports. Users of ActiveVOS Central can start a process that has been deployed to the server, work on tasks that are part of a running process, and view reports pertinent to tasks.

SDK Installation Instructions

Copy the SDK archive to your file system and launch ActiveVOS Designer. Import the archive as follows:

In ActiveVOS Designer, select File > Import.
Expand the General section, select Existing Projects into Workspace, and select Next.
Select the Select Archive File radio button and browse to the location of the archive.
Select the zip file and select Finish.
A project named com.activevos.api opens in your Project Explorer, showing the contents listed in the table above.

Note: This project contains two nested orchestration projects. We highly recommend that you import the orchestration projects into your workspace separately if you plan to modify them. Eclipse does not treat a child project as an exclusive project and your modified files will not be contained in the child project.