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:

Detail one.

The name of the SFTP site.

Detail one.

The SSH key.

Detail one.

The remote folder to which Amperity will send data.

Important

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

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

Step 1.

Open the Destinations tab to configure a destination for Tulip. Click the Add Destination button to open the Destination dialog box.

Name, description, choose plugin.

Enter a name for the destination and provide a description. For example: “Tulip” and “This sends files to Tulip”.

From the Plugin drop-down, start typing “sftp” to filter the list, and then select Tulip.

Step 2.

Credentials allow Amperity to connect to Tulip.

The credential type is set automatically to passphrase or private-key. You may use an existing credential or you may add a new one.

Choose an existing credential or add credential.

Select an existing credential from the Credential drop-down.

– or –

Select Create a new credential from the Credential drop-down. This opens the Credential dialog box.

Enter the name for the credential, and then add a description. Select hostname from the HOSTNAME drop-down list. Enter the username and passphrase.

Update the settings for the SFTP destination.

When finished, click Save.

Step 3.

Each destination has settings that define how Amperity will deliver data to Tulip. These settings are listed under the Settings section of the Destination dialog box.

Settings for SFTP destinations.

Complete the following SFTP Settings:

  • The path to the Remote folder.

    Tip

    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”.

  • The File format. Select the file format – Use a CSV file – from the drop-down list.

  • Optional. The Escape character that is 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.

  • Optional. The Compression format. Set the encoding method to “None”.

  • Optional. The PGP public key that is used to encrypt files that are sent to Tulip.

  • Optional. The Quote mode that should be used within the file. From the drop-down, select one of “all fields”, “all non-NULL fields”, “fields with special characters only”, “all non-numeric fields” or “None”.

    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 not set to “None”, you should specify an escape character.

  • Optional. Select Include success file upon completion to add a .DONE file that indicates 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.

  • Optional. Select Include header row in output files if headers should be included in the output.

  • Optional. Select Exclude Parquet extension from the directory name for managing how Apache Parquet files are added to directories.

Step 4.

Business users are assigned to the Amp360 User and/or AmpIQ User policies. (Amp360 User allows access to queries and orchestrations and AmpIQ User allows access to segments and campaigns.) A business user cannot select a destination that is not visible to them.

Business users – including users assigned to the DataGrid Operator policy – may have restricted access to PII.

What is restricted access to PII?

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.

You can make this destination visible to orchestrations and allow users with restricted access to PII to use this destination by enabling one (or both) of the following options:

Allow business users access to this destination.

Note

To allow business users to use this destination with campaigns, you must enable the Make available to campaigns option within the data template. This allows users to send campaign results from Amperity to Tulip.

The other two settings may be configured within the data template instead of the destination.

Step 5.

Review all settings, and then click Save.

Save the destination.

Important

You must configure a data template for this destination before you can send data to Tulip.

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

Step 1.

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.

Step 1

Enter the name of the data template and a description. For example: “Tulip” and “Send files to Tulip.”.

Step 2.

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.

Step 2.

If business user access was not configured as part of the destination, you may configure access from the data template.

Step 3.

Verify all configuration settings.

Verify settings for the data template.

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.

Step 4.

Review all settings, and then click Save.

Save the data template.

After you have saved the data template, and depending on how you configured it, business users can send query results to Tulip to Tulip.