Gateway Readme for macOS

 Table of Contents

  1. Overview
  2. System Requirements
  3. Set Up Instructions
    1. STEP 1: Create an Agent
      1. Start the agent and run it as a service
      2. Stopping/deleting the agent
      3. Re-starting the agent
      4. Check the status of the agent
    2. STEP 2: Add and Configure a Plugin 
      1. Option 1: Start from the download folder
      2. Option 2: Start from the Socrata site
      3. Reconfigure a plugin
      4. Removing a plugin

Overview

Establishing a Socrata Gateway connection is a two-step process:

  1. Create an agent
  2. Add a plugin (or plugins) to that agent

Agents are small programs that establish a secure connection to Socrata and act as a manager for a plugin or set of plugins.

After the agent is downloaded and set up, we’ll help you connect to your individual data sources with plugins for specific data types.

You can add as many plugins as you like to a single agent, including multiple plugins of the same type.

You can find a 60-second video on setting up an agent on a Mac here

System Requirements

The agent requires Java 8 or newer
Find it here: OpenJDK 11

Networking
The host must be allowed to make connections to Socrata on port 443

SSL
If you have special SSL and/or Self-Signed Certificates configured, they must be added to the Java trust store. For more information, please see: http://www.thesqlreport.com/?p=576

User Permissions
Sudo (root) or Administrator access is required to configure the service

Set Up Instructions

STEP 1: Create an Agent

Start the agent and run it as a service

  1. From your Socrata site click the “Provision Agent” button on either the:
    1. Admin/Gateway page ({Your_Domain}/admin/gateway) OR
    2. When you're choosing your data source while creating or editing a dataset
  2. Follow the agent naming and download process.
  3. Place the downloaded folder in a directory on the server or computer you are connecting to Socrata (if it’s not there already). Note or copy this folder path. You’ll need it when you set up a plugin later.
  4. Unzip the downloaded file.
  5. Run the agent as a service.
    1. In the downloaded folder, open the macOS folder.
    2. Double click on the “setup” file.
    3. This will open the Terminal, set up the agent to run as a service, and complete the setup.
      Note: You can use this process to manually restart the agent.
  6. Check the status of your agent to ensure the set up was successful. A successfully connected agent is needed before you can move on to step 2 of the Gateway set up — adding and configuring a plugin.

On your Socrata site you can check the agent status in the following places:

  • In the “Provision Agent” set up stepper (On the “Set up instructions” page there is an “Am I connected?” widget. Clicking “refresh” will check your connection.
  • On the Admin/Gateway page ({Your_Domain}/admin/gateway), it will appear in the table
  • When you're choosing your data source while creating or editing a dataset it will appear in the list as “Connected”

Stopping/deleting the agent

Important: All plugins associated with this agent will also stop and any schedules associated with datasets created under this agent will stop.

Locally:

  1. Navigate to the folder where the downloaded agent jar file resides.
  2. In the macOS folder, double click the "stop" bash file.


On Socrata:

Note: This does not delete the service from your machine. It only deletes it from appearing on Socrata.

  1. Navigate to {Your_Domain}/admin/gateway
  2. Choose "Delete agent" from the "Actions" menu.

Re-starting the agent

In the macOS folder, double click the “setup” bash file.

Check the status of the agent on your computer or server

  1. Open the terminal on your computer or server.
  2. In the terminal enter:
     launchctl list | grep socrata

This command will list out all of the information on services running on your system. It will list the (PID) process id, status and service label for each service. The “grep” command will filter the list of services to display only those services that include “socrata” in the name.

A sample output will display:

1550 0 com.socrata.Gateway_SQL_Agent

If there are no results returned or no PID attached to the service then you may need to run the “setup” bash file again.


STEP 2: Add and Configure a Plugin

TIPS:

  • ”PLUGIN_TYPE” is a type from a list you’ll be presented upon set up.
  • “PLUGIN_NAME” is a name you select to identify this plugin on Socrata.
  • Configuration for the plugin type and plugin name are case sensitive. Please ensure you’re using the case presented at set up.
  • You can add as many plugins as you like to a single agent, including multiple plugins of the same type.

Option 1: Start from the download folder

  1. Double click the "configure" bash script, follow the prompted instructions.
  2. When the plugin is run it will display a window on your server asking for plugin-specific configuration and credentials (if needed). This information will not live on Socrata.
  3. Fill out the configuration information and click “OK”. Return to Socrata and your plugin will then be ready to use!


Option 2: Start from the Socrata site

  1. Click "Add Plugin" either
    1. On the Admin/Gateway page ({Your_Domain}/admin/gateway)
    2. When you're choosing your data source while creating or editing a dataset
  2. Choose your plugin.
  3. Name your plugin.
    1. Naming tip: Who is responsible + Data source description + Data source type
    2. Example: Finance_Risk_CSV
    3. Non alphanumeric characters will be converted to underscores
  4. Open the terminal on your computer or server and navigate to the directory where the downloaded agent jar file resides.
  5. Copy and paste the plugin command into the command prompt/terminal.
  6. Run the command by hitting enter or return. This will download the plugin from Socrata, verify it, and run it on your server.
    Tip: If you get an error, try changing directories.
  7. When the plugin is run it will display a window on your server asking for plugin-specific configuration and credentials (if needed). This information will not live on Socrata.
  8. Fill out the configuration information and click “OK”. Return to Socrata and your plugin will then be ready to use!


Reconfigure a plugin

  1. From the download folder double click the "configure" bash script.
  2. It will ask you to enter the plugin. Choose the TYPE of plugin you want to reconfigure (Note: It’s case sensitive). Press enter [ENTER].
  3. It will ask you to name your plugin. Type in the name of the existing plugin you want to reconfigure (Note: It’s case sensitive). Press enter [ENTER].
  4. When the plugin is run it will display a window on your server asking for plugin-specific configuration and credentials (if needed). This information will not live on Socrata.
  5. Fill out the configuration information and click “OK”. Return to Socrata and your reconfigured plugin will then be ready to use!


Removing a plugin

Important: All schedules associated with the dataset(s) created under this plugin will break when you remove the plugin.

  1. Open the terminal on your computer or server and navigate to the directory where the downloaded agent jar file resides.
  2. In the terminal enter:
     java -jar socrata-ingress-agent.jar --delete-plugin PLUGIN_TYPE:PLUGIN_NAME’

    Example: java -jar socrata-ingress-agent.jar --delete-plugin csv:Finance_Risk_CSV
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.