The FileRename plug-in icon
The File Rename plug-in node receives a rename action message with the old and new file names and then it changes the file name. A status message is propagated to the "status" terminal to confirm the success of the rename action. If the new file name, in the action message, is a relative GDG file name (GDG.STEM(+1)) then the absolute GDG name (GDG.STEM.G00nnV00) is included in the status message as the new file name.
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 action and status messages are maintained in the Environment tree of the message flow.
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. |
This node receives the rename file action message on the action terminal.
The following is the format of this action message:
[M]<FileAdapter>Note:
[M] is a mandatory element and [O] is an optional element.
If the rename is successful an status message if propagated to the status terminal. The following is the format of the status message:
<FileAdapter>An exception message is propagated to the "failure" terminal when an error exception is detected by the File Rename plug-in node. The following is the format of the exception messages:
<FileAdapter>
<Filename>'string'
<Exception>FileRename</Exception>
<Function>rename</Function>
<NewFilename>string</NewFilename>
<ErrorNumber>integer</ErrorNumber>
<ErrorText>string</ErrorText>
<TimeException>timestamp</TimeException>
</Filename>
</FileAdapter>
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 Rename. 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. |