diff --git a/README.md b/README.md index 0ba0d12..c4ee369 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# MY-PRODUCT-NAME +# mattermost-connector -[![CI Build](https://github.com/axonivy-market/REPO-NAME/actions/workflows/ci.yml/badge.svg)](https://github.com/axonivy-market/REPO-NAME/actions/workflows/ci.yml) +[![CI Build](https://github.com/axonivy-market/mattermost-connector/actions/workflows/ci.yml/badge.svg)](https://github.com/axonivy-market/mattermost-connector/actions/workflows/ci.yml) -"YOUR SHORT DESCRIPTION GOES HERE" +Mattermost enhances team messaging for streamlined workflows and better collaboration. -Read our [documentation](MY-PRODUCT-NAME-product/README.md). \ No newline at end of file +Read our [documentation](mattermost-connector-product/README.md). diff --git a/mattermost-connector-product/README.md b/mattermost-connector-product/README.md index 8a278ea..40c9a8e 100644 --- a/mattermost-connector-product/README.md +++ b/mattermost-connector-product/README.md @@ -1,32 +1,51 @@ - - # Mattermost Connector -YOUR DESCRIPTION GOES HERE: Please just give a short description here without further headings. +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: - +- 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. ## Demo -YOUR DEMO DESCRIPTION GOES HERE +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 -## Setup +Mattermost Instance -YOUR SETUP DESCRIPTION GOES HERE - +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@ -``` \ No newline at end of file +``` diff --git a/mattermost-connector-product/images/create-incoming-webhook.png b/mattermost-connector-product/images/create-incoming-webhook.png new file mode 100644 index 0000000..da63144 Binary files /dev/null and b/mattermost-connector-product/images/create-incoming-webhook.png differ diff --git a/mattermost-connector-product/images/create-personal-access-token.png b/mattermost-connector-product/images/create-personal-access-token.png new file mode 100644 index 0000000..c4e10b0 Binary files /dev/null and b/mattermost-connector-product/images/create-personal-access-token.png differ diff --git a/mattermost-connector-product/images/create-slash-command.png b/mattermost-connector-product/images/create-slash-command.png new file mode 100644 index 0000000..64dfee8 Binary files /dev/null and b/mattermost-connector-product/images/create-slash-command.png differ diff --git a/mattermost-connector-product/images/enable-personal-access-token.png b/mattermost-connector-product/images/enable-personal-access-token.png new file mode 100644 index 0000000..37546be Binary files /dev/null and b/mattermost-connector-product/images/enable-personal-access-token.png differ diff --git a/mattermost-connector-product/images/slash-command.png b/mattermost-connector-product/images/slash-command.png new file mode 100644 index 0000000..d9db6ef Binary files /dev/null and b/mattermost-connector-product/images/slash-command.png differ diff --git a/mattermost-connector-product/images/task-notification-from-ivy.png b/mattermost-connector-product/images/task-notification-from-ivy.png new file mode 100644 index 0000000..1dac1e4 Binary files /dev/null and b/mattermost-connector-product/images/task-notification-from-ivy.png differ