- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
|
action type - ftp server [2016/09/14 18:19] |
action type - ftp server [2016/09/14 18:19] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Integrate with an FTP Server ====== | ||
| + | This action type allows you to integrate with an [[http://en.wikipedia.org/wiki/File_Transfer_Protocol|FTP Server]] in these ways: [[#Read Files|read]] (reads a directory and allows you to act on each file that exists in that directory, [[#Get a File|get]] (downloads one file from the FTP server in a specific location to a [[Field Type - File Attachment|file attachment]] [[Field|field]] in WorkXpress), [[#Send a File|send]] (uploads a file from WorkXpress to a specific location on the FTP server), [[#Delete a File|delete]] (deletes a file from a specific location on the FTP server), and [[#Move a File|move]] (moves a file from one location on the FTP server to another). | ||
| + | ===== Settings ===== | ||
| + | ==== Main Settings ==== | ||
| + | These settings apply to all five types of FTP actions you can execute. | ||
| + | === Address of Server === | ||
| + | Choose a Server Address (e.g. 111.222.333.444, or ftpserver.customer.com) to connect to. | ||
| + | === Server Port === | ||
| + | Choose the port to connect to for the server if it is non standard. By default 21 will be used for FTP and 22 for Secure FTP and SCP. | ||
| + | === FTP Access Username === | ||
| + | Choose the username that has access to the FTP server. | ||
| + | === FTP Access Password === | ||
| + | Choose the password for the above user. | ||
| + | === Connection Method === | ||
| + | Choose a protocol to use when communicating with the server. FTP is an unsecured standard where the files will be transferred without encryption and is only appropriate for sending files that are public. Secure FTP and SCP uses SSH to provide a secure encrypted communication channel that is appropriate for sending private files. SCP is a more limited communication method and only supports sending and receiving of files. | ||
| + | |||
| + | ==== Read Files ==== | ||
| + | This action will read the files in a folder on an FTP server. It will then loop over it's child actions once for each file it finds, making that file's name available to each child action. You should use this action when you aren't sure what files will be in a certain directory, and you need to read all of them. It essentially acts like a loop inside which you can place a [[#Get a File|get a file]] action to obtain each file that's read here. | ||
| + | === FTP Folder Path === | ||
| + | Choose the path to the folder to read on the FTP Server. Example: if your files are located in the directory %%ftp.customer.com/data/%%, you'd want the FTP folder path expression to result in "/data/". | ||
| + | |||
| + | ==== Get a File ==== | ||
| + | This action will let you get a file from a server via FTP and save it into a file field. Often, but not always, used hand-in-hand with a [[#Read Files|read files]] action. If it is used in concert with a read files action, the read files action acts as a loop, then this action is placed inside it to obtain each file that's read in the directory. | ||
| + | === FTP Folder Path === | ||
| + | Build an expression that will result in the path (including filename) that you wish to obtain from the FTP server. Example: if your files are located in the directory %%ftp.customer.com/data/%%, you'd want the FTP folder path expression to result in "/data/filename.ext". | ||
| + | === File Storage Location === | ||
| + | Choose where to store the file when it's retrieved. This must be a [[Field Type - File Attachment|file attachment]] [[Field|field]] in your WorkXpress app. | ||
| + | |||
| + | ==== Send a File ==== | ||
| + | This action will let you send a file from a file field, or made from an expression, to a Server via FTP. | ||
| + | === File Source === | ||
| + | Choose where to get the file from within your WorkXpress application. Typically the full field output for a [[Field Type - File Attachment|field attachment]] [[Field|field]]. | ||
| + | === File Storage Path === | ||
| + | Choose where on the FTP Server to store the file. This location must be the path including file name. Example: if you want to store your file in the directory %%ftp.customer.com/data/%%, you'd want the file storage path expression to result in "/data/filename.ext". | ||
| + | |||
| + | ==== Delete a File ==== | ||
| + | This action will let you delete a file on a server via FTP. | ||
| + | === File Path === | ||
| + | Choose the path to the file to delete on the FTP Server. This location must be the path including file name. Example: if you want to delete the file at the location %%ftp.customer.com/data2/filename.ext%%, you'd want the file path expression to result in "/data/filename.ext". | ||
| + | |||
| + | ==== Move a File ==== | ||
| + | This action will let you move a file from one path to another on a server via FTP. | ||
| + | === File Source === | ||
| + | Choose the path to the file on the FTP Server you wish to move. This location must be the path including file name. Example: if you want to move the file at the location %%ftp.customer.com/data2/filename.ext%%, you'd want the file source expression to result in "/data/filename.ext". | ||
| + | === File Destination === | ||
| + | Choose where on the FTP Server to put the file. This location must be the path including file name. Example: if you want to move the file to the location %%ftp.customer.com/data2/filename.ext%%, you'd want the file destination expression to result in "/data2/filename.ext". | ||
