H Schema Reference: Locale Message Catalog l10n_msgcat.dtd

This appendix provides a reference to elements of the l10n_msgcat.dtd schema, the schema behind XML you use to define log messages localized for a specific Java locale.

This appendix includes the following sections:

H.1 Overview of the Locale Message Catalog Elements

Oracle Event Processing provides a number of locale message catalog elements that you use to define log messages localized for a given Java locale.

H.1.1 Element Hierarchy

The top-level Oracle Event Processing locale message catalog elements are organized into the following hierarchies, depending on message catalog type:

Example H-1 Locale-Specific Log Message Catalog Hierarchy

locale_message_catalog
    logmessage
        messagebody
        messagedetail
        cause
        action

Example H-2 Locale-Specific Simple Text Catalog Hierarchy

message_catalog
    message
        messagebody

H.1.2 Examples

This section provides the following message catalog examples:

Example H-3 Locale-Specific Log Message Catalog

<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<message_catalog 
  l10n_package="programs.utils"
  version="1.0">
  <logmessage
    messageid="600001">
    <messagebody>
      Could not open file, {0} on {1,date} after {2,number} attempts.
    </messagebody>
    <messagedetail>
      The configuration for this application will be defaulted to
      factory settings. Custom configuration information resides
      in file, {0}, created on {1,date}, but is not readable.
    </messagedetail>
    <cause>
      The user is not authorized to use custom configurations. Custom
     configuration information resides in file, {0}, created on
     {1,date}, but is not readable.The attempt has been logged to
     the security log.
    </cause>
    <action>
      The user needs to gain approriate authorization or learn to
      live with the default settings.
    </action>
  </log_message>
</message_catalog>

Example H-4 Locale-Specific Simple Text Catalog

<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<locale_message_catalog 
  l10n_package="programs.utils"
  subsystem="MYUTIL" 
  version="1.0">
  <message>
    <messageid="FileMenuTitle">
    <messagebody> Fichier </messagebody>
  </message>
</locale_message_catalog>

H.2 locale_message_catalog

Use this element to define values for a parameterized Oracle CQL or EPL rule in an EPL processor component.

H.2.1 Child Elements

The locale_message_catalog element supports the following child elements:

H.2.2 Attributes

Table H-1 lists the attributes of the locale_message_catalog element.

Table H-1 Attributes of the locale_message_catalog Element

Attribute Description Data Type Required?

I10n_package

Java package containing generated LogLocalizer or TextLocalizer properties for this catalog.properties file are named after the catalog file name.

For example, for a French log message catalog called mycat.xml, a properties file called <l10n_package>.mycatLogLocalizer_fr_FR.properties is generated.

String

No.

version

Specifies the version of the I10n_msgcat.dtd being used.

Use: Must be "1.0"

Syntax: x.y where x and y are numeric.

Example: version="1.0"

String

Yes.

H.2.3 Example

The following example shows how to use the message_catalog element in log message catalog file:

<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<message_catalog 
  l10n_package="programs.utils"
  version="1.0">
  <logmessage
    messageid="600001">
    <messagebody>
      Could not open file, {0} on {1,date} after {2,number} attempts.
    </messagebody>
    <messagedetail>
      The configuration for this application will be defaulted to
      factory settings. Custom configuration information resides
      in file, {0}, created on {1,date}, but is not readable.
    </messagedetail>
    <cause>
      The user is not authorized to use custom configurations. Custom
     configuration information resides in file, {0}, created on
     {1,date}, but is not readable.The attempt has been logged to
     the security log.
    </cause>
    <action>
      The user needs to gain approriate authorization or learn to
      live with the default settings.
    </action>
  </logmessage>
</message_catalog>

H.3 logmessage

Use this element to define a formal log message.

H.3.1 Child Elements

The logmessage component configuration element supports the following child elements:

H.3.2 Attributes

Table H-2 lists the attributes of the logmessage component configuration element.

Table H-2 Attributes of the logmessage Element

Attribute Description Data Type Required?

messageid

Unique identifier for this log message. Uniqueness should extend across all catalogs. Value must be in range defined by baseid and endid attributes.

Use: Value must be in the range defined by the baseid and endid attributes defined in the message_catalog element.

Syntax: one to six decimal digits.

Example: messageid="600001"

String

Yes.

datelastchanged

Date/time stamp used for managing modifications to this message. The date is supplied by utilities that run on the catalogs.

Use: The date is supplied by utilities that run on the catalogs.

Syntax: Long.toString(new Date().getTime());

String

No.

H.3.3 Example

The following example shows how to use the logmessage element in log message catalog file:

<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<message_catalog 
  l10n_package="programs.utils"
  version="1.0">
  <logmessage
    messageid="600001">
    <messagebody>
      Could not open file, {0} on {1,date} after {2,number} attempts.
    </messagebody>
    <messagedetail>
      The configuration for this application will be defaulted to
      factory settings. Custom configuration information resides
      in file, {0}, created on {1,date}, but is not readable.
    </messagedetail>
    <cause>
      The user is not authorized to use custom configurations. Custom
     configuration information resides in file, {0}, created on
     {1,date}, but is not readable.The attempt has been logged to
     the security log.
    </cause>
    <action>
      The user needs to gain approriate authorization or learn to
      live with the default settings.
    </action>
  </logmessage>
</message_catalog>

H.4 message

Use this element to define an informal log message.

H.4.1 Child Elements

The message element supports the following child elements:

H.4.2 Attributes

Table H-3 lists the attributes of the message element.

Table H-3 Attributes of the message Element

Attribute Description Data Type Required?

messageid

Unique identifier for this log message in alpha-numeric string format. Uniqueness is required only within the context of this catalog.

String

Yes.

datelastchanged

Date/time stamp used for managing modifications to this message. The date is supplied by utilities that run on the catalogs.

Use: The date is supplied by utilities that run on the catalogs.

Syntax: Long.toString(new Date().getTime());

String

No.

H.4.3 Example

The following example shows how to use the message element in log message catalog file:

<?xml version="1.0"?> 
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<locale_message_catalog
  l10n_package="programs.utils"
  version="1.0">
  <message messageid="FileMenuTitle">
    <messagebody>
      File
    </messagebody>
  </message>
</message_catalog>

H.5 messagebody

Use this element to define a concise, one-line log message body.

H.5.1 Child Elements

The messagebody element has no child elements.

H.5.2 Attributes

The messagebody element has no attributes.

H.5.3 Example

The following example shows how to use the messagebody element in log message catalog file:

<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<message_catalog 
  l10n_package="programs.utils"
  version="1.0">
  <logmessage
    messageid="600001">
    <messagebody>
      Could not open file, {0} on {1,date} after {2,number} attempts.
    </messagebody>
    <messagedetail>
      The configuration for this application will be defaulted to
      factory settings. Custom configuration information resides
      in file, {0}, created on {1,date}, but is not readable.
    </messagedetail>
    <cause>
      The user is not authorized to use custom configurations. Custom
     configuration information resides in file, {0}, created on
     {1,date}, but is not readable.The attempt has been logged to
     the security log.
    </cause>
    <action>
      The user needs to gain approriate authorization or learn to
      live with the default settings.
    </action>
  </logmessage>
</message_catalog>

H.6 messagedetail

Use this element to define a more detailed explanation of the issue being logged.

H.6.1 Child Elements

The messagedetail element supports has no child elements.

H.6.2 Attributes

The messagedetail element has no attributes.

H.6.3 Example

The following example shows how to use the messagedetail element in log message catalog file:

<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<message_catalog 
  l10n_package="programs.utils"
  version="1.0">
  <logmessage
    messageid="600001">
    <messagebody>
      Could not open file, {0} on {1,date} after {2,number} attempts.
    </messagebody>
    <messagedetail>
      The configuration for this application will be defaulted to
      factory settings. Custom configuration information resides
      in file, {0}, created on {1,date}, but is not readable.
    </messagedetail>
    <cause>
      The user is not authorized to use custom configurations. Custom
     configuration information resides in file, {0}, created on
     {1,date}, but is not readable.The attempt has been logged to
     the security log.
    </cause>
    <action>
      The user needs to gain approriate authorization or learn to
      live with the default settings.
    </action>
  </logmessage>
</message_catalog>

H.7 cause

Use this element to define the root cause of the issue being logged.

H.7.1 Child Elements

The cause element supports has no child elements.

H.7.2 Attributes

The cause element has no attributes.

H.7.3 Example

The following example shows how to use the cause element in log message catalog file:

<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<message_catalog 
  l10n_package="programs.utils"
  version="1.0">
  <logmessage
    messageid="600001">
    <messagebody>
      Could not open file, {0} on {1,date} after {2,number} attempts.
    </messagebody>
    <messagedetail>
      The configuration for this application will be defaulted to
      factory settings. Custom configuration information resides
      in file, {0}, created on {1,date}, but is not readable.
    </messagedetail>
    <cause>
      The user is not authorized to use custom configurations. Custom
     configuration information resides in file, {0}, created on
     {1,date}, but is not readable.The attempt has been logged to
     the security log.
    </cause>
    <action>
      The user needs to gain approriate authorization or learn to
      live with the default settings.
    </action>
  </logmessage>
</message_catalog>

H.8 action

Use this element to define how to fix the issue being logged, if possible.

H.8.1 Child Elements

The action element supports has no child elements.

H.8.2 Attributes

The action element has no attributes.

H.8.3 Example

The following example shows how to use the action element in log message catalog file:

<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC 
   "weblogic-locale-message-catalog-dtd"
   "http://www.bea.com/servers/wls90/dtd/l10n_msgcat.dtd">
<message_catalog 
  l10n_package="programs.utils"
  version="1.0">
  <logmessage
    messageid="600001">
    <messagebody>
      Could not open file, {0} on {1,date} after {2,number} attempts.
    </messagebody>
    <messagedetail>
      The configuration for this application will be defaulted to
      factory settings. Custom configuration information resides
      in file, {0}, created on {1,date}, but is not readable.
    </messagedetail>
    <cause>
      The user is not authorized to use custom configurations. Custom
     configuration information resides in file, {0}, created on
     {1,date}, but is not readable.The attempt has been logged to
     the security log.
    </cause>
    <action>
      The user needs to gain approriate authorization or learn to
      live with the default settings.
    </action>
  </logmessage>
</message_catalog>