APIs, SDKs, and Services > Overview, Downloading, and Installing > APIs and SDKs
  

APIs and SDKs

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.
API or SDK
Description
Informatica Business Process Manager SDK
The Informatica Business Process Manager 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.
The components of this SDK are:
  • - AdminSDK: Process Server Administration API. Contains operations to communicate with the Server.
  • - Identity Service: Contains operations to get users and groups stored in a member directory tied to Process Server services.
  • - WSHT4J: Web Services Human Task (WS-HT) API. Contains operations for creating a custom BPEL for People application.
  • - XML-JSON Binding: XML-JSON API. Contains documents and samples of HTML form building using the Process Central technologies.
For more information, see Overview, Downloading, and Installing.
Alert for Faulting Processes Service
For many reasons, an activity may throw an uncaught fault. Process Server provides the ability to suspend a process on an uncaught fault, and if desired, you can also trigger an alert. For details, search for Alert Service elsewhere in this help.
Automated Step Operations
These operations are part of Guide Designer, which is described later in this table.
Data Access Service
You can interact directly with a data source within a BPEL process by using this service. This service lets you create an invoke activity that executes one or more SQL statements on a specified data source and receives a result set as the response. For details, see Data Access Service elsewhere in this help.
Email Service
Process Server supports an email service. This means you can create a process that sends email messages to a list of recipients using an invoke activity. Many types of processes can benefit from an email delivery activity, including use an Alert Service. For details, see Email Service elsewhere in this help.
Event Action Service
An event-action process receives and handles the events you define in other processes. For details, see Creating an Event-Action BPEL Process elsewhere in this help.
Execute Report Service
This service lets you create a BPEL process that sends a request to the server to take a snapshot of a deployed report, save the report as a PDF, MS Word, or other format, and return it to the process. Within your BPEL process, you provide programming logic to email the report, use it in a People activity, or send it to an endpoint based on an invoked service. You can schedule the process to run daily (or other frequency) to have a daily report emailed. For details, see Reporting Service elsewhere in this help.
Human Task Service
These are the core WS-HT operations
Identity Search Service
An identity service provides a way to look up users and groups based on a defined set of attributes. Process Server support for an identity service is based on the Lightweight Directory Access Protocol (LDAP), JDBC, or a file-based service. For details, see Identity Service elsewhere in this help.
Migration Service
The migration service allows fine grain control over migrating running process instances to a newer (or different) version of a process definition. The simplest way to migrate running processes is to specify this choice in the Process Deployment Descriptor of the newer version being deployed, on the General Deployment Options page. For details, see "Migration Service" elsewhere in this help.
Monitor Alert Service
Process Server provides engine monitoring, and if desired, you can trigger an alert to notify an administrator when an engine stops running or when a monitored property has a warning or error condition. For details, see Monitoring Alert Service elsewhere in this help.
OAuth Service
If your business process needs a system whose resources can be accessed using OAuth authentication, you can use the OAuth system service to allow delegated access to private resources. For details, see Using an OAuth REST-Based System Service elsewhere in this help.
REST Service
You can create web service interaction activities in BPEL that can handle messages based on the Representational State Transfer (REST) architecture rather than WSDL operations. This means that you do not need your own WSDL file in order to create certain types of BPEL processes. You may also access partner REST services from a BPEL process. For details, see Using a REST-based Service elsewhere in this help.
Retry Invoked Service
At times an endpoint may not reply when it is invoked in a BPEL process. In normal circumstances, the invoke faults. To avoid this, you can attach a policy to the endpoint reference in the PDD file to indicate that additional retry attempts are allowed at a specified interval for the end point.
Alternately, you can name a service in the policy section of the PDD file whose job it is to provide a retry interval, that you may want to calculate dynamically, and do additional work programmatically. The service could also specify an alternate endpoint to try when the invoke is faulting or suspended.
For details, see "Retry-Policy Service" elsewhere in this help.
Guide Designer Automated Step Service
For details, see About Guide Designer Host Provider SDK elsewhere in this help.
Server Logging Service
Process Server provides a Server Log which captures the details of server events, such as configuration changes and errors in running processes. You can create a BPEL process to interact with the Server Log so that you can add your own message to the log programmatically. This interaction provides a way to troubleshoot your running processes. For details, see Server Log Service elsewhere in this help.
Shell Command Service
You can create an invoke activity that calls a POJO service to execute a shell command script. You can, for example, call a script that updates a database or adds a new user to an identity service. To use the shell command system service, you must create and locate your script in a working directory that is specified within the input message for the invoke activity. For details, see Shell Command Invoke Service elsewhere in this help.
Task Custom Notification
This process lets you create a custom process to execute for a people activity's notification deadline. For details, see Human Tasks elsewhere in this help.