Difference between revisions of "Documents (Client)"
| Line 33: | Line 33: | ||
=== Viewing/Editing the Object Data === | === Viewing/Editing the Object Data === | ||
| − | Not only the file, but also the {{UBIK}} property values of a document object | + | Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. To access them, click on the document object. |
| − | To | + | |
| − | + | The way properties are displayed depends on the client being used. | |
| + | |||
| + | On the '''WinX''' client, the properties are shown directly on the right side of the screen. | ||
| + | |||
| + | On the '''MAUI''' client, you need to switch to the Properties tab to view them. | ||
== Creating Documents == | == Creating Documents == | ||
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects. | Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects. | ||
| − | + | Via the context menu entry you can create such documents. (where it is configured) | |
| − | + | ||
| − | + | ||
{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}} | {{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}} | ||
| Line 59: | Line 61: | ||
=== File upload === | === File upload === | ||
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size. | Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Synchronization === | === Synchronization === | ||
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server. | Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Modify Documents == | == Modify Documents == | ||
| Line 82: | Line 72: | ||
=== Redlining === | === Redlining === | ||
| − | Redlining is the process of creating a | + | Redlining is the process of creating a modified or annotated version of an existing document. |
| − | + | ||
| − | + | To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document. | |
| − | + | ||
| + | After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, adjusting opacity, and selecting different colors | ||
The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}} | The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}} | ||
{{Clear}} | {{Clear}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==== Editing an already downloaded file ==== | ==== Editing an already downloaded file ==== | ||
Revision as of 07:08, 10 March 2026
Documents are UBIK® objects referencing a file, e.g. a PDF document. Like other UBIK® objects, they can be synchronized to the UBIK® Client. UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...)
Contents
Document Types
- Managed Document - Documents with a locally managed file.
- Linked Document - Documents with a file linked by an URL, not locally managed by UBIK®.
Viewing Documents
Documents can be viewed from any location where a Documents tab is available.
Documents are displayed with a thumbnail preview.
WinX
MAUI (iOS)
On WinX, the display mode for documents can be configured.
Available display modes (WinX only):
- Gallery View (default)
- List View
- Flip View
Clicking on a document navigates to the corresponding object and opens the internal document viewer.
WinX
MAUI (iOS)
Viewing/Editing the Object Data
Not only the file itself can be viewed, but also the UBIK® property values of a document object. To access them, click on the document object.
The way properties are displayed depends on the client being used.
On the WinX client, the properties are shown directly on the right side of the screen.
On the MAUI client, you need to switch to the Properties tab to view them.
Creating Documents
Depending on the configuration of the UBIK® data model and the ACM, documents can be created as children for existing objects. Via the context menu entry you can create such documents. (where it is configured)
 | File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive. |
Taking a Picture
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.
Editing and Submitting the newly created Document
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.
uploaded Document objects can potentially contain detailed Information concerning the original file (e.g. file name, path)
File upload
Regarding the file upload, there is a mechanism FileUploadRestriction that ensures files only get uploaded if the file size is below the configured max upload size.
Synchronization
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.
Modify Documents
For editing, Redlining and actually changing ManagedDocuments (where changing is allowed) is possible.
Redlining
Redlining is the process of creating a modified or annotated version of an existing document.
To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.
After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, adjusting opacity, and selecting different colors
The previous redlining number indicators are replaced by the child document indicators.
Editing an already downloaded file
If the file was already downloaded, the user is asked to choose any installed 3rd party application for editing the respective file. In case no such app is installed, editing the document is not possible.
| The 3rd party app used for editing the file must be able to return the resulting file (in contrast to store it on the file system without telling UBIK®)! A recommended app fitting this requirement is the [Photo Editor by Aviary]. |
When the editing was finished, the new file is marked as changed and will be committed automatically if Automatic Sync mode is active, else the user can commit manually.
Editing a not yet downloaded file
When a file wasn't downloaded yet but editing was chosen nontheless, the UBIK® Android client will automatically download the file. After the download was finished, the user is asked if (s)he wants to edit the document now. If so, the editing proceeds as described for an already downloaded file.
PDF Documents
PDF Renderers
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
- The standard Syncfusion renderer which uses Windows.Data.PDF
- PDFium
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the PdfRenderer setting in the WinX client and see if the issue still persists.
 | Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option. |
Syncfusion
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.
PDFium
- This renderer currently does not support digital signatures (e.g. created by Docusign) unless they are flattened into the PDF documents.
- With this renderer selected, some documents in the Flip View might appear blank when zooming.
PDF Text Search
It is possible to search and highlight arbitrary texts in the UBIK PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results.
Automatic Text Search
Using the Document Highlighting Classification A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.
Remember Document Settings
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a UBIK® session. It can be configured in the Settings. With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.
If a document is configured with the Auto Zoom classification, it will be overruled by the user's value as soon as the user sets it. If an AnnotationDefaultStrokeWidth value is configured, it will be overridden by the user's value as soon as the user sets it.
| Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually. |
The SaveZoomSettingsCommand can be applied to a button as follows:
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
See also
- Create a new Document (UBIK Android)
- Make a Document ready for Redlining
- SYSCLS DOCUMENT (Classification)
- SYSCLS FILEDOCUMENT (Classification)
- SYSCLS EDITABLEDOCUMENT (Classification)
- SYSCLS REDLINEDFILE (Classification)
- SYSCLS DOCUMENT HIGHLIGHTING CLASSIFICATION (Classification)
- SYSCLS URLDOCUMENT (Classification)
- SYSCLS THUMBNAILEDDOCUMENT (Classification)
- SYSCLS TEXTDOCUMENT (Classification)
- SYSCLS OFFLINE AVAILABLE DOCUMENT (Classification)
