Skip to content
Truchsess

Products and knowledge

A product is a part of your company that work belongs to. Products decide which members see what, and which knowledge a worker may read.

Who can do this

Section titled “Who can do this”
  • The administrator adds products, decides requests and imports knowledge.
  • Members request products and agents on the tab Products, and see their requests on the tab Requests.

Before you start

Section titled “Before you start”
  • A product id: lowercase letters, digits and hyphens, for example design-system. A worker refers to a product by this id.
  • For an import: the documents as .md or .txt files, or one .zip with them. You must be in the office on https://myai.local/.

Steps

Section titled “Steps”

Add a product

Section titled “Add a product”
  1. Open the tab Products, panel Add a product.
  2. Enter Product id and Product name.
  3. Press Add product. The product is active at once.

Decide a request

Section titled “Decide a request”

Members send requests on the tab Products: Request a new product and Request another agent.

  1. Open Administration, sub-tab General, panel Approvals.
  2. Read Requested by, Request, Product and Cost / month. “Approving a request authorizes its stated monthly cost.”
  3. Press Approve or Deny, adjust the reason, and press the button again to confirm.

An approved product request makes the product active, and the requester becomes its owner. An approved agent request records the agent under the product. It does not install a worker.

Import documents

Section titled “Import documents”
  1. Open Administration, sub-tab Knowledge.
  2. Choose the Product.
  3. Choose the Files: one .zip, or several .md and .txt files.
  4. Press Upload and review.
  5. Read the review list: Key, Original name, Title, Size, Status (“new”, “changed: … line(s) added, … removed”, or “unchanged”). Files that cannot be imported are listed under Skipped with the reason.
  6. Tick or untick documents under Import. Unchanged documents are not selected.
  7. Press Import selected, or Discard to stop.

What you see afterwards

Section titled “What you see afterwards”
  • The new product appears on Products and in every product list of the portal.
  • After an import: “Imported N document(s) into … Earlier versions of changed documents stay readable.” Workers on that product read the documents in their next task. See Knowledge.

Older revisions

Section titled “Older revisions”

Each import of a changed document makes a new revision. The earlier revisions stay in the box, with who wrote them and when. A worker with knowledge permission can read an older revision on request.

To go back to an earlier text, import the earlier file again: it shows as “changed”, and Import selected makes it the current version.

Your choices

Section titled “Your choices”
Choice What it does When to pick it Can you undo it?
Add product Creates an active product. A new area of work. No: a product cannot be deleted or renamed.
Approve a product request Makes the product active, the requester its owner. The cost and purpose are fine. No.
Deny Rejects the request. No.
Import selected Writes the chosen documents. After reading the review. Partly: import the earlier file again. A new document cannot be removed.
Discard Throws the upload away. Nothing is written. Wrong files. n/a

Limits of an import: at most 50 MB and 2,000 files per upload, at most 64 KB per document, text in UTF-8 only. An upload is deleted after an hour, or when you leave the page.

Skipped files and why: “not a text document” (not .md or .txt), “binary”, “too large” (over 64 KB), “bad name”, “link”, “path with ..”, “same key as another file”, “more than 2,000 files”.

Section titled “Related pages”