Wiki source code of Listener
Last modified by Outhman Moustaghfir on 2024/02/16 10:33
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = Overview = | ||
| 2 | |||
| 3 | The Listener connector plays a crucial role in detecting files that haven't been identified by any other listener. It automatically detects such files and triggers the execution of their respective scenarios. | ||
| 4 | |||
| 5 | = Icon = | ||
| 6 | |||
| 7 | [[image:Capture d'écran 2024-02-15 153516.png]] | ||
| 8 | |||
| 9 | = Execution and Variables = | ||
| 10 | |||
| 11 | During the execution of the scenario, the Listener connector generates the following variables, which can be utilized within the scenario: | ||
| 12 | |||
| 13 | * **iXProtocol:** Protocol used for sending the file (e.g., SFTP, FTP, AS2). | ||
| 14 | * **iXProfileID:** ID of the configuration name used for sending the file. | ||
| 15 | * **iXFileName:** Name of the input file. | ||
| 16 | * **envParent:** Environment information. | ||
| 17 | * **iXDir:** Directory where the listener listens for the input file. | ||
| 18 | * **iXFileType:** Type of the input file (e.g., txt, xml, pdf). | ||
| 19 | |||
| 20 | = Exemple : = | ||
| 21 | |||
| 22 | Consider a scenario with an SFTP Listener configured as follows: | ||
| 23 | |||
| 24 | [[image:Capture d'écran 2024-02-16 10091f7.png]] | ||
| 25 | |||
| 26 | |||
| 27 | and we have this scenario : | ||
| 28 | |||
| 29 | [[image:Capture d'écran 2024-02-16 101132.png]] | ||
| 30 | |||
| 31 | And a scenario where a file test.txt is sent by the user sftpDvp. If the file is not detected by any Listener, the Listener connector will trigger the scenario. | ||
| 32 | |||
| 33 | For this example, the generated variables will be: | ||
| 34 | |||
| 35 | * **iXProtocol:** SFTP | ||
| 36 | * **iXProfileID:** sftpDvp | ||
| 37 | * **iXFileName:** test.txt | ||
| 38 | * **envParent:** iXPath | ||
| 39 | * **iXDir:** / | ||
| 40 | * **iXFileType:** txt | ||
| 41 | |||
| 42 | = Conclusion = | ||
| 43 | |||
| 44 | The Listener connector acts as a safety net by identifying files that have not been detected by other listeners. It ensures that any unattended files trigger the execution of their designated scenarios. | ||
| 45 | |||
| 46 |