This article will walk through the steps on how to configure a Slack connector within the HubStor Connector Service (HCS).
The steps involved in creating a slack connector are:
Configuring the Slack environment
Creating a staging area
Authenticating the Slack connector
Configuring Slack connector settings
The settings required depend on the Slack plan.
Free, Standard, or Plus Plans
If possible, create a specific Slack user account for the HubStor connector. This Slack user must have the 'Workspace Admin' account type assigned to it.
When using an existing user for authentication, note the following:
- The user may see messages from Slackbot detailing export activity while the HubStor connector is running.
- The HubStor connector will perform housekeeping activities (removing old exports and export tokens) for exports created by its assigned user. You should remove all old exports assigned to the user prior to configuring the user to be used with the HubStor connector.
Slack Enterprise plans allow the use of the Discovery API. This uses an API token for connectivity and has some specific Workspace Settings and Permissions requirements.
For Enterprise accounts, contact HubStor to arrange to retrieve an Org token for HubStor.
The following requirements/recommendations come directly from Slack.
The HubStor Slack Connector will stage all Slack data from the workspace to a local folder on the Connector Service machine.
Ensure that a staging area folder is available for the connector to use. The staging area folder should have enough room to stage all the Slack data. Starting with 256 GB is recommended. It should also be restricted only to administrators (and the HubStor service account).
Note that long path support is not yet available for the Slack connector. The Staging area folder should be maintained in root of the drive (with no more than 35 characters of a path for the staging folder).
For Slack Enterprise plans, contact HubStor to retrieve your Org token. See the next section on where to input this in the Connector UI.
For Slack Free, Standard and Plus plans: use the Slack Administration Utility tool to retrieve the authentication token.
The following describes the Slack Connector
settings available in the HubStor Connector Service (HCS) user interface. After
creating the connector, use the “Update Connector…” button in the HCS UI to
access the settings.
Enable Diagnostic Logging – This
option is used to create a diagnostic file for HubStor support analysis
o For the first ingestion, set this value very high (e.g. 365 days) to capture the base set of Slack data.
o Once the initial crawl is complete, HubStor recommends a value of at most 7 days for efficient processing going forward.
o Note: Slack currently appears
to have a roughly 2 week retention on message edits/deletion change events. HubStor
does not recommend setting higher than 7 days as it is possible that message
edit/deletion events (shown in blue or red background in HTML) may be overwritten
in subsequent crawls.
Refresh Staging Area Only – This setting causes the connector to refresh
the staging area only, stopping before updating any locations into the online
Stor. This can be used if there is an issue with the staging area creation that
needs to be addressed without any unwanted changes online.