BigCommerce Select Configuration

Version 21.0.7996


BigCommerce Select Configuration

Version 21.0.7996


The Select action retrieves data from BigCommerce and brings it into ArcESB.

Tables and Columns

If you choose Select for the BigCommerce connector, you must select a target table (or tables) from BigCommerce. Click the + Add button above the Tables pane.

Add Table Button

A modal appears and lists all available tables. Select the desired table and click + Add.

Table List Modal

The chosen table appears under the Tables pane, and the columns in the table appear under the Columns pane. The connector automatically detects values that have special relevance (e.g. the primary key, foreign keys, etc) and labels them accordingly.

Table Column List

By default, all of the columns are selected for inclusion in the action for the BigCommerce connector. You can exclude individual columns by un-checking them.

Note: You can select more tables by clicking + Add and repeating this process. See Child Tables for more information.

Filters

After selecting a table, you can optionally use the Filter pane to filter the data that the connector selects. The connector translates your filter rules into query syntax, and the syntax appears in the Query pane at the bottom of the connector configuration page.

Note: The filter feature is optional, and you do not have to apply a filter to your data if it does not suit your use case.

Creating a Filter Rule

To create a filter rule, follow these steps:

  1. Click Add rule.
  2. In the drop-down list for the new rule, choose the column that you want to filter.
  3. Two new fields appear. In the new drop-down list, choose the filtering condition.
    • The available filtering conditions depend on the data type for the column you select. For example, a long data type has the condition Greater Than, whereas a string data type does not.
  4. If your chosen filtering condition requires a value, enter that value in the blank value field. If your chosen filtering condition does not require a value (for example, if you choose Is Null), the value field disappears.
  5. When your filter rule is complete, its background changes from red to white.

The image below shows an example of a filter rule on a column named Author. With this filter rule in place, the connector only selects values in the Author column that contain the value Smith.

Filter Groups

You can apply multiple filter rules to your connector by clicking Add rule and creating more rules. Filter rules are separated by groups, and all filters belong to the same group by default. You can create multiple groups to separate filter rules by clicking Add group.

Each filter rule within a group interacts with one another based on the options you select at the top of the group:

  • You can check the NOT box to invert the filter conditions. For example, in the Author filter shown above, checking the NOT box instructs the connector to select Author values that do not contain the value Smith.
  • Select either AND or OR to determine the group logic for multiple filters.
    • If you select AND, every filter rule within the group must be true for the filter conditions to be met.
    • If you select OR, at least one filter rule within the group must be true for the filter conditions to be met. Multiple filter rules can be met, and the results will be the same as if only one were met.

Filter groups have simple parent/child relationships. Each filter rule and filter group that belongs to a parent group exists as a single entity for the filter logic. For example, the screenshot below shows multiple filter groups.

In this example, the parent group is using OR logic. This means that if any of the following statements is true, the filter condition is met:

  • The Author column contains the value Smith
  • The Id column equals 1 or 2
  • The Title column contains the value Kitchen and the UpdatedAt column is greater than 400

If this filter condition is met, the connector Selects the data that meets the condition and passes it down the flow.

Example ArcESB Flow

After you choose the tables and columns for the Select-configured BigCommerce connector, place the connector at the beginning of an ArcESB flow. The screenshot below depicts an example flow with a BigCommerce Select connector, an XML Map connector, and a CSV connector at the end:

Data in this example flow passes through these steps:

  1. The BigCommerce_Select connector pulls data from a BigCommerce connection.

  2. This data passes to the XML_Map connector as the Source File, which maps to the Source tree.

  3. Data from the CSV1 connector passes to the XML_Map connector as the Destination File, which maps to the Destination tree.

  4. The XML_Map connector attempts to automatically map Source elements to Destination elements with the same name. You can manually change these and fill in blank mappings by dragging elements from Source to Destination.

    XML Element Mapping

  5. The file from CSV1 that has been modified with data from BigCommerce_Select then passes down the flow from CSV1.

XML Aggregate Columns

Most BigCommerce database columns function as single elements for mapping. The examples above under Example ArcESB Flow demonstrate single-element columns.

Some columns appear in the BigCommerce connector with the XML aggregate icon </> next to their names. In contrast to a standard single-element column, an aggregate column contains a collection of entities. The following screenshot shows an aggregate column called OrderItems in an Select-configured BigCommerce connector:

Aggregate Row Icon

In an XML Map connector, the full structure of the aggregate column expands to display all of its contents. The following screenshot shows the OrderItems column expanded:

Expanded Aggregate Map

Each element of an aggregate column can be mapped the same way as single-element columns.