top of page

Unlock the Power of File Listeners in Dev Studio: A Practical Guide

To create a File Listener in Dev Studio, follow these steps: 

  • In the Dev Studio header, click on Create -->Integration Resources --> File Listener

  • In the Short Description field, provide a meaningful description for the file listener. 

  • In the Listener Name field, enter a name for the file listener. Ensure that the name begins with a letter and includes only letters, numbers, and hyphens. 

  • Click on Create and open

  • In the Listener Nodes section, choose how the listener nodes will start. 

a. Block Startup: If this option is selected, the file listener will not start. If this option is cleared, the file listener will start automatically during system startup or can be initiated from Admin Studio. 

b. Run on All Nodes: This option allows the file listener to start on all servers within the cluster. 

 c. Node-Based Startup: With this option, the file listener starts only on designated nodes. 

  • In the Node ID field, for a multi-node cluster, specify the node ID(s) of the server host node(s) where you want the file listener to operate. When a server starts, it activates the file listener on the current node if it matches any node in the provided list. If a node is defined, the current node must correspond to a name in this list to enable the file listener. If no nodes are specified, the file listener will not be activated on any node. 

 

d. Host-Based Startup: This option allows the file listener to start on a specified number of nodes located on particular servers within the cluster. 

  • In the Host Name field, enter the network location of the host server where the file listener should initiate. 

  • In the Node Count field, specify the number of nodes on which the file listener should start. 

 

e. Node Classification-Based Startup: This option enables the file listener to start on specific types of nodes. 

  • Click Add a row.    

  • In the Node Type field, select the type of node where you want the file listener to start. 

  • If you want to delete all instances from the Log-Connect-AssignedNodes class to enable the file listeners to be restarted, select the Reset Startup option. 

 

Source Properties Configuration: 

        In the Source Properties section, you need to configure the relevant settings. 

        In the Source Location field, enter the file specification that the file listener will use to locate input files. 

In the Source Name Mask field, specify the filter for selecting files to process from the source location directory. You can use an asterisk (*) as a wildcard. You are allowed to include only one asterisk at the root of the mask (before the period) and one asterisk in the file type. If you don’t specify a mask or use ‘.’, the file listener will select all files in the source location. 

Optional: If you want the file listener to process files without considering case sensitivity in file names, select Disable Case Sensitivity

Listener Properties Configuration: 

  1. In the Concurrent Threads field, enter the number of threads that the listener requestor will create on each server node when it starts. You should enter 1 or a small integer. Each thread processes a single file. Keep in mind that multithreading is only beneficial when multiple files are available for processing simultaneously. If the node where the file listener is running has sufficient JVM memory and CPU resources, using 2 to 5 threads can enhance throughput when multiple files are present. 

2. In the Service Package field, select the file service that the file listener will link to. 

3. In the Service Class field, choose the appropriate service class. 

4. In the Service Method field, select the desired service method. 

5. If the file service requires authenticated requestors, configure the requestor login information in the Requestor Login section: 

     a. In the Requestor User ID field, select the operator ID that the file listener will use for logging in. This operator ID determines the access group and, consequently, the ruleset list for the file listener. 

      b. In the Password field, enter the password associated with the operator ID. 

6. Click Save


Optional: You can test connectivity for all startup modes except Blocked Startup. Click on Test Connectivity to verify that your system can locate the directory. The system will attempt to create the listener thread on the current node and access the device and directory. The results of the test will be displayed, including the parameters used, the steps attempted, and the outcome of each step. 


--Team Enigma








1 view0 comments

Comments


bottom of page