Skip to content

Documents

A collection's documents are its manuals and SOPs, searched by the documents grounding tool for Incident and Ask.

  • Formats: PDF, and UTF-8 text (.txt, .md, .csv). Refused with a reason: an encrypted PDF, a PDF with no text layer (a scan: run OCR first), text that is not UTF-8, Word and Excel files, anything else.
  • Artekis keeps a document's text, not the file. Keep the original elsewhere. At most 25 MB per upload, 1,000,000 characters of text per document and 200 documents per collection; the same file twice in one collection is refused. Documents are never pruned; you delete them.
  • Safety: key-shaped strings are replaced with «redacted» before the text is stored, and so is any unbroken run of 1,024 or more letters and digits (an encoded key, certificate or image); the upload reports how many.
  • Upload through the Context model view's Documents card (a narrow layout shows an upload icon that opens a Browse pop-up), through system.artekis.documents.add(collection, filename, bytes) with a byte array (for example event.file.getBytes from a File Upload component), or through POST /data/artekis/web/documents?collection=&filename= with the file as an application/octet-stream body (a form body is refused). A refusal carries an HTTP status and a code: encrypted, no-text, not-utf8, format, cap, duplicate, no-model, forbidden, storage. A PDF that takes more than 60 s to read is refused format with a message starting extraction-timeout:: export a simpler PDF or split it. A 25 MB PDF uploaded through the gateway route parsed in 2.3 s; the same file added from a Designer script took 13.7 s (it crosses the Designer link encoded).
  • Linking: the context model is the only link between an asset and a document: select the document and the asset in the editor and the link is kept by Save. Deleting a document an asset still links is allowed: the model then warns about the missing id and the asset's documents coverage drops until the link is removed.
  • Upload and delete show only at documentUploadSecurityLevel, and every attempt, refused ones included, is an Artekis.Audit line.