Skip to main content

What is the Search Order for the SubscriptionMessages.proper

Updated
Beginning with DocuShare 3.1 Update 1 a messages directory exists in the DocuShare home directory. This change supports a localized SubscriptionMessages.properties file. When localizing the SubscriptionMessages.properties file it is important to know the search order used by DocuShare to locate a SubscriptionMessages.properties file. DocuShare searches 3 different directories for SubscriptionMessages.properties in the following order:
  1. Current working directory: [DS-Home]\bin
  2. DocuShare messages directory [DS-Home]\messages
  3. DocuShare config directory: [DS-Home]\config
In each directory DocuShare searches by name for SubscriptionMessages.properties in the following order:

(A) SubscriptionMessages_.properties
(B) SubscriptionMessages.properties
(C) SubscriptionsMessages_en_US.properties (only if locale is not en_US)

For example if a DocuShare site is configured with French as the default language, DocuShare will search for SubscriptionMessages.properties in the following order. 1A, 1B, 1C, 2A, 2B, 2C, 3A, 3B, 3C.

Assuming our hypothetical French language DocuShare server was a standard default installation, it would not have a localized SubscriptionMessages_fr.properties file. Following the search order outlined above the server will use [DS-Home]\messages\SubscriptionMessages.properties (2B).

When you localize the SubscriptionMessages.properties file for the French locale, name the localized file SubscriptionMessage_fr.properties. Save the file in the [DS-Home]\messages directory. DocuShare will use [DS-Home]\messages\SubscriptionMessage_fr.properties (2A), as long as the default language for the DocuShare site is set to French

NOTE: [DS-Home] represents the DocuShare installation directory. This is \Xerox\Docushare if the default is accepted during installation.
[locale] represents the language locale for DocuShare. For example, fr = French, de = German, es = Spanish. The Subscription Message file for French would be named SubscriptionMessages_fr.properties.
The default language is configured on the Installed Languages page, in Admin Home, under [Administration Menu], [Site Management].