You are on page 1of 61

BOS 5.

6
In this section:
Welcome
For Business Analysts
For Process Engineers
For Application Developers
For System Administrators
For Process Administrators
General
Getting Started
Process Design
Connectivity
Data and Variables
Form [field] Design
Web applications
System Administration
LDAP synchronization
Process Administration
Document management
Process Simulation
End Users
Development

Welcome
The new online documentation system for Bonita Open Solution contains descriptions and
how-tos (tutorials) for the many features and functions available in the Open Source and
Subscription Package versions of Bonita Open Solution.
The documentation is organized by section.

Functional Guides
The first 5 chapters organize information by role, pointing to the sections in the
documentation below that are most likely to be of interest to the Business
Analyst (process modeling), the Process Engineer (model completion for execution),
the Application Developer (applications for Web deployment), the System
Administrator (setting up Bonita Open Solution), and the Process
Administrator (managing deployed processes). These sections are aligned with User
Guidance in Bonita Open Solution.

Features Description and Tutorials


The rest of the documentation is generally organized by function as each group of features
are applied to model, connect, deploy, and manage processes using Bonita Open
Solution. The Table of Contents to the left of this page collapses and expands. Explore
this, and the pages beneath it, to become familiar with the documentation organization.
An advanced search feature is in development and will be added soon.
This online documentation system is a work in progress - we will be continuing to add
more complete information, connect links, and build cross-references.
Your feedback will help us improve the documentation. You can report errors, incomplete
or missing information, and other issues via the community bug report function available
in Report Issues. Add your issue to the Project titled Documentation Feedback. We'll do
our best to get it fixed promptly.
- The BonitaSoft Documentation Team
http://www.bonitasoft.com/resources/documentation/bos-56/business-analysts

For Business Analysts


This guide includes features for visually modeling business processes.
Jump directly to each section using the links below.
(You can always navigate among all topics in the documentation using the Menu/Table of
Contents at the left.)

Process Design
Create a new diagram
Create a new pool
Add a Task
Define a transition (draw)
Add a gate
Timer events
Message flow
Call Activity

Define Actors
Create a new lane

Change appearance
Change color and font

Check BPMN model


Check BPMN model (Set process validation)
Basic actions
Text annotations
Generate Documentation
Generate process documentation
Share
Print a diagram
Export a diagram
Import a diagram
Simulation
Simulation
Multi-instantiation
Multi-instantiation
Configure events
Configure Timer
Configure Messages
We are planning a printable version of this Guide. Check back!
For Application Developers
This guide includes features for visually modeling business processes, plus technical
implementation details to develop an executable model.

Jump directly to each section using the links below.


(You can always navigate among all topics in the documentation using the Menu/Table of
Contents at the left.)

Process Design
o Diagram
o Pool
o Lane
o Tasks
o Set process validation
o Transitions (conditions, decision table)
o Gateways
o Timer events
o Message events
o Text annotations
o Generate process documentation
o Multi-instantiation
o Change appearance of design elements
Executable Design
o Actors selection and assignment
o Data and variables
o Connectors (add, test, debug)
o Contexts
o KPIs/BAM
Application Design
o Form (field) design
o Web applications
o Translation / choose language for forms
Simulation
o Simulation
Run
o Run
We are planning a printable version of this Guide. Check back!
For System Administrators
This guide includes features and instructions for installation, deployment, and version migration
for Bonita Open Solution.

Jump directly to each section using the links below. (You can always navigate among all topics in
the documentation using the Menu/Table of Contents at the left.)

Installations
o Simple BOS installation on a single PC
o Request a BOS Subscription Pack license for a development or production
environment
o Install a BOS-Tomcat or BOS-JBoss bundle
o Install BOS "from scratch"
o Configure BOS for use with other databases
o Configure multi-tenancy
Version migration
LDAP synchronization
We are planning a printable version of this Guide. Check back!

For Process Administrators


This guide includes explanations about features for managing deployed processes.

Jump directly to each section using the links below. (You can always navigate among all topics in
the documentation using the Menu/Table of Contents at the left.)

Bonita User Experience


o Manage processes
o Manage cases
o Manage steps
o Manage users
o Monitoring & reporting
o Document management
We are planning a printable version of this Guide. Check back!
Process Design
In this section:
BPMN
User Guidance
Process templates
Working in Bonita Studio
Expression editor (Groovy script editor)
Configure KPI / BAM (SP)
Subprocesses
Multi-instantiation
Loop a task or a call activity
Define an asynchronous sequence
Contexts (SP)
Actor selection and assignment
Design collaboration (SP)
Generate process documentation (SP)
Select a new language for Bonita Studio
Import community contribution
Run a process
Export process for installation / deployment
Access log files
In this section, you will find all the tools you will need to design your processes using BPMN
2.0 compliant elements and simple drag and drop techniques.
...

BPMN
BPMN stands for Business Process Model and Notation.
It is a standard notation and graphical representation designed to depict business
processes. BPMN is intended as a common language for all BPM project stakeholders:
business analysts who create and refine the processes
technical developers responsible for implementing the processes and
business managers who monitor and manage the processes

BPMN 2.0 specifications and the Object Management Group


BPMN 2.0, the latest version of BPMN, was released in January 2011.

"This specification provides a notation and model for Business Processes and an
interchange format that can be used to exchange BPMN Process definitions (both domain
model and diagram layout) between different tools. The goal of the specification is to
enable portability of Process definitions, so that users can take Process definitions created
in one vendor's environment and use them in another vendor's environment".
(c.f. Object Management Group)

Bonita Open Solution and BPMN


Bonita Studio is consistent with BPMN 2.0 specifications for process
modelling. (see OMG: BPMN 2.0 - Chapter 2: Conformance)
Bonita Open Solution uses the following BPMN process types set out in the OMG
conformance specifications:
BPMN core elements
process diagrams
collaboration diagrams (which include pools and message flow)
The Process Modeling Conformance type set consists of BPMN elements:
task types
embedded tub-Processes
call activity
gateways
event types (Start, Intermediate, and End)
lane
data object (including DataInput and DataOutput)
messages
groups
text annotation
sequence flow (including conditional and default flows)
message flow
A BPMN Elements Description will be generated with Process Documentation.
User Guidance
In this section:
Apply User Guidance checklist
Select / change User Guidance profile
Create a custom User Guidance profile
User Guidance consists of 2 parts:

User Guidance profiles


User Guidance checklists
USER GUIDANCE PROFILES
A Bonita Studio user can choose one of 3 default profiles. Each profile filters the features
presented in Bonita Studio. By disabling some features that you don't need at the moment, you'll
have a cleaner, less cluttered Bonita Studio interface.
You can select one from among these profiles, or change profiles at any time.
Business Analyst
Process Engineer
Application Developer
USER GUIDANCE CHECKLISTS
When you apply the User Guidance feature, there is a User Guidance checklist tailored to the
active profile.
Each item in the task list is accompanied by a brief explanation and a link to more complete
documentation.
This provides a recommended order for process model design, and the task can be checked
off as completed as you proceed.
In Bonita Open Solution Subscription Pack, User Guidance profiles can be customized, that is, you
can name a new profile, and pick and choose which features to include in Bonita Studio for that
profile, and which tasks to include on its User Guidance task list.
Process Templates
This feature is available in BOS Efficiency version only.
A number of different process templates can be downloaded on-line from the template library,which can be
accessed via theWelcome page of Bonita Studio.
Import a process template and then modify it according to your specific needs.

How To Import A Process Template


Go to the Welcome page > Design panel > Process templates > then click on Get
your process templates.

Figure 1. Click on Get your process templates.


This will take you to the download page on Bonitasoft website.
Figure 2. Download page for process templates.
Here you can choose from a number of different process templates adapted to various
professional sectors.

Figure 3. The template is


imported
RESULT
Figure 4. Process template is ready to be customized
Once imported into Bonita Studio, you can customize the process template to your
needs.
Working In Bonita Studio
In this section:
Tour of Bonita Studio
Diagram
Pool
Lane
Tasks
Transitions (flow)
Gateways
Start events
End events
Intermediate events
Boundary events
Link events
Error events
Message events
Timer events
Signal events
Text annotations
Other element details
Connectors
Data and variables
KPI / BAM
Creating forms
Set Bonita Studio preferences
Change the appearance of design elements
Design manipulation tools
Set process validation
Bonita Studio is the graphic design interface of Bonita Open Solution. This section describes the
use of Business Process Management standard notation (BPMN 2.0) to draw your processes step
by step on the whiteboard, using tools contained in the design and context palettes.
Expression Editor (Groovy Script Editor)
The expression editor is available throughout Bonita Studio, to create scripts in the form of expressions in
Groovy. It comes up each time you click on Edit expression.

Figure 1. Expression editor


If you need to apply operations to the output of a connector, for example, before it is stored as the value of a
variable, you can use Groovy to create the expression.

How To Use The Expression Editor (Groovy Script Editor)


Click on edit expression anywhere in Bonita Studio, for example:
Click on a task in a pool, and in its Details panel > Application tab > Entry
pageflow, Add or Edit a form.
Select a text widget on the form, and in its Details panel > General tab >
Data pane, select Edit expression.
After a few seconds the expression editor will appear.
Figure 2. Expression editor appears
Enter the script in the field for entering an expression. Use the provided tools and
shortcuts as needed.

For example, all defined process data variables are offered in a drop-down menu in the
list at the top.
Figure 3. Select variables to use in Groovy expressions
Bonita variables are also available from a drop-down menu at the top of the editor.
Figure 4. System variables are also available to use in expressions
A set of Groovy expressions is available in Categories; click on the script highlighted in
Functions to load it into the editor.

Figure 5. Find predefined Groovy functions


When the expression is valid, click on Set Variables to enter test data.
Figure 6. Use Set variables to test the expression
Click Evaluate to see the test data presented in the resulting expression.

Figure 7. Test data presented


RESULT
The expression or script will appear in the field.

Figure 8. Example of Groovy script in Initial value for a form field


REFERENCES
Groovy: A dynamic language for the Java platform
Configure KPI / BAM (SP)
In this section:
Create a KPI database connection
Add a KPI to a task or a process
Create and install a BAM report
Export a KPI
Import a KPI
This feature is available in Bonita Open Solution Subscription Pack, Teamwork version.
Key Performance Indicators (KPIs) in Bonita Open Solution refer to any data that you want to collect on a
process for Business Activity Monitoring (BAM).

Identify the KPIs which are to be associated with a process, create them and add them to the appropriate tasks
or at the process (pool) level. They will then capture specific data from each case of the process as it runs and
insert it into an external database.

BAM reporting (in Bonita User Experience) will pull data from this same database and show it in reports.
These reports are defined and installed in Bonita Studio.

Create A KPI Database Connection


KPI data needs to be collected and stored in an external database. Before defining a KPI on a task or a
process (pool), you'll need to define which database you will use, structure the appropriate database table, and
configure a connector to access the database and insert the data collected when the process case is Run.
How To Create A KPI Database Connection (SP)
To create a KPI database connection, go to the Menu bar in Bonita Studio and
select BAM -> KPI > Create KPI.

Figure 1. Add KPI database


connection
To define a KPI database connection, provide parameters for the specific table you will
use for this KPI in your database.
Figure 2. Define the database table for the KPI data
Table 1. KPI database table definition
Next you will need to configure a connector to access the database.

Select Create new database configuration to specify the database where the KPI
data will be stored.

Figure 3. Create a new database connector configuration for this KPI


Figure 4. Select the database type for this KPI
See the documentation for explanation on how to configure database connectors. The
example below shows the wizards used to configure access to MySQL
Figure 5. Example of database access configuration for MySQL
You can test the connection from Bonita Studio to your database from here.

When you have finished the configuration, select Create.


Figure 6. KPI database configuration completed
Select Finish to complete this step.
You also can Edit existing KPIs from this menu, Export a KPI out of this workspace for
use in another for collaborative work, or Import a KPI that was developed in another
users Bonita Studio.
Figure 7. Export a KPI
RESULT
The KPI database connection appears in a list presented when you select a task, in
the General tab > BAM pane.

Figure 8. Newly configured KPI database connection now available to apply to a task or
a pool
Subprocesses
In this section:
Create a call activity
Create an event subprocess
A subprocess is a complete process (with a start and an end) that is called from another process.
There is a parent-child relationship, that is, the flow in the child process is essentially contained
within the parent process. One parent process can call multiple subprocesses and a subprocess
may be called by multiple parent processes.

In a parent process diagram, a subprocess can be called via a call activity or by an event
subprocess.

A call activity calls an independent, re-usable subprocess that has its own pool. That is, it looks
like any other process and it can be called by other parent processes. Its start and end are linked
to its parent processes via data mapping.

Figure 1. Subprocess: call activity


An event subprocess is embedded in the parent process and can there be called only by that
parent process.

Figure 2. Subprocess: Event subprocess

Multi-Instantiation
In this section:
Multi-instantiate a task
Multi-instantiate a call activity (subprocess)
Develop a new instantiator
Develop a new join checker
Multi instantiation instantiates (initiates) the same task or set of tasks multiple times in
parallel. The number of instances (and possibly also the specific actors who will perform each
instance), are determined in the process design.
The number of iterations of a multi-instantiated task are known in advance and the iterations are
performed in parallel.

To multi-instantiate a task, you will need an instantiator and a join checker.

The instantiator is configured to specify how many times the task will be repeated.
The join checker is configured to evaluate when the specified number of parallel
instances have been completed, so the process can continue to the next step.
If there are multiple tasks to multi-instantiate as a discrete sequence, define a multi-
instantiated call activity (that is, a multi-instantiated subprocess).
Instantiators and join checkers are similar to connectors, and can be defined, created, and tested
in essentially the same way as connectors can be.

Loop A Task Or A Call Activity


Looping allows the process to execute a task or a call activity (subprocess) repeatedly, either until a condition
(defined as an expression) has been met, or until a specified number of loops has completed. The loop has
either a pre-test or post-test condition associated with it.

This is evaluated either at the beginning or at end of the loop to determine whether it should continue.

How To Loop A Task Or A Call Activity


In Bonita Studio, click on the task or call activity to be looped and go to its Details
panel: General tab-> Advanced pane. Select the option is Looped.

Figure 1. Loop a task or a call activity


Select the test condition:

test after: completes a loop, then evaluates the condition. If the condition is
met the process continues.
test before: evaluates the condition. If the condition is met, the task or
process is repeated (looped).
Define the loop condition using an expression.
You can also manually limit the number of loops performed by entering a number
in Maximum Loop.

RESULT
The looped task or call activity appears on the pool:

Figure 2. Looped task


When the process execution arrives at this task, it will be looped multiple times, and
completed only when the exit condition is met.

Define An Asynchronous Sequence


A synchronous sequence is a group of activities that must all complete successfully before the process can
continue, but that can be completed in parallel to other activities in the process.
By default in Bonita Studio, the entire process is a single synchronous sequence.

This can be changed by creating subsequences that are asynchronous. That is, sequences can be
decoupled.
A synchronous sequence (transaction) can then be completed in parallel to other sequences.
To mark the end of one transaction and identify the beginning of another, the activity in the process
immediately following the transactional sequence should be de-synchronized. This signals the
disconnection of this sequence from the transactional group.

When the Bonita Execution Engine receives an order from a client application (Bonita User Experience or third
party application) it uses the client Java thread. During the execution, if an activity is marked
as asynchronous, the engine will give the control back to the client and open a new Java thread to continue
with the execution of following activities.
To indicate de-synchronization of any element, click on the element and go to Details -> Advanced and
un-check the selection forSynchronous.

How To Define An Asynchronous Sequence


In Bonita Studio, click on any element and go to Details -> General tab > Advanced pane
and un-check the selection for Synchronous.
Figure 1. De-synchronize the
last element in a transactional sequence

RESULT
The last element in the synchronous sequence marks the end of a group of activities
that must all complete successfully before the process can continue.

Contexts (SP)
In this section:
Associate a process with a context
Define context keys
Contexts are useful to handle different environments/status/contexts of a process; for example, to test
a process in a test environment before deploying it.

For example, by defining a test context and a production context and associating different
variables to each context, there is no need to change values in connectors, forms, or other places where
variables necessarily differ in different environments.

A context is a set of key-value pairings. Context keys (which will be replaced by a predefined value) can be
used as input in most text variables.

When a process is associated with a context and then Run, the context keys are replaced by the associated
values defined for that context.

Actor Selection And Assignment


In this section:
Define an actor selector
Assign an actor
Apply a filter
Actors are the individuals called to complete a Task (they become users in the deployed process).
All human tasks must have at least one actor assigned.
Generally, assigning an actor is a dynamic process. An actor selector, defined by the process
designer, is activated at process execution. The actor selector is similar to a connector; you will
create them, configure them according to your requirements and external IT systems, and then
apply them where needed.
All of the tasks defined in a lane can be assigned to the same actor(s), or actors can be assigned
task by task. You can also define actor(s) for a lane and subsequently override this assignment
on a task-by-task basis.

If desired, you can also define static (fixed) lists of individuals for a lane or task. This is useful for
development and testing.

To assign a subset of actors from a list returned by an actor selector, you can define and apply a
filter. See Apply a Filter to assign a subset of Actors.

Define An Actor Selector


In this section:
Get delegee of a user
Find users assigned to a given role
Find users assigned to a given group
Find users assigned to a given role of a given group
Get manager of a team member
Get all team members of a manager
Get process initiator
Execute a NovaBonita RoleMapper
Select actors from a list defined as a variable
Select actors from a static list
Enter an individual actor manually
Retrieve actors from a database
Search in an LDAP directory service
Use actor selectors in BOS to assign one or more actors / end users to perform steps in a process.
Actor selectors are provided at the diagram and pool (i.e., global) level. Here you will choose the type of actor
selector that you want to create, give it a name, and define the path/action it will use to fetch the actors during
execution of the task.

You can create actor selectors at the task level also. Any actor selectors created inside a task will show up in
the actor selectors list at the diagram and pool level.

Actor selectors are grouped into 3 categories:

Bonita: most of these will retrieve a list of Actors as defined in Bonita User Experience,
ie:
Users, roles, groups, delegees, managers, team members
Database: these will retrieve a list of actors from external databases
LDAP: this will retrieve a list of actors from an LDAP directory
You can Edit an actor selector from the diagram, pool, or task level. Once the actor selector is defined, it's
easy to add, remove, or change users in the group without redesigning the process.
When you Remove an actor selector from the task level, it is removed from the Task only.
When you Remove an actor selector from the pool or diagram level, it is deleted entirely.
How To Define An Actor Selector
Go to the pool, and in its Details panel select the General tab and the Actor
Selectors pane. Click on Create.

Figure 1. Create a new


actor selector
An Initiator actor selector is provided by default. Use it whenever you want the user
who completed the first Process Form (ie, to initiate a case of the process) to be the
actor in a subsequent task (or of all tasks in a lane.)
To add any other type of actor selector, choose one from the list presented, for
example:

Figure 2. Choose the type of


actor selector to configure
To see how to configure each of the three types of actor selectors, see Define an actor
selector, Define a database actor selector, and Define an LDAP actor selector.
Give the actor selector a name and a description.
Figure 3. Give the actor
selector a name and a description
Enter the path to find this group, as you have defined it in Bonita User Experience.

Figure 4. Enter the path to


find the group as it is defined in Bonita User Experience

Note that you can save this actor selector configuration, and test it, in the same way
that you can Save a connector configuration and Test a connector.
When you have completed the wizard to define an Actor Selector, it will appear in the
Actor Selectors list with its Name and type.

RESULT

Figure 5. An actor selector


has a name and a type
Actor selectors defined at the pool level are available to be assigned either by lane or
task by task.
Get Delegee Of A User
This actor selector will retrieve a list of users who are designated as delegees of a user (as defined
by the process administrator in Bonita User Experience).
How To Get Delegee Of A User
Go to the pool, and in its Details panel select the General tab and the Actor
Selectors pane. Click on Create. Choose Bonita to open the list of Actor selectors.
Choose Delegee Get delegee of a user.

Fig 1. Configure an actor selector to get delegees of a user


Click on Next and give the actor selector a name and a description.
In User Name, enter the name of the user for whom this actor selector will fetch
delegees.
Figure 2. Enter the name of the user for whom to fetch delegees
Any names you enter here must be properly defined with access to Bonita User
Experience (or your web application). See Manage Users. You can also use the
predefined defaults provided in Bonita Open Solution: john, jack, james or admin.
Note that you can save this actor selector configuration, and test it, in the same way
that you can Save a connector configuration and Test a connector.
RESULT
When you have completed the wizard to define an actor selector, it will appear in the
actor selectors list with its name and type.

Figure 3. New actor selector


appears in list
Actor selectors defined at the pool level are available to be assigned either by lane or
task by task.
Find Users Assigned To A Given Role
This actor selector will retrieve a list of users who are designated with a defined role (as defined by
the process administrator in Bonita User Experience).
How To Find Users Assigned To A Given Role
Go to the pool, and in its Details panel select the General tab and the Actor
Selectors pane. Click on Create. Choose Bonita to open the list of Actor selectors.
Choose User role Find users assigned to a given role.

Figure 1. Configure an actor selector to get users with a specific role


Click on Next and give the actor selector a name and a description.
In Role name, enter the role name as defined in Bonita User Experience.
Figure 2. Enter the role name
Note that you can save this actor selector configuration, and test it, in the same way
that you can Save a connector configuration and Test a connector.
RESULT
When you have completed the wizard to define an actor selector, it will appear in the
actor selectors list with its name and type.

Figure 3. New actor selector


appears in list
Actor selectors defined at the pool level are available to be assigned either by lane or
task by task.

Find Users Assigned To A Given Group


This actor selector will retrieve a list of users within a defined group of users (as defined by the
process administrator in Bonita User Experience).
How To Find Users Assigned To A Given Group
Go to the pool, and in its Details panel select the General tab and the Actor
Selectors pane. Click on Create. Choose Bonita to open the list of Actor selectors.
Choose User Group Find users assigned to a given group.

Figure 1. Configure an actor selector to get users in a specific group


Click on Next and give the actor selector a name and a description.
In Group path, enter the full path to the group as defined in Bonita User Experience
Tick the option to include subgroups, if desired.
Figure 2. Enter the path to the group
Note that you can save this actor selector configuration, and test it, in the same way
that you can Save a connector configuration and Test a connector.
RESULT
When you have completed the wizard to define an actor selector, it will appear in the
actor selectors list with its name and type.

Figure 3. New actor selector


appears in list
Actor selectors defined at the pool level are available to be assigned either by lane or
task by task.
Assign An Actor
In this section:
Assign an actor to a lane
Assign an actor to a task
Use default actors (for test)
Use actor selector to fetch process initiator
Test an actor selector
Once an actor selector has been defined, you can use it to assign an actor or a set of actors to
a lane or to a task.

Assign An Actor To A Lane


All of the tasks defined in a lane can be assigned to the same actor(s), for example, to a functional group such
as Human Resources or IT engineers. When you assign actor(s) to a lane this way, every
task in the lane is presented with the same actor or set of actors.

You can override this assignment on a task-by-task basis.

How To Assign An Actor To A Lane


Go to the lane, and in its Details panel select the General tab and the Actors pane.
Select either Select actors dynamically or Individual. Click on Choose.
If you have ticked Select actors dynamically,

Figure 1. Choose an actor


selector for a lane
You will see a list of actor selectors (previously created for this process).
Figure 2. Choose one or
more actor selectors for the lane
You can choose more than one actor selector by using Ctrl+ select. Click Finish.
If you have ticked Individual,

Figure 3. Assign an
individual actor for a lane
you can add the name of the individual you want to assign this lane to.

Note: Any names you enter here must be properly defined with access to Bonita User
Experience (or your web application). See Manage Users.
For a test environment, you can also use the predefined defaults provided in Bonita
Open Solution: john, jack, james or admin.

RESULT
The actor selector appears in the list for this lane.
Figure 4. The actor selector
for this list shows in the list of actor selectors
Or

The individual user name appears in the Actor pane.

Figure 5. The individual user


name appears in the Actor pane
All tasks in this lane will use this actor selector/actor by default. To change this on a
task-by-task basis, seeassign an actor to a task.

Assign An Actor To A Task


Each human task in a process must have an actor, assigned by an actor selector. Actor selectors are generally
defined at the process level, and you can then choose one or more to be applied to a task.

Actor selectors can be defined at the task level, and when you do this, they are stored at the process level and
available everywhere in your process.

If the task is in a lane that has an actor selector assigned to it, you can elect to keep the actors defined
in this lane, or override the actors defined in lane. If you choose to Override, then youll
choose either Select actors dynamically or Individual for this Task.
How To Assign An Actor To A Task
Go to the task, and in its details panel select the General tab and the Actors pane.
Choose to either Keep actors defined in Lane, or Override actors defined in
Lane. If you choose to Override, then you'll choose either Select actors
dynamically or Individual for this task.
If you have ticked Override and Select actors dynamically,

Figure 1. Choose an actor


selector for a task
you will see a list of actor selectors (previously created for this process).

Figure 2. Choose one or


more actor selectors for the task
You can choose more than one actor selector by using Ctrl+ select.

Click Finish.
If you have ticked Override and Individual,

Figure 3. Enter the name of


an individual actor for this task
you can add the name of the individual you want to assign this lane to. Note that any
names you enter here must be properly defined with access to Bonita User Experience
(or your web application).
See Manage Users. For a test environment, you can also use the predefined defaults
provided in Bonita Open Solution: john,jack,james or admin.
If you have ticked Keep actors defined in lane,

Figure 4. The actor selector


defined for the lane will apply to this task
The actor selector defined for the lane will be executed for this task when the process
is run.

RESULT
The actor selector appears in the list for this lane.

Figure 5. The actor selector


for this list shows in the list of actor selectors

Use Default Actors (For Test)


To make process concept testing easier, Bonita Open Solution provides predefined default actors who
can be assigned to tasks: john, jack, james and admin. These default actors are properly defined with
access to Bonita User Experience using the password bpm .

To apply any of these users, see Assign an actor to a lane, or Assign an actor to a task, in the section
that describes how to assign an Individual.
When you Run a Process from Bonita Studio, by default you are automatically logged in as the Actor/ User
defined as admin, with the password bpm. You can change this configuration in Preferences.
How To Use Default Actors (For Test)
Use default actors for a lane
Go to the lane, and in its details panel select the General tab and the Actors pane.
Select Individual. Click onChoose.

Figure 1. Enter admin, john,


jack, or james as the actor for this lane
Use default actors for a task
Go to the task, and in its details panel select the General tab and the Actors pane.
Choose Override, thenIndividual.

Figure 2. Enter admin, john,


jack, or james as the actor for this task
RESULT
When you Run the process, tasks assigned to one of the default users will appear in
the Bonita User Experience for that user. To see this, log out as admin and log in as
john, jack, or james with the password bpm .
Figure 3. The default actors/users admin, john, jack, and james can log in using the
password bpm

Use Actor Selector To Fetch Process


Initiator
The Initiator actor selector is provided by default. It takes the person who takes the first action in a process, ie,
initiates a case of the process. Use it whenever you want the user who completed the first process form to be
the actor in other tasks in the process.

How To Use An Actor Selector To Fetch Process Initiator


Go to the lane or task, and in its details panel select the General tab and
the Actors pane.
In a lane, tick Select actors dynamically and select Choose.
In a task, tick Override actors defined in Lane and select Choose.
Figure 1. Choose an actor
selector for a lane or task
Initiator will show on the list of available actor selectors. (You may also see a list of
actor selectors previously created for this process).

Figure 2. Choose process


initiator
Click Finish.
You can add the name of the individual you want to assign this lane to.

Note: any names you enter here must be properly defined with access to Bonita User
Experience (or your web application). See Manage Users. For testing, you can also use
the predefined defaults provided in Bonita Open Solution: john, jack, james or admin.
RESULT
The actor selector for the process initiator appears in the list for this lane.
Figure 3. The process
initiator actor selector for this list shows in the list of actor selectors

Test An Actor Selector


After you have configured an actor selector, you can test it.

How To Test An Actor Selector


Go to the lane or task, and in its details panel select the General tab and
the Actors pane. Click on the Actor selector you want to test and click Edit.

Figure 1. Choose an actor


selector to test
Click Next through the actor selector wizard until you reach the wizard with Test
configuration. In the simple example shown below, the actor selector is a manually
entered list containing default actors.
Click on Test configuration.
Figure 2. Test actor selector configuration
The actor selector test is launched. The results window shows what is returned by the
actor selector.

RESULT
The results window appears to show what is returned by the actor selector. In this
example, all three names are found and returned.

Figure 3. The results window shows what is


returned by the actor selector

Apply A Filter
In this section:
Assign an actor from a previous task
Assign an actor from one of several previous tasks
Select random candidates
Create a new filter
Apply a filter to obtain a subset of actors from a list returned by an actor selector. Use one of the predefined
filters in Bonita Studio or create your own filter using a script.
How To Apply A Filter
Go to a lane or task, and in its details panel select the General tab and
the Actors pane. Next to the Actor selectors list is the Filters list. (You will need to have
already defined one or more actor selectors.) Click on Add.

Figure 1. Add a filter to an actor selector


A list of preconfigured filters will appear. To see how to configure these, see their
individual documentation.

Figure 2. Actor selector


filters provided in Bonita Open Solution
Save a filter configuration, or test a filter, in the same way you can save a connector
configuration or test a connector.
RESULT
A filter will appear in the Filters list in the Details panel > General tab > Actors
pane.
Design Collaboration (SP)
In this section:
Create a local repository
Connect to a shared repository
Change between a local and a shared repository
Create a shared repository
Synchronize a shared repository
Manage locks on shared resources
Versioning and history
Export a repository
Import a repository
In Bonita Open Solution Open Source, collaborate on process design by exporting and importing
a workspace.

In Bonita Open Solution Teamwork version, you can use a remote repository to share workspaces,
and can synchronize, version, and restore shared workspaces for process design collaboration.
For information about migrating repositories, see Migrate a repository from 5.5 to 5.6.
Generate Process Documentation (SP)
This feature is available in Bonita Open Solution, Teamwork version.
When a process is open in Bonita Studio, it is possible to generate documentation containing a summary of
individual elements in the process. This is like a process report.

Choose the settings for the format of the export file, how the report will be presented, choose a logo to display
and its size in pixels.

What will be exported in the documentation?


You will see the elements contained in the process. The documentation generated will contain:

a description of BPMN elements


an image of the process
a list of activities
tables showing groups, actors, tasks, sequence flows, connectors, data, data types,
deadlines, dependancies, messages , message flows and KPI.
Template settings
The way the different elements in the process are presented on paper can be easily configured in a pop-up
window, before exporting.
In the optional settings in the pop-up window, you can choose to:
export the report in different formats: .pdf, .doc, .html, .rtf, .ppt
show or hide a description of the BPMN elements
change the colour of headings
display your logo
How To Generate Process Documentation (SP)
Go to the Menu bar > Process.
In the dropdown menu, click on Generate documentation.
Figure 1. Dropdown menu
A popup window will be displayed where you can configure a number of parameters for
the exported file.
In the optional settings in the pop-up window, you can choose to:

export the report in .pdf, .doc, .html, .rtf, or .ppt format


show or hide a description of the BPMN elements
show or hide empty properties
change the colour of the background for H1 and H2
define the size of the logo in pixels (10-150 pixels)
set the path where a logo is found on your computer, by browsing straight to it
display a logo on the first page or on all pages
Once the parameters have been set, click on the Generate button to export the file.
Figure 2. Pop-up window to
configure the documentation export
RESULT
A report about the process will be generated and exported:

in the format you chose


with the presentation you chose
to the place on your computer you chose
Figure 3. Example of a process report in .pdf format
Diagram
In this section:
Create a new diagram
Save a diagram
Duplicate a diagram
Version a diagram
Print a diagram
Close a diagram
Delete a diagram
Open a diagram
Name a diagram
Import a diagram
Export a diagram
Export as BPMN 2.0
A diagram is a file that contains the process design, with all its elements, attributes and
dependencies, within Bonita Studio.
You can have several process diagrams open at one time in Bonita Studio.
A diagram can contain a process which can contain multiple pools and lanes.
Note that a diagram is not equal to a process. A single diagram can contain
multiple pools (processes) at one time.

Figure 1. A diagram in Bonita Studio


Figure 2. Multiple pools (processes) in a diagram

Draw A Transition
You can draw a transition between elements in a pool in two ways:
using the design palette, or
using the context palette on an element.
How To Draw A Transition
When an element, such as a task, is created using drag and drop from the design palette,
no transition is created. When an element is created from another element using the
context palette, a transition is created automatically.

Figure 1. Two unconnected


tasks

Draw a transition from the design palette


To create a transtion between two unconnected elements, click on the transition icon in
the design palette.
Figure 2. Transition icon in the design
palette
An arrow will appear when you hover over the whiteboard. This means a transition can
now be created. The function not available icon appears if you are not over a element.
The icon will become functional when you hover over the element to be connected.

Figure 3. A transition icon is not available


Click on the first element, then drag the arrow to the next element in the sequence.
A transition is created between the two elements.
Note that the position of a transition can be adapted to the design by moving its handles.

Figure 4. Transition handles


Figure 5. Create a transition
from the context palette
Draw a transitionfrom the context palette
Click on an element where the transition will exit.This will display the context palette
around the element.
Click on the arrow in the context palette.
Drag the arrow to the next element, where the transition will enter.
RESULT
Elements in a process are connected in sequence by transitions.

Figure 6. Transition created between two tasks


Generate Process Documentation (SP)
This feature is available in Bonita Open Solution, Teamwork version.
When a process is open in Bonita Studio, it is possible to generate documentation containing a summary of
individual elements in the process. This is like a process report.

Choose the settings for the format of the export file, how the report will be presented, choose a logo to display
and its size in pixels.

What will be exported in the documentation?


You will see the elements contained in the process. The documentation generated will contain:

a description of BPMN elements


an image of the process
a list of activities
tables showing groups, actors, tasks, sequence flows, connectors, data, data types,
deadlines, dependancies, messages , message flows and KPI.
Template settings
The way the different elements in the process are presented on paper can be easily configured in a pop-up
window, before exporting.
In the optional settings in the pop-up window, you can choose to:
export the report in different formats: .pdf, .doc, .html, .rtf, .ppt
show or hide a description of the BPMN elements
change the colour of headings
display your logo
How To Generate Process Documentation (SP)
Go to the Menu bar > Process.
In the dropdown menu, click on Generate documentation.
Figure 1. Dropdown menu
A popup window will be displayed where you can configure a number of parameters for
the exported file.
In the optional settings in the pop-up window, you can choose to:

export the report in .pdf, .doc, .html, .rtf, or .ppt format


show or hide a description of the BPMN elements
show or hide empty properties
change the colour of the background for H1 and H2
define the size of the logo in pixels (10-150 pixels)
set the path where a logo is found on your computer, by browsing straight to it
display a logo on the first page or on all pages
Once the parameters have been set, click on the Generate button to export the file.
Figure 2. Pop-up window to
configure the documentation export
RESULT
A report about the process will be generated and exported:

in the format you chose


with the presentation you chose
to the place on your computer you chose
Figure 3. Example of a process report in .pdf format

You might also like