Objective
After reading this article, you will understand how to make it easy for your mobile users to jump to the Current Youreka Mobile App from different mobile apps they may be using in the field.
Before you get started
This article might be helpful before you read further:
Note: There are two versions of this article. One for the Old Mobile App, available until mid-2023, and one for the Current Mobile App, available starting October 2022. This version is intended for users of the Current Youreka Mobile app. To access the article for the Old Mobile App, click here.
Youreka has powerful deeplinking capabilities, allowing for passing data to and from other apps to enable seamless work. There are many use cases where there is a need to work with other mobile apps like Salesforce Mobile, Salesforce Field Service Mobile, Salesforce Maps or a custom built app. Leveraging Youreka’s deeplinking, data can be sent into Youreka and trigger the desired workflow while staying in context of the work at hand, allowing users to complete complex forms on-the-go.
In order to create a deeplink, first consider which application you want your mobile users to jump from. Consider which type of forms you wish for them to fill out, and which records those Forms should be related to in Salesforce. When creating deeplinks, we are able to define all of these things in the URL making it easy for end users to simply click a button, and fill out their forms.
Deeplink Parameters
Below are some of the different parameters you might consider using when developing a deeplink:
URL Parameter | Description |
---|---|
https://youreka.io/yourekamobile? |
Required if deeplinking to the Youreka Mobile App |
newForm=True& |
Creates a New Form record once URL is clicked |
TemplateID={Template-Id-Goes-Here}& |
Defines the template that will be used when creating a new form record |
FormID={Form-ID-Goes-Here}& |
Opens an existing Form record in Youreka Mobile |
disco__Form_Account__c={Account-ID-Goes-Here}& |
These parameters populate the Form lookups. If your form templates are field linking, you should populate each lookup that the field links are using |
recordId={Record-ID-Goes-Here}& |
If Mobile Cards are enabled, this parameter will take the user to a specific record on the Youreka Mobile App, where they can begin completing Forms |
forceSync=true |
When deeplinking into Youreka this will perform a manual sync and retrieve the latest data from Salesforce. This will impact performance and is only needed if new Forms or Mobile Card records have been updated since last using Youreka. |
By combining these parameters together, you can construct a link that will drive individuals to the Youreka mobile app. Below are some examples of complete Youreka Mobile Deeplinks:
Deeplink Examples
Deeplink Example | Description |
---|---|
https://youreka.io/yourekamobile?newForm=true&TemplateID={!Account.Store_Visit_Form_Template_ID_Custom__c}&disco__Form_Account__c={!Account.Id} |
This deeplink launches from a mobile application, creates a new Form record using a dynamically set form template, and automatically relates the Form to a specific Account in the system – prepopulating the form with data from that Account |
https://youreka.io/yourekamobile?newForm=true&TemplateID={!$Form_Template_ID_Custom__c}&Work_Order__c={!$Id}&disco__Form_Contact__c={!$ContactId}&disco__Form_Account__c={!$AccountId}&disco__Form_Case__c={!$CaseId} |
This deeplink launches from the Field Service Lightning Mobile application, creates a new Form record using a dynamically set form template (perhaps set on the Work Order, or the Work Type), and automatically relates the Form to the Work Order, Contact, Account, and Case – prepopulating the form with data from all of these records |
More Deeplinking Examples With Expected Behaviors
Deep Link Format | Behavior When Mobile Cards not enabled | Behavior When Mobile Cards enabled | Behavior When Check-in/Check-out enabled |
---|---|---|---|
https://youreka.io/yourekamobile?formID=18-character-form-id | Link to existing form | Link to existing form.**** | Not Permitted message |
https://youreka.io/yourekamobile?newForm=true&TemplateID=18-character-template-id[&disco__form_contact__c=18-character-contact-id] *** | Create a new form in the Youreka Mobile App. | Create a new form in the Youreka Mobile App.**** | Not Permitted message |
https://youreka.io/yourekamobile?recordId=18-character-record-id | Pre-Gambrills: n/a Post-Gambrills: Mobile Cards Not Enabled message. | Open forms list for record (primary object) | Open forms list for record (primary object)and load check-in modal |
** While the aforementioned apps are the only ones that have been officially tested, Deep linking should function the same from other third-party apps. If issues are found with other apps, please contact Youreka Support.
*** Prepopulate required field links on the new form page by adding their ids to the link. Include the ampersand, object name and either the salesforce id to link to an existing record or the word NEW to create a new one.
**** If the Form has the Primary Object Lookup, it will take you to that Primary Object Record Forms List when you leave the form. If the Form doesn’t have the Primary Object Lookup, it will take you to the Primary Object list but it will not be accessible on the mobile app from a list. However, the changes on he form will still be saved to Salesforce.
Salesforce Field Service Mobile Deeplink
In Salesforce Field Service Mobile App Extensions can be leveraged to deeplink and open the relevant Form, Work Order or Service Appointment within Youreka.
Please carefully consider the business use case when building the Youreka deeplink. In order to see a list of Forms relevant to the Work Order, Mobile Cards should be enabled within Youreka and the deeplink should direct to the Work Order Id.
If needing to jump directly from a Work Order/Service Appointment then the deeplink should direct to the Form Id, which will allow field workers to complete the Form directly. Leveraging outbound deeplinks, the user can be directed back to SFS Mobile upon submission of the Form.
Deeplink to Specific Form
Here is an example of deeplinking that will create a new form. This option is best if users will only need to fill out one type of form while on the job and it gets created on demand when deeplinking into Youreka.
Please keep in mind that your deeplink may look different, depending on which Form Template you intend to use, as well as which Form lookups you require.
Pro Tip: You can either choose to hardcode a template ID here, or create a dynamic template ID, which could be established on the Work Order, Service Appointment, or even Work Type record! A dynamic template ID is powerful, because it allows you to create a single app extension, but that app extension could lead to many different types of forms.
https://youreka.io/yourekamobile?newForm=true&TemplateID={!$Form_Template_ID_Custom__c}&Work_Order__c={!$Id}&disco__Form_Contact__c={!$ContactId}&disco__Form_Account__c={!$AccountId}&disco__Form_Case__c={!$CaseId}
Deeplink to a Group of Forms
Here is an example of deeplinking to a Mobile Card in Youreka that will display all the relevant Forms. This option is best if users need to complete several forms while complete a single job
In order do this, you need to set up Mobile Cards for the Work Order object.
After you have Mobile Cards set up for the Work Order object, you should create an App Extension, and then add the deeplink URL to the launch value. An example of a deeplink to a mobile card can be seen in the code snippet below.
https://youreka.io/yourekamobile?recordId={!$Id}
When users click on the app extension in SFS Mobile, they will be taken to a page that shows a list of forms that have been created and related to that specific Work Order. If you wish for users to be able to create new form records, create New Form Buttons in the Mobile Admin tab.
Pro Tip: This option is extremely powerful. It gives businesses ultimate flexibility on providing checklists/forms to their technicians based on unique business needs. The pro tip here would be to use Salesforce automation to generate the forms before the technician rolls the truck. We made a video showing you what this could look like!
Considerations for Deeplinking from Field Service Mobile App
- In SFS Mobile you can create many app extensions, each scoped to different SFS objects (i.e. work order vs. work order line item). Each app extension can also launch different types of Forms by using a dynamically set Form Template. You can also have multiple SFS Mobile settings based on user profiles. Because of all of these options, Field Workers can have access to their specific Forms and Checklists based on the business needs and use cases.
- When creating app extensions for the SFS Mobile, iOS App Extensions require a $ symbol when passing parameters between applications. However, Android App Extension Launch Values should omit any $ symbols when creating deeplinks.
Salesforce Mobile Deep Link
In order to deeplink from Salesforce Mobile to Youreka, create a Custom Button with the Content Source of URL. Set the Display Type to Detail Page Button and add it to the relevant Page Layout.
The button should have the base URL below:
/apex/disco__OpenYourekaAppV2
Any additional parameters can be appended to this URL. Here’s an example of deeplinking and creating a new Form with the Form Template dynamically set from a custom Lookup on the Work Order, and setting the Form Lookup to the current Work Order:
/apex/disco__OpenYourekaAppV2?newForm=True&TemplateID={! CASESAFEID( WorkOrder.Form_TemplateId__c ) }&Work_Order__c={! CASESAFEID( WorkOrder.Id ) }
Please note, Youreka requires the 18-character ID of any Salesforce record, so ensure you are using the CASESAFEID(id) formula when referring to any dynamic fields with record IDs. See Salesforce Help for more detail.
Troubleshooting
- IOS
- Are deeplinks in IOS prompting some users to enter a phone number and not taking them to the Youreka Mobile App? A couple of Safari settings changes could help this:
- Settings > Safari > Request Desktop Website > All websites > Switch Off
- Settings > Safari > Advanced > Website Data > Swipe and delete the data
- Are deeplinks in IOS prompting some users to enter a phone number and not taking them to the Youreka Mobile App? A couple of Safari settings changes could help this:
- Android
- Are deeplinks prompting some users to download the app when they already have it installed? follow these steps:
- Android settings > search the Youreka app and select the Youreka app with the white background > set as default > set open supported links to ON
- Android settings > search the Youreka app and select the Youreka app with the white background > set as default > Supported web addresses > set youreka.io to ON
- Are deeplinks prompting some users to download the app when they already have it installed? follow these steps:
Comments
0 comments
Please sign in to leave a comment.