Template Links Overview
A Template Link is a URL that links to a specific template in HotDocs Advance. When a user opens the URL, Advance prompts them to create a new work item using the linked template.
For example, you can display the link to a specific template on a relevant page in your own knowledge base. By clicking the link, a user viewing the page is able to launch Advance and create a new work item using the linked template.
Overview
Template links enable you to include hyperlinks to HotDocs templates within your own content. This is useful as it enables you to provide links to contextually-relevant templates to users as they read your content. For example, in a law firm's knowledge base article about commercial leases, you can include a link to a commercial lease contract template in Advance. When a user opens the link, Advance will prompt them to create a new work item. Once created, Advance will open an interview for the new work item.
Advance displays template links in the template details pane as a hyperlink labeled Link. You can include these links in your own content by copying the template link. Template links will only appear in the template details pane if your template:
- Is assigned to at least one work group
- Has a live version
- Is an Author template
Unlike public interview links, where a link can be opened by external users, template links can only be opened by users with an Advance account.
Workflow
You copy a template link on the template details pane in Advance. You paste the link into your own content. A user accesses your content and opens the template link. The link opens the Advance login page. When the user logs in, Advance prompts them to create a new work item. Once the user creates the new work item, Advance opens an interview for the new work item. The user can use the interview to update the work item as usual.
Work Item Details
When users open a template link, the following details are required to create the new work item:
- Work item name — a unique name for the work item
- Work group — the work group to which the work item is assigned
You can either set these details for your users or allow your users to enter the details themselves. You can set work item details using the Template Link Options described below.
Work Item Name
The work item name field displays a default name. This uses the format: [user's name]-[template name]-[timestamp]. For example, John Smith-Commerical Lease-8641631267725. If you have set the work item name using the template link options, the work item name cannot be edited by the user.
Work Group
The work group field is a drop-down list of the work groups available to the user. Users must have access to at least one of the work groups to which the linked template is assigned. If you have set the work group using the template link options, the selected work group cannot be changed by the user.
Template Link Options
You can optionally set options for a template link by adding parameters to the query string of the template link URL. For example, you can set the work item name, work group, or set the template link to automatically bypass the Create Work Item dialog. See the following topics for more information:
Please note that data in the query string could be present in logs. Excluding sensitive data is advised.