Product Knowledge Base

Space shortcuts

Page tree

Diagram

Elements

ResultSet
References Notes

This handles the result set of a Selection of files from a source host. The result set can be written into a file or checked against an expectation.

Element Type Required Description
ResultSetFile string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

If the value of this parameter specifies a valid filename then the result set of a Selection of files from a source host will be written to this file.

The result set file is located on the host that runs the YADE Client.

CheckResultSetCount
  • Occurrence: 0..1
Optional

Check number of expected hits in result-list.
ExpectedResultSetCount int
  • Pattern: [\-+]?[0-9]+
  • Whitespace: collapse
  • Occurrence: 1
Required
References Notes

Number of expected hits in result-list.
RaiseErrorIfResultSetIs string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 1
Required
References Notes

This parameter has only an effect if the YADE Client is operated with JobScheduler.

This parameter specified a comparison operator. With this parameter YADE can be caused to raise an error if the number of files that are subject to a file transfer operation does not correspond to the expected number of files.

Use of this parameter requires

  • the number of expected files to be specified with the ExpectedSizeOfResultSet parameter

At run-time the specified value is compared to the effective number of files. In case of a missing match an error is raised.

Possible values of this parameter are:

  • for equal
    • =
    • ==
    • eq
    • equal
  • for not equal
    • !=
    • <>
    • ne
    • not equal
  • for less than
    • <
    • lt
    • less than
  • for less or equal
    • <=
    • le
    • less or equal
  • for greater or equal
    • >=
    • ge
    • greater or equal
  • for greater than
    • >
    • gt
    • greater than

Example:

  • Assuming that the parameter RaiseErrorIfResultSetIs is set "=" and the parameter ExpectedSizeOfResultSet is set to the value "1".
  • If the number of files does not match "1" then an error will raised.
EmptyResultSetState string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

This parameter is used to specify the processing if

  • no files are found that are subject to a file transfer operation and
  • the YADE Client is operated in job chain with JobScheduler.
For that situation this parameter specifies the a job chain node for which processing of the job chain should be continued. The job chain node is identified by its state which is the value of this parameter.

The respective job chain node is expected to handle the situation of missing files, e.g. to repeat processing.

The respective job chain node is only reached if no errors occurred. In particular, please note that the parameter DisableErrorOnNoFilesFound has to be "true".

 

  • No labels