Loading the JSON File

This topic describes the pre-selection requirements for knowledge field mapping when uploading documents to an external knowledge system.

For example, if you want the Author field to automatically be set as “John Fernandes” during document upload, this can be configured in advance. Once configured, the author’s name will be automatically populated when the document is published to the external knowledge system.

If such preselection requirements exist, please provide the following details for each field you would like to configure prior to generating the Knowledge Base (KB) articles. These configurations are uploaded into Aisera using a JSON file. The JSON file must be created with the required field details and then uploaded through the Admin UI (refer to the sections below).

Create the JSON File

To create the JSON file, the following information is required:

• Field Name

• Field Path

• Data Type

• Allowed Values within the Field

• Selection Type (Single-select or Multi-select)

Additionally, please review the technical specifications below regarding the required JSON format structure.

KB Generation Field Maps

External System Fields JSON

{

   "fields": [

     {

       "fieldName": "string", //Field Label which user sees in the UI when mapping for a job.

       "fieldPath": "string", //

       "dataType": "string",

       "externalFieldType": "string"

       "allowMultiSelect": true,

       "values": [

          "test",
          
"test2"

        ]

     }
   
]

 }

fieldName: (Required field)

This is the label which user sees in the external system and also which user sees in the Aisera UI when mapping for a job.

For Salesforce you can find this in Fields & Relationships view under FIELD LABEL column.

fieldPath: (Required field)

This is the path of the field which is used while uploading this field to external system.

For Salesforce you can find this in Fields & Relationships view under FIELD Name column.

dataType: (Optional field, Default value is string)

This the dataType of the field value.

Supported values for this is Integer, Boolean, String.

For Integer, Long and Double values use Number as DataType

externalFieldType: (Optional field)

Right now every field is dropdown where user can select one or multiple values based on the allowMultiSelect field, we want to provide support for use cases where user can enter values dynamically for text, date ..e.t.c so to provide custom extensibility we have added this field.

allowMultiSelect: (Optional field, Default value is false.)

This field is used to specify whether external system supports multiple values for that field or not.

Supported values for that field is true or false.

values:

The list of value supported by external system.

Values should of same dataType provided in the above field.

Upload the JSON file using the Aisera Admin UI:

1. Navigate to Settings -> Configuration -> Knowledge Generation.

You will see the following screen.

The Integration Type pull-down lists the integrated systems for which JSON files have been uploaded to your Aisera Gen AI tenant. This section will appear blank if no files have been uploaded previously.

1. Choose an existing Integration name from the pull-down list.

2. Select the radio button for Add data values from the JSON to upload a new file.

Select the integration type and upload the JSON file as per the instructions in the pre-requisite section.

If your JSON files contains new values, select the option Completely override values with latest file and click OK.

For any existing values to be updated/deleted use this override option.

This action will entirely replace the fields and values, and the updated data will be reflected in the Knowledge Generation -> Action -> Configuration -> Knowledge Field Mapping page.

NOTE: There is no capability to remove an existing field from any of the above options.

Supported Data Types:

Number Field Types: These fields accept only numerical values. Depending on the 'allowMultiSelect' setting, users can select either single or multiple number values.

Text Field Types: These fields accept alpha, numeric, special characters. If multiple values are provided, they appear in a dropdown menu. With 'allowMultiSelect' enabled, users can select multiple options from this dropdown.

Date/Time Field Types: These fields provide a date/time picker in the generated knowledge configuration screen, allowing users to select specific dates and times. The values given will be ignored. User should choose the data picker to select the date/time.

Picklist: These fields accept alpha, numeric, special characters. Presents a dropdown menu with predefined options, permitting single selection.

Picklist (Multi-Select): These fields accept alpha, numeric, special characters. Allows users to select multiple options from a dropdown menu in the configuration screen.

Record Type: These fields accept alpha, numeric, special characters. Users can choose from available values in a dropdown menu; these are not displayed as radio buttons in the user interface.

Checkbox: These fields accept alpha, numeric, special characters. Displayed as a picklist, enabling users to select either 'true' or 'false'.

Email: These fields accept alpha, numeric, special characters. When multiple email addresses are provided, they appear in a dropdown menu. If 'allowMultiSelect' is enabled, users can choose multiple email addresses from this dropdown.

Phone: Similarly, if multiple phone numbers are provided, they are listed in a dropdown menu. With 'allowMultiSelect' enabled, users can select multiple phone numbers from this list.These fields accept alpha, numeric, special characters.

Limitations:

There is no validation for phone numbers and email addresses in their formats. JSON will accept whatever values are provided in the JSON, so please validate before you upload.

Important note: When you start a job, the system saves the current knowledge field mappings. If these mappings or their values are changed later, such changes won't affect jobs that have already been run. For example, suppose a previous job included a field called "Product Line" with the value "Finance," and this value was used to prefill the "Product Line" field during document publishing. If someone later changes "Finance" to "Financial Module," the past job will still reference "Finance." When attempting to publish a document from that past job, the system won't find "Finance" in the updated mappings and will ignore this value. Only the fields and values that still exist in the current configuration will be prefilled during the document upload.

When you've finished this section, you will be able to load the knowledge field names and their corresponding values into the Aisera Gen AI Platform, where they are pulled and displayed on the Knowledge Generation -> Action -> Configuration -> Knowledge Field Mappings screen, as shown above.