LookupMessage Method for an Application

The LookupMessage method returns message text for a key. It returns this information in the current language.

Format

Application.LookupMessage (category, key, [arg1], [arg2],...., [argN])

The following table describes the arguments for the LookupMessage method.

Argument Description

category

Name of the Message Category object that is the parent of the Key value. You can define this value in Siebel Tools.

key

Name of the Message object whose text contains the value that Siebel CRM must format. You can define this value in Siebel Tools.

Other arguments:

  • arg1

  • arg2

  • argN

If the error message contains a substitution argument, such as %1, then Siebel CRM uses these optional arguments to format the error message.

Usage

Useful for retrieving locale specific custom error messages.

Used With

Server Script

Examples

The following Siebel eScript example returns the following text:

Enter Account Title before stepping off.

To test this code in the User Defined Errors message category, create a new record with the following text:

Enter %1 before stepping off.

Siebel CRM uses the Account Title parameter to substitute the %1 variable:

var sVal = TheApplication().LookupMessage("User Defined Errors", "Test", "Account 
Title");