MSSQL Advanced Settings

For users who have some experience working with their data in Panoply, there are a number of items that can be customized for this data source.

1. Destination Schema: This is the name of the target schema to save the data. The default schema is Public. This cannot be changed once a source had been collected.
2. Destination:
   • The default table destination is sqlserver_{__schemaname}_{__tablename}.
   • To define a different destination table, enter that in this field.
   • To send the data into separate tables, the user must, at minimum, also include the variable {__tablename} along with the desired prefix. for example, if you enter the destination mydata_{__tablename}, the resulting table for an MSSQL table named customers would be mydata_customers.
3. Primary Key: The Primary Key is the field or combination of fields that Panoply will use as the deduplication key when collecting data. Panoply sets the primary key depending on the scenario identified in the following table. To learn more about primary keys in general, see Primary Keys

4. Enable CDC: By default, Panoply fetches all of your MSSQL data on each run. If you want to utilize the MSSQL CDC, check this checkbox.
   Once checked, only tables that have CDC enabled in MSSQL will be available for selection.
   Collecting data using CDC will enable Panoply to automatically identify new and updated records in your MSSQL table and will extract only them.

6. Incremental Key: By default, Panoply fetches all of your MSSQL data on each run. If you only want to collect some of your data, enter a column name to use as your incremental key. The column must be logically incremental. Panoply will keep track of the maximum value reached during the previous run and will start there on the next run.

• Incremental Key configurations
  • If no Incremental Key is configured by the user, by default, Panoply collects all the MSSQL data on each run for the MSSQL tables or views selected.
  • If the Incremental Key is configured by column name, but not the column value, Panoply collects all data, and then automatically configures the column value at the end of a successful run.
  • If the Incremental Key is configured by column name and the column value (manually or automatically), then on the first collection, Panoply will use that value as the place to begin the collection.
    • The value is updated at the end of a successful collection to the last value collected.
    • In future collections, the new value is used as the starting value. So in future collections Panoply looks for data where the IK value is greater than where the collection ended.
• When an Incremental Key is configured, Panoply will look for that key in each of the selected tables and views. If the table or view does not have the column indicated as the Incremental Key, it must be collected as a separate instance of the data source.
• A table or view may have some records that have a ‘null’ value for the incremental key, or they may not capture the incremental key at all. In these situations Panoply omits these records instead of failing the entire data source.

7. Exclude: The Exclude option allows you to exclude certain data, such as names, addresses, or other personally identifiable information. Enter the column names of the data to exclude.
8. Parse String: If the data to be collected contains JSON, include the JSON text attributes to be parsed.
9. Truncate: Truncate deletes all the current data stored in the destination tables, but not the tables themselves. Afterwards Panoply will recollect all the available data for this data source.
10. Click Save Changes and then click Collect.
    • The data source appears grayed out while the collection runs.
    • You may add additional data sources while this collection runs.
    • You can monitor this collection from the Jobs page or the Data Sources page.
    • After a successful collection, navigate to the Tables page to review the data results.