Liquid UI - WS Reference Library

3.1.1 GuiXTMobile.sy3 File


The main configuration file for the liquid UI Mobile client is the GuiXTMobile.sy3 file, which is located in the same directory on the device as the executable. This file can contain a large number of settings. It is divided into three sections, which are as follows.

Note: If you wish to roll out a large number of similar settings to your users, you can clone the sy3 file and send it to your users. The users will then enter only their specific user credentials when they create connections.
General

This section contains settings that apply to all profiles and connections.

Profile

This section contains the individual profiles and their settings. Each profile will be uniquely named. An example of a profile name is 'Profile-1'.

Connect

If there is more than one connection, each connection will also be individually specified in the sy3 file. An example of a connection name is 'Connect-1'.

These sections explain in more detail below.

General

The settings typically found in the 'General' section of the sy3 file are as follows.

LCompanyName=

Description

LSID=

There are often two LSID entries. The first specifies your company' SAP installation number.

LSID=

There are often two LSID entries. The second specifies your company' SAP system number.

LLicense=

This entry contains the actual Mobile license number.

LConnectCount=

This entry is a number specifying how many times the connection must fail before timing out. (e.g. 10)

UseOSKeysMapping=

Entry specifies if the OS key mapping will be used in the device. The available settings are as follows:

0

The OS key mappings are not used. This is the default setting.

1

The OS key mappings will be used

UseFontSizeInPoint=

You must create this entry manually in the sy3 file as it is not in the profile settings by default. This specifies the point size of the onscreen font. The size range is from 6-10 and the default is 8.5.

SignatureDesign=

This entry must be manually added to the sy3 file as it is not present by default. It specifies whether or no the SAP Signature Design will be used. The available settings are as follows

0

The Signature Design layout will not be used. This is the default setting.

1

Signature Design will be used.

Profile

 SuppressIdleTimeLogout=

This entry specifies if the idle time logout is or is not enabled. If it is enabled, then Mobile will log out if there is no activity for a designated period of time. This period is specified in the sy3 file as well. There are two possible values for this setting, which are '0' and '1'. If the setting is '0', then idle time logout is active. If the setting is '1', then idle time logout is inactive.

URReconnectAfterLogout=

This entry specifies if the client will automatically re-connect after a user logout. If the setting equals '0' then there will be no attempt to re-connect. If the setting equals '1', then the client will automatically try to reconnect after a disconnect.

NetworkDetectInterval=

Time in minutes between the Mobile sending a signal to the connected SAP system and the time the SAP application server responds. If the time exceeds the threshold, Mobile will display a message to the user warning of possible network disruption.

ServerDetectInterval=

Time in minutes between the periodic signals Mobile sends to the SAP and the response. If the response time exceeds the threshold, Mobile will log off and disconnect all sessions.

ScanDetectThreshold=

Time in milliseconds between the first and second characters entered in a field. If the time is below the threshold, Mobile assumes a scan is being performed.

ScanCompleteThreshold=

Time in milliseconds between the end of character entry and the initiation of any smart attributes associated with the field in question. If the time exceeds the threshold, Mobile will begin smart attribute processing.

AutoTab=

Specifies if the AutoTab smart attribute is or is not active. The available options are as follows.

0

The AutoTab smart attribute is not active.

1

The AutoTab smart attribute is active.

PatternMatching=

Specifies if the Pattern Matching smart attribute is or is not active. The available options are as follows.

0

Pattern Matching is not active.

1

Pattern Matching is active.

AutoSubmit=

Specifies if the Auto-Submit smart attribute is or is not active. If auto-submit is turned on, then the user-specified transaction codes will be submitted after a field or fields are filled in. The available options are as follows.

0

Auto-Submit is not active.

1

Auto-Submit is active.

Validate=

Specifies if the Validate smart attribute is or is not active. The available options are as follows.

0

Validate is not active.

1

Validate is active.

DisplayScreenTitle=

Specifies if screen titles will or will not be displayed. The available options are as follows.

0

Screen titles will not be displayed.

1

Screen titles will be displayed.

DefaultLanguage=

Specifies the default language (e.g. EN for English).

R3UserDefWidth=

Specifies the default width in pixels of the screen that will be painted in Mobile. This information is sent to SAP and SAP will return the amount of data appropriate for this size.

R3UserDefHeight=

Specifies the default height in pixels of the screen that will be painted in Mobile. This information is sent to SAP and SAP will return the amount of data appropriate for this size.

UseR3ActualWidth=

You can define a custom size for your Mobile screens. To specify a particular width, enter a value in this parameter. This value will be the width in pixels of the screen that will be painted in Mobile. You can set this value to a smaller size than the defaults and SAP will return the appropriate amount of data for that size. This setting can be changed in the Profile.

UseR3ActualHeight=

You can define a custom size for your Mobile screens. To specify a particular height, enter a value in this parameter. This value will be the height in pixels of the screen that will be painted in Mobile. You can set this value to a smaller size than the defaults and SAP will return the appropriate amount of data for that size. This setting can be changed in the Profile.

SuppressWaitingResponseTime=

When activated, this setting suppresses the dialog box that Mobile displays during certain actions. The The default setting is '0', meaning that message dialogs will not be suppressed. Set this parameter to '1' to suppress the messages. The affected actions are as follows:

  • Waiting for responses from the server.
  • Sending logoff requests.
  • Requests in progress.
  • Connecting to a server.
URDisableCommandEntry=

When checked, it disables your ability to enter text in the transaction field. The available values for this parameter are as follows.

Note: This parameter can also be changed in the Profile.
0

Command entry in the transaction field is enabled. This is the default value.

1

Command entry in the transaction field is disabled.

DisplayMenuBar=

When checked, it specifies if the menu bar is or is not displayed in the Mobile client. The available values for this parameter are as follows.

Note: This parameter can also be changed in the Profile.
0

The menu bar will not be displayed. This is the default value.

1

The menu bar will be displayed.

Language=

Specifies the language to be used.

Note: This setting is only used if auto-logon is enabled.
Password=

Specifies the password to be used for logging into SAP.

Note: This setting is only used if auto-logon is enabled.
UserName=

Specifies the user name to be used for logging into SAP.

Note: This setting is only used if auto-logon is enabled.
DefaultName=

Specifies the default user name for a logon attempt.

SuppressTableControl=

Specifies if SAP table controls will or will not be displayed. The available values are as follows.

0

SAP table controls will not be suppressed.

1

SAP table controls will be suppressed.

AutoTCode=

Designates the tcode of the start transaction that you will be taken to after logging into SAP. An example of a valid transaction code would be VA01.

IconOnlyAppToolbar=

Specifies that only icons will be displayed in the Mobile client's menu bar. The available values are as follows.

0

Both icons and text will be displayed on the menu bar.

1

Only icons will be displayed on the menu bar.

DragSelectThreshold=

Time in milliseconds that indicates a user may be 'drag-selecting' content in a given field. When tapping into a field, users may either select the entire field or 'drag-select' only a part of the text. If the user taps and holds longer than this threshold, Mobile assumes that drag-selecting is being used.

DoneEnteringTextThreshold=

Time in milliseconds between the end of manual text entry and the initiation of smart attributes. Smart attribute processing commences after the threshold is exceeded.

DefaultClientNumber=

Specifies the default SAP client number.

XBehavesLikeWindows=

Specifies if the application does or does not follow Windows behvioral guidelines when it is minimized. If this is set to true, then when a window is minimized, Mobile will close the window. If set to false, the window will be minimized. The available settings and values are as follows:

0

The application does not behave like WIndows.

1

The application behaves like Windows.

BeepOnChar=

Specifies if the application will beep when a character is entered. The default setting is '1'. The available settings are as follows.

0

Mobile will not beep when you enter a character.

1

Mobile will beep when a character is entered.

Note: This is the default setting.
OPtionalLogScreen=

This setting specifies that an optional logon screen will be displayed when a user logs into SAP with Mobile. The available settings are as follows.

0

The standard logon screen will be displayed.

1

Mobile will display an alternate logon screen.

SoftKeyEnable=

Specifies if soft keys are or are not enabled. If they are enabled, the 'Softkey=' option will also apply. The available options are as follows:

Note: If this is enabled, you can also use the 'SoftKey' parameter described below.
0

The Soft keys are not enabled.

1

The Soft keys are enabled.

SoftKey=

Specifies a default soft key that will be used with Mobile.

Note: This is only active if the 'SoftKeyenable' settigns are also turned on. SoftKeyenable is explained in the
BypassExceptionDialog=

If this is activated, Mobile will display a message warning the user that the session and connection will be terminated when a timeout situation occurs. If this is not active, Mobile will simply go ahead and terminate the connection and session. This is useful for slow connections and the available options are as follows.

0

An exception dialog will be displayed.

1

An exception dialog will not be displayed - Mobile will terminate the connection.

SuperRestrict=

Specifies if the super-restriction feature is activated. The available options are as follows:

0

Super-restricted profiles are not activated.

1

Super-restricted profiles are activated.

DisplayPatMatchMessage=

If activated, all messages related to pattern matching will not be displayed in Mobile. The available options are shown below.

0

Mobile will display all pattern matching messages.

1

Pattern matching messages will be suppressed.

DialogOnError=

Specifies if Mobile pops up a dialog box in addition to the statusline message when an error occurs. The available settings are as follows:

0

Mobile will display dialogs when errors occur.

1

Mobile will not display any error messages.

ClearToSendTimeOut=90

When Mobile sends data to SAP the default time for a response is 90 seconds. You can change the threshold here or in the Profile settings. If the time exceeds this threshold, Mobile will display a timeout message and will close the connection.

ProfileName=

Specifies which profile is to be used for the connection. You will enter the name of the profile you want to use.

OfflineMode=

Specifies if the Offline mode for Mobile is or is not enabled. Mobile normally operates with this disabled, but when used with the Synactive Offline solution, this will need to be enabled. The available options are as follows.

0

Offline mode is not enabled.

1

Offline mode is enabled.

Connect

Description=

A string that describes the server. This can be anything.

AppServer=

Specifies the name of the target SAP system

SystemNumber=

Specifies the system number of the target SAP server.

DefaultLogon=

Designates if there is or is not a default logon that you have specified. The available settings are as follows.

0

No default logon has been specified.

1

A default logon exists.

UseProfileName=

Specifies which profile is to be used for the connection.