RDSSchema1.xsd 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. Licensed Materials - Property of IBM
  4. IBM Cognos Products: CCS
  5. (c) Copyright IBM Corp. 2005, 2010
  6. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. -->
  8. <xs:schema xmlns="http://developer.cognos.com/schemas/rds/types/1" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:rdsCM="http://developer.cognos.com/schemas/rds/contentmodel/1" targetNamespace="http://developer.cognos.com/schemas/rds/types/1" elementFormDefault="qualified" attributeFormDefault="unqualified">
  9. <xs:import namespace="http://developer.cognos.com/schemas/rds/contentmodel/1" schemaLocation="./layoutDataXML.xsd"/>
  10. <!--****** Basic Types ******-->
  11. <xs:complexType name="SessionType">
  12. <xs:sequence>
  13. <xs:element name="conversationID" type="rdsCM:StringValue">
  14. <xs:annotation>
  15. <xs:documentation>The storeID of the conversation object stored in CM</xs:documentation>
  16. </xs:annotation>
  17. </xs:element>
  18. <xs:element name="status">
  19. <xs:annotation>
  20. <xs:documentation>The async status, can be either WORKING or COMPLETE</xs:documentation>
  21. </xs:annotation>
  22. <xs:simpleType>
  23. <xs:restriction base="xs:string">
  24. <xs:enumeration value="WORKING"/>
  25. <xs:enumeration value="COMPLETE"/>
  26. </xs:restriction>
  27. </xs:simpleType>
  28. </xs:element>
  29. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  30. </xs:sequence>
  31. <xs:anyAttribute namespace="##any"/>
  32. </xs:complexType>
  33. <xs:complexType name="ResponseStatus">
  34. <xs:sequence>
  35. <xs:element name="responseCode" type="ResponseCodeEnum">
  36. <xs:annotation>
  37. <xs:documentation>A code that specifies whether the response succesed or failed.</xs:documentation>
  38. </xs:annotation>
  39. </xs:element>
  40. <xs:element name="responseMessage" type="rdsCM:StringValue" minOccurs="0">
  41. <xs:annotation>
  42. <xs:documentation>A message that explains the details of the error.</xs:documentation>
  43. </xs:annotation>
  44. </xs:element>
  45. <xs:element name="promptURL" type="rdsCM:StringValue" minOccurs="0"/>
  46. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  47. </xs:sequence>
  48. <xs:anyAttribute namespace="##any"/>
  49. </xs:complexType>
  50. <xs:element name="responseStatus" type="ResponseStatus">
  51. <xs:annotation>
  52. <xs:documentation>Contains status information for the response.</xs:documentation>
  53. </xs:annotation>
  54. </xs:element>
  55. <xs:complexType name="Base64Value">
  56. <xs:simpleContent>
  57. <xs:extension base="xs:base64Binary">
  58. <xs:anyAttribute namespace="##any" processContents="lax"/>
  59. </xs:extension>
  60. </xs:simpleContent>
  61. </xs:complexType>
  62. <!--****** Enumerations ******-->
  63. <xs:simpleType name="ResponseFormatEnum">
  64. <xs:annotation>
  65. <xs:documentation>Enumerations for Response Format</xs:documentation>
  66. </xs:annotation>
  67. <xs:restriction base="xs:string">
  68. <xs:enumeration value="META_ONLY"/>
  69. <xs:enumeration value="META_AND_LAYOUT"/>
  70. <xs:enumeration value="DATA_ONLY"/>
  71. <xs:enumeration value="META_AND_DATA"/>
  72. <xs:enumeration value="ALL"/>
  73. </xs:restriction>
  74. </xs:simpleType>
  75. <xs:simpleType name="ResponseCodeEnum">
  76. <xs:annotation>
  77. <xs:documentation>Enumerations for Response Status</xs:documentation>
  78. </xs:annotation>
  79. <xs:restriction base="xs:string">
  80. <xs:enumeration value="NO_ERROR"/>
  81. <xs:enumeration value="AUTHENTICATION_ERROR"/>
  82. <xs:enumeration value="SERVER_ERROR"/>
  83. <xs:enumeration value="REQUEST_ERROR"/>
  84. <xs:enumeration value="PROMPT_REQUIRED"/>
  85. </xs:restriction>
  86. </xs:simpleType>
  87. <xs:simpleType name="VersionTypeEnum">
  88. <xs:annotation>
  89. <xs:documentation>Enumerations for version specification types.</xs:documentation>
  90. </xs:annotation>
  91. <xs:restriction base="xs:string">
  92. <xs:enumeration value="NEW">
  93. <xs:annotation>
  94. <xs:documentation>NEW - run report to obtain new content (instead of a stored version). This is the default</xs:documentation>
  95. </xs:annotation>
  96. </xs:enumeration>
  97. <xs:enumeration value="LATEST">
  98. <xs:annotation>
  99. <xs:documentation>LATEST -retrieve the latest stored version. If none exists, run the report to obtain new content.</xs:documentation>
  100. </xs:annotation>
  101. </xs:enumeration>
  102. <xs:enumeration value="VERSION_NAME">
  103. <xs:annotation>
  104. <xs:documentation>VERSION_NAME -retrieve the stored version, with the name specified. </xs:documentation>
  105. </xs:annotation>
  106. </xs:enumeration>
  107. </xs:restriction>
  108. </xs:simpleType>
  109. <xs:simpleType name="DirectionEnum">
  110. <xs:annotation>
  111. <xs:documentation>Enumeration of the valid directions.</xs:documentation>
  112. </xs:annotation>
  113. <xs:restriction base="xs:string">
  114. <xs:enumeration value="UP">
  115. <xs:annotation>
  116. <xs:documentation>Drills up to a higher level of granularity</xs:documentation>
  117. </xs:annotation>
  118. </xs:enumeration>
  119. <xs:enumeration value="DOWN">
  120. <xs:annotation>
  121. <xs:documentation>Drills down to a lower level of granularity</xs:documentation>
  122. </xs:annotation>
  123. </xs:enumeration>
  124. </xs:restriction>
  125. </xs:simpleType>
  126. <!--***** Method: Login *****-->
  127. <xs:element name="LoginParam" type="LoginRequest">
  128. <xs:annotation>
  129. <xs:documentation>Logs into IBM Cognos 8</xs:documentation>
  130. </xs:annotation>
  131. </xs:element>
  132. <xs:complexType name="LoginRequest">
  133. <xs:sequence>
  134. <xs:element name="xmlCredential" type="XMLCredential">
  135. <xs:annotation>
  136. <xs:documentation>An XML Crendential object. See the IBM Cognos 8 SDK guide for details on the credential specification.</xs:documentation>
  137. </xs:annotation>
  138. </xs:element>
  139. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  140. </xs:sequence>
  141. <xs:anyAttribute namespace="##any" processContents="lax"/>
  142. </xs:complexType>
  143. <xs:element name="LoginResponse">
  144. <xs:annotation>
  145. <xs:documentation>Response to the login request</xs:documentation>
  146. </xs:annotation>
  147. <xs:complexType>
  148. <xs:sequence>
  149. <xs:element ref="responseStatus"/>
  150. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  151. </xs:sequence>
  152. <xs:anyAttribute namespace="##any" processContents="lax"/>
  153. </xs:complexType>
  154. </xs:element>
  155. <!--**** Method: LogoutAll ******-->
  156. <xs:element name="LogoutAllParam" type="LogoutAllRequest">
  157. <xs:annotation>
  158. <xs:documentation>Logout of all namespaces</xs:documentation>
  159. </xs:annotation>
  160. </xs:element>
  161. <xs:complexType name="LogoutAllRequest">
  162. <xs:sequence>
  163. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  164. </xs:sequence>
  165. <xs:anyAttribute namespace="##any" processContents="lax"/>
  166. </xs:complexType>
  167. <xs:element name="LogoutAllResponse">
  168. <xs:annotation>
  169. <xs:documentation>Response to the logoutAll request</xs:documentation>
  170. </xs:annotation>
  171. <xs:complexType>
  172. <xs:sequence>
  173. <xs:element ref="responseStatus"/>
  174. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  175. </xs:sequence>
  176. </xs:complexType>
  177. </xs:element>
  178. <!--****** Method: Upload File *****-->
  179. <xs:element name="UploadFileParam" type="UploadFileRequest">
  180. <xs:annotation>
  181. <xs:documentation>Uploads a MS Office file to Cognos Connection</xs:documentation>
  182. </xs:annotation>
  183. </xs:element>
  184. <xs:complexType name="UploadFileRequest">
  185. <xs:sequence>
  186. <xs:element name="folder" type="rdsCM:StringValue">
  187. <xs:annotation>
  188. <xs:documentation>Search path to the folder to publish to</xs:documentation>
  189. </xs:annotation>
  190. </xs:element>
  191. <xs:element name="name" type="rdsCM:StringValue">
  192. <xs:annotation>
  193. <xs:documentation>Name of the document</xs:documentation>
  194. </xs:annotation>
  195. </xs:element>
  196. <xs:element name="description" type="rdsCM:StringValue" minOccurs="0">
  197. <xs:annotation>
  198. <xs:documentation>A description of the document</xs:documentation>
  199. </xs:annotation>
  200. </xs:element>
  201. <xs:element name="screenTip" type="rdsCM:StringValue" minOccurs="0">
  202. <xs:annotation>
  203. <xs:documentation>A screen tip to display for this item in Cognos Connection</xs:documentation>
  204. </xs:annotation>
  205. </xs:element>
  206. <xs:element name="fileType" type="FileTypeEnum">
  207. <xs:annotation>
  208. <xs:documentation>Type of file</xs:documentation>
  209. </xs:annotation>
  210. </xs:element>
  211. <xs:element name="fileData" type="Base64Value">
  212. <xs:annotation>
  213. <xs:documentation>Base64 encoded file data</xs:documentation>
  214. </xs:annotation>
  215. </xs:element>
  216. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  217. </xs:sequence>
  218. <xs:anyAttribute namespace="##any" processContents="lax"/>
  219. </xs:complexType>
  220. <xs:element name="UploadFileResponse">
  221. <xs:complexType>
  222. <xs:sequence>
  223. <xs:element ref="responseStatus"/>
  224. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  225. </xs:sequence>
  226. <xs:anyAttribute namespace="##any" processContents="lax"/>
  227. </xs:complexType>
  228. </xs:element>
  229. <!--****** Method: Download File ******-->
  230. <xs:element name="DownloadFileParam" type="DownloadFileRequest">
  231. <xs:annotation>
  232. <xs:documentation>Gets a MS Office file published to Cognos Connection.</xs:documentation>
  233. </xs:annotation>
  234. </xs:element>
  235. <xs:complexType name="DownloadFileRequest">
  236. <xs:sequence>
  237. <xs:element name="searchPath" type="rdsCM:StringValue">
  238. <xs:annotation>
  239. <xs:documentation>The path to the office document in CC.</xs:documentation>
  240. </xs:annotation>
  241. </xs:element>
  242. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  243. </xs:sequence>
  244. <xs:anyAttribute namespace="##any" processContents="lax"/>
  245. </xs:complexType>
  246. <xs:element name="DownloadFileResponse">
  247. <xs:annotation>
  248. <xs:documentation>Respone to the DownloadFile request</xs:documentation>
  249. </xs:annotation>
  250. <xs:complexType>
  251. <xs:sequence>
  252. <xs:element ref="responseStatus"/>
  253. <xs:element name="fileData" type="Base64Value" minOccurs="0">
  254. <xs:annotation>
  255. <xs:documentation>The file in Base64 coded form. Only exists if the request pointed to a valid Office document</xs:documentation>
  256. </xs:annotation>
  257. </xs:element>
  258. </xs:sequence>
  259. </xs:complexType>
  260. </xs:element>
  261. <!--****** Async Method: GetReportInfo ******-->
  262. <xs:element name="GetReportInfoParam" type="GetReportInfoRequest">
  263. <xs:annotation>
  264. <xs:documentation>Used to request the report object structure</xs:documentation>
  265. </xs:annotation>
  266. </xs:element>
  267. <xs:complexType name="GetReportInfoRequest">
  268. <xs:sequence>
  269. <xs:element name="searchPath" type="rdsCM:StringValue">
  270. <xs:annotation>
  271. <xs:documentation>searchPath to the report</xs:documentation>
  272. </xs:annotation>
  273. </xs:element>
  274. <xs:element ref="promptValues" minOccurs="0" maxOccurs="unbounded"/>
  275. <xs:element name="sourceType" type="SourceTypeEnum">
  276. <xs:annotation>
  277. <xs:documentation>The type of resource, such as path, report, conversationID or metrics</xs:documentation>
  278. </xs:annotation>
  279. </xs:element>
  280. <xs:element name="generateRelativeUrl" type="rdsCM:BooleanValue" minOccurs="0">
  281. <xs:annotation>
  282. <xs:documentation>When present and set to true generated URLs will be relative ones</xs:documentation>
  283. </xs:annotation>
  284. </xs:element>
  285. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  286. </xs:sequence>
  287. <xs:anyAttribute namespace="##any" processContents="lax"/>
  288. </xs:complexType>
  289. <xs:complexType name="ReportInfoOutput">
  290. <xs:annotation>
  291. <xs:documentation>Async result of a GetReportInfo request.</xs:documentation>
  292. </xs:annotation>
  293. <xs:sequence>
  294. <xs:element ref="document"/>
  295. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  296. </xs:sequence>
  297. <xs:anyAttribute namespace="##any" processContents="lax"/>
  298. </xs:complexType>
  299. <!--****** Async Method: GetReportContent ******-->
  300. <xs:element name="GetReportContentParam" type="GetReportContentRequest">
  301. <xs:annotation>
  302. <xs:documentation>Retrieves the report content</xs:documentation>
  303. </xs:annotation>
  304. </xs:element>
  305. <xs:complexType name="GetReportContentRequest">
  306. <xs:sequence>
  307. <xs:element name="searchPath" type="rdsCM:StringValue">
  308. <xs:annotation>
  309. <xs:documentation>The searchPath to the object</xs:documentation>
  310. </xs:annotation>
  311. </xs:element>
  312. <xs:element name="rowLimit" type="rdsCM:IntegerValue" minOccurs="0">
  313. <xs:annotation>
  314. <xs:documentation>Maximum number of rows to retrieve</xs:documentation>
  315. </xs:annotation>
  316. </xs:element>
  317. <xs:element name="version" type="versionSelection" minOccurs="0">
  318. <xs:annotation>
  319. <xs:documentation>The version of the report object requested. (May also be a request for a new run).</xs:documentation>
  320. </xs:annotation>
  321. </xs:element>
  322. <xs:element name="burstInfo" type="BurstType" minOccurs="0">
  323. <xs:annotation>
  324. <xs:documentation>Allows selection of a specific burst output for a report version (by specifying a burstKey and/or burstId</xs:documentation>
  325. </xs:annotation>
  326. </xs:element>
  327. <xs:element name="filters" type="Filter" minOccurs="0" maxOccurs="unbounded">
  328. <xs:annotation>
  329. <xs:documentation>Filter definitions to apply to the output</xs:documentation>
  330. </xs:annotation>
  331. </xs:element>
  332. <xs:element name="paged" type="rdsCM:BooleanValue" minOccurs="0"/>
  333. <xs:element name="generateRelativeUrl" type="rdsCM:BooleanValue" minOccurs="0">
  334. <xs:annotation>
  335. <xs:documentation>When present and set to true generated URLs will be relative ones</xs:documentation>
  336. </xs:annotation>
  337. </xs:element>
  338. <xs:element ref="promptValues" minOccurs="0" maxOccurs="unbounded"/>
  339. <xs:element ref="sourceType"/>
  340. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  341. </xs:sequence>
  342. <xs:anyAttribute namespace="##any" processContents="lax"/>
  343. </xs:complexType>
  344. <xs:complexType name="ContentOutput">
  345. <xs:annotation>
  346. <xs:documentation>Aynsc output of the getReportContent request.</xs:documentation>
  347. </xs:annotation>
  348. <xs:choice>
  349. <xs:element ref="rdsCM:document"/>
  350. <xs:element ref="rdsCM:filterResultSet"/>
  351. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  352. </xs:choice>
  353. <xs:anyAttribute namespace="##any" processContents="lax"/>
  354. </xs:complexType>
  355. <!--****** Async Method: GetPromptsAndContent ******-->
  356. <xs:element name="GetPromptsAndContentParam" type="GetPromptsAndContentRequest">
  357. <xs:annotation>
  358. <xs:documentation>Retrieves Content using the saved prompt answers specified by promptID</xs:documentation>
  359. </xs:annotation>
  360. </xs:element>
  361. <xs:complexType name="GetPromptsAndContentRequest">
  362. <xs:sequence>
  363. <xs:element name="searchPath" type="rdsCM:StringValue">
  364. <xs:annotation>
  365. <xs:documentation>The searchPath to the object</xs:documentation>
  366. </xs:annotation>
  367. </xs:element>
  368. <xs:element name="rowLimit" type="rdsCM:IntegerValue" minOccurs="0">
  369. <xs:annotation>
  370. <xs:documentation>Maximum number of rows to retrieve</xs:documentation>
  371. </xs:annotation>
  372. </xs:element>
  373. <xs:element name="version" type="versionSelection" minOccurs="0">
  374. <xs:annotation>
  375. <xs:documentation>The version of the report object requested. (May also be a request for a new run).</xs:documentation>
  376. </xs:annotation>
  377. </xs:element>
  378. <xs:element name="burstInfo" type="BurstType" minOccurs="0">
  379. <xs:annotation>
  380. <xs:documentation>Allows selection of a specific burst output for a report version (by specifying a burstKey and/or burstId</xs:documentation>
  381. </xs:annotation>
  382. </xs:element>
  383. <xs:element name="filters" type="Filter" minOccurs="0" maxOccurs="unbounded">
  384. <xs:annotation>
  385. <xs:documentation>Filter definitions to apply to the output</xs:documentation>
  386. </xs:annotation>
  387. </xs:element>
  388. <xs:element name="promptId" type="rdsCM:StringValue">
  389. <xs:annotation>
  390. <xs:documentation>The id to the prompt answers in the content store</xs:documentation>
  391. </xs:annotation>
  392. </xs:element>
  393. <xs:element name="paged" type="rdsCM:BooleanValue" minOccurs="0"/>
  394. <xs:element name="generateRelativeUrl" type="rdsCM:BooleanValue" minOccurs="0">
  395. <xs:annotation>
  396. <xs:documentation>When present and set to true generated URLs will be relative ones</xs:documentation>
  397. </xs:annotation>
  398. </xs:element>
  399. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  400. </xs:sequence>
  401. </xs:complexType>
  402. <xs:complexType name="PromptAndContentOutput">
  403. <xs:annotation>
  404. <xs:documentation>Async Output of the GetPromptsAndContent request</xs:documentation>
  405. </xs:annotation>
  406. <xs:sequence>
  407. <xs:element name="ContentOutput" type="ContentOutput"/>
  408. <xs:element name="promptValues" type="PromptValue" minOccurs="0" maxOccurs="unbounded"/>
  409. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  410. </xs:sequence>
  411. <xs:anyAttribute namespace="##any" processContents="lax"/>
  412. </xs:complexType>
  413. <!--***** Method: DescribePrompts ******-->
  414. <xs:element name="DescribePromptsParam" type="DescribePromptsRequest"/>
  415. <xs:complexType name="DescribePromptsRequest">
  416. <xs:sequence>
  417. <xs:element name="sourceID" type="rdsCM:StringValue">
  418. <xs:annotation>
  419. <xs:documentation>The source ID of the request</xs:documentation>
  420. </xs:annotation>
  421. </xs:element>
  422. <xs:element ref="sourceType" minOccurs="0"/>
  423. <xs:element name="conversationID" type="rdsCM:StringValue" minOccurs="0">
  424. <xs:annotation>
  425. <xs:documentation>Used if there are multiple promp pages. The response to this request will contain a conversation ID, which must be passed into the the next DescribePromptsRequest to fetch the second page.</xs:documentation>
  426. </xs:annotation>
  427. </xs:element>
  428. <xs:element ref="promptValues" minOccurs="0" maxOccurs="unbounded">
  429. <xs:annotation>
  430. <xs:documentation>The answers from previous prompt pages</xs:documentation>
  431. </xs:annotation>
  432. </xs:element>
  433. <xs:element name="searchPValue" type="searchPValueType" minOccurs="0"/>
  434. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  435. </xs:sequence>
  436. <xs:anyAttribute namespace="##any" processContents="lax"/>
  437. </xs:complexType>
  438. <xs:complexType name="DescribePromptsOutput">
  439. <xs:sequence>
  440. <xs:element name="prompts" type="PItemArray">
  441. <xs:annotation>
  442. <xs:documentation>Prompt Items on this page</xs:documentation>
  443. </xs:annotation>
  444. </xs:element>
  445. <xs:element name="conversationID" type="rdsCM:StringValue" minOccurs="0">
  446. <xs:annotation>
  447. <xs:documentation>If there are additonal prompt pages, this ID must be used to continue the next DescribePrompts request.</xs:documentation>
  448. </xs:annotation>
  449. </xs:element>
  450. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  451. </xs:sequence>
  452. </xs:complexType>
  453. <xs:element name="DescribePromptsResponse">
  454. <xs:complexType>
  455. <xs:sequence>
  456. <xs:element ref="responseStatus"/>
  457. <xs:element name="prompts" type="PItemArray">
  458. <xs:annotation>
  459. <xs:documentation>Prompt Items on this page</xs:documentation>
  460. </xs:annotation>
  461. </xs:element>
  462. <xs:element name="conversationID" type="rdsCM:StringValue">
  463. <xs:annotation>
  464. <xs:documentation>Used for subsequent requests, such as getting the next page or search and select prompts</xs:documentation>
  465. </xs:annotation>
  466. </xs:element>
  467. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  468. </xs:sequence>
  469. </xs:complexType>
  470. </xs:element>
  471. <!--***** Method: GetPrompts ******-->
  472. <xs:element name="GetPromptsParam" type="GetPromptsRequest">
  473. <xs:annotation>
  474. <xs:documentation>Retrieves saved prompt answers from the current user session in Content Manager</xs:documentation>
  475. </xs:annotation>
  476. </xs:element>
  477. <xs:complexType name="GetPromptsRequest">
  478. <xs:sequence>
  479. <xs:element name="promptId" type="rdsCM:StringValue">
  480. <xs:annotation>
  481. <xs:documentation>ID of the prompt location in CM</xs:documentation>
  482. </xs:annotation>
  483. </xs:element>
  484. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  485. </xs:sequence>
  486. <xs:anyAttribute namespace="##any" processContents="lax"/>
  487. </xs:complexType>
  488. <xs:element name="GetPromptsResponse">
  489. <xs:annotation>
  490. <xs:documentation>Response to the GetPrompts request</xs:documentation>
  491. </xs:annotation>
  492. <xs:complexType>
  493. <xs:sequence>
  494. <xs:element ref="responseStatus"/>
  495. <xs:element name="promptValues" type="PromptValue" minOccurs="0" maxOccurs="unbounded">
  496. <xs:annotation>
  497. <xs:documentation>An array of prompt values</xs:documentation>
  498. </xs:annotation>
  499. </xs:element>
  500. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  501. </xs:sequence>
  502. <xs:anyAttribute namespace="##any" processContents="lax"/>
  503. </xs:complexType>
  504. </xs:element>
  505. <!--***** Method: SetPrompts ******-->
  506. <xs:element name="SetPromptsParam" type="SetPromptsRequest">
  507. <xs:annotation>
  508. <xs:documentation>Saves prompt answers to the Content Manager user session</xs:documentation>
  509. </xs:annotation>
  510. </xs:element>
  511. <xs:complexType name="SetPromptsRequest">
  512. <xs:sequence>
  513. <xs:element ref="promptValues" maxOccurs="unbounded"/>
  514. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  515. </xs:sequence>
  516. <xs:anyAttribute namespace="##any" processContents="lax"/>
  517. </xs:complexType>
  518. <xs:element name="SetPromptsResponse">
  519. <xs:complexType>
  520. <xs:sequence>
  521. <xs:element ref="responseStatus"/>
  522. <xs:element name="promptId" type="rdsCM:StringValue"/>
  523. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  524. </xs:sequence>
  525. <xs:anyAttribute namespace="##any" processContents="lax"/>
  526. </xs:complexType>
  527. </xs:element>
  528. <!--***** Method: UpdateIDs ******-->
  529. <xs:element name="UpdateIDsParam" type="UpdateIDsRequest">
  530. <xs:annotation>
  531. <xs:documentation>Updates a list of report element IDs with their new format</xs:documentation>
  532. </xs:annotation>
  533. </xs:element>
  534. <xs:complexType name="UpdateIDsRequest">
  535. <xs:sequence>
  536. <xs:element name="searchPath">
  537. <xs:annotation>
  538. <xs:documentation>searchPath of the report to which these IDs belong.</xs:documentation>
  539. </xs:annotation>
  540. </xs:element>
  541. <xs:element name="id" type="rdsCM:StringValue" maxOccurs="unbounded">
  542. <xs:annotation>
  543. <xs:documentation>List of old format ids to be converted to new format.</xs:documentation>
  544. </xs:annotation>
  545. </xs:element>
  546. <xs:element name="generateRelativeUrl" type="rdsCM:BooleanValue" minOccurs="0">
  547. <xs:annotation>
  548. <xs:documentation>When present and set to true generated URLs will be relative ones</xs:documentation>
  549. </xs:annotation>
  550. </xs:element>
  551. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  552. </xs:sequence>
  553. <xs:anyAttribute namespace="##any" processContents="lax"/>
  554. </xs:complexType>
  555. <xs:complexType name="UpdateIDsOutput">
  556. <xs:annotation>
  557. <xs:documentation>Aynsc output of the updateIDs request.</xs:documentation>
  558. </xs:annotation>
  559. <xs:sequence>
  560. <xs:element name="mappings" type="IDmapping" minOccurs="0" maxOccurs="unbounded"/>
  561. <xs:element name="updatedSearchPath" type="rdsCM:StringValue" minOccurs="0"/>
  562. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  563. </xs:sequence>
  564. <xs:anyAttribute namespace="##any" processContents="lax"/>
  565. </xs:complexType>
  566. <xs:complexType name="IDmapping">
  567. <xs:sequence>
  568. <xs:element name="old" type="rdsCM:StringValue">
  569. <xs:annotation>
  570. <xs:documentation>Old ID value passed in</xs:documentation>
  571. </xs:annotation>
  572. </xs:element>
  573. <xs:element name="new" type="rdsCM:StringValue">
  574. <xs:annotation>
  575. <xs:documentation>New ID value foudn that matches. Will be empty if not found, or if found, but the new element has no new format ID.</xs:documentation>
  576. </xs:annotation>
  577. </xs:element>
  578. <xs:element name="found" type="rdsCM:BooleanValue">
  579. <xs:annotation>
  580. <xs:documentation>True if the passed in "old" ID was found.</xs:documentation>
  581. </xs:annotation>
  582. </xs:element>
  583. </xs:sequence>
  584. <xs:anyAttribute namespace="##any" processContents="lax"/>
  585. </xs:complexType>
  586. <!--****** Async Method: Drill******-->
  587. <xs:element name="DrillParam" type="DrillRequest">
  588. <xs:annotation>
  589. <xs:documentation>Performs a drill operation and retrieves content</xs:documentation>
  590. </xs:annotation>
  591. </xs:element>
  592. <xs:complexType name="DrillRequest">
  593. <xs:sequence>
  594. <xs:element name="contextId" type="rdsCM:StringValue">
  595. <xs:annotation>
  596. <xs:documentation>The contextId related to the object being drilled on</xs:documentation>
  597. </xs:annotation>
  598. </xs:element>
  599. <xs:element name="conversationId" type="rdsCM:StringValue">
  600. <xs:annotation>
  601. <xs:documentation>The identifier of the conversation to identify the report state that is to be drilled on.</xs:documentation>
  602. </xs:annotation>
  603. </xs:element>
  604. <xs:element name="direction" type="DirectionEnum">
  605. <xs:annotation>
  606. <xs:documentation>The direction to drill, up or down</xs:documentation>
  607. </xs:annotation>
  608. </xs:element>
  609. </xs:sequence>
  610. <xs:anyAttribute namespace="##any" processContents="lax"/>
  611. </xs:complexType>
  612. <xs:element name="ReleaseParam" type="ReleaseRequest"/>
  613. <xs:complexType name="ReleaseRequest">
  614. <xs:sequence>
  615. <xs:element name="conversationID" type="rdsCM:StringValue"/>
  616. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  617. </xs:sequence>
  618. <xs:anyAttribute namespace="##any"/>
  619. </xs:complexType>
  620. <xs:element name="ReleaseResponse">
  621. <xs:complexType>
  622. <xs:sequence>
  623. <xs:element ref="responseStatus"/>
  624. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  625. </xs:sequence>
  626. <xs:anyAttribute namespace="##any"/>
  627. </xs:complexType>
  628. </xs:element>
  629. <xs:complexType name="PromptPageRequestType">
  630. <xs:sequence>
  631. <xs:element ref="sourceID">
  632. <xs:annotation>
  633. <xs:documentation>The ID of the resource, such as a report StoreID</xs:documentation>
  634. </xs:annotation>
  635. </xs:element>
  636. <xs:element ref="sourceType"/>
  637. </xs:sequence>
  638. </xs:complexType>
  639. <!--***** Asynchronous Toolkit Objects *****-->
  640. <xs:element name="GetOutputResponse">
  641. <xs:annotation>
  642. <xs:documentation>This element encapsulates all Async Output responses</xs:documentation>
  643. </xs:annotation>
  644. <xs:complexType>
  645. <xs:sequence>
  646. <xs:element ref="responseStatus" minOccurs="0"/>
  647. <xs:element name="asyncStatus" type="AsyncStatus"/>
  648. <xs:element name="output" type="AsyncOutput"/>
  649. <xs:element name="conversationID" type="rdsCM:StringValue" minOccurs="0"/>
  650. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  651. </xs:sequence>
  652. <xs:anyAttribute namespace="##any" processContents="lax"/>
  653. </xs:complexType>
  654. </xs:element>
  655. <xs:element name="CancelOutputResponse">
  656. <xs:complexType>
  657. <xs:sequence>
  658. <xs:element ref="responseStatus"/>
  659. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  660. </xs:sequence>
  661. <xs:anyAttribute namespace="##any" processContents="lax"/>
  662. </xs:complexType>
  663. </xs:element>
  664. <xs:complexType name="AsyncOutput">
  665. <xs:annotation>
  666. <xs:documentation>This object is a container for async output</xs:documentation>
  667. </xs:annotation>
  668. <xs:choice>
  669. <xs:element name="ContentOutput" type="ContentOutput"/>
  670. <xs:element name="PromptAndContentOutput" type="PromptAndContentOutput"/>
  671. <xs:element name="ReportInfoOutput" type="ReportInfoOutput"/>
  672. <xs:element name="DescribePromptsOutput" type="DescribePromptsOutput"/>
  673. <xs:element name="UpdateIDsOutput" type="UpdateIDsOutput"/>
  674. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  675. </xs:choice>
  676. <xs:anyAttribute namespace="##any" processContents="lax"/>
  677. </xs:complexType>
  678. <xs:element name="wait" type="AsyncRequest">
  679. <xs:annotation>
  680. <xs:documentation>Required by AsyncToolkit</xs:documentation>
  681. </xs:annotation>
  682. </xs:element>
  683. <xs:element name="cancel" type="AsyncRequest">
  684. <xs:annotation>
  685. <xs:documentation>Required by AsyncToolkit</xs:documentation>
  686. </xs:annotation>
  687. </xs:element>
  688. <xs:complexType name="AsyncRequest">
  689. <xs:annotation>
  690. <xs:documentation>Container for async request types</xs:documentation>
  691. </xs:annotation>
  692. <xs:choice>
  693. <xs:element name="GetReportContentRequest" type="GetReportContentRequest"/>
  694. <xs:element name="GetReportInfoRequest" type="GetReportInfoRequest"/>
  695. <xs:element name="GetPromptsAndContentRequest" type="GetPromptsAndContentRequest"/>
  696. <xs:element name="DescribePromptsRequest" type="DescribePromptsRequest"/>
  697. <xs:element name="UpdateIDsRequest" type="UpdateIDsRequest"/>
  698. <xs:element name="DrillRequest" type="DrillRequest"/>
  699. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  700. </xs:choice>
  701. </xs:complexType>
  702. <xs:simpleType name="AsyncStatus">
  703. <xs:annotation>
  704. <xs:documentation>Simple enumeration for async status. These values are not extensible</xs:documentation>
  705. </xs:annotation>
  706. <xs:restriction base="xs:string">
  707. <xs:enumeration value="WORKING"/>
  708. <xs:enumeration value="COMPLETE"/>
  709. <xs:enumeration value="READY"/>
  710. </xs:restriction>
  711. </xs:simpleType>
  712. <!--***** Report Content *****-->
  713. <xs:complexType name="ReportContent">
  714. <xs:annotation>
  715. <xs:documentation>Contains the structure of a report.</xs:documentation>
  716. </xs:annotation>
  717. <xs:sequence>
  718. <xs:element ref="rdsCM:document" minOccurs="0"/>
  719. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  720. </xs:sequence>
  721. <xs:anyAttribute namespace="##any" processContents="lax"/>
  722. </xs:complexType>
  723. <xs:complexType name="MetaData">
  724. <xs:sequence>
  725. <xs:element name="document">
  726. <xs:complexType>
  727. <xs:complexContent>
  728. <xs:extension base="MDocument"/>
  729. </xs:complexContent>
  730. </xs:complexType>
  731. </xs:element>
  732. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  733. </xs:sequence>
  734. <xs:anyAttribute namespace="##any" processContents="lax"/>
  735. </xs:complexType>
  736. <xs:element name="metaData" type="MetaData">
  737. <xs:annotation>
  738. <xs:documentation>The metadata structure of the report</xs:documentation>
  739. </xs:annotation>
  740. </xs:element>
  741. <xs:complexType name="Layout">
  742. <xs:sequence>
  743. <xs:element name="page" type="LPage" minOccurs="0" maxOccurs="unbounded"/>
  744. <xs:element ref="rdsCM:styleGroup" minOccurs="0" maxOccurs="unbounded"/>
  745. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  746. </xs:sequence>
  747. <xs:anyAttribute namespace="##any" processContents="lax"/>
  748. </xs:complexType>
  749. <xs:element name="layout" type="Layout">
  750. <xs:annotation>
  751. <xs:documentation>The layout structure of the report</xs:documentation>
  752. </xs:annotation>
  753. </xs:element>
  754. <!--***** Meta Data ******-->
  755. <xs:complexType name="MDocument">
  756. <xs:sequence>
  757. <xs:element ref="rdsCM:id" minOccurs="0"/>
  758. <xs:element ref="page" minOccurs="0" maxOccurs="unbounded"/>
  759. <xs:element ref="layout" minOccurs="0"/>
  760. <xs:element name="parameters" minOccurs="0">
  761. <xs:complexType>
  762. <xs:sequence>
  763. <xs:element name="parameter" type="rdsCM:StringValue" minOccurs="0" maxOccurs="unbounded"/>
  764. <xs:element ref="rdsCM:extension"/>
  765. </xs:sequence>
  766. </xs:complexType>
  767. </xs:element>
  768. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  769. </xs:sequence>
  770. <xs:anyAttribute namespace="##any" processContents="lax"/>
  771. </xs:complexType>
  772. <xs:complexType name="MReportElementArray">
  773. <xs:sequence>
  774. <xs:element name="item" type="MReportElement" minOccurs="0" maxOccurs="unbounded">
  775. <xs:annotation>
  776. <xs:documentation>An array of MetaReportElements. Each meta element corresponds to a ReportElement in the Content Model schema.</xs:documentation>
  777. </xs:annotation>
  778. </xs:element>
  779. </xs:sequence>
  780. <xs:anyAttribute namespace="##any" processContents="lax"/>
  781. </xs:complexType>
  782. <xs:complexType name="MReportElement">
  783. <xs:sequence>
  784. <xs:element name="posId" type="rdsCM:StringValue" minOccurs="0"/>
  785. <xs:element name="conditional" type="rdsCM:BooleanValue" minOccurs="0"/>
  786. <xs:choice>
  787. <xs:element name="MTextFrame" type="MTextFrame"/>
  788. <xs:element name="MImage" type="MImage"/>
  789. <xs:element name="MListFrame" type="MListFrame"/>
  790. <xs:element name="MTableOfContents" type="MTableOfContents"/>
  791. <xs:element name="MChart" type="MChart"/>
  792. <xs:element name="MCrossTab" type="MCrossTab"/>
  793. <xs:element name="MMap" type="MMap"/>
  794. <xs:element name="MMetricDiagram" type="MMetricDiagram"/>
  795. <xs:element name="MHyperlink" type="MHyperlink"/>
  796. <xs:element name="MHTML" type="MHTML"/>
  797. <xs:element name="MRichText" type="MRichText"/>
  798. <xs:element name="MBookmark" type="MBookmark"/>
  799. <xs:element name="MRepeater" type="MRepeater"/>
  800. <xs:element name="MRepeaterTable" type="MRepeaterTable"/>
  801. <xs:element name="MWidget" type="MWidget" minOccurs="0"/>
  802. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  803. </xs:choice>
  804. </xs:sequence>
  805. <xs:anyAttribute namespace="##any" processContents="lax"/>
  806. </xs:complexType>
  807. <xs:complexType name="MPage">
  808. <xs:sequence>
  809. <xs:element ref="rdsCM:id" minOccurs="0"/>
  810. <xs:element name="posId" type="rdsCM:StringValue"/>
  811. <xs:element name="header" type="MReportElementArray" minOccurs="0">
  812. <xs:annotation>
  813. <xs:documentation>Document header elements</xs:documentation>
  814. </xs:annotation>
  815. </xs:element>
  816. <xs:element name="body" type="MReportElementArray" minOccurs="0">
  817. <xs:annotation>
  818. <xs:documentation>Document body elements</xs:documentation>
  819. </xs:annotation>
  820. </xs:element>
  821. <xs:element name="footer" type="MReportElementArray" minOccurs="0">
  822. <xs:annotation>
  823. <xs:documentation>Document footer elements</xs:documentation>
  824. </xs:annotation>
  825. </xs:element>
  826. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  827. </xs:sequence>
  828. <xs:anyAttribute namespace="##any" processContents="lax"/>
  829. </xs:complexType>
  830. <xs:complexType name="MListFrame">
  831. <xs:sequence>
  832. <xs:element ref="rdsCM:id" minOccurs="0"/>
  833. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  834. </xs:sequence>
  835. <xs:anyAttribute namespace="##any" processContents="lax"/>
  836. </xs:complexType>
  837. <xs:complexType name="MTableOfContents">
  838. <xs:sequence>
  839. <xs:element ref="rdsCM:id" minOccurs="0"/>
  840. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  841. </xs:sequence>
  842. <xs:anyAttribute namespace="##any" processContents="lax"/>
  843. </xs:complexType>
  844. <xs:complexType name="MTextFrame">
  845. <xs:sequence>
  846. <xs:element ref="rdsCM:id" minOccurs="0"/>
  847. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  848. </xs:sequence>
  849. <xs:anyAttribute namespace="##any" processContents="lax"/>
  850. </xs:complexType>
  851. <xs:complexType name="MChart">
  852. <xs:sequence>
  853. <xs:element ref="rdsCM:id" minOccurs="0"/>
  854. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  855. </xs:sequence>
  856. <xs:anyAttribute namespace="##local" processContents="lax"/>
  857. </xs:complexType>
  858. <xs:complexType name="MCrossTab">
  859. <xs:sequence>
  860. <xs:element ref="rdsCM:id" minOccurs="0"/>
  861. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  862. </xs:sequence>
  863. <xs:anyAttribute namespace="##any" processContents="lax"/>
  864. </xs:complexType>
  865. <xs:complexType name="MImage">
  866. <xs:sequence>
  867. <xs:element ref="rdsCM:id" minOccurs="0"/>
  868. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  869. </xs:sequence>
  870. <xs:anyAttribute namespace="##any" processContents="lax"/>
  871. </xs:complexType>
  872. <xs:complexType name="MMap">
  873. <xs:sequence>
  874. <xs:element ref="rdsCM:id" minOccurs="0"/>
  875. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  876. </xs:sequence>
  877. <xs:anyAttribute namespace="##any" processContents="lax"/>
  878. </xs:complexType>
  879. <xs:complexType name="MMetricDiagram">
  880. <xs:sequence>
  881. <xs:element ref="rdsCM:id" minOccurs="0"/>
  882. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  883. </xs:sequence>
  884. <xs:anyAttribute namespace="##any" processContents="lax"/>
  885. </xs:complexType>
  886. <xs:complexType name="MHTML">
  887. <xs:sequence>
  888. <xs:element ref="rdsCM:id" minOccurs="0"/>
  889. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  890. </xs:sequence>
  891. <xs:anyAttribute namespace="##any" processContents="lax"/>
  892. </xs:complexType>
  893. <xs:complexType name="MRichText">
  894. <xs:sequence>
  895. <xs:element ref="rdsCM:id" minOccurs="0"/>
  896. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  897. </xs:sequence>
  898. <xs:anyAttribute namespace="##any" processContents="lax"/>
  899. </xs:complexType>
  900. <xs:complexType name="MBookmark">
  901. <xs:sequence>
  902. <xs:element ref="rdsCM:id" minOccurs="0"/>
  903. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  904. </xs:sequence>
  905. <xs:anyAttribute namespace="##any" processContents="lax"/>
  906. </xs:complexType>
  907. <xs:complexType name="MRepeater">
  908. <xs:sequence>
  909. <xs:element ref="rdsCM:id" minOccurs="0"/>
  910. <xs:element name="item" type="MReportElement" minOccurs="0" maxOccurs="unbounded"/>
  911. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  912. </xs:sequence>
  913. <xs:anyAttribute namespace="##any" processContents="lax"/>
  914. </xs:complexType>
  915. <xs:complexType name="MHyperlink">
  916. <xs:sequence>
  917. <xs:element ref="rdsCM:id" minOccurs="0"/>
  918. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  919. </xs:sequence>
  920. <xs:anyAttribute namespace="##any" processContents="lax"/>
  921. </xs:complexType>
  922. <xs:complexType name="MWidget">
  923. <xs:sequence>
  924. <xs:element ref="rdsCM:id" minOccurs="0"/>
  925. <xs:element name="type" type="rdsCM:StringValue" minOccurs="0"/>
  926. <xs:element name="widgetURI" type="rdsCM:StringValue" minOccurs="0"/>
  927. <xs:element name="storeID" type="rdsCM:StringValue" minOccurs="0"/>
  928. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  929. </xs:sequence>
  930. <xs:anyAttribute namespace="##any" processContents="lax"/>
  931. </xs:complexType>
  932. <xs:complexType name="MRepeaterTable">
  933. <xs:sequence>
  934. <xs:element ref="rdsCM:id" minOccurs="0"/>
  935. <xs:element name="pref_columns" type="rdsCM:IntegerValue">
  936. <xs:annotation>
  937. <xs:documentation>Preferred number of colums, if the data can fit within it</xs:documentation>
  938. </xs:annotation>
  939. </xs:element>
  940. <xs:element name="pref_rows" type="rdsCM:IntegerValue">
  941. <xs:annotation>
  942. <xs:documentation>Preferred number of rows, if the data can fit within it</xs:documentation>
  943. </xs:annotation>
  944. </xs:element>
  945. <xs:element name="item" type="MReportElement" minOccurs="0" maxOccurs="unbounded">
  946. <xs:annotation>
  947. <xs:documentation>The items to be repeated in each table cell</xs:documentation>
  948. </xs:annotation>
  949. </xs:element>
  950. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  951. </xs:sequence>
  952. <xs:anyAttribute namespace="##any" processContents="lax"/>
  953. </xs:complexType>
  954. <xs:complexType name="MConditional">
  955. <xs:annotation>
  956. <xs:documentation>This represents a conditional block section. This is essentially a placeholder element which will be replaced by the elements contained within one of the conditionalResult sections in the actual report data</xs:documentation>
  957. </xs:annotation>
  958. <xs:sequence>
  959. <xs:element ref="rdsCM:id" minOccurs="0"/>
  960. <xs:element name="conditionalResult" type="MReportElementArray" minOccurs="0" maxOccurs="unbounded">
  961. <xs:annotation>
  962. <xs:documentation>Each conditionalResult indicates a set of elements that might appear in the data in this position.</xs:documentation>
  963. </xs:annotation>
  964. </xs:element>
  965. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  966. </xs:sequence>
  967. <xs:anyAttribute namespace="##any" processContents="lax"/>
  968. </xs:complexType>
  969. <!--***** Layout Structure *****-->
  970. <xs:complexType name="LayoutElementArray">
  971. <xs:sequence>
  972. <xs:element name="item" type="LayoutElementArrayItem" minOccurs="0" maxOccurs="unbounded"/>
  973. <xs:element ref="rdsCM:style" minOccurs="0"/>
  974. </xs:sequence>
  975. <xs:anyAttribute namespace="##any" processContents="lax"/>
  976. </xs:complexType>
  977. <xs:complexType name="LayoutElementArrayItem">
  978. <xs:choice>
  979. <xs:element name="LTable" type="LTable"/>
  980. <xs:element name="LReference" type="LReference"/>
  981. <xs:element name="LContainer" type="LContainer"/>
  982. <xs:element name="LFieldSet" type="LFieldSet"/>
  983. <xs:element name="LRepeater" type="LRepeater"/>
  984. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  985. </xs:choice>
  986. <xs:anyAttribute namespace="##any" processContents="lax"/>
  987. </xs:complexType>
  988. <xs:complexType name="LPage">
  989. <xs:sequence>
  990. <xs:element ref="rdsCM:id" minOccurs="0"/>
  991. <xs:element name="posId" type="xs:string"/>
  992. <xs:element name="header" type="LayoutElementArray" minOccurs="0"/>
  993. <xs:element name="body" type="LayoutElementArray" minOccurs="0"/>
  994. <xs:element name="footer" type="LayoutElementArray" minOccurs="0"/>
  995. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  996. </xs:sequence>
  997. <xs:anyAttribute namespace="##any" processContents="lax"/>
  998. </xs:complexType>
  999. <xs:complexType name="LContainer">
  1000. <xs:sequence>
  1001. <xs:element name="item" type="LayoutElementArrayItem" minOccurs="0" maxOccurs="unbounded"/>
  1002. <xs:element ref="rdsCM:style" minOccurs="0" maxOccurs="unbounded"/>
  1003. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1004. </xs:sequence>
  1005. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1006. </xs:complexType>
  1007. <xs:complexType name="LFieldSet">
  1008. <xs:sequence>
  1009. <xs:element name="item" type="LayoutElementArrayItem" minOccurs="0" maxOccurs="unbounded"/>
  1010. <xs:element name="caption" type="rdsCM:StringValue"/>
  1011. <xs:element name="styles" type="rdsCM:StringValue" minOccurs="0" maxOccurs="unbounded"/>
  1012. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1013. </xs:sequence>
  1014. </xs:complexType>
  1015. <xs:complexType name="LTable">
  1016. <xs:sequence>
  1017. <xs:element name="row" type="LTableRow" minOccurs="0" maxOccurs="unbounded"/>
  1018. <xs:element ref="rdsCM:style" minOccurs="0"/>
  1019. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1020. </xs:sequence>
  1021. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1022. </xs:complexType>
  1023. <xs:complexType name="LReference">
  1024. <xs:sequence>
  1025. <xs:element ref="rdsCM:id" minOccurs="0"/>
  1026. <xs:element name="posId" type="rdsCM:StringValue"/>
  1027. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1028. </xs:sequence>
  1029. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1030. </xs:complexType>
  1031. <xs:complexType name="LTableRow">
  1032. <xs:sequence>
  1033. <xs:element name="cell" type="LContainer" minOccurs="0" maxOccurs="unbounded"/>
  1034. <xs:element ref="rdsCM:style" minOccurs="0"/>
  1035. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1036. </xs:sequence>
  1037. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1038. </xs:complexType>
  1039. <xs:complexType name="LDocument">
  1040. <xs:sequence/>
  1041. </xs:complexType>
  1042. <xs:complexType name="LRepeater">
  1043. <xs:sequence>
  1044. <xs:element ref="rdsCM:id" minOccurs="0"/>
  1045. <xs:element name="posId" type="rdsCM:StringValue"/>
  1046. <xs:element name="layout" type="LContainer"/>
  1047. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1048. </xs:sequence>
  1049. </xs:complexType>
  1050. <!--****** Prompt Types ******-->
  1051. <xs:complexType name="PromptValue">
  1052. <xs:sequence>
  1053. <xs:element name="name" type="rdsCM:StringValue">
  1054. <xs:annotation>
  1055. <xs:documentation>The name of the prompt parameter</xs:documentation>
  1056. </xs:annotation>
  1057. </xs:element>
  1058. <xs:element name="values" type="PValueArray">
  1059. <xs:annotation>
  1060. <xs:documentation>The value(s) of the prompt answer</xs:documentation>
  1061. </xs:annotation>
  1062. </xs:element>
  1063. </xs:sequence>
  1064. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1065. </xs:complexType>
  1066. <xs:complexType name="PValueArray">
  1067. <xs:sequence>
  1068. <xs:element name="item" type="PValueArrayItem" minOccurs="0" maxOccurs="unbounded"/>
  1069. </xs:sequence>
  1070. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1071. </xs:complexType>
  1072. <xs:complexType name="PValueArrayItem">
  1073. <xs:choice>
  1074. <xs:element name="SimplePValue" type="SimplePValue">
  1075. <xs:annotation>
  1076. <xs:documentation>Simple prompt answer (i.e. single value)</xs:documentation>
  1077. </xs:annotation>
  1078. </xs:element>
  1079. <xs:element name="RangePValue" type="RangePValue">
  1080. <xs:annotation>
  1081. <xs:documentation>A range prompt answer. May include a start and/or and end value, depending on the type of range prompt</xs:documentation>
  1082. </xs:annotation>
  1083. </xs:element>
  1084. <xs:element name="TreePValue" type="TreePValue">
  1085. <xs:annotation>
  1086. <xs:documentation>Never used.</xs:documentation>
  1087. </xs:annotation>
  1088. </xs:element>
  1089. <xs:element ref="rdsCM:extension"/>
  1090. </xs:choice>
  1091. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1092. </xs:complexType>
  1093. <xs:complexType name="SimplePValue">
  1094. <xs:sequence>
  1095. <xs:element ref="inclusive">
  1096. <xs:annotation>
  1097. <xs:documentation>Indicates where this answer is inclusive in the prompt expression</xs:documentation>
  1098. </xs:annotation>
  1099. </xs:element>
  1100. <xs:element name="useValue" type="rdsCM:StringValue">
  1101. <xs:annotation>
  1102. <xs:documentation>The use value of the prompt</xs:documentation>
  1103. </xs:annotation>
  1104. </xs:element>
  1105. <xs:element name="displayValue" type="rdsCM:StringValue" minOccurs="0">
  1106. <xs:annotation>
  1107. <xs:documentation>The optional display value for the prompt</xs:documentation>
  1108. </xs:annotation>
  1109. </xs:element>
  1110. </xs:sequence>
  1111. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1112. </xs:complexType>
  1113. <xs:complexType name="RangePValue">
  1114. <xs:sequence>
  1115. <xs:element ref="inclusive"/>
  1116. <xs:element name="start" type="SimplePValue" minOccurs="0"/>
  1117. <xs:element name="end" type="SimplePValue" minOccurs="0"/>
  1118. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1119. </xs:sequence>
  1120. <xs:anyAttribute namespace="##any"/>
  1121. </xs:complexType>
  1122. <xs:complexType name="TreePValue">
  1123. <xs:sequence>
  1124. <xs:element ref="inclusive"/>
  1125. <xs:element name="children" type="TreePValue" minOccurs="0" maxOccurs="unbounded"/>
  1126. <xs:element name="nodeValue" type="SimplePValue"/>
  1127. </xs:sequence>
  1128. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1129. </xs:complexType>
  1130. <xs:element name="inclusive" type="rdsCM:BooleanValue"/>
  1131. <xs:complexType name="BurstType">
  1132. <xs:sequence>
  1133. <xs:element name="burstKey" type="rdsCM:StringValue" minOccurs="0"/>
  1134. <xs:element name="burstId" type="rdsCM:StringValue" minOccurs="0"/>
  1135. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1136. </xs:sequence>
  1137. </xs:complexType>
  1138. <xs:complexType name="versionSelection">
  1139. <xs:sequence>
  1140. <xs:element name="versionType" type="VersionTypeEnum"/>
  1141. <xs:element name="versionName" type="rdsCM:StringValue" minOccurs="0"/>
  1142. <xs:element name="searchPath" type="rdsCM:StringValue" minOccurs="0">
  1143. <xs:annotation>
  1144. <xs:documentation>Optionally a searchPath to the version object can be specified, in place of the versionName.</xs:documentation>
  1145. </xs:annotation>
  1146. </xs:element>
  1147. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1148. </xs:sequence>
  1149. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1150. </xs:complexType>
  1151. <xs:element name="document" type="MDocument">
  1152. <xs:annotation>
  1153. <xs:documentation>A Meta representation of the document object.</xs:documentation>
  1154. </xs:annotation>
  1155. </xs:element>
  1156. <xs:element name="page" type="MPage">
  1157. <xs:annotation>
  1158. <xs:documentation>Meta representation of the document pages</xs:documentation>
  1159. </xs:annotation>
  1160. </xs:element>
  1161. <xs:complexType name="XMLCredential">
  1162. <xs:sequence>
  1163. <xs:any namespace="##any" processContents="lax"/>
  1164. </xs:sequence>
  1165. </xs:complexType>
  1166. <xs:complexType name="PItemArray">
  1167. <xs:sequence>
  1168. <xs:element name="canFinish" type="rdsCM:BooleanValue"/>
  1169. <xs:element name="hasNextPage" type="rdsCM:BooleanValue"/>
  1170. <xs:element name="item" type="PItem" minOccurs="0" maxOccurs="unbounded"/>
  1171. </xs:sequence>
  1172. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1173. </xs:complexType>
  1174. <xs:complexType name="PItem">
  1175. <xs:choice>
  1176. <xs:element name="PListBox" type="PListBox">
  1177. <xs:annotation>
  1178. <xs:documentation>Represents a selectValue prompt, usually represented as either a list box (multi-value) or as a dropdown list (single value)</xs:documentation>
  1179. </xs:annotation>
  1180. </xs:element>
  1181. <xs:element name="PTextBox" type="PTextBox">
  1182. <xs:annotation>
  1183. <xs:documentation>Represents a type-in prompt.</xs:documentation>
  1184. </xs:annotation>
  1185. </xs:element>
  1186. <xs:element name="PTreePrompt" type="PTreePromptType">
  1187. <xs:annotation>
  1188. <xs:documentation>Represents a tree prompt</xs:documentation>
  1189. </xs:annotation>
  1190. </xs:element>
  1191. <xs:element name="PDateTimeBox" type="PDateTimeBox">
  1192. <xs:annotation>
  1193. <xs:documentation>Represents any of the datetime prompts (date, datetime, time, and interval). Usually rendered with a calender control.</xs:documentation>
  1194. </xs:annotation>
  1195. </xs:element>
  1196. <xs:element name="PDataSource" type="PDataSourceType">
  1197. <xs:annotation>
  1198. <xs:documentation>Represents a Data Source signon prompt</xs:documentation>
  1199. </xs:annotation>
  1200. </xs:element>
  1201. <xs:element name="PSearchAndSelect" type="PSearchAndSelectType">
  1202. <xs:annotation>
  1203. <xs:documentation>Represents a Search and Select promp</xs:documentation>
  1204. </xs:annotation>
  1205. </xs:element>
  1206. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1207. </xs:choice>
  1208. </xs:complexType>
  1209. <xs:complexType name="PTextBox">
  1210. <xs:sequence>
  1211. <xs:element name="name" type="rdsCM:StringValue">
  1212. <xs:annotation>
  1213. <xs:documentation>Name of the prompt value to be filled.</xs:documentation>
  1214. </xs:annotation>
  1215. </xs:element>
  1216. <xs:element name="multiSelect" type="rdsCM:BooleanValue">
  1217. <xs:annotation>
  1218. <xs:documentation>True if this is a multi-value prompt.</xs:documentation>
  1219. </xs:annotation>
  1220. </xs:element>
  1221. <xs:element name="range" type="rdsCM:BooleanValue">
  1222. <xs:annotation>
  1223. <xs:documentation>True if this is a range prompt. Two text box UI elements should be rendered by the client.</xs:documentation>
  1224. </xs:annotation>
  1225. </xs:element>
  1226. <xs:element name="required" type="rdsCM:BooleanValue">
  1227. <xs:annotation>
  1228. <xs:documentation>True if this prompt must be filled in to run the report.</xs:documentation>
  1229. </xs:annotation>
  1230. </xs:element>
  1231. <xs:element name="numericOnly" type="rdsCM:BooleanValue"/>
  1232. <xs:element name="columnName" type="rdsCM:StringValue" minOccurs="0">
  1233. <xs:annotation>
  1234. <xs:documentation>If available, the display name of the column that is being prompted on</xs:documentation>
  1235. </xs:annotation>
  1236. </xs:element>
  1237. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1238. </xs:sequence>
  1239. </xs:complexType>
  1240. <xs:complexType name="PListBox">
  1241. <xs:sequence>
  1242. <xs:element name="name" type="rdsCM:StringValue">
  1243. <xs:annotation>
  1244. <xs:documentation>Name of the prompt value to be filled</xs:documentation>
  1245. </xs:annotation>
  1246. </xs:element>
  1247. <xs:element name="multiSelect" type="rdsCM:BooleanValue">
  1248. <xs:annotation>
  1249. <xs:documentation>True if this is a multi-value prompt</xs:documentation>
  1250. </xs:annotation>
  1251. </xs:element>
  1252. <xs:element name="range" type="rdsCM:BooleanValue">
  1253. <xs:annotation>
  1254. <xs:documentation>True if this is a range prompt. Two list box UI elements should be rendered by the client.</xs:documentation>
  1255. </xs:annotation>
  1256. </xs:element>
  1257. <xs:element name="required" type="rdsCM:BooleanValue">
  1258. <xs:annotation>
  1259. <xs:documentation>True if this prompt must be filled in to run the report.</xs:documentation>
  1260. </xs:annotation>
  1261. </xs:element>
  1262. <xs:element name="options" type="POptions" maxOccurs="unbounded">
  1263. <xs:annotation>
  1264. <xs:documentation>A list of use-display value pairs</xs:documentation>
  1265. </xs:annotation>
  1266. </xs:element>
  1267. <xs:element name="columnName" type="rdsCM:StringValue" minOccurs="0">
  1268. <xs:annotation>
  1269. <xs:documentation>If available, the display name of the column that is being prompted on</xs:documentation>
  1270. </xs:annotation>
  1271. </xs:element>
  1272. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1273. </xs:sequence>
  1274. </xs:complexType>
  1275. <xs:complexType name="PDateTimeBox">
  1276. <xs:sequence>
  1277. <xs:element name="name" type="rdsCM:StringValue">
  1278. <xs:annotation>
  1279. <xs:documentation>Name of the prompt value to be filled.</xs:documentation>
  1280. </xs:annotation>
  1281. </xs:element>
  1282. <xs:element name="multiSelect" type="rdsCM:BooleanValue">
  1283. <xs:annotation>
  1284. <xs:documentation>True if this is a multi-value prompt</xs:documentation>
  1285. </xs:annotation>
  1286. </xs:element>
  1287. <xs:element name="range" type="rdsCM:BooleanValue">
  1288. <xs:annotation>
  1289. <xs:documentation>True if this is a range prompt.</xs:documentation>
  1290. </xs:annotation>
  1291. </xs:element>
  1292. <xs:element name="required" type="rdsCM:BooleanValue">
  1293. <xs:annotation>
  1294. <xs:documentation>True if this prompt must be filled in to run the report.</xs:documentation>
  1295. </xs:annotation>
  1296. </xs:element>
  1297. <xs:element name="valueType" type="DTValueType">
  1298. <xs:annotation>
  1299. <xs:documentation>Type of prompt (date, time, interval, etc.)</xs:documentation>
  1300. </xs:annotation>
  1301. </xs:element>
  1302. <xs:element name="calendarType" type="CalendarType" minOccurs="0">
  1303. <xs:annotation>
  1304. <xs:documentation>Type of calendar to use.</xs:documentation>
  1305. </xs:annotation>
  1306. </xs:element>
  1307. <xs:element name="displaySeconds" type="rdsCM:BooleanValue" minOccurs="0">
  1308. <xs:annotation>
  1309. <xs:documentation>Display seconds.</xs:documentation>
  1310. </xs:annotation>
  1311. </xs:element>
  1312. <xs:element name="displayMilliseconds" type="rdsCM:BooleanValue" minOccurs="0">
  1313. <xs:annotation>
  1314. <xs:documentation>Display milliseconds.</xs:documentation>
  1315. </xs:annotation>
  1316. </xs:element>
  1317. <xs:element name="firstDate" type="DateTimeValue" minOccurs="0">
  1318. <xs:annotation>
  1319. <xs:documentation>first date that can be selected.</xs:documentation>
  1320. </xs:annotation>
  1321. </xs:element>
  1322. <xs:element name="lastDate" type="DateTimeValue" minOccurs="0">
  1323. <xs:annotation>
  1324. <xs:documentation>last date that can be selected.</xs:documentation>
  1325. </xs:annotation>
  1326. </xs:element>
  1327. <xs:element name="columnName" type="rdsCM:StringValue" minOccurs="0">
  1328. <xs:annotation>
  1329. <xs:documentation>If available, the display name of the column that is being prompted on</xs:documentation>
  1330. </xs:annotation>
  1331. </xs:element>
  1332. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1333. </xs:sequence>
  1334. </xs:complexType>
  1335. <xs:complexType name="POptions">
  1336. <xs:sequence>
  1337. <xs:element name="useValue" type="rdsCM:StringValue"/>
  1338. <xs:element name="displayValue" type="rdsCM:StringValue" minOccurs="0"/>
  1339. </xs:sequence>
  1340. </xs:complexType>
  1341. <xs:complexType name="DateTimeValue">
  1342. <xs:simpleContent>
  1343. <xs:extension base="xs:date">
  1344. <xs:anyAttribute namespace="##any"/>
  1345. </xs:extension>
  1346. </xs:simpleContent>
  1347. </xs:complexType>
  1348. <xs:simpleType name="DTValueType">
  1349. <xs:restriction base="xs:string">
  1350. <xs:enumeration value="DATE"/>
  1351. <xs:enumeration value="TIME"/>
  1352. <xs:enumeration value="DATETIME"/>
  1353. <xs:enumeration value="INTERVAL"/>
  1354. </xs:restriction>
  1355. </xs:simpleType>
  1356. <xs:simpleType name="CalendarType">
  1357. <xs:restriction base="xs:string">
  1358. <xs:enumeration value="GREGORIAN"/>
  1359. <xs:enumeration value="IMPERIAL"/>
  1360. </xs:restriction>
  1361. </xs:simpleType>
  1362. <xs:element name="promptValues" type="PromptValue"/>
  1363. <xs:simpleType name="FileTypeEnum">
  1364. <xs:annotation>
  1365. <xs:documentation>Enumerations for File Type</xs:documentation>
  1366. </xs:annotation>
  1367. <xs:restriction base="xs:string">
  1368. <xs:enumeration value="XLWB"/>
  1369. <xs:enumeration value="PPDeck"/>
  1370. <xs:enumeration value="WordDoc"/>
  1371. </xs:restriction>
  1372. </xs:simpleType>
  1373. <xs:complexType name="Filter">
  1374. <xs:sequence>
  1375. <xs:element name="filterValue" type="rdsCM:StringValue"/>
  1376. <xs:element name="filterType" type="rdsCM:FilterTypeEnum"/>
  1377. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1378. </xs:sequence>
  1379. <xs:anyAttribute namespace="##any" processContents="lax"/>
  1380. </xs:complexType>
  1381. <!--**** REST API ****-->
  1382. <xs:element name="promptPageResponse">
  1383. <xs:annotation>
  1384. <xs:documentation>The response to the promptPage request</xs:documentation>
  1385. </xs:annotation>
  1386. <xs:complexType>
  1387. <xs:sequence>
  1388. <xs:element name="url" type="xs:anyURI">
  1389. <xs:annotation>
  1390. <xs:documentation>A URL that provides an HTML prompting UI</xs:documentation>
  1391. </xs:annotation>
  1392. </xs:element>
  1393. <xs:element name="conversationID">
  1394. <xs:annotation>
  1395. <xs:documentation>A conversation ID where the prompt answers will be stored when the prompting UI has finished it's task. Pass this ID into the promptAnswers method to retrive the prompt answers</xs:documentation>
  1396. </xs:annotation>
  1397. <xs:complexType>
  1398. <xs:simpleContent>
  1399. <xs:extension base="xs:string"/>
  1400. </xs:simpleContent>
  1401. </xs:complexType>
  1402. </xs:element>
  1403. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1404. </xs:sequence>
  1405. <xs:anyAttribute namespace="##any"/>
  1406. </xs:complexType>
  1407. </xs:element>
  1408. <xs:element name="promptAnswers">
  1409. <xs:annotation>
  1410. <xs:documentation>A list of prompt answers for the request</xs:documentation>
  1411. </xs:annotation>
  1412. <xs:complexType>
  1413. <xs:sequence>
  1414. <xs:element name="conversationID" type="rdsCM:StringValue" minOccurs="0"/>
  1415. <xs:element name="searchPromptValue" type="searchPValueType" minOccurs="0">
  1416. <xs:annotation>
  1417. <xs:documentation>Used to perform searching for search and select prompts. You must have a conversationID for this operation to succeed.</xs:documentation>
  1418. </xs:annotation>
  1419. </xs:element>
  1420. <xs:element ref="promptValues" minOccurs="0" maxOccurs="unbounded"/>
  1421. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1422. </xs:sequence>
  1423. <xs:anyAttribute namespace="##any"/>
  1424. </xs:complexType>
  1425. </xs:element>
  1426. <xs:element name="error">
  1427. <xs:annotation>
  1428. <xs:documentation>Standard error response</xs:documentation>
  1429. </xs:annotation>
  1430. <xs:complexType>
  1431. <xs:sequence>
  1432. <xs:element name="message" type="rdsCM:StringValue">
  1433. <xs:annotation>
  1434. <xs:documentation>A description of the error that occured</xs:documentation>
  1435. </xs:annotation>
  1436. </xs:element>
  1437. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1438. </xs:sequence>
  1439. <xs:anyAttribute namespace="##any"/>
  1440. </xs:complexType>
  1441. </xs:element>
  1442. <xs:element name="noerror">
  1443. <xs:annotation>
  1444. <xs:documentation>Response for cancel and release methods</xs:documentation>
  1445. </xs:annotation>
  1446. </xs:element>
  1447. <xs:simpleType name="SourceTypeEnum">
  1448. <xs:annotation>
  1449. <xs:documentation>Enumeration of the valid source types.</xs:documentation>
  1450. </xs:annotation>
  1451. <xs:restriction base="xs:string">
  1452. <xs:enumeration value="metrics">
  1453. <xs:annotation>
  1454. <xs:documentation>A metrics manager resource</xs:documentation>
  1455. </xs:annotation>
  1456. </xs:enumeration>
  1457. <xs:enumeration value="conversationID">
  1458. <xs:annotation>
  1459. <xs:documentation>A conversation resource that is stored in CM for async and secondary requests</xs:documentation>
  1460. </xs:annotation>
  1461. </xs:enumeration>
  1462. <xs:enumeration value="path">
  1463. <xs:annotation>
  1464. <xs:documentation>A resource that is referenced by its cm storeID</xs:documentation>
  1465. </xs:annotation>
  1466. </xs:enumeration>
  1467. <xs:enumeration value="report">
  1468. <xs:annotation>
  1469. <xs:documentation>A resource that is referenced by its report searchPath</xs:documentation>
  1470. </xs:annotation>
  1471. </xs:enumeration>
  1472. </xs:restriction>
  1473. </xs:simpleType>
  1474. <xs:complexType name="connectionType">
  1475. <xs:sequence>
  1476. <xs:element name="name" type="rdsCM:StringValue"/>
  1477. <xs:element name="searchPath" type="rdsCM:StringValue"/>
  1478. <xs:element name="selected" type="rdsCM:BooleanValue"/>
  1479. </xs:sequence>
  1480. </xs:complexType>
  1481. <xs:complexType name="signonType">
  1482. <xs:sequence>
  1483. <xs:element name="name" type="rdsCM:StringValue" minOccurs="0"/>
  1484. <xs:element name="searchPath" type="rdsCM:StringValue" minOccurs="0"/>
  1485. <xs:element name="selected" type="rdsCM:BooleanValue"/>
  1486. </xs:sequence>
  1487. </xs:complexType>
  1488. <xs:complexType name="PDataSourceType">
  1489. <xs:sequence>
  1490. <xs:element name="name" type="rdsCM:StringValue"/>
  1491. <xs:element name="connection" type="connectionType"/>
  1492. <xs:element name="signon" type="signonType" minOccurs="0" maxOccurs="unbounded"/>
  1493. </xs:sequence>
  1494. </xs:complexType>
  1495. <xs:complexType name="searchPValueType">
  1496. <xs:sequence>
  1497. <xs:element name="value" type="rdsCM:StringValue">
  1498. <xs:annotation>
  1499. <xs:documentation>The keywords you are searching on</xs:documentation>
  1500. </xs:annotation>
  1501. </xs:element>
  1502. <xs:element name="parameterName" type="rdsCM:StringValue">
  1503. <xs:annotation>
  1504. <xs:documentation>The parameter that the search is associated with</xs:documentation>
  1505. </xs:annotation>
  1506. </xs:element>
  1507. <xs:element name="id" type="rdsCM:StringValue">
  1508. <xs:annotation>
  1509. <xs:documentation>The ID of the PSearchAndSelect prompt control</xs:documentation>
  1510. </xs:annotation>
  1511. </xs:element>
  1512. <xs:element name="caseInsensitive" type="rdsCM:BooleanValue" minOccurs="0">
  1513. <xs:annotation>
  1514. <xs:documentation>Perform a case insensitive search. Defaults to true</xs:documentation>
  1515. </xs:annotation>
  1516. </xs:element>
  1517. <xs:element name="matchAll" type="rdsCM:BooleanValue" minOccurs="0">
  1518. <xs:annotation>
  1519. <xs:documentation>If true, then the results must start with the first keyword and contain the remaining keywords. If matchAnywhere is also true, then the search must contain all the keywords in any order </xs:documentation>
  1520. </xs:annotation>
  1521. </xs:element>
  1522. <xs:element name="matchAnywhere" type="rdsCM:BooleanValue" minOccurs="0">
  1523. <xs:annotation>
  1524. <xs:documentation>If true, then the result must contain any of the key words. If both this and matchAll are false, then the search result includes anything that starts with any of the key words</xs:documentation>
  1525. </xs:annotation>
  1526. </xs:element>
  1527. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1528. </xs:sequence>
  1529. </xs:complexType>
  1530. <xs:complexType name="PSearchAndSelectType">
  1531. <xs:sequence>
  1532. <xs:element name="name" type="rdsCM:StringValue">
  1533. <xs:annotation>
  1534. <xs:documentation>Name of the prompt value to be filled</xs:documentation>
  1535. </xs:annotation>
  1536. </xs:element>
  1537. <xs:element name="multiSelect" type="rdsCM:BooleanValue">
  1538. <xs:annotation>
  1539. <xs:documentation>True if this is a multi-value prompt</xs:documentation>
  1540. </xs:annotation>
  1541. </xs:element>
  1542. <xs:element name="range" type="rdsCM:BooleanValue">
  1543. <xs:annotation>
  1544. <xs:documentation>True if this is a range prompt. Two list box UI elements should be rendered by the client.</xs:documentation>
  1545. </xs:annotation>
  1546. </xs:element>
  1547. <xs:element name="required" type="rdsCM:BooleanValue">
  1548. <xs:annotation>
  1549. <xs:documentation>True if this prompt must be filled in to run the report.</xs:documentation>
  1550. </xs:annotation>
  1551. </xs:element>
  1552. <xs:element name="id" type="rdsCM:StringValue"/>
  1553. <xs:element name="parameter" type="rdsCM:StringValue"/>
  1554. <xs:element name="caseInsensitive" type="rdsCM:BooleanValue"/>
  1555. <xs:element name="matchAll" type="rdsCM:BooleanValue"/>
  1556. <xs:element name="matchAnywhere" type="rdsCM:BooleanValue"/>
  1557. <xs:element name="columnName" type="rdsCM:StringValue" minOccurs="0">
  1558. <xs:annotation>
  1559. <xs:documentation>If available, the display name of the column that is being prompted on</xs:documentation>
  1560. </xs:annotation>
  1561. </xs:element>
  1562. <xs:element name="options" type="POptions" maxOccurs="unbounded">
  1563. <xs:annotation>
  1564. <xs:documentation>A list of use-display value pairs</xs:documentation>
  1565. </xs:annotation>
  1566. </xs:element>
  1567. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1568. </xs:sequence>
  1569. </xs:complexType>
  1570. <xs:complexType name="GetTreePromptNodeRequest">
  1571. <xs:sequence>
  1572. <xs:element name="conversationID" type="rdsCM:StringValue"/>
  1573. <xs:element ref="nodeValue"/>
  1574. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1575. </xs:sequence>
  1576. <xs:anyAttribute/>
  1577. </xs:complexType>
  1578. <xs:element name="nodeValue" type="PromptValue"/>
  1579. <xs:complexType name="TreePromptNodeOutput">
  1580. <xs:sequence>
  1581. <xs:element ref="responseStatus"/>
  1582. <xs:element name="treePromptNode" type="TreePromptNodeType"/>
  1583. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1584. </xs:sequence>
  1585. </xs:complexType>
  1586. <xs:element name="GetTreePromptNodeParam" type="GetTreePromptNodeRequest"/>
  1587. <xs:element name="GetTreePromptNodeResponse" type="TreePromptNodeOutput"/>
  1588. <xs:complexType name="NodeOption">
  1589. <xs:sequence>
  1590. <xs:element name="useValue" type="rdsCM:StringValue"/>
  1591. <xs:element name="displayValue" type="rdsCM:StringValue"/>
  1592. </xs:sequence>
  1593. </xs:complexType>
  1594. <xs:complexType name="TreePromptNodeType">
  1595. <xs:sequence>
  1596. <xs:element name="options" type="NodeOption" minOccurs="0" maxOccurs="unbounded"/>
  1597. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1598. </xs:sequence>
  1599. </xs:complexType>
  1600. <xs:complexType name="PTreePromptType">
  1601. <xs:sequence>
  1602. <xs:element name="name" type="rdsCM:StringValue"/>
  1603. <xs:element name="multiSelect" type="rdsCM:BooleanValue"/>
  1604. <xs:element name="required" type="rdsCM:BooleanValue"/>
  1605. <xs:element name="treeUI" type="rdsCM:StringValue"/>
  1606. <xs:element name="canExpand" type="rdsCM:BooleanValue"/>
  1607. <xs:element name="columnName" type="rdsCM:StringValue" minOccurs="0"/>
  1608. <xs:element name="treeNode" type="TreePromptNodeType"/>
  1609. <xs:element ref="rdsCM:extension" minOccurs="0"/>
  1610. </xs:sequence>
  1611. </xs:complexType>
  1612. <xs:element name="sourceType" type="SourceTypeEnum">
  1613. <xs:annotation>
  1614. <xs:documentation>The type of resource, such as path, report, conversationID or metrics</xs:documentation>
  1615. </xs:annotation>
  1616. </xs:element>
  1617. <xs:element name="sourceID" type="rdsCM:StringValue"/>
  1618. </xs:schema>