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 package 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

1. Setting the Retriever subdomain as a global variable
2. Adding the credentials
3. Creating workflows
4. Creating workflows with the API block
   1. Submit return
   2. Get orders
   3. Get order details

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. 

For further information consult Retriever: Authentication.

Setting the Retriever subdomain as a global variable

To save time entering information when you create workflows, 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, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Add your API key.
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. Add the information details.
2. Click the AUTHORIZATION tab.
3. Ensure that API Key is selected as the Authorization type.
4. Ensure that the Token Name is Authorization
5. Enter Bearer followed a space and the API Key. For example, Bearer abcde-adw3n-jknadd78l1kjndc .
6. Ensure that Add to Header is selected.
7. 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, click Configuration>Workflows and select Users from the Objects list. 
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 an endpoint.
8. Click the right arrow > to select your preset.
9. Populate the required information in the Configure section.
   •  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.
10. Click Advanced Mode
11. In the Authorization tab, select the credentials that you created in Adding the credentials.
12. In the Response tab map the message response by placing {{response}} in the Response field and mapping it to a long text Oomnitza field. Once you have the entire response, you can then parse the JSON response values to custom Oomnitza fields, as per the example below.
13. Connect the blocks.
14. Validate, launch, and save your workflow.

Retriever Submit Return preset

Submits a device return order to an offboarding employee. For further information, refer to the Retriever REST API documentation: Submit Order.

When you select this preset, you need to populate all required company information in the Configure section. This is where your offboarding employee will ship the laptop. The employee information is stored in the Advanced Mode > Body tab. The offboarding employee info is mapped to Oomnitza fields using Jinja templating. These fields need to exist in Oomnitza and be populated with user information for this preset to work.

Retriever will return tracking information when the request is sent. To retrieve this information, you must ensure that the order id, outbound tracking and return tracking is mapped to an Oomnitza field in the Advanced Mode > Response tab. 

Retriever Get Orders preset

Gets all device return orders for your organization, sorted by date created (newest first). For further information, refer to the Retriever REST API documentation: List Orders. To return order information, you must ensure that the order id, outbound tracking and return tracking is mapped to an Oomnitza field in the Advanced Mode > Response tab. 

 

Retriever Get Order Details preset

Fetches a single device return order. For further information, refer to the Retriever REST API documentation: Get Order Details. The order to be retrieved is referenced in the Advanced Mode > Information tab in the property {{return_id}}. To retrieve order information, you must ensure that the id, outbound tracking and return tracking is mapped to an Oomnitza field in the Advanced Mode > Response tab. 

 

Reference articles for workflows

• Mapping positive and negative responses
• Troubleshooting workflows 
• Using the API block