LIST

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

Retrieves a directory listing from the file server.

Dependencies

The file gets copied to the file server from the media server. The larger the file, the longer you will need to wait for the file. To avoid problems, use a Wait action to give the script a few seconds to find and transfer the file.

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

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 Path The file path and file pattern to list. It supports variables and wild cards. An asterisk (*) matches zero or more characters of any kind at that position. a question mark (?) matches exactly one character of any kind at that position. By default, *.* . For example, MailLog\*.eml would return all EML files in the MailLog folder.
Result Var The variable name that is created and holds returned information. For example, if the contact enters their account number as 123456, then the variable holds 123456.
Count Var The name of the variable to contain the number of files listed. By default, COUNT.

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.

Error

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.