Skip to main content

 

 

DealerTeam

Configure a scheduled FTP export from within DealerTeam

Goal

Configure a scheduled FTP export from within DealerTeam.

After reading this article you will be able to:

  • Add the Outbound File Transfer tab
  • Navigate to the outbound file transfer
  • Export custom files
  • Explain the outbound file transfer fields

 

Attention! Before starting this article you will need to Enable the dealer.Udate Outbound File Transfer. Read Enable Custom Permissions to learn how.

 

Step One: Add the Outbound File Transfer Tab

  1. Click the setup gear icon.
  2. Select Setup.

1 Export - setup.png

 

  1. Enter Tabs in the quick find area.
  2. Click Tabs.
  3. Click New.

1 Export - new tab.png

 

  1.  Select Outbound File Transfer as the Object value. 
  2. Select a value for the Tab Style.
  3. Click Next.

3 Export - Tab.png

 

  1. Select the Profiles the Tab will be visible for and click Next.

4 Export - Tab profiles.png

 

  1. Select the Apps the Tab will be available on and click Save.

5 Export - Tab apps.png

 

Step Two: Navigate to Outbound File Transfers

  1. Click the App Launcher icon.

6 Export - app launcher.png

 

  1. Enter Outbound File Transfers in the quick find area.
  2. Click Outbound File Transfers.

7 Export - oft object.png

 

Step Three: Export Custom Files

  1. Click New.

8 Export - new.png

 

  1. Enter the SOQL Statement.
  2. Fill out the Configuration fields.
  3. Check Active.
  4. Click Save.

9 Export - custom file.png

 

  1. Click Run OFT.

10 Export - run oft.png

 

Historical Runs

To view historical runs click View All on the related Outbound File Transfer History.

10. Export - run history.png

 

Outbound File Transfer Fields

Outbound File

Field Description
Destination File Name The name of the string data written to the remote file system.
Export File Type The type of file to be created on the remote file server.
Omit Header Row If checked, the header row will be removed from the newly created remote file.
Delimiter Select your default character to separate values. If left blank the default delimiter is comma.
Column Encapsulation How to define the data columns.
Name  Label and link that appears in the list view.
SOQL statement Contains SOQL Statement to be executed by the middlware. Ex: Select Id, Name From Account Where Site != null.
Active Check this box to allow files to be exported.
Last Run Results Contains the result of the last execution, success or error message.
Last Run Date The date and time of the most recently completed OFT Job. Updated by trigger.
Last Run Status The date and time of the most recently completed OFT Job. Updated by trigger.

11 Export - outbound file.png

 

SOQL Statement

The SOQL Statement can point to any queryable object (not just Vehicle Inventory). Once the user attempts to save FTP job record, it will first automatically check the provided SOQL statement for validation, if there are errors in it, it will prevent saving of the record, and provide graphical error feed back.

 

SOQL Error

An notification will appear if the SOQL statement is incorrect or has a syntactical error.

clipboard_eb8c7abf6c6580404f33eeee6ac27c6a3.png

 

SOQL Examples

Here are some examples of working SOQL statements:

SELECT dealer__Store_Location__c, Blank_1__c, dealer__VIN__c, dealer__Stock_Number__c, dealer__Year__c, dealer__Make__c,dealer__Body_Type__c,  FROM dealer__Vehicle_Inventory__c WHERE dealer__Publish_Vehicle_Info_To_Web__c = true AND dealer__In_Stock__c = true

SELECT dealer__Service_Vehicle__r.Name FROM dealer__Vehicle_Inventory__c FROM dealer__Vehicle_Inventory__c

 

Configuration

Field Description
Transport Protocol The protocol to use for the file transfer.
URN Universal Resource Name, this should contain the IP address or DNS Entry for the resource endpoint.
Username The username to connect to remote file server.
Port The port used to connect to the remote file server.
Password The password used to connect to remote file server.

12 Export - configuration.png

 

What's Next

Schedule Outbound File Transfers to repeat. Learn how to by reading Schedule Apex Jobs.