# FTP下载组件使用说明
# 组件说明
FTP下载用于从FTP服务器检索一个或多个文件。
# 配置项说明
| 配置名称 | 数据类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| 节点名称 | String | 是 | - | 当前创建的节点名称，由用户自定义且不可为空。命名可包含字母、数字、下划线。 |
| IP地址 | String | 是 | - | ftp服务器名称或地址。 |
| 端口号 | String | 是 | - | ftp服务器端口号。 |
| 用户名 | String是 | 是 | - | ftp服务器用户名。 |
| 密码 | String | 是 | - | ftp服务器密码。 |
| 是否使用二进制模式 | Boolean | 否 | 否 | 勾选此选项，ftp使用BINARY方式传输，否则，使用ASCII方式传输。 |
| 超时 | Int | 否 | 0 | 连接ftp服务器超时时间。 |
| 是否使用活动FTP连接 | Boolean | 否 | 否 | 勾选此选项，ftp使用主动模式，否则，使用被动模式。 |
| 控制编码 | String | 否 | UTF-8 | 指定文件名/目录使用的字符集。 |
| 远程文件目录 | String | 是 | - | 指定ftp目录。 |
| 通配符 | String | 否 | - | 正则匹配ftp目录下文件。 |
| 获取文件后删除文件 | Boolean | 否 | 否 | 勾选此选项，下载成功后，删除ftp目录下该文件。 |
| 移动文件夹 | Boolean | 否 | 否 | 勾选此选项，且未勾选获取文件后删除文件时，下载成功后，将改文件移至指定ftp目录。 |
| 移动至文件夹 | Boolean | 否 | - | 当移动文件夹为"是"时，指定文件移动目录。 |
| 新建文件夹 | Boolean | 否 | 否 | 当移动文件夹为"是"时，移动文件夹不存在时，创建文件夹。 |
| 本地文件目录 | String | 是 | - | 本地下载目录。 |
| 指定时间格式 | Boolean | 否 | 是 | 勾选此选项，在文件名中指定位置，根据指定掩码添加日期时间。 |
| 文件名包含日期 | Boolean | 否 | 否 | 勾选此选项，在文件扩展名之前添加日期，使用掩码"yyyyMMdd"。 |
| 文件名包含时间 | Boolean | 否 | 否 | 勾选此选项，在文件扩展名之前添加时间，使用掩码"HHmmssSSS"。 |
| 指定日期时间 | String | 否 | - | 指定文件名添加时间的掩码。 |
| 是否在扩展名前添加日期 | Boolean | 否 | 否 | 指定时间相对于扩展名的位置。 |
| 是否覆盖文件 | Boolean | 否 | 否 | 本地下载目录存在相同文件，是否使用新文件进行覆盖。 |
| 如果文件已存在 | String | 否 | - | 本地下载目录存在相同文件。 跳过：文件已存在，不进行覆盖，也不计入错误数。 给本地文件指定一个唯一名称：文件已存在，在文件扩展名之前添加时间戳"yyyyddMM_hhmmssSSS"。 失败：文件已存在，计入错误数。 |
| 是否在结果中添加文件名 | Boolean | 否 | 否 | 是否将文件名输出到输出流中。 |
| 成功条件 | 全部正常：指定ftp目录下文件全部成功下载，组件执行结果成功。 获取文件数不小于：指定ftp目录下成功下载文件数大于该值，组件执行结果成功。 错误数小于：指定ftp目录下文件下载失败文件数小于该值，组件执行结果成功。 | |||
| 数量 | Int | 否 | 0 | 指定获取文件数/错误数数量 |