Link Element in BML
The <link> element in BML is designed for creating hyperlinks within BML content. It functions similarly to the anchor (<a>) tag in HTML, allowing users to navigate to different locations or documents. This element is essential for creating interconnected and navigable BML applications.
To initiate a user action through a link, ensure the link is embedded within a label associated with a dataset. The <link> element must include the appropriate target and workflowActionName attributes to specify the action's target and name, respectively.
To initiate an action group through a link, the <link> element must include the appropriate target and actionGroupName attributes to specify the action's target and name, respectively.
Attributes
The <link> element comes with attributes that specify the target location, behavior, and how the link should be opened. Here's a detailed list of these attributes.
| Attribute Name | Required | Type | Description |
|---|---|---|---|
| target | No | String | Specifies the target. The value tel prompts the user's device to start a phone call. The value mail opens the default email client on the device. The value workflowAction executes a workflow action. The value web opens content in a webbrowser, unless the user works on a mobile device and the link points to BizzStream content. In that case, the mobile app will open the BizzStream content. |
| location | No | String | Defines the location to which the link will navigate. If no location is specified, the contents of the element will not be clickable. |
| openInNewTab | No | Boolean | If set to true, the link opens in a new browser tab. If false or not set, the link will open in the same tab. |
| workflowActionName | No | String | The name of the user action to start. |
| actionGroupName | No | String | The name of the action group to start. |
Examples
Basic Link
This example demonstrates a straightforward use of the link element to navigate to a specified URL:
<bml>
<link target="web" location="https://www.bizzstream.com">
<text>some text</text>
</link>
</bml>
Result
Workflow action
This example demonstrates a straightforward use of the link element to trigger the execution of a user action configured in the workflow:
<bml>
<link target="workflowAction" workflowActionName="renderPdfAction">
<text>Click here to render the PDF</text>
</link>
</bml>
Result
Action group
This example demonstrates a straightforward use of the link element to trigger the execution of an action group configured in the layout:
<bml>
<link target="actionGroup" actionGroupName="openOverlay">
<text>Click here to open an overlay</text>
</link>
</bml>