READFILE

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

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


Generic	Email	Chat	Phone	Voicemail	Work Item	SMS

Input Properties

These properties define data that the action uses when executing.

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.
File Name	The name of the file. The file must be located in the file storage in CXone Mpower. Include the path to the file if it's in a folder.
Max Length	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 read from the file. The default variable is BUFFER.
Convert To Array	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.