Skip to main content

[APP_PATH:<appPath>]

Describes the application access profile for the application path <appPath>. The CSP.ini file contains one [APP_PATH:<appPath>] section for each application access profile defined within the Web Gateway configuration.

Details

An application access profile defines the way that the Web Gateway routes requests for an application path. The CSP.ini file maintains each application access profile as a section of the CSP.ini file. Each application access profile section begins with the header line [APP_PATH:<appPath>], where <appPath> represents the application path. For example, the section corresponding to a server access profile named irisserver1 would begin with the line [irisserver1].

Available Parameters

Default_Server

The name of the server access profile to which the Web Gateway should attempt to route requests for this application path by default, before any alternative servers. You should also define this server as an Alternative_Server, usually Alternative_Server_0.

Alternative_Servers

A numeric value indicating the way the Web Gateway should route requests to alternative InterSystems IRIS application servers, when alternative servers are defined. Allowed values are:

  • FailOver — enables failover from one application server onto the next available alternative, in the order specified

  • LoadBalancing — enables load-balancing among application servers in a round-robin fashion, along with failover

  • Disabled — disables failover and load balancing capabilities

You must define all the application servers you want to use for an application path using Alternative_Server_<n> parameters.

Alternative_Server_0, Alternative_Server_1,... Alternative_Server_<n>

Strings which specify server access profiles within the Web Gateway’s routing behavior for the application access profile, and whether those InterSystems IRIS application servers are enabled or disabled within the application access profile. When failover is enabled, the Web Gateway attempts to route requests for the application to the application server identified by the Alternative_Server_0 parameter, then the Alternative_Server_1 parameter, then Alternative_Server_2, and so on. The Web Gateway can continue this failover behavior for an arbitrary number (<n>) of alternative servers—in other words, up to the Alternative_Server_<n> parameter.

Each Alternative_Server_<n> parameter begins with a bit specifying the status of the application server within the application access profile (1 for enabled, 0 for disabled) and ends with the name of the server access profile for the desired InterSystems IRIS application server. When the Web Gateway updates the value of this parameter, it separates the status and the server access profile name using an arbitrary number of ~ characters, for legibility.

For example, if you want to specify that the third active InterSystems IRIS application server in your application’s failover sequence should be the server which corresponds to a server access profile named irisserv1, then you would add the following line to the application access profile block:

Alternative_Server_2=1~~~~~~irisserv1
KeepAlive

Specifies how the Web Gateway should implement HTTP Keep-Alive connection behavior for this application. Allowed values are:

  • No Action — the Web Gateway allows the HTTP response headers for each request to determine the Keep-Alive status of a connection. This is the default value

  • Enabled

  • Disabled

Non_Parsed_Headers

Specifies whether the Web Gateway streams HTTP response headers directly to the client (Enabled) or submits them to the hosting web server for parsing and filtering (Disabled). The default value is Enabled.

Response_Size_Notification

Specifies the method the Web Gateway uses to notify clients about the amount of data contained in an HTTP response for this application. Allowed values are:

  • Chunked Transfer Encoding and Content Length — the default value.

  • Chunked Transfer Encoding

  • Content Length

Response_Size_Notification_Always

Specifies whether the Web Gateway sends response size notifications for all HTTP responses which are associated with this application. Allowed values are Enabled or Disabled. The default value is Disabled.

GZIP_Compression

Specifies whether the Web Gateway compresses all pages returned for this application. Allowed values are Enabled or Disabled. The default value is Disabled.

GZIP_Minimum_File_Size

Specifies the minimum response size (in bytes) for which the Web Gateway invokes GZIP compression. The default value is 500.

GZIP_Exclude_File_Types

The file types which the Web Gateway excludes from GZIP compression for this application, specified as a space-separated list of file type extensions. The default value includes natively compressed files: jpeg gif ico png gz zip mp3 mp4 tiff.

Extra_CGI_Env_Variables

Additional CGI environment variables which the Web Gateway should provide to the InterSystems IRIS application server with each request for this application. For the default set of variables which the Web Gateway provides, see CGI Environment Variables Passed by the Web Gateway.

Proc_Class

The name of a custom request handler which the Web Gateway should use to process requests for this application.

FeedbackOpens in a new tab