Creating a Deep Link

Deep links allow data to be passed from another application directly into a form. A deep link is a URL link, that when clicked, opens the app and launches a specific form with pre-filled values and operating conditions specified. For example, you can trigger a deep link from IFS Mobile Work Order (MWO) to automatically open and populate a form.

If you're not familiar with the steps in this process, please contact your IT department or support@omnibyte.com for assistance.

1. Open the form for which you want to create a deep link and from the toolbar, click (Connect) and select Deep Links. Then select + Deep Link to open the Deep Links window.
   
2.  In the Deep Link Name field, enter a name for the deep link.
3. Toggle on/off the parameters for the deep link you are building. A parameter is a piece of information that tells the app what data to display or how to behave then the deep link is opened. If you use a parameter that adds “<<addvaluehere>>” make sure to replace everything between << and >> with the correct value before using the link. 

   FindSaved	Uses the IntegrationFormEntityID to find a saved form in the app. Typically used to allow users to resume a previously started form that was saved but not yet submitted. By providing a direct link to the saved form, FindSaved lets a user bypass the need to manually search for the form, enabling quick and seamless continuation of incomplete submissions.
   HideFormList	Hides the home page when opening a form from a deep link.
   ShowSubmitPage	Shows a page that says “Form Submitted” rather than taking the user back to the forms listing.
   HideFieldParams	Hides the bar at the top of the main menu in the app that displays the values that were passed in. This can be useful when passing sensitive data or when you want to minimize on-screen clutter for the user.
   SendFormSubmissionEmails	Triggers the sending of submission emails when a form is successfully submitted. The system will send emails according to the form’s configured submission email rules.
   HideBackButton	Hides the back button in the app when a form is accessed via a deep link. When enabled, users are prevented from navigating back to the home page.
   NoSync	Prevents the application from performing a data sync when a user accesses the app via a deep link.
   FormName	App tries to automatically open a specific form when the app is launched via the deep link. The value of this parameter should match the exact name of the form as defined in the system.
   LinkID (?)	Associates or groups multiple form submissions under a common identifier submission by the app deep linking. For example, a service call may be “linked” to multiple safety form submissions.
   FormDefinitionID	Directs the app to automatically open a specific form based on its unique internal identifier when the app is launched. The FormDefinitionID references the form by its system-assigned unique ID, ensuring greater accuracy—especially when multiple forms may share similar names.
   IntegrationFormEntityID (?)	Locates and references a specific existing form submission or saved draft. It is typically passed as a parameter in a deep link to retrieve a form that has already been created but not yet submitted. The IntegrationFormEntityID points to a specific instance of that form — usually tied to an external system record such as a job, task, inspection, work order, or assessment.
   AdditionalEmails	Allows one or more email addresses to be added to the recipient list for submission notification emails associated with a form.
   CallBackURL	Specifies a URL to which the app will redirect or deep link after a form is saved or submitted.
   ExternalSync	Used with the CallBackURL to facilitate seamless data synchronization workflows with an integrating application. When ExternalSync is enabled, the app first opens to perform a data sync, ensuring that the latest form data and configurations are updated. After the sync is complete, the app automatically navigates back to the integrating app via the specified CallBackURL, enabling smooth transitions and up-to-date information exchange between systems.
   RegKey	Accepts and uses a registration key passed directly within the deep link URL. By including this parameter, the user can bypass the manual entry of the registration key during the app’s launch or form access process.

4. Toggle DataSetParameters on to use a data set on the deep link. Data set parameters are used in a deep link to filter the data that is retrieved from the server, ensuring that only the relevant information is returned. These parameters are provided when the deep link is executed. Keep in mind the data set parameter is passed in as a string, even if it is a number. If the value needs to be treated as a number, you’ll need to convert it to an integer. For details about using data set parameters, see Using Data Set Parameters for Deep Links.

5. Click + Form Field to add any fields you want to include in the deep link along with the value you want them to contain.

   Toggle Encode on if you want certain characters in the URL to be converted into URL-safe formats. Encoding prevents these characters from breaking the link or causing errors. For example, ampersands and question marks have special meanings in URLs. When included as a deep link they could be misinterpreted by browsers.
6. From the Link Format list, select the format you want to use for the deep link: Mobile App, Windows Desktop, or Browser.
7. Click Create Link to create the deep link. Once the link is created, you can edit any of the information in the link as needed. The (Copy) button can be used to copy the link into the integrating product as needed. We recommend pasting the link in your preferred format and testing it to confirm the deep link works correctly.
8. Click Save. Saving the deep link allows you to make changes later if the form changes or your data in the integrating product changes.