ITS Service Parameter
|Tiny Link: (useful for email etc)||https://wiki.scn.sap.com/wiki/x/POk|
This document only describes ITS service parameters that are either of particular interest or essential to 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.
List of the Service Parameters
1) Mandatory Parameters
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. Example: ~ITSMOBILE 1
The ITS sets up an environment for a mobile service.
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.
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.
Example: ~SOURCES itsmobile01, itsmobile
If a template is not found in the itsmobile01 service, the ITS searches the next service listed - in this case, itsmobile - for a matching template.
2) Parameters for Include Control
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).
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
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.
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.
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.
3) 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.
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.
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.
4) Additional Parameters
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.
If ~ITSMOBILEMSGSOUND is set 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 Note
1719568 ITSmobile: message sound code moved to a separate include
Example: ~ITSMOBILESOUNDINCLUDE NEWBEEP
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.
Defines how many lines per page are shown in the ALV table. If not set, all table lines are shown in one page. Parameter only relevant if you use ALV grid controls in your dynpro. (Generation style ITSGENMOBILE4)
Example: ~ALVGRIDPAGESIZE 10
NB: This feature is only available with style MOBILE4 (Generation style ITSGENMOBILE4 )
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
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.
This parameter defines the factor (integer number) by which the width of visible elements will be multiplied.
This parameter defines defines which measurements units will be used.
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
The CUA Area can be enabled by setting the ~itsmobileSearchhelpShowCUA to"X" (default is OFF, i.e. CUA Area is not shown)
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
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 following Support Pack's and Kernel version's outlined in the SAP note 1461464 ITSmobile: improved SearchHelp dialog ITSmobile: improved SearchHelp dialog
to have these additional search help feature's.
Turn the Standards Mode explicitily on. See SAP Note 2289261 ITSmobile: fixed MOBILE4 generator not to switch to Standards mode