Insert Hyperlink
Description
The Insert Hyperlink activity inserts a hyperlink into a Microsoft Word document at a specified bookmark or text location.
The hyperlink can target either a URL or another bookmark within the document.
The activity updates the specified Word File in place. The same file reference can be used by subsequent Word activities.
Common Capabilities
Process Data Support
This activity supports dynamic configuration using variables from the Process Data drawer.
You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.
Learn more → Using Process Data
Execution Control
Controls how this activity behaves when multiple incoming execution paths converge.
Learn more → Execution Control
On Error
Defines how the workflow behaves if this activity encounters a runtime error.
Design-Time Configuration
Display Text
The label displayed for this activity on the workflow canvas.
Word File
The Word document to modify.
Password
Optional password used to open a password-protected document.
Insertion Location
Find By
Specifies how the insertion location is identified.
Available options:
- Bookmark
- Text
Default: Bookmark
Bookmark To Find
The bookmark name used to identify the insertion location.
Available when Find By is Bookmark.
Remove Bookmark After Insertion
Determines whether the bookmark is removed after the hyperlink is inserted.
Available when Find By is Bookmark.
Default: False
Text To Find
The text used to identify the insertion location.
Available when Find By is Text.
Occurrence
Specifies which matching occurrence is used.
Available options:
- First
- Last
- All
Default: All
Hyperlink Settings
Hyperlink Type
Specifies the hyperlink destination type.
Available options:
- URL
- Bookmark
Default: URL
Target
The destination of the hyperlink.
Depending on the selected Hyperlink Type, this value represents:
- A URL such as
https://example.com - A bookmark name within the document
Text
Optional display text shown for the hyperlink.
When left empty, the text at the insertion location is used.
Text Search Options
Available when Find By is Text.
Page Lookup Mode
Specifies whether the search is limited to particular pages.
Available options:
- All
- Single
- Range
Default: All
Lookup Page By
Available when Page Lookup Mode is Single.
Specifies how the page is identified.
Available options:
- Page Number
- Page Index
Page Number
The printed page number to search.
Available when:
- Page Lookup Mode = Single
- Lookup Page By = Page Number
Page Index
The zero-based page index to search.
Available when:
- Page Lookup Mode = Single
- Lookup Page By = Page Index
From Page Index
The starting zero-based page index.
Available when Page Lookup Mode is Range.
To Page Index
The ending zero-based page index.
Available when Page Lookup Mode is Range.
Search In
Available when Find By is Text.
Body
Search within the document body.
Default: True
Header
Search within document headers.
Default: False
Footer
Search within document footers.
Default: False
If Body, Header, and Footer are all disabled, the document body is searched automatically.
Search Options
Available when Find By is Text.
Match Case
Determines whether the search is case-sensitive.
Default: False
Match Whole Words Only
Matches complete words only.
Default: False
Use Regular Expression
Treats the search pattern as a regular expression.
Default: False
Regular Expression
The regular expression pattern used to identify matches.
Available when Use Regular Expression is enabled.
Cross-Platform Considerations
Text-based insertion that relies on page-specific searches can produce different results on Windows and Linux because page layout calculations depend on the Word rendering engine.
For the most consistent behavior across platforms, use bookmarks instead of page-restricted text searches whenever possible.
Outputs
This activity does not produce any outputs.
The updated document is written back to the specified Word File.