Skip to content

Commit

Permalink
MARP-1454 update readme with new UI (#81)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README_DE.md

---------

Co-authored-by: AlexSchaIvy <[email protected]>
  • Loading branch information
ndkhanh-axonivy and AlexSchaIvy authored Dec 16, 2024
1 parent c4b015a commit 9fab813
Show file tree
Hide file tree
Showing 12 changed files with 76 additions and 56 deletions.
41 changes: 29 additions & 12 deletions docuware-connector-product/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,46 @@ This connector:

## Demo

1. Upload a document to a DocuWare file cabinet.
### Features

Upload result
1. **Organization Retrieval**
Click the **Organizations** button to retrieve the organization ID. The system will automatically include this ID in subsequent requests.

![demo-dialog](images/demo1.png)
![organization-result](images/get-organization-result.png)

![demo-dialog](images/demo2.png)
2. **File Cabinets Retrieval**
Click the **File Cabinets** button to fetch the cabinet Id of the selected organization. The cabinet Id determines where the file will be uploaded.

The uploaded file in Docuware dashboard.
![file-cabinet-result](images/get-file-cabinet-result.png)

![demo-dialog](images/demo3.png)
3. **Document Uploading**
Select a file to upload to the chosen DocuWare file cabinet. You can verify the uploaded file on the DocuWare dashboard.

2. Provide a GUI to test some basic DocuWare calls.
![upload-document](images/upload-document-result.png)

![demo-dialog](images/demo4.png)
4. **Document Retrieval**
Automatically fetch documents using the predefined **organization** and **fileCabinetId** fields from the `variables.yaml` file.

Get Organizations: click on Organizations button to get the organization id and automatically add to the request when upload file.
![fetch-documents](images/fetch-documents.png)

![demo-dialog](images/demo5.png)
5. **Document Viewing**
View documents directly within the interface using DocuWare’s document viewer.

Get File Cabinets: click on File Cabinets button to get the cabinet ID of the organization to locate which cabinet that the file will be uploaded.
![view-document](images/view-document.png)

![demo-dialog](images/demo6.png)
6. **Document Properties Editing**
Modify document properties, including metadata and custom fields.

![edit-document-properties](images/edit-document-properties.png)

7. **Document Deletion**
Delete documents from the file cabinet.

![delete-document](images/delete-document.png)

To view and edit documents and their properties, run the process named **DocuWare View/Edit Document**.

To upload documents and perform actions like retrieving organizations, getting file cabinets, and uploading documents, run the process named **Start some DocuWare calls**.

## Setup

Expand Down
91 changes: 47 additions & 44 deletions docuware-connector-product/README_DE.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,79 @@
# DocuWare Konnektor
# DocuWare Connector

[DocuWare](https://start.docuware.com/) bietet Cloud-basiertes Dokumenten-Management und Software zur Workflow-Automation. Damit lassen sich beliebige Geschäftsdokumente digitalisieren, revisionssicher archivieren und bearbeiten, um so die Kernprozesse deines Unternehmens zu optimieren.
[DocuWare](https://start.docuware.com/) bietet cloudbasierte Dokumentenverwaltung und Workflow-Automatisierungssoftware. Es kann verwendet werden, um alle Geschäftsdokumente revisionssicher zu digitalisieren, zu archivieren und zu verarbeiten, um die Kernprozesse Ihres Unternehmens zu optimieren.

**Der Axon Ivy DocuWare Konnektor ermöglicht eine effiziente Integration von DocuWare Funktionalitäten in Deine Prozessanwendungen**
Der Axon Ivy DocuWare-Connector ermöglicht eine effiziente Integration von DocuWare-Funktionalitäten in deine Axon Ivy Prozessanwendungen.

Dieser Konnektor:
Dieser Connector:

- minimiert deinen Integrationsaufwand: Nutze die Demoversion, die Beispiele für die API-Aufrufe enthält.
- basiert auf REST-Webservice-Technologien.
- ermöglicht dir den Zugriff auf grundlegende DocuWare-Funktionen.
- minimiert den Integrationsaufwand: Verwende die Demo-Version, die Beispiele für API-Aufrufe enthält.
- basiert auf REST-Webdienst-Technologien.
- gibt dir Zugriff auf grundlegende DocuWare-Funktionen.

## Demo

1. Upload a document to a DocuWare file cabinet.
### Funktionen

Upload result
1. **Abruf von Organisationen**
Klicke auf die Schaltfläche **Organisationen**, um die Organisations-ID abzurufen. Das System fügt diese ID automatisch in nachfolgende Anfragen ein.

![demo-dialog](images/demo1.png)
![organization-result](images/get-organization-result.png)

![demo-dialog](images/demo2.png)
2. **Abruf von Dateiablagen**
Klicke auf die Schaltfläche **Dateiablagen**, um die Ablagen-ID der ausgewählten Organisation abzurufen. Die Ablagen-ID bestimmt, wohin die Datei hochgeladen wird.

The uploaded file in Docuware dashboard.
![file-cabinet-result](images/get-file-cabinet-result.png)

![demo-dialog](images/demo3.png)
3. **Hochladen von Dokumenten**
Wähle eine Datei aus, die in die ausgewählte DocuWare-Dateiablage hochgeladen werden soll. Du kannst die hochgeladene Datei auf dem DocuWare-Dashboard überprüfen.

2. Provide a GUI to test some basic DocuWare calls.
![upload-document](images/upload-document-result.png)

![demo-dialog](images/demo4.png)
4. **Abruf von Dokumenten**
Dokumente werden automatisch abgerufen, indem die vordefinierten Felder **organization** und **fileCabinetId** aus der Datei `variables.yaml` verwendet werden.

Get Organizations: click on Organizations button to get the organization id and automatically add to the request when upload file.
![fetch-documents](images/fetch-documents.png)

![demo-dialog](images/demo5.png)
5. **Anzeigen von Dokumenten**
Dokumente können direkt in der Benutzeroberfläche mithilfe des DocuWare-Dokumentenbetrachters angezeigt werden.

Get File Cabinets: click on File Cabinets button to get the cabinet ID of the organization to locate which cabinet that the file will be uploaded.
![view-document](images/view-document.png)

![demo-dialog](images/demo6.png)
6. **Bearbeiten von Dokumenteigenschaften**
Ändere die Dokumenteigenschaften, einschließlich Metadaten und benutzerdefinierter Felder.

## Setup

Before any interactions between the Axon Ivy Engine and DocuWare services can be run, they have to be introducted to each other. This can be done as follows:
![edit-document-properties](images/edit-document-properties.png)

1. Get a DocuWare account and the DocuWare cloud `host-name`, `user-name`, `password` and `host-id` to use.
7. **Löschen von Dokumenten**
Lösche die Dokumente aus der Dateiablage.

1. Override the global variables for `host-name`, `user-name`, `password` and `host-id` in the demo project as shown in the example below.
![delete-document](images/delete-document.png)

```
Variables:
docuware-connector:
host: <myhost>.docuware.cloud
Um Dokumente anzuzeigen und deren Eigenschaften zu bearbeiten, starte den Prozess mit dem Namen **DocuWare View/Edit Document**.

username: <myuser>
# [password]
password: <mypass>
hostid: <mhostid>
```
Um Dokumente hochzuladen und Aktionen wie Abruf von Organisationen, Abruf von Dateiablagen und Hochladen von Dokumenten auszuführen, starte den Prozess mit dem Namen **Start some DocuWare calls**.

3. DocuWare unterstützt 3 Wege, um ein Access Token vom Identity Service zu generieren:
## Setup

3.a Token anfordern durch Benutzername & Passwort - GrantType ist `password`
Bevor eine Interaktion zwischen der Axon Ivy Engine und den DocuWare-Diensten ausgeführt werden kann, müssen diese mit einander verknüpft werden. Dies kann wie folgt durchgeführt werden:

3.b Token anfordern durch ein DocuWare-Token - GrantType ist `dwtoken`
1. Erstelle ein DocuWare-Konto und nutze den DocuWare-Cloud-`host`, `user-name` und das `password`.

3.c Token anfordern durch Username & Passwort (Trusted User) - GrantType ist `trusted`
2. Überschreibe die globalen Variablen für `host`, `username` und `password` im Demo-Projekt wie im folgenden Beispiel gezeigt:

4. Für GrantType ist `dwtoken`, wir müssen ein LoginToken bekommen. Bitte starten Sie den Prozess startRequestALoginToken.ivp und folgen Sie der Anleitung, um ein neues LoginToken zu erzeugen
```yaml
@variables.yaml@

3. DocuWare unterstützt 3 Methoden, um ein Zugriffstoken vom Identitätsdienst zu generieren:

If your REST URL does not follow the predefined REST URL pattern of this connector, you can change the URL in the Engine Cockpit. To change the URL in the Designer, you have to unpack the connector project and change it there.
3.a Zugriffstoken per Benutzername und Passwort anfordern - GrantType ist `password`

3.b Zugriffstoken mit einem DocuWare-Token anfordern - GrantType ist `dwtoken`

3.c Zugriffstoken per Benutzername und Passwort (Trusted User) anfordern - GrantType ist `trusted`

Run `start.ivp` of the DocuWareDemo demo process to test your setup.
4. Für GrantType `dwtoken` muss ein LoginToken generiert werden. Starte den Prozess `startRequestALoginToken.ivp` und folge der Anleitung, um ein neues LoginToken zu erstellen.

Wenn deine REST-URL nicht dem vordefinierten REST-URL-Muster dieses Connectors entspricht, kannst du die URL im Engine Cockpit ändern. Um die URL im Designer zu ändern, musst du das Connector-Projekt entpacken und dort ändern.

Starte `start.ivp` des DocuWareDemo-Demoprozesses, um deine Einrichtung zu testen.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docuware-connector-product/images/demo2.png
Binary file not shown.
Binary file removed docuware-connector-product/images/demo3.png
Binary file not shown.
Binary file removed docuware-connector-product/images/demo4.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9fab813

Please sign in to comment.