Skip to end of metadata
Go to start of metadata

Diagram

Elements

Polling
References Notes

Polling is the YADE capability to wait for incoming files.

  • If a file is found then polling is completed and the file transfer starts.
  • If no file is found then YADE would wait for a configurable PollInterval and then repeat the check for incoming files.
  • Having exceeded the PollTimeout YADE will not repeat checks for incoming files but will fail with the respective exception.
Element Type Required Description
PollInterval int
  • Pattern: [\-+]?[0-9]+
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies the time in seconds that will be waited before a new poll for files is carried out.

PollTimeout int
  • Pattern: [\-+]?[0-9]+
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies the total length of time in minutes that a file will be polled for.

  • If the value of this parameter is zero then polling will not be carried out.
  • If a file becomes available within the time specified then it will be transferred, otherwise an error will be raised.
  • Polling will be stopped once one (or more) file(s) have been detected.
MinFiles int
  • Pattern: [\-+]?[0-9]+
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies the minimum number of files that have to be found during the polling period in order to cause the transfer to start. This parameter becomes effective with the PollTimeout parameter.

WaitForSourceFolder boolean
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

This parameter determines the behavior of the polling when the source folder doesn't exist. If the value is "true" and the source folder doesn't exist then the polling continues otherwise it raise an error.

PollErrorState string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

When YADE runs as a job with JobScheduler and is used for polling then this parameter specifies the node of the current job chain that should be executed after the current YADE job if the timeout as specified with the PollTimeout parameter is exceeded without finding a file.

If no state is specified then an error will be raised if no files are found after timeout.

It is required that the parameter PollingServer is "false".

PollingServer boolean
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies YADE to act as a polling server.

  • If this value "false" then the polling server stops after the first polling trial. The first polling trial ends if either the PollTimeout is reached or some files (at least MinFiles) are found.
  • If this value "true" then the polling server starts polling trials endlessly (see PollForever) or until PollingServerDuration is reached. If some files are found inside a polling trial then these files are transferred before the next polling trial is started.

This setting should be "false" if YADE is executed by JobScheduler as JobScheduler itself has mechanisms to start jobs repeatedly.

PollingServerDuration
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies how long the YADE polling server should run.

It is required that the parameter PollingServer is "true".


Supported formats:

  • s(n) - seconds, e.g. 30,180...
  • m(n):s(n) - minutes:seconds, e.g. 10:30, 123:456 ...
  • h(n):m(n):s(n) - hours:minutes:seconds, e.g. 12:30:30, 123456:7:8 ...
PollForever boolean
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies an unbounded duration for Polling and would cause YADE not to terminate after processing of incoming files.

This parameter is an alternative to the PollingServerDuration that specifies a limited duration.

It is required that the parameter PollingServer is "true".

This setting should not be used if YADE is executed by JobScheduler as JobScheduler itself has mechanisms to start jobs repeatedly.

 

  • No labels
Write a comment…