Use Variable Watchlists

Required permissions: ACD > Studio > Scripts > Debug

Watchlists allow you to keep track of specific variables and data objects. This makes it easier to find them during a trace, without searching manually. This saves you time, especially for scripts with many variables or that you run traces on frequently.

Watchlists are saved per user and per script. They are saved in your CXone Mpower user preferences. You can see them no matter what browser or computer you use, as long as you're logged in to CXone Mpower with the same user account.

The watchlist shows variable values in real time as the script runs. Select any action in the trace results to view their values at that point in the script. Variable names in red italics have changed values or are new.

Variables appear in the watchlist in the order you add them. The most recently-added variable appears at the bottom of the list. If a variable is redacted, its value will also be masked in the watchlist.

Create and Use a Variable Watchlist

1. In CXone Mpower, click the app selector and select Omnichannel Routing > Studio .
2. On the Scripts page, locate and double-click to open the script you want to work with or create a new one. The script opens in a new tab.

3. Start a trace on one or more contacts The person interacting with an agent, IVR, or bot in your contact center..

4. If tracing multiple contacts, double-click a contact on the multiple traces window to view that trace in the trace output window.

5. Click an action's row in the trace output to see all variables and their values in the script at the time that the action was triggered. The variables appear on the Variables tab on the right side of the trace output window.
6. On the Variables tab, click the plus sign to the right of a variable to add it to the watchlist. The plus sign is only visible when the cursor hovers over it. For dynamic data objects, you can:
   • Click the plus sign on the parent object name to add it and all submembers. If a submember is already selected, you must click the checkmark next to the submember to remove it from the watchlist before you can add the entire object to the watchlist.
   • Expand the object and the plus sign for one or more submembers to add specific ones to the watchlist.
   • Expand submembers and click the plus sign for one or more members of a submember to the watchlist.
7. Click the checkmark next to a variable to remove it from the watchlist.

8. Click the Watchlist tab to see all variables currently being tracked.

   Learn more about fields in this step

   Field	Details
   Variable	Shows the name of the variable.
   Value	Shows the value of the variable. Initially, the value of a variable is empty. It shows a value only when the trace runs and an action modifies that variable's value.
   Type	Shows the type of variable or the type of data that the variable holds. Variables types include Variable, Dynamic Data, and UCN.Data.DynamicData.

9.  On the Watchlist tab, you can: 
   • Click a column heading to sort the watchlist. By default, variables are sorted by name with the most newest at the bottom.
   • Click the down-arrow next to a variable name to see actions that modify the value of that variable.
   • Click the trash can to delete a variable from the watchlist.
   • Click the plus sign to the right of the search bar to manually add variables to the watchlist.
   • See the value of a variable at a particular point in the script by clicking an action on the left side of the Trace output window. The value of the variable updates to what it was when that action fired. If the variable was new or changed when the selected action fired, it appears in red italics
   • Double-click a variable to view details about it.
   • Click the three stacked dots next to the search bar to Save, upload a different watchlist to this script, or download the watchlist. .
10. Click Save.

Add Variables to a Watchlist Manually

You can manually add variables or dynamic data objects to your watchlist. This lets you add variables to a watchlist without having to find them in the trace output first.

Type variable names exactly as they're spelled, including underscores and periods. You can add dynamic objects with submembers, such as beowulfFoes.foe1.name. Variable names are not case sensitive, but dynamic object names are.

1. In CXone Mpower, click the app selector and select Omnichannel Routing > Studio .
2. On the Scripts page, locate and double-click to open the script you want to work with or create a new one. The script opens in a new tab.

3. Start a trace on one or more contacts The person interacting with an agent, IVR, or bot in your contact center..

4. If tracing multiple contacts, double-click a contact on the multiple traces window to view that trace in the trace output window.

5. On the Watchlist tab, click the plus sign to the right of the search bar.
6. Enter variable names one at a time, pressing Enter after each one. The variable appears in the list on the window. Repeat this step to add more variables.
7. Click the trash can next to a variable on the window to delete it
8. Click Add to Watchlist when you're finished adding variables.

Download a Watchlist

You can download a watchlist to share it with other CXone Mpower Studio users. You can also download a watchlist if you want to use the same watchlist with another script.

Watchlists are saved as JSON with file type WT.

1. In CXone Mpower, click the app selector and select Omnichannel Routing > Studio .
2. On the Scripts page, locate and double-click to open the script you want to work with or create a new one. The script opens in a new tab.

3. Start a trace on one or more contacts The person interacting with an agent, IVR, or bot in your contact center..

4. If tracing multiple contacts, double-click a contact on the multiple traces window to view that trace in the trace output window.

5. On the Watchlist tab, click the three stacked dots to the left of the search bar and select Download .
6. Enter a name for the watchlist and choose where to save it on your computer, then click Save . When the download is saved, a success toast Small, temporary pop-up messages on the bottom of the screen indicating things like errors and successes. message appears.

Upload a Watchlist

You can upload a watchlist to add it to a Studio script. This lets you use the same watchlist in multiple scripts. If someone else creates a watchlist for a script, they can share it with you so you can both track the same variables in that script.

1. In CXone Mpower, click the app selector and select Omnichannel Routing > Studio .
2. On the Scripts page, locate and double-click to open the script you want to work with or create a new one. The script opens in a new tab.

3. Start a trace on one or more contacts The person interacting with an agent, IVR, or bot in your contact center..

4. If tracing multiple contacts, double-click a contact on the multiple traces window to view that trace in the trace output window.

5. On the Watchlist tab, click the three stacked dots to the left of the search bar and select Upload .
6. Select a watchlist on your computer, then click Open. If the script already has a watchlist, you're prompted to confirm that it will be replaced. When the file is uploaded, a success toast Small, temporary pop-up messages on the bottom of the screen indicating things like errors and successes. message appears.