Fileinfo

Retrieves information about a file from the directory and saves it as a variable.

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.

Generic

Email Chat Phone Voicemail Work Item SMS

Input Properties

These properties define data that the action uses when executing.

Property

Description

FileName The name of the new file. The file name is relative to the folder path where the script is saved. For example, if your script is in a folder called Test, using a file name of Sample.wav will be interpreted as Test\Sample.wav automatically. Access to files above the current script folder is not allowed.
FileInfoVar The name of the variable to contain the file information. By default, FILE.

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.

OnError

Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.

Tips & Tricks

Technically, this is a C# class, like the one used by the Createemail action. The class contains the following members:

Member Format Description
Accessed DateTime Date and time the file was last accessed (in UTC).
AuthorID int Agent ID of the file’s creator (this is not populated today).
BusNo int Business unitClosed High-level organizational grouping used to manage technical support, billing, and global settings for your CXone environment number of file’s owner.
ContactID int Contact IDClosed A unique numerical identifier assigned to each contact associated with this file (often used for call logging files).
Created DateTime Date and time the file was originally created (in UTC).
DeleteTime DateTime Date and time when the file will be deleted automatically (in UTC). This may be the Min datetime value which represents Never.
Description string Optional text description associated with the file (unused today).
EntryID int The unique ID associated with the file (used internally as a primary key).
FileName string The name of the file without the path.
FolderID int An ID representing the folder where the file is located.
FullFileName string The full path and file name.
IsDeleted bool Indicates if this file has been deleted. Deleted files stay in the system for at least 24 hours.
IsFolder bool Indicates if this record refers to a folder or a file.
MailStatus byte Unused.
Modified DateTime Date and time when the file was last modified.
ModifiedID int Agent ID of the user which last modified the file (this is not populated today).
NumFiles int If IsFolder is true, this may contain the number of files contained within the folder.
PhysicalBytes int Indicates the number of bytes occupied by this file on disk.
PhysicalLocation string Indicates the path and file name of the system file used to store the contents of the file on disk.
Protected bool True if this file is locked to prevent accidental overwrite or deletion.
Purpose FilePurposeType Indicates the category of this file. The categories are listed below.
Size int Indicates the actual number of bytes that this file requires.
Version int Indicates the version number of this file. Used only if file versioning is enabled.
VolumeID int Indicates the ID of the physical disk volume where the file is stored.
VolumeStatus VolumeStatus Indicates the current status of the physical disk volume where the file is stored.
Weblink bool True if this file is visible from the web server for public access.