Deeplinks Deep links can be used for launching catalogs, scenarios, the contact list, or a call to a specific user. The Deeplink Deep link URL can be retrieved from CMS and then used to launch the app with the appropriate action.
In addition to performing the action actions for that deeplinkdeep link, users can add additional data from a third-party system by adding extra parameters to the URL.
...
| Table of Contents | ||||
|---|---|---|---|---|
|
Deeplink Deep link Anatomy
Deeplinks Deep links are essentially special URLs that can be used to launch the Worklink App from a device:
...
This is an example of a catalog deeplinkdeep link. Other types of deeplinks deep links would have different action parameters and supporting parameters for that action.
...
worklink://- The first part of the Deeplink Deep link is the scheme. Thisworklinkscheme refers to the Worklink App. Devices with the Worklink App installed recognize that URLs with this scheme will mean that the device should launch the Worklink App when this URL is clicked on, instead of going to a new web page. For links that will also work when the app is not installed seeresource- This is thedomainand is required for all URLs. In this case, it used to ensure that the URL is structured correctly and recognizable to the Worklink App.?- Everything after the?question mark are called query parameters and will be used by the Worklink App to do different things.action=fetch_catalog- The Worklink App will need anactionquery parameter present to perform actions. The values of this parameter can be changed to perform that action. In this example, it will be fetching a catalog to display in the Worklink App. There are other actions that can be taken and will explained in the next section.&- The&ersand symbol is used to delineate different query parameters. This could also appear as%3Dwhen it is URL encoded.catalog=123456- Each defined action would require additional query parameters in order for the Worklink App to correctly perform the action. In the case offetch_catalog, the Worklink App needs the id of the catalog to retrieve. In this example, the catalog id is set to123456.
Deeplink Deep link Actions
Fetch Catalog
Will open a catalog in the Worklink App. Any additional query parameters added to this Deeplink Deep link will be treated as external data and attached to any scenario sessions that are created from the opened catalog.
...
Used to display the company contacts in the Worklink App. Any additional query parameters added to this Deeplink Deep link will be treated as external data and attached to any call sessions created from this contact list.
...
Used to create a new scenario session in the Worklink App. Additional query parameters will be added as external data to the scenario session that is created.
| Info |
|---|
If the Deeplink’s Deep link’s targeted Scenario is a Persisted Session type, it will open the active session if the user has already created a session for that Scenario, rather than create a new session. |
...
Example: worklink://resource?action=fetch_scenario&scenario=123456
Adding External Data
Deeplinks Deep links accept an arbitrary number of extra query parameters which can be used to link data in customer (or 3rd party) systems with ScopeAR data.
...
| Code Block |
|---|
worklink://resource?action=fetch_catalog&asset=42&helloworkorder=world89&anythingassigneduser=youjoe_wantsmith |
becomes ScenarioSession.externalData = { “hello”“workorder”: “world”“89”, “anything”“assigneduser”: “you“joe_want” smith” }
Example #2
Even nested query parameters are accepted, e.g.:
...
| Code Block |
|---|
{
"anything": "you_want",
"even": {
"deeply2": {
"nested": "arguments"
}
}
} |
Querying Records
To query for records that have external data populated by a Deeplink, refer to this article on how to do GraphQL queries with external data: Queries using External Data
Deferred Deeplinks
...
Deferred Deep links
While the deep link format above can be used to directly launch WorkLink on a device that already has WorkLink installed, the more common and more flexible usage of deep links is to use a deferred deep link.
A deferred deep link has an expanded format that prepends “https://getworklink.com/deferred/fallback?deep_link=” to the deep links above which then redirects the deep link through the getworklink web service.
An example of a deferred deep link would look like this:
https://getworklink.com/deferred/fallback?deep_link=worklink://resource?action=fetch_catalog&catalog=123456
A deferred deep link that includes external data would look like this:
https://getworklink.com/deferred/fallback?deep_link=worklink://resource?action=fetch_catalog&asset=42&workorder=89&assigneduser=joe_smith
Deferred deep links go through the web service which will then display a web page that allows the user to select how to launch WorkLink. This can be used to install Worklink before launching the deep link or to relaunch the deep link on other devices.
Deferred deep links to specific resources have been turned into shortcodes for your convenience within the CMS. These shortened deep links are called shortcode deferred deep links. A shortcode deferred deep link will look like the following:
| Code Block |
|---|
http://getworklink.com/abc |
Or take the form of a QR Code:
...
A Defered Deeplink will bring the User to the getworklink service and prompt the user to install the Worklink app (if not already installed) before redirecting to a standard Deeplink:
...
These Deferred Deeplinks can be found in the ScopeAR CMS web interface in various places:
abcd |
For scenarios and catalogs, this shortcode has also been turned into a QR code that you can download and use.
Fetch Catalog
The Fetch Catalog Deferred Deeplink Deep link can be found on a catalog page:
...
Fetch User
The Fetch User Deferred Deeplink Deep link can be found on a user profile page:
...
The Fetch Scenario Deferred Deeplink Deep link is found on a scenario page:
...
The Fetch Contact List Deferred Deeplink Deep link is found on the company page under the settings tab:
...
Deferred DeepLinks and External Data
The External Data section above describes how to add external data parameters to deep links. In the same way, external data parameters can be added to either a deferred deep link or its shortcode equivalent.
An example of this would look like:
https://getworklink.com/3n7B&workorder=89&assigneduser=joe_smith
When this link is used, it would then become the deferred deep link URL:
https://getworklink.com/deferred/fallback?deep_link=worklink://resource?action=fetch_scenario&scenario=123456&workorder=89&assigneduser=joe_smith
Creating Deep Links for 3rd-Party Integration
When auto-creating deep links in a 3rd party application for integration purposes, typically the easiest thing to do is to append the external data to the shortcode link for the resource that you want to use. This will then be expanded to the full deferred deep link format when launched.
Querying Records
To query for records that have external data populated by a Deep link, refer to this article on how to do GraphQL queries with external data: Queries using External Data