Difference between revisions of "Bonitasoft Workflow connector"

Latest revision as of 08:59, 30 October 2014

Bonita BPM is an open-source business process management and workflow suite created in 2001. Bonita can be applied for various projects requiring complex workflows like Supply Chain Management, e-Government, Human Resources, Contract management, etc. Bonita-OpenKM connectors feature, allow Bonita BPM to use OpenKM to save and retrieve documents.

Available versions

Version	OpenKM Compatibility	Bonita BPM Compatibility
Bonita-OpenKM-Connectors-2.0.zip	6.4.x Professional	6.x
Bonita-OpenKM-Connectors-1.0.zip	6.2.x Professional & 6.3.x community	6.x

Samples

Can test the connector with some samples available at Bonita-OpenKM-Connectors-Samples-1.0.zip.

openkm-diagram-cancelCheckoutDocument-1.0.bos
openkm-diagram-checkinDocument-1.0.bos
openkm-diagram-checkoutDocument-1.0.bos
openkm-diagram-createFolder-1.0.bos
openkm-diagram-deleteDocument-1.0.bos
openkm-diagram-deleteFolder-1.0.bos
openkm-diagram-downloadDocument-1.0.bos
openkm-diagram-downloadDocumentByVersion-1.0.bos
openkm-diagram-uploadDocument-1.0.bos

Source code

Source code available at github bonita-connector-openkm

How to configure OpenKM Connectors

Go to OpenKM in the connectors list. Select a connector. Click on Next.

Upload a document

Inputs.

Enter the following input parameters to upload a document.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
File to upload	Document attachment	String
Destination path	Path in OpenKM	String

Configure the server information and click on next.

Configure the document information and click on next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Download document

Inputs.

Enter the following input parameters.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
Document to download	Document path in OpenKM	String
Destination path	Output path	String

Configure the server information and click on Next.

Configure the document information and click on Next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Download document by version

Inputs.

Enter the following input parameters.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
Document to download	Document path in OpenKM	String
Version of document	Version of document	String
Destination path	Output path	String

Configure the server information and click on Next.

Configure the document information and click on Next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Delete a document

Inputs.

Enter the following input parameters.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
Document to delete	Document path in OpenKM	String

Configure the server information and click on Next.

Configure the document information and click on Next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Checkout document

Inputs.

Enter the following input parameters.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
Document to checkout	Document path in OpenKM	String

Configure the server information and click on Next.

Configure the document information and click on Next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Cancel checkout document

Inputs.

Enter the following input parameters.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
Document to cancel checkout	Document path in OpenKM	String

Configure the server information and click on Next.

Configure the document information and click on Next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Checkin a document

Inputs.

Enter the following input parameters.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
File to upload	Document attachment	String
Destination path	Document path in OpenKM	String
Comment	Comment	String

Configure the server information and click on Next.

Configure the document information and click on Next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Create folder

Inputs.

Enter the following input parameters.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
Destination path	Destination path in OpenKM	String
Folder to create	Folder name	String

Configure the server information and click on Next.

Configure the folder information and click on Next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Delete folder

Inputs.

Enter the following input parameters.

Input	Description	Type
Host	IP address or name of OpenKM directory host server	String
Username	OpenKM user name	String
Password	OpenKM password	String
Folder to delete	Folder path in OpenKM	String

Configure the server information and click on Next.

Configure the folder information and click on Next.

Outputs.

Map the output of this connector to a variable in the process. Click on Finish.

Output	Description	Type
okmStatus	Response status	Bool
okmErrorCause	Response error cause	String
okmErrorMessage	Response error message	String

Difference between revisions of "Bonitasoft Workflow connector"

Latest revision as of 08:59, 30 October 2014

Contents

Available versions

Samples

Source code

How to configure OpenKM Connectors

Upload a document

Download document

Download document by version

Delete a document

Checkout document

Cancel checkout document

Checkin a document

Create folder

Delete folder

Navigation menu

Views

Personal tools

Navigation

Search

Tools

@@ Line 1: / Line 1: @@
-== How to configure OpenKM Connectors ==
+{{TOCright}} __TOC__
+[http://www.bonitasoft.com/ Bonita BPM] is an open-source business process management and workflow suite created in 2001. Bonita can be applied for various projects requiring complex workflows like Supply Chain Management, e-Government, Human Resources, Contract management, etc. Bonita-OpenKM connectors feature, allow [http://www.bonitasoft.com/ Bonita BPM] to use OpenKM to save and retrieve documents.
+=== Available versions ===
+{| border="1" cellpadding="2" cellspacing="0"
+|'''Version'''
+|'''OpenKM Compatibility'''
+|'''Bonita BPM Compatibility'''
+|-
+|[http://download.openkm.com/bonita/Bonita-OpenKM-Connectors-2.0.zip Bonita-OpenKM-Connectors-2.0.zip]
+|6.4.x Professional
+|6.x
+|-
+|[http://download.openkm.com/bonita/Bonita-OpenKM-Connectors-1.0.zip Bonita-OpenKM-Connectors-1.0.zip]
+|6.2.x Professional & 6.3.x community
+|6.x
+|}
+=== Samples ===
+Can test the connector with some samples available at [http://download.openkm.com/bonita/Bonita-OpenKM-Connectors-Samples-1.0.zip Bonita-OpenKM-Connectors-Samples-1.0.zip].
+* openkm-diagram-cancelCheckoutDocument-1.0.bos
+* openkm-diagram-checkinDocument-1.0.bos
+* openkm-diagram-checkoutDocument-1.0.bos
+* openkm-diagram-createFolder-1.0.bos
+* openkm-diagram-deleteDocument-1.0.bos
+* openkm-diagram-deleteFolder-1.0.bos
+* openkm-diagram-downloadDocument-1.0.bos
+* openkm-diagram-downloadDocumentByVersion-1.0.bos
+* openkm-diagram-uploadDocument-1.0.bos
-Go to OpenKm in the connectors list. Select a connector. Click on Next.
+=== Source code ===
+Source code available at [https://github.com/openkm/dms github bonita-connector-openkm]
-[[File:SelectAConnectorDefinition.jpg|center]]
+== How to configure OpenKM Connectors ==
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Figure 1. Select a connector.
+Go to OpenKM in the connectors list. Select a connector. Click on Next.
-|}
+[[File:SelectAConnectorDefinition.jpg]]
 == Upload a document ==
@@ Line 14: / Line 47: @@
 '''Inputs.'''
-Enter the following input parameters.
+Enter the following input parameters to upload a document.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 41: / Line 74: @@
 |String
 |}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 1. Input parameters to upload a document.
-|}
-Configure the server information and click on Next.
+Configure the server information and click on next.
-[[File:uploadDocument-OpenKMConfiguration.jpg|center]]
+[[File:uploadDocument-OpenKMConfiguration.jpg]]
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Figure 2. Configure the server information.
-|}
-Configure the document information and click on Next.
+Configure the document information and click on next.
-[[File:uploadDocument-Fileinformation.jpg|center]]
+[[File:uploadDocument-Fileinformation.jpg]]
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Figure 3. Configure OpenKM connector to upload a document.
-|}
@@ Line 67: / Line 90: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 87: / Line 107: @@
 |String
 |}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 2. Output parameters.
-|}
+[[File:outPut operations.jpg]]
 == Download document ==
@@ Line 98: / Line 117: @@
 Enter the following input parameters.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 122: / Line 141: @@
 |Output path
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 3. Input parameters to download a document.
 |}
@@ Line 130: / Line 146: @@
 Configure the server information and click on Next.
-[[File:downloadDocument-OpenKMConfiguration.jpg|center]]
+[[File:downloadDocument-OpenKMConfiguration.jpg]]
 Configure the document information and click on Next.
-[[File:downloadDocument-DocumentInformation.jpg|center]]
+[[File:downloadDocument-DocumentInformation.jpg]]
 '''Outputs.'''
@@ Line 140: / Line 158: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 159: / Line 174: @@
 |Response error message
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 4. Output parameters.
 |}
+[[File:outPut operations.jpg]]
 == Download document by version==
@@ Line 172: / Line 185: @@
 Enter the following input parameters.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 200: / Line 213: @@
 |Output path
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 5. Input parameters to download a document by version.
 |}
@@ Line 208: / Line 218: @@
 Configure the server information and click on Next.
-[[File:downloadDocumentByVersion-OpenKMConfiguration.jpg|center]]
+[[File:downloadDocumentByVersion-OpenKMConfiguration.jpg]]
 Configure the document information and click on Next.
-[[File:downloadDocumentbyVersion-DocumentInformation.jpg|center]]
+[[File:downloadDocumentbyVersion-DocumentInformation.jpg]]
 '''Outputs.'''
@@ Line 218: / Line 229: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 237: / Line 245: @@
 |Response error message
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 6. Output parameters.
 |}
+[[File:outPut operations.jpg]]
 == Delete a document ==
@@ Line 250: / Line 256: @@
 Enter the following input parameters.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 270: / Line 276: @@
 |Document path in OpenKM
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 7. Input parameters to delete a document.
 |}
@@ Line 278: / Line 281: @@
 Configure the server information and click on Next.
-[[File:deleteDocument-OpenKMConfiguration.jpg|center]]
+[[File:deleteDocument-OpenKMConfiguration.jpg]]
 Configure the document information and click on Next.
-[[File:deleteFolder-FolderInformation.jpg|center]]
+[[File:deleteFolder-FolderInformation.jpg]]
 '''Outputs.'''
@@ Line 288: / Line 292: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 307: / Line 308: @@
 |Response error message
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 8. Output parameters.
 |}
+[[File:outPut operations.jpg]]
 == Checkout document ==
@@ Line 320: / Line 319: @@
 Enter the following input parameters.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 340: / Line 339: @@
 |Document path in OpenKM
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 9. Input parameters to checkout a document.
 |}
@@ Line 348: / Line 344: @@
 Configure the server information and click on Next.
-[[File:checkout-OpenKMConfiguration.jpg|center]]
+[[File:checkout-OpenKMConfiguration.jpg]]
 Configure the document information and click on Next.
-[[File:checkout-DocumentInformation.jpg|center]]
+[[File:checkout-DocumentInformation.jpg]]
 '''Outputs.'''
@@ Line 358: / Line 356: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 378: / Line 373: @@
 |String
 |}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 10. Output parameters.
-|}
+[[File:outPut operations.jpg]]
 == Cancel checkout document ==
@@ Line 389: / Line 383: @@
 Enter the following input parameters.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 409: / Line 403: @@
 |Document path in OpenKM
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 11. Input parameters to cancel checkout of a document.
 |}
@@ Line 417: / Line 408: @@
 Configure the server information and click on Next.
-[[File:cancel check out-OpenKm Configuration.jpg|center]]
+[[File:cancel check out-OpenKm Configuration.jpg]]
 Configure the document information and click on Next.
-[[File:cancel checkout-DocumentInformation.jpg|center]]
+[[File:cancel checkout-DocumentInformation.jpg]]
 '''Outputs.'''
@@ Line 427: / Line 420: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 446: / Line 436: @@
 |Response error message
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 12. Output parameters.
 |}
+[[File:outPut operations.jpg]]
 == Checkin a document ==
@@ Line 459: / Line 447: @@
 Enter the following input parameters.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 487: / Line 475: @@
 |Comment
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 13. Input parameters to checkin a document.
 |}
@@ Line 495: / Line 480: @@
 Configure the server information and click on Next.
-[[File:checkin-OpenKMConfig.jpg|center]]
+[[File:checkin-OpenKMConfig.jpg]]
 Configure the document information and click on Next.
-[[File:checkin-FileInformation.jpg|center]]
+[[File:checkin-FileInformation.jpg]]
 '''Outputs.'''
@@ Line 505: / Line 492: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 524: / Line 508: @@
 |Response error message
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 14. Output parameters.
 |}
+[[File:outPut operations.jpg]]
 == Create folder ==
@@ Line 537: / Line 519: @@
 Enter the following input parameters.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 561: / Line 543: @@
 |Folder name
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 15. Input parameters to create a folder.
 |}
@@ Line 569: / Line 548: @@
 Configure the server information and click on Next.
-[[File:createFolder-OpenKMConfiguration.jpg|center]]
+[[File:createFolder-OpenKMConfiguration.jpg]]
 Configure the folder information and click on Next.
-[[File:createFolder-folderInformation.jpg|center]]
+[[File:createFolder-folderInformation.jpg]]
 '''Outputs.'''
@@ Line 579: / Line 560: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 598: / Line 576: @@
 |Response error message
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 16. Output parameters.
 |}
+[[File:outPut operations.jpg]]
 == Delete folder ==
@@ Line 611: / Line 587: @@
 Enter the following input parameters.
-{| border="1" cellpadding="2" cellspacing="0" align="center"
+{| border="1" cellpadding="2" cellspacing="0"
 |'''Input'''
 |'''Description'''
@@ Line 631: / Line 607: @@
 |Folder path in OpenKM
 |String
-|}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 17. Input parameters to delete a folder.
 |}
@@ Line 639: / Line 612: @@
 Configure the server information and click on Next.
-[[File:deleteFoldert-OpenKMConfiguration.jpg|center]]
+[[File:deleteFoldert-OpenKMConfiguration.jpg]]
 Configure the folder information and click on Next.
-[[File:deleteFolder-FolderInformation.jpg|center]]
+[[File:deleteFolder-FolderInformation.jpg]]
 '''Outputs.'''
@@ Line 649: / Line 623: @@
 Map the output of this connector to a variable in the process. Click on Finish.
-[[File:outPut operations.jpg|center]]
+{| border="1" cellpadding="2" cellspacing="0"
-{| border="1" cellpadding="2" cellspacing="0" align="center"
 |'''Output'''
 |'''Description'''
@@ Line 669: / Line 640: @@
 |String
 |}
-{| border="0" cellpadding="2" cellspacing="0" align="center"
-|Table 18. Output parameters.
-|}
+[[File:outPut operations.jpg]]