​

Scripts Platform

• How to create a plug?
• How to set and use the parameters?
• How to Edit/Delete the Plug?
• How to add Plugs to the Codeless bot builder?

How to create plugs using the Scripts platform?

The Scripts is a platform that uses Deluge or Data Enriched Language for Universal Grid Environment as its online scripting language. Deluge is deemed to be robust and easy to use because of its user-friendly syntax. The deluge script builder offers a drag-drop user interface, thus leaving out the task of remembering deluge syntax and functions for the user. Furthermore, deluge offers a connection interface to make third-party integration easy. Let's break down the steps to create a plug using the script platform. 

Set up a profile:

• In the SalesIQ dashboard, navigate to Settings > Developers > Plugs.
• Inside the Plugs dashboard, click Add.

• Give your Plug a name, add a description, and choose the platform as Scripts. 
• Finally, click on Create Plug. You will be redirected to the selected plug builder. 

​

Define parameters:

• The first step in creating plugs is defining the input and output parameters and their data types.
• Provide a name and select their datatypes. To add more parameters, click on Add. 

Note:  Learn how to set and use these parameters inside the plug builder. 

​​

• The input parameters are from the codeless bot builder to do an action/function. Once the action is completed, the values are to be sent to the codeless bot as an output parameter. For example, to schedule a booking, we need the visitor's name, email, phone, date & time (input parameters). After the booking is completed, we can send the booking ID (output parameter) as a reference to the visitor. 
• Then, click on Save.

Plug logic:

• Provide/write the logic for the plug. If you're looking to integrate your plug with any external applications, use the connection interface to perform API calls. 

Test and Publish:

•  Click on Test to preview the Plug, and finally, click on Publish. 
• Only published plugs will be listed in the codeless bot builder. 

• Once the plug is executed, the desired output will be displayed as a response. This will be sent to the codeless bot builder. Here, the booking ID will be sent to the codeless bot builder and then to the visitors. 

How to set and use the parameters?

Once the input and output parameters are set, the values of the input parameters can be fetched in the session object. To understand this, let's take an example of scheduling an appointment in Zoho bookings. 

Fetch the inputs inside the plug:

• To schedule an appointment in Zoho bookings, we need the visitors' names, email, phone, and date & time as the plug input. 

• These inputs can be fetched inside the builder via the session object using the below syntax.

//Calling the input parameters
name = session.get("name").get("value");
email = session.get("email").get("value");
phone_number = session.get("phone").get("value");
datetime = session.get("datetime").get("value");

• Then write the plug logic to schedule an appointment. Refer to the below scripts to schedule bookings in Zoho bookings. 

//create appointment in Zoho bookings API
customerDetails = Map();
customerDetails.put("name",name);
customerDetails.put("email",email);
customerDetails.put("phone_number",phone_number);
//Variable the store the success JSON output of scheduling an appointment in Zoho Bookings
create_booking = zoho.bookings.createAppointment(service_id,changed_formate_datetime,customerDetails,staff_id,"Asia/Calcutta",true,"zohobookings");

Set the required data as output:

• Store the success response in a variable (create_booking).
• Then get the booking id from the response and set it as the output parameter "booking_id" in the plug's response.

Note: Map the output variable with the output parameter in the "Parameters". The output value (bookingid) will be passed to the codeless bot builder. 

• Then, Save, test the plug, and Publish it to be listed in the Codeless bot. 

Sample Plug Script to schedule appointments in Zoho bookings

response = Map();
name = "";
phone = "";
email = "";
datetime = "";
//The service_id and staff_id of Zoho Bookings
service_id = "4302354000000026055";
staff_id = "4302354000000026017";
//Calling the input parameters
name = session.get("name").get("value");
email = session.get("email").get("value");
phone_number = session.get("phone").get("value");
datetime = session.get("datetime").get("value");
//Changing the datetime format
change_format = datetime.get("date_time").replaceFirst("T",",");
changed_formate_datetime = toTime(change_format,"yyyy-MM-dd,HH:mm");
//create appointment in Zoho bookings API
customerDetails = Map();
customerDetails.put("name",name);
customerDetails.put("email",email);
customerDetails.put("phone_number",phone_number);
//Variable the store the success JSON output of scheduling an appointment in Zoho Bookings
create_booking = zoho.bookings.createAppointment(service_id,changed_formate_datetime,customerDetails,staff_id,"Asia/Calcutta",true,"zohobookings");
info create_booking;
booking_id = create_booking.get("response").get("returnvalue").get("booking_id");
info bookingid;
response = Map();
response.put("bookingid",booking_id);
return response;

To know more about the Zoho bookings plug, visit our plug templates here. 

How to Edit/Delete the Plug?

Edit the Plug:

• To edit the plug, navigate to Settings > Developers > Plugs. All your existing plugs will be listed here. 

• Click on the plug you would like to edit.
• Then, click Configure profile to edit the plugs' name and description. 

• To edit the plugs' code/script, Edit code, and you will be directed to the scripts platform.

Delete/Disable the Plug:

• To delete the plug, navigate to Settings > Developers > Plugs. All your existing widgets will be listed here. 
• To delete the plug, hover over the plug, and the delete icon will appear.
• Toggle on the widget at the right to disable it.

​

How to add Plugs to the Codeless bot builder?

• In your Codeless bot builder, select the Plug block under Action Cards. 

• Then, select the plug you want to add to the bot's flow. ​​
• Next, provide the input parameters (Default value/bot context) for plug execution. 

Note: Only published plugs are listed here.

• A static value can also be given as the plug input. Type the required value in the search box and click on the Set value. 

• In the above reference, a static value "Website Bot" is declared for the Source plug. 

• ​Next, provide a bot context to store the output of the plug and use it on the further block to display it to the visitor. 
• Finally, click on Save.
• The plug will have a success and failure leg. Add cards to handle both cases. 

Note: If the plug takes more than 15 seconds to execute, the failure leg will get triggered in the Codeless bot builder platform. 

• The above reference is a plug to schedule an appointment using Zoho booking. The "bookingid" is one of the outputs from the plug, which returns the booking ID of the appointment.
• It is stored in a bot context "visitor.booking.id" and used in an end card to display the booking ID to the visitor, as shown in the reference below.