A menu item is used for launching the interface that contains the widget you’ve built. Once it is created, it can be displayed almost anywhere in the system as a top-level menu, as a menu item under a drop-down menu, or as a button. Place the menu item for a wizard in the place most useful to the users.
| Step | Result | |
|---|---|---|
| 1 |
|
Navigation to Menus |
| 2 |
A Menu Details screen opens. |
New Menu Items button |
| 3 |
Field Description Application Context Defines the location of the Menu item.The following Application Contexts are supported: | |
| 4 |
|
Adding specific domains for the menu item |
| 5 |
Test the menu item. First refresh your Docupace window (press F5). Then find the place where the menu item is located. Select it. The wizard you created should be launched and should work as expected. If you encounter issues with the wizard, please look through the solutions in the Troubleshooting section of this guide. |
Application Context | Result |
|---|---|
Application – displayed as a menu item (standalone or in a drop-down) in the toolbar at the top of the Docupace window |
. Domain Summary – displayed as a button with an icon and a name at the top of the Work Item Summary panel |
. |
Multi Document Toolbar - displayed as a button with an icon and a name at the top of the Document Summary panel for a Work Item. |
Task - displayed as a button with an icon and a name next to the Task Name at the top left of the Work Item screen. Task Documents - displayed as a button with an icon and a name at the top of the Document Summary panel for a Work Item.
|
|
Users
will see this name as a menu item or on a button. Choose a name that will
make most sense to the user. If the menu opens an interface with a wizard in
it, then choose a name that clearly represents the action performed by the wizard.
Parent Menu Item
If
placing this menu item under a drop-down menu, select the top-level menu item
name from the list.
Order
Sets
the placement of the Menu item if it is part of a drop-down menu. Enter a number
from 1 up, no decimal digits. The Menu item with the smallest Order number will
be displayed at the top of the menu, and so on.
Stylesheet Class
To
change the look of the Menu Item from the system default one, add a button
class from the Bootstrap library (https://getbootstrap.com/docs/3.3/css/#buttons) or from the internal
Docupace classes.
Icon Class
Indicates the image that is used in case the Menu Item will
be displayed as an icon (for example, if Application Context is set as Table
Record). Enter the Icon Class from Bootstrap Glyphicons (https://getbootstrap.com/docs/3.3/components/),
for example:
glyphicon glyphicon-ok-sign
glyphicon glyphicon-plus-sign
glyphicon glyphicon-download-alt
glyphicon glyphicon-check
Description
Users
will not see this description; it is for internal reference only.
Interface
Select
the interface that will be called by this menu item.
System Access Rule
Choose
which users the Menu Item shall be available by choosing from the drop-down
list.
Is Disabled
Current
status of the menu item. If disabled (value Yes), none of the users
will see this menu item.
Visibility Condition
Determines
under which conditions the Menu Item is made visible to the users. If this
field is left empty, the Menu Item will be visible in all cases.
Use
JavaScript code, for example:
$parent.$parent.allTaskData.workitemData.domain
== 401
In
this case the Menu Item will be visible only if this is a Client Activity Work
Item, its domain ID is 401.
Menu Details screen
Menu Details screen | |
Monitor – displayed as a button with an icon and a name in the Monitor page, above the table of found items. Affects all the selected items from the table of results.
|
Examples of how Application Context defines the position of menu items – Task, Domain Summary, Application, Multi Document Toolbar |
Dashboard – displayed as a menu in the top-right toolbar of the Dashboard view. Affects all the selected items from the list.
|
Examples of how Application Context defines the position of menu items - Monitor |
Domain Details – displayed as a menu in the top-right toolbar of the Details screen of any item.
|
Examples of how Application Context defines the position of menu items – |
Examples of how Application Context defines the position of menu items - Monitor
Examples of how Application Context defines the position of menu items – Dashboard
Dashboard | |
Retrieve Domain - displayed as a button with an icon and a name above the table of found items in the Retrieve View for the domain that is listed in Domains panel below. Domain Table Links – in the table of found items in the Retrieve View, makes the values in the respective column into hyperlinks, and opens the corresponding URL, when clicked (not supported for Interface Menu Items, only applicable for URL Menu Items).
|
Examples of how Application Context defines the position of menu items – Domain Details |
Examples of how Application Context defines the position of menu items – Retrieve Domain |
- In the Domains panel, add those domain where you want to see your menu item (button). For example, if the wizard is only relevant for activities with the Client Subfolders, then add this domain to the list.
Adding specific domains for the menu item
- Click Save and Close.
Test the menu item. First refresh your Docupace window (press F5). Then find the place where the menu item is located. Select it. The wizard you created should be launched and should work as expected.
If you encounter issues with the wizard, please look through the solutions in the Troubleshooting section of this guide.