Getting Started

We have recently changed the URL structure of our developer documentation. Redirects for the most important pages are set up. However, we cannot guarantee that all your bookmarks will still find their intended destination. Please also refer to the search in the top bar or the navigation on the left-hand side to find what you are looking for.

We apologize for any inconvenience.

About this Documentation

The yuuvis® Momentum documentation has a functional structure based on the division into the core system and additional services as you can see in the navigation. If you are already familiar with the product, you can use the page tree to easily navigate directly to your topic.

Alternatively, the entry points provided below may help you to find topics of your interest.

We hope this growing portal serves you well and invite you to submit requests or suggestions to us.



Later Versions

Jump to the corresponding documentation space.

Target Groups

Find here articles of your interest ...

... as a system architect.

› open...

... as a developer.

› open...

... as a DevOps engineer.

› open...

... as a user.

› open...

Main Topics

An introduction into the system. Learn about the basic concepts of yuuvis® Momentum.

Schema - Defining Object Types

Detailing the available schema, object type definitions as well as property definitions.

Search Query Language

How to query in an SQL-like manner.

Access Authorization and Permissions

A yuuvis® Momentum user has to be authorized to the functionality of the system by assigning roles. For the individual roles, permissions can be set to allow actions on objects restricted by defined conditions where appropriate and the usage of specific endpoints can be controlled.

Basic Use Case Flows

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

Custom Client Build with Libraries

Documentation of the client core and framework libraries, as usable for custom client development.

About yuuvis® Momentum

Think of yuuvis® Momentum as a tool for accelerated development of tailored content and information management solutions.

API

An overview of all our public interfaces is provided.

Endpoints

 open...

Core

  • Page:
    API — Organization and description of the yuuvis® Momentum ReST API endpoints is found here. Consider using our yuuvis® Postman Collections for convenient testing.
  • Page:
    DMS Endpoints — These endpoints may be used by any kind of client, operating under an authorized user. 
  • Page:
    Admin Endpoints — These endpoints allow the administration of system properties for a tenant. They enable the tenant administrator to apply changes to the tenant-specific schema of available object types as well as to the rolesset carrying the permissions. Tenant is always the one the requesting administrative user belongs to.

    Note: to use this API, you must be a tenant administrator. This means that you must have specific authorizations.

  • Page:
    System Endpoints — These endpoints allow the administration of the yuuvis® Momentum system. Global schemas and role sets are merged into each tenant's schema and role set, making the contained object types and roles available in each of them.

    Note: To use this API, you must be a system administrator. This means that you must have specific authorizations.

  • Page:
    Rendition Endpoints — These endpoints provide document renditions in different formats.
  • Page:
    Web-API Gateway Endpoints The higher-level API of the Web-API Gateway on top of the core, as it is useful for client application developers.
  • Page:
    User Settings Endpoints — The USERSERVICE API allows accessing and managing custom user information, settings and content.

Additional Services

There is no content with the specified labels

Services

Find here a list of all yuuvis® Momentum services including core and periphery.

Overview of all yuuvis® Momentum Services

 open...

The requirement of high and thus horizontal scalability as well as high availability is currently best combatted by architectures comprising of distributable small services which can be run in more than one instance. Such architectures offer redundance and pinpoint scalabilityleading, among other advantages, to the wild success of this architectural pattern. This article describes the services yuuvis® Momentum is made of.

Core Services


The services yuuvis® Momentum Core is made of.

yuuvis® Momentum fields a core consisting of a small zoo of cloud-native microservices, which allows for high availability and scalability. The entirety of the core's functions is made available through the API-gateway as core API. Two servicesthree if counting in the API-gateway serve the microservice architecture itself: ADMIN allowing service administration like restarting a service or changing its intended amount of instances, and CONFIG, reading, caching and delivering configuration information to the other services.

NameFunctionConfiguration profilesCertificatesStandard portsScalable
Gateway
APIAPI-gatewayprod, cloud, redisno7450-7459yes
Basic Core Services
AUTHENTICATIONuser authentication, session managementprod, cloudyes80no
ORGANIZATIONmapping users to roles (the latter carrying the permissions)prod, cloud, mq, trusted, keycloakyes7440-7449yes
SYSTEMschema managementprod, cloud, mq, redisyes7400yes
(as of 2020 Autumn)
REPOSITORYmanagement of the binary storageprod, cloudno7500-7509yes
REGISTRYmanagement of object metadata in the relational databaseprod, cloud, mq, jpa, dbs, redisno7510-7519yes
INDEXindexing in Elasticsearchprod, cloud, es, mq, redisno7291-7300yes
SEARCHprocessing of queriesprod, cloud, es, mqno7221-7230yes
AUDITobject history, audit trail managementprod, cloud, jpa, dbsno7251yes
CONTENTANALYZERsynchronous full-text extraction and determination of the MIME typeprod, cloudno7430-7439yes
Archive Services
ARCHIVEconnector for storage solutionsprod, cloud, storageno7530-7539yes
Rendition Services
CONTROLLERjob messaging using third party RabbitMQ and more, used for asynchronous operationsprod, es, oauth2, lc, mqyes7332-7335yes
TEXTEXTRACTORasynchronous full-text extractionprod, cloud, lc, mqno7400-7429yes
RENDITIONgeneration of renditions of submitted documents
no7341yes

Structural Services

ADMIN* **administration, monitoring, configurationprod, cloudno7273yes
CONFIGSERVICEconfiguration serverprod, cloud, nativeno7281yes
DISCOVERY**service registrationprod, cloudno7261no
Rollback Administration
COMMANDER*command tool for rollbacksprod, dbs, esno7412

no

* service of special interest for DevOps | ** obsolete when using Kubernetes


Additional Services


Services for functional extension as upper layers on top of the yuuvis® Momentum core system.

The client services offer, in accordance with the layered onion approach, both additional functionality as well as higher-level API functions valuable to client applications. Next to the user and the viewer services, the web-api gateway service is the main service for the client development.
>> Client Development

NameFunctionConfiguration profilesCertificatesStandard portsScalable
Client Services
API-WEBweb-api gateway, bundling of higher-level functions in one client API, adds more features like custom forms, localization, and object type icons to the system.prodno7550yes
CLIENTreference client based on core and framework libraries that can be used for custom client developmentprodno80yes
ARCHITECT (as of 2020 Winter)supports custom form modeling including form scripts, localization of technical names, and user management (will be moved to another application later this year).prodno80yes
VIEWERoffers client-side viewing capability for certain file typesprodno80yes
USERSERVICEstores user settings and caches user information-no8080yes
SOTHOOKfills the property appClientsystem:leadingTypeIdprodno
10779
yes
Tenant Management 
TENANT-MANAGEMENTtenant management API with endpoints for maintaining tenants and their usersprod, oauth2no8080yes
MANAGEMENT-CONSOLEmanagement console API as backend service for maintaining organizations that maintain tenants.-no7560yes
MANAGEMENT-CONSOLE-CLIENTWeb-client with a graphical user interface for the management console API. -no80yes
METRICSprovides tenant specific metrics.
The tenant management API offers exposed endpoints of this service.
-no8080yes
Business Process Management (BPM)
BPM-ENGINEFlowable-based BPM engine-no8080yes
BPM-ADMIN-UIadmin user interface for the BPM engine-no8080no

Specific Terms

Learn about the terminology used to describe the features of yuuvis® Momentum.

Glossary

› open...

Current Development

Find here the most recent information on our current development.