Parameter | Description |
transportName | Name of the transport being used within the File adapter. This must match the transport name specified in the IAF configuration file so that the transport can recognize events intended for it. |
requestId | Request identifier for this open file event. The response, which is either a FileHandle event or a FileError event, contains this identifier. |
codec | Name of the codec to use with the file. This must match one of the codecs specified in the adapter-static.xml IAF configuration file. When you want the File adapter to read and write entire lines of data just as they are, specify the null codec (JNullCodec). When you want the File adapter to interpret file lines in some way, you can specify either the CSV codec (JCSVCodec) or the Fixed Width codec (JFixedWidthCodec) according to how the data in the file is formatted. To open fixed width or CSV files, you must add some information to the payload field of the OpenFileForReading event. The codecs needs this information to correctly interpret the data. For details about adding to the payload field, see Opening comma separated values (CSV) files or Opening fixed width files. |
filename | Absolute path, or file pattern (for example, *.txt, *.csv) within absolute directory path if intending to read all files matching a pattern in order of last time modified.While a relative path might work, an absolute path is recommended. A relative path must be relative to where the IAF has been started, which can be unpredictable. For example: c:\logfiles\*.log /user/local/jcasablancas/logfiles/*.log For more information, see Specifying file names in OpenFileForReading events. |
linesInHeader | The number of lines in the header, or 0 if there is no header.Text files sometimes contain a number of lines at the beginning of the file that explain the format. As these are usually of some specific format, the Apama File adapter cannot interpret them. By skipping these lines, the File adapter can process just the data contained in the file. |
acceptedLinePattern | Regular expression pattern (in the same format used by Java) to use to match lines to read. The File adapter reads only those lines that match this pattern. To read all lines, specify an empty string. |
payload | String dictionary for storing extra fields for use with codecs. For fixed width files the following fields make up the payload; for other types of files, they will be ignored.  sequence<integer> fieldLengthsThe length (number of characters) in each field, in order, where the number of fields is given by fieldLengths.size() boolean isLeftAlignedWhether the data in the field is aligned to the left or not (that is, right aligned) string padCharacterThe pad character used when the data is less than the width of the field For CSV files, the following field makes up the payload; for other types of files it will be ignored. string separatorThe separator character |