| Page Properties | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Resources & Remarks
Modification History
|
| Excerpt |
|---|
An overview of the features provided by yuuvis® Momentum client as reference implementation to demonstrate the usage of the developer libraries. |
...
| Main menu |
| If you left-click the yuuvis® icon while pressing Ctrl, a new tab will open with another dashboard in your browser. If you left-click the yuuvis® icon in the hit list, folder, or object view, the dashboard will appear again. |
| Create object |
| Search (not displayed in the Dashboard view) |
| Settings menu |
Dashboard
In the middle of the dashboard, you will find the multi-part search input field.
In the footer area, the objects that you recently created or edited are displayed in the form of a tile row. Click the Recently created or Recently edited buttons below the tile row to select which objects you want to view. If you click the More... button to the right of the objects listed in the footer area, the listed objects are displayed in a hit list.
Navigation by Keyboard
To make all functions and actions in yuuvis® Momentum client as reference application easily accessible, most of the commands can be called without using a mouse. To navigate through the application by keyboard, open the Quick access command palette at any time by pressing the Ctrl key twice. Then, start typing a string to find the command you are looking for.
...
Dashboard
Create object
In-tray
Inbox
My follow-ups
- My processes
Settings
About
...
- Retention management (as of 2022 Summer, only for users with specific authorization)
Settings
About
Object Actions Menu
Various actions are available for editing documents and folders via this menu, depending on the context and your permissions. It is available in different areas, such as in hit lists, in the folder view, and in the object view, via the 
Object actions icon.
>> ActionMenuComponent
The suggested actions and processes always refer to the selected object(s). If you select several objects in an object list (such as a hit list) and then click the Object actions icon in the object list area, you can apply an action or a process to several objects.
 | Add as new version Adds a document file to the selected object in a hit list or in a folder view. Adding a document file automatically creates a new document version. | |
 | Copy to clipboard Copies links from one or more selected objects to your operating system's clipboard. | |
 | Delete Deletes the selected object. Deleted items cannot be restored. | |
 | Download document file Downloads the document file of one or more selected objects to the local file system in the original format. | |
 | Manage follow-up Creates follow-ups for a selected object or opens the dialog for modifying, deleting or confirming follow-ups. | |
 | Move Changes the parent folder of an object. It is also possible to remove the current parent folder so that the object will no longer have any parent objects. | |
 | Open in the folder/Open Opens the selected object’s parent folder view. The object view will be opened for document files without a parent folder. | |
 | Show references Displays an overview of the objects that reference the selected object. | |
 | Show
| Set retention time (as of 2022 Summer) Only for users with specific authorization: Set an expiration date. Extend retention time (as of 2022 Summer) Only for users with specific authorization: Replace the expiration date by a later date. |
| Open in the folder/Open Opens the selected object’s parent folder view. The object view will be opened for document files without a parent folder. | |
| Show references Displays an overview of the objects that reference the selected object. | |
| Show versions Opens an overview of all versions of the selected object. You can select two versions in the version list to compare them side by side. The action is not offered if the selected object only has one version (see Object Versions). Set as current version This action is available when a Version view is displayed. |
...
- Language
You can use the English and German buttons to control the language display of the general user interface elements and the object types, menus, fields, and catalogs specifically configured for your company. - Permissions
The Roles dropdown menudisplays the roles that are assigned to the currently logged in user. - Layout
Customize the design of the client layout to your personal preference.Theme, Accent color and Dashboard background image
Choose between a light and a dark design/dark/high contrast design, set an accent color, and upload a background image. This setting is stored on your device, meaning you can work on different devices with different layouts.- Dashboard type (as of 2022 Winter)
Choose between the default dashboard layout and a customizable dashboard layout. Export, Import and Reset
You can also export the layout settings for use in other clients by clicking the Export button. Similarly, you can transfer the layout settings from other clients to yours by clicking the Import button. Click the Reset button to delete all of your individual layout settings.
- Configuration
Edit Hit lists, Search filters and Cache.
...
>> DynamicCatalogManagementComponent
Object Aspects
Objects contain various information that are displayed in units called object aspects. They are summarized in a form with a header area and multiple tabs containing the individual object aspects.
...
Summary Aspect Area
Displays the object properties (basic metadata, type metadata and tags) of an object, such as name, editor, number of versions, file size, etc. The information is divided into the areas Basic metadata, Type metadata, andAdvanced information.
If more than one version of a document exists, you can also click the highlighted version number to access the version view.
Metadata Aspect Area
The Metadata aspect area offers the option of editing the type metadata of the selected object, provided that you have the appropriate rights.
History Aspect Area
The History aspect area provides a view of the creation process as well as the editing and usage history of an object. It contains a chronological list of who made which changes to the content or type metadata of an object and when. The output (download and read) of an object is also logged in this aspect area. You can filter the events of the editing history, if needed. The entries in the history also contain links to the versions of the document. You can open the version view by clicking one of these links.
...
For users to be able to see READ events in the object history, i.e., whether an object was only viewed, they must be assigned the YUUVIS_MANAGE_SETTINGS role.
Content Aspect Area
The Content aspect area offers a content preview of the selected object. Different content previews are used depending on the file type of a the document file. If no file-specific preview is used, the document rendered to a PDF by yuuvis® Momentum is displayed in the PDF content preview by default. If a PDF cannot be rendered, nothing is displayed in the content preview., based on the VIEWER service or PDF rendition as described in Preview of Binary Content Files.
| Expand | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
|
The Version View
If type metadata is modified or the document content file is edited, replaced, moved, or deleted, then new versions of the object are created. The older versions are retained. All versions of an object can be managed in the version view.
>> VersionListComponent
...
The version view shows a list of all versions. Select a version to display its version-specific object information in the object aspect area as described above. If two versions are selected in the list, you can compare them in the tabs Changes to metadata and Changes to content where you have a number of actions available for a visual comparison.The slider in the center helps you find the differences
Note: If the content preview is provided as a PDF rendition, it is only available for the current version.
>> Preview of Binary Content Files
The slider in the center helps you find the differences. If you move your mouse over the slider, a dropdown menu will offer you more comparison options.
...
You require the YUUVIS_CREATE_OBJECT role to be able to create objects.
You can create objects (folders and documents) in stages. This procedure is especially useful if you create a lot of objects in a short period of time that you do not want to complete until later.
Creating Documents
The following options are available for you to create documents:
...
In-tray – Assigning Final Object Types
Variable The functionality is based on floating secondary object types are the starting point for this. You can assign those object types to incomplete objects to this object type after the creation process.
In the first step of the creation process, only a small amount of general type metadata is entered and the object is created. You can assign the final object type at a later point, depending on the configuration of the variable secondary object type.
All incomplete objects are listed in the Main menu in the in-tray. If you select want an object in the list of incomplete objects to be displayed in the in-tray, the object aspects will be displayed. You can see which additional options are available for the assign the appclient:dlm:prepare tag with value 0. Replace the value with 1 as soon as you are finished with the desired manual adjustments for the object. As the tag is specified in some object type definitions in the client's schema, it can be set via metadata form.
If you select an object in the list of incomplete objects in the in-tray, its object aspects will be displayed. You can see which additional options are available for the selected object by the buttons displayed in the Metadata aspect area:
...
If the Assign object type button is displayed in the Metadata aspect area, then you can assign an object type to the object. You can only assign an object type to an object once and this cannot be changed. After you have assigned an object type to an incomplete object, the Assign object type button will no longer be displayed and the object will be removed from the list of incomplete objects.
...
If a user does not have any rights to a referencing object, it will not be displayed for this user. If a user has read access to a referencing object, but not to the folder in which the object was filed, then the user is only offered the object view for the object.
Searching
...
Retention management
Only for users with specific authorization: The view is available as of 2022 Summer and provides a list of document objects with retention properties assigned to them, especially
- having any expiration date (All),
- having an expiration date within the next month (Next month) or
- having an expired expiration date (To be removed).
Note: The destruction date is displayed if specified, but is not evaluated.
Searching
You can start search requests on any page. The search dialog is available for this purpose on the dashboard and in the yuuvis® Momentum bar. The following options are available and can also be combined:
| A drop-down menu to the left of the search input field to limit your search to selected object types. |
| Search term | Full-text search for terms that you think might occur in the objects you are looking for. Searches the contents of document files as well as the string fields within metadata of objects. Note that number and date fields are not taken into account in the full-text search. |
| Define search conditions. Search for specific properties of objects, such as
The Filter panel in the Hit list view uses Select the property and specify the value by which you want to filter. For properties with resolved user IDs as values, a preview of available users is displayed after typing the first letters. To display all users, type **. The Filter panel in the Hit list view uses predefined filters. In addition, filter criteria can also be changed in the search field in the yuuvis® Momentum bar. These settings are not saved and are only available for the current session. |
| Run the search request. |
The search combines all search terms and all limitations on object properties and object types with AND by default. Object types are combined in the search with OR. In the search dialog, you can change the logical operator of multiple search terms or criteria to OR and/or create nested searches.
>> QuickSearchComponent
>> Search via Web-API Gateway
Hit List View
The results of a search are displayed in a hit list of all objects that were found. The hit list view is divided into the areas described below. You can sort, filter, and configure the hit list. Search results are sorted lexicographically. This means that sorting is case-sensitive and special characters are accounted for. Depending on the configuration, the hit list will contain several columns with basic metadata, type metadata, tags, such as type, title, description, editor, etc. The view of a hit list always corresponds to the hit list configuration of the selected object type.
Header Area
| Hit list configuration menu. You can add or remove columns via the Hit list configuration menu in the header of the hit list.Export the hit list with the displayed columns as CSV file. Datetime values will be formatted in ISO standard whereas decimals will be formatted corresponding to the localization of the logged-in user. Note: If you want to display the exported file in MS Excel, please use CSV import with UTF-8 encoding (or the configured encoding). |
| Hit list configuration menu. You can add or remove columns via the Hit list configuration menu in the header of the hit list. |
| Refresh the hit list. |
| Object actions menu. If multiple objects are selected, the action will be applied to all of them. |
...
Selected elements:
The row of selected elements is highlighted.
Multiple rows can be selected.
Focused elements:
- Only one element out of all selected elements can be focused.
- The icon is highlighted again at the beginning of the row.
- For focused elements, the object aspects are displayed in the object area.
You can use the mouse to select further elements by additionally holding down the Ctrlkey or the Shift key while clicking these elements. If you hold down the Shift key when clicking the mouse, all the rows between the row you have clicked and the row with the most recent focusing are selected, but the focus remains on the first row. If you hold down the Ctrl key when clicking the mouse, the row you have clicked is highlighted in addition to the existing selections. The focus still remains on the first row. When you position the cursor on another selected row and click the right mouse button, this row is focused.
...
Processes are created based on at least one object, which is stored as an attachment in the process. Each process contains tasks that must be completed by users.
There are three specific views that allow users to handle processes:
...
.
In the default configuration, users can start a follow-up process for an object via Manage follow-us provided by the object actions menu. If an administrator configures further types of business processes in addition to follow-up processes, they can be started for individual objects via the respective object action under MORE ACTIONS in the object actions menu.
Each process contains tasks that must be completed by users.
There are three specific views that allow users to handle processes:
- The Inbox view lists all tasks of processes the currently logged-in user is assigned to, such as reminder tasks for follow-up processes that have reached their follow-up date.
- The My processesfollow-ups view lists all processes except active follow-ups started by the logged-in user.
>> YuvBpmModule
Follow-up Processes
Those processes can be created for both folder and document objects. They act as processing reminders, for example. You can only create one follow-up for each object via the object actions menu. Once you have created a follow-up, it will be displayed in the My follow-ups view provided via the main menu until the due date of the follow-up is reached. Here you can edit or delete all active follow-ups (i.e., follow-ups for which time has not yet expired).
When the due date of a follow-up is reached, the object to be followed up is also displayed in the Inbox provided via the main menu. By confirming the follow-up, you can remove expired follow-ups from both the Inbox and the My follow-ups view.
Other Processes
If an administrator configures further types of business processes in addition to follow-up processes, they can be started for individual objects via the respective object action under MORE ACTIONS in the object actions menu. All active processes started by yourself are listed in My processes.
Inbox
The Inbox shows an overview of all the tasks a user is assigned to.The view of the Inbox can be toggled between a list view and a table view using the corresponding buttons at the bottom right.
In the Table view, the following columns are displayed: Type, Task, Subject, Received on and Due on. In the Type column, the 
icon represents tasks of custom processes and the 
icon represents follow-ups. The sort order can be changed by clicking on the header of the corresponding column. The position of columns can be rearranged within the table by drag and drop of individual columns. A red entry in the Due on column indicates that this task is overdue.
In the List view, Type (icon only), Subject and Task are displayed on the left-hand side, and the due date on the right-hand side. Sorting the inbox items or repositioning the information is not possible.
...
- up processes that you created via the object actions menu.
- The My processes view lists all processes started by the logged-in user.
>> YuvBpmModule
In the individual views, the process/task list can be sorted by individual columns as already described for hit lists. Furthermore, it is possible to filter by specifying a term that should be matched by the subject of each displayed process/task.
The number of displayed processes/tasks is limited to 100 in the individual views in the default configuration. The configuration can be customized by specifying other values in the main.json configuration file.
>> Customizing the Main Configuration
Inbox View
The Inbox shows an overview of all the tasks a user is assigned to. The view of the Inbox can be toggled between a list view and a table view using the corresponding buttons at the bottom right.
In the Table view, the following columns are displayed: Type, Task, Subject, Received on and Due on. In the Type column, the icon represents tasks of custom processes and the icon represents follow-ups. The sort order can be changed by clicking on the header of the corresponding column. The position of columns can be rearranged within the table by drag and drop of individual columns. A red entry in the Due on column indicates that this task is overdue.
In the List view, Type (icon only), Subject and Task are displayed on the left-hand side, and the due date on the right-hand side. Sorting the inbox items or repositioning the information is not possible.
Tasks can be opened for editing by clicking on the respective task in the Inbox view. On the right-hand side, the task details will open, in which you can edit the task. After editing, the task can be further processed using the buttons at the bottom of the task details.
...
In the Inbox, attachments can be added to the task or deleted from it while the process is running. Attachments are displayed in the Attachments task aspect in the task details for every task. The document highlighted in the accent color is the focused attachment for which object details are displayed. Note that the first attachment cannot be deletedfrom it while the process is running. Attachments are displayed in the Attachments task aspect in the task details for every task. The document highlighted in the accent color is the focused attachment for which object details are displayed. Note that the first attachment cannot be deleted.
My follow-ups View
Follow-up processes can be created for both folder and document objects. They act as processing reminders, for example. You can only create one follow-up for each object via the object actions menu. Once you have created a follow-up, it will be displayed in the My follow-ups view provided via the main menu until the due date of the follow-up is reached. Here you can edit or delete all active follow-ups (i.e., follow-ups for which time has not yet expired).
When the due date of a follow-up is reached, the object to be followed up is also displayed in the Inbox provided via the main menu. By confirming the follow-up, you can remove expired follow-ups from both the Inbox and the My follow-ups view.
My processes View
If you started a process, it appears in the My processes view. In addition to the filter option by a query term, the predefined filters All, Running and Completed are available.
By selecting a process in the task list, the users can open the process details view with the Summary, Progress, Comments and Attachments aspect areas.
Retention Management View
The Retention management view is accessible via the Main menu as of product version 2022 Winter LTS. A hit list view displays all objects with a system:rmExpirationDate property. The functional icons in the header area are already described for the hit list view.
The first column of the hit list contains a colored label that indicates whether the expiration date is already exceeded or not. A time is specified that tells users by how long the expiration date is already exceeded or how long it is until the expiration date is reached. If the time is longer than 12 months, it is indicated in years (e.g., 1.5 year(s) means one year and six months).
The predefined filters All, Next month and To be removed are available.
By clicking an object in the hit list, you open the object aspects for this object.
| Info | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
Read on
|
...