Difference between revisions of "Bonitasoft Workflow connector"

From OpenKM Documentation
Jump to: navigation, search
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{TOCright}} __TOC__
 
{{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
 +
 +
 +
=== Source code ===
 +
Source code available at [https://github.com/openkm/dms github bonita-connector-openkm]
 +
  
 
== How to configure OpenKM Connectors ==
 
== How to configure OpenKM Connectors ==
Line 5: Line 41:
 
Go to OpenKM in the connectors list. Select a connector. Click on Next.
 
Go to OpenKM in the connectors list. Select a connector. Click on Next.
  
[[File:SelectAConnectorDefinition.jpg|center]]
+
[[File:SelectAConnectorDefinition.jpg]]
  
 
== Upload a document ==
 
== Upload a document ==
Line 13: Line 49:
 
Enter the following input parameters to upload a document.
 
Enter the following input parameters to upload a document.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 42: Line 78:
 
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]]
  
  
 
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]]
  
  
Line 54: Line 90:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 75: Line 108:
 
|}
 
|}
  
 +
 +
[[File:outPut operations.jpg]]
  
 
== Download document ==
 
== Download document ==
Line 82: Line 117:
 
Enter the following input parameters.
 
Enter the following input parameters.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"  
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 106: Line 141:
 
|Output path
 
|Output path
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 3. Input parameters to download a document.
 
 
|}
 
|}
  
Line 114: Line 146:
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
  
[[File:downloadDocument-OpenKMConfiguration.jpg|center]]
+
[[File:downloadDocument-OpenKMConfiguration.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 5. Configure the server information.
 
|}
 
  
  
 
Configure the document information and click on Next.
 
Configure the document information and click on Next.
  
[[File:downloadDocument-DocumentInformation.jpg|center]]
+
[[File:downloadDocument-DocumentInformation.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
+
 
|Figure 6. Configure OpenKM connector to download a document.
 
|}
 
  
 
'''Outputs.'''
 
'''Outputs.'''
Line 131: Line 158:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 7. Outputs operation.
 
|}
 
 
 
 
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
 
|'''Output'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 153: Line 174:
 
|Response error message
 
|Response error message
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 4. Output parameters.
 
 
|}
 
|}
  
  
 +
[[File:outPut operations.jpg]]
  
 
== Download document by version==
 
== Download document by version==
Line 166: Line 185:
 
Enter the following input parameters.
 
Enter the following input parameters.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"  
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 194: Line 213:
 
|Output path
 
|Output path
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 5. Input parameters to download a document by version.
 
 
|}
 
|}
  
Line 202: Line 218:
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
  
[[File:downloadDocumentByVersion-OpenKMConfiguration.jpg|center]]
+
[[File:downloadDocumentByVersion-OpenKMConfiguration.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 8. Configure the server information.
 
|}
 
  
  
 
Configure the document information and click on Next.
 
Configure the document information and click on Next.
  
[[File:downloadDocumentbyVersion-DocumentInformation.jpg|center]]
+
[[File:downloadDocumentbyVersion-DocumentInformation.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 9. Configure OpenKM connector to download by version a document.
 
|}
 
  
 
'''Outputs.'''
 
'''Outputs.'''
Line 219: Line 229:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 10. Outputs operation.
 
|}
 
 
 
 
 
 
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
 
|'''Output'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 242: Line 245:
 
|Response error message
 
|Response error message
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 6. Output parameters.
 
 
|}
 
|}
  
  
 +
[[File:outPut operations.jpg]]
  
 
== Delete a document ==
 
== Delete a document ==
Line 255: Line 256:
 
Enter the following input parameters.
 
Enter the following input parameters.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"  
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 275: Line 276:
 
|Document path in OpenKM
 
|Document path in OpenKM
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 7. Input parameters to delete a document.
 
 
|}
 
|}
  
Line 283: Line 281:
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
  
[[File:deleteDocument-OpenKMConfiguration.jpg|center]]
+
[[File:deleteDocument-OpenKMConfiguration.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 11. Configure the server information.
 
|}
 
  
 
Configure the document information and click on Next.
 
Configure the document information and click on Next.
  
[[File:deleteFolder-FolderInformation.jpg|center]]
+
[[File:deleteFolder-FolderInformation.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 12. Configure OpenKM connector to delete a document.
 
|}
 
  
  
Line 300: Line 292:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 13. Outputs operation.
 
|}
 
 
 
 
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
 
|'''Output'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 322: Line 308:
 
|Response error message
 
|Response error message
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 8. Output parameters.
 
 
|}
 
|}
  
  
 +
[[File:outPut operations.jpg]]
  
 
== Checkout document ==
 
== Checkout document ==
Line 335: Line 319:
 
Enter the following input parameters.
 
Enter the following input parameters.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"  
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 355: Line 339:
 
|Document path in OpenKM
 
|Document path in OpenKM
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 9. Input parameters to checkout a document.
 
 
|}
 
|}
  
Line 363: Line 344:
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
  
[[File:checkout-OpenKMConfiguration.jpg|center]]
+
[[File:checkout-OpenKMConfiguration.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 14. Configure the server information.
 
|}
 
  
  
 
Configure the document information and click on Next.
 
Configure the document information and click on Next.
  
[[File:checkout-DocumentInformation.jpg|center]]
+
[[File:checkout-DocumentInformation.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
+
 
|Figure 15. Configure OpenKM connector to checkout a document.
 
|}
 
  
 
'''Outputs.'''
 
'''Outputs.'''
Line 380: Line 356:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 16. Outputs operation.
 
|}
 
 
 
 
 
 
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
 
|'''Output'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 404: Line 373:
 
|String
 
|String
 
|}
 
|}
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 10. Output parameters.
 
|}
 
  
 +
 +
[[File:outPut operations.jpg]]
  
 
== Cancel checkout document ==
 
== Cancel checkout document ==
Line 415: Line 383:
 
Enter the following input parameters.
 
Enter the following input parameters.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"  
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 435: Line 403:
 
|Document path in OpenKM
 
|Document path in OpenKM
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 11. Input parameters to cancel checkout of a document.
 
 
|}
 
|}
  
Line 443: Line 408:
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
  
[[File:cancel check out-OpenKm Configuration.jpg|center]]
+
[[File:cancel check out-OpenKm Configuration.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 17. Configure the server information.
 
|}
 
  
  
 
Configure the document information and click on Next.
 
Configure the document information and click on Next.
  
[[File:cancel checkout-DocumentInformation.jpg|center]]
+
[[File:cancel checkout-DocumentInformation.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 18. Configure OpenKM connector to cancel chekout a document.
 
|}
 
  
  
Line 461: Line 420:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 19. Outputs operation.
 
|}
 
 
 
 
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
 
|'''Output'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 483: Line 436:
 
|Response error message
 
|Response error message
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 12. Output parameters.
 
 
|}
 
|}
  
  
 +
[[File:outPut operations.jpg]]
  
 
== Checkin a document ==
 
== Checkin a document ==
Line 496: Line 447:
 
Enter the following input parameters.
 
Enter the following input parameters.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"  
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 524: Line 475:
 
|Comment
 
|Comment
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 13. Input parameters to checkin a document.
 
 
|}
 
|}
  
Line 532: Line 480:
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
  
[[File:checkin-OpenKMConfig.jpg|center]]
+
[[File:checkin-OpenKMConfig.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 20. Configure the server information.
 
|}
 
  
  
 
Configure the document information and click on Next.
 
Configure the document information and click on Next.
  
[[File:checkin-FileInformation.jpg|center]]
+
[[File:checkin-FileInformation.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 21. Configure OpenKM connector to checkin a document.
 
|}
 
  
  
Line 550: Line 492:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 22. Outputs operation.
 
|}
 
 
 
 
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
 
|'''Output'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 572: Line 508:
 
|Response error message
 
|Response error message
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 14. Output parameters.
 
 
|}
 
|}
  
  
 +
[[File:outPut operations.jpg]]
  
 
== Create folder ==
 
== Create folder ==
Line 585: Line 519:
 
Enter the following input parameters.
 
Enter the following input parameters.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"  
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 609: Line 543:
 
|Folder name
 
|Folder name
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 15. Input parameters to create a folder.
 
 
|}
 
|}
  
Line 617: Line 548:
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
  
[[File:createFolder-OpenKMConfiguration.jpg|center]]
+
[[File:createFolder-OpenKMConfiguration.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 23. Configure the server information.
 
|}
 
 
 
  
  
 
Configure the folder information and click on Next.
 
Configure the folder information and click on Next.
  
[[File:createFolder-folderInformation.jpg|center]]
+
[[File:createFolder-folderInformation.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 24. Configure OpenKM connector to create a folder.
 
|}
 
  
  
Line 636: Line 560:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 25. Outputs operation.
 
|}
 
 
 
 
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
 
|'''Output'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 658: Line 576:
 
|Response error message
 
|Response error message
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 16. Output parameters.
 
 
|}
 
|}
  
  
 +
[[File:outPut operations.jpg]]
  
 
== Delete folder ==
 
== Delete folder ==
Line 671: Line 587:
 
Enter the following input parameters.
 
Enter the following input parameters.
  
{| border="1" cellpadding="2" cellspacing="0" align="center"
+
{| border="1" cellpadding="2" cellspacing="0"  
 
|'''Input'''
 
|'''Input'''
 
|'''Description'''
 
|'''Description'''
Line 691: Line 607:
 
|Folder path in OpenKM
 
|Folder path in OpenKM
 
|String
 
|String
|}
 
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Table 17. Input parameters to delete a folder.
 
 
|}
 
|}
  
Line 699: Line 612:
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
  
[[File:deleteFoldert-OpenKMConfiguration.jpg|center]]
+
[[File:deleteFoldert-OpenKMConfiguration.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 26. Configure the server information.
 
|}
 
  
  
 
Configure the folder information and click on Next.
 
Configure the folder information and click on Next.
  
[[File:deleteFolder-FolderInformation.jpg|center]]
+
[[File:deleteFolder-FolderInformation.jpg]]
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 27. Configure OpenKM connector to delete a folder.
 
|}
 
 
 
 
 
  
 
'''Outputs.'''
 
'''Outputs.'''
Line 718: Line 623:
 
Map the output of this connector to a variable in the process. Click on Finish.
 
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="0" cellpadding="2" cellspacing="0" align="center" 
 
|Figure 28. Outputs operation.
 
|}
 
 
 
 
 
 
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
 
|'''Output'''
 
|'''Output'''
 
|'''Description'''
 
|'''Description'''
Line 742: Line 640:
 
|String
 
|String
 
|}
 
|}
{| border="0" cellpadding="2" cellspacing="0" align="center" 
+
 
|Table 18. Output parameters.
+
 
|}
+
[[File:outPut operations.jpg]]

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.

SelectAConnectorDefinition.jpg

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.

UploadDocument-OpenKMConfiguration.jpg


Configure the document information and click on next.

UploadDocument-Fileinformation.jpg


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


OutPut operations.jpg

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.

DownloadDocument-OpenKMConfiguration.jpg


Configure the document information and click on Next.

DownloadDocument-DocumentInformation.jpg


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


OutPut operations.jpg

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.

DownloadDocumentByVersion-OpenKMConfiguration.jpg


Configure the document information and click on Next.

DownloadDocumentbyVersion-DocumentInformation.jpg

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


OutPut operations.jpg

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.

DeleteDocument-OpenKMConfiguration.jpg

Configure the document information and click on Next.

DeleteFolder-FolderInformation.jpg


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


OutPut operations.jpg

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.

Checkout-OpenKMConfiguration.jpg


Configure the document information and click on Next.

Checkout-DocumentInformation.jpg


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


OutPut operations.jpg

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.

Cancel check out-OpenKm Configuration.jpg


Configure the document information and click on Next.

Cancel checkout-DocumentInformation.jpg


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


OutPut operations.jpg

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.

Checkin-OpenKMConfig.jpg


Configure the document information and click on Next.

Checkin-FileInformation.jpg


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


OutPut operations.jpg

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.

CreateFolder-OpenKMConfiguration.jpg


Configure the folder information and click on Next.

CreateFolder-folderInformation.jpg


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


OutPut operations.jpg

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.

DeleteFoldert-OpenKMConfiguration.jpg


Configure the folder information and click on Next.

DeleteFolder-FolderInformation.jpg

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


OutPut operations.jpg