Readfile

Reads data from a file into a local variable.

This action attempts to read any file that's named in the FileName property. Not all file types are readable. For example, images and music files may not be successfully read by this action. Any file that is readable is written into the specified variable.

Readfile provides basic can be used to retrieve simple data items from a file stored in the folder. It's typically used in conjunction with theWritefile action. Together, Readfile and Writefile provide basic data storage and retrieval capabilities. For advanced data access, use Sqlselect, Sqlexec, Sqltable, and Sqlcursor.

Dependencies

An excessive load is placed on your system when these conditions are met: 

  • Your business unit has more than ~15 concurrent calls.
  • The scripts that are running contain file-related actions, such as Writefile, Readfile, and Fileexist.

This results in throttling. Your business unit will experience latency with script execution and other functions, including contact handling and state changes, until the backlog of processes completes.

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.

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.

FileName

The name of the file. The file must be located in the file storage in CXone. Include the path to the file if it's in a folder.

MaxLength

Limits the size of the file. You can choose from Limit1K, Limit2K, Limit4K, Limit8K, Limit16K, Limit32K.
Variable The name of the variable that you want to hold the data from the file. The default variable is BUFFER.

ConverttoArray

If you want the contents of a text file converted to an array in the variable, select True. In the file, the contents of each array element must be separated on its own line.

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.
FileNotFound Path taken if the filename cannot be found.