Skip to main content

Whitelist feature

Get an overview of setting up and using the Whitelist feature in Productsup.

Introduction

Whitelists help you manage your data. They allow or protect specific terms from data modifications that occur as part of your data flow. Combining Whitelist rule boxes with other rule boxes lets you simultaneously modify particular elements in your product data while excluding others.

Note

Before using a Whitelist rule box, you must set up a Standard or Dynamic Inclusion/Exclusion list.

Set up the Standard Inclusion/Exclusion list

  1. Go to Lists from your site's main menu and select ADD LIST.

    site_lists_page.png
  2. Next, choose Standard Inclusion/Exclusion and select Continue.

    new_list_types_stan_incl.png
  3. In Name, give your Inclusion/Exclusion List a custom name to help you identify it. You can later edit the custom name.

  4. (Optional) Toggle on the Share list button and select one of the following:

    1. Account level - Share this list with all sites across all projects under this account.

    2. Project level - Share this list with all sites under this project.

    Note

    If you share the list at the account or project level, the platform updates the list during an import from the original site where you created the list.

  5. Select Add.

Add values to the Standard Inclusion/Exclusion list

After creating your Standard Inclusion/Exclusion list, see the following to add values:

  1. Within your newly-created list, enter a value you want to use for excluding a product in Search. Select Add to save your value. Repeat this step, as necessary, to continue adding values to your Standard Inclusion/Exclusion list.

  2. If you make changes to the source file, perform an import to update the list.

    standard_inclusion.png

Set up a Dynamic Inclusion/Exclusion list

  1. Go to Lists from your site's main menu and select ADD LIST.

    site_lists_page.png
  2. Next, choose Dynamic Inclusion/Exclusion and select Continue.

    new_list_types_dyna_incl.png
  3. In Name, give your Inclusion/Exclusion List a custom name to help you identify it. You can later edit the custom name.

Option 1 - Upload a list source file in CSV format

  1. Create a CSV file containing a header since the platform skips the first row. Use a structure similar to the following:

    csv_file_structure.png
  2. Next, move your CSV list file to the Drag and drop your CSV file field or select Browse to upload the file.

  3. Select Add.

  4. A message appears stating that the download is in progress.

  5. Once your CSV file completes uploading, you can see your list of defined values under the column Term.

  6. If you make changes to the source file, perform an import to update the list.

  7. Select Add.

  8. A message appears stating that the download is in progress.

  9. Once your CSV file completes uploading, you can see your list of defined values under the column Term.

  10. If you make changes to the source file, perform an import to update the list.

Option 2 - Upload a list source file via a URL

  1. Enter a source file URL in Source URL. To add a Google Sheets list source file, see Add a list source file via Google Sheets and return to this section, step 2.

  2. As necessary, enter credentials in Username and Password to access the source file.

  3. In Delimiter, choose the delimiter. The platform selects the tab (\t) as the default.

  4. (Optional) In Encoding, declare the encoding if it is not UTF-8.

  5. (Optional) In Enclosure, choose your desired enclosure, for example, ( ‘’ or ““ or || ).

  6. Toggle on Reset list on every import to remove all data whenever there is an import. When toggled on, it also leaves all configurations unchanged during an import.

  7. (Optional) Toggle on the Share list button and select one of the following:

    1. Account level - Share this list with all sites across all projects under this account.

    2. Project level - Share this list with all sites under this project.

    Note

    If you share the list at the account or project level, the platform updates the list during an import from the original site where you created the list.

  8. Select Add.

  9. A message appears stating that the download is in progress.

  10. Once your CSV file completes uploading, you can see your list of defined values under the column Term.

  11. If you make changes to the source file, perform an import to update the list.

    add_dyna_incl.png

Add a list source file via Google Sheets

To add a list file in Google Sheets, you must first modify the URL that leads to your list.

  1. In the URL, replace the text edit with:

    export?format=csv

    If gid exists in the spreadsheet URL, replace it with:

    &gid

    The modified link should look similar to the following example:

    https://docs.google.com/spreadsheets/d/{key}/export?format=csv#&gid={gid}

    • In this example, {key} and {gid} are placeholders.

    Note

    To import a list from a specific sheet in your Google Sheets file, replace #gid with &gid in the file's URL. The URL should be similar to this template: https://docs.google.com/spreadsheets/d/{key}/export?format=csv&gid={gid}.

  2. Make sure the Google Sheets URL is accessible to everyone. Read-only is sufficient. Otherwise, the Productsup platform can't download the Google Sheets file.

    • Test the URL by opening it in a browser. If you set it up correctly, once you hit enter, a CSV download begins.

  3. Now continue with the setup in step 2.

Add a Whitelist rule box

After creating an Inclusion/Exclusion list, you can add Whitelist rule boxes to your data flow. To create a Whitelist rule box:

  1. Go to the site that contains the data you want to set up using the Whitelist rule box. Select Data View from the site's sidebar menu.

  2. Select the channel containing the attribute you want to assign a Whitelist rule box.

    This example uses an attribute from Intermediate, but you can also assign Whitelist rule boxes for attributes in individual export channels.

    dataview-intermediate_selection.png
  3. Select the Edit button for the attribute you want to assign a Whitelist rule box. For example, gtin.

  4. Filter for whitelist and drag the Whitelist rule box to the stage in your data flow where it should apply. This example applies the rule to the Source Column, meaning it applies to data passing from Import to Intermediate.

    dataview-boxrules_filter.png
  5. Select the Inclusion/Exclusion list containing the terms you want to whitelist and set the priority.

    dataview-boxrules_set.png

    Tip

    Setting a priority prevents conflicts between rule boxes. Terms in the whitelist with the highest priority are unaffected by other rule boxes, including Whitelist rule boxes with a lower priority, in the event of a conflict.

  6. Select Save.