Installation

Prism

Community Edition

Deprecated v2.1.4

Installation Steps

CLI

For a shorter method of installing the plugin, follow the steps below

Terminal/Powershell

Open a Terminal/Powershell in your Prism plugin directory

Clone Repository

git clone https://github.com/fraktlfx/prism-slack.git Slack

Install Requirements

pip install -r requirements.txt -t ./PythonLibs

Manual

For a more manual method of installation, follow the steps below

Download

Download the plugin release package from the repository

Unzip

Unzip the folder (if needed)

Rename (Optional)

The top level folder must be called: Slack. Rename the folder if it’s needed.

Move

Move the plugin to the Prism plugins directory

Reload Prism

Restart/Reload Prism and the plugin should automatically appear in the plugin list enabled

Slack API’s

This step is only necessary if you didn’t use the CLI method of installation

We did not include the Slack API’s in the repository to limit the size of it. You can either download the release package or you can download it on your own.If you chose to download it on your own, please follow the steps below to do so.

Install Slack SDK

pip install slack_sdk

Install Slack Bolt

pip install slack_bolt

Locate Slack package install locations

pip show slack_sdk pip show slack_bolt

Copy/Move the packages

Copy/Move the now installed slack packages to the following folder: {PRISM_PLUGIN_DIRECTORY}/Slack/PythonLibs

Studio Edition

Installation Steps

Download

You can download the plugin from the email you received from Keyforge upon purchase of the subscription/perpetual license. The download button is at the bottom of the email.

Unzip and Move

You’ll be downloading a bundle that comes with most operating systems. Unzip and move the version you need to your Prism plugins directory or your custom location.

Install Requirements

Windows

Run the install_packages.bat file in order to install the required packages to make the Slack Studio Edition plugin work.We will make an attempt to locate your Python executable that comes bundled with Prism, but if we are not able to find it, we will ask you to input the path to it. We do this because we need to know what version of Prism you are running in order to install the proper libraries.

MacOS

Run the install_packages.command file in order to install the required packages to make the Slack Studio Edition plugin work.When installing on the mac, you will likely be hit with a quarantine message saying that

Apple could not verify “install_packages.command” is free of malware that may harm your Mac or compromise your privacy.

When trying to install by clicking on install_packages.command. To get the file to run, you need to then go into Settings -> Privacy & Security -> Scroll to the bottom and select “Open Anyway”.You can also open the file in a text editor to make sure that we aren’t putting anything malicious on your machine if you have security concerns.

Linux

Execute the install_packages.desktop file in order to install the required packages to make the Slack Studio Edition plugin work.Compared with the Windows edition of the plugin, the Linux version is going to require some level interaction from the user. As we are installing libraries according to the Prism python executable, we need to know where the location of your Prism installation resides. So when you run the script, it will ask you to input the path to your Prism installation, then we handle things from there.

License the Plugin

Open Prism and the plugin should automatically prompt you to authenticate your license and enter your email used to purchase the subscription/perpetual license.

Slack

Slack Prism App

Use the Provided Manifest

Locate the manifest.yml file in the Resources folder of the repository/plugin directory. This file simplifies the bot creation process.If you are unable to locate the file, you can expand the section below to see its contents based on the edition of the plugin.

Community Edition Manifest

Deprecated v2.1.4

display_information:
name: Prism
description: Slack bot for Prism Pipeline
background_color: "#0c3300"
features:
app_home:
    home_tab_enabled: false
    messages_tab_enabled: true
    messages_tab_read_only_enabled: true
bot_user:
    display_name: Prism
    always_online: true
oauth_config:
scopes:
    bot:
    - app_mentions:read
    - channels:history
    - channels:read
    - chat:write
    - chat:write.public
    - files:read
    - files:write
    - groups:history
    - groups:read
    - im:write
    - channels:join
    - users:read
settings:
event_subscriptions:
    bot_events:
    - app_mention
    - channel_created
    - function_executed
    - message.channels
    - message.groups
interactivity:
    is_enabled: true
org_deploy_enabled: false
socket_mode_enabled: true
token_rotation_enabled: false

Studio Edition Manifest

display_information:
name: Prism
description: Slack bot for Prism Pipeline
background_color: "#0c3300"
features:
app_home:
    home_tab_enabled: false
    messages_tab_enabled: true
    messages_tab_read_only_enabled: true
bot_user:
    display_name: Prism
    always_online: true
oauth_config:
redirect_urls:
    - https://127.0.0.1:5646
scopes:
    user:
    - openid
    - profile
    bot:
    - app_mentions:read
    - channels:history
    - channels:read
    - chat:write
    - chat:write.public
    - files:read
    - files:write
    - groups:history
    - groups:read
    - im:write
    - channels:join
    - users:read
settings:
event_subscriptions:
    bot_events:
    - app_mention
    - channel_created
    - function_executed
    - message.channels
    - message.groups
interactivity:
    is_enabled: true
org_deploy_enabled: false
socket_mode_enabled: true
token_rotation_enabled: false

Create your Slack app

Go to the Your Apps page on the Slack API website. Follow the instructions for creating apps using manifests provided on this page:
Creating Apps using manifests

Customize the App Icon

Once your app is create, navigate to the Basic Information page in the Slack API dashboard.
Under the Display Information section, upload an App Icon to personalize your app.

Install the App

In the left-hand menu, select the Install App section.
Install the app into your Slack workspace

Obtain your Client ID and Client Secret

Studio Edition

Required for Sign-in with Slack functionality

Go to the Basic Information page in the left-hand menu.
Copy the Client ID and Client Secret displayed on this page.

Enter Client ID and Client Secret in Prism Settings

Studio Edition
Open the Slack Project/Studio settings page in Prism. Paste the copied Client ID and Client Secret in the appropriate fields.

Obtain the Bot User OAuth Token

Go to the OAuth & Permissions page in the left-hand menu.
Copy the Bot User OAuth Token displayed on this page. It should start like this: xoxb-

Enter the token in Prism Settings

Open the Slack Project/Studio settings page in Prism. Paste the copied Bot User OAuth token in the appropriate field.

Obtain the Bot App-Level Token

Required if you want to enable Bolt server functionality

Go to the Basic Information page in the left-hand menu.
Select the Write token to open a window that contains a token that starts with: xapp-
If you do not see a token, then generate the Write Token

Enter App-Level Token

Required if you want to enable Bolt server functionality

Open the Slack Project/Studio Settings page in Prism. Paste the copied App-Level Token into the appropriate field to complete the integration.

PRISM_STUDIO_PATH

A Prism environment variable that defines the location of the Studio configuration file. Because the Slack plugin configuration file is stored in the same directory by default, pointing this variable to the Studio config ensures the Slack config can be located automatically. This allows Prism+ and non-Prism+ machines to work together without running into missing Slack configuration issues.

PRISM_SLACK_CONFIG_PATH

A Slack plugin environment variable that will allow you to point to a custom location to store and look for the Slack configuration file. This is useful if you want to keep the Slack configuration separate from the Studio configuration or if you want to point to a shared location for the Slack config that all machines can access.

Introduction

Prism

Slack

Development

API

Prism

Community Edition

CLI

Manual

Slack API’s

Studio Edition

Slack

Slack Prism App

PRISM_STUDIO_PATH

PRISM_SLACK_CONFIG_PATH

​Prism

​Community Edition

​CLI

​Manual

​Slack API’s

​Studio Edition

​Slack

​Slack Prism App

​PRISM_STUDIO_PATH

​PRISM_SLACK_CONFIG_PATH

Prism

Community Edition

CLI

Manual

Slack API’s

Studio Edition

Slack

Slack Prism App

PRISM_STUDIO_PATH

PRISM_SLACK_CONFIG_PATH