{"sections":[{"heading":"Include the evidence needed to reproduce","steps":["State the tool, version/build, numerical-engine version where relevant, OS and CPU architecture.","Give the intended task, exact steps or command, first error and whether it occurs at launch, licensing, input parsing, meshing, solving or export.","Include the current run log and settings relevant to that stage. State whether a supplied example succeeds.","Prefer the smallest redistributable input that reproduces the issue. Keep required process/include files together when they can be shared.","For numerical differences, give units, compared quantities, input versions and refinement evidence rather than only a screenshot of the final number."]},{"heading":"Review before sending","paragraphs":["Remove passwords, licence keys, session tokens, proxy credentials, unrelated personal data and confidential customer/process information. System IDs and licence-related diagnostics should go only through private support when requested.","A report may remain unresolved when its attachment or exact version is unavailable. The knowledge base labels these gaps instead of presenting an untested workaround as a solution."]},{"heading":"Distinguish a selected archive from a portable calculation","paragraphs":["In the checked InductEx 8 Studio candidate, Support Bundle copies selected saved files rather than unsaved editor text. Its generated reports include licence-status metadata, and selected raw files keep their exact content. Review all members before sharing; switching source-file copying off is not automatic anonymisation.","The support archive also gives copied documents prefixed names without rewriting their internal references. Use the related portable calculation-record guide when you need a complete runnable input hierarchy and a checked fresh rerun. These are InductEx-specific scoped observations, not a claim about every product’s archive format."]}],"canonical_url":"https://www.sun-magnetics.com/knowledge-base/support-effective-report","url":"/knowledge-base/support-effective-report","known_issues":[],"search_record":{"execution":false,"relatedProducts":[],"version_tags":["Release-specific"],"text":"Prepare a useful support report without exposing a licence or private design Include the first error, exact environment and a minimal reproducible example. Review logs and bundles before sharing them privately. General support Include exact client and engine versions How to Include the evidence needed to reproduce State the tool, version/build, numerical-engine version where relevant, OS and CPU architecture. Give the intended task, exact steps or command, first error and whether it occurs at launch, licensing, input parsing, meshing, solving or export. Include the current run log and settings relevant to that stage. State whether a supplied example succeeds. Prefer the smallest redistributable input that reproduces the issue. Keep required process/include files together when they can be shared. For numerical differences, give units, compared quantities, input versions and refinement evidence rather than only a screenshot of the final number.  Review before sending Remove passwords, licence keys, session tokens, proxy credentials, unrelated personal data and confidential customer/process information. System IDs and licence-related diagnostics should go only through private support when requested. A report may remain unresolved when its attachment or exact version is unavailable. The knowledge base labels these gaps instead of presenting an untested workaround as a solution.  Distinguish a selected archive from a portable calculation In the checked InductEx 8 Studio candidate, Support Bundle copies selected saved files rather than unsaved editor text. Its generated reports include licence-status metadata, and selected raw files keep their exact content. Review all members before sharing; switching source-file copying off is not automatic anonymisation. The support archive also gives copied documents prefixed names without rewriting their internal references. Use the related portable calculation-record guide when you need a complete runnable input hierarchy and a checked fresh rerun. These are InductEx-specific scoped observations, not a claim about every product’s archive format. ","id":"support-effective-report","keywords":"","kind":"How to","title":"Prepare a useful support report without exposing a licence or private design","product":"General support"},"version":"Include exact client and engine versions","id":"support-effective-report","related":["/knowledge-base/inductex-missing-current-file","/knowledge-base/josim-singular-circuit","/knowledge-base/shared-daemon-starts-but-unlicensed","/knowledge-base/inductex-support-bundle","/knowledge-base/inductex-export-project","/knowledge-base/josim-autosave-recovery"],"downloads":[],"publication_status":"published","numerical_output":null,"provenance":{"execution_checks":[],"figure_evidence":[],"review_notes":["Support history informed this draft. Current-source guidance has been checked; a fresh walkthrough on the intended distributed release and product-owner review remain pending."],"scope":"Recorded inputs/builds only. Complete walkthrough and final-package acceptance remain separate.","verification_requirements":{"gui_method":"product-native scenario or recorded operator walkthrough; screenshots required for GUI guidance","status":"review-incomplete","illustrations":"required","required":["technical-review","release-applicability","gui-workflow","illustrations"],"legacy_walkthrough_field":"pending retained; not evidence of a complete scenario"},"sources":[{"id":"support:SUP-005","section":"Generalised editorial finding; outcome qualification retained"},{"id":"support:SUP-006","section":"Generalised editorial finding; outcome qualification retained"},{"id":"support:SUP-017","section":"Generalised editorial finding; outcome qualification retained"},{"id":"smlicensed:README.md","section":"Troubleshooting diagnostics"},{"id":"inductex:docs/manual/studio_results.tex","section":"Run summary and diagnostic artifacts"},{"id":"josim-pro:docs/manual_source/sections/troubleshooting.tex","section":"Runtime diagnostics"},{"id":"validation:support-records-windows-20261104","section":"VAL-034/VAL-035; scoped InductEx archive contents, privacy limits and separate runnable record"}]},"title":"Prepare a useful support report without exposing a licence or private design","type":"How to","markdown_url":"/_functions/kbResource?path=markdown%2Fsupport-effective-report.md","summary":"Include the first error, exact environment and a minimal reproducible example. Review logs and bundles before sharing them privately.","product":"General support"}