camunda / connector-sns Goto Github PK

License: Other

FreeMarker 6.54% Java 93.46%

connector-sns's Introduction

Camunda 8 orchestrates complex business processes that span people, systems, and devices

Camunda 8 delivers scalable, on-demand process automation as a service. Camunda 8 is combined with powerful execution engines for BPMN processes and DMN decisions, and paired with tools for collaborative modeling, operations, and analytics.

This repository contains the core execution cluster components of Camunda 8:

Zeebe - The cloud-native process engine of Camunda 8.
Tasklist - Complete tasks that require human input.
Operate - Manage, monitor, and troubleshoot your processes.
Optimize - Improve your processes by identifying constraints in your system.

In addition to the core execution cluster components, the Camunda 8 stack also includes:

Console - Configure and deploy clusters with Console.
Web Modeler - Web Application to model BPMN, DMN, & Forms and deploy or start new instances.
Desktop Modeler - Use Desktop Modeler as a desktop application for modeling BPMN, DMN, and Forms with your local process application project.
Connectors - Integrate with an external system by using a Connector.

Using Camunda 8, you can:

Define processes visually in BPMN 2.0
Choose your programming language
Deploy with Docker and Kubernetes
Build processes that react to messages from Kafka and other message queues
Scale horizontally to handle very high throughput
Fault tolerance (no relational database required)
Export process data for monitoring and analysis
Engage with an active community

Learn more at camunda.com.

Release Lifecycle

Our release cadence within major releases is a minor release every six months, with an alpha release on each of the five months between minor releases. Releases happen on the second Tuesday of the month, Berlin time (CET).

Minor releases are supported with patches for eighteen months after their release.

Here is a diagram illustrating the lifecycle of minor releases over a 27-month period:

2024                       2025                                2026
Ap Ma Ju Ju Au Se Oc No De Ja Fe Ma Ap Ma Ju Ju Au Se Oc No De Ja Fe Ma Ap Ma Ju
8.5--------------------------------------------------|
                  8.6--------------------------------------------------|
                                    8.7-----------------------------------------
                                                      8.8-----------------------
                                                                        8.9-----
1  2  3  4  5  6  7  8  9  10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

Here is a diagram illustrating the release schedule of the five alpha releases prior to an upcoming minor release over a 7-month period:

2024                                2025
Oct       Nov          Dec          Jan          Feb          Mar          Apr
8.6-----------------------------------------------------------------------------
          8.7-alpha1   8.7-alpha2   8.7-alpha3   8.7-alpha4   8.7-alpha5   8.7--
1         2            3            4            5            6            7

Status

To learn more about what we're currently working on, check the GitHub issues and the latest commits.

Helpful Links

Recommended Docs Entries for New Users

Contributing

Read the Contributions Guide.

Code of Conduct

This project adheres to the Camunda Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior as soon as possible.

License

Zeebe, Operate, and Tasklist source files are made available under the Camunda License Version 1.0 except for the parts listed below, which are made available under the Apache License, Version 2.0. See individual source files for details.

Available under the Apache License, Version 2.0:

Java Client (clients/java)
Go Client (clients/go)
Spring SDK (spring-boot-starter-camunda-sdk)
Exporter API (exporter-api)
Protocol (protocol)
Gateway Protocol Implementation (gateway-protocol-impl)
BPMN Model API (bpmn-model)

Clarification on gRPC Code Generation

The Zeebe Gateway Protocol (API) as published in the gateway-protocol is licensed under the Camunda License 1.0. Using gRPC tooling to generate stubs for the protocol does not constitute creating a derivative work under the Camunda License 1.0 and no licensing restrictions are imposed on the resulting stub code by the Camunda License 1.0.

connector-sns's People

Contributors

Watchers

Forkers

skayliu isabella232

connector-sns's Issues

Amazon SNS: adjust template

What should we do?
As per step 3 from the https://github.com/camunda/team-connectors/blob/main/how-to/CREATE_NEW_CONNECTOR.md#step-3-adjust-fresh-connector-to-your-use-case we need to adjust the template to make it usable

New lines in messages are not supported in SNS connectors

Describe the Bug

When we create a message with new line the new lines are not supported in the email sent from the connector whereas if we try to publish the same from the SNS console the new lines seems to be supported. Hence we need to add the same in our connector too.

Steps to Reproduce

Create/append a SNS connector
Create a topic with email protocol in SNS
add the topic ARN and the necessary authentication details
create a message with new line
we could see that the new line is displayed as '\n" and a new line is not applied
Whereas when we try to send the same message using the SNS console a new line appears in the received message

Message sent and received using SNS connectors

Message sent and received using the SNS console

Expected Behavior

Support new lines in message in the SNS connector as in SNS console

Environment

OS: [Windows 10]
Library version: [0.1.0 rc-2]
Camunda Cloud Environment: [staging]

Amazon SNS: Discover input fields customers would need to use SNS

What shall we do?

Discover what input fields customer would require to send an SNS message.

Research notes

From CLI

https://docs.aws.amazon.com/cli/latest/reference/sns/publish.html

From AWS dashboard

To publish a message, the user must complete the message body's value, as this one is the only mandatory field. We could use the following fields for the first version of the template: topic ARN, subject, region, and message.

Sending Integer as message is displayed as decimal when recieved

Describe the Bug

When we try to send an integer number in our message we see that in the received email it is displayed as decimal whereas the number structure is maintained when we send it via the SNS console

Steps to Reproduce

Create/append a SNS connector task
Add the necessary authentication and ARn details
create a message with a integer number in it say 12
Now in the received email we could see that the number is displayed in decimal format and not integer
When we send the same message using SNS console in AWS we could see that the format of the Integer number is maintained

Expected Behavior

Format of integer should be maintained.

Environment

OS: [ Windows 10]
Library version: [0.1.0 rc-2]
Camunda Cloud Environment: [staging ]

Adjust repository access

What should we do?

https://github.com/camunda/team-connectors/blob/main/how-to/REPOSITORY_SETUP.md#access

Why should we do it?

Align repository setup

Adding Emoji to message is displayed in encrypted format

Describe the Bug

When we create a message with emoji in it we see that the email received from the SNS connector the emoji is displayed in encrypted format whereas this feature is supported by SNS and is missing in the connectors from our end

Steps to Reproduce

Create/Append a SNS connector
Add a emoji to the message that we aim to send
Choose the protocol in SNS as email
In the received email we could see that the emoji is in encrypted format

In the process model:

In the mail:

Expected Behavior

The SNS connector should support sending emojis in messages as well as subject as this issue exists in subject field too

Environment

OS: [ Windows 10]
Library version: [0.1.0 rc-2]
Camunda Cloud Environment: [staging]

The length of the field "subject" must be less than 100 characters

Describe the Bug

We have an error in the instance if the length of the subject is > 99.

Steps to Reproduce
Add a subject > 99.

Expected Behavior

We should have a constraint in the template in order to let the user know what is the maximum length for this field. We should also add validation in the backend.

#20