Creating a basic integration for Cisco Jasper assets

Let Oomnitza be your single source of truth!

The Jasper asset load fetches device information, including the status, activation date, and user associated with a device. See Cisco Developer Docs: Get Device Details.

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

Connect Oomnitza and Jasper in minutes

Get the information and 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 device information
• Configurable reports to share information about devices with your colleagues and management such as corporate-wide reports that detail the distribution and status of the devices in your environment

Note on the Jasper basic integration

Local basic integrations are managed on your local machine. You must prepare your local environment , download the Oomnitza connector, update a configuration file, and push it to your Oomnitza instance. Finally, must manage the scheduling of your basic integration on your local machine - using tools such as Task Scheduler. 

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. In Oomnitza, click Configuration > Integrations and click Block view
2. In the Basic section for Asset Integrations, click the Jasper tile.
3. Download the source code and place it in a directory such as C:\oomnitza_connector. 

Note
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 using pip install -r requirements.txt

Tip
Run pip install --upgrade pip before installing and use the new version of pip

Generate the configuration file

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

Tip
Run python connector.py --help to see all available command line options.

Edit the configuration file

You must modify the following sections in the configuration file:

• The Oomnitza section
• The Jasper section

Before you edit the configuration file, you must retrieve the following information:   

Your Oomnitza token which can be created in Configuration > Security > API tokens

Your Jasper username and password

1. Open the configuration file that you generated in edit mode.
2. In the Oomnitza section, enter the URL of your Oomnitza instance and enter the API token that you generated in Oomnitza. 
   

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

3. In the Jasper section, make the following changes:
   • Set enable to True.
   • Enter the path to the WSDL files for the API. The default wsdl_path is sufficient to run this integration. However, in case of any issues, you can also get the Terminal.wsdl file in your Console (Home > API Integration > Technical References > Get WSDL Files).
   • Enter your Jasper username and password. 
   • Enter your Jasper API Token. Please refer to the Technical Documentation available on the Jasper Control Centre (Home > API Integration).
   • Supply the path to the storage file. The storage file is a log file that is generated once the integration is run. It fetches historical information relating to modified terminal ID(s).

   Jasper settings 
   enable = True
   wsdl_path = http://api.jasperwireless.com/ws/schema/Terminal.wsdl
   username = [e-mail]
   password = change-me
   api_token = YOUR Jasper API TOKEN
   storage = storage.db

4. You can delete all the other configurations you do not need from the list, i.e. Kace, Jasper etc.
5. Save your changes.

Important
Cisco Jasper recommends that, for auditing purposes, enterprise accounts create a dedicated Control Center user whose sole purpose is to execute API functions. In most cases, this will be an Account Admin user, a role that will be able to perform the majority of API functions. 

Map Jasper fields to Oomnitza fields

Map Jasper fields to Oomnitza fields to get the asset information that you need. For the field mapping, it is recommended to follow these steps:

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

When your connector is uploaded to Oomnitza, it will use the mappings that you have configured.

Custom mappings

Account ID
Ctd Session Count
Custom 1
Custom 2
Custom 3
Customer Custom 1
Customer Custom 2
Customer Custom 3
Customer Custom 4
Date Activated
Date Added
Date Modified
Date Shipped
Fixed IP Address
Global Sim Type
ICCID*
IMEI
IMSI
MSISDN
Month To Date Data Usage
Month To Date SMS Usage
Month To Date Usage
Month To Date Voice Usage
Operator Custom 1
Operator Custom 2
Operator Custom 3
Operator Custom 4
Operator Custom 5
Overage Limit Override
Overage Limit Reached
Primary ICCID
Rate Plan
Rating
Secure Sim ID
Secure Sim Password Copy Rule
Secure Sim Username Copy Rule
Status
Suspended
Version

*ICCID is the primary unique identifier for a SIM in Control Center. Like a serial number, the ICCID is typically printed on the SIM card itself and cannot be changed.

Run the Jasper network devices connector

To upload the Jasper 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 jasper --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 jasper

Getting your results

1. Click Configuration > Integrations and click Block view
2. In the Basic section for Asset Integrations, click the Jasper 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 Jasper 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.