# Magento (v1)

Information note **Magento extraction is supported by Stitch**   
This integration is powered by [Singer's](https://www.singer.io/) Magento tap and certified by Stitch. [Check out and contribute to the repo on GitHub](https://github.com/singer-io/tap-mysql).  
  
For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport).

## Magento feature snapshot

A high-level look at Stitch's Magento (v1) integration, including release status, useful links, and the features supported in Stitch.

| **STITCH** |  |  |  |
| --- | --- | --- | --- |
| **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Deprecated on November 8, 2021 | **Supported by**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | [Stitch](https://community.qlik.com/t5/Support/ct-p/qlikSupport) |
| **Stitch plan**<br><br>the Info icon<br><br>The type of Stitch plan required to use the integration. | Standard | **Supported versions**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | n/a |
| **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**<br><br>the Info icon<br><br>Indicates if the integration is available as a source in Stitch Connect. | the Remove icon<br><br>This version of the integration isn't available via the API.<br><br><br>Not available | **Singer GitHub repository** | [singer-io/tap-mysql](https://github.com/singer-io/tap-mysql) |
| **CONNECTION METHODS** |  |  |  |
| **SSH connections**<br><br>the Info icon<br><br>Indicates if SSH tunnels are supported for connecting this database to Stitch. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **SSL connections**<br><br>the Info icon<br><br>Indicates if SSL connections are supported for connecting this database to Stitch. | the Remove icon<br><br>This feature is not supported for this version of the integration.<br><br><br>Unsupported |
| **REPLICATION SETTINGS** |  |  |  |
| **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **Table-level reset**<br><br>the Info icon<br><br>Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**<br><br>the Info icon<br><br>Indicates if Replication Methods can be defined by you for tables in the integration. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **REPLICATION METHODS** |  |  |  |
| **[Log-based Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/log-based-incremental)**<br><br>the Info icon<br><br>Log-based Incremental Replication is a replication method in which Stitch identifies modifications to records - including inserts, updates, and deletes - using a database's binary log files. | the Remove icon<br><br>This feature is not supported for this version of the integration.<br><br><br>Unsupported | **[Key-based Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/key-based-incremental)**<br><br>the Info icon<br><br>Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **[Full Table Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/full-table)**<br><br>the Info icon<br><br>Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |  |  |
| **DATA SELECTION** |  |  |  |
| **Table selection**<br><br>the Info icon<br><br>The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **Column selection**<br><br>the Info icon<br><br>The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **[View replication](https://help.qlik.com/en-US/stitch/replication/replicating-database-views)**<br><br>the Info icon<br><br>Indicates if Stitch supports replicating views from this database integration. | the Remove icon<br><br>This feature is not supported for this version of the integration.<br><br><br>Unsupported | **Select all**<br><br>the Info icon<br><br>Indicates if the integration supports selecting all available tables and columns. | the Warning 2 icon<br><br>Log-based Incremental Replication must be enabled and set as the default Replication Method to use the Select All feature.<br><br><br>Supported, with prerequisites |
| **TRANSPARENCY** |  |  |  |
| **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**<br><br>the Info icon<br><br>Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**<br><br>the Info icon<br><br>Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |

## Connecting Magento

### Magento setup requirements

To set up Magento in Stitch, you need:

* **Permissions in Magento that allow you to create/manage users.** This is required to create the Stitch database user.

### Step 1: Configure database connection settings

In this step, you’ll configure the database server to allow traffic from Stitch to access it. There are two ways to connect your database:

* **A direct connection** will work if your database is publicly accessible.
* **An SSH tunnel** is required if your database isn’t publicly accessible. This method uses a publicly accessible instance, or an SSH server, to act as an intermediary between Stitch and your database. The SSH server will forward traffic from Stitch through an encrypted tunnel to the private database.

Click the option you’re using below and follow the instructions.

I'm using an SSH tunnel to connect.

1. Follow the steps in the [Setting up an SSH Tunnel for a database connection guide](https://help.qlik.com/en-US/stitch/security/data-encryption/setting-up-ssh-tunnel-for-database-connection) to set up an SSH tunnel for Magento.
2. Complete the steps in this guide after the SSH setup is complete.

#### I'm using a direct connection.

For the connection to be successful, you’ll need to configure your firewall to allow access from our IP addresses.

The IP addresses you’ll whitelist depend on the [**Data pipeline region** your account is in](https://help.qlik.com/en-US/stitch/security/supported-data-pipeline-regions).

1. [Sign into your Stitch account](https://app.stitchdata.com/), if you haven’t already.

2. Click **User menu (your icon) &gt; Edit User Settings** and locate the **Data pipeline region** section to verify your account’s region.

3. Locate the list of IP addresses for your region:

   * [North America region IP addresses](https://help.qlik.com/en-US/stitch/security/stitch-ip-addresses#north-america-ip-addresses)

   * [Europe region IP addresses](https://help.qlik.com/en-US/stitch/security/stitch-ip-addresses#europe-ip-addresses)

4. Whitelist the appropriate IP addresses.

### Step 2: Create a Stitch database user

Information note You must have the `CREATE USER` and `GRANT OPTION` privileges to complete this step.

Next, you’ll create a dedicated database user for Stitch. This will ensure Stitch is visible in any logs or audits, and allow you to maintain your privilege hierarchy.

* Instructions
* Privileges list

1. Log into your database as a user with `CREATE USER` and `GRANT OPTION` privileges.

2. Run the following command to create the Stitch database user:

   ```
   CREATE USER '<stitch_username>'@'localhost' IDENTIFIED BY '<password>';
   ```

   Replace `<password>` with a secure password. If using SSH, this can be different than the SSH password.

3. Grant the Stitch user `SELECT` privileges by running this command for every table you want to replicate:

   ```
   GRANT SELECT ON '<database_name>'.'<table_name>' to '<stitch_username>'@'localhost';
   ```

   Limiting access to only the tables you want to replicate ensures that the integration can complete discovery (a structure sync) in a timely manner. If you encounter issues in Stitch where tables aren’t displaying, try limiting the Stitch database user’s table access.

See the **Privileges list** tab for an explanation of why these permissions are required by Stitch.

In the table below are the database user privileges Stitch requires to connect to and replicate data from a Magento database.

| **Privilege name** | **Reason for requirement** |
| --- | --- |
| [SELECT](https://dev.mysql.com/doc/refman/5.5/en/privileges-provided.html#priv_select) | Required to select rows from tables in a database. |

### Step 3: Connect Stitch

In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.

* [Step 3.1: Define the database connection details](https://help.qlik.com/en-US/stitch/integrations/databases/magento#define-connection-details)

* [Step 3.2: Define the SSH connection details](https://help.qlik.com/en-US/stitch/integrations/databases/magento#ssh-connection-details)

* [Step 3.3: Create a replication schedule](https://help.qlik.com/en-US/stitch/integrations/databases/magento#create-replication-schedule)

* [Step 3.4: Save the integration](https://help.qlik.com/en-US/stitch/integrations/databases/magento#save-integration)

#### Step 3.1: Define the database connection details

1. If you aren’t signed into your Stitch account, [sign in now](https://app.stitchdata.com/).

2. On the Stitch Dashboard page, click the **Add Integration** button.

3. Locate and click the **MySQL** icon.

4. Fill in the fields as follows:

   * **Integration Name**: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

     For example, the name “Stitch Magento” would create a schema called `stitch_magento` in the destination. **Note:** The schema name cannot be changed after the integration is saved.

   * **Host (Endpoint)**: Enter the host address (endpoint) used by the Magento instance. For example: This could be a network address such as `192.68.0.1`, or a server endpoint like `dbname.hosting-provider.com`.

   * **Port**: Enter the port used by the Magento instance. The default is `3306`.

   * **Username**: Enter the Stitch Magento database user’s username.

   * **Password**: Enter the password for the Stitch Magento database user.

#### Step 3.2: Define the SSH connection details

Information note **Note**: Skip this step if you’re not using SSH to connect to Stitch.

If you’re using an SSH tunnel to connect your Magento database to Stitch, you’ll also need to define the SSH settings. Refer to the [Setting up an SSH Tunnel for a database connection guide](https://help.qlik.com/en-US/stitch/security/data-encryption/setting-up-ssh-tunnel-for-database-connection) for assistance with completing these fields.

1. Click the **SSH Tunnel** checkbox.

2. Fill in the fields as follows:

   * **SSH Host**: Enter the public IP address or hostname of the server Stitch will SSH into.

   * **SSH Port**: Enter the SSH port on your server. (`22` by default)

   * **SSH User**: Enter the Stitch Linux (SSH) user’s username.

#### Step 3.3: Create a replication schedule

Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.

In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Magento integrations support the following replication scheduling methods:

* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)

* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)

* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage.

#### Step 3.4: Save the integration

When finished, click **Check and Save**.

Stitch will perform a connection test to the Magento database; if successful, a *Success!* message will display at the top of the screen. **Note**: This test may take a few minutes to complete.

### Step 4: Select data to replicate

Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements).

The last step is to select the tables and columns you want to replicate. [](https://help.qlik.com/en-US/stitch/integrations/databases/magento#schema)

**Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts.

* Selection options
* Individual tables and columns
* All tables and columns

For Magento integrations, you can select:

1. **Individual tables and columns**

2. **All tables and columns**

Click the tabs to view instructions for each selection method.

1. In the Integration Details page, click the **Tables to Replicate** tab.

2. Locate a table you want to replicate.

3. Click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate.

4. After you set a table to replicate, a page with the table’s columns will display. De-select columns if needed.

5. Next, you’ll define the table’s Replication Method. Click the **Table Settings** button.

6. In the **Table Settings** page:

   1. Define the table’s **Replication Method**.

   2. If using [Key-based Incremental Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/key-based-incremental), select a [Replication Key](https://help.qlik.com/en-US/stitch/replication/replication-keys).

   3. When finished, click **Update Settings**.

7. Repeat this process for every table you want to replicate.

8. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections.

Information note

**Important:** Before using this feature, note that:

1. Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections.

2. Log-based Incremental Replication must be enabled and set as the default Replication Method to use the Select All feature.

Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature.

1. Click into the integration from the Stitch Dashboard page.

2. Click the **Tables to Replicate** tab.

3. Navigate to the table level, selecting any databases and/or schemas that contain tables you want to replicate.

4. In the list of tables, click the box next to the **Table Names** column.

5. In the menu that displays, click **Track AllTables and Fields (Except Views)**:

   ![The Track AllTables and Fields (Except Views) menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track AllTables and Fields (Except Views) menu in the Tables to Replicate tabThe Track AllTables and Fields (Except Views) menu in the Tables to Replicate tab

6. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections.

### Initial and historical replication jobs

After you finish setting up Magento, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.**

Information note

**Initial replication jobs with Anchor Scheduling**

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information.

#### Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage.