FILELIST VARA Objects

FILELIST VARA objects retrieve the file names of the files stored in a particular directory. When defining FILELIST VARA object, specifying an Agent is mandatory. On Windows Agents, file names are sorted in ascending order. On UNIX Agents, the file names are not sorted.

FILELIST VARA objects have contain one column; they do not have a result column. Keep this in mind when using the GET_PROCESS_LINE script element in relation with FILELIST VARA objects.

Use PromptSet variables here when you use the Dynamic Reload feature for combo box prompts. The PromptSet variables are resolved when the object that includes the PromptSet is executed.

A FILELIST VARA object definition is made up of the following pages:

  • General Page

    Common to all object types, here you define basic object information and apply custom values to it

  • Variables

    Here you define the object-specific settings. Some sections on this page are common to all VARA objects and are described for all of them in dedicated topics:

  • Version Management Page

    Common to all object types, here you find a list of all versions of the object

  • Documentation Page

    Common to all object types, here you enter information that you consider important to understand the configuration and behavior of the object

This topic describes how to configure the Variables page.

To Define a FILELIST VARA Object

  1. In the Variable Settings section specify how the VARA object is going to access the target system from which it retrieves the values.

    • Type

      Read-only, always Filelist for this type of VARA objects.

    • Agent

      The OS Agent that is used to access the directory. Agent Groups are not allowed.

      If you do not select anything, the Agent of the task that uses the VARA object is applied.

      Notes:

      • A runtime error occurs if the VARA object is used in an object to which no Agent or Login has been assigned.
      • File Transfer object as source: If you do not assign an Agent, the Agent that is defined in the destination settings of the File Transfer object is used.

      • You can include PromptSet variables here when using the dynamic reload feature for combo box prompts. When you use PromptSet variables in a dynamic VARA object, the Preview feature returns an error. This is because the PromptSet variables do not exist in the dynamic VARA object. However, the PromptSet variables will be resolved when objects including the PromptSet are executed.

    • Apply Task Agent

      Deploys the Agent of the task that uses the VARA object. If the task does not have an Agent (such as, for example, in Script objects), the Agent of the VARA object is used. If neither the VARA object nor the task has an Agent, an error occurs.

    • Login

      Login object that allows the VARA object to access the Agent.

    • Apply Task Login

      Deploys the login of the task that uses the VARA object.

      If the task does not have a Login object assigned, (such as, or example, in Script objects), the Login assigned to the VARA object is used. If neither the VARA object nor the task has a Login object, an error occurs.

    • Files

      The directory from which the file names should be returned as a value list when the VARA object is accessed. For example, on a Windows computer it could be:

      C:\temp\*.*

      You can also limit the list to files with a particular name or suffix. To set such filters, use "*" (several characters) or "?" (exactly one character). For example:

      C:\utility\temp\*.txt

  2. Define the Data Types and Formatting.

  3. Define the Script Access.

  4. Click the Preview button to validate the VARA object. This function checks whether the directory exists, if the Agent is available, if there is read access to the path, and so on. If the settings are correct, the file list is displayed.

  5. To export the content of the preview table to a CSV file, click Export Table. All rows and column are exported. Use this function if you need to further process the content of the CSV file (paste it to a different application for further processing and so on).

  6. To copy one or more rows in the Preview table, select the Copy button. The selected rows are copied to the clipboard and you can paste them to a third party tool (Google, Sheets, Excel, text editor, and so on).

    Note: This function is available only if https is used on the Automic Web Interface .

  7. Save your changes.

See also: