Import from Cvent
The “Import from Cvent” script template (template ID 321555) imports data from the Cvent REST API.
Parameters
- Cvent API Key (required): A platform custom credential, with the Cvent API client ID (username) and client secret (password). Your client ID and secret are available from an application set up in the Cvent Developer Portal. Note that your application must have the relevant scopes selected for the Cvent objects you would like to import. See here for more information.
-
Cvent Object (required): The Cvent object to import.
- Attendees
- This option uses the list attendees endpoint.
- Scope required: event/attendees:read
- Events
- This option uses the list events endpoint.
- Scope required: event/events:read
- Attendees
- Days (optional): The number of days (as an integer) of data to import. If not specified, all data will be imported. If specified, only data modified in the last N days will be imported, as determined by the “lastModified” column. For incremental syncs in an automated pipeline, combine this parameter with the “existing table rows = upsert” option below, e.g., “existing table rows = upsert” and “days = 7” if your pipeline is scheduled to run weekly.
- Start Date (optional): The start date (inclusive) for data to import, in YYYY-MM-DD format. If specified, only data modified on or after this date will be imported. This parameter can optionally be used in conjunction with "Days" or "End Date".
- End Date (optional): The end date (inclusive) for data to import, in YYYY-MM-DD format. If specified, only data modified on or before this date will be imported. This parameter can optionally be used in conjunction with "Days" or "Start Date".
- 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 (default: Fail). 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.
- Upsert: For upserts, unless otherwise stated for specific Cvent objects listed above, the ID and last modified timestamp columns to be used are 'id' and 'lastModified', respectively. For incremental syncs in an automated pipeline, combine this “upsert” option with the “days” / “start date” / “end date” parameters above, e.g., “existing table rows = upsert” and “days = 7” if your pipeline is scheduled to run weekly.
Comments
0 comments
Please sign in to leave a comment.