BOS 5.1 Connectors Guide

Bonita Open Solution
Version 5.1
Connectors Reference Guide

Version1.0
Bonita Open Solution 5.1 Connectors Reference Guide
Bonita Open Solution V5.1

Connectors Reference Guide
Contents
Part 1. Bonita Open Solution Connectors Overview .......................................................................... 9

Part 2 How to connect processes to information systems .............................................................. 10
2.1 How to Add a Connector to a Step or a Process ................................................................... 10
2.1.1 Add a Connector to a Step ............................................................................................ 10
2.1.1.1 Trigger a Connector when a Step Deadline is reached ............................................. 12
2.1.2 Add a Connector to a Process or Pool........................................................................... 13
2.1.3 Define Connector inputs and outputs........................................................................... 13
2.1.4 Save Connector Configuration ...................................................................................... 14
2.1.5 Move / Copy a Connector ............................................................................................. 14
2.1.6 Test a Connector ........................................................................................................... 16
2.2 How to configure Messaging and Social Connectors ............................................................ 18
2.2.1 Configure a Connector to send an email ...................................................................... 18
2.2.2 Configure a Connector to send a Twitter Direct Message ............................................ 20
2.2.3 Configure a Connector to send a Twitter Status Update .............................................. 21
2.3 How to configure Java Connectors ....................................................................................... 22
2.3.1 Configure a Connector to invoke a Java method .......................................................... 22
2.4 How to configure Scripting Connectors ................................................................................ 24
2.4.1 Execute a shell command or script ............................................................................... 24
2.4.1.1 Input.......................................................................................................................... 24
2.4.1.2 Output....................................................................................................................... 25
2.4.2 Configure a Connector to execute a Groovy script ....................................................... 26
2.4.2.1 Input.......................................................................................................................... 26
2.4.2.2 Output....................................................................................................................... 27
2.5 How to configure LDAP Directory Connectors ...................................................................... 28
2.5.1 Inputs ............................................................................................................................ 28
2.5.2 Outputs ......................................................................................................................... 30
2.6 How to configure Bonita system Connectors ....................................................................... 31
2.6.1 Configure a Connector to add a comment ................................................................... 31
2.6.2 Configure a Connector to send a command to execute a Step .................................... 32
2.6.3 Configure a Connector to send a command to start a Step ......................................... 33
2.6.4 Configure a Connector to send a command to finish a Step ........................................ 34
2.6.5 Configure a Connector to create a variable .................................................................. 35
BOS V5.1, Connectors Reference Guide, 24 Mar 10 www.bonitasoft.com | © BonitaSoft S.A. page 2
2.6.6 Configure a Connector to create multiple variables ..................................................... 36

2.7 How to configure Bonita V4 hook Connectors ..................................................................... 37
2.7.1 Configure a Connector to use a hook previously defined in Bonita v4......................... 37
2.8 How to configure Database Connectors ............................................................................... 38
2.8.1 Inputs ............................................................................................................................ 38
2.8.2 Outputs ......................................................................................................................... 40
2.9 How to configure Alfresco Connectors ................................................................................. 41
2.9.1 Common inputs ............................................................................................................. 41
2.9.2 Common outputs .......................................................................................................... 42
2.9.3 Configure a Connector to cancel a checked-out Alfresco file ....................................... 43
2.9.3.1 Unique inputs ........................................................................................................... 43
2.9.4 Configure a Connector to check in an Alfresco file ....................................................... 43
2.9.4.1 Unique inputs ........................................................................................................... 43
2.9.5 Configure a Connector to check out an Alfresco file ................................................... 44
2.9.5.1 Unique inputs ........................................................................................................... 44
2.9.6 Configure a Connector to create an Alfresco folder by path ........................................ 45
2.9.6.1 Unique inputs ........................................................................................................... 45
2.9.7 Configure a Connector to delete an Alfresco folder ..................................................... 46
2.9.7.1 Unique inputs ........................................................................................................... 46
2.9.8 Configure a Connector to delete an Alfresco item by ID .............................................. 46
2.9.8.1 Unique inputs ........................................................................................................... 46
2.9.9 Configure a Connector to download an Alfresco file by ID ........................................... 47
2.9.9.1 Unique inputs ........................................................................................................... 47
2.9.10 Configure a Connector to download an Alfresco file by store and ID .......................... 47
2.9.10.1 Unique inputs ........................................................................................................... 47
2.9.11 Configure a Connector to List Alfresco File versions .................................................... 48
2.9.11.1 Unique inputs ........................................................................................................... 48
2.9.12 Configure a Connector to list checked-out Alfresco files.............................................. 48
2.9.13 List all Alfresco folders by path ..................................................................................... 48
2.9.13.1 Unique inputs ........................................................................................................... 48
2.9.14 Configure a Connector to update a checked-out Alfresco file...................................... 49
2.9.14.1 Unique inputs ........................................................................................................... 49
2.9.15 Configure a Connector to upload an Alfresco file by path ............................................ 50
2.9.15.1 Unique inputs ........................................................................................................... 50
2.10 How to configure Jasper Connectors .................................................................................... 51
2.10.1 Inputs ............................................................................................................................ 51
2.10.2 Outputs ......................................................................................................................... 52
2.11 How to Configure Sugar CRM Connectors ............................................................................ 53
2.11.1 Common inputs ............................................................................................................. 53

2.11.2 Common outputs .......................................................................................................... 54
2.11.2 Configure a Connector to get SugarCRM entries from indicated module .................... 55
2.11.2.1 Unique Inputs ........................................................................................................... 55
2.11.3 Configure a Connector to get SugarCRM Opportunities from an Account................... 56
2.11.3.1 Unique inputs ........................................................................................................... 56
2.11.4 Configure a Connector to create or modify a SugarCRM entry .................................... 57
2.11.4.1 Unique inputs ........................................................................................................... 57
2.11.5 Configure a Connector to create a SugarCRM Account ................................................ 57
2.11.5.1 Unique Inputs ........................................................................................................... 57
2.11.6 Configure a Connector to create a SugarCRM Contact................................................. 58
2.11.6.1 Unique Inputs ........................................................................................................... 58
2.11.7 Configure a Connector to create a SugarCRM Opportunity ......................................... 59
2.11.7.1 Unique inputs ........................................................................................................... 59
2.12 How to configureTalend Connectors .................................................................................... 60
2.12.1 Configure a Connector to launch a Talend job ............................................................. 60
2.12.1.1 Inputs ........................................................................................................................ 61
2.12.1.2 Outputs ..................................................................................................................... 62
2.12.2 Configure a Connector to launch a Talend MDM Connector ....................................... 63
2.12.2.1 Inputs ........................................................................................................................ 63
2.13 How to Configure eXo Connectors........................................................................................ 65
2.13.1 Common inputs ............................................................................................................. 65
2.13.2 Common outputs .......................................................................................................... 66
2.13.3 Configure a Connector to cancel checkout of an exo JCR item .................................... 67
2.13.3.1 Unique Inputs ........................................................................................................... 67
2.13.4 Configure a Connector to check in an eXo JCR item ..................................................... 67
2.13.4.1 Unique inputs ........................................................................................................... 67
2.13.5 Configure a Connector to check out an eXo JCR item .................................................. 68
2.13.5.1 Unique inputs ........................................................................................................... 68
2.13.6 Configure Connector to create a folder in eXo ............................................................. 68
2.13.6.1 Unique inputs ........................................................................................................... 68
2.13.7 Configure a Connector to delete an item from eXo...................................................... 69
2.13.7.1 Unique inputs ............................................................................................................ 69
2.13.8 Configure a Connector to download an eXo file ........................................................... 69
2.13.8.1 Unique inputs ........................................................................................................... 69
2.13.9 Configure a Connector to list eXo file versions ............................................................. 70
2.13.9.1 Unique inputs ........................................................................................................... 70
2.13.10 Configure a Connector to list eXo folders ................................................................. 70
2.13.10.1 Unique inputs ........................................................................................................... 70

2.13.11 Configure a Connector to upload a file to eXo.......................................................... 71
2.13.10 Configure a Connector to enable version control on an eXo JCR file ....................... 71
2.13.10.1 Unique inputs ........................................................................................................... 71
2.14 How to configure xWiki Connectors ..................................................................................... 72
2.14.1 Common inputs ............................................................................................................. 72
2.14.1 Common outputs .......................................................................................................... 74
2.15 How to configure Google Connectors ................................................................................... 75
2.15.1 Common inputs ............................................................................................................. 75
2.15.2 Configure a Connector to create a Google calendar event with web content ............. 76
2.15.2.1 Unique inputs ........................................................................................................... 76
2.15.3 Configure a Connector to create a Google calendar event .......................................... 77
2.15.3.1 Unique inputs ........................................................................................................... 77
2.15.4 Configure a Connector to delete a Google calendar event .......................................... 78
2.15.4.1 Unique inputs ........................................................................................................... 78
2.16 How to configure a Connector to execute a web service ..................................................... 78
2.16.1 Inputs ........................................................................................................................ 78
Part 3. How to Configure Your Own Connectors .............................................................................. 81
3.1 Develop your own Connectors.............................................................................................. 81
3.2 Import or Export a Connector ............................................................................................... 83
Part 4. How to import a Connector from BonitaSoft Community contributions ............................. 83
Part 5. How to analyze a problem in Bonita Open Solution ............................................................. 84
Figures
Figure 1. Choose a Connector to Add .................................................................................................. 10

Figure 2. Specify Connector parameters at the Step level (Automatic or Subprocess Step) .............. 11
Figure 3. Specify Connector parameters at the Step level (Human Step) ........................................... 11
Figure 4. Configure a Deadline to trigger a Connector ........................................................................ 12
Figure 5. Specify Connector parameters at the Process or Pool level ................................................. 13
Figure 6. Add variables or delete output ............................................................................................. 13
Figure 37. Add a variable to take Connector output ........................................................................... 14
Figure 7. Save a Connector configuration ............................................................................................ 14
Figure 8. Move or duplicate a Connector ............................................................................................ 15
Figure 9. Select Test a Connector......................................................................................................... 16
Figure 10. Test a Connector configuration........................................................................................... 16
Figure 11. Choose a Connector to configure and evaluate.................................................................. 17
Figure 12. Evaluate the Connector when it is configured .................................................................... 17
Figure 13. …and wait for the evaluation results .................................................................................. 17
Figure 14. Configure a Connector to send an email............................................................................. 18
Figure 15. Complete email Connector configuration ........................................................................... 19
Figure 16. Configure a Connector to send a Twitter Direct Message .................................................. 20
Figure 17. Configure a Connector to send a Twitter Status Update .................................................... 21
Figure 18. Configure a Connector to invoke a Java method ................................................................ 22
Figure 19. Browse for the java class, enter a string to search and choose .......................................... 22
Figure 20. Choose the java method to invoke ..................................................................................... 23
Figure 21. Configure a Connector to execute a shell command or script............................................ 24
Figure 22. Choose a destination variable for the output returned...................................................... 25
Figure 23. Configure a Connector to execute a Groovy script ............................................................. 26
Figure 24. Choose a destination variable for the output returned...................................................... 27
Figure 25. Configure a Connector to search in an LDAP directory and return a list ............................ 28
Figure 26. Define LDAP directory search ............................................................................................. 29
Figure 27. Configure LDAP Connector outputs .................................................................................... 30
Figure 28. Configure a Connector to add a comment.......................................................................... 31
Figure 29. Configure a Connector to send a command to execute a Step .......................................... 32
Figure 30. Configure a Connector to send a command to start a Step................................................ 33
Figure 31. Configure a Connector to send a command to finish a Step .............................................. 34
Figure 32. Configure a Connector to create a variable ........................................................................ 35
Figure 33. Configure a Connector to create a variable ........................................................................ 36
Figure 34. Configure a Connector to use a hook defined in Bonita v4 ................................................ 37
Figure 35. Configure a connector to execute a database query .......................................................... 38
Figure 36. Define variable to take database query output .................................................................. 40
Figure 38. Alfresco Connectors ............................................................................................................. 41
Figure 39. Common inputs for all Alfresco Connectors ....................................................................... 41
Figure 40. Configure outputs for Alfresco Connector .......................................................................... 42
Figure 42. Enter path and information for checked-out file to cancel ................................................ 43
Figure 43. Enter ID and information for checked-in file ...................................................................... 43
Figure 44. Enter ID for checked-out file ............................................................................................... 44
Figure 45. Enter Alfresco path and folder details ................................................................................ 45
Figure 46. Enter path of Alfresco folder to delete ............................................................................... 46
Figure 47. Enter ID for item to be deleted ........................................................................................... 46
Figure 48. Enter path and information for file to download ............................................................... 47
Figure 49. Enter version store and information for file to download .................................................. 47
Figure 50. Enter ID of file ..................................................................................................................... 48
Figure 51. Specify the path for the folders .......................................................................................... 49

Figure 52. Enter path and information for checked-out file to update ............................................... 49
Figure 53. Enter path of and information about file ............................................................................ 50
Figure 54. Configure Connector to Create a Jasper Report from a database ...................................... 51
Figure 55. Enter Jasper database locator and authentication ............................................................. 51
Figure 56. Enter file path and output for Jasper report ....................................................................... 52
Figure 57. Configure Connectors for SugarCRM .................................................................................. 53
Figure 58. Enter SugarCRM database locator and authentication ...................................................... 53
Figure 59. Define where to take SugarCRM output ............................................................................. 54
Figure 60. Inputs for Get SugarCRM entries ........................................................................................ 55
Figure 61. Inputs for Get SugarCRM opportunities .............................................................................. 56
Figure 62. Inputs for Create or modify a SugarCRM entry................................................................... 57
Figure 63. Inputs to Create a SugarCRM account ................................................................................ 57
Figure 64. Inputs to Create a SugarCRM contact ................................................................................. 58
Figure 65. Inputs to Create a SugarCRM opportunity .......................................................................... 59
Figure 66. Configure a Connector to launch a Talend job ................................................................... 60
Figure 67. Configure a new Talend job ................................................................................................ 61
Figure 68. Configure output of Talend job ........................................................................................... 62
Figure 69. Enter Talend MDM authentication ..................................................................................... 63
Figure 70. Enter Talend MDM configuration ....................................................................................... 64
Figure 71 Configure eXo Connectors ................................................................................................... 65
Figure 72. Inputs for eXo Connectors .................................................................................................. 65
Figure 73. Outputs for eXo Connectors ............................................................................................... 66
Figure 74. Unique input for Cancel a checked-out eXo item ............................................................... 67
Figure 75. Unique input for Check in an eXo item ............................................................................... 67
Figure 76. Unique input for check out an eXo item ............................................................................. 68
Figure 77. Configure Connector to Create a new folder in eXo ........................................................... 68
Figure 78. Configure Connector to Delete an item from eXo............................................................... 69
Figure 79. Inputs for Download an eXo file ......................................................................................... 69
Figure 80. Inputs for List eXo file versions ........................................................................................... 70
Figure 81. Inputs for List eXo folders ................................................................................................... 70
Figure 82. Configure Connector to Upload a file to eXo ...................................................................... 71
Figure 83. Define inputs for version control on an eXo file ................................................................. 71
Figure 84. Configure an xWiki Connector ............................................................................................ 72
Figure 85. Common inputs for xWiki Connectors ................................................................................ 72
Figure 86. Common inputs for xWiki Connectors ................................................................................ 73
Figure 87. Outputs for xWiki Connectors ............................................................................................. 74
Figure 88. Configure a Google calendar event ..................................................................................... 75
Figure 89. Common inputs for Google calendar Connectors............................................................... 75
Figure 90. Configure a Connector to Create a Google calendar event with web content ................... 76
Figure 91. Configure a Connector to Create a Google calendar event ................................................ 77
Figure 92. Configure a Connector to Delete a Google calendar event ................................................ 78
Figure 93. Configure a Connector to Execute a web service ................................................................ 78
Figure 94. Configure a Web service Connector ................................................................................... 79
Figure 95. Configure Execute a Web service Connector outputs ......................................................... 80
Figure 96. Add your own Connector to Bonita Open Solution ............................................................ 81
Figure 97. Set the description of your Connector ................................................................................ 81
Figure 98. Create java source file ......................................................................................................... 82
Figure 99. Your Connector is now available ......................................................................................... 83
Figure 100. Import (or Export) a Connector from the Menu bar ......................................................... 83
Figure 101. Select an extension from the Contributions page ............................................................ 84
Figure 102. Click Install to import extension........................................................................................ 84
Bonita Open Solution

How to Use Connectors
Welcome to Bonita Open Solution (BOS). If you don’t already have the software, you can download
it from the BonitaSoft web site..
How to Use Connectors is intended to help you use the Connectors provided in Bonita Open
Solution Version 5, the complete open source Business Process Management Solution.
You can download this, and the general User Guide and updates, from the BonitaSoft web site.
Part 1 gives a basic overview and general information.
Part 2 describes how to use predefined Connectors to connect Bonita Open Solution to external
information systems.
Part 3 describes how to develop your own Connectors.
Part 4 describes how to import a Connector.
Part 5 gives information about how to analyze problems in Bonita Open Solution.
Part 1. Bonita Open Solution Connectors Overview
Bonita Open Solution provides Connectors to connect a Step or a Process to external

information systems.
Connectors take specified input (directly as a value from the end user or carried over / built
into an expression) and execute. Some Connectors also return output back into Bonita Open
Solution. Inputs and outputs for each Connector provided in Bonita Open Solution are given
in this document.
There are two ways to configure Connectors:
 Add a Connector – choose a Connector already defined in Bonita Open Solution

 Create a Connector – Create a new Connector type; place it in an existing Bonita
Open Solution Category; use this as a wizard for future Connectors of the same type
Once created, Connectors can be Moved or Copied (to another Step or to a Process or Pool).
There is also a function to Test a Connector before the Process is run.
Part 2 How to connect processes to information systems
2.1 How to Add a Connector to a Step or a Process
2.1.1 Add a Connector to a Step
To Add a Connector already defined in Bonita Open Solution to a Step, click the Step and go
to Details -> Connectors -> Add.
Note: you will need to have global variables defined, to associate with your inputs and/or
output results. See How to define Data variables in the Bonita Open Solution User Guide.
When the Select a connector window appears, choose the type of Connector you want to
add. (These Connectors are described in detail in the following paragraphs, but all of them
go through these same first steps).
Figure 1. Choose a Connector to Add
In the wizard, for all Connectors, specify:
 Name: name the Connector

 Description / Purpose: what the Connector does
 Select event: at which event the Connector is activated
Figure 2. Specify Connector parameters at the Step level (Automatic or Subprocess Step)
Figure 3. Specify Connector parameters at the Step level (Human Step)
o Enter: the connector implements as soon as the Process moves to this

Step
o Start: the connector implements when the assigned Actor completes
the necessary action (presented via the web application and
initiated when the form is Submitted)
o Suspend: the connector implements if the Actor suspends the Process
o Resume: the connector implements if the Actor resumes the Process
o Finish: the connector implements as this Step is completed
 If Connector fails: choose the appropriate action to take if the Connector itself fails
to execute properly:
o Abort process and raise error; or
o Ignore error and continue process.
2.1.1.1 Trigger a Connector when a Step Deadline is reached
Deadlines are used to trigger a Connector after the specified duration or date has passed.
A Deadline is either:
 a date by which a Step must be completed, or

 the duration of time during which a Step must be completed.
Deadlines can be set for both Human and Automatic Steps. Go to Step -> Deadlines -> Add.
Choose a Connector to be triggered when the deadline is reached.
Figure 4. Configure a Deadline to trigger a Connector
 Enter Name and Description

 Message Type: select Duration, Date or Variable
o Duration: select the length of time to elapse between the initiation of this
Step and the activation of the Connector
o Date: Select the date and time for the activation of the Connector
o Variable: Select a predefined variable that will return a date or an integer
(See How to define a Data variable)
 If Connector fails: choose the appropriate action to take if the Connector itself fails:
o Abort process and raise error; or
o Ignore error and continue process.
 Select Next to continue and configure the Connector to activate when the deadline
is reached. See Add a Connector to a Step.
2.1.2 Add a Connector to a Process or Pool
At the Process level, there are also options to implement a Connector at any time during the
Process:
Figure 5. Specify Connector parameters at the Process or Pool level
o Cancel the connector implements if the Actor cancels the Process (case)
o Abort the connector implements if the Process case encounters a fatal
error
2.1.3 Define Connector inputs and outputs
Next, define the parameters required for Connector inputs and, where appropriate, for
outputs. You will need to define variables used in the inputs before configuring the
Connector; but for outputs, you can create variables directly within the output
configuration.
Note that whenever an output configuration wizard appears, you either need to define the
output or delete the output field.
Figure 6. Add variables or delete output
Figure 7. Add a variable to take Connector output
Specific Connector input and output configurations are described in the following sections.
2.1.4 Save Connector Configuration
For many Connectors, you have an option to Save connector configuration which allows you
to re-use the same configuration to define another Connector of the same type. This option
will appear as you continue the Connector configuration wizard:
Figure 8. Save a Connector configuration
2.1.5 Move / Copy a Connector
To move a Connector to a another Step, or to a Pool or Process, Go to Step -> Connectors

and select the Connector you want to move. Then select Move.
Figure 9. Move or duplicate a Connector
Be sure that any variables you defined in a Connector attached to a Step are also available
either globally in the target Process, or locally in the target Step.
To duplicate a Connector – that is, Move it and at the same time leave a copy in its original
location, check the Make a Copy option before moving it.
2.1.6 Test a Connector
You can test the function of a Connector before you configure and save it. To do this, you’ll
configure your Connector first as a test. Once it works, you can create the real thing.
Check external configurations before testing a specific Connector. Sometimes the Connector
test returns an error due to external factors. (For example, some Bonita Connectors may
return errors because the Process has not been Run, and therefore the BEE has not been
launched. This example illustrates that not all Connectors can be tested before an
execution.)
From the Menu Bar, Select Connector -> Test a Connector.
Figure 10. Select Test a Connector
Then Select the type of Connector to test (Connectors, Groups, or Filters).
Figure 11. Test a Connector configuration
Then choose the category and specific Connector to test. Continue to configure the
Connector (as explained below, beginning in Section 2.2).
Figure 12. Choose a Connector to configure and evaluate
When the Connector parameters are defined, Evaluate it.
Figure 13. Evaluate the Connector when it is configured
Figure 14. …and wait for the evaluation results
You will get a Results window indicating that the Connector was successfully implemented,
or that an error occurred with information to help debug the connector.
When you are satisfied with the Connector behavior, you can Save connector configuration
and use this as a basis to create the actual Connector where you want it.
2.2 How to configure Messaging and Social Connectors
2.2.1 Configure a Connector to send an email
This connector will send an email message when activated. There is no output returned.
Figure 15. Configure a Connector to send an email
Email
Category: Messaging
Connector description: send an email message
Input Description Type
Host IP address or name of string
email server
Port port defined for email number
system
Security: SSL check if SSL security
authorization required
Security: STARTTLS check if STARTTLS security
authorization required
Authentication: User User name for the host string
Name and password account
Authentication: password User password for the host string
account
Figure 16. Complete email Connector configuration
Email
Category: Messaging
Connector description: send an email message
From name@name.ext string
To: name@name.ext, string
name@name.ext
CC: name@name.ext, string
name@name.ext
Bcc: name@name.ext, string
name@name.ext
Subject text string
Message message to recipient which string
can include variable(s) and
text (hello ${var})
Or select a data you want chose a variable to add select
to use
HTML email Check to activate HTML
tags in message
Other headers: name name of additional header string
information
Other headers: value value of additional header string
information
2.2.2 Configure a Connector to send a Twitter Direct Message
This Connector will send a direct message to a Twitter address. There is no output.
Figure 17. Configure a Connector to send a Twitter Direct Message
Twitter – Direct Message

Category: Social
Connector description: send a Twitter message directly
User name or email Sender’s name: string
name@name.ext
Password Sender’s Twitter password string
Message message to recipient which string
can include variable(s) and
text (eg hello ${var})
Select data… chose a variable to add select
Recipient @username string
HTTP Proxy proxy server IP address string
Proxy port port of proxy server number
Proxy user name name of proxy user string
Proxy password password of proxy user string
2.2.3 Configure a Connector to send a Twitter Status Update
This Connector will broadcast a Status Update via Twitter. There is no output returned.
Figure 18. Configure a Connector to send a Twitter Status Update
Twitter – Update Status

Category: Social
Connector description: send a Twitter update to “What are you doing?”
User name or email Sender’s name string
Password Sender’s Twitter password string
Show password checkbox boolean
New status message from sender string
Or select a data you want choose a variable to add string
to use
HTTP Proxy proxy server IP address string
Proxy port port of proxy server number
Proxy user name name of proxy user string
Proxy password password of proxy user string
Show password checkbox boolean
2.3 How to configure Java Connectors
2.3.1 Configure a Connector to invoke a Java method
Figure 19. Configure a Connector to invoke a Java method
Figure 20. Browse for the java class, enter a string to search and choose
Figure 21. Choose the java method to invoke
Java Executor
Category: Java
Connector description: configure invocation of Java methods
Class java class; click Browse and select
enter a string to find class
Methods methods defined for select
selected class;
double-click on method to
set
2.4 How to configure Scripting Connectors
2.4.1 Execute a shell command or script
2.4.1.1 Input
Figure 22. Configure a Connector to execute a shell command or script
Shell
Category: Scripting
Connector description: execute a shell command or script
Shell command enter command, script, or string
command path to execute
a shell file
can include variable(s)
Or select a data you want choose a variable to add select
to use
2.4.1.2 Output
Figure 23. Choose a destination variable for the output returned
You can return the output of your executable into a predefined variable. Note that if there is no
output for your connector, you should delete this option (click the red X).
Output Description Type

Result result of script or string
command
2.4.2 Configure a Connector to execute a Groovy script
2.4.2.1 Input
Figure 24. Configure a Connector to execute a Groovy script
Enter an expression in Groovy. You can include predefined variables (including variables that are
Groovy expressions) here.
Groovy
Category: Scripting
Connector description: execute a Groovy command or script
Groovy script enter the script directly string
2.4.2.2 Output
Figure 25. Choose a destination variable for the output returned
You can return the output of your executable into a predefined variable. Note that if there is no
output for your connector, you should delete this option (click the red X).

Result result of script or object
command
2.5 How to configure LDAP Directory Connectors
This Connector searches in an LDAP directory and returns a list.
2.5.1 Inputs
Figure 26. Configure a Connector to search in an LDAP directory and return a list
LDAP
Category: Database
Connector description: search in an LDAP directory and return a list of specified
attributes
server hosting LDAP
directory
Port LDAP directory port number
number
Protocol choose LDAP, LDAPS, or select
TLS
User LDAP User name string
Password LDAP user password string
Figure 27. Define LDAP directory search
Base DN Identify Distinguished Name at string

which to start search
Filter specify a subset , e.g. String in accordance with
(&(objectClass=person) LDAP syntax
(givenName=John))
Attributes define attributes to return in string or strings separated
result entries using LDAP syntax by “,”
Under Advanced Configuration:
Scope  SUBTREE (entire subtree select

starting at the base DN)
 ONELEVEL (entries immediately
below base DN)
 BASE (search just named entry)
Size limit maximum number of entries to number
return
Time limit (in seconds) maximum time to allow search number
to run
Referral handling IGNORE or FOLLOW referrals select
Alias dereferencing ALWAYS: Always dereference select
aliases
SEARCHING: Dereference
aliases only after name
resolution
NEVER: Never dereference
aliases
FINDING: Dereference aliases
only during name resolution.
2.5.2 Outputs
Figure 28. Configure LDAP Connector outputs

Result result of Query: List of LdapAttributes
LdapAttributeList
2.6 How to configure Bonita system Connectors
Bonita Connectors apply actions inside the Bonita-defined process.
2.6.1 Configure a Connector to add a comment
This Connector adds a comment to a Step which will be shown in the User Experience when
the Process is running.
Figure 29. Configure a Connector to add a comment
Add a comment
Category: Other
Connector description: Add text to a Step or a Process
Input Input description Type
message enter text to display string
On this step The comment appears
when this step shows up in
the User Experience inbox
2.6.2 Configure a Connector to send a command to execute a Step
This Connector executes a specified Step when it is activated.
Figure 30. Configure a Connector to send a command to execute a Step
Execute a Step
Category: other
Connector description: send a command to execute the indicated Step (anywhere in
the Pool)
Step name name of Step string
2.6.3 Configure a Connector to send a command to start a Step
This Connector starts a specified Step when it is activated.
Figure 31. Configure a Connector to send a command to start a Step
Start a Step
Category: other
Connector description: send a command to start the indicated Step (any Step in the
Pool)
2.6.4 Configure a Connector to send a command to finish a Step
This Connector finishes a specified Step when it is activated.
Figure 32. Configure a Connector to send a command to finish a Step
Finish a Step
Category: other
Connector description: send a command to finish the indicated Step (any Step in the
Pool)
2.6.5 Configure a Connector to create a variable
This Connector sets the value of a Data variable when a Step is reached.
Figure 33. Configure a Connector to create a variable
Set variable
Category: other
Connector description: create a global or a local variable
Name name of variable string
Value variable definition string
2.6.6 Configure a Connector to create multiple variables
This Connector sets the value of a Data variable when a Step is reached.
Figure 34. Configure a Connector to create a variable
Set variable
Category: other
Connector description: create a global or a local variable
Name name of variable string
Value variable definition string
2.7 How to configure Bonita V4 hook Connectors
2.7.1 Configure a Connector to use a hook previously defined in Bonita v4
Figure 35. Configure a Connector to use a hook defined in Bonita v4
HookProcessConnector
Category: other
Connector description: Use a hook defined in Bonita v4 as a Connector
className name of javaclass string
2.8 How to configure Database Connectors
To see an example of how to configure a Connector to query a MySQL database, see the
video How to Query a Database with Bonita Open Solution.
2.8.1 Inputs
Bonita Open Solution supports multiple databases. The inputs required for each database
are specified in each database Connector wizard.
Figure 36. Configure a connector to execute a database query
1. Local access databases

 Access
2. Server based / remote access databases (with assigned port)

 PostGreSQL
 Sybase
 MySQL
 MSSQLServer
 Ingres
 Informix
 DB2
3. Server based /remote access (w/o port)

 Teradata
 AS400
4. Local OR Server-based
 H2
5. Local OR Server OR Web-server-based
 HSQL
6. Oracle
Note that to send the query result to a variable, you will need to define the Data variable
before you define the Connector.
Databases
Category: Database
Connector description: search in a database and return data
1,2,3,5,6
Database name of database string
1,2,3,4,5,6
User name database user’s name string
1,2,3,4,5,6
Password database password string
2,3,4,5,6
Host name IP address or name of string
database host server
2,3,5,6
Port database assigned port integer
2,2a
DB server name of database server string
4,5
Local check if locally based boolean
4,5
Server check if server-based boolean
5
Web server check if web-server based boolean
4
SSL support check if SSL security boolean
authentication required
6
SID check if database has an boolean
Oracle system ID
6
oracleServiceName check if this is to go to an boolean
alias
6
oracleOCI check is this is to go to an boolean
Oracle Instant Client
1,2,3,4,5,6
Query the statement or query string
expression which can
include variable(s) with the
syntax ${var}
1,2,3,4,5,6
Or select a data choose a variable to add select
you want to use
others some databases require
unique input (ie Oracle)
2.8.2 Outputs
You can return the output of your database query into a variable.
Figure 37. Define variable to take database query output
Database Connectors Output

rowSet result of Query RowSet
Destination variable Select a predefined
variable or Add a new one
2.9 How to configure Alfresco Connectors
For an example of how to configure an Alfresco Connector, see the video How to Upload a File to
Alfresco with Bonita Open Solution.
Figure 38. Alfresco Connectors
2.9.1 Common inputs
All Alfresco Connectors require the same initial input:
Figure 39. Common inputs for all Alfresco Connectors
Alfresco Connectors
host IP address or name of string
Alfresco directory host
server
port Alfresco directory port number
number
username Alfresco user name string
password Alfresco user password string
Unique inputs for each Alfresco Connector are given in the following sections.
2.9.2 Common outputs
All Alfresco Connectors present the same output options:
Figure 40. Configure outputs for Alfresco Connector

responseType Response type String
statusCode Response status code number
statusText Response status text String
stackTrace Stacktrace if exception String
occured
Destination variable Select a predefined
variable or Add a new one
2.9.3 Configure a Connector to cancel a checked-out Alfresco file
2.9.3.1 Unique inputs
Figure 41. Enter path and information for checked-out file to cancel
Cancel Checked-out File

Category: Alfresco
Connector description: cancel a checked-out file
File ID ID of the file to be canceled String
2.9.4 Configure a Connector to check in an Alfresco file
Figure 42. Enter ID and information for checked-in file
Check in
Category: Alfresco
Connector description: check in an Alfresco file
fileID ID of the file you are string
checking in
Major version
Check-in comments
2.9.5 Configure a Connector to check out an Alfresco file
Figure 43. Enter ID for checked-out file
Check out a File

Category: Alfresco
Connector description: check out an Alfresco file
fileID ID of the file you are string
checking out
2.9.6 Configure a Connector to create an Alfresco folder by path
Figure 44. Enter Alfresco path and folder details
Create Folders By Path

Category: Alfresco
Connector description: create folder in specified path
parentPath path of the folder in which String (file syntax)
you will create a new
folder
newFoldersName folder name String
newFoldersDescription folder description String
2.9.7 Configure a Connector to delete an Alfresco folder
Figure 45. Enter path of Alfresco folder to delete
Delete Folder By Path

Category: Alfresco
Connector description: delete folder and its contents in specified path
folderPath path of the folder to be String
deleted
2.9.8 Configure a Connector to delete an Alfresco item by ID
Figure 46. Enter ID for item to be deleted
Cancel Checked-out File

Category: Alfresco
Connector description: cancel a checked-out file
File ID ID of the item to be String
deleted
2.9.9 Configure a Connector to download an Alfresco file by ID
Figure 47. Enter path and information for file to download
Download file by ID
Category: Alfresco
Connector description: download a file by ID
Folder for the downloaded Destination folder for the String (file path syntax)
file file
Downloaded file name Name of file to be String
downloaded
2.9.10 Configure a Connector to download an Alfresco file by store and ID
Figure 48. Enter version store and information for file to download
Download file by store and ID

Category: Alfresco
Connector description: download a file by store and ID
Version store The sore for the version String

Folder for the downloaded Destination folder for the String (file path syntax)
file file
Downloaded file name Name of file to be String
downloaded
2.9.11 Configure a Connector to List Alfresco File versions
Figure 49. Enter ID of file
List File Versions

Category: Alfresco
Connector description: create folder in specified path
fileID ID of the file for which you string
are listing versions
2.9.12 Configure a Connector to list checked-out Alfresco files
This Connector has no unique inputs or outputs. See 2.9.1 and 2.9.2, Alfresco Common Inputs and
Output.
2.9.13 List all Alfresco folders by path
This Connector returns a list of Alfresco folders found in a specified path.
Figure 50. Specify the path for the folders
List Folder By Path

Category: Alfresco
Connector description: list folders in specified path
Folder path path of the folder for which String (file syntax)
you will list contents
2.9.14 Configure a Connector to update a checked-out Alfresco file
Figure 51. Enter path and information for checked-out file to update
Update Checked-out File

Category: Alfresco
Connector description: update a checked-out file
Absolute path of file path of the checked-out String (file syntax)
files
Description file description String
Mime type mime type String
checkedOutFileID ID of the file to be updated String
2.9.15 Configure a Connector to upload an Alfresco file by path
Figure 52. Enter path of and information about file
Upload File By Path

Category: Alfresco
Connector description: upload file to destination folder
Absolute path of file path of the folder in which String (file syntax)
you will create a new file
File name file name String
Description file description String
Mime type Mime type String
Destination folder Name of the destination String
folder in which you will
create a new file
2.10 How to configure Jasper Connectors
Figure 53. Configure Connector to Create a Jasper Report from a database
2.10.1 Inputs
Figure 54. Enter Jasper database locator and authentication
Create Report
Category: Jasper
Connector description: create a Jasper report from a database
Database driver Database driver string
JDBC URL Location of database string
User name database user name string
Password database user password string
2.10.2 Outputs
Figure 55. Enter file path and output for Jasper report
Create Report
Category: Jasper
Connector description: create a Jasper report from a database
JRXML file path Path of Jasper xml file string
Parameters: name Name of parameter to string
include in report
Parameters: value Value of parameter to string
include in report
Output file path Destination of output file string
Output format Choose pdf, html, or xml
2.11 How to Configure Sugar CRM Connectors
Figure 56. Configure Connectors for SugarCRM
2.11.1 Common inputs
Figure 57. Enter SugarCRM database locator and authentication
Get Sugar entries

Category: SugarCRM
Connector description: get SugarCRM entries from the indicated module
Sugar SOAP port Location of SOAP port String in the form a of a
path
User database user name String
Password database user password string
Application name Name of your Sugar app string
Figure 58. Define where to take SugarCRM output
Define the Data variables needed to accept the report returned. Note that you can Add
variables here for output.
2.11.2 Configure a Connector to get SugarCRM entries from indicated module
2.11.2.1 Unique Inputs
Figure 59. Inputs for Get SugarCRM entries
Get Sugar entries

Category: SugarCRM
Connector description: get SugarCRM entries from the indicated module
Module SugarCRM module to String
search in
Query Search function string
Order by How to organize the results string
returned
Fields to retrieve Results to return Array
Link name List of link names Array
Link fields Variable definitions for the Array
link fields
2.11.3 Configure a Connector to get SugarCRM Opportunities from an Account
Figure 60. Inputs for Get SugarCRM opportunities
Get Account Opportunities

Category: SugarCRM
Connector description: get SugarCRM opportunities from the specified account
Account ID ID of SugarCRM account to String
search
Account name Name of SugarCRM string
account to search
2.11.4 Configure a Connector to create or modify a SugarCRM entry
Figure 61. Inputs for Create or modify a SugarCRM entry
Set Sugar Entry

Category: SugarCRM
Connector description: Create or modify SugarCRM entry
Module Name of CRM module String
Name value list Name and value of entries string
to create or modify
2.11.5 Configure a Connector to create a SugarCRM Account
Figure 62. Inputs to Create a SugarCRM account
Create Sugar Account

Category: SugarCRM
Connector description: Create an account
Account name Name of new account String
Phone number Account’s phone number number
Website Account’s Web site URL
2.11.6 Configure a Connector to create a SugarCRM Contact
Figure 63. Inputs to Create a SugarCRM contact
Create Sugar Contact

Category: SugarCRM
Connector description: Create a contact
First name Name of contact String
Last name Family name of contact String
Email address name@name.ext String
Account ID Account to save contact to string
2.11.7 Configure a Connector to create a SugarCRM Opportunity
Figure 64. Inputs to Create a SugarCRM opportunity
Create Sugar Opportunity

Category: SugarCRM
Connector description: creates an opportunity
Name Name of contact String
Account ID Account to file opportunity String
in
Expected close date Date Date
Amount Anticipated amount of sale number
Probability Estimated probability of number
closure
2.12 How to configureTalend Connectors
2.12.1 Configure a Connector to launch a Talend job
Figure 65. Configure a Connector to launch a Talend job
2.12.1.1 Inputs
Figure 66. Configure a new Talend job
Talend Job Launcher

Category: Talend
Connector description: Create a new Talend Job
Project Name Name of the Talend project string
Job Name Name of the Talend job string
Job Version Version of the Talend job string
Job Parameter: name name of parameter string
Job parameter: value value of parameter string
Add row
Print Buffer Output Choose if you want your boolean
job to contain a buffer
output
2.12.1.2 Outputs
Figure 67. Configure output of Talend job

bufferOutput Definition of the schema of Array array (table) of
the response of the job strings
2.12.2 Configure a Connector to launch a Talend MDM Connector
2.12.2.1 Inputs
Figure 68. Enter Talend MDM authentication
Talend MDM Connector

Category: Talend
Connector description: Update a Talend MDM entity
server. You may use the
MDM_host variable if
defined
Port Host port. You may use number
the MDM_port variable if
defined.
Version The version to use. If string
empty, defaults to the
[HEAD] version. You may
use the MDM_universe
variable if defined.
Figure 69. Enter Talend MDM configuration
Talend MDM Connector

Category: Talend
Connector description: Update a Talend MDM entity
datamodel The data-model to use. You string
may use the
MDM_dataModel variable
if defined.
datacontainer The data-container to string
update. You may use the
MDM_dataCluster variable
if it is defined.
updatemap: name XPath of the element to string
update. More than one
element may be updated,
add multiple rows using
“add row”. There must be
at least one row with the
XPath to the PK. You may
use the variables with the
“_xpath” suffix if defined.
updatemap: value The PK value, or the value string
to set in the element for all
the other rows.
Add row
2.13 How to Configure eXo Connectors
Figure 70 Configure eXo Connectors

Figure 71. Inputs for eXo Connectors
eXo
host IP address or name of eXo string
directory host server
port eXo directory port number number
username eXo user name string
password eXo user password string
Figure 72. Outputs for eXo Connectors

response Can be: String
 client error
 redirection
 server error
 success
 unknown
statusCode Response status code number
2.13.3 Configure a Connector to cancel checkout of an exo JCR item
Figure 73. Unique input for Cancel a checked-out eXo item
eXo - CancelCheckout
Category: eXo
Connector description: Cancel checked-out item of eXo JCR through WebDAV server
URI URI of the item to cancel String
2.13.4 Configure a Connector to check in an eXo JCR item
Figure 74. Unique input for Check in an eXo item
eXo – Check in an eXo item

Category: eXo
Connector description: Check in an eXo JCR item through WebDAV server
URI URI of the item to check in String
2.13.5 Configure a Connector to check out an eXo JCR item
Figure 75. Unique input for check out an eXo item
eXo – Check out an eXo item

Category: eXo
Connector description: Check out an item from eXo JCR through WebDAV server
URI URI of the item to check String
out
2.13.6 Configure Connector to create a folder in eXo
Figure 76. Configure Connector to Create a new folder in eXo
eXo - CreateFolder
Category: eXo
Connector description: Create a new folder in eXo JCR
Parent URI URI of the parent folder String
new folder name name of new folder String
2.13.7 Configure a Connector to delete an item from eXo
Figure 77. Configure Connector to Delete an item from eXo
eXo – DeleteItem
Category: eXo
Connector description: delete an item from eXo JCR
URI URI of the item to delete String
2.13.8 Configure a Connector to download an eXo file
Figure 78. Inputs for Download an eXo file
eXo – DownloadFile
Category: eXo
Connector description: Download a file from a WebDav server
File URI URI of the file to download String
Output file folder Destination folder for the String
file
Output file name Name of the output file String
2.13.9 Configure a Connector to list eXo file versions
Figure 79. Inputs for List eXo file versions
eXo – File Versions

Category: eXo
Connector description: list file versions history through WebDAV server
URI URI of the file with versions String
to list
2.13.10 Configure a Connector to list eXo folders
Figure 80. Inputs for List eXo folders
eXo – List Folder

Category: eXo
Connector description: list eXo folder through WebDAVserver
URI URI of the folder to list String
2.13.11 Configure a Connector to upload a file to eXo
Figure 81. Configure Connector to Upload a file to eXo
eXo - UploadFile
Category: eXo
Connector description: upload file to a WebDAV server
Destination URI the destination URI of the String
folder of the uploaded file
File the absolute path of the String
file to upload
ContentType mime type of the uploaded String
file
2.13.10 Configure a Connector to enable version control on an eXo JCR file
Figure 82. Define inputs for version control on an eXo file
eXo – Version Control

Category: eXo
Connector description Enables version control on a file of aneXo JCR through WebDAV
server
URI URI of the folder for String
version control
2.14 How to configure xWiki Connectors
There are two xWikis Connectors; both have the same set of inputs and outputs to configure.
Figure 83. Configure an xWiki Connector
Figure 84. Common inputs for xWiki Connectors
Figure 85. Common inputs for xWiki Connectors
xWiki
host IP address or name of wiki string
host server
port wiki port number number
User name Wiki account user name string
password Wiki user password string
Wiki name Name of wiki String
Space name Wiki space String
Page name Page in wiki String
Class name Wiki class String
Property name
Property value
Figure 86. Outputs for xWiki Connectors

Property value* Value returned from search string
response Can be: String
 client error
 redirection
 server error
 success
 unknown
Property value is returned for the Get Metadata Connector only.
Note that the output fields can be deleted (red X) if no output is needed.
2.15 How to configure Google Connectors
Figure 87. Configure a Google calendar event
Figure 88. Common inputs for Google calendar Connectors
Google Calendar
userEmail Gmail user email user String
name: name@gmail.com
password Gmail password string
CalendarUrl URL of Google calendar (eg string
http://www.google.com/
calendar/feeds/
your_gmail_address/
private/full
2.15.2 Configure a Connector to create a Google calendar event with web content
Figure 89. Configure a Connector to Create a Google calendar event with web content
Google Calendar – CreateEventWithWebContent

Category: Google
Connector description: create a new event with Web content in specified Google
calendar
Title Title of event String
Content Content of event String
startTime Date and time to start Date (and time)
event
endTime Date and time to end event Date and time
icon URL of favicon (eg String
http://www.google.com/
favicon.ico
Icon Title Title of icon String
contentType Text or HTML String
url URL of web content String
Width Width of web content in number
pixels
Height Height of web content in number
pixels
2.15.3 Configure a Connector to create a Google calendar event
Figure 90. Configure a Connector to Create a Google calendar event
Google Calendar – CreateEvent

Category: Google
Connector description: create a new event in specified Google calendar
Title Title of event String
Content Content of event String
startTime Date and time to start Date
event
endTime Date and time to end event Date
2.15.4 Configure a Connector to delete a Google calendar event
Figure 91. Configure a Connector to Delete a Google calendar event
GoogleCalendar – DeleteEvent
Category: Google
Connector description: delete an event from specified Google calendar
searchString String to find event (by String
title)
2.16 How to configure a Connector to execute a web service
Figure 92. Configure a Connector to Execute a web service
2.16.1 Inputs
Figure 93. Configure a Web service Connector
Web Service Client – Execute a web service

Category: Web Services
Connector description: execute a Web service
Target NS Target namespace (URL) String
Service name Name of web service string
Port name Web service port name string
Request Requestor entity string
End point address URI string
Binding Specify protocol and data string
format
Figure 94. Configure Execute a Web service Connector outputs

Result result of execution source
Part 3. How to Configure Your Own Connectors
For a step-by-step example of how to develop a Connector, see the tutorial How to Create a
Connector. See also the video tutorial Create a Twitter Connector in Bonita Open Solution.
3.1 Develop your own Connectors
To add your own connector to Bonita Open Solution:

 Menu bar: Connector -> New Connector
 Menu bar: -> Connector -> New Group
 Menu bar: -> Connector -> New Filter
 click a Step and go to Details -> Connectors -> Create
Figure 95. Add your own Connector to Bonita Open Solution
The Connector wizard will appear.
Figure 96. Set the description of your Connector
 Connector ID: name the Connector

 Description: description of Connector function
 Category: select one of the existing Bonita Connector categories
 Icon: import an image to be displayed with the Connector name (recommended
square, not larger than 60 x 60 pixels)
 Class name: this automatically takes the Connector name, but you can change it
here
 Package: Java package
 Specify the pages of the wizard of your connector. This will define the parameters of
the fields to appear in the form displayed in the User Interface. Select Create.
o Enter the Page ID, title, and description
o Select Create
o For each field in the wizard, enter a Field name, indicate if it is Mandatory,
select a Widget and a Data type. Select OK to return to Set the description
of your Connector.
 Specify the outputs of your Connector. Select Create.
o Enter the field names and data types
Click Finish when completed.
The java source file window will appear, in which you can create the executable Connector.
When it is completed, save it and close the window to return to the Process.
Figure 97. Create java source file
The Connector you have created is now available in Details -> Connectors.
Figure 98. Your Connector is now available
For more information, see the tutorial, “How to Create a Connector,” and the video “How to
Get the Latest Tweet About a Subject.”
3.2 Import or Export a Connector
To import your own Connector to Bonita Open Solution:
 Menu Bar: Connector -> Open Connector
Figure 99. Import (or Export) a Connector from the Menu bar
Browse to where your Connector is located and upload it.
To export a Connector form Bonita Open Solution:
 Menu Bar -> Connector -> Export Connector
The Connector will be exported as a *.jar file.
Part 4. How to import a Connector from BonitaSoft Community

contributions
To import a Connector from BonitaSoft Community Contribution into Bonita Open Solution:
 Menu Bar: Extensions -> Browse contributions.
This will connect to the Contributions section of www.Bonitasoft.org. From here you can
select a shared extension and Install it. (You will need to be registered as a BonitaSoft
Community user and log in to the Community forum from Bonita Studio).
Figure 100. Select an extension from the Contributions page
Figure 101. Click Install to import extension
To close the Contributions page and return to the Whiteboard, click the X in the upper right
corner of the BonitaSoft.org window.
Part 5. How to analyze a problem in Bonita Open Solution
Your Bonita Open Solution log files (for Bonita Studio and Bonita Execution Engine are
available via the Menu Bar: Help -> Show log and Help -> Show engine log.
When you encounter a problem, please post a description of the problem and a copy of your
log file on the Bonita Community Forum at www.bonitasoft.org/forum/.
BonitaSoft developers, among others, actively contribute to the Bonita Community and will
post a response.

BOS 5.1 Connectors Guide

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

BOS 5.1 Connectors Guide

Uploaded by

Copyright:

Available Formats

Bonita Open Solution

Connectors Reference Guide

Bonita Open Solution V5.1

Part 1. Bonita Open Solution Connectors Overview .......................................................................... 9

2.6.6 Configure a Connector to create multiple variables ..................................................... 36

2.11.1 Common inputs ............................................................................................................. 53

2.13.10.1 Unique inputs ........................................................................................................... 70

Figure 1. Choose a Connector to Add .................................................................................................. 10

Figure 51. Specify the path for the folders .......................................................................................... 49

Bonita Open Solution

Part 1 gives a basic overview and general information.

Part 3 describes how to develop your own Connectors.

Part 4 describes how to import a Connector.

Part 1. Bonita Open Solution Connectors Overview

Bonita Open Solution provides Connectors to connect a Step or a Process to external

There are two ways to configure Connectors:

 Add a Connector – choose a Connector already defined in Bonita Open Solution

Part 2 How to connect processes to information systems

2.1 How to Add a Connector to a Step or a Process

2.1.1 Add a Connector to a Step

Figure 1. Choose a Connector to Add

In the wizard, for all Connectors, specify:

 Name: name the Connector

Figure 3. Specify Connector parameters at the Step level (Human Step)

o Enter: the connector implements as soon as the Process moves to this

2.1.1.1 Trigger a Connector when a Step Deadline is reached

 a date by which a Step must be completed, or

Figure 4. Configure a Deadline to trigger a Connector

 Enter Name and Description

2.1.2 Add a Connector to a Process or Pool

Figure 5. Specify Connector parameters at the Process or Pool level

2.1.3 Define Connector inputs and outputs

Figure 6. Add variables or delete output

Figure 7. Add a variable to take Connector output

2.1.4 Save Connector Configuration

Figure 8. Save a Connector configuration

2.1.5 Move / Copy a Connector

To move a Connector to a another Step, or to a Pool or Process, Go to Step -> Connectors

Figure 9. Move or duplicate a Connector

2.1.6 Test a Connector

From the Menu Bar, Select Connector -> Test a Connector.

Figure 10. Select Test a Connector

Then Select the type of Connector to test (Connectors, Groups, or Filters).

Figure 11. Test a Connector configuration

Figure 12. Choose a Connector to configure and evaluate

When the Connector parameters are defined, Evaluate it.

Figure 13. Evaluate the Connector when it is configured

Figure 14. …and wait for the evaluation results

2.2 How to configure Messaging and Social Connectors

2.2.1 Configure a Connector to send an email

Figure 15. Configure a Connector to send an email

Figure 16. Complete email Connector configuration

2.2.2 Configure a Connector to send a Twitter Direct Message

Figure 17. Configure a Connector to send a Twitter Direct Message

Twitter – Direct Message

2.2.3 Configure a Connector to send a Twitter Status Update

Figure 18. Configure a Connector to send a Twitter Status Update

Twitter – Update Status

2.3 How to configure Java Connectors

2.3.1 Configure a Connector to invoke a Java method

Figure 19. Configure a Connector to invoke a Java method

Figure 21. Choose the java method to invoke

2.4 How to configure Scripting Connectors