What is the purpose of the YADE Background Service?
The principle objective of the YADE Background Service is to collect all file transfer activities through YADE and store them to a database, e.g. MySQL, PostgreSQL, Oracle etc.
The YADE transfer history can then be used for analysis, compliance, alerting, planning, to measure SLAs etc.
The main components of the YADE Background Service are
- JobScheduler running as daemon/service on a server
- YADE history import job chain running inside the JobScheduler
How to transmit the transfer history data to the YADE Background Service?
YADE writes detailed log entries of all file transfers irrespective of their status into the jade_history.csv and jade_history.log.
- jade_history.csv CSV format file
- jade_history.log Log file generated by as per Log4j configuration
There are two possible ways how to transmit the YADE transfer history to the YADE Background Service:
- Near Real Time: immediately after file transfer using TCP/UDP, the YADE Client initiates the transfer.
- Batch Mode: as per scheduled job of the YADE Background Service using file transfer, the YADE Background Service initiates the transfer.
The transfer history can be sent to the YADE Background Service immediately after the file transfer over TCP or UDP. The required parameters for the YADE Background Service, i.e.ServiceHost, ServicePort, TransferMethod (protocol) etc., can be configured in the profile BackgroundService of the jade_settings.ini, which will be used by all the subsequent profiles.
The file name and location of jade_histiry.log and jade_history.csv can be configured by the profile jadeHistory in the file jade_settings.ini, which will be used by all the subsequent profiles. The YADE Background Service will launch tasks (YADE history import job chain) to collect all the jade_history.csv files from different hosts. The jade_histroy.csv files can be received from different YADE Client hosts where YADE is running), to the YADE Background Service, using FTP, SFTP, FTPS, SCP. Once the files have been successfully received by the YADE Background Service then the files will be processed automatically and the transfer history will be imported into the respective database.
Firewall and Port Settings
- The YADE Background Service is using TCP/UDP ports, i.e. 4440 for the JobScheduler Operation Center GUI and to receive the transfer history (TCP/UDP packets), therefore firewall rules should include:
- allow incoming TCP traffic from YADE Client host to YADE Background Service at port 4440.
- allow incoming UDP traffic from YADE Client host to YADE Background Service at port 4440.
- allow incoming TCP traffic from a host accessing the JobScheduler Operation Center GUI and YADE Background Service at port 4440.
- For YADE Background Service to receive jade_history.csv files from the YADE Client hosts the respective ports as per transfer protocol, i.e. FTP 21, SFTP 22, should be allowed by the firewall on YADE Client hosts for the YADE Background Service.