Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idDONE

Product Version
Report Notepresentable
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Max/Inga2020
Page created.
Antje08 FEB 20212.4New page properties macro.
Antje17 MAY 20212021 Summerrenamed for new structure



Excerpt

A better way of understanding our yuuvis® Momentum microservices - graphical overviews of the architecture and basic use case flows Graphical overviews describing the interaction of the yuuvis® Momentum core services in exemplary basic use case flows. 


Section
bordertrue


Column

Table of Contents

Table of Contents
exclude(Table of Contents|Read on|Another Tutorial|Another Concept Article|Another interesting Tutorial|Summary|DMS endpoints|yuuvis® Momentum Services|Architecture)


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. 

Anchor
graphicalOverview_LoginCoreAPI
graphicalOverview_LoginCoreAPI

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.

...

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). >> Importing Documents via Core API

...

Anchor
graphicalOverview_RetrievalContent
graphicalOverview_RetrievalContent

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). >> Retrieving Documents via Core API

...

Anchor
graphicalOverview_RetrievalMetadata
graphicalOverview_RetrievalMetadata

Retrieval of Metadata by ID / Older Version

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}). >> Retrieving Documents via Core API

...

Anchor
graphicalOverview_SearchQueries
graphicalOverview_SearchQueries

Search Queries

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). >> CMIS-Based Search Query Language

Expand
titleClick here to show the search queries flow >>


1. - HTTP get request to object URL

2. - Enrichment of request with authentication Token

3. - Request query execution

4. - Translate and send ES query

5. - Receive ES query results

6. - Return metadata object list

7. - Create API response from metadata

8. - Return HTTP metadata response

Webhook entry points

*1 - dms.request.search

*2 - dms.response.objects


Anchor
graphicalOverview_UpdateContent
graphicalOverview_UpdateContent

Update Content

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). >> Updating Documents via Core API

...

Anchor
graphicalOverview_UpdateMetadata
graphicalOverview_UpdateMetadata

Update Metadata

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}). >> Updating Documents via Core API

...

Anchor
graphicalOverview_Deletion
graphicalOverview_Deletion

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}). >> Deleting Documents via Core API

Expand
titleClick here to show the deletion flow >>


1. - HTTP delete request to object id URL

2. - Enrichment of request with authentication token

3. - Query object using Search Service to verify user Authorization

4. - Query object in ElasticSearch

5. - ElasticSearch object reponse

6. - Authorization Verification Results

7. - Infer flag for deletion on object

8. - Flag as deleted in Database

9. - Flag as deleted in ElasticSearch via Index

10. - FLAGGED_FOR_DELETE audit entry

11. - Delete content through repository service

12. - Infer deletion of object in database

13. - Infer deletion of object in ElasticSearch

14. - OBJECT_DELETED audit entry

15. - Return Deletion Results

Webhook entry points

*1 - dms.response.objects


Summary

Info
iconfalse

Read on

Section


Column
width25%

Architecture

Insert excerpt
Architecture
Architecture
nopaneltrue
 Keep reading


Column
width25%

yuuvis® Momentum Services

Insert excerpt
Core Services
Core Services
nopaneltrue
 Keep reading


Column
width25%

DMS Endpoints

Insert excerpt
DMS Endpoints
DMS Endpoints
nopaneltrue
 Keep reading




...