NGPVAN: Import Saved Lists

The NGPVAN: Import Saved Lists custom script template allows users to import the VAN IDs from a saved list in NGP or VAN to a Platform table. Additionally, you can import list metadata (list name, list count etc) for a single list_id or a folder of lists. You can use it for both NGP and VAN lists by inputting the respective credential (NGP or VAN) in the NGPVAN Credential parameter. (Click here for credential creation info).

You can create your script using this link, or in Platform you can navigate to Code → Scripts → More Script Templates and searching for “NGPVAN Import Saved Lists” or “36552”.  If you are not shared on this template, please email support@civisanalytics.com.

Parameters

• Database (required): Name of the destination database for imported data.
• Database Credential (required): A valid database credential for the cluster.
• Import Mode (required): One of ‘Saved List Import’ or ‘List Metadata Import’. List import returns a table of van_ids saved in the specified list. List metadata returns list name, description, door and head counts.
• Output Table (required): Name of table to store NGPVAN response.
• Output Table Setting (required): Drop or append existing rows in output table
• NGPVAN List ID: Unique ID of NGPVAN list or list metadata to import (Civis API NGP or VAN user must be shared on folder containing the list in NGP or VAN). One of List ID or Folder ID is required.
• NGPVAN Folder ID: For use in list metadata import mode only. If a folder ID is provided instead of a list ID, metadata for all lists saved in the folder will be imported.
• Max door count: For use in list metadata import mode only. If indicated, retrieve only Saved Lists containing this number of doors or fewer.
• Max people count: For use in list metadata import mode only. If indicated, retrieve only Saved Lists containing this number of people or fewer.
• NGP VAN Credential (required): A custom Civis credential with a username and password for NGP or VAN.
• Database Mode (required): NGPVAN database

Output Table Fields

List import mode

List metadata import mode