SOAM section

The SOAM section contains configuration related to system behavior such as session manager, service instance manager, and how Symphony writes data to disk.

version

The version of the Symphony middleware.

Where used

SOAM

Required/Optional

Optional—When the version is not included, the application will run on the latest version of Symphony available in the cluster.

Valid values

3.1 or higher

Example

version="5.1"

SOAM>SSM section

Configuration related to session manager behavior.

startUpTimeout

Number of seconds to wait for the session manager to start up before the session director considers it as timed out.

When the process times out, the session director requests EGO to replace the session manager host and tries again to start a new session manager.

The session manager is started when Symphony is started if prestartApplication is true for the enabled application. Otherwise, the session manager is started when a client connects to an enabled application, which does not have running session manager and prestartApplication is false.

Where used

SOAM > SSM

Required/Optional

Optional

Valid values

1 or more

Default value

60 seconds

Related attributes

preStartApplication—Influences when the session manager and service instance manager are started, when Symphony starts or when Symphony receives a request from a client of this application

shutDownTimeout

Number of seconds to wait for the session manager to shut down before the session director considers it as timed out and restarts the session manager.

The session manager should shut down within the timeout period when the related application is unregistered or disabled.

Where used

SOAM > SSM

Required/Optional

Optional

Valid values

1 or more

Default value

300 seconds

disableFlowControl

For internal system use only.

resReq

String that describes criteria for selecting resources allocated to the session director to start the session manager.

This is not applicable for Symphony DE.

Where used

SOAM > SSM

Required/Optional

Optional

Default value

" " (empty)—SSM can run on any hosts in the resource groups configured in resourceGroupName in the SOAM > SSM section. By default, the resourceGroupName is ManagementHosts.

Synopsis

"select(select_string)""select(select_string) order(order_string)"

Related Attributes

  • resourceGroupName in SOAM > SSM—Resource group from which resources are requested to run session managers.

Description

A resource requirement string describes the criteria for defining a set of resources to run session managers. Session managers should run on management hosts. If you have changed the default value of resourceGroupName, you must indicate the select string

"select(mg)" 
so that only management hosts are selected to run the session managers. Running the session manager on a management host is essential for reliability and recovery.

The entire resource requirement string cannot contain more than 512 characters.

Options

select(select_string)

Specifies the criteria for selecting the resources. The selection string filters out the resources that do not meet the criteria, resulting in a list of one or more eligible resources.

The parentheses must be typed as shown.

order(order_string)

Specifies the sort order for selecting the best resource from the list of eligible resources. The most appropriate resource is listed first, the least is listed last.

The parentheses must be typed as shown.

select

select synopsis

select(expression)select(expression operator expression)select((expression operator expression) operator expression)

select description

The selection string is a logical expression used to select one or more resources to match one or more criteria. Any resource that satisfies the criteria is selected.

resource_name operator value
resource_name

The following resources can be used as selection criteria.

Static resources

Static resources are built-in resources that represent host information that does not change over time, such as the maximum RAM available to user processes or the number of processors in a machine. Most static resources are determined at start-up time, or when hardware configuration changes are detected.

Static resources can be used to select appropriate hosts based on binary architecture, relative CPU speed, and system configuration.

Note:

The resources ncpus, ncores, nprocs, nthreads, maxmem, maxswp, and maxtmp are not static on UNIX hosts that support dynamic hardware reconfiguration.


Index

Measures

Units

Determined by

type

host type

string

configuration

model

host model

string

configuration

hname

host name

string

configuration

cpuf

CPU factor

relative

configuration

server

host can run remote jobs

Boolean

configuration

rexpri

execution priority

nice(2) argument

configuration

ncpus

number of processors

processors

LIM

ndiks

number of local disks

disks

LIM

maxmem

maximum RAM

MB

LIM

maxswp

maximum swap space

MB

LIM

maxtmp

maximum space in /tmp

MB

LIM


CPU factor (cpuf)

The CPU factor is the speed of the host’s CPU relative to other hosts in the cluster. If one processor is twice the speed of another, its CPU factor should be twice as large. CPU factors are defined by the cluster administrator. For multiprocessor hosts, the CPU factor is the speed of a single processor.

Server

The server static resource is Boolean. It has the following values:

  • 1 if the host is configured to run jobs from other hosts.

  • 0 if the host is a client for submitting jobs to other hosts.

operator
The following operators can be used in selection strings. If you are using the selection string in an XML format, you must use the applicable escape characters in the XML Equivalence column. The operators are listed in order of decreasing precedence:

Operator

XML Equivalent

Syntax

Meaning

!

n/a

!a

Logical NOT: 1 if a==0, 0 otherwise

*

n/a

a*b

Multiply a and b

/

n/a

a / b

Divide a by b

+

n/a

a+b

Add a and b

-

n/a

a-b

Subtract b from a

>

>

a > b

1 if a is greater than b, 0 otherwise

<

&lt;

a < b

1 if a is less than b, 0 otherwise

>=

&gt;=

a >= b

1 if a is greater than or equal to b, 0 otherwise

<=

&lt;=

a <= b

1 if a is less than or equal to b, 0 otherwise

==

n/a

a == b

1 if a is equal to b, 0 otherwise

!=

n/a

a != b

1 if a is not equal to b, 0 otherwise

&&

&amp;&amp;

a && b

Logical AND: 1 if both a and b are non-zero, 0 otherwise

||

n/a

a || b

Logical OR: 1 if either a or b is non-zero, 0 otherwise


value

Specifies the value to be used as criteria for selecting a resource. Value can be numerical, such as when referring to available memory or swap space, or it can be textual, such as when referring to a specific type of host.

Example: Simple selection expression using static resources

The following example selects resources with total memory greater than 500MB:
select(maxmem &gt; 500) 

Example: Compound selection expression using static resources

The following example selects resources with total memory greater than 500MB and total swap space greater than or equal to 300MB:
select(maxmem &gt; 500 &amp;&amp; maxswp &gt;=300) 

order

Sorts the selected resources into an order of preference according to the values of the resources.

order synopsis

order(order_string)

order description

The order string acts on the results of a select string, sorting the selected resources to identify the most favorable resources, and eliminate the least desirable resources.

Resources are sorted into ascending order based on the result of an arithmetical expression.

The result orders the resources from smallest to largest.

order_string

Specify an arithmetic expression that expresses the desired outcome.

You can create an expression using operators and numbers.

Use the following operators:

+

add

subtract-

*

multiply

/

divide

Order resources based on available swap space

The following example orders the selected resources based on their available swap space, but sorts by descending order, ordering hosts with the greatest amount of available swap space first:
order(0-swp) 

resourceGroupName

Resource group from which resources are requested to run session managers. The resource group should be a management host resource group and must be an existing resource group in EGO.

Not required for Symphony DE.

Where used

  • SOAM >SSM

Required/Optional

Optional

Default value

If the resource group is not defined, the system selects resources from the ManagementHosts group to start the session manager.

Related attributes

  • resReq in SOAM > SSM—Specifies the criteria for selecting resources to start the session manager. Resources will only be selected from resource groups specified by resourceGroupName .

workDir

Absolute path in which the session manager process stores data for operations, including paging, journaling and history files.

Paging, journaling, and history data files are saved in subdirectories under the workDir if a relative path is configured for the paging, journaling, and data history paths.

This is not applicable in Symphony DE. In Symphony DE the working directory of the session manager is:

  • Windows— %SOAM_HOME%\work

  • Linux— $SOAM_HOME/work

Where used

  • SOAM > SSM

Required/Optional

Optional

Valid values

Any accessible absolute path on the network or local disk. To facilitate the session manager recovery, workDir should be set to a directory on a shared file system.

Default value

By default, the session manager working directory is the same for all applications. If applications are configured to write to the same directory, the operating system user accounts assigned to start the session manager must have access to that directory. It is recommended that all operating system execution users who start the session managers be in the same primary user group.

If a shared directory is configured in the cluster, the default working directory for the session manager points to the shared location in the host on which session manager runs:

  • ${EGO_SHARED_TOP}/soam/work

If there is no shared directory configured in the cluster, then the default working directory points to the local location in the host on which session manager runs:

  • Windows—%EGO_CONFDIR%\..\..\soam\work

  • Linux—$EGO_CONFDIR/../../soam/work

SSMResPubPluginCmd

Start-up command including path that launches the data-aware scheduling plug-in process. This process is used in conjunction with an external application to request the location and cost values for preferred user-defined service attributes.

Parameter SSMResPubPluginCmd supports substitution with the following Symphony variables:

  • SOAM_HOME

  • VERSION_NUM

  • EGO_CONFDIR

  • EGO_SHARED_TOP

  • EGO_MACHINE_TYPE

For example:

SSMResPubPluginCmd="${SOAM_HOME}/${VERSION_NUM}/${EGO_MACHINE_TYPE}/bin/MyPlugin"

Where used

  • SOAM > SSM

Required/Optional

Optional

Valid values

Any location accessible on your network or local disk.

SSMResPubCacheEnabled

Specifies whether caching is enabled for results received from the plug-in so that subsequent calls for the same attributes will return cached values.

Where used

  • SOAM > SSM

Required/Optional

Optional

Valid values

true | false

Default value

true

SOAM>SSM>boundaryManagerConfig>elementDefinitions>boundaryElement

For internal system use only.

name

For internal system use only.

description

For internal system use only.

minValue

For internal system use only.

maxValue

For internal system use only.

SOAM>SSM>boundaryManagerConfig>elementDefinitions>boundaryElement>additionalConfig

For internal system use only.

name

For internal system use only.

value

For internal system use only.

SOAM >SSM > boundaryManagerConfig>boundaries>boundary

elementName

Specifies how the system responds to changes in the amount of physical memory, virtual memory, or virtual address space on the session manager host.

  • AvailableMemory—The boundary manager monitors the amount of virtual memory available on the host. Virtual memory is physical memory plus swap memory that is available on the host.

  • AvailableVirtualAddressSpace—The boundary manager monitors the amount of virtual address space the session manager can use to map memory. It is possible for the host to have more than enough memory available, which is physical memory plus swap memory, but the process cannot access anymore because it has no available address space to map this memory to.

  • ProcessMemory—The boundary manager monitors the amount of physical memory that is available for each process.

Where used

SOAM > SSM > boundaryManagerConfig > boundaries > boundary

Required/Optional

Optional

Valid values

AvailableMemory | AvailableVirtualAddressSpace | ProcessMemory

Related attributes

  • name (event)—Multiple boundary events are associated with each elementName

  • value (event)—A value is assigned to each boundary event

  • name (param)—The MaxSizeReference parameter is associated with AvailableVirtualAddressSpace and ProcessMemory

  • value (param)—A value is assigned to the MaxSizeReference parameter

SOAM >SSM > boundaryManagerConfig>boundaries>boundary>event

name (event)

Specifies the name of the boundary event that triggers a system response when the value of the event is reached.

The system monitors the boundaries defined, available memory, and available virtual address space, to ensure the robust functionality of the session manager. Messages are logged to the session manager log file and administrators are notified through event notification when new event are triggered..

Memory low conditions can be caused by:

  • Running too many memory -consuming processes on the session manager host

  • Too many unprocessed input and output messages

  • Too many unfinished sessions or tasks

The following describes system reactions when a boundary limit is reached:


Boundary event

Messages

Workload processing changes

System processing changes

BEV_PROACTIVE

INFO

The SSM starts to page data, which can lead to slower input handling. The impact is dependent on message size, disk speed, etc.

Starts scheduling common data and input/output messages for paging.

BEV_SEVERE

WARNING

  • The SSM starts to release already paged data from memory. This will impact the time to dispatch tasks as they must be read back into memory before being dispatched.

  • The session manager allows clients to create new sessions and submit new tasks. These actions were prohibited by the session manager after the BEV_CRITICAL event was triggered.

Assigns higher priority to paging write requests, memory is released once the messages are paged out

BEV_CRITICAL

WARNING

  • New connections from the client to the session manager are rejected

  • New session creations and tasks submissions are held until a lower level event is triggered such as BEV_SEVERE or BEV_PROACTIVE

Assigns higher priority to paging write requests

BEV_HALT

FATAL

  • All new session and client requests are rejected

  • Processing of existing requests is stopped

  • Runs in maintenance mode

  • Only cluster administrator can access workload through the console

  • Once memory drops down, and BEV_SEVERE or BEV_PROACTVE is triggered, the session manager resumes work


Memory low conditions can be corrected by:

  • Running the session manager on a dedicated management host

  • Adding more physical memory or increasing the amount of assigned swap memory

  • Terminating any faulty sessions that are consuming excessive amounts of memory

  • Terminating any nominal sessions to release memory

Where used

SOAM > SSM > boundaryManagerConfig > boundaries > boundary > event

Required/Optional

Optional

Valid values

BEV_PROACTIVE | BEV_SEVERE | BEV_CRITICAL | BEV_HALT

Related attributes

  • elementName—The name of the system resource monitored by the boundary manager

  • value (event)—The minimum value the system resource can reach before the event is triggered

value (event)

Specifies the value of a boundary event as a percentage of the entire resource available.

When the availability of the resource monitored falls below the boundary event value, it triggers a system response to ensure the session manager has enough memory to function.

Where used

SOAM > SSM > boundaryManagerConfig > boundaries > boundary > event

Required/optional

Optional

Valid values

0 or more

Default values

The following describes the element names, event names, and their default boundary values:


elementName / event name

BEV_PROACTIVE

BEV_SEVERE

BEV_CRITICAL

BEV_HALT

AvailableMemory

50

40

25

15

AvailableVirtualAddressSpace

50

40

25

15

ProcessMemory

0

0

0

0


Related attributes

  • elementName—Specifies the resource to which the boundary applies.

  • name (event)—Specifies the boundary event for which a value is assigned.

SOAM >SSM > boundaryManagerConfig>boundaries>boundary>param

name (param)

Specifies the name of the boundary parameter. The boundary parameter and its associated value are used as a reference against which boundary events are triggered for AvailableVirtualAddressSpace and ProcessMemory.

The system monitors the boundaries defined to ensure the robust functionality of the session manager. Messages are logged to the session manager log file and administrators are notified through event notification when new events are triggered.

For a description of system reactions when boundary events occur, refer to the description for SOAM > SSM > boundaryManagerConfig > boundaries > boundary > event.

Where used

SOAM > SSM > boundaryManagerConfig > boundaries > boundary > param

Required/Optional

Optional

Valid values

MaxSizeReference

Related attributes

  • elementName—The name of the system resource monitored by the boundary manager

  • value (param)—The minimum value the system resource can reach before the event is triggered

value (param)

The value is used in conjunction with events BEV_PROACTIVE, BEV_SEVERE, BEV_CRITICAL, BEV_HALT. When the value of MaxSizeReference is defined, the percentage associated with the boundary events is a ratio based on this value instead of the default value.

  • For element AvailableVirtualAddressSpace, the value of MaxSizeRefereence defines the maximum virtual address space in MB. If the value of MaxSizeReference is not defined or is not valid, the default value of 2G (for 32 bit OS) and 8T (for 64 bit OS) is used.

  • For element "ProcessMemory", the value of MaxSizeReference defines the quota of the memory size for the SSM in MB. If the value of MaxSizeReference is not defined or is not valid, the default value of 2G (for 32 bit OS) and 8T (for 64 bit OS) is used.

Where used

SOAM > SSM > boundaryManagerConfig > boundaries > boundary > param

Required/optional

Optional

Valid values

0 or more; if 0 is defined, the default value is used (8T for 64 bit OS and 2G for 32 bit OS)

Related attributes

  • elementName—Specifies the resource (ProcessMemory or AvailableVirtualAddressSpace) to which the boundary applies.

  • name (param)—Specifies the boundary for which a value is assigned.

SOAM>SSM>boundaryManagerConfig>globalConfig

For internal system use only.

name

For internal system use only.

value

For internal system use only.

SOAM>SIM

blockHostOnTimeout

Used with the startUpTimeout (SOAM > SIM) attribute. Defines whether to block this host for the application when the service instance manager times out on process startup. If set to true, when the service instance manager times out on startup, the host is added to the blocked host list and is no longer used for the application unless the host is explicitly unblocked through the Platform Management Console.

Symphony DE blocks slots rather than hosts. Slots can be unblocked by disabling and enabling your application.

Where used

SOAM > SIM

Required/Optional

Optional

Valid values

true | false

Default value

true, host is added to the blocked host list for the application upon timeout

Related attributes

startUpTimeout (SOAM > SIM)

blockHostOnVersionMismatch

For internal system use only.

startUpTimeout

Number of seconds to wait for the service instance manager to start up before the session manager considers it as timed out. This parameter works in conjunction with blockHostOnTimeout.

After a session manager starts a service instance manager, if the service instance manager cannot contact the session manager within the startUpTimeout, the session manager requests a new host from EGO and tries to start a new service instance manager on the new host.

Where used

SOAM > SIM

Required/Optional

Optional

Valid values

1 or more

Default value

120 seconds

Related attributes

  • blockHostOnTimeout—Determines whether the host is blocked if timeout occurs on SIM startup.

SOAM>DataHistory

Parameters related to sessions and tasks historical data storage.

pollFrequency

Specifies the frequency, in seconds, at which the history files are polled to determine if the current file should be archived.

Where used

SOAM > DataHistory

Required/Optional

Optional

Valid values

1 to 10 (inclusively)

Default value

10 seconds

Related attributes

  • fileSwitchSize—Defines, according to file size, when old history files are archived and new history files are started

  • fileSwitchTime—Defines, according to file age, when old history files are archived and new history files are started

fileSwitchSize

Maximum size, in megabytes, the history file can reach before the file is archived at the next polling interval.

When the history file reaches the maximum size specified, the file is renamed by appending a time stamp to the file name.

Data history file names have the following format:

applicationName_session.soamdb or applicationName_task.soamdb

After renaming the file names would be similar to the following:

applicationName_session.soamdb.yyyy_mm_dd_hh_mm_ss_x

applicationName_task.soamdb.yyyy_mm_dd_hh_mm_ss_x

Where used

SOAM > DataHistory

Required/Optional

Optional

Valid values

1 to 100 (inclusively)

Default value

100 MB

Related attributes

pollFrequency—The size of the file is checked at the time interval defined by pollFrequency

fileSwitchTime

Maximum number of hours that can elapse before the history file is archived at the next polling interval.

When the history file reaches the maximum age specified, the file is renamed by appending a time stamp to the file name.

Data history file names have the following format:

applicationName_session.soamdb or applicationName_task.soamdb

After renaming the file names would be similar to the following:

applicationName_session.soamdb.yyyy_mm_dd_hh_mm_ss_x

applicationName_task.soamdb.yyyy_mm_dd_hh_mm_ss_x

Where used

SOAM > DataHistory

Required/Optional

Optional

Valid values

1 to 168(1 week)

Default value

24 hours

Related attributes

pollFrequency—The age of the file is checked at the time interval defined by pollFrequency

lastingPeriod

Number of hours the archived history files are retained before deleted.

Where used

SOAM > DataHistory

Required or optional

Optional

Range or valid values

1 to 168 (1 week)

Default value

96 hours (4 days)

lastingPeriodInSeconds

For internal system use only.

path

Absolute or relative path in which session and task historical files are stored. If relative path is specified, the directory is located under session manager working directory. The path should be accessible by both session director and session manager, so that the session and task historical data can be retrieved by command line and PMC.

Note:

Ensure the user account running the session director (cluster administrator), and the user account running the session manager for the application (os execution account assigned to the consumer) has access to the directory.

By default, history files are saved under the following locations:

  • For Symphony,

    • Windows—%EGO_CONFDIR%\..\..\soam\work\history

    • Linux—$EGO_CONFDIR/../../soam/work/history

  • For Symphony DE,

    • Windows—%SOAM_HOME%\work\history

    • Linux—$SOAM_HOME/work/history

If you specify an absolute path, all the history files are saved in the specified path. An absolute path must be accessible by both session director and the session manager for this application.

Where used

  • SOAM > DataHistory

Required/Optional

Optional

Valid values

Any absolute or relative path on network or local disk which can be accessed by both session director and session manager.

Default value

By default, data history files are saved in the "history" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

delimiter

For internal system use only.

SOAM>PagingTasksInput

Parameters related to task input message paging configurations.

path

Directory where paging files for task input are stored. The path to the file can be specified as a relative or absolute path. If a relative path is specified, paging files are saved in a subdirectory relative to the session manager working directory. The specified directory must be accessible from all management hosts to facilitate session manager failover.

Where used

  • SOAM > PagingTasksInput

Required/Optional

Optional

Valid values

Any accessible absolute or relative path on network or local disk that can be accessed from all management hosts.

Default values

By default, paging files are saved in the "paging" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

blockSize

Specifies the number of bytes per block for paging. The block size should be large enough to contain the largest message. If the block size is not large enough, the data is spread across multiple blocks, which can slow down paging processes.

Consider the size of the largest input message when determining the optimal blocksize for paging input tasks

Where used

  • SOAM > PagingTasksInput

Required/Optional

Optional

Valid values

1 or more

Default value

4096 bytes (4KB)

diskSpace

Maximum amount of disk space, in bytes, dedicated to paging task input messages.

Where used

SOAM > PagingTasksInput

Required/Optional

Optional

Valid values

1 or more

Default values

4294967296 bytes (4 GB)

bitmapBits

For internal system use only.

pmeType

For internal system use only.

SOAM>PagingTasksInput>PagingMode

For internal system use only.

name

For internal system use only.

readPriority

For internal system use only.

writePriority

For internal system use only.

removePriority

For internal system use only.

SOAM>PagingTasksInputNonRec

Parameters related to task input message paging configurations for non- recoverable sessions.

Note:

The PagingTasksInputNonRec and PagingTasksOutputNonRec elements must be set in pairs in the application profile; if only one of them is configured, it is ignored by the system.

path

Directory where paging files for task input are stored. The path to the file can be specified as a relative or absolute path. If a relative path is specified, paging files are saved in a subdirectory relative to the session manager working directory. To speed up paging and session manager recovery, the specified directory can be on the local drive since the paged data of non-recoverable sessions does not need to be persisted at a shared location.

Where used

  • SOAM > PagingTasksInputNonRec

Required/Optional

Optional

Valid values

Any accessible absolute or relative path on network or local disk.

Default values

By default, paging files are saved in the "paging" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

blockSize

Specifies the number of bytes per block for paging. The block size should be large enough to contain the largest message. If the block size is not large enough, the data is spread across multiple blocks, which can slow down paging processes.

Consider the size of the largest input message when determining the optimal blocksize for paging input tasks

Where used

  • SOAM > PagingTasksInputNonRec

Required/Optional

Optional

Valid values

1 or more

Default value

4096 bytes (4KB)

diskSpace

Maximum amount of disk space, in bytes, dedicated to paging task input messages.

Where used

SOAM > PagingTasksInputNonRec

Required/Optional

Optional

Valid values

1 or more

Default values

4294967296 bytes (4 GB)

bitmapBits

For internal system use only.

pmeType

For internal system use only.

SOAM>PagingTasksInputNonRec>PagingMode

For internal system use only.

name

For internal system use only.

readPriority

For internal system use only.

writePriority

For internal system use only.

removePriority

For internal system use only.

SOAM>PagingTasksOutput

Parameters related to task output message paging configurations.

path

Directory where paging files for task output are stored. The path to the files can be specified as a relative or absolute path. If a relative path is specified, paging files are saved in a subdirectory relative to the session manager working directory. The specified directory must be accessible from all management hosts to facilitate session manager failover.

Where used

  • SOAM > PagingTasksOutput

Required/Optional

Optional

Valid values

Data files can be stored on any storage device accessible on the network. To facilitate failover, Symphony working files should be stored on a shared file system.

Default values

By default, paging files are saved in the "paging" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

blockSize

Specifies the number of bytes per block for paging. The block size should be large enough to contain the largest message. If the block size is not large enough, the data is spread across multiple blocks, which can slow down paging processes.

Consider the size of the largest output message when determining the optimal blocksize for paging output tasks

Where used

  • SOAM > PagingTasksOutput

Required/Optional

Optional

Valid values

1 or more

Default value

4096 bytes (4KB)

bitmapBits

For internal system use only.

diskSpace

Maximum amount of disk space, in bytes, dedicated to paging task output messages.

Where used

SOAM > PagingTasksOutput

Required/Optional

Optional

Valid values

1 or more

Default value

4294967296 bytes (4 GB)

pmeType

For internal system use only.

SOAM>PagingTasksOutput>PagingMode

For internal system use only.

name

For internal system use only.

readPriority

For internal system use only.

writePriority

For internal system use only.

removePriority

For internal system use only.

SOAM>PagingTasksOutputNonRec

Parameters related to task output message paging configurations for non-recoverable sessions.

Note:

The PagingTasksInputNonRec and PagingTasksOutputNonRec elements must be set in pairs in the application profile; if only one of them is configured, it is ignored by the system.

path

Directory where paging files for task output are stored. The path to the files can be specified as a relative or absolute path. If a relative path is specified, paging files are saved in a subdirectory relative to the session manager working directory. To speed up paging and session manager recovery, the specified directory can be on the local drive since the paged data of non-recoverable sessions does not need to be persisted at a shared location.

Where used

  • SOAM > PagingTasksOutputNonRec

Required/Optional

Optional

Valid values

Any accessible absolute or relative path on network or local disk.

Default values

By default, paging files are saved in the "paging" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

blockSize

Specifies the number of bytes per block for paging. The block size should be large enough to contain the largest message. If the block size is not large enough, the data is spread across multiple blocks, which can slow down paging processes.

Consider the size of the largest output message when determining the optimal blocksize for paging output tasks

Where used

  • SOAM > PagingTasksOutputNonRec

Required/Optional

Optional

Valid values

1 or more

Default value

4096 bytes (4KB)

diskSpace

Maximum amount of disk space, in bytes, dedicated to paging task output messages.

Where used

SOAM > PagingTasksOutputNonRec

Required/Optional

Optional

Valid values

1 or more

Default value

4294967296 bytes (4 GB)

bitmapBits

For internal system use only.

pmeType

For internal system use only.

SOAM>PagingTasksOutputNonRec>PagingMode

For internal system use only.

name

For internal system use only.

readPriority

For internal system use only.

writePriority

For internal system use only.

removePriority

For internal system use only.

SOAM>PagingCommonData

Parameters related to common data paging configurations.

path

Directory where the files are stored for common data. The path to the files can be specified as a relative or absolute path. If a relative path is specified, common data files are saved in a subdirectory relative to the session manager working directory. The specified directory must be accessible from all management hosts to facilitate session manager failover.

Where used

  • SOAM > PagingCommonData

Required/Optional

Optional

Valid values

Data files can be stored on any storage device accessible on the network. To facilitate failover, Symphony working files should be stored on a shared file system.

Default values

By default, paging files are saved in the "paging" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

blockSize

Specifies the number of bytes per block for paging. The block size should be large enough to contain the largest message. If the block size is not large enough, the data is spread across multiple blocks, which can slow down paging processes.

Consider the size of the largest common data message when determining the optimal block size for paging common data.

Where used

  • SOAM > PagingCommonData

Required/Optional

Optional

Valid values

1 or more

Default value

102400 bytes (100KB)

diskSpace

Specifies the maximum amount of disk space, in bytes, dedicated to paging.

Where used

SOAM > PagingCommonData

Required/Optional

Optional

Valid values

1 or more

Default values

8589934592 bytes (8GB)

bitmapBits

For internal system use only.

pmeType

For internal system use only.

SOAM>PagingCommonData>PagingMode

For internal system use only.

name

For internal system use only.

readPriority

For internal system use only.

writePriority

For internal system use only.

removePriority

For internal system use only.

SOAM>PagingCommonDataNonRec

Parameters related to common data paging configurations for non-recoverable sessions.

Note:

The PagingCommonDataNonRec and PagingCommonDataUpdatesNonRec elements must be set in pairs in the application profile; if only one of them is configured, it is ignored by the system.

path

Directory where the files are stored for common data. The path to the files can be specified as a relative or absolute path. If a relative path is specified, common data files are saved in a subdirectory relative to the session manager working directory. To speed up paging and session manager recovery, the specified directory can be on the local drive since the paged data of non-recoverable sessions does not need to be persisted at a shared location.

Where used

  • SOAM > PagingCommonDataNonRec

Required/Optional

Optional

Valid values

Any accessible absolute or relative path on network or local disk.

Default values

By default, paging files are saved in the "paging" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

blockSize

Specifies the number of bytes per block for paging. The block size should be large enough to contain the largest message. If the block size is not large enough, the data is spread across multiple blocks, which can slow down paging processes.

Consider the size of the largest common data message when determining the optimal block size for paging common data.

Where used

  • SOAM > PagingCommonDataNonRec

Required/Optional

Optional

Valid values

1 or more

Default value

102400 bytes (100KB)

diskSpace

Specifies the maximum amount of disk space, in bytes, dedicated to paging.

Where used

SOAM > PagingCommonDataNonRec

Required/Optional

Optional

Valid values

1 or more

Default values

8589934592 bytes (8GB)

bitmapBits

For internal system use only.

pmeType

For internal system use only.

SOAM>PagingCommonDataNonRec>PagingMode

For internal system use only.

name

For internal system use only.

readPriority

For internal system use only.

writePriority

For internal system use only.

removePriority

For internal system use only.

SOAM>PagingCommonDataUpdates

Parameters related to common data updates paging configurations.

path

Directory where the files are stored for common data updates. The path to the files can be specified as a relative or absolute path. If a relative path is specified, common data update files are saved in a subdirectory relative to the session manager working directory. The specified directory must be accessible from all management hosts to facilitate session manager failover.

Where used

  • SOAM > PagingCommonDataUpdates

Required/Optional

Optional

Valid values

Data files can be stored on any storage device accessible on the network. To facilitate failover, Symphony working files should be stored on a shared file system.

Default values

By default, paging files are saved in the "paging" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

blockSize

Specifies the number of bytes per block for paging. The block size should be large enough to contain the largest message. If the block size is not large enough, the data is spread across multiple blocks, which can slow down paging processes.

Consider the size of the largest common data update message when determining the optimal block size for paging common data updates.

Where used

  • SOAM > PagingCommonDataUpdates

Required/Optional

Optional

Valid values

1 or more

Default value

102400 bytes (100KB)

diskSpace

Specifies the maximum amount of disk space, in bytes, dedicated to paging.

Where used

SOAM > PagingCommonDataUpdates

Required/Optional

Optional

Valid values

1 or more

Default values

8589934592 bytes (8GB)

bitmapBits

For internal system use only.

pmeType

For internal system use only.

SOAM>PagingCommonDataUpdates>PagingMode

For internal system use only.

name

For internal system use only.

readPriority

For internal system use only.

writePriority

For internal system use only.

removePriority

For internal system use only.

SOAM>PagingCommonDataUpdatesNonRec

Parameters related to common data updates paging configurations for non-recoverable sessions.

Note:

The PagingCommonDataNonRec and PagingCommonDataUpdatesNonRec elements must be set in pairs in the application profile; if only one of them is configured, it is ignored by the system.

path

Directory where the files are stored for common data updates. The path to the files can be specified as a relative or absolute path. If a relative path is specified, common data update files are saved in a subdirectory relative to the session manager working directory. To speed up paging and session manager recovery, the specified directory can be on the local drive since the paged data of non-recoverable sessions does not need to be persisted at a shared location.

Where used

  • SOAM > PagingCommonDataUpdatesNonRec

Required/Optional

Optional

Valid values

Any accessible absolute or relative path on network or local disk.

Default values

By default, paging files are saved in the "paging" directory under the session manager working directory.

Related attributes

  • workDir (SOAM > SSM)—the working directory of session manager.

blockSize

Specifies the number of bytes per block for paging. The block size should be large enough to contain the largest message. If the block size is not large enough, the data is spread across multiple blocks, which can slow down paging processes.

Consider the size of the largest common data update message when determining the optimal block size for paging common data updates.

Where used

  • SOAM > PagingCommonDataUpdatesNonRec

Required/Optional

Optional

Valid values

1 or more

Default value

102400 bytes (100KB)

diskSpace

Specifies the maximum amount of disk space, in bytes, dedicated to paging.

Where used

SOAM > PagingCommonDataUpdateNonRec

Required/Optional

Optional

Valid values

1 or more

Default values

8589934592 bytes (8GB)

bitmapBits

For internal system use only.

pmeType

For internal system use only.

SOAM>PagingCommonDataUpdatesNonRec>PagingMode

For internal system use only.

name

For internal system use only.

readPriority

For internal system use only.

writePriority

For internal system use only.

removePriority

For internal system use only.

SOAM>JournalingTasks

path

For internal system use only.

blockSize

For internal system use only.

bitmapBits

For internal system use only.

diskSpace

For internal system use only.

pmeType

For internal system use only.

SOAM>JournalingSessions

path

For internal system use only.

blockSize

For internal system use only.

bitmapBits

For internal system use only.

diskSpace

For internal system use only.

pmeType

For internal system use only.

SOAM>JournalingSessionTagConfig

path

For internal system use only.

blockSize

For internal system use only.

bitmapBits

For internal system use only.

diskSpace

For internal system use only.

pmeType

For internal system use only.