Skip to Main Content
Return to Navigation

Setting Domain-Level Environment Variables

This section provides an overview and discusses:

Understanding Domain-Level Environment Settings

Environment settings can be set at the following levels:

  • Operating System: At this level, the environment settings apply to all processes running at that time on the host, such as PS_CFG_HOME.

  • Domain: At this level, you can specify settings that apply to only that domain. That is you can override any operating system environment settings, as well as any that come by default from the higher-level configuration file (.UBX).

Note: Setting a variable at the domain-level overrides the variable set in the parent environment. Variables like PS_HOME and PS_CFG_HOME cannot be set at the domain level.

The settings you modify or add for that domain will be saved in the *PS_ENVFILE section one of the following files, depending on the domain type:

  • psappsrv.ubx

  • psprcsrv.ubx

  • pssrchsrv.ubx

When the configuration settings are loaded for that domain, then these settings will also be reflected in the .env file for that domain.

Working with Domain-Level Environment Settings

To set domain level environment settings, select Edit Environment Settings from the Quick-configure menu for an application server, Process Scheduler server.

Note: There is no Quick-configure menu for the search server (Verity), however when you configure the domain, PSADMIN prompts to determine if you want to manage your domain environment variables.

The following example displays application server domain settings.

--------------------------------------
PeopleSoft Domain Environment Settings
--------------------------------------
     Domain Name: ORCLDMO1

     TM_BOOTTIMEOUT           :[120]
     TM_RESTARTSRVTIMEOUT     :[120]
     TM_BOOTPRESUMEDFAIL      :[Y]
     FLDTBLDIR32              :[{$TUXDIR}{FS}udataobj]
     FIELDTBLS32              :[jrep.f32,tpadm]
     ALOGPFX                  :[{LOGDIR}{FS}TUXACCESSLOG]
     COBPATH                  :[{$PS_APP_HOME}\CBLBIN%PS_COBOLTYPE%;
{$PS_HOME}\CBLBIN%PS_COBOLTYPE%]
     INFORMIXSERVER           :[{$Startup\ServerName}]
   # IPC_EXIT_PROCESS         :[1]
     IPC_TERMINATE_PROCESS    :[1]
     PATH                     :[{$PS_HOME}\verity\{VERITY_OS}
\{VERITY_PLATFORM}\bin;{$PATH};{$Domain Settings\Add to PATH}]




  1) Edit environment variable
  2) Add environment variable
  3) Remove environment variable
  4) Comment / uncomment environment variable
  5) Show resolved environment variables
  6) Save
  h) Help for this menu
  q) Return to previous menu
Edit environment variable

Enables you to edit the values of the listed environment settings. After selecting this option, enter the row number of the environment setting you want to edit, and modify the value as needed.

Environment variable: TM_BOOTTIMEOUT
Enter value [120]:150

For any settings that you modify, the system displays an asterisk next to it (*).

Add environment variable

Use this option to add new environment variables for the domain. After selecting this option, enter the name of the environment variable and its value when prompted.

Enter name of environment variable: MY_VARIABLE
Enter value: D:\PSFT_HCM

For any settings that you add, the system displays an asterisk next to it (*).

Remove environment variable

Removes any of the currently listed environment settings. After selecting this option, enter the row number of the environment setting you want to remove.

Comment / uncomment environment variable

Use to comment or uncomment the environment setting. When you comment a setting, the system ignores that domain-level setting. Any default, or operating system-level settings would take effect. When you uncomment the setting, the system recognizes the domain-level setting value.

After selecting this option, enter the row number of the environment setting you want to comment or uncomment.

Environment variables that are commented (ignored by the system), have a # symbol next to it.

Show resolved environment variables

Expands the meta variables for system settings, such as PS_HOME, TUXDIR, and so on, so that you can view the actual file path.

For example, the following is unresolved:

:[{LOGDIR}{FS}TUXACCESSLOG]

And the following is resolved:

:[D:\PT_SERVER\8.52\appserv\FSDMO852\LOGS\TUXACCESSLOG]
Save

Select to save the settings you've added or modified.

Help for this menu

Select to display online help information for this interface.

Setting Domain-Level Environment Variables

In most cases, you may not need to modify or add domain-level environment variables.

Some reasons to set a domain-level environment variable are:

  • custom PeopleCode may require a domain-level environment variable.

  • additional tracing may require additional Tuxedo environment variables, if specified in your Tuxedo documentation.

  • a GCS analyst may request a specific environment setting for troubleshooting issues.

Note: PS_HOME, PS_CFG_HOME, PS_APP_HOME and PS_CUST_HOME environment variables should not be set at the domain-level and can cause undesirable results if set at the domain level.

The following table describes the default environment settings exposed at the domain level:

Server Type

Environment Setting

Description

Application Server

TM_BOOTTIMEOUT

Time allowed before Tuxedo performs a timeout for a domain boot.

 

TM_RESTARTSRVTIMEOUT

Time allowed before Tuxedo performs a timeout for a server process restart.

 

TM_BOOTPRESUMEDFAIL

TM_BOOTPRESUMEDFAIL is an indicator to the Tuxedo system that dictates how the domain should behave if a process fails to start before TM_BOOTTIMEOUT (above) has been reached.

When set to Y, no further domain processes will be started and any existing domain processes will be terminated.

If set to N, the boot process will proceed. By default, this is set toY because domains cannot be relied upon to function correctly if any of the domain processes fail to start in a timely fashion.

 

FLDTBLDIR32

The directory in which field buffer descriptor files are located. This is an internal Tuxedo setting.

Modification of this value could result in unpredictable behavior as Tuxedo will be unable to locate its buffer descriptor files.

 

FIELDTBLS32

The list of the buffer descriptor files that are required by the domain runtime. These files are located in the directory defined by the FLDTBLDIR32 variable. This is an internal Tuxedo setting.

Modification of this value could result in unpredictable behavior as Tuxedo may allocate buffers incorrectly.

 

ALOGPFX

Path to the Tuxedo access log for that domain.

 

COBPATH

COBOL path for that domain.

 

INFORMIXSERVER

(Applies only to Informix database connections) Specifies the default database server to which an explicit or implicit connection is made.

 

IPC_EXIT_PROCESS

Indicates that the process should be shutdown in a graceful fashion, allowing cleanup functions to execute.

This is analogous to normal shutdown and is achieved by using the MS C++ ExitProcess function.

Typically this value or IPC_TERMINATE_PROCESS is set. These values should be considered to be mutually exclusive.

 

IPC_TERMINATE_PROCESS

IPC_TERMINATE_PROCESS is an indication that the process should exit immediately.

This is analogous to a process kill or forced shutdown. The exit handlers do not have an opportunity to run. This would typically be used in a situation where the process has failed to respond to a normal shutdown instruction.

Typically this value or IPC_EXIT_PROCESS is set. These values should be considered to be mutually exclusive.

 

PATH

Specifies a set of directories where executable programs are located for that domain.

Process Scheduler Server

COBPATH

See COBPATH explanation for application server.

 

INFORMIXSERVER

See INFORMIXSERVER explanation for application server.

 

PATH

See PATH explanation for application server.

Search Server (Verity)

TM_RESTARTSRVTIMEOUT

Time allowed before Tuxedo performs a timeout on a server process restart.

 

TM_RESTARTSRVTIMEOUTKILL

TM_RESTARTSRVTIMEOUTKILL is an indication to the Tuxedo system that a process that hangs on restart should be killed.

 

IPC_EXIT_PROCESS

See IPC_EXIT_PROCESS explanation for application server.

 

IPC_TERMINATE_PROCESS

See IPC_TERMINATE_PROCESS explanation for application server.

 

PATH

See PATH explanation for application server.