Skip navigation links

Bonita BPM Engine 7.5 API

This is an overview of Bonita BPM Engine API.

See: Description

Packages 
Package Description
com.bonitasoft.engine.api
The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.
com.bonitasoft.engine.api.converter  
com.bonitasoft.engine.api.impl  
com.bonitasoft.engine.bdm
Provides classes and interfaces for business data models (BDM).
com.bonitasoft.engine.bpm.bar  
com.bonitasoft.engine.bpm.flownode
com.bonitasoft.engine.bpm.parameter
com.bonitasoft.engine.bpm.process
Package com.bonitasoft.engine.bpm.process gathers all model interfaces and exceptions related to process instance / definition objects manipulated by process APIs, and specific to Bonita BPM Subscription Edition.
com.bonitasoft.engine.bpm.process.impl
com.bonitasoft.engine.business.application  
com.bonitasoft.engine.businessdata
com.bonitasoft.engine.connector  
com.bonitasoft.engine.converter  
com.bonitasoft.engine.exception  
com.bonitasoft.engine.log
Provides classes and interfaces for business data (BD) and repository (BDR).
com.bonitasoft.engine.monitoring
com.bonitasoft.engine.platform
Contains classes and interfaces related to the Bonita BPM Platform.
com.bonitasoft.engine.profile
com.bonitasoft.engine.reporting
com.bonitasoft.engine.theme
com.bonitasoft.engine.theme.exception  
org.bonitasoft.engine.api
The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.
org.bonitasoft.engine.api.permission  
org.bonitasoft.engine.bdm
Provides classes and interfaces for business data models (BDM).
org.bonitasoft.engine.bpm
Provides classes and interfaces for BPM basic concepts
org.bonitasoft.engine.bpm.actor
This package contains everything concerning Actor : Definition, Instance, Exceptions, Updater...
org.bonitasoft.engine.bpm.bar
Contains classes and interfaces related to the Java representation of a business archive (*.bar)
org.bonitasoft.engine.bpm.bar.actorMapping
Contains Actor mapping model classes.
org.bonitasoft.engine.bpm.bar.form.model  
org.bonitasoft.engine.bpm.businessdata  
org.bonitasoft.engine.bpm.category
This package contains everything concerning Category : Criterion, Exceptions, Updater...
org.bonitasoft.engine.bpm.comment
This package contains everything concerning Comment : Archived, Search descriptor...
org.bonitasoft.engine.bpm.connector
Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.context
Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.contract
Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.contract.impl
Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.data
This package contains everything concerning Data : Definition, Instance, Exceptions, Criterion...
org.bonitasoft.engine.bpm.document
org.bonitasoft.engine.bpm.flownode
Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.flownode.impl
org.bonitasoft.engine.bpm.form  
org.bonitasoft.engine.bpm.parameter
org.bonitasoft.engine.bpm.process
Package org.bonitasoft.engine.bpm.process gathers all model interfaces and exceptions related to process instance / definition objects manipulated by process APIs.
org.bonitasoft.engine.bpm.process.impl  
org.bonitasoft.engine.bpm.supervisor
org.bonitasoft.engine.bpm.userfilter
org.bonitasoft.engine.business.application  
org.bonitasoft.engine.business.application.impl  
org.bonitasoft.engine.business.data
org.bonitasoft.engine.command
org.bonitasoft.engine.connector  
org.bonitasoft.engine.entitymember
org.bonitasoft.engine.exception
org.bonitasoft.engine.expression
org.bonitasoft.engine.filter  
org.bonitasoft.engine.form  
org.bonitasoft.engine.home
Contains classes related to the Bonita Home.
org.bonitasoft.engine.identity
Manages information about an organization, that is, the set of users who can act in processes and the groups and the organization's roles and the relation between them.
org.bonitasoft.engine.job
org.bonitasoft.engine.operation
Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.page  
org.bonitasoft.engine.platform
Contains classes and interfaces related to the Bonita BPM Platform.
org.bonitasoft.engine.platform.command
Contains classes related to Platform commands.
org.bonitasoft.engine.profile
org.bonitasoft.engine.search
Contains classes to use when invoking search methods
org.bonitasoft.engine.session
org.bonitasoft.engine.theme
org.bonitasoft.engine.theme.exception
org.bonitasoft.engine.util

This is an overview of Bonita BPM Engine API.

Packages in org.bonitasoft.engine are available from Bonita BPM Community Edition, and also in Bonita BPM Subscription Editions
However, packages in com.bonitasoft.engine are only available for Bonita BPM Subscription Edition developers.

The main classes to start with are:

A good starting point on using Bonita BPM Engine APIs is Bonita documentation website

Here is a simple example of an Engine API (here, the IdentityAPI):

// First of all, log in:
final LoginAPI loginAPI = TenantAPIAccessor.getLoginAPI();
APISession session = loginAPI.login(userName, password);

// Then access any Bonita BPM Engine API:
IdentityAPI identityAPI = TenantAPIAccessor.getIdentityAPI(session);

// For instance, get the current logged in user (yourself):
User myself = identityAPI.getUser(session.getUserId());

// ... do something with the User ...

// don't forget to log out:
loginAPI.logout(session);

Skip navigation links

Copyright © 2017 Bonitasoft S.A.. All rights reserved.