.. _syqada_validate:

###################
syqada validate
###################

>>> syqada validate filename [--config configfile] [--createconfig new-configfile]

This command checks a template, task, or protocol file for complete definition of
parameters and either declares it OK or identifies what the problems are. It can
be especially useful during the development of a workflow, but also during a new
deployment of an existing workflow.

>>> syqada validate filename --config configfile.config

This form of the command is useful for identifying any remaining
unresolved parameter references.  With this form, *syqada validate*
uses the parameters defined in configfile.config to populate
*filename* if *filename* is a template or the template(s) invoked by
filename if it is a task or protocol file, and reports the unresolved
parameters.

>>> syqada validate protocol-file.protocol --createconfig newconfig.config

With this form of the command, *syqada validate* writes a file named
newconfig.config that will contain all the undefined parameters found in
the templates invoked by protocol-file.protocol.

>>> syqada validate protocol-file.protocol --protocol_caching status
With this form of the command, *syqada validate* will compare the cached
protocol files and report simply whether they differ from the reference.

>>> syqada validate protocol-file.protocol --protocol_caching diffs
With this form of the command, *syqada validate* will compare the cached
protocol files and report their differences from the reference on standard error.

>>> syqada validate protocol-file.protocol --protocol_caching force
With this form of the command, *syqada validate* force updates from the reference
to the cached protocol files.