The <<skip...>> function will force the Agentry Server to skip the step definition in which the function call is contained. This function takes an optional comment argument, the contents of which will be the log message generated by the Server for the log file of the step type’s system connection. This function is only valid when called within the script component of a module-level step definition.
This function can be used during testing to skip over a script that you do not wish to run, or in certain production situations where you may not wish a script to run under certain conditions. The primary intent of this function is the result of the requirements of the contents of a SQL step’s script. This script cannot be empty, nor can it contain only SDML logic with no valid SQL statement to be processed. Depending on conditional processing, such as queries returned by the <<if...>> function, it is possible for a script to return a valid SQL statement in one condition, but not in another. In this situation, the <<skip>> function should be the expression returned when no SQL statement should be run. Note that this function is not limited to SQL step definitions, though this is its primary intended use.
- comment This is an optional argument. It contains any text value that will be used as a log message generated by the Server for the log file of the step type’s system connection.