Collapse AllExpand All

8.1. Copying Files from an FTP Server

When xTuple Connect is installed and enabled, the Configure Import and Export screen shows a "Transfer Information From" list on the "Import Settings" tab. To set up xTuple Connect to retrieve files from an FTP server, you add the FTP server to this list:

  1. Follow this path: System > Setup > Configure > Import/Export

  2. Click on the "Import Settings" tab

  3. Click on the NEW button next to the "Transfer Files From" list

  4. You will see the Import Source screen that looks like this:

    Defining an Import Source

  5. Enter a name you can use to remember this Import Source

  6. Enter the host name or IP address of the FTP server you will download files from

  7. Enter the user name and password given to you by the FTP server administrator

  8. Enter the directory from which you will download files (this might be empty)

  9. If the names of the files you will be downloading all have some pattern in common, such as containing the name of your company, enter that pattern in the "File Name or Pattern" field (e.g. .*Prodiem.xml)

    Tip

    See http://www.xtuple.org/PatternMatching for information on regular expressions.

  10. If you want to do something to the files on the FTP server after the download is complete, select from the "After Successful Download" options (this only affects the FTP server, not your local copy of the files, and gives you a mechanism for not downloading the same file from the FTP server more than once)

  11. Check the Recurring box and enter how frequently you want to download files from this Import Source, what date and time you want to start, and what date and time you want to stop

  12. On the right-hand side of the screen, enter email information the xTuple Connect Batch Manager can use to let you know what files have been downloaded

    Note

    If the Recurring box is not checked, the email information will not be saved. Without a recurring event, the Import Source will never be used. The email information is part of the xTuple Connect Batch Manager job, not the Import Source.

  13. Click the SAVE button

    Note

    It is important to remember that this is the schedule for downloading files. The download job does not import the files into the database. Downloading files from FTP servers and importing them into the xTuple database are distinct steps and are scheduled independently.

    This distinction lets you retrieve files from different FTP servers on schedules that might be determined by your business partners, but import the data into your database when you want to.