Skip to content

Customizer Integrations

Boards adds multiple features to other HCL Connections applications via Connections Customizer. For details about what features this adds, see the usage documentation.

These features require your Connections envirionment to have Customiser installed. If you're new to Connections Customizer, here's a great video introduction and the install documentation.

Installation

Customizer Reverse Proxy Configuration

Check the rules in your HTTP proxy that direct traffic to mw-proxy (customizer). See the relevant section from the install documentation.

Huddo Boards features appear on every page in Connections where the Connections header appears. Your rules should match every URL that appears in the browser address bar. As mentioned in the documentation above, you may want to avoid matching some URLs (like API requests) for better performance.

This example works well. If you have a suggestion for improvement, please open a GitHub issue.

files/customizer|files/app|communities/service/html|forums/html|search/web|homepage/web|social/home|mycontacts|wikis/home|blogs|news|activities/service/html|profiles/html|viewer

Add Resources to mw-proxy Server

  1. Get a terminal session to your mw-proxy server. e.g. via ssh
  2. Download and extract boards-extensions.tgz package to the /pv-connections/customizations/boards-extensions directory on your mw-proxy server.

    mkdir -p /pv-connections/customizations/boards-extensions
    curl -s https://docs.huddo.com/boards/connections/customizer/boards-extensions.tgz | tar zxvf - -C /pv-connections/customizations/boards-extensions
    

  3. If you have your own Boards deployment, replace https://boards.huddo.com with your Boards URL (e.g. https://connections.example.com/boards) in the settings file.

    sed -i.original 's|https://boards.huddo.com|https://connections.example.com/boards|g' settings.js
    

Add the app to Connections App Registry

  1. In a web browser, open https://connections.example.com/files/customizer/boards-extensions/manifest.json. You should see JSON similar to the screenshot below. Copy this JSON to the clipboard.
  2. Open the Connections Customizer App Registry: https://connections.example.com/appreg
  3. Click "New App" button
  4. Open Code Editor
  5. Paste the JSON from the clipboard, in to the editor
  6. Click Save Changes
  7. Your screen should look something like this: Appreg Code Editor

Disabling Extensions

Individual extensions within this package can be disabled using the Extensions screen or by editing the JSON in the Code Editor. For example, if you're not using Connections 8, you may want to disable the extensions for Connections 8. There is no major issue in keeping these enabled. However, disabling extensions that are not compatible or needed will stop unnecessarily loading that extension's code.

Keep in mind that any changes made will be discarded when following the Updating steps below. Appreg Extensions Screen

Updating

You can see when this package was last updated here. Open https://connections.example.com/files/customizer/boards-extensions/VERSION to see your version.

  1. To update, run

    /pv-connections/customizations/boards-extensions/update.sh
    
    on your mw-proxy server.

  2. Repeat the Boards URL configuration if necessary.

  3. Copy the updated https://connections.example.com/files/customizer/boards-extensions/manifest.json and overwrite the existing code in the Connections Customizer App Registry.

App Editor


Last update: 2022-08-01