Difference between revisions of "Error Codes"

From Fusion Registry Wiki
Jump to navigation Jump to search
(Created page with "== Error Codes == All Error Codes are assigned a code value which has the format: '''XXX-YYY-ZZZ''' Where: * '''XXX''' is the product code - a three letter alpha-numeric cod...")
 
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
[[Category:Functions]]
 +
[[Category:How_To]]
 +
 +
'''Note:''' error codes were introduced into the Registry in Release 10.5.4
 +
 
== Error Codes ==
 
== Error Codes ==
  
Line 9: Line 14:
  
 
Some typical examples:
 
Some typical examples:
 
 
<pre>
 
<pre>
 
REG-201-140
 
REG-201-140
Line 15: Line 19:
 
000-201-140
 
000-201-140
 
</pre>
 
</pre>
 +
 +
'''Note:''' Assigning error codes is an ongoing activity in our Fusion products, but if you see an error code which is a single dash character ("-") this is where an error has yet to be assigned a code. Please inform Metadata Technology of this issue and it will be addressed.
  
 
==== Product Code ====
 
==== Product Code ====
Line 20: Line 26:
 
* '''REG''' - Fusion Registry
 
* '''REG''' - Fusion Registry
 
* '''EDG''' - Fusion Edge Server
 
* '''EDG''' - Fusion Edge Server
* '''000''' - Un-named product
+
* '''000''' - Unnamed product
 
 
 
 
  
 
==== Module Code ====
 
==== Module Code ====
 
A three digit numeric which identifies the module that caused the error. The module codes defined so far are:
 
A three digit numeric which identifies the module that caused the error. The module codes defined so far are:
* '''100''' - Structural Errors
 
* '''200''' - Data Errors
 
 
* '''201''' - Data Validation
 
* '''201''' - Data Validation
  
Line 34: Line 36:
  
  
==== Data Validation Errors Code ====
+
=== Data Validation Error Codes ===
The following is the list of error codes that can be produced during Data Validation.  
+
The following is the list of error codes that can be produced during Data Validation
 +
 
 +
'''NOTE''': When error codes are reported they will always be prefixed with the Product code. For for the Registry for the error where "''Component '<id>' does not exist in Data Structure''" the produced code is REG-201-001.
  
 
* 201-001 - Component '<id>' does not exist in Data Structure
 
* 201-001 - Component '<id>' does not exist in Data Structure
Line 47: Line 51:
 
* 201-051 - Missing mandatory attribute '<id>'
 
* 201-051 - Missing mandatory attribute '<id>'
 
* 201-101 - Multiple observation values missing from reported time range '<startPeriod>' to '<endPeriod>'
 
* 201-101 - Multiple observation values missing from reported time range '<startPeriod>' to '<endPeriod>'
* 201-131 - Observation value has been specified but OBS_STATUS enforces that this is not valid. OBS_STATUS: <obsStatusValue>
+
* 201-102 - Missing Observation for Time Period: '<timePeriod>'
* 201-132 - Observation value has not been specified but OBS_STATUS enforces that a value must be specified. OBS_STATUS: <obsStatusValue>
+
* 201-130 - Observation value has been specified but OBS_STATUS enforces that this is not valid. OBS_STATUS: <obsStatusValue>
* 201-161 - Invalid Date Format `<obsTime>`
+
* 201-131 - Observation value has not been specified but OBS_STATUS enforces that a value must be specified. OBS_STATUS: <obsStatusValue>
* 201-162 - The Observation Date does not match the expected format for the frequency Dimension: '<freqDimensionId>'. Expected frequency format: '<format>'. Observation Date is: '<obsTime>'
+
* 201-150 - Invalid Date Format `<obsTime>`
* 201-181 - Component '<id>' does not exist in Data Structure
+
* 201-151 - The Observation Date does not match the expected format for the frequency Dimension: '<freqDimensionId>'. Expected frequency format: '<format>'. Observation Date is: '<obsTime>'
* 201-182 - Data Structure Definition does not define an Attribute with Id '<id>'
+
* 201-160 - Failed calculation '<calculationExpression>' for Dimension '<dimensionId>'. Output could not be calculated.
* 201-183 - Data Structure Definition component '<id>' is not an attribute it is a <structureType>
+
* 201-161 - Failed calculation '<calculationExpression>' for Dimension '<dimensionId>'. Output could not be calculated due to error '<errorMessage>'. Inputs to the calculation are '<inputs>'.
* 201-184 - Data Structure Definition attribute '<id>' is not attached to the dataset, it is attached to the: <attachmentLevel>
+
* 201-162 - Failed calculation '<calculationExpression>' for Dimension '<dimensionId>'. Calculation result <result>. Inputs to the calculation are '<inputs>'.
* 201-185 - Data Structure Definition does not define a Group with id '<groupName>'
+
* 201-163 - Failed calculation '<calculationExpression>'for Dimension '<dimensionId>'. Reported Value <value>. Inputs to the calculation are '<inputs>'.
* 201-186 - Data Structure Definition does not define Component '<id>' in Group '<groupId>'
+
* 201-180 - Component '<id>' does not exist in Data Structure
* 201-187 - Missing value for Dimension <id>
+
* 201-181 - Data Structure Definition does not define an Attribute with Id '<id>'
* 201-188 - <conceptid>' does not exist in Data Structure
+
* 201-182 - Data Structure Definition component '<id>' is not an attribute it is a <structureType>
* 201-189 - Observation Attribute '<id>' is not defined by Data Structure: <dsdUrn>
+
* 201-183 - Data Structure Definition attribute '<id>' is not attached to the dataset, it is attached to the: <attachmentLevel>
* 201-200 - Output could not be calculated. Inputs to the calculation are '<inputs>'
+
* 201-184 - Data Structure Definition does not define a Group with id '<groupName>'
* 201-201 - Output could not be calculated due to error '<errorMsg>'. Inputs to the calculation are '<inputs>'
+
* 201-185 - Data Structure Definition does not define Component '<id>' in Group '<groupId>'
* 201-202 - Calculation result [ is greater than or equal to | is greater than | is less than or equal to | is less than | is equal to | does not match expected output of | ] '<expectedValue>'. Inputs to the calculation are '<reportedValues>'. Inputs to the calculation are '<inputs>'
+
* 201-186 - Missing value for Dimension <id>
 +
* 201-187 - '<conceptid>' does not exist in Data Structure
 +
* 201-188 - Series Attribute '<attributeId>' is not defined by Data Structure: <dsdId>
 +
* 201-189 - Observation Attribute '<attributeId>' is not defined by Data Structure: <dsdId>
 +
* 201-190 - Group <groupName> Attribute '<attributeId>' is not defined by Data Structure: <dsdId>
 +
* 201-200 - <componentId> is reporting value '<reportedValue>'' which is not a valid representation in referenced <type> '<id>'
 +
* 201-201 - Reported value '<value>' is not of expected type '<type>'
 +
* 201-202 - Reported value '<value>' for '<componentId>' is not of expected type '<type>'
 +
* 201-203 - Reported value '<value>' for '<componentId>' is expected to be numerical
 +
* 201-204 - Reported value '<value>' for '<componentId>' does not match expected pattern '<pattern>'
 +
* 201-205 - Reported value '<value>' for '<componentId>' exceeds the number of allowed decimal places of <numberOfDecimals>
 +
* 201-206 - Reported value '<value>' for '<componentId>' is shorter than the minimum allowed length of <minLength>
 +
* 201-207 - Reported value '<value>' for '<componentId>' is greater than the maximum allowed length of <maxLength>
 +
* 201-208 - Reported value '<value>' for '<componentId>' is less than the specified start value of <startValue>
 +
* 201-209 - Reported value '<value>' for '<componentId>' is greater than the specified end value of <endValue>
 +
* 201-210 - Reported value '<value>' for '<componentId>' do not fit the allowed intervals starting from <startValue> and increasing by <interval>
 +
* 201-211 - Reported value '<value>' for '<componentId>' is less than the specified min value of <minValue>
 +
* 201-212 - Reported value '<value>' for '<componentId>' is greater than the specified max value of <maxValue>
 +
* 201-213 - Reported value '<value>' for '<componentId>' is before the allowed start time of <date>
 +
* 201-214 - Reported value '<value>' for '<componentId>' is after the allowed start time of <date>
 +
* 201-215 - Duplicate language '<locale>' for TextType
 +
* 201-216 - <textTypeValue> invalid with respect to allowed string : <validPattern>
 +
* 201-217 - <number> reported values for <componentId> exceeds limit of <number>
 +
* 201-218 - {number> reported values for <componentId> is fewer then the minimum required of <number>
 +
* 201-230 - Duplicate value reported for series <seriesCode>. Reported values are: '<value1>' and '<value2>' ( Time Period: <timePeriod> )
 +
* 201-231 - Contradictory '<value>' value reported. Both '<value1>' and '<value2>' have been reported in the same dataset for series '<seriesCode>'
 +
* 201-250 - Disallowed <Dimension | Attribute > Value: <id>=<<nowiki />code>
 +
* 201-251 - No Observations are allowed for this dataset
 +
* 201-252 - No Series are allowed for this dataset
 +
* 201-253 - Series contains values which have been restricted
 +
* 201-254 - Group '<groupName>' contains values which have been restricted
 +
* 201-300 - Illegal observation value - it exceeds 15 characters. Observation value: <obsValue>
 +
* 201-301 - The observation: <obsValue> is invalid.
 +
* 201-302 - The first observation of the time series <seriesCode> is empty. This is not permitted for a time range.
 +
* 201-303 - The last observation of the time series <seriesCode> is empty. This is not permitted for a time range.
 +
* 201-310 - The length of the OBS_STATUS value is greater than the maximum permitted for an EDI Message, which is 35 characters. Supplied value: <value>
 +
* 201-311 - No observation attribute 'OBS_STATUS' present on DSD, but the data contains a value for this attribute
 +
* 201-312 - The length of the OBS_CONF value is greater than the maximum permitted for an EDI Message, which is 35 characters. Supplied value: <value>
 +
* 201-313 - No observation attribute 'OBS_CONF' present on DSD, but the data contains a value for this attribute
 +
* 201-314 - The length of the OBS_PRE_BREAK value is greater than the maximum permitted for an EDI Message, which is 15 characters. Supplied value: <value>
 +
* 201-315 - No observation attribute 'OBS_PRE_BREAK' present on DSD, but the data contains a value for this attribute
 +
* 201-320 - Error processing attribute on line: <lineNo> . Cause: <cause>
 +
* 201-320 - Observation Value should not be present in a delete message.
 +
* 201-321 - OBS_STATUS should not be present in a delete message.
 +
* 201-322 - OBS_CONF should not be present in a delete message.
 +
* 201-323 - OBS_PRE_BREAK should not be present in a delete message.

Latest revision as of 08:02, 4 September 2023


Note: error codes were introduced into the Registry in Release 10.5.4

Error Codes

All Error Codes are assigned a code value which has the format: XXX-YYY-ZZZ

Where:

  • XXX is the product code - a three letter alpha-numeric code identifying the product that has caused the error
  • YYY is the module code - a three digit numeric
  • ZZZ is the identifying error code - a three digit numeric which identifies the error for the particular module

Some typical examples:

REG-201-140
EDG-004-123
000-201-140

Note: Assigning error codes is an ongoing activity in our Fusion products, but if you see an error code which is a single dash character ("-") this is where an error has yet to be assigned a code. Please inform Metadata Technology of this issue and it will be addressed.

Product Code

A three letter alpha-numeric code which identifies the product.

  • REG - Fusion Registry
  • EDG - Fusion Edge Server
  • 000 - Unnamed product

Module Code

A three digit numeric which identifies the module that caused the error. The module codes defined so far are:

  • 201 - Data Validation

Identifying Code

A three-digit number which identifies a unique error code in a module. No further inference of meaning need necessarily be obtainable from the identifying code i.e. It is not necessary to split a modules codes into further divisions in the identifying code, but code assigners will ensure that related codes are close to one another as far as possible.


Data Validation Error Codes

The following is the list of error codes that can be produced during Data Validation.

NOTE: When error codes are reported they will always be prefixed with the Product code. For for the Registry for the error where "Component '<id>' does not exist in Data Structure" the produced code is REG-201-001.

  • 201-001 - Component '<id>' does not exist in Data Structure
  • 201-002 - Data Structure Definition attribute '<id>' is not attached to the dataset, it is attached to the: <attachment level>
  • 201-003 - Data Structure Definition does not define a Group with id '<id>'
  • 201-004 - Observation does not report a TIME_PERIOD
  • 201-005 - Syntax error in reported Time Period: '<obsTime>'
  • 201-006 - Measure Dimension '<id>' is reporting value '<conceptId>' which is not a valid representation in referenced Concept Scheme
  • 201-007 - The reported value '<id>' for '<conceptId>' is not valid for time period '<obsTime>'
  • 201-008 - Date type not recognised : <dateType name>
  • 201-051 - Missing mandatory attribute '<id>'
  • 201-101 - Multiple observation values missing from reported time range '<startPeriod>' to '<endPeriod>'
  • 201-102 - Missing Observation for Time Period: '<timePeriod>'
  • 201-130 - Observation value has been specified but OBS_STATUS enforces that this is not valid. OBS_STATUS: <obsStatusValue>
  • 201-131 - Observation value has not been specified but OBS_STATUS enforces that a value must be specified. OBS_STATUS: <obsStatusValue>
  • 201-150 - Invalid Date Format `<obsTime>`
  • 201-151 - The Observation Date does not match the expected format for the frequency Dimension: '<freqDimensionId>'. Expected frequency format: '<format>'. Observation Date is: '<obsTime>'
  • 201-160 - Failed calculation '<calculationExpression>' for Dimension '<dimensionId>'. Output could not be calculated.
  • 201-161 - Failed calculation '<calculationExpression>' for Dimension '<dimensionId>'. Output could not be calculated due to error '<errorMessage>'. Inputs to the calculation are '<inputs>'.
  • 201-162 - Failed calculation '<calculationExpression>' for Dimension '<dimensionId>'. Calculation result <result>. Inputs to the calculation are '<inputs>'.
  • 201-163 - Failed calculation '<calculationExpression>'for Dimension '<dimensionId>'. Reported Value <value>. Inputs to the calculation are '<inputs>'.
  • 201-180 - Component '<id>' does not exist in Data Structure
  • 201-181 - Data Structure Definition does not define an Attribute with Id '<id>'
  • 201-182 - Data Structure Definition component '<id>' is not an attribute it is a <structureType>
  • 201-183 - Data Structure Definition attribute '<id>' is not attached to the dataset, it is attached to the: <attachmentLevel>
  • 201-184 - Data Structure Definition does not define a Group with id '<groupName>'
  • 201-185 - Data Structure Definition does not define Component '<id>' in Group '<groupId>'
  • 201-186 - Missing value for Dimension <id>
  • 201-187 - '<conceptid>' does not exist in Data Structure
  • 201-188 - Series Attribute '<attributeId>' is not defined by Data Structure: <dsdId>
  • 201-189 - Observation Attribute '<attributeId>' is not defined by Data Structure: <dsdId>
  • 201-190 - Group <groupName> Attribute '<attributeId>' is not defined by Data Structure: <dsdId>
  • 201-200 - <componentId> is reporting value '<reportedValue> which is not a valid representation in referenced <type> '<id>'
  • 201-201 - Reported value '<value>' is not of expected type '<type>'
  • 201-202 - Reported value '<value>' for '<componentId>' is not of expected type '<type>'
  • 201-203 - Reported value '<value>' for '<componentId>' is expected to be numerical
  • 201-204 - Reported value '<value>' for '<componentId>' does not match expected pattern '<pattern>'
  • 201-205 - Reported value '<value>' for '<componentId>' exceeds the number of allowed decimal places of <numberOfDecimals>
  • 201-206 - Reported value '<value>' for '<componentId>' is shorter than the minimum allowed length of <minLength>
  • 201-207 - Reported value '<value>' for '<componentId>' is greater than the maximum allowed length of <maxLength>
  • 201-208 - Reported value '<value>' for '<componentId>' is less than the specified start value of <startValue>
  • 201-209 - Reported value '<value>' for '<componentId>' is greater than the specified end value of <endValue>
  • 201-210 - Reported value '<value>' for '<componentId>' do not fit the allowed intervals starting from <startValue> and increasing by <interval>
  • 201-211 - Reported value '<value>' for '<componentId>' is less than the specified min value of <minValue>
  • 201-212 - Reported value '<value>' for '<componentId>' is greater than the specified max value of <maxValue>
  • 201-213 - Reported value '<value>' for '<componentId>' is before the allowed start time of <date>
  • 201-214 - Reported value '<value>' for '<componentId>' is after the allowed start time of <date>
  • 201-215 - Duplicate language '<locale>' for TextType
  • 201-216 - <textTypeValue> invalid with respect to allowed string : <validPattern>
  • 201-217 - <number> reported values for <componentId> exceeds limit of <number>
  • 201-218 - {number> reported values for <componentId> is fewer then the minimum required of <number>
  • 201-230 - Duplicate value reported for series <seriesCode>. Reported values are: '<value1>' and '<value2>' ( Time Period: <timePeriod> )
  • 201-231 - Contradictory '<value>' value reported. Both '<value1>' and '<value2>' have been reported in the same dataset for series '<seriesCode>'
  • 201-250 - Disallowed <Dimension | Attribute > Value: <id>=<code>
  • 201-251 - No Observations are allowed for this dataset
  • 201-252 - No Series are allowed for this dataset
  • 201-253 - Series contains values which have been restricted
  • 201-254 - Group '<groupName>' contains values which have been restricted
  • 201-300 - Illegal observation value - it exceeds 15 characters. Observation value: <obsValue>
  • 201-301 - The observation: <obsValue> is invalid.
  • 201-302 - The first observation of the time series <seriesCode> is empty. This is not permitted for a time range.
  • 201-303 - The last observation of the time series <seriesCode> is empty. This is not permitted for a time range.
  • 201-310 - The length of the OBS_STATUS value is greater than the maximum permitted for an EDI Message, which is 35 characters. Supplied value: <value>
  • 201-311 - No observation attribute 'OBS_STATUS' present on DSD, but the data contains a value for this attribute
  • 201-312 - The length of the OBS_CONF value is greater than the maximum permitted for an EDI Message, which is 35 characters. Supplied value: <value>
  • 201-313 - No observation attribute 'OBS_CONF' present on DSD, but the data contains a value for this attribute
  • 201-314 - The length of the OBS_PRE_BREAK value is greater than the maximum permitted for an EDI Message, which is 15 characters. Supplied value: <value>
  • 201-315 - No observation attribute 'OBS_PRE_BREAK' present on DSD, but the data contains a value for this attribute
  • 201-320 - Error processing attribute on line: <lineNo> . Cause: <cause>
  • 201-320 - Observation Value should not be present in a delete message.
  • 201-321 - OBS_STATUS should not be present in a delete message.
  • 201-322 - OBS_CONF should not be present in a delete message.
  • 201-323 - OBS_PRE_BREAK should not be present in a delete message.