Show TOC Entering content frame

Function documentation Help Integration Locate the document in its SAP Library structure

Use

This function allows you to integrate:

·        The help file (file with the .CHM extension) with a mobile client application

·        Context-sensitive help for tile sets of the mobile client application

Prerequisites

You must have obtained:

·        A valid user account with a profile other than the ROGuest profile.

·        The name of the help file. For example, 00007420.CHM (the Mobile System Maintenance help file)

·        The unique IDs of help topics that correspond to the tile sets, if you want to integrate context-sensitive help for tile sets.

Note

The unique IDs are referred to as the LOIOs if you use Knowledge Warehouse as the authoring tool. To find out the LOIO of a specific topic in the help file, perform the following steps:

...

                                                  i.       Display the required topic.

                                                ii.       In the topic, click the secondary mouse button and choose Properties.

                                               iii.       In the Properties window, copy the URL of the Address (URL) field and paste it in the notepad.

                                               iv.       Delete the text until the double colon.

The remaining text indicates the LOIO of the topic that you must use for context-sensitive help integration. For example, if the URL is
mk:@MSITStore:E:\Help%20Files\3.1\For%20testing\00006657.chm::/DF80173B4079CC7EE10000000A11402F/content.htm, then the LOIO of the topic is /DF80173B4079CC7EE10000000A11402F/content.htm.

Features

·        Application help integration – you can create your own .CHM help file using any supporting authoring tool and then integrate the new help file using this function.

Note

If you choose to integrate a custom help file then you must copy the required help file to the location where default SAP help files are currently stored.

·        Tile set help integration – enables you to link specific help topics for tile sets of the same context. This is done by identifying Logical Information Object (LOIOI) unique to a topic.

·        Help Modeler – an alternative method that enables you to integrate help topics as well as test the integration. You do not have to wait to generate the application in order to test the integrated help.

Activities

You can integrate help using any user profile except the “ROGuest” profile. Mobile Application Studio provides you with two methods of integrating help:

·        Using the Property window – you integrate help via the Properties window of a tile set. For more information, see Integrating Help Using the Properties Window.

·        Using the Help Modeler  you integrate help via the Help Modeler tool. This tool also enables you to test the link of a tile set. For more information, see Integrating Help Using the Help Modeler.

Note

Application users can access the integrated help topic from any of the following:

§         Help command Tile Set Help in the Help Menu

§         Help link in the white area above the tile set

§         Help command in the context menu of a tile set that is opened

 

Leaving content frame