Difference between revisions of "Bonitasoft Workflow connector"

Revision as of 09:01, 20 October 2014 (view source) Jllort (talk | contribs) ← Older edit		Revision as of 09:04, 20 October 2014 (view source) Jllort (talk | contribs) Newer edit →
Line 6:		Line 6:
	[[File:SelectAConnectorDefinition.jpg]]		[[File:SelectAConnectorDefinition.jpg]]
−
	== Upload a document ==		== Upload a document ==
Line 82:		Line 81:
	Enter the following input parameters.		Enter the following input parameters.
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Input'''		|'''Input'''
	|'''Description'''		|'''Description'''
Line 106:		Line 105:
	|Output path		|Output path
	|String		|String
−	|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 3. Input parameters to download a document.
	|}		|}
Line 115:		Line 111:
	[[File:downloadDocument-OpenKMConfiguration.jpg]]		[[File:downloadDocument-OpenKMConfiguration.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"	+	{| border="0" cellpadding="2" cellspacing="0"
	|Figure 5. Configure the server information.		|Figure 5. Configure the server information.
	|}		|}
Line 123:		Line 119:
	[[File:downloadDocument-DocumentInformation.jpg]]		[[File:downloadDocument-DocumentInformation.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"	+
−	|Figure 6. Configure OpenKM connector to download a document.
−	|}
	'''Outputs.'''		'''Outputs.'''
Line 132:		Line 126:
	[[File:outPut operations.jpg]]		[[File:outPut operations.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 7. Outputs operation.
−	|}
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Output'''		|'''Output'''
	|'''Description'''		|'''Description'''
Line 154:		Line 145:
	|String		|String
	|}		|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 4. Output parameters.
−	|}
−
Line 166:		Line 153:
	Enter the following input parameters.		Enter the following input parameters.
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Input'''		|'''Input'''
	|'''Description'''		|'''Description'''
Line 195:		Line 182:
	|String		|String
	|}		|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"	+	{| border="0" cellpadding="2" cellspacing="0"
	|Table 5. Input parameters to download a document by version.		|Table 5. Input parameters to download a document by version.
	|}		|}
Line 203:		Line 190:
	[[File:downloadDocumentByVersion-OpenKMConfiguration.jpg]]		[[File:downloadDocumentByVersion-OpenKMConfiguration.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 8. Configure the server information.
−	|}
Line 211:		Line 195:
	[[File:downloadDocumentbyVersion-DocumentInformation.jpg]]		[[File:downloadDocumentbyVersion-DocumentInformation.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 9. Configure OpenKM connector to download by version a document.
−	|}
	'''Outputs.'''		'''Outputs.'''
Line 220:		Line 201:
	[[File:outPut operations.jpg]]		[[File:outPut operations.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 10. Outputs operation.
−	|}
−		+	{| border="1" cellpadding="2" cellspacing="0"
−	{| border="1" cellpadding="2" cellspacing="0" align="center"
	|'''Output'''		|'''Output'''
	|'''Description'''		|'''Description'''
Line 243:		Line 220:
	|String		|String
	|}		|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 6. Output parameters.
−	|}
−
Line 255:		Line 228:
	Enter the following input parameters.		Enter the following input parameters.
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Input'''		|'''Input'''
	|'''Description'''		|'''Description'''
Line 275:		Line 248:
	|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.
	|}		|}
Line 284:		Line 254:
	[[File:deleteDocument-OpenKMConfiguration.jpg]]		[[File:deleteDocument-OpenKMConfiguration.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 11. Configure the server information.
−	|}
	Configure the document information and click on Next.		Configure the document information and click on Next.
	[[File:deleteFolder-FolderInformation.jpg]]		[[File:deleteFolder-FolderInformation.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 12. Configure OpenKM connector to delete a document.
−	|}
Line 301:		Line 265:
	[[File:outPut operations.jpg]]		[[File:outPut operations.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 13. Outputs operation.
−	|}
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Output'''		|'''Output'''
	|'''Description'''		|'''Description'''
Line 323:		Line 284:
	|String		|String
	|}		|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 8. Output parameters.
−	|}
−
Line 335:		Line 292:
	Enter the following input parameters.		Enter the following input parameters.
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Input'''		|'''Input'''
	|'''Description'''		|'''Description'''
Line 355:		Line 312:
	|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 364:		Line 318:
	[[File:checkout-OpenKMConfiguration.jpg]]		[[File:checkout-OpenKMConfiguration.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 14. Configure the server information.
−	|}
Line 372:		Line 323:
	[[File:checkout-DocumentInformation.jpg]]		[[File:checkout-DocumentInformation.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"	+
−	|Figure 15. Configure OpenKM connector to checkout a document.
−	|}
	'''Outputs.'''		'''Outputs.'''
Line 381:		Line 330:
	[[File:outPut operations.jpg]]		[[File:outPut operations.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 16. Outputs operation.
−	|}
−		+	{| border="1" cellpadding="2" cellspacing="0"
−	{| border="1" cellpadding="2" cellspacing="0" align="center"
	|'''Output'''		|'''Output'''
	|'''Description'''		|'''Description'''
Line 403:		Line 348:
	|Response error message		|Response error message
	|String		|String
−	|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 10. Output parameters.
	|}		|}
Line 415:		Line 357:
	Enter the following input parameters.		Enter the following input parameters.
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Input'''		|'''Input'''
	|'''Description'''		|'''Description'''
Line 435:		Line 377:
	|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 444:		Line 383:
	[[File:cancel check out-OpenKm Configuration.jpg]]		[[File:cancel check out-OpenKm Configuration.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 17. Configure the server information.
−	|}
Line 452:		Line 388:
	[[File:cancel checkout-DocumentInformation.jpg]]		[[File:cancel checkout-DocumentInformation.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 18. Configure OpenKM connector to cancel chekout a document.
−	|}
Line 462:		Line 395:
	[[File:outPut operations.jpg]]		[[File:outPut operations.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 19. Outputs operation.
−	|}
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Output'''		|'''Output'''
	|'''Description'''		|'''Description'''
Line 484:		Line 414:
	|String		|String
	|}		|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 12. Output parameters.
−	|}
−
Line 496:		Line 422:
	Enter the following input parameters.		Enter the following input parameters.
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Input'''		|'''Input'''
	|'''Description'''		|'''Description'''
Line 524:		Line 450:
	|Comment		|Comment
	|String		|String
−	|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 13. Input parameters to checkin a document.
	|}		|}
Line 533:		Line 456:
	[[File:checkin-OpenKMConfig.jpg]]		[[File:checkin-OpenKMConfig.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 20. Configure the server information.
−	|}
Line 541:		Line 461:
	[[File:checkin-FileInformation.jpg]]		[[File:checkin-FileInformation.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 21. Configure OpenKM connector to checkin a document.
−	|}
Line 551:		Line 468:
	[[File:outPut operations.jpg]]		[[File:outPut operations.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 22. Outputs operation.
−	|}
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Output'''		|'''Output'''
	|'''Description'''		|'''Description'''
Line 573:		Line 487:
	|String		|String
	|}		|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 14. Output parameters.
−	|}
−
Line 585:		Line 495:
	Enter the following input parameters.		Enter the following input parameters.
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Input'''		|'''Input'''
	|'''Description'''		|'''Description'''
Line 609:		Line 519:
	|Folder name		|Folder name
	|String		|String
−	|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 15. Input parameters to create a folder.
	|}		|}
Line 618:		Line 525:
	[[File:createFolder-OpenKMConfiguration.jpg]]		[[File:createFolder-OpenKMConfiguration.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 23. Configure the server information.
−	|}
−
Line 627:		Line 530:
	[[File:createFolder-folderInformation.jpg]]		[[File:createFolder-folderInformation.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 24. Configure OpenKM connector to create a folder.
−	|}
Line 637:		Line 537:
	[[File:outPut operations.jpg]]		[[File:outPut operations.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 25. Outputs operation.
−	|}
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Output'''		|'''Output'''
	|'''Description'''		|'''Description'''
Line 659:		Line 556:
	|String		|String
	|}		|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 16. Output parameters.
−	|}
−
Line 671:		Line 564:
	Enter the following input parameters.		Enter the following input parameters.
−	{| border="1" cellpadding="2" cellspacing="0" align="center"	+	{| border="1" cellpadding="2" cellspacing="0"
	|'''Input'''		|'''Input'''
	|'''Description'''		|'''Description'''
Line 691:		Line 584:
	|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 700:		Line 590:
	[[File:deleteFoldert-OpenKMConfiguration.jpg]]		[[File:deleteFoldert-OpenKMConfiguration.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 26. Configure the server information.
−	|}
Line 708:		Line 595:
	[[File:deleteFolder-FolderInformation.jpg]]		[[File:deleteFolder-FolderInformation.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 27. Configure OpenKM connector to delete a folder.
−	|}
−
−
	'''Outputs.'''		'''Outputs.'''
Line 719:		Line 601:
	[[File:outPut operations.jpg]]		[[File:outPut operations.jpg]]
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Figure 28. Outputs operation.
−	|}
−		+	{| border="1" cellpadding="2" cellspacing="0"
−	{| border="1" cellpadding="2" cellspacing="0" align="center"
	|'''Output'''		|'''Output'''
	|'''Description'''		|'''Description'''
Line 741:		Line 619:
	|Response error message		|Response error message
	|String		|String
−	|}
−	{| border="0" cellpadding="2" cellspacing="0" align="center"
−	|Table 18. Output parameters.
	|}		|}

---

Revision as of 09:04, 20 October 2014

Contents 1 How to configure OpenKM Connectors 2 Upload a document 3 Download document 4 Download document by version 5 Delete a document 6 Checkout document 7 Cancel checkout document 8 Checkin a document 9 Create folder 10 Delete folder

How to configure OpenKM Connectors

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

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.

Configure the document information and click on next.

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

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.

Figure 5. Configure the server information.

Configure the document information and click on Next.

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

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.

Configure the document information and click on Next.

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

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.

Configure the document information and click on Next.

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

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.

Configure the document information and click on Next.

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

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.

Configure the document information and click on Next.

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

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.

Configure the document information and click on Next.

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

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.

Configure the folder information and click on Next.

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

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.

Configure the folder information and click on Next.

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