Creating workflows for Retriever assets

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets as data from Retriever is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Retriever in minutes

Follow the steps below to connect Oomnitza and Retriever to use the Retriever submit order preset. You can use this preset to submit a request to an offboarding employee to return a device, all you need to do is give the address where you want the packaged returned. The offboarding employee will receive email notifications once their box is dispatched, and the company will also be kept informed of the status of the return. Currently only laptop return orders may be created with this API.

Navigation

Setting the Retriever subdomain as a global variable

Adding the credentials

Creating workflows

Creating workflows with the API block

Submit Order

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

Authentication is performed using an API key, which can be obtained by any admin in the Retriever portal. When making an API call, the key should be provided in the Authorization header as follows:

Authorization: Bearer <API_KEY>

For further information consult the Retriever: Authentication.

Setting the Retriever subdomain as a global variable

To save time entering information when you create the integration and the workflow, you can add the Retriever subdomain as a global variable in Oomnitza.

1. From the menu, go to Configuration>General.
2. Click Global Settings.
3. Click Add new variable (+). 
4. Enter Retriever.Subdomain as the variable name.
5. Enter your Retriever subdomain. If your subdomain ishttps://mycompany.helloretriever.comyour subdomain would be: mycompany.
6. Save your changes.

Adding the credentials

To stream Retriever user data into Oomnitza, complete the following steps:

1. In Oomnitza, go to Configuration>Security>Credentials.
2. Click Add new credential (+).
3. Add the information details.
4. Click the AUTHORIZATION tab.
5. Ensure that API Key is selected as the authorization type.
6. Enter Authorization as the name of the token. 
7. Enter Bearer followed by the API Key. For example, Bearer abcde-adw3n-jknadd78l1kjndc .
8. Ensure that Add to Header is selected.
9. Save your changes.

Next

You use the credentials that you added to create and customize your Retriever integrations with Oomnitza.

Creating workflows

Creating workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create a workflow with the API block. To create a user workflow, complete the following steps:

1. From the menu, you can select Configuration>Workflows>People. 
2. Click Add (+). The Begin and End blocks are automatically added to the sandbox.
3. Enter the name and a description of the workflow. 
4. Edit the Begin block by adding the rules that will trigger the workflow. For example, for this preset you may want to create a rule that identifies offboarding employees (such as those with Status=Offboarding).
5. Click the Blocks tab, and drag and drop the API block onto the canvas.
6. Click the Edit icon.
7. Enter Retriever in the Select Preset search field and select the Submit Order preset.
8. Click the right arrow > to select your preset.
9. Populate the required information in the Configure section. Refer to the Retriever Submit Order preset for further information. 
10. Connect the blocks.
11. Validate, launch, and save your workflow.

The Retriever Submit Order preset

The Submit Order preset creates a device return order. When you select this preset, you need to provide the following:

Authentication and domain details

• Credentials: Your correct Retriever Credentials that you created in Adding the credentials.
• Subdomain. Your subdomain should be derived from the global variable you created when Setting the Retriever subdomain as a global variable. Alternatively, click Set Manually to manually enter your subdomain.

Company return information

This is where your offboarding employee will ship the laptop. Retriever will send you tracking information when the laptop return shipment is in transit.

• Return Recipient Name
• Return Address Company
• Return Address Line 1
• Return Address Line 2
• Return Address City
• Return Address State
• Return Address Zip
• Display Name
• Notification Email

Response mapping information

Enter the Oomnitza fields you will use to store the JSON values returned in the response:

• Map Retriever ID to Field: The id returned in the JSON response.
• Map Retriever Box Track to Field: Theoutbound_tracking number returned in the JSON response.
• Map Retriever Box Return Track to Field: Thereturn_tracking number returned in the JSON response.

You can use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. The offboarding employee info is mapped to custom Oomnitza fields. These fields need to exist in Oomnitza and be populated with user information for this preset to work. Alternatively, if you wish to test the workflow, you can manually enter the employee information.

   "employee_info":{
   "email":"{{email}}",
   "name":"{{full_name}}",
   "address_line_1":"{{home_street}}",
   "address_line_2":"{{home_line_2}}",
   "address_city":"{{home_city}}",
   "address_state":"{{home_state}}",
   "address_zip":"{{home_zip_plus_4}}"
   },
       

3. Select the Response tab.
4. For troubleshooting purposes, you can map the Response field  {{response}} to a custom long text Oomnitza field. Once you have the entire response, you can then map more JSON response values to custom Oomnitza fields. To create a custom field, go to People>Customization in Oomnitza. For further information, see Creating Custom Fields in Oomnitza.

For further information, refer to the Retriever REST API documentation: Submit Order.

For further information on workflows see:
 Understanding workflows
 Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.