Messages Folder

The Messages folder, residing in the Administration cabinet, contains message form documents that contain message strings that are substituted for message keys in the browser user interface and posted emails; message files also enable a multi-language user interface.

The message documents define all text strings used in the user interface and email correspondence. By default, the Messages folder contains two flavors of documents:

Document Flavor	Description
'message' flavor	Contains message key and message value pairs for message definitions. The message key defines the name of the message and the message value defines the text displayed to the user. The message value may contain parameters that enable Astoria to insert parameters into a message so it can include dynamic information in a multi-language safe way. These parameters are indicated by braces surrounding a single digit. For example, "{0} was updated by {1}" would be a message value with two parameters. To put a left brace in a message, use two consecutive left braces: {{. By default, there are several documents of the 'message' flavor in the Messages folder: messages_ALL. Contains messages that should not be translated. These are usually values that are stored internally in the repository. The user rarely needs to modify this document. messages_enUS. Contains US English message strings, for general system messages and display strings. definitionsMessages_enUS. Contains US English message strings for Label and Tip strings for Fields and Repeat Groups. In addition, there may be application-specific message files. As with all Webform documents in Astoria, message files are represented in XML. When a message file is checked in, transformations generate equivalent files in jython and xslt formats.
'shadowParameters' flavor	Defines the transformations to be performed when the Messages file is checked in. This document does not require updating because it is set up during installation to carry out the required transformations when the message file is changed.

Document Flavor

Description

'message' flavor

Contains message key and message value pairs for message definitions. The message key defines the name of the message and the message value defines the text displayed to the user. The message value may contain parameters that enable Astoria to insert parameters into a message so it can include dynamic information in a multi-language safe way. These parameters are indicated by braces surrounding a single digit. For example, "{0} was updated by {1}" would be a message value with two parameters.

To put a left brace in a message, use two consecutive left braces: {{.

By default, there are several documents of the 'message' flavor in the Messages folder:

messages_ALL. Contains messages that should not be translated. These are usually values that are stored internally in the repository. The user rarely needs to modify this document.
messages_enUS. Contains US English message strings, for general system messages and display strings.
definitionsMessages_enUS. Contains US English message strings for Label and Tip strings for Fields and Repeat Groups.

In addition, there may be application-specific message files.

As with all Webform documents in Astoria, message files are represented in XML. When a message file is checked in, transformations generate equivalent files in jython and xslt formats.

'shadowParameters' flavor

Defines the transformations to be performed when the Messages file is checked in. This document does not require updating because it is set up during installation to carry out the required transformations when the message file is changed.

If you wish to modify the default messages in ACS, or if you wish to add new messages, you must create a new message document. Right-click the Messages folder, and select Administration > Create Form > New Message Document. You can override messages that exist in the Astoria Software supplied message documents, or you can add new message keys/values.

Note: Do not copy Astoria Message Documents then modify the values you wish to change. Subsequent Astoria upgrades will change values of some message keys and your override documents will still have the old values. The probability of introducing errors is high if you utilize this technique. Use the Message Validation Report command to help you cleanup your message documents.

Note: The order of message documents in the Messages folder is important. The later documents override the previous documents. Message documents you create are placed at the end of the list, so customer message files override Astoria supplied message files.

Note: Do not modify the Astoria Software supplied message documents. Any changes you make are subject to being replaced the next time your system is upgraded.