Natural Client Configuration Tool

#### Search Results

Search

# Natural Client Configuration Tool

This document covers the following topics:

- Invoking the Configuration Tool

- Session Configuration

- Logging Configuration

- Logon Page

- Logout

## Invoking the Configuration Tool

Natural for Ajax offers a configuration tool. The configuration tool is used to create the session configurations which are then available in the logon page. It can also be used for logging purposes in case of problems; however, this should only be done when requested by Software AG support.

The configuration tool is automatically installed when you install Natural for Ajax .

To invoke the configuration tool

- Enter the following URL in your browser:

      http://<host>:<port>/cisnatural/conf_index.jsp

  where <host> and <port> are the host name and port number of your application server.

  Note
  You might wish to protect the configuration tool against unauthorized access. See Configuring Container-Managed Security for information on how to restrict the access to sensitive areas of the application server environment. If you have restricted access to the configuration tool, an authentication dialog appears. The appearance of this dialog depends on the authentication model you have chosen.

  The configuration tool appears.

  The configuration tool has two frames.

  The home page of the configuration tool is initially shown in the right frame. It provides brief descriptions for the links provided in the left frame. It also provides links to several Software AG pages on the web.

  When you have invoked a function (for example, when you are currently viewing the session configuration), you can always choose the Home link in the left frame to return to the home page of the configuration tool.

  The functions that are invoked by the other links in the left frame are described below.

## Session Configuration

This section explains how to manage the content of the configuration file for the sessions. It covers the following topics:

- Invoking the Session Configuration Page

- Global Settings

- Adding a New Session

- Editing a Session

- Overview of Session Options

- Duplicating a Session

- Deleting a Session

- Adding a New User

- Saving the Configuration

### Invoking the Session Configuration Page

The content of the configuration file for the sessions is managed using the Session Configuration page.

To invoke the Session Configuration page

1. In the frame on the left, choose the Session Configuration link.

   The Session Configuration page appears in the right frame. It shows the global settings and lists all sessions and users that are currently defined. For a session, some of the configuration file information is shown. Example:

### Global Settings

The global settings apply for all defined sessions. You can define the following global settings in the configuration file:

Option | Description
--- | ---
Last activity timeout (n seconds) | The number of seconds that the client waits for the next user activity. When the defined number of seconds has been reached without user activity, the session is closed. The default is 3600 seconds.
- Trace directory | Optional. Location of a different trace directory. When a different trace directory is not defined, the trace files are written to the default trace directory. By default, the trace files are written to the directory which has been set by the Java property `java.io.tmpdir` . On Windows, this is normally the environment variable `TMP` for the user who started the application server. On Linux, this is normally /tmp or /var/tmp . You can also set this property in the start script for the application server. The following examples apply to Wildfly. Example for Windows ( run.bat ):
      set JAVA_OPTS=%JAVA_OPTS% -Djava.io.tmpdir=C:\temp
- Example for Linux ( run.sh ):
      set JAVA_OPTS="$JAVA_OPTS -Djava.io.tmpdir=/tmp
Tracing can be enabled individually for each session (see Overview of Session Options below). However, it should only be enabled when requested by Software AG support.
SSL trust file path | Optional. The path to your trust file. See Configuring SSL for further information.
SSL trust file password | If your trust file is password-protected, you have to specify the appropriate password. When you do not specify the password for a password-protected trust file, the trust file cannot be opened and it is thus not possible to open an SSL session. When your trust file is not password-protected, you should not specify a password.
Use secure logon page | If selected, users are authenticated before they access the Natural for Ajax logon page. See also Configuring Application-Managed Authentication . If Use SAML for JAAS-based authentication is also selected, the secure logon page is only shown in the case of an error in the SAML artifact validation.
Use SAML for JAAS-based authentication | If selected, Natural for Ajax expects the use of the `SAMLArtifactLoginModule` which does not prompt the end user for a user name and password. If you want to use other login modules which expect the user to enter a valid user name and password (such as the `SSXLoginModule` ), make sure that this check box is not selected. See also Using Software AG Security Infrastructure .

### Adding a New Session

You can add a new session to the configuration file.

To add a new session

1. Choose the Add New Session button.

   The Edit Session page appears.

2. Specify all required information as described below in the section Overview of Session Options .

3. Choose the OK button to return to the Session Configuration page.

   The new session is not yet available in the configuration file.

4. Choose the Save Configuration button to write the new session to the configuration file.

### Editing a Session

You can edit any existing session in the configuration file.

To edit a session

1. Choose the Edit link that is shown next to the session that you want to edit.

   The Edit Session page appears.

2. Specify all required information as described below in the section Overview of Session Options .

3. Choose the OK button to return to the Session Configuration page.

   The modifications are not yet available in the configuration file.

4. Choose the Save Configuration button to write the modifications to the configuration file.

### Overview of Session Options

The Edit Session page appears when you

- add a new session, or

- edit an existing session.

Example:

The Edit Session page provides the following options:

Option | Description
--- | ---
Session ID | Mandatory. A session name of your choice. On the logon page, the session name is provided in a drop-down list box.
Application name | Optional. An application name of your choice. This name is used to provide more individual disconnect messages. The name entered here will replace the term "Application" in the standard disconnect message of Natural for Ajax applications. For example, if the field Application name contains the word "Calculator" the disconnect message "Application finished successfully" would instead be "Calculator finished successfully" . Similar custom messages will be displayed if the application ends with an error.
Type | The platform on which user ID and password are authenticated. You can select the required setting from the drop-down list box. Undefined Default. User ID and password can have a maximum of 32 characters. See also the description for Natural for Windows or Linux below. Natural for Mainframes User ID and password can have a maximum of 8 characters. Natural for Mainframes with Natural Security User ID and password can have a maximum of 8 characters. The user ID must comply with the Natural naming conventions for library names . Natural for Windows or Linux User ID and password can have a maximum of 32 characters. When a domain is required, you have to specify it together with the user ID (in the form " domain \ user-ID " ).
Show style sheet selector | With Natural for Ajax, the users can switch to another style sheet during a running session. If set to No , the users are no longer able to select another style sheet.
Style sheet | The name of the style sheet which determines the colors, fonts and PF key button style of the current session. See Using Style Sheets . When this element is specified, a fixed style sheet is used. In this case, the corresponding field does not appear on the logon page and the user is thus not able to select a different style sheet.
Host name | The name or TCP/IP address of the server on which Natural and the Natural Web I/O Interface server are running. When this is specified, the corresponding field does not appear on the logon page.
Port number | The TCP/IP port number on which the Natural Web I/O Interface server is listening. When this is specified, the corresponding field does not appear on the logon page.
Use SSL | If set to Yes , a secure connection is established between Natural for Ajax on the application server and the Natural Web I/O Interface server. Important If you want to use SSL with Natural for Mainframes, one of the corresponding mainframe types must be selected; the type must not be Undefined or Natural for Windows or Linux . The other way around, if you want to use SSL with Natural for Windows or Linux, you must not select one of the mainframe types; the type may also be Undefined in this case.
Use JAAS-based authentication | If selected, application-managed authentication is used. This setting implies that Forward credentials is also selected. See also Configuring Application Managed Authentication . If Use SAML for JAAS-based authentication is also selected in the global settings, the user name and password are not visible in the Natural for Ajax logon page. See also Using Software AG Security Infrastructure .
Forward credentials | If selected, the security credentials from the application server are forwarded to the Natural Web I/O Interface server, thus sparing the user a second logon. See also Forwarding the User Credentials to Natural .
User name | Optional. A valid user ID for the current machine. When this is specified, the corresponding field does not appear on the logon page.
User name in upper case | If selected, the input field for the user ID is in upper-case mode.
Password | Optional. A valid password for the above user ID. Under Windows and Linux, this is always the operating system password of the user, even if Natural Security is active. On the mainframe, this is different: When Natural Security is not active, this is the operating system password of the user. When Natural Security is active, this is the Natural Security password. When a password is specified, the corresponding field does not appear on the logon page. The configuration tool saves the password in encrypted form.
Save user credentials | Applies only to applications that are designed as Application Designer workplaces. If set to Yes (default), the default behavior of the option Share session user applies. If set to No , the user credentials (user ID and password) are not saved in the Application Designer session and are therefore not available for an Application Designer subsession. An example for a workplace application is available under the following URL: http:// <host> : <port> /cisnatural/servlet/StartCISPage?PAGEURL=/njxdemos/wpworkplace.html where <host> and <port> are the host name and port number of your application server.
Share session user | Applies only to applications that are designed as Application Designer workplaces. If set to No (default), the user credentials of the main Application Designer session are automatically used in an Application Designer subsession if the server and port of the subsession is the same as in the main session. If the server and port are not the same, the user has to specify the user ID and password in a logon dialog. If set to Yes , the user credentials of the Application Designer main session are always used for all Application Designer subsessions on all involved servers - even if the server and port are different.
Application | Natural for Mainframes The name of the Natural program or a command sequence that starts your application as you would enter it on the `NEXT` prompt. Example: `TEST01 data1,data2` Natural for Linux The name of the Linux shell script for starting the Natural application (a file similar to nwo.sh ). Natural for Windows The name of the Windows command file ( .bat ) for starting the Natural application. When this is specified, the corresponding field does not appear on the logon page.
Natural parameters | Optional. Parameters for starting the Natural application. This can be stack parameters, a parameter file/module or other Natural-specific information. Natural for Mainframes Used to pass dynamic Natural profile parameters to the session, for example: `SYSPARM=(MYPARMS) STACK=(LOGON MYAPPL)` Note It is recommended to specify the Natural program that starts the application with the option Application instead of passing it with the profile parameter `STACK` . Natural for Linux and Natural for Windows Used when the above shell script (Linux) or command file (Windows) uses the parameter `$5` after "natural" , for example: `PARM=MYPARM STACK=(LOGON MYLIB;MENU)`
1. Disconnect behavior | Defines whether the default disconnect page is to be shown when a Natural program ends, or whether the current browser tab is to be closed. You can select the required setting from the drop-down list box. Display disconnect page Default. The disconnect page is always displayed. Always close browser The current browser tab is closed. When the last tab in the browser is closed, the entire browser is closed. Close browser, but display disconnect page on error The current browser tab is closed. When the last tab in the browser is closed, the entire browser is closed. However, in the case of an unexpected error, the disconnect page is shown. Internet Explorer allows closing the browser with JavaScript by default. For Firefox, however, this has to activated as follows: In the Firefox address bar, type the following:
       about:config
3. A warning message appears, saying that changing the advanced settings can be harmful and that you should only continue if you are sure of what you are doing. Choose the I'll be careful, I promise! button. In the Filter text box, type the following:
       dom.allow_scripts_to_close_windows
Set this value to "true" by double-clicking on the entry (default: "false" ).
Language | You can select the required language from the drop-down list box. It is also possible to select Set in workplace from the drop-down list box. When selected, the language that is currently used in the workplace will also be used for the next start of Natural. See also Multi-Language Management . Default: English.
Double-click behavior | Applies only to Natural maps, not to rich GUI pages. The key that is to be simulated when double-clicking an output field. By default, this is the ENTER key. It is possible to disable the double-click behavior, or to define a function key ( PF1 through PF12 ). You can select the required setting from the drop-down list box. Tip When context-sensitive help has been defined for the output fields, it may be useful to define PF1 . The help function will then be invoked when the user double-clicks an output field.
PF keys display style | Applies only to Natural maps, not to rich GUI pages. By default, only the named function keys are shown as buttons. It is also possible to show buttons for all function keys, including those which do not have names. You can specify whether to display buttons for 12, 24, 36 or 48 function keys. Each line always contains 12 function key buttons. The first line also contains a button for the ENTER key. Each function key button is always displayed at the same position. You can select the required setting from the drop-down list box.
Screen rows | Applies only to Natural maps, not to rich GUI pages. The number of rows in the output window. Possible values: minimum 24, no upper limit. Default: 24. Not used by Natural for Mainframes which uses the profile parameter `TMODEL` instead.
Screen columns | Applies only to Natural maps, not to rich GUI pages. The number of columns in the output window. Possible values: minimum 80, no upper limit. Default: 80. Not used by Natural for Mainframes which uses the profile parameter `TMODEL` instead.
Show function key numbers | Applies only to Natural maps, not to rich GUI pages. If set to Yes , the PF key numbers are shown next to the PF keys.
Trace | Should only be set to Yes when requested by Software AG support.
Check for numeric input | If set to Yes (default), numeric input fields are validated. In this case, only the following characters are allowed in numeric input fields (in addition to the numbers "0" through "9" ): blank + (plus) - (minus) _ (underscore) , (comma . (period) ? (question mark) If set to No , numeric input fields are not validated.
Auto skip | Applies only to Natural maps, not to rich GUI pages. If set to Yes , the cursor is automatically placed in the next input field when the last possible character has been entered in the current input field. If set to No (default), the cursor remains in the current input field.
Timeout (in seconds) | The number of seconds that the client waits for a response after an updated page was sent to the Natural session. When the defined number of seconds has been reached without response, the session is closed. The default is 60 seconds. Normally, you need not change this value.
Translate characters from / Translate characters to | Applies only to Natural maps, not to rich GUI pages. Optional. Used to translate characters that are sent from the host or entered by the user into different characters to be shown on the screen. You enter the characters to be translated in the Translate characters from text box and the characters to be used instead in the Translate characters to text box (in the same order as in the first text box). Both text boxes must contain the same amount of characters. The following example shows how to translate all lower-case characters to upper-case characters: The following example shows how to translate the so-called "European numerals" to "Arabic-Indic numerals" :
Filler character | Applies only to Natural maps, not to rich GUI pages. Optional. The filler character that is to be removed from the input fields. An application can define, for example, an underscore (_) as the filler character. Trailing filler characters will be removed from the input fields, and leading filler characters will be replaced with blanks.

### Duplicating a Session

You can add a copy of any existing session to the configuration file.

To duplicate a session

1. Choose the Duplicate link that is shown next to the session that you want to duplicate.

   A new entry is shown at the bottom of the list of sessions. Its name is "Copy of session-ID " . The duplicated session is not yet available in the configuration file.

2. Edit and save the duplicated session as described above.

### Deleting a Session

You can delete any existing session from the configuration file.

To delete a session

1. Choose the Delete link that is shown next to the session that you want to delete.

   The session is deleted from the list of sessions. It is not yet deleted in the configuration file.

2. Choose the Save Configuration button to delete the session from the configuration file.

### Adding a New User

You can predefine Natural users and their passwords in the configuration file.

When a Natural page is opened with a URL that specifies a user in the URL parameter `natuser` , the specified user is matched against the list of users in the configuration file. When the specified user is defined in the configuration file, the corresponding password is used to authenticate the user when the Natural session is started. See also Starting a Natural Application with a URL .

Example - when the following URL is used, the password defined for "user1" is used:

http://myhost:8080/cisnatural/servlet/StartCISPage?PAGEURL=/cisnatural/NatLogon.html&xciParameters.natuser=user1 ...

To add a new user

1. Choose the Add New User button.

   The Edit User page appears.

2. Specify a user name and passwort

3. Choose the OK button to return to the Session Configuration page.

   The new user is not yet available in the configuration file.

4. Choose the Save Configuration button to write the new user to the configuration file.

Note
You edit, duplicate and delete a user in the same way as a session (see the corresponding descriptions above).

### Saving the Configuration

When you choose the Save Configuration button, all of your changes are written to the configuration file. The server picks up the new settings automatically the next time it reads data from the configuration file.

Caution
If you do not choose the Save Configuration button but log out instead or leave the configuration tool by entering another URL, the new settings are not written to the configuration file.

## Logging Configuration

The content of the configuration file for logging is managed using the Logging Configuration page. See the section Logging for detailed information.

## Logon Page

The configuration tool provides the following link s in the left frame:

- Natural Web I/O Interface Logon

- Natural for Ajax Logon

Each of these links opens the corresponding logon page in the right frame.

The logon page uses the current settings in the configuration file. When you select a session from the drop-down list box, you can check whether the connection details are shown as desired. If not, you can go back to the session configuration and modify the settings of the corresponding session.

See also About the Logon Page .

## Logout

When the configuration tool is protected against unauthorized access and you log out of the configuration tool, you make sure that no other user can change the client configuration when you leave your PC unattended for a while.

To log out

- In the frame on the left, choose the Logout link.

  When the configuration tool is protected against unauthorized access, the authentication dialog is shown again.

  When it is not protected, the home page is shown again.

### On this page

- Invoking the Configuration Tool
- Session Configuration
- Logging Configuration
- Logon Page
- Logout