[[Category:UBIK ClientDOCUMENT|Documents]] are [[Document:Category:UBIK Object|Documents]] are {{UBIK}} [[UBIK Object|objects]] referencing a file, e.g. a PDF document.Like other {{UBIK}} objects, they can be synchronized to the [[{{UBIK Android]] clientClient}}.
The Android client provides various features related to documents.
== Document Types in {{UBIK}} Android ==
* 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 in {{UBIK}} Android ==
=== Viewing the File ===
[[File:UI_TechSpec_UBIKClient_Document_01.png|thumb|170px|border|alt=Content Browser|Content Browser]][[File:UI_TechSpec_UBIKClient_Document_02.png|thumb|170px|border|alt=Object List|Object List]] Documents can be viewed using the [[Content Browser (UBIK Android)UBIK_Client_Basics#Content_Browser|Content Browser]].Please also refer to the screenshots on the right.
For every object, three content tabs are shown: "Children", "Properties" and "Documents".
The latter contains a thumbnail grid view for all document-type children of the current object.
[[File:UI_TechSpec_UBIKClient_Document_03.png|thumb|170px|border|alt=Thumbnail grid|Thumbnail grid]] A click on such a thumbnail shows the document if it was already downloaded.Else, otherwise the document will be downloaded from the server and a dialog for showing it will be shown on success. [[File:UI_TechSpec_UBIKClient_Document_04.png|thumb]]
3rd party applications are used to show documents. Therefore, if no viewer for a certain file type (e.g. PDF) is installed, an error message will be shown.
[[<gallery widths="200" heights="200">File:UI_TechSpec_UBIKClient_Document_01.png|Content BrowserFile:UI_TechSpec_UBIKClient_Document_02.png|Object ListFile:UI_TechSpec_UBIKClient_Document_03.png|Thumbnail gridFile:UI_TechSpec_UBIKClient_Document_04.png|Download documentFile:UI_TechSpec_UBIKClient_Document_05.png|thumb]]Open document</gallery>
=== Viewing the Object Data ===
Then, the property list view for the respective object will be opened, allowing the user to change values (if it was configured on the server).
== Creating Documents in {{UBIK}} Android ==
Depending on the server configurationof the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.A context menu entry appears in the [[Content Browser (UBIK Android)UBIK_Client_Basics#Content_Browser|Content Browser]] for creating objects if this is configured. Find detailed information how to create a new document on the client [[HowTo:Create_a_new_Document_(UBIK_Android)|here]].
=== Taking a Picture ===
=== 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 property view, allowing the user to abort the creation or to enter specific property values (e.g. for the name description of the object) and finally save the object. {{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path){{Clear}}
=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.
== Editing Modify Documents in {{UBIK}} Android ==
For editing, currently only [[Redlining (UBIK Android)HowTo:Make_a_Document_ready_for_Redlining|Redlining]] and actually changing [[ManagedDocuments]] (where changing is allowed) is possible.
=== Redlining ===
Redlining is the process of creating a new, adapted version of an existing document.This can be achieved on the {{UBIK}} Android client, if it was has been configured correctly on in the server{{UBIK}} data model and ACM.A respective context menu button will be available in the ''Content Browser '' for a document object in this case.
For redlining, a copy of the document will be created and opened for editing in any installed 3rd party application that can handle the "intent".
When the user accepts the change, the creation of a new document object classified as a redlined document will be triggered (as described in "Creating Documents in {{UBIK}} Android").
The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}
{{Clear}}
=== Editing Documents ===
In order to edit a document managed by {{UBIK}}, one has to access the Document object by long-clicking its thumbnail in the documents-tab of its parent object's ''Content Browser''.
Then, the ''Content Browser'' for the Document object provides an "Edit File" action item in the context aware action bar. {{Version/AndroidSince|2.4.5}}
<gallery widths="200" heights="200">
File:UI_TechSpec_UBIKClient_Document_01.png|Content Browser
File:UI_TechSpec_UBIKClient_Document_02.png|Object List
File:UI_TechSpec_UBIKClient_Document_03.png|Thumbnail grid
File:UI_TechSpec_UBIKClient_Document_Properties.png|Document in Content Browser
</gallery>
==== Editing an already downloaded file ====
[[File:UI_TechSpec_UBIKClient_ChooseAppForEditing.png|thumb|Choosing a 3rd party application for editing]]
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.
{{Attention|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 [[https://play.google.com/store/apps/details?id=com.aviary.android.feather 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 ====
[[File:UI_TechSpec_UBIKClient_EditDownloadedFile.png|thumb|Notification for editing a 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.
{{Clear}}
== PDF Documents ==
=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
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 [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.
{{Hint|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 [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.
[[Category:Android|Documents (UBIK Android)]]
[[Category:Document|Documents (UBIK Android)]]
=== 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. {{Version/XamarinSince|4.3.0}}
==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|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 {{Version/WinXSince|4.9}} ===
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#Content|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 [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.
{{Attention|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:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>
[[Category:Android|Documents (UBIK Android)]]
[[Category:Document|Documents (UBIK Android)]]
== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo: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)
[[Category:Android|Documents (UBIK Android)]]
[[Category:Document|Documents (UBIK Android)]]