FILEINFO
![]() |
Retrieves information about a file from the directory and saves it as a variable. |
Supported Script Types
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Generic | Chat | Phone | Voicemail | Work Item |
Properties
- FileName
-
The full file name and path of the file to be inspected.
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.
Branches
- Default
- The Default branch condition will be used unless another branch condition is met.
- OnError
- This branch condition will be triggered if any kind of invalid file pattern or file paths is entered. File names and paths are limited to certain valid characters and are enforced by the Microsoft APIs working in the background.
Tips and Tricks
Technically, this is a C# class like used by CREATEEMAIL. 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 unitFile format associated with Microsoft Excel; may also be expressed as .xlsx number of file’s owner. |
ContactID | int | Contact IDA 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. |