Difference between revisions of "Bonitasoft Workflow connector"

From OpenKM Documentation
Jump to: navigation, search
Line 9: Line 9:
 
== Upload a document ==
 
== Upload a document ==
  
−
Enter the following input parameters and click on Next.
+
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
Line 36: Line 36:
 
|String
 
|String
 
|}
 
|}
 +
Table 1. Input parameters to upload a document.
  
  
Line 73: Line 74:
  
 
== Download document ==
 
== Download document ==
 +
 +
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
Line 136: Line 139:
  
 
== Download document by version==
 
== Download document by version==
 +
 +
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
Line 203: Line 208:
  
 
== Delete a document ==
 
== Delete a document ==
 +
 +
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
Line 261: Line 268:
  
 
== Checkout document ==
 
== Checkout document ==
 +
 +
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
Line 319: Line 328:
  
 
== Cancel checkout document ==
 
== Cancel checkout document ==
 +
 +
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
Line 378: Line 389:
  
 
== Checkin a document ==
 
== Checkin a document ==
 +
 +
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
Line 445: Line 458:
  
 
== Create folder ==
 
== Create folder ==
 +
 +
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
Line 508: Line 523:
  
 
== Delete folder ==
 
== Delete folder ==
 +
 +
Enter the following input parameters.
  
 
{| border="1" cellpadding="2" cellspacing="0" align="center"
 
{| border="1" cellpadding="2" cellspacing="0" align="center"

Revision as of 19:40, 17 October 2014

How to configure OpenKM Connectors

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


SelectAConnectorDefinition.jpg


Upload a document

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.

UploadDocument-OpenKMConfiguration.jpg

Configure the document information and click on Next.

UploadDocument-Fileinformation.jpg

Relarion output parameters.

OutPut operations.jpg

Outputs

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


Download document

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

Relarion output parameters.

OutPut operations.jpg

Outputs

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


Download document by version

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

Relarion output parameters.

OutPut operations.jpg

Outputs

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


Delete a document

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

Relarion output parameters.

OutPut operations.jpg

Outputs

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


Checkout document

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

Relarion output parameters.

OutPut operations.jpg

Outputs

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


Cancel checkout document

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

Relarion output parameters.

OutPut operations.jpg

Outputs

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


Checkin a document

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

Relarion output parameters.

OutPut operations.jpg

Outputs

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


Create folder

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

Relarion output parameters.

OutPut operations.jpg

Outputs

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


Delete folder

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

Relarion output parameters.

OutPut operations.jpg

Outputs

Output Description Type
okmStatus Response status Bool
okmErrorCause Response error cause String
okmErrorMessage Response error message String
Retrieved from "https://www.openkm.com/wiki/index.php?title=Bonitasoft_Workflow_connector&oldid=11922"