Working With Custom Exports

Creating a custom export allows you to control the following report elements:

  • Columns included
  • Column labels
  • Sorting
  • Filtering

You also have the option to include custom exports in Study Home.

Creating a Custom Export

  1. In Studio, access the study and select Exports.
  2. Add a new blank export or create one using an existing export’s specifications:
    1. Add New: In the Custom Exports tab, select Add Export > Create New.
    2. Create from Existing: You can use export specifications from any study as long as you have access to Studio to download its specifications.
      1. Access the export you want to use as your template, and select Export Specification. A .JSON specification file is downloaded to your device.
      2. Go back to the Exports tab and select Add Export > Create from Existing.
      3. Add the specification file you downloaded in Step 1, and select Continue. The specifications, filters, and sorting from your specification file are selected.
  3. Enter an Export Name, Description, and Filename.
  4. If you do not want the export to be Available in Study Home, turn the toggle off.
  5. Add Columns
    1. Under Specification, select Add Columns. A pane opens on the side of the page.
    2. Select the add icon next to each column you want to be included in the report.
    3. To change the name of the column heading, add the text you want to be displayed in the Column Label box. If you do not add a label, the value in the Column Name column will be used in your report.
      1. To use the domain in the column heading, add domain token: {{domain}}. For example, {{domain}}TEST. When you use a domain in a column title, you must also include the token in the filename.
    4. To rearrange columns after you have added them, select the grid icon on the side of the row and drag the column to the order you want it. You can also select the Remove Column icon .
  6. (Optional) Add Filters
    1. To add a filter, expand the Filter section and select Add Filter.
    2. Select the column box. A pane that includes all columns which can be filtered on the side of the page.
    3. Select the add icon next to the column you want to filter. You can also select the Remove Sort icon to remove a filter from your report.
    4. Select a Type to indicate how the column filter should restrict the value.
    5. Enter a Value to indicate what text the column and type should be looking for.
    6. Select the Save button . Your filter selections are saved.
    7. Repeat Steps 6a through 6f for all filters you want to add.
  7. (Optional) Add Sorting
    1. To add sorting, select Add Sort. A pane that includes all columns which can be sorted on the side of the page.
    2. Select the add icon next to the columns you want to sort by.
    3. To change it to sort by ascending or descending, select the button next to the column name, and select the sort direction you want.
    4. To rearrange columns after you have added them, select the grid icon on the side of the row and drag the column to the sort order you want it. You can also select the Remove Sort icon .
  8. Select Preview Export. A preview opens in a new tab.
  9. Make any adjustments needed, and when the preview looks correct, select Publish.

Editing a Custom Export

  1. In Studio, find the custom export you want to edit, and select the Edit Custom Export icon .
  2. Make any necessary changes to the export.
  3. Select Publish. Your changes are saved.

Deleting a Custom Export

You cannot delete a published custom export.

If you do not want users running a custom export you created, we recommend that you take the following steps:

  1. Remove it from all export jobs.
  2. Turn off the Available in Study Home toggle.
  3. Change the name of the export to DO NOT USE or something similar to discourage users from using it in an export.

Additional Resources