LOOKUP TABLE VARS

This help page is for Studio. This information is also available for Desktop Studio.

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.

Currently, you cannot upload a spreadsheet to this action in Studio. If you need to include LookupTableVars in a Studio script, you can open the script in Desktop Studio. Upload the spreadsheet and configure the action, then save the script. You can continue working on the script in Studio.

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 Mpower 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

A square with a line branching from it that goes to three other squares.

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

Add Caption

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

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.