Simple:Press Documentation

Plugin: Slack Integration

Plugin Description

Plugin: Slack Integration – This Simple:Press plugin integrates with Slack for displaying forum activity into a Slack channel or group. Slack is platform for team communications.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new “Slack Integration” section in the “Available Plugins – Install Simple:Press Plugins” panel under the forum Admin menu path Forum > Plugins > Available Plugins. From this panel the Simple:Press plugin can be activated, or deleted by the admin.
  • When properly installed, a new folder in the forum plugin folder named “slack” containing this plugin’s files.

Activating this plugin provides:

  • A change to the new “Slack Integration” section in the “Available Plugins – Install Simple:Press Plugins” panel under the Admin menu path Forum > Plugins > Available Plugins so the plugin can be deactivated, uninstalled, or have its Options set up.
    • The Options link goes to the new “Slack Integration Plugin” forum Admin panel the plugin’s administrative options are set up.
    • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.
  • A new “Slack Integration Plugin” forum Admin panel where:
      • specifics of the Slack communications are set up as well as Slack notifications.
      • The “Help” link should be used for assistance in setting up the options.
    • The “Slack Integration Plugin” forum Admin panel can also be accessed under the Admin menu path Forum > Components > Slack Integration.
  • A new forum Admin menu item “Slack Integration” on the menu path Forum > Components > Slack Integration where the “Slack Integration Plugin” forum Admin panel can be accessed.

There are no new permissions added to the permission sets due to this plugin.

Plugin Requirements

Slack must be set up and functional. It is suggested that Slack account(s) and communications information be known before this plugin is installed. More information regarding Slack, Slack accounts, and signing up is available at Slack.com.

Simple:Press version 5.5.6 and above is required.

The Simple:Press plugin must be installed, activated, and its options set before it is operational.

  • As part of the installation, a “Slack Integration” section is added to the “Available Plugins – Install Simple:Press Plugins” panel under the admin menu Forum > Plugins > Available Plugins. From this panel the plugin can be activated, deactivated, uninstalled, deleted, or its options set using its “Activate/Delete” and “Deactivate/Uninstall/options” selections.
    • The Options link goes to the new “Slack Integration Plugin” forum Admin panel where its options must be set up.

There are no new permissions added to the permission sets due to this plugin that must be set up.

The plugin has no (0) template tags so there are no recommendations made regarding developing Child Themes or Custom Themes to accommodate changes to template tags.

Plugin Installation and Activation

Please see Using Plugins on how to obtain and install this Simple:Press plugin.

  • Whatever method is used to add the Simple:Press plugin, the folder that should have been added to the forum plugin folder is named “slack“.
  • If using the “Simple:Press Upload Plugin – Upload a Simple:Press Plugin” panel at the forum Admin menu Forum > Plugins > Plugin Uploader, the folder to browse for after downloading it from the Simple:Press site is “slack.zip” before clicking the “Upload Now” button.

As mentioned there the default location for Simple:Press plugin folders is …/wp-content/sp-resources/forum-plugins. If this path is changed, it is important to note that the plugin’s folder and its content need to reside in the forum plugins folder wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Activation is accomplished from the Admin Dashboard panel menu by selecting Forum > Plugins > Available Plugins from the drop down forum Admin menu. On the “Available Plugins – Install Simple:Press Plugins” panel select the “Slack Integration” plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options” with a “Get Started” Link.

  • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.

To deactivate the plugin, click on “Deactivate”. The “Deactivate/Uninstall/Options” label changes to “Activate/Delete”.

Plugin Administrative Options

After activation, a) on the aforementioned “Available Plugins – Install Simple:Press Plugins” panel, click “Options” on the “Slack Integration” plugin section or b) under the “Components” entry on the forum menu on the left side forum admin page click the “Slack Integration” sub-menu item to get the “Slack Integration Plugin” panel with the “Slack Integration Options” and “Slack Integration Notifications” sections.

    • Slack Integration Options Inputs

In this section specifics of the Slack communications are set up.

      • In the text input box to the right of “Incoming WebHooks URL:” enter the Slack configured integration incoming webhook url. This can be obtained from Slack when creating a new Incoming WebHook integration.
      • In the text input box to the right of “Channel:” enter the channel name where notifications are to be sent.
        • Be sure to include the Slack required # in the channel name.
      • In the text input box to the right of “Username:” enter the custom name of the “bot” (connects to Slack using their “Real Time Messaging API) to deliver the notification.
      • If there are no other options to select on the panel, click on the “Update ” button at the bottom of the page to save the settings. Otherwise, proceed to the next option(s) to select.

 

    • Slack Integration Notifications Selections

In this section the notifications to receive in Slack are set up.

    • If new post notifications are to be received in Slack, click on the check box next to “Enable new post notifications to Slack” if there isn’t already a green check mark in it.
      • The check box is selected if it has a green check mark in it.
      • The check box is not selected if it is blank. De-select a check box containing a green check mark by clicking on it to remove the check mark.
    • If new user registration notifications are to be received in Slack, click on the check box next to “Enable new user registrations notifications to Slack” if there isn’t already a green check mark in it.
      • The check box is selected if it has a green check mark in it.
      • The check box is not selected if it is blank. De-select a check box containing a green check mark by clicking on it to remove the check mark.
    • If there are no other options to select on the panel, click on the “Update” button at the bottom of the page to save the settings. Otherwise, proceed to the next option(s) to select.

To be complete for multilingual forums, the language translation files for this plugin should be installed or downloaded/properly placed in the appropriate forum-language folder for SP plugins using one of the procedures below in the “Plugin Language Translation” section of this page.

Plugin Language Translation

A plugin may not have language translation files, but in general each Simple:Press plugin has its own language translation files each with multiple pages for translating the forum plugin’s message strings.

Forum Plugin translation files are to reside in a unique forum folder location as defined by the “Simple:Press Plugin Language Files” entry on the “Integration – Storage Locations” forum Admin panel available through the forum Admin menu at Forum > Integration > Storage Locations.

  • The default location for forum plugin translation files is the folder “…/wp-content/sp-resources/forum-language/sp-plugins”.

Information regarding downloading language files, “mo’ language file placement, and translation (language localization) is found at Localization.

WARNING: On the Localization page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.

More information is available regarding translation files at Simple:Press Translations. which is the repository for Simple:Press language translation files. On the base page, select the “Getting Started Guide” link for basics about it’s use. On that page, select the “register a username here” link to obtain a password to the site. Use the “Contact Form” link to request the desired language if it is not currently available. The “Contact Form” link may also be used to volunteer to be a validator for a translation project.

The “Slack Integration” plugin’s available language translation files with translation statistics, and message translations can be viewed at Slack Integration within the repository for Simple:Press language translation files.

  • Installing the Simple:Press “Slack Integration” Plugin Language Translation “.mo” files
    The plugin’s language translations files for each language can be correctly located in two ways.

    • Using the Admin Word:Press “Site Language” and Simple:Press “Language Translation” Features
      WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
        • Under the “Language Translation Selection Sequences” heading, the “Coordinated Language Translation File Download Using the Simple:Press ‘Language Translation’ Selection” section, follow the instructions at “Adding its Translation File(s) After Downloading/Activating a Simple:Press Theme or Simple:Press Plugin”.
          • Follow the instructions to select the “Site Language” and then get to the admin page with the “Integration – Language Translations” section where this plugin should have an entry.
          • Click on the “Install” button for this plugin, “Slack Integration” to install the language translation file for the current “Site Language” language.
            • Note: If the message “No Translation Project Exists” is displayed rather than the “Install” button, a translation file for that language could not be found in GlotPress at this time. Consider posting in the Simple:Press forum if it is felt there needs to be one added.
          • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
          • As called out in the section, continue to change the “Site Language” language and repeat the process until all desired translation files for this plugin have been installed.

       

    • Manually Finding and Storing Simple:Press Plugin’s Language Translation ‘mo’ files
    • WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
    • After reviewing the material discussed under the “Language Translation Selection Sequences” heading, the “Manual Installation of Simple:Press Language Translation Files section, follow the steps outlined at “Finding and Storing ANY Simple:Press Plugin’s Language Translation ‘mo’ files”.
    • Each time through the process at the step, “Scroll down the list and click on the name of the plugin whose language files are being sought to see the translation file Version Number available”, substitute “Slack” for the phrase “the name of the plugin whose language files are being sought”.
    • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
    • Repeat the steps for each language it is desired to have a translation file (french, spanish, etc.) for the plugin on the website.

Plugin Usage

Individuals with access to the Slack page (app, web, etc.) can see notifications for the forum activities selected by the forum Admin on the “Slack Integration Plugin” admin panel. The notifications possible are:

  • “New post notifications to Slack”
  • “New user registration notifications to Slack”

Plugin Special Notes

Slack must be set up and functional. It is suggested that Slack account(s) and communications information be known before this plugin is installed. More information regarding Slack, Slack accounts, and signing up is available at Slack.com.

Template Tags Used in the Plugin

There are no (0) template tags available for this plugin that allows further customization of the plugin’s usage or otherwise customize the website.

Action and Hooks Used in the Plugin

There are no Actions and Hooks available in the Plugin’s Template Tags because there are no template tags.
There are no other Actions and Hooks available for this plugin.

Plugin and Template Tag Changelog

Since Simple:Press version 5.5.6.

Codex page sync’d to code version 5.5.6 and plugin version 1.0.

More Topics In SimplePress: Plugins


Copyright © 2006-2019 Simple:Press. All Rights Reserved.