Difference between revisions of "Bonitasoft Workflow connector"

From OpenKM Documentation
Jump to: navigation, search
Line 53: Line 53:
 
[[File:uploadDocument-Fileinformation.jpg|center]]
 
[[File:uploadDocument-Fileinformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.
Line 84: Line 84:
 
== Download document ==
 
== Download document ==
  
−
Inputs.
+
'''Inputs.'''
  
 
Enter the following input parameters.
 
Enter the following input parameters.
Line 123: Line 123:
 
[[File:downloadDocument-DocumentInformation.jpg|center]]
 
[[File:downloadDocument-DocumentInformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.
Line 152: Line 152:
 
== Download document by version==
 
== Download document by version==
  
−
Inputs.
+
'''Inputs.'''
  
 
Enter the following input parameters.
 
Enter the following input parameters.
Line 195: Line 195:
 
[[File:downloadDocumentbyVersion-DocumentInformation.jpg|center]]
 
[[File:downloadDocumentbyVersion-DocumentInformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.
Line 224: Line 224:
 
== Delete a document ==
 
== Delete a document ==
  
−
Inputs.
+
'''Inputs.'''
  
 
Enter the following input parameters.
 
Enter the following input parameters.
Line 258: Line 258:
 
[[File:deleteFolder-FolderInformation.jpg|center]]
 
[[File:deleteFolder-FolderInformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.
Line 287: Line 287:
 
== Checkout document ==
 
== Checkout document ==
  
−
Inputs.
+
'''Inputs.'''
  
 
Enter the following input parameters.
 
Enter the following input parameters.
Line 322: Line 322:
 
[[File:checkout-DocumentInformation.jpg|center]]
 
[[File:checkout-DocumentInformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.
Line 350: Line 350:
 
== Cancel checkout document ==
 
== Cancel checkout document ==
  
−
Inputs.
+
'''Inputs.'''
  
 
Enter the following input parameters.
 
Enter the following input parameters.
Line 385: Line 385:
 
[[File:cancel checkout-DocumentInformation.jpg|center]]
 
[[File:cancel checkout-DocumentInformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.
Line 414: Line 414:
 
== Checkin a document ==
 
== Checkin a document ==
  
−
Inputs.
+
'''Inputs.'''
  
 
Enter the following input parameters.
 
Enter the following input parameters.
Line 457: Line 457:
 
[[File:checkin-FileInformation.jpg|center]]
 
[[File:checkin-FileInformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.
Line 486: Line 486:
 
== Create folder ==
 
== Create folder ==
  
−
Inputs.
+
'''Inputs.'''
  
 
Enter the following input parameters.
 
Enter the following input parameters.
Line 525: Line 525:
 
[[File:createFolder-folderInformation.jpg|center]]
 
[[File:createFolder-folderInformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.
Line 554: Line 554:
 
== Delete folder ==
 
== Delete folder ==
  
−
Inputs.
+
'''Inputs.'''
  
 
Enter the following input parameters.
 
Enter the following input parameters.
Line 589: Line 589:
 
[[File:deleteFolder-FolderInformation.jpg|center]]
 
[[File:deleteFolder-FolderInformation.jpg|center]]
  
−
Outputs.
+
'''Outputs.'''
  
 
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.

Revision as of 21:06, 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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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=11930"