When creating new requests, follow the best practices below to assist the efficient issue resolution.
General rule: when in doubt, use your best judgment.
Write an Informative Request Title
Many requests are managed and assigned by the request title. Therefore, using a descriptive summary is highly advised as long as it is written in a concise manner. For example, instead of "DQA: Drill through doesn't work", say "DQA: Drill-through cannot write Boolean using ODBC to MSSQL".
Send in the Exception Text
In the process of reporting a request, thrown exceptions are of great value. For cases when an unexpected runtime action occurs, or the runtime crashes entirely, simply locate the thrown exception and copy/paste it into your request description.
If the GUI does not perform as you expect, check the Error Log view in the Status Panel. It is hidden by default, but experienced users are advised to activate this feature in the menu: Window > Show view > Other… > General > Error Log. Double-click on an issue to open the window where you can view and copy the exception text.
If the runtime in GUI crashes or reports any [FATAL] message or Profiling Drill-through fails with a [WARN] message, a run report appears in the Run Results view of the Status Panel. If it is not visible, activate the feature in Window > Show view > Other… > Ataccama DQC > Run Results. Double-click on an issue to open the window where you can view and copy the exception text.
Send in Plans and Data Files
We encourage you to share any created plans or data files with us. Scenario description is necessary, but plans and data help us reproduce your issue – we will verify the fix to confirm the issue no longer exists. If you prefer, we can also edit and extend the plan for you instead of describing what you should change.
Uploaded data is stored behind the Ataccama firewall on internally hosted servers.
Share Your Environment Details
Inform us about all the environment variables you can. Applicable questions typically include the following:
- Which version of Java was used to run DQC?
- Which OS was used and on which OS is the database running?
Which driver was used to connect to the database?
- Exactly which database version was used?
- Which product version was used?
Tell the Story
Describing the story of your task helps us in two ways.
First, we receive a more thorough description of the request priority (not simply priority set to critical), which helps with timing: we will know whether the solution is required for a presentation next week or as a quick response because of a customer call this afternoon.
Second, an alternate solution might exist. Knowing your goal instead of what is not working for you may lead to a more efficient solution.