Configure navigation settings

  1. On the Home page, click Form Designer > Navigation.
  2. Consume the required category for the navigation menu in the Category box. (Default: Working category)
  3. In the Navigation box, enter a name for the navigation. For example, Database.
  4. Specify the size of navigation menus to display at runtime. (Default width: 150, default height: 30)
  5. To add a menu item to navigation, select navigation and click Add for Menu Items.
  6. Select either option for Type:
    1. Menu Item: Creates a submenu.
    2. Separator: Adds a line to group related menu items.
  7. Enter a name for the menu item in the Menu Item Name box.
  8. Enter the Shortcut keys to press to select the menu item, such as C for Copy.
  9. Select either option for Load Image from Store:
    1. No: Enter an image name or URL in the Image box.(Default: No)

      Note For on-premise TotalAgility, the image needs to reside in <Installation location>\Kofax\TotalAgility\Agility.Server.Web\Forms\Images.

    2. Yes: Consume an existing image or enter the image name (for example, Add.png) in the Image box.

    Note The name must match the name in the database for the image to display at runtime.

  10. You can also use an image along with name for a menu item or submenu item. Do the following in the Image box, depending on the environment:
    • For TotalAgility on-premise: Enter the name of the image. Ensure that this image is already available in the \Agility.Server.Web\Forms\Images folder.

    • For TotalAgility in Azure: Use a predefined image provided by TotalAgility (See Custom images provided by TotalAgility ), enter the image name or the URL to the image.

    At runtime, the image appears to the left of the menu item name.

  11. In the Redirect group, specify where to redirect the menu item.
    • To redirect a menu item to a internal form, select Form for Type, consume the required form in the Target box and then map the initialization parameters to configure which data to pass into the target form by consuming the global variables or providing static values in the Value boxes.
      Note Global variables are used to store and transport data from one form to another.
    • To redirect a menu item to an external form, select URL for Type, in the Target box and enter the URL of the external form, such as www.kofax.com.

      Alternatively, to redirect a menu item to a custom page, enter the page name in the Target box.

      Note TotalAgility only supports custom files of HTML and java script types.

    • To redirect a menu item to the Insight Studio, select Insight for Type and in the Target box, consume the specific Insight view/chart.
      Note The Insight option appears, if only Insight is installed in TotalAgility. This option is not available in an Azure environment.
  12. Select a Window type where the redirected form should appear.
    • Same Window: Redirects the form to the same window. Choose to load the entire page or content only.
      • Entire Page: Displays the form in the entire page.
      • Content Only: Displays only the content of the form and not the header and the navigation panel. To refresh the content each time a change is made, click Yes for Refresh Content.
    • Pop-Up Window: Displays the form as a pop-up. Specify the width and height of the pop-up window (default: 800x500) and then select the pop-up window to modal or modeless (default: Modal).
      • Modal: Prevents the user from clicking on the main form unless they have closed the pop-up window.
      • Modeless: Allows the user to click outside the pop-up window to close the pop-up window and return to the main form.
        • Control to Return Data and Close: Allows the user to select a control from the list to populate data and close the pop-up to return to the main form.
          Note Populating data is supported only from a single pop-up.
    • New Window: Displays the form in a new window.
  13. Configure Access Permissions to allow or deny access to a menu item.
    1. For Access, select the preferred option to allow or deny access to everyone except those listed.
      Note Set the access based on user's role, department, and security permissions. For example, in an in-house leave tracking system, only managers can access menu options to run reports on absences due to sick leave and planned leaves. Other users cannot access these options.
    2. Consume the required resources and/or groups in the Resources box.
  14. Add more menus and submenus as needed.
  15. Use the Up and Down buttons to reorder the menu and submenu items.
    Note To remove an existing menu, select the menu and click Delete generic delete.
  16. Set the form properties, Horizontal Navigation and Vertical Navigation, to display the new menu at runtime. See Configure the properties of a form.