Case Management Documents

Dieser Adapter bildet die Schnittstelle zur „Case Management“-Funktionalität der Produktkomponente X4 BPM. Der Adapter ermöglicht das Verwalten von Dokumenten (Dateien) an Vorgängen. Dokumente können zusätzlich zu Merkmalen des Fachdatenmodells direkt an Vorgängen hinterlegt werden.

Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

AttachDocument: Fügt dem Vorgang ein Dokument hinzu.
UpdateDocument: Aktualisiert ein vorhandenes Dokument.
UpdateDocumentMetadata: Aktualisiert die Metadaten eines vorhandenen Dokuments.
GetDocument: Gibt das Dokument als Output aus.
GetDocumentMetadata: Gibt die Metadaten eines Dokuments als Output aus.
ListAllDocumentMetadata: Gibt die Metadaten aller Dokumente des Vorgangs als Output aus.
RemoveDocument: Entfernt das Dokument aus dem Vorgang.

Parameter

`Adapter`	Hauptklasse des Adapters (nicht verändern!) Mögliche Werte: de.softproject.x4.server.bmn.casemanagement.adapter.CaseDocumentAdapter: Hauptklasse (Standard)
`caseId`	ID des zu verarbeitenden Vorgangs Mögliche Werte: Beliebige (gültige) Case-ID `%CASE_ID%`: aktuelle Case-ID (Standard)
`title`	Titel des Dokuments Mögliche Werte: Beliebige Zeichenkette Der Titel des Dokuments dient zur Identifizierung und muss innerhalb eines Prozesses eindeutig sein!
`fileName`	Dateiname des Dokuments Mögliche Werte: Beliebige Zeichenkette, z. B. `Anhang/Rechnung.pdf`
`encoding`	Zeichenkodierung des Dokuments Mögliche Werte: Gültige Angabe der Zeichenkodierung, z. B. `UTF-8`
`mimeType`	MIME-Type des Dokuments Mögliche Werte: Gültige Angabe des MIME-Types, z. B. `application/xml`
`base64`	Gibt an, ob das Dokument als Base64-Zeichenkette übergeben wird. Mögliche Werte: `true`: Dokument wird als Base64-Zeichenkette übergeben. `false`: Dokument wird direkt übergeben (Standard).

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`-1`	Die Operation konnte nicht ausgeführt werden.

Input

Der Adapter erwartet keinen speziellen Input.

Wenn bei den Operationen AttachDocument und UpdateDocument der Parameter base64 auf true gesetzt ist, muss der Input eine Base64-kodierte Zeichenkette sein.

Output

Je nach Operation gibt der Adapter Daten in verschiedenen XML-Strukturen aus:

Bei folgenden Operationen wird der Input bei einer erfolgreichen Operation wieder als Output ausgegeben:
- AttachDocument
- UpdateDocument
- UpdateDocumentMetadata
- RemoveDocument

GetDocumentMetadata-Operation

Beispiel-Output für die Operation GetDocumentMetadata

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>Rechnung</Title>
	<FileName>Rechnung.xml</FileName>
	<MimeType>application/xml</MimeType>
	<Encoding>UTF-8</Encoding>
</Document>

ListAllDocumentMetadata-Operation

Beispiel-Output für die Operation ListAllDocumentMetadata

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>Kommentar.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>Rechnung</Title>
		<FileName>Rechnung.xml</FileName>
		<MimeType>application/xml</MimeType>
		<Encoding>UTF-8</Encoding>
	</Document>
</Documents>

GetDocument-Operation:
Wenn der Parameter base64 auf true gesetzt ist, wird das Dokument als Base64-kodierte Zeichenkette ausgegeben.