Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version
Report Notepresentable
Assignee

Resources & Remarks

Links, Pictures, whatever

Modification History

Add a new line to this table and fill it whenever you edit the page.

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



Graphical overviews describing the interaction of the yuuvis® Momentum core services in exemplary basic use case flows. 



Table of Contents


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)



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)

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

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


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


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). 
>> Concept: Search Query Language


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


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}). 
>> 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


Read on


Core Services

 Keep reading


Additional Services and Custom Clients

 Keep reading



DMS Endpoints

 Keep reading