{"id":17980,"date":"2017-03-07T15:34:33","date_gmt":"2017-03-07T15:34:33","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&p=10250"},"modified":"2023-02-15T11:48:25","modified_gmt":"2023-02-15T11:48:25","slug":"general-settings","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-settings\/general-settings\/","title":{"rendered":"General Settings"},"content":{"rendered":"
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

To modify the general settings of a bot:<\/p>\n

    \n
  1. Select the\u00a0Build<\/strong> tab from the top.<\/li>\n
  2. Click\u00a0Configuration > General Settings<\/strong>.<\/li>\n

    \"Bot<\/a><\/ol>\n

    General Bot Settings<\/span><\/h2>\n

    Modify one or more of the settings described in the following table.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Field<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    Bot Name<\/td>\nThe name of the Bot. When a Bot is published, the Name<\/strong> cannot be changed. This field is required.<\/td>\n<\/tr>\n
    Description<\/td>\nThe description of the Bot. This field is required.<\/td>\n<\/tr>\n
    Icon<\/td>\nThe icon\u00a0image for\u00a0the Bot\u00a0displayed in Bot\u00a0Builder, Bots Marketplace, and the end-user interface as shown in the previous illustration. The image format must be .png<\/span> and best results are obtained using a 200 x 200-pixel image. This field is required.<\/td>\n<\/tr>\n
    Target Audience<\/td>\n\n
      \n
    • Select General Public<\/strong> if the bot is for public use for both managed and unmanaged users in your domain. Bot assignments are not required and when the Bots Admin deploys the bot, it is available for use by all domain users. Use this option to make a bot widely available for all user types.<\/span><\/li>\n
    • Select Enterprise Users<\/strong> if the bot is for managed users only in a domain, for example, for your employees or paid customers. After the Bots Admin approves and deploys this bot, it is not available to any managed users unless explicitly assigned by the Bots Admin. Use this option when you want to control which managed users in your domain can access and set up this bot on their devices.<\/span><\/li>\n<\/ul>\n

      Once Target Audience<\/strong> is defined and saved, you cannot change them.<\/td>\n<\/tr>\n

    Default Bot Language<\/td>\nThis is uneditable and is set at the time of Bot creation.<\/td>\n<\/tr>\n
    Bot Id<\/td>\nNon-editable, assigned by the platform. Can be copied for use in API calls etc..<\/td>\n<\/tr>\n
    Variable Namespaces<\/td>\nYou can categorize variables using Namespaces and map them to various components. The XO Platform will load the variables only from the mapped namespaces while executing specific components. Learn more<\/a>.<\/td>\n<\/tr>\n
    Subdomain (Tenancy)<\/td>\n\n

    Click Yes<\/strong> to enable the use of tenancy. When the tenancy is defined, the end-user is prompted to enter a tenant name as part of the URL for the Bot, for example, kore<\/em>, for the\u00a0www.kore<\/em><\/strong>.someWebService.com<\/span> tenant-specific URL.<\/span><\/span> When enabled define the following properties:<\/p>\n

      \n
    • Help Hint<\/strong> – The text displayed to the end-user to prompt the user to enter a tenant-specific URL for the Bot.<\/li>\n
    • Base\u00a0URL<\/strong> – The base URL for the Bot that the end-user must specify their company to complete the tenant-specific URL using the following syntax: https:\/\/{tenant}.someWebService.com\u00a0where<\/span>\u00a0{tenant}, including the braces, represents the tenant name.<\/span><\/span>\u00a0<\/span><\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    Show link for task setup\/execution<\/td>\n\n
      \n
    • Select Yes<\/strong> to display a link to enable the choice for a user to input information used to execute a task in a user interface form or input the data directly into the message input field, for example, <\/span>Enter the title for new Asana task. To make edits, click here.<\/span>\u00a0<\/em><\/span>where\u00a0<\/span>here<\/span><\/em> is a link to a form with fields.<\/span><\/li>\n
    • When No<\/strong> is selected, the user can only input information for the task in the message input field. For example, <\/span>Enter the title for new Asana task<\/em>.<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    Error Message(s)<\/td>\nEdit or add custom HTTP Status Codes<\/strong> and error messages for your Bot. For more information, see Customizing Error Messages<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    To save the Bot settings, click Save<\/strong>. The < Bot Name<\/strong> > updated successfully<\/em> message is displayed.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Customizing Error Messages<\/span><\/h2>\n

    In Bot Builder, each Bot and task contains a set of predefined error messages along with actions for standard HTTP Status codes returned for an HTTP Request method. In most cases, the default response and action are sufficient for an end-user response, however, you may need to handle other HTTP Status codes not defined by default, or customize the error message itself, or change the default response by Kore.ai in the event of an error. This topic describes how to customize and create error messages for Kore.ai Bots and tasks. When you create a Bot or a task, you can add or customize error messages for HTTP Status codes in the Error Messages<\/strong> section of the Bot or task settings. \"General
    \n<\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t

    \r\n\t\t
    \r\n\t\t\t

    Custom Status Codes<\/span><\/h3>\n

    There are approximately 25 HTTP Status codes defined by default for a Bot or task. To customize an HTTP Status code<\/strong><\/p>\n

      \n
    1. Open the Bot or task in Bot Builder<\/li>\n
    2. Select\u00a0Build<\/strong> tab from top menu<\/li>\n
    3. From the left menu click Configurations -> General Settings <\/strong><\/li>\n
    4. Scroll down to locate the Error Messages<\/strong> section.<\/li>\n
    5. Click the Edit<\/strong>\u00a0\"Edit\u00a0icon for the code that you want to customize to open the\u00a0Setup Error Message<\/strong> dialog. \"Setup
      \n<\/a><\/li>\n
    6. In the Message Type<\/strong> field, select one of:\n