XML Schema

  • Updated

An XML Schema is used to synchronize the rule application schema with an externally defined XML Schema Definition (XSD). To add the schema, click on the Schemas icon in the Navigation Pane and then click the Add button - > XML Schema

mceclip0.pngThe following is a description of the XML Schema Definition form:


The logical name of the XML Schema Definition.

Opening a file from the file or http dialog will import the XSD and display the entities it defines. "Apply to RuleApp" must be selected to actually apply and save the imported information (see "Entities" below).

Load-from Path

Displays the last-loaded XSD path for this schema, if any. Note that this file does not have to be present after it is imported and applied in order to execute the rule application runtime.

Use "file" to browse for an XSD from the file system, and "http" to enter a url path to an XSD.

The "Reload" button will force a resynchronization from the current XSD file. If there has been no change in the XSD file since the last load and apply, a confirmation message will appear.

Global Elements and Types

Lists the complex elements contained in the XSD file, and which ones are selected to be included in the rule app schema.

When a complex element is marked with a checkmark, any complex elements referred to by elements of the just-selected complex element are also automatically checked.

The rule app schema entity, complex field or complex collection name may be aliased by entering a custom value in the "Entity / Complex" column.

Local Elements

List the child elements for the currently selected complex elements, and which ones are selected to be included in the rule app schema.

When a local element which is a complex type is checked, the complex type is also automatically checked.

The rule app schema field or Collection name may be aliased by entering a custom value in the "field" column.

Rule app schema fields may be manually changed from field to Calculation.

Auto Select

Automatically selects other dependent global elements.

Deselect All

De-selects all global elements from the XSD.

Apply to RuleApp

Synchronizes the selected complex elements with the rule app. All existing same-named rule app entities and fields are preserved. A validation warning will occur when saving if Apply has not been run since the schema has last been refreshed via file, http or Reload.

"Last Applied" indicates when this was last performed.

Any fields, collections or calculations not present and selected in the XSD schema child elements set will be removed from the rule app for the selected Entity on Apply, except for "Temporary Storage" fields, Collections and Calculations which may exist in the rule app schema without being selected in the End Point.

View XSD

Loads the XML schema definition in a browser for viewing.

Advanced Settings


  • When enabled, Create Entities for anonymous xs:complexTypes will create an entity for nested complex types. When disabled, nested complex types will be nested as complex fields within the entity schema [enabled by default].
  • Remove Orphaned Entities After Schema Reload indicates any entities left in an orphaned state after the user reloads the XSD will be removed. [unchecked by default]
  • Enabling Bind xs:enumeration restriction fields to value lists will populate the value list with the enumeration content and associate it with the appropriate field. [checked by default]
  • Enabling Create Constraints for xs:enumeration restriction fields will deny values that are not in the newly created value list. If this is checked, the Bind xs:enumeration restriction fields to value lists must also be checked as the constraint cannot be enforced without an associated value list. Leaving this unchecked will allow users to import an XSD containing enumerations without automatically creating these constraints. [unchecked by default]
  • Enabling Embed XSD in rule application will save the XSD along with the rule application. When an XSD is embedded in a rule application, the original XSD can be moved or it's filepath can be altered without affecting the ability to test or save the rule application. Any future changes to the XSD will still have to be manually reapplied to the rule application. [checked by default]
  • Enabling Auto-include dependent cs:complexTypes [checked by default] will include related complex types even if they were not selected for inclusion in the Global elements and types grid.


  • Enabling Validate XML when loaded will perform validations on the XSD standard compliance including but not limited to XML namespace validity, custom Boolean formatting, and local date formatting. XSD validation will always occur on the loaded XML unless an endpoint override is specified at runtime. The endpoint override may specify the use of the embedded XSD or a URL/Filesystem path XSD. [checked by default]
  • Enabling Allow Duplicate Instances will allow XML graphs containing duplicate entity instances to be loaded in either irVerify or in the irSDK object for calling the rule engine, RuleSessionState. For example, if a collection member is duplicated as another member in the same collection, loading this scenario into irVerify will cause errors unless this option is checked. When the option is selected, duplicate instances of the entities are permitted. [unchecked by default]

Validation Errors Tab

Any validation errors related to the XSD import are shown here.

Notes Tab

Allows free-form capture of text to describe the XSD

Was this article helpful?

0 out of 0 found this helpful



Please sign in to leave a comment.