Bonitasoft Workflow connector

How to configure OpenKM Connectors

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

Figure 1. Select a connector.

Upload 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	Path in OpenKM	String

Table 1. Input parameters to upload a document.

Configure the server information and click on Next.

Figure 2. Configure the server information.

Configure the document information and click on Next.

Figure 3. Configure OpenKM connector to upload a file.

Outputs.

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

Figure 4. Outputs operation.

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

Table 2. Output parameters.

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

Table 3. Input parameters to download a document.

Configure the server information and click on Next.

Figure 5. Configure the server information.

Configure the document information and click on Next.

Figure 6. Configure OpenKM connector to download a document.

Outputs.

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

Figure 7. Outputs operation.

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

Table 4. Output parameters.

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

Table 5. Input parameters to download a document by version.

Configure the server information and click on Next.

Figure 8. Configure the server information.

Configure the document information and click on Next.

Figure 9. Configure OpenKM connector to download by version a document.

Outputs.

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

Figure 10. Outputs operation.

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

Table 6. Output parameters.

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

Table 7. Input parameters to delete a document.

Configure the server information and click on Next.

Figure 11. Configure the server information.

Configure the document information and click on Next.

Figure 12. Configure OpenKM connector to delete a document.

Outputs.

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

Figure 13. Outputs operation.

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

Table 8. Output parameters.

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

Table 9. Input parameters to checkout a document.

Configure the server information and click on Next.

Figure 14. Configure the server information.

Configure the document information and click on Next.

Figure 15. Configure OpenKM connector to checkout a document.

Outputs.

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

Figure 16. Outputs operation.

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

Table 10. Output parameters.

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

Table 11. Input parameters to cancel checkout of a document.

Configure the server information and click on Next.

Figure 17. Configure the server information.

Configure the document information and click on Next.

Figure 18. Configure OpenKM connector to cancel chekout a document.

Outputs.

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

Figure 19. Outputs operation.

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

Table 12. Output parameters.

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

Table 13. Input parameters to checkin a document.

Configure the server information and click on Next.

Figure 20. Configure the server information.

Configure the document information and click on Next.

Figure 21. Configure OpenKM connector to checkin a document.

Outputs.

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

Figure 22. Outputs operation.

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

Table 14. Output parameters.

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

Table 15. Input parameters to create a folder.

Configure the server information and click on Next.

Figure 23. Configure the server information.

Configure the folder information and click on Next.

Figure 24. Configure OpenKM connector to create a folder.

Outputs.

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

Figure 25. Outputs operation.

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

Table 16. Output parameters.

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

Table 17. Input parameters to delete a folder.

Configure the server information and click on Next.

Figure 26. Configure the server information.

Configure the folder information and click on Next.

Figure 27. Configure OpenKM connector to delete a folder.

Outputs.

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

Figure 28. Outputs operation.

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

Table 18. Output parameters.