Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 4.02 KB

README.md

File metadata and controls

61 lines (46 loc) · 4.02 KB
Raw

EloquaDataLoader

Export data from Oracle Eloqua's BULK API then either sync it into an SQlite3 database or dump into JSON files.

Basics: Using the program

To use the program fill in your Eloqua login information in config module, then run the functions located in the ldbs module to perform the various syncs available.

You can use the hourly_sync, or daily_sync functions to run any of the scripts in this module at the intervals you specify.

Module Breakdown:

  • ElqBulk - The core module that holds the ElqBulk class which performs BULK API 2.0 exports and syncs to your SQLite database, or dumps to JSON
  • ElqRest - WARNING: Due to Eloqua not actually supporting bulk export of External Activities, this function uses a large amount of API calls, and takes a long time to complete a fresh pull, use at your own risk. A custom wrapper for the Eloqua REST 2.0 API to import any, or all External Activities or Campaigns from your Eloqua instance.
  • TableNames - The list of tables currently available for export through BULK API in Eloqua
  • config - Company, username, and password used to log in to allow ElqDB to function, requires a user with Advanced Marketing User privileges or higher
  • ldbs - This is the module you'll be running most of the time, it has functions that facilitate the majority of syncing actions available through this script
  • geoip - An additional module that holds another class that uses the maxminddb package with the GeoLite2 database to geolocate IP addresses located in the activity tables exported with ElqDB
  • closest_city - Takes the GeoIP table created by geoip and calculates the distance to the closest major population center in North America, also lists the city and country. Appends the information to the GeoIP table.

Usage:

After setting up the config module, open the ldbs module and place the functions you want to run in the main function at the bottom. You can set up any kind of sync you'd like in this module, as well as run most functions from any module in this program.

     def main():
         """
         Main function runs when file is run as main.
         """

         # Performs full database sync, only updating records modified since the last sync
         sync_database(filename='EloquaDB.db')

         # Iterates through all tables with IP addresses and logs the IP with
         # its geolocation in the GeoIP table
         full_geoip(filename='EloquaDB.db')

         # Calculates the distance from a given point to every major population center in North America
         # Then returns that population center, the distance from it in km, and the country that city is in
         closest_city(filename='EloquaDB.db')

         # Performs a full campaign sync, updates the last 'page' of campaigns (default page size is set to 100)
         sync_campaigns(filename='Eloquadb.db')

         # Performs full external activity sync, only updating records created since the last sync
         # WARNING THIS CAN USE A HIGH NUMBER OF API CALLS AND TAKE A LONG TIME - CHECK YOUR API LIMIT BEFORE USING THIS
         sync_external_activities(filename='EloquaDB.db')

         # Exports GeoIP table inner joined with tables that contain activities
         # with IP addresses in csv format
         geoip.export_geoip(filename='EloquaDB.db')

Geolocation By IP

Added functionality provided through the geoip module. Use the run_geoip or full_geoip functions in ldbs to roughly match the IP Addresses in activity tables that contain them with real-world coordinates. Accuracy of these coordinates vary from 5km to 50km, so only really useful for high level anaylsis/insights.

Dependencies

Download the GeoLite2 City MaxMind DB binary, gzipped file, then unpack it in the same directory as your .py files.