# DigiWF Ticket-Integration
Die DigiWF Ticket-Integration ermöglicht es Prozessentwicklern, mit einem Ticket-System zu interagieren. Momentan steht ein Adapter für Zammad zur Verfügung.
# Verwendung
Für die Verwendung der DigiWF Ticket-Integration stehen mehrere Funktionalitäten zur Verfügung:
- Artikel erstellen
- Artikel mit Benutzer erstellen
# Artikel erstellen
Um einen Artikel zu erstellen, müssen Sie die folgenden Daten an die Ticket-Integration übergeben:
{
"type": "writeArticle",
"integration": "ticketIntegration",
"fileContext": "fileContext",
"ticketId": "1234",
"article": "Some text",
"status": "OPEN",
"filepaths": "path/to/folder/,path/to/file2"
}
2
3
4
5
6
7
8
9
Um die Prozessentwicklung zu beschleunigen, kann das Element-Template Ticketing: Artikel schreiben verwendet werden.
# Felder
| Feld | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
type | String | Der Typ des Events. In diesem Fall writeArticle. | Ja |
integration | String | Der Name der Integration. In diesem Fall ticketIntegration. | Ja |
fileContext | String | Der Datei-Kontext in welchem die Dateien und Ordner aus filepaths liegen. | Ja |
ticketId | String | Die ID des Tickets, zu dem der Artikel hinzugefügt werden soll. | Ja |
article | String | Der Text des Artikels. | Ja |
status | String | Der Status, den das Ticket annehmen soll. | Nein |
filepaths | String | Eine Kommaseparierte Liste von Datei- und Ordnerpfaden aus dem S3 Bucket. Ordner müssen mit einem Slash enden. | Nein |
# Artikel mit Benutzer erstellen
Um einen Artikel mit einem Benutzer zu erstellen, müssen Sie die folgenden Daten an die Ticket-Integration übergeben:
{
"type": "writeArticleWithUser",
"integration": "ticketIntegration",
"fileContext": "fileContext",
"ticketId": "1234",
"article": "Some text",
"userId": "1234",
"status": "OPEN",
"filepaths": "path/to/folder/,path/to/file2"
}
2
3
4
5
6
7
8
9
10
Um die Prozessentwicklung zu beschleunigen, kann das Element-Template Ticketing: Artikel mit Benutzer schreiben verwendet werden.
# Felder
Es werden die gleichen Felder wie bei writeArticle benötigt, zusätzlich wird die userId benötigt.
| Feld | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
userId | String | Die ID des Benutzers, zu dem der Artikel hinzugefügt werden soll. | Nein |
# BPMN Error
| Error Code | Error Message | Beschreibung | Handlungsempfehlung |
|---|---|---|---|
LOAD_FILE_FAILED | An file could not be loaded from url: filepath | Die Datei konnte nicht geladen werden | Stellen Sie sicher, dass die Datei im S3 Bucket vorhanden ist |
LOAD_FOLDER_FAILED | An folder could not be loaded from url: folderpath | Der Ordner konnte nicht geladen werden | Stellen Sie sicher, dass der Ordner im S3 Bucket vorhanden ist |
FILE_SIZE_ERROR | The following files exceed the maximum size of <maximal Größe von Dateien> MB:<Liste von Dateien mit Größen> | Einige Dateien haben die maximal zulässige Größe überschritten | Stellen Sie sicher, dass nur Dateien mit der zulässigen Maximalgröße in den S3 Bucket geladen werden. |
BATCH_SIZE_ERROR | Batch size of <Summe der auf einmal verarbeiteten Dateien> MB is too large. Allowed are <maximal Größe eines Batches> MB. | Die Summe von auf einmal zu verarbeitenden Dateien ist zu hoch | Stellen Sie sicher, dass die Summe von auf einmal zu verarbeitenden Dateien nicht die Maßimalgröße überschreitet. |
FILE_TYPE_NOT_SUPPORTED | The type of this file is not supported: filepath | Der Dateityp der Datei wird nicht unterstützt | Die Datei kann nicht in DMS abgelegt werden |