Changes

Settings

7,837 bytes added, 15 February

/* UWP/WinX/Xamarin */ Redesign Settings page

There are several categories of settings, each providing a group of configurable options for (a) specific feature(s).

{| class="wikitable" style="text-align: center; width: 30%; float:left; margin-left: auto; margin-right: 0px"

|+ Table Legend

! Symbol

! Meaning

| 🟢

|| Supported and accessible in the UI

| 🟡

|| Supported and accessible through [[UBIK_WinX_Client_Basics#Profiles|Profile]] xml

| 🟠

|| Not supported

| ⚪

|| Obsolete

<br/>

== General ==

This initial section in the Profile description contains some general settings.

{| class="wikitable" | width = "75100%"

! style="width:28%; text-align: left" | Name!! style="width:44%; text-align: left" | Purpose!! style="width:7%; text-align: center" | WinX!! style="width:7%; text-align: center" | Xamarin<br/>iOS!! style="width:7%; text-align: center" | Xamarin<br/>UWP!! style="width:7%; text-align: center" | Xamarin<br/>Android

| ''AutoBranchSync''|| Denotes whether the automatic branch download below an object will be synchronized automatically or not. It is set to "false" by default. '''This is now obsolete, see ~~Content~~ General Settings-> EnableAutoBranchDownload instead.'''(*) Refers to ''EnableAutoBranchDownload''. The Auto Branch Download can be set in the General Settings (UWP & Xamarin).|| 🟢*|| 🟢*|| 🟢*|| 🟢*

| ''AutoBranchSyncPeriod''|| Denotes the period for automatic branch synchronization in minutes. Its value is set to "0" by default, when the ''AutoBranchSync'' is set to false. '''Otherwise it should take an other figure. This is now obsolete, see ~~Content~~ General Settings-> EnableAutoBranchDownload instead.'''(*) Refers to ''EnableAutoBranchDownload''. The Auto Branch Download can be set in the General Settings (UWP & Xamarin).|| 🟢*|| 🟢*|| 🟢*|| 🟢*

| ''BranchDownloadSubLevels''|| Determines how a branch download is performed. If not configured (equals to '''0''' by default), an entire branch is downloaded in one attempt. If set to 1 for example, the 1st level children of the selected root is first analyzed, then sub branch downloads are performed for each of the children. Basically the higher the number, the more "fragmented" the branch download becomes. This usually increases the overall download time, but can be helpful for scenarios like really large branches or unstable networks since it has a better chance of finishing smaller individual downloads.|| 🟡|| 🟡|| 🟡|| 🟡

| ''Customizing''|| Denote your specific folder for XAMLs that depict how the Content is displayed, here. If, by default, the value is set to ''i:nil='''true''''', then the specific XAML folder is denoted by the name of the Profile at the bottom of the Profile Description.|| 🟡|| 🟡|| 🟡|| 🟡

| ''UICompatibilityLevel''|| Determines which UI versions the client app should try to be compatible with. In major version updates, UI redesigns can happen and sometimes old UI components might even be completely removed. For example, the app bars are removed since {{Version/WinXSince|4.0}} (level 400) because their features are embedded into other parts of the new UI. For those who want to stick with the previous UI for a while, this setting just needs to set to a level earlier, e.g. 380.|| 🟡|| 🟡|| 🟡|| 🟡

| ''ExpertMode''|| This boolean field denotes whether the Metadefinitions are loaded whenever the Profile of the App is loaded anew or not. By default the value is set to '''false''', i.e. the Metadefinitions are only loaded when the Application is initialized the first time, or when all data has been purged.|| 🟡|| 🟡|| 🟡|| 🟡

| ''ShowUnreleasedFeatures''|| This boolean field denotes whether some unofficially released features/options should be enabled/shown. For example, the developer settings in the Xamarin app is hidden by default and only shown when this value is set to true.|| 🟡|| 🟡|| 🟡|| 🟡

| ''SendCrashReports''|| Determines whether the device sends crash reports to the App Center or not. '''Please note that the diagnostic data is still saved locally and that all users on the device share the same switch. This means if one user enables crash reports, all users on this device will also send crash reports.'''Can be set in the General Settings -> Send crash reports (UWP & Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢|-|''IsFavorite'' || This boolean field denotes whether the Profile will be shown as a favourite on top of a list when there are also other Profiles in the Application client available.|| 🟢|| 🟡|| 🟡|| 🟡|-|''LastUsed'' || Contains a Timestamp when this profile was used the last time. || 🟡|| 🟡|| 🟡|| 🟡|-|''Name'' || This field denotes the name of the Profile. It also determines the name of the subfolder containing XAML customizing files, if the value of the ''Customizing'' field is set to ''i:nil=true'', as well as the name of the subfolder containing database files, if the value of the ''Project'' field is set to ''i:nil=true''. Can be set in the General Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡|-|''Customizing'' || This field determines the name of the subfolder containing XAML customizing files. It might be common to have to carry the same name as the ''Name'' field. If it is unspecified (''i:nil=true''), the value of ''Name'' will be used as subfolder name.|| 🟡|| 🟡|| 🟡|| 🟡|-|''Project'' || This field can name a special project. It determines the name of the subfolder containing database files. It might be common to have to carry the same name as the ''Name'' field. If it is unspecified (''i:nil=true''), the value of ''Name'' will be used as subfolder name. Can be set in the General Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

{{Attention|The UICompatibilityLevel setting tells the client app to be compatible to the specified versions of the UI if possible. This doesn't mean all existing UI customizings are still supported in newer versions of the app. In fact, any feature where this setting has an effect will explicitly mention it. Otherwise, you should always check the "XAML Notes" tab of each version's release note page.}}

~~[[Category:Client|Settings]]~~

== Connection ==

This section contains properties to denote the internal connection settings of the App.

{| class="wikitable" | width = "75100%"

|''Application'' || Denotes the name of the Application that will be run, e.g. one could use ''YourApp'' as the name for an Application.Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''AuthenticationPort'' || Denotes the Port used on the Authentication Server. Default values might be: ''443; 777; 888;''Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''AuthenticationProtocol'' || Denotes which Transfer Protocol for Authentication might be used. By default ''https'' is used.Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''AuthenticationServer'' || Denotes the Authentication Server, e.g. ''your.auth-server.net'' could be used.Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''AuthenticationService'' || Denotes the path on the Authentication Server to the Authentication Service File, e.g. the path might be ''YourFolder/YourApp/USAM/USAM.svc''. In this case the User System Authentication Manager (USAM) is used.Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''AuthenticationServiceConfig'' || WSHttpBinding (the default value) or BasicHttpBinding. It should be set according to the [[Configuration_Files/Services.config|webservice configuration]].Can be set in the Connection Settings -> Content Service Config (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''ConnectionTimeOut'' || Denotes the time in seconds when a web service call is dropped by the app. It's necessary so that the app doesn't wait indefinitely in events such as connection lost. The default value is ''300'' seconds. If you know your individual web service calls will take longer, the value should be increased accordingly.Can be set in the Connection Settings -> Time-Out of data connection (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''ContentPort'' || Denotes the Port used on the Content Server. Default values might be: ''443; 777; 888;'' Often it is the same port as for the one for the Authentication Server.|| 🟢|| 🟡|| 🟡|| 🟡

|''ContentProtocol'' || Denotes which Transfer Protocol for the Content might be used. By default ''https'' is used.Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''ContentServer'' || Denotes the Content Server, e.g. ''your.content-server.net'' could be used. Could be the same server as the Authentication Server.Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''ContentService'' || Denotes the path on the Content Server to the Content Service File, e.g. the path might be ''YourFolder/YourApp/CONTENT/UBIKContent.svc''. Make sure that the path points to the ''UBIKContent.svc'' file.Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

| ''ContentServiceConfig''|| WSHttpBinding (the default value) or BasicHttpBinding. It should be set according to the [[Configuration_Files/Services.config|webservice configuration]].Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''Context'' || Denotes the name of the Context, e.g. ''CXT_YourApp_001''. This context is specified inside UBIK and all the different Metadefintions are loaded from it.Can be set in the Connection Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''SignalingServer'' || Denotes the Server for Remote Support.|| 🟡|| 🟠|| 🟠|| 🟠

|''SyncMode'' || Denotes the Synchronization Mode of the Application. Possible Values are: Manual(Online), Offline, Auto; by default the SyncMode is set to ''Manual''. For Version 4.2 and up, the selected Sync Mode gets saved into the current Profile.|| 🟢|| 🟢|| 🟢|| 🟢

== Content ==

These internal content settings control the behaviors and activities of the content data.

{| class="wikitable" | width = "75100%"

|''AutoSaveMode'' || If this boolean field is set ''true'' changed Objects will be saved automatically when users leave the relevant pages. Otherwise, the User will see a save button and be asked to save the changes when leaving the relevant pages.Can be set in the General Settings -> Enable auto save mode (UWP).(*) Supported but not configurable on Xamarin.|| 🟢|| 🟡*|| 🟡*|| 🟡*

|''ChildPageChildrenPortion'' || Denotes the Portion of the visible Content Page Area that is split between the Children of an Object and its Properties. Usually the value is between ''0'' and ''100''. By default it is normally set to ''67'', i.e. taking two thirds of the Content Page Area to display Children of a given Object.|| ⚪|| ⚪|| ⚪|| ⚪

|''ChildPagePropertyPortion'' || Denotes the Portion of the visible Content Page Area that is split between the Properties of an Object and its Children . Usually the value is between ''0'' and ''100''. By default it is normally set to ''33'', i. e. taking one third of the Content Page Area to display Properties of a given Object.|| ⚪|| ⚪|| ⚪|| ⚪

|''DetailsPageChildrenPortion'' || Denotes the Portion of the visible Details Page Area that is split between the Children of an Object and its Properties. Usually the value is between ''0'' and ''100''. By default it is normally set to ''67'', i.e. taking two thirds of the Details Page Area to display Children of a given Object.|| ⚪|| ⚪|| ⚪|| ⚪

|''DetailsPagePropertyPortion'' || Denotes the Portion of the visible Details Page Area that is split between the Properties of an Object and its Children . Usually the value is between ''0'' and ''100''. By default it is normally set to ''33'', i. e. taking one third of the Details Page Area to display Properties of a given Object.|| ⚪|| ⚪|| ⚪|| ⚪

|''DocumentInternalMode'' || Denotes whether a Document is truly displayed only inside of the Application, then the boolean field should be set to ''true''. If there should be a preview of the Document available inside the Application only and the Document is to be opened by an external Application, the boolean field should be set to ''false''. By default the field is set to ''false''.|| ⚪|| 🟠|| 🟠|| 🟠

|''DocumentPageChildrenPortion'' || Denotes the Portion of the visible Document Page Area that is split between a Document lying beneath an Object and its Properties. Usually the value is between ''0'' and ''100''. By default it is normally set to ''80'', i.e. taking 80% of the Document Page Area to display a Document connected to a given Object.|| ⚪|| ⚪|| ⚪|| ⚪

|''DocumentPagePropertyPortion'' || Denotes the Portion of the visible Document Page Area that is split between the Properties of an Object and a Document belonging to it . Usually the value is between ''0'' and ''100''. By default it is normally set to ''20'', i. e. taking 20% of the Document Page Area to display Properties of a Document belonging to a given Object.|| ⚪|| ⚪|| ⚪|| ⚪

|''DocumentPagePropertyWidth'' || Denotes the maximum width (in pixels) that Properties of a Document can take when a Document belonging to an Object is displayed. By default the value is ''300 px''. || 🟡|| 🟡|| 🟡|| 🟡

|''[[Content_Logging#Log_setting|EnableSyncLogging]]'' || Determines whether certain content-related activities should be recorded as log files. Denotes whether a logging of different events, e.g. loading an object, changing a Property on an Object, etc. should take place. By default , this boolean field is set to ''true''.Can be set in the General Settings -> Content logging (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''EnableAutoBranchDownload'' || Denotes whether [[Branch_Download#Automatic_Download|auto branch download]] should be allowed. By default this boolean field is set to 'false''.Can be set in the General Settings -> Enable auto branch download (UWP & Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢

|''GeoDistanceSorting'' || Denotes whether the Children of an Object should be displayed in a ranking of geographic distance to the Parent Object. By default this boolean field is set ti to ''true''.Can be set in the General Settings -> Order by geo distance (UWP) & AR Settings -> Order by geo distance (Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢

|''NextLevelClassificationPreload'' || When set to false, provides the possibility to override the effect of [[SYSCLS_PRELOAD_CHILDREN]], namely to prevent the preload. See the link for more details.|| 🟡|| 🟡|| 🟡|| 🟡

| ''PriorityThreshold''|| Any property with a priority number greater than this integer setting value is regarded as a high priority property and is highlighted when being displayed. Can be set in the General Settings -> Priority Treshold Properties (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

| ''~~Update Expiry~~UpdateExpirySeconds''|| Determines how long (in seconds) freshly updated content becomes outdated and will be updated again when the user browses to it.Can be set in the General Settings -> Update Expiry (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

| ''~~[[Content_Logging#Log_setting|Content Logging~~PdfRenderer''~~]]|| Determines whether certain content related activities should be recorded as log files.~~|-~~| ''PdfRenderer''~~|| The renderer used to display PDF documents in the app.{{Version/WinXSince|4.6}}Can be set in the General Settings -> PDF Renderer (UWP).|| 🟢|| 🟠|| 🟠|| 🟠

~~[[Category:Client|Settings]]~~

== Push==

These internal push settings control the behaviors and activities of pushed data. For general information see [[Push Service (Client)|{{UBIK}} Push Service]].

{| class="wikitable" | width = "75100%"

|''ActivatePush'' || This boolean field denotes whether new resp. changed data should be pushed to other clients, which might be running the Application at the same time, or not. Can be set in the Push Settings -> Push active (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''PushPollingIntervalSeconds'' || Denotes the interval in seconds for the client to retrieve newly pushed data from the server.Can be set in the Push Settings -> Push Polling Interval(UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''PushPort'' || Denotes the Port Number to use when connecting to the Push Server (optional), might be set to the same Port number as the Content Port Number.Can be set in the Push Settings (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''PushProtocol'' || Denotes which Transfer Protocol for the Push might be used. By default ''https'' is used.Can be set in the Push Settings -> Push Protocol (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''PushServer'' || Denotes the Push Server, e.g. ''your.push-server.net'' could be used. Could be the same server as the Content Server.Can be set in the Push Settings -> Push Server (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''PushService'' || Denotes the path on the Push Server to the Push Service File, e.g. the path might be ''YourFolder/YourApp/PUSH/UBIKPush.svc''. Make sure that the path points to the ''UBIKPush.svc'' file.Can be set in the Push Settings -> Push Service Path (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''ShowPushMessage'' || This boolean field denotes whether the User is informed about an occurring Push, or not. By default it is set to ''false''.Can be set in the Push Settings -> Notify on Push (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

== Scan==

These internal scan settings control the behaviors and activities of scanned data.

{| class="wikitable" | width = "75100%"

|''CurrentBarcodeFormats'' || Refers to a Microsoft definition for QR Codes, denoted in [http://schemas.microsoft.com/2003/10/Serialization/Arrays]. Can be set in the Camera Settings -> 2D Markers (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''CurrentOCRProfileIndex'' || Specifies a certain OCR Profile. Yet, in the client in the camera settings you can also specify the OCR Profile. || 🟢|| 🟡|| 🟡|| 🟡

|''PostProcessRegex'' || If this field is set to ''true'', you can specify how a text based Code has to look like in the client settings.Can be set in the Camera Settings -> Post process Regex (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

|''ScanARMarker'' || This boolean field denotes whether an [[AR-Marker|ARMarker ]] can be scanned and will be recognized. (*) Can be set via related toggle buttons in Scan & POI View.|| 🟢*|| 🟡|| 🟡|| 🟡

|''ScanCodes'' || This boolean field denotes whether 2D-Codes, e.g. Barcode, QRCode, etc. can be scanned and will be recognized.(*) Can be set via related toggle buttons in Scan & POI View.|| 🟢*|| 🟡|| 🟡|| 🟡

|''ScanOCR'' || This boolean field denotes whether an [[OCR|OCRMarker ]] can be scanned and will be recognized.(*) Can be set via related toggle buttons in Scan & POI View.|| 🟢*|| 🟡|| 🟡|| 🟡

|''UnlockByScanTimeOut'' || This numeric field denotes whether a normally locked object can be unlocked for changes for a certain amount of time (in seconds).|| 🟡|| 🟡|| 🟡|| 🟡

|''CodesTryInverted'' || This boolean field denotes whether the client should try to scan color inverted 2D codes. The default value is "false".Can be set in the Camera Settings -> Try color inverted 2D codes (UWP) & AR Settings -> Try color inverted 2D codes (Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢

== Session==

These internal session settings control the behaviors and activities of a session.

{| class="wikitable" | width = "75100%"

|''AlternativeViewMode'' || By default this boolean field is set to ''false''. If set ''true'', it denotes that there is more than one View mode available.|| ⚪|| ⚪|| ⚪|| ⚪

|''ZoomedInMode'' || If this boolean flag is set true, the Children of an Object are shown as Tiles. Otherwise they are shown as List items.|-|} ~~== Final Settings ==These final settings control the behaviors and activities of a profile.~~ ⚪{| ~~class="wikitable"~~ | ~~width = "75%"~~⚪|-~~! Name!! Purpose~~|-⚪|~~''IsFavorite''~~ |~~| This boolean field denotes whether the Profile will be shown as a favourite on top of a list when there are also other Profiles in the Application client available.~~|-~~|''LastUsed'' || Contains a Timestamp when this profile was used the last time.~~ |-|''MultiUserMode'' || When set to ''false'', {{UBIK}} can only remember a single user per profile and will automatically log that user in when a profile is selected. When set to ''true'', the credential remembering feature becomes unavailable. However, this is no longer relevant {{Version/WinXSince|3.6}} because the new version(s) can remember multiple users per profile.|-|''Name'' || This field denotes the name of the Profile. It also determines the name of the subfolder containing XAML customizing files, if the value of the ''Customizing'' field is set to ''i:nil=true'', as well as the name of the subfolder containing database files, if the value of the ''Project'' field is set to ''i:nil=true''.|-|''Customizing'' || This field determines the name of the subfolder containing XAML customizing files. It might be common to have to carry the same name as the ''Name'' field. If it is unspecified (''i:nil=true''), the value of ''Name'' will be used as subfolder name.|-|''Project'' || This field can name a special project. It determines the name of the subfolder containing database files. It might be common to have to carry the same name as the ''Name'' field. If it is unspecified (''i:nil=true''), the value of ''Name'' will be used as subfolder name.|-~~|''ShowHiddenSettings'' || By default this boolean field is set to ''false'', i.e. no hidden settings are shown.~~⚪

== Maps ==

These settings control the behaviors of the [[Map View|map]] throughout the app.

{| class="wikitable" | width = "75100%"

| ''~~Map Type~~MapType''|| Determines which [[Map_View_(Xamarin)#Base_Map|base map ]] image will be used in the map.Can be set in the Maps Settings -> Map Type (UWP) & AR Settings -> Map Type (Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢

| ''~~Default Zoom Level~~DefaultZoomLevel''|| Controls how closely zoomed in the map should be whenever it is shown.Can be set in the Maps Settings -> Default Zoom Level (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

== Video ==

{| class="wikitable" | width = "75100%"

| ''~~Camera Device~~SelectedCameraId''|| Specifies which camera to use in the app.Can be set in the Camera Settings -> Device (UWP) & AR Settings -> Camera (Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢

| ''~~Camera Resolution~~SelectedCameraConfigurationIndex''|| Specifies which camera resolution to use in the app.Can be set in the Camera Settings -> Resolution (UWP) & AR Settings -> Camera resolution (Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢

| ''Zoom {{Version/XamarinSince|4.4}} (Android only, device dependent)''|| Controls how closely zoomed in the camera view should be whenever it is shown. The higher the number, the closer the view appears.Can be set in the AR Settings (Xamarin).|| 🟠|| 🟠|| 🟠|| 🟢

{{Hint|* The camera preview window (UWP only) in the settings is hidden when the camera is currently in use in e.g. the POI view or the scan view. However, a user can still change the relevant settings and see immediate results.* Setting up a high Camera Resolution could affect the performance.}}

~~[[Category:Client|Settings]]~~

== Location ==

{| class="wikitable" | width = "75100%"

| ''~~Calibration Heading~~CalibrationHeading''|| Specifies the heading that is used when manually calibrating the orientation sensor.Can be set in the Location Settings -> Heading Offset (UWP).|| 🟢|| 🟡|| 🟡|| 🟡

| ''~~Location Mode~~LocationModeEnums''|| Specifies the Location Mode.Can be set in the Location Settings -> Location Mode (UWP) & AR Settings -> Positioning Mode (Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢

| ''~~Use PoseFusion~~UsePoseFusion''|| Specifies whether PoseFusion is used or not.Can be set in the Location Settings -> Enable PoseFusion (UWP) & AR Settings -> Use Pose Fusion (Xamarin).|| 🟢|| 🟢|| 🟢|| 🟢

[[Category:Client|Settings]]

=Android=

CWI

257

edits

Changes

Settings

UBIK Wiki / Augmensys