Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idPROGRESS

Product Version2022 Spring
Report Note
AssigneeAntje

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje11 JAN 20222022 Springcreated for new structure of client documentation

Applying Filters

To get a better overview in object lists, you can apply one or more filters to an object list at the same time. To do this, click the checkboxes after the filters you want to use in the filter area. The result will appear in the object list immediately. You can remove the filters by unchecking the checkboxes.

Clicking a group name in the filter area, will select or disable all filters in this group.

...

yuuvis® Momentum client as reference implementation is an Angular application that is structured in multiple components. Each of them implements a specific area of the client application using the functionality provided by the components of the developer libraries.

In the header area, you will find the yuuvis® Momentum bar with icons for the most frequently used features, such as the Main menu icon, the Settings menu icon, the Create object icon, and the yuuvis® icon. .

Main menu iconImage Added

Main menu

yuuvis iconImage Added

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 iconImage Added

Create object

Search iconImage Added

Search (not displayed in case of the Dashboard view)

Settings menu iconImage Added

Settings menu

Dashboard

In the middle of the dashboard, you will find the multi-part search input field.
>> Searching and Finding

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, which you can also sort, filter, and configure..

Menus

...

Main Menu

You can access the main menu using the Main menu icon on the yuuvis® Momentum bar. You can access the following areas via the main menu:

  • Dashboard

  • Create object

  • In-tray

  • Inbox

  • My follow-ups

  • My processes
  • Settings

  • About yuuvis® client

...

Filter Configuration Menu

The filter configuration menu provides a graphical interface to configure your filters. It is accessible via the filter area in the hit list view or via the Settings menu. All users can configure user-defined filters that are only available to themselves.

...

You can also delete filters you have created and saved. Default filters cannot be deleted.

...

Object Actions Menu

Various actions are available for editing documents and folders . You can find these actions in the Object actions menu. The object actions menu offers you a different selection of actionsvia this menu, depending on the context and your permissions. The objects actions menu It is available for you in different areas in yuuvis® Momentum client, such as in hit lists, in the folder view, and in the object view, via the Actions menu iconImage AddedObject actions icon.

The suggested actions and processes always refer to the selected object(s). If you select several objects in an object list (such as in a hit list) and then click the Object actions icon in the area window of the object list, you can apply an action or a process to several objects.

Replace document file iconImage Modified

Add as new version

Adds a document file to the marked object in a hit list or in a folder view (see Adding Documents). Adding a document file automatically creates a new document version.

Copy to clipboard iconImage Modified

Copy to clipboard

Copies links from one or more selected objects to your operating system's clipboard (see Copying Objects).

Delete iconImage Modified

Delete

Deletes the selected object (see Deleting Objects). Deleted items cannot be restored.

Download document file iconImage Modified

Download document file

Downloads the document file of one or more selected objects to the local file system in the original format (see Downloading Document Files).

Follow-up iconImage Modified

Manage follow-up

Creates follow-ups for a selected object or opens the dialog for modifying, deleting or confirming follow-ups (see Following Up Documents).

Move iconImage Modified

Move

Moves one or more documents to another filing location. For example, from the main directory to a folder, from one folder to another, or from one folder back to the main directory (see Moving Document Files).

Open in context iconImage Modified

Open in the folder/Open

Opens the selected object’s folder view of the filing location (see The Folder View). The object view will be opened for document files that are filed in the main directory (in the top layer in the yuuvis® Momentum filing system) of yuuvis® Momentum (see Object View and Object Area).

Show references iconImage Modified

Show references

Displays an overview of the objects that reference the selected object (see References).

Versions iconImage Modified

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).

...

Settings Menu

Use the settings menu to configure Configure the main settings of your yuuvis® Momentum client. Open the settings menu by clicking the Settings menu in the yuuvis® Momentum icon bar and select Settings from the dropdown menu. Alternatively, you can also open the settings menu via the Main menu.

The following information and configuration settings are available in the settings menu:

  • 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 drop-down menu Roles indicates the roles that are assigned to the currently logged in user.
  • Layout
    In the Layout settings area, you can customize 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, 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.

    • Export, Import and Reset
      You can also use the layout settings for 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

    in your yuuvis® Momentum client
    • .

  • Configuration
    Edit Hit listsSearch filters and Cache.

Object Views

Object Aspects

Objects in 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.

The header area contains a title and description (if available) and the following icons:


Visualizes the object type.

Refresh the object aspects.

Object action menu.

The layout of the object areas can be customized as described here.

...

titleopen...

...

You can show an aspect area that had been hidden in the background by clicking an aspect title bar.

...

. If you have changed the number and the width of the aspect areas, these changes will be saved automatically when you switch views.

Split aspect iconImage Added

Split aspect. The view splits and several aspect areas are displayed next to each other.

...

You can use the separator bar between the aspect areas to adjust the size of the displayed areas.

...

Undock

Only available for the Content aspect. Open the content preview in a separate browser window

...

.

...

Click the Close iconImage Removed Close icon in the undocked content preview to close the standalone content preview window.

...

If you click the Close iconImage Removed Close icon in an aspect area, the aspect area will revert back to normal.

Close iconImage Added

The aspect area will revert back to normal.

The following object aspects are available.

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, and Administrative information.

If more than one version of a document exists, you can also click the highlighted version number to access the version view. Here, you can compare the versions of an object with one another (see Object Versions).

Metadata aspect area

The Metadata aspect area offers the option of editing the type metadata of the selected object (see Editing Metadata), provided that you have the appropriate rights.

History aspect area

The editing history of the selected object is shown in the History aspect area . It displays, for instance, what changes were made to an object, at what time, and by which user or the system. You 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, for example, 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 the aspect area. You can filter the events of the editing history, if needed (see Filtering the History). 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 (see Object Versions).

...

.

...

The

...

History entries that log changes to type metadata or the content of objects contain links to the corresponding object versions. Clicking a link opens the version view, in which you can track the changes made to the object in detail (see Object Versions).

The entries in the history can be filtered by clicking the Search iconImage Removed Search icon in the aspect area. You can configure the following settings in the filter menu that opens:

  • Limit date

    In the header area, you can use operators (>, <, =, -) and date fields to limit the history filter to a specific time period.

  • Limit history entries

    The history filter displays a table that allows you to use checkboxes to limit the filter to the following history entries:

...

entries in the history can be filtered by

  • limiting the date to a time period using the operators (>, <, =, -) or
  • specifying a type of action via the checkboxes. Clicking a group name will select all history

...

  • entries of this group.

Content aspect area

The Content aspect area offers a content preview of the selected document. Different content previews are used depending on the file type of a document file (see The Content Preview). 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.

Expand
titleopen...


FormatMime typeComment
Audiompeg, mp3, ogg, wavAudio files are played by the browser with HTML5 audio by default. All played files are streamed to avoid unnecessary data downloads.
E-mailsmessage/rfc822 (eml)emlfiles are analyzed by MailParser. Unsupported file types are offered for download.
Imagejpeg, gif, png, svg, bmp, icoCustom Angular application with Angular-X image viewer plug-in. Supported mime types are rendered by the browser in the default HTML tag img by default. Unsupported file types are offered for download.
JSONapplication/jsonCustom Angular application with ngx-json-viewer plug-in.
Markdownx-web-markdown, markdownCustom application with markdown-to-JSX plug-in and custom angular application with showdown plug-in.
Open Officeodt (texts), ods (tables), odp (presentations)Files are analyzed and rendered from https://webodf.org/. The ODFs are currently resolved as application/zip. The viewer also analyzes the mime types and reacts to the file extension that must be specified.
PDFapplication/pdfPDF.js - JavaScript-based PDF viewer from Mozilla. PDF.js support is also supported by the yuuvis® API
TextplainPlain text is rendered by the browser by default.
Videompeg, mp4, ogg, webmVideo files are played by the browser with HTML5 video by default. All played files are streamed to avoid unnecessary data downloads.
XMLxmlXML is rendered as text by the browser by default.


The Version View

If type metadata is modified in an object in yuuvis® Momentum client  or the document 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.

There are a number of ways to open the version view:

  • Via the  Actions menu iconImage Removed Object actions menu, if the selected document has more than one version

  • In the object area via the link on the version number in the Summary aspect area.Via the links on the version numbers in the History aspect area.

The version view shows a list of all versions. If two versions are selected in the list, you can compare the content or type metadata of the selected versions in the object area of the version view:

  • The Changes to metadata tab in the object area shows you which type metadata has been changed.

  • The Changes to content tab in the object area offers you a visual comparison of both versions.

Comparing Versions

If you select two versions in the version list, the changes between these two versions are displayed in the object area. If you click the Changes to metadata tab, you will see the changes in the type metadata. If you click the Changes to content tab, you will see a visual comparison of the selected versions. You have a number of action available in the visual comparison:

...

  • Via the links on the version numbers in the History aspect area.

The version view shows a list of all versions. Select a version to display its version-specific object information in Object aspect areas 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. If you move your mouse over the slider, a drop-down menu will offer you more comparison options.

...

Slider iconImage Modified
Drag the slider left and right to resize the images.
Slider iconImage Modified
Displays both images instantly.
Slider iconImage Modified
Layers both images on top of each other so that you can use the sliders to display one image and then the other.
Slider iconImage Modified
Only displayed when both images are superimposed. Clicking the icon reverts
the view back to normal.

Creating Objects

...

the view back to normal.

Creating Objects

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 the yuuvis® Momentum filing system in  in a short space of time that you do not want to complete until later.

Creating Documents

...

The following options are available for you to create documents in yuuvis® Momentum client:

  • Create documents via the Create icon Create object icon on the yuuvis® Momentum bar

  • Create documents via the Create object entry in the main menu

  • Create document files via drag and drop

...

If you did not open a folder when you created a document, for example, on the dashboard, in hit lists, in an open object view (see Object View and Object Area), the document does not have a parent object.

Documents with Content and Documents with no Content

There are numerous document types in yuuvis® Momentum that can differ significantly from each other in their function and properties. The document types are configured administratively.object.

Documents with Content and Documents with no Content

You can find out which document types are available in your yuuvis® Momentum system by opening the Create object creation menu. Open the Create object menu by clicking the Create icon Create object icon or the Create object entry in the main menu, or by dragging and dropping one or more files onto the  yuuvis® Momentum client desktopDashboard.

One of the basic properties of the document types in the Create object menu is that they may or may not contain a binary content file.
>> Schema - Defining Object Types

Simple and Variable Object Types

A distinction is also made in yuuvis® Momentum between the following object types, particularly with regard to the creation process:

...

Upload Status

If you upload files to the yuuvis® Momentum filing system, this is indicated by the  Upload status icon in the yuuvis® Momentum bar. Click the icon to view the names and status of the files uploaded in a menu. A green tick behind an entry indicates that the upload process was successful. Click the Remove icon to remove entries from the list to get a better overview. The  Upload status icon will no longer be displayed once all of the entries have been removed from the list.

...

You will need to keep a few things in mind when filing e-mails directly from an e-mail program via drag and drop. Whether or not drag-and-drop filing of e-mails from an e-mail program directly into yuuvis® Momentum client is possible depends on the e-mail program and the browser you are using. For example, the drag-and-drop filing of e-mails from Microsoft Outlook is supported in yuuvis® Momentum client if yuuvis® Momentum client is running in a Google Chrome browser. In this case, the e-mail is filed in yuuvis® Momentum in the same file format (*.msg) in which it is transferred from Microsoft Outlook. Filing an e-mail in the *.msgMSG file format has one distinct disadvantage in that the content preview will differ slightly from the filed e-mail (see The Content Preview).

If you are working with a different browser, say Firefox for example, and would like to file e-mails via drag and drop, then it is best to use the Outlook Add-In for Drag & Drop from OPTIMAL SYSTEMS. It enables drag-and-drop filing, ensuring that e-mails that are dropped onto yuuvis® Momentum client are transferred as *.emlEML files so that the content preview generates a more accurate view of the filed e-mail. If you are interested in this add-in, please contact your partner at OPTIMAL SYSTEMS.

...

If you want to cancel the creation process and leave the form, click an icon on the yuuvis® Momentum bar.

Editing Objects

Assigning Final Object Types

...

If you want to add the document file of another yuuvis® Momentum object to an yuuvis® Momentum object, then  then you will need to first download this document file to your local file system using the object actions menu (see Downloading Document Files) before you can add it to another object as a document file again using the replace function in the object action menu or using drag and drop.

Editing

...

Metadata

...

You require the YUUVIS_CREATE_OBJECT role to be able to edit type metadata in yuuvis® Momentum client.

...

Only integers from -231 to 231-1 (i.e., from -2,147,483,648 to 2,147,483,647) may be entered in the metadata form. Entries that fall outside this range will cause rounding or other errors.

Metadata Form Fields

FieldProperty
Catalog fields

Catalog entry. Selection from a suggestion list after one character has been entered or via the catalog. For hierarchical catalogs with entries in layers, the administrator configures whether the entries for all layers are accepted or only the entry for the lowest layer. Free inputs are not accepted.

Catalog values marked in red are catalog values that can no longer be assigned to a catalog entry due to adjustments made to the catalog (see Editing Catalogs in Metadata Forms). Click on the red  Remove icon to delete it.

CheckboxesCheckboxes have either the status 'active' or 'not active'. On an administrative level, the additional status 'neutral' can also be integrated.
Date fields

Date. Free input or via the Calendar iconImage Modified Calendar icon.

The format of the date varies based on the user’s language settings. If you click in a date field, the date format to be entered will be displayed.

German: DD.MM.YYYY

English: MM/DD/YYYY

E-mail fields

E-mail addresses must be entered in full and contain the  at character. Placeholders and so on are not supported. E-mail addresses are not case sensitive. To enter multiple e-mail addresses, press Enter to confirm your entry.

Sample entry: employee@optimal-systems.de.

Click the E-mail iconImage Modified E-mail icon to create an e-mail with this address in the local e-mail application.

ID fields

User or group. Selection from a suggestion list after two characters have been entered.

Free inputs are not accepted.

Mandatory fieldsMandatory fields must be completed, which is why they are indicated by an asterisk.
Numerical fieldsDigits. The maximum number of digits and decimal places is defined.
Tables

Entry via a dialog. New rows are added at the bottom. Double-clicking a row opens the dialog for editing or deleting the row. The content of metadata tables can be exported as a *.CSV file.

Telephone fields

To enter multiple telephone numbers, press Enter to confirm your entry.

URL fields

Addresses in URL fields must begin with the protocol information, e.g., http://, https://. Web addresses must be entered in full. Placeholders and so on are not supported. Web addresses are not case sensitive. To enter multiple web addresses, press Enter to confirm your entry.

Sample entry: http://www.optimal-systems.de.

The URL can be opened in the browser by clicking the www iconImage Modified www icon.

Tables in Metadata Forms

The following customization options and functions are available for tables in metadata forms:

...

Catalogs that can be edited are indicated by a Pencil icon. If you click on this type of icon, an edit menu opens for the catalog in which the following features are available.

Expand
titleopen...


IconDescription of the feature
Input field iconImage Modified
You can create new catalog entries using the entry field in the header area of the edit menu.
Remove iconImage Modified
Delete a catalog entry by clicking the remove icon.
Checkbox inactive iconImage Modified / Checkbox active iconImage Modified
This checkbox allows you to control whether a catalog entry is displayed in the metadata form or not.
Sort feature iconImage Modified
If you click this icon, you can drag and drop the line of the catalog entry to where you want it to be in the list of catalog entries.


If you delete a catalog entry in the catalog edit menu, the catalog values cannot then be deleted in the metadata forms. Catalog values orphaned by deletion are marked red in the metadata form and by a red Remove icon.

...

Info
iconfalse

Read on

Section


Column
width25%

Another Tutorial

Brief summary of the article linked.


Column
width25%

Another Concept Article

Brief summary of the article linked.


Column
width25%

Another interesting Tutorial

Brief summary of the article linked.