dump

Save a copy of the data extract into a given file format.

This guide explains how to configure the dump instruction. To learn about another instruction, go back to the Available custom script instructions overview.

Introduction

Use the dump instruction to save a copy of the data extract.

Use regular expressions and placeholders to create dynamic filenames, and select the file format in which the data extract is saved.

Creating a custom script enrichment using the dump instruction

To create and configure a custom script using the dump instruction, follow these steps:

  1. Create a custom script enrichment.

  2. In the Instructions step, select the dump instruction.

  3. To configure the custom script instruction, fill in the following fields. Required fields are marked with an asterisk (*).

Filename

Enter the filename for the saved data extract file. Include the file format in the title. For example, to save the data extract into a CSV file, ensure the filename ends in .csv. Use placeholders, such as %Y-%m-%d, to include the creation date in the filename.

Fileformat

Enter the format for the file in which the data extract is saved. Currently, the allowed file formats are CSV and JSON.

Workspace

Enter the name of the workspace that contains the data extracts to be saved. Leave this field empty to use the workspace in which the enrichment is applied.

Tags

Enter keywords to determine which data extracts to include in the enrichment.

Subtable

Enter the name for a subtable that you want to use within this custom script.

A subtable is a temporary table that only exists for this custom script. You can apply additional instructions within the same custom script to the subtable. However, the subtable cannot be used in any other custom scripts.

If a subtable does not exist for the current custom script, the enrichment is applied to the data extract, and the enriched data is output into the subtable. If the subtable already exists for the custom script, the subtable is used as the input for the enrichment and optionally as the output.