Retrieves
multiple files from the FTP server based on a file name pattern.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Remote Files Options properties
Properties for defining the files to retrieve.
File Pattern For Remote Files
A
string
value that represents
the a textual pattern that matches the name of the files that you
want to retrieve from the server. The file pattern can use the asterisk
(*) and question mark (?) symbols:
-
Use the asterisk
(*) to represent any series of characters. For example, the pattern
te*.xdp matches the file name test.xdp.
-
Use the question mark (?) to represent any single character.
For example, the pattern te?t.xdp matches the file name test.xdp.
Remote Directory Path
A
string
value that represents
the path to the directory that contains the files that you want
to retrieve.
File Transfer Mode
A
TransferModeEnum
value that
represents the format of the file data that is transferred. Valid
values are
Binary
and
ASCII
.
You
should use binary transfer mode only if you are certain that the
computer that runs the AEM forms Server and the FTP server interpret
ASCII characters in the same way. For example, different types of
computer systems interpret the end-of-file character differently.
Transferring text files from one computer type to another can result
in nonsensical characters being inserted at the end of the file.
However,
transferring files in ASCII mode is marginally faster than transferring
in binary mode.
Connection Settings properties
Use the Connection Settings properties to specify information
required for connecting to the FTP server.
Use Configuration Options
A
boolean
value that specifies
whether to use the settings in the service configuration instead
of the settings specified in the properties of the operation. A value
of
True
means to use the default connection settings
configured for the FTP service. A value of
False
means
to use the settings configured in the properties for the operation.
If
you use a literal value to configure this property, selecting the
Use Configuration Options check box means to use the default connection
properties that are set for the FTP service. If you want to use
the connection settings specified in the operation, deselect the
Use Configuration Options check box
Host
A
string
value that represents
the IP address or URI. For example, you can use the name of the
computer that is resolved by Domain Naming Scheme (DNS).
Port Number
An
int
that represents the port
number for transferring files. The default port number is 21.
User
A
string
value that represents
the user name to connect to the FTP server. No default is provided.
Password
A
string
value that represents
the password to use for authenticating with the FTP server. No default
is provided.
Retrieved Documents properties
Properties that specify how to handle retrieved data.
List Of Documents
The location to save the retrieved files.
The data is a
list
of
document
values.
|
|
|