Menu Administration
The Vizion Platform allows extensive flexibility in configuring menus for navigating the system. Administrators can create customized menus that allow organizing and linking directly to virtually any element within the application, in any configuration you desire, including user-generated pages, internal system pages, and custom URLs. Administrators can also specify links to specific Views, Filters, Tabs, Applets, and more. This allows the Administrator to develop system menus crafted to meet precise business cases and end-user scenarios.
Menus in the Vizion Platform are organized within their Menu Application. Visibility and access to the Menu Applications are controlled with security permissions, allowing the creation of a tightly controlled and tailored user experience.
See Introducing Menu Applications for introductory information on menus.
A fresh instance of the Vizion Platform comes pre-installed with a default set of System Menu Applications.
The Favorites Menu contains the links the user has saved as a Favorite for quick access to frequently used pages. For more information, see Managing Your Favorites List.
The Info Center contains all the pages and tools within the Vizion Platform that allow the user to ingest, manipulate, and display data in different ways.
The Dev Center contains all the pages and tools within the Vizion Platform that allows the user to build applications.
The Admin Center contains all the pages and tools within the Vizion Platform related to application configuration, user management, and security.
The Help Menu contains links to helpful information about the system including Help, About, Hot Keys, User Manual, API Documentation, DB Documentation, BPD Help and BPD Editor. These links are in various stages of use.
Adding Menu Applications
Beyond the standard System Menu Applications, the Administrator builds the additional Menu Applications needed to provide a place for the system’s Menu Items. Menu Items are the actual links to the pages in the Vizion Platform system.
Steps to Add a Menu Application | ||
|---|---|---|
1 | Navigate to Dev Center > Build Applications > Menu. |
|
2 | Click the Menu Application name at the top of the page. In our example, it is App Center. A list of your custom Menu Applications displays. Click Add Menu Application. | |
3 | Complete the General Tab. See Menu Application - General Tab.
|
|
4 | Click the Role Assignments tab to give permissions to Security Roles. See Menu Application - Role Assignments Tab.
|
|
5 | Click OK. Your Menu Application will now be visible as a Menu Application shortcut and in the Main menu. To add Menu Subgroups and Menu Items, see Adding Menu Subgroups and Menu Items. |
|
Menu Application - General Tab
Field Name | Field Description |
|---|---|
Applications Name | A unique system name for the Menu Application that will not be seen by the end user. |
Label | A user-friendly name for the Menu Application which will display in the Vizion Platform Menu. |
Description | A short description of the use of the menu or any other data you need for administrative purposes. |
Order Number | This value is used to set the initial ordering of the Menu Application within the main menu. For example, if you set the value to 1, this item will show up as the top menu item in the main menu upon refreshing the browser. |
Subgroup for DropGrid Imports | This option is used to designate the Menu Application as a Menu Subgroup used for the DropGrid import tool. This will be the location for DropGrid data imports. |
Icon | This setting allows you to assign an Icon to your Menu Application. Click the ellipsis to display a list of icons you can choose from or create a new one. The Menu Application icon is displayed as a shortcut icon in the Navigation Bar. Note that once an Icon has been set, you cannot remove it and can only trade it with another icon. |
Menu Application - Role Assignments Tab
Here you see a list of the security roles configured for your organization.
To assign permissions to a Menu Application:
On the Role Assignments tab, check the boxes for the roles that you want to have access to this Menu Application and click OK.
Roles that are not checked will not see the Menu Application as a shortcut icon or in the extended menu.
Adding Menu Subgroups and Menu Items
The Menu page (Dev Center > Build Applications > Menu) gives you the ability to list details for all of the custom Menu Applications you have privileges for. In a tree format, you will see Menu Subgroups and Menu Items for each Menu Application. Remember that Menu Items are the actual links to the pages in the Vizion Platform system and Menu Subgroups are an additional level of organization.
The menu hierarchy is Menu Application > Menu Subgroup > Menu Item.
Privileges to a Menu Application gives users access to the Menu Subgroups and Items. See Menu Application - Role Assignments Tab.
When you add a Menu Subgroup or Menu Item, you first need to determine where in the Menu you want it to go.
General guidelines about adding Menu Items to a Menu Subgroup:
The number of menu categories is not limited but should not exceed ten; adding more than ten risks having one or more menu item not displayed.
The number of hierarchical levels supported is limited only by the user's minimum screen resolution. To be safe, levels should not exceed five, or may risk users not being able to see a menu item.
Menu items may only be used once in a menu group.
Steps to Add Menu Subgroups and Menu Items | ||
|---|---|---|
1 | Navigate to Dev Center > Build Applications > Menu. | |
2 | Click the Menu Application at the top of the page to give you the list of Menu Applications to choose from. Select the Menu Application for your new Menu Subgroup or Item. |
|
3 | Select a location within the Menu hierarchy that you wish to be the parent location of the new Menu Subgroup or Item. In our example, we have selected the Information Menu Subgroup.
(Another way to get to this hierarchy is from the expanded menu. See Viewing the Application Menu.) | |
4 | Click Add. |
|
5 | Choose whether this new item will be a new Menu Item or a Menu Subgroup. A Menu Subgroup is just a Menu. It creates a new header in the Menu hierarchy. Menu Items display under Menu Subgroups. |
|
6 | For Menu Subgroups, complete the following fields (For Menu Items, skip to step 7): Label Text - Type the text to display in the Menu Application. Visible - Allows you to display or hide the Menu Subgroup. Useful for hiding items when designing new Menus. DropGrid - Creates a location for imports from DropGrid. | |
7 | For Menu Items: Select the Item Type: User Pages - Allows you to link to any of the user created Vizion Platform elements such as Trackor Browsers, E-File Browser, Tasks, and WorkFlow Queues. User pages require you to specify the Primary Trackor Type, then you can specify a View and Filter you wish to be the default items seen by the user upon loading page. Internal Pages - Internal Pages allow you to specify a View and Filter you wish to be the default items seen by the user upon loading the page. The Administrator can also opt to Hide View and/or Filter controls, which limit the user to the selected View and Filter defined in the Menu configuration. Web URL - URL Types allow you to provide a label for the Menu Item and specify a web address the link takes you to. Miscellaneous > Teaser Type - The Teaser allows you to specify a label for the Menu Item and provide a message presented to the user when they click the link. Miscellaneous > External Widget - See Section Below for Adding External Widget as a Menu Item.
Depending on the Item Type selected, you will have some of the following fields to complete: Label Text - Type the label that will display for the Menu Item. URL - If enterable, enter the URL for the Menu Item. Primary Trackor Type - Select the Trackor Type for the Menu Item. When the Trackor Browser type is selected, you can also use the Hide Parents/Children Selector to limit the users' ability to navigate between different Trackors. View - Select the View to display upon loading the page. You can also opt to Hide View controls which limits the user to the selected View defined for the Menu Item. Filter - Select the Filter to display upon loading the page. You can also opt to Hide Filter controls which limits the user to the selected Filter defined for the Menu Item. Visible - Allows you to display or hide the Menu Item. Useful for hiding items when designing new Menus. On Click Message Text -enter the message for the user to see when they click the Menu Item. |
|
6 | Click OK. |
|
Adding External Widget as a Menu Item
External Widgets are a OneVizion® Product. Separate licensing is required for all customers, and implementation requires a Statement of Work to assure platform performance is properly managed. Use of this feature is subject to audit at all times. Please contact Sales at OneVizion for pricing and licensing details as well as permissions for any proof of concept projects.
Steps to add an External Widget Menu Item
Step | Instruction | Screenshot Help/Example |
|---|---|---|
1 | Access the Add Menu Item Form and select Menu Item. |
|
2 | Complete the following fields: |
You can set parameter placeholders in the External Widget Code. These placeholders will be dynamically replaced with values returned by SQL queries. The placeholder format is {$paramName}. By default, parameters have no SQL query and will be resolved as empty. When SQL query is present, the system uses the first column value and places it in the Widget Code. Example: Below is a screenshot of the Edit Form for an External Widget. Two parameter placeholders were added. After clicking Save/Apply, you can click the Params button to edit the parameters.
|
4 | Assign an Icon if desired. |
|
5 | Check Visible. |
|
6 | Click OK. The new item will appear in the Main Menu, and when you click it, the widget will load in the main window. |
|
Viewing the Application Menu
You can display the menu hierarchy for a particular Menu Application by finding the menu name in the expanded menu and clicking the Edit for that menu.
Removing a Menu Item Assignment
Administrators may remove a menu item from the menu group hierarchy by highlighting the menu item and clicking Delete. Removing a menu item only removes it from the menu group hierarchy; it does not delete the menu item from the database.
Reordering a Menu Item
From the menu group hierarchy, users may reorder a menu item in the menu group hierarchy by highlighting it in the menu group hierarchy and clicking the Up or Down button. (You may need to click ellipsis first.)
Reordering a menu item will not change its horizontal position in the hierarchy (i.e., it will not change its sub-group menu item); it will only change its vertical position in the hierarchy. Users may reorder a sub-group menu item using this method as well. This will include all of the menu items in the sub-group, so each of the menu items under the task management sub-group menu item will move with it.
To apply changes to the current menu, refresh the page.
Updating the Main Menu Icons
The Vizion Platform allows you to set a custom logo for the expanded menu display and a custom icon for the collapsed Menu of Menu Applications, the Main Menu Icon. These menu properties are configured within the Tenant Parameters page.
The Company Logo in the Expanded Menu
Steps to Update the Company Logo in the Expanded Menu | ||
|---|---|---|
1 | Navigate to Admin Center > System Administration > System > Tenant Parameters | |
2 | Use the Search field to search Tenant Parameters for Clientlogo. |
|
3 | Click Edit. |
|
4 | Click the ellipsis button beside the Value field to display a list of all prior logos and icons uploaded by the company to date. Click the Add button to upload a new image of your choice OR select a pre-existing one. The logo file must be .png, .jpeg, .gif, or .svg format. |
|
5 | Click OK. |
|
6 | Click OK. |
|
The Main Menu Icon
Steps to Update the Main Menu Icon | ||
|---|---|---|
1 | Access the Tenant Parameters page. |
|
2 | Use the Search field to search Tenant Parameters for Menuicon. | |
3 | Click Edit. |
|
4 | Click the ellipsis button beside the Value field to display a list of all prior logos and icons uploaded by the company to date. Click the Add button to upload a new image of your choice OR select a pre-existing one. The logo file must be .png, .jpeg, .gif, or .svg format.
|
|
5 | Click OK. |
|
6 | Click OK. |
|
Administration of MenusA user’s security role must be included in the Menu Application’s Role Assignments tab for a user to have access to the Menu Application and its subgroups and items. Administrators will need the ADMIN_MENU Security Group to be able to Administer the Menus for users. Users need the specific Security Group to access the Default System Menu Applications: SHOW_MENU_ADMIN_CENTER, SHOW_MENU_DEV_CENTER, SHOW_MENU_INFO_CENTER |
|---|
