SFTP - Instructions for custom fields

TABLE OF CONTENTS

• SFTP - Instructions for custom fields
  • Custom field response file processing logic
  • File format and naming conventions
  • Frequency and scheduling
  • Custom field file format

This topic contains helpful information to ensure your file uploads are successful.

For general SFTP guidelines and information, see SFTP - Setup instructions.

Custom field response file processing logic

Spotnana allows either a partial or full custom field response data set each time you upload the file. The file name indicates the name of the custom field and response list for which responses are being uploaded. Each custom field and its responses must be sent in a separate file (for details on file naming conventions, see below). The logic used to process the contents of your CSV file is as follows:

• If the ACTION column for the row is set to CREATE, the response option will be created for the response list.

• If the ACTION column for the row is set to UPDATE and the response option already exists, the response description will be updated for that response.

If the ACTION column for the row is set to DELETE , the response option will be deleted. If no record in the Spotnana database matches the response option, the row will be skipped and no action will be taken.

File format and naming conventions

Each .CSV custom field feed file name must use this format:

CUSTOM_FIELD_V3_OPTIONS.[customFieldID].[optionGroupID].*.csv

where:

• [customFieldID] is a variable that changes for each field. This ID is contained within the file name shown in step 2 on the SFTP import instructions dialog box that is part of the Import from SFTP directory instructions. 

• [optionGroupID] is a variable that changes for each response list. This ID is contained within the file name shown in step 2 on the SFTP import instructions dialog box that is part of the Import from SFTP directory instructions..  

• the * (wildcard) represents any characters you wish to add to the name. 

• the “.” after the [optionGroupID] and the “.” before “csv” must be present. 

The file name is not case sensitive. We recommend including the date and time in the name of the file (to ease troubleshooting in the future). For example:

CUSTOM_FIELD_V3_OPTIONS.[customFieldID].[optionGroupID].spotnana_integration_<DateTime>.csv

The .CSV feed file must also be in a specific format. The column names must exactly match the defined format (see Custom field format section below). 

Frequency and scheduling

We recommend you upload a file daily to be sure to notify Spotnana of any additions/updates/deletions that may have occurred (if your custom fields change often, daily updates may be preferred). If this practice is followed: 

• new responses will be available to be selected at checkout by travelers immediately. 

• deprecated responses will be removed as an option and no longer available for travelers to select. 

Deprecated responses will still be visible on reports.

Custom field file format

Use this information to help you ensure the data in your custom field upload is correctly formatted and prepared.