alfaSettings.json configuration

The example alfaSettings.json configuration file includes the following settings as well as a number of deactivated lines which are not for standard use.

Configuration relevant fields are in AlfabetPresentationSessionServiceConfig and AlfabetRuntimeConfig.

AlfabetPresentationSessionServiceConfig fields:

Field Required Setting
AlfabetWebConfig settings
diableContentSecurityPolicyHeader The default setting is false. Content security headers are enabled by default to restrict content that can be loaded in the application.
ContentSecurityPolicyValue You can use this field to set content security policy directives required by the security policy of your company. An overview of directives is available: https://content-security-policy.com/.
AlfabetPresentationSessionServiceConfig settings
msfile

Enter the absolute path to the alfabetms.xml configuration file containing the server alias for the Alfabet Web Application. All backslashes in the path must be escaped with a backslash:

  • "msfile":"C:\\Installationdirectory\\Programs\\alfabetms.xml",
easyin

If you define a user name in this field, the login screen of the Alfabet user interface will be prefilled with this user name. This field must be left empty for production environments. Only use this field for test or configuration instances.
alias Enter the name of the server alias for the Alfabet Web Application.
sessionTimeout Without user activity, an Alfabet session will time out after 20 seconds. You can alter the timeout value with this field in the format hh:mm. The timeout should not exceed 1 hour.
AlfabetRuntimeConfig settings
Debug Set the Debug field to false unless issues are encountered and debugging is required. If the Debug field is set to true and the field UseNLog is set to true , log files will be written in the runtime directory of the Alfabet Web Application and error messages displayed in browsers will reveal web server details.
UseNLog

Set the UseNLog field to true to use the NLog component for logging. NLog requires additional configuration in the JSON object of the field NLog.

Set the Set theUseNLog field to false to use Alfabet specific logging mechanisms configured in the server alias of the Alfabet Web Application.
ApplicationRuntimeMode Set ApplicationRuntimeMode to Standard for production environments. Additional options:
  • View : The Alfabet user interface opens view only.
  • Design: Use this setting for debugging and testing. The technical name of views will be displayed in brackets after each caption. You can easily identify which view you are working on and provide the required information to Software GmbH Support.
ApplicationRuntimeID Include the ApplicationRuntimeID in the configuration and set it to an arbitrary non-empty alphanumeric value to disable reloading of content files (js, css, icons) on every application restart.
EnableVersionHeader Set the EnableVersionHeader field to true if you want the operating system version to be included in the full version information about Alfabet and to be displayed in the About Alfabet dialog.
SolutionAssembliesSearchStrategy Set the SolutionAssembliesSearchStrategy to Production . This setting influences the loading of .dll files. Settings other then Production are only relevant for Software GmbH internal development tasks.
CacheDurationInSeconds Set the maximum number of seconds that content may remain in the browser cache. After the cache duration expires, the browser will have to re-load the content from the Web server instead of re-using it from the cache.
ExperimentalFeatures If you encounter problems with the execution of right rules, you can re-set the default batch calculation of right rules either completely to a one by one calculation, or exclude right rules with WITH statements from batch calculation only. The specification is done in the following syntax:
  • "ExperimentalFeatures":{
    • "LocalRightsRulesBatchExecution":"mode"
    • }

You can set the following modes:

  • full: The default setting for batch calculation of right rules. This setting results in the best performance.
  • simple: Right rules with WITH statements are excluded from batch calculation and are calculated separately.
  • disabled: Right rules are calculated one by one. This setting results performance loss for right rules calculation and shall only be used if problems are encountered. It is recommended to report the issues with right rules calculation to Software GmbH Support .
ShowBacktoAppLinkonLogout Set this attribute to false to hide the link to the login page from the logout page of the Alfabet user interface which is displayd after logout of the user and after a session expired. The default value is true.
NLog settings The JSON object in this field contains the NLog configuration settings. For details of the configuration, see the NLog configuration documentation.

In the Examples sub-folder of the AlfabetWebApplication folder, there is a folder Log_SAML containing an alfasettings.json file with an example configuration for logging of SAML activity with NLog. If you need more examples for other use cases, you can propose the use case for generation of an additional example file.
AppInsights settings An example providing information about information that may be added to apply Azure® AppInsights ® analysis on Alfabet use. This section is commented out because it is not used in the standard implementation.