Overview

The file generator utility is a tool created to allow users to create a scheduled and automated download of data from Sensemetrics cloud storage to the user's local storage option of their choosing. The tool utilizes Table data profiles configured in Sensemetrics, a software package download, and webpage allowing the user to configure their download preferences. 

Setting up Data Table Profiles

Data table profiles will need to be configured for sensors that need to be exported via the File Generator Utility. Follow the information provided in the Data Tables article about setting up Data Tables so they can be exported, Data Tables.

Downloading the Exporter Package

A package must be downloaded to your computer in order for the tool to work. Sensemetrics offers both Windows and Mac package options. Please request the zip file from the Sensemetrics Customer support team by submitting a ticket request, Support Ticket Submission. 

Download the file to the computer that will store the data generated from The downloaded file will be zipped. Unzip the file, and open the unzipped folder. Expand the "pkg" folder, which will provide the application options as illustrated below. 

For Windows users, select and download the file "sensemetrics-file-import-win.exe". For Mac users, select and download the file "sensemetrics-file-import-macos".

The Exporter package previously downloaded must be running in the open window at all times for export tool to function.

Note: For security reasons, many computers will ask for verification to download the file. Mac users can right click and select open on the file "sensemetrics-file-import-macos" file in order to circumvent the security message. 

Setting up the Utility

Once the exporter package has been downloaded, navigate to the file generator configuration webpage: http://localhost:3005/.

1. API Key- The first step in the setup of the utility is to retrieve and input the Sensemetrics API key. The API key can be directly accessed by clicking the "account settings" link below the API key input window and logging into the Sensemetrics application. 

The API key can also be found in the application by navigating to the Manage Account dropdown, (a) then clicking account settings, (b) selecting "Development", and (c) copying the API Key.

2. Project Selection- Once the API Key has been entered, the utility will verify the API connection. If successful, additional options will become available. The first option selection is to select the project for data export from the dropdown options.

Data Export Configuration

Once a project has been selected, the Data Profiles created by or shared with the user will populate in configuration windows at the bottom of the page.

3a. File Generator Toggle- The toggle button allows the user to turn the export function on or off for a selected profile.

3b. Export File Name- A prefix can be appended to the export file name to enable better tracking of exported and sorting of exported files.

3c. Export File Directory Path- Enter the local file pathway for the generated file to be saved to on the computer.

3d. Export Schedule- The schedule selection allows the user to select export frequency between hour, daily, weekly, and monthly, and set a time for the export to occur.

3e. Additional Options- The "More" dropdown provides the user with some additional dropdown options and details. The first option allows the user to select a time range and manually export data. The Export History provides information about previous exports.

Export Files

After a file has been scheduled for delivery or manually exported, a CSV file will be generated in the configured file pathway as illustrated below.