XSD

Allows to do an XSD validation. For example you need to check your Import Table XML file.

Json

Example

{
  "name": "file-validation-xsd",
  "taskReferenceName": "b",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "mode": "FILE",
    "file": "${a.output.file}",
    "xsd": "file://assets/file.xsd",
    "xsdVersion": "1.0",
    "failOnError": true
  }
}

Definition

Property	Type	Required	Description
			The name (or type) of the task
			The unique name of the task in your job. It is used to reference this task in the workflow.
			The functional description of this task in your job.
			The type of the task. It must be SUB_WORKFLOW.
	:		true: the job continues if there is an error on this task. false: the job fails.
			Input parameters of the task. See below

Inputs

Property	Type	Required	Description
	:
			It can reference the output of a previous task, example: ${previous_taskReferenceName.output.file} , or a static file, example: file://assets/file.xlsx, or a user input, example: ${workflow.input.input_key}.
			It can reference the output of a previous task, example: ${previous_taskReferenceName.output.files} , or a user input, example: ${workflow.input.input_key}.
			Your own XSD file.
			Instead of supplying your own schema, validate against one of the platform's - see the schema catalogue below.
		optional	1.0 | 1.1. Defaults to 1.0.
	:		true: the task will fail if only one file is invalid.
	:		Default: false When set to true, the report generation is skipped and thus the report is not available in the output parameters.
	:		Default: info It defines the log level to be recorded in the report. error < warning < info < debug

Outputs

Property	Type	Description
allFilesValid		YES | NO. YES: all files have been validated successfully. NO: at least one file has not been validated.
report		An XML file holding the validation logs. See below.

Validating against a Product-Live schema

The request document of several tasks has a published schema. Rather than maintaining your own copy, set xsdKey to one of these and leave xsd empty:

azure-storage-blob-put-input-request, file-conversion-json-to-xml-input-request, file-generation-archive-input-request, file-generation-xlsx-input-request, protocol-ftp-get-input-request, protocol-ftp-move-input-request, protocol-ftp-post-input-request, protocol-rest-perform-input-request, protocol-soap-perform-input-request, rules-engine-import-rules-input-request, table-import-items-input-request, table-import-schema-input-request

This is the usual way to check a generated request file before feeding it to the task it targets.

Output report log codes

Code	Severity	Raised when
VALIDATION_SUCCESS	info	A file passed validation. The log gives the file name and the time it took.
VALIDATION_ERROR	error	A file failed validation. The log gives the file name and the validation message.
XSD_KEY_INVALID	warning	The xsdKey provided is not one of the keys above.

Limits and additional notes

• The limitation of the input file size is 500 Mb.

FAQ

What is the version of XSD?

XSD 1.0