Difference between revisions of "Bonitasoft Workflow connector"

From OpenKM Documentation
Jump to: navigation, search
Line 111: Line 111:
  
 
[[File:downloadDocument-OpenKMConfiguration.jpg]]
 
[[File:downloadDocument-OpenKMConfiguration.jpg]]
−
{| border="0" cellpadding="2" cellspacing="0" 
 
−
|Figure 5. Configure the server information.
 
−
|}
 
  
  
Line 124: Line 121:
  
 
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.
−
 
−
[[File:outPut operations.jpg]]
 
−
 
  
 
{| border="1" cellpadding="2" cellspacing="0"  
 
{| border="1" cellpadding="2" cellspacing="0"  
Line 146: Line 140:
 
|}
 
|}
  
 +
 +
[[File:outPut operations.jpg]]
  
 
== Download document by version==
 
== Download document by version==
Line 181: Line 177:
 
|Output path
 
|Output path
 
|String
 
|String
−
|}
 
−
{| border="0" cellpadding="2" cellspacing="0" 
 
−
|Table 5. Input parameters to download a document by version.
 
 
|}
 
|}
  
Line 199: Line 192:
  
 
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.
−
 
−
[[File:outPut operations.jpg]]
 
−
 
  
 
{| border="1" cellpadding="2" cellspacing="0"  
 
{| border="1" cellpadding="2" cellspacing="0"  
Line 221: Line 211:
 
|}
 
|}
  
 +
 +
[[File:outPut operations.jpg]]
  
 
== Delete a document ==
 
== Delete a document ==
Line 263: Line 255:
  
 
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.
−
 
−
[[File:outPut operations.jpg]]
 
−
 
  
 
{| border="1" cellpadding="2" cellspacing="0"  
 
{| border="1" cellpadding="2" cellspacing="0"  
Line 285: Line 274:
 
|}
 
|}
  
 +
[[File:outPut operations.jpg]]
  
 
== Checkout document ==
 
== Checkout document ==
Line 328: Line 318:
  
 
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.
−
 
−
[[File:outPut operations.jpg]]
 
−
 
  
 
{| border="1" cellpadding="2" cellspacing="0"  
 
{| border="1" cellpadding="2" cellspacing="0"  
Line 350: Line 337:
 
|}
 
|}
  
 +
 +
[[File:outPut operations.jpg]]
  
 
== Cancel checkout document ==
 
== Cancel checkout document ==
Line 393: Line 382:
  
 
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.
−
 
−
[[File:outPut operations.jpg]]
 
−
 
  
 
{| border="1" cellpadding="2" cellspacing="0"  
 
{| border="1" cellpadding="2" cellspacing="0"  
Line 415: Line 401:
 
|}
 
|}
  
 +
 +
[[File:outPut operations.jpg]]
  
 
== Checkin a document ==
 
== Checkin a document ==
Line 466: Line 454:
  
 
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.
−
 
−
[[File:outPut operations.jpg]]
 
−
 
  
 
{| border="1" cellpadding="2" cellspacing="0"  
 
{| border="1" cellpadding="2" cellspacing="0"  
Line 488: Line 473:
 
|}
 
|}
  
 +
 +
[[File:outPut operations.jpg]]
  
 
== Create folder ==
 
== Create folder ==
Line 535: Line 522:
  
 
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.
−
 
−
[[File:outPut operations.jpg]]
 
−
 
  
 
{| border="1" cellpadding="2" cellspacing="0"  
 
{| border="1" cellpadding="2" cellspacing="0"  
Line 557: Line 541:
 
|}
 
|}
  
 +
 +
[[File:outPut operations.jpg]]
  
 
== Delete folder ==
 
== Delete folder ==
Line 599: Line 585:
  
 
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.
−
 
−
[[File:outPut operations.jpg]]
 
−
 
  
 
{| border="1" cellpadding="2" cellspacing="0"  
 
{| border="1" cellpadding="2" cellspacing="0"  
Line 620: Line 603:
 
|String
 
|String
 
|}
 
|}
 +
 +
 +
[[File:outPut operations.jpg]]

Revision as of 09:07, 20 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

Inputs.

Enter the following input parameters to upload a document.

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


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


OutPut operations.jpg

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


OutPut operations.jpg

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


OutPut operations.jpg

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

OutPut operations.jpg

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


OutPut operations.jpg

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


OutPut operations.jpg

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


OutPut operations.jpg

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


OutPut operations.jpg

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


OutPut operations.jpg

Retrieved from "https://www.openkm.com/wiki/index.php?title=Bonitasoft_Workflow_connector&oldid=11945"