Product Version 2020 Autumn (2.3)
Features
Here, you will find some of the new release's features. Check out the Change Log for further information on all changes.
Full-text Search Options
Our query language integrated in yuuvis® serves to standardize DMS requests to the yuuvis® API system. Within simple queries or queries with aliases the condition in the WHERE clause can be extended to perform a full-text search (CONTAINS()
). For more flexibility in the full-text search the following features are available:
- phrase search - search for a string consisting of several words in the same order (sentence)
- search term - include or exclude
- "+" - include, the search term must occur
- "-" - exclude, the search term must not occur
The search results are sorted according to their weighted score (elasticsearch).
New and Modified Endpoints
Rendition Endpoint for Text Extraction
A new endpoint—GET /api/dms/objects/{objectId}/contents/renditions/text—returns the full-text rendition of an already uploaded content of a DMS object (objectId). You are able to render native files into plain text (extraction).
Document Lifecycle Management
Overwriting Property Attribute 'required'
Any property definition in the schema needs the specification of the required
attribute. Its boolean value decides if the corresponding property is mandatory (true
) or optional (false
) for an object. However, the value of the required
attribute can be overwritten by a propertyReference
in object type definitions.
>> Schema - Defining Object Types | Overwriting the 'required' Property Attribute
Schema - Defining Object Types
Attribute 'contentStreamAllowed' in secondary object type definitions
The contentStreamAllowed
attribute is required in document object type definitions. It specifies whether objects of this type must, must not, or may have content. As of product version 2.3, the attribute is available also for secondary object type definitions and thus can substantiate the value of the contentStreamAllowed
attribute in a document object type definition that references the corresponding secondary object type.
>> Secondary Object Type Definitions
yuuvis® Momentum Services
Outsourcing Passwords from Profiles as Kubernetes Secrets
Passwords can be outsourced from profile files as Kubernetes Secrets. In the configuration file, placeholders are included instead that are replaced by the actual passwords during the runtime of the Kubernetes pod. Kubernetes Secrets let you store and manage sensitive information like passwords externally. Storing this confidential information in a Kubernetes Secret is more flexible than handling it in an internal yuuvis® profile.
>> Configuration of Microservices using Profiles
Functional Extensions - Server side
New System Hooks
Webhooks and AMQP hooks belong to the system hooks—functions that apply to core functions of the yuuvis® Momentum API whenever certain conditions are met and that extend or modify those functions. As such, they serve as a modular, external approach for introducing new functionalities as extensions of already existing ones. The triggering conditions can be defined in the system hook configuration. Check out our newly available system hooks for your project-specific use cases:
- AMQP hook dms.response.update
triggered by object update events and tag operations, provides the properties of the corresponding object - AMQP hook dms.response.delete
triggered by object deletion events, provides the properties of the corresponding object - Webhook dms.response.delete
triggered directly after a successful deletion of a document and after the equivalent AMQP hook
(OKTO-4407 | OKTO-4408 | OKTO-4409)
Functional Extensions - Client side
yuuvis® client as reference implementation
Secondary object types (static | floating | primary)
With product version 2020 Summer (Summer 2020) we have introduced so called floating secondary object types ("dynamic") into our core system in addition to static ones. They are supported by our yuuvis® client.
To be able to use floating secondary object types please read the Breaking Changes for product version 2.3 (Autumn 2020).
- Creating new document objects with preview
With the help of primary floating secondary object types, it is possible to create objects with a files and showing their preview next to the metadata form.
>> Configurations for Creating Objects While Seeing a Preview
(COOL-12499 | COOL-12637 | COOL-12740 | COOL-12743 | COOL-12741 | COOL-12898 | COOL-12960 | COOL-12958 | COOL-13110 | COOL-13150 | COOL-13175 | COOL-13176 | COOL-12938 | COOL-13078 | COOL-13389 | COOL-12726 | COOL-12738 | COOL-12739 | COOL-12765 | COOL-12802) - Applying and removing metadata extensions
It is possible to apply additional object characteristics like e-mail fields or address fields if needed (non-primary/-required floating secondary object types). From a technical point of view, floating secondary object types are applied to or removed from the object instance at any time during a document's lifecycle and as long as it is not archived.
(COOL-12771) - Form modelling
It is possible to model a custom form for a floating secondary object type with theappClient:primary
classification tag as well. In this case, all fields can be used in the custom form model that is part of the object type the floating secondary object type is referenced of and that is part of the also referenced floating secondary object type with theappClient:required
classification. A custom form for an also referenced floating secondary object type that can be extended (= without classification) can be modeled as well.
Form modeling & scripting using yuuvis® architect
Forms can be modeled with the help of our new yuuvis® architect tool. They can contain a script to manipulate field values or to validate the entered values.
>> yuuvis® architect
(COOL-12429 | COOL-12413 | COOL-12638 | COOL-12566)
References
Objects can easily be referenced by users, if the system administrator provides string fields of the id:reference[<list of object types>]
classification. This type of field offers a list of found objects while typing characters and if an entry is selected by the user its title is shown in a chip. A simple click on the chip opens the referenced object for information or further activities. A list of objects that reference the current object can be called via a custom action.
>> "Defining Object Types for yuuvis® client#ConfigurationsforSpecificFormFieldBehaviors"
(COOL-12998 | COOL-12783 | COOL-13217)
Follow-ups
Each user can create, change, and remove a follow-up time for an object to initiate further actions later on. Created follow-ups can be viewed in the user's 'My processes' list and the reminders about follow-ups which are due are listed in the 'Inbox'. This feature is the first step into the business process management world using our integration with Flowable (open-source workflow engine).
(COOL-12653 | COOL-12658 | COOL-12960 | COOL-13308)
Filters
For the hit list view as well as for the object view flexible filter options are provided so that users can adjust the system to their personal preferences. To keep rtack of everything and get fast access to frenquently used objects, each user can configure filters using the new panel. From creating individual filters over hiding standard ones up to combining various filters with AND and OR operators—anything is possible.
(COOL-11836 | COOL-12544 | COOL-12666 | COOL-12486 | COOL-12513)
Custom object type icons
System administrators can configure custom icons for objects types on system and tenant level.
>>Defining Object Types for yuuvis® client, "Managing Icons"
(COOL-10062)
Saving configurations as default
Users with the 'YUUVIS_MANAGE_SETTINGS' role can save their current filter and column settings as default. New users automatically have these default settings and can—after further modifications—reset to the default settings if wanted.
>> "Role Administration" tutorial
(COOL-13045)
Clearing the application cache
Some settings are stored locally in the cache of the used browser:
- layout (column width and area widths),
- system data (configuration) and
- historical data (last seen and last applied filters).
In the "Settings" area users can decide individually for each part of the cache which one should be cleared when clicking the "Clear application cache" button.
Business Process Management Integration
yuuvis® Momentum is a powerful document management system (DMS) that can with ease handle hundreds of millions of documents, of numerous types, spread over multiple tenants and used by hundreds or thousands of users. In order to efficiently adopt and enforce your business rules, a considerable automation is necessary to support your users who work on the documents. For that reason we integrated the business process management engine from Flowable (open-source workflow engine) into yuuvis® to provide workflow functionality.
yuuvis® stores and manages your documents and the engine implements all business rules that define how they are processed - automation as well as a great opportunity to document your business rules. Flowable executes business processes described in BPMN 2.0 (Business Process Model and Notation) which is a graphical representation based on a flowcharting technique.
The following microservices provide all functionality, integration options and management features needed:
- BPM-ENGINE - Flowable based business process management engine including an identity management connector to Keycloak for accessing users and their roles
- BPM-ADMIN-UI - Administration console to manage models, processes, tasks, and jobs
- (as of product version 2020 Winter - BPM-MODELER-UI - Modeler for creation, editing and deploying workflow models)
Check out our yuuvis® Client we offer as reference implementation where the process of controlling follow-ups is implemented as one possible example.
>> Business Process Management (BPM) Engine
(ERA-7420 | ERA-7421 | ERA-7450 | ERA-7526)
Tooling
yuuvis® architect
Our new yuuvis® architect makes you much more effective in modeling CREATE and EDIT forms with its scripts that are offered in the client to edit metadata.
Audit Trail Cleanup via Commander Service
There are many different actions that trigger the creation of a new entry in the respective object's audit trail. In order to avoid an accumulation of too many audit trail entries, a deletion is now possible via the Commander service. This tool for yuuvis® allows you as a DevOp to perform low-level maintenance on your core system.
>> Audit Trail - an "Object's History" | audit-cleanup Command | COMMANDER Service for System Maintenance
Changelog
Bugfixes
Hotfixes
Below you will find information about the provided hotfixes. The latest status about the atrefacts can be bound here: "Version Tags Services".