Import from Blackbaud Luminate Online

The “Import from Blackbaud Luminate Online” script template (template ID 314337) imports data from Blackbaud Luminate Online.

Before using this script template, your Luminate Online 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 Civis compute cluster. The NAT directs outgoing traffic through the IP addresses listed in the next step.
• Allowlist these IP addresses in your Luminate Online admin console (under API settings), so this script template can reach the Luminate Online Server API through your account (reference):
  • 18.207.171.255
  • 34.198.242.0
  • 34.192.122.37
  • 34.237.119.77
  • 35.153.38.203
  • 52.202.119.255
• Generate a Site Administrator API key in the Luminate Online admin console. This is separate from your login username and password.
• Create a dedicated Luminate Online admin user for this integration rather than using a personal account (best practice).

Parameters

• Luminate Online Host (required): The Luminate Online API hostname, e.g., “service.convio.net”. Do not include the protocol (https://).
• Luminate Online Short Name (required): Your organization’s Luminate Online short name (also called the “site short name”), used to construct API URLs.
• Luminate Online API Key (required): A Luminate Online credential whose Password field contains your Site Administrator API key, generated in the Luminate Online admin console.
• Luminate Online Login (required): A Luminate Online credential whose Username field is the API login name and whose Password field is the login password. Best practice is to use a dedicated Luminate Online admin user.
• Luminate Online Object (required): The Luminate Online object to import. Currently implemented options:
  • Constituents
  • Donations
  • Recurring Gifts
• Days (optional): The number of days of data to import. If left blank (and Start Date and End Date are also blank), all data is imported.
• Start Date (optional): The start date (inclusive) for data to import, in YYYY-MM-DD format.
• End Date (optional): The end date (inclusive) for data to import, in YYYY-MM-DD format.
• 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.