Difference between revisions of "Bonitasoft Workflow connector"

From OpenKM Documentation
Jump to: navigation, search
Line 348: Line 348:
  
 
[[File:cancel checkout-DocumentInformation.jpg|center]]
 
[[File:cancel checkout-DocumentInformation.jpg|center]]
 +
 +
Relarion output parameters.
 +
 +
[[File:outPut operations.jpg|center]]
 +
 +
Outputs
 +
 +
{| border="1" cellpadding="2" cellspacing="0"
 +
|'''Output'''
 +
|'''Description'''
 +
|'''Type'''
 +
|-
 +
|okmStatus
 +
|Response status
 +
|Bool
 +
|-
 +
|okmErrorCause
 +
|Response error cause
 +
|String
 +
|-
 +
|okmErrorMessage
 +
|Response error message
 +
|String
 +
|}
 +
 +
 +
 +
== Checkin a document ==
 +
 +
{| border="1" cellpadding="2" cellspacing="0"
 +
|'''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.
 +
 +
[[File:checkin-OpenKMConfig.jpg|center]]
 +
 +
Configure the document information and click on Next.
 +
 +
[[File:checkin-FileInformation.jpg|center]]
 +
 +
Relarion output parameters.
 +
 +
[[File:outPut operations.jpg|center]]
 +
 +
Outputs
 +
 +
{| border="1" cellpadding="2" cellspacing="0"
 +
|'''Output'''
 +
|'''Description'''
 +
|'''Type'''
 +
|-
 +
|okmStatus
 +
|Response status
 +
|Bool
 +
|-
 +
|okmErrorCause
 +
|Response error cause
 +
|String
 +
|-
 +
|okmErrorMessage
 +
|Response error message
 +
|String
 +
|}
 +
 +
 +
 +
== Create folder ==
 +
 +
{| border="1" cellpadding="2" cellspacing="0"
 +
|'''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.
 +
 +
[[File:createFolder-OpenKMConfiguration.jpg|center]]
 +
 +
Configure the folder information and click on Next.
 +
 +
[[File:createFolder-folderInformation.jpg|center]]
 +
 +
Relarion output parameters.
 +
 +
[[File:outPut operations.jpg|center]]
 +
 +
Outputs
 +
 +
{| border="1" cellpadding="2" cellspacing="0"
 +
|'''Output'''
 +
|'''Description'''
 +
|'''Type'''
 +
|-
 +
|okmStatus
 +
|Response status
 +
|Bool
 +
|-
 +
|okmErrorCause
 +
|Response error cause
 +
|String
 +
|-
 +
|okmErrorMessage
 +
|Response error message
 +
|String
 +
|}
 +
 +
 +
 +
== Delete folder ==
 +
 +
{| border="1" cellpadding="2" cellspacing="0"
 +
|'''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.
 +
 +
[[File:deleteFoldert-OpenKMConfiguration.jpg|center]]
 +
 +
Configure the folder information and click on Next.
 +
 +
[[File:deleteFolder-FolderInformation.jpg|center]]
  
 
Relarion output parameters.
 
Relarion output parameters.

Revision as of 18:47, 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

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

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

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

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

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

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

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

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

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

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