GuiXT Configuration

This section covers the configuration for GuiXT. Topics covered are as follows:

• GuiXT.ini File
• Using the Profile Tool
• User Catalog

GuiXT.ini File

GuiXT is configured through the GuiXT.ini file that we introduced previously. In this section, we will discuss the GuiXT.ini file and define the parameters contained within it. A typical GuiXT.ini file appears as follows:

There are many parameters that are contained in a GuiXT.INI file. These are defined as follows:

• Key: There are typically two 'Key' entries in the GuiXT.ini file. The first one is for the GuiXT license key. This is not required for components - only for GuiXT itself. The second 'Key' entry specifies the license registration keys for the GuiXT components (eg. Designer, Viewer, Input Assistant, etc).
• IgnoreRegistry: If a central GuiXT.ini or the local GuiXT.ini is to be used to specify configurations, set this parameter to 'Yes'. If the GuiXT Profiler is to be used, set this parameter to 'No'.
• Component: This section is where any installed GuiXT components are defined. There are multiple entries to accommodate the components that can be installed. Typically the entries are for GuiXT, InputAssistant, Viewer and Designer.
• Directory1 - Directory4: The script directories. There can be up to four script directories specified - GuiXT will search each one in succession when searching for scripts.
• StartMinimized: Specifies GuiXT to start with a minimized window.
• StartHidden: Specifies that GuiXT window should be hidden when the application starts.
• History: Shows the local value help and displays the user's action history when users are in InputAssistant. there are four subordinate options for History, as follows:
  • HistoryUpdate: Makes the history update active, enabling History to be displayed.
  • Domains: Specifies the domains that are to be used for the local value help.
  • HistoryOnRightButton: Enables the history to be displayed when users press the mouse right button.
  • History on MiddleButton: Enables history to display when users press the mouse's middle button.
• icon_tip_field: The identification for icons used in field tooltips. The default value is 'OL'.
• icon_tip_box: The identification for icons used in groupbox tooltips. The default value is '35'.
• Option: These parameters can be used for user-defined parameters. If statements can be used or other code to specify user parameters. Synactive Support or Professional Services can provide additional details on how to create and use the user-defined parameters.
• Replication: Specifies if file replication is or is not active.
• Directory0: Specifies the directory used to hold replicated files.
• Testkey: Used only for testing - not typically used in customer environments.
• Trace: Turns internal tracing for error analysis on or off.
• Docu: Specifies the directory where the GuiXT documentation is stored.
• Linksapurl: For Viewer only. Specifies support for SAP URLs in a normal HTML display.
• RfcPassword: Specifies the password for RFC calls in plain text.
• FileAcceessTimeout: Maximum time in seconds for access to FTP, HTTP or external file servers before the request times out.

The GuiXT.ini file can be edited in two different way, as follows:

• Manually editing GuiXT.ini
• Using the Profile tool

Manually editing GuiXT.ini

The quickest method of changing parameters in GuiXT is to edit the GuiXT.ini file. To edit the GuiXT.ini file, users can employ any text editor. In our examples, we are using the default Windows editor Notepad. This file is explained in detail above and is located in the following directory:
C:\Program Files\SAP\FrontEnd\SAPgui\

Using the Profile Tool

In the GuiXT window, press the Profile button or go to the Edit menu and select Profile. A new window will open, as shown below:

In the Profile window, set the following parameters:

• Directories: In the Directories section of the Profile window, set the script directories to be used. GuiXT supports up to four script directories, which will be searched in progression, 1-4.
• Installed Components: The Installed Component section specifies which Synactive components are installed. In our example, we have GuiXT, Input Assistant, Viewer and Designer installed. It is important to select only the components for which the user has valid licenses.
• License Keys: The license key for the installed components, as previously defined. This would hold the license key or keys for the installed Synactive components.
• History Directory: A default history directory is recommended. If the user has an existing history folder, input the path to that directory in this field.
• Update Active: Check the 'Update Active' checkbox if the 'Component Input Assistant' is being used. If the user is not using this component, the checkbox will not be active.

In addition to the above required parameters, there are other parameters that can be modified in the Profile window. These are explained in the GuiXT.ini File section above.

User Catalog

As was previously discussed in the Profile section above,, it is possible to activate different script directories on different user systems. However, this is not always sufficient, as there are scenarios where simply specifying the scripts as being assigned to a specific machine may not be the best option. for example, if a user works on multiple systems, it is better to define the relevant scripts based on the user's SAP identity. Similarly, if a user prefers a single standard (and central) configuration for managing scripts, then the user catalog is the best choice. By using a group catalog, it is possible to select not only specific script directories, but also to designate both systems and group directories upon which those scripts will act. User catalogs are read after the SAP login screen - for the login screen itself, the listed directories in the guixt.ini file will apply. The syntax for creating a user catalog in the guixt.ini is as follows.

UserCatalog \\ServerName\GuiXT\DatabaseName\usercatalog.txt

In this example, there is an entry in the guixt.ini file that will specify a the user catalog. It is possible to replace the 'DatabaseName' portion of the path with a variable, as shown below. This will allow for different user catalogs to be applied to different production systems.

UserCatalog \\serverName\GuiXT\&database\usercatalog.txt

It is possible to store a user catalog file on a Web server. In this case, users can specify the location as shown in the following example:

UserCatalog http:////www.mycompany.com/guixt/usercatalog.txt

Each user catalog contains up to five groups, which are named as the following:

• M1:
• M2:
• MX:
• TEST:
• XX:

Each group can have up to four script directories specified. If the directory names contain spaces, it is necessary to designate them as strings by using double-quotes, as in the following example:

Directory1 "\\server\guixt\Directory Name"

Below the groups, there is a section where users can specify one group for each client or user. At the end of each client, users can specify the correspondence for all remaining users by adding 'client/*'. If it is necessary to list a client-independent association, add an asterisk '*' to the end of the given catalog. It is not necessary to list users in alphabetical order, but doing so will aid list maintenance, so it is recommended. If the specification 'none' is used with a directory name, it designates that the given directory is not active even if it is specifically referenced.

Modifications in a user catalog become active on the user's first login after the changes have been applied. If a user catalog is changed while a session is active, the changes will only take effect on the users' subsequent login - they will not affect any current sessions.

If a particular user is not found in the user catalog, then the system will first look to see if there is a general notification. If there is a '*' entry, the system will use the corresponding groups. If no such designation exists, then the system will use any default directories that are specified in the guixt.ini file.