Web Services Security Guides › CA SiteMinder® Web Services Security Agent Guide for Apache-based Web Servers › SiteMinder WSS Agent Logging › How to Set Log Files, and Command-line Help to Another Language

How to Set Log Files, and Command-line Help to Another Language

The following components support log files, and command-line help in other languages:

• The Policy Server
• The Web Agent
• The Report Server
• The CA SiteMinder® Agent for SharePoint
• The CA SiteMinder® SPS
• SiteMinder WSS Agents
• Any custom software that is created with the CA SiteMinder® SDK.

The following graphic describes the work flow for setting log files, and command-line help to another language:

Follow these steps:

1. Determine the IANA code for your language.
2. Create the environment variable for your operating environment using one of the following procedures:
   • Set the locale variable on Windows operating environments.
   • Set the locale variable on UNIX or Linux operating environments.
3. (Optional) Verify the locale variable setting on windows operating environments.
4. (Optional) Repeat Steps 1 through 3 to set any other components in your environment to the same language.

Determine the IANA Code for Your Language

Each language has a unique code. The Internet Assigned Numbers Authority (IANA) assigns these language codes. Adding a language code to a locale variable changes the language that the software displays. Determine the proper code for the language that you want before creating the locale variable.

The following table lists the IANA codes that correspond to the languages supported by the software:

Note: A list of IANA language codes is available from this third-party website.

Environment Variables

The environment variables are settings by which users can customize a computer to suit their needs. Examples of environment variables include the following items:

• A default directory for searching or storing downloaded files.
• A username.
• A list of locations to search for executable files (path).

Windows operating environments allow global environment variables, which apply to all users of a computer. The environment variables on UNIX or Linux operating environments must be set for each user or program.

To set the locale variable, pick the procedure for your operating environment from the following list:

• Set the locale variable on Windows operating environments.
• Set the locale variable on UNIX or Linux operating environments.

Set the Locale Variable on Windows Operating Environments

The following locale variable specifies the language settings for the software:

SM_ADMIN_LOCALE

Create this variable and set it to the language that you want. Set this variable on each component for which you want to use another language. For example, suppose you want to have a Policy Server and an agent that is set to French. Set this variable on both of those components to French.

Note: The installation or configuration programs do not set this variable.

Follow these steps:

1. Click Start, Control Panel, System, Advanced system settings.

   The system properties dialog appears.

2. Click the Advanced tab.
3. Click Environment Variables.
4. Locate the System variables section, and then click New.

   The New System Variable dialog opens with the cursor in the Variable name: field.

5. Type the following text:

   SM_ADMIN_LOCALE
   

6. Click the Variable name: field, and then type the IANA language code that you want.
7. Click OK.

   The New System Variable dialog closes and the SM_ADMIN_LOCALE variable appears in the list.

8. Click OK twice.

   The locale variable is set.

9. (Optional) Repeat Steps 1 through 8 to set other components to the same language.

Verify the Locale Variable Value on Windows Operating Environments

You can very the value to which the locale variable is set at any time. You can do this procedure after setting the variable to confirm that it is set correctly.

Note: Instructions for verifying the variable value on UNIX and Linux are in the setting procedure.

Follow these steps:

1. Open a command-line window with the following steps:
   1. Click Start, Run.
   2. Type the following command:

      cmd
      

   3. Click OK.

      A command-line window opens.

2. Enter the following command:

   echo %SM_ADMIN_LOCALE%
   

   The locale appears on the next line. For example, when the language is set to German, the following code appears:

   de
   

   The value of the locale variable is verified.

Set the Locale Variable on UNIX or Linux Operating Environments

The following locale variable specifies the language settings for the software:

SM_ADMIN_LOCALE

Create this variable and set it to the language that you want. Set this variable on each component for which you want to use another language. For example, suppose you want to have a Policy Server and an agent that is set to French. Set this variable on both of those components to French.

Note: The installation or configuration programs do not set this variable.

Follow these steps:

1. Log in to the computer that is running the component that you want.
2. Open a console (command-line) window.
3. Enter the following command:

   export SM_ADMIN_LOCALE=IANA_language_code
   

   The command in the following example sets the language to French:

   export SM_ADMIN_LOCALE=fr
   

   The locale variable is set.

4. (Optional) Verify that the locale variable is set properly by entering the following command:

   echo $SM_ADMIN_LOCALE
   

   The locale appears on the next line. For example, when the language is set to German, the following code appears:

   de
   

5. (Optional) Repeat Steps 1 through 4 to set other components to the same language.