Processor able to write data to industrial PLCs using Apache PLC4X
plc4x, sink, write
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Connection Pool Service | connection-pool-service | Controller Service API: PLC4XConnectionPool Implementations: GenericPLC4XConnectionPool ProxyPLC4XConnectionPool StandardPLC4XConnectionPool | The Controller Service that is used to obtain connection to the PLC device. | |
| Record Reader | record-reader | Controller Service API: RecordReaderFactory Implementations: IPFIXReader EBCDICRecordReader SyslogReader XMLReader WindowsEventLogReader YamlTreeReader JASN1Reader CEFReader ReaderLookup JsonTreeReader AvroReader JsonPathReader Syslog5424Reader CSVReader GrokReader CiscoEmblemSyslogMessageReader ExcelReader ScriptedReader ParquetReader | Specifies the Controller Service to use for reading record from a FlowFile. The Record Reader may use Inherit Schema to emulate the inferred schema behavior, i.e. an explicit schema need not be defined in the reader, and will be supplied by the same logic used to infer the schema from the column types. | |
| Record Writer | record-writer | Controller Service API: RecordSetWriterFactory Implementations: ScriptedRecordSetWriter CSVRecordSetWriter FreeFormTextRecordSetWriter AvroRecordSetWriter ParquetRecordSetWriter XMLRecordSetWriter JsonRecordSetWriter RecordSetWriterLookup | Specifies the Controller Service to use for writing results to a FlowFile. The Record Writer may use Inherit Schema to emulate the inferred schema behavior, i.e. an explicit schema need not be defined in the writer, and will be supplied by the same logic used to infer the schema from the column types. | |
| Request Timeout | request-timeout | 10 seconds | The maximum amount of time allowed for reading data from PLC. Fraction of milliseconds are rounded up. |
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| Record field name, or RecordPath expression | Address of the register to be written to. RecordPath expression is accepted inside a %{} block. | Address Map for linking record fields to PLC registers. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
| Name | Description |
|---|---|
| original | The original FlowFile that was attempted to be sent to the PLC device. |
| failure | An error occurred while processing |
| success | Successfully processed |
| Name | Description |
|---|---|
| plc4x.write.row.count | Number of rows from the input FlowFile, attempted to be written into the PLC |
| plc4x.write.error.count | Number of rows from the input FlowFile, failed to be written into the PLC |