AX1410

File System command

Use the File System command to perform Axiom Software file system operations from an Axiom form. You can copy files and delete files.

Can be used in

  • Axiom forms

When the File System command is selected from the Command Library as the shortcut target, it displays as command://FileSystem or command://FileSystemCommandAdapter (legacy syntax).

Shortcut parameters

This command uses the following shortcut parameters:

Item Description

Action

The action to perform on the designated source file:

  • Copy: Creates a copy of the source file and saves it to the destination.
  • Delete: Deletes the source file.

Source

Specifies the source file for the action. The source must be a full path and file name in the Axiom Software file system, such as:

\Axiom\File Groups\Capital Requests\Drivers\Driver1.xlsx

You can "hard-code" a file path, or you can use an indirect cell reference to read the path from a cell in the form source file. For example, if you enter [Variables!B2] then the path will be read from that cell.

Destination

Specifies the destination for the Copy action. Does not apply if the action is Delete.

The destination must be a full path and file name in the Axiom Software file system. For example:

\Axiom\File Groups\Capital Requests\Drivers\Driver2.xlsx

You can "hard-code" a file path, or you can use an indirect cell reference to read the path from a cell in the form source file. For example, if you enter [Variables!B3] then the path will be read from that cell.

Processing Step

Specifies when the command will be executed during the form update process. By default, this is set to Form - After Processing, which means that the command will be performed after the entire form update process is complete.

If desired, you can specify a different processing step for the command. For more information, see Timing of command execution and Axiom form update process.

Visibility

In Axiom forms, the command used does not impact whether the button is visible or enabled.

Remarks

  • The user executing the file action must have the appropriate permissions to the source and the destination. For example, in order to copy a file to designated location, the user must have at least read-only access to the source file and read/write access to the destination folder.

    For non-administrators, file actions are only supported for files and folders where users can be explicitly granted permissions to those files and folders (meaning, the files and folders available on the Files tab of security). Actions on other files are not supported and may not work as expected.

  • If the file being copied is a driver file, the file is processed after copying to perform a save-to-database. If Save Type 3 is enabled for the file, the file must be configured so that the driver table name in the copy will be unique.

  • If the file being deleted is a driver file, the associated driver table is deleted as well. This is the same behavior as when deleting the file in Axiom Explorer.