From 8f1d4d282452fb3720ca28633827ee0618693326 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Sat, 11 May 2019 11:00:04 +0000 Subject: [PATCH] [UPD] README.rst --- base_technical_user/README.rst | 85 +++++ sql_export/README.rst | 111 ++++++ sql_export/static/description/index.html | 466 +++++++++++++++++++++++ 3 files changed, 662 insertions(+) create mode 100644 base_technical_user/README.rst create mode 100644 sql_export/static/description/index.html diff --git a/base_technical_user/README.rst b/base_technical_user/README.rst new file mode 100644 index 000000000..2b67e7605 --- /dev/null +++ b/base_technical_user/README.rst @@ -0,0 +1,85 @@ +=================== +Base Technical User +=================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/12.0/base_technical_user + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-base_technical_user + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module extends the functionality of company management. +It allows you to bind a technical user on the company in order to use it in +batch processes. + +The technical user must +- be inactive to avoid login +- be in the required groups depending of what you need to do + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +If you install the module, you will find a tab on the company form allowing +to define the technical user. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* ACSONE SA/NV + +Contributors +~~~~~~~~~~~~ + +* Cédric Pigeon + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/sql_export/README.rst b/sql_export/README.rst index 11f4118db..963e95fa3 100644 --- a/sql_export/README.rst +++ b/sql_export/README.rst @@ -7,3 +7,114 @@ SQL Export !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/12.0/sql_export + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-sql_export + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Allow to export data in csv files FROM sql requests. +There are some restrictions in the sql query, you can only read datas. +No update, deletion or creation are possible. +A new menu named Export is created. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + + +Dashboards > Sql Export + + +**Specific use with parameters** + +- `%(company_id)s` allows to set in the query the company id of the user +- `%(user_id)s` allows to set in the query the user id +- for any created field with `Sql Export Variables` menu, you can use it with `%(x_field_example)s` syntax + (Limitation for relational fields) + +Known issues / Roadmap +====================== + +* Some words are prohibited and can't be used is the query in anyways, even in + a select query: + - delete + - drop + - insert + - alter + - truncate + - execute + - create + - update + +See sql_request_abstract module to fix this issue. + +* checking SQL request by execution and rollback is disabled in this module + since variables features has been introduced. This can be fixed by + overloading _prepare_request_check_execution() function. + +* Move modules sql_request_abstract and sql_export to oca/reporting-engine + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Akretion + +Contributors +~~~~~~~~~~~~ + +* `Akretion `_: + + * Florian da Costa + * Mourad EL HADJ MIMOUNE + * Benoît GUILLOT + +* `Eficent `_: + + * Aaron Henriquez + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/sql_export/static/description/index.html b/sql_export/static/description/index.html new file mode 100644 index 000000000..28ec8b66d --- /dev/null +++ b/sql_export/static/description/index.html @@ -0,0 +1,466 @@ + + + + + + +SQL Export + + + +
+

SQL Export

+ + +

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

+

Allow to export data in csv files FROM sql requests. +There are some restrictions in the sql query, you can only read datas. +No update, deletion or creation are possible. +A new menu named Export is created.

+

Table of contents

+ +
+

Usage

+

Dashboards > Sql Export

+

Specific use with parameters

+
    +
  • %(company_id)s allows to set in the query the company id of the user
    • +
  • %(user_id)s allows to set in the query the user id
    • +
  • for any created field with Sql Export Variables menu, you can use it with %(x_field_example)s syntax +(Limitation for relational fields)
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Some words are prohibited and can’t be used is the query in anyways, even in +a select query: +- delete +- drop +- insert +- alter +- truncate +- execute +- create +- update
    • +
+

See sql_request_abstract module to fix this issue.

+
    +
  • checking SQL request by execution and rollback is disabled in this module +since variables features has been introduced. This can be fixed by +overloading _prepare_request_check_execution() function.
    • +
  • Move modules sql_request_abstract and sql_export to oca/reporting-engine
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Akretion
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/server-tools project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +