10.5 Creating Help for Your Application
Help created in App Builder displays on a dedicated Help page. To access Help, users click a link that takes them to a dedicated Help page. This Help page displays page and field-level Help topics specific to the page they are viewing.
- Creating Help
Developers can create both a dedicated Help page and item Help text for an application. - Using the Bulk Edit Item Help Report
Edit all Help topics within an application at once using the Bulk Edit Item Help report - Seeding Item Help Topics
For applications that do not yet contain Help, you can perform a mass update (or seed) of default Help text. - Creating a Help Navigation Bar Entry
Once you have created your Help, the next step is to create a navigation bar entry so users can link to it.
Parent topic: Managing Database Application Components
10.5.1 Creating Help
Developers can create both a dedicated Help page and item Help text for an application.
Parent topic: Creating Help for Your Application
10.5.1.1 About Creating Help
App Builder includes built-in attributes to create Help for your application. Creating Help for your application involves the following steps:
-
Step 1: Create a dedicated Help page and Help region. See "Creating a Help Page and Region."
-
Step 2: Define page Help text. See "Defining Page Help."
-
Step 3: Define item Help text. See "Defining Item Help."
-
Step 4: Create a navigation bar icon to link to your Help page. See "Creating a Help Navigation Bar Entry."
Parent topic: Creating Help
10.5.1.2 Creating a Help Page and Region
To create a Help page and region in Page Designer:
See Also:
Parent topic: Creating Help
10.5.2 Using the Bulk Edit Item Help Report
Edit all Help topics within an application at once using the Bulk Edit Item Help report
Developers can use the Bulk Edit Item Help report to view the item Label and Name, access the item, or link to the page containing the item.to the associate page
If you are including Help in your application, you can edit multiple Help topics at once using the Bulk Edit Item Help report.
To view the Bulk Edit Item Help report:
See Also:
Parent topic: Creating Help for Your Application
10.5.3 Seeding Item Help Topics
For applications that do not yet contain Help, you can perform a mass update (or seed) of default Help text.
To seed Help topics:
- On the Workspace home page, click the App Builder icon.
- Select an application.
- Click the Utilities icon.
- From Page Specific Utilities, select Item Utilities.
- Click Grid Edit of All Item Help Text.
- Click Seed Item Help Text.
- To edit existing item Help:
- In Item Help Text, enter the default text to appear in all Help topics.
- Click Apply Changes.
- To create help text for all items that currently do not have help text, click Seed Item Help Text and follow the on-screen instructions.
- Click Apply Changes.
Parent topic: Creating Help for Your Application
10.5.4 Creating a Help Navigation Bar Entry
Once you have created your Help, the next step is to create a navigation bar entry so users can link to it.
To create a navigation bar entry:
Parent topic: Creating Help for Your Application