Lookup Table Vars

Loads a custom data row from a table defined by a worksheet in an Excel spreadsheet, then stores the values as individual script variables.

You can upload a spreadsheet through the action and select the worksheet to be read from. The worksheet is stored as a Base 64-encoded string in the script.

Dependencies

  • The spreadsheet that you upload to use with this action is stored as a Base 64-encoded string in the script. It is not stored on a file server.
  • You cannot edit the data after you upload the file. Instead, you must refresh the data by uploading a new version. This can only be done by the Studio user who originally uploaded the file. If the user is not available to update the file, you must delete the action from the script and upload a new version. See the Use the Action section on this page for details on how to refresh the data.
  • The larger the spreadsheet, the greater the chances of this action causing issues on the CXone servers. The number of rows and columns the spreadsheet has impacts the overall size of the file. The maximum number of rows is in the range of 10,000-20,000, depending on the number of columns and the amount of data in the cells. Be cautious when using this action with spreadsheets with a number of rows in that range. You may want to consider using a different solution, such as a database.
  • When reading from the spreadsheet, LookupTablVars ignores the last row. To avoid missing data, add a row at the end of the spreadsheet. The row can be empty or can contain nonsense values such as "end of file."
  • Column names cannot include spaces.

Supported Script Types

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Generic

 Email Chat Phone Voicemail Work Item SMS Digital

Input Properties

These properties define data that the action uses when executing.

These properties are automatically completed when you use the wizard to load a spreadsheet.

Property

Description

Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

Value The value matched to the key column used in deciding which data row to retrieve.
File Name The name of the spreadsheet file the worksheet was loaded from. Used by the Refresh option when re-loading the spreadsheet.
Worksheet Name The name of the worksheet selected to use with the action. Used by the Refresh option when reloading the workbook.
Key Column The name of the key column on the selected worksheet. Used by the Refresh option when re-loading the workbook.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition

Description

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 action's other branches are not defined.

NoMatch

Path taken when the action cannot identify the custom data row from the defined table.

Use the Action

  1. Add the LookupTableVars action to your script and connect it.
  2. Double-click LookupTableVars to open the wizard. If you have already uploaded a spreadsheet and want to choose a new one, right-click on the action and click Select New Workbook from the properties window.
  3. Click Next to accept the default option Private, Single-Use Look-up Table. The other option is not currently supported.
  4. Select the spreadsheet you want the action to use and click Open.
  5. If the spreadsheet contains multiple worksheets, select the worksheet you want the action to read from and click Next.
  6. Select the column name you want to use as the lookup key and click Next.
  7. Review your choices and click Next. The action encodes the selected worksheet and adds the encoded string to the script file.
  8. Click Finish.

Refresh the Data

If the data changes, you can refresh the data stored in the script. This must be done with the same user account and on the same computer that originally added the file.

  1. Right-click on LookupTableVars.

  2. Click Refresh Workbook.