Creating a basic integration for Insight assets

The Insight basic connector uses the Insight API to gain visibility of orders. 

You can use either one of the following filters to refine the data that is retrieved:

• Date range. Based on order_creation_date_from = YYYY-MM-DD and order_creation_date_to = YYYY-MM-DD.
• Lookback period. The default is 20 days. You enter a numeric value to specify the look back period.

Connect Oomnitza and Insight in minutes

Get the information and the insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key information for network devices
• Configurable reports to share information about network devices with your colleagues and management
• Configurable workflows that you can easily create to:
  • obtain real-time tracking information for Insight shipments in Oomnitza such as the delivery status of a laptop that you ordered for an employee
  • Create sales orders
  • Fetch a sales invoice relating to a customer order

Note
This integration is a local basic integration, which means that it needs to be managed on your local machine. You'll need to prepare your local environment beforehand, download the Oomnitza connector, update a configuration file, and push it to your Oomnitza instance. Finally, you'll need to manage the scheduling of your basic integration on your local machine (using tools such as Task Scheduler for example).

Before you start

To stream data into Oomnitza, complete these tasks:

1. Review the system requirements. 
2. Download and install Python. Best practice is to create a virtual environment. A virtual environment is created on top of the existing Python installation and can be isolated from the packages in the base environment, so only those explicitly installed in the virtual environment are available.

Installing the connector

GitHub: Getting started

Download the source code for the Oomnitza connector

1. Log into Oomnitza.
2. Click Configuration > Integrations and click Block view
3. In the Basic section for Asset Integrations, click the Insight tile.
4. Download the source code and place it in a directory, such asC:\oomnitza_connector

You can also download the source code on the Oomnitza Connector page on GitHub.

Installing the requirements

In the directory you created (C:\oomnitza_connector), install the required Python dependencies stored in the requirements.txt file usingpip install -r requirements.txt

Tip
Runpip install --upgrade pipbeforehand to install and use the new version of pip

Generate the configuration file

In the same directory, runpython connector.py generate-inito generate theconfig.inifile. For further information read the Connector Configs section in the Getting started document.

Tip
Runpython connector.py --helpto see all available command line options.

Edit the configuration file

You must modify the following sections in the configuration file:

• The Oomnitza section
• The Insight section

Before you start

Before you edit the configuration file, you must complete the following actions:   

• Create an API token. See Adding, revoking, and refreshing an Oomnitza API token.
• Retrieve your Insight Client ID, Secret and Key which is assigned during customer set-up. Contact Insight directly to retrieve this information.

Open the configuration file that was generated in edit mode.

Editing the Oomnitza section 

[oomnitza]
url= https://<name_of_instance>.oomnitza.com
api token = <my_Oomnitza_token> 

1. Enter the URL of your Oomnitza instance.
2. Enter the API token that was generated in Oomnitza.

Editing the Insight section

[insight]
enable = True
url = 
region = NA
client_id = 
client_key = 
client_secret = 
order_creation_date_from = 
look_back_period = 20
order_creation_date_to = 
tracking_data = X

1. Set enable to True.
2. Enter the Insight URL. The format of the URL is https://example.oomanitza.com.
3. Enter a region. The default is NA.
4. Enter the following information which you have retrieved from Insight:
   1. Client ID
   2. Client Secret
   3. Client key
5. Add a filter to refine the data that is retrieved for Insight orders. You can create a date range filter or a lookback period filter. 
   Important
   You can either enter a date range or a lookback period. If you enter values for a date range order_creation_date_from and order_creation_date_to, and also enter a value for look_back_period, the value that you enter for the look_back_period is ignored. That is, you either enter a date range or a lookback period.
   1. Date range. To specify  a date range, use the following fields: order_creation_date_from and order_creation_date_to. The date format for the fields is YYYY-MM-DD.
   2. Lookback period. The default is 20 days. Enter a numeric value.
6. Include tracking data for the order, It defaults to "X" if no specific tracking data is available.
7. Delete the configurations that you do not need from the list such as Kace, Jasper, and so on.
8. Save your changes.

Map Insight fields to Oomnitza fields

To get the information that you need to manage your network devices, complete these actions:

1. Click Configuration > Integrations and click Block view
2. In the Basic section for Asset Integrations, click the Insight tile.
3. Click Mappings.
4. Map the Insight fields to the Oomnitza fields.  
5. Select the Serial Number as the sync key, which will synchronize the data that is streamed from Insight to Oomnitza.
6. Click FINISH.

Custom Insight mappings

You can map the following fields to Oomnitza:

• Billing Item
• Billing Number
• Billing Quantity
• Insight Order Item
• Insight Order Number
• Manufacturer
• Manufacturer SKU
• Material Description
• Order Creation Date
• Order Status
• Recipient
• Serial Number
• Tracking Number
• Web Reference

Want to map more Insight fields to Oomnitza?
Contact Support

Run the Insight network devices connector

To upload the network device information to Oomnitza, run the connector.

Run the connector in test mode to ensure that the mapped information is uploaded to Oomnitza:

python connector.py upload insight --testmode

When you are confident that you are uploading the information that you mapped, run the connector again in normal mode:

python connector.py upload insight 

1. Click Configuration > Integrations and click Block view
2. In the Basic section for Asset Integrations, click the Insight tile.
3. Click SYNC SESSIONS.
4. Go to the Assets page and review the information that is uploaded.

Schedule
To find out how to schedule the integration, contact Support or see Installing the connector

Unleash the power of Oomnitza

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

• Configure dashboards for your assets
• Configure custom reports about your assets 

See Getting started.