Schema services

Use Schema services to validate objects and to validate the pipeline.

validate

Validates an object using an IS document type, XML document type, or an IS schema.

Input parameters for validate

  • object: Document. Where Document is an IData to be validated.

  • conformsTo: Select the list of document types from the project.

  • maxErrors: String. Optional. Number of errors to be collected. Default value is 1. When the number of errors found is equal to maxErrors, the validation processor stops validation and returns the result. If maxErrors is set to -1, the validation processor returns all errors.

  • ignoreContent: String. Optional. Flag that specifies whether the validation processor will validate content keys of the type String or String List. Set to:

    • true to ignore content (that is, do not validate keys of these types).
    • false to validate content. This is the default.

  • failIfInvalid: String. Optional. Flag that indicates whether the service should fail and throw an exception if the object is invalid. Set to:

    • true to indicate that the service should fail if the object is invalid.
    • false to indicate that service should signal success and return errors to the pipeline if the object is invalid. This is the default. .

Output Parameters for validate

  • isValid: String. Flag that indicates whether or not the validation was successful. A value of:

    • true indicates that the validation was successful.
    • false indicates that the validation was unsuccessful.

  • errors: Document List. Errors encountered during validation. Each document will contain the following information:

    • pathName: String. Location of the error in XQL.
    • errorCode: String. Error code (for example, VV-001).
    • errorMessage: String. Error message (for example, Missing Object).

Usage Notes for validate

  • When validating supplied XML against an IS document type, webMethods Integration uses the Java™ regular expression compiler by default.
  • When validating against an IS document type, if the Allow null property is set to false for a field in the document type and the corresponding element in the instance document carries the attribute xsi:nil, webMethods Integration displays the [] Undefined Object found error.
  • When validating against an IS document type, if the Allow null property is set to false for a field in the document type and the corresponding element in the instance document contains content or contains child elements, webMethods Integration displays the [] FieldName cannot have content or child elements since xsi:nil is true error.
  • When validating XML, webMethods Integration uses the W3C recommendation XML Schema Part 2: Datatypes.

validatePipeline

Validates the pipeline against a document type.

Input parameters for validatePipeline

  • conformsTo: Select the list of document types of a project.

  • maxErrors: String. Optional. Number of errors to be collected. Default value is 1. When the number of errors found is equal to maxErrors, the validation processor stops validation and returns the result. If maxErrors is set to -1, the validation processor returns all errors.

  • ignoreContent: String. Optional. Flag that specifies whether the validation processor will validate content keys of the type String, String List, or String Table. Set to:

    • true to ignore content (that is, do not validate keys of these types).
    • false to validate content. This is the default.

  • failIfInvalid: String. Optional. Flag that indicates whether the service should fail and throw an exception if the object is invalid. Set to:

    • true to indicate that service should fail if object is invalid.
    • false to indicate that service should simply signal success and return errors to the pipeline if object is invalid. This is the default.

Output parameters for validatePipeline

  • isValid: String. Flag that indicates whether or not the validation was successful. A value of:

    • true indicates that the validation was successful.
    • false indicates that the validation was unsuccessful.

  • errors: Document List. Errors encountered during validation. Each document will contain the following information:

    • pathName: String. Location of the error in XQL.
    • errorCode: String. Error code (for example, VV-001).
    • errorMessage: String. Error message (for example, Missing Object).