System properties

The system properties page is used to configure basic settings for the framework.

The following table shows the properties on the page.
Table 1. System properties
Property name Value Example Description
External Web URL None https://www.example.com:58080 A partial URL that defines the location where browser requests are directed to reach the Control Center. Control Center applications use this property to generate URLs on your browser page.

The syntax of this property is protocol://host:port.

This property is required only when the network includes intermediate nodes that change the request header to substitute a server name or port that is not reachable from your system. An example is a reverse proxy server.

For example, if the Control Center is accessed internally at https://example.com:58448, this internal URL is a valid value to use for this property. The actual value that you use depends on your network infrastructure.

Notes:
  • The value of this property is critical for the Control Center to work properly. An incorrect value can cause a blank page to be displayed after login, which requires you to manually update the database to fix the problem. For more information, see Troubleshooting Control Center.
  • Restart the Control Center pod for changes to this property to take effect.
HTTP Request Header for Remote Address     Control Center writes the IP address that is associated with certain user requests to an audit or event log. By default, the address is the source of the HTTP request, which can represent the originating client computer or the last proxy or load balancer to forward the request. Use this property to identify which HTTP request header, if any, is used by Control Center to obtain the originating IP address of a client.
Web Services' HTTP Response Headers   Pragma: no-cache | Cache-Control: no-store, no-cache | Expires: -1 | X-FRAME-OPTIONS: SAMEORIGIN Specify any HTTP headers that are to be added to each HTTP response from the web services. Use this property to control caching along the network response path or for any other purpose. The HTTP headers that are specified in this property are not applied to static content such as stylesheets or icon images.

Each response header is of the form name: value. Specify multiple headers by separating them with the pipe symbol (|).

Note: Restart the web services pods for changes to this property to take effect.
Control Center's HTTP Response Headers   Pragma: no-cache | Cache-Control: no-store, no-cache | Expires: -1 | X-FRAME-OPTIONS: SAMEORIGIN Specify any HTTP headers that are to be added to each HTTP response from the Control Center servlets. Use this property to control caching along the network response path or for any other purpose. The HTTP headers that are specified in this property are not applied to static content such as stylesheets or icon images.

Each response header is of the form name: value. Specify multiple headers by separating them with the pipe symbol (|).

To support multiple tabs, Control Center uses framing. Do not use the DENY option when the X-FRAME-OPTIONS response header is specified.

Note: Restart the Control Center pod for changes to this property to take effect.
OIDC login user exit None com.ibm.paydir.userexit.samples.OIDCSampleUserExit Fully qualified user exit class name for processing login requests. This user exit class is called when the user logs in for role-based authorization.
Logout URL None http://www.example.com The URL that you are directed to when you sign off from the browser. If this property is not specified when single sign-on is being used, you are directed to the welcome page. If this property is not specified in a non-single-sign-on environment, you are directed to the login page.
Note: When this property is used in a non-single-sign-on environment, the URL specified in this property must revoke authentication for the user. If it does not revoke the authentication, the user remains authenticated and unexpected behavior might occur.
Single Sign On Enabled No Yes, No Indicate whether single sign-on authentication is being used. If single sign-on authentication is being used, this property must be set to yes. If no value is specified for this property, it defaults to no.
Login Single Sign on User Exit None com.example.LoginSSOuserexit Fully qualified user exit class name for single sign-on requests. This user exit class is called when the user logs in for single sign-on. The user ID is set from the request header.
Note: This property is not used when Trust Association Interceptor++ (TAI++) is used for single sign-on.
Login Single Sign On User Exit Properties None
properties_loc=value,
properties_file=value
 Optional configuration properties for the single sign-on user exit class. Use delimited name and value pairs to specify any extra custom properties that are needed as optional values by this user exit.
Note: This property is not used when Trust Association Interceptor++ (TAI++) is used for single sign-on.
Operational time zone None UTC (GMT +0:00) The time zone to use when FTM reports are generated and specific pages, such as the Processing Windows page, are displayed.
Instance Name None Development, Test, Production Name of the environment instance. Any Common Services component can reference the property. The value of this property is displayed in the banner portion of each Control Center page.
Note: Restart the Control Center pod for changes to this property to be reflected in the banner.
Web Service Browser Default Enabled, Disabled, Documentation only Indicate whether the Web Service Browser is enabled, disabled, or provides documentation only.
Note: Restart the web services pods for changes to this property to take effect.
Data Security Classification   Restricted Identifies the data security classification to be displayed in the black banner (to the left of the product title or instance name) of the user interface. If the user interface contains restricted data, setting a classification of Restricted ensures that this classification is viewable for all pages that are displayed within the user interface.
Test System Indicator Test Production Identifies the system as either a test or production system. It can be used in Business Rules to reject transmissions. For example, you can reject transmissions in the following situations.
  • Incoming transmissions that are flagged as test are being run on a production system.
  • Incoming transmissions that are not flagged as test are being run on a test system.

Actions

The actions that are available on the page are shown in the following list.
  • Open documentation displays the help page.
  • Filter column displays the build filter link that you can use to create a filter for the columns on the page.
  • Search entry field. Typing text in this field automatically filters the properties that are displayed in the table. The table displays only those properties that match what was typed in the search field.
  • Refresh updates the displayed properties.
  • Download CSV saves the displayed table view as a .csv file.
  • Customize columns displays a page to select which columns are shown or hidden on the page.
  • Row settings configures the size and the spacing of the text that is displayed in the cells of the table.
  • Reset table configuration changes the table view back to the default configuration.
  • To update a property, click the property name or anywhere in the row to open the edit property dialog box.