OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

489 lines
16 KiB

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
  7. <title>BI View Editor</title>
  8. <style type="text/css">
  9. /*
  10. :Author: David Goodger (goodger@python.org)
  11. :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
  12. :Copyright: This stylesheet has been placed in the public domain.
  13. Default cascading style sheet for the HTML output of Docutils.
  14. See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
  15. customize this style sheet.
  16. */
  17. /* used to remove borders from tables and images */
  18. .borderless, table.borderless td, table.borderless th {
  19. border: 0 }
  20. table.borderless td, table.borderless th {
  21. /* Override padding for "table.docutils td" with "! important".
  22. The right padding separates the table cells. */
  23. padding: 0 0.5em 0 0 ! important }
  24. .first {
  25. /* Override more specific margin styles with "! important". */
  26. margin-top: 0 ! important }
  27. .last, .with-subtitle {
  28. margin-bottom: 0 ! important }
  29. .hidden {
  30. display: none }
  31. .subscript {
  32. vertical-align: sub;
  33. font-size: smaller }
  34. .superscript {
  35. vertical-align: super;
  36. font-size: smaller }
  37. a.toc-backref {
  38. text-decoration: none ;
  39. color: black }
  40. blockquote.epigraph {
  41. margin: 2em 5em ; }
  42. dl.docutils dd {
  43. margin-bottom: 0.5em }
  44. object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  45. overflow: hidden;
  46. }
  47. /* Uncomment (and remove this text!) to get bold-faced definition list terms
  48. dl.docutils dt {
  49. font-weight: bold }
  50. */
  51. div.abstract {
  52. margin: 2em 5em }
  53. div.abstract p.topic-title {
  54. font-weight: bold ;
  55. text-align: center }
  56. div.admonition, div.attention, div.caution, div.danger, div.error,
  57. div.hint, div.important, div.note, div.tip, div.warning {
  58. margin: 2em ;
  59. border: medium outset ;
  60. padding: 1em }
  61. div.admonition p.admonition-title, div.hint p.admonition-title,
  62. div.important p.admonition-title, div.note p.admonition-title,
  63. div.tip p.admonition-title {
  64. font-weight: bold ;
  65. font-family: sans-serif }
  66. div.attention p.admonition-title, div.caution p.admonition-title,
  67. div.danger p.admonition-title, div.error p.admonition-title,
  68. div.warning p.admonition-title, .code .error {
  69. color: red ;
  70. font-weight: bold ;
  71. font-family: sans-serif }
  72. /* Uncomment (and remove this text!) to get reduced vertical space in
  73. compound paragraphs.
  74. div.compound .compound-first, div.compound .compound-middle {
  75. margin-bottom: 0.5em }
  76. div.compound .compound-last, div.compound .compound-middle {
  77. margin-top: 0.5em }
  78. */
  79. div.dedication {
  80. margin: 2em 5em ;
  81. text-align: center ;
  82. font-style: italic }
  83. div.dedication p.topic-title {
  84. font-weight: bold ;
  85. font-style: normal }
  86. div.figure {
  87. margin-left: 2em ;
  88. margin-right: 2em }
  89. div.footer, div.header {
  90. clear: both;
  91. font-size: smaller }
  92. div.line-block {
  93. display: block ;
  94. margin-top: 1em ;
  95. margin-bottom: 1em }
  96. div.line-block div.line-block {
  97. margin-top: 0 ;
  98. margin-bottom: 0 ;
  99. margin-left: 1.5em }
  100. div.sidebar {
  101. margin: 0 0 0.5em 1em ;
  102. border: medium outset ;
  103. padding: 1em ;
  104. background-color: #ffffee ;
  105. width: 40% ;
  106. float: right ;
  107. clear: right }
  108. div.sidebar p.rubric {
  109. font-family: sans-serif ;
  110. font-size: medium }
  111. div.system-messages {
  112. margin: 5em }
  113. div.system-messages h1 {
  114. color: red }
  115. div.system-message {
  116. border: medium outset ;
  117. padding: 1em }
  118. div.system-message p.system-message-title {
  119. color: red ;
  120. font-weight: bold }
  121. div.topic {
  122. margin: 2em }
  123. h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
  124. h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  125. margin-top: 0.4em }
  126. h1.title {
  127. text-align: center }
  128. h2.subtitle {
  129. text-align: center }
  130. hr.docutils {
  131. width: 75% }
  132. img.align-left, .figure.align-left, object.align-left, table.align-left {
  133. clear: left ;
  134. float: left ;
  135. margin-right: 1em }
  136. img.align-right, .figure.align-right, object.align-right, table.align-right {
  137. clear: right ;
  138. float: right ;
  139. margin-left: 1em }
  140. img.align-center, .figure.align-center, object.align-center {
  141. display: block;
  142. margin-left: auto;
  143. margin-right: auto;
  144. }
  145. table.align-center {
  146. margin-left: auto;
  147. margin-right: auto;
  148. }
  149. .align-left {
  150. text-align: left }
  151. .align-center {
  152. clear: both ;
  153. text-align: center }
  154. .align-right {
  155. text-align: right }
  156. /* reset inner alignment in figures */
  157. div.align-right {
  158. text-align: inherit }
  159. /* div.align-center * { */
  160. /* text-align: left } */
  161. .align-top {
  162. vertical-align: top }
  163. .align-middle {
  164. vertical-align: middle }
  165. .align-bottom {
  166. vertical-align: bottom }
  167. ol.simple, ul.simple {
  168. margin-bottom: 1em }
  169. ol.arabic {
  170. list-style: decimal }
  171. ol.loweralpha {
  172. list-style: lower-alpha }
  173. ol.upperalpha {
  174. list-style: upper-alpha }
  175. ol.lowerroman {
  176. list-style: lower-roman }
  177. ol.upperroman {
  178. list-style: upper-roman }
  179. p.attribution {
  180. text-align: right ;
  181. margin-left: 50% }
  182. p.caption {
  183. font-style: italic }
  184. p.credits {
  185. font-style: italic ;
  186. font-size: smaller }
  187. p.label {
  188. white-space: nowrap }
  189. p.rubric {
  190. font-weight: bold ;
  191. font-size: larger ;
  192. color: maroon ;
  193. text-align: center }
  194. p.sidebar-title {
  195. font-family: sans-serif ;
  196. font-weight: bold ;
  197. font-size: larger }
  198. p.sidebar-subtitle {
  199. font-family: sans-serif ;
  200. font-weight: bold }
  201. p.topic-title {
  202. font-weight: bold }
  203. pre.address {
  204. margin-bottom: 0 ;
  205. margin-top: 0 ;
  206. font: inherit }
  207. pre.literal-block, pre.doctest-block, pre.math, pre.code {
  208. margin-left: 2em ;
  209. margin-right: 2em }
  210. pre.code .ln { color: grey; } /* line numbers */
  211. pre.code, code { background-color: #eeeeee }
  212. pre.code .comment, code .comment { color: #5C6576 }
  213. pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
  214. pre.code .literal.string, code .literal.string { color: #0C5404 }
  215. pre.code .name.builtin, code .name.builtin { color: #352B84 }
  216. pre.code .deleted, code .deleted { background-color: #DEB0A1}
  217. pre.code .inserted, code .inserted { background-color: #A3D289}
  218. span.classifier {
  219. font-family: sans-serif ;
  220. font-style: oblique }
  221. span.classifier-delimiter {
  222. font-family: sans-serif ;
  223. font-weight: bold }
  224. span.interpreted {
  225. font-family: sans-serif }
  226. span.option {
  227. white-space: nowrap }
  228. span.pre {
  229. white-space: pre }
  230. span.problematic {
  231. color: red }
  232. span.section-subtitle {
  233. /* font-size relative to parent (h1..h6 element) */
  234. font-size: 80% }
  235. table.citation {
  236. border-left: solid 1px gray;
  237. margin-left: 1px }
  238. table.docinfo {
  239. margin: 2em 4em }
  240. table.docutils {
  241. margin-top: 0.5em ;
  242. margin-bottom: 0.5em }
  243. table.footnote {
  244. border-left: solid 1px black;
  245. margin-left: 1px }
  246. table.docutils td, table.docutils th,
  247. table.docinfo td, table.docinfo th {
  248. padding-left: 0.5em ;
  249. padding-right: 0.5em ;
  250. vertical-align: top }
  251. table.docutils th.field-name, table.docinfo th.docinfo-name {
  252. font-weight: bold ;
  253. text-align: left ;
  254. white-space: nowrap ;
  255. padding-left: 0 }
  256. /* "booktabs" style (no vertical lines) */
  257. table.docutils.booktabs {
  258. border: 0px;
  259. border-top: 2px solid;
  260. border-bottom: 2px solid;
  261. border-collapse: collapse;
  262. }
  263. table.docutils.booktabs * {
  264. border: 0px;
  265. }
  266. table.docutils.booktabs th {
  267. border-bottom: thin solid;
  268. text-align: left;
  269. }
  270. h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
  271. h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  272. font-size: 100% }
  273. ul.auto-toc {
  274. list-style-type: none }
  275. </style>
  276. </head>
  277. <body>
  278. <div class="document" id="bi-view-editor">
  279. <h1 class="title">BI View Editor</h1>
  280. <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  281. !! This file is generated by oca-gen-addon-readme !!
  282. !! changes will be overwritten. !!
  283. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
  284. <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/11.0/bi_view_editor"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-11-0/reporting-engine-11-0-bi_view_editor"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/143/11.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
  285. <p>BI View Editor is a tool integrated in Odoo that allows users define and
  286. execute their own reports without the need to code.</p>
  287. <p>Purpose:</p>
  288. <ul class="simple">
  289. <li>The BI View Editor is used to create reports not already contained in the
  290. standard Odoo, combining data from existing sources.</li>
  291. <li>It has been designed to be used by users with little or no knowledge of
  292. the technical architecture of Odoo. Users visually link business objects
  293. and select the fields to visualize.</li>
  294. <li>The BI View Editor offers users different types of representations,
  295. including tree, graph, pivot views.</li>
  296. </ul>
  297. <p><strong>Table of contents</strong></p>
  298. <div class="contents local topic" id="contents">
  299. <ul class="simple">
  300. <li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
  301. <li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
  302. <li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
  303. <li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
  304. <li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
  305. <li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
  306. <li><a class="reference internal" href="#other-credits" id="id7">Other credits</a><ul>
  307. <li><a class="reference internal" href="#images" id="id8">Images</a></li>
  308. <li><a class="reference internal" href="#funders" id="id9">Funders</a></li>
  309. </ul>
  310. </li>
  311. <li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li>
  312. </ul>
  313. </li>
  314. </ul>
  315. </div>
  316. <div class="section" id="usage">
  317. <h1><a class="toc-backref" href="#id1">Usage</a></h1>
  318. <p>To graphically design your analysis data-set:</p>
  319. <ul class="simple">
  320. <li>From the Dashboards menu, select “Custom BI Views”</li>
  321. <li>Browse trough the business objects in the Query tab</li>
  322. <li>Pick the interesting fields (Drag &amp; Drop)</li>
  323. <li>For each selected field, right-click on the Options column and select whether it’s a row, column or measure; if you want to remove the field from the list view, unflag the checkbox ´List´ in the Options column</li>
  324. <li>Save and click “Generate BI View”</li>
  325. <li>Click “Open BI View” to view the result</li>
  326. <li>If module Dashboard (board) is installed, the standard “Add to My Dashboard” functionality would be available</li>
  327. <li>Click “Create a menu” to create a new menu item directly linked to your new BI view (this feature is available in developer mode); when the BI view is reset back to draft this menu will be removed, and you will need to re-create the menu entry.</li>
  328. </ul>
  329. </div>
  330. <div class="section" id="known-issues-roadmap">
  331. <h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
  332. <ul class="simple">
  333. <li>Non-stored fields and many2many fields are not supported</li>
  334. <li>Provide graph view for table relations</li>
  335. <li>Extend the capabilities of the tree views (e.g. add sums)</li>
  336. <li>Provide a tutorial (eg. a working example of usage)</li>
  337. <li>Implement a more advanced UI, with possibilities to use LEFT JOIN as default instead of INNER JOIN</li>
  338. <li>Find better ways to extend the <em>_auto_init()</em> without override</li>
  339. <li>Possibly avoid the monkey patches</li>
  340. <li>Data the user has no access to (e.g. in a multi company situation) can be viewed by making a view</li>
  341. <li>Store the JSON data structure in ORM</li>
  342. <li>Would be nice if models available to select when creating a view are limited to the ones that have intersecting groups (for non technical users)</li>
  343. </ul>
  344. </div>
  345. <div class="section" id="bug-tracker">
  346. <h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
  347. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>.
  348. In case of trouble, please check there if your issue has already been reported.
  349. If you spotted it first, help us smashing it by providing a detailed and welcomed
  350. <a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20bi_view_editor%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
  351. <p>Do not contact contributors directly about support or help with technical issues.</p>
  352. </div>
  353. <div class="section" id="credits">
  354. <h1><a class="toc-backref" href="#id4">Credits</a></h1>
  355. <div class="section" id="authors">
  356. <h2><a class="toc-backref" href="#id5">Authors</a></h2>
  357. <ul class="simple">
  358. <li>Onestein</li>
  359. </ul>
  360. </div>
  361. <div class="section" id="contributors">
  362. <h2><a class="toc-backref" href="#id6">Contributors</a></h2>
  363. <ul class="simple">
  364. <li>Simon Janssens &lt;<a class="reference external" href="mailto:s.janssens&#64;onestein.nl">s.janssens&#64;onestein.nl</a>&gt;</li>
  365. <li>Diego Luis Neto &lt;<a class="reference external" href="mailto:diegoluis.neto&#64;gmail.com">diegoluis.neto&#64;gmail.com</a>&gt;</li>
  366. <li>Dennis Sluijk &lt;<a class="reference external" href="mailto:d.sluijk&#64;onestein.nl">d.sluijk&#64;onestein.nl</a>&gt;</li>
  367. <li>Kevin Graveman &lt;<a class="reference external" href="mailto:k.graveman&#64;onestein.nl">k.graveman&#64;onestein.nl</a>&gt;</li>
  368. <li>Richard Dijkstra &lt;<a class="reference external" href="mailto:r.dijkstra&#64;onestein.nl">r.dijkstra&#64;onestein.nl</a>&gt;</li>
  369. <li>Andrea Stirpe &lt;<a class="reference external" href="mailto:a.stirpe&#64;onestein.nl">a.stirpe&#64;onestein.nl</a>&gt;</li>
  370. <li>Antonio Esposito &lt;<a class="reference external" href="mailto:a.esposito&#64;onestein.nl">a.esposito&#64;onestein.nl</a>&gt;</li>
  371. <li>Jordi Ballester Alomar &lt;<a class="reference external" href="mailto:jordi.ballester&#64;eficent.com">jordi.ballester&#64;eficent.com</a>&gt;</li>
  372. </ul>
  373. </div>
  374. <div class="section" id="other-credits">
  375. <h2><a class="toc-backref" href="#id7">Other credits</a></h2>
  376. <div class="section" id="images">
  377. <h3><a class="toc-backref" href="#id8">Images</a></h3>
  378. <ul class="simple">
  379. <li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li>
  380. </ul>
  381. </div>
  382. <div class="section" id="funders">
  383. <h3><a class="toc-backref" href="#id9">Funders</a></h3>
  384. <p>The development of this module has been financially supported by:</p>
  385. <ul class="simple">
  386. <li>IDEAL Connaissances SAS <a class="reference external" href="https://www.idealconnaissances.com">https://www.idealconnaissances.com</a></li>
  387. </ul>
  388. </div>
  389. </div>
  390. <div class="section" id="maintainers">
  391. <h2><a class="toc-backref" href="#id10">Maintainers</a></h2>
  392. <p>This module is maintained by the OCA.</p>
  393. <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
  394. <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
  395. mission is to support the collaborative development of Odoo features and
  396. promote its widespread use.</p>
  397. <p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/11.0/bi_view_editor">OCA/reporting-engine</a> project on GitHub.</p>
  398. <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
  399. </div>
  400. </div>
  401. </div>
  402. </body>
  403. </html>