Skip to content

Commit 7eb0578

Browse files
authored
fix: update readme to have proper wordings (#9)
- README been reviewed or updated in light of what we are adding to the converter and transformation documentation cards Signed-off-by: Joel Hanson <[email protected]>
1 parent 11a6344 commit 7eb0578

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,64 @@
1-
# kafka-connect-xml-converter
1+
# Kafka Connect XML converter and transformation plug-ins
22

3-
A Kafka Connect plugin to make it easier to work with XML data in Kafka Connect pipelines.
3+
The Kafka Connect XML converter and transformation plug-ins make it easier to work with XML data in Kafka Connect pipelines.
44

55
## Contents
66

77
- `com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlConverter`
8-
- a Kafka Connect converter for converting to/from XML strings
8+
A Kafka Connect converter for converting between structured objects (Kafka Connect's internal data format, and Java Maps and Lists) and XML strings.
99
- `com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlTransformation`
10-
- a Kafka Connect transformation for converting Kafka Connect records to/from XML strings
10+
A Single Message Transform (SMT) that takes a Kafka Connect record containing an XML string and transforms it into a structured Connect record.
1111
- `com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlMQRecordBuilder`
12-
- an MQ Source Record builder for parsing MQ messages containing XML strings
12+
An MQ Source Record builder for parsing MQ messages containing XML strings.
1313

1414
## Configuration
1515

16-
Optional configuration that can be set when using the plugin to turn XML strings into Connect records (XML string -> Conect Record)
16+
The following table lists optional configuration that can be set when turning XML strings into Connect records by using the plug-ins (XML string to Connect record).
1717

18-
| **Option** | **Default value** | **Notes** |
19-
| --------------------- | ----------------- | --------------------------------------------------------------------------------------- |
20-
| `root.element.name` | `root` | The name of the root element in the XML document being parsed. |
21-
| `xsd.schema.path` | | Location of a schema file to use to parse the XML string. |
22-
| `xml.doc.flat.enable` | `false` | Set to `true` if the XML strings contain a single value (e.g. `<root>the message</root>`) |
18+
| **Option** | **Default value** | **Notes** |
19+
| --------------------- | ----------------- | ------------------------------------------------------------------------------------------------- |
20+
| `root.element.name` | `root` | The name of the root element in the XML document that is being parsed. |
21+
| `xsd.schema.path` | | The location of the schema file to use when parsing the XML string. |
22+
| `xml.doc.flat.enable` | `false` | Set to `true` if the XML strings contain a single value (for example, `<root>the message</root>`) |
2323

24-
Optional configuration that can be set when using the plugin to create XML strings from Connect records (Conect Record -> XML string)
24+
The following table lists optional configuration that can be set when turning Connect records into XML strings by using the plug-ins (Connect Record to XML string)
2525

2626
| **Option** | **Default value** | **Notes** |
2727
| ------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
2828
| `root.element.name` | `root` | The name to use for the root element of the XML document being created. Only used when no name can be found within the schema of the Connect record. |
2929

3030
## Example uses
3131

32-
Use **`XmlConverter`** with Source Connectors to produce structured Connect records to Kafka topics as XML strings.
32+
Use **`XmlConverter`** with source connectors to produce structured Connect records to Kafka topics as XML strings.
3333

3434
```properties
3535
value.converter=com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlConverter
3636
value.converter.schemas.enable=false
3737
```
3838

39-
Use **`XmlConverter`** with Source Connectors to produce Connect records to Kafka topics as XML strings, with an embedded XSD schema. (requires structs)
39+
Use **`XmlConverter`** with source connectors to produce Connect records to Kafka topics as XML strings, with an embedded XSD schema (requires structured objects).
4040

4141
```properties
4242
value.converter=com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlConverter
4343
value.converter.schemas.enable=true
4444
```
4545

46-
Use **`XmlTransformation`** with Sink Connectors to convert a Connect record containing an XML string into a structured Connect record.
46+
Use **`XmlTransformation`** with sink connectors to convert a Connect record containing an XML string into a structured Connect record.
4747

4848
```properties
4949
transforms=xmlconvert
5050
transforms.xmlconvert.type=com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlTransformation
5151
transforms.xmlconvert.converter.type=value
5252
```
5353

54-
Use **`XmlConverter`** with the MQ Sink Connector to send non-XML Kafka messages to MQ queues as XML strings.
54+
Use **`XmlConverter`** with the IBM MQ sink connector to send non-XML Kafka messages to MQ queues as XML strings.
5555

5656
```properties
5757
mq.message.builder=com.ibm.eventstreams.connect.mqsink.builders.ConverterMessageBuilder
5858
mq.message.builder.value.converter=com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlConverter
5959
```
6060

61-
Use **`XmlMQRecordBuilder`** with the MQ Source Connector to convert XML strings from MQ queues into Connect records.
61+
Use **`XmlMQRecordBuilder`** with the IBM MQ source connector to convert XML strings from MQ queues into Connect records.
6262

6363
```properties
6464
mq.record.builder=com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlMQRecordBuilder
@@ -68,11 +68,11 @@ mq.record.builder.xsd.schema.path=/location/of/mq-message-schema.xsd
6868

6969
## Adding the IBM MQ Source Connector JAR to the Project
7070

71-
To build the project, you need to pull and install the latest IBM MQ Source Connector JAR. Follow these steps:
71+
To build the project, you need to pull and install the latest IBM MQ source connector JAR. Follow these steps:
7272

7373
1. **Download the MQ Source Connector JAR**
7474

75-
Download the latest version of the MQ Source Connector JAR from the official IBM GitHub releases page:
75+
Download the latest version of the IBM MQ source connector JAR from the official IBM GitHub releases page:
7676

7777
```bash
7878
curl -L -o kafka-connect-mq-source-<VERSION>.jar https://github.com/ibm-messaging/kafka-connect-mq-source/releases/download/v<VERSION>/kafka-connect-mq-source-<VERSION>.jar

0 commit comments

Comments
 (0)