Creating a Skill for VPN access
Problem Statement: Off-Campus/On Campus students request secured VPN Access to the classes for University. There is an unexpected heavy reliance on online classes due to the pandemic. It made a large number of people to look for related information on procuring the secured VPN access and write an email to the concerned team.
Opportunity: All the required information for providing VPN access is collected from the bot. The bot automatically sends the request to the concerned team for processing the VPN access request.
Approach: Bot will have access to a class skill that collects all the required information like University ID, email id, contact numbers to reach and calls the send-grid API that sends an email to the concerned team to process the VPN access request from the collected details.
Let's understand how to build this Skill.
Define Attribute
Create an attribute Requested user to get the name of the student or employee who is seeking a VPN access
On Skill Builder--> Attribute tab, click on Create Attribute.
Add attribute details such as Name and Data type.
Set the prompt message to be displayed to the end-user, like “Raise this request on behalf of “
Click Save.
Follow the above steps and create the below attributes:
‘Mail_ID’ to store the email id of the requester
‘Description’ to store a brief description of the request
‘Summary’ to store summary details about the requester such as Class, Section, Department
‘Yes_no’ to collect whether the requester has a University ID or do not have
‘UVID’ to store the University ID of the requester.
‘Access’ to collect the type of required access such as Student Use, Employee Use, Campus access - For Student use, Special access- For Employee use, etc.
Phone Number to store the contact number of the requester for communication.
Preferred contact time to collect preferred time to contact like morning (8 am-11 am), evening(6 pm-8 pm)
Contact Instructions to capture any additional instructions from the requester.
Location to store whether the requester is On-campus or Off-Campus
Create an Integration
Define Integration to Send-grid API with the “Send mail” operation. The integration will send an email to the concerned team to process the VPN access request with the required details.
On the tenant menu, click on Integration.
Create an Application with the integration type as REST.
Add an instance to the Send-grid environment.
Configure the ‘Send mail’ Operation.
Build a Skill
On Skill Builder--> Create Skill tab, enter Skill details such as Skill Name, Category, Description, and KPI Metrics
Under Invocation type, add User Phrases such as ‘I request access to the class,’ ‘VPN access to the class.’
Under Conversation flow,
Add the attribute Requested user.
Add the attribute Mail_ID
Add the attribute Description to store a brief description of the request.
Add the attribute Summary.
Add the attribute Yes_no
Add a Ruleset to check whether the requester has a valid ID. Configure the following rules.
If Yes_no equal to No, set the UVID to Not applicable and continue
Add the attribute UVID to store the University ID of the requester.
Add the attribute Access to collect the type of required access such as Student Use, Employee Use, Campus access - For Student use, Special access- For Employee use, etc.
Add the attribute Phone Number to store the contact number of the requester for communication.
Add the attribute Preferred contact time to collect preferred time to contact like morning (8 am-11 am), evening(6 pm-8 pm)
Add the attribute Contact Instructions to capture any additional instructions from the requester.
Add the attribute Location to store whether the requester is On-campus or Off-Campus.
Add the Integration operation Send mail to send a confirmation message.
Override the operation and pass the attributes Requested user, Mail_ID, Description, Summary, Yes_no, UVID, Access, Phone Number, Preferred contact time, Contact Instructions, Location to the Operation in the Outbound payload
Add Information Message to be sent to the requester such as “Thanks - your request has been forwarded”.
Click Save to finish building the skill.
The next step is to add permission to the skill. Click on Permission and the Users or Groups who should be able to execute the Skill.
Run Build and Publish to make the skill available in the Virtual Agent.
Once the skill is Published, Go to the Test Widget to test the skill. Click on Debug Logs and execute the skill to view the runtime Skill execution logs.
Your skill is now ready to use. Go to Conversation History to view the list of conversations where the end-user requested the skill.
Below is the sample skill definition. Note that the integration details should be replaced with your organization-specific instance details.
Additional Resources
Visit the below Wiki Documentation for more information on:
Creating an Attribute on Create Global Attributes
Configure a 3rd party Web service integration on REST Integrations
Creating and Managing Skills is at Create Skills
Using local attribute in skills on Use Variables in Skills
Publishing Skill on Build and Publish
Understanding Conversation logs on Conversation History.
Provide permissions to users or groups at Permission
Defining Rulesets on Using Rule Sets
Test your Skill on Test your Bot
Debugging skill on Debug Skills