Programmatic Interface - Data File Commands

These commands are associated with Logged Data Files. They allow browsing the directory structure, downloading files, and deleting files.


List of all commands
Programmatic Overview


Show LoggedFileStats

This command returns information about directories of logged data files. For the specified directory, the response shows the total space used and the number of data files contained in the directory and its subdirectories. In addition, the amount of space available for additional logging is shown. Note that the available space is a characteristic of the entire file system.


Parameters:

directory=/200311/07 The full path to the desired directory.
This is an optional parameter. If not specified, then statistics are shown for '/'.


Response:
LoggedFileStats directory=/ fileCount=391 MbytesUsed=131.136 
                MbytesAvailable=1.260

Show LoggedFilePools

This command generates a multi-line response that shows the current status of the data File Management Pools. See the commands Show AutoDelete and Set AutoDelete for details on how to configure File Management Pools. This command shows the most recent results from scanning the logged data files. Note that this data is only updated at approximately one minute intervals.


Parameters:

No parameters are available.

Response:
<Show LoggedFilePools>
pool=a       files=112 size=49.9  maxSize=50  autoDelete=Yes full=No
pool=b       files=52  size=44.6  maxSize=50  autoDelete=No  full=No
pool=Default files=216 size=8.1   maxSize=5   autoDelete=No  full=Yes
<end of Show LoggedFilePools>

Show LoggedFiles

This command generates a multi-line response that lists the contents of a specified directory. This shows any subdirectory names, and any data files along with their lengths.


Parameters:

directory=/200311/07 The full path to the desired directory.


Response:
<Show LoggedFiles directory=/200311>
Directory name=07
Directory name=08
LoggedFile name=Hollister200311070600a.T00 size=462237
LoggedFile name=Hollister200311070700a.T00 size=463776
<end of Show LoggedFiles directory=/200311>

Show LoggedFile

This command returns information about a specific data file.


Parameters:

path=/Path The full path to the desired file, starting at '/'.


Response:
LoggedFile path=/200311/Hollister200311071300a.T00 size=3706872

Download LoggedFile

This command allows transfering a logged data file to an external computer. The desired file is specifed by the path parameter. If the file exists, then it is returned in the response. Because logged data files are often in a binary, non-ascii, format, the response is not returned as type 'text/plain'. Instead, the type will be 'application/octet-stream'.

Note that any error messages (like file not found, etc.) must come over the same channel, but they will be encoded with type 'text/plain'.


Parameters:

path=/Path The full path to the desired file, starting at '/'.


Response:

Delete LoggedFiles

This command deletes an entire directory tree. The entire contents of the directory is removed, including all subdirectories and data files.

Parameters:

directory=/200311/07 The full path to the directory to be deleted.
This parameter must be specified.

Response:

OK: LoggedFile Directory /200311/07 is deleted.

Delete LoggedFile

This command deletes a single logged data file.


Parameters:

path=/Path The full path to the desired file, starting at '/'.


Response:
OK: LoggedFile /200311/Hollister200311071300a.T00 is deleted.