Developer

Owned by Technische Redaktion
Last updated: Jun 16, 2022Version comment

Topics related to the usage of our interfaces.

API

Find here an overview of all available interfaces.

 open...

Core

  • Page:
    DMS Endpoints — Manage DMS objects in yuuvis® Momentum or retrieve structural information for the tenant that are relevant for all its users.
  • 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.

Additional Services' Endpoints

  • Page:
    KAIROS-API Endpoints — The KAIROS-API endpoints for inference schema management.
  • Page:
    CATALOG Service Endpoints — The CATALOG service API provides CRUD (create, read, update, delete) operations on catalogs and catalog entries.
  • Page:
    PREDICT-API Endpoints — The PREDICT-API endpoints allow for the development of client applications with integrated AI functionality.
  • Page:
    BPM Engine Endpoints — These endpoints allow the management of workflow processes and tasks.
  • Page:
    Tenant Management Endpoints — These endpoints can be used to retrieve information from the identity provider. Role and user management for a tenant and to create and delete tenants in Keycloak.
  • 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.

Backend

Learn about the concepts of using yuuvis® Momentum backend or jump directly into the coding guided by our example tutorials.

 open...

Core Concepts

Documentation for yuuvis® Momentum Core in a structured, theoretical way, with links to the tutorial section.

Authentication against the Core API

This article details the authentication methods compatible with the yuuvis® Core API and how to choose the correct one for your use case.

Schema - Defining Object Types

Define properties and reference them in object type definitions for the entire system, for individual tenants or for a specific app.

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.

Search Query Language

How to query in an SQL-like manner.

Object Representation Formats

A description of the structure in which yuuvis® Momentum expects objects to be formatted and returns objects.

Database Schema

The described database tables are used to manage the metadata of objects.

Binary Content Files

Binary content files can be imported and assigned to document objects in yuuvis® Momentum. Archiving can be managed and renditions can be retrieved.

Renditions

Various types of renditions are available for binary content files to provide their information in different formats.

Document Lifecycle Management (DLM)

This article gives information on tagging and schema flow functionality (secondary object types) in the context of a document's lifecycle.

Document Retention

A retention can be used to ensure that a document object is not deleted and the binary content file assigned it is not deleted or changed.

Apps

Management of apps that are based on yuuvis® Momentum via schema, permissions, system hook configuration and availability configurations.

Error Handling

Structure and identification codes of errors that can be thrown during different processes.

System Hooks

Define additional actions triggered by specified events, extend the functionality of yuuvis® Momentum API.

Interceptors

Intervening a running process at a certain position and redirecting the process flow in order to include project-specific processing steps.

Core Example Tutorials

Follow the tutorials that guide you through the document management with yuuvis® Momentum by means of code examples.

Login to the Core API (Java)

This tutorial will give you a brief overview of the most important login procedures for the yuuvis® API system and how to use them in a Java Client application

Importing Documents via Core API

This tutorial shows how documents can be imported into a yuuvis® API system via the Core API. During this tutorial, a short Java application will be developed that implements the HTTP requests for importing documents. We additionally provide a JavaScript version of this tutorial. 

Retrieving Documents via Core API

In this tutorial, we will discuss various ways to retrieve objects via the Core API from the yuuvis® API system using an OkHttp3 Java client.

Updating Documents via Core API

This tutorial demonstrates how to update documents in yuuvis® API with the Core API. The following example will result in a short Java application that implements the HTTP requests for updating a document. 

Deleting Documents via Core API

This tutorial explains how documents can be deleted using the Core API with the help of a Java client. This tutorial requires basic knowledge of importing documents using the Core API.

Retrieving Document History Entries

This tutorial shows how we can use a Java application to make a request to the Core API of the yuuvis® API system to retrieve the history entries of a DMS document. In addition, it briefly describes which history entries are generated for a document.

Compound Documents

Concatenate multiple binary content files as byte arrays in one compound document. Create sub-documents that refer to specified ranges within the total byte array.

Managing the Schema

This tutorial shows how to use the Core API to get the tenant-specific schema of the system, how to validate a schema, and how to bring in a new schema.

Changing Schema Structures ("Schema Flow")

This tutorial shows how to change your basic schema for individual instances of an object type during the entire lifecycle of a document. Classify objects at a later point in time, add or remove property groups at runtime by defining and referencing "floating" secondary object types.

Tagging Objects for Processing

Based on tags, you set up complex stateful processing chains. This tutorial describes how tags can be added, displayed, and updated in an example context. For this purpose, a typical application will be discussed: An import management system, which is an example for a processing chain, where tags are a helpful tool to describe the current status of each object.

Setting and Querying Structured Data

This example tutorial provides explanations and code examples to get an idea on how to define and specify structured data properties and on how to query them.

Overwriting the 'required' Property Attribute

This tutorial shows how to reference the same property definition in different object type definitions, in some of them as a required property and in others as a non-required property.

Preprocessing Metadata using Webhooks

An example Webhook consumer service set up using Java and Spring Boot. 

Interceptor Example Tutorial

Learn how to set up a Microservice that can fill the role of an interceptor of any of the available interceptor types. Java code examples of such microservices can also be found here. 

Importing Documents (JavaScript)

This tutorial shows how documents can be imported into a yuuvis® API system via the Core API. This tutorial is an extension of the Java import tutorial, applying its concepts to a different popular programming language, JavaScript.

Additional Services

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

Client Development

Learn how to build an own client application by means of developer libraries or modify our yuuvis® Momentum client as reference implementation according to your business use case. Alternatively, you could also build an independent solution using our yuuvis® styles.

Client Services

Services for building a client for yuuvis® Momentum.

Tenant Management

Services for tenant and user management via API.

Business Process Management (BPM)

Services for Business Process Management.

Artificial Intelligence Platform

Enables yuuvis® Momentum users to automatically classify documents and extract metadata from documents using machine learning models trained on their own data, both on-premises and in the cloud.

CATALOG Service

The service provides the usage of catalogs defined as document object types in a tenant schema.

SAP Integration

Combine yuuvis® Momentum with SAP.

Frontend

 open...

  • Page:
    yuuvis® styles —

    If you are creating a new application intended to handle specific data of the yuuvis® backends and you only need the CSS files, you can use the npm package: https://www.npmjs.com/package/@yuuvis/styles.

    Shortly, we will publish a website that shows all styles used as an example application on https://yuuvis-cc.yuuvis.org/
  • Page:
    Custom Client Build with Libraries —

    Documentation of the client core and framework libraries, as usable for custom client development.
  • Page:
    Form Scripting (Client-side) —

    If you configure custom forms for objects, you can additionally use executable scripts to, e.g., validate data, change data, change field properties - such as "read-only" or "mandatory" - and show context-related messages. Form-related scripts enhance your options by adding further functionalities to support your use cases and processes the best. 
  • Page:
    Client Scripting API —

    This article describes the Client Scripting API used to develop custom clients as well as client-side form scripts. For more information on building custom clients, refer to the client API documentation.