Scrub User Guide – BigCommerce

In the following document, we will outline the basic use of the Scrub app for Bigcommerce, as well as its various settings and possibilities.

Process

A process is a collection of filters and rules that are used to globally and systematically edit content on your store.

Create a Process

Step 1

  • Filters
    • Explain what filters are and how they filter out the product.
  • Sort by
    • This will determine by which field will the sorting happen when fetching the products from Bigcommerce: ID, Title, or Modified Date.
  • Direction
    • This will determine the direction of the sorting process, either ascending or descending, be it numerical or alphabetical.
  • Attributes
    • Fetches only the products that either are or aren’t featured and are or aren’t visible. Please note this is a 3-state checkbox component, so if you don’t click on them, the filters won’t be applied, either positively or negatively.
  • Keyword
    • When not empty, filter products by keywords found in the name or SKU fields.
  • Categories
    • When selected, fetches only products belonging to the chosen categories.
  • Brand
    • When selected, fetches only products belonging to the chosen brand.
  • Date Modified
    • When selected, fetches only products whose modified date is greater than the chosen date.
  • ID In
    • This is a comma-separated list of Bigcommerce product IDs. When not empty, fetches only products whose IDs are included in the list.
  • ID Not In
    • This is a comma-separated list of Bigcommerce product IDs. When not empty, fetches only products whose IDs are NOT included in the list.
  • Rules
    • Rules are defined to search for specific instances of content and replace them with another string. They consist of:
  • REGEX
    • This will determine if the search string will be a Regular Expression or just a simple string.
  • Search
    • The content that will be searched.
  • Replace
    • If the content specified in the search is found, it will be replaced by what is inserted in this field.
  • Field
    • In which field the search will take place.
  • Case Sensitive
    • If the search is case sensitive, aka if we should differentiate lowercase and uppercase letters in the search.
  • Search Type
    • The behavior that should consider the search a match for the searched content. They are:
      • Match
      • Contains
      • Starts With
      • Ends With

Step 2

In Step 2 you’ll be able to see all of the instances that were found using the filters and rules defined in the previous step. Here you’ll be able to check what will be replaced in each field and make manual edits before the changes are made on your store. After reviewing, when you’ve decided to move forward with the changes, all you need to do is click “Run Process”, which will take you to the final step on the Process Details page.

Step 3

Here you’ll be able to follow the progress and review what changes were made to your store. You’ll see the pending, failed, and successful changes, as well as what filters and rules were used to make this process. Now all you need to do is wait for the completion of the process.