Table of Contents

Search

  1. Preface
  2. Overview, Downloading, and Installing
  3. Administration API
  4. Identity Service API
  5. Screenflow Programming and SDK
  6. ActiveVOS WSHT API
  7. Embedding Request Forms in Standalone Web Pages
  8. XML-JSON for Process Central

7. APIs, SDKs, and Services

7. APIs, SDKs, and Services

Overview, Downloading, and Installing

Overview, Downloading, and Installing

You can download the Informatica Business Process Manager Software Development Kit (SDK) with its application programming interfaces (API) for developing custom applications .
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
Process 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 Process Server services.
orchestration
Contains two sample BPEL orchestration projects for use in Process Developer as well as a deployment archive for a third sample project
src
Empty folder for your source code
WSHT4J
Process Server Web Services Human Task (WS-HT) API. Contains operations for creating a custom BPEL for People application.
XML-JSON-Binding
Process Developer XML-JSON API. Contains documents and samples of HTML form building using the Process Central technologies.
Process Server Administration API
The Process 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.
Process Server Identity Service API
Process 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 (IdentityService4J api).
Screenflow Programming SDK
The Platform SDK contains a business user tool for workflow development called the Guide Designer. The guide designer has a simple interface for creating steps such as screens and automated actions and they can use and modify data in a host system. The guides that you create are applications that run from within a web browser connecting to either an internal or external server. The browser can be within a mobile device such as an iPhone or within a PC or a computer created by Apple.
The Host Provider SDK and associated Service Programming Interface (SPI) allow developers to expose data and operations in their host system to the Designer. At the heart of the system are reusable services that are defined using the powerful Process Developer environment and deployed to the Process Server environment. These services implement the SPI necessary for providing a hosting environment (Host Provider) and are described to the Process Servr using a simple descriptor mechanism.
WS-HumanTask API
Process 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 Process 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 Informatica implementation of the WS-HT specification and Process Server Extension APIs. It also includes a few examples describing the use of the API via SOAP and indirectly via Java code using JAX-WS (WSHT4J API)
We recommend that you read the
WS-HumanTask Architecture
document to get an appreciation of WS-HT. This document will help you understand concepts necessary to the use of the API.
XML-JSON-Binding API
Process Server 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 Process Server service-based processes. This approach allows JavaScript developers to use various libraries such as jQuery to build process-enabled applications.
Process Server uses the JSON binding for Process Central request and task forms. This implementation provides functions that are available for use by developers for process-enabled application projects.
XML-JSON-Binding and Process Central API
Process Central is a client application packaged with Process Server that contains Process Request Forms, Tasks, and Reports. Users of Process 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 Instruction

Copy the SDK archive to your file system and launch Process Developer. Import the archive as follows:
  1. In Process Developer, select File > Import.
  2. Expand the General section, select Existing Projects into Workspace, and select Next.
  3. Select the Select Archive File radio button and browse to the location of the archive.
  4. Select the zip file and select
    Finish
    .
  5. A project named
    com.activevos.api
    opens in your Project Explorer, showing the contents listed in the table above.
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.