Knowledge base

This is a TIPP CORE administration page, with the browser title “TIPP knowledge base”. It installs the documentation of the database tables and columns that the AI uses when it writes SQL, and lets a consultant record notes that explain what this customer’s data means. It is used by a TIPP administrator or consultant after installing or upgrading TIPP, and whenever generated SQL turns out wrong for this company.

Before you start

• Only administrators can open this page.
• The page must be allowed under TIPP Page Security.
• The knowledge base table must exist in the database. If not you see “The knowledge base table is missing. Run TIPP_KnowledgeBase.sql first.” and the page is not usable.
• To install documentation you need either a documentation pack built into your TIPP version or a .pack file from the knowledge extractor.

How to install or update the schema documentation

1. Open Knowledge base and look at the Schema documentation section. It has one row per product: Synergy always, plus Globe, Macola or JobBoss when your installation has such companies.
2. Compare the columns In this database and Shipped with this build. Each shows a version with the number of tables and columns, and rules where there are any.
3. Click the button in the last column. It reads Install if nothing is installed yet, Update if a different version is installed, and Reinstall if the installed version equals the shipped one (the row also shows “up to date”).
4. Wait for the overlay “Please leave the page open.” to finish. A green message “Installed” followed by product, version and counts appears and the table refreshes.

Installing replaces only the documentation that came with TIPP for that product. Your own notes are never touched.

How to load a pack from a file

1. In Load a pack from a file, click the file chooser next to Pack file and select a .pack file written by the knowledge extractor.
2. Click Load. The pack states its own product, so Globe.pack loads as Globe.
3. Check the green message with the number of tables, columns and curated rules installed.

How to add a rule or note for the AI

1. In Rules the AI must follow, choose the Product the note applies to.
2. Choose Kind: “Product knowledge (ships with TIPP)” for general truth about the product, or “Relevant for us” for something that is only true in this installation.
3. Set Order. Lower numbers go first. The default is 100. Put hard rules above examples.
4. Optionally enter a Title (up to 200 characters).
5. Write the Note. A whole block of rules is fine. For example, a rule that a certain selection code means intercompany and must be excluded.
6. Click Save. You see “Note added. It is sent in full with every AI request for that product.” Click Clear to empty the form without saving.

How to edit or delete a note

1. In Everything the AI is told, find the note. Notes are sorted by product, then Product knowledge before local notes, then by Order.
2. Click Edit. The note loads in the form above. Change it and click Save: “Note updated.”
3. To remove a note, click Delete and confirm “Delete this note?”. You see “Note deleted.”

How to see what the AI is told

1. In What the AI actually sees, choose the Database. Leave it empty for Synergy.
2. Optionally type a Question in your own words.
3. Click Show. A summary line and the exact text passed to the AI appear.

Screen guide

Schema documentation

• Product: the system the documentation is for.
• In this database: the installed version and how many tables, columns and rules it holds, or a dash if nothing is installed.
• Shipped with this build: the version available in your TIPP version, or “none”.
• Installed: when it was installed.
• Install, Update, Reinstall: installs the shipped documentation for that row. “nothing to install” appears when nothing ships for that product.

Rules the AI must follow

• Product: which product the note belongs to. Required.
• Kind: Product knowledge (ships with TIPP) or Relevant for us. Both are sent in full on every request.
• Order: whole number, default 100; zero or lower becomes 100.
• Title: optional, up to 200 characters.
• Note: required, at least 3 characters.
• Save and Clear: store the note, or empty the form.

Everything the AI is told

• Product, Scope, Order, Title, Note: Scope shows curated for Product knowledge and local for Relevant for us. Long product notes show only their length in characters and say to open them to read; click Edit to read them. Local notes show the first part of the text.
• Edit and Delete: change or remove a note.

Messages and what to do

• “The knowledge base table is missing. Run TIPP_KnowledgeBase.sql first.” Ask your TIPP consultant to run that script on the database.
• “No packs are embedded in this build of TIPP.Knowledge” followed by instructions: load a pack from a file instead.
• “Choose a .pack file first.” Select a file before clicking Load.
• “That file is not a knowledge pack:” followed by a reason. Use a .pack written by the knowledge extractor.
• “The pack does not say which product it is for.” or “The pack contains no tables.” The file is incomplete; get a new one.
• “No pack for” a product “ships with this build.” Use Load a pack from a file.
• “Could not read the pack:” followed by a reason, and “Install failed, nothing was changed:” followed by a reason. Nothing was changed; fix the cause shown and retry.
• “Write the note first.” The Note is empty or shorter than 3 characters.
• “Preview failed:” followed by a reason. Check the Database and try again.

What you cannot do here

• Edit the documentation that ships with TIPP. It can only be replaced by installing or loading a pack.
• Use the page without being an administrator.
• Keep two versions of the same product documentation. Installing replaces the earlier one.

Related pages

• TIPP AI Settings: where the AI provider keys and models are set.
• TIPP Page Security: controls who can open this page.

Common questions

What is the knowledge base for? It holds the table and column documentation and the rules the AI needs to write correct SQL for your data.

How do I install the documentation? In Schema documentation, click Install (or Update) on the product row.

What is the difference between Update and Reinstall? Update appears when the shipped version differs from the installed version. Reinstall appears when they are equal (“up to date”) and installs it again.

Will an update remove my notes? No. Installing only replaces the documentation that came with TIPP. Notes written on this page are left alone.

What is the difference between the two Kinds of notes? Product knowledge (ships with TIPP) is general truth about the product. Relevant for us describes only this installation. Both are sent in full on every request.

What should I write in a note? Short, concrete rules, for example which code to exclude or which field holds a certain value. A few good notes are worth more than many vague ones.

What does Order do? Notes with a lower number are sent first. Use low numbers for hard rules.

How do I check what the AI will see? Use What the AI actually sees: choose the Database, type a Question, and click Show.

Why is a product missing in the list? Synergy always appears. Globe, Macola and JobBoss appear only when your installation has a company of that type or a pack for it ships.

How do I load a .pack file? Choose it next to Pack file under Load a pack from a file and click Load.

Why does the page not open for me? Only administrators can use it.