Skip to content

Commit

Permalink
style(formatting): some minor grammar tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
christinaausley committed Jun 5, 2024
1 parent aba9a27 commit 0c780ee
Show file tree
Hide file tree
Showing 9 changed files with 72 additions and 72 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ The Amazon EventBridge Webhook Connector supports four types of authorization:

Select the appropriate authorization type based on your security requirements and fill in the corresponding properties accordingly.

### Fill properties in the **Activation** and **Correlation** sections
### Fill out the properties in the **Activation** and **Correlation** sections

1. (Optional) Configure the **Activation Condition**. This condition will be used to filter the events from the specified event source. For example, if an incoming Amazon EventBridge event has the following body:

Expand Down Expand Up @@ -197,7 +197,7 @@ This condition will trigger the Amazon EventBridge Webhook Connector only when t

- **Correlation key (payload)** is a FEEL expression used to extract the correlation key from the incoming message. This expression is evaluated in the Connector Runtime, and the result is used to correlate the message.

- **Message ID expression** and **Message TTL** are optional properties that can be used to set the message ID and time-to-live for the incoming message. Refer to the [Message ID expression](#message-id-expression) and [Message TTL](#message-ttl) sections for more information.
- **Message ID expression** and **Message TTL** are optional properties that can be used to set the message ID and time-to-live for the incoming message. Refer to the [message ID expression](#message-id-expression) and [message TTL](#message-ttl) sections for more information.

For example, if your correlation key is defined with a process variable named `myCorrelationKey`, and you want to correlate by the `shipment` property in the request detail, which contains:

Expand Down Expand Up @@ -225,13 +225,12 @@ your correlation key settings will look like this:

#### Message ID expression

The **Message ID expression** is an optional field that allows you to extract the message ID from the incoming message. Message ID serves as a unique identifier for the message and is used for message correlation.
The **Message ID expression** is an optional field that allows you to extract the message ID from the incoming message. The message ID serves as a unique identifier for the message and is used for message correlation.
This expression is evaluated in the Connector Runtime and the result is used to correlate the message.

In most cases, it is not necessary to configure the **Message ID expression**. However, it is useful if you want to ensure message deduplication or achieve certain message correlation behavior.
Learn more about how message IDs influence message correlation in the [messages guide](../../../concepts/messages#message-correlation-overview).
In most cases, it is not necessary to configure the **Message ID expression**. However, it is useful if you want to ensure message deduplication or achieve a certain message correlation behavior. Learn more about how message IDs influence message correlation in the [messages guide](../../../concepts/messages#message-correlation-overview).

For example, if you want to set the message ID to the value of the `detail.transactionId` field in the incoming event, you can configure the **Message ID expression** as follows:
For example, if you want to set the message ID to the value of the `detail.transactionId` field in the incoming event, configure the **Message ID expression** as follows:

```
= request.body.detail.transactionId
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,15 +113,15 @@ a BPMN process triggered by an [Amazon SNS](https://console.aws.amazon.com/sns/h
2. Set the **Allow to receive messages from topic(s)** value to **any** if the process may be triggered by any topic, or **Specific topic(s)** if you wish to allow-list only certain topics to start a new BPMN process.
3. If you have chosen the **Specific topic(s)**, you have to list comma-separated topics in the field **Topic ARN(s)** as well. In that case, the **Amazon SNS inbound Connector** will auto-approve each qualified subscription request.
4. In the section **Activation**, configure **Condition** when the Amazon SNS topic can trigger a new BPMN process. The following example will trigger a new BPMN process for every notification with a subject _Start BPMN_: `=(request.body.Subject = "Start BPMN")`.
5. In the section **Output mapping** fill the field **Result variable** to store the response in a process variable. For example, `myResultVariable`. Alternatively, you can fill the field **Result expression** to map specific fields from the response into process variables using [FEEL](/components/modeler/feel/what-is-feel.md).
The following example will extract both message and subject from Amazon SNS message: `={message: request.body.Message, subject: request.body.Subject}`.
5. In the **Output mapping** section, fill in the **Result variable** field to store the response in a process variable. For example, `myResultVariable`. Alternatively, fill in the **Result expression** field to map specific fields from the response into process variables using [FEEL](/components/modeler/feel/what-is-feel.md).
The following example will extract both the message and subject from an Amazon SNS message: `={message: request.body.Message, subject: request.body.Subject}`.

### Correlation

The **Correlation** section allows you to configure the message correlation parameters.

:::note
The **Correlation** section is not applicable for the plain **Start Event** element template of the Amazon SNS Connector. Plain **Start Events** are triggered by process instance creation and do not rely on message correlation.
The **Correlation** section is not applicable for the plain **start event** element template of the Amazon SNS Connector. Plain **start events** are triggered by process instance creation and do not rely on message correlation.
:::

#### Correlation key
Expand All @@ -144,7 +144,7 @@ This expression is evaluated in the Connector Runtime and the result is used to
In most cases, it is not necessary to configure the **Message ID expression**. However, it is useful if you want to ensure message deduplication or achieve certain message correlation behavior.
Learn more about how message IDs influence message correlation in the [messages guide](../../../concepts/messages#message-correlation-overview).

For example, if you want to set the message ID to the value of the `attrName1` attribute in the incoming event, you can configure the **Message ID expression** as follows:
For example, if you want to set the message ID to the value of the `attrName1` attribute in the incoming event, configure the **Message ID expression** as follows:

```
= request.body.MessageAttributes.attrName1.Value
Expand Down
32 changes: 17 additions & 15 deletions docs/components/connectors/out-of-the-box-connectors/amazon-sqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,31 +126,31 @@ To configure the SQS inbound Connector and receive messages from your SQS Queue,
4. In the **Message polling properties** section, set the polling wait time. This is the duration (in seconds) for which the call waits for a message to arrive in the queue before returning. Refer to the [Amazon documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html) for more details.
5. (Optional) In the **Use next attribute names for activation condition** section, set an array of **Attribute names** or **Message attribute name** (e.g., `["attributeName1", "attributeName2"]`) to receive messages from the queue with specific metadata. Alternatively, you can leave it empty to get results with all available attributes. Learn more about message metadata [here](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html).
6. (Optional) Configure the **Activation Condition**. For example, if an external message has the body `{"messageId": 1, "body": "Hi team", "messageAttributes":{"key":{"stringValue":"value"}}...}`, the **Activation Condition** value might look like `=(messageAttributes.key.stringValue="value")`. Leave this field empty to receive all messages every time.
7. Set **Output mapping**. For example, to get only the message body, you can set `{resultBody: body}` in the **Result expression**. Learn more about **Output mapping** [here](../use-connectors/index.md).
7. Set the **Output mapping**. For example, to get only the message body, you can set `{resultBody: body}` in the **Result expression** field. Learn more about **Output mapping** [here](../use-connectors/index.md).

### Activation condition

**Activation condition** is an optional FEEL expression field that allows for the fine-tuning of the Connector activation.
**Activation condition** is an optional FEEL expression field that allows for fine-tuning of the Connector activation.
For example, if an external message has the body `{"messageId": 1, "body": "Hi team", "messageAttributes":{"key":{"stringValue":"value"}}...}`, the **Activation Condition** value might look like `=(messageAttributes.key.stringValue="value")`. Leave this field empty to receive all messages every time.

By default, messages with unmatched activation conditions are not deleted from the queue. They become available for consumers again after the visibility timeout expires. You can set up a dead-letter queue where messages are forwarded after a certain number of delivery attempts.

You can also configure the Amazon SQS inbound Connector to delete messages from the queue if they don't match the activation condition. In this case, the message will not end up in the dead-letter queue.
To delete messages that don't match the activation condition, check the **Consume unmatched events** checkbox.
To delete messages that don't match the activation condition, check the **Consume unmatched events** box.

| **Consume unmatched events** checkbox | Activation condition | Outcome |
| ------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------ |
| Checked | Matched | Message is removed from the queue |
| Unchecked | Matched | Message is removed from the queue |
| Checked | Unmatched | Message is removed from the queue |
| Unchecked | Unmatched | Message is not removed from the queue and will be redelivered or placed in the dead-letter queue |
| **Consume unmatched events** box | Activation condition | Outcome |
| -------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------ |
| Checked | Matched | Message is removed from the queue |
| Unchecked | Matched | Message is removed from the queue |
| Checked | Unmatched | Message is removed from the queue |
| Unchecked | Unmatched | Message is not removed from the queue and will be redelivered or placed in the dead-letter queue |

### Correlation

The **Correlation** section allows you to configure the message correlation parameters.

:::note
The **Correlation** section is not applicable for the plain **Start Event** element template of the Amazon SQS Connector. Plain **Start Events** are triggered by process instance creation and do not rely on message correlation.
The **Correlation** section is not applicable for the plain **start event** element template of the Amazon SQS Connector. Plain **start events** are triggered by process instance creation and do not rely on message correlation.
:::

#### Correlation key
Expand Down Expand Up @@ -198,7 +198,7 @@ Learn more about correlation keys in the [messages guide](../../../concepts/mess

#### Message ID expression

The **Message ID expression** is an optional field that allows you to extract the message ID from the incoming message. Message ID serves as a unique identifier for the message and is used for message correlation.
The **Message ID expression** is an optional field that allows you to extract the message ID from the incoming message. The message ID serves as a unique identifier for the message and is used for message correlation.
This expression is evaluated in the Connector Runtime and the result is used to correlate the message.

In most cases, it is not necessary to configure the **Message ID expression**. However, it is useful if you want to ensure message deduplication or achieve certain message correlation behavior.
Expand All @@ -217,11 +217,13 @@ The value is specified as an ISO 8601 duration. For example, `PT1H` sets the TTL

### Deduplication

The **Deduplication** section allows you to configure the connector deduplication parameters.
Not to be confused with message deduplication, connector deduplication is a mechanism in the Connector Runtime that determines how many SQS subscriptions are created if there are multiple occurrences of the **Amazon SQS Consumer Connector** in the BPMN diagram.
By default, the connector runtime deduplicates connectors based on properties, so elements with the same subscription properties only result in one subscription. Learn more about deduplication in the [deduplication guide](../use-connectors/inbound.md#connector-deduplication).
The **Deduplication** section allows you to configure the Connector deduplication parameters.

If you want to customize the deduplication behavior, you can check the **Manual mode** checkbox and configure the custom deduplication ID.
Not to be confused with **message deduplication**, **Connector deduplication** is a mechanism in the Connector Runtime that determines how many SQS subscriptions are created if there are multiple occurrences of the **Amazon SQS Consumer Connector** in the BPMN diagram.

By default, the Connector runtime deduplicates Connectors based on properties, so elements with the same subscription properties only result in one subscription. Learn more about deduplication in the [deduplication guide](../use-connectors/inbound.md#connector-deduplication).

To customize the deduplication behavior, check the **Manual mode** checkbox and configure the custom deduplication ID.

## Activate the SQS inbound Connector

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -313,12 +313,12 @@ Please refer to the [update guide](/components/connectors/custom-built-connector
The **Correlation** section allows you to configure the message correlation parameters.

:::note
The **Correlation** section is not applicable for the plain **Start Event** element template of the GitHub Webhook Connector. Plain **Start Events** are triggered by process instance creation and do not rely on message correlation.
The **Correlation** section is not applicable for the plain **start event** element template of the GitHub Webhook Connector. Plain **start events** are triggered by process instance creation and do not rely on message correlation.
:::

### Correlation keys

- **Correlation key (process)** is a FEEL expression that defines the correlation key for the subscription. This corresponds to the **Correlation key** property of a regular **Message Intermediate Catch Event**.
- **Correlation key (process)** is a FEEL expression that defines the correlation key for the subscription. This corresponds to the **Correlation key** property of a regular **message intermediate catch event**.
- **Correlation key (payload)** is a FEEL expression used to extract the correlation key from the incoming message. This expression is evaluated in the Connector Runtime and the result is used to correlate the message.

For example, given that your correlation key is defined with `pullRequestId` process variable, and the request body contains `{"pull_request": {"id": 123}}`, your correlation key settings will look like this:
Expand All @@ -330,7 +330,7 @@ Learn more about correlation keys in the [messages guide](../../../concepts/mess

#### Message ID expression

The **Message ID expression** is an optional field that allows you to extract the message ID from the incoming message. Message ID serves as a unique identifier for the message and is used for message correlation.
The **Message ID expression** is an optional field that allows you to extract the message ID from the incoming message. The message ID serves as a unique identifier for the message and is used for message correlation.
This expression is evaluated in the Connector Runtime and the result is used to correlate the message.

In most cases, it is not necessary to configure the **Message ID expression**. However, it is useful if you want to ensure message deduplication or achieve certain message correlation behavior.
Expand Down
Loading

0 comments on commit 0c780ee

Please sign in to comment.