--- 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: externalLink layout: subsection wd_wcptag: externalLink --- Displays a text link that navigates to a specified URL. Use `externalLink` on view and edit pages. ## Example This sample `externalLink` navigates to an external URL. ``` { "type": "externalLink", "label": "About Workday", "descriptor": "Go to the Workday web site", "url": "https://www.workday.com/" } ``` This sample `externalLink` navigates to the Workday home page using a relative URL and the `tenant` predefined app variable. ``` { "type": "externalLink", "label": "Workday Home", "descriptor": "Go to your tenant's Workday home page", "url": "<% '/' + tenant + '/d/home.htmld' %>" } ``` In this similar sample, you can use `externalLink` to display a Workday report. You can save the relative path of the custom report in an app variable, and reference it using `attrstore`. ``` { "type": "externalLink", "label": "Detailed Report", "descriptor": "Open the report and export to Excel", "url": "<% '/' + tenant + attrstore.customReportPath%>" } ``` ## Mobile Support Android, iOS ## Attributes - descriptor Data type: binding-String The display text of an external link. - id Data type: binding-String Unique identifier used to reference this widget from other tags. Notes: - The `id` must start with a letter. - The `id` must be unique per page. - To enable other widgets to reference this widget `id`, place this widget before the other widgets on the PMD. The PMD validation returns an "Undefined variable" error if it doesn't find a previously defined `id` in the PMD. - Workday recommends that you include the `id` in your tag definitions for debugging purposes. - label Data type: dynamicBinding-String Text that displays beside or above most widgets. Often used in simple widgets that include inputs. The maximum number of characters is 255. - render Data type: binding-Boolean If true, this tag renders as a widget on the page. If false, the loaded page doesn't add this tag or its children. The default is true. Unlike the `visible` attribute, when `render` is false, other tags on the page can't reference this tag or widget on edit pages. On view pages, a tag can't reference other tags regardless of the `render` attribute value. - sortOrder Data type: binding-String When you set `sorted` to true on the `section` or `fieldSet` parent of this widget, the `sortOrder` attribute determines the order of this widget within its parent. The sort order is relative to the siblings of the widget. Typical values are "a", "b", "c", and so on. Example: The widget with `"sortOrder": "a"` displays before the widget with `"sortOrder": "b"`. Note: The `sortOrder` doesn't apply to sorting data on the widget. `sortOrder` only applies to the placement order of the widgets within the parent widget. - url Data type: dynamicBinding-String The destination URL for the external link. - visible Data type: booleanScript If true, the widget generated by this tag is visible. If false, this tag and its children tags aren't visible. This tag provides the ability to display or hide the widget dynamically based on user interactions on the page. The default is true. Unlike the `render` attribute, the generated widget persists on the page even when `visible` is false. Notes: - When the widget or field you’re hiding changes on the page, you must include it inside a `fieldSet`. - When the `visible` attribute is false for this widget on an edit page, the outbound endpoint doesn't include the `valueOutBinding` data of the widget in the outbound payload. To include the `valueOutBinding` data in the payload, use the `onSend` event handler. ## PMD Scripting Methods - getDescriptor() Return type: `string` Description: Returns the text of the `externalLink`. - getLabel() Return type: `string` Description: Returns the widget label. - getUrl() Return type: `string` Description: Returns the url of the `externalLink`. - isVisible() Return type: `boolean` Description: Returns true if this widget is visible. - setDescriptor(String descriptor) Return type: `void` Description: Sets the text of the `externalLink`. - setLabel(String label) Return type: `void` Description: Sets the widget label. - setUrl(String label) Return type: `void` Description: Sets the url of the `externalLink`. - setVisible(boolean visible) Return type: `void` Description: Displays or hides this widget.. If you need to change the visibility of an `externalLink`, ensure that it's inside a `fieldSet`.