FAQ Wiki
Page tree
Skip to end of metadata
Go to start of metadata

ITS Service Parameters 


This document only describes ITS service parameters that are either of particular interest or essential to ITS mobile services. If a particular patch level is required for individual parameters, this information is provided. Please note that there are also general ITS parameters, such as 'sap-language', ~record, and ~urlmime that can also be set for mobile applications.


KBA 2494749 might be helpfull when editing Service Parameters in SICF.


This page is part of:

ITSmobile

Tiny link (useful for e-mail):

https://wiki.scn.sap.com/wiki/x/POk

List of the Service Parameters


1) Mandatory Parameters

~ITSMOBILE

The ~ITSMOBILE parameter is mandatory and must be set to 1 for all mobile services. The parameter specifies that the particular service is for mobile devices and adjusts the ITS environment accordingly. This parameter switches off the ITS browser check and deactivates the inclusion of the browser-specific Java script on the HTML pages.

The ITS sets up an environment for a mobile service.

Example:  ~ITSMOBILE  1

~TRANSACTION

The ~TRANSACTION parameter defines the transaction to be started in the SAP system and thus determines the application to be run in the Web Application Server. A template must be available in the service for every screen of this application that is called.

Example:  ~TRANSACTION itmobile01

When the service is started using the URL, if the subsequent login is successful, the transaction itmobile01 is started.

~THEME

The ~THEME parameter defines the template set that is to be used to display the transaction. You determine which theme must be specified when you generate the template. The generator saves the templates under the theme you specify. You must specify this theme with ~THEME in the service so that the templates can be found.

Example:  ~THEME 99

When searching the generated templates for the application, the system searches for the template with the matching name/number in the current service under the HTML templates in folder 99.

~SOURCES

You use the ~SOURCES parameter to specify the services (separated by a comma) in which the templates are to be searched for. This is useful for screens/templates that are called in different transactions. You consequently do not have to regenerate the templates for these screens in every service. Instead, you simply specify the service in the ~SOURCES parameter in which the templates were already generated. Please note that the switch ~SOURCES only applies to the HTML templates. The switch cannot be used to influence the search order for MIME files (for example, JavaScript, style sheets, and GIFs). Since the runtime service provides ITSMOBILE for individual system screens, this service should always be specified as the last service.

Example:  ~SOURCES   itsmobile01, itsmobile

If a template is not found in the itsmobile01 service, the ITS searches the next service listed - in this example: itsmobile - for a matching template.

2) Unwanted parameters

~WEBGUI=1


Setting the ~webgui parameter to value 1 tells the Internet Transaction Server to start a webgui (SAP GUI for HTML) service.
However ITSmobile services are NOT webgui services. So the ~webgui parameter should be completely removed or set with the default value "0":
~WEBGUI=1
or
~WEBGUI=0


3) Parameters for Include Control

The parameters for include control are used to be able to make changes to JavaScript, CSS style sheets, or for example, device-specific function key mapping without having to make changes to the generated templates. By activating these switches, for example, a separate style sheet can be inserted in all the generated templates without actually changing the generator or the templates themselves. Please note that the inserted include files replace the default include files from the ITSMOBILE service. Consequently, your inserted CSS file, for example, must, define all the classes that are defined in the mobile.css default file of the service ITSMOBILE. Your include files replace the standard include files.

~ITSMOBILEDEVICEINCLUDE

You use ~ITSMOBILEDEVICEINCLUDE to specify your own device include file in which, for example, the mapping of function keys for a specific device is defined. The device include file is included on every HTML page in the <head> tag. Function keys are normally mapped using http meta http-equiv instructions that call a specified JavaScript when a key code is entered. The device include file is exactly the right place for these device/browser-specific instructions. The ITSMOBILE01 service can be used to illustrate this.

Example:  ~ITSMOBILEDEVICEINCLUDE devicesample
  

The content of the devicesample file is included in the HTML <head> tag on every HTML page. The devicesample file must be available in the relevant service as an HTML template.

See also SAP Note 1491666 (ITSMobile: How to obtain function key values).


~ITSMOBILECSSINCLUDE

You use ~ITSMOBILECSSINCLUDE to overwrite the default CSS style sheet of the mobile.css file from the ITSMOBILE service. The specified file must be stored in the SAP system in the current service under MIME objects and must be published. Since your own CSS file replaces the default CSS style sheet, you must have defined all the CSS classes used by ITSmobile in your file. Therefore it is recommended to copy the standard mobile.css file and modify it.

Example:  ~ITSMOBILECSSINCLUDE mycssstyle

The CSS file mycssstyle.css is included on every HTML page as a style sheet. The file extension .css is adapted and must not be specified in the parameter. Use transaction SE80 in the SAP system to ensure that the file mycssstyle.css exists in the current service and was published

See also KBA 3056108 (ITSmobile: How to use ~ITSMOBILECSSINCLUDE parameter)
and KBA 2716570 (ITSmobile: small screen size when using Android devices).


~ITSMOBILEJSINCLUDE

You use ~ITSMOBILEJSINCLUDE to overwrite the default JavaScript file mobile.js from the ITSMOBILE service. The specified file must be stored in the SAP system in the current service under MIME objects and published. Since your own JS file replaces the default JavaScript file, you must have defined all the JavaScript functions used by ITSmobile in your file so that no JavaScript errors occur when the service is executed.

Example:  ~ITSMOBILEJSINCLUDE  myjavascript

The JS file myjavascript.js is included on every HTML page as JavaScript. The file extension .js is adapted and must not be specified in the parameter. Use transaction SE80 in the SAP system to ensure that the file myjavascript.js exists in the current service under MIME objects and was published.

~ITSMOBILECUAINCLUDE

You use ~ITSMOBILECUAINCLUDE to overwrite the CUA area of the HTML page. The default CUA area is at the top of the HTML page and contains the display of the screen title and error messages, if applicable, and a GIF to trigger enter, a GIF to log off, and the SAP icon. By specifying a CUA include file, you can independently configure this area without making any changes to the actual template. When configuring the area, do not forget to display messages. To use the application, it is essential to display the messages.

Example:  ~ITSMOBILECUAINCLUDE mycuaarea

The content of your CUA file mycuaarea.html is included on every HTML page. The file extension .html is adapted and must not be specified in the parameter. Use transaction SE80 in the SAP system to ensure that the file mycuaarea.html exists in the current service under HTML templates and was published.

~ITSMOBILENOCUAINCLUDE

When the parameter is 1 or X, no CUA area will be rendered at the top of the HTML Page. The default CUA area is at the top of the HTML page and contains the display of the screen title and error messages, if applicable, and a GIF to trigger enter, a GIF to log off, and the SAP icon. Having no CUA area saves at least one full line (row), which some applications can appreciate very much.

Example:  ~ITSMOBILENOCUAINCLUDE 1

OR

Example:  ~ITSMOBILENOCUAINCLUDE X

~ITSMOBILEVOICEINCLUDE

You use ~ITSMOBILEVOICEINCLUDE to configure the generation of XHTML+Voice to meet your own requirements. Your voice include file replaces the voice.html default file from the ITSMOBILE service. Your file must contain the BHTML functions GenerateSpeech and GenerateSpeechDialog(FieldIndex), since these two functions are called from the main page to generate the HTML for speech support.

Example:  ~ITSMOBILEVOICEINCLUDE myvoice

To generate speech support, the functions GenerateSpeech and GenerateSpeechDialog(FieldIndex) are called in your myvoice.html voice include page. The file extension .html is adapted and must not be specified in the parameter. Use transaction SE80 in the SAP system to ensure that the file myvoice.html exists in the current service under HTML templates and was published.


4) Parameters for Popup Control

In the default setting, the ITS displays neither popups nor system messages. If a popup or a system message is received, it is automatically confirmed by ITS with ENTER and is not displayed. This setting makes sense in the majority of cases.
However, for applications that use popups, for example, when logging off ("Do you really want to log off? YES/NO") it may be necessary to activate popups. Note that the popups can only be displayed as fullscreen images and that a template must be available for every popup if the ITS does not provide a default template for the screen.
In addition to the application popups, system messages and express mails (transactions SM02 and SO01) can also be activated to a limited extent for mobile services. This can make sense if you want to make important system messages (for example, update task terminations) visible to the mobile user. Again, the messages can only be displayed in fullscreen mode and a template for the screen must be provided if ITS does not provide a default template.

~POPUPS

You use ~POPUPS to activate the application popups for mobile services. If the switch is set to 1, popups are displayed. Please note that you must provide an HTML template in your service for every application popup.  With the default setting "0", ITS automatically confirms popups with ENTER.

Example:  ~POPUPS  1

Application popups are displayed as fullscreen images.

~SHOW_SYSTEM_MODAL

With ~SHOW_SYSTEM_MODAL, you activate system messages and express mails (transactions SM02/SO01) for mobile services. Please note that the system messages and express messages are displayed as fullscreen images and that a HTML template must be available for the screen.

Example:  ~ SHOW_SYSTEM_MODAL  1

For system messages and express mails, a short message is displayed as a fullscreen image to mobile users. 


5) Additional Parameters

~ITSMOBILEMSGSOUND

With ~ITSMOBILEMSGSOUND you can activate beeps for messages. If the parameter is set "the beep" is run with the HTML tag "bgsound" if a message is received. The browser must support the HTML tag "bgsound" so that the beep can be outputed.

Example: ~ITSMOBILEMSGSOUND 1

When a new message is received, an output "beep" is received according to the message type.

~ITSMOBILESOUNDINCLUDE

If ~ITSMOBILEMSGSOUND is set, than the HTML tag "bgsound" is used to make the device "beep". On some browsers the "bgsound" HTML tag is not supported. In such cases the parameter ~ITSMOBILESOUNDINCLUDE can be used as described in SAP Notes  1719568 (ITSmobile: message sound code moved to a separate include)  and  3013443 (ITSmobile Visual Editor: implemented the SoundInclude feature) .

Example: ~ITSMOBILESOUNDINCLUDE NEWBEEP


~RESP_CONTENT_TYPE

This parameter is only for mobile applications with Language issue requirements. The parameter sets the HTML response-type to XHTML+Voice. The parameter must be set for all applications that have been generated with ITSMOBILEGENXV i.e "Mobile devices with language support". All other applications must not set this parameter.

Example: ~RESP_CONTENT_TYPE Application/xhtml+xml

The HTML Response Type is set to xhtml so that the browser can interpret the response correctly. Browsers that have no language assistance can react differently. Either the page without language assistance is displayed or the content is offered for download.

~ALVGRIDPAGESIZE

Defines how many lines per page are shown in the ALV table. 

If not set, all table lines are shown in one page.
A value -1 of the ~ALVGRIDPAGESIZE parameter leads to ALV Grid controls to have the same height as in SAPGUI. (See also SAP Note 3019222 .)
Parameter only relevant if you use ALV grid controls in your dynpro.

Example: ~ALVGRIDPAGESIZE 10


~DYNPRO_COMPRESSION

If you wish to remove lines containing no visible elements that are still visible on the screen then set ~DYNPRO_COMPRESSION service parameter to the value of "1"

NB: This feature is only available with style MOBILE4 (Generation style ITSGENMOBILE4) and you also need to be on at the following Support Pack listed in the SAP Note 1493374 (ITSmobile: new feature: dynpro compression).

 Example: ~DYNPRO_COMPRESSION 1

See also: SAP Note 3118444 (ITSmobile: fixed empty line height for DYNPRO_COMPRESSION feature).

~ITSMOBILENAMESPACE

This parameter is only needed when you are using an ITSmobile Services with a namspace e.g. "/AII/servicename", "/SCWM/RFUI" etc As an ICF service name, cannot contain a "/" character it is not possible to create an ICF service with the same name as the SE80 service which uses the namespace,which is required for ITSmobile to function correctly.

See SAP note: 1323339 ITSmobile: Services with a namspace for further details and an example of how to use this parameter.


Example: ~ITSMOBILENAMESPACE /SCWM/RFUI

You also need to be on the Support Pack mentioned in this note for this feature (one can also apply the SNOTE correction from SAP note 1323339)

~ITSMOBILEELEMFACTOR & ~ITSMOBILEELEMUNITS

Using the following two parameters allows one to the increase the font size of individual elements, but without increasing the other individual elements on the screen.

~ITSMOBILEELEMFACTOR

This parameter defines the factor (integer number) by which the width of visible elements will be multiplied.

~ITSMOBILEELEMUNITS

This parameter defines defines which measurements units will be used.

Example:
~ITSMOBILEELEMFACTOR 7
~ITSMOBILEELEMUNITS px

will produce "width:70px" for a 10-dynpro-character wide button.

If the parameter ~ITSMOBILEELEMFACTOR is not specified, the default factor is ""0.82"

NB: This feature is only available with style MOBILE4 and you also need to be on at least the following Support Pack's outlined in the
SAP Note 1316326 to have this feature. 1316326 ITSmobile: HTML element size is independent of font size


~ITSMOBILESEARCHHELPSHOWCUA

The CUA Area can be enabled by setting the ~itsmobileSearchhelpShowCUA to"X" (default is OFF, i.e. CUA Area is not shown)

~ITSMOBILESEARCHHELPNOFILTER

The Filter Area can be disabled by setting the ~itsmobileSearchhelpNoFilter to"X" (default is ON, i.e. SearchHelp dialog offers a possibility to filter/restrict the list of possible selection)
The advantage of setting this is to create more screen space for your ITSMobile service if it uses search help functionality

~SEARCHHELPRESULTPERPAGE

Defines the number of results that are returned in the result table. See SAP Note 1461464 ITSmobile: improved SearchHelp dialog


 ~ITSMOBILESEARCHHELPPREV & ~ITSMOBILESEARCHHELPNEXT

~ITSMOBILESEARCHHELPPREV and  ~ITSMOBILESEARCHHELPNEXT can be used to overwrite default labels of the 'Next' and 'Previous' buttons on a SearchHelp dialog. See SAP Note 1461464 ITSmobile: improved SearchHelp dialog   


NB: You also need to be on at least the followingBasis Support Pack's and Kernel version's outlined in the SAP Note 1461464 ITSmobile: improved SearchHelp dialog  to have these additional search help feature's.

~ITSMOBILESTANDARDSMODE

Turn the Standards Mode explicitily on. See SAP Note 2289261 ITSmobile: fixed MOBILE4 generator not to switch to Standards mode

~NO_LOGON_USEREXIT

Using ~NO_LOGON_USEREXIT 1 will disable User Exit.  See SAP Note 1465767 - Logon user exit SUSR0001 not called