Skip to content

Insert Emakin Links to Forms or Reports

This guide explains how to insert links to Emakin-specific items such as workitems, documents, or cases when designing an application within Emakin. These links allow users to seamlessly navigate to key parts of the workflow directly from forms or reports.

Step-by-Step Guide

  1. Identify the Emakin Item's Unique Identifier and Display Information

    • Obtain the Unique Identifier (ID): Determine the specific Workitem, Document, or Case within Emakin that you want to link to in your application. Each item has a unique ID that will be used to create the link.

    • Obtain the Display Information: Identify what you want to display as the link text on the form. As a best practice:

      • Use the Case Number as the display text for a case, while the Case ID is embedded in the link.

      • Use the Form Number as the display text for a workitem, while the Workitem ID is embedded in the link.

  2. Open the Form Designer

    • In the Emakin platform, navigate to the Form Designer where you are building or editing a form.

    • Open the specific form where you want to insert the Emakin link.

  3. Add the HTML Control

    • Within the Form Designer, navigate to the desired location on the form where you want to place the link.

    • Add an HTML Control to that location on the form.

image-20240902-144434.png

  1. Insert the Emakin Link Using the HTML Code

  2. Inside the HTML Control, insert the appropriate HTML snippet for linking to either a workitem or a case:

For a Workitem:

1
<Html> HtmlClass="" AllowCopy="False" ResetStyle="True"> <Content><![CDATA[<a href="/#/workitem/{{WorkItemId}}" target="_blank">{{FormNo}}</a>]]></Content> </Html>

For a Case:

1
<Html> HtmlClass="" AllowCopy="False" ResetStyle="True"> <Content><![CDATA[<a href="/#/case/{{CaseId}}" target="_blank">{{CaseNo}}</a>]]></Content> </Html>
  • For a Document:
1
<Html> HtmlClass="" AllowCopy="False" ResetStyle="True"> <Content><![CDATA[<a href="/#/file/{{FileId}}" target="_blank">{{FileName}}</a>]]></Content> </Html>

  • Replace {{WorkItemId}}, {{CaseId}}, {{FileId}}with the unique ID you obtained for the workitem, case or file.

  • Replace {{FormNo}}, {{CaseNo}}, {{FileName}}with the display information (Form Number, Case Number or the FileName) that you want users to see as the link text.

  • Save and Test the Link

  • After inserting the HTML code, save the changes to your form.

  • Test the form to ensure that the link navigates correctly to the specified Emakin workitem or case, and that it opens in a new tab as intended.

Best Practices

  • Clear Link Text: Ensure that the {{FormNo}}, {{CaseNo}} or {{FileName}}placeholders or values are clear and descriptive, making it easy for users to understand what they are clicking on.

  • Consistent Use: Maintain consistency in how you use and display these links across different forms to provide a cohesive user experience.

  • User Access: Verify that all users who need to access the linked Emakin items have the necessary permissions.

Troubleshooting

  • Link Functionality: If the link doesn’t work, double-check the HTML code and ensure the IDs are stored in the correct Xml node.

  • Access Permissions: If users encounter access errors, confirm that they have the correct roles and permissions to view the linked Emakin workitem or case.