Skip to content

Commit 00a71be

Browse files
committed
readme adjustments
1 parent b126140 commit 00a71be

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,39 +90,43 @@ and the JSONata expression `Phone.{type: number}`, an object constructor, the ac
9090
```Split Property``` - use this field to choose a separator.
9191

9292
### Re-assemble Messages
93-
**(Beta)**
9493

9594
Inverse of the split action: Given a stream of incoming messages a sum message is generated.
9695
Has 3 different behaviour variants:
9796
* Only specify group size and no delay timer. A message is emitted once the group size is reached for the given group. Should less message then the given group size arrive, then the group is silently discarded.
9897
* Only specify delay timer and no group size. All incomming messages count towards the delay timer. Once no more message is received in this time frame there will be a emitted message for each group.
9998
* Specify both group size and delay timer. Groups that have reached their limit are emitted directly. Beyond that the action behaves as specifed in the line before.
99+
100100
Supported:
101101
* Messages can be re-ordered in the flow
102102
* If messages are re-delivered as a result of the platform's at once delivery guarantee, does not trigger false positives
103103
* Messages from one original message can be interleaved with messages from another original message
104104
(e.g. Two overlapping webhook calls arrive and the flow has components where parallel processing > 1.)
105+
105106
Limitations:
106107
* All groups must have one or more messages. (i.e. No groups of size 0).
107-
Can't do re-grouping when a split is done on an empty array. (i.e. No empty for each pattern supported)
108-
* If all messages in a group fail to arrive at the re-assemble action (because one message suffered an error earlier in the flow)
109-
then this component will silently discard the group.
108+
Can't do re-grouping when a split is done on an empty array. (i.e. No empty for each pattern supported).
110109
* All messages must arrive within the same container lifetime.
111110
If at any point there is more than a 15 second gap in messages, then the group will be silently discarded.
112111
* The group is dropped if there are any unexpected restarts to the container.
113112
* In case only a groupSize is given and no delay timer is specified. The size of the group must be known by all group members.
114113
* In case of using the delay timer. Messages are only emitted when all parts arrive. Emitting a message only when the first part arrives isn't supported.
115114
* The delay timer can not exceed 40,000 milliseconds. If more than this maximum is given, then this maximum will be used instead.
115+
116116
#### List of Expected Config fields
117117
```groupId``` - Globally unique id for the group to distinguish it from other groups. This value needs to be the same for all messages in a group.
118+
118119
```messageId``` - Id for a message to distinguish it from other messages in the group.
119120
Must be unique per group but does not have to be globally unique. This value needs to be different for all messages in a group.
121+
120122
```messageData``` - Data from individual messages can be inserted here in form of an object. This object is then inserted into an array which is available in the message emitted for this group.
123+
121124
```groupSize``` - Number of messages in the group.
125+
122126
```Delay timer (in ms)``` - Time the process waits when no incoming messages before emiting (Max 40,000 milliseconds)
123127

124128
## Known limitations (common for the component)
125-
No.
129+
None.
126130

127131
## Documentation links
128132
More information and some examples can be found here: [Splitter documentation](https://www.elastic.io/connectors/splitter-integration/).

0 commit comments

Comments
 (0)