SK SKYVVA Documentation

27.2 How to use file and ftp/sftp adapter?

This tutorial explains what file, ftp/sftp adapter are, and why do we need them. It describes how to create and use them.

1 What is File adapter?

File adapter is used to integrate data from file to SFDC and from Salesforce to file. The file type that our Agent support is CSV, XML and Excel that can be integrated with their content. You can integrate file attachment into attachment object.

2 What is FTP/SFTP adapter?

FTP Adapter use as a connector to transfer data from FTP server to Salesforce and from Salesforce to FTP server.

3 Prerequisite

Before creating adapter, you have to have Integration and interface and these two things must create in Salesforce. To create, edit, and delete you need to do in Salesforce not Agent. Please perform both integration and interface development in Salesforce first. Then run AgentUI and create adapter there.

4 The creating of Adapter

This document will be explain about two adapter:

4.1 File adapter This document is focus only on the creation of adapter, so some steps before it would be skip eg. Creating Integration and Interface. To create File Adapter, there are some steps must be follow: Run Agent UI > Integration Wizard > Choose Integration > Choose existing interface.
  1. Adapter Section: Choose Adapter Type (File) > Name Adapter
  2. Adapter Properties:
  3. File type: Choose CSV
  4. File Upload Mode: Choose CONTENT or FILE
  5. Folder: Choose the folder (path to get the file/ files)
  6. File Name: Choose file name (a file name for agent to query data from. If this
field is empty, it mean you to select all files in the selected folder. • Keep File: The file will keep in the folder. • Lock File: The file will lock. • Delete File: The file will delete. • Backup File: The file will back up in the other folder. your file, you have to input your folder name here.
  1. Click “Test Source Connection” to test the connection to the specified folder and
file.
  1. Click Save.

Note: For Excel and XML File, you can just do the same as CSV File. However, just you need to change the file types, adapter and its properties accordingly. 5 FTP/SFTP Adapter This document is focus only on the creation of adapter, so some steps before it would be skip eg. Creating Integration and Interface. To create FTP Adapter, there are some steps must be followed: Run Agent UI > Integration Wizard > Choose Integration > Choose existing interface.

can be any link from your side the FTP Server) -Keep File: The file will keep in the folder.- Lock File: The file will lock- Delete File: The file will delete.- Backup File: The file will backup in the other folder. your file, you have to input your folder name here
  1. Click “Test Source Connection” to test the connection to the specified folder and
file.
  1. Click Save.
Note: For SFTP configuration, please kindly look for document (SFTP Configuration). 6 To test Integration There are three ways to test yours integrate. 6.1 Button Test Integration When you click test integrate the 50 records among many data will process. The maximun is 50. By clicking this button you will know if your configure is correct or not. This button is located in Integration Setup Wizard-Integration Detail. 6.2 Button Process The Process button is also located in Integration Setup Wizard-Integration Datail. When you click this button all your data will be processed. This is manually processing. 6.3 Schedule Click Integration Scheduling>Property File Selection>Integration Name>Interface Name>Integration Mode>On>Run at/Run every>Save 7  To check result Go to SF > Message Monitoring Board
Open this article in the interactive viewer →