CSOv210 en:Structure of the file CS4OutlookAdminConfig.xml: Unterschied zwischen den Versionen

Aus Cryptshare Documentation
Wechseln zu:Navigation, Suche
(Imported from text file)
 
Keine Bearbeitungszusammenfassung
Zeile 1: Zeile 1:
 
-----
{{InfoBox|title=Working with XML files|content=Please familiarize yourself with the fundamentals of XML files before you start to edit the CS4OultookAdminConfig.xml. Furthermore, the use of an advanced editor that has an appropriate representation and syntax checking is recommended for editing the file (eg. [http://notepad-plus-plus.org/ Notepad ++], [http://www.pspad.com/en/ PSPad], or other).
{{InfoBox|title=Working with XML files|content=Please familiarize yourself with the fundamentals of XML files before you start to edit the CS4OultookAdminConfig.xml. Furthermore, the use of an advanced editor that has an appropriate representation and syntax checking is recommended for editing the file (eg. [http://notepad-plus-plus.org/ Notepad ++], [http://www.pspad.com/en/ PSPad], or other).
}}
}}


{| class="wikitable"
== Main Nodes and Sub Nodes ==
|-
|== Main Nodes and Sub Nodes ==
The file consist of a '''main node''' for each e-mail address for which configuration data is stored in the file.
The file consist of a '''main node''' for each e-mail address for which configuration data is stored in the file.
Within every main node there is a '''sub node''' for each [[{{NAMESPACE}}:Settings|setting]] that can be influenced.
Within every main node there is a '''sub node''' for each [[{{NAMESPACE}}:Settings|setting]] that can be influenced.
Every node starts with the tag <Item> and ends with the tag </item> on the same level.
Every node starts with the tag <Item> and ends with the tag </item> on the same level.


|style='text-align: center;'|'''[[File:5014152.png]]'''
[[File:5014152.png|frame|none|Sub Node]]
'''Sub Node'''
|}


== Values within each Settings Node ==
== Values within each Settings Node ==


{| class="wikitable"
Name of the [[{{NAMESPACE}}:Settings|setting]] that can be influenced.
|-
 
!| 
[[File:5013909.png]]


!|
When the Cryptshare for Outlook Add-In is started the first time, all values are initialised with hard-coded values which will be overwritten by the server settings on first contact with the server.
|-
|Name of the [[{{NAMESPACE}}:Settings|setting]] that can be influenced.


|[[File:5013909.png]]
|-
|When the Cryptshare for Outlook Add-In is started the first time, all values are initialised with hard-coded values which will be overwritten by the server settings on first contact with the server.
The variable <IsInitialValue> defines, if the value of this setting is a value that has been created during initialisation of the add-in (true)-
The variable <IsInitialValue> defines, if the value of this setting is a value that has been created during initialisation of the add-in (true)-
If <IsInitialValue> is set to "true", the values <Restriction> and <Value> of this [[{{NAMESPACE}}:Settings|setting]] will be overwritten with [[{{NAMESPACE}}:Server_Side_Configuration|server values]] next time the add-in contacts the Cryptshare server. At the same time, <IsInitialValue> will be set to "false".
If <IsInitialValue> is set to "true", the values <Restriction> and <Value> of this [[{{NAMESPACE}}:Settings|setting]] will be overwritten with [[{{NAMESPACE}}:Server_Side_Configuration|server values]] next time the add-in contacts the Cryptshare server. At the same time, <IsInitialValue> will be set to "false".
This happens in any case, no matter if the server setting [[{{NAMESPACE}}:Allow_Configuration_Using_Local_File|Allow Configuration Using Local File]] is active or inactive.
This happens in any case, no matter if the server setting [[{{NAMESPACE}}:Allow_Configuration_Using_Local_File|Allow Configuration Using Local File]] is active or inactive.


|[[File:5013910.png]]
[[File:5013910.png]]
|-
 
|The variable <Restriction> defines if the user can see and edit the corresponding field in the [[{{NAMESPACE}}:5013962|Tab "Add-In Settings"]] in the User Interface. The following options are available:
The variable <Restriction> defines if the user can see and edit the corresponding field in the [[{{NAMESPACE}}:5013962|Tab "Add-In Settings"]] in the User Interface. The following options are available:


{| class="wikitable"
{| class="wikitable"
Zeile 54: Zeile 43:
|}
|}


|[[File:5013911.png]]
[[File:5013911.png]]
|-
 
|The variable <Type> defines, which kind of value may be used for the variable <Value>. Please refer to the information concerning the respective [[{{NAMESPACE}}:Settings|setting]] to see which values can be used.
The variable <Type> defines, which kind of value may be used for the variable <Value>. Please refer to the information concerning the respective [[{{NAMESPACE}}:Settings|setting]] to see which values can be used.


{| class="wikitable"
{| class="wikitable"
Zeile 73: Zeile 62:
|}
|}


|[[File:5013912.png]]
[[File:5013912.png]]
|-
|The variable <Value> contains the value for the setting. Details can be found in the section [[{{NAMESPACE}}:Variables_of_the_file_CS4OutlookAdminConfig.xml|Variables of the file CS4OutlookAdminConfig.xml]] or in the description of all available [[{{NAMESPACE}}:Add_In_Settings|Add-In Settings]].


|[[File:5013913.png]]
The variable <Value> contains the value for the setting. Details can be found in the section [[{{NAMESPACE}}:Variables_of_the_file_CS4OutlookAdminConfig.xml|Variables of the file CS4OutlookAdminConfig.xml]] or in the description of all available [[{{NAMESPACE}}:Add_In_Settings|Add-In Settings]].
|}


-----
[[File:5013913.png]]

Version vom 8. März 2022, 13:19 Uhr

Working with XML files
Please familiarize yourself with the fundamentals of XML files before you start to edit the CS4OultookAdminConfig.xml. Furthermore, the use of an advanced editor that has an appropriate representation and syntax checking is recommended for editing the file (eg. Notepad ++, PSPad, or other).

Main Nodes and Sub Nodes

The file consist of a main node for each e-mail address for which configuration data is stored in the file. Within every main node there is a sub node for each setting that can be influenced. Every node starts with the tag <Item> and ends with the tag </item> on the same level.

Sub Node

Values within each Settings Node

Name of the setting that can be influenced.

5013909.png

When the Cryptshare for Outlook Add-In is started the first time, all values are initialised with hard-coded values which will be overwritten by the server settings on first contact with the server.

The variable <IsInitialValue> defines, if the value of this setting is a value that has been created during initialisation of the add-in (true)-

If <IsInitialValue> is set to "true", the values <Restriction> and <Value> of this setting will be overwritten with server values next time the add-in contacts the Cryptshare server. At the same time, <IsInitialValue> will be set to "false".

This happens in any case, no matter if the server setting Allow Configuration Using Local File is active or inactive.

5013910.png

The variable <Restriction> defines if the user can see and edit the corresponding field in the Tab "Add-In Settings" in the User Interface. The following options are available:

Value Effect
Editable The user can see and edit the setting.

Values with the restriction "Editable" will not be overwritten by server values, no matter if the server setting Allow Configuration Using Local File is active or inactive as they are intended to be managed locally.

Read-Only The user can see the setting, but not modify it. If the setting Allow Configuration Using Local File is active, this value will be overwritten with the server-side value at every contact with the server.
Invisible The user can neither see nor modify the setting. If the setting Allow Configuration Using Local File is active, this value will be overwritten with the server-side value at every contact with the server.

5013911.png

The variable <Type> defines, which kind of value may be used for the variable <Value>. Please refer to the information concerning the respective setting to see which values can be used.

Value Meaning
Integer Whole number
Boolean "true" or "false"
String Sequence of characters

5013912.png

The variable <Value> contains the value for the setting. Details can be found in the section Variables of the file CS4OutlookAdminConfig.xml or in the description of all available Add-In Settings.

5013913.png