--- title: Menu Buttons slug: menu-buttons createdAt: 2025-06-11T20:26:17.824Z --- Menu Buttons are used extensively on the home page and toolbars to allow users to perform tasks. The RibbonButton below is an example of the Menu Button. This section describes the options available for setting up these links. ## Action Properties The following are the basic properties on a menu that are required to specify an action. ### Links Each button has a 'Link' object this object is the target for the button. If no other options are set then the button will show the Properties Form for the object or the Browse page if the object has children. Examples for Links | | | | ------------------------------- | -------------------------------------------------------------------------------- | | **Link** | **Description** | | =//CurrentUser | The properties for the current user would be shown | | =//Resources/Distribution Lists | The browse objects page will be shown for the user to browse distribution lists. | Unless specifed by the 'AccessRights' property (specified below) then the user must have at least the following rights to access to the object. If they do not have access then the button will be automatically hidden. | | | | | --------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Link Type** | **Default Rights ** | **Description / Notes** | | Service | USE;ADD | "USE;ADD" means that the ACE entry must grant USE and ADD rights. Note: These cannot be split across multiple ACE entries. For example, granting 'Users'\:USE and 'Self\:ADD' would not grant access and show the button. Adding 'Self\:USE+ADD' would grant access. | | Task | EXECUTE | The user must have execute rights and the task must be licensed. | | ServiceInstance | VIEW | The user must have view rights on the service instance. | | Add Other | READ | The user must have READ access to the object. |   ### Task Each button can also have a 'Task' specified. If set then the specified task will be run for the 'Link' object instead. For example, Link=//CurrentUser and Task=//Tasks/Users/Disable User then the task 'Disable User' would be run the current user. The button will be automatically hidden if the user does not have 'EXECUTE' rights on the task. When executing the task the link object will be saved into the task arguments using the following default binding paths. | | | | ----------------------------- | ---------------------------- | | **Object** | **Default Bind Path** | | UserDirectoryEntry | user | | ComputerDirectoryEntry | computer | | ContactDirectoryEntry | contact | | GroupDirectoryEntry | group | | Role | roles/role | | Asset | asset | | AssetInstance | assets/instance | | Article | article | | Distribution List | distributionLists/dl | | Service Instance | services/instance | | Service | service | | Security Group | securityGroups/securityGroup | | Folder | folder | | Folder ACE | folders/ace | | Sharepoint object | sharePointItem | | Sharepoint ACE | sharePointItems/ace | | Job | job | | Team | teams/team | | Connector | connector | | Shared Mailbox | mailboxes/mailbox | | Shared Mailbox Permission | mailboxes/access/ace | | Cloud Folder | cloudFolder | | Cloud Folder Permission (Ace) | cloudFolders/ace | | Service Desk Ticket | ticket | | Task | selectedTask | | Generic resource | resource |   ### Other Behaviour Properties The following properties can also be used to control how the button behaves. | | | | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Property** | **Description** | | AccessRights | The current user must have the specified rights on the LINK object. If the user does not have rights then the button is hidden. | | Enabled | Specifies if the button is to be shown but disabled. | | ExtendedRights | Extended rights are also checked. If the user does not have the specified rights then the button will be hidden. Please see below for definitions of extended rights. | | Target | Specifies the target window to open when the button is clicked. Normal options are '' (Blank) or 'Dialog' to display the link in a dialog.  | | User | By default the current user is normally set as in the target job as 'user', however, you can override the current user. For example, you could specified "=//CurrentUser/Manager" to act upon the users manager by default. | ## Display Properties The following are the common display properties that are used for menu buttons. | | | | ------------ | ------------------------------------------------------------------------------------------------------------------------- | | **Property** | **Description** | | Text | The text to display for the button | | ImageURL | The image to display for the button. | | ToolTip | The tooltip hover to display when the user hovers over the button. | | Visible | Specifies if the button is visible by default or not. Note: Access rights on the Link and Task objects can override this. | ###  Extended Rights The following extended rights are available. The extended rights that are available depend upon the Link object.   | | | | | ---------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Extended Right | Applies To | Description | | SupportsUpdate | Service, ServiceInstance | Does the associated service have the 'SupportsUpdate' flag on | | Existing | All | Is the associated object an existing object (ie the ID >0) | | OrderSelf | Service | Is CanOrderSelf true on the associated service. Is property is true if the current user can order the service. | | SelfOnly | Link = User or User is set | The current user matches the selected user (or is the =//Job/user) in the current job | | CanOrder | Service | Is CanOrder true on the associated service. This property is true if the user can order the service for themselves or any other user. | | SelectUser | Task | Can the user select any user apart from themselves. | | BrowseItems | N/A | Is the current page BrowseObjects | | BrowseTree | N/A | Is the current page Browsing objects by tree. | | Secured | Folders, Sharepoint, CloudFolder | Is the current object secured. | | IsLeaf | All | Is the current object a leaf node. | | HasSubItems | All | If the subitems count >0 | | ManageMembers | Role, DL, Security Group, Team | | | ManageInstances | Service | Can the user manage instances of this service | | GroupOnly | DL, SecurityGroup | Only true if the associated object has an AD group. | | Published | All | Only should the button if the associated object is published. | | NoExisting | Task must be set | Is there an existing pending Task for this user. Used to hide a new request button if there is an existing request. | | NewTask | Link must be a Task | The current Job.Task must be different from the Task in the Link | | Access:\[RIGHTS] | All | Does the Link object or Any it's children have the specified right. This allows checking on rights not just on the parent but on the children as well. This is useful if the user does not have the specified rights on the parent but only on one of the child nodes. | Role: - Only true for static roles DL - User must have ADDUSER rights Security Group: User must have ADDUSER rights Team: User must have ADDUSER rights Can the current user manage the members of the object. Multiple rights can be combined to more complicated rights. '|' = or '&', ',',';' = and '!' = not Examples | | | | ----------------- | ------------------------------------------------------------------ | | Example | Description | | !Published | Will display the button if the link object is not published. | | Published\&IsLeaf | Will only display if the link object is published and a leaf node. |