› Workflow › Business processes › Design a basic process › Add an activity › Activity types › AI Knowledge Base activities › Add to knowledge base activity › Configure an Add to knowledge base activity

Configure an Add to knowledge base activity

Use the following procedure to configure an Add to knowledge base activity.

The Add to knowledge base activity is available only to Enterprise tier customers. For users on the Standard and Advanced tiers, this feature is restricted and indicated by a lock icon.

  1. Add an activity to the map. See Add an activity.

    By default, the Configuration tab is open in the properties panel of the activity.

  2. Enter a Name for the activity.
  3. On the Type list, select AI Knowledge Base > Add to knowledge base.
  4. On the AI Knowledge Base provider list, select the knowledge base provider configured. See Integrate TotalAgility with AI Knowledge Base.

    If using the Tungsten knowledge base provider, you must have the required licenses to add documents to the knowledge base.

  5. The indexes that are added while configuring the AI knowledge base integration are automatically added in Azure AI Search and appear on the Index list. Select an index.
  6. On the Input list, select one of the following variable types.

    Document A single document is added to the knowledge base.
    Folder All documents within the folder are added to the knowledge base.
    String/Data object

    The text provided is added to the knowledge base. You can access the unique ID for any non-document data added to the knowledge base and use it to delete that data.

    The Mime type, Sources, and “Overwrite if exists” properties are unavailable for String and Data object input types.

  7. On the Tag list, select a process or server variable of type String or provide an inline value such as SharePoint or an external system.

    The Tag property is only available if you select the input variable as String or Data object.

  8. On the Mime type list, select a mime type, such as PDF.
  9. Under Index fields, you can add identifiers to a document and modify or delete existing identifiers. You can add multiple identifiers, however, the same identifier type cannot be used more than once.

    To add an identifier

    1. Click .

    2. In the Name box, click the down arrow to expand the list, and select one of the following identifiers: Job ID,Case ID, or Case Ref. (Default: None)

    3. In the Value box, click the down arrow and select a server or process string variable.

      If you select a nullableString for any identifier, no value is stored for it, but you can pass any value through nullablestring.

    To edit an identifier Select the identifier and click and modify the required fields.
    To delete an identifier Select the identifier and click .

  10. To overwrite a document or all documents in a folder if they already exist, select Overwrite if exists. (Default: Clear)
  11. To suspend the job if the document already exists in the knowledge base, select Suspend job on error. (Default: Clear)

    The "Suspend job on error" property is available only if the "Overwrite if exists" property is not enabled.

  12. On the ID list, select a String variable (process or server).
  13. Save the process.

    When the activity is executed:

    • The documents and text are added to the knowledge base with the configured identifiers.

    • The document/data is added to the knowledge base, and the mapped variable (String or Data object) is populated with the unique ID assigned to the chunk in the knowledge base.

    • An audit log entry is recorded.

    • An error occurs if the document does not exist and the "Overwrite if exists" property is enabled.

    When uploading large documents to the AI knowledge base, you may need to increase the target activity duration according to the document size to ensure successful uploads.