{"id":18057,"date":"2018-07-23T10:01:47","date_gmt":"2018-07-23T10:01:47","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15099"},"modified":"2022-10-03T09:23:50","modified_gmt":"2022-10-03T08:23:50","slug":"reusing-bot-functions-custom-script-file","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-settings\/bot-functions\/reusing-bot-functions-custom-script-file\/","title":{"rendered":"Bot Functions"},"content":{"rendered":"

Bot Functions is a feature that uses a custom Script file that enables you to collate and manage reusable utility JavaScript functions that can be used by different tasks, nodes, and other elements. Once you upload a custom script file to the assistant, it reduces the redundant development efforts by making all the functions in the file accessible anywhere in the assistant.<\/span><\/p>\n

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

Using the Custom Script File<\/span><\/span><\/h1>\n

Let\u2019s consider one use case from a Travel Planning Assistant, to understand how you can leverage the custom script file to reduce development overhead considerably. Take a look at the following conversation flow of this assistant, that frequently presents customers with options to make a choice. In the below chat, the assistant first prompts the user to select what they want to book, by clicking Flight or Hotel, and then also prompts them to select a Fare, such as Economy, Premium Economy or First Class.\u00a0<\/span><\/p>\n

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

You can observe that both the booking and fare options in the above chat are identical in functionality, but only the choices that they show differ. Instead of hard-coding the functionality of the button template into each node, you can write a function in the custom script file that can be invoked by these nodes by passing options. Below is the sample function script to accomplish the functionality.<\/span><\/p>\n

function custTemplatel(info){
var message = {
\"type\": \"template\",
\"payload\": {
\"template_type\": \"button\",
\"text\": \"Select an option\",
\"subText\": \"3utton Template
\"buttons\": []}
};
for (i = 0; i < info.length; i++)
var button = {
\"type\": \"postback\", 
\"title\": info[i], 
\"payload\": \"payloadl\"
):
message.payload.buttons.push(button);
}
return JSON.stringify(message);
}
<\/span><\/p>\r\n<\/pre>\n
This is how the function can be called from the nodes:<\/span><\/p>\n
var info =[\"Flight\",\"Hotel\"]; 
print(custTemplatel(info));|
<\/span><\/p><\/pre>\n
<\/div><\/div>\n
Uploading a Custom Script File<\/span><\/span><\/h1>\n
Follow these steps to upload the script file to the assistant:<\/span><\/p>\n
    \n
  1. Select the <\/span>Build<\/strong> tab from the top menu<\/span><\/li>\n
  2. From the left menu, select <\/span>Configurations > Bot Functions<\/strong><\/li>\n
  3. Under <\/span>Custom Script<\/strong>, click <\/span>Import<\/strong>.<\/span><\/li>\n
  4. On the <\/span>Import Custom Script<\/span><\/em> dialog, click <\/span>Browse <\/strong>and navigate to the script file in your local machine. Click <\/span>Import<\/strong>.<\/span><\/li>\n
  5. After the import is successful, click <\/span>Done<\/strong>.<\/span><\/li>\n<\/ol>\n
    \"\"<\/a><\/span><\/p>\n
    <\/div><\/div>\n
    Updating the Custom Script File<\/span><\/span><\/h1>\n
    You can add or modify functions in the custom script file by downloading the file, making changes, and then importing it back to the assistant. Importing a new custom script file <\/span>replaces <\/span>the existing file, which cannot be retrieved later. Therefore, we recommend you exercise caution and keep a copy of the downloaded file for backup.<\/span><\/p>\n
      \n
    1. Select the <\/span>Build<\/strong> tab from the top menu.<\/span><\/li>\n
    2. From the left menu, select <\/span>Configurations > Bot Functions.<\/strong><\/li>\n
    3. Under the <\/span>Custom Script<\/strong>, click <\/span>Download<\/strong> to save a copy of the file on your local computer.<\/span><\/li>\n
    4. After you make changes to the file, click <\/span>Import New<\/strong>.<\/span><\/li>\n
    5. Click <\/span>Browse <\/strong>to the location of the custom script file on your local computer and then click <\/span>Import<\/strong>.<\/span><\/li>\n
    6. Click <\/span>Done <\/strong>when the import is complete.<\/span><\/li>\n<\/ol>\n
      <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
      Bot Functions is a feature that uses a custom Script file that enables you to collate and manage reusable utility JavaScript functions that can be used by different tasks, nodes, and other elements. Once you upload a custom script file to the assistant, it reduces the redundant development efforts by making all the functions in…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[20],"tags":[],"class_list":["post-18057","post","type-post","status-publish","format-standard","hentry","category-bot-functions"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18057","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=18057"}],"version-history":[{"count":7,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18057\/revisions"}],"predecessor-version":[{"id":47191,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18057\/revisions\/47191"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18057"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18057"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18057"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}