Send data 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 .

This topic describes the steps that are required to send files to Tulip from Amperity:

1. Get details

2. Add destination

3. Add data template

Get details

Tulip requires the following configuration details:

1. The name of the SFTP site.

2. The SSH key.

3. The remote folder to which Amperity will send data.

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.

Add destination

Configure Amperity to send files directly to Tulip.

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

1. From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.

2. Enter the name of the destination and a description. For example: “Tulip” and “This sends query results to “Tulip”.

3. From the Plugin drop-down, select SFTP.

   This automatically selects passphrase or private-key as the Credential Type and assigns hostname as the location to which data is sent.

4. From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box. Enter a name for the credential (typically “Tulip”), and then enter the username and password required to access this SFTP location.

5. Under Settings, enter the path to the remote folder.

   Tip

   For remote folders that contain spaces, use a backslash (\) character to escape the space. For example, a folder named “From ACME” should be entered as “FromACME”.

6. From the File Format drop-down, select Use a CSV file.

7. Add a single character to be used as an escape character in the output file. (This should match the escape character required by Tulip.)

   Note

   If an escape character is not specified and quote mode is set to “None” this may result in unescaped, unquoted files. When an escape character is not specified, you should select a non-“None” option from the Quote Mode setting.

8. Specify the encoding method. Set the encoding method to “None”.

9. Optional. Add the PGP public key that is used to encrypt files sent to Tulip.

10. Optional. Specify the line ending type: LF or CRLF.

11. Optional. Set the quote mode.

    Note

    If the quote mode is set to “None” and the Escape Character setting is empty this may result in unescaped, unquoted files. When quote mode is “None”, you should specify an escape character.

12. Optional. Select Include success file upon completion to add a .DONE file to indicate when an orchestration has finished sending data.

    Tip

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

13. Optional. Select Include header row in output files if headers are included in the output.

14. Select Allow business users to use this destination.

    This allows users who have been assigned to the Amp360 User and/or AmpIQ User policies to use this destination with orchestrations and/or campaigns.

15. Select Allow business users with limited PII access to send data. (A business user with limited PII access is someone who has been assigned the Restrict PII Access policy option.)

16. Click Save.

Add data template

A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.

To add a data template

	From the Destinations tab, open the menu for a destination that is configured for Tulip, and then select Add data template. This opens the Add Data Template dialog box. From the Destinations tab, open the menu for a destination that is configured for Tulip, and then select Add data template. This opens the Add Data Template dialog box.
	Verify business user access to queries and orchestrations and access to segments and campaigns. A business user may also have restricted access to PII, which prevents them from viewing and sending customer profile data. If business user access was not configured as part of the destination, you may configure access from the data template.
	Verify all configuration settings. Note When the settings required by the SFTP site were are not configured as part of the destination, you must configure them as part of the data template before making this destination available to campaigns.
	Review all settings, and then click Save. After you have saved the data template, and depending on how you configured it, business users can send query results to Tulip to Tulip.