cm4dummies.htm 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  1. <html lang="en-us">
  2. <!--
  3. Licensed Materials - Property of IBM
  4. IBM Cognos Products: ps
  5. (C) Copyright IBM Corp. 2005, 2011
  6. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. -->
  8. <!--
  9. Copyright (C) 2008 Cognos ULC, an IBM Company. All rights reserved.
  10. Cognos (R) is a trademark of Cognos ULC, (formerly Cognos Incorporated).
  11. -->
  12. <!--
  13. Content Manager API converter v1.0.1
  14. This tool translates a Content Manager for Dummies syntax into the SOAP RPC-style syntax.
  15. Daniel Rodrigue
  16. -->
  17. <!-- =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -->
  18. <!-- Stylesheet used to translate the source code -->
  19. <!-- =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -->
  20. <xml id="cmPreProcess" src="pre-process.xslt" />
  21. <xml id="cmPostProcess" src="post-process.xslt" />
  22. <!-- =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -->
  23. <!--
  24. CONTENT MANAGER ADD SAMPLE 1
  25. -->
  26. <xml id="xmlAddSample1">
  27. <cm:add xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  28. <cm:search>/content/*[@defaultName='Package1']</cm:search>
  29. <cm:objects>
  30. <cm:report>
  31. <cm:defaultName>Report1</cm:defaultName>
  32. <cm:data contentType="text/xml" href="">
  33. <some-inline-xml>
  34. <example />
  35. </some-inline-xml>
  36. </cm:data>
  37. </cm:report>
  38. <cm:folder>
  39. <cm:defaultName>Folder1</cm:defaultName>
  40. </cm:folder>
  41. </cm:objects>
  42. <cm:options updateAction="fail" />
  43. </cm:add>
  44. </xml>
  45. <!--
  46. CONTENT MANAGER ADD SAMPLE 2
  47. -->
  48. <xml id="xmlAddSample2">
  49. <cm:add xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  50. <cm:objects>
  51. <cm:report>
  52. <cm:searchPath>/content/*[@defaultName='Package1']</cm:searchPath>
  53. <cm:defaultName>Report1</cm:defaultName>
  54. </cm:report>
  55. <cm:folder>
  56. <cm:searchPath>/content/*[@defaultName='Package1']</cm:searchPath>
  57. <cm:names>
  58. <cm:value locale="en">Folder1</cm:value>
  59. <cm:value locale="fr">Dossier1</cm:value>
  60. </cm:names>
  61. </cm:folder>
  62. </cm:objects>
  63. <cm:options updateAction="fail" />
  64. </cm:add>
  65. </xml>
  66. <!--
  67. CONTENT MANAGER QUERY SAMPLE
  68. -->
  69. <xml id="xmlQuerySample">
  70. <cm:query xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  71. <cm:search>/content/*[permission('read')]</cm:search>
  72. <cm:properties>
  73. <cm:property name="path" />
  74. <cm:property name="defaultName" />
  75. <cm:property name="names" />
  76. <cm:property name="data" />
  77. </cm:properties>
  78. <cm:sortBy>
  79. <cm:sort name="name" order="ascending" />
  80. </cm:sortBy>
  81. <cm:options permission="read" schemaInfo="false" skipObjects="0" maxObjects="0" dataEncoding="base64" skipDataBytes="0" maxDataBytes="0" />
  82. </cm:query>
  83. </xml>
  84. <!--
  85. CONTENT MANAGER UPDATE SAMPLE
  86. -->
  87. <xml id="xmlUpdateSample1">
  88. <cm:update xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  89. <cm:objects>
  90. <cm:report>
  91. <cm:searchPath>/content/*[@defaultName='Package1']/*[@defaultName='Report1']</cm:searchPath>
  92. <cm:defaultName>NewReport1Name</cm:defaultName>
  93. </cm:report>
  94. </cm:objects>
  95. </cm:update>
  96. </xml>
  97. <!--
  98. CONTENT MANAGER UPDATE SAMPLE WITH POLICIES
  99. -->
  100. <xml id="xmlUpdateSample2">
  101. <cm:update xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  102. <cm:objects>
  103. <cm:report>
  104. <cm:searchPath>/content/*[@defaultName='Package1']/*[@defaultName='Report1']</cm:searchPath>
  105. <cm:defaultName>NewReport1Name</cm:defaultName>
  106. <cm:policies>
  107. <cm:policy>
  108. <cm:securityObject>
  109. <cm:searchPath>CAMID("b882b4d5-be4d-47bf-98d6-f4111aabc0cb:6003249c-1b6c-4196-8fc1-beed20edff8e")</cm:searchPath>
  110. </cm:securityObject>
  111. <cm:permission name="read" access="grant" />
  112. <cm:permission name="write" access="grant" />
  113. <cm:permission name="execute" access="grant" />
  114. </cm:policy>
  115. </cm:policies>
  116. </cm:report>
  117. </cm:objects>
  118. </cm:update>
  119. </xml>
  120. <!--
  121. CONTENT MANAGER UPDATE SAMPLE WITH MEMBERS
  122. -->
  123. <xml id="xmlUpdateSample3">
  124. <cm:update xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  125. <cm:objects>
  126. <cm:role>
  127. <cm:searchPath>/directory//*[@defaultName='Role1']</cm:searchPath>
  128. <cm:members>
  129. <cm:account>
  130. <cm:searchPath>CAMID("b882b4d5-be4d-47bf-98d6-f4111aabc0cb:6003249c-1b6c-4196-8fc1-beed20edff8e")</cm:searchPath>
  131. </cm:account>
  132. </cm:members>
  133. </cm:role>
  134. </cm:objects>
  135. </cm:update>
  136. </xml>
  137. <!--
  138. CONTENT MANAGER DELETE SAMPLE 1
  139. -->
  140. <xml id="xmlDeleteSample1">
  141. <cm:delete xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  142. <cm:search>/content/*[@defaultName='Package1']/*[@defaultName='Report1']</cm:search>
  143. <cm:options recursive="true" force="true" />
  144. </cm:delete>
  145. </xml>
  146. <!--
  147. CONTENT MANAGER DELETE SAMPLE 2
  148. -->
  149. <xml id="xmlDeleteSample2">
  150. <cm:delete xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  151. <cm:objects>
  152. <cm:report>
  153. <cm:searchPath>/content/*[@defaultName='Package1']/*[@defaultName='Report1']</cm:searchPath>
  154. </cm:report>
  155. </cm:objects>
  156. <cm:options recursive="true" force="true" />
  157. </cm:delete>
  158. </xml>
  159. <!--
  160. CONTENT MANAGER MOVE SAMPLE 1
  161. -->
  162. <xml id="xmlMoveSample1">
  163. <cm:move xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  164. <cm:search>/content/*[@defaultName='Package1']/*[@defaultName='Report1']</cm:search>
  165. <cm:target>/content/*[@defaultName='Package2']</cm:target>
  166. <cm:options updateAction="fail" />
  167. </cm:move>
  168. </xml>
  169. <!--
  170. CONTENT MANAGER MOVE SAMPLE 2
  171. -->
  172. <xml id="xmlMoveSample2">
  173. <cm:move xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  174. <cm:objects>
  175. <cm:report>
  176. <cm:searchPath>/content/*[@defaultName='Package1']/*[@defaultName='Report1']</cm:searchPath>
  177. </cm:report>
  178. </cm:objects>
  179. <cm:target>/content/*[@defaultName='Package1']</cm:target>
  180. <cm:options updateAction="fail" />
  181. </cm:move>
  182. </xml>
  183. <!--
  184. CONTENT MANAGER COPY SAMPLE 1
  185. -->
  186. <xml id="xmlCopySample1">
  187. <cm:copy xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  188. <cm:search>/content/*[@defaultName='Package1']/*[@defaultName='Report1']</cm:search>
  189. <cm:target>/content/*[@defaultName='Package2']</cm:target>
  190. <cm:options recursive="true" updateAction="fail" />
  191. </cm:copy>
  192. </xml>
  193. <!--
  194. CONTENT MANAGER COPY SAMPLE 2
  195. -->
  196. <xml id="xmlCopySample2">
  197. <cm:copy xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  198. <cm:objects>
  199. <cm:report>
  200. <cm:searchPath>/content/*[@defaultName='Package1']/*[@defaultName='Report1']</cm:searchPath>
  201. </cm:report>
  202. </cm:objects>
  203. <cm:target>/content/*[@defaultName='Package1']</cm:target>
  204. <cm:options recursive="true" updateAction="fail" />
  205. </cm:copy>
  206. </xml>
  207. <!--
  208. CONTENT MANAGER MULTIPLE ADD SAMPLE
  209. -->
  210. <xml id="xmlMultipleAddsSample">
  211. <cm:add xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  212. <cm:requests>
  213. <cm:add>
  214. <cm:search>/content/*[@defaultName='Package1']</cm:search>
  215. <cm:objects>
  216. <cm:report>
  217. <cm:defaultName>Report1</cm:defaultName>
  218. </cm:report>
  219. </cm:objects>
  220. </cm:add>
  221. <cm:add>
  222. <cm:search>/content/*[@defaultName='Package1']</cm:search>
  223. <cm:objects>
  224. <cm:report>
  225. <cm:defaultName>Report2</cm:defaultName>
  226. </cm:report>
  227. </cm:objects>
  228. </cm:add>
  229. </cm:requests>
  230. </cm:add>
  231. </xml>
  232. <!--
  233. CONTENT MANAGER MULTIPLE QUERY SAMPLE
  234. -->
  235. <xml id="xmlMultipleQueriesSample">
  236. <cm:query xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  237. <cm:requests>
  238. <cm:query>
  239. <cm:search>/content/*[permission('read')]</cm:search>
  240. <cm:properties>
  241. <cm:property name="path" />
  242. </cm:properties>
  243. </cm:query>
  244. <cm:query>
  245. <cm:search>~/*[@defaultName='Home']/*]</cm:search>
  246. <cm:properties>
  247. <cm:property name="path" />
  248. </cm:properties>
  249. </cm:query>
  250. </cm:requests>
  251. </cm:query>
  252. </xml>
  253. <!--
  254. CONTENT MANAGER EXPORT SAMPLE
  255. -->
  256. <xml id="xmlExportSample">
  257. <cm:export xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  258. <cm:search>/exportDeploymentFolder/exportDeployment[@defaultName='Export specification']</cm:search>
  259. <cm:package>
  260. <cm:packageDeploymentInfo sourceName="Package HR" targetName="Package HResources" enabled="true"/>
  261. <cm:packageDeploymentInfo sourceName="Package Test" targetName="Package Test" enabled="false"/>
  262. </cm:package>
  263. <cm:options archive="Archive File" archiveOverwrite="false"
  264. packageSelect="true" packagePolicies="true" packageOutputs="false"
  265. namespaceSelect="false" namespaceThirdParty="false" namespaceConflictResolution="keep"
  266. dataSourceSelect="true" dataSourceSignonSelect="true" dataSourceConflictResolution="keep"
  267. recipientsSelect="false" recipientsThirdParty="false" recipientsConflictResolution="keep"
  268. takeOwnership="true"/>
  269. </cm:export>
  270. </xml>
  271. <!--
  272. CONTENT MANAGER IMPORT SAMPLE
  273. -->
  274. <xml id="xmlImportSample">
  275. <cm:import xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  276. <cm:search>/exportDeploymentFolder/exportDeployment[@defaultName='Export specification']</cm:search>
  277. <cm:package>
  278. <cm:packageDeploymentInfo sourceName="Package HR" targetName="Package HResources" enabled="true"/>
  279. <cm:packageDeploymentInfo sourceName="Package Test" targetName="Package Test" enabled="false"/>
  280. </cm:package>
  281. <cm:options archive="Archive File" archiveOverwrite="false"
  282. packageSelect="true" packagePolicies="true" packageOutputs="false"
  283. namespaceSelect="false" namespaceThirdParty="false" namespaceConflictResolution="keep"
  284. dataSourceSelect="true" dataSourceSignonSelect="true" dataSourceConflictResolution="keep"
  285. recipientsSelect="false" recipientsThirdParty="false" recipientsConflictResolution="keep"
  286. takeOwnership="true"/>
  287. </cm:import>
  288. </xml>
  289. <!--
  290. CONTENT MANAGER GET ARCHIVE OPTIONS SAMPLE
  291. -->
  292. <xml id="xmlGetArchiveOptionsSample">
  293. <cm:getArchiveOptions xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  294. <cm:options archive="Archive File"/>
  295. </cm:getArchiveOptions >
  296. </xml>
  297. <!--
  298. CONTENT MANAGER LIST ARCHIVES SAMPLE
  299. -->
  300. <xml id="xmlListArchivesSample">
  301. <cm:listArchives xmlns:cm="http://developer.cognos.com/schemas/xts-cm/1/">
  302. </cm:listArchives>
  303. </xml>
  304. <!-- =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -->
  305. <!-- MAIN HTML PAGE -->
  306. <!-- =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -->
  307. <head>
  308. <title>Content Manager Converter v1.0.1</title>
  309. <meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
  310. <style>
  311. body { background-color: threedface }
  312. body,p,td,textarea { font-size:8pt; font-family:Tahoma; margin: 2px }
  313. input,button,select { font-family:Tahoma; font-size:8pt; margin: 0px }
  314. textarea { width: 100% }
  315. span { color:#303080; }
  316. </style>
  317. <script language="javascript">
  318. <!--
  319. var cmPreProcessV3 = null;
  320. var cmPostProcessV3 = null;
  321. function convert()
  322. {
  323. var objDoc = new ActiveXObject("Msxml2.DOMDocument.3.0");
  324. objDoc.async = false;
  325. if (objDoc.loadXML(xmlSource.value)) {
  326. var prettyDoc = new ActiveXObject("Msxml2.DOMDocument.3.0");
  327. prettyDoc.async = false;
  328. prettyDoc.loadXML(objDoc.transformNode((radConvert[0].checked) ? cmPreProcessV3 : cmPostProcessV3));
  329. if (prettyDoc != null && prettyDoc.documentElement != null)
  330. {
  331. xmlTarget.value = prettyDoc.documentElement.xml;
  332. }
  333. else
  334. {
  335. xmlTarget.value = "***Empty Results***";
  336. }
  337. } else {
  338. window.alert("Invalid XML request");
  339. }
  340. }
  341. function event_onresize()
  342. {
  343. var ta = document.getElementById( "xmlTarget" );
  344. var newHeight = window.document.body.offsetHeight - ta.offsetTop - 9;
  345. if (newHeight > 50)
  346. ta.style.height = newHeight;
  347. }
  348. function insertSample()
  349. {
  350. var doc = btnSample.value;
  351. xmlSource.value = document.all(doc).XMLDocument.xml;
  352. }
  353. function radOnClick()
  354. {
  355. btnSample.disabled = (radConvert[1].checked );
  356. if ( radConvert[0].checked)
  357. {
  358. insertSample();
  359. }
  360. }
  361. //-->
  362. </script>
  363. <script for="window" event="onresize">
  364. event_onresize();
  365. </script>
  366. <script for="window" event="onload">
  367. <!--
  368. cmPreProcessV3 = new ActiveXObject("Msxml2.DOMDocument.3.0");
  369. if (cmPreProcessV3 != null) {
  370. cmPreProcessV3.async = false;
  371. btnCMConvert.disabled = !cmPreProcessV3.load(cmPreProcess.XMLDocument);
  372. if (btnCMConvert.disabled) {
  373. window.alert("ERROR: Cannot load 'pre-process.xslt' transformation source");
  374. }
  375. else
  376. {
  377. var oOutput = cmPreProcessV3.documentElement.selectSingleNode("//xsl:output");
  378. if (oOutput != null)
  379. {
  380. oOutput.setAttribute("indent", "yes");
  381. }
  382. }
  383. } else {
  384. window.alert("ERROR: Cannot initialize MSXML Version 3.0 component.");
  385. btnCMConvert.disabled = true;
  386. }
  387. cmPostProcessV3 = new ActiveXObject("Msxml2.DOMDocument.3.0");
  388. if (cmPostProcessV3 != null) {
  389. cmPostProcessV3.async = false;
  390. btnCMConvert.disabled = !cmPostProcessV3.load(cmPostProcess.XMLDocument);
  391. if (btnCMConvert.disabled) {
  392. window.alert("ERROR: Cannot load 'post-process.xslt' transformation source");
  393. }
  394. else
  395. {
  396. var oOutput = cmPostProcessV3.documentElement.selectSingleNode("//xsl:output");
  397. if (oOutput != null)
  398. {
  399. oOutput.setAttribute("indent", "yes");
  400. }
  401. }
  402. }
  403. xmlSource.value = xmlQuerySample.XMLDocument.xml;
  404. event_onresize();
  405. //-->
  406. </script>
  407. </head>
  408. <body>
  409. <p style="font-size:10pt; background-color: activecaption; color: captiontext; padding: 4px">
  410. <b>Content Manager API converter</b>
  411. <br />
  412. This tool translates a Content Manager for Dummies syntax into the SOAP RPC-style syntax.
  413. </p>
  414. <table cellpadding="0" cellspacing="0" border="0" width="100%">
  415. <tr>
  416. <td>
  417. <input type="radio" name="radConvert" value="pre" checked="checked" onclick="javascript:radOnClick()" />
  418. <span>Use pre-process converter (pre-process.xslt). Insert a request sample from: </span>
  419. <select id="btnSample" size="1" onchange="javascript:insertSample()">
  420. <option value="xmlAddSample1">Add (sample 1)</option>
  421. <option value="xmlAddSample2">Add (sample 2)</option>
  422. <option value="xmlQuerySample" selected="">Query</option>
  423. <option value="xmlUpdateSample1">Update</option>
  424. <option value="xmlUpdateSample2">Update (with Policies)</option>
  425. <option value="xmlUpdateSample3">Update (with Members)</option>
  426. <option value="xmlDeleteSample1">Delete (sample 1)</option>
  427. <option value="xmlDeleteSample2">Delete (sample 2)</option>
  428. <option value="xmlMoveSample1">Move (sample 1)</option>
  429. <option value="xmlMoveSample2">Move (sample 2)</option>
  430. <option value="xmlCopySample1">Copy (sample 1)</option>
  431. <option value="xmlCopySample2">Copy (Sample 2)</option>
  432. <option value="xmlMultipleAddsSample">Multiple Adds</option>
  433. <option value="xmlMultipleQueriesSample">Multiple Queries</option>
  434. <option value="xmlExportSample">Export</option>
  435. <option value="xmlImportSample">Import</option>
  436. <option value="xmlGetArchiveOptionsSample">Get Archive Options</option>
  437. <option value="xmlListArchivesSample">List Archives</option>
  438. </select>
  439. </td>
  440. <td rowspan="2" valign="middle" align="right">
  441. <!-- TODO: Reload button should be made a bit smarter by reloading only the XSLTs instead of
  442. reloading the entire HTML page -->
  443. <button id="btnRefresh" style="width: 120px" onclick="javascript:window.location.reload()">Reload XSLT Files</button>
  444. </td>
  445. </tr>
  446. <tr>
  447. <td>
  448. <input type="radio" name="radConvert" value="post" onclick="javascript:radOnClick()" />
  449. <span style="color:#303080;">Use post-process converter (post-process.xslt). Insert a Content Manager response in the box.</span>
  450. </td>
  451. </tr>
  452. </table>
  453. <!-- example of the new xts-cm query -->
  454. <textarea rows="16" id="xmlSource" ></textarea>
  455. <p align="right">
  456. <button id="btnCMConvert" disabled="disabled" style="width: 80px" onclick="javascript:convert()">Convert</button>&nbsp;
  457. <button id="btnClearSrc" style="width: 80px" onclick="javascript:xmlSource.value=''">Clear Source</button>&nbsp;
  458. <button id="btnClearResults" style="width: 80px" onclick="javascript:xmlTarget.value=''">Clear Results</button>&nbsp;
  459. <button id="btnCopy" style="width: 80px" onclick="javascript:{txt = document.getElementById('xmlTarget').createTextRange();txt.execCommand('Copy');}">Copy</button>
  460. </p>
  461. <p style="color:#303080;">Conversion results:</p>
  462. <textarea rows="25" id="xmlTarget" ></textarea>
  463. </body>
  464. </html>