Bug report format
This guide is intended to provide additional clarification on the correct procedure for creating a Bug Report. Properly creating a Bug Report, using predefined templates and formats designated for this type of request, is crucial to ensure the user's requirements are fully understood. This, in turn, accelerates the development process for the fix and eliminates potential misunderstandings or misinterpretations of the report.
NOTE: Each bug report should focus on a single, specific issue. Avoid combining multiple issues or bugs into one request, as this can complicate prioritization and issue resolution process. This approach ensures clarity, better tracking, and more efficient handling of bug reports.
For these reasons, we kindly ask that, when creating a Bug Report, you complete all required sections and provide all the necessary information currently available to you.
If you have already created a Support Ticket and the format of your request is not properly completed, there is no need to open a new ticket. Instead, simply update the existing ticket by accessing it on the Bicom Systems Technical Support Portal, navigating to the Properties section, and updating the Type to 'Bug report.'
Once updated, you will receive a prompt with new sections that need to be carefully filled out, especially those marked as mandatory. Please complete the following fields on your Support Ticket as thoroughly and accurately as possible, or provide the information in a regular reply to the ticket so that the Support Engineer can update the ticket fields.
1. When did the issue start happening? (mandatory)
Specify the date and time when the issue was first observed. If the exact timing is unknown, provide an approximate timeframe.
Example:
This issue was observed recently during client configuration tasks.
2. How to replicate the issue? (mandatory)
Describe the steps required to reproduce the issue. Be as detailed as possible to help identify the problem.
Example:
1. Navigate to the PBXware management interface.
2. Create a new Ring Group.
3 .Set the number for the Ring Group to 800.
4. Observe that the system does not validate the number 800 as it should, despite it being assigned to the Enhanced Callpark Feature Code.
3. What is the expected behavior? (mandatory)
Explain how the system should function under normal circumstances, compared to the issue being experienced.
Example:
The system should validate the Feature Code 800 and prevent it from being used in other configurations such as Ring Groups, IVRs, or Queues.
4. Which services are impacted by this issue?
List the specific services or functionalities affected by the issue, such as calls, messaging, recordings, etc.
Example:
Call handling
5. How does this issue impact your business?
Describe the consequences of the issue for your business, such as downtime, financial losses, or reduced efficiency.
Example:
This issue can lead to misconfigurations, causing confusion for administrators and impacting the reliability of client setups. It increases the risk of conflicts between Ring Groups and Feature Codes.
6. Select product (mandatory)
Choose the specific product this bug relates to. Further, please mention the operating system(s) where this feature will be used, such as Windows, macOS, or Linux, and provide the version number of the product you are currently using, same as the additional information if required about the license, edition and access to the system.
Example:
PBXware, LICNUM123, PBXwaresystem.com, v7.x