Difference between revisions of "Bonitasoft Workflow connector"

From OpenKM Documentation
Jump to: navigation, search
Line 112: Line 112:
 
|Output path
 
|Output path
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 3. Input parameters to download a document.
 
|}
 
|}
  
Line 146: Line 149:
 
|Response error message
 
|Response error message
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 4. Output parameters.
 
|}
 
|}
  
Line 184: Line 190:
 
|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 218: Line 227:
 
|Response error message
 
|Response error message
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 6. Output parameters.
 
|}
 
|}
  
Line 248: Line 260:
 
|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.
 
|}
 
|}
 +
  
 
Configure the server information and click on Next.
 
Configure the server information and click on Next.
Line 281: Line 297:
 
|Response error message
 
|Response error message
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 8. Output parameters.
 
|}
 
|}
  
Line 311: Line 330:
 
|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 345: Line 367:
 
|Response error message
 
|Response error message
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 10. Output parameters.
 
|}
 
|}
  
Line 374: Line 399:
 
|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 408: Line 436:
 
|Response error message
 
|Response error message
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 12. Output parameters.
 
|}
 
|}
  
Line 446: Line 477:
 
|Comment
 
|Comment
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 13. Input parameters to checkin a document.
 
|}
 
|}
  
Line 480: Line 514:
 
|Response error message
 
|Response error message
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 14. Output parameters.
 
|}
 
|}
  
Line 514: Line 551:
 
|Folder name
 
|Folder name
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 15. Input parameters to create a folder.
 
|}
 
|}
  
Line 548: Line 588:
 
|Response error message
 
|Response error message
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 16. Output parameters.
 
|}
 
|}
  
Line 578: Line 621:
 
|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 612: Line 658:
 
|Response error message
 
|Response error message
 
|String
 
|String
 +
|}
 +
{| border="0" cellpadding="2" cellspacing="0" align="center" 
 +
|Table 18. Output parameters.
 
|}
 
|}

Revision as of 21:15, 17 October 2014

How to configure OpenKM Connectors

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


SelectAConnectorDefinition.jpg
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.

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 operations.jpg


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.

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 operations.jpg


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.

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 operations.jpg


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.

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 operations.jpg


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.

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 operations.jpg


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.

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 operations.jpg


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.

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 operations.jpg


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.

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 operations.jpg


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.

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 operations.jpg


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