--- 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, Presentation Components, widgets, tags, UI components] nav: wcp_docs parent_url: /wcp_docs/ title: taskReference layout: subsection wd_wcptag: taskReference --- Contains a reference to the task (page) that users navigate to when they click a `button`, `buttonGroup`, or `dropDownButton`. You can include parameters to send to the page. Use `taskReference` on view and edit pages. Jump to: - [Mobile Support](/wcp_docs/cgt1531499518059.html#section-mobile-support) - [Attributes](/wcp_docs/cgt1531499518059.html#section-attributes) ## Usage ## Navigating to a Page Use `taskReference` within button widgets to specify the page to navigate to. In the `taskReference` attribute, specify the `taskId` of the page. Note: A PMD page corresponds to a task, as defined in the `tasks[]` array in the App Metadata (AMD). The `taskId` in `taskReference` must be a valid task `id` in `tasks[]` in the AMD. Ensure that you specify the task `id`, not the `page` `id`. If you specify an incorrect `taskId` in `taskReference`, you'll get an error with the HTTP status code 404. The `taskReference` attribute in this sample `button` navigates to the sample manageMyDonations task, which corresponds to a sample manageMyDonations.pmd. ``` { "type": "button", "action": "PRIMARY", "label": "My Charitable Donations", "taskReference": { "taskId": "manageMyDonations" } } ``` The task definition in the AMD for the manageMyDonations.pmd, whose task `id` is manageMyDonations: ``` "tasks": [ { "id": "manageMyDonations", "routingPattern": "/myDonations", "page": { "id": "manageMyDonations" } }, . . . ] ``` Note: If the `routingPattern` of the task definition in the AMD contains path parameters, the parameter bindings in `taskReference` must match the path parameters in the `routingPattern`. To reference path parameters, use the `routeParams` predefined app variable. For more details about route parameters, see: - `routingPattern` under tasks in [Reference: Extend App Metadata](/wcp_docs/btj1547749859781.html). - `routeParams` in [Reference: Predefined App Variables](/wcp_docs/urd1528494500512.html). ## Sending Key-Value Parameter Bindings to a Page To send key-value parameters to the next page, specify the `parameterBindings` attribute in `taskReference`. The `taskReference` in this sample `button` specifies `parameterBindings`, which sends the charityId parameter to the next page. ``` { "type": "button", "action": "AUXILIARY", "label": "Update", "taskReference": { "taskId": "updateCharity", "parameterBindings": { "charityId": "<% charity.id %>" } } } ``` The next page can reference the parameter bindings using the `queryParams.` aParameterName. The aParameterName variable is a key in `parameterBindings` of the `taskReference` (from the previous page). Example: The updateCharity page references the queryParams.charityId parameter in the endpoint url: ``` { "name": "charity", "baseUrlType": "app", "url": "<% 'charities/' + queryParams.charityId %>", "authType": "sso" } ``` ## Sending Object Parameters to a Page While the `parameterBindings` attribute of `taskReference` sends key-value parameter bindings to the next page, the `parameters` attribute enables you to send a map object binding to the next page. In this next example, the `taskReference` sends both a simple parameter startDate and a map object parameter expenseEntry.expenseEntryStatus. ``` { "type": "button", "id": "expenseDetailsButton", "label": "Expense Details", "action": "AUXILIARY", "taskReference": { "taskId": "expenseDetails", "parameterBindings": { "startDate": "2021-03-15" }, "parameters": "<% expenseEntry.expenseEntryStatus %>" } } ``` The sample expenseEntry.expenseEntryStatus map object contains these fields: ``` { "descriptor": "New", "id": "dc74b9a0446c11de98360015c5e6daf6" } ``` Note: We combine entries from both `parameters` and `parameterBindings`. If there is a duplicate entry, then the entry in `parameterBindings` takes precedence. To reference the fields in the map object in the next page, use `queryParams.` aParameterName. The aParameterName variable is a field in the map object in `parameters` of the `taskReference` (from the previous page). Example: These text widgets from the sample expenseDetails page reference the parameter bindings from the sample button. Note that queryParams.descriptor references the descriptor field in the expenseEntry.expenseEntryStatus map object. ``` { "type": "text", "label": "Start date", "value": "<% queryParams.startDate %>" }, { "type": "text", "label": "Expense status", "value": "<% queryParams.descriptor %>" } ``` ## Mobile Support Android, iOS ## Attributes - parameterBindings Data type: Map> A map containing task parameters sent to the specified `taskId` (page). You can use `parameterBindings` to specify a set of key-value parameters: - parameterKey - A static string that identifies the parameter value in the destination page. The destination page can reference the parameter using queryParams.parameterKey. Don't use the reserved keyword "type" as a parameterKey. - parameterValue - A binding string that contains the parameter value. This sample sends 2 parameters: a static date and the `expenseEntryStatus.descriptor` field from the expenseEntry endpoint. ``` "taskReference": { "taskId": "expenseDetailsOnStartDate", "parameterBindings": { "startDate": "2021-03-15", "expenseStatus": "<% expenseEntry.expenseEntryStatus.descriptor %>" } } ``` The sample expenseEntry.expenseEntryStatus object contains this sample JSON: ``` { "descriptor": "New", "id": "dc74b9a0446c11de98360015c5e6daf6" } ``` The sample expenseDetailsOnStartDate page can reference the parameters as queryParams.startDate and queryParams.expenseStatus. Note that the `id` field isn't available because the sample `parameterBindings` doesn't include the `id` parameter. Note: We combine entries from both `parameters` and `parameterBindings`. If there is a duplicate entry, then the entry in `parameterBindings` takes precedence. - parameters Data type: binding-Map A binding to a map object containing parameters sent to the specified `taskId` (page). You can use `parameters` to specify a map object containing the parameters. Example: ``` "taskReference": { "taskId": "expenseDetails", "parameters": "<% expenseEntry.expenseEntryStatus %>" }, ``` The sample expenseEntry.expenseEntryStatus object contains this sample JSON: ``` { "descriptor": "New", "id": "dc74b9a0446c11de98360015c5e6daf6" } ``` The sample expenseDetails destination page can reference the parameters as queryParams.descriptor and queryParams.id. Note: We combine entries from both `parameters` and `parameterBindings`. If there is a duplicate entry, then the entry in `parameterBindings` takes precedence. - taskId Data type: binding-String (Required) The id of the task (page) to navigate to. Define the task ID in the `tasks` section of the AMD. Each task ID corresponds to a PMD page.