metadata.xsd 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. Licensed Materials - Property of IBM
  4. IBM Cognos Products: moser
  5. (C) Copyright IBM Corp. 2015, 2021
  6. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. -->
  8. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" version="7.4">
  9. <xsd:complexType name="propertyType">
  10. <xsd:annotation>
  11. <xsd:documentation>generic properties.</xsd:documentation>
  12. </xsd:annotation>
  13. <xsd:sequence>
  14. <xsd:element name="name" type="xsd:string" minOccurs="0"/>
  15. <xsd:element name="value" type="xsd:string" minOccurs="0"/>
  16. </xsd:sequence>
  17. </xsd:complexType>
  18. <xsd:complexType name="baseObjectType">
  19. <xsd:annotation>
  20. <xsd:documentation>The base metadata object. used as base object class in JAVA code for tree walking.</xsd:documentation>
  21. </xsd:annotation>
  22. <xsd:sequence>
  23. <xsd:element name="idForExpression" type="xsd:string" minOccurs="0">
  24. <xsd:annotation>
  25. <xsd:documentation>fully qualified object identifier generated for expression definition.</xsd:documentation>
  26. </xsd:annotation>
  27. </xsd:element>
  28. </xsd:sequence>
  29. </xsd:complexType>
  30. <xsd:complexType name="physicalObjectType">
  31. <xsd:annotation>
  32. <xsd:documentation>The physical metadata object.</xsd:documentation>
  33. </xsd:annotation>
  34. <xsd:complexContent>
  35. <xsd:extension base="baseObjectType">
  36. <xsd:sequence>
  37. <xsd:element name="name" type="xsd:string">
  38. <xsd:annotation>
  39. <xsd:documentation>The object name as it is known by the underlying data source.</xsd:documentation>
  40. </xsd:annotation>
  41. </xsd:element>
  42. <xsd:element name="description" type="xsd:string" minOccurs="0">
  43. <xsd:annotation>
  44. <xsd:documentation>The object description.</xsd:documentation>
  45. </xsd:annotation>
  46. </xsd:element>
  47. <xsd:element name="hidden" type="xsd:boolean" default="false" minOccurs="0">
  48. <xsd:annotation>
  49. <xsd:documentation>If true, the object is hidden in database.</xsd:documentation>
  50. </xsd:annotation>
  51. </xsd:element>
  52. <xsd:element name="originalName" type="xsd:string" minOccurs="0">
  53. <xsd:annotation>
  54. <xsd:documentation>The original object name which might be different than how it is referred in the undelying data source.</xsd:documentation>
  55. </xsd:annotation>
  56. </xsd:element>
  57. </xsd:sequence>
  58. </xsd:extension>
  59. </xsd:complexContent>
  60. </xsd:complexType>
  61. <xsd:complexType name="objectType">
  62. <xsd:annotation>
  63. <xsd:documentation>The base metadata object.</xsd:documentation>
  64. </xsd:annotation>
  65. <xsd:complexContent>
  66. <xsd:extension base="baseObjectType">
  67. <xsd:sequence>
  68. <xsd:annotation>
  69. <xsd:documentation>identification and description</xsd:documentation>
  70. </xsd:annotation>
  71. <xsd:element name="identifier" type="xsd:string">
  72. <xsd:annotation>
  73. <xsd:documentation>The object identifier. (LETTER | "_") (LETTER | DIGIT | "_")* </xsd:documentation>
  74. </xsd:annotation>
  75. </xsd:element>
  76. <xsd:element name="description" type="xsd:string" minOccurs="0">
  77. <xsd:annotation>
  78. <xsd:documentation>The object description. Translatable</xsd:documentation>
  79. </xsd:annotation>
  80. </xsd:element>
  81. <xsd:element name="label" type="xsd:string" minOccurs="0">
  82. <xsd:annotation>
  83. <xsd:documentation>The object label. Translatable</xsd:documentation>
  84. </xsd:annotation>
  85. </xsd:element>
  86. <xsd:element name="comment" type="xsd:string" minOccurs="0">
  87. <xsd:annotation>
  88. <xsd:documentation>Module developer comment. not Translatable</xsd:documentation>
  89. </xsd:annotation>
  90. </xsd:element>
  91. <xsd:element name="screenTip" type="xsd:string" minOccurs="0">
  92. <xsd:annotation>
  93. <xsd:documentation>Defines the text that will be displayed when a user passes the cursor over an interface element. Translatable</xsd:documentation>
  94. </xsd:annotation>
  95. </xsd:element>
  96. <xsd:element name="hidden" type="xsd:boolean" default="false" minOccurs="0">
  97. <xsd:annotation>
  98. <xsd:documentation>If true, the object is hidden in Metadata Tree View.</xsd:documentation>
  99. </xsd:annotation>
  100. </xsd:element>
  101. <xsd:element name="property" type="propertyType" minOccurs="0" maxOccurs="unbounded">
  102. <xsd:annotation>
  103. <xsd:documentation>Generic property container.</xsd:documentation>
  104. </xsd:annotation>
  105. </xsd:element>
  106. <xsd:element name="propertyOverride" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
  107. <xsd:annotation>
  108. <xsd:documentation>List of properties name that this object override. Only valid if the object is not copy.</xsd:documentation>
  109. </xsd:annotation>
  110. </xsd:element>
  111. <xsd:element name="editMode" type="editModeType" default="RW" minOccurs="0">
  112. <xsd:annotation>
  113. <xsd:documentation>Transient property to control which aspects of the object are allowed to be changed/overridden. E.g. for objects from FM this will be set to RO, it will be set for all instances of objectType for the FM package.</xsd:documentation>
  114. </xsd:annotation>
  115. </xsd:element>
  116. </xsd:sequence>
  117. </xsd:extension>
  118. </xsd:complexContent>
  119. </xsd:complexType>
  120. <xsd:simpleType name="instanceType">
  121. <xsd:annotation>
  122. <xsd:documentation>The instance type. Copy is default instance type</xsd:documentation>
  123. </xsd:annotation>
  124. <xsd:restriction base="xsd:NMTOKEN">
  125. <xsd:enumeration value="copy">
  126. <xsd:annotation>
  127. <xsd:documentation>This instance is a copy of another instance.</xsd:documentation>
  128. </xsd:annotation>
  129. </xsd:enumeration>
  130. <xsd:enumeration value="local">
  131. <xsd:annotation>
  132. <xsd:documentation>This instance is defined locally.</xsd:documentation>
  133. </xsd:annotation>
  134. </xsd:enumeration>
  135. <xsd:enumeration value="missing">
  136. <xsd:annotation>
  137. <xsd:documentation>
  138. This instance is a reference of another instance. However, the referenced instance is missing.
  139. This value is a feedback message to client.
  140. Module that has metadata objects with missing instanceType is invalid. Saving an invalid module is not allowed.
  141. </xsd:documentation>
  142. </xsd:annotation>
  143. </xsd:enumeration>
  144. <xsd:enumeration value="reference">
  145. <xsd:annotation>
  146. <xsd:documentation>This instance is a reference of another instance.</xsd:documentation>
  147. </xsd:annotation>
  148. </xsd:enumeration>
  149. </xsd:restriction>
  150. </xsd:simpleType>
  151. <xsd:simpleType name="editModeType">
  152. <xsd:annotation>
  153. <xsd:documentation>Transient property to control which aspects of the object are allowed to be changed/overridden.</xsd:documentation>
  154. </xsd:annotation>
  155. <xsd:restriction base="xsd:NMTOKEN">
  156. <xsd:enumeration value="RW">
  157. <xsd:annotation>
  158. <xsd:documentation>All aspects of the object are editable.</xsd:documentation>
  159. </xsd:annotation>
  160. </xsd:enumeration>
  161. <xsd:enumeration value="RO">
  162. <xsd:annotation>
  163. <xsd:documentation>The object is read-only.</xsd:documentation>
  164. </xsd:annotation>
  165. </xsd:enumeration>
  166. </xsd:restriction>
  167. </xsd:simpleType>
  168. </xsd:schema>