| Table of Contents |
|---|
Introduction
The YADE Background Service provides a centralized transfer history collection, storage and viewing function for any number of YADE Clients. It is important that this service provides both prompt and reliable information and therefore two approaches for handling the history information can be configured in YADE.
Overview
See the YADE Component Architecture article for a schematic overview that includes the Background Service.
The YADE history file
- YADE can be configured to write the history information directly to this file after each transfer session has been completed.
Note that the history information is directly written by YADE and is not an extract from the log files. - The history file is usually located on the same server as the YADE Client itself.
- This file is then read at regular intervals by the (central) JobScheduler that provides the Background Service. This information is then stored in the (central) transfer history database.
- YADE and the Background Service can be configured to limit the size of the history file and avoid read/write conflicts between YADE and the Background Service.
- See the YADE Parameter Reference - SystemPropertyFiles article for more detailed information about the configuration of the YADE history file.
The automatic importing of the history file by the JobScheduler is described in more detail in the YADE Background Service Automation article.
The YADE BackgroundService
There are two methods with which the YADE Background Service can import the file transfer history to a database. Both methods can be applied at the same time to receive file transfer information immediately and reliably.
Immediate and transient history information
- YADE can be configured to send the history information after each transfer session has been completed immediately to the JobScheduler providing the Background Service.
This information is sent using the UDP protocol in a 'fire and forget' manner. - The JobScheduler then uses the YADE Background Service jobs to write the history information to the transfer history database.
- The history information is lost if the JobScheduler providing the Background Service is not available at the time of transmission.
- See the YADE Parameter Reference - BackgroundServiceFragmentRef article for more detailed information about the configuration of the YADE BackgroundService.
Delayed and persistent history information
- The YADE Background Service provides delayed transfer of the history information to the transfer history database and the YADE Background Service History Viewer or other viewing, reporting or notification system.
- The Background Service jobs copy the history file of each YADE instance to a central server and import the data to the transfer history database.
For more information
- See the YADE Component Architecture article for an overview of how YADE, the transfer history and the Background Service integrate and links leading to further information sources.
| Info |
|---|
Alan, diese Seite ist ein Beispiel dafür, wie wir es nicht machen: Sie brauchen keine Parameter zu dokumentieren, das ist längst in der Parameter Reference Documentaton erfolgt und einfach nur redundant. Was stattdessen gebraucht wird, ist eine Erläuterung wie der Background Service funktioniert, wozu ich ihn einsetze und welche Hürden und Kanten es dabei ggf. gibt. Auf keinen Fall werden hier einzelne Parameter beschrieben. |
| Table of Contents |
|---|
Background Service Parameters
Client Parameters
scheduler_host
This parameter specifies the host name or IP address of a server for which Job Scheduler is operated for Managed File Transfer. The contents of an optional history file (see parameter history), is added to a central database by JobScheduler. This parameter causes the transfer of the history entries for the current transfer by UDP to JobScheduler. Should Job Scheduler not be accessible then no errors are reported, instead, the contents of the history will automatically be processed later on.
The default value for this parameter is localhost.
scheduler_job_chain - The name of a job chain
The name of a job chain for Managed File Transfer with Job Scheduler, see parameter scheduler_host. The job chain accepts history entries and performs an import into a (central) database.
The default value for this parameter is scheduler_sosftp_history.
scheduler_port
The TCP-port for which a JobScheduler, see parameter scheduler_host.
The default value for this parameter is 4444.
send_transfer_history - send transfer history to the background service
send transfer history to the background service
The default value for this parameter is false.
scheduler_transfer_method - how to communicate with the BackgroundService
How to communicate with the BackgroundService. Possible values are "UDP" and "TCP".
The default value for this parameter is UDP.
Params to create a history file
Params to control the Transfer History
history - The name of the transfer history file
The value of this parameter specifies a history file. The history file is written in CSV format. The path and name of the history file is specified as value for this parameter. A history record is created for each file that has been transferred.
A history file contains the following columns:
guid
A unique identifier for the history entry. This identifier is used for checking of duplicate entries in combination with Job Scheduler for Managed File Transfer
mandator
A character that denominates the mandator of a file transfer, see respective parameter.
transfer_timestamp
The point in time when the transfer took place.
pid
The process id of the current process that executes the file transfer, see parameter current_pid.
ppid
The process id of the parent of the process that executes the file transfer, see respective parameter.
operation
One of the operations send or receive, see respective parameter.
localhost
The name of the host on which this program is executed.
localhost_ip
The IP address of the host on which this program is executed.
local_user
The name of the user account for which this program is executed.
Target (Remote)_host
The name of the host to/from which a transfer is executed, see parameter host.
Target (Remote)_host_ip
The IP address of the host to/from which a transfer is executed, see parameter host.
Target (Remote)_user
The name of the user account for the Target (Remote) host, see parameter user.
protocol
The protocol can be either ftp, sftp or ftps, see respective parameter.
port
The port on the Target (Remote) host, see respective parameter.
local_dir
The local directory to/from which a file has been transferred, see respective parameter.
Target (Remote)_dir
The Target (Remote) directory to/from which a file has been transferred, see respective parameter.
local_filename
For send operations this is the original file name on the local host.
For receive operations this is the resulting file name on the local host optionally having applied replacement operations, see parameter replacing.
Target (Remote)_filename
For send operations this is the resulting file name on the Target (Remote) host, optionally having applied replacement operations, see parameter replacing.
For receive operations this is the original file name on the Target (Remote) host.
file_size
The size of the transferred file in bytes.
md5
The value of the MD5 hash that is created from the file that was transferred.
status
The status can be either success or error.
last_error_message
Should an error have occurred then the last error message will be given in this column.
log_filename
The name of the log file, see respective parameter.
history_entries - additional entries for the transfer history
additional entries for the transfer history
The default value for this parameter is .
history_repeat
The parameter is used in order to synchronize parallel write access to the history file by multiple instances of this program. This parameter specifies the maximum number of repeat intervals when trying to write to the history file if the history file is locked due to parallel instances of this program.
The default value for this parameter is 3.
history_repeat_interval
The parameter is used in order to synchronize parallel write access to the history file by multiple instances of this program. This parameter specifies the the interval in seconds of repeated trials to write to the history file if the history file is locked due to parallel instances of this program.
The default value for this parameter is 1.
mandator
This parameter specifies the mandator for which a file transfer is effected. The mandator is added to an optional history file, see parameter history and has no technical relevance for the transfer.
The default value for this parameter is SOS.