Work order connector set up [WIP]

Description

The work-order connector has been designed to redirect users at the work-order level in the Deepomatic application. With this connector, the user follows these steps :

  • The field engineer is on his primary field app, on his job screen. In the job form, he is asked to verify his work or audit with Deepomatic.

  • When clicking on the button to document his work, he is redirected seamlessly to the Deepomatic app :

    • he arrives directly on the work order screen where he sees all the pictures he has to take for this job. For each of these pictures, the user will have the following flow once he clicks on "take picture" :

      • arrives on the camera screen,

      • takes a picture and validates,

      • AI runs on device

      • sees the analysis results,

      • in case of errors, and according to your configuration, he might have to declare an exception within the Deepomatic interface.

  • Once they are done, they finally click the "done button" to return to their original field application to continue their journey.

To Lens deeplink

Path

deepolens:///connector/v1/<region>/prod/org/<org_slug>/site/<site_id>/work_order/<work_order_id>

Params

  • region - eu or us .

  • org_slug - The organization slug.

  • site_id - UUID of site.

  • work_order_id - UUID of work order.

Query Params

  • callback_uri - URI where the users will be redirected after leaving Deepomatic Lens. It must be serialized (see Path)

  • use_fragment - (optional) Some softwares, as Oracle Field Services, do not support query parameters in the call back and the results of the analysis provided by Deepomatic (via query parameters in the callback) may be lost. By default the results are provided with query parameters, but you can ask Deepomatic to provide them as fragments using the query parameter use_fragment=true when calling the connector.

Example 

deepolens:///connector/v1/<region>/prod/org/myorg/site/f66ac2bc-22bd-49d0-88ff-3121ecfa03ce/work_order/34f122be-21c1-45a0-9b87-bfe6e6b49ef2?callback_uri=primaryapp%3A%2F%2F%2Fitem1If

If you open the link again, the user will land directly on the results of the analysis.

To primary app Deeplink (callback)

Path

It is the callback_uri field that you included in the To Lens deeplink.

You should include in this link all the necessary reference to take the field engineer at the right place for example :

  • job_id

  • anchor

The lenght of the callback_uri must be maximum 475 caracters long.

Protected Query Params

Some query parameters are protected and cannot be used in the callback_uri :

  • work_order_id

  • work_item_id

  • input_id

  • status

  • justify_failure

  • is_edited

If used, you the following error will be returned error=protected_query_params_used

Query Params

  • work_order_id ( required) - UUID of work order.

  • work_order_progress (required) - Percentage of the work-order completion. num [0-100]

  • work_order_progress_detail - beta - serialized json with the status of each work-item (picture taken). This field is 1500 characters long. Beyond this length, it will be too_long_error . This field is beta and its purpose is for visual indication and not for process purpose.

Work order progress detail

Json example

[
    {"cabinet-before" : "online-ok"}, 
    {"splice-tray-before" : "online-ko"},
    {"splice-tray-after" : "offline-ok"},
    {"powermeter" : "offline"},
    {"cabinet-after" : null },
]

work item status code :

  • null - no picture submitted

  • offline - a picture was submitted offline no analysis executed

  • offline-ok - a picture was submitted offline, an offline analysis has been executed and the tasks included in the conformity score are all validated

  • offline-ko - a picture was submitted offline, an offline analysis has been executed but the tasks included in the conformity score are not all validated

  • online-ok - a picture was submitted, an online analysis has been executed and the tasks included in the conformity score are all validated

  • online-ko - a picture was submitted, an online analysis has been executed but the tasks included in the conformity score are not all validated

Serialized json example : 

%7B%22work-orderId%22%3A%224fe8e729-41fb-4008-9966-1fa3c1c9b80c%22%2C%22progress%22%3A%2290%22%2C%22work-items-status%22%3A%5B%7B%22work-item%22%3A%22cabinet-before%22%2C%22status%22%3A%22online-ok%22%7D%2C%7B%22work-item%22%3A%22splice-tray-before%22%2C%22status%22%3A%22online-ko%22%7D%2C%7B%22work-item%22%3A%22splice-tray-after%22%2C%22status%22%3A%22offline-ok%22%7D%2C%7B%22work-item%22%3A%22powermeter%22%2C%22status%22%3A%22offline-ko%22%7D%2C%7B%22work-item%22%3A%22cabinet-after%22%2C%22status%22%3Anull%7D%5D%7D

Callback example

primaryapp:////item1?work_order_id=6d9a69fa-e54f-4599-8492-f4f8bfb4e91b&progress=80&work_order_progress_detail=%7B%22work-orderId%22%3A%224fe8e729-41fb-4008-9966-1fa3c1c9b80c%22%2C%22progress%22%3A%2290%22%2C%22work-items-status%22%3A%5B%7B%22work-item%22%3A%22cabinet-before%22%2C%22status%22%3A%22online-ok%22%7D%2C%7B%22work-item%22%3A%22splice-tray-before%22%2C%22status%22%3A%22online-ko%22%7D%2C%7B%22work-item%22%3A%22splice-tray-after%22%2C%22status%22%3A%22offline-ok%22%7D%2C%7B%22work-item%22%3A%22powermeter%22%2C%22status%22%3A%22offline-ko%22%7D%2C%7B%22work-item%22%3A%22cabinet-after%22%2C%22status%22%3Anull%7D%5D%7D

Last updated

Was this helpful?