com.sap.ip.me.api.conf
Interface PropertyKeys

public interface PropertyKeys

This interface contains all property keys used by the Mobile Engine framework within the configuration. Each property key description contains a set of possible values for that key and the default value.

Author:

SAP

Field Summary

static java.lang.String	AWT_DIALOGBOXES_RESIZING Enable dialog box resizing.
static java.lang.String	AWT_EXIT_MENUENTRY_DISABLED Controls whether or not the AWT menu entry for the exit funtion is enabled or disabled.
static java.lang.String	AWT_LOGOFF_MENUENTRY_DISABLED Controls whether or not the AWT menu entry for the user logoff is enabled or disabled.
static java.lang.String	AWT_LOGON_MENUENTRY_DISABLED Controls whether or not the AWT menu entry for the user logon menu entry is enabled or disabled.
static java.lang.String	AWT_PREFERRED_HEIGHT The preferred heigth of the Mobile Infrastructure AWT home application.
static java.lang.String	AWT_PREFERRED_WIDTH The preferred width of the Mobile Infrastructure AWT home application.
static java.lang.String	AWT_SCROLLBARS_ENABLING Show scrollbars within dialogs if the dialog box is too small for its content.
static java.lang.String	AWT_SYNC_MENUENTRY_DISABLED Controls whether or not the AWT menu entry for the sync menu entry is enabled or disabled.
static java.lang.String	DATACOMPRESSION_GZIP_ENABLING Enable gzip compression while synchronization.
static java.lang.String	INSTALLATION_DIRECTORY The Mobile Engine installation path.
static java.lang.String	MI_HOME Specifies the Mobile Infrastructure client home page url.
static java.lang.String	PREFIX_FOR_DLLS_LOADED_AT_STARTUP All dlls, that have to be loaded by the Mobile Inftrastructure framework, have to set up a configuration entry with this prefix.
static java.lang.String	PRINTER_IMPLEMENTATIONS A comma separated list of Printer implementation classes.
static java.lang.String	RUNTIME The UI that should be started by the Mobile Engine startup class (com.sap.ip.me.core.Startup ).
static java.lang.String	RUNTIME_APPLICATION_TO_BE_STARTED_AUTOMATICALLY The name of the application which shall be started automatically after a user logon.
static java.lang.String	RUNTIME_HOST The hostname of the Mobile Infrastructure webserver.
static java.lang.String	RUNTIME_PORT The port on which the Mobile Infrastructure webserver is running.
static java.lang.String	SETTING_LANGUAGECHECK if not set the language test is omited and the application starts even if the language is not supported by the application.
static java.lang.String	SYNCSETTINGS_BACKGROUNDFILTER The setting for 'Filter on Timed Sync'.
static java.lang.String	SYNCSETTINGS_CLIENT The client of the SAP Web AS that will be used for synchronization.
static java.lang.String	SYNCSETTINGS_CONNECTION_TIMEOUT The connection timeout in milliseconds.
static java.lang.String	SYNCSETTINGS_CONNECTION_TYPE Connection type for synchronization.
static java.lang.String	SYNCSETTINGS_COUNTRY The current country setting.
static java.lang.String	SYNCSETTINGS_GATEWAY Deprecated. since MI 2.5
static java.lang.String	SYNCSETTINGS_LANGUAGE The current log in and synchronization language.
static java.lang.String	SYNCSETTINGS_LONGUSERNAME Deprecated. since MI 2.5
static java.lang.String	SYNCSETTINGS_NEW_PROTOCOL_ACTIVE Determines if new protocol type for synchronization is active.
static java.lang.String	SYNCSETTINGS_TIMEZONE The current time zone setting.
static java.lang.String	SYNCSETTINGS_USER Deprecated. since MI 2.5
static java.lang.String	SYNCSETTINGS_WAITFORRESUTLS_TIMEOUT The timeout in milliseconds to wait for results being sent from the Mobile Infrastructure Server.
static java.lang.String	TRACE_ENABLED Enable tracing.
static java.lang.String	TRACE_FILENAME The location of the trace file (absolute or relative to the Mobile Infrastructure installation folder).
static java.lang.String	TRACE_FILESIZE The maximum size of the trace file in KB.
static java.lang.String	TRACE_LEVEL The current effective trace level.
static java.lang.String	TRACE_PERFORMANCELOG_ENABLED Indicates wether the performance log is enabled or not.
static java.lang.String	TRACE_SAT_ENABLED Indicates wether Single Activity Tracing (SAT) is enabled or not.
static java.lang.String	TRACE_USEMESSAGETYPE Deprecated. since MI 2.5
static java.lang.String	TRACE_USETIMESTAMP Deprecated. since MI 2.5

Field Detail

AWT_DIALOGBOXES_RESIZING

public static final java.lang.String AWT_DIALOGBOXES_RESIZING

Enable dialog box resizing.
Possible values: true for enable resizing or false for disable
Default value: false

Since:

ME 2.1 SP01

See Also:

Constant Field Values

AWT_SCROLLBARS_ENABLING

public static final java.lang.String AWT_SCROLLBARS_ENABLING

Show scrollbars within dialogs if the dialog box is too small for its content.
Possible values: true show scrollbars within dialogs if dialog box is too small for its content or false if no scrollbars should be displayed in dialogs
Default value: false

Since:

ME 2.1 SP01

See Also:

Constant Field Values

AWT_PREFERRED_WIDTH

public static final java.lang.String AWT_PREFERRED_WIDTH

The preferred width of the Mobile Infrastructure AWT home application.
Possible values: any positive integer value. The value should be between 240 and the width of the screen
Default value: 240

Since:

ME 2.1 SP01

See Also:

Constant Field Values

AWT_PREFERRED_HEIGHT

public static final java.lang.String AWT_PREFERRED_HEIGHT

The preferred heigth of the Mobile Infrastructure AWT home application.
Possible values: any positive integer value. The value should be between 290 and the height of the screen
Default value: 290

Since:

ME 2.1 SP01

See Also:

Constant Field Values

AWT_LOGOFF_MENUENTRY_DISABLED

public static final java.lang.String AWT_LOGOFF_MENUENTRY_DISABLED

Controls whether or not the AWT menu entry for the user logoff is enabled or disabled.
Possible values: true for disabling the user logoff menu entry or false for enabling the user logoff menu entry
Default value: false

Since:

MI 2.5 SP10

See Also:

Constant Field Values

AWT_EXIT_MENUENTRY_DISABLED

public static final java.lang.String AWT_EXIT_MENUENTRY_DISABLED

Controls whether or not the AWT menu entry for the exit funtion is enabled or disabled.
Possible values: true for disabling the exit funtion or false for enabling the exit funtion
Default value: false

Since:

MI 2.5 SP10

See Also:

Constant Field Values

AWT_LOGON_MENUENTRY_DISABLED

public static final java.lang.String AWT_LOGON_MENUENTRY_DISABLED

Controls whether or not the AWT menu entry for the user logon menu entry is enabled or disabled.
Possible values: true for disabling the user logon menu entry or false for enabling the user logon menu entry
Default value: false

Since:

MI 2.5 SP10

See Also:

Constant Field Values

AWT_SYNC_MENUENTRY_DISABLED

public static final java.lang.String AWT_SYNC_MENUENTRY_DISABLED

Controls whether or not the AWT menu entry for the sync menu entry is enabled or disabled.
Possible values: true for disabling the sync menu entry or false for enabling the sync menu entry
Default value: false

Since:

MI 2.5 SP10

See Also:

Constant Field Values

RUNTIME_APPLICATION_TO_BE_STARTED_AUTOMATICALLY

public static final java.lang.String RUNTIME_APPLICATION_TO_BE_STARTED_AUTOMATICALLY

The name of the application which shall be started automatically after a user logon. Possible values: any technical name of an application Default value: not set

Since:

MI 2.5 SP10

See Also:

Constant Field Values

DATACOMPRESSION_GZIP_ENABLING

public static final java.lang.String DATACOMPRESSION_GZIP_ENABLING

Enable gzip compression while synchronization. Take care that the J2EE engine has to be configured too if compressed synchronization should be used.
Possible values: true for enabling compressed synchronization or false for disabling compressed synchronization
Default value: false

Since:

ME 2.1 SP01

See Also:

Constant Field Values

INSTALLATION_DIRECTORY

public static final java.lang.String INSTALLATION_DIRECTORY

The Mobile Engine installation path. May be used read-only . This path is passed as a startup argument. The correct path is automatically set by the setup.exe for Win32 setups and the link for the Mobile Engine start on WinCE devices contains the correct path settings too.
Possible values: A system dependant path of the Mobile Engine installation.
Default value: system dependant. Will be set while startup.

Since:

ME 2.1

See Also:

Constant Field Values

SYNCSETTINGS_CONNECTION_TYPE

public static final java.lang.String SYNCSETTINGS_CONNECTION_TYPE

Connection type for synchronization.
Possible values: http for synchronization via http, disc for synchronization via file
Default value: http

Since:

ME 2.1 SP01

See Also:

Constant Field Values

SYNCSETTINGS_GATEWAY

public static final java.lang.String SYNCSETTINGS_GATEWAY

Deprecated. since MI 2.5

The gateway for synchronisation. Possible values: any url (including the protocol).
Default value: Empty

See Also:

Constant Field Values

SYNCSETTINGS_LANGUAGE

public static final java.lang.String SYNCSETTINGS_LANGUAGE

The current log in and synchronization language. May be used read-only .
Possible values: any language iso code that is defined in ISO 639.
Default value: not set (depends on installation)

Since:

ME 2.1

See Also:

Constant Field Values

SYNCSETTINGS_COUNTRY

public static final java.lang.String SYNCSETTINGS_COUNTRY

The current country setting. May be used read-only .
Possible values: any country iso code that is defined in ISO 3166.
Default value: not set (system country setting)

Since:

MI 2.5

See Also:

Constant Field Values

SYNCSETTINGS_TIMEZONE

public static final java.lang.String SYNCSETTINGS_TIMEZONE

The current time zone setting. May be used read-only .
Possible values: any time zone id that is supported by java.util.TimeZone
Default value: not set (system time zone setting)

Since:

MI 2.5

See Also:

Constant Field Values

SYNCSETTINGS_LONGUSERNAME

public static final java.lang.String SYNCSETTINGS_LONGUSERNAME

Deprecated. since MI 2.5

The long user name that is retrieved from the backend system. May be used read-only .
Possible values: any string
Default value: not set

See Also:

Constant Field Values

SYNCSETTINGS_BACKGROUNDFILTER

public static final java.lang.String SYNCSETTINGS_BACKGROUNDFILTER

The setting for 'Filter on Timed Sync'.
Possible values: true or false

Default value: false (filter is not activated)

Since:

MI 2.5

See Also:

Constant Field Values

SYNCSETTINGS_USER

public static final java.lang.String SYNCSETTINGS_USER

Deprecated. since MI 2.5

The user login-name of the current user. May be used read-only
Possible values: any string
Default value: not set

See Also:

Constant Field Values

SYNCSETTINGS_CLIENT

public static final java.lang.String SYNCSETTINGS_CLIENT

The client of the SAP Web AS that will be used for synchronization. May be used read-only
Possible values: any string
Default value: not set

Since:

ME 2.1

See Also:

Constant Field Values

RUNTIME

public static final java.lang.String RUNTIME

The UI that should be started by the Mobile Engine startup class (com.sap.ip.me.core.Startup ). May be used read-only
Possible values: awt or tomcat
Default value: tomcat

Since:

ME 2.1

See Also:

Constant Field Values

SYNCSETTINGS_CONNECTION_TIMEOUT

public static final java.lang.String SYNCSETTINGS_CONNECTION_TIMEOUT

The connection timeout in milliseconds.
Possible values: any string that represents a long and -1 (no connection test)
Default value: -1

Since:

ME 2.1

See Also:

Constant Field Values

SYNCSETTINGS_WAITFORRESUTLS_TIMEOUT

public static final java.lang.String SYNCSETTINGS_WAITFORRESUTLS_TIMEOUT

The timeout in milliseconds to wait for results being sent from the Mobile Infrastructure Server.
Possible values: any string that represents a long and -1 (wait until server sends a response; somtimes the server does not send any response)
Default value: -1

Since:

ME 2.1 SP02

See Also:

Constant Field Values

TRACE_ENABLED

public static final java.lang.String TRACE_ENABLED

Enable tracing.
Possible values: true for switching trace on or false for switching off
Default value: false

Since:

ME 2.1

See Also:

Constant Field Values

TRACE_LEVEL

public static final java.lang.String TRACE_LEVEL

The current effective trace level.
Possible values: 10, 50, 60, 70 , 80, 90 and 1000

• 10 (fatal errors)
• 50 (errors)
• 60 (warnings)
• 70 (information)
• 10 (path information)
• 90 (debugging)
• 1000 (all)

Default value: 1000

Since:

MI 2.1

See Also:

Constant Field Values

TRACE_FILENAME

public static final java.lang.String TRACE_FILENAME

The location of the trace file (absolute or relative to the Mobile Infrastructure installation folder).
Possible values: any filename. If it starts with / the filename is interpreted as relative to the SAP MI installaion folder.
Default value: /log/trace.txt

Since:

ME 2.1

See Also:

Constant Field Values

TRACE_FILESIZE

public static final java.lang.String TRACE_FILESIZE

The maximum size of the trace file in KB. If the trace file reaches the configured size one backup file will be created and a new trace file is started.
Possible values: any positive long value (length in KB) or -1> .
Default value: 200

See Also:

Constant Field Values

TRACE_USEMESSAGETYPE

public static final java.lang.String TRACE_USEMESSAGETYPE

Deprecated. since MI 2.5

This flag is not used any more .
A flag that indicates wether message type should be printed to the trace file.
Possible values: true or false
Default value: true

See Also:

Constant Field Values

TRACE_USETIMESTAMP

public static final java.lang.String TRACE_USETIMESTAMP

Deprecated. since MI 2.5

This flag is not used any more .
A flag that indicates wether timestamp is enabled within the trace file.
Possible values: true or false
Default value: true

See Also:

Constant Field Values

TRACE_PERFORMANCELOG_ENABLED

public static final java.lang.String TRACE_PERFORMANCELOG_ENABLED

Indicates wether the performance log is enabled or not.
Possible values: true performance log is enabled or false = it is disabled
Default value: false

Since:

ME 2.1 SP02

See Also:

Constant Field Values

TRACE_SAT_ENABLED

public static final java.lang.String TRACE_SAT_ENABLED

Indicates wether Single Activity Tracing (SAT) is enabled or not.
Possible values: true SAT is enabled or false = it is disabled
Default value: false

Since:

MI 2.5

See Also:

Constant Field Values

SYNCSETTINGS_NEW_PROTOCOL_ACTIVE

public static final java.lang.String SYNCSETTINGS_NEW_PROTOCOL_ACTIVE

Determines if new protocol type for synchronization is active. May be used read-only
New protocol is based on the assumption that for each received container an acknwoledge will be created. The acknowledge will be send also via container.
In the new protocol only one http connection is required for one sync cycle. The old protocol requires two connections, one for data and one for the acknowledge.
If Mobile Infrastructure has synchronized once it is not possible to switch the protocol
Possible values: true (new protocol) or false (old protocol)
Default value: true

Since:

ME 2.1 SP01

See Also:

Constant Field Values

PREFIX_FOR_DLLS_LOADED_AT_STARTUP

public static final java.lang.String PREFIX_FOR_DLLS_LOADED_AT_STARTUP

All dlls, that have to be loaded by the Mobile Inftrastructure framework, have to set up a configuration entry with this prefix. The value of the configuration has to be a colon separated list of dlls. Possible values: a comma separated list of system libraries. The names should not contain any folder information and they should not have the system library suffix like ".dll"
Default value: not set
Example:
If you want to add support for intermec printer that needs 3 dlls following has to be inserted into the configuration file:
MobileEngine.Startup.LoadDlls.Printer.Intermec700 = javaapi, prnport, prnerr
The javaapi.dll, prnport.dll and prnerr.dll have to be in the system library path (e.g. the windows folder). The suffix of the key Printer.Intermec700 can freely be chosen. The suffix may contain a-z,A-Z,0-9 and dot characters only.

Since:

ME 2.1 SP 02 PL 03

See Also:

Constant Field Values

MI_HOME

public static final java.lang.String MI_HOME

Specifies the Mobile Infrastructure client home page url. May be used read-only
This value is set by the Mobile Infrastructure framework and must not be changed by any application! .
Default value: http://localhost:4444/

See Also:

Constant Field Values

SETTING_LANGUAGECHECK

public static final java.lang.String SETTING_LANGUAGECHECK

if not set the language test is omited and the application starts even if the language is not supported by the application.
Possible values: true or false
Default value: true

See Also:

Constant Field Values

RUNTIME_PORT

public static final java.lang.String RUNTIME_PORT

The port on which the Mobile Infrastructure webserver is running. Will be set automatically by the framework. May be used read-only
Possible values: any port number
Default value: 4444

See Also:

Constant Field Values

RUNTIME_HOST

public static final java.lang.String RUNTIME_HOST

The hostname of the Mobile Infrastructure webserver. May be used read-only
Possible values: localhost or 127.0.0.1
Default value: localhost

See Also:

Constant Field Values

PRINTER_IMPLEMENTATIONS

public static final java.lang.String PRINTER_IMPLEMENTATIONS

A comma separated list of Printer implementation classes. The classes have to be full qualified. Possible values: A comma separated list of full qualified class names
Default value: empty

See Also:

Constant Field Values