240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
68 lines
5.8 KiB
Plaintext
68 lines
5.8 KiB
Plaintext
---
|
|
title: "Workflow Automation"
|
|
---
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<PlanAvailability slug="entry-ent" />
|
|
|
|
Mattermost Playbooks provides structure, monitoring and automation for repeatable, team-based processes integrated with the Mattermost platform. Playbooks are [configurable checklists](/end-user-guide/workflow-automation/work-with-tasks) for teams to achieve [specific and predictable outcomes](/end-user-guide/workflow-automation/metrics-and-goals), such as incident response, software release management, and logistical operations.
|
|
|
|
From Mattermost v11.1, Entry, Enterprise, and Enterprise Advanced customers can enable adaptive, conditional workflows responding in real time to changing mission or operational context. Admins can define attributes such as severity, category, or linked ticket ID, and use those attributes to hide or show tasks depending on the values of these attributes which can be seen and modified during a playbook run. Learn more about [playbook attributes](/end-user-guide/workflow-automation/work-with-playbooks#playbook-attributes) and [conditional playbook tasks](/end-user-guide/workflow-automation/work-with-tasks#conditional-tasks).
|
|
|
|
While Playbooks primarily focus on coordinating people and tasks, they also have integration points. You can trigger a playbook run via an incoming webhook, allowing an external tool to trigger a playbook run. Within a playbook, you can define steps that execute webhooks or call external APIs. Additionally, playbooks can work in conjunction with plugins, keeping the entire workflow visible in Mattermost, and reducing the need to switch between apps during critical processes.
|
|
|
|
Playbooks monitor channels for keywords or user actions to trigger a structured process, which brings up a set of individual or shared tasks, each associated with manual or automated actions. As playbooks are executed, some may have requirements for [broadcasting status updates to stakeholders](/end-user-guide/workflow-automation/notifications-and-updates) at regular intervals, to populate workflow dashboards by conducting [retrospectives](/end-user-guide/workflow-automation/metrics-and-goals#configure-retrospectives-before-a-run) after the core process is complete, or other customer requirements as exit criteria for a [playbook “run”](/end-user-guide/workflow-automation/work-with-runs).
|
|
|
|
[Advanced permissions](/end-user-guide/workflow-automation/share-and-collaborate) are also available to delegate and manage playbook controls in larger organizations.
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
Playbooks comes pre-packaged, installed, and enabled with Mattermost server.
|
|
|
|
## Access
|
|
|
|
<Tabs>
|
|
<TabItem value="web-and-desktop" label="Web and Desktop">
|
|
|
|
Access playbooks using a web browser or the desktop app by selecting the product menu located in the top-left corner of the Mattermost interface and then selecting **Playbooks**.
|
|
|
|
</TabItem>
|
|
<TabItem value="mobile" label="Mobile">
|
|
|
|
From Mattermost v11.0 and mobile app v2.34.0, mobile users can:
|
|
|
|
- **Post status updates directly from mobile**: When you open a playbook run on mobile, a new status update button allows you to post progress updates and share status with your team while on the move or in the field.
|
|
- **Create and manage playbook runs** for operational command at the edge.
|
|
|
|
From Mattermost v11 and mobile app v2.32.0, mobile users can access playbooks from the mobile app to [interact with playbook tasks](/end-user-guide/workflow-automation/work-with-tasks#interact-with-playbook-tasks) and [update tasks](/end-user-guide/workflow-automation/work-with-tasks#update-tasks).
|
|
|
|
From Mattermost v10.11 and mobile app v2.31.0, mobile users can access playbooks from the mobile app in read-only mode. [Playbooks slash commands](/end-user-guide/workflow-automation/interact-with-playbooks#slash-commands) are supported in the mobile app, but actions like starting runs or updating checklists aren't available through the mobile interface.
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
|
|
## Usage
|
|
|
|
Use collaborative playbooks to orchestrate prescribed workflows and define, streamline, and document complex, recurring operations, and help your organization stay in command with integrated communication, collaboration, and status dashboards managing your workflow life cycles.
|
|
|
|
### Try it yourself!
|
|
|
|
Walk through our [Incident Response playbook demonstration](https://mattermost.com/demo/playbooks-incident-response/) to see what you can do with playbooks.
|
|
|
|
## Learn more
|
|
|
|
This end user documentation is for anyone who wants guidance on building repeatable processes in Mattermost.
|
|
|
|
- [Learn about collaborative playbooks](/end-user-guide/workflow-automation/learn-about-playbooks) - Learn what collaborative playbooks are and how they're used.
|
|
- [Work with collaborative playbooks](/end-user-guide/workflow-automation/work-with-playbooks) - Customize a playbook for successful runs.
|
|
- [Work with runs](/end-user-guide/workflow-automation/work-with-runs) - Edit triggers and actions in an active run.
|
|
- [Work with tasks](/end-user-guide/workflow-automation/work-with-tasks) - Work with tasks and the task inbox.
|
|
- [Work with notifications and updates](/end-user-guide/workflow-automation/notifications-and-updates) - Keep track of all your active runs and tasks.
|
|
- [Work with metrics and goals](/end-user-guide/workflow-automation/metrics-and-goals) - Unlock insights about the performance of collaborative workflows across organizations with workflow dashboards.
|
|
- [Share and collaborate on playbooks](/end-user-guide/workflow-automation/share-and-collaborate) - Reuse and share collaborative playbooks with your organization.
|
|
- [Interact with playbooks](/end-user-guide/workflow-automation/interact-with-playbooks) - Interact with collaborative playbooks using slash commands and the REST API.
|