- APPS
- Viindoo Brain - Digest 17.0
| Lines of Code | 328 |
| Technical name | viin_brain_digest |
| License | OPL-1 |
| Website | https://viindoo.com/apps/app/17.0/viin_brain_digest |
| Read description for | |
| Required Apps | Discuss (mail) |
| Included Dependencies | Viindoo Brain |
Know how current your knowledge base is, from the digest your managers already read
For companies that keep their know-how in Viindoo Brain and send the e-mail digest
Adds Brain KPIs to the e-mail digest: pages edited and pages that need review, per company
Odoo 17.0 · Community, Viindoo Cloud · OPL-1
Extends Viindoo Brain.
What changes for your team
The knowledge base reports in with the other figures
The digest covers sales and activity, and says nothing about the knowledge base.
→ Brain Pages Edited counts the pages edited in the last 24 hours, 7 days and 30 days. Open Report shows each Space's pages by review state.
The review backlog is visible without opening Brain
An outdated procedure is found when someone follows it.
→ Brain Pages to Review counts the published pages waiting for their owner's review. Open Report lists them by owner, with Space and last edit.
Each digest reports what its readers need
A figure nobody asked for is noise in a manager's inbox.
→ Both figures sit in a Brain group on the KPIs tab of each digest, each with its own tick box.
Ready on day one
Installs by itself
Once Viindoo Brain and the KPI Digests app are both installed.
Set first
Tick the two figures on a digest and list its recipients. Send Now sends it at once and keeps its schedule.
What is included
The two digest figures, their tick boxes on every digest, and the Open Report links. The reports, review dates and page owners come with Viindoo Brain.
Before you decide
What leaves the database?
Two counts in the digest e-mail, sent to the recipients you list. No page title or content goes with them.
Do all recipients see the same numbers?
No. Each recipient's figures count only the pages that person may read.
We run several companies. Whose figures are these?
The company of the digest. One digest per company gives each company's managers their own.
Why is the to-review figure the same in all three columns?
It counts the pages waiting when the digest is sent, not over a period.
What does it take to run?
Viindoo Brain and the KPI Digests app. An administrator sets up the digests.
Try it, then ask us
The Documentation tab walks through setup and how to read each figure.
Pre-sales & partnership
viindoo.com/contactusTechnical support
viindoo.com/ticketTechnical requirements
- Odoo version: 17.0
- Editions: Odoo Community, Viindoo Cloud
- Required modules: Viindoo Brain, KPI Digests
- License: OPL-1
- Languages: English, Vietnamese
Viindoo Brain - Digest
Who this guide is for. The administrator who sets up the e-mail digest, and the people who receive it: managers and wiki owners who want to see how current the company wiki is. It describes what you see on screen and what to click.
Note
Extends Viindoo Brain - see its documentation: Viindoo Brain.
Overview
A company wiki is only useful while its pages are current. Viindoo Brain - Digest adds the health of the wiki to the e-mail digest that people already receive, so a wiki that is going stale is noticed without opening Brain.
The digest e-mail gains two figures, each with three columns (the last 24 hours, the last 7 days and the last 30 days):
- Brain Pages Edited - how many pages were edited in that period. It shows how alive the wiki is.
- Brain Pages to Review - how many published pages need a review today, because their review date has come or because an assistant changed them since they were last verified. It shows how much of the wiki is waiting for its owners.
Both figures are counted for the company of the digest, and each recipient sees the figures over the pages that person may read. Under each figure, an Open Report link opens the matching list in Brain.
| Role | What they do | Access right to assign |
|---|---|---|
| Administrator | Turns the two figures on for a digest, chooses who receives it and sends it. | Administration / Access Rights on the user. |
| Digest recipient | Reads the two figures in the e-mail and opens the matching report. | None: the person is listed in the Recipients tab of the digest. |
Setup (for the Administrator)
Installation
Viindoo Brain - Digest has no tile of its own in the Apps list. It installs itself when both Viindoo Brain and the KPI Digests app are installed. You can also tick Viindoo Brain - Digest in the Reports and Digest section of Brain ‣ Configuration ‣ Settings and click Save.
Turn the two figures on
Both figures are off until you switch them on, one digest at a time.
- Activate the developer mode: the Technical menu of Settings only shows in that mode.
- Open Settings ‣ Technical ‣ Email ‣ Digest Emails and open the digest you want to change, or click New to create one.
- Open the KPIs tab. The Brain group sits among the other KPI groups of the digest.
- Tick Brain Pages Edited and Brain Pages to Review, then save.
Each figure has its own tick box, so you can show only one of them.
Choose who receives the digest
Open the Recipients tab of the digest, click Add a line and select the people who should read the figures. Each recipient gets the e-mail in their own language.
Send the digest
The digest goes out on its own at the Periodicity you chose. To send it right away, for example to check the result, click Send Now at the top of the digest. It does not change the periodicity.
Digest recipient: reading the figures
Each Brain figure has its own block in the digest e-mail, with the number for the last 24 hours, the last 7 days and the last 30 days.
How to read them:
- Brain Pages Edited counts the pages of the company whose last edit falls in the period. A page edited several times counts once. Archived pages count; pages in Trash do not.
- Brain Pages to Review is the number of published pages that need review today, so it is the same in the three columns. Archived pages, drafts and pages in Trash are not counted.
- Each person sees the figures over the pages that person may read, so two recipients can see different numbers.
Open the matching report
Click Open Report under a figure to see the pages behind it.
Under Brain Pages Edited, Open Report opens Pages Analysis, which counts the pages of each Space by review state.
The report leaves archived pages out, so its total can be one or more lower than the figure in the e-mail.
Under Brain Pages to Review, Open Report opens Needs review, which lists the pages waiting for review, grouped by owner, with their Space, last edit and review state.
Both reports are also in Brain, under Reporting ‣ Pages Analysis and Pages ‣ Needs review. Everything else about these screens, and about reviewing and verifying pages, is in the Viindoo Brain documentation linked at the top.
Troubleshooting
- The Brain group is not on the KPIs tab.
- Viindoo Brain - Digest installs itself only when Viindoo Brain and the KPI Digests app are both installed. Check both in the Apps list, or tick Viindoo Brain - Digest in Brain ‣ Configuration ‣ Settings.
- A recipient does not see the Brain figures in the e-mail.
- Check that both figures are ticked on the KPIs tab of that digest and that the person is listed in the Recipients tab. An e-mail sent before the figures were ticked does not contain them: click Send Now to send a new one.
- Two recipients see different numbers.
- This is expected: each person's figures cover the pages that person may read.
- The Technical menu is missing in Settings.
- Activate the developer mode.
FAQ
- Can I show only one of the two figures?
- Yes. Each one has its own tick box in the Brain group.
- Do the figures follow the company?
- Yes. A digest belongs to one company, and the figures cover the pages of that company. Create one digest per company to give each company's managers their own figures.
- Does a page in Trash or an archived page count?
- Pages in Trash are not counted in either figure. Archived pages are counted in Brain Pages Edited only.
- Why is the Brain Pages to Review figure the same in the three columns?
- It is the number of pages waiting today, not a count over a period.
This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file).
You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one).
It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software.
The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.