Language and Regional Settings for Reporting

This section explains how to use the language and regional settings for reporting in On Key and Wyn.

Using Language-Region Settings

The language and region preferences for the On Key report server can be set on a user, site and System Options level, and determines:

  • how the report server user interface is presented in terms of language, number and date formats.
  • how number and date formats are applied when rendering data through standard report design elements.

Language-region format and options

The language and region code should be specified in the "xx-yy" format, where "xx" and "yy" represent the two-letter language and country codes, according to ISO 639-1 and ISO 3166-1 alpha-2, respectively.

The supported report server UI languages and report server report languages are restricted to those supported by the specific report server, and should be confirmed in the user profile settings and the Report Designer.

Set the report server language and region preferences

In On Key, the report server language and region preferences can be set at a user, site and System Options level, by editing the Report Server UI Language and Report Server Report Language fields. This will first default to the user setting, then to the user's site setting, then to the System Options setting.

Refer to the user options Reports section for more information.

Configure the Wyn report server

Log into the Wyn report server as an administrator and define the custom user properties that will be used to set the user interface and report language-region preferences. You can add the following custom user properties to the system:

  • language_preference
  • OnKeyReportLanguage

Next, link these two custom user properties to claims with the same name in the User Context. Refer to Report Design for more information.  

Use the OnKeyReportLanguage property to set a report's regional preference

Selected Wyn Report Design elements have international language properties. These property values should be left as "Default", in order to derive their values from the overall report-level language-region setting. This ensures that the formatting for the specified field is determined by the report-level setting, which is obtained from the custom user property.

Set the report level MISC language property to:

  • {UserContext.GetValue("OnKeyReportLanguage")}  

This expression will then insert the report language-region preference value for the user into the field, from the OnKeyReportLanguage user property.

Report Design

The report design approach makes use of various properties to determine the report language-region preference. User properties that are passed from On Key to the Wyn server and that could be used in report development are:

  1. language_preference

    2. This is recognised by the report server as the preferred user interface language property for the user. This property will be linked to a claim with the same name in the User Context passed to the report server from On Key.  

  2. OnKeyReportLanguage

    3. This is used in the Report Designer to specify the report language-region preference. This property will be linked to a claim with the same name in the User Context passed to the report server from On Key.

  3. OnKeyUserCode and OnKeyUserId

    4. These properties can be used in the report to filter data according to On Key permissions. The report needs to be authored with permissions in mind and will need to know which permission ID to use, depending on the content that you are filtering.

Learn more about using the Wyn Enterprise Report Designer here.