Guides
Maintain a knowledge base
Keep the organization knowledge base current with text or URL source material.
The knowledge base accepts one source item at a time. Use it for policy text or a canonical URL that your organization wants Orvelt to use as source material.
Add an item
Choose text or a canonical URL
Call knowledgeBase.add with exactly one of:
text, up to 10,000 characters.url, up to 2,048 characters and formatted as a URI.
Do not send both fields in the same item. Keep the text concise and link to the canonical source when a URL can change independently.
List source items
Keep the returned item ID
Call knowledgeBase.get before editing a policy or removing an outdated source. Keep the returned item ID with the source record in your admin tool.
Update or remove an item
Confirm dependencies before deletion
Use knowledgeBase.update with the item ID and the replacement text or url. Use knowledgeBase.delete only after confirming that no current workflow depends on the item.