Use the the FTP Delete File activity to delete specific
files from the specific directories, during run time.
Typically the
FTP Delete File activity is used in conjunction
with the
FTP List Files activity as shown in the following
example orchestration:
- The Schedule Job activity creates an orchestration job
every hour.
- The FTP List Files activity generates a list of files found
in the \temp directory located in the root directory of the FTP Server
and stores the result into a string.
- The Read Flat File activity parses the list of files and
stores the result into a repeating XML structure.
- The For Each activity iterates through repeating structure
that contains the list of files:
- If file ends in the .tmp extension, the FTP Delete File activity
deletes the specified file.
For an example project that uses an
FTP Delete File activity,
see
Analizar ejemplo de listado de directorio.
Symbolic link
The
FTP Delete File activity
supports symbolic links to directories if the following conditions
are true:
- If symbolic links to directories are supported by operating system
that hosts the FTP Server.
- If symbolic links to directories are supported by the FTP Server
itself.
To determine the specific symbolic link support for a specific
FTP Server on a specific operating system, see your operating system
and FTP Server documentation.
Adding an FTP Delete File activity in the orchestration
- Create or open an orchestration. A graphical representation of
the orchestration is displayed.
- Select the Activities tab and expand the
FTP folder.
- Drag the Delete File activity onto the orchestration.
- Select the activity. The Checklist is displayed.
Creating, selecting, or editing an FTP endpoint
- Click Pick Endpoint task from the Checklist and
choose from one of the following actions:
- Select an existing endpoint:
- Select Browse. The Project Explorer is
displayed.
Attention: Specifying a new FTP Endpoint with
a different directory structure than the original FTP Endpoint can
cause the orchestration job to fail during run time. You must either
specify a new FTP Server that matches the directory structure of the
originally specified FTP Server or change the configured directory
of the In Directory field by clicking Browse as
described in the "Configure the activity" procedure.
- Select an existing endpoint and click OK.
Go to the "Configuring the activity" procedure.
- Select an existing endpoint and edit the endpoint:
- Select Browse. The Project Explorer is
displayed.
- Select an existing endpoint and click OK.
Attention: Specifying a new FTP Endpoint with a different directory
structure than the original FTP Endpoint can cause the orchestration
job to fail during run time. You must either specify a new FTP Server
that matches the directory structure of the originally specified FTP
Server or change the configured directory of the In Directory field
by clicking Browse as described in the "Configuring
the activity" procedure.
- Click Edit. The Edit Endpoint pane is displayed.
- Create a new endpoint: Select New. The
Create Endpoint pane is displayed.
- Create or edit an FTP endpoint: Creación o edición de un punto final FTP
Configuring the activity
- Select the Configure task from the Checklist. The
Configure pane is displayed.
- Configure the fields in this pane as described in the following
table:
Table 1. Field |
Description |
Look for |
|
File Named |
This field is not used for this activity. You
specify the name of the file to delete using the filename input
parameter of the Map Input task. |
In Directory |
Specifies the directory on the FTP server where
the Integration Appliance deletes the specified file. You can specify
a directory using one of the following options:- Directly enter directory path by clicking in the field and typing
in one of the following directory paths:
- Relative directory path, for example: /process.
(Assumes that FTP home has been configured for the user account that
connects to the FTP Server. See "Note" for more information.)
- Complete directory path, for example on a UNIX machine: /home/user/process.
- Click Browse... to populate the drown-down
list of available directories. Select the appropriate directory from
the drop-down list.
During run time, the value specified in the In Directory field
of the Configure task is overwritten if a value is provided
for the optional directory input parameter using
one of the following options: - The directory input parameter is mapped to
a variable.
- A default value is provided for the directory input
parameter.
For more information, see the "Mapping the input of the activity" procedure.Note: UNIX: If you specify a relative
directory path when connecting to an FTP Server on a UNIX machine, verify that the FTP home directory
has been correctly specified in the /etc/password file
for the user account connecting to the FTP Server.
|
Specifying the retry options
- Select the Retry task from the Checklist. The Retry
pane is displayed.
- Configure the retry options for connecting to an FTP Server. The
following table describes the retry options for connecting to an FTP
Server:
Table 2. Field |
Description |
Retry |
|
1) Wait ___ second(s) between each retry. |
The number of seconds that the Integration Appliance
waits before trying to establish a connection to the FTP Server. |
2) Try to connect ___ times before failing. |
Specifies the maximum number of times the Integration
Appliance attempts to establish a connection to the FTP Server before
issuing an error and stopping the processing of the current orchestration
job. If you deploy an orchestration that contains an FTP Delete
File activity and the Integration Appliance cannot connect to
the specified FTP Server, the Integration Appliance logs the connections
errors as warnings in the system and orchestration logs until the
retry count value is reached. When the retry count is reached, the
Integration Appliance logs an error in the system and orchestration
logs and the stops processing the current orchestration job.
For
example, you set the retry count to 3. The first, second, and third
connection errors are shown in the system log as warnings. The Integration
Appliance logs the fourth connection error as an error and stops processing
the current orchestration job.
|
Mapping the input of the activity
- Select the Map Inputs task in the Checklist. The
Retry pane is displayed. The input parameters of the activity are
displayed in the To Activity pane.
- You must map a variable to the filename input
parameter. All other input parameters are optional. The filename parameter
specifies the name of the file to delete on the FTP Server.
If the input parameter listed in the following table are not
displayed in the To Activity pane of the Map Inputs pane, select from the toolbar menu or right-click in the To Activity
pane and select the Show Optional Parameters option.
If the option is not selectable in the
toolbar menu, click on a node in the Map Inputs pane to make this
option active.
You can optionally override the settings you
specified in the Configure and Pick Endpoint task of
the Checklist dynamically during run time, using the input
parameters defined in the following table.
For example, the
directory on the FTP Server where the Integration Appliance deletes
the file could be set in the Configure task to the directory
called process. During run time, the directory name: processXML could
be passed into the activity using the directory input
parameter. The directory name specified dynamically during run time
overrides the original setting specified in the Configure pane. In
this example, the file would be deleted from the processXML directory.
Table 3. Input Parameter Name/Node |
Description |
Overrides the Setting in Task? |
directory |
Specifies the directory on the FTP server where
the Integration Appliance places the file generated in this activity. |
The directory input parameter
overrides the In Directory field of the Configure task. |
connection/timeout |
Specifies number of seconds before a timeout
occurs between the Integration Appliance attempting to establish a
connection to the endpoint and the time it takes for the endpoint
to respond to the connection request. For the FTP Delete File activity,
the amount of time the Integration Appliance attempts to establish
a connection to the FTP Server before timing out. |
The timeout node of the connection input
parameter overrides the Connection Timeout -Time out after
___ second(s) when establishing a connection to the Endpoint field
of the FTP endpoint. |
connection/host |
Specifies the Host Name or IP address for the
FTP server. |
The host node of the connection input
parameter overrides the Host Name field of
the FTP endpoint. |
connection/port |
Specifies the port number for the specified
host name. The standard port for FTP traffic is 21. The default port
for SFTP traffic is 22. |
The port node of the connection input
parameter overrides the Port field of the FTP
endpoint. |
connection/username |
Specify a user name for the account used to
connect to the FTP Server. |
The username node of the connection input
parameter overrides the User Name field of
the FTP endpoint. |
connection/password |
Specify a password for the account used to connect
to the FTP Server. |
The password node of the connection input
parameter overrides the Password field of the
FTP endpoint. |