Foundation1 / Development Guide / User Interface / Ee Dev / Navigator / This page

Navigator

The navigator is a hierarchical structure of entries which normally performs a navigation request to a specific page, task, report etc. Navigator entries are separated per component and located in a file named navigator-functional.xml in <component>\source\<component>\client folder.

For information about the editing the navigator see, Navigator Editor. For reference, please see Navigator Reference

Contents

• How to create a new navigator entry
• How to create a new empty navigator for a new component

How to create a new navigator entry using text editor

1.       Locate the file you want to edit. Location: <component>\source\<component>\client\navigator-functional.xml

2.       Open with a text editor

3.       Search for the entry to change using editors “Find” function.
Hint: use the entry name or URL

4.       Save the file

When a navigator file is changed, the complete navigator must be rebuilt. When running the standard build scripts the navigator will be built, but for a quicker roundtrip a special build script, named  _generate_dictionary.cmd, is available just to rebuild navigator. Its location is in ee-runtime\source.

How to create a new navigator entry using navigator editor

1. Locate the root folder in which all component files are stored. This folder is normally named components, source etc.
2. Start Navigator Editor. You can read a functional description of the tool in navigator editor tool guide.
3. Enter the root folder for all components found in step 1 in the FND_HOME textbox.
4. Select components to edit, can be a single component name eg APPSRV, a comma separated list eg APPSRV,ENTERP or * for all components in the FND_HOME folder.
5. Select components to reference, can be a single component name eg APPSRV, a comma separated list eg APPSRV,ENTERP or * for all components in the FND_HOME folder. Referenced components are read-only views of the component navigators.
6. In the tree, locate the folder in which you want to create your entry. Right click and select "New Child"
7. Enter a key, preferably using a rather short using CAPITAL letters.
   Example ORDER_MGT. Enter also the component in which the navigator entry should be located (=which navigator-functional.xml file to save it in)
8. Give the node a name and a wanted ordinal number. Make use of the tree information to see the ordinal numbers.
9. Enter the wanted URL and select a type from the type dropdown.
10. Save the file using the Save button

When a navigator file is changed, the complete navigator must be rebuilt. When running the standard build scripts the navigator will be built, but for a quicker roundtrip a special build script is available just to rebuild navigator etc.

How to create a new empty navigator for a new component

1. Make sure  a folder structure like <component>\source\<component\>\client is created.
2. Create a file named navigator-functional.xml in
3. Enter the following contents in navigator-functional.xml

<?xml version="1.0" encoding="utf-8"?>
<FndNavigator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Legacy="false">
   <FndNavigatorEntries>
   </FndNavigatorEntries>
</FndNavigator>

4. Save the file and continue in How to create a new navigator entry.