Report a problem

Copy the panel's short report, save a masked debug bundle, check what is in it, and fill in the issue form.

Something in the panel is wrong, missing or confusing. A good write-up lets the developer reproduce it without a round of questions. It needs four things: the version, the package flavour, a short text the panel writes for you, and a debug bundle with your data masked.

Before you start

1. Turn on Mask values in the top bar. While it is on, everything that leaves the panel has its strings and numbers replaced with placeholders. Keys, structure, element names and step names stay. It is off when DevTools opens unless Mask values at start is ticked in Settings, so check it every time. See Mask values.
2. Get the panel into the state where the problem shows: the right tab, the right step, the call selected.

Copy the report

1. Open Settings: the gear in the top bar, or press ,. The Tools row has Copy report, Save a debug bundle and Open bundle….
2. Press Copy report. It puts a few lines of Markdown on the clipboard: the script, the extension version, the step it is on, the size of the data, the number of Problems, what may stop Next on that step and the last five failed calls with their reasons. A line whose fact is not known is left out. Nothing is sent anywhere. See Copy report.

Save a debug bundle

1. In the Tools row of Settings, press Save a debug bundle. You get one file, omniscript-debug-<time>.json, saved on your computer.
2. It holds the version, your settings, the selected script and its step, the data, the last 12 reads of it, the script's definition, the last 50 captured calls and what each tab is showing. With Mask values on, the data, calls and filter text are masked. See Debug bundle.

Only the answers in the script's definition are masked. Its labels, Set Values and other text are kept and can hold real values, so look at the file before you share it.

Look inside before you send it

You can check what the bundle shows without sending it anywhere.

1. In the Tools row of Settings, press Open bundle… and pick the file. The panel shows the script as it was when it was saved, read-only. A bar says "Bundle: <file> · read-only" with Back to live.
2. Click through Data, Structure and Calls. If you can see a value you would not want to share, save the bundle again with Mask values on.
3. Press Back to live when you are done. See Open bundle.

Fill in the issue form

1. Open the bug report form on GitHub.
2. Extension version: at the bottom right of the panel, or on chrome://extensions.
3. Package flavour: core OmniStudio, a managed package (vlocity_cmt, vlocity_ins or vlocity_ps), or not sure.
4. What you did and what happened: the tab, the steps, what you expected and what you saw. A screenshot helps. Check that it shows no real data.
5. Copy report: paste the text from the clipboard.
6. Masked debug bundle: drag the file into the box.
7. Tick the box that confirms Mask values was on and nothing shows real data.

Please do not paste real org data anywhere. If the problem is in a particular call or a hidden field, the guides Why did this call fail, and what did it send? and Why is this field hidden? show what to look at first.

Every control is described in the reference. More guides.