Engaging Networks Import

The “Import from Engaging Networks” script template imports data from an export job of the Engaging Networks Services REST API. The parameters of this script template closely follow those available for this export API endpoint, with the exception that the “displayUserDataInTransactionExport” boolean argument is set to be “true”.

Before using this script template, your Engaging Networks account needs to be configured for the following:

• Submit a ticket to Civis support via support@civisanalytics.com to confirm that the Network Address Translator (NAT) is enabled on your compute cluster. The NAT directs outgoing traffic through the IP addresses listed in the next step.
• Allowlist these IP addresses for Civis Platform (reference), so that this script template can successfully interact with the Engaging Networks REST API through your account:
  • 18.207.171.255
  • 34.198.242.0
  • 34.192.122.37
  • 34.237.119.77
  • 35.153.38.203
  • 52.202.119.255
• Set up a query for an export job.
• Set up an export group to define which supporter fields to include in the exported data.

Parameters

• Engaging Networks REST API Credential (required): Username and password for Engaging Networks REST API.
• Query Name (required): The dashboard name of the query to run for this Engaging Networks export.
• Export Format (optional): Corresponds to the "format" parameter in the Engaging Networks REST API for exports. Defaults to “Hybrid”. Other options are “Transaction” and “User data”.
• Apply Custom Reference Names (optional): Whether to apply custom reference names to the exported data. Defaults to false.
• Export Group (required): The name of an "export group" created in the Engaging Networks account that defines which supporter fields should be included in the exported data.
• Export File Type (optional): The file type of the exported data. Defaults to “csv” (reflecting any customization options you have specified through the Data API menu in your user dashboard), while the other option is “standardcsv” (in a standard form common to all Engaging Networks clients).
• Database (required): The Civis Platform database to which to write records.
• Database Credential (required): A valid database credential for the Civis Platform database. To use the credential associated with the logged-in user, choose from the dropdown the credential that has this user’s Civis Platform username.
• Schema and Tablename (required): The schema and table name you would like to import the data into, e.g., schema.table.
• Column Data Type Overrides (optional): A mapping from column names to data types to use instead of the data types from the data source. Each line should be in the form of "column_name: DATA_TYPE" (without quotes), e.g., "foo_bar: VARCHAR". Only provide an entry for columns for which you want to override the data type; do not provide entries for columns that should use the default data type from the data source. This parameter is useful for data type issues that would otherwise cause the import to fail, e.g., use "foobar: VARCHAR" if the data source says "foobar" should be a numeric type but it actually contains non-numeric values.
• Existing Table Exists (optional): The action to take if a table with the requested name already exists. Options are:
  • Append: Records will be appended to the existing table
  • Fail: The sync job fails if the table exists
  • Drop: Removes the entire table including column information.
  • Truncate: Records on the table will be wiped out while maintaining the current columns.