OWACurrent en:Add In Settings: Unterschied zwischen den Versionen

Version vom 29. Januar 2024, 11:26 Uhr

Overview

The Add-in settings allow the end user to configure key elements of the Cryptshare for OWA add-in. This includes changing the preferred language, enabling dark mode, and obtaining the Client ID necessary for Remote Logging setup.

In order to access the Add-in settings, users should follow this procedure:

Open the add-in on any message.
Click the three dots (...) to open the main add-in menu.
Click "Settings" to open the General Settings view.
To access any other settings view, use the menu at the top of the settings page.

General Settings View

Cryptshare Server URL

The Cryptshare Server URL displays the server from which this add-in is hosted, and will obtain its settings from. Please note that the Server URL is unchangeable.

Display Mode

The Cryptshare for OWA add-in supports being displayed in "dark mode", opposed to the default appearance. The dark display mode is characterized by dark backgrounds with bright elements, matching the "dark mode" of Outlook on the Web. The chosen setting will be applied automatically upon save.

The "Light" option will force the add-in to its default appearance. Conversely, the "Dark" option will force the add-in to the inverted appearance. If "Use system preferences" is selected, the add-in will automatically follow the color scheme set by the browser the add-in is opened in. This color scheme, depending on the browser, may be defined by the global system settings.

Language

The language setting affects the language the add-in is displayed in. On first startup, the add-in language will be set to your default browser locale, if the equivalent language package is available on the Cryptshare Server. This language selection may be changed at any time from this setting.

Language Packages reside on server-side

To be able to select a language, the language pack must be installed on the Cryptshare Server before starting the add-in. To install additional language packages, please refer to Installing Language Packages in the server manual.

Logging Settings

The Cryptshare for OWA add-in by default logs information to the JavaScript browser console. Considering the likely high amount of users/clients working with the add-in, error analysis may become time-consuming and complicated. To facilitate diagnosis for administrators and users, the add-in may be set up to send logged information to the Cryptshare Server. This feature is also referred to as "Remote Logging". This allows administrators to receive the logged information from several clients at a central location.

Client ID

The Client ID is unique to every installation of the add-in, identifying the location of the logs that may be received by remote logging. It is necessary to activate remote logging on the Cryptshare Server for every client.

Logging

This section of the Log settings view informs the user of the current status of remote logging, and if enabled, which log level is currently set.

Activating Remote Logging

In order to activate remote logging for the add-in, the Cryptshare Server administrator needs the client ID of this particular installation. The user may copy this Client ID from the "Client ID" section in the settings view by clicking the text field. The entire ID will automatically be selected to facilitate easy copying to the clipboard using Ctrl+C.

If you are the administrator and have received the client ID from the user who wishes to implement remote logging, please refer to the Server documentation on Remote Logging to enable the transmission of logs.

User Settings

In order to send Cryptshare Transfers, it is necessary to supply some contact details in case the recipient of the transfer needs to contact the sender for any additional information.

This information will be requested by the add-in when attempting to send a new transfer, if it is not currently set.

Using the User Settings menu, it is possible to modify the name and phone number associated with any newly created transfers. The used e-mail address will always match the currently logged in account for Outlook on the web.

To change these settings, simply enter the desired values and click the "Save" button.

@@ Zeile 1: / Zeile 1: @@
-= General =
+== Overview ==
-[[File:OWA_UserSettingsPage_EN.png|thumbnail|Example of the default settings view.]]
+The Add-in settings allow the end user to configure key elements of the Cryptshare for OWA add-in. This includes changing the preferred language, enabling dark mode, and obtaining the Client ID necessary for Remote Logging setup.
-The Cryptshare for OWA add-in Settings allow a user to '''change the preferred language''' and to setup a '''different server URL''' than the pre-configured URL. Furthermore it is possible to get the Client ID in order to activate [[{{NAMESPACE}}:72319930|remote logging]] for support purposes.
-To access the add-in settings, open the add-in in your browser.
+In order to access the Add-in settings, users should follow this procedure:
+* Open the add-in on any message.
-# Log in to Office 365.
+* Click the three dots (...) to open the main add-in menu.
-# Start the add-in
+* Click "Settings" to open the General Settings view.
-## Select any message
+* To access any other settings view, use the menu at the top of the settings page.
-## Click on the 3 dots (...)  in order to open the main menu as shown in the picture
-##:[[File:72319923.png|frameless|none]]
+== General Settings View ==
-## Click on the Cryptshare for OWA add-in to start it
+=== Cryptshare Server URL ===
-# Press on the 3 dots (...) menu in the top right corner of the add-in
+The Cryptshare Server URL displays the server from which this add-in is hosted, and will obtain its settings from.
-#:[[File:72319921.jpg]]
+'''Please note that the Server URL is unchangeable.'''
-# Click on ''Settings''
-<br clear=all>
+=== Display Mode ===
+The Cryptshare for OWA add-in supports being displayed in "dark mode", opposed to the default appearance.
-== Cryptshare Server URL ==
+The dark display mode is characterized by dark backgrounds with bright elements, matching the "dark mode" of Outlook on the Web.
-The Cryptshare Server URL for the add-in can be changed if the add-in resources are hosted elsewhere. The URL can be changed under '''Settings → User Settings'''.
-* The given URL must start with '''https://'''
-* The URL must point to a Cryptshare Server hosting Cryptshare for OWA add-in resources.
-== Display mode ==
-[[File:OWA_DarkMode_EN.png|right|thumb|Example of the add-in with dark mode enabled]]
-It is possible to choose between a light and a dark display mode within the settings. The dark display mode is characterized by dark backgrounds with bright elements.
 The chosen setting will be applied automatically upon save.
-<br clear=all>
+The "Light" option will force the add-in to its default appearance.
-= Language Settings =
+Conversely, the "Dark" option will force the add-in to the inverted appearance.
-On first startup the language used in the add-in will be set to your default browser language, if the language packages are available. The language can be changed separately from the language settings configured in OWA. This setting is located under '''Settings → User Settings'''.
+If "Use system preferences" is selected, the add-in will automatically follow the color scheme set by the browser the add-in is opened in. This color scheme, depending on the browser, may be defined by the global system settings.
-{{InfoBox|title=Language Packages reside on server-side|content=Please note, that in order to be able to switch between language packages, these must be installed on server-side first. For instructions on how to install new language packages please refer to [https://wiki.cryptshare.com/display/CSM/Installing+Language+Packages Installing Language Packages] in the server manual.
-}}
+=== Language ===
+The language setting affects the language the add-in is displayed in.
-= Remote Logging =
+On first startup, the add-in language will be set to your default browser locale, if the equivalent language package is available on the Cryptshare Server.
-Please go to '[[{{NAMESPACE}}:72319930|Error Analysis, Support & Logging]]' for details about the Remote Logging Feature.
+This language selection may be changed at any time from this setting.
-= Storage Location for Settings =
-== General ==
+{{InfoBox|title=Language Packages reside on server-side|content=To be able to select a language, the language pack must be installed on the Cryptshare Server before starting the add-in. To install additional language packages, please refer to [https://documentation.cryptshare.com/w/CSSCurrent_en:Installing_and_customizing_language_packages Installing Language Packages] in the server manual.}}
-As the purpose for specific settings is different as on the one hand it is relevant for the specific user and on the other hand is relevant for the specific client, the Cryptshare for OWA add-in stores its settings in two different places, depending on that purpose.
-== Settings stored in the browser ==
-The following settings are stored in the application storage of the browser and therefore are not persistent between different browsers:
+== Logging Settings ==
-* Language Selection
+The Cryptshare for OWA add-in by default logs information to the JavaScript browser console. Considering the likely high amount of users/clients working with the add-in, error analysis may become time-consuming and complicated. To facilitate diagnosis for administrators and users, the add-in may be set up to send logged information to the Cryptshare Server. This feature is also referred to as "Remote Logging". This allows administrators to receive the logged information from several clients at a central location.
-* Acceptance-State for the Terms of Use
-* Client ID
+=== Client ID ===
-== Settings stored for the OWA Account ==
+The Client ID is unique to every installation of the add-in, identifying the location of the logs that may be received by remote logging. It is necessary to activate remote logging on the Cryptshare Server for every client.
-The following settings are stored in the so called roaming settings of an account and are therefore persistent between browsers and systems where OWA can be executed:
-* URL of the Cryptshare Server
+=== Logging ===
-* Maximum attachment size
+This section of the Log settings view informs the user of the current status of remote logging, and if enabled, which log level is currently set.
------
+=== Activating Remote Logging ===
+In order to activate remote logging for the add-in, the Cryptshare Server administrator needs the client ID of this particular installation.
+The user may copy this Client ID from the "Client ID" section in the settings view by clicking the text field. The entire ID will automatically be selected to facilitate easy copying to the clipboard using Ctrl+C.
+If you are the administrator and have received the client ID from the user who wishes to implement remote logging, please refer to the Server documentation on [https://documentation.cryptshare.com/w/CSSCurrent_en:Logging#Remote_Logging Remote Logging] to enable the transmission of logs.
+== User Settings ==
+In order to send Cryptshare Transfers, it is necessary to supply some contact details in case the recipient of the transfer needs to contact the sender for any additional information.
+This information will be requested by the add-in when attempting to send a new transfer, if it is not currently set.
+Using the User Settings menu, it is possible to modify the name and phone number associated with any newly created transfers. The used e-mail address will always match the currently logged in account for Outlook on the web.
+To change these settings, simply enter the desired values and click the "Save" button.