diff --git a/mattermost-connector-product/README.md b/mattermost-connector-product/README.md index 40c9a8e..718b423 100644 --- a/mattermost-connector-product/README.md +++ b/mattermost-connector-product/README.md @@ -1,12 +1,14 @@ # Mattermost Connector -Axon Ivy’s mattermost connector helps you to accelerate process automation initiatives by integrating Mattermost features into your process application within no time. This connector: +Axon Ivy’s mattermost connector helps you to accelerate process automation initiatives by integrating Mattermost features into your process application within no time. -- Gives you full power to the [Mattermost's APIs](https://api.mattermost.com/). -- Allow you to start the Axon Ivy process by hitting the slash command key from the mattermost's channel. -- Allow you to send a message to the mattermost's channel from the Axon Ivy workplace. -- Notifies users on the channel for new Axon Ivy workflow Tasks. -- Supports you with an easy-to-copy demo implementation to reduce your integration effort. +This connector: + +- supports you with a demo implementation to reduce your integration effort. +- gives you full power to the [Mattermost's APIs](https://api.mattermost.com/). +- allow you to start the Axon Ivy process by hitting the slash command key from the mattermost's channel. +- allow you to send a message to the mattermost's channel from the Axon Ivy workplace. +- notifies users on the channel for new Axon Ivy workflow Tasks. ## Demo diff --git a/mattermost-connector-product/README_DE.md b/mattermost-connector-product/README_DE.md new file mode 100644 index 0000000..b9c2338 --- /dev/null +++ b/mattermost-connector-product/README_DE.md @@ -0,0 +1,54 @@ +# Mattermost Konnektor + +Der Mattermost-Konnektor von Axon Ivy integriert Mattermost-Funktionen in deine Axon Ivy Prozessanwendung. + +Dieser Konnektor: + +- unterstützt dich mit einer Demo-Implementierung, um den Integrationsaufwand zu reduzieren. +- gewährleistet vollen Zugriff auf die APIs von [Mattermost](https://api.mattermost.com/). +- ermöglicht es dir, den Axon Ivy-Prozess durch Eingabe des Slash-Kommandos im Mattermost-Kanal zu starten. +- ermöglicht das Senden von Nachrichten an den Mattermost-Kanal aus der Axon Ivy-Oberfläche. +- benachrichtigt Benutzer im Kanal über neue Axon Ivy-Workflow-Aufgaben. + +## Demo + +1. Hit the slash command key on the channel's chat. +The Axon Ivy process will be triggered and create a new task. +The task's information will be sent to the channel by a message. + +![call-slash-command](images/slash-command.png) + +2. Click on the link, start and finish task. +The data from this task will be sent back to the channel. + +![task-notification-from-ivy](images/task-notification-from-ivy.png) + +### Setup + +Mattermost Instance + +1. Ref to [Deploy Mattermost](https://docs.mattermost.com/guides/deployment.html). +2. Create Team, User, ... +3. Go to the System Console to enable Personal Access Tokens +![enable-personal-access-token](images/enable-personal-access-token.png) +4. Go to the Profile and create Personal Access Tokens on the Security tab. The Access Token is used for the ivy variable configuration. +![create-personal-access-token](images/create-personal-access-token.png) +5. Enable Bot Account Creation and create a bot account for sending notification to the channel Axon Ivy. E.g. axonivy-bot +6. Create a slash command in the Integrations menu. +![create-slash-command](images/create-slash-command.png) +7. Create a incoming webhook for the channel that the axonivy can use and post data to the selected channel. +![create-incoming-webhook](images/create-incoming-webhook.png) + +Add the following `Variables` to your `variables.yaml`: + +- `Variables.mattermost.baseUrl` +- `Variables.mattermost.accessToken` +- `Variables.mattermost.teamName` +- `Variables.mattermost.botName` + +and replace the values with your given setup. + +``` +@variables.yaml@ +``` +