Skip to Content

Changes for page Part I. Message Namespace

Last modified by Artur on 2025/09/10 11:19
From version 3.24
edited by Helena
on 2025/06/23 17:27
Change comment: There is no comment for this version
To version 3.23
edited by Helena
on 2025/06/23 17:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -924,132 +924,132 @@
924 924  
925 925  Derivation:
926 926  
927 -* //MessageType// (restriction)
928 -** ConstraintQueryType
927 +//MessageType// (restriction)
928 + ConstraintQueryType
929 929  
930 930  Content:
931 931  
932 -* Header, Query
933 -* Element Documentation:
932 +Header, Query
934 934  
935 -(% style="width:902.294px" %)
936 -|(% style="width:167px" %)**Name**|(% style="width:287px" %)**Type**|(% style="width:445px" %)**Documentation**
937 -|(% style="width:167px" %)Header|(% style="width:287px" %)BasicHeaderType|(% style="width:445px" %)
938 -|(% style="width:167px" %)Query|(% style="width:287px" %)qry: ConstraintQueryType|(% style="width:445px" %)
934 +Element Documentation:
939 939  
936 +|**Name**|**Type**|**Documentation**
937 +|Header|BasicHeaderType|
938 +|Query|qry: ConstraintQueryType|
939 +
940 940  **TransformationSchemeQueryType: **TransformationSchemeQueryType defines the structure of a transformation scheme query message.
941 941  
942 942  Derivation:
943 943  
944 -* //MessageType// (restriction)
945 -** TransformationSchemeQueryType
944 +//MessageType// (restriction)
945 + TransformationSchemeQueryType
946 946  
947 947  Content:
948 948  
949 -* Header, Query
950 -* Element Documentation:
949 +Header, Query
951 951  
952 -(% style="width:833.294px" %)
953 -|(% style="width:165px" %)**Name**|(% style="width:325px" %)**Type**|(% style="width:340px" %)**Documentation**
954 -|(% style="width:165px" %)Header|(% style="width:325px" %)BasicHeaderType|(% style="width:340px" %)
955 -|(% style="width:165px" %)Query|(% style="width:325px" %)qry: TransformationSchemeQueryType|(% style="width:340px" %)
951 +Element Documentation:
956 956  
953 +|**Name**|**Type**|**Documentation**
954 +|Header|BasicHeaderType|
955 +|Query|qry: TransformationScheme QueryType|
956 +
957 957  **VtlMappingSchemeQueryType: **VtlMappingSchemeQueryType defines the structure of a VTL mappings scheme query message.
958 958  
959 959  Derivation:
960 960  
961 -* //MessageType// (restriction)
962 -** VtlMappingSchemeQueryType
961 +//MessageType// (restriction)
962 + VtlMappingSchemeQueryType
963 963  
964 964  Content:
965 965  
966 -* Header, Query
967 -* Element Documentation:
966 +Header, Query
968 968  
969 -(% style="width:843.294px" %)
970 -|(% style="width:164px" %)**Name**|(% style="width:303px" %)**Type**|(% style="width:373px" %)**Documentation**
971 -|(% style="width:164px" %)Header|(% style="width:303px" %)BasicHeaderType|(% style="width:373px" %)
972 -|(% style="width:164px" %)Query|(% style="width:303px" %)qry: VtlMappingSchemeQueryType|(% style="width:373px" %)
968 +Element Documentation:
973 973  
970 +|**Name**|**Type**|**Documentation**
971 +|Header|BasicHeaderType|
972 +|Query|qry: VtlMappingSchemeQuer yType|
973 +
974 974  **NamePersonalisationSchemeQueryType: **NamePersonalisationSchemeQueryType defines the structure of a name personalisation scheme query message.
975 975  
976 976  Derivation:
977 977  
978 -* //MessageType// (restriction)
979 -** NamePersonalisationSchemeQueryType
978 +//MessageType// (restriction)
979 + NamePersonalisationSchemeQueryType
980 980  
981 981  Content:
982 982  
983 -* Header, Query
984 -* Element Documentation:
983 +Header, Query
985 985  
986 -(% style="width:895.294px" %)
987 -|(% style="width:186px" %)**Name**|(% style="width:363px" %)**Type**|(% style="width:343px" %)**Documentation**
988 -|(% style="width:186px" %)Header|(% style="width:363px" %)BasicHeaderType|(% style="width:343px" %)
989 -|(% style="width:186px" %)Query|(% style="width:363px" %)qry: NamePersonalisationSchemeQueryType|(% style="width:343px" %)
985 +Element Documentation:
990 990  
987 +|**Name**|**Type**|**Documentation**
988 +|Header|BasicHeaderType|
989 +|Query|qry: NamePersonalisationS chemeQueryType|
990 +
991 991  **RulesetSchemeQueryType: **RulesetSchemeQueryType defines the structure of a ruleset scheme query message.
992 992  
993 993  Derivation:
994 994  
995 -* //MessageType// (restriction)
996 -** RulesetSchemeQueryType
995 +//MessageType// (restriction)
996 + RulesetSchemeQueryType
997 997  
998 998  Content:
999 999  
1000 -* Header, Query
1001 -* Element Documentation:
1000 +Header, Query
1002 1002  
1003 -(% style="width:886.294px" %)
1004 -|(% style="width:152px" %)**Name**|(% style="width:311px" %)**Type**|(% style="width:420px" %)**Documentation**
1005 -|(% style="width:152px" %)Header|(% style="width:311px" %)BasicHeaderType|(% style="width:420px" %)
1006 -|(% style="width:152px" %)Query|(% style="width:311px" %)qry: RulesetSchemeQueryType|(% style="width:420px" %)
1002 +Element Documentation:
1007 1007  
1004 +|**Name**|**Type**|**Documentation**
1005 +|Header|BasicHeaderType|
1006 +|Query|qry: RulesetSchemeQueryTy pe|
1007 +
1008 1008  **UserDefinedOperatorSchemeQueryType: **UserDefinedOperatorSchemeQueryType defines the structure of a user defined operator scheme query message.
1009 1009  
1010 1010  Derivation:
1011 1011  
1012 -* //MessageType// (restriction)
1013 -** UserDefinedOperatorSchemeQueryType
1012 +//MessageType// (restriction)
1013 + UserDefinedOperatorSchemeQueryType
1014 1014  
1015 1015  Content:
1016 1016  
1017 -* Header, Query
1018 -* Element Documentation:
1017 +Header, Query
1019 1019  
1020 -(% style="width:866.294px" %)
1021 -|(% style="width:174px" %)**Name**|(% style="width:358px" %)**Type**|(% style="width:331px" %)**Documentation**
1022 -|(% style="width:174px" %)Header|(% style="width:358px" %)BasicHeaderType|(% style="width:331px" %)
1023 -|(% style="width:174px" %)Query|(% style="width:358px" %)qry: UserDefinedOperatorSchemeQueryType|(% style="width:331px" %)
1019 +Element Documentation:
1024 1024  
1021 +|**Name**|**Type**|**Documentation**
1022 +|Header|BasicHeaderType|
1023 +|Query|qry: UserDefinedOperatorS chemeQueryType|
1024 +
1025 1025  **CustomTypeSchemeQueryType: **CustomTypeSchemeQueryType defines the structure of a custom type scheme query message.
1026 1026  
1027 1027  Derivation:
1028 1028  
1029 -* //MessageType// (restriction)
1030 -** CustomTypeSchemeQueryType
1029 +//MessageType// (restriction)
1030 + [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CustomTypeSchemeQueryType
1031 1031  
1032 1032  Content:
1033 1033  
1034 -* Header, Query
1035 -* Element Documentation:
1034 +Header, Query
1036 1036  
1037 -(% style="width:828.294px" %)
1038 -|(% style="width:200px" %)**Name**|(% style="width:308px" %)**Type**|(% style="width:317px" %)**Documentation**
1039 -|(% style="width:200px" %)Header|(% style="width:308px" %)BasicHeaderType|(% style="width:317px" %)
1040 -|(% style="width:200px" %)Query|(% style="width:308px" %)qry: CustomTypeSchemeQueryType|(% style="width:317px" %)
1036 +Element Documentation:
1041 1041  
1038 +|**Name**|**Type**|**Documentation**
1039 +|Header|BasicHeaderType|
1040 +|Query|qry: CustomTypeSchemeQuer yType|
1041 +
1042 1042  **ErrorType: **ErrorType describes the structure of an error response.
1043 1043  
1044 1044  Content:
1045 1045  
1046 -* ErrorMessage+
1047 -* Element Documentation:
1046 +ErrorMessage+
1048 1048  
1049 -(% style="width:899.294px" %)
1050 -|**Name**|**Type**|(% style="width:546px" %)**Documentation**
1051 -|ErrorMessage|com: CodedStatusMessageTy pe|(% style="width:546px" %)ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors.
1048 +Element Documentation:
1052 1052  
1050 +|**Name**|**Type**|**Documentation**
1051 +|ErrorMessage|com: CodedStatusMessageTy pe|ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors.
1052 +
1053 1053  **//BaseHeaderType//: **BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this
1054 1054  
1055 1055  Content:
... ... @@ -1058,30 +1058,29 @@
1058 1058  
1059 1059  Element Documentation:
1060 1060  
1061 -(% style="width:891.294px" %)
1062 -|**Name**|**Type**|(% style="width:552px" %)**Documentation**
1063 -|ID|com:IDType|(% style="width:552px" %)ID identifies an identification for the message, assigned by the sender.
1064 -|Test|xs:boolean|(% style="width:552px" %)Test indicates whether the message is for test purposes or not.
1065 -|Prepared|HeaderTimeType|(% style="width:552px" %)Prepared is the date the message was prepared.
1066 -|Sender|SenderType|(% style="width:552px" %)Sender is information about the party that is transmitting the message.
1067 -|Receiver|PartyType|(% style="width:552px" %)Receiver is information about the party that is the intended recipient of the message.
1068 -|com:Name|com:TextType|(% style="width:552px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1069 -|Structure|//com: PayloadStructureType//|(% style="width:552px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1070 -|DataProvider|com: DataProviderReferenceType|(% style="width:552px" %)DataProvider identifies the provider of the data for a data/reference metadata message.
1071 -|DataSetAction|com:ActionType|(% style="width:552px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1072 -|DataSetID|com:IDType|(% style="width:552px" %)DataSetID provides an identifier for a contained data set.
1073 -|Extracted|xs:dateTime|(% style="width:552px" %)Extracted is a time-stamp from the system rendering the data.
1074 -|ReportingBegin|com: ObservationalTimePeriodType|(% style="width:552px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
1075 -|ReportingEnd|com: ObservationalTimePeriodType|(% style="width:552px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
1076 -|EmbargoDate|xs:dateTime|(% style="width:552px" %)EmbargoDate holds a time period before which the data included in this message is not available.
1077 -|Source|com:TextType|(% style="width:552px" %)Source provides human-readable information about the source of the data.
1061 +|**Name**|**Type**|**Documentation**
1062 +|ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1063 +|Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1064 +|Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1065 +|Sender|SenderType|Sender is information about the party that is transmitting the message.
1066 +|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1067 +|com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1068 +|Structure|//com: PayloadStructureType//|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1069 +|DataProvider|com: DataProviderReferenc eType|DataProvider identifies the provider of the data for a data/reference metadata message.
1070 +|DataSetAction|com:ActionType|DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1071 +|DataSetID|com:IDType|DataSetID provides an identifier for a contained data set.
1072 +|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.
1073 +|ReportingBegin|com: ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).
1074 +|ReportingEnd|com: ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).
1075 +|EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.
1076 +|Source|com:TextType|Source provides human-readable information about the source of the data.
1078 1078  
1079 1079  **StructureHeaderType: **StructureHeaderType defines the structure for structural metadata messages.
1080 1080  
1081 1081  Derivation:
1082 1082  
1083 -* //BaseHeaderType// (restriction)
1084 -** StructureHeaderType
1082 +//BaseHeaderType// (restriction)
1083 + StructureHeaderType
1085 1085  
1086 1086  Content:
1087 1087  
... ... @@ -1089,22 +1089,21 @@
1089 1089  
1090 1090  Element Documentation:
1091 1091  
1092 -(% style="width:1099.29px" %)
1093 -|**Name**|(% style="width:224px" %)**Type**|(% style="width:663px" %)**Documentation**
1094 -|ID|(% style="width:224px" %)com:IDType|(% style="width:663px" %)ID identifies an identification for the message, assigned by the sender.
1095 -|Test|(% style="width:224px" %)xs:boolean|(% style="width:663px" %)Test indicates whether the message is for test purposes or not.
1096 -|Prepared|(% style="width:224px" %)HeaderTimeType|(% style="width:663px" %)Prepared is the date the message was prepared.
1097 -|Sender|(% style="width:224px" %)SenderType|(% style="width:663px" %)Sender is information about the party that is transmitting the message.
1098 -|Receiver|(% style="width:224px" %)PartyType|(% style="width:663px" %)Receiver is information about the party that is the intended recipient of the message.
1099 -|com:Name|(% style="width:224px" %)com:TextType|(% style="width:663px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1100 -|Source|(% style="width:224px" %)com:TextType|(% style="width:663px" %)Source provides human-readable information about the source of the data.
1091 +|**Name**|**Type**|**Documentation**
1092 +|ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1093 +|Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1094 +|Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1095 +|Sender|SenderType|Sender is information about the party that is transmitting the message.
1096 +|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1097 +|com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1098 +|Source|com:TextType|Source provides human-readable information about the source of the data.
1101 1101  
1102 1102  **GenericDataHeaderType: **GenericDataHeaderType defines the header structure for a generic data message.
1103 1103  
1104 1104  Derivation:
1105 1105  
1106 -* //BaseHeaderType// (restriction)
1107 -* GenericDataHeaderType
1104 +//BaseHeaderType// (restriction)
1105 + [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataHeaderType
1108 1108  
1109 1109  Content:
1110 1110