Primary Web Server configuration settings are defined within the config.js file. A sample config.js file structure is shown below.
The parameters in the config.js file are as follows:
Server Parameters
The following parameters define the server information.
- R3_SERVER_NAME:
-
Specifies the SAP ERP connection string. Refer to the Connection Strings for more information on defining a connection string and its supported syntaxes.
Syntax
const R3_SERVER_NAME = "H/serverName";
- DEF_WEBPORT_BASE
-
When SSL is disabled, the Web Server uses a specific listening port. However, if SSL is enabled, you must specify the DEF\_WEBPORTSSL\_BASE entry defined below.
Syntax
const DEF_WEBPORT_BASE = "85";
Note: This port must be open on the firewall for the Web Server to function correctly.
- DEF_WEBPORT_IDX
-
Defines the index for the array that holds the ports for the Web Server. By default, it is set to ’0’.
Syntax
const DEF_WEBPORT_IDX = "0";
- USING_SSL
-
Specifies whether you are utilizing SSL for connecting to the Web Server. If it is set to ‘true’, you must connect to SSL. If set to ‘false’, the connection will not connect with SSL.
Syntax
const USING_SSL = false;
- DEF_WEBPORTSSL_BASE
-
If SSL is enabled, need to specify the listening port for the Web Server. If SSL is disabled, need to define the DEF_WEBPORT_BASE entry defined below.
Syntax
const DEF_WEBPORTSSL_BASE = "443";
Note: This port must be open on the firewall for Web Server to function correctly.
- DEF_WEBPORTSSL_IDX
-
Defines the instance number for the Web Server. Multiple instances can run simultaneously on a single machine, so each instance must have a unique number.
Syntax
const DEF_WEBPORTSSL_IDX = "0";
- DEF_SSL_PARAPHRASE
-
Defines the passphrase you select for SSL and the value is stored as a string.
Syntax
const DEF_SSL_PARAPHRASE = "Alana888";
- DEF_SSL_KEYFILE
-
Specifies the key file that is used by the Web Server when SSL is enabled. This file is used to encrypt the SSL transmissions. It must be the file type 'key' and is typically stored in the C:\Program Files\Synactive Inc\GuiXTFuzion\cert directory.
Syntax
const DEF_SSL_KEYFILE = "server.key";
- DEF_SSL_CERTIFICATE
-
Specifies the security certificate that is used by the Web Server when SSL is enabled. This file must be the 'cert' type and is typically stored in the C:\Program Files\Synactive Inc\GuiXTFuzion\cert directory.
Syntax
const DEF_SSL_CERTIFICATE = "server.crt";
Client Parameters
The following parameters define the SAP client parameters if you are using Single Sign-on (SSO).
- SSO_CLINUM
-
Specifies the three-digit SAP client number that will be used in SSO.
Syntax
const SSO_CLINUM = "800";
- SSO_LANG
-
Specifies the one-digit SAP language code for the client that will be used in SSO.
Syntax
const SSO_LANG = "E";
Web Parameters
The parameters listed below relate to the Web presentation in the browser and to the establish the connection the Web Server and SAP.
- HTML_TITLE
-
Added from build 1.1.95.0. If you are upgrading from a version of Web Server earlier than 1.1.95.0, you must add this line to the config.js file.
const HTML_TITLE = "Synactive Web Server";
- MAX_CONN_NUM
-
The maximum number of users who can concurrently connect to a single instance of Web Server. The default is 100.
Syntax
const MAX_CONN_NUM = 100;
- SESSION_TIMEOUT
-
Specifies the connection timeout in seconds and the default value is 120.
Syntax
const SESSION_TIMEOUT = 120;
- SESSIONIDKEY
-
This parameter is passed in an HTTP request from the client to the server. It is used to identify the user session at the server uniquely.
Syntax
const SESSIONIDKEY = "GWSessionID";
- MODALIDKEY
-
This parameter is passed in an HTTP request from the client to the server. It is used to uniquely identify a connection at the server.
Syntax
const MODALIDKEY = "GWModalID";
- REQMODALKEY
-
Syntax
const REQMODALKEY = "REQMODAL";
- NSESSIONS
-
Defines the maximum number of concurrent sessions supported. Currently, a single instance of Web Server supports up to six concurrent sessions.
const NSESSIONS = 6;
- NMODALS
-
Defines the maximum number of modals supported by a Server instance. A single instance of Web Server supports up to seven modals.
const NMODALS = 7;
- OLETRACE
-
Used for tracing OLE calls. By default, it is '0'. Set to ‘1’ to activate.
const OLETRACE = 0;
- TIMESTAMP
-
Flag for activating timestamps. By default, it is ‘0’ and set to ‘1’ to enable.
const TIMESTAMP = 0;
- PRINT_REQUEST_HEADERS
-
This parameter is used to print the HTTP request header. It is used primarily for debugging. The default value is ‘0’.
const PRINT_REQUEST_HEADERS = 0;
- STORE_ALL_MESSAGES
-
This parameter instruct the Web Server whether to store all messages or not.
const STORE_ALL_MESSAGES = false;
- RELOAD_RETRY_MAX
-
Specifies the number of times the Web Server should reload when the connection is lost. The default value is ‘3’.
const RELOAD_RETRY_MAX = 3;
- MENU_SENT_ONCE
-
Specifies that the root menus will only be sent once. Menus are specified as strings.
const MENU_SENT_ONCE = ["System", "Help"];
- ENABLE_AUTOSAVE
-
Used to specify if the Auto-save feature is enabled or disabled. It is set to ‘0’ by default. Change to ‘1’ to enable the autosave feature.
const ENABLE_AUTOSAVE = 0;
- USE_CORNELIUS
-
Defines whether the Liquid UI Server is using the Liquid UI WS engine or not. Set this parameter to 'true' for a WS environment. Set it to 'false' if you are not using a WS environment. The syntax is shown below.
const USE_CORNELIUS = true;
- CORNELIUS_SCRIPT_LOCATION
-
Defines the location of the upload scripts to be accessed by the WS version of the Web Server. The defined path is as shown in the example below.
const CORNELIUS_SCRIPT_LOCATION = "C:\TESTFILES\MyScripts";
- MAX_UPLOAD_SIZE
-
Defines the maximum upload size for script files in XX format. The default is ‘0x20000’. Due to a round-up error, the actual script file may be only half of the listed size or 64KB.
const MAX_UPLOAD_SIZE = 0x20000;
- MAX_POST_SIZE
-
Defines the maximum file size in HTTP POST operations. Set to '0x2000' by default.
const MAX_POST_SIZE = 0x2000;
- HTML_FILEPATH
-
Defines the location of the HTML files that control the OLE_HTML_CONTROL. Formatted as path as shown in the following example.
const HTML_FILEPATH = "C:\guixt4web\saphtmls";
- ENABLE_COMPRESSION
-
Indicates whether the file should be compressed or not. Compressing larger files can reduce the data quality. By default, compression is disabled (false).
const ENABLE_COMPRESSION = false;
- ENABLE_NTLM
-
Used during single-sign on to specify if NTLM is enabled. By default it is set to ‘false’
const ENABLE_NTLM = false;
- g_usercatalog
-
Defines the user catalog in an array format.
g_usercatalog={};
- g_usercatalog['user']
-
Sets the variable 'g_usercatalog' as the user password based on the user ID passed in.
g_usercatalog['user'] = 'password';
Gadget Flags
These flags apply to the Live Help feature built into the Web Server. They should only be modified if you are instructed by a Synactive Sales or Support representative and are listed here for reference purposes only.
- GADGETFLAGS
-
const GADGETFLAGS = {};
- GADGETFLAGS.LIVEHELP
-
GADGETFLAGS.LIVEHELP = 0x00000001;
- GADGET_ENABLED
-
const GADGET_ENABLED = GADGETFLAGS.LIVEHELP;
Client Flags
- CLIENT_CAPS_ALL
-
This parameter is edited for client flags. It specifies that when used, all the listed flags are included.
const CLIENT_CAPS_ALL = CLIFLAGS.CLI_SYSTEMMENU|CLIFLAGS.CLI_TOOLBAR|CLIFLAGS.CLI_GADGET|CLIFLAGS.CLI_CNTXTMENU|CLIFLAGS.CLI_CMNDENTRY;
- CLIENT_CAPS
-
When used, it signifies the same thing as the 'const CLIENT_CAPS_ALL' parameter.
const CLIENT_CAPS = CLIENT_CAPS_ALL;