UI - Navigator Designer¶
Configuring the IFS Cloud Web navigator can be done with the Navigator Designer tool. With Navigator Designer you can do the following navigator configurations:
- Change the label and destination for existing entries
- Hide or delete entries.
- Add entries
- Re-position entries
Open Navigator Designer¶
Navigator Designer is opened from the application user menu. Open Navigator Designer will replace the navigator pane with the designer tool.
Work in Navigator Designer¶
Change a navigator entry label¶
Navigator entry labels can be changed by following these steps:
- Open Navigator Designer from the user menu
- Click on the navigator entry you want to configure Selecting an entry opens the entry property pane at the bottom of the designer.
- Update the Label field in the pane that opens up in the bottom of the designer.
- If the customer is using IFS Cloud in multiple languages, the translations for the modified navigator entry might also need to be updated. Refer to Translate a Configured Navigator Entry for more information.
Change a navigator entry destination¶
- Open Navigator Designer from the user menu
- Click on the navigator entry you want to configure Selecting an entry opens the entry property pane at the bottom of the designer.
- Update the destination accordingly. Destination denotes the link attribute that are named differently depending of what type of navigator entry you are editing; e.g. ; Assistant, External Path, Internal Path, Tree, Uri
Hide or delete a navigator entry¶
There is a clear difference between Hiding and deleting an entry. Hiding an entry flags it as hidden and prevents it from appearing in the runtime navigator. Deleting an entry removes it entirely.
Note:* Core application entries cannot be deleted and can only be hidden. Custom entries, however, can be either hidden or deleted. If you select Delete* on an entry in the designer, the system deletes the entry if possible; otherwise, it hides it. Hiding a custom entry must be done from the entry properties pane.
Hide a core entry or delete a custom entry
- Open Navigator Designer from the user menu
- Hover on the navigator entry you would like to hide
- Click on the delete command 'trash can icon'. This will mark the navigator entry with a strike through line in Navigator Designer indicating that the item will be hidden or deleted.
- Save
After saving a core item will reside in the designer as hidden while a custom entry is removed.
Hide or show an entry in the property pane (works for both core and custom entries)
- Open Navigator Designer from the user menu
- Click on the navigator entry you want to configure Selecting an entry opens the entry property pane at the bottom of the designer.
- Toggle the hidden flag
- Save
Add a navigator entry¶
A new navigator entry can be a navigation reference to:
- An external URL
- An IFS Cloud Web Assistant, Page or Tree
- A custom Assistant, Page or Tree
- A Lobby page
- An internal path
or a menu entry to create a new navigator folder.
Entries can be added in couple of different ways.
Add a new entry to a parent¶
- Open Navigator Designer from the user menu
- For the parent entry to add an item click the new item command '+' New item command is available both on the parent entry node or between child entry nodes.
- Select the wanted entry type from the dropdown menu
- In the new item dialog that opens, enter required attribute values
- Save and Publish
Duplicate an existing entry¶
- Open Navigator Designer from the user menu
- On the entry to be duplicated, click the duplicate command.
- Select the duplicated entry
- In the entry property pane, change entry details according to your needs.
- Save and Publish
Drag and Drop existing entry¶
Open Navigator Designer from the user menu
While holding down the 'ctrl' key, drag the item to copy and drop at wanted location.
Select the copied entry and change entry details if needed.
Save and Publish
Entry Types¶
| Entry Type | Description |
|---|---|
| Assistant | A navigator entry that links to an IFS Cloud core or custom assistant. Assistant field dropdown menu, enumerates all available assistants for the selected client model. |
| External | A navigator entry that links to an external url Note: external url field has a maximum character limit of 250 characters. |
| Internal | A navigator entry that links to an IFS Cloud core or custom item. Assistant, Lobby, Page and Tree are specific versions of an internal entry. When adding any of the specific versions a lookup is provided to help select correct item. Internal entries are free text describing the relative path to the item. Note: for this item type, there are no lookup available, you need to know how to construct a valid path. The reason to use internal would be when there is a need to provide additional path information that the specific entry versions does not allow for. Example: For a page Internal Path: page/\ Note: The internal path field has a maximum length of 250 characters. When adding an internal entry, you must manually select the client model that matches the target item, because the projection bound to the permission set is derived from the selected client model. This is also important to consider when copying or duplicating an entry as a template. The template will only work as intended if the client model matches your use case, since the client model cannot be changed after the entry is created. |
| Lobby | A navigator entry that links to an IFS Cloud core or custom lobby page The Lobby field dropdown menu, enumerates all existing lobbies regardless of selected client model. The client model for a lobby is typically the same as for the parent folder entry. A lobby page can have child entries |
| Menu | A navigator folder entry The client model for custom folder will not affect any permissions only translation paths. For this reason it is recommended to leave it as the default value. Note: Empty navigator folders are automatically omitted from the runtime navigator. A folder is considered empty if it has no child entries or if the user does not have access rights to any of its child entries. In these cases, the folder is not visible in the runtime navigator. |
| Page | A navigator entry that links to an IFS Cloud core or custom page The Page field dropdown menu, enumerates all existing pages for selected client model. A page entry can act as a lobby page and have child pages. |
| Tree | A navigator entry that links to an IFS Cloud core or custom tree The Tree field dropdown menu, enumerates all existing trees for selected client model A Tree entry can act as a lobby page and child pages. |
Re-locate navigator entries¶
Entries can be repositioned as needed by using drag and drop. When dragging an entry, you can use the CTRL key to choose between moving and copying it. If CTRL is pressed when you drop the entry, a copy is created; otherwise, the entry is moved to the new location.
Note: If you move a core entry to a different parent, the original entry is hidden and a custom copy is created at the new location. This is because core entries cannot actually be deleted or moved.
Navigator Configurations and Contexts¶
Same way as with configurations made in Page Designer, Navigator Configurations can be made either in a Global Context or in additional contexts. See Configuration Context for more information about the Configuration Context concept.
Export and Import of Navigator Configurations¶
In the Navigator Configuration Overview page, all Navigator configurations are listed by Context. From here they can be added to Application Configuration Packages to take the navigator configurations between different environments.
Translate a Configured navigator entry¶
See Translations in Configurations for information on how to add translations to configured items.