snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)
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
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
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
---
|
||||
title: "Interact with playbooks"
|
||||
---
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
## Slash commands
|
||||
|
||||
Slash commands are available for collaborative playbooks. The `/playbook` slash command allows interaction with incidents via the post textbox on desktop, browser, and mobile. To run a playbook use the `/playbook run` slash command from any channel.
|
||||
|
||||
Available slash commands include:
|
||||
|
||||
- `/playbook run` - Run a playbook.
|
||||
- `/playbook finish` - Finish the playbook run in this channel.
|
||||
- `/playbook update` - Provide a status update.
|
||||
- `/playbook check [checklist #] [item #]` - Check/uncheck the checklist item.
|
||||
- `/playbook checkadd [checklist #] [item text]` - Add a checklist item.
|
||||
- `/playbook checkremove [checklist #] [item #]` - Remove a checklist item.
|
||||
- `/playbook owner [@username]` - Show or change the current owner.
|
||||
- `/playbook info` - Show a summary of the current playbook run.
|
||||
- `/playbook timeline` - Show the timeline for the current playbook run.
|
||||
- `/playbook todo` - Get a list of your assigned tasks.
|
||||
- `/playbook settings digest [on/off]` - Turn daily digest on/off.
|
||||
- `/playbook settings weekly-digest [on/off]` - Turn weekly digest on/off.
|
||||
|
||||
## Playbooks on the go
|
||||
|
||||
Learn how to [access and work with playbooks on the go](/end-user-guide/workflow-automation/work-with-runs#playbook-runs-on-mobile) with the Mattermost mobile app.
|
||||
|
||||
## API documentation
|
||||
|
||||
To interact with the data model programmatically, consult the [REST API specification](https://github.com/mattermost/mattermost-plugin-incident-collaboration/blob/master/server/api/api.yaml).
|
||||
|
||||
Playbooks help streamline and manage complex processes while decreasing the risk of forgotten steps or tasks. They also support tool integration, status updates in a dedicated channel, and can be edited on the fly. When a playbook run is finished, you can review the entire run to assess any areas of improvement for the next run.
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: "Learn about collaborative playbooks"
|
||||
---
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
A collaborative playbook is a repeatable process that is measured and refined over time. For example, the steps you follow when dealing with an outage, a software release, or welcoming a new member of your team can all be made into a playbook.
|
||||
|
||||
Using collaborative playbooks, teams can orchestrate prescribed workflows and define, streamline, and document complex, recurring operations.
|
||||
|
||||
Each playbook represents a recurring outcome or specific goal that your teams collaborate on to achieve, such as service outage recovery or customer onboarding. Collaborative playbooks are made up of:
|
||||
|
||||
- [Checklists](/end-user-guide/workflow-automation/work-with-playbooks#make-checklists): The list of tasks to be completed for the run. Can be edited during a run. From Playbooks v2.6.0, checklists can also be created and managed directly within public and private channels.
|
||||
- [Templates](/end-user-guide/workflow-automation/work-with-playbooks#templates): Used for frequently-used actions such as updates and reminders. You can create your own templates or use default ones.
|
||||
- [Automation actions](/end-user-guide/workflow-automation/work-with-tasks#task-actions): Used for inviting members, creating webhooks, editing welcome messages, and more.
|
||||
- [Permissions](/end-user-guide/workflow-automation/share-and-collaborate): Manage permissions at the channel and at the playbook level.
|
||||
|
||||
Teams run a playbook every time they want to orchestrate people, tools, and data to achieve that outcome as quickly as possible while providing visibility to stakeholders.
|
||||
|
||||
- For participants, playbooks prescribe processes and actions such as task checklists, status updates, and retrospective reports.
|
||||
- For your integrated tools, playbooks configure the triggers that execute automated actions.
|
||||
- For stakeholders, playbooks provide a single pane of glass for visibility into each run as well as aggregate insights over time.
|
||||
|
||||
## What's a run?
|
||||
|
||||
A run is the execution of the steps in a playbook. When a playbook is run, the process begins in a channel. Members of a playbook can view the run's progress in the run details page or they can participate in the run channel.
|
||||
|
||||
To find all playbook runs, open **Product menu \> Playbooks**, and then select any playbook name. Next, select **Runs** from the navigation bar, then choose a run to view its overview. Select **Go to channel** to open the run’s channel.
|
||||
|
||||
When the process is completed, the run is ended. A retrospective can be run and the channel can be archived.
|
||||
|
||||
## Keywords
|
||||
|
||||
It's important to make it easy to start a run. One way to do this is by setting up keywords. These keywords prompt a user to start the run when they're used. In the incident response playbook, the keywords are specific to critical incidents, for example `sev-1` and `#incident`. It's unlikely that someone would use those terms in general conversation and, even if they do, they can elect not to start the playbook run when prompted.
|
||||
|
||||
## Welcome message
|
||||
|
||||
Create a welcome message so that when members join your run, it's easy for them to see where they're needed and where to find the relevant information. This is especially important during a time-sensitive incident to eliminate confusion and help members ramp up quickly.
|
||||
|
||||
## Tasks and checklists
|
||||
|
||||
Tasks and checklists are the foundation of a template and a workflow. In an incident, it's critical to get stakeholders together as soon as possible, so one of the first tasks is to add the on-call engineer to the channel, followed by starting a bridge call. When you're setting up these tasks, you can add slash commands, @mentions, and integrations with tools such as Zoom to make the initiation as seamless as possible.
|
||||
|
||||
## Status updates
|
||||
|
||||
Regular updates are important communication tools, especially in the middle of an incident like an outage. Channels can get very busy and overwhelming, and if you have more than one incident at a time, it's often too noisy for stakeholders to keep track of everything.
|
||||
|
||||
Use the **Broadcast update to other channels** option to cut through the noise and share critical information with both channel members and other users in a dedicated channel.
|
||||
|
||||
Additionally, set a timer that issues a reminder for updates to be shared.
|
||||
|
||||
## Retrospective
|
||||
|
||||
When an incident is over, create a retrospective that captures the impact of the event. You can also add metrics, such as how long it took to resolve the incident, which you can apply to other, similar incidents to see where you can improve and refine your workflows.
|
||||
|
||||
<Tip>
|
||||
|
||||
Looking to optimize team productivity? Learn how to automate repeatable workflows with [this on-demand webinar](https://mattermost.com/webinar/4-strategies-to-improve-technical-teams-productivity/), then download our [Mattermost Playbooks datasheet](https://mattermost.com/mattermost-playbooks-datasheet/).
|
||||
|
||||
</Tip>
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: "Work with metrics and goals"
|
||||
---
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
Workflow dashboards unlock insights about the performance of workflows across organizations. They compare the output metrics from different runs of collaborative playbooks, against targets and historical performance. Each time a collaborative playbook is run, you can update the workflow dashboard for the team and stakeholders to review, where dashboard components are customized per playbook.
|
||||
|
||||
Examples of metrics-based workflow dashboards that can be set up to monitor and inform performance include: time to detect, time to resolve in incident response workflows, work plan completion percentage for monthly software releases management workflows, and launch success rate for logistical workflows involving launch operations.
|
||||
|
||||
## Configure retrospectives before a run
|
||||
|
||||
Access the **Playbooks** tab in Mattermost. Locate the playbook you want to modify, select the **...** icon under **Actions** and then select **Edit**. In the next screen, select **Retrospective**. Move the toggle to **Enable Retrospective**.
|
||||
|
||||
You can set a reminder to fill out the retrospective after a run is finished. The configured template is pre-populated in the run's retrospective.
|
||||
|
||||
Use the run timeline to help write an accurate retrospective. Events such as owner changes, status updates, and task assignments appear automatically. Selected posts may also be added to the timeline by using the post context menu.
|
||||
|
||||

|
||||
|
||||
## Metrics
|
||||
|
||||
Use metrics to identify key areas where you want to extract valuable insights by measuring performance and improvement. Metrics are enabled when you enable retrospectives. Calibrate the type of metric you want to measure, and once a run is finished you can view the output in the retrospective. You can have multiple metrics configured per playbook and you can edit them at any time. Metrics can be configured based on numeric, time, or value input.
|
||||
|
||||
These metrics can be anything that's of interest to you and your team. For example, for a software release playbook you might want to have a metric tracking how many bugs were detected during a run. The output of the metrics you've added is provided in the retrospective. Over time, you can use metrics across retrospectives to examine anomalies and refine goals.
|
||||
|
||||
Another example is a support incident playbook. The time to resolution metric can be applied and used to identify areas that need more refinement, such as tasks that might work better if they're split up so goals are reached faster.
|
||||
|
||||
When you delete configured metrics from a playbook, the data isn't deleted, but you no longer see those metrics in the dashboard. In addition, the corresponding metric field is removed from the retrospective form and from published retrospectives.
|
||||
|
||||
### Metrics dashboard
|
||||
|
||||
For each run, you can enter a value per metric under the retrospective section. This value can be based on whatever you are measuring, such as number of bugs found per run.
|
||||
|
||||
You can edit this value as many times as you'd like - for example to ensure you have the correct parameters for your metric - until you've published the retrospective at which point both the metrics and report are no longer editable. The final value only shows up in the playbook dashboard once the retrospective has been published.
|
||||
|
||||
The playbook dashboard reports on each metric for all runs by showing:
|
||||
|
||||
- Average value for all runs
|
||||
- The last 10-run average value and difference with prev 10-run average
|
||||
- The value range for all runs
|
||||
- The target value
|
||||
- The actual values chart for last 10-runs
|
||||
|
||||
The lower half of the page shows a list of finished runs with metrics values. You can filter or sort a list by metrics values.
|
||||
|
||||

|
||||
|
||||
### Export channel data
|
||||
|
||||
<PlanAvailability slug="ent-plus" />
|
||||
|
||||
See the [export channel data](/administration-guide/comply/export-mattermost-channel-data) documentation for details on working with channel export functionality.
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
title: "Work with notifications and updates"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
There are multiple ways to receive collaborative playbook updates and notifications.
|
||||
|
||||
## Status updates
|
||||
|
||||
Status updates ensure that stakeholders remain informed about the playbook run's progress.
|
||||
|
||||
You can post a status update from the run channel and you can also configure the playbook to send a reminder to post a status update.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="web-and-desktop" label="Web and Desktop">
|
||||
|
||||
1. To post a status update, access the **Playbooks** tab in Mattermost. Select the run you want to post the update for. In the run details page, select **Post update**.
|
||||
- If this is the first status update and the playbook has a defined template, that template will be pre-populated here.
|
||||
- If this is a subsequent status update, the message from the last status update will be pre-populated here.
|
||||
2. Optionally set a reminder to prompt for the next status update.
|
||||
- If this is the first status update and the playbook has a defined default reminder timer, that timer will be pre-selected here.
|
||||
- If this is a subsequent status update, the last reminder timer will be pre-populated here.
|
||||
3. Select **Post update** to post your status update.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mobile" label="Mobile">
|
||||
|
||||
From Mattermost v11.1 and mobile v2.34.0, mobile users can post status updates directly from the Mattermost mobile app:
|
||||
|
||||
1. Open a playbook run from your mobile app.
|
||||
2. Select the status update button that appears when viewing the run details.
|
||||
3. In the status update modal:
|
||||
- If this is your first status update and the playbook has a status update template, the template content will be pre-populated.
|
||||
- For subsequent updates, your most recent status update content will be pre-populated.
|
||||
- The modal header shows how many people and channels will receive your status update.
|
||||
4. Select your reminder timing from the predefined options available in the mobile app.
|
||||
5. Select **Post update** to share your status update.
|
||||
|
||||
<Note>
|
||||
|
||||
- The status update button is only available to participants in the playbook run and is disabled when the run is finished.
|
||||
- Mobile time selector options are limited to predefined choices, unlike the web interface which allows custom date entry.
|
||||
|
||||
</Note>
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
When the playbook has a defined broadcast channel, status updates are copied to the broadcast channel as a message from the Playbooks bot. Status updates broadcast to another channel won’t be updated or removed if the original post is edited or deleted.
|
||||
|
||||
The most recent status post alsos displays in the right-hand sidebar of the run channel and in the timeline. To correct or remove a status post, edit or delete the post as needed.
|
||||
|
||||
## Request an update
|
||||
|
||||
To request a status update, access the **Playbooks** tab in Mattermost. Select the run you want an update for. In the run details page, select the <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> menu next to **Post update** and select **Request update**.
|
||||
|
||||
<Note>
|
||||
|
||||
Requesting updates is only available in the web browser and desktop app. This functionality is not available on mobile.
|
||||
|
||||
</Note>
|
||||
|
||||
## Follow runs and playbooks
|
||||
|
||||
Follow specific playbooks to receive updates on important events such as when a run is started and finished, as well as status and retrospective updates every time that playbook is run. This is a good option if you're interested in all instances of a specific workflow, such as an outage resolution playbook.
|
||||
|
||||
You can also choose to follow a specific run without actively participating. You’ll receive updates for that run only and can take action if needed. This is useful when you’re only interested in a single instance of a procedure—for example, following onboarding for one specific customer rather than every onboarding run.
|
||||
|
||||
<Note>
|
||||
|
||||
Following playbooks and runs is only available in the web browser and desktop app. This functionality is not available on mobile.
|
||||
|
||||
</Note>
|
||||
|
||||
## Daily digest
|
||||
|
||||
To help you keep track of your runs, tasks, and statuses, a daily digest is sent via direct message in Mattermost.
|
||||
|
||||
Running playbooks in multiple channels can be overwhelming. The daily digest is sent once a day, in the morning. It lists the actionable items for each run, as well as any outstanding tasks or status updates required. Select the run name to move to that channel.
|
||||
|
||||
The digest is on by default. To turn it off, use the slash command `/playbook settings digest off`.
|
||||
|
||||
## Playbook to do
|
||||
|
||||
As you complete tasks and finish runs, you can update the details in the digest using the slash command `/playbook todo`. This slash command can be run in any channel, direct message, or group message. Once run, it delivers an updated digest which includes a list of active runs you belong to.
|
||||
@@ -0,0 +1,139 @@
|
||||
---
|
||||
title: "Share and collaborate on playbooks"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
There are different ways for teams to access and interact with collaborative playbooks. This is managed in the System Console using permissions. Permissions can be granted in a variety of ways, to allow for different combinations of access and visibility.
|
||||
|
||||
Permissions are provided using:
|
||||
|
||||
- **System Scheme:** Applies permissions universally across all teams, channels, and playbooks.
|
||||
- **Team Override Schemes:** Allow admins to customize permissions for each team.
|
||||
|
||||
For more information about System and Team Override Schemes, refer to the [Advanced Permissions](/administration-guide/onboard/advanced-permissions) documentation.
|
||||
|
||||
<Note>
|
||||
|
||||
Some permissions functionality is only available to Mattermost Enterprise customers. For more information, visit [https://mattermost.com/pricing](https://mattermost.com/pricing).
|
||||
|
||||
</Note>
|
||||
|
||||
In the context of collaborative playbooks, members are assigned a role and based on the selected permissions, this determines how they interact with playbooks. A member can be a member of one playbook, and an admin of another. This allows for granular permissions across teams and departments. For example, setting playbook visibility so only certain teams can view it, or setting permissions to allow an organization to view a playbook but only designated team members can make edits.
|
||||
|
||||
Permissions are applied only to playbooks. There are no permissions that are specific to runs.
|
||||
|
||||
<Important>
|
||||
|
||||
From Playbooks v2.6.0, channel checklists use [channel-based permissions](/administration-guide/manage/team-channel-members) rather than playbook-specific permissions. This means that users with appropriate channel permissions can create, manage, and interact with checklists directly within channels without requiring separate playbook access permissions.
|
||||
|
||||
</Important>
|
||||
|
||||
## Playbook roles
|
||||
|
||||
- **Member**: In the context of collaborative playbooks, members are users of Mattermost who are added to a playbook.
|
||||
- **Playbook Admin**: Playbook Admins are also members, and may have elevated permissions to change playbook and run visibility as well as functional settings. They do not have access to the System Console and their privileges are managed by the system admin. Members need to be promoted to the role from within playbooks. The Playbook Admin role is applied per playbook.
|
||||
|
||||
<Note>
|
||||
|
||||
Before you make system or team changes to permissions, ensure that you don't lose access to your existing playbooks. Navigate to the playbook you're a member of. Select the **Manage Access** icon and change your role from **Member** to **Admin**.
|
||||
|
||||
</Note>
|
||||
|
||||
## Playbooks permissions
|
||||
|
||||
Default playbooks settings are completely open which enable all members to participate in runs, edit playbooks, view runs and playbooks, remove other members from runs, edit actions, and make other changes. Permissions provide better control over confidential runs and playbooks, as well as member management. Note that even with the default settings, private playbooks restrict these actions to members of the playbook.
|
||||
|
||||
### Create read-only playbooks
|
||||
|
||||
In the following example, only playbook admins can edit playbooks. Other users can view public playbooks and private playbooks of which they are a member, but can't edit any playbook or change playbook memberships.
|
||||
|
||||
1. Go to **System Console \> User Management \> Permissions**.
|
||||
2. In the **All Members** section, uncheck **Manage Public Playbooks** and uncheck **Manage Private Playbooks**.
|
||||
3. Scroll down to the **Playbook Admin** section and confirm that **Manage Public Playbooks** and **Manage Private Playbooks** are checked.
|
||||
4. Select **Save**.
|
||||
|
||||
## Restrict who can create playbooks
|
||||
|
||||
You can also set permissions for read-only playbooks that do allow members to create new public or private playbooks.
|
||||
|
||||
1. Go to **System Console \> User Management \> Permissions**.
|
||||
2. In the **All Members** section, uncheck **Manage Public Playbooks** and uncheck **Manage Private Playbooks**.
|
||||
3. Then, check **Create Public Playbook** and **Create Private Playbook**.
|
||||
4. Select **Save**.
|
||||
|
||||
### I want to restrict who can convert playbooks from public to private
|
||||
|
||||
You can control whether Members can convert playbooks from public to private.
|
||||
|
||||
1. Go to **System Console \> User Management \> Permissions**.
|
||||
2. In the **All Members** section, check **Convert Playbooks**.
|
||||
3. Select **Save**.
|
||||
|
||||
Alternatively, to restrict this action so only Playbook Admins can convert playbooks from public to private, uncheck the setting above and:
|
||||
|
||||
1. Go to **System Console \> User Management \> Permissions**.
|
||||
2. Scroll down to **Playbook Admin**.
|
||||
3. Check **Convert Playbooks**.
|
||||
4. Select **Save**.
|
||||
|
||||
### I want to control who starts a run
|
||||
|
||||
By default, all Members can start a run using a playbook. You can restrict this so that only Playbook Admins can start a run. Note that with this configuration, Members are not able to start runs or edit playbooks.
|
||||
|
||||
1. Go to **System Console \> User Management \> Permissions**.
|
||||
2. In the **All Members** section, uncheck **Manage Runs**. This also unchecks **Create Runs**.
|
||||
3. Scroll down to **Playbook Admin** and ensure that **Manage Runs** is checked.
|
||||
4. Select **Save**.
|
||||
|
||||
If you want to continue to allow Members to edit playbooks, an alternative to this configuration is to make the playbook private.
|
||||
|
||||
## Duplicate a playbook
|
||||
|
||||
Playbooks are repeatable workflows and sometimes it’s easier to copy and improve rather than start from scratch.
|
||||
|
||||
You can do this by duplicating a playbook in the Playbooks screen. Select the **...** under **Actions** and then select **Duplicate**. The copied playbook will have **Copy of** appended to its original name which you can edit.
|
||||
|
||||
To import a playbook, go to the Playbooks screen, and select **Import**. Choose the team you’re importing to, then select the JSON file. You can also export any playbook to JSON to easily share with other Mattermost servers.
|
||||
|
||||
## Archive a playbook
|
||||
|
||||
<Note>
|
||||
|
||||
To archive a playbook, you must be a member of the playbook or playbook admin and have applicable **Manage Playbook Configurations** permission granted by a system administrator.
|
||||
|
||||
</Note>
|
||||
|
||||
To archive a playbook:
|
||||
|
||||
1. Go to the **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> icon and select **Playbooks**.
|
||||
2. Select **View all...** under the **Playbooks** section in the left menu.
|
||||
3. Select the **...** in the **Actions** column for the playbook you would like to archive.
|
||||
4. Select the **Archive** menu option then the **Archive** button to confirm you would like to archive the playbook.
|
||||
|
||||

|
||||
|
||||
## Restore an archived playbook
|
||||
|
||||
<Note>
|
||||
|
||||
To restore an archived playbook, you must have applicable **Manage Playbook Configurations** permission granted by a system administrator.
|
||||
|
||||
</Note>
|
||||
|
||||
To restore an archived playbook:
|
||||
|
||||
1. Go to the **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> icon and select **Playbooks**.
|
||||
2. Select **View all...** under the **Playbooks** section in the left menu.
|
||||
3. Verify the **With archived** checkbox next to the playbook search bar is selected.
|
||||
4. Select the **...** in the **Actions** column for the playbook you would like to restore.
|
||||
5. Select the **Restore** menu option then the **Restore** button to confirm you would like to restore the playbook.
|
||||
|
||||

|
||||
|
||||
## Export channel data
|
||||
|
||||
<PlanAvailability slug="ent-plus" />
|
||||
|
||||
See the [export channel data](/administration-guide/comply/export-mattermost-channel-data) documentation for details on working with channel export functionality.
|
||||
@@ -0,0 +1,207 @@
|
||||
---
|
||||
title: "Work with collaborative playbooks"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
A collaborative playbook is a checklist of the tasks that make up your processes. Collaborative playbooks allow you to take codified knowledge and processes and make them accessible and editable by your organization and team. When you're setting up your playbook, you'll be able to break tasks down, and assign actions to them - such as using a slash command to start a Zoom call. You can also decide whether to use the same channel every time your playbook is run, or a new one.
|
||||
|
||||
There are other parts of a playbook, such as automation settings, and metrics. Playbook configuration applies both to the execution of the playbook as well as to its management and improvement.
|
||||
|
||||
But the very first thing you’ll want to set up is a checklist.
|
||||
|
||||
Each time you use the process you’ve documented, such as onboarding a new customer, the playbook is used to start a run - a discrete single use of the process - and that run is captured in a channel (either a dedicated one or a new one every time you run the playbook).
|
||||
|
||||
Setting up a playbook includes configuring how the playbook manages the creation of its channel as well as how stakeholders are notified.
|
||||
|
||||
To open a playbook and view its statistics, select the playbook name. To begin a run using a specific playbook, select **Run** beside that playbook’s name.
|
||||
|
||||
## Templates
|
||||
|
||||
Creating a playbook from scratch can be daunting, even if you have the process mapped out. One way to get started quickly is to use one of the pre-configured templates available. These templates are populated with content and settings to provide guidance and are customizable.
|
||||
|
||||
Playbook templates are basic workflows that you can use to get started quickly. As you learn more about your workflows, you can customize them into specific playbooks.
|
||||
|
||||
### Choose a template
|
||||
|
||||
The first step is to choose the right template for your use case. There are pre-configured templates for specific scenarios. The checklists, actions, status updates, and retrospective settings for these templates may already be filled in and, where appropriate, enabled. You can always edit and adjust these settings - they're there to guide you - removing them doesn't negatively affect the playbook run.
|
||||
|
||||
<Tip>
|
||||
|
||||
Take a look at the **Learn how to use playbooks** template. This template breaks down the components of a playbook and you can also start a test run to see how everything fits together. If you're taking this option, you can stop reading here and enjoy the test run. You can also choose a blank template and start from scratch - this is a good option if your use case is unique.
|
||||
|
||||
</Tip>
|
||||
|
||||
In the incident response template, the template contains items that are relevant to incident resolution. These are general items to help you get started.
|
||||
|
||||
## Edit a playbook
|
||||
|
||||
You can change a playbook’s configuration at any time, but changes will only be applied to future incidents. Ongoing or ended incidents previously started from that playbook remain unchanged.
|
||||
|
||||
1. Go to **Product menu \> Playbooks**.
|
||||
2. Find the playbook you want to edit.
|
||||
- Only public playbooks and private playbooks that you're a member of are listed. System admins have unrestricted access to all playbooks on the team.
|
||||
3. Select the name of the playbook.
|
||||
- To edit the playbook directly select the actions menu next to the playbook name, then select **Edit**.
|
||||
- To access the playbook dashboard, select the hyperlinked playbook name.
|
||||
4. Select the **Outline** tab.
|
||||
5. Edit the text portions of the playbook inline. Use the left-hand menu to navigate to other parts of the playbook that you may want to edit.
|
||||
|
||||
## Make checklists
|
||||
|
||||
Checklists in a playbook or run are restricted to playbook participants and owners.
|
||||
|
||||
To create a checklist in a playbook, go to the **Tasks** section. Start from templated tasks or create your own. Select **Add a task** or **Add a section** to build out checklists in the playbook. Drag and drop to reorder tasks and sections as needed. Task descriptions support a limited form of Markdown, including text styling and hyperlinks.
|
||||
|
||||
Playbook tasks consist of text rendered in Markdown (when present). You can't run commands directly from a task in a playbook, but you can trigger [built-in slash commands](/integrations-guide/built-in-slash-commands) and [custom slash commands](https://developers.mattermost.com/integrate/slash-commands/custom/), or outgoing webhooks, to run as part of the task action by starting the task with `/`.
|
||||
|
||||
### Channel checklists
|
||||
|
||||
From Playbooks v2.6.0, you can additionally create and manage channel-based checklists directly within [public](/end-user-guide/collaborate/channel-types#public-channels) and [private](/end-user-guide/collaborate/channel-types#private-channels) channels without requiring a playbook template or a run. Channel checklists use existing Mattermost channel permissions to control access, so any channel member who can manage channel names, headers, and purpose can create, edit, and manage channel checklists.
|
||||
|
||||
To create a new channel checklist or modify an existing checklist, select the **Checklists** option in the top left corner of the Mattermost interface.
|
||||
|
||||
<Note>
|
||||
|
||||
- Channel checklists aren't available in [direct messages](/end-user-guide/collaborate/channel-types#direct-message-channels) or [group messages](/end-user-guide/collaborate/channel-types#group-message-channels).
|
||||
- To create a channel checklist, you must be a channel [Member](/end-user-guide/collaborate/learn-about-roles#member) (not a [Guest](/end-user-guide/collaborate/learn-about-roles#guest)). To edit a channel checklist, any channel member who can post to the channel can do so, including guests.
|
||||
- Channel checklists in [archived](/end-user-guide/collaborate/channel-types#archived-channels) channels can't be modified. Archived channels must be [unarchived](/end-user-guide/collaborate/archive-unarchive-channels#unarchive-a-channel) to access and edit their channel checklists.
|
||||
- A single channel can contain both playbook runs and channel checklists.
|
||||
- When using Mattermost in a web browser or the Desktop app, you can convert a channel checklist into a playbook by selecting the checklist name and then selecting **Save as a Playbook**.
|
||||
|
||||
</Note>
|
||||
|
||||
## Multiple runs in a channel
|
||||
|
||||
From Mattermost v7.7, you can choose to start each run in a new channel or re-use an already existing channel.
|
||||
|
||||
Here are some scenarios why you might want to start each run in the same channel:
|
||||
|
||||
- Short, frequently-used processes benefit from being in the same channel - it keeps the process streamlined.
|
||||
- Teams with multiple independent workflows, such as release teams, benefit from having them in one place.
|
||||
- Cutting down on the number of new channels created makes it easier to find run channels again.
|
||||
- The run name isn't linked to the channel's name so you can tell multiple workflows apart.
|
||||
|
||||
When you're configuring your playbook:
|
||||
|
||||
- You can link it to an existing channel so that each run starts in that channel.
|
||||
- You can choose that each time the playbook is run, it creates a new channel.
|
||||
|
||||
To access this setting, open the **Playbooks** tab. Select the playbook you want to edit, then select the **Outline** tab. Select **Actions** in the left-hand menu and make your selection under the **When a run starts** heading.
|
||||
|
||||
When you start a run, your selection is the default but can be changed for each run. Additionally, it's also possible to move a started run to another channel, so you're not locked into whichever option you select.
|
||||
|
||||
## Status updates
|
||||
|
||||
There may be multiple active runs on any given day.
|
||||
|
||||
Configuring an update cadence is an easy way to centralize status updates, decrease noise, and remember where everything is. You can do this when you're setting up your playbook. Navigate to the **Usage** section and set the parameters based on expected update cycles and where the updates should be published.
|
||||
|
||||
## Keywords
|
||||
|
||||
You can use keywords to trigger a playbook. Keywords are set in the **Channel Actions** menu and are applicable to a specific channel. When you use the Keywords action any channel member who has access to the playbook and who uses one of the listed keywords will be prompted to run the associated playbook.
|
||||
|
||||
If you find your keywords result in too many false positives, consider refining your list and also consider that URLs used by run members may also contain monitored keywords.
|
||||
|
||||
## Actions
|
||||
|
||||
You can customize actions associated with your playbook to ensure a smooth start when starting a run. Select the **Actions** tab to view the automation options available.
|
||||
|
||||
Options include:
|
||||
|
||||
- Create a channel when a run is started
|
||||
- Invite members to the run
|
||||
- Send outgoing webhooks
|
||||
- Automatically add the run channel to a sidebar category
|
||||
|
||||
Actions such as channel creation and adding the channel to a sidebar category are set per-playbook and applied to each run that uses that playbook.
|
||||
|
||||
If you’re a system admin or channel admin of the run channel you can also edit these settings in the run channel, via the channel menu, in **Channel Actions**. Editing the settings in the run channel will only affect that channel and the changes aren’t applied to the playbook. Only channel admins can edit the **Channel Actions** items (such as the welcome message) but members who have access to the playbook can edit the welcome message and run behavior settings. Editing these won’t change the welcome message of a run that’s in progress - it only applies going forward. If you want to change the behavior of all future runs associated with the playbook, edit the playbook directly in the **Actions** menu.
|
||||
|
||||
## Playbook attributes
|
||||
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
From Mattermost v11.1, using Mattermost in a web browser or the desktop app, you can define custom attributes for your playbooks to create adaptive workflows that respond to changing mission or operational context. From Mattermost mobile v2.37.0, you can view and edit playbook run attributes on mobile devices, including text fields, select, and multi-select types. Attributes such as severity, category, or linked ticket ID can be configured to trigger context-aware tasks and enable intelligent adaptation to situational conditions.
|
||||
|
||||
<Note>
|
||||
|
||||
This feature requires Mattermost Playbook v2.5.0 or later.
|
||||
|
||||
</Note>
|
||||
|
||||
Attributes enable you to:
|
||||
|
||||
- Define contextual information that varies between runs (e.g., incident severity, priority level, customer type).
|
||||
- Trigger different tasks or workflows based on attribute values.
|
||||
- Create conditional logic in your playbooks for more sophisticated automation.
|
||||
- Maintain consistent data collection across runs.
|
||||
|
||||
Playbook attributes are visible to all run participants and can be referenced in status updates.
|
||||
|
||||
<Note>
|
||||
|
||||
When viewing and editing playbook run attributes on mobile devices, color formatting and URL links in attributes are not supported and display as plain text.
|
||||
|
||||
</Note>
|
||||
|
||||
### Configure attributes
|
||||
|
||||
To configure attributes:
|
||||
|
||||
1. Go to the **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> icon and select **Playbooks**.
|
||||
|
||||
2. Select the playbook you want to define attributes for.
|
||||
|
||||
3. Select the **Attributes** tab.
|
||||
|
||||
4. Select **Add your first attribute**.
|
||||
|
||||

|
||||
|
||||
5. Enter an attribute name and specify its type as **Text**, **URL**, **Select**, or **Multi-Select**.
|
||||
|
||||
6. For **Select** and **Multi-Select** types, define the available values.
|
||||
|
||||
7. Select **Add attribute** to add additional attributes and values.
|
||||
|
||||

|
||||
|
||||
<Tip>
|
||||
|
||||
- Control how attribute-based conditions appear in a playbook outline by dragging and dropping them into your preferred order.
|
||||
- Use the **Actions** menu to rename, duplicate, or delete attributes.
|
||||
|
||||

|
||||
|
||||
</Tip>
|
||||
|
||||
## Conditional playbooks
|
||||
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
From Mattermost v11.1, using Mattermost in a web browser or the desktop app, you can create conditional playbooks with more sophisticated workflows that respond intelligently to changing circumstances. From Mattermost mobile v2.37.0, you can also view and edit playbook run attributes on mobile devices. By leveraging playbook attributes, you can define conditions that determine which tasks and checklists are included in a playbook run based on real-time data.
|
||||
|
||||
Conditional playbooks enable you to:
|
||||
|
||||
- Add tasks that only apply when specific conditions are met.
|
||||
- Define tasks and checklists that change based on attribute values.
|
||||
- Create adaptive workflows that change based on real-time data.
|
||||
|
||||
See the [conditional tasks](/end-user-guide/workflow-automation/work-with-tasks#conditional-tasks) documentation for details on configuring conditional tasks within playbooks.
|
||||
|
||||
## Run metrics
|
||||
|
||||
The **Usage** tab in the workflow dashboard provides run metrics for that playbook. These metrics are available to all viewers. It's not possible to edit or add to these metrics.
|
||||
|
||||
## Webhooks
|
||||
|
||||
- For information about the webhook payload for `run start`, see the [PlaybookRunWebhookPayload](https://github.com/mattermost/mattermost-plugin-playbooks/blob/b4c8058d8660efe35050bc7eb080e3819c7ab09c/server/app/playbook_run_service.go#L176-L185) struct. An example of the JSON payload for a run start [is available](https://gist.github.com/icelander/b68f2bf2b4ffefec93400cb050211cf1).
|
||||
- For information about the webhook payload for `status update`, see the [PlaybookRunWebhookPayload](https://github.com/mattermost/mattermost-plugin-playbooks/blob/b4c8058d8660efe35050bc7eb080e3819c7ab09c/server/app/playbook_run_service.go#L176-L185) struct. An example JSON payload for a status update [is available](https://gist.github.com/icelander/2f9938ad68d1e0aa656f97969895d080).
|
||||
|
||||
<Tip>
|
||||
|
||||
Watch this [on-demand webinar on securing your mission-critical work](https://mattermost.com/webinar/cybersecurity-incident-response/) to learn about the key features and functionality to look for in your incident response tooling.
|
||||
|
||||
</Tip>
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: "Work with runs"
|
||||
---
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
A run is the execution of a collaborative playbook. You can start each run in a new channel or you can elect to use the same channel for multiple runs.
|
||||
|
||||
To access runs, select the product menu in the top-left corner of Mattermost, then select **Playbooks**. In the runs list, you can select a run to view more details, such as the overview and retrospective. This is an easy way to assess all the active runs to which you have access.
|
||||
|
||||
## Follow and participate
|
||||
|
||||
You don't have to be in a run's channel to follow the run. You can:
|
||||
|
||||
- **Follow**: If you're following a playbook, you won't necessarily be added to each of the playbook's runs but you will be added as a follower. To join a run channel, select **Participate** in the header of that run.
|
||||
- **Participate**: If you're participating in a run it's likely because you're in a team or group of people who've been added to it. In this case, you'll be able to follow the run in the run channel and also view the details in the list of runs in the **Playbooks** tab.
|
||||
|
||||
## View run details
|
||||
|
||||
When you’re in a channel with an active run, select the **Toggle Run Details** icon in the channel header to open the right-hand pane to view the run details. Information such as run name and description can be edited in-line, and the checklists can be collapsed and filtered based on their status.
|
||||
|
||||
Some run actions can be edited while the run is in progress. This increases visibility into the run's progress and can improve accountability.
|
||||
|
||||
## Playbook runs on mobile
|
||||
|
||||
From Mattermost server v11.0 and mobile app v2.34.0, mobile users can create and manage playbook runs for operational command at the edge.
|
||||
|
||||
## Runs and channel behavior
|
||||
|
||||
When you configure your playbook, you can decide whether each run of that playbook starts in a new channel or uses the same channel. You can run multiple playbooks in the same channel, simultaneously. Each playbook in use is listed in the RHS of the run channel.
|
||||
|
||||
If you decide to run a playbook in a new channel, you can do this when you start the run. In the channel RHS, select **Start run**. Then select how you'd like it to be executed.
|
||||
|
||||
<Tip>
|
||||
|
||||
- When deciding whether to reuse a channel for multiple runs, or create new channels for each playbook run, multiple runs in a single channel can help avoid too many channels being created, which can lead to channel overload.
|
||||
- Playbook run channels aren't automatically archived when runs are marked as complete; however, you can [archive channels](/end-user-guide/collaborate/archive-unarchive-channels#archive-a-channel) you no longer need, and system admins can [allow user access to archived channels](/administration-guide/configure/site-configuration-settings#allow-users-to-view-archived-channels) if needed. See the [multiple runs in a channel](/end-user-guide/workflow-automation/work-with-playbooks#multiple-runs-in-a-channel) documentation for additional considerations.
|
||||
- In contrast, using a dedicated channel for each playbook run can be helpful particularly in cases where strict [compliance](/administration-guide/comply/compliance-export) and [channel data export](/administration-guide/comply/export-mattermost-channel-data) is required.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Send outgoing webhooks
|
||||
|
||||
1. In your run, select **Toggle Run Details** to open the right-hand sidebar.
|
||||
2. Select **Run details**.
|
||||
3. In the **Run details** page, scroll down to **Actions**.
|
||||
4. Add your webhook URLs in the field provided. You can turn off this option using the toggle.
|
||||
5. Select **Save**.
|
||||
104
docs/main/end-user-guide/workflow-automation/work-with-tasks.mdx
Normal file
104
docs/main/end-user-guide/workflow-automation/work-with-tasks.mdx
Normal file
@@ -0,0 +1,104 @@
|
||||
---
|
||||
title: "Work with tasks"
|
||||
---
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
## Tasks and due dates
|
||||
|
||||
In some workflows, there are time constraints on tasks and others may have more flexible timeframes. Associating tasks with deliverable dates provides visibility into workloads and helps everyone stay accountable during the run.
|
||||
|
||||
To assign a due date to a task, select the **Toggle Run Details** icon to open the **Run Details** screen. Hover over the task you’d like to edit and select the calendar icon to assign a due date. Due dates can be used to sort tasks in the run overview.
|
||||
|
||||
When a due date is assigned to a task, and the task is overdue or due today, a reminder is added to the playbook's daily digest along with tasks that don't have an assigned due date. As tasks are completed, they're removed from the daily digest reminders. You can refresh the list of assigned tasks at any time using the `/playbook todo` slash command.
|
||||
|
||||
Due dates can be entered in text (e.g., "two minutes ago") or numerically (e.g., "15 March 2023").
|
||||
|
||||
## Task actions
|
||||
|
||||
You can automatically complete tasks in a playbook run using keyword triggers. When the keywords you've entered are mentioned in the run, the task is marked as completed.
|
||||
|
||||
For this feature, you should use a string of text rather than individual words. The search is an `ANY` search, meaning that if you used the individual words "target" and "completed", either of those words will trigger the action to be marked as complete. If you're using phrases that have formatting, make sure you use the Markdown formatting in the text field.
|
||||
|
||||
When you edit a task, you'll see the following:
|
||||
|
||||
- The text to search for in the messages
|
||||
- Ability to limit this for posts from a specific user (or bot)
|
||||
- Option to mark the task as done (or not).
|
||||
|
||||

|
||||
|
||||
## Conditional tasks
|
||||
|
||||
<PlanAvailability slug="entry-ent" />
|
||||
|
||||
From Mattermost v11.1, using Mattermost in a web browser or the desktop app, tasks can be conditionally included in playbooks based on attribute values or runtime conditions. This enables adaptive workflows where tasks are only presented when they're relevant to the current context. For example:
|
||||
|
||||
- **Security incidents**: Include additional forensic tasks for incidents classified as security-related.
|
||||
- **Customer tier workflows**: Show different approval processes based on customer subscription level.
|
||||
- **Geographic operations**: Include region-specific compliance tasks based on the location property.
|
||||
- **Skill-based assignments**: Automatically assign tasks to team members based on areas of expertise.
|
||||
|
||||
### Configure conditional logic
|
||||
|
||||
To set up conditional behavior in a playbook:
|
||||
|
||||
1. Go to **Product** <img src={useBaseUrl('/img/ui/products_E82F.svg')} alt="Navigate between Channels, collaborative playbooks, and boards using the product menu icon." className="theme-icon" /> icon and select **Playbooks**.
|
||||
|
||||
2. Select the playbook or run you want to add conditions to.
|
||||
|
||||
3. Select the **Outline** tab.
|
||||
|
||||
4. Under **Tasks**, identify a task you want to make conditional.
|
||||
|
||||
5. From the **More** <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> icon next to the task, select **Add condition**.
|
||||
|
||||

|
||||
|
||||
6. Select an attribute, condition, and value to define when the task should be included. Then select **Done editing**.
|
||||
|
||||

|
||||
|
||||
Conditional tasks are evaluated and automatically added to or removed from the checklist based on defined conditions. This reduces cognitive load by showing only relevant tasks and ensures that critical steps aren't overlooked in different scenarios.
|
||||
|
||||
<Tip>
|
||||
|
||||
You can add up to 2 conditions per task to create an either/or condition.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Task inbox
|
||||
|
||||
In addition to the daily digest, you also have access to a task inbox. The task inbox provides you with a cross-run overview of the tasks you're accountable for, sorted by due date.
|
||||
|
||||
You can:
|
||||
|
||||
- Access each task directly, without having to visit the individual runs.
|
||||
- Mark tasks as complete or skip them.
|
||||
- Change the task assignee from yourself to another team member. The task will then be removed from your inbox.
|
||||
- You can change the due date of tasks to manage priorities and urgency.
|
||||
|
||||
To view your task inbox, access the **Playbooks** tab in Mattermost. In the header, next to your profile image, select the tasks list icon. A list of every task assigned to you from every run that's in progress is displayed.
|
||||
|
||||
## Mobile playbooks task management
|
||||
|
||||
From Mattermost v11.0 and mobile v2.32.0, mobile users can perform the following task management operations on playbook runs:
|
||||
|
||||
### Interact with playbook tasks
|
||||
|
||||
- **Task interaction**: Tap on any task to open a detailed bottom sheet view with task options and information.
|
||||
- **Check/Uncheck tasks**: Complete or reopen tasks directly from the Mattermost mobile app.
|
||||
- **Skip/Unskip tasks**: Mark tasks as skipped or return them to active status as workflow requirements change.
|
||||
|
||||
### Update tasks
|
||||
|
||||
- **Update assignee**: Change who is responsible for completing a task directly from the mobile app.
|
||||
- **Modify due dates**: Adjust task deadlines to accommodate changing priorities and schedules.
|
||||
- **Edit task commands**: Update slash commands or instructions associated with tasks.
|
||||
- **Change run ownership**: Transfer run ownership between team members.
|
||||
- **Rename tasks**: Update a task's name to reflect evolving scope or priorities. (From Mattermost mobile v2.38.0)
|
||||
- **Add or edit task descriptions**: Add context to a task or update an existing description. (From Mattermost mobile v2.38.0)
|
||||
- **Delete a task**: This action cannot be undone. (From Mattermost mobile v2.37.0)
|
||||
|
||||
These mobile capabilities provide full task management functionality for teams working with playbooks while on mobile devices, complementing your existing desktop and web browser experiences.
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
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.
|
||||
Reference in New Issue
Block a user