Properties
The FileReader module has the following properties:
| Name | Description | ID | Flags |
|---|---|---|---|
| Alarm command | The command executed when there hasn't been any file update in 'TimeToAlarm' milliseconds in the specified directory. This typically is the full path to an executable or similar. | 1610 | Persisted, ExpertPage |
| Alarm command parameters | The parameters sent to the command in 'Alarm command'. | 1620 | Persisted, ExpertPage |
| Completion port handle | The handle of the I/O completion port in use. | 50120 | InfoPage |
| Directory handle | The handle of the monitored directory. | 50110 | InfoPage |
| FileChangeTimeout | The maximum amount of milliseconds to wait for a file change notification to occur before the directory is manually scanned for filechange(s). | 1350 | Persisted, Enumerated, ExpertPage |
| FileChangeToParseDelay | A delay in milliseconds indicating how long to wait from a file is detected as changed until it is actually being parsed by the FileParserObject. | 1400 | Persisted, ExpertPage |
| Filename Pattern | A filename pattern including the path for files that will be sent to the parser | 1150 | Persisted, File |
| FileParser | The ProgID identifying the parser component used by this module when parsing the file(s). | 1300 | Persisted, Enumerated, ProgID |
| FileReader trace file1 | If set, internal file update handling of the ApisFileReaderBee will be traced to this file. Should only be used for short time periods and for verbose troubleshooting of file update dynamics. | 2000 | Persisted, File, ExpertPage |
| LastFileChangeTime | The time of the last notification of a matching file-change the module has registered. | 100000 | PerformancePage |
| LastFileParserFileName | The name of file last parsed. | 103000 | PerformancePage |
| LastFileParserFileTimeUsage | The time used by the file-parser to handle last file update. | 102000 | PerformancePage |
| LastUpdatedItemCount | The number of items updated by the last file-change notification. | 101000 | PerformancePage |
| ScanDirectoryOnStart | If true, the SourceDirectory will be scanned once upon startup to look for matching files, if false directory will be scanned on startup but depend on directory changes and/or FileChangeTimeout for first scan. | 1340 | Persisted, ExpertPage |
| SourceDirectory | The directory which the module shall monitor for file changes. | 1100 | Persisted, Hidden, Folder |
| TimeToAlarm | The time in milliseconds that the module delays when lack of fileupdates until the alarm action specified in the 'Alarm command' property is executed. | 1600 | Persisted, ExpertPage |
| UseApisTime | Use Apis timestamps instead of the timestamps given by the parser component. | 1500 | Persisted, ExpertPage |
Additional FileReader properties, shared with the specific:
| Name | Description | ID | Flags |
|---|---|---|---|
| FavorArrayItems | When 'true', the module tell it's file parser object to use vector and matrices as item types when applicable. | 10000 | Persisted, ExpertPage |
| Database login | Same as User ID in connection string. If blank, integrated security will be used. | 10005 | Persisted, User, ExpertPage |
| Database login password | Used when Database login is other than blank. | 10006 | Persisted, Password, ExpertPage |
| Database name | The name of the database on given server, used in connection string. | 10004 | Persisted, ExpertPage |
| Database server | The server machine where the database exists, used in connection string. | 10003 | Persisted, ExpertPage |
| FileParser debug trace file | If specified, the complete filename of a tracefile used for debugging from parsers. Whether or not a file is generated, is parser specific behavior. If empty, no tracefile will be used. | 10009 | Persisted, File, ExpertPage |
| Honeystore database | If applicable, the name of the Honeystore database to use for parser component. | 10008 | Persisted, ExpertPage |
| Locale ID | The locale ID to be used when parsing files. | 10001 | Persisted, ExpertPage |
| Offset from UTC | The offset from UTC can be used by the parser component when handling files. Norwegian timezone is +60. | 10002 | Persisted, ExpertPage |
| Parser specific enum | This property may have meaning for some types of parsers, other may not use it. | 10007 | Persisted, DynamicEnumeration, ExpertPage |
See also Module Properties 1: FileReader trace file has default a maximum count of 10 files with maximum size of 64 MB, other values can be specified in the module specific registry key using DWORD values TraceToFileMaxCount and TraceToFileMaxSize