- 3.4.2 Functional Specifications
- Accessing the URL Module
- Description: Users can access the URL module through multiple pathways:
- Sidebar Navigation: Click on Bot Space -> Knowledge Hub -> URL from the sidebar menu.
- Quick Menu Access: Utilize the quick menu on the home screen for direct access to the URL module.
- Adding a Website URL
- Description: Users can add their website URLs to be used as knowledge sources for bot training.
- Functionalities:
- Single URL Addition: Currently, the system supports adding one website URL at a time.
- Post-URL Addition Options: After adding a valid website URL, the system prompts users to choose between:
- Automatic Sitemap Generation: The system scans the provided website URL and generates a sitemap by identifying all accessible URLs.
- Manual URL Addition: Users manually add specific sub-URLs from their website to be included in the knowledge base.
- Business Rules & Validations:
- URL Validation:
- Required Field: The website URL field is mandatory.
- Validation: The system verifies that the entered URL is in a valid format.
- Error Handling: If an invalid URL is entered, an error message is displayed prompting the user to enter a valid URL.
- Sitemap Generation:
- Automatic Generation:
- Description: The system automatically scans the provided website URL to generate a sitemap by identifying and collecting all accessible sub-URLs.
- Business Rules & Validations:
- URL Limit: Automatic sitemap generation is restricted to a maximum of 5,000 URLs per website.
- Error Handling: If the website contains more than 5,000 URLs, an error message is displayed indicating that the limit has been exceeded.
- Regeneration Capability:
- Description: Users can regenerate the sitemap by clicking the “Resync” button, initiating a fresh scan of the website to update the sitemap.
- Manual URL Addition:
- Description: Users can manually add specific sub-URLs from their website to include in the bot’s knowledge base.
- Business Rules & Validations:
- Domain Consistency: All manually added sub-URLs must belong to the same domain as the primary website URL.
- Validation: The system checks that each sub-URL is a valid URL and belongs to the specified domain.
- Error Handling: If a sub-URL does not match the primary domain or is invalid, an error message is displayed prompting the user to correct the entry.
- Automatic Generation:
- URL Validation:
- URL Management
- Description: Users can manage their added URLs through functionalities such as deleting URLs, viewing detailed URL listings, and activating or deactivating specific URLs.
- Functionalities:
- Delete URLs:
- Description: Users can delete individual URLs from the listing.
- Usage: Click the “Delete” button associated with the desired URL and confirm the deletion action.
- View URL Listings:
- Description: Users can view all URLs associated with the main website by clicking on an individual URL from the listing.
- Usage: Click on a specific URL to expand and view all sub-URLs under the main website.
- Activate/Deactivate URLs:
- Description: Users can toggle the activation status of individual URLs.
- Usage: Click the “Activate/Deactivate” button next to the desired URL.
- Implications:
- Active URLs: These URLs are used to train the bot, enhancing its response capabilities.
- Inactive URLs: These URLs are excluded from bot training and will not influence the bot’s behavior.
- Delete URLs:
- Accessing the URL Module
Functional Specifications
Updated on August 26, 2025
devdocs