Indicate

Extends the agent interface with custom functionality, specifically an icon that the agent clicks to initiate that functionality. You can double click the action to open a configuration wizard.

Supported Script Types

Properties

Property Details
Target Determines the recipient type from a drop-down list.
TargetIDs The ID of the target, such as an agent ID or a skill ID.
Name This property is the name or key used to identify the value. This can be any name or number. Names are not case sensitive. If you have multiple Indicate actions in use, this name is used to track which Indicate action is turned on or off.
ImageFile

The URL of an image file in the tenant directory on the CXone file server. This is the image that agents will click on. The file must be a GIF, JPG, or PNG and 16x16 pixels in size. This property is required when using the Indicate action in Agent for Salesforce or Fully Integrated Lightning Agent for Salesforce.

A broken link for ImageFile can cause severe performance issues for the associated tenant. When using custom icons, it is important to verify that the link is accurate.

MAX uses a predefined set of images for all indicators, based on the ActionType. Using ImageFile with MAX won't change the images that agents see.
Tooltip The text that appears when the mouse cursor hovers over the indicator icon or text.
State A drop-down list of either On or Off to determine whether or not the indicator will be displayed. Typically, you need two indicate actions with the same name. One to enable the button, one to disable the button.
ActionType
  • RunExe — runs a local executable. This option uses a Java plugin that is only functional with Internet Explorer, which CXone does not support. This requires a local executable which resides in the Windows path or with the full path entered in the ActionValue field. The file path must include double back slashes (\\) in the path. For example, C:\\Program Files\\inContact\\studio.exe. Most modern browsers do not support running executable programs. If you want to use this type, ensure that your agents use a compatible browser.
  • OpenURL — opens a default web browser to the URL specified in the ActionValue field.
  • SpawnScript — spawns a script specified in the ActionValue field and pass parameters.
  • SignalScript — signals a script specified in the ActionValue field and pass parameters.
  • ShowCustomForm — launches a custom html form created in Studio. The captured data from the custom form will trigger the ONDATA event in the script.
ActionValue

The value needed by the specified ActionType. Variables are supported in this property by encapsulating the variable in {braces}.

  • RunExe - The name or path to a windows executable file. The file path must include double back slashes (\\) in the path. For example, C:\\Program Files\\MyCompany\\myApp.exe -h {ANI}.
  • OpenURL - Must be fully qualified domain name and URL. Query string parameters are supported. For example, http://www.example.com/file.asp?ANI={ANI}. You can also customize the title of the tab that pops up in the MAX interface by appending the icAgentPanelTitle= parameter to the URL.
  • SpawnScript - The name of the script that you want to spawn. The name must be the full path to the script (from the current directory of the running script).
  • SignalScript - The ID of the running script that you want to signal. Typically you are spawning a related script and can use {ContactID} to signal the current script. Use {MasterID} to signal the parent script, or something like {SpawnID} to signal a child script.
  • ShowCustomForm - This field offers the ability to build a custom HTML form. Any standard form input fields may be used, including Input, Textarea, Password, Checkbox, Radio, Select, Button, and Submit. The <form> tags should not be included.

    Each input field must contain a name. Fields without a name will be ignored. Example, <input type="text" name="phone">. Names and values will be returned to the script as variables using the Ondata action. If the script is missing the Ondata action then the form will be useless. Form fields that support multiple values, for example Checkbox and Select, will contain a comma-separated array.

    Multiple submit buttons can be used using the same or different names, but any submit button will submit the data and close the window. If you want a button that doesn't submit, then use a button rather than a submit.

    Linked stylesheets are not supported but inline styles are supported. For example, <div style="position: absolute: left: 10px: top: 100px:">.

    Javascript will work when linked to an external javascript, but content must be HTTPS to avoid errors. For example:

    <script type="text/javascript" src="https://www.example.com/test.js"></script>

    <INPUT TYPE="button" NAME="button" Value="Click" onClick="MyFunction(this.form)">

Fieldset and Legend are supported for laying the forms out in a more readable fashion. Inline styles could be applied to the HTML entities. For example:

<fieldset>
<legend>Gender:</legend>
<input type="radio" name="gender" value="male"/>Male
<input type="radio" name="gender" value="female"/>Female<br/>
</fieldset>

Branches

Branch Details

Default

Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the other branches are not defined.

OnError

Path taken when the action fails to execute properly.

Tips & Tricks

  • These icons in the agent interface can be used to run or signal a script, open a URL, or build basic web-based forms and process their data.
  • An indicator must also be turned off in the script or it will continue to appear in the agent interface after the contact has ended. Typically, 2 Indicate actions are used - one to turn the button on, and another to turn the button off.
  • Because the Indicate action is so flexible, be very careful programming and test thoroughly.
  • The Indicate action has a wizard to step through the process. Double-click the Indicate action to start the wizard.

Similar Solutions