Manage Scripts

This page provides information about tasks you may need to do when working with scripts. The Work with Scripts help page can help you learn how to create and modify scripts.

View a Script's Properties

Required permissions: ACD > Studio > Scripts View

The script properties are available on the panel on the right side of the script canvas. The properties panel doesn't show everything that's available in the Properties tab in Desktop Studio. For example, you cannot change the script's media type at this time.

1. In CXone, 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. The script opens in a new tab.
3. On the right side of the script canvas, view the properties panel. This panel contains the following options: 
   • Actions tab: Shows a list of all actions currently in the script. Beside each action is the action's ID, a numeric identifier assigned in the order the action was added to the script. Beneath each action is its caption, if it has one. Click an action in the list to highlight the corresponding action on the canvas.
   • Sort By: Allows you to sort the list of actions. You can sort by name or action ID, and in ascending or descending order.
   • Variables tab: Allows you to list variables that should be redacted from traces and logs.
   • Search canvas: Allows you to search the script canvas. The search can find actions or terms in captions or annotations on the script canvas. It cannot search values in action properties, including in editor windows. Results of your search appear below the search field, replacing the list of actions.
   • Errors and warnings: Allows you to see if the script currently has any errors or warnings. If there are any, the button label includes the number. Click the button to view a list of the errors or warnings.

Promote a Script to the Next Development Stage

Required permissions: ACD > Studio > Testing Stage Promote To, ACD > Studio > Pre-Deployment Stage Promote To, or ACD > Studio > Production Stage Promote To

CXone Studio supports a development lifecycle for scripts. There are up to four development stages that a Studio administrator can enable. Each stage is associated with a folder in Studio. If you have the appropriate permissions, you can promote a script from one stage to the next. When a script is promoted, it's copied into the next stage's folder.

If your organization uses a third-party version control system with Studio, script promotion is committed to that system. You must have access to the repository to commit changes to it. If you don't have access, talk to your versionrepository owner in your organization. The first time you commit a change to the repository, you are prompted to enter an access token from the version control system. You can generate a token in the version control system's platform. Currently, GitHub is the only supported provider.

The ability to view, create and edit, and promote scripts to each development workflow stage is controlled by permissions. Contact your CXone or Studio administrator if you have questions about your Studio permissions.

Development workflows, script promotion, and using a version control system with CXone Studio must be enabled and configured by a Studio administrator.

Promote a Single Script

1. In CXone, 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. The script opens in a new tab.
3. From the Save drop-down list in the upper right corner of the canvas, select Promote. The Promote Script window displays the name of the current stage and the one you're promoting to. If your organization uses a third-party version control system with Studio, you can also see the name of the repository the change will be committed to.

4. If your company uses a version control system with Studio and this is the first time you're committing a script change to your version control system, enter your Access Token. You can obtain the access token in the version control platform.

5. Click Promote. A toast Toast messages are small, temporary pop-up messages on the bottom of the screen indicating things like errors and successes. They are built-in to CXone functionality and can appear on any screen. message appears in the bottom right corner of the page when the script is successfully promoted.

Promote Multiple Scripts at Once

1. In CXone, click the app selector and select Omnichannel Routing > Studio .
2. On the Scripts page, select the checkbox next to each script you want to promote.
3. Click Promote in the upper right corner of the page.

4. If your company uses a version control system with Studio and this is the first time you're committing a script change to your version control system, enter your Access Token. You can obtain the access token in the version control platform.

5. Click Promote. A toast message appears in the bottom right corner of the page when the scripts are successfully promoted.

Put a Script into Production

Required permissions: ACD > Contact Settings > Points of Contact Edit

When a script is fully tested and ready to put into use in CXone, you can put it into production. To do that, you need to assign a script to a point of contact The entry point that an inbound contact uses to initiate an interaction, such as a phone number or email address. in CXone ACD.

1. Click the app selector and select ACD.

2. Go to Contact Settings > Point of Contact.

3. Click the point of contact you want to assign a script to.

4. Click Edit.

   View image

   

5. Select the Script that you want this point of contact to use. The drop-down list shows all active scripts currently available for the Media Type of the current point of contact.
6. Click Done.

View a Script's History

Required permissions: ACD > Contact Settings > Scripts > View

You can view previous versions of a script, see the date and time the script was changed, and the user who made the change. The previous versions of the script open in the same tab as the active version of the script. Previous versions of the script cannot be modified.

A script's version history is limited to the development stage it's currently in. You can see any changes that have been made since the script was promoted to that stage. To see changes made from an earlier stage, you must open the script in that stage's folder. Development stages are an optional feature that must be enabled in CXone Studio.

1. In CXone, 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. The script opens in a new tab.

3. Click the script name at the top of the page and select Version History. The Version History pane opens on the left side of the page.

   View image

   

4. On the Version History pane, click a previous version to see the script at that point in time. The script displayed in the tab changes to that version.

5. To save a previous version with a new name, click Save Version As in the upper right corner of the page. Specify the name and location and click Save. The saved version becomes the active script in the current tab.

   If you save a previous version of a script with the same name as the active version of any script, Studio overwrites active script with the past version you're attempting to save.

6. To compare the historical version of the script with the active version, save the previous version as a new script, then return to the tab with the Scripts page and open the active version of the script. It will open in a new tab.
7. To return to the editable view of the active version of the script, click the arrow next to the date in the top left corner of the page.

Revert to Previous Version of Script

Studio keeps previous versions of all scripts. Each time you save your changes, another version is added to the script file's history. You can revert to a previous version of a script file.

If you have saved a copy of a script under a different name as a backup and want to revert back to it, don't follow these steps. Instead, open the backup copy you want to revert to. You can work in the backup copy, or you can duplicate it to create a new working copy and leave the backup in place. You can deactivate copies of scripts that you don't want anymore.

Revert to a Previous Version of a Script from CXone Studio

Permissions required:  Applications > Studio > Scripts Create/Edit

1. In CXone, click the app selector and select Studio.
2. Open the script you want to revert. If the script you want to revert is currently deactivated, you must reactivate it first.

3. Click the script name at the top of the page and select Version History. The Version History pane opens on the left side of the page.

   View image

   

4. On the Version History pane, click a previous version to see the script at that point in time. The script displayed in the tab changes to that version.
5. Click Restore.
6. Click Restore again to confirm that you want to revert to the open version. The selected script becomes active in the current browser tab.

Revert to a Previous Version of a Script from CXone

Permissions required:  ACD > Contact Settings > Scripts > Edit

When scripts are reverted from CXone, the name of the file doesn't change as it does when you revert from Studio.

1. In CXone, click the app selector and select ACD > Scripts.
2. Click the script you want to revert. If the script you want to revert is currently deactivated, you must reactivate it first.

3. On the Version History tab, select the version you want to revert to from the Previous Versions list and click Revert Back.

   View image)

   

4. In Studio, open the script you reverted and continue working on it.

Redact Variables from Traces and Logs

Required permissions: ACD > Studio > Scripts Create/Edit

Variable redaction eliminates variable values from traces and logs generated by a script. You can redact variables and objects.

Redaction is configured at the script level in the VariableRedaction field of a script's properties. Redacted values are replaced with a string of X characters. The length of the variable value determines how many X's are used, meaning that a redacted five-letter word would result in five X's. Partial variable redaction, such as part of a credit card number, is not supported.

1. In CXone, 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. The script opens in a new tab.
3. In the properties panel on the right side of the script, click the Variables tab.

4. Click Redacted .

   View image)

   

5. In the field on the Variables tab, enter the name of each variable you want to redact.  Press Enter after each variable. These names should correspond to variables created in Assign or SNIPPET actions in the script.

6. Click Redacted again to hide the list of variable names.

7. Save your script.

Lock and Unlock Scripts

Required permissions: ACD > Studio > Scripts Create/Edit

Scripting locking allows you to lock a script so that only you can edit it. This prevents multiple Studio users from modifying a script at the same time. This is an optional feature that must be enabled in CXone.

When you want to edit a script, you must lock it. This puts the script into edit mode. Scripts stay locked until you unlock them, or until another Studio user overrides your lock. When you're finished working with a script, you can unlock it. This places the script in read-only mode and makes it available for other Studio users to edit if they need to.

Before you lock a script, Studio refreshes the script. This loads any changes that may have been made by other Studio users between the time you opened the script and when you lock it.

1. In CXone, 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. The script opens in a new tab.

3. Hover the cursor over the eye next to the script name in the toolbar at the top of the canvas workspace and select Edit Script (Lock).

4. When you're finished working with the script, hover your cursor over the lock next to the script name in the toolbar at the top of the canvas workspace and click View Only Script (Unlock).

Override a Locked Script

Required permissions: ACD > Studio > Scripts Lock Override

When you open a script that's locked for editing, the icon next to the script name above the canvas workspace is a closed lock . You can hover the cursor over the icon to see who locked the script. If it's you, you have the option to unlock the script and put it into read-only mode. If it was locked by another user, it shows the name of the user.

If your CXone role includes the Lock Override permission, the drop-down also includes the option to override the lock. When you override a script lock, Studio loads the latest saved version of the script. If the other user has unsaved changes they cannot be saved after the lock is overridden. If the other user attempts to save the script after the lock is overridden, they see an error message letting them know about the override. When a script's lock has been overridden, it can be duplicated and saved with another name.

You can review changes to a script by viewing a previous version of it. This is helpful if another user has edited a script and you want to know what they changed.

Be sure to follow your organization's guidelines for overriding other users' script locks.

1. In CXone, click the app selector and select Omnichannel Routing > Studio .
2. Click the ellipsis next to the script you want to override and select Lock Override.
3. Alternatively, you can: 
   1. Open a script that's locked by another user.
   2. Click the lock next to the script name in the toolbar above the canvas workspace and click Lock Override.
   3. Click OK when prompted to confirm you want to override the other user's lock. A status message appears when the lock is successfully overridden.

Deactivate a Script

Required permissions: ACD > Studio > Scripts Deactivate

Scripts cannot be deleted from Studio. Instead, you can deactivate them. Deactivated scripts are only visible in Studio if you choose to view All or Inactive scripts on the CXone Studio Scripts tab. You can also see them on the Scripts page in the CXoneACD application.

You don't need to deactivate a script to prevent CXone from using it. CXone only uses scripts that are assigned to a skill Used to automate delivery of interactions based on agent skills, abilities, and knowledge and a point of contact The entry point that an inbound contact uses to initiate an interaction, such as a phone number or email address..

1. In CXone, click the app selector and select Omnichannel Routing > Studio .
2. On the Scripts page, locate the script you want to deactivate.
3. Click the three horizontal dots next to the script and select Deactivate. You can also open a script and click the down arrow button next to the script name and select Deactivate from the drop-down menu.
4. Confirm that you want to deactivate the script. A notification appears in the lower right corner of the window when the deactivation is complete.
5. You can add notes to the script in CXone if you want to explain why you deactivated the script:
   1. In CXone, click the app selector and select ACD > Scripts.
   2. Select Inactive from the Show drop-down.
   3. Click the script and add your comments on the Notes tab.

Reactivate a Script

Required permissions: ACD > Studio > Scripts Deactivate

You can reactivate a script to make it visible in Studio again. Currently, you cannot reactivate a script from within CXone Studio.

1. In CXone, click the app selector and select ACD > Scripts.
2. Select Inactive from the Show drop-down.
3. Click the script you want to reactivate.
4. Click Activate on the Details tab of the script's page.