{"id":24824,"date":"2020-10-30T12:07:19","date_gmt":"2020-10-30T12:07:19","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=24824"},"modified":"2022-10-03T08:59:45","modified_gmt":"2022-10-03T07:59:45","slug":"managing-namespace","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-settings\/bot-management\/managing-namespace\/","title":{"rendered":"Managing Namespace"},"content":{"rendered":"

Chances are that you have defined tens or hundreds of (Environment or Content) variables and used them in the VA definitions. These variables could have been used in defining text prompts or messages, JavaScript, transitions, and service call definitions. Loading all these variables for every single task irrespective of their usage would lead to delays in response times impacting the user experience.<\/span><\/p>\n

Using <\/span>Namespaces<\/strong> you can categorize variables and map them to various components. The XO Platform would load the variables only from the mapped namespaces while executing specific components.<\/span><\/p>\n

Learn more about Variables.<\/span><\/a><\/p>\n

<\/div><\/div>\n

Enabling Namespaces<\/span><\/span><\/h1>\n

You can enable namespaces by going to <\/span>Build > Configurations > General Settings. <\/strong>Turn on the toggle, then confirm your choice to enable the feature.<\/span>
<\/strong><\/p>\n

\"\"<\/a><\/span><\/p>\n

<\/div><\/div>\n

Implementation<\/span><\/span><\/h1>\n

Once the Variable Namespaces feature is enabled:<\/span><\/p>\n

    \n
  1. A <\/span>Default<\/strong> namespace is automatically created by the platform which cannot be deleted or modified;<\/span><\/li>\n
  2. All tasks and variables, if any, are automatically associated with this default namespace;<\/span><\/li>\n
  3. You can define and manage namespaces;<\/span><\/li>\n
  4. You can add or remove the Environment and Content variables to these namespaces. A variable can belong to one or more namespaces. You cannot remove the Environment and Content variables from the default namespace.<\/span><\/li>\n
  5. You can map namespaces to the various components of the bot definition like:<\/span><\/li>\n
      \n
    1. Tasks which include Dialog, and Alert;<\/span><\/li>\n
    2. Nodes in Dialog Task;<\/span><\/li>\n
    3. Knowledge Task;<\/span><\/li>\n
    4. Small Talk;<\/span><\/li>\n
    5. Standard Responses; and<\/span><\/li>\n
    6. Event Handlers.<\/span><\/li>\n<\/ol>\n
    7. You can remove the namespace mapping for the components. But if you mapped components with any namespace, then the execution of these components may fail if you have included one or more variables in defining the component.<\/span><\/li>\n<\/ol>\n

      Once Variable Namespaces are mapped, the following steps are implemented by the platform during task execution :<\/span><\/p>\n

        \n
      1. only the variables that belong to the namespace mapped to a component will be loaded;<\/span><\/li>\n
      2. if the variable that is not mapped is referenced by the component, it will flag a \u201c<\/span>variable not found<\/span><\/em>\u201d error;<\/span><\/li>\n
      3. the same logic applies to Bot functions used within the tasks.<\/span><\/li>\n<\/ol>\n
        <\/div><\/div>\n

        Creating Namespaces<\/span><\/span><\/h1>\n

        When configuring a variable (environment or content), you have an option to <\/span>Add Namespace<\/strong>. Use this option to create a namespace.<\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        <\/div><\/div>\n

        Editing<\/span><\/span><\/h1>\n

        You also have an option <\/span>to Manage Namespaces <\/strong>from under <\/span>Build > Configurations > Environment\/Content Variables<\/strong>.<\/span>
        <\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        Use this option to <\/span>view, edit,<\/strong> or <\/span>delete<\/strong> namespaces. Deleting a namespace that is mapped to any component is restricted. You need to unmap the namespace from all associated components before deletion. As mentioned earlier, you cannot delete the default namespace.<\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        <\/div><\/div>\n

        Variable Mapping<\/span><\/span><\/h2>\n

        Once created, the namespace needs to be mapped to variables, tasks, and other components. This will ensure that only the variables that belong to the namespace mapped to a component would be loaded at the time of execution.<\/span><\/p>\n

        At the time of variable creation (environment and content), you can map the namespace. By default, the variables would be assigned to the <\/span>default<\/strong> namespace. A variable can be mapped to multiple namespaces. You can change the mapping later by editing the variable definition.<\/span>
        <\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        <\/div><\/div>\n

        Components<\/span><\/span><\/h2>\n

        All the components have a <\/span>Manage Variable Namespaces<\/strong> action item which can be used to map the component with a particular namespace. Below is a list of places where you can find the <\/span>Manage Variable Namespaces<\/strong> option:<\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        \u00a0<\/p>\n

        Nodes within Dialog Tasks<\/span><\/span><\/h3>\n

        You can find the option under the Component Properties section of the node. You can choose to use the Variable Namespace associated with the task or customize it for the node.\u00a0<\/span><\/p>\n

        \"\"<\/a><\/p>\n

        Knowledge Graph<\/span><\/span><\/h3>\n

        Conversation Skills > Knowledge Graph > More Options<\/strong> menu.<\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        Small Talk<\/span><\/span><\/h3>\n

        Conversation Skills > Small Talk > Group Settings<\/strong> icon.<\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        Event Handlers<\/span><\/span><\/h3>\n

        Intelligence > Event > More Options<\/strong> menu.<\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

        Chances are that you have defined tens or hundreds of (Environment or Content) variables and used them in the VA definitions. These variables could have been used in defining text prompts or messages, JavaScript, transitions, and service call definitions. Loading all these variables for every single task irrespective of their usage would lead to delays…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[21],"tags":[],"class_list":["post-24824","post","type-post","status-publish","format-standard","hentry","category-bot-management"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24824","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=24824"}],"version-history":[{"count":6,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24824\/revisions"}],"predecessor-version":[{"id":47174,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24824\/revisions\/47174"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=24824"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=24824"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=24824"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}