You are here: Integrating With CPQ Cloud > Integration Guides > FTP Automation

FTP Automation

OVERVIEW

FTP (File Transfer Protocol) Automation allows uploads (similar to Bulk Uploads functionality) to an FTP server. Scheduled uploads can be automatically imported into a CPQ Cloud site. Automated uploads can include:

FTP Automation is useful for CPQ Cloud sites that require stored data to be refreshed regularly. For example, your configuration might require updates to pricing tables from an ERP system. These updates are especially important if CPQ Cloud is the Parts Master (for Salesforce Parts Integration or integration with another CRM) and the Parts data is pushed from an ERP system to the CPQ Cloud site.

ADMINISTRATION

ClosedSetting up FTP Automation

  1. Contact CPQ Cloud Ops for the creation an FTP profile and its corresponding "automated" folder on the FTP server.
  2. Prepare the files that will be uploaded.
    1. Determine the format of the CSV files that will be uploaded.

      Usually, the CSV format can be obtained by downloading the relevant CSV file from Bulk Data Services.

      The Data Table CSV format used with FTP Automation differs from the file format used when Data Tables are uploaded through the UI.

      The Data Table CSV file does not have to include header rows when using FTP Automation. However, if there are no headers, the system will not recognize the natural keys special _update_action column, and the uploaded data will look incorrect.

      If you are using natural keys, and want to use the _update_action column, include headers in your Data Table CSV file.

    2. After exporting a Data Table via the UI, delete the first 5 rows (_start meta data, column headings, data types, descriptions, and _end meta data) before uploading the table using FTP Automation.
    3. Place each file that will be uploaded into a separate .ZIP file.
  3. Prepare the Upload List (upload_list.xml).

    The upload_list.xml file lists the uploaded files in the order they will be processed. Example Upload List file:

    <?xml version="1.0" encoding="UTF-8"?>

    <files>

    <file>

    <name>Filename.zip</name>

    <type>REGULAR</type>

    </file>

    </files>

      For Data Table CSV uploads, the type is DATA_TABLES_CSV. For all other uploads, the type is REGULAR.
  4. Upload the files to the automated folder on the FTP server.
    1. Upload the ZIP files followed by the upload_list.xml file.
    2. Test the uploads manually.
    3. Test the automated process.
    1. Testing the manual & automated process ensures that the schedule allows sufficient time to process one upload before the next upload is sent.

ClosedAdditional Data Table Functionality

When uploading Data Tables, records in the upload are appended to the existing table in CPQ Cloud.

ClosedData Table Commands

In addition to uploading Data Tables, actions such as Delete and Deploy can be triggered using the automated upload.

Action Files to Upload
Delete
  • upload_list.xml (this will specify Delete.ZIP with type "REGULAR")
  • Delete.ZIP (this will contain a delete.xml file)
Upload
  • upload_list.xml (this will specify Table.ZIP with type "DATA_TABLES_CSV")
  • Table.ZIP (this will contain a table.CSV file)
Deploy
  • upload_list.xml (this will specify Delete.ZIP with type "REGULAR")
  • Delete.ZIP (this will contain a delete.xml file)
    These processes must run in the correct sequence, either by uploading the Delete, Upload, and Deploy files during consecutive scheduled upload events, or by loading the files at the same time listed in the correct order in the upload_list.xml file.

ClosedExample of Delete XML file

ClosedExample of Deploy XML file


NOTES

RELATED TOPICS

Related Topics Link IconSee Also