...
Introduction:
Makes chatbot menu options configurable so it can easy to maintain without a dev engineer. So we can add/edit existing menu options.
...
Status
...
| Status | ||
|---|---|---|
|
...
Owner
...
...
Contributors
...
...
Approved
...
| Status | ||||
|---|---|---|---|---|
|
...
Decision
...
| Status | ||||
|---|---|---|---|---|
|
...
It has the following advantages:
It will help with a faster deployment process.
Quick change based on the requirement and easy to deploy.
Any time/ anyone(authorized) / any flow/menu text can change quickly.
Add/Edit change the text for Menu options.
Problem statement:
As a solution owner, I would want to deploy menu options faster without having to depend on a release on both portal and WhatsApp with the following details -
Able to change the text
Able to change the menu options (Add/edit/remove)
Able to create new flows/structure such as introducing new menu options which are not there
Able to change answers to queries
Able to add/edit/remove hyperlinks
Able to analyze the data after changes
💡 Research insights
It takes place for any owner can change the menu-driven flow for the chatbot and its full flex change any time without doing code change in a git repository.
📊 Solution hypothesis
It will help with a faster deployment process.
Quick change based on the requirement and easy to deploy.
Any time/ anyone / any flow/menu text can change quickly.
Add/Edit change the text for Menu options.
🌈 Design solutions
...
Solution 1
...
Solution 2
...
Overview
Using AWS container
Enable load and execute config from was container for chatbot.
...
Key Design Problems:
How to upload a local file to blob storage.
Versioning and rollback for files.
Secure (Only authorized users can access)
Design solutions:
Solution 1:
Using Jenkins job where we can upload a file while build and deploy of the job.
...
Download and upload files from blob through Jenkins with the following process
Only the owner/authorized user can log in to Jenkins.
Using Jenkins azure plugins we can parameterize the build.
We can choose which file from local and upload in specified blob storage.
Build a chatbot with a new configuration.
Upload artifact and deploy.
Pros:
Easy to maintain, add, and modify any time Menu options and query answers just by uploading the JSON object.
We can keep/maintaining all versions of files.
It will help to revert back to the old version of files if something went wrong with the new version of files.
It's secure since the only authorized user can upload and download.
Solution 2:
Create a separate application for accessing and modifying the file.
User onboard via API(backend)
Share credentials with user
For creating the files in a blob it requires azure services keys.
...
Pros:
Easy to create and update config JSON using API’s
| Code Block |
|---|
Create
{{host}}/chatbot/config/create
Update
{{host}}/chatbot/config/update |
For every new update, it will create a new file with a version number.
Easy to roll back to the older version.
Since it is a login based app so only an authorized person only can do.
Chatbot download/update configurations and build process:
Enable load and execute config from AZURE container for a chatbot.
Make literals and chart flow configurable.
Keep files in blob storage public accessible.
While doing a build for chatbot/router run the below commands in
...
the docker file
Code Block FROM node:10.19.0 as builder WORKDIR /app COPY . /app ADD http://source.file/config/literals /config/literals.js ADD http://source.file/config/chatflow /config/chatflow.js RUN npm install FROM node:10.19-slim COPY --from=builder /app . EXPOSE 4000 8443 CMD [ "node", "appRest.js" ]For every build, it will download it from the blob and add it
/router/config/*files.So now we can change
...
only those required files and do build and deploy
...
Using API (DB)
Store config in Database to fetch and update config. It all using API’s to create and update config using JSON object as request body.
| Code Block |
|---|
Create
{{host}}/chatbot/config/create
Update
{{host}}/chatbot/config/update |
This will take place in jenkins job,
Any owner can update config
...
Link
...
https://project-sunbird.atlassian.net/browse/SB-21295
...
Benefits and risks
...
Easy to maintain, add and modify any time Menu options and query answers.
Now its configurable from outside chatbot so its more easier to deploy.
Below requirements will satisfy.
Able to change the text
Able to change the menu options (Add/edit/remove)
Able to create new flows/structure such as introducing new menu options which are not there
Able to change answers to queries
Able to add/edit/remove hyper links
Able to analyse the data after changes
We can keep/maintaing all versions of files
It will help to revert back the old version of files if something went wrong with new version of files.
Only tech guys can do upload an
Easy to create and update using API’s
Jenkins job to read and update config using API’s.
non tech guys can easy update using API
Can't revert back to old version config.
Difficult to maintain versionsing of files.
✅ Follow up
Keep track of the discussion with the following status and steps.
...
Decision
...
Status
...
Next steps
...
https://project-sunbird.atlassian.net/browse/SB-21488
...
| Status | ||||
|---|---|---|---|---|
|
- POC
- Discussion with DC
- Implementation
- Verify