Components

Back Next

Configuring a file listener

Before you create file listeners, verify that the following conditions exist:

The organization has the appropriate licenses.

The file listener is running on the secure agent.

Perform the following steps to configure a file listener:

To create a file listener, click

New

Components

File Listener

, and then click

Create

To edit a file listener, on the

Explore

page, navigate to the file listener. In the row that lists the file listener, click

Actions

and select

Edit

When you edit a file listener, such as update the run-time environment, connector type, connection, or listener rule properties, the file listener requires a reset. A warning message appears. Click

to continue. This action clears the list of previously tracked files.

Configure the following file listener details:

Parameter	Description
File Listener Name	Name of the file listener. A file listener name must be unique within the organization. File listener names can contain alphanumeric characters, spaces, and underscores. The names must begin with an alphabetic character or underscore. File listener names are not case sensitive.
Location	Project directory in which the file listener is created.
Description	Optional description of the file listener. Maximum length is 1024 characters.
Status	Status of the file listener: Enabled or Disabled. A disabled file listener does not listen to files on the designated folder.
Runtime Environment	Runtime environment that contains the Secure Agent used to run the file listener.
Source Type	Type of source to which file listener listens. Select one of the following source types: Server . File listener listens to the server. For more information about parameters and file listener rules that you configure for the server, see Configuring file listener for a server source type. Connector . File listener listens to the connection. For more information about parameters and file listener rules that you configure for the connector, see Configuring file listener for a connector source type.

Configure the schedule by which the file listener runs:

Parameter	Description
Run	Frequency at which the file listener runs, daily, weekly, or monthly.
Start Date	Date on which the file listener starts running.
End Date	Date until which the file listener runs.
Repeat indefinitely	The file listener runs without an end date.
Start At	Time of day when the file listener starts running.
Check Until	Time of day when the file listener stops running.
Check Every	Frequency at which the file listener checks for files in the folder to which it listens, by seconds, minutes, or hours.
Time Zone	Time zone according to which the file listener runs.
Days to Run	Days of the week when the file listener runs when you select to run the file listener weekly.
Day of Month	Day of the month when the file listener runs when you select to run the file listener every month.
Day of Week	Day of the week the file listener runs when you select to run the file listener every month
Week	The week the file listener runs when you select to run the file listener every month. For example, to run the file listener on the fourth Sunday of the month, select Day of Week : Sunday and Week : Fourth .

Under Failure Management, you can select the following options:

Continue to run on failure

. The file listener continues to retry and run in case of a failure, such as a temporary network disruption.

Send a notification on failure

. Receive a notification if the file listener fails. Enter a list of email addresses to which you want to send notifications if the file listener fails.

Use commas to separate a list of email addresses.

Click

Save

File listeners

Configuring file listener for a server source type

Configuring file listener for a connector source type

Add Parameters

Download Guide

Watch

Comments

Cloud Data Integration Homepage

Free Trial