Synchronize customer data with external services

Published April 11, 2022
Modules
Difficulty
Selected Clients
empik logodecathlon logo

If you manage the customers’ data in several places at once, you can use the Synerise Automation module to synchronize it. It’s possible thanks to the HTTP and SFTP integrations that allow you to send data from Synerise to external sources and the other way round.

This use case describes how to prepare an automated workflow that launches every day and sends the updated list of customers with the agreement for email communication from Synerise to an external resource using the SFTP protocol.

One of the challenges addressed in this use case is modifying the value of the customer attribute (a newsletter agreement attribute) so the data structure is consistent.

Prerequisites


  • You must have customers in the Profiles module.
  • You must have a target resource with which you synchronize the data (in this use case, an SFTP server is used).

Process


  1. Create a segmentation of customers whose data you want to send to the external resource.
  2. Prepare data transformation to modify the data to meet the requirements of the external resource data structure.
  3. Prepare a workflow that sends the data of customers from Synerise to the external resource.

Prepare a segmentation


As the first part of the process, create a segmentation of customers who agreed to receive emails. Data of these customers will be sent to the external resource.

  1. Go to Analytics icon Analytics > Segmentation > New segmentation.

  2. As the name of the segmentation, enter Subscribers.

  3. Click Choose filter.

  4. From the dropdown list, select newsletter_agreement.

  5. As the logical operator, select Equal.

  6. In the text field, enter enabled.

  7. Click Save.

    The configuration of the segmentation
    The configuration of the segmentation

Prepare data transformation


In this part of the process, you define the rules of modifying data before sending it to the SFTP server, so the data is consistent. For the purposes of this case, a newsletter_agreement parameter value will be changed from enabled to true. Additionally, we add a parameter which marks data as imported, so this import can be distinguished in the SFTP server.

The data transformation diagram which is the output of this part of the process is used later to automate sending the data.

Prerequisites

You need a sample of data that will be used in data transformation. You can add it in two ways:

  • Prepare a .csv file with a few columns and example values.
    Click here to see an example file

    clientId,email,newsletter_agreement
    111111111,john.doe@synerise.com,enabled
    222222222,kathy.smith@synerise.com,enabled
    333333333,lily.novak@synerise.com,enabled
    444444444,matt.turner@synerise.com,enabled

  • Export several customers from the Profiles module to a .csv file.
    Click here to read the instructions

    1. Go to Profiles.
    2. On the list, select several customers.
    3. At the top of the list, click the Export button.
    4. On the pop-up, enter the name of the export.
    5. Select three attributes: email, clientId, and newsletter_agreement.
    6. Click Apply.
    7. On the pop-up, click Go to Reports.
    8. On the list, find your export.
    9. Next to the export, click the Three dot icon icon.
    10. From the context menu, select Download.
      Result: A .csv file is downloaded.

  1. Go to Automation icon Automation > Data Transformation > Create transformation.
  2. Enter the name of the transformation.
  3. Click Add input.

Add file with sample data

This node allows you to add a data sample. In further steps, you define how the data must be modified. Later, when this transformation is used in the Automation workflow, the system uses the rules created with the sample data as a pattern for modifying actual data.

  1. On the pop-up, click Add example.
  2. Upload the file with the sample data.
  3. Click Generate.
The configuration of the Data input node
The configuration of the Data input node

Edit the newsletter_agreement value

This node allows you to replace the enabled value of the newsletter_agreement attribute with true.

  1. On the canvas, click the right mouse button.
  2. From the dropdown list, select Edit values.
  3. Click the Edit values node.
  4. In the configuration of the node:
    1. Click Add rule.
    2. Click Add column.
    3. Select the newsletter_agreement column.
    4. Under Edit values by, from the dropdown list, select Replacing.
    5. In the left dropdown, leave the Value option at default.
    6. In the text field, enter true.
    7. Confirm by clicking Apply.
The configuration of the Edit values node
The configuration of the Edit values node

Add the parameter which marks data as imported

This node allows you to add a column to the data - in result, you can easily identify the import in the external source (the SFTP server).

  1. On the canvas, click the right mouse button.

  2. From the dropdown list, select Add column.

  3. In the configuration of the node:

    1. In the Add column field, enter importType.
    2. In the dropdown, leave the Defined value.
    3. In the text field, enter synerise_subscribers.
    4. Confirm by clicking Apply.
    The configuration of the Add column node
    The configuration of the Add column node

Add the finishing node

This node lets you preview the output of the modifications to the sample data.

  1. On the canvas, click the right mouse button.

  2. From the dropdown list, select Data output.

    The preview of modifications to the file
    The preview of modifications to the file
  3. In the upper right corner, click Save and publish.

    The diagram of data transformation
    The diagram of data transformation

Prepare a workflow


As the final part of the process, create a workflow which sends the customers’ data every day to the external source using the SFTP protocol.

  1. Go to Automation icon Automation > Workflows > New workflow.
  2. Enter the name of the workflow.

Define the launch date

  1. As the trigger node, add Scheduled Run.
  2. In the configuration of the node:
    1. Leave the Run trigger option at default (all time).
    2. From the Timezone dropdown list, select the time zone consistent with the timezone selected for your workspace.
    3. Define the frequency of the workflow (for example, everyday at 6.00 A.M.).
      The workflow will automatically launch everyday at 6.00 A.M.
    4. Confirm by clicking Apply.
The configuration of the Scheduled Run node
The configuration of the Scheduled Run node

Select customers to export

  1. Add a Get Profiles node.

  2. In the configuration of the node:

    1. Select the segmentation you created in the first part of the process.
    2. In the Attributes section, select newsletter_agreement and email.
    3. Confirm by clicking Apply.
    The configuration of the Get Profiles node
    The configuration of the Get Profiles node

Select the data transformation rules

  1. Add a Data Transformation node.
  2. In the configuration of the node, select the data transformation you have created before.
  3. Confirm by clicking Apply.
The configuration of the Data Transformation node
The configuration of the Data Transformation node

Configure settings for SFTP protocol

  1. Add the SFTP - Send file node.

  2. In the configuration of the node:

    1. Enter the path to your server.
    2. Select the port.
    3. Enter the path to the directory.
    4. Enter the name of the file.
    5. If needed, in the File name suffix, select the suffix of the file name.
    6. From the File format dropdown list, select the CSV format.
    7. Verify and modify the delimiters if needed.
    8. In the Authentication section, select the method of authentication.
    9. Confirm by clicking Apply.
    The configuration of the SFTP node
    The configuration of the SFTP node

Add the finishing node

  1. Add the End node.
  2. In the upper right corner, click Save & Run.
    Result:
    The workflow configuration
    The workflow configuration

You can monitor the flow of the workflow in the Transformation logs tab. It contains information about each execution of the workflow.

The logs for the workflow
The logs for the workflow

Check the use case set up on the Synerise Demo workspace


You can check the configuration of each item created in this use case on our Synerise Demo workspace:

If you don’t have access to the Synerise Demo workspace, please leave your contact details in this form, and our representative will contact you shortly.

Read more


😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker