Use Botium Crawler to Create a Test Set

Create and maintain regression test sets by mapping out all conversation flows in your chatbot using Botium Crawler. This powerful tool detects quick replies and buttons, simulates clicks on each option, and follows paths until it reaches a set depth or encounters an open-ended question. This article guides you through the setup process.

1. Navigate Using the Left Pane: On the left navigation pane, locate Botium Tools & Settings in the menu and select Test Data Wizard .
2. Crawler Wizard: Select the Crawler Wizard from the list of options on the page.
   
   
3. Project Name: Choose an appropriate name and enter it as the project name.
4. Namespace: This step is optional
   Tip: Botium Namespaces allow you to group together Test Projects, Test Results, Test Sets, Chatbots and Crawler Projects under one common namespace. This is particularly useful for testing multiple chatbot implementations across different brands or product offerings that your business might have.
5. Connect to Chatbot: Select the Bot you wish to run the crawler session on. The dropdown menu provides a list of all the bots you have connected to your Botium account.
6. Conversation Entrypoints: This step is optional - These are the messages that the crawler uses to start the conversations. By default the crawler is going to start with hello and help entry points.
   Tip: If the chatbot has automatic welcome messages, those will be used as entry points unless you specify more with the Number of Welcome Messages parameter in the next step.

   Note: For each start message that you include in your Crawler Project, parallel jobs will be started with each message to begin the crawl.
7. Number of Welcome Messages: This step is optional - Some chatbots initiate the conversation without user interaction. In this case, you need to specify how many welcome messages will be sent by the bot.
   Note: If you don’t have a start message, the crawler will try to find quick replies and buttons in the welcome messages and start the conversations from there.
8. Create Project: Click Create Crawler Project to build the project. You will then be taken to the 'Execution' tab
   
   
9. Execution: Next you will be taken to the Execution tab where you can verify your entries and set further Advanced criteria before running the crawler. All of these settings are optional.
   Tip: At this point it is considered best practice to set the 'Wait for Chatbot Messages' response time to a minimum of 500ms to ensure that you capture your bots responses successfully.
   • Maximum Conversation Depth: This is the depth of the conversation in the conversation flow . This is set to five by default.(One depth is a user-bot message pair.)
   • Generate Utterances Lists: Botium will generate Utterance Lists for each conversation step (recommended)
   • Merge Utterance Lists and User Examples: All text messages are saved as utterances. The crawler can recognize non-unique utterances and merge them into a single utterance.
   • Exit Criteria: If the text or payload of any quick reply or button matches any of the exit criteria, the conversation is stopped and marked as successfully ended.
   • Ignore Buttons: Ignore any buttons where the text or payload match any of the specified ignore button expressions.
   • Botium Agent: If you have Botium Agents installed and connected to Botium, you can select a specific agent here on which to run the crawler jobs.
10. Save: To save your crawler configuration, click the SAVE button.
11. Start First Crawler Session: To begin crawling, first click the OVERVIEW button at the top of the page and then click the START FIRST CRAWLER SESSION button.
    
    
    Note: The crawler will now begin crawling through your bot. While the crawler is running, it will be indicated in the top left corner of the screen. Each Convo and utterance will appear underneath as they become available.
    
    
12. Copy to Test Set: Once complete, click the COPY TEST SCRIPTS INTO TEST SET button to create a new test set or add to an existing test set.
    
    
    1. Select Test Set: Choose 'Register new Test Set'. This will instruct Botium to create a new test set.
       Note: You can also choose to add the scripts to an existing test set but the steps for this are slightly different. Those steps are covered in the article Use Botium Crawler to Update a Test Set.
    2. Set Test Name: Give you new test set a name.
    3. Choose to Create a New Test Project: At this point, you can toggle the switch to decide if you want to create a test project using the crawler results. This will instruct Botium to create a new project using the generated test set.
    4. Copy Test Scripts: To finish you can choose to COPY TEST SCRIPTS or COPY TEST SCRIPTS AND OPEN TEST SET.
    Tip: Both of these options will save your test cases to your new test set but the latter will open the test set directly so you can continue to add more test cases.