Glossary ...

[C] [D] [E] [H] [M] [R] [S] [T]


C

  • CMIS
    The CMIS-Based Query Language serves to standardize DMS requests with the yuuvis® API. It consists of a subset of the SQL-92 grammar, augmented by a syntax for requesting full text. Thus, the CMIS query language provides a relational view of the data. The virtual tables requested in the FROM clause correspond to DMS object types and the virtual columns requested in SELECT correspond to the CMIS properties (metadata).
    >> "How to ... | CMIS-Based Query Language"
  • Compound document
    Compound documents are combinations of the binary coding of several individual documents, which can be translated back into the individual documents by means of the intervals (ranges) in which the binary content of individual documents can be found. Compound documents consist of content and metadata, just like any other document (object) in the system.
  • Content digest
    When a document is stored a content digest is generated automatically (Secure Hash Algorithm, SHA256). This digest is returned as a hex-encoded value and is stored together with the metadata of the document. The digest is the only sure way of identifying that object. The hex-encoded value allows you to verify that e.g. the document remained unchanged.
    >> "Endpoint | Validate content digest by ID ..."

D

  • Document (object)
    Business objects of a type that generally contain a document file in addition to its metadata.
    Document files can be text documents, e-mails, image files, video, etc.
    >> "Endpoint | Store one or more documents ..."

E

  • Endpoint (operation)
    The various yuuvis® API products provide a set of endpoints (functions) related to the context of the product. E.g., the yuuvis® API Convert offers endpoints to deal with renditions.
    An endpoint is one end of a communication channel you use as touchpoint for interacting with the yuuvis® API from your web application, for example. It can include a URL of a server or service and is the location from which the resources can be accessed to carry out their function.

H

  • History
    The history of a business object gives detailed information about the actions and modifications that have been carried out for a given object, e. g., the creation of a document or download of the document file as PDF. Each action or modification is stored in a separate history entry.
    >> "Endpoint | Get a list of history entries by ID"

M

  • Metadata
    In yuuvis®, metadata are either object properties that are determined by the system, e. g., the creator or creation time of an object or describe the specific properties of a business object, e. g., the sender and recipient of an email. These properties can be used as search parameters to find business objects in the system.
    >> "Endpoint | Get document metadata by ID"
  • Multipart body
    For transferring data of several types (e.g. a binary file along with a JSON object) in a single request you typically use multipart body. This type of request combines one or more sets of data, separated by boundaries, into a single body.

R

  • Rendition
    Document conversion that allows you to carry out transformation processes of various document files into text, pdf, image and more. The PDF can be used, for example, for document previews or dispatching options.
    >> "Endpoint | Get a PDF rendition"

S

  • Subscription
    A subscription is an agreement to use one or more yuuvis® products.

T

  • Tenant
    A client organization that is served by yuuvis®. This organization’s data is stored in a separate database.
    A specific instance of yuuvis® with accounts and groups.
    >> "Endpoint | Get the raw tenant schema"