Guidelines
      Back to home
      1. biGENIUS-X Knowledge Base
      2. Getting Started
      3. Guidelines

      Save a developer, write a good bug report

      The bug will be resolved faster if you provide us with helpful information.

      Support ticket handlers and developers appreciate your effort not to give them (more) grey hair.

      Here's a checklist for a good bug report:

      1. Ticket subject
      2. Ticket description
        1. Expected vs. actual results
        2. Steps to reproduce
      3. Severity
      4. Summary
      5. Screenshots
      6. Implementation Package Configuration and Version
      7. Environment
      8. Logs

      Ticket subject

      The subject should be short but informative: This will help us navigate bug reports.

      Ticket description

      Describe the issue you encounter. Make sure to include the following points:

      Expected vs. actual results

      I think explaining what you expected to happen and what happened is essential. It helps us understand if it is the intended behavior of the product or an actual glitch.

      Steps to reproduce

      Please try to reproduce the bug before reporting it to us. Could you tell us if you can consistently reproduce the issue or if it only occurs occasionally? If you notice any patterns or trends, please mention them as well. Remember that the steps required to reproduce the bug may take time to be noticeable. Providing a clear and detailed guide with step-by-step instructions will significantly assist our developers in reproducing and resolving the issue.

      • Be specific:  Instead of "I created a Hub," say, "I created a Hub by using the wizard Create Hub from Stage" or "I created a Hub manually, added a Dataflow Set, and mapped the Business Key." 
      • You can use short sentences.
      • Be careful of pronouns, and make sure it's clear what they reference. Use names and nouns if possible.

      Severity

      Severity indicates the seriousness of the defect in the functionality or environment.

      • Low: No significant impact is expected.
      • Medium: It causes some undesirable behavior, but the overall system still works
      • High: It is a highly severe defect and collapses the system. However, certain parts of the system remain functional.
      • Critical: This defect indicates a complete process shutdown; nothing can proceed.

      Screenshots

      In general, screenshots can enhance our understanding of an issue.

      Implementation Package Configuration and Version

      Please send us information on your implementation package configuration and specify the version.

      You can find Generator information on the Project Settings:

      Environment

      Tell us on which kind of environment you are working:

      Which Web Explorer are you using?

      Is your source data local or remote?

      Is your target database local or remote?

      Logs

      Please include the relevant part of the Web Browser logs in the console.

      You can find them by clicking on F12 and displaying the Console tab:

      Then, do a right-click on the logline and choose Save as.

       

      *yes, we took this line from <https://marker.io/blog/write-bug-report>, it is just too good.