Bonita Workflow connector 2.0

Compatibility

Bonita Workflow connector 2.0 should be used from OpenKM version 6.4.x Professional.

Download

Download Bonita-OpenKM-Connectors-2.0.zip

Samples

The connector can be tested 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

The source code is available at github bonita-connector-openkm.

How to configure OpenKM Connectors

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

Connectors definition

Upload a document

Inputs.

Enter the following input parameters to upload a document.

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

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	Type	Description
okmStatus	Bool	Response status.
okmErrorCause	String	Response error cause.
okmErrorMessage	String	Response error message.

Download document

Inputs

Enter the following input parameters to upload a document.

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

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	Type	Description
okmStatus	Bool	Response status.
okmErrorCause	String	Response error cause.
okmErrorMessage	String	Response error message.

Download document by version

Inputs

Enter the following input parameters to upload a document.

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

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	Type	Description
okmStatus	Bool	Response status.
okmErrorCause	String	Response error cause.
okmErrorMessage	String	Response error message.

Delete a document

Inputs

Enter the following input parameters.

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

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	Type	Description
okmStatus	Bool	Response status.
okmErrorCause	String	Response error cause.
okmErrorMessage	String	Response error message.

Checkout document

Inputs

Enter the following input parameters.

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

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	Type	Description
okmStatus	Bool	Response status.
okmErrorCause	String	Response error cause.
okmErrorMessage	String	Response error message.

Cancel checkout document

Inputs

Enter the following input parameters.

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

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	Type	Description
okmStatus	Bool	Response status.
okmErrorCause	String	Response error cause.
okmErrorMessage	String	Response error message.

Checkin a document

Inputs

Enter the following input parameters.

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

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	Type	Description
okmStatus	Bool	Response status.
okmErrorCause	String	Response error cause.
okmErrorMessage	String	Response error message.

Create folder

Inputs

Enter the following input parameters.

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

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	Type	Description
okmStatus	Bool	Response status.
okmErrorCause	String	Response error cause.
okmErrorMessage	String	Response error message.

Delete folder

Inputs

Enter the following input parameters.

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