Connectors Reference Guide - Bonita BPM · Bonita Open Solution 5.6 Connectors Reference Guide BOS...

Bonita Open Solution

Version 5.6

Connectors Reference Guide

Bonita Open Solution 5.6 Connectors Reference Guide

BOS 5.6 Connectors Reference Guide, 27 October 2011 www.bonitasoft.com | © BonitaSoft S.A. page 2

Change Notice

New and improved connectors in Bonita Open Solution 5.6:

Drools: 6 new connectors

Salesforce: 7 new connectors (BOS Teamwork version only)

SAP graphical query (BOS Efficiency version only)

Configure a connector to send an email

Configure a connector to execute a secure web service

Configure a connector with to execute a web service with XML (BOS Teamwork only) General information about connectors, and specific information about the connectors listed abve, is now in the online documentation system found at http://docs.bonitasoft.com. The Connectors Reference Guide now contains only information about configuring specific connectors. The information in this document will be migrated to the online documentation system; check there for updates.

http://docs.bonitasoft.com/




Contents

1.0 How to configure Messaging and Social connectors ............................................................ 12

1.1 Configure a Connector to send a Twitter Direct Message .................................................... 12

1.2 Configure a connector to send a Twitter Status Update ...................................................... 13

2.0 How to configure Java connectors ........................................................................................ 15

2.1 Configure a Connector to invoke a Java method .................................................................. 15

3.0 How to configure scripting connectors ................................................................................. 17

3.1 Execute a shell command or script ....................................................................................... 17

3.1.1 Input .............................................................................................................................. 17

3.1.2 Output ........................................................................................................................... 18

3.2 Configure a Connector to execute a Groovy script ............................................................... 19

3.2.1 Input .............................................................................................................................. 19

3.2.2 Output ........................................................................................................................... 20

4.0 How to configure LDAP Directory Connectors ...................................................................... 21

4.1 Inputs .................................................................................................................................... 21

4.2 Outputs ................................................................................................................................. 23

5.0 How to configure Bonita system Connectors ....................................................................... 24

5.1 Configure a Connector to add a comment ........................................................................... 24

5.2 Configure a Connector to send a command to execute a task ............................................. 25

5.3 Configure a Connector to send a command to start a task .................................................. 26

5.4 Configure a Connector to send a command to finish a task ................................................. 27

5.5 Configure a Connector to create a variable .......................................................................... 28

5.6 Configure a Connector to create multiple variables ............................................................. 29

5.7 Configure a Connector to use a hook previously defined in Bonita v4................................. 30

5.8 Configure a Connector to add an attachment ...................................................................... 31

5.9 Configure a Connector to get the Initiator of a Process Case ............................................... 32

5.10 Configure a Connector to get the Submitter of a task .......................................................... 33

5.11 Configure a Connector to get a User Name .......................................................................... 34

5.12 Configure a Connector to start a Case .................................................................................. 35

6.0 How to configure Database Connectors ............................................................................... 36

6.1 Inputs .................................................................................................................................... 36

6.2 Outputs ................................................................................................................................. 39

6.3 Use Java Database Connectivity (JDBC) to execute a query or script ................................... 40

6.3.1 Inputs ............................................................................................................................ 40

6.4 Use the graphical query tool for SQL database Connectors (available in BOS Teamwork) . 42

7.0 How to configure Alfresco Connectors ................................................................................. 46

7.1 Common inputs ..................................................................................................................... 47



7.2 Common outputs .................................................................................................................. 48

7.3 Configure a Connector to cancel a checked-out Alfresco file ............................................... 49

7.3.1 Unique inputs ................................................................................................................ 49

7.4 Configure a Connector to check in an Alfresco file ............................................................... 49

7.4.1 Unique inputs ................................................................................................................ 49

7.5 Configure a Connector to check out an Alfresco file ........................................................... 50

7.5.1 Unique inputs ................................................................................................................ 50

7.6 Configure a Connector to create an Alfresco folder by path ................................................ 51

7.6.1 Unique inputs ................................................................................................................ 51

7.7 Configure a Connector to delete an Alfresco folder ............................................................. 51

7.7.1 Unique inputs ................................................................................................................ 51

7.8 Configure a Connector to delete an Alfresco item by ID ...................................................... 52

7.8.1 Unique inputs ................................................................................................................ 52

7.9 Configure a Connector to download an Alfresco file by ID ................................................... 52

7.9.1 Unique inputs ................................................................................................................ 52

7.10 Configure a Connector to download an Alfresco file by store and ID .................................. 53

7.10.1 Unique inputs ................................................................................................................ 53

7.11 Configure a Connector to List Alfresco File versions ............................................................ 54

7.11.1 Unique inputs ................................................................................................................ 54

7.12 Configure a Connector to list checked-out Alfresco files ...................................................... 54

7.13 List all Alfresco folders by path ............................................................................................. 54

7.13.1 Unique inputs ................................................................................................................ 54

7.14 Configure a Connector to update a checked-out Alfresco file .............................................. 55

7.14.1 Unique inputs ................................................................................................................ 55

7.15 Configure a Connector to upload an Alfresco file by path .................................................... 56

7.15.1 Unique inputs ................................................................................................................ 56

8.0 How to configure Jasper Connectors .................................................................................... 57

8.1 Inputs .................................................................................................................................... 57

8.2 Outputs ................................................................................................................................. 58

9.0 How to Configure Sugar CRM Connectors ............................................................................ 59

9.1 Common inputs ..................................................................................................................... 59

9.2 Common outputs .................................................................................................................. 60

9.3 Configure a Connector to get SugarCRM entries from indicated module ............................ 61

9.3.1 Unique Inputs ................................................................................................................ 61

9.4 Configure a Connector to get SugarCRM Opportunities from an Account ........................... 62

9.4.1 Unique inputs ................................................................................................................ 62

9.5 Configure a Connector to create or modify a SugarCRM entry ............................................ 63

9.5.1 Unique inputs ................................................................................................................ 63



9.6 Configure a Connector to create a SugarCRM Account ........................................................ 64

9.6.1 Unique Inputs ................................................................................................................ 64

9.7 Configure a Connector to create a SugarCRM Contact......................................................... 64

9.7.1 Unique Inputs ................................................................................................................ 64

9.8 Configure a Connector to create a SugarCRM Opportunity ................................................. 65

9.8.1 Unique inputs ................................................................................................................ 65

10.0 How to configure Talend Connectors ................................................................................... 66

10.1 Configure a Connector to launch a Talend job ..................................................................... 66

10.1.1 Inputs ........................................................................................................................ 67

10.1.2 Outputs ......................................................................................................................... 68

10.2 Configure a Connector to launch a Talend MDM Connector ............................................... 68

10.2.1 Inputs ............................................................................................................................ 68

11.0 How to Configure eXo Connectors ........................................................................................ 71

11.1 Common inputs ..................................................................................................................... 71

11.2 Common outputs .................................................................................................................. 72

11.3 Configure Connector to create a folder in eXo ..................................................................... 73

11.3.1 Unique inputs ................................................................................................................ 73

11.4 Configure a Connector to download an eXo file ................................................................... 73

11.4.1 Unique inputs ................................................................................................................ 73

11.5 Configure a Connector to upload a file to eXo ..................................................................... 74

12.0 How to configure xWiki Connectors ..................................................................................... 75

12.1 Common inputs ..................................................................................................................... 75

12.2 Common outputs .................................................................................................................. 77

13.0 How to configure Google Connectors ................................................................................... 78

13.1 Common inputs ..................................................................................................................... 78

13.2 Configure a Connector to create a Google calendar event with web content ..................... 79

13.2.1 Unique inputs ................................................................................................................ 79

13.3 Configure a Connector to create a Google calendar event .................................................. 80

13.3.1 Unique inputs ................................................................................................................ 80

13.4 Configure a Connector to delete a Google calendar event .................................................. 81

13.4.1 Unique inputs ................................................................................................................ 81

14.0 How to configure web service Connectors ........................................................................... 82

14.1 How to configure a Connector to execute a web service ..................................................... 82

14.1.1 Inputs ............................................................................................................................ 82

14.1.2 Outputs ......................................................................................................................... 83

14.2. How to call a Web service using POJO (available in BOS Teamwork) ............................... 84

14.2.1 Inputs ............................................................................................................................ 84

14.2.2 Outputs ......................................................................................................................... 85



14.3 Call a Web service using XML (available in BOS Teamwork) ................................................ 86

14.3.1 Inputs ............................................................................................................................ 86

14.3.2 Outputs ......................................................................................................................... 87

15.0 How to configure SAP Connectors ........................................................................................ 89

15.1 Configure a Connector to execute an SAP call function ....................................................... 89

15.1.1 Inputs for existing configuration ................................................................................... 89

15.1.2 Outputs ......................................................................................................................... 92

15.2 Configure a Connector to create an SAP connection............................................................ 93

15.2.1 Inputs ............................................................................................................................ 93

15.2.2 Outputs ......................................................................................................................... 94

15.3 Configure a Connector to execute an SAP commit ............................................................... 94

15.3.1 Inputs ............................................................................................................................ 94

15.4 Configure a Connector to release an SAP connection .......................................................... 95

15.4.1 Inputs ............................................................................................................................ 95

15.5 Configure a Connector to execute an SAP rollback .............................................................. 95

15.5.1 Inputs ............................................................................................................................ 95

16.0 How to configure SharePoint Connectors ............................................................................ 96

16.1 Common inputs ..................................................................................................................... 96

16.2 Common outputs .................................................................................................................. 97

16.3 Configure a Connector to cancel checkout from a SharePoint server .............................. 98

16.4 Configure a Connector to check in a SharePoint file ............................................................ 98

16.4.1 Unique inputs ................................................................................................................ 98

16.5 Configure a Connector to check out a SharePoint file .......................................................... 98

16.6 Configure Connector to get items from a SharePoint List .................................................... 98

16.6.1 Unique inputs ................................................................................................................ 98

16.6.2 Unique Outputs ............................................................................................................. 99

16.7 Configure Connector to create a new folder in SharePoint ................................................ 100

16.7.1 Unique inputs .............................................................................................................. 100

16.8 Configure a Connector to delete a SharePoint item ........................................................... 100

16.8.1 Unique inputs .............................................................................................................. 101

16.9 Configure a Connector to download a SharePoint file ....................................................... 102

16.9.1 Unique inputs .............................................................................................................. 102

16.10 Configure a Connector to upload a file to SharePoint .................................................... 103

16.10.1 Unique inputs .......................................................................................................... 103

17.0 How to Configure Exchange Connectors ............................................................................ 104

17.1 Common inputs ................................................................................................................... 104

17.2 Configure a Connector to create a new Exchange calendar item ...................................... 105

17.2.1 Unique Inputs .............................................................................................................. 105



17.2.2 Unique outputs ........................................................................................................... 106

17.3 Create a new Exchange contact .......................................................................................... 107

17.3.1 Unique inputs .............................................................................................................. 107

18.0 How to Configure Sheetster Connectors ............................................................................ 108

18.1 Configure a Connector to get the content of a cell ............................................................ 108

18.1.1 Inputs .......................................................................................................................... 108

18.1.2 Outputs ....................................................................................................................... 109

19.0 How to Configure CMIS Connectors ................................................................................... 110

19.1 Common inputs ................................................................................................................... 110

19.2 Verify if an object exists .................................................................................................. 111

19.2.1 Unique inputs .............................................................................................................. 111

19.2.2 Unique Outputs ........................................................................................................... 111

19.3 Create a folder .................................................................................................................... 112

19.3.1 Unique inputs .............................................................................................................. 112

19.4 Delete a folder .................................................................................................................... 113

19.4.1 Unique inputs .............................................................................................................. 113

19.5 Delete an object .................................................................................................................. 114

19.5.1 Unique inputs .............................................................................................................. 114

19.6 Download CMIS document ................................................................................................. 115

19.6.1 Unique inputs .............................................................................................................. 115

19.7 Retrieve an object ............................................................................................................... 116

19.7.1 Unique inputs .............................................................................................................. 116

19.7.2 Unique Outputs ........................................................................................................... 116

19.8 Get a list of repositories for a CMIS server ......................................................................... 117

19.8.1 Unique Outputs ........................................................................................................... 117

19.9 Get the root folder of a repository ..................................................................................... 117

19.9.1 Unique inputs .............................................................................................................. 117

19.9.2 Unique Outputs ........................................................................................................... 118

19.10 List a folder ...................................................................................................................... 118

19.10.1 Unique inputs .......................................................................................................... 118

19.10.2 Unique Outputs ....................................................................................................... 119

19.11- List versions of a document ............................................................................................ 119

19.11.1 Unique inputs ......................................................................................................... 119

19.11.2 Unique Outputs ....................................................................................................... 120

19.12- Modify a document ......................................................................................................... 120

19.12.1 Unique inputs ......................................................................................................... 120

19.13- Upload a file .................................................................................................................... 121

19.13.1 Unique inputs .......................................................................................................... 121



Figures

Figure 1. Configure a Connector to send a Twitter Direct Message .................................................... 12 Figure 2. Configure a Connector to send a Twitter Status Update ...................................................... 13 Figure 3. Configure a Connector to invoke a Java method .................................................................. 15 Figure 4. Browse for the java class, enter a string to search and choose ............................................ 15 Figure 5. Choose the Java method to invoke ....................................................................................... 16 Figure 6. Configure a Connector to execute a shell command or script .............................................. 17 Figure 7. Choose a destination variable for the output returned ........................................................ 18 Figure 8. Configure a Connector to execute a Groovy script ............................................................... 19 Figure 9. Choose a destination variable for the output returned ........................................................ 20 Figure 10. Configure a Connector to search in an LDAP directory and return a list ............................ 21 Figure 11. Define LDAP directory search ............................................................................................. 22 Figure 12. Configure LDAP Connector outputs .................................................................................... 23 Figure 13. Configure a Connector to add a comment .......................................................................... 24 Figure 14. Configure a Connector to send a command to execute a task ........................................... 25 Figure 15. Configure a Connector to send a command to start a task ................................................ 26 Figure 16. Configure a Connector to send a command to finish a task ............................................... 27 Figure 17. Configure a Connector to create a variable ........................................................................ 28 Figure 18. Configure a Connector to create a variable ........................................................................ 29 Figure 19. Configure a Connector to use a hook defined in Bonita v4 ................................................ 30 Figure 20. Configure a Connector to add an attachment .................................................................... 31 Figure 21. Configure a Connector to get the initiator of a Process case ............................................. 32 Figure 22. Data returned for case initiator .......................................................................................... 32 Figure 23. Configure a Connector to get Submitter of a task .............................................................. 33 Figure 24. Data returned for Step Submitter ....................................................................................... 33 Figure 25. Configure a Connector to get a User Name ........................................................................ 34 Figure 26. Data returned for User Name ............................................................................................. 34 Figure 27. Configure a Connector to instantiate a Process Case ......................................................... 35 Figure 28. Data returned Instantiated Process Case ............................................................................ 35 Figure 29. Configure a connector to execute a database query .......................................................... 37 Figure 30. Define variable to take database query output .................................................................. 39 Figure 31. Use JDBC to query a database ............................................................................................ 40 Figure 32. Configure JDBC .................................................................................................................... 41 Figure 33. Select the option to Use graphical query builder ............................................................... 42 Figure 34. Graphical query builder....................................................................................................... 43 Figure 35. Add a table in the graphical editor...................................................................................... 43 Figure 36. Use Query tab to see the query .......................................................................................... 44 Figure 37. Use variables or Groovy expressions in Conditions ............................................................ 44 Figure 38. Test the query ..................................................................................................................... 45 Figure 39. Alfresco Connectors ............................................................................................................. 46 Figure 40. Common inputs for all Alfresco Connectors ....................................................................... 47 Figure 41. Configure outputs for Alfresco Connector .......................................................................... 48 Figure 42. Enter path and information for checked-out file to cancel ................................................ 49 Figure 43. Enter ID and information for checked-in file ...................................................................... 49 Figure 44. Enter ID for checked-out file ............................................................................................... 50 Figure 45. Enter Alfresco path and folder details ................................................................................ 51 Figure 46. Enter path of Alfresco folder to delete ............................................................................... 51 Figure 47. Enter ID for item to be deleted ........................................................................................... 52 Figure 48. Enter path and information for file to download ............................................................... 52 Figure 49. Enter version store and information for file to download .................................................. 53



Figure 50. Enter ID of file ..................................................................................................................... 54 Figure 51. Specify the path for the folders .......................................................................................... 54 Figure 52. Enter path and information for checked-out file to update ............................................... 55 Figure 53. Enter path of and information about file ............................................................................ 56 Figure 54. Configure Connector to Create a Jasper Report from a database ...................................... 57 Figure 55. Enter file path and output for Jasper report ....................................................................... 58 Figure 56. Configure Connectors for SugarCRM .................................................................................. 59 Figure 57. Enter SugarCRM database locator and authentication ...................................................... 59 Figure 58. Define where to take SugarCRM output ............................................................................. 60 Figure 59. Inputs for Get SugarCRM entries ........................................................................................ 61 Figure 60. Inputs for Get SugarCRM opportunities .............................................................................. 62 Figure 61. Inputs for Create or modify a SugarCRM entry ................................................................... 63 Figure 62. Inputs to Create a SugarCRM account ................................................................................ 64 Figure 63. Inputs to Create a SugarCRM contact ................................................................................. 64 Figure 64. Inputs to Create a SugarCRM opportunity .......................................................................... 65 Figure 65. Configure a Connector to launch a Talend job ................................................................... 66 Figure 66. Configure a new Talend job ................................................................................................ 67 Figure 67. Configure output of Talend job ........................................................................................... 68 Figure 68. Enter Talend MDM authentication ..................................................................................... 68 Figure 69. Enter Talend MDM configuration ....................................................................................... 69 Figure 70 Configure eXo Connectors ................................................................................................... 71 Figure 71a and b. Inputs for eXo Connectors ...................................................................................... 71 Figure 72. Outputs for eXo Connectors ............................................................................................... 72 Figure 73. Configure Connector to Create a new folder in eXo ........................................................... 73 Figure 74. Inputs for Download an eXo file ......................................................................................... 73 Figure 75. Configure Connector to Upload a file to eXo ...................................................................... 74 Figure 76. Configure an xWiki Connector ............................................................................................ 75 Figure 77a and b. Common inputs for xWiki Connectors .................................................................... 76 Figure 78. Outputs for xWiki Connectors ............................................................................................. 77 Figure 79. Configure a Google calendar event ..................................................................................... 78 Figure 80. Common inputs for Google calendar Connectors ............................................................... 78 Figure 81. Configure a Connector to Create a Google calendar event with web content ................... 79 Figure 82. Configure a Connector to Create a Google calendar event ................................................ 80 Figure 83. Configure a Connector to Delete a Google calendar event ................................................ 81 Figure 84. Configure a Connector to Execute a web service ................................................................ 82 Figure 85. Configure a Web service Connector ................................................................................... 82 Figure 86. Configure Execute a Web service Connector outputs ......................................................... 83 Figure 87. Create a Connector to call a Web Service based on POJO .................................................. 84 Figure 88. Configure a Web Services Connector using POJO ............................................................... 84 Figure 89. Find the Java object to define the output ........................................................................... 85 Figure 90. Define Web service output ................................................................................................. 86 Figure 91. Configure a Web Services Connector using xml ................................................................. 86 Figure 92. Set the Xpath expression to define the output ................................................................... 87 Figure 93. Define xml Web service output........................................................................................... 88 Figure 94. Configure a Connector to call an SAP function ................................................................... 89 Figure 95a and b. Configure a Connector to execute an SAP call function ......................................... 90 Figure 96. Configure a connector to execute an SAP call function, cont’d .......................................... 91 Figure 97. Configure a connector to execute an SAP call function, cont’d .......................................... 91 Figure 98. Configure outputs for SAP call function .............................................................................. 92 Figure 99a and b. Configure a Connector to create an SAP client ....................................................... 93 Figure 100. Configure outputs for Create an SAP client ...................................................................... 94 Figure 101. Configure a connector to execute an SAP commit ........................................................... 94



Figure 102. Configure a connector to release an SAP connection ....................................................... 95 Figure 103. Configure a connector to execute an SAP rollback ........................................................... 95 Figure 104 Configure SharePoint Connectors ...................................................................................... 96 Figure 105. Inputs for SharePoint Connectors ..................................................................................... 96 Figure 106. Sharepoint map .................................................................................................................. 97 Figure 107a and b. outputs for Outputs for SharePoint Connectors ................................................... 97 Figure 108. Unique input for Check in file from a SharePoint server .................................................. 98 Figure 109. Configure Connector to Create a new folder in SharePoint ............................................. 99 Figure 110. Unique output for Get items from a SharePoint list ......................................................... 99 Figure 111a and b. Configure Connector to Create a new folder in SharePoint ............................... 100 Figure 112. Configure Connector to Delete an item from SharePoint .............................................. 101 Figure 113. Inputs for Download a SharePoint file ............................................................................ 102 Figure 114. Configure Connector to Upload a file to SharePoint ...................................................... 103 Figure 115. Configure Exchange connectors ...................................................................................... 104 Figure 116. Configure a Connector to create a new calendar item ................................................... 105 Figure 117. Configure a Connector to map outputs ........................................................................... 106 Figure 118. Configure Connector for create a new Exchange contact .............................................. 107 Figure 119. Configure a Connector to get the content of a Sheetster cell ........................................ 108 Figure 120. Outputs of a Sheetster Connector .................................................................................. 109 Figure 121. Configure CMIS connectors ............................................................................................. 110 Figure 122. Configure CMIS Connector to verify if an object exists .................................................. 111 Figure 123. Unique output to verify if an object exists ...................................................................... 111 Figure 124. Configure CMIS Connector to create a folder ................................................................. 112 Figure 125. Configure CMIS Connector to delete a folder ................................................................. 113 Figure 126. Configure CMIS Connector to delete an object .............................................................. 114 Figure 127. Configure CMIS Connector to download a document .................................................... 115 Figure 128. Configure CMIS Connector to retrieve an object ............................................................ 116 Figure 129. Unique output to retrieve an object ............................................................................... 116 Figure 130. Unique output for get a list of CMIS repositories ........................................................... 117 Figure 131. Configure CMIS Connector to get the root folder of a repository .................................. 117 Figure 132. Unique output to get the root folder of a repository ..................................................... 118 Figure 133. Configure CMIS Connector to list a folder ...................................................................... 118 Figure 134. Unique output for verify if an object exists .................................................................... 119 Figure 135. Configure CMIS Connector to list versions of a document ............................................. 119 Figure 136. Unique output for the versions list for a document ....................................................... 120 Figure 137. Configure CMIS Connector to modify a document ......................................................... 120 Figure 138. Configure CMIS Connector to upload a file..................................................................... 121



Bonita Open Solution

How to Use Connectors

See the BonitaSoft online documentation (http://docs.bonitasoft.com) for an overview of connectors, and for:

Add a connector to a task or pool

Create a custom connector

Define connector output

Save and reuse connector configurations

Trigger a connector on a task deadline

Move or copy a connector

Test a connector

Import a connector

Export a connector

Debug / disconnect a connector

Refresh connector repository And for the following improved and new connectors:

Drools: 6 new connectors

Salesforce: 7 new connectors (BOS Teamwork version only)

Configure a connector to send an email

SAP graphical query (BOS Efficiency version only)

Configure a connector to call a secure web service

Configure a connector with to call a web service with XML (BOS Teamwork only)





1.0 How to configure Messaging and Social connectors

See the BonitaSoft online documentation (http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/messaging/send-email) for how to configure a connector to send an email.

1.1 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 1. Configure a Connector to send a Twitter Direct Message


http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/messaging/send-email

http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/messaging/send-email



Twitter – Direct Message

Category: Social

Connector description: send a Twitter message directly

Input Description Type

Consumer key *See below string

Consumer secret *See below string

Access token *See below string

Access token secret *See below string

Message message to recipient which can include variable(s) and text (eg hello ${var})

string

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

You will need to configure BOS as a registered application for Twitter – see this blog post on how to obtain and what to do with the ConsumerKey, ConsumerSecret, Access Token and Access Secret.

1.2 Configure a connector to send a Twitter Status Update

This Connector will broadcast a Status Update via Twitter. There is no output returned.

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

http://consultingblogs.emc.com/nileeshabojjawar/archive/2010/03/18/twitter4j-oauth-generating-the-access-token.aspx



Twitter – Update Status

Category: Social

Connector description: send a Twitter update to “What are you doing?”


Consumer key *See send a Twitter direct message, above

string

Consumer secret *See send a Twitter direct message, above

string

Access token *See send a Twitter direct message, above

string

Access token secret *See send a Twitter direct message, above

string

Show password checkbox boolean

Message message from sender string

Or select a data you want to use

choose a variable to add 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

Show password checkbox boolean



2.0 How to configure Java connectors

2.1 Configure a Connector to invoke a Java method

Figure 3. Configure a Connector to invoke a Java method

Figure 4. Browse for the java class, enter a string to search and choose



Figure 5. Choose the Java method to invoke

Java Executor

Category: Java

Connector description: configure invocation of Java methods


Class java class; click Browse and enter a string to find class

select

Methods methods defined for selected class; double-click on method to set

select



3.0 How to configure scripting connectors

See the BonitaSoft online documentation (http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/scripting/execute-complex-shell-script) for how to configure a connector to execute a complex shell script.

3.1 Execute a shell command or script

3.1.1 Input

Figure 6. 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 command path to execute a shell file can include variable(s)

string

Or select a data you want to use

choose a variable to add select


http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/scripting/execute-complex-shell-script

http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/scripting/execute-complex-shell-script



3.1.2 Output

Figure 7. 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 command

string



3.2 Configure a Connector to execute a Groovy script

3.2.1 Input

Figure 8. 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

http://groovy.codehaus.org/



3.2.2 Output

Figure 9. Choose a destination variable for the output returned



Result result of script or command

object



4.0 How to configure LDAP Directory Connectors

This Connector searches in an LDAP directory and returns a list. For more detail about how to configure an LDAP connector in an Actor Selector, see http://www.bonitasoft.org/wiki/doku.php?id=actor_selector_ldap

4.1 Inputs

Figure 10. 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


Host IP address or name of server hosting LDAP directory

string

Port LDAP directory port number

number

Protocol choose LDAP, LDAPS, or TLS

select

User LDAP User name string

Password LDAP user password string

http://www.bonitasoft.org/wiki/doku.php?id=actor_selector_ldap



Figure 11. Define LDAP directory search

Base DN Identify Distinguished Name at which to start search

string

Filter specify a subset , e.g. (&(objectClass=person)

(givenName=John))

String in accordance with LDAP syntax

Attributes define attributes to return in result entries using LDAP syntax

string or strings separated by “,”

Under Advanced Configuration:

Scope subtree (entire subtree starting at the base DN)

one level (entries immediately below base DN)

base (search just named entry)

select

Size limit maximum number of entries to return

number

Time limit (in seconds) maximum time to allow search to run

number

Referral handling ignore or follow referrals select

Alias dereferencing always: Always dereference aliases

searching: Dereference aliases

select



only after name resolution

never: Never dereference aliases

finding: Dereference aliases only during name resolution.

4.2 Outputs

Figure 12. Configure LDAP Connector outputs


Result result of Query: LdapAttributeList

List of LdapAttributes



5.0 How to configure Bonita system Connectors

Bonita Connectors apply actions inside the Bonita-defined process. Note that when a Connector is configured to act on another Task in the Process, the target Task must be already activated in order for the connector to work properly (ie, Connectors cannot act on future Tasks.)

5.1 Configure a Connector to add a comment

This Connector adds a comment to a Task which will be shown in the User Experience when the Process is running.

Figure 13. Configure a Connector to add a comment

Add a comment

Category: Other

Connector description: Add text to a Task or a Process

Input Input description Type

message enter text to display string

On this step The comment appears when this task shows up in the User Experience inbox



5.2 Configure a Connector to send a command to execute a task

When it is activated, it executes a specified Task.

Figure 14. Configure a Connector to send a command to execute a task

Execute a Task

Category: other

Connector description: send a command to execute the indicated Task (anywhere in the Pool)


Step name name of Task string



5.3 Configure a Connector to send a command to start a task

This Connector starts a specified Task when it is activated.

Figure 15. Configure a Connector to send a command to start a task

Start a Task

Category: other

Connector description: send a command to start the indicated Task (any Task in the Pool)





5.4 Configure a Connector to send a command to finish a task

This Connector finishes a specified Task when it is activated.

Figure 16. Configure a Connector to send a command to finish a task

Finish a Task

Category: other

Connector description: send a command to finish the indicated Task (any Task in the Pool)





5.5 Configure a Connector to create a variable

This Connector sets the value of a Data variable when a Task is reached.

Figure 17. 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



5.6 Configure a Connector to create multiple variables

This Connector sets the value of multiple Data variables when a Task is reached.

Figure 18. 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

Set value as expression Chose an expression to set String

Set value as table Chose a table to set String in the form: list<list<object>>



5.7 Configure a Connector to use a hook previously defined in Bonita v4

Figure 19. 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



5.8 Configure a Connector to add an attachment

This Connector adds an attachment as data in a Task.

Figure 20. Configure a Connector to add an attachment

Add a comment

Category: Other

Connector description: Add an attachment to a Task or a Process


Attachment name enter text to display string

File path Path to directory where file is located



5.9 Configure a Connector to get the Initiator of a Process Case

Figure 21. Configure a Connector to get the initiator of a Process case

Get Case Initiator

Category: Other

Connector description: Get the Initiator of a Process Case


InstanceUUID enter UUID of target process

string

Figure 22. Data returned for case initiator

You can return the output this connector into a predefined variable.


instanceInitiator result UUID



5.10 Configure a Connector to get the Submitter of a task

This Connector will fetch the name of the User who submits a Task (in Bonita User Experience).

Figure 23. Configure a Connector to get Submitter of a task

Get Task Submitter

Category: Other

Connector description: get the name of the User who submits a task


Step name Name of target Task string

Figure 24. Data returned for Step Submitter



author result string



5.11 Configure a Connector to get a User Name

This Connector will fetch the name of a User.

Figure 25. Configure a Connector to get a User Name

Get User Name

Category: Other

Connector description: get the name of a User


Step name Name of target Task string

Figure 26. Data returned for User Name



user result string



5.12 Configure a Connector to start a Case

This Connector will instantiate a Process case using given parameters..

Figure 27. Configure a Connector to instantiate a Process Case

Instantiate a Process Case

Category: Other

Connector description: start a Process Case


Process name Name of target Process string

Process version Which version of Process to Instantiate

number

Process variables Add the input variables to start the case with

various

Figure 28. Data returned Instantiated Process Case


Output Description Type createdProcessInstanceUUID result string



6.0 How to configure Database Connectors

You can configure a Bonita Open Solution connector for the databases shown below, or you can use Java Database Connectivity (JDBC) to execute a query on any database. (See Use JDBC to execute a query.) 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. Drivers for the following databases can be downloaded as noted:

H2 http://www.h2database.com/html/download.html

HSQL http://sourceforge.net/projects/hsqldb/files/

Ingres http://community.ingres.com/wiki/Ingres_JDBC_Driver_Downloads

MySQL http://dev.mysql.com/downloads/connector/j/

Oracle http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html

PostgreSQL http://jdbc.postgresql.org/

SQLserver http://jtds.sourceforge.net/

Sybase http://www.sybase.com/products/allproductsa-z/softwaredeveloperkit/jconnect

Teradata http://www.teradata.com/downloadcenter/

6.1 Inputs

Bonita Open Solution supports multiple databases. The inputs required for each database are specified in each database Connector wizard.

http://www.bonitasoft.org/blog/?p=329

http://www.h2database.com/html/download.html

http://sourceforge.net/projects/hsqldb/files/

http://community.ingres.com/wiki/Ingres_JDBC_Driver_Downloads

http://dev.mysql.com/downloads/connector/j/

http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html

http://jdbc.postgresql.org/

http://jtds.sourceforge.net/

http://www.sybase.com/products/allproductsa-z/softwaredeveloperkit/jconnect

http://www.sybase.com/products/allproductsa-z/softwaredeveloperkit/jconnect

http://www.teradata.com/downloadcenter/



Figure 29. Configure a connector to execute a database query

1. Local access databases

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

JDBC

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

Input Description Type 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

database host server string

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

authentication required boolean

6 SID check if database has an Oracle system ID

boolean

6 oracleServiceName check if this is to go to an alias

boolean

6 oracleOCI check is this is to go to an Oracle Instant Client

boolean

1,2,3,4,5,6 Query the statement or query expression which can include variable(s) with the syntax ${var}

string

1,2,3,4,5,6 Or select a data you want to use

choose a variable to add select

others some databases require unique input (ie Oracle)



6.2 Outputs

You can return the output of your database query into a variable.

Figure 30. 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



6.3 Use Java Database Connectivity (JDBC) to execute a query or script

Figure 31. Use JDBC to query a database

6.3.1 Inputs



Figure 32. Configure JDBC

Databases

Category: Java Database Connector

Connector description: Use a JDBC to execute a command on a database


Driver database access driver string

URL Location of the target database

String in the form of a URL

User name database user’s name string

Password database password string

Query or script To be executed on database

string

Statement separator For multiple statements: (separator specific to database being queried)

go MS SQL, Sybase ; all others



6.4 Use the graphical query tool for SQL database Connectors

(available in BOS Teamwork)

You can create a query for an SQL database (MySQL, PostgreSQL, Oracle, and MSSQLServer) using the graphic SQL query tool. To use this feature, you need to have a working connection to your database. To create an SQL query graphically, go to the Details for a Task, General ->. Connectors -> Add. Choose an SQL Database Connector (for example, MySQL). Name the Connector, select the event parameter, and select the “If connector fails” option. Configure the Connector from blank settings. (See Bonita Open Solution Connectors Guide for more information about how to configure Connectors.) When the MySQL database configuration and test dialog appears, select Use graphical query builder.

Figure 33. Select the option to Use graphical query builder



Figure 34. Graphical query builder

Select a Query type: SELECT, INSERT, UPDATE, or DELETE. To add a table, right-click in the panel and use the pop-up menu

Figure 35. Add a table in the graphical editor

Note that you can check the query source by clicking on the Query tab.



Figure 36. Use Query tab to see the query

Use the Condition tab in the bottom of the editor to simply build a where clause. Here you can inject variables from your process, and/or create a Groovy expression.

Figure 37. Use variables or Groovy expressions in Conditions

When you have completed the query, you can test if using the Run SQL button.



Figure 38. Test the query



7.0 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 39. Alfresco Connectors

http://www.youtube.com/user/BonitaSoft#p/a/f/1/duv3NnWmGh4

http://www.youtube.com/user/BonitaSoft#p/a/f/1/duv3NnWmGh4



7.1 Common inputs

All Alfresco Connectors require the same initial input:

Figure 40. Common inputs for all Alfresco Connectors

Alfresco Connectors


host IP address or name of Alfresco directory host server

string

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.



7.2 Common outputs

All Alfresco Connectors present the same output options:

Figure 41. Configure outputs for Alfresco Connector


responseDocument Response document String

responseType Response type String

statusCode Response status code number

statusText Response status text String

stackTrace Stacktrace if exception occured

String




7.3 Configure a Connector to cancel a checked-out Alfresco file

7.3.1 Unique inputs

Figure 42. 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

7.4 Configure a Connector to check in an Alfresco file

7.4.1 Unique inputs

Figure 43. 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 checking in

string

Major version if true, the file is checked in as a major version (example from 5.1 to 6.0) if false, the file the file is checked in as a minor version (example from 5.1 to 5.2)

Boolean

Check-in comments File history string

7.5 Configure a Connector to check out an Alfresco file

7.5.1 Unique inputs

Figure 44. 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 checking out

string



7.6 Configure a Connector to create an Alfresco folder by path

7.6.1 Unique inputs

Figure 45. 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 you will create a new folder

String (file syntax)

newFoldersName folder name String

newFoldersDescription folder description String

7.7 Configure a Connector to delete an Alfresco folder

7.7.1 Unique inputs

Figure 46. 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 deleted

String



7.8 Configure a Connector to delete an Alfresco item by ID

7.8.1 Unique inputs

Figure 47. 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 deleted

String

7.9 Configure a Connector to download an Alfresco file by ID

7.9.1 Unique inputs

Figure 48. 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 file

Destination folder for the file

String (file path syntax)

Downloaded file name Name of file to be downloaded

String

7.10 Configure a Connector to download an Alfresco file by store and ID

7.10.1 Unique inputs

Figure 49. 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 file

Destination folder for the file

String (file path syntax)

Downloaded file name Name of file to be downloaded

String



7.11 Configure a Connector to List Alfresco File versions


Figure 50. Enter ID of file

List File Versions

Category: Alfresco

Connector description: create folder in specified path

fileID ID of the file for which you are listing versions

string

7.12 Configure a Connector to list checked-out Alfresco files

This Connector has no unique inputs or outputs. See 2.8.1 and 2.8.2, Alfresco Common Inputs and Output.

7.13 List all Alfresco folders by path

This Connector returns a list of Alfresco folders found in a specified path.


Figure 51. 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 you will list contents


7.14 Configure a Connector to update a checked-out Alfresco file


Figure 52. 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 files


Description file description String

Mime type mime type String

checkedOutFileID ID of the file to be updated String



7.15 Configure a Connector to upload an Alfresco file by path


Figure 53. 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 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 folder in which you will create a new file

String



8.0 How to configure Jasper Connectors

8.1 Inputs

Figure 54. Configure Connector to Create a Jasper Report from a database

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



8.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 include in report

string

Parameters: value Value of parameter to include in report

string

Set value as expression Use and expression for the output value

string

Set value as table Use table for the output values

String in the form: list<list<object>>

Output file path Destination of output file string

Output format Choose pdf, html, or xml



9.0 How to Configure Sugar CRM Connectors

Figure 56. Configure Connectors for SugarCRM

9.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

9.2 Common outputs

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.



9.3 Configure a Connector to get SugarCRM entries from indicated

module

9.3.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 search in

String

Query Search function string

Order by How to organize the results returned

string

Fields to retrieve Results to return Array

Set value as expression; set value as a table

Choose for single or multiple values

String or array in the form list<list<object>>

Link name List of link names Array

Link fields Variable definitions for the link fields

Array

9.4 Configure a Connector to get SugarCRM Opportunities from an

Account

9.4.1 Unique inputs

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 search

String

Account name Name of SugarCRM account to search

string



9.5 Configure a Connector to create or modify a SugarCRM entry

9.5.1 Unique inputs

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 to create or modify

string






9.6 Configure a Connector to create a SugarCRM Account

9.6.1 Unique Inputs

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

9.7 Configure a Connector to create a SugarCRM Contact

9.7.1 Unique Inputs

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 [email protected] String

Account ID Account to save contact to string

9.8 Configure a Connector to create a SugarCRM Opportunity

9.8.1 Unique inputs

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 in

String

Expected close date Date Date

Amount Anticipated amount of sale number

Probability Estimated probability of closure

number



10.0 How to configure Talend Connectors

10.1 Configure a Connector to launch a Talend job

Figure 65. Configure a Connector to launch a Talend job



10.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 job to contain a buffer output

boolean






10.1.2 Outputs

Figure 67. Configure output of Talend job


bufferOutput Definition of the schema of the response of the job

Array array (table) of strings

10.2 Configure a Connector to launch a Talend MDM Connector

10.2.1 Inputs

Figure 68. Enter Talend MDM authentication



Talend MDM Connector

Category: Talend

Connector description: Update a Talend MDM entity


Host IP address or name of server. You may use the MDM_host variable if defined

string

Port Host port. You may use the MDM_port variable if defined.

number

Version The version to use. If empty, defaults to the [HEAD] version. You may use the MDM_universe variable if defined.

string

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 may use the MDM_dataModel variable if defined.

string

datacontainer The data-container to update. You may use the MDM_dataCluster variable if it is defined.

string

updatemap: name XPath of the element to 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.

string

updatemap: value The PK value, or the value to set in the element for all the other rows.

string

Add row






11.0 How to Configure eXo Connectors

Figure 70 Configure eXo Connectors

11.1 Common inputs

Figure 71a and b. Inputs for eXo Connectors

eXo




host IP address or name of eXo directory host server

string

port eXo directory port number number

username eXo user name string

password eXo user password string

URI URI of the item to manipulate

String

11.2 Common outputs

Figure 72. Outputs for eXo Connectors


response Can be:

client error

redirection

server error

success

unknown

String





11.3 Configure Connector to create a folder in eXo


Figure 73. 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

11.4 Configure a Connector to download an eXo file


Figure 74. 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 file

String

Output file name Name of the output file String

11.5 Configure a Connector to upload a file to eXo

Figure 75. 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 folder of the uploaded file

String

File the absolute path of the file to upload

String

ContentType mime type of the uploaded file

String



12.0 How to configure xWiki Connectors

There are two xWikis Connectors; both have the same set of inputs and outputs to configure.

Figure 76. Configure an xWiki Connector

12.1 Common inputs



Figure 77a and b. Common inputs for xWiki Connectors

xWiki


host IP address or name of wiki host server

string

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



12.2 Common outputs

Figure 78. Outputs for xWiki Connectors


Property value* Value returned from search string

response Can be:

client error

redirection

server error

success

unknown

String


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.



13.0 How to configure Google Connectors

Figure 79. Configure a Google calendar event

13.1 Common inputs

Figure 80. Common inputs for Google calendar Connectors

Google Calendar


userEmail Gmail user email user name: [email protected]

String

password Gmail password string

CalendarURL URL of Google calendar (eg http://www.google.com/

calendar/feeds/

your_gmail_address/

private/full

string



13.2 Configure a Connector to create a Google calendar event with web

content


Figure 81. 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 event

Date (and time)

endTime Date and time to end event Date and time

icon URL of favicon (eg http://www.google.com/

favicon.ico

String

Icon Title Title of icon String

contentType Text or HTML String

url URL of web content String

Width Width of web content in pixels

number

Height Height of web content in pixels

number

13.3 Configure a Connector to create a Google calendar event


Figure 82. 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 event

Date

endTime Date and time to end event Date

13.4 Configure a Connector to delete a Google calendar event


Figure 83. 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 title)

String



14.0 How to configure web service Connectors

See the BonitaSoft online documentation (http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/web-services) for how to configure connectors:

to call a secure web service

to call a secure web service with XML (available in BOS Teamwork)

14.1 How to configure a Connector to execute a web service

Figure 84. Configure a Connector to Execute a web service

14.1.1 Inputs

= Figure 85. Configure a Web service Connector


http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/web-services

http://docs.bonitasoft.com/bos-56/connectivity/connectors-bonita-open-solution/web-services



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 format

string

14.1.2 Outputs

Figure 86. Configure Execute a Web service Connector outputs


response result of execution source



14.2. How to call a Web service using POJO (available in BOS Teamwork)

Call a Web service using Java objects (POJO).

Figure 87. Create a Connector to call a Web Service based on POJO

14.2.1 Inputs

Figure 88. Configure a Web Services Connector using POJO

Enter the WDSL location and Introspect to load parameters.



Web Services

Category: Web service based on java (POJO)

Connector description: configure execution of a Web service


WSDL URL Location of the web service to execute

URL

Service Name of Web service info

Port HTTP Post SOAP SOAP12 HTTPGet

Select one

Operation Web service operation Select

Parameters Select from parameters associated with Web service selected and associate to a value or expression

Java objects

14.2.2 Outputs

Figure 89. Find the Java object to define the output



Figure 90. Define Web service output



Result result of Web service execution

As defined

14.3 Call a Web service using XML (available in BOS Teamwork)

Call a Web service using XML.

14.3.1 Inputs

Figure 91. Configure a Web Services Connector using xml

Enter the WDSL location and Introspect to load parameters.



Web Services

Category: Web service based on xml

Connector description: configure execution of a Web service


WDSL URL Location of the web service to execute

URL

Service Name of Web service info

Port HTTP Post SOAP SOAP12 HTTPGet

Select one

Operation Web service operation Select

Parameters Parameters in xml tree text

14.3.2 Outputs

Figure 92. Set the Xpath expression to define the output



Figure 93. Define xml Web service output



Result result of Web service execution

As defined

When the configuration is complete, click on Finish.



15.0 How to configure SAP Connectors

See the BonitaSoft online documentation (at http://docs.bonitasoft.com/use-graphical-query-tool-call-sap-function-sp) for how to use the SAP graphical query tool (available in BOS Efficiency).

Figure 94. Configure a Connector to call an SAP function

15.1 Configure a Connector to execute an SAP call function

15.1.1 Inputs for existing configuration


http://docs.bonitasoft.com/use-graphical-query-tool-call-sap-function-sp

http://docs.bonitasoft.com/use-graphical-query-tool-call-sap-function-sp



Figure 95a and b. Configure a Connector to execute an SAP call function

SAP Call Function

Category: SAP

Connector description: Call an SAP function

Input: Existing Configuration

Description Type

Existing configuration name

Name of the SAP configuration

String

Input: New Configuration:


Server type Application or message serve

Choose one option

Client Number of the SAP client for logon

number

User ID User ID for SAP logon string

Password SAP password string

Language Code for language selection

string

Host Name SAP host name or IP address of the server

String

System number SAP system number number



Figure 96. Configure a connector to execute an SAP call function, cont’d


Repository Name of SAP repository String

Function Name Name of SAP function string

Commit on success, Roll back on failure; Release client

Choose one or more actions

Boolean

Figure 97. Configure a connector to execute an SAP call function, cont’d


Type Data variable type String

Table/Structure Name Name of SAP table or structure

string

Parameter name Data variable name string

Parameter value Data variable value string



15.1.2 Outputs

Figure 98. Configure outputs for SAP call function


Type Data variable type String

Table/Structure Name Name of SAP table or structure

string

Xpath Navigation path string

Variable name Name of output variable value

string

HTML file Name of HTML to save output to

string



15.2 Configure a Connector to create an SAP connection

15.2.1 Inputs

Figure 99a and b. Configure a Connector to create an SAP client

Create an SAP client

Category: SAP

Connector description: Create an SAP client


Server type Application or message serve

Choose one option

Client Number of the SAP client for logon

number

User ID User ID for SAP logon string

Password SAP password string

Language Code for language selection

string

Host Name SAP host name or IP address of the server

String

System number SAP system number number



15.2.2 Outputs

Figure 100. Configure outputs for Create an SAP client


createdConnectionName Output variable name String

15.3 Configure a Connector to execute an SAP commit

15.3.1 Inputs

Figure 101. Configure a connector to execute an SAP commit


Existing connection Name Name of SAP connection string


Release client Choose action Boolean



15.4 Configure a Connector to release an SAP connection

15.4.1 Inputs

Figure 102. Configure a connector to release an SAP connection


Existing connection name Name of SAP connection string

15.5 Configure a Connector to execute an SAP rollback

15.5.1 Inputs

Figure 103. Configure a connector to execute an SAP rollback


Existing connection Name Name of SAP connection string


Release client Choose action Boolean



16.0 How to configure SharePoint Connectors

Figure 104 Configure SharePoint Connectors

16.1 Common inputs

Figure 105. Inputs for SharePoint Connectors

SharePoint


username SharePoint user name string

password SharePoint user password string

fileUrl Location of SharePoint file String (url)



16.2 Common outputs

Figure 106. Sharepoint map


succeed response string

Figure 107a and b. outputs for Outputs for SharePoint Connectors




response Can be:

client error

redirection

server error

success

unknown

String



16.3 Configure a Connector to cancel checkout from a SharePoint server No unique inputs or outputs

16.4 Configure a Connector to check in a SharePoint file

16.4.1 Unique inputs Add a comment to the Connector input (optional).

Figure 108. Unique input for Check in file from a SharePoint server

16.5 Configure a Connector to check out a SharePoint file

No unique inputs or outputs

16.6 Configure Connector to get items from a SharePoint List




Figure 109. Configure Connector to Create a new folder in SharePoint

SharePoint – get items from a List

Category: SharePoint

Connector description: Get items from a List on a SharePoint server


SharePoint list name Name of the SharePoint list String

16.6.2 Unique Outputs

Figure 110. Unique output for Get items from a SharePoint list


xmlResponse response string



16.7 Configure Connector to create a new folder in SharePoint


Figure 111a and b. Configure Connector to Create a new folder in SharePoint

SharePoint – Create a Folder


Connector description: create a folder on a SharePoint sever through WebDAV


host IP address or name of SharePoint directory host server

string

port SharePoint server port number

number



Parent URI URI for new folder String

New folder name Name of new folder string

16.8 Configure a Connector to delete a SharePoint item




Figure 112. Configure Connector to Delete an item from SharePoint

SharePoint – Delete Item


Connector description: delete an item from SharePoint server through WebDAV


host IP address or name of SharePoint directory host server

string

port SharePoint server port number

number



URI to delete URI for folder to delete String



16.9 Configure a Connector to download a SharePoint file


Figure 113. Inputs for Download a SharePoint file

SharePoint – DownloadFile


Connector description: Download a file from a SharePoint server through WebDav


File URI URI of the file to download String

Output file folder Destination folder for the file

String

Output file name Name of the output file String



16.10 Configure a Connector to upload a file to SharePoint


Figure 114. Configure Connector to Upload a file to SharePoint

SharePoint - UploadFile


Connector description: upload a file to a SharePoint server through WebDAV


Destination URI the destination URI of the folder of the uploaded file

String

File the absolute path of the file to upload

String

ContentType mime type of the uploaded file

String

URI URI of the folder for version control

String



17.0 How to Configure Exchange Connectors

17.1 Common inputs

Figure 115. Configure Exchange connectors

Exchange

Category: Exchange

Connector description: create new calendar items and contacts with Exchange


Username Account holders name String

Password Account holders password String

Server selection Location of server selection



17.2 Configure a Connector to create a new Exchange calendar item

17.2.1 Unique Inputs

Figure 116. Configure a Connector to create a new calendar item

Exchange – create a new calendar item

Category: Exchange

Connector description: create new Exchange calendar item


Subject Subject of calendar event String

Body Calendar event message string

Start time Beginning of event date

End time End of event date

Location Location of event string

Required attendees emails List of email addresses string



17.2.2 Unique outputs

Figure 117. Configure a Connector to map outputs




response Response text String




17.3 Create a new Exchange contact


Figure 118. Configure Connector for create a new Exchange contact

Exchange – create a new contact

Category: Exchange

Connector description: create new Exchange contacts


GivenName Contact’s first name String

Surname Contact’s family name string

CompanyName Contact’s company string

Job Title Contact’s position string

Phonenumber Contact’s phone number string

Email Contact’s email address string



18.0 How to Configure Sheetster Connectors

18.1 Configure a Connector to get the content of a cell

The Sheetster connector retrieves the content of the specified cell, in a specified sheet, of a specified workbook, of a Sheetster server. 18.1.1 Inputs

Figure 119. Configure a Connector to get the content of a Sheetster cell

Sheetster – get the contents of a cell

Category: Sheetster

Connector description: get the contents of a Sheetster cell


URL Location of Sheetster server

string

Username Name of user to log in string

Password Password of user string

Workbook ID The identifier of the target workbook

number

Sheet name The name of the target sheet

string

Cell The target cell string



18.1.2 Outputs

Figure 120. Outputs of a Sheetster Connector


Cell Content the value of the content of the cell

Any (number, text, Boolean, etc)



19.0 How to Configure CMIS Connectors

CMIS protocol to access a remote content management server (CMS) is built on HTTP. Requests are sent via Web Services or ATOM binding types. Each binding type refers to a unique URL entry point. A CMIS-accessible server may have one or more repositories, so you will specify which repository you want to access. To identify a repository, use the “get repositories” connector. Bonita provides a set of connectors to deal with common create, read, update and delete operations on CMS objects. For more information, see the Apache Chemistry project documentation.

19.1 Common inputs

Figure 121. Configure CMIS connectors

CMIS

Category: CMIS

Connector description: access a remote content management server


Username Account holder’s name String

Password Account holder’s password String

URL Entry point for the repository, corresponding to the binding type

String

Binding type The way the requests are sent

Selection : ATOM or WebService

http://incubator.apache.org/chemistry/



19.2 Verify if an object exists 19.2.1 Unique inputs

Figure 122. Configure CMIS Connector to verify if an object exists

CMIS – Verify if an object exists

Category: CMIS

Connector description: Verify object


Repository name Name of target repository String

Object path Path to the object to be verified

String


Figure 123. Unique output to verify if an object exists


objectExists True if the object exists, false otherwise

Boolean



19.3 Create a folder


Figure 124. Configure CMIS Connector to create a folder

CMIS – Create a folder

Category: CMIS

Connector description: Create a folder



Parent folder path The path to the parent folder

String

Subfolder name The name of the folder to create, as a subfolder of the parent folder

String



19.4 Delete a folder


Figure 125. Configure CMIS Connector to delete a folder

CMIS – Delete a folder

Category: CMIS

Connector description: Delete a folder



Folder path The path to the folder to delete

String



19.5 Delete an object


Figure 126. Configure CMIS Connector to delete an object

CMIS – Delete an object

Category: CMIS

Connector description: Delete an object



Object path The path of the object to delete

String



19.6 Download CMIS document

This connector downloads a document from the Bonita server. 19.6.1 Unique inputs

Figure 127. Configure CMIS Connector to download a document

CMIS – Download a CMIS document

Category: CMIS

Connector description: Download a CMIS document



Document path The path of the document to download

String

Destination filename The path of the document to create on the bonita server file system

String



19.7 Retrieve an object


Figure 128. Configure CMIS Connector to retrieve an object

CMIS – Retrieve an object

Category: CMIS

Connector description: Retrieve an object



Object path The path of the object to retrieve

String


Figure 129. Unique output to retrieve an object


cmisObject The CMIS object CMISObject (see Apache Chemistry documentation)





19.8 Get a list of repositories for a CMIS server


Figure 130. Unique output for get a list of CMIS repositories


repositories The list of repositories on the server

List<Repository>

See Apache Chemistry documentation for more information on Repositories.

19.9 Get the root folder of a repository


Figure 131. Configure CMIS Connector to get the root folder of a repository

CMIS – get the root folder of a repository

Category: CMIS

Connector description: get the root folder of a repository


repositoryName Name of target repository String





Figure 132. Unique output to get the root folder of a repository


rootFolder The root folder of a repository

Folder

See Apache Chemistry documentation for more information on Folders.

19.10 List a folder


Figure 133. Configure CMIS Connector to list a folder

CMIS – list a folder

Category: CMIS

Connector description: list a folder



Folder path The path to the folder to list

String





Figure 134. Unique output for verify if an object exists


folderContent The content of the folder List<CmisObject>

See Apache Chemistry documentation for more information on CmisObjects.

19.11- List versions of a document


Figure 135. Configure CMIS Connector to list versions of a document

CMIS – list versions of document

Category: CMIS

Connector description: list versions of a document



Document path The path to the document String





Figure 136. Unique output for the versions list for a document


Versions List The list of versions List<ObjectData>

See Apache Chemistry documentation for more information on ObjectData.

19.12- Modify a document


Figure 137. Configure CMIS Connector to modify a document

CMIS – modify a document

Category: CMIS

Connector description: modify a CMIS document



Document The attachment document to upload

AttachmentInstance

File path The path to the file to modify

String




19.13- Upload a file


Figure 138. Configure CMIS Connector to upload a file

CMIS – Upload a file

Category: CMIS

Connector description: upload a file



Destination folder The folder where to upload the file

String

File name The name of the file to create

String

File The attachment containing the document

AttachmentInstance

Connectors Reference Guide - Bonita BPM · Bonita Open Solution 5.6 Connectors Reference Guide BOS...

Documents

Transcript of Connectors Reference Guide - Bonita BPM · Bonita Open Solution 5.6 Connectors Reference Guide BOS...