...

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)

...

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

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

Expand
title Click here to show the content retrieval flow by ID >>
1. - HTTP get request to object URL 2. - Enrichment of request with authentication Token 3. - Check for User Authorization using search service query 4. - Query elastic search for object ID 5. - Elasticsearch metadata reponse (if user is authorized) 6. - Repository url of objectId 7. - Request content of objectID 8. - Query objectId in Storage Provider 9. - Storage Provider metadata response 10. - Return metadata object metadata 11. - Write CONTENT_ACCESSED audit entry 12. - Create API response from metadata 13. - Return HTTP metadata response Webhook entry points *1 - dms.response.objects

...

Expand
title Click here to show the content retrieval flow by ID (older version) >>
1. - HTTP get request to object URL 2. - Enrichment of request with authentication Token 3. - Check for User Authorization using search service query 4. - Query elastic search for object ID 5. - Elasticsearch metadata reponse response (if user is authorized) 6. - Verify that user has object access rights 7. - Retrieve metadata version using Registry Service 8. - Query object metadata version from database 9. - Return metadata including Repository URL of content 10. - Return content Repo URL 11. - Request content of objectID 12. - Query objectId in Storage Provider 13. - Storage Provider metadata response 14. - Return metadata object metadata 15. - Write CONTENT_ACCESSED audit entry 16. - Create API response from metadata 17. - Return HTTP metadata response Webhook entry points *1 - dms.response.objects

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

...

xxx If a specific version or all versions of the document's metadata is to be requested, the endpoints to be called change and include the versions (GET /api/dms/objects/{objectId}/versions / GET /api/dms/objects/{objectId}/versions/{versionNr}).

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

>> CMIS-Based Query Language

Expand
title Click 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. - Recieve 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

Update Content

...

xxx

Expand
title Click here to show the update content flow >>
1. - HTTP post request to content url of object 2. - Enrichment of the Request with authentication token 3. - Verify user has writing permissions on object using Search Service 4. - Query object in Elastic Search 5. - Return ElasticSearch query results 6. - Return User Authorization Verification results 7. - Infer analysis of new content item 8. - Commit new content to storage 9. - Content Storage Handling 9.1 - Using custom storage via Archive Service 9.2 - Using s3 interface of repository 10. - Update object metadata contentstream attribute 11. - Commit updated metadata to database and index 12. - Index the updated metadata in ES 13. - Write CONTENT_UPDATED audit entry 14. - Return updated metadata 15. - Create API response from metadata 16. - Return updated metadata Webhook entry points *1 - dms.response.objects

...

Info
icon false
Read on Section Column width 25% Another Tutorial Brief summary of the article linked. Column width 25% Another Concept Article Brief summary of the article linked. Column width 25% Another interesting Tutorial Brief summary of the article linked.