Edit and Search External FTP Objects in Salesforce Connect
CData Connect AI, enables you to access FTP data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce Mobile App. In this article, you will use CData Connect AI and Salesforce Connect to access external FTP objects alongside standard Salesforce objects.
Connect to FTP from Salesforce
To work with live FTP data in Salesforce Connect, we need to connect to FTP from Connect AI, provide user access to the connection, and create a Workspace for the FTP data.
Connect to FTP from Connect AI
CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "FTP" from the Add Connection panel
-
Enter the necessary authentication properties to connect to FTP.
To connect to FTP or SFTP servers, specify at least RemoteHost and FileProtocol. Specify the port with RemotePort.
Set User and Password to perform Basic authentication. Set SSHAuthMode to use SSH authentication. See the Getting Started section of the data provider help documentation for more information on authenticating via SSH.
Set SSLMode and SSLServerCert to secure connections with SSL.
The data provider lists the tables based on the available folders in your FTP server. Set the following connection properties to control the relational view of the file system:
- RemotePath: Set this to the current working directory.
- TableDepth: Set this to control the depth of folders to list as views.
- FileRetrievalDepth: Set this to retrieve and list files recursively from the root table.
Stored Procedures are available to download files, upload files, and send protocol commands. See the Data Model chapter of the FTP data provider documentation for more information.
- Click Save & Test
-
Navigate to the Permissions tab in the Add FTP Connection page and update the User-based permissions.
Add a Personal Access Token
When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
Configure FTP Endpoints for Salesforce Connect
After connecting to FTP, create a workspace for your desired table(s).
-
Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
- Click Add to add new assets to the Workspace.
-
Select the FTP connection (e.g. FTP1) and click Next.
-
Select the table(s) you wish to work with and click Confirm.
- Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}
With the connection, PAT, and Workspace configured, you are ready to connect to FTP data from Salesforce Connect.
Connect to FTP Data as an External Data Sources
Follow the steps below to connect to the feed produced by Connect AI.
- Log into Salesforce and click Setup -> Integrations -> External Data Sources.
- Click Now External Data Sources.
- Enter values for the following properties:
- External Data Sources: Enter a label to be used in list views and reports.
- Name: Enter a unique identifier.
- Type: Select the option "Salesforce Connect: OData 4.0".
- URL: Enter the URL to the OData endpoint of Connect AI: https://cloud.cdata.com/api/odata/{workspace_name}
- Select the Writable External Objects option.
- Select JSON in the Format menu.
- In the Authentication section, set the following properties:
- Identity Type: If all members of your organization will use the same credentials to access Connect AI, select "Named Principal". If the members of your organization will connect with their own credentials, select "Per User".
- Authentication Protocol: Select Password Authentication to use basic authentication.
- Certificate: Enter or browse to the certificate to be used to encrypt and authenticate communications from Salesforce to your server.
- Username: Enter a CData Connect AI username (e.g. [email protected]).
- Password: Enter the user's PAT.
Synchronize FTP Objects
After you have created the external data source, follow the steps below to create FTP external objects that reflect any changes in the data source. You will synchronize the definitions for the FTP external objects with the definitions for FTP tables.
- Click the link for the external data source you created.
- Click Validate and Scan.
- Select the FTP tables you want to work with as external objects.
Access FTP Data as Salesforce Objects
After adding FTP data as an external data source and syncing FTP tables as external objects, you can use the external FTP objects just as you would standard Salesforce objects.
-
Create a new tab with a filter list view:
-
Create reports of external objects:
-
Create, update, and delete FTP objects from the Salesforce dashboard:
Simplified Access to FTP Data from Cloud Applications
At this point, you have a direct, cloud-to-cloud connection to live FTP data from Salesforce. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Salesforce, refer to our Connect AI page.