Language and Regional Settings

Introduction

Overview

Contract Eagle provides features to control the way information is displayed according to the locale (or "culture" or "language") of the user.

Contract Eagle is an English-language system, thus the main purpose of providing regional settings is to control the way dates and currency values are displayed.

Who needs to read this?

Most people do not need to read this document because Contract Eagle will use information gathered from the user's web browser to identify the most appropriate locale to apply. 

What difference does it make?

The table below shows an example of the difference in date and currency values when comparing the "English - United Kingdom" language with the "English - United States" language.

How Contract Eagle Selects The Right Locale

Contract Eagle uses a formula (or "algorithm") to determine which is the most appropriate language to use.

It steps through the following methods until it has been successful in assigning a locale.

1. Method 1 - Override Value of "IIS" In Web Config File
2. Method 2 - Override language in Web Config File
3. Method 3 - Language Preference from User's Web Browser
4. Method 4 - Select the first available "English" locale installed on the server

Other locale functionality available within Contract Eagle

1. Enable user-customised settings
2. How to check your culture settings

Method 1 - Override Value of "IIS" in Web Configuration

Firstly - Specify the Override Value in the Configuration File

Specifying the override value "IIS" in the application configuration file will tell Contract Eagle to use the ASP .NET settings within IIS to determine the appropriate culture.

By default the Contract Eagle Web Configuration file will be found in "C:\Program Files\Contract Eagle\Contract Eagle\Web\Web.config".  Within the file there will be a setting with the key "OverrideCulture". Note that changing this file will automatically reset the Contract Eagle application.

Secondly - Select the Culture within IIS

IIS 7 - Windows Vista / 7 / 2008

• Open up the IIS Management Console
• Locate the virtual directory for Contract Eagle
• Click the Contract Eagle Node
• Double-click the ".NET Globalization" Icon

• Select the appropriate "Culture" setting

• If you have customised your culture settings and wish to apply those customisations within Contract Eagle then you will need to set "Enable Client Based Culture" to True. Then, because the customised culture settings will apply to a specific user account you will then need to do one of the following:
  • EITHER You will need to ensure that the application pool is running with the same identity as the customised user account.
  • OR You will need to set up ASP .NET impersonation to use the same identify as the customised user account.

IIS 6 - Windows Server 2003

• Open up the IIS Management Console
• Locate the virtual directory for Contract Eagle
• Right-click the Contract Eagle Node and select the "Properties" option
• Select the "ASP .NET" page
• Click on the "Edit Configuration" button

• Having click the "Edit Configuration" button you will see the screen below.
• Select the "Application" page
• Select the desired Culture (Note that you can set the UI culture too although it doesn't have any effect on Contract Eagle).
• Click OK to save the setting.

Method 2 - Override language in Web Config File

Specifying an override language in the application configuration file will tell Contract Eagle to use that culture, regardless of the preference of the user's web browser.

By default the Contract Eagle Web Configuration file will be found in "C:\Program Files\Contract Eagle\Contract Eagle\Web\Web.config".  Within the file there will be a setting with the key "OverrideCulture".

The example above shows the "English - United Kingdom" language being used as the override value.  The value specified must be an English language installed on your server. Typically this is one of the following: en-US,en-GB,en-AU,en-CA,en-NZ,en-IE,en-ZA,en-JM,en-BZ,en-TT,en-ZW,en-PH,en-SG,en-MY,en-IN.

Method 3 - Language Preference from User's Web Browser

This method describes the default behavior for Contract Eagle, because the override settings are left blank when Contract Eagle is installed initially.

This method takes the list of languages provided by the user's web browser and attemtps to match them up against the available languages on the server. The way to control this behaviour is to changes the languages specified by each user's browser.  This is done as follows:

Internet Explorer

• Select the "Tools" menu then "Internet Options"
• Click on the "Languages" button, which is on the "General" page
• If your preferred language isn't on the list then click the "Add..." button to add it
• Move your preferred language to the top of the list

Mozilla Firefox

• Select the "Tools" menu then "Options" then "Content"
• Click the "Choose..." button within the Languages section
• If your preferred language isn't on the list then select and add it
• Move your preferred language to the top of the list

Google Chrome

• Select the "Tools" menu, which has the wrench/spanner icon
• Select "Options" then "Under the Hood"
• Scroll down until you see the "Change font and language settings" button
• Click this button then go to the "languages" page.
• If your preferred language isn't on the list then click the "Add" button to add it to the list.
• Move your preferred language to the top of the list

Method 4 - Select the first available "English" locale installed on the server

When all other methods fail to find a preferred culture then the default is to use the first available English culture on the server.

You can identify the list of available languages via the "Environment" page within Contract Eagle. See the section "How to check your culture settings".

This method of culture selection is a last resort and best avoided. If possible try and ensure your culture is explicitly set via one of the first three methods. 

Enable user customised settings

User customised settings are adjusted via the "Regional and Language" options in Windows. The purpose of these instructions is not to tell you how to adjust these settings but to tell you how to pick up these settings within Contract Eagle.

There are two requirements to force Contract Eagle to pickup the settings:

1. Set the identity of the Contract Eagle web application to be the user that owns the customised settings
2. Set the flag to enable custom culture settings within Contract Eagle.

Set the identity

The user customised settings belong to a specific user, therefore it is necessary to set the identify of the Contract Eagle application to that of the specific user.  This can be done within IIS, either by specifying an ASP .NET impersonation or by specifying the user as the identity of the application pool (Note: Application pools aren't a feature of IIS on Windows XP).

Set the flag

 If you are using the "IIS" override specified in method 1 above then you can only specify this setting within the ".NET Globalisation" section of the IIS Management console (this is not available in Windows XP or Server 2003).   You need to set the "Enable Client Based Culture" to "True".

If you are using the options specified in methods 2, 3 or 4 above then you can specify this setting within the application configuration. You need to define the setting "ApplyCustomCultureSettings" to have a value of "Y".  (See picture below).

How to Check your culture settings

• Open up a new Contract Eagle window
• Select the "About Contract Eagle" option from the "Help" menu
• Click the "Environment" button
• The value for "Current Culture" indicates the language which Contract Eagle is using. It will also describe the way it assigned that language eg. "Browser culture matched to server".