Configuration reference

This page describes the JSON stored in the ai.powerfinder.metadata parameter. It holds the indexes and contexts of the PowerFinder plugin.

The Indexes and Contexts tabs of the PowerFinder configuration page write this JSON for you. Use this page to read or check a configuration. For the meaning of each setting, see the Usage Manual.

Structure

{
  "indexes": {
    "<index name>": { ...index... }
  },
  "contexts": {
    "<context name>": { ...context... }
  }
}

The keys of indexes and contexts are the names of the indexes and contexts. Names must be unique.

Index

Key	Type	Description
table	string	Name of the class or process to index
active	boolean	false disables the index: it is not synchronized and not queried
attributes	array	Attributes to index. See Attribute
filter	string	Optional CMDBuild filter, as a JSON string. Only matching cards are indexed
add_attachments	boolean	true also indexes the attachments of the cards. Requires the DMS
permissions	object	Who can query the index. See Permissions
description	string	Optional description of the index

Attribute

Key	Type	Description
name	string	Name of the attribute in the class or process
active	boolean	false keeps the attribute in the list but does not send it to PowerFinder
description	string	Description of the attribute
extended_description	string	Powerfinder description of the attribute

Permissions

Key	Type	Description
mode	string	auto: users who can read the class or process can query the index. custom: only the groups in groups can
groups	array of strings	Group names. Used only with custom

Context

Key	Type	Description
indexes	array of strings	Names of the indexes in the context
notes	string	Optional notes

The default and search contexts are always present. The global chatbot and the requests without a context use default. The Homepage AI search uses search.

Example

Help desk users can query incidents and the knowledge base. All users who can read the KnowledgeBase class can query its index. The incident index includes only open incidents (lookup Status with ID 10553) and their attachments.

{
  "indexes": {
    "table_Incident": {
      "table": "Incident",
      "active": true,
      "attributes": [
        { "name": "Code", "active": true, "description": "Code", "extended_description": "Incident number" },
        { "name": "ShortDescr", "active": true, "description": "Short description", "extended_description": "Summary of the problem" },
        { "name": "Description", "active": true, "description": "Description", "extended_description": "Full description of the problem" },
        { "name": "Category", "active": true, "description": "Category", "extended_description": "Incident category" },
        { "name": "Notes", "active": false, "description": "Notes", "extended_description": "" }
      ],
      "filter": "{\"attribute\":{\"simple\":{\"attribute\":\"Status\",\"operator\":\"equal\",\"value\":[\"10553\"],\"parameterType\":\"fixed\"}}}",
      "add_attachments": true,
      "permissions": {
        "mode": "custom",
        "groups": ["Helpdesk", "SuperUser"]
      }
    },
    "table_KnowledgeBase": {
      "table": "KnowledgeBase",
      "active": true,
      "attributes": [
        { "name": "Code", "active": true, "description": "Code", "extended_description": "Article code" },
        { "name": "Description", "active": true, "description": "Title", "extended_description": "Article title" },
        { "name": "Solution", "active": true, "description": "Solution", "extended_description": "Steps to solve the problem" }
      ],
      "filter": "",
      "add_attachments": false,
      "permissions": {
        "mode": "auto",
        "groups": []
      }
    }
  },
  "contexts": {
    "default": {
      "indexes": ["table_KnowledgeBase"]
    },
    "search": {
      "indexes": ["table_Incident", "table_KnowledgeBase"]
    },
    "ticketing": {
      "indexes": ["table_Incident", "table_KnowledgeBase"],
      "notes": "Used by the AI Assistant widget of the Incident process"
    }
  }
}