Feature Availability
Overview
Custom Menu in Zoho Connect lets you add customized menus to entities such as status, tasks, events, in addition to the default menus—Follow, Print, Bookmark, and Copy post URL that are already available. They can be shared with a set of users or Groups and can be used to solve specific use cases.
Handlers associated with a custom menu
A custom menu has four handlers with each having a defined purpose. You can use Deluge scripts to write a custom function in these handlers and define how the menu should work. Click
here to learn more about Deluge scripts
Menu click handler: This handler is triggered once the user clicks the custom menu option from the dropdown. You can use this to perform a simple one-step action or open a form to get user inputs.
Form change handler: This handler can be used if the fields in the form box should dynamically change values based on the user input. For eg., options in field B should change based on the user's input in field A.
Field Lookup Handler: This handler can be used to perform a custom lookup and fetch results matching the input entered by the user in the select/multiSelect field.
Form submit handler: This handler is used for form submission. The user inputs are validated and a success/failure message is displayed.
For optimal functioning of a custom menu, the execution time of each handler should not exceed 20 seconds.
By default, only the network admins can create custom menus. However, if allowed by the network admin, selected users in the network will be able to create custom menus.
Custom menu is supported in the following Zoho Connect entities — conversation, announcements, polls, questions, events, tasks, and forums.
- Click the gear icon [] from the menu in the right.
- Select Settings from the dropdown.
- In the Settings page, select Custom Menu under Developer Space.
- In the Configuration details page, enter the menu name that should be displayed in the dropdown.
- Select who should access the menu and the entities in which the menu should be available.
Click Save & edit code.
- Write the custom function in the required handlers.
- Click Publish found in the top-right corner of the page to make it available to the shared users.
If you have not published the custom menu, it will be saved as draft and only you'll be able to access it. To check if the custom menu is working as intended, you can save the menu as draft and try using it.
- Click the gear icon [] from the menu in the right.
- Select Settings from the dropdown.
- In the Settings page, select Custom Menu under Developer Space.
- Select the required menu from the list.
- In the Configuration details pop-out, click the Edit Configuration.
- Now, make changes to the basic details of the menu and the function in its handlers.
- Click Save.
If you need to make changes to a published custom menu without affecting its functioning, you can duplicate the menu, make the required changes, then update the changes to the original one. You will be provided with the option to update the changes to the original menu when to try to publish the duplicated menu.
You can duplicate and create a new custom menu from a published menu.
- Click the gear icon [] from the menu in the right.
- Select Settings from the dropdown.
- In the Settings page, select Custom Menu under Developer Space.
- Select the required menu from the list.
- In the Configuration details pop-out, click the the duplicate icon [] in the top-right corner.
The custom menu will be duplicated. You can now make changes to it, as per your needs.
The duplicate option is not available in the menus that are in draft mode.
- Click the gear icon [] from the menu in the right.
- Select Settings from the dropdown.
- In the Settings page, select Custom Menu under Developer Space.
- Select the required menu from the list.
- In the Configuration details pop-out, toggle the button in the top-right corner to disable it.
- In the Configuration details pop-out, click the trash icon [] in the top-right corner to delete it.
Execution logs
The logs in each custom menu will list the details of every execution made. The details include who executed the menu, time of execution, the results, the parameters passed, and return data. The logs can be used to analyze and debug issues in the menu.
At times, the user might have chosen not to share the menu usage details with the menu developer. In such cases, the menu creator can only see the user name, status and time of execution. And, when there is an execution failure, the menu developer can request the user to provide permission to share usage details to help in debugging the issue.
Even after the user provides permission, the menu developer will not be able to view the details of the past execution. So, they can request the user to perform the same action once again and get the details of the failure logged.
To view logs:
- Click the gear icon [] from the menu in the right.
- Select Settings from the dropdown.
- In the Settings page, select Custom Menu under Developer Space.
- Select the required menu from the list.
- In the Configuration details pop-out, click the Edit Configuration.
- Scroll down to Logs and click Expand next to it.
The logs will be stored for the last 1 year only.
The custom menu will collect certain information from the user profile depending on its function. A user trying to access a custom menu for the first time will see a screen asking them to provide permission to access information. However, the user can revoke the permissions they have given whenever they want to.
To revoke or change the given permissions:
- Click the gear icon [] from the menu in the right.
- Select Settings from the dropdown.
- In the Settings page, select Custom Menu under Developer Space.
- Select the required menu from the list.
- Click the View Granted Permissions in the bottom-right corner of the Configuration details pop-out.
- You can revoke/provide the required permissions from the list.
Execution Limit
Zoho Connect has a limit on the number of handler executions made in a network per day. This limit differs with each subscription plan and can be increased by either upgrading to a higher plan or contacting Zoho Connect's support team. Once you have exhausted the maximum limit, all custom menus in your network will stop working for the rest of the day. And, the menus will resume functioning by 12.00 AM based on your network's data center location.
To view your network's usage details,
- Click the gear icon [] from the menu in the right.
- Select Settings from the dropdown.
- In the Settings page, select Custom Menu under Developer Space.
- You'll see the usage details in the top-right corner of the page.