Configure file transfer action

File transfer actions (Category: Asset update actions) enable the Axeda® Platform to write a file to an asset and enable an asset to write a file to the Platform. For example, you can use this action to copy a configuration file from the Platform to an asset, or to copy a log file from an asset to the Platform.

The Platform source or destination locations for the uploaded or downloaded files are configured by your Platform administrator and viewable in the System Configuration page. You should be familiar with the file structure of the asset to which you want to download files or from which you are uploading files.

To configure File Transfer actions

1. From the Transfer Direction box, select how this File Transfer action operates, as follows:

Upload files from asset - Copy a specified file from an asset to the Platform.

Download files to asset - Copy a specified file from the Platform to an asset.

2. If this action will upload files from the asset, complete the parameters as follows:

Source File(s) - type the fully-qualified path and file name(s) to upload from the asset. For Axeda IDM Agents, this path is the logical path, defined in the FileRepository configuration for the agent. For more information, refer to the user guide for your IDM Agents and to the topic, IDM Agent FileRepository Configuration Example.

Target Directory - type the name of the new file to create on the Platform.

§ This file will be created in the path and folder identified by your Platform administrator. The default path and folder is <installation/servicelink/upload>.

§ Make sure to include any subfolder names if you want to create the file in a subfolder of the main upload folder specified by your Platform administrator.

3. If this action will download files from the Platform to the asset, complete the parameters as follows:

Source File(s) - type the name of the file to download from the Platform.

§ This file must be in the path and folder identified by your Platform administrator. The default path and folder is <installation/servicelink/upload. If the default path and folder were modified, make sure the download files are in the correct location.

§ Make sure to include any subfolder names if the file to download is not located in the download folder specified by your Platform administrator.

Target Directory - type the fully-qualified path and new file name to create on the asset. For Axeda IDM Agents, this path is the logical path, defined in the FileRepository configuration for the agent. For more information, refer to the user guide for your IDM Agents and to the topic, IDM Agent FileRepository Configuration Example.

4. For File Transfer actions that download a file, select the Restart Agent (Downloads only) check box if the Agent should restart on the asset after the download. Note that the Axeda IDM Agents do not support this feature.

5. When you are finished, click Next to select the user groups with edit permissions for this action. If you click Finish, the action confirmation page appears. If you click Cancel and continue canceling, all information configured in this wizard is removed.

Note: If you type invalid source or destination directories, an error appears. When you click OK in the error message window, the "Select an action to view or edit its properties" page appears. You'll need to use the New - Action menu to create the File Transfer action again with the correct directory locations.

Tips

o If transferring files in a clustered server environment, each server in the cluster should contain the same directory structure (as specified by your Platform administrator) and the same files; or the required directories should be available on the network share for the servers.

The source file must exist somewhere under the download base directory.
You can specify a relative path name, for example, upgrades\newfile.dat. This path name will be appended to the base directory, for example, \servicelink\download\upgrades\newfile.dat
You can specify a full path name, as long as the path resolves to a folder underneath the download base.
You cannot use directory uplevel/escape characters (that is, "..") as part of the path to indicate a file outside of the base directory.
You must provide a source file. This file must be readable and cannot be a directory.
If the target path that you specify ends in a directory separator character, such as /' or \', then the source file name will be appended to the target.
You can use wildcard characters (*' and ?') as part of the source file name. A file transfer for every non-empty file matching the wildcard specification is defined. For example, a source file of "data\*.txt" will queue transfers for all text files in the folder "data".
If using wildcards, the target path is appended with the name of each source file found.

You cannot use wildcard characters in the target name.
You can define relative paths. Any relative path is appended to the asset's base directory path. The asset base path is the configured upload base directory then concatenated with the asset model number and serial number. For example, if the asset has model and serial numbers of ModelA' and Serial123', and the target path is logs\alarm.log', then the source file will be copied to:
\servicelink\upload\ModelA\Serial123\logs\alarm.log'
The target path directories do not have to exist; the upload process will create any required but missing directories.
Make sure the target path resolves to a path underneath the asset upload base path.
Do not use directory escape characters (such as ..') to specify a target outside of the asset base path.
If the target is a file, it will be created. If the target file already exists, it will be overwritten.
If the target is a directory, then the source file name will be appended to the target path.

o In the Axeda® Service application, Asset dashboard Rules module, you can view and enable or disable the rules configured for a specific asset.

o The Service application, Asset dashboard Audit Log module, shows a log of activity for the selected asset, including registration, actions run, alarms acknowledged, statuses, usage value setting, and more. Also, if you have privileges to the Administration application, you can search the Audit log for asset, Platform, and user activity.

Action wizard - Configure file transfer action

To configure File Transfer actions

Tips