## Documentation Index

Access the complete documentation index at:
https://www.zoho.com/en-sa/payroll/llms.txt

Use this file to discover all available documentation pages before proceeding.

# Custom Buttons

Custom Buttons are additional buttons you can create in Zoho Payroll to perform specific actions for your records. You can create them using the Deluge Script Editor and execute actions based on the functions you add. Also, you can use custom buttons to open links from records.

**Note:** You can add up to 10 custom buttons and custom links per module.

You can create custom buttons for:

*   Employees
*   Pay Runs
*   Loans
*   Custom Modules

## Create Custom Buttons

To create a custom button:

*   Go to **Settings** in the top right corner of the page.
    
*   Choose the module where you want the custom button.
    
*   Click the **Custom Buttons** tab.
    
*   Click **\+ New** in the top right corner.
    
*   **Button Type**: Choose the type of action you want the button to perform.
    
    *   **Custom Button**: Executes a pre-configured action when the button is clicked.
    *   **Custom Links**: Opens the specified URL when the button is clicked.
*   Next, enter a name for your button.
    
    *   **Location**: Choose where the custom button should appear on the module page. Click **Preview** to see where the button will be available. You can choose from the following locations:
    *   **Details Page**: The custom button appears on the page you see when you open a specific record in a module.
    *   **List Page - Action Menu**: The custom button appears in the Action menu on the page that lists all records in a module.
    *   **List Page - Bulk Action Menu**: The custom button appears in the Bulk Actions menu when you select multiple records on the List page of a module. This option will be available only if you select **Custom Button** as the _Button Type_.
*   **URL**: Enter the URL that should open when the button is clicked. (This field will be available only if you select **Custom Links** as the _Button Type_). You can add placeholders to the URL by clicking **Insert Placeholders** next to the field if necessary.
    
*   Click **Save** if the _Button Type_ is _Custom Link_.
    
*   If you selected _Custom Button_, you need to enter additional details. On the page that follows:
    
*   Enter the Deluge script to define the button’s function.
    
*   Under _When to show this button?_, choose one of the options based on your preference: (This field will be available only if you select **Details Page Menu** as the _Location_).
    
    *   **Show Always**: Select this option to display the button in all records without any criteria.
    *   **Show based on criteria**: Select this option to add criteria to display the custom button for specific records.
*   Under _Who can access this button?_, select who can view and access the button from any of the following options:
    
    *   **Only me**: Select this option if you don’t want other users to access this custom button.
    *   **Only Selected Users**: Select this option and select specific users in your organisation who can view and access the button.
    *   **Everyone**: Select this option to make the button visible for all users in your organisation.
*   Click **Save** to save and execute it later, or **Save and Execute** to save and run it immediately.
    

Now, the custom button will be created, and it will be displayed in the selected module based on the configured preference.

## Execute Custom Buttons

Once you create the custom button, you can use it from the respective module where you’ve configured it to appear. Here’s how:

*   Go to the module where you set up the custom button.
*   Locate the custom button and click it. You can view the others by clicking the dropdown next to the custom button. You can change the order by reordering the custom buttons.
*   Click **Proceed** to continue. A custom button executes its configured action, while a custom link redirects you to its configured URL.

## Edit Custom Buttons

To edit custom buttons:

*   Go to **Settings** in the top right corner of the page.
*   Select the module where the custom button is configured.
*   Click the _Custom Buttons_ tab.
*   Hover over the custom button you want to edit.
*   Click the _Dropdown_ icon and select **Edit**.
*   Make the necessary changes.
*   Click **Save** to save the custom button, or **Save and Execute** to save and run it immediately.

## Reorder Custom Buttons

You can change the order of custom buttons to suit your preferences. Here’s how:

*   Go to **Settings** in the top right corner of the page.
*   Select the module where the custom button is configured.
*   Click the _Custom Buttons_ tab.
*   Select the location where you want to reorder the buttons from the **Location** dropdown. You cannot reorder custom buttons when the _Location_ is _All_.
*   Click **Change Order** in the top right corner.
*   Drag and drop the buttons to arrange them in your preferred order.

**Note:** You can identify custom links using the URL icon next to the button name.

*   Click Save Reorder in the top right corner to apply the changes.

## View Workflow Logs

You can view the workflow logs for custom buttons to view details such as its execution status, reason for failure, and other details. To view the workflow logs for custom buttons:

*   Go to **Settings** in the top right corner of the page.
*   Select the module where the custom button is configured.
*   Click the _Custom Buttons_.
*   Click **View Logs** in the top right corner. You’ll be redirected to the _Workflow Logs_ page. You’ll be able to find details such as the time when the button was executed, the module, the location, and the execution status. You can click on a log to view additional details, such as the return message.

## Delete Custom Buttons

To delete custom buttons:

*   Go to **Settings** in the top right corner of the page.
*   Select the module where the custom button is configured.
*   Click the _Custom Buttons_ tab.
*   Hover over the custom button you want to delete.
*   Click the _Dropdown_ icon and select **Delete**.
*   Click **OK** to confirm the deletion.

The custom button will be deleted.