Difference between revisions of "Filling Out the DD Rule Class"
(Creation - Safety Save) |
(Creation - Safety Save) |
||
| Line 1: | Line 1: | ||
The ability to define Schematron rules gives you another mechanism for validating labels through defined dependencies and contingencies over and above what the XSD Schema standard provides. For example, you can define a rule that requires that any label that contains ''ClassA'' also contains ''ClassB'', or that all calibrated products contain a class with instrument calibration parameters. | The ability to define Schematron rules gives you another mechanism for validating labels through defined dependencies and contingencies over and above what the XSD Schema standard provides. For example, you can define a rule that requires that any label that contains ''ClassA'' also contains ''ClassB'', or that all calibrated products contain a class with instrument calibration parameters. | ||
| − | Each ''<DD_Rule>'' class defines one Schematron | + | Each ''<DD_Rule>'' class defines one Schematron <code><rule></code> definition. The Schematron <code><pattern></code> blocks are generated as needed by ''LDDTool''. |
| − | You should have an understanding of how to write '''XPath''' specifications and Schematron statements before diving in here, or the terminology can be rather opaque. | + | You should have an understanding of how to write '''XPath''' specifications and Schematron statements before diving in here, or the terminology can be rather opaque. There is much more flexibility in Schematron itself than there is in these classes, and you should use them very carefully as this is an area of active ''Ingest_LDD''/''LDDTool'' development. Keep your rules very simple and very explicit, and you should be OK. |
| Line 18: | Line 18: | ||
The value of this attribute is the ''Xpath'' path defining the context for the rule. Specifically, it provides the value of the <code>context</code>'XML attribute of the Schematron <code><rule></code> element. | The value of this attribute is the ''Xpath'' path defining the context for the rule. Specifically, it provides the value of the <code>context</code>'XML attribute of the Schematron <code><rule></code> element. | ||
| − | '''''N.B.'':''' references to elements defined in this local dictionary ''must'' be prepended with the namespace abbreviation defined in the ''<namespace_id>'' at the top of the ''Ingest_LDD'' class. | + | '''''N.B.'':''' references to elements defined in this local dictionary ''must'' be prepended with the namespace abbreviation defined in the ''<namespace_id>'' at the top of the ''Ingest_LDD'' class using the standard colon (':') separator. |
== <rule_assign> == | == <rule_assign> == | ||
| Line 24: | Line 24: | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
| − | This attribute is | + | This attribute is related to adding a Schematron variable definition capability (a <code><let></code> defined inside the <code><rule></code>. This capability is not yet available. Do not use this attribute. |
== <DD_Attribute_Reference> == | == <DD_Attribute_Reference> == | ||
| Line 30: | Line 30: | ||
''REQUIRED'' | ''REQUIRED'' | ||
| − | + | This is a test construct that was inadvertently designated "required". Do not use it. You will have to ignore validation errors complaining that this class is missing. | |
== <DD_Class_Reference> == | == <DD_Class_Reference> == | ||
| Line 36: | Line 36: | ||
''REQUIRED'' | ''REQUIRED'' | ||
| − | + | This is a test construct that was inadvertently designated "required". Do not use it. You will have to ignore validation errors complaining that this class is missing. | |
== <DD_Rule_Statement> == | == <DD_Rule_Statement> == | ||
| Line 42: | Line 42: | ||
''REQUIRED'' | ''REQUIRED'' | ||
| − | This class | + | This class defines the various bits and pieces that go into a single <code><assert></code> or<code><report></code> element. If the corresponding <code><rule></code> element does not already exist, it will be created. |
=== <rule_type> === | === <rule_type> === | ||
| Line 48: | Line 48: | ||
''REQUIRED'' | ''REQUIRED'' | ||
| − | This value indicates the type of test to be defined. | + | This value indicates the type of test to be defined. There are only two defined values you should ever use: |
:::{| | :::{| | ||
| Line 54: | Line 54: | ||
| - | | - | ||
| Creates an <code><assert></code> element within the <code><rule></code>. | | Creates an <code><assert></code> element within the <code><rule></code>. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| align="right" | '''Report''' | | align="right" | '''Report''' | ||
| Line 72: | Line 64: | ||
''REQUIRED'' | ''REQUIRED'' | ||
| − | This attribute contains the text that will go into the <code>test</code> XML attribute of the <code><assert></code> or <code><report></code> element being defined. Make sure that you use the local dictionary namespace abbreviation in all references to elements from this dictionary. | + | This attribute contains the text that will go into the <code>test</code> XML attribute of the <code><assert></code> or <code><report></code> element being defined. Make sure that you use the local dictionary namespace abbreviation in all references to elements from this dictionary. Referencing any other namespace is currently highly problematic and should be avoided. |
| + | |||
| + | The test string must, of course, use the appropriate Schematron test syntax. | ||
=== <rule_message> === | === <rule_message> === | ||
| Line 84: | Line 78: | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
| − | Use this free-text field to provide a human-readable explanation of what is being | + | Use this free-text field to provide a human-readable explanation of what is being tested and why, if it is not already clear from the ''rule_message'' text. This appears to be entirely internal documentation - the description is ''not'' transferred to the output Schematron file produced by ''LDDTool''. |
=== <rule_value> === | === <rule_value> === | ||
| Line 90: | Line 84: | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
| − | This attribute | + | This attribute is deprecated. Do not use it. |
Revision as of 19:39, 27 March 2015
The ability to define Schematron rules gives you another mechanism for validating labels through defined dependencies and contingencies over and above what the XSD Schema standard provides. For example, you can define a rule that requires that any label that contains ClassA also contains ClassB, or that all calibrated products contain a class with instrument calibration parameters.
Each <DD_Rule> class defines one Schematron <rule> definition. The Schematron <pattern> blocks are generated as needed by LDDTool.
You should have an understanding of how to write XPath specifications and Schematron statements before diving in here, or the terminology can be rather opaque. There is much more flexibility in Schematron itself than there is in these classes, and you should use them very carefully as this is an area of active Ingest_LDD/LDDTool development. Keep your rules very simple and very explicit, and you should be OK.
Contents
<local_identifier>
REQUIRED
This value provides a handle for this rule within the dictionary. It must be unique within the Ingest_LDD file.
<rule_context>
REQUIRED
The value of this attribute is the Xpath path defining the context for the rule. Specifically, it provides the value of the context'XML attribute of the Schematron <rule> element.
N.B.: references to elements defined in this local dictionary must be prepended with the namespace abbreviation defined in the <namespace_id> at the top of the Ingest_LDD class using the standard colon (':') separator.
<rule_assign>
OPTIONAL
This attribute is related to adding a Schematron variable definition capability (a <let> defined inside the <rule>. This capability is not yet available. Do not use this attribute.
<DD_Attribute_Reference>
REQUIRED
This is a test construct that was inadvertently designated "required". Do not use it. You will have to ignore validation errors complaining that this class is missing.
<DD_Class_Reference>
REQUIRED
This is a test construct that was inadvertently designated "required". Do not use it. You will have to ignore validation errors complaining that this class is missing.
<DD_Rule_Statement>
REQUIRED
This class defines the various bits and pieces that go into a single <assert> or<report> element. If the corresponding <rule> element does not already exist, it will be created.
<rule_type>
REQUIRED
This value indicates the type of test to be defined. There are only two defined values you should ever use:
Assert - Creates an <assert>element within the<rule>.Report - Creates a <report>element within the<rule>
<rule_test>
REQUIRED
This attribute contains the text that will go into the test XML attribute of the <assert> or <report> element being defined. Make sure that you use the local dictionary namespace abbreviation in all references to elements from this dictionary. Referencing any other namespace is currently highly problematic and should be avoided.
The test string must, of course, use the appropriate Schematron test syntax.
<rule_message>
REQUIRED
This attribute provides the message that will be displayed when the associated assert or report is triggered.
<rule_description>
OPTIONAL
Use this free-text field to provide a human-readable explanation of what is being tested and why, if it is not already clear from the rule_message text. This appears to be entirely internal documentation - the description is not transferred to the output Schematron file produced by LDDTool.
<rule_value>
OPTIONAL
This attribute is deprecated. Do not use it.
