Resources

Remarks

Introduction

By chunking up the system into microservices it can be tough to keep the overview of all available services, their relationships and dependencies to each other. The following graphical overview of our microservice architecture offers you a first entry point into the yuuvis® Momentum landscape. By providing further and more detailed examples based on special use cases (flows) you'll get a better and easy way of understanding our entire landscape.

Graphical Overview

For visualizing the topology of our microservices the following overview shows - on a higher level - many of our core microservices. 
For understanding various flows - on a more granular level - check out the detailed diagrams visualizing special use case. 

Login to the Core API - Authentication (Browser / Application)

...

To interact with yuuvis® it is necessary to log in with a user account. The user accounts are managed by at least one external identity provider.

...

1. - HTTP request to any API endpoint, sending basic authentication or bearer token

2. - verify credentials externally

3. - receive auth code to authentication with auth code

4. - request roleset acquisition

5. - query user roleset externally

6. - receive user roleset

7. - present roleset

8. - provide authentication token and proceed with initial API request

9. - request information from other parts of the system

10. - obtain requested information

11. - produce API response

12. - send HTTP response to user

Webhook entry points

*1 - user.info

Expand
title Click here to show the authentication flow (application) >>
	Image Removed

Include Page
Authentication Flow (Application) Authentication Flow (Application)

1. - HTTP request to any API endpoint

2. - Redirect to Identification Provider

3. - Verify Credentials externally

4. - Redirect to authentication with Auth code

5. - Send Auth code to Authentication Service

6. - Retrieve UserId using Auth code

7. - Recieve UserId

8. - Request roleset acquisition

9. - Query user roleset

10. - Recieve user roleset

11. - Present roleset

12. - Provide authentication token and Proceed with initial API request

13. - Request information from other parts of the System

14. - Obtain requested information

15. - Produce API response

16. - Send HTTP response to User

Webhook entry points

*1 - user.info

Expand
title Click here to show the authentication flow (browser) >>
	Image Removed

Include Page
Authentication Flow (Browser) Authentication Flow (Browser)

Note
The authentication flow is always part of all described flows. It is used to get a valid authentication token for further processing.

To interact with yuuvis® Momentum, it is necessary to log in with a user account. The user accounts are managed by at least one external identity provider.
>> Concept: Authentication against the Core API
>> Example Tutorial: Login to the Core API (Java)

Anchor
graphicalOverview_ImportingDocuments graphicalOverview_ImportingDocuments

Importing Documents

Documents can be imported into a yuuvis® Momentum system using the provided core API's HTTP requests for importing documents (POST /api/dms/objects).

...

...

1. - HTTP Post request containing metadata and content

2. - enrichment of request with authentication token

3. - defer content to storage services

3.1 - analyze content file

3.2 - skip content analyzer

4. - content storage handling

4.1 - using custom storage via archive service

4.2 - using s3 interface of repository

5. - create metadata based on previous steps

6. - write metadata to storage / index instances

7. - index new object in ES

8. - create initial audit entry

9. - create API response from metadata

10. - return metadata as HTTP response

During asynchronous import operations, the controller service provides messaging for the boxed in services

Webhook entry points

*1 - dms.request.import.storage.before

...

 
>> Example Tutorial: Importing Documents via Core API

Retrieval of Content by ID / Older Version

...

1. - xxx

Webhook entry points

*1 - xxx

Expand
title Click here to show the content retrieval flow ( by ID ) >>
	Image Removed

Include Page
Retrieval of Content by ID Retrieval of Content by ID

1. - xxx

Webhook entry points

*1 - xxx

Expand
title Click here to show the content retrieval flow by ID (older version) >>
	Image Removed

Include Page
Retrieval of Content by ID / Older Version Retrieval of Content by ID / Older Version

The content of already imported documents into the yuuvis® Momentum system can be retrieved using the provided core API's HTTP requests for retrieving content files (GET /api/dms/objects/{objectId}/contents/file). If a specific version of the document's content is to be requested, the endpoint to be called changes and includes the specific version (GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/file). 
>> Example Tutorial: Retrieving Documents via Core API

Anchor
graphicalOverview_RetrievalMetadata graphicalOverview_RetrievalMetadata

Retrieval of Metadata by ID / Older Version

...

1. - xxx

Webhook entry points

*1 - xxx

Expand
title Click here to show the metadata retrieval flow ( by ID ) >>
	Image Removed

Include Page
Retrieval of Metadata by ID Retrieval of Metadata by ID

...

Expand
title Click here to show the metadata retrieval flow by ID (older version) >>
Image Removed	1. - xxx Webhook entry points *1 - xxx

Search Queries ...

The metadata of already imported documents into the yuuvis® Momentum system can be retrieved using the provided core API's HTTP requests for retrieving the metadata (GET /api/dms/objects/{objectId}). If a specific version or all versions of the document's metadata is to be requested, the endpoint to be called changes and includes the specific version (GET /api/dms/objects/{objectId}/versions / GET /api/dms/objects/{objectId}/versions/{versionNr}). 
>> Example Tutorial: Retrieving Documents via Core API

Search Queries

...

Update Content ...

Already imported objects into the yuuvis® Momentum system can be queried using the provided core API's HTTP request with the search query as request body (POST /api/dms/objects/search). 
>> Concept: Search Query Language

Update Content

...

Update Metadata ...

The content of an already imported document into the yuuvis® Momentum system can be updated using the provided core API's HTTP requests for updating the content (POST /api/dms/objects/{objectId}/contents/file). 
>> Example Tutorial: Updating Documents via Core API

Update Metadata

...

Deletion ...

The metadata of an already imported document into the yuuvis® Momentum system can be updated using the provided core API's HTTP requests for updating the metadata (POST /api/dms/objects/{objectId} / PATCH /api/dms/objects/{objectId}). 
>> Example Tutorial: Updating Documents via Core API

Deletion

...

An already imported document into the yuuvis® Momentum system can be deleted using the provided core API's HTTP requests for deleting documents (DELETE /api/dms/objects/{objectId}). 
>> Example Tutorial: Deleting Documents via Core API

...

Another Tutorial

...

Another Concept Article

...

...

Another interesting Tutorial

...