Case Management Documents

The adapter is the interface to the Case Management functionality of the product component X4 BPM. The adapter enables you to manage documents for processes. In addition to characteristics of the business data model, documents can be stored directly in processes.

Properties

Operation

Defines the operation executed by the adapter.

Possible values:

AttachDocument: Defines the operation executed by the adapter.
UpdateDocument: Updates an existing document.
UpdateDocumentMetadata: Updates the metadata of an existing document.
GetDocument: Returns the document as output.
GetDocumentMetadata: Returns the metadata of the document as output.
ListAllDocumentMetadata: Returns the metadata of all documents of the case as output.
RemoveDocument: Removes the document from the case.

Parameters

`Adapter`	Main class of the adapter (Do not change!) Possible values: de.softproject.x4.server.bmn.casemanagement.adapter.CaseDocumentAdapter: Main class (default)
`caseId`	ID of the case to be processed Possible values: Any (valid) Case ID `%CASE_ID%`: current Case ID (default)
`title`	Title of the document Possible values: Any string The title of the document serves to identify it and must be unique within a process!
`fileName`	File name of the document Possible values: Any string, e.g. `Appendix/Invoice.pdf`
`encoding`	Character encoding of the document Possible values: Valid specification of character encoding, e.g. `UTF-8`
`mimeType`	MIME Type of the document Possible values: Valid specification of the MIME Types, e.g. `application/xml`
`base64`	Defines if the document is passed as a Base64 string. Possible values: `true`: Document is passed as Base64 string. `false`: Document is passed directly (default).

Status values

`1`	The operation was executed successfully.
`-1`	An error occurred during the operation's execution.

Input

The adapter doesn't expect any specific input.

If the base64 parameter is set to true in the AttachDocument and UpdateDocument operations, the input must be a Base64-encoded string.

Output

The adapter returns different kinds of documents depending on the executed operation:

In the following operations, the input is output again if the operation is successful:
- AttachDocument
- UpdateDocument
- UpdateDocumentMetadata
- RemoveDocument

GetDocumentMetadata operation

Sample Output for the GetDocumentMetadata Operation

XML

<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<Document updatedOn="2019-03-28T13:34:46.233+01:00" updatedBy="x4" createdOn="2019-03-28T13:34:45.690+01:00" createdBy="x4">
	<Title>Invoice</Title>
	<FileName>Invoice.xml</FileName>
	<MimeType>application/xml</MimeType>
	<Encoding>UTF-8</Encoding>
</Document>

ListAllDocumentMetadata operation

Sample Output for the ListAllDocumentMetadata Operation

XML

<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<Documents>
	<Document createdOn="2019-03-28T13:35:04.543+01:00" createdBy="x4">
		<Title>Kommentar</Title>
		<FileName>Comment.txt</FileName>
		<MimeType>text/plain</MimeType>
		<Encoding>UTF-8</Encoding>
	</Document>
	<Document createdOn="2019-03-28T13:34:45.690+01:00" createdBy="x4" updatedOn="2019-03-28T13:34:46.233+01:00" updatedBy="x4">
	<Title>Invoice</Title>
		<FileName>Invoice.xml</FileName>
		<MimeType>application/xml</MimeType>
		<Encoding>UTF-8</Encoding>
	</Document>
</Documents>

GetDocument operation:
If the parameter base64 is set to true, the document will be output as Base64 encoded string.