> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/platform-documentation/form-node-parts/hyperlink.md).

# Hyperlink

## Description

The hyperlink part allows you to include a hyperlink in a logicnet form.

## Use

The hyperlink is either a regular link (which opens in a new window) or an iframe in the current form. This is controlled by the show\_location parameter. If the URL is an absolute URL it is treated as a link to an arbitrary site, otherwise it is assumed to be a link to a file in the documents directory of the web server.

## Editor Fields

| Field Name                | Description/Use                                                                                                                                                                                                                | Type/Options              | Optional/Mandatory |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- | ------------------ |
| Linked to                 | <p><strong>Webservice</strong>: If you select this option the system displays a progress bar for a webservice call.<br><strong>Mirth</strong>: If you select this option the system shows a progress bar for a Mirth call.</p> | Webservice \| Mirth       | Mandatory          |
| Link                      | This is the URL or document name to be opened.                                                                                                                                                                                 | Text                      | Mandatory          |
| Appearance                | <p><strong>Hyperlink</strong>: If you select this option the system shows the document as a hyperlink.<br><strong>Open in node</strong>: If you select this option the system shows the document in an embedded iframe.</p>    | Hyperlink \| Open in node | Mandatory          |
| Show full link as caption | <p><strong>Yes</strong>: If you select this the system shows the full path of the document as caption.<br><strong>No</strong>: If you select this the system shows a custom caption.</p>                                       | Yes \| No                 | Mandatory          |
| Caption                   | If you opt to display a custom caption, enter the caption here.                                                                                                                                                                | Text                      | Optional           |
| Target                    | The default target is "\_blank". This opens the document in a new tab. See <http://www.w3schools.com/TAgs/att_a_target.asp> for all possible targets.                                                                          | Text                      | Optional           |
| Root                      | If the URL is not an absolute path, you can specify a root path.                                                                                                                                                               | Text                      | Optional           |

## Example

Please download and import the following [example project](/release-9/example-gallery/example-projects-for-parts/hyperlink-example-project.md) in your workspace.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/platform-documentation/form-node-parts/hyperlink.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.