File Subsystem

The File Subsystem Type enables interacting with file system operations like copy, delete, get file size, etc. It also supports FTP operations like Download, Upload, Delete and check if a given path is a directory. It requires the filemanager application

PROPERTIES
Name File Subsystem
System ID 07
Connection String null
Heartbeat Connection String null
SUPPORTED NODE DEFINITIONS
Message UID Node Definition Name
SuperState Async Create MD5 Checksum SuperState
SuperState Async File Archive SuperState
SuperState Async File Copy SuperState
SuperState Async File Extract SuperState
SuperState Async File Move SuperState
010716 Asynchronous Create MD5 Checksum
010715 Asynchronous File Archive
010701 Asynchronous File Copy
010717 Asynchronous File Extract
010702 Asynchronous File Move
SuperState Calculate Checksum
070118 Calculate CRC32 Checksum Complete
010718 Calculate CRC32 Checksum Start
SuperState Calculate CRC32 Checksum
010725 Concatenate
070128 Copy Folder Complete
070127 Copy Folder Contents Complete
010727 Copy Folder Contents Start
SuperState Copy Folder Contents
010728 Copy Folder Start
SuperState Copy Folder
010721 Create Folder
070116 Create MD5 Checksum Complete
010708 Delete Files
010720 Delete Folder
070115 File Archive Complete
070107 File Copy Complete
010712 File Copy
010704 File Delete
070117 File Extract Complete
010709 File Listing
070114 File Move Complete
010713 File Move
010703 File Rename
010705 File Size
010710 Folder Listing
010706 Folder Size
010740 FTP Authentication Delete
010738 FTP Authentication Download
010737 FTP Authentication Is Directory
010739 FTP Authentication Upload
010733 FTP Delete
010732 FTP Download
010741 FTP Filtered Upload
010734 FTP Is Directory
010742 FTP Rename File
010711 FTP Upload Download
010735 FTP Upload
010723 Get Base Name
010724 Get Extension
010726 Get Name
010722 Get Parent
070130 Move Folder Complete
070129 Move Folder Contents Complete
010729 Move Folder Contents Start
SuperState Move Folder Contents
010730 Move Folder Start
SuperState Move Folder
010731 Partition Size
010736 Retrieve File From URL
010747 SFTP Authentication Delete
010746 SFTP Authentication Upload
010743 SFTP Check File Exists
010745 SFTP Delete
010744 SFTP Upload
SuperState Uncompress

* The message has been deprecated. Please use the replacement message(s) instead.

NODE DEFINITION DETAILS

Calculates the MD5 checksum of the specified file. The request is made and an asynchronous response is received on completion. Use the 'Calculate Checksum' if the input type is STRING

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
filePath
checksum

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
SourceFiles
DestinationPath

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
Source Path
Destination Path

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
Source File
Destination Directory

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
Source Path
Destination Path

Starts to calculate the MD5 Checksum of the specified file. The response is received asynchronously, see Asynchronous Create MD5 Complete. Most callers should use the Async Create MD5 Checksum superstate instead.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The path of the file to have its MD5 sum calculated
RESPONSE MESSAGE:
Parameter Name Description / Value

Starts archiving a file. The asynchronous response is received later, see File Archive Complete. Most users should be using the Async File move Archive Superstate or Uncompress instead. To move the file synchronously, see File Move.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
SourceFiles NO A comma separated list of file paths to be archived. No trailing spaces between file paths are allowed.
DestinationPath NO The path of the resulting archive
RESPONSE MESSAGE:
Parameter Name Description / Value

Starts copying a file to the specified destination. The asynchronous response is received later, see File Copy Complete. To copy the file synchronously, see File Copy.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
DestinationPath NO The destination of the copied file
SourcePath NO The path of the file to be copied. No folders are supported
RESPONSE MESSAGE:
Parameter Name Description / Value

Starts extracting the specified file. The response is received asynchronously, see File Extract Complete. Most callers should use the Async File Extract superstate instead.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
SourcePath NO The path of the file to be extracted
DestinationDirectory NO The directory to which the archive must be extracted. If the directory does not exist, it will be created.
RESPONSE MESSAGE:
Parameter Name Description / Value

Starts moving a file to the specified destination. The asynchronous response is received later, see File Move Complete. Most users should be using the Async File move SuperState instead. To move the file synchronously, see File Move.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
SourcePath NO The path of the directory to be moved
DestinationPath NO The path of the moved directory. This must be a non existent folder path.
RESPONSE MESSAGE:
Parameter Name Description / Value

Calculates the MD5 checksum of the specified file. The request is made and an asynchronous response is received on completion. Use the 'Async Create MD5 Checksum SuperState' if the input type is FILE

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
checksum
filePath

Notification that the asynchronous calculation of the CRC32 checksum for a file is completed.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
checksum The CRC32 checksum result

Start the asynchronous calculation of the CRC32 checksum for a file.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
filePath NO Path to the file for which the CRC32 checksum is calculated.
RESPONSE MESSAGE:
Parameter Name Description / Value

Calculate the CRC32 Checksum for a file.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
filePath
checksum

Concatenates a parent and a leaf to produce a complete path. This call is platform dependent.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
name NO The final part of the desired concatenated path
parent NO The first part of the desired concatenated path
RESPONSE MESSAGE:
Parameter Name Description / Value
path The resulting concatenated path

Response to the asynchronous folder copy

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value

Response to the asynchronous folder content copy

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value

Copy the contents of the folder to the provided destination folder location. If the destination folder does not exist, it is created.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
dir NO The directory path from which to copy the contents
destinationDir NO The directory path to copy the contents to. If it doesn't exist, it will be created. If it exists, its contents will be merged with the contents of the source direcotry.
RESPONSE MESSAGE:
Parameter Name Description / Value

Asynchronously copy the contents of a folder to another folder.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
dir
destinationDir

Copy the folder and its contents to the destination folder. If the destination folder does not exist, it is created.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
dir NO The directory to copy
destinationDir NO The path under which to copy the directory to
RESPONSE MESSAGE:
Parameter Name Description / Value

Asynchronously copy a folder under the destination folder

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
dir
destinationDir

Creates a folder. If the folder exists, returns success. Returns nack if the path exists and is not a folder. Returns nack if the folder create fails.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
dir NO The path of directory to be created
RESPONSE MESSAGE:
Parameter Name Description / Value

Response to the Asynchronous Create MD5 Checksum call indicating completion of md5 hash calculation

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
checksum The resulting MD5 checksum

Deletes all files specified in the provided list. The file paths must be separated by commas with no trailing spaces.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
PathList NO A comma separated list of regular file paths thar must be deletd. No trailing space are allowed betwen file paths.
RESPONSE MESSAGE:
Parameter Name Description / Value

Removes the specified folder from the filesystem

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
dir NO The path of the folder to be deleted
RESPONSE MESSAGE:
Parameter Name Description / Value

Response to the Asynchronous File Archive call indicating completion of the operation

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value

Response to the Asynchronous File Copy call indicating completion of the operation

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value

Copies a file to the specified destination, synchronously. Use the 'Asynchronous File Copy Superstate' to copy large files.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
SourcePath NO The path of the file to be copied
DestinationPath NO The destination of the copied file. If this is a directory, the file will be copied under this directory
RESPONSE MESSAGE:
Parameter Name Description / Value

Deletes a file. Directories are not supported.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The path of the regular file to be deleted
RESPONSE MESSAGE:
Parameter Name Description / Value

Response to the Asynchronous File Extract call indicating completion of the operation

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value

Lists all files inside a directory except subdirectories.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The directory to be listed
RESPONSE MESSAGE:
Parameter Name Description / Value
Result The directory listing

Response to the Asynchronous File Move call indicating completion of the operation

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value

Moves a file to the specified destination, synchronously. Use the 'Asynchronous File Move Superstate' to copy large files.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
SourcePath NO The path of the file to be moved
DestinationPath NO The destination of the file to be moved. If this is a directory the file will be moved under it.
RESPONSE MESSAGE:
Parameter Name Description / Value

Renames a file given by a complete SourcePath to a DestinationName which contains only the new file name. If the given path is a directory it throws an exception.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
SourcePath NO The path of the file to be renamed
DestinationName NO The new name of the file
RESPONSE MESSAGE:
Parameter Name Description / Value

Gets the size, in bytes, of a regular file

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The path of the file. Directories are not supported.
RESPONSE MESSAGE:
Parameter Name Description / Value
FileSize The size of the file in bytes

Returns a List of all the Folders that are children of the given Path. Note that this message returns only the child folders, excluding files. If a given Path desnt denote a folder, it will return an empty list.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The path of the folder to be listed
RESPONSE MESSAGE:
Parameter Name Description / Value
Result The listing of the folder. Includes subdrectories.

Gets the free space of the provided partition. This will not return the folder size of the given path. The Partition Size node can be used with this node to determine the total space used in a given partition.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The path of the partition
RESPONSE MESSAGE:
Parameter Name Description / Value
FreeSpace Free space in bytes of the specified partition

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The ftp url of the file or the folder to be deleted. Ex.: ftp://host/folder1 to delete folder1 and its subfolders. ftp://host/folder1/file1 to delete file1.
Username NO
Password NO
RESPONSE MESSAGE:
Parameter Name Description / Value

FTP Download that works either for files or directories. It supports nested folders. FTP User/Passwd must be provided in the message.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
DestinationPath NO
SourcePath NO
Username NO
Password NO
RESPONSE MESSAGE:
Parameter Name Description / Value

Checks if a FTP path is a directory or a not (a file). FTP User/Passwd must be set in the message.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO
Username NO
Password NO
RESPONSE MESSAGE:
Parameter Name Description / Value
IsDirectory

Uploads a file or a directory to a remote directory. It supports nested directories. FTP User/Passwd must be provided in the message

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
DestinationPath NO
SourcePath NO
Username NO
Password NO
RESPONSE MESSAGE:
Parameter Name Description / Value

Deletes a file or folder remotely on a FTP location. It supports removing nested directories. FTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The ftp url of the file or the folder to be deleted. Ex.: ftp://host/folder1 to delete folder1 and its subfolders. ftp://host/folder1/file1 to delete file1.
RESPONSE MESSAGE:
Parameter Name Description / Value

FTP Download that works either for files or directories. It supports nested folders. FTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
DestinationPath NO The local path where the file will be downloaded to. The filemanager application user must have write access to this folder. Ex.: /content/folder1 which means that SourcePath will be downloaded inside folder1.
SourcePath NO The ftp url of the file or directory to be downloaded. Known issue: Try to download a directory a (or any child) which name has spaces. Ex.: ftp://host/folder1 which means that folder1 and its subfolders will be downloaded inside DestinationPath. ftp://host/folder1/file1 which means that file1 will be downloaded inside DestinationPath.
RESPONSE MESSAGE:
Parameter Name Description / Value

Uploads a file or a directory to a remote directory. For directory, the paramter name pattern would be applied to filter files under it for uploading. It supports nested directories. FTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
DestinationPath NO The ftp url of directory where the local file or directory will be uploaded to. Ex: ftp://host/folder1 which means that SourcePath will be uploaded into folder1.
FileNamePattern NO Regex pattern that used to filter files under directory for uploading to FTP.
SourcePath NO The path to the file or directory that must be uploaded. Ex.: /content/file1 which means that file1 will be uploaded to DestinationPath. /content/folder1 which means that folder1 and its subfolders will be uploaded to DestinationPath.
RESPONSE MESSAGE:
Parameter Name Description / Value

Checks if a FTP path is a directory or a not (a file). FTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The ftp url of the folder or file. Ex: ftp://host/folder1
RESPONSE MESSAGE:
Parameter Name Description / Value
IsDirectory True if the remote file is a directory and false otherwise

Rename file/directory name on remote FTP location. e.g. FromName: ftp://ftp.server.com/path/filename.txt ToName: newFilename.txt

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
FromName NO File name to be renamed from. It should contains the complete path of file/folder including ftp host e.g. ftp://ftp.server.com/path/filename1.txt or ftp://ftp.server.com/path
ToName NO File name to be renamed to, only supports rename in same directory. e.g. new file/directory name
RESPONSE MESSAGE:
Parameter Name Description / Value

FTP Download or Upload that works only for files. If the SourcePath is a FTP location it works as FTP Download. Otherwise, it tests if the DestinationPath is a FTP location and works as FTP Upload. FTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
SourcePath NO The source path, which can be a local file or a remote ftp location Ex: /content/file1 which will upload file1 to DestinationPath ftp://host/folder1/file1 which will download file1 to DestinationPath
DestinationPath NO The destination path, which can be a local file or a remote ftp location. Ex.: /content/download - to use as a download ftp://host/folder1 to use as a upload
RESPONSE MESSAGE:
Parameter Name Description / Value

Uploads a file or a directory to a remote directory. It supports nested directories. FTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
DestinationPath NO The ftp url of directory where the local file or directory will be uploaded to. Ex: ftp://host/folder1 which means that SourcePath will be uploaded into folder1.
SourcePath NO The path to the file or directory that must be uploaded. Ex.: /content/file1 which means that file1 will be uploaded to DestinationPath. /content/folder1 which means that folder1 and its subfolders will be uploaded to DestinationPath.
RESPONSE MESSAGE:
Parameter Name Description / Value

Returns the base name of the input, i.e. the name minus the full path and extension. This call is platform independent

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
path NO The path of the file
RESPONSE MESSAGE:
Parameter Name Description / Value
basename Base name of the path - without the parent or extension

Returns the extension, i.e. the portion of the path after the last period, of the leaf element

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
path NO The file path
RESPONSE MESSAGE:
Parameter Name Description / Value
extension The extension of the file

Returns the name of the file or directory denoted by the specified path

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
path NO Full file path e.g. /content/movie.mpg
RESPONSE MESSAGE:
Parameter Name Description / Value
name File name. For the path /content/movie.mpg the name is movie.mpg

Returns the parent of the specified path (file or directory)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
path NO The file path
RESPONSE MESSAGE:
Parameter Name Description / Value
parent The parent of the file, i.e., the file path without the file name

Response to the asynchronous folder move

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value

Response to the asynchronous folder content move

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value

Move the contents of a folder from the source folder to the destination folder. If the destination folder does not exist, it is created.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
dir NO The directory path from which to move contents
destinationDir NO The new directory path to which to move the contents
RESPONSE MESSAGE:
Parameter Name Description / Value

Asynchronously move the contents of a folder to a destination folder.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
dir
destinationDir

Move a folder and its contents to a new parent folder (retaining the name of the folder being moved). If the destination parent folder does not exist, it is created.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
dir NO The directory to move
destinationDir NO The path under which to move the directory to
RESPONSE MESSAGE:
Parameter Name Description / Value

Asynchronously move the folder and its contents under a new parent folder.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
dir
destinationDir

Gets the size of a partition in bytes. If the specified path is not a partition, returns the size of the containing partition.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The path of the partition
RESPONSE MESSAGE:
Parameter Name Description / Value
Size The size of the partitioin in bytes

Message is used to download a file from HTTP/HTTPS url

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Url NO HTTP/HTTPS url pointing to the file to download
DestinationPath NO Destination folder where the file will be downloaded
RESPONSE MESSAGE:
Parameter Name Description / Value
Path linux path where the file is downloaded

Deletes a file or folder remotely on a SFTP location. It supports removing nested directories. SFTP User/Passwd are now passed as parameters.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The sftp url of the file or the folder to be deleted. Ex.: sftp://host/folder1 to delete folder1 and its subfolders. sftp://host/folder1/file1 to delete file1.
Username NO The username to login in the SFTP Server
Password NO The password to login in the SFTP Server
RESPONSE MESSAGE:
Parameter Name Description / Value

Uploads a file or a directory to a remote directory using SFTP. It supports nested directories. SFTP User/Passwd are now passed as parameters.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Username NO The username to login in the SFTP Server
Password NO The password to login in the SFTP Server
SourcePath NO The path to the file or directory that must be uploaded. Ex.: /content/file1 which means that file1 will be uploaded to DestinationPath. /content/folder1 which means that folder1 and its subfolders will be uploaded to DestinationPath.
DestinationPath NO The sftp url of directory where the local file or directory will be uploaded to. Ex: sftp://host/folder1 which means that SourcePath will be uploaded into folder1.
RESPONSE MESSAGE:
Parameter Name Description / Value

Checks if a File or directory exists on remote SFTP location. SFTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The sftp url of the file or the folder to be checked. Ex.: sftp://host/folder1 to check folder1 sftp://host/folder1/file1 to check file1.
RESPONSE MESSAGE:
Parameter Name Description / Value
IsExisting True if the remote file or directory exists.

Deletes a file or folder remotely on a SFTP location. It supports removing nested directories. SFTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
Path NO The sftp url of the file or the folder to be deleted. Ex.: sftp://host/folder1 to delete folder1 and its subfolders. sftp://host/folder1/file1 to delete file1.
RESPONSE MESSAGE:
Parameter Name Description / Value

Uploads a file or a directory to a remote directory using SFTP. It supports nested directories. SFTP User/Passwd must be configured on filemanager.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
SourcePath NO The path to the file or directory that must be uploaded. Ex.: /content/file1 which means that file1 will be uploaded to DestinationPath. /content/folder1 which means that folder1 and its subfolders will be uploaded to DestinationPath.
DestinationPath NO The sftp url of directory where the local file or directory will be uploaded to. Ex: sftp://host/folder1 which means that SourcePath will be uploaded into folder1.
RESPONSE MESSAGE:
Parameter Name Description / Value

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
source
directory
© 2002 - 2012 Ericsson Television Inc.
All Rights Reserved.