You can use the action ValidateProcessConfig
to check for errors in a task configuration file.
To validate a task configuration file
Send the action ValidateProcessConfig
to Media Server, including one of the following parameters:
Config
|
A base64 encoded configuration file to validate. |
ConfigName
|
The name of a configuration file to validate, when the configuration file is stored in the directory specified by the ConfigDirectory parameter, in the [Paths] section of the Media Server configuration file. |
ConfigPath
|
The path of a configuration file to validate. |
For example, to validate the configuration facedetect.cfg
, which is stored in the directory specified by the ConfigDirectory
parameter:
http://host:14000/action=ValidateProcessConfig&ConfigName=facedetect
The response to the action includes a processable
element. This contains a Boolean value that indicates whether the configuration could be used to start processing. The value true
indicates that there were no fatal errors. If you have used deprecated configuration parameters or the configuration contains unused parameters these are listed in the errors
element of the response but are not considered to be fatal errors.
A value of true
does not guarantee that processing will succeed, because this might depend on the source media and whether resources (such as another Media Server) are available. If the configuration sends records to another Media Server, the action does not validate configurations on the downstream server.
If errors are detected, they are described in the errors
element of the response.
For more information about this action, refer to the Media Server Reference.