Send customer profiles to Tulip

Tulip is a store experience platform that helps your brand connect with your customers by using personalized retail experiences, access to online and in-store products, and seamless omnichannel checkout and fulfillment.

Use the Tulip File Importer tool to send CSV files to Tulip using SFTP, after which the files are automatically uploaded to Tulip by the Bulk API.

Note

Tulip supports the following entities: stores, employees, categories, products, variants, prices, inventory, customers, and order history. Review the file naming conventions for each entity, review the sample files , and make sure your output has the correct file formatting .

Amperity can be configured to send CSV files to Tulip.

Get details

Review the following details before configuring credentials for Tulip and before configuring Amperity to send CSV files to Tulip.

Detail 1.

Credential settings

Credentials for Tulip require a “username” and “private key”. Set the hostname to , which is similar to “sftp-tulip-staging.tulipretail.com”.

Note

The name of the SFTP site, SSH key, and remote folder are provided by Tulip support after the File Importer is activated in the Tulip Admin Console.

Detail 2.

Required configuration settings

File format

Configure Amperity to send CSV files to Tulip.

Some file formats allow a custom delimiter. Choose the “Custom delimiter” file format, and then add a single character to represent the custom delimiter.

Remote folder

The remote folder to which Amperity will send data.

A “/” (forward slash) must be used as the first character for this value. For example: “/folder/name”. For example: “/folder/name”.

If the path to the remote folder contains a space, use a backslash (\) character to escape that space. For example, a folder named “From ACME” should be entered as “From\ ACME”.

Note

All other Amperity file format settings for Tulip are optional.

Configure credentials

Configure credentials for Tulip before adding a destination.

Note

The name of the SFTP site, SSH key, and remote folder are provided by Tulip support after the File Importer is activated in the Tulip Admin Console.

An individual with access to Tulip should use SnapPass to securely share “username”, “hostname”, and “private key” details with the individual who will configure Amperity.

To configure credentials for Tulip

Step 1.

From the Settings page, select the Credentials tab, and then click the Add credential button.

Step 2.

In the Credentials settings dialog box, do the following:

From the Plugin dropdown, select Tulip.

Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.

From the Credential type drop-down, select “private-key”.

Step 3.

The settings that are available for a credential are determined by the credential type. For the “private-key” credential type, configure settings, and then click Save.

Username

Required. A username with access to Tulip. This username must be allowed to write data to the remote folder to which Amperity will send data.

Hostname

Required. The hostname for Tulip. For example: , which is similar to “sftp-tulip-staging.tulipretail.com”.

Private key

A private key that is used to encrypt files that are sent to Tulip.

Add destination

Use a sandbox to configure a destination for Tulip. Before promoting your changes, send a test audience, and then verify the the results in Tulip. After the end-to-end workflow has been verified, push the destination from the sandbox to production.

Important

The file prefix the filename generated by Amperity must match the file prefix required by Tulip for that entity. For example, inventory must have TIN_ as a prefix, orders must have TOR_ as a prefix, and customers must have TCU_ as a prefix. In addition, all files must be CSV files and end with .csv.

Use YYYYMMDD for the datetime formatting.

Include header rows.

The sequence of files that are sent to Tulip does matter. Heirarchy is used to determine, for example, categories and sub-categories; stores should be loaded before employees because an employee is assigned to a store.

To add a destination for Tulip

Step 1.

Open the Destinations page, and then click the Add destination button.

Add

To configure a destination for Tulip, do one of the following:

  1. Click the row in which Tulip is located. Destinations are listed alphabetically and you can scroll up and down the list.

  2. Search for Tulip. Start typing “sftp”. The list will filter to show only matching destinations. Select “Tulip”.

Step 2.

Select the credential for Tulip from the Credential drop-down, and then click Continue.

Tip

Click the “Test connection” link on the “Configure destination” page to verify that Amperity can connect to Tulip.

Step 3.

In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination.

Configure business user access

By default a destination is available to all users who have permission to view personally identifiable information (PII).

Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies.

Enable the PII setting checkbox to allow users with limited access to PII access to this destination.

Restricted PII access is enabled when the Restrict PII access policy option that prevents users who are assigned to that option from viewing data that is marked as PII anywhere in Amperity and from sending that data to any downstream workflow.

Step 4.

Configure the following settings, and then click “Save”.

Compression

The compression format to apply to the file. May be one of “GZIP”, “None”, “TAR”, “TGZ”, or “ZIP”.

Escape character

The escape character to use in the file output. Applies to CSV, TSV, PSV, and custom delimiter file types.

When an escape character is not specified and the quote mode is “None” files may be sent with unescaped and unquoted data. When an escape character is not specified, you should select a non-“None” option as the quote mode.

File format

Required

Configure Amperity to send CSV files to Tulip.

Filename template

A filename template defines the naming pattern for files that are sent from Amperity. Specify the name of the file, and then use Jinja-style string formatting to append a date or timestamp to the filename.

Header

Enable to include header rows in output files.

Line ending

The line ending to use in file output. May be one of “LF” or “CRLF”.

PGP public key

The PGP public key that Amperity will use to encrypt files.

Quote mode

The quote mode to use within the file. May be one of “all fields”, “all non-NULL fields”, “fields with special characters only”, “all non-numeric fields” or “None”.

Unescaped, unquoted files may occur when quote mode is set to “None” and an escape character is not specified.

Remote folder

Required

The remote folder to which Amperity will send data.

A “/” (forward slash) must be used as the first character for this value. For example: “/folder/name”. For example: “/folder/name”.

If the path to the remote folder contains a space, use a backslash (\) character to escape that space. For example, a folder named “From ACME” should be entered as “From\ ACME”.

Success file

Enable to send a “.DONE” file when Amperity has finished sending data.

If a downstream sensor is listening for files sent from Amperity, configure that sensor to listen for the presence of the “.DONE” file.

Use Zip64?

Enable to apply Zip64 data compression to very large files.

Step 5.

After this destination is configured, users may configure Amperity to:

  • Use orchestrations to send query results

  • Use orchestrations and campaigns to send audiences

  • Use orchestrations and campaigns to send offline events

to Tulip.