Camera connector setup [WIP]

Description

The Camera Connector has been designed to redirect users at the camera 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 take a picture.

  • When clicking on the button to take a photo, he is redirected seamlessly to the Deepomatic app :

    • he arrives directly on the camera screen where he sees example of the picture he has to take and a camera guide.

    • He takes a picture and validate,

    • the AI runs on device

    • and the user 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>/work_item/<work_item_name>

Params

  • region - eu or us .

  • org_slug - The organization slug.

  • site_id - UUID of site.

  • work_order_id - UUID of work order.

  • work_item_name - the slug name of the work item

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/work_item/<work_item_name>?callback_uri=primaryapp%3A%2F%2F%2Fitem1If

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

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_item_name (required) - name of the work item.

  • input_id (optional) -The input id is returned if the analysis was performed online.

  • status (required) - Status of the work item analysis

  • justify_failure (optional) - Returned if the user justified a failure justify_failure=true .

  • is_edited (optional) - Returned if the user edited the analysis result is_edited=true .

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

Example

primaryapp:///item1?work_order_id=6d9a69fa-e54f-4599-8492-f4f8bfb4e91b&work_item_name=street_cabinet_open_after&status=offline_analysis_ok&justify_failure=true

Last updated

Was this helpful?