FileDelete node

The FileDelete plug-in icon

This page contains information on:

The File Delete plug-in node receives a delete action message and then it removes the file. A status message is propagated to the "status" terminal to confirm the success of the delete action.

If an error condition is detected, an exception message is propagated to the "failure" terminal (if the "failure" terminal is not wired then a user exception is thrown to terminate the processing).

Copies of the action and status messages are maintained in the Environment tree of the message flow.

FileDelete node terminals

action

Input terminal receives the action control messages to open and close the file.

failure

Output terminal to which an exception message is propagated in case that the node detects an error exception.

status

Output terminal to which status messages are propagated when the file is opened or closed.

Using the FileDelete node

This node receives the delete file action message on the action terminal.

Delete action message

The following is the format of this action message:

[M]<FileAdapter>
[M]      <Filename>'string'
[M]           <Action>DELETE</Action>
[M]           <Type>OUTPUT</Type>
[M]      </Filename>
[M]</FileAdapter>

Note: [M] is a mandatory element and [O] is an optional element.

Status message

If the deletion is successful an status message if propagated to the status terminal. The following is the format of the status message:

<FileAdapter>
     <Filename>'string'
          <Status>DELETED</Status>
          <Type>OUTPUT</Type>
          <TimeFileDeleted>timestamp</TimeFileDeleted>
     </Filename>
</FileAdapter>

Exception messages

An exception message is propagated to the failure terminal when an error exception is detected by the File Delete plug-in node. The following is the format of the exception messages:

Exception when the action message is invalid

<FileAdapter>
               <Exception>FileDelete</Exception>
               <ErrorText>string</ErrorText>
               <TimeException>timestamp</TimeException>
</FileAdapter>

Exception when system functions return errors

<FileAdapter>
         <Filename>'string'
               <Exception>FileDelete</Exception>
               <Function>remove</Function>
               <ErrorNumber>integer</ErrorNumber>
               <ErrorText>string</ErrorText>
               <TimeException>timestamp</TimeException>
          </Filename>
</FileAdapter>

FileDelete node properties

All the following properties are on the Default tab

Property	Default	Description
Generate debug data	None	This property can have the values of "None", "Performance" or "Full". The "Performance" option is the same as the "None" option for the File Delete. The "Full" option generates debugging and trace information.
Trace Filename		Path and name of the trace file. If no trace file is specified then the debugging information is sent to the broker's stdout.

action	Input terminal receives the action control messages to open and close the file.
failure	Output terminal to which an exception message is propagated in case that the node detects an error exception.
status	Output terminal to which status messages are propagated when the file is opened or closed.