Appfire Docs+ Slack integration
- Robert Alexander Marshall
Overview
The Appfire Docs+ app provides two-way integration for Slack and Confluence.
Docs+ streamlines communication offering real-time updates, and enhances collaboration. The Comala Document Management integration with the Docs+ app can be used to
send a custom Slack message to one or more users using a workflow trigger with the send-slack-user action macro in an applied workflow
send Slack messages for default workflow notifications to users in a linked Slack workspace
This integration supports optimization of your document management and control, cross-functional collaboration, and aligns with modern workflow practices, increasing document management efficiency.
Requires Comala Document Management Data Center v7.3.0 or later in your instance and the Appfire Docs+ app.
Slack integration
Appfire Docs+ must be
installed and set up in your Confluence instance
After installation of the Appfire Docs+ app you need to
sign in with Slack in your Slack Workspace
create an application link for your Confluence instance
connect your Confluence user account to your Slack user
Refer to Appfire Docs+ installation and set up guide.
On installation and set up of the Appfire Docs+ app you can
Custom Slack messages can be generated using a workflow trigger listening for a Comala Document Management workflow event in an applied workflow. The workflow trigger uses the send-slack-user macro.
Enabling Slack notifications sends Comala Document Management default workflow notifications as Slack messages to associated users (approval assignees).
Add custom Slack messages
A custom Slack message can be sent using the send-slack-user action macro in a workflow trigger.
In an applied workflow
the workflow trigger listens for a Comala Document Management workflow event, for example,
pageapprovedon the workflow event, the send-slack-user macro, in the body of the trigger, creates and sends a message to one or more named users
Workflow setup
The send-slack-user macro is available from Comala Document Management Data Center v7.3.0 or later.
In your Confluence instance
create a new space (or navigate to an existing space)
In the space
go to Space Tools > Document Management
In the document management dashboard open the workflow builder
choose Create workflow
In the visual editor
choose the markup editor toggle { } option
replace the existing workflow markup in the Workflow Schema dialog box by copying and pasting the following markup
{workflow:name=my workflow}
{state:In Progress|approved=Approved}
{approval:Review|assignable=true}
{state}
{state:Approved|final=true|updated=In Progress|hideselection=true}
{state}
{trigger:pageapproved|approval=Review}
{send-slack-user:user=@user@|subject= approved: @pagetitle@}
The page @page@ has just been approved by you.
{send-slack-user}
{trigger}
{workflow}Save the workflow in the workflow builder
Exit to return to the space document management dashboard
Enable and apply the workflow in your space.
On a page, an approval transition from the In Progress state to the Approved state sends a Slack message to the current user.
Value references, for example, @user@, @pagetitle@, are valid in the send-slack-user macro subject and body. You can also add emoji markdown and some HTML markup elements
For example, the trigger below:
{trigger:statechanged|state=Approved}
{send-slack-user:user=@creator@|subject=:white_check_mark: Page approved: @pagetitle@}
:unicorn_face: Congratulations, this [page|@page@] has been approved!!
@page@
Approved by @user@ on @Review>approvaldate@.
Comment: @Review>approvalcomment@
{send-slack-user}
{trigger}Generates the following Slack message on the transition to the Approved state in the applied workflow.
Configure Slack Notifications
Slack messages can be configured to be sent for the default workflow notifications. The Slack notifications option can be set in
global workflow notifications dashboard for the whole instance
space notifications dashboard for each space
The space configuration, if set, takes precedence over the global configuration.
Global notifications configuration
In the app global Workflow Notifications configuration dashboard
choose Edit
check the Slack notification option
Save
When enabled, the default workflow notifications for the instance are sent to associated Slack users using the Appfire Docs+ app. For example, if State Expired Notifications is enabled and a due date added to the Published state in a workflow reached, the following Slack message is sent.
Notifications settings can be set for each space using the space tools Notifications dashboard. The space configuration overrides the global notifications configuration.
Space notifications configuration
In each space document management Notifications dashboard
scroll down to the Slack Notification option
choose Enabled from the dropdown option
The default workflow notifications, when enabled in the space, are sent to associated Slack users using the Appfire Docs+ app.
For example,
Task - Assignee when enabled, sends a Slack message to the task assignees for each workflow task-related event
Read Confirmation when enabled, sends a Slack message to read confirmation assignees for each workflow-related read confirmation event
Space notification configuration settings override the global notifications configuration.
Related Pages
Appfire Docs+
Comala Document Management