---
category: [Administration & Integrations, Platform and Product Extensions, Platform and Product Extensions/Integration, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions/Workday Extend]
keyword: Extend
nav: wcp_docs
parent_url: /wcp_docs/
title: Create Custom Tasks
layout: subsection
---

### Prerequisites

<a id="prereq_N10021_N1001E_N10001"></a>
Set up your custom app that you want to access from Workday.

Security: <i>Custom Task</i> domain in the System functional area.

### Context

<a id="context_N1002C_N1001E_N10001"></a>
You can use custom tasks to enable users to access your Workday Extend app in Workday. You can build, deploy, and share apps that run on Workday and meet the specific business needs of your enterprise.

### Steps

1.  <a id="d177e78"></a>Access the <b>Create Custom Task</b> task.
2.  <a id="d177e87"></a>As you complete the section, consider:

<table><thead><tr><th>    Option</th><th>    Description</th></tr></thead><tbody><tr><td><b>Title</b></td><td>The task title that displays in Workday. This value is available in the <code>{taskTitle}</code> parameter.</td></tr><tr><td><b>Reference ID</b></td><td>When you don't enter a Reference ID, Workday creates one based on the task title and a unique identifier.</td></tr><tr><td><b>Application ID</b></td><td>Use the <code>applicationId</code> property in the App Metadata (AMD) file for your app.</td></tr><tr><td><b>Site ID</b></td><td>Use the <code>siteId</code> property in the Site Metadata (SMD) file for your app.</td></tr><tr><td><b>Route Path</b></td><td>The route to the landing page in the custom app. <p>The <b>Route Path</b> can contain a combination of path and query parameters. Examples:</p><ul><li>    Path parameters: <code>/myCustomTask/pathParam1/pathParam2</code>
</li><li>    Query parameters: <code>/myCustomTask?queryParam1=value1&queryParam2=value2</code>
</li><li>    Path and query parameters: <code>/myCustomTask/pathParam1?queryParam1=value1</code>
</li></ul> <p>The <b>Route Path</b> must correspond to the <code>routingPattern</code> of the task definition in the <code>tasks[]</code> array in the AMD. Ensure that the root in the <b>Route Path</b> matches the root in the <code>routingPattern</code>.</p> <p>You can use these keywords in the <b>Route Path</b>:</p><ul><li>    <code>{customTaskObjectId}</code> - The ID of the current context instance. Example: If you enable the custom task as a related action on a worker, <code>{customTaskObjectId}</code> contains the Workday ID of the current worker.
</li><li>    <code>{taskTitle}</code> - The custom task title.
</li></ul> <p>If the <b>Route Path</b> has path parameters, append the positional path parameters in the <code>routingPattern</code>. Surround path parameters with curly braces, <code>{ }</code>.</p> <p>Example: The <b>Route Path</b> is <code>/myCustomTask/{customTaskObjectId}/{taskTitle}</code>. The corresponding <code>routingPattern</code> is <code>/myCustomTask/{workerID}/{title}</code>. To reference the path parameters in the landing page, use <code>routeParams.workerID</code> and <code>routeParams.title</code>. Use <code>routeParams</code> to persist the parameters after a page flow navigation.</p> <p>If the route to the default or home page contains no path parameters, specify <code>/</code> as the <b>Route Path</b>. Ensure that the <code>routingPattern</code> in the AMD also specifies <code>/</code>.</p> <p>If the <b>Route Path</b> has query parameters, don't include them in the <code>routingPattern</code>. You can reference query parameters in the landing page using <code>queryParams</code>.</p></td></tr></tbody></table><br/>

3.  <a id="d177e284"></a>As you complete the <b>Business Object</b> section, consider how to secure your selection:

<table><thead><tr><th>    Option</th><th>    Description</th></tr></thead><tbody><tr><td><b>Secured selection</b></td><td>Workday prompts the user for an instance of the selected business object when they run the custom task. Workday evaluates the contextual security of the custom task against the processing user at run time to determine the instances that are available when the user runs the task. Example: Select the Worker business object and secure the custom task to the <i>Employee as Self</i> security group. The app user can only run the custom task as a related action from their own worker profile.</td></tr><tr><td><b>Unsecured selection</b></td><td>Workday prompts the user for an instance of the selected business object when they run the custom task. Because Workday doesn't evaluate the contextual security of the custom task, all instances are available when the user runs the task. Example: You select the Worker business object and secure the custom task to the <i>Employee as Self</i> security group. The app user can run the custom task as a related action from any worker profile.</td></tr><tr><td><b>No selection</b></td><td>Workday doesn't prompt the user for an instance of the selected business object when they run the custom task. The task isn't available as a related action. <p><b>Note:</b> You must select either <b>Secured selection</b> or <b>Unsecured selection</b> to ensure that the business object context is set consistently when you access the custom task from a profile group.</p></td></tr></tbody></table><br/>

4.  <a id="d177e338"></a>In the <b>Usages</b> section, select or create a custom dashboard if you want to enable the custom task as a worklet.

    When you configure the worklet, you must add the custom task as a custom report.

    <b>Note:</b> Custom dashboards don't provide a scroll bar. When you use a custom task to access an Extend app from a custom dashboard, the bottom of the app page might be cut off if the page size is too large to fit into the worklet.

    You can't select a custom dashboard if the custom task is used as an initiating action for a custom business process.

    <b>Note:</b> Custom dashboards are read-only. An edit page of a custom app renders as a view page on a custom dashboard.

5.  <a id="d177e362"></a>In the <b>Security</b> section, select the security domains for the custom task.

    When you select the <b>Testing Mode Only</b> check box, only permitted testers who meet the domain or event security permissions can view and run the custom task.

    You can't select a domain if the custom task is used as an initiating action for a custom business process.



### Result

<a id="result_n4m_3bn_h4b"></a>
The user can run the custom task as a related action on the available instances of the business object except when you choose <i>No selection</i> to secure the business object. Workday makes the ID of the selected instance available in the `customTaskObjectId` parameter.

You can also select the category in which Workday displays the custom task from the related actions menu on the <b>Related Actions Category Override</b> prompt. When you don't select a category override, Workday uses the name of the business object as the category in which to display the custom task. Example: If an instance of the Employee business object is Logan McNeil, you can select the title of your custom task as a related action from Logan McNeil in the Employee category.

### Example

You can configure these values to work with an existing custom app:

<table><tbody><tr><td><b>Title</b></td><td>The title of your custom task.</td></tr><tr><td><b>Application ID</b></td><td>Use the <code>applicationId</code> property in the App Metadata (AMD) file for your app.</td></tr><tr><td><b>Site ID</b></td><td>Use the <code>siteId</code> property in the Site Metadata (SMD) file for your app.</td></tr><tr><td><b>Route Path</b></td><td><code>/MyCustomTask?objectId={customTaskObjectId}&title={taskTitle}</code> <p>You can also use the <code>routingPattern</code> in the <code>tasks[]</code> array in the AMD file for your app. Append the required parameters.</p></td></tr><tr><td><b>Business Object</b></td><td>Employee</td></tr></tbody></table><br/>

Workday resolves the Application ID and Site ID parameters according to this pattern:

```
/<tenantname>/d/wday/app/<applicationId>/<siteId>/<routepath>
```

### Next Steps

<a id="postreq_pgf_5z5_bhb"></a>
You can configure different ways to access the custom task in Workday, such as the profile group, related actions menu, and others. You can also search for a custom task directly from the search bar.

If you have permissions to view and edit a custom task, and meet the security permissions applied to the task, you can also run the task as a related action from the task itself. Select <b>Custom Task</b> &gt; <b>Run</b> to run the task.

<b>Note:</b> To delete a custom task, access the <b>View Custom Task</b> task and select the custom task you want to delete. As a related action, select <b>Custom Task</b> &gt; <b>Delete</b>.

You can't delete a custom task that is applied to or utilized by an active custom business process, a menu on a dashboard, a profile group, or a worklet.

### Related Information

[Concept: Custom Tasks and Apps in Workday](/wcp_docs/ovp1598058719650.html)

[Concept: Page Navigation](/wcp_docs/qoc1553369215127.html)

[Tutorial: Create a Custom Task](https://wd5.myworkday.com/workday/learning/course/31254226c44c01a9f34486fd5e2cd290?type=9882927d138b100019b928e75843018d)

[Administrator Guide: Steps: Set Up Custom Dashboards](https://doc.workday.com/access/sources/dita/topic?wd:docset=adminguide&ft:locale=en-US&resourceid=vnn1487272847075)

[Administrator Guide: Steps: Set Up Workday Mobile Applications](https://doc.workday.com/access/sources/dita/topic?wd:docset=adminguide&ft:locale=en-US&resourceid=dan1370797996359&dita:mapPath=dan1370797899707.ditamap)