This document outlines a standalone (all in one) deployment of Huddo Boards. This can be used as a proof of concept, staging deployment or even a production deployment for a limited number of users (e.g. < 500).
-You may run all services including database and file storage on one server, or you can use an external mongo database or s3 file store.
-Like all other deployments of Huddo Boards, this requires configuration of 2 domains: Application and API. e.g. boards.huddo.com and boards.api.huddo.com
+Tip
+This document outlines a standalone (all in one) deployment of Huddo Boards using docker-compose. This can be used as a proof of concept, staging deployment or even a production deployment for a limited number of users (e.g. < 500).
You may run all services including database and file storage on one server, or you can use an external Mongo database or S3 file store.
+Like all other deployments of Huddo Boards, this requires configuration of 2 domains: Application and API. e.g. boards.huddo.com and boards.api.huddo.com
RHEL (or Centos 7) server with:
You may use an external proxy or send traffic directly to the server. If you are sending traffic directly to the server, you will need pem encoded certificate (with full chain) and key.
+The implementation of this will require 2 domains in your environment (typically "boards." and "boards-api." subdomains), one for the web app and one for the API.
Boards uses 3 types of persistent data: mongodb, s3 file store and redis cache.
-Each of these may use external services or the included services in the template (this hugely changes the server demand).
-If using the included services, you will need to map directories for mongo and s3 containers to the data drive above, this data drive should be backed up however you currently backup data
-Most required variables are in the template, for more information see the Kubernetes docs
+Boards uses 3 types of persistent data:
+Each of these may use external services (e.g. Mongo Atlas) or the included services in the template (this hugely changes the server demand).
+Warning
+If using the included services, you must have a separate mount point on your server for persistent data with a directory each for mongo and s3(minio) storage. You will need to map directories for mongo and s3 containers to this data drive. This data drive should be backed up however you currently backup data.
+Please follow this guide to get access to our images in Quay.io so that we may give you access to our repositories and templates. Once you have access please run the docker login command available from the Quay.io interface, for example:
docker login -u="<username>" -p="<encrypted-password>" quay.io
+download the configuration files:
+ +update all example values in both files as required. Most required variables are in the template, for more information see the Kubernetes docs
+The minio credentials are are used to both set in the minio service and access it from other services, the x-minio-access field is used as the username in minio and the x-minio-secret is used as the password you can view minios documentation on these fields here: https://docs.min.io/minio/baremetal/reference/minio-server/minio-server.html#root-credentials and an example of the values used here: https://docs.min.io/docs/minio-docker-quickstart-guide.html the standard seems to be around 20 characters all caps/numbers for the username and around 40 characters any case / number for the password.
+The nginx proxy setup assumes that you will have 2 subdomains as stated above with a shared (wildcard) ssl certificate, both the certificate and key file for these domains need to be accessible to the server and the path filled in under the proxy section. you may use separate certificates if needed by mounting them both in the proxy service with appropriate naming and using the new mounted files in the nginx.conf.
Tip
+Authentication: the user environment variables in the compose file assume you are installing this in a Connections environment, these can be removed or replaced with a Microsoft 365 tenant info as shown here. For more info on other authentication methods contact the huddo team. The default variables for Domino are also included and can be uncommented as required.
+Start the deployment using the following command
+docker-compose -f ./boards.yml up -d
+The mount point on your system for the mongo data needs to include user 1001 with read/write access, see bitnami/mongodb for more info and full documentation.
+if your setup is not running, first check the db logs and make sure it is not complaining about permissions to write the files it needs
+docker-compose logs mongo
To remove any other network configuration/hops on the docker server you should be able to:
+curl -H "Host: your.web.url" --insecure https://localhost
+This should return the html from webfront
+curl -H "Host: your.api.url" --insecure https://localhost
+This should return the html for the swagger api documentation
+curl -H "Host: your.api.url" --insecure https://localhost/health
+This should return "{listening: 3001}"
If the above works then you may have configuration issues with a proxy / dns not pointing traffic to the docker server properly
+If it does not work then the local nginx proxy is probably not working, check docker-compose logs nginx to see if it points out any misconfiguration
The core image has ping enabled and has access to all others so you can use it to test connectivity
+docker-compose exec -it core sh
+ping user
+ping mongo
+... etc
+This site contains technical and user documentation for Huddo Apps. For purchase and product information visit huddo.com.
For the status of Huddo Boards Cloud, please see our status page.
"},{"location":"log4j/","title":"Log4j","text":"Recently a severe vulnerability was discovered in the log4j package. Details of that are here and Apache mitigation/patching details are here.
The status of the Huddo Applications in regard to the vulnerability are below.
"},{"location":"log4j/#badges","title":"Badges","text":"Badges does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.
"},{"location":"log4j/#analytics","title":"Analytics","text":"Analytics does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.
"},{"location":"log4j/#boards-websphere","title":"Boards WebSphere","text":"Boards WebSphere does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.
"},{"location":"log4j/#boards-dockercomponent-pack","title":"Boards Docker/Component Pack","text":"Boards Docker does not contain any Java and as such is not affected by this vulnerability.
"},{"location":"log4j/#boards-cloud","title":"Boards Cloud","text":"Boards Cloud does not contain any Java and as such is not affected by this vulnerability.
"},{"location":"log4j/#ccm-migrator","title":"CCM Migrator","text":"CCM Migrator does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.
"},{"location":"status/","title":"Status","text":"This page provides information on the status of our cloud services.
Huddo Boards Cloud - OnlinePlanned MaintenanceOffline
"},{"location":"analytics/install/add-widgets/","title":"Add Widgets","text":"So far, you have configured the location of the Huddo widgets. You will now add the widgets to the user interface.
"},{"location":"analytics/install/add-widgets/#add-the-configurators-widgets-to-their-communities","title":"Add the Configurators Widgets to their Communities","text":"Login to Connections and navigate to the previously created Badges Configurator Community
Click Community Actions then 'Add Apps' from the drop down menu
Select the Configurator to add to the Community
Click X
The Configurator will now be added to the main view.
We recommend removing all the default widgets from the main page (i.e. Forums, Bookmarks, Files and Feeds) to conserve screen real-estate, and making use of the Configurator widget easier. The default widgets may be removed or added back at any stage.
"},{"location":"analytics/install/add-widgets/#remove-the-default-widgets-optional","title":"Remove the Default Widgets (Optional)","text":"Click the Actions drop-down and select Delete
Fill in the required data then click Ok on the Delete prompt
"},{"location":"analytics/install/add-widgets/#add-the-huddo-analytics-widget-to-communities","title":"Add the Huddo Analytics Widget to Communities","text":"Login to Connections and navigate to the Huddo Analytics Community
Click Community Actions then 'Add Apps' from the drop down menu
Select HuddoAnalytics
Click X
We recommend removing all the default widgets from the main page (i.e. Forums, Bookmarks, Files and Feeds) to conserve screen real-estate, and making use of the Analytics widgets easier. The default widgets may be removed or added back at any stage.
Your first Huddo Analytics widget will now be added to the main view.
The default view shows the report categories. Once a report category is selected, default report instances for that category can be selected.
Once the report instance is selected, further options for that report can be selected.
The report currently configured is previewed below the options and can be saved for quick viewing on all subsequent page loads.
In the Huddo Analytics community, the Huddo Analytics widgets provide access to Connections Administrator level reports. In other communities, the Huddo Analytics widgets can be added to provide access to Community Manager level reports.
Multiple Huddo Analytics widgets are designed to exist in each community.
"},{"location":"analytics/install/add-widgets/#add-the-user-analytics-widget-to-the-home-page","title":"Add the User Analytics Widget to the Home page","text":"Adding widgets to the Home page of Connections is done through the Connections Web page.
Login to Connections as a user assigned to the admin security role of the Homepage application and navigate to the Administration tab.
Click the 'Add another app' button and enter the following details. Once you have defined each widget, click Save and then click the 'Add another widget' button to add the next.
Widget Type Widget Title URL Address Use HCL Connections specific tags Display on My Page Display on Updates Pages Opened by Default Multiple apps Prerequisites User Analytics iWidget Huddo User Analytics https://<CONNECTIONS_SERVER_URL>/Huddo/AnalyticsDashboard.xml False True False False True - Highlight the Huddo User Analytics widget in the Disabled widgets section and click Enable and it will now show in the Enabled widgets list.
It will also show on the Updates and Widgets tabs, if these options were selected.
"},{"location":"analytics/install/add-widgets/#add-the-huddo-user-analytics-widget-to-my-page","title":"Add the Huddo User Analytics Widget to My Page","text":"This step will ensure the User Analytics widget was defined successfully in the Administration section, and is working as expected. This step is a good introduction to User Reports, however is optional.
Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.
Open My Page through the Sidebar link or Home button and select Customize
Select Huddo User Analytics. If you cannot find it, look under the 'Other' category.
Click X
You will now have your first Huddo User Analytics Widget displayed in the My Page section. From here you can start using Analytics by selecting a report category, and then a specific reports instance.
Multiple Huddo User Analytics widgets are designed to exist on My Page.
"},{"location":"analytics/install/app/","title":"Install Application","text":"The Huddo Analytics Application is provided as a .war file that is to be installed as a WebSphere Application in your Connections server environment. The application provides the Huddo Analytics engine, as well as the widgets for user interaction.
"},{"location":"analytics/install/app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"Login to the WebSphere Integrated Solution Console for your Connections environment via a webbrowser.
Enter your administrator User ID and Password, then click the \u201cLog in\u201d button.
"},{"location":"analytics/install/app/#install-the-huddowar-file","title":"Install the Huddo.war file","text":"Navigate to Applications \u2192 Application Types \u2192 WebSphere enterprise applications
Click the Install button
Browse the Local File System Path for the downloaded Huddo.war file then Click Next
Check the Fast Path Option then Click Next
Change the Application name to Huddo then Click Next
Highlight the Nodes for the Application, including the IHS Node. Select the Badges Module, click Apply then Next.
Please Note: It\u2019s recommended that you create a separate cluster for Huddo if your Connections install is bigger than 10,000 users. You can do this via the ISC by clicking on Servers > Clusters > WebSphere application server clusters and then clicking New.
Click on Browse and map the default resources as shown. Click Next.
Enter Huddo as the Context Root, then click Next.
Please Note: The Huddo Installation guide assumes that the Context Root is set as \u2018/Huddo\u2019. If you set the Context Root to something other than \u2018/Huddo\u2019, then make sure that you replace \u2018/Huddo\u2019 with your Context Root when entering addresses.
Review the Installation Summary. Click Finish.
Review the Installation Results. Click Save.
Review the Synchronisation Summary. Click OK.
You have now successfully installed Huddo as a WebSphere Enterprise Application. Next, you will need to edit the security settings.
"},{"location":"analytics/install/app/#modify-the-huddo-application-security-role-assignments","title":"Modify the Huddo Application Security Role assignments","text":"During this step, we will be defining the authenticated users/groups for each Security Role.
Find Huddo in the list of enterprise applications and click on Huddo to open the application configuration screen
Click Security role to user/group mapping
To ensure that only authorised users have access to Huddo and its data, modify the mapping of the AllServlets and Reader roles to the Special Subjects: All Authenticated in Application/Trusted Realm, then Click OK
Please note: You may set the Reader role to Everyone to grant read-only access to Huddo widget data to unauthenticated users.
"},{"location":"analytics/install/apply-changes/","title":"Apply Changes","text":"The clusters must be restarted for the widget configuration changes to take effect.
"},{"location":"analytics/install/apply-changes/#restart-the-clusters","title":"Restart the Clusters","text":"Login to the Integrated Solution Console
Navigate to Servers \u2192 Clusters \u2192 WebSphere Application Server Clusters
Select all of the Connections Clusters
Click Ripplestart.
"},{"location":"analytics/install/comm-properties/","title":"Community Properties","text":""},{"location":"analytics/install/comm-properties/#step-6-additional-properties-for-communities-widgets-optional","title":"Step 6: Additional properties for Communities Widgets (OPTIONAL)","text":"At this stage, the Huddo Configuration Widget shows in the Communities Customization Palette for all Communities. This means they can be added to any community. However, they are restriced to function only in their respective Community created during this installation process. This message will be shown if theyare added to any other community.
It is possible to remove these Widgets from the Customizations Palette, so that users cannot see/add them to their Communties. This requires modifying the Configuration Widget definitions we created earlier in the widgets-config.xml file and restarting the clusters again.
Checkout and edit the widgets-config.xml file:
Connections 5.5
Connections 6.0
Connections 6.5
Locate the Configuration Widget definitions under the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
Add the attribute showInPalette=\"false\" to each Configurator you wish to hide from the Customizations page. We could not define this attribute earlier, as otherwise we wouldn\u2019t have been able to add the Widgets to the Configuration Communities.
Add the attribute loginRequired=\"true\" to each Community widget if you wish to hide the widgets from users that are not logged in. This is only applicable if your security settings for the Communities application allow users to view communities without logging in.
Your configuration should now look like this:
<widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\nCheck in the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
Then Restart the clusters.
"},{"location":"analytics/install/customising/","title":"Customising","text":""},{"location":"analytics/install/customising/#customising-huddo-strings-properties-images-optional","title":"Customising Huddo Strings, Properties & Images (Optional)","text":"You only need to perform this step if you wish to customise the user interface strings used in Huddo or the default properties used by the application, e.g. to use a custom context root etc. If you do not wish to do any of the above, you do not need to follow this step.
"},{"location":"analytics/install/customising/#customising-huddo-strings","title":"Customising Huddo Strings","text":"The files for customising Huddo Strings need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Please Note:
This step can be performed at any stage after the installation and is not required to complete the installation.
<installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultLang/{\n NAME_LABEL : \"User Name\",\n MESSAGE_LABEL : \"Notes\",\n MY_NETWORK : \"My Circle\",\n EVERYONE : \"All\",\n THIS_COMMUNITY : \"Community\",\n CONGRATULATIONS_PROFILE_COMPLETE_MSG : \"Congratulations on completing your profile!\",\n GRID_VIEW:\"Grid View\"\n}\nIf you wish to add specific customisations for different languages:
Example:
English: PROFILES_STATS_DIR/ HuddoStrings/en/UserInterfaceLang.js\nEnglish-UK: PROFILES_STATS_DIR/ HuddoStrings/en-gb/UserInterfaceLang.js\nFrench: PROFILES_STATS_DIR/ HuddoStrings/fr/UserInterfaceLang.js\nThe files for customising Huddo Properties need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Available properties files to customise:
Please Note:
<installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultProperties/The custom images need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Please Note:
This step can be performed at any stage after the installation and is not required to complete the installation.
Determine the image(s) to be customised in the HuddoImages folder from the location <installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultImages/
Common files customised include:\n kudos_stream.png (as seen in the Homepage Activity Stream)\n mobile_`<MOBILE_DEVICE>`.png (i.e. mobile_android.png etc \u2013 as seen for Huddo mobile)\nCreate a folder called HuddoImages in the directory given by the PROFILES_STATS_DIR Websphere Variable.
The Huddo Widgets provide the interface for user interaction within Connections. During this step, we will be configuring communities for secure access to the configuration interfaces for Badges and Metrics, as well as provisioning the Analytics widget, Badges/Thanks/Awards Summaries and Leaderboard widgets for end users as well as the Huddo News Gadget.
"},{"location":"analytics/install/install-widgets/#create-the-configurator-community","title":"Create the Configurator Community","text":"The Badges Configurator Widget is the widget that allows users to perform admin-level configuration of Huddo. The widget has been designed such that it is available to a specific Connections community where membership can be maintained, thereby securing access to the configurator. The HUddo Analytics Admin-level reports interface has been designed with the same concept, which is why the following steps will ask you to create 2 new communities.
Login to Connections, navigate to Communities and click Create a Community
Enter a name, such as Huddo Configurator
Set Access to Restricted
Specify Members as those people you wish to be able to edit Badge definitions. Users can be specified after clicking the Access Advanced Features link.
Enter any tags, web address and description you wish then click Save.
Note: Configurators requires a large column community layout to function properly. Either \u20183 Columns with side menu and banner\u2019, \u20183 Columns with side menu\u2019 or \u20182 Columns with side menu\u2019.
You have now created the Huddo Configurator Community.
Take note of the CommunityUUID in the URL address, as we will need this later.
"},{"location":"analytics/install/install-widgets/#create-the-huddo-analytics-administrator-community","title":"Create the Huddo Analytics Administrator Community","text":"The Huddo Analytics widget allows users to review Connections Usage data over specified time periods. Users have access to both reporting and graph functionalities. The following community will be used to host the Connections Administrator level reports and graphs.
Login to Connections, navigate to Communities and click Start a Community.
Enter a name, such as Huddo Analytics.
Set Access to Restricted.
Specify Members as those people you wish to be able to access Connections Administrator level reports and graphs. In Connections 5+, users can be specified after clicking the Access Advanced Features link.
Enter any tags, web address and description you wish and click Save.
You have now created the Huddo Analytics Administrator Community.
Take note of the CommunityUUID in the URL address, as we will need this later.
"},{"location":"analytics/install/install-widgets/#check-out-the-widgets-configxml-file","title":"Check out the widgets-config.xml file","text":"To install most of the Widgets you must edit the widgets-config.xml file for Profiles. This file contains the settings for each defined widget. To update this file, you must check the file out and, after making changes, you must check the file back in, as documented in the links below.
The widgets-config.xml file is a standard Connections file that is used to define the configuration settings for each of the widgets supported by Profiles and Communities. To update settings in the file, you must check the file out and, after making changes, you must check the file back during the same wsadmin session as the checkout for the changes to take effect.
Checking Out the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
"},{"location":"analytics/install/install-widgets/#configure-configurator-and-community-leaderboard-widgets","title":"Configure Configurator and Community Leaderboard Widgets","text":"By updating the widgets-config.xml with the code supplied below, the Badges Configurator and Huddo Community Analytics widgets will be made available. This will allow them to be placed into Connections Communities.
You must define the Widgets and where to find their associated .xml files. You will need the CommunityUuids you took note of earlier.
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
IMPORTANT: Don\u2019t forget to substitute the following placeholders with the corresponding values! YOUR_METRICS_COMMUNITY_UUID, YOUR_BADGES_COMMUNITY_UUID, YOUR_FILTERS_COMMUNITY_UUID , YOUR_ANALYTICS_COMMUNITY_UUID, CONNECTIONS_SERVER_NAME
<widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoAnalytics\" description=\"HuddoAnalytics\" modes=\"view edit\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AnalyticsDashboard.xml\" uniqueInstance=\"false\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"adminCommunityId\" value=\"YOUR_ANALYTICS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\nWe recommend using absolute URLs in widget-config.xml for reduced configuration complexity. If you have a requirement for the use of relative URLs and are unsure of the implications, you may discuss this with our support team.
"},{"location":"analytics/install/install-widgets/#check-in-the-widgets-configxml-file","title":"Check in the widgets-config.xml file","text":"Now that you have modified the widgets-config.xml, it must be checked back in to Connections. Please refer to the Connections product documentation for instructions on how to check in the widgets-config.xml file, located below.
Checking In the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
"},{"location":"analytics/install/install-widgets/#register-widgets-connections-60-cr1-onwards","title":"Register Widgets (Connections 6.0 CR1 onwards)","text":"Since Connections 6.0 CR1 it is now required to register third-party widgets in the widget-container for increased security. We have scripts and instructions for this here.
"},{"location":"analytics/install/install-widgets/#add-huddo-configuration-jsp-to-the-header","title":"Add Huddo configuration JSP to the header","text":"Perform this task to add Huddo Configuration information to Connections pages.
This is achieved by customising the header.jsp file, used for customizing the Connections Navigation bar.
If you have not customised the header.jsp file for your connections environment, please make a copy of the file from:
<WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/Homepage.ear/homepage.war/nav/templates
Paste the copy into the common\\nav\\templates subdirectory in the customization directory: <installdir>\\data\\shared\\customization\\common\\nav\\templates\\header.jsp
Edit the header.jsp file in the customisations directory add the following lines after the Moderation link and before the </ul> HTML tag as shown:
To add the Huddo Config JSP
--%><c:if test=\"${'communities' == appName || 'homepage' == appName || 'profiles' == appName}\"><%--\n --%><c:catch var=\"e\"><c:import var=\"kudosConfig\" url=\"http://${pageContext.request.serverName}/Kudos/kudosConfig.jsp\"/></c:catch><%--\n --%><c:if test=\"${empty e}\"><script type=\"text/javascript\">${kudosConfig}</script></c:if><%--\n--%></c:if><%--\nSave and close the file, the changes will take effect when the clusters are restarted. (See next task)
"},{"location":"analytics/install/install-widgets/#specify-huddo-analytics-admin-community-for-security","title":"Specify Huddo Analytics Admin Community for Security","text":"This change will not be picked up by Connections until the Huddo Application is restarted. This will be performed at the end of the configuration.
Create the resource.properties file in the Profiles Statistics customisation directory: <PROFILES_STATS_DIR>/HuddoProperties Where PROFILES_STATS_DIR is defined by the WebSphere variable: e.g. /opt/IBM/Connections/data/shared/profiles/statistics/HuddoProperties
Put the following line in the file, replacing <KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID> with the ID of the Huddo Analytics Community created in Task 2.4:
analyticsAdminCommunityID=<KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID>\nIMPORTANT: If a file of the same name already exists, merge the contents into the existing file.
"},{"location":"analytics/install/licence/","title":"Licence","text":"All versions of Huddo Badges and Analytics require a licence to function. If you do not have a licence file, please contact us at support@huddo.com
"},{"location":"analytics/install/licence/#upload-your-licence-file-in-the-badges-configurator","title":"Upload your licence file in the Badges Configurator","text":"Login to Connections Navigate to the Huddo Configurator Community.
Select the Settings tab in the BadgesConfigurator widget. If there are no tabs, this is the default view.
Click the Update Licence button.
Click Choose File and browse to your Huddo.licence file and click Upload.
"},{"location":"analytics/install/overview/","title":"Overview","text":"The following section provides an overview of the installation process and the packages that are to be installed. For an experienced Connections administrator or IBM WebSphere Application Server administrator, we expect that this installation process should take no longer than a couple of hours.
The install process for Huddo Analytics involves the following steps:
Please Note: These steps are only applicable to a new install of Huddo Analytics. For information about upgrading, please see the Huddo Analytics Update Guide.
"},{"location":"analytics/install/websphere-faq/","title":"Huddo Analytics Installation FAQ","text":""},{"location":"analytics/install/websphere-faq/#installation","title":"Installation","text":""},{"location":"analytics/install/websphere-faq/#images-do-not-work","title":"Images do not work","text":"Please go to the BadgesConfigurator->Settings tab then restart the Huddo Application.
"},{"location":"analytics/install/websphere-faq/#scheduler-not-running","title":"Scheduler not running","text":"Issue is with the timerManager in WAS. Create a new one to resolve issue.
"},{"location":"analytics/install/websphere-faq/#performance-tuning","title":"Performance tuning","text":"Review this guide for changes that can be made.
"},{"location":"analytics/install/websphere-faq/#connections-8-ui","title":"Connections 8 UI","text":"The new UI that comes with Connections 8 breaks some CSS of Analytics. Please use the below to fix it up, which can be applied as per the HCL Docs.t_admin_navbar_change_style.html)
.ConnectionsRankDropDown {\n border: 1px solid !important;\n}\n\n.KudosAnalyticsOptionSelect {\n border: 1px solid !important;\n}\n\n.AnalyticsCategoryList li div {\n font-size: 10px !important;\n}\n\n.KudosAnalyticsField .dijitReset.dijitInputField.dijitArrowButtonInner {\n width: 16px !important;\n}\nThis section covers the fundamental how-tos for accessing reports within Huddo Analytics
"},{"location":"analytics/user-guide/access-reports/#view-reports","title":"View Reports","text":"In order to view a report, you will need to add the Analytics widget applicable to your access level, select a report category and select a report.
"},{"location":"analytics/user-guide/access-reports/#add-an-analytics-widget","title":"Add an Analytics Widget","text":"This step will add the Huddo Analytics widget to the main view. The widget may be added in one of two ways based on your access level.
"},{"location":"analytics/user-guide/access-reports/#user-level","title":"User Level","text":"Open Homepage -> My Page -> Customize
Select Huddo User Analytics and Click X
"},{"location":"analytics/user-guide/access-reports/#community-level","title":"Community Level","text":"Open Community -> Community Actions -> Customize
Select Huddo Analytics then Click X
"},{"location":"analytics/user-guide/access-reports/#administration-level","title":"Administration Level","text":"Open Huddo Analytics Community -> Community Actions -> Customize
Select Huddo Analytics then Click X
"},{"location":"analytics/user-guide/access-reports/#select-a-report-category","title":"Select a Report Category","text":"The Huddo Analytics Widget should now be visible in the main view displaying an icon for each category of reports available. Please note that the categories visible to you may vary based on your access level. You may select a category by clicking on the icon to bring up the report selection menu.
"},{"location":"analytics/user-guide/access-reports/#select-a-report","title":"Select a Report","text":"A report menu containing reports relating to that category will now be visible below the icons. Select a report from the menu to preview it.
"},{"location":"analytics/user-guide/access-reports/#customise-reports","title":"Customise Reports","text":"All reports offer a range of options and filters to allow viewers to customise and personalise the report.
All reports have Query Parameters that define the context and scope of the underlying query for the report.
Table reports also have column filters (for filtering by value) and the ability to enable/disable columns (right click on column headers).
"},{"location":"analytics/user-guide/access-reports/#saving-reports","title":"Saving Reports","text":"Once you are satisfied with your report selection you can Save it. Click Save.
Personalise the report by specifying a custom title and description and click OK.
On save, the widget will switch to view-mode, hiding the query parameters. This report will now be loaded as per the saved configuration any time the page is opened.
"},{"location":"analytics/user-guide/access-reports/#managing-reports","title":"Managing Reports","text":"Reports can be managed at any stage during their lifecycle. The button in the top right hand corner provides access to the following functions:
"},{"location":"analytics/user-guide/access-reports/#refresh","title":"Refresh","text":"Reloads the widget. The report interface can be refreshed at any stage. Please be aware that most Connections environment data is refreshed on a schedule and will not be affected by this button.
"},{"location":"analytics/user-guide/access-reports/#edit","title":"Edit","text":"Reopens the report in edit-mode for customising. Any changes to the report parameters that are made to the report and saved will overwrite the existing report. Please ensure you add a new widget if you wish to keep the existing report.
"},{"location":"analytics/user-guide/access-reports/#move-updown","title":"Move Up/Down","text":"Reports can be positioned in any order. They can also be dragged and dropped. This is based on the Connections widget layout.
"},{"location":"analytics/user-guide/access-reports/#remove","title":"Remove","text":"If you no longer require the current report you can remove it. Note: this cannot be undone.
"},{"location":"analytics/user-guide/available-reports/","title":"Available Reports","text":""},{"location":"analytics/user-guide/available-reports/#reporting-access-levels","title":"Reporting Access Levels","text":"The Reports within Huddo Analytics are divided into 3 separate access levels based on the role of a User within Connections, to allow for more targeted and relevant reporting.
"},{"location":"analytics/user-guide/available-reports/#personal-analytics","title":"Personal Analytics","text":"All users are presented with reports about their own activity and content to allow them to analyse and understand their own usage of Connections. These reports can be accessed through the \u2018My Page\u2019 area in the Homepage application.
Examples - My Most visited Blogs, My Recent Network Contact, My Recent Followers, etc.
"},{"location":"analytics/user-guide/available-reports/#community-level-analytics","title":"Community Level Analytics","text":"Community managers/owners are presented with reports that help monitor their Community\u2019s usage and adoption. These reports can be accessed through the Huddo Community Analytics widget. These reports can only be accessed and customised by the Owners of the Community.
Examples \u2013 Most Popular Ideas, Number of Visits Over Time, Most Recent Members, etc.
"},{"location":"analytics/user-guide/available-reports/#overall-admin-connections-analytics","title":"Overall (admin) Connections Analytics","text":"Overall Connections Reports focus on usage and adoption of the entire Connections environment. These reports are accessed in a very similar way to Community reports but they are only available within the \u2018Huddo Analytics\u2019 community as defined in the widgets-config.xml file during installation. Please see the Installation guide for more details.
Examples - Most Active Users, Most Active Content, Percentage of Users Active in BUILDING, Connections Usage by Application, etc.
"},{"location":"analytics/user-guide/available-reports/#categories-of-reports","title":"Categories of Reports","text":"Huddo Analytics includes over 100 pre-defined graphs and data reports to help monitor user-adoption and usage within Connections. In addition, further reports can be created by Connections Administrators and Community Managers using the Custom Report templates. Most reports are organised into the five main categories as listed below.
Connections - Reports in this category provide an overview of user activity within Connections e.g. Number of Visit Events Over Time, Number of Create Events by Application
Demographics - These Reports are based on user groups defined by Profile attributes e.g. _Connections Usage by Country, Connections Usage by Building, Percentage of Users Active in Each Building
Content Content Reports provide an insight into the different types of content as well as content with specific attributes within Connections e.g. Most Created Types of Content, Most Followed Content, Most Visited Content
User - These Reports \u2013 are aimed at enabling the viewer to identify users based on their usage of Connections e.g. Inactive Users, Users Ranked by Number of Visits, Most Active Users
Community Community reports help identify communities based on usage and adoption related attributes such as size, contributions e.g. Largest Communities, Most Active Communities usage
There is also a Huddo report category for Huddo Badges/Thanks/Awards.
Huddo Huddo reports help quantify Badges/Thanks/Awards received on Badge and User e.g. Total Awarded Badges, Thanks Awarded usage, Huddo Summary Report
"},{"location":"analytics/user-guide/available-reports/#default-available-reports","title":"Default Available Reports","text":"Below is a full list of all reports provided as part of Huddo Analytics, organised by Report Access Level and Category.
"},{"location":"analytics/user-guide/available-reports/#personal-analytics_1","title":"Personal Analytics","text":""},{"location":"analytics/user-guide/available-reports/#huddo","title":"Huddo","text":"Name Type Purpose My Huddo Badges (Last Month) Table Displays the Huddo Badges awarded to users in the previous month My Huddo Thanks (Last Month) Table Displays your Huddo Thanks given and received in the previous month My Huddo Awards (Last 6 Months) Table Displays your Huddo Awards received in the previous 6 months My Colleagues Recently Awarded Badges Table Displays the Huddo Badges recently awarded to my colleagues"},{"location":"analytics/user-guide/available-reports/#connections","title":"Connections","text":"Name Type Purpose My Application Usage Pie A pie chart showing your activity for each Application as a percentage of the total activity My Connections Visits Trend A trend line showing the number of visits made by you over time My Connections Contributions Trend A trend line showing the number of contributions made by you over time My Status Updates Over Time Trend A cumulative trend line showing the number of status updates created by you #### Content Name Type Purpose My Activities by Users Bar Ranks your Activities by Number of Users My Blogs Posts by Visits Bar Ranks your Blogs Posts by number of visits My Blogs by Posts Bar Ranks your Blogs by Posts My Bookmarks by Visits Bar Ranks your Bookmarks by Visit My Ideation Blogs by Ideas Bar Ranks your Ideation Blogs by Ideas My Ideas by Votes Bar Ranks your Ideas by Votes My File Folders by Contents Bar Ranks your File Folders by Contents My Files by Download Bar Ranks your Files by Downloads My Files by Shares Bar Ranks your Files by Shares My File Library Visitors Bar Users visiting your File Library My Forums by Visits Bar Ranks your Forums by Visit My Forums by Topics Bar Ranks your Forums by Topics My Forum Topics by Visits Bar Ranks your Forum Topics by Visits My Forum Topics by Replies Bar Ranks your Forum Topics by Replies My Wiki Pages by User Visits Bar Ranks your Wiki Pages by User Visits My Wiki Pages by User Updates Bar Ranks your Wiki Pages by User Updates My Most Creates Types of Content Bar A bar chart showing your most created types of content My Most Active Content Table Ranks Content Created by you by the amount of user activity My Least Active Content Table Ranks content created by you by the amount of user activity My Most Followed Content Table Ranks your content by number of followers My Most Active Community Content Table Ranks Content in communities that you own by the amount of user activity My Lease Active Community Content Table Ranks Content in communities that you own by the amount of user activity"},{"location":"analytics/user-guide/available-reports/#user","title":"User","text":"Name Type Purpose My Recent Network Contacts Table List your Recent Network Contacts My Recent Followers Table Lists your Recent Followers My Recent Content Followers Table Displays Connections Users following your content"},{"location":"analytics/user-guide/available-reports/#community","title":"Community","text":"Name Type Purpose My Most Active Communities Bar Bar chart showing Communities you own by the amount of user activity My Most Visited Communities Bar Bar chart showing the most visited communities owned by you My Communities by Contributions Bar Bar chart showing your Communities with the most number of content being created My Lease Active Communities Table Table showing Communities you own by the amount of user activity Most Recent Public Communities Table Table showing the most recently created Public Communities"},{"location":"analytics/user-guide/available-reports/#community-level-analytics_1","title":"Community Level Analytics","text":""},{"location":"analytics/user-guide/available-reports/#connections_1","title":"Connections","text":"Name Type Purpose Total Number of Events by Application Pie Displays activity within each Application as a percentage of total activity Number of VISIT Events by Application Pie Displays number of VISIT events within each Application as a percentage of total number of VISIT events Number of CREATE Events by Application Pie Displays number of CREATE events within each Application as a percentage of total number of VISIT Unique Users VISIT Events by Application Pie Bar chart showing the number of Unique Users VISIT events for each application Unique Users CREATE Events by Application Pie Bar chart showing the number of Unique Users CREATE events for each application Unique User Events by Application Pie Pie chart showing the number of Unique User events for each application Number of VISIT Events Over Time Trend Graph showing the total number VISIT events over a selected time period Number of CREATE Events Over Time Trend Graph showing the total number CREATE events over a selected time period Unique User VISIT Events Over Time Trend Trend line showing the number of Unique User VISIT events over a selected time period Unique User CREATE Events Over Time Trend Trend line showing the number of Unique Users CREATE events over a selected time period First VISIT Events Over Time Trend Trend line showing the number of first-time user VISIT events over a selected time period First CREATE Events Over Time Trend Trend line showing the number of first-time user CREATE events over a selected time period. Can be filtered by Community Source, Item Type and Event Type Total Number of Events by Device Pie Displays activity from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Number of VISIT Events by Device Pie Displays number of VISIT events from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Number of CREATE Events by Device Pie Displays number of CREATE events from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Unique Users VISIT Events by Device Pie Displays number of Unique Users CREATE events for each Device. Data available from Connections 5.0 onwards Unique Users CREATE Events by Device Pie Displays number of Unique User events for each Device. Data available from Connections 5 onwards Unique User Events by Device Pie Displays activity from each Device as a percentage of total activity. Data available from Connections 5.0 onwards"},{"location":"analytics/user-guide/available-reports/#content","title":"Content","text":"Name Type Purpose Most Created Types of Content Bar Graph showing the most created content types in this Community Most Visited Bookmarks Bar Chart showing the bookmarks that have the most visits Most Popular Ideas Bar Chart showing the Ideas that have received the most votes Most Downloaded Files Bar Chart showing the Most downloaded files in the Community Forums with Most Topics Bar Graph showing the Forums with most topics in the Community Forum Topics with Most Replies Bar Graph showing Forum Topics with the most replies Most Updated Wiki Pages Bar Graph showing Wiki Pages in the community by number of UPDATE events Activities with Most Number of Users Bar Chart showing the activities with the most number of users Unique Visitors to the File Library Over Time Trend Trend line showing the number of Unique Visitors to the Community's File Library Most Active Content Table Table showing content with the most number of events generated Most Followed Content Table Table showing content with the most number of followers Most Recent Content Table Table showing the most recently created content Custom Content Report Table Table for creating custom Content-related reports"},{"location":"analytics/user-guide/available-reports/#user_1","title":"User","text":"Name Type Purpose Users Ranked by Number of Visits Bar Chart showing Users who have the most VISIT events in this community Users Ranked by Number of Contributions Bar Chart showing Users who have the most CREATE events in this community Most Recent Members Table Table listing the most recent Members of this Community Most Recent Followers Table Table listing the most recent Followers of this Community Custom User Report Table Table for creating custom Users-related reports"},{"location":"analytics/user-guide/available-reports/#demographics","title":"Demographics","text":"Name Type Purpose Community Usage by COUNTY Pie Pie chart showing the activity in each Country as a percentage of the total activity Number of Active Community Users by COUNTRY Bar Bar chart showing the number of Active Users in each Country Percentage of Community Users Active in COUNTRY Bar Bar chart showing the percentage of Active Users in each Country Community Usage by BUILDING Pie Pie chart showing the activity in each Building as a percentage of the total activity Number of Active Community Users by BUILDING Bar Bar chart showing the number of Active Users in each Building Percentage of Community Users Active in BUILDING Bar Bar chart showing the percentage of Active Users in each Building Community Usage by DEPARTMENT Pie Pie chart showing the activity in each Department as a percentage of the total activity Number of Active Community Users by DEPARTMENT Bar Bar chart showing the number of Active Users in each Department Percentage of Community Users Active in DEPARTMENT Bar Bar chart showing the percentage of Active Users in each Department Community Usage by FLOOR Pie Pie chart showing the activity in each Floor as a percentage of the total activity Number of Active Community Users by FLOOR Bar Bar chart showing the number of Active Users in each Floor Percentage of Community Users Active in FLOOR Bar Bar chart showing the percentage of Active Users in each Floor Usage Data Report by COUNTRY Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Country Usage Data Report by BUILDING Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Building Usage Data Report by DEPARTMENT Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Department Usage Data Report by FLOOR Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Floor"},{"location":"analytics/user-guide/available-reports/#overall-connections-analytics","title":"Overall Connections Analytics","text":""},{"location":"analytics/user-guide/available-reports/#connections_2","title":"Connections","text":"Name Type Purpose Total Number of Events by Application Pie Displays activity within each Application as a percentage of total activity Number of VISIT Events by Application Pie Displays number of VISIT events within each Application as a percentage of total number of VISIT events Number of CREATE Events by Application Pie Displays number of CREATE events within each Application as a percentage of total number of VISIT events Unique User Events by Application Pie Pie chart showing the number of Unique User events for each application Unique Users VISIT Events by Application Pie Bar chart showing the number of Unique Users VISIT events for each application Unique Users CREATE Events by Application Pie Bar chart showing the number of Unique Users CREATE events for each application Number of VISIT Events Over Time Trend Graph showing the total number VISIT events over a selected time period Number of CREATE Events Over Time Trend Graph showing the total number CREATE events over a selected time period Unique User VISIT Events Over Time Trend Trend line showing the number of Unique User VISIT events over a selected time period Unique User CREATE Events Over Time Trend Trend line showing the number of Unique Users CREATE events over a selected time period First VISIT Events Over Time Trend Trend line showing the number of first-time user VISIT events over a selected time period First CREATE Events Over Time Trend Trend line showing the number of first-time user CREATE events over a selected time period Total Number of Events by Device Pie Displays activity from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Number of VISIT Events by Device Pie Displays number of VISIT events from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Number of CREATE Events by Device Pie Displays number of CREATE events from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Unique Users VISIT Events by Device Pie Displays number of Unique Users CREATE events for each Device. Data available from Connections 5.0 onwards Unique Users CREATE Events by Device Pie Displays number of Unique User events for each Device. Data available from Connections 5.0 onwards Unique User Events by Device Pie Displays activity from each Device as a percentage of total activity. Data available from Connections 5.0 onwards"},{"location":"analytics/user-guide/available-reports/#huddo_1","title":"Huddo","text":"Name Type Purpose Huddo Badges Distribution Column A histogram displaying the current distribution of users based on the number of Huddo Badges achieved by them. This can be filtered by Category Profile Progress Distribution Column A histogram displaying the current distribution of users based on the percentage of completion of their profiles as calculated by the Huddo Profile Progress widget Huddo Thanks Distribution Column A histogram displaying the current distribution of users based on the number of Huddo Thanks given and received by them Huddo Badges Awarded Table - Huddo Awards Awarded Table - Huddo Thanks Awarded Table - Huddo Badges Awarded by Users Table - Huddo Awards Awarded by Users Table - Huddo Thanks Awarded by Users Table - Huddo Summary Report Table - Profile Progress for Users Table -"},{"location":"analytics/user-guide/available-reports/#demographics_1","title":"Demographics","text":"Name Type Purpose Connections Usage by COUNTRY Pie Bar chart showing the activity in each Country as a percentage of the total activity Number of Active Users by COUNTRY Bar Bar chart showing the number of Active Users in each Country Percentage of Users Active in COUNTRY Bar Bar chart showing the percentage of Active Users in each Country Connections Usage by BUILDING Pie Bar chart showing the activity in each Building as a percentage of the total activity Number Active Users by BUILDING Bar Bar chart showing the number of Active Users in each Building Percentage of Users Active in BUILDING Bar Bar chart showing the percentage of Active Users in each Building Connections Usage by DEPARTMENT Pie Pie chart showing the activity in each Department as a percentage of the total activity Number of Active Users by DEPARTMENT Bar Bar chart showing the number of Active Users in each Department Percentage of Users Active in DEPARTMENT Bar Bar chart showing the percentage of Active Users in each Department Connections Usage by FLOOR Pie Pie chart showing the activity in each Floor as a percentage of the total activity Number of Active Connections Users by FLOOR Bar Bar chart showing the number of Active Users in each Floor Percentage of Connections Users Active in FLOOR Bar Bar chart showing the percentage of Active Users in each Floor Usage Data Report by COUNTRY Table Table showing number of active users, percentage of active users, total number of users, and percentage of activity each Country Usage Data Report by BUILDING Table Table showing number of active users, percentage of active users, total number of users, and percentage of activity each Building Usage Data Report by DEPARTMENT Table Table showing number of active community users, percentage of active community users total number of community users, and percentage of activity each Department Usage Data Report by FLOOR Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Floor"},{"location":"analytics/user-guide/available-reports/#content_1","title":"Content","text":"Name Type Purpose Most Created Types of Content Bar Graph showing the most created content types across Connections Number of Status Updates Created Over Time Trend Graph showing the total number of Status Updates posted over a selected period of time Most Active Content Table Table showing content with the most number of events generated Least Active Content Table Table showing content with the least number of events generated Most Visited Content Table Table showing content with the most number of visit and read events generated Most Followed Content Table Table showing content with the most number of followers File Libraries by Computed Size (MB) Table Table showing File Libraries with their Computed Size in Megabytes Custom Content Report Table Table for creating custom Content-related reports Custom Content Report Inc. Parent Table Table for creating Content-related reports which includes the Parent Name"},{"location":"analytics/user-guide/available-reports/#user_2","title":"User","text":"Name Type Purpose Users With Most Network Contacts Bar Chart of Users who have the most number of Network Contacts Most Active Users Table Table of users who have generated the most number of events in Connections in the selected time period Least Active Users Table Table of users who have generated the least number of events in Connections in the selected time period Inactive Users Table Table of Users who have no activity in Connections in the selected time period Recently Active Users Table Table of Users that have been active in the last week with Number of Events and Date of last activity Users with Most Contributions Table Table of Users with the most number of CREATE events in the selected time period First Time Users Table Table of Users showing the most recent first time Users New Users CREATE Events Table Table of Users who have recently made their first contribution to Connections, i.e. first CREATE event Custom User Report Table Table for creating custom Users-related reports"},{"location":"analytics/user-guide/available-reports/#community_1","title":"Community","text":"Name Type Purpose Communities with Most Events Bar Chart showing the Communities with the highest number of events Communities with Most VISIT Events Bar Bar Chart showing the Communities with the highest number of VISIT events Communities with Most CREATE events Bar Bar Chart showing Communities with the highest number of CREATE events Largest Communities Bar Bar Chart showing the Communities with the most number of Members Communities with Most Events Table Table of Communities with the most number of events in Connections in the selected time period Communities with Least Events Table Table of Communities with the least number of events in Connections in the selected time period Most Recent Communities Table Table showing the most recently created Communities Custom Community Report Table Table for creating custom Communities-related reports"},{"location":"analytics/user-guide/itemtype-map/","title":"Event Map","text":""},{"location":"analytics/user-guide/itemtype-map/#metrics-event-itemtype-map","title":"Metrics Event ItemType Map","text":"Below is a table displaying the Item Types applicable for each Event Type for each Connections Application. This is for advanced users who wish to further understand and take advantage of the Source, Event Type and Item Type filters provided in the reports query parameters. Please note that this is a guideline only. Event-ItemType associations may vary based on Connections version, environment variables, usage, installed applications etc.
"},{"location":"analytics/user-guide/itemtype-map/#activities","title":"Activities","text":"Event COMPLETE Activity ToDo COPY Activity Template CREATE Activity Attachment CommentEntrySectionTagTemplateTodo DELETE Activity Attachment CommentEntrySectionTemplateTodo FOLLOW Activity MOVE Section READ EntryTodo TAG Activity CommentEntrySectionTemplateTodo UNCOMPLETE Activity ToDo UNDELETE Activity CommentEntrySectionTodo UNFOLLOW Activity UNTAG Activity CommentEntrySectionTemplateTodo UPDATE Activity Attachment CommentEntryMembershipSectionTemplateTodo VISIT Activity Default Membership VISIT_DUP Activity DefaultNot Relevant: ADD, APPROVE, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, PIN, PREVIEW, RECOMMEND, REJECT, REMOVE, RESTORE, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#blogs","title":"Blogs","text":"Event ADD Membership APPROVE Comment Entry CREATE Blog Comment Entry File Tag Trackback DELETE Blog Comment Entry File Membership FOLLOW Blog READ Entry RECOMMEND Comment Entry REJECT Comment Entry RESTORE Comment Entry TAG Blog Comment Entry UNFOLLOW Blog UNRECOMMEND Entry UNTAG Blog Comment Entry UPDATE Blog Entry Membership VISIT Administration Blog Default ManageBlog VISIT_DUP Blog DefaultNot Relevant: COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, REMOVE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN,, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#bookmarks","title":"Bookmarks","text":"Event CREATE Bookmark Tag DELETE Bookmark READ Bookmark TAG Bookmark UNTAG Bookmark UNWATCH Person Tag UPDATE Bookmark VISIT Bookmark Default VISIT_DUP Bookmark Default WATCH Person TagNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, FOLLOW, GRADUATE, LOCK, MOVE, PIN, PREVIEW, RECOMMEND, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, VOTE
"},{"location":"analytics/user-guide/itemtype-map/#communities","title":"Communities","text":"Event ADD Invite Membership CREATE Bookmark Comment CommunityFeedTagWallpostWidget DECLINE Invite DELETE Bookmark Comment CommunityFeedInviteMembershipWallpostWidget FOLLOW Community RECOMMEND Wall RESTORE Community TAG Bookmark Community Feed UNFOLLOW Community UNRECOMMEND Wall UNTAG Bookmark Community Feed Membership UPDATE Bookmark CommunityFeedMembership VISIT Communities Community Default VISIT_DUP Communities Community DefaultNot Relevant: APPROVE, COMPLETE, COPY, DOWNLOAD, EMPTY, FOLLOW, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, REJECT, REMOVE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#files","title":"Files","text":"Event ADD CommunityFile Share CREATE Collection Comment FileLibraryMediafileTag DELETE Collection Comment FileFileversionLibraryMediafile DOWNLOAD File Mediafile EMPTY Trash FOLLOW Collection File Mediafile READ File RECOMMEND File REJECT Comment File REMOVE Collection CommunityFile RESTORE Comment File Filerversion TAG Collection Comment File Library UNDELETE File UNFOLLOW Collection File UNRECOMMEND File UNTAG Collection Comment File Library UPDATE Collection Comment FileLibraryMediafileMembership VISIT Default Folder Library VISIT_DUP Default LibraryNot Relevant: APPROVE, COMPLETE, COPY, DECLINE, GRADUATE, LOCK, MOVE, PIN, PREVIEW, UNCOMPLETE, UNLOCK, UNPIN, UNWATCH, VISIT, VISIT_DUP
"},{"location":"analytics/user-guide/itemtype-map/#forums","title":"Forums","text":"Event CREATE Attachment ForumReplyTagTopic DELETE Attachment ForumReplyTopic FOLLOW Forum Topic LOCK Forum Topic MOVE Forum Topic PIN Topic READ Reply Topic REJECT Forum Topic TAG Forum Reply Topic UNDELETE Forum Topic UNFOLLOW Forum Topic UNLOCK Forum Topic UNPIN Topic UNTAG Forum Reply Topic UPDATE Reply Topic VISIT Activity Default MembershipNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, PREVIEW, READ, REMOVE, RESTORE, UNCOMPLETE, UNRECOMMEND, UNWATCH, VISIT_DUP, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#homepage","title":"Homepage","text":"Event CREATE Tag Widget DELETE Widget TAG Watchlist UNTAG Watchlist VISIT Activitystream Activitystream.actionrequired Activitystream.atmentions Activitystream.discover Activitystream.imfollowing Activitystream.mynotifications Activitystream.saved Activitystream.statusupdates Default Gettingstarted Widgets VISIT_DUP Activitystream Activitystream.atmentions Activitystream.discover Activitystream.imfollowing Activitystream.mynotifications Activitystream.statusupdates Default Gettingstarted WidgetsNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, FOLLOW, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, RECOMMEND, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, UPDATE, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#ideation-blog","title":"Ideation Blog","text":"Event APPROVE Comment Idea CREATE Comment File Idea IdeationBlog Tag Trackback DELETE Comment File Idea IdeationBlog GRADUATE Idea READ Idea RECOMMEND Comment REJECT Comment Idea RESTORE Comment Idea TAG Comment Idea IdeationBlog UNTAG Comment Idea IdeationBlog UPDATE Idea IdeationBlog VISIT Default Ideationblog Manageblog VISIT_DUP Default Ideationblog VOTE IdeaNot Relevant: ADD, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, FOLLOW, LOCK, MOVE, PIN, PREVIEW, REMOVE, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, UPDATE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#media-gallery","title":"Media Gallery","text":"Event CREATE Mediafile DELETE Mediafile DOWNLOAD Mediafile FOLLOW Mediafile PREVIEW Mediafile READ Mediafile UPDATE Mediafile VISIT Default LibraryNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, EMPTY, GRADUATE, LOCK, MOVE, PIN, RECOMMEND, REJECT, REMOVE, RESTORE, TAG, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, UNTAG, UNWATCH, VISIT_DUP, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#profiles","title":"Profiles","text":"Event ADD Invitation Link CREATE Collegue Comment Status Tag Wallpost DELETE Collegue Comment Person Profile.audio Profile.photo Status Wallpost FOLLOW Person RECOMMEND Wall TAG Person Profile UNFOLLOW Person UNRECOMMEND Wall UNTAG Person Profile UPDATE Profile Profile.about Profile.audio Profile.photo VISIT Default Network Profiles Search VISIT_DUP DefaultNot Relevant: APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#wikis","title":"Wikis","text":"Event CREATE Attachment Comment Library Page Tag DELETE Attachment Comment Library Page PageVersion FOLLOW Library Page READ Page RECOMMEND Page TAG Comment Library Page UNDELETE Page UNFOLLOW Library Page UNRECOMMEND Page UNTAG Comment Library Page UPDATE Attachment Comment Library Membership Page VISIT Default Library Membership VISIT_DUP Default LibraryNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/terms/","title":"Glossary of Terms","text":""},{"location":"analytics/user-guide/terms/#events","title":"Events","text":"Any action or occurence performed by the user in Connections. Typical event types are VISIT, CREATE, READ, UPDATE, DELETE. Here is a summary of common events:
EVENT Description ACKCOM Acknowledgment of a platform command ADD To add an existing item to a new place, e.g. a User as a new member of a Community, or Sharing a File with other users APPROVE Approval of content for moderation COMMAND Invocation of a platform command COMPLETE To mark an Activity or Todo as completed COPY To duplicate an Activity or Activity Template CREATE To create a new item, e.g. a Blog Entry or Bookmark DELETE To delete an existing item, e.g. an Entry/Section from an Activity or a Widget from Homepage/Communities DOWNLOAD To download a File or Media File FOLLOW To follow an item (changes/comments etc), e.g. a File, Community, Forum Topic or Wiki Page GRADUATE To graduate an Idea in an Ideation Blog to the next level MEMBERSHIP Modification of membership or access control for a given resource MOVE To move a section in an Activity PIN To pin a Topic in a Forum PREVIEW To preview a Media File in the Media Gallery READ To read an item, e.g. a Blog Entry, Forum Topic or Wiki Page etc. RECOMMEND To recommend an item, e.g. a Blog Entry, File, or Wiki Page etc. RESTORE To restore a File from a previous version TAG To add a tag to an item, e.g. Activity Entry, Bookmark, File, Forum, Forum Topic etc. UNCOMPLETE To remove a previous \u2018Complete\u2019 from an Activity or Todo UNDELETE To restore a previously deleted Activity Entry UNFOLLOW To remove a previous \u2018follow\u2019 UNGRADUATE To remove a \u2018graduate\u2019 on an Idea UNPIN To unpin a Topic from a Forum UNRECOMMEND To remove a previous recommendation UNTAG To remove a previous tag UNVOTE To remove a vote previously cast in an Ideation Blog UNWATCH To remove a User from your Bookmarks Watchlist UPDATE To update an existing item, e.g. your Status, or change the name of a file VISIT To visit a Connections page, e.g. the Homepage VISIT_DUP Duplicate visits, e.g. Visits to the exact same place within a similar time frame VOTE To vote for an Idea in an Ideation Blog WATCH To add a User to your Bookmarks Watchlist"},{"location":"analytics/user-guide/terms/#reports","title":"Reports","text":"The visible data (graph or table) produced to analyse the use of your IBM Connections environment.
"},{"location":"analytics/user-guide/terms/#report-definition","title":"Report Definition","text":"The default instances provided with Huddo which can be used as-is (or customised) to create Reports
"},{"location":"analytics/user-guide/terms/#view-mode","title":"View mode","text":"The default mode of a saved Analytics widget. It only displays the graph or table, hiding all the configuration options for the report.
"},{"location":"analytics/user-guide/terms/#edit-mode","title":"Edit mode","text":"This is the default mode for newly added Analytics widgets, before a report is saved to them. This mode provides access to all the configuration options for reports allowing users to preview new reports and customise saved reports.
"},{"location":"analytics/user-guide/introduction/","title":"Introduction","text":""},{"location":"analytics/user-guide/introduction/#purpose-of-huddo-analytics","title":"Purpose of Huddo Analytics","text":"Huddo Analytics provides an insight into the usage of your Connections environment with the help of graphical and tabular reports. It primarily focuses on providing information that directly addresses important user-adoption concerns. Answer questions such as - Which features are being used? How many users are using each feature? How is each feature being used? Which aspects of a feature need focus?
"},{"location":"analytics/user-guide/introduction/#what-is-a-report","title":"What is a Report?","text":"A Report in Huddo Analytics presents a series of data pertaining to the usage of your Connections environment. There are several types of reports included in Huddo Analytics;
"},{"location":"analytics/user-guide/introduction/#table-reports","title":"Table Reports","text":"These reports show data in a tabular form, with the ability to sort and filter on column values and also to toggle entire columns.
"},{"location":"analytics/user-guide/introduction/#bar-charts","title":"Bar Charts","text":"Bar charts are great for visual comparisons between values.
"},{"location":"analytics/user-guide/introduction/#trend-reports","title":"Trend Reports","text":"These reports are used for showing values that change over time. They are a great tool for identifying usage trends over a period of time. They can be viewed as absolute or cumulative trends.
"},{"location":"analytics/user-guide/introduction/#column-charts","title":"Column Charts","text":"Column charts are great for representing a distribution.
"},{"location":"analytics/user-guide/introduction/#pie-charts","title":"Pie Charts","text":""},{"location":"analytics/user-guide/using-reports/","title":"Using Reports","text":""},{"location":"analytics/user-guide/using-reports/#analytics-dashboard","title":"Analytics Dashboard","text":"The Analytics Widget can be used to create and position multiple reports on a single page. Reports can be previewed and customised before being saved for ongoing use. This enables users to create a personalised dashboard of their favourite/most-viewed reports for easy, repeat access.
"},{"location":"analytics/user-guide/using-reports/#customise-reports-to-answer-specific-questions","title":"Customise Reports to Answer Specific Questions","text":"A Report also provides the capability to customise the query underlying its data to answer more specific questions. There are 4 main customisation options;
"},{"location":"analytics/user-guide/using-reports/#customise-query-parameters","title":"Customise Query Parameters","text":"Make reports more specific by specifying parameters such as who, when, where, what, etc. using filters for Community, User, Application, Time Period, Event Type, etc.
After you have set the parameters you desire, press 'Run' to apply them and update the report data.
"},{"location":"analytics/user-guide/using-reports/#sort-columns","title":"Sort Columns","text":"Tabular reports allowing sorting column data (ascending/descending) by clicking on the header name.
"},{"location":"analytics/user-guide/using-reports/#filtersearch-table-results-keyword-minmax","title":"Filter/Search table results (keyword, min/max)","text":"Search report table columns by Keywords, Min/Max values and Start/End dates.
"},{"location":"analytics/user-guide/using-reports/#enabledisable-columns","title":"Enable/Disable columns","text":"Some tabular reports allow you to hide unwanted columns to focus on the data you\u2019re interested in by right-clicking on the column header.
"},{"location":"badges/","title":"Index","text":"Huddo Badges can transform and accelerate organisations user adoption of Connections by encouraging users to leverage the full range of social services and drive user adoption and behaviour.
Huddo Badges for Connections is a flexible gamification engine for Connections. By providing achievements and rewards (Huddo Badges), rank and leaderboards (Huddo Rank), and missions (Huddo Missions), organisations can dramatically improve their user engagement and adoption of Connections.
In addition, Huddo Badges is an extensible platform that can leverage game theory to provide performance management mechanics and reward systems for applications outside of Connections such as HR, Sales Force Management, Help Desks, and many more.
Huddo also now includes a peer to peer and team recognition feature; Huddo Thanks.
"},{"location":"badges/#huddo-points","title":"Huddo Points","text":"Huddo Points are awarded to people for performing certain actions. For example you get a Huddo Point for posting a status update or making a comment. You get 5 Huddo Points for creating a blog, or 3 Huddo Points for having one of your files recommended by another person. You can even be awarded Huddo Points for achieving a particular badge or for completing a Huddo Mission or category of badges. The value of any particular action or reward can be configured so the points system can be tweaked to meet your needs. You can also be awarded Huddo Points for your actions outside of Connections helping to drive your organisations\u2019 performance management.
"},{"location":"badges/#huddo-metrics","title":"Huddo Metrics","text":"Metrics are at the heart of Huddo Badges. Metrics are basically a way of awarding and tracking Huddo that determine if a particular badge, mission, or achievement has been awarded. Metrics also award Huddo that add to the person\u2019s Huddo Rank and their leaderboard position.
Metrics are SQL statements that analyse information in your database. You can even define Metrics that count other Metrics! We provide many out of the box metrics for Connections that you can add to or modify. In addition you can also build your own custom metrics that capture actions and performance from external applications. You can then reward users based on their actions and behaviour outside of Connections.
"},{"location":"badges/#huddo-filters","title":"Huddo Filters","text":"Filters work alongside Metrics. Filters are also SQL statements, and they are applied to Metrics to, as the name suggests, filter the selected users using contextual parameters such as Time, Community, Name etc. For example, to select a user with the display name Joe Bloggs, we can use the Profile Like Metric with the filter Display Name Like with its parameter set to \u2018Joe Bloggs \u2019.
Like Metrics, we also provide many out of the box filters for Connections that you can modify or add to, and you can build your own custom filters for use with external applications.
"},{"location":"badges/#huddo-badges","title":"Huddo Badges","text":"Huddo Badges are rewards that users receive for performing certain actions. There are simple badges that are fairly easy to achieve and more complex badges that require significant effort. The Huddo Badges are designed to not only reward users but to also encourage progression and exploration of other features. Badges are grouped into categories and missions and are achieved by meeting the required metrics for each badge.
Badges are defined by selecting pre-configured Metrics, and specifying the upper and lower limits of the Huddo points returned by these Metrics, required to achieve that Badge. You can make Badges as simple or as complex as you wish by varying the amount of Metrics you are counting.
"},{"location":"badges/#huddo-awards","title":"Huddo Awards","text":"Huddo Awards is a reward and recognition system which provides the capability of directly awarding Badges to one or more users. Huddo provides a set of default Awards to reward loyalty, efficiency, expertise, etc. The default Awards have been designed to be generic and universally applicable, however they can be customised and/or replaced with ones more applicable to your environment.
"},{"location":"badges/#huddo-leaderboard","title":"Huddo Leaderboard","text":"The Huddo Badges Leaderboard enables users to view the top 10 contributors throughout Connections. You can filter the leaders to just people from your network, everyone, or even Community members (when viewing the Huddo Leaderboard in a Community).
You can also view a break-down of which categories the Points/Badges came from by simply selecting the user in the Leaderboard.
"},{"location":"badges/#huddo-configurators","title":"Huddo Configurators","text":"The Huddo Badges, Metrics & Filters Configurators allow the user to control and customise Badges, Metrics & Filters.
These Configurators are designed for use by Administrators, and not general users. As such controlling access to them is very important. Therefore we have built them to only operate in one specific Connections Community, which you can control. This means that the Community Administrators use the Members list to specify the users allowed access to each Configurator.
We will be creating three Communities; one for each Configurator. These Communities can be Stand-alone Communities or Sub-Communities of existing Communities if you wish.
"},{"location":"badges/#huddo-badges-summary","title":"Huddo Badges Summary","text":"The Huddo Summary Widget is added to everyone's profile so that others can see what achievements and rewards the person has received. When you mouse over each badge it provides you with details on why the badge was awarded and tasks that you can consider to try and win another badge! The idea is to not only reward people for their behaviour but to also provide them with guidance and education on what else they can do in Connections. When users click on the View All link it takes them to their Huddo Badges Progress and Detail Page.
"},{"location":"badges/#huddo-profile-progress-widget","title":"Huddo Profile Progress Widget","text":"Encourage the users to get started in Connections!
The Profile Progress Widget displays a progress bar indicating a Profile\u2019s maturity level and gives users ideas to improve it based on what the Profile is lacking. This widget uses existing metrics to measure in real-time the level of completion of a Profile. What makes this feature really powerful is that it is completely configurable allowing you to fine tune it to your environment!
"},{"location":"badges/#huddo-thanks","title":"Huddo Thanks","text":"There is nothing quite as simple as saying \"Thank You\" to provide some recognition of great work. Think about it for a moment...when somebody thanks you for your great idea, or for putting in that extra work to meet a deadline, or maybe for just being a good team mate, it makes you feel great and more motivated to stay engaged.
That is why ISW has developed Huddo Thanks, the peer to peer and team recognition tool for Connections.
Motivate your team We all do performance reviews (or we all should!), however often the problem is that the various achievements or small goals we meet throughout the year can be easily forgotten. Why wait for the next big meeting to provide some feedback to your team. Huddo Thanks enables you to provide real time feedback and to publically acknowledge great work quickly and easily. The recognition then stays visible on the person's profile so that peers and colleagues can see and recognise the value that is placed on a person\u2019s work.
Peer to Peer recognition Thanks don\u2019t always come from your boss either! Often having your direct peers\u2019 thank you for some great work can be a great motivator. With Huddo Thanks users of Connections can select from a range of Thanks related badges, choose who to award the thanks to, add a message and send it off! The thanks will appear on the users profile as well as integrate within their Activity Steam so that others can see as well.
Management or Team recognition Huddo also allows for Manager or Team Leader Thanks Badges. You can create your own special badges that only certain people can award such as employee of the month. And because Huddo Thanks is built to be social, within Connections peers and colleagues are able to see and add value to the recognition and thanks as well!
Thanks Badges Select from provided badges or create your own. You can even set how often a Thanks badge may be awarded to add more value.
Personalised Messages & Reputation\nYou can provide a personal message of recognition when awarding a thanks\nbadge. Thanks Received and Given remain on your profile so the recognition you\nreceive is not forgotten.\nThanks Allowance Control how often a Thanks badge may be awarded to add more value and create a greater impact.
Social Recognition & Notifications\nThanks given to users are published in the Discover Feed for everyone\nto see. An email notification is sent to the user as well to make sure they\nreceive your thanks.\nHuddo Groups allows administrators to group users.
These groups can then be used to control access to various parts of Huddo. For example in Thanks Badges, allowing you to define Thanks which can only be awarded by selected users. This allows you to define exclusive Management badges such as \u201cEmployee of the Month\u201d which can only be awarded by those you choose! You can also use Groups to exclude users from appearing in the Leaderboards!
"},{"location":"badges/#connections-activity-stream-integration","title":"Connections Activity Stream Integration","text":"Huddo now includes Embedded Experiences in the Activity Stream through use of the new Open Social Gadget standards. Now you can enjoy a richer Huddo experience, through the ability to Comment & Like on Awarded Badges and Thanks.
Awarded Badges\nAll awarded badges will now appear on the Discovery tab in the Activity Stream. Further details about the Badge can be viewed by opening\nthe Embedded Huddo Gadget.\nHuddo News Gadget
From the Huddo News Gadget users can now Like and Comment on Huddo Activity Stream Entries.
Liking Huddo Entries
When a User Likes the item, a new entry describing the Liking of the Content, is created in the Activity Stream and the original entry is rolled up into the new entry. If the user chooses to Undo this Like, then this new Stream Entry is removed and the previous Entry takes its place again.
Commenting on Huddo Entries
When a User Comments on the item, a new entry describing the Comment on the Content, is created in the Activity Stream and any previous entries are rolled up into the new entry. If the user chooses to remove this Comment, then the new Stream Entry is removed and the previous Entry takes its place again. Users can also edit their own comments after posting to correct any mistakes quickly and easily.
Recent Updates
All activity performed on the Stream Entries can be viewed on the Recent Updates tab of the Huddo News Gadget. This includes the creation of the original entry as well as all comments and likes on the entry. This allows you to see who responded and when. To make things even simpler, all timestamps are updated in real time, so you are never misinformed!
Thanks Given
All Thanks given by users will now appear in the Discovery tab in the Activity Stream. Further details about the Thanks, including the personal message of recognition, can be seen by opening the Embedded Huddo News Gadget.
Thanks Email Notifications
Users receiving Thanks will also be notified by email. Details about the Thanks, including the personal message of recognition, are included in this email.
"},{"location":"badges/update-images/","title":"Huddo Images","text":""},{"location":"badges/update-images/#update-kudos-images-to-huddo-images","title":"Update Kudos Images to Huddo Images","text":"Huddo Badges is supplied with a set of images for the default Badges, Thanks and Awards. There are updated images available to go with rebrand of Kudos -> Huddo. These will be available as the defaults in the rebranded version of Huddo Badges but existing clients can update these now.
"},{"location":"badges/update-images/#load-updated-images","title":"Load Updated Images","text":"Download the updated Huddo Images
Login to Connections and navigate to the Badges Configurator Community
Select the Settings tab in the BadgesConfigurator widget, scroll to the bottom and click the 'Import' button
Select the downloaded images.zip file and select 'Overwrite Customisations', then 'Upload'
You will get a prompt indicating that 281 records will be updated, press 'OK'
The images will now be updated.
"},{"location":"badges/websphere-faq/","title":"Huddo Badges Installation FAQ","text":""},{"location":"badges/websphere-faq/#installation","title":"Installation","text":""},{"location":"badges/websphere-faq/#activity-stream-items-not-posting","title":"Activity Stream items not posting","text":"Ensure SSL certificates correctly imported to the ISC & trust chain valid
"},{"location":"badges/websphere-faq/#images-do-not-work","title":"Images do not work","text":"Please go to the BadgesConfigurator->Settings tab then restart the Huddo Application.
"},{"location":"badges/websphere-faq/#news-gadget-icon-not-showing-after-updating-url","title":"News Gadget Icon not showing after updating URL","text":"The URL for this is set once, the first time, then never ever updated. Need to go to HOMEPAGE.NR_SOURCE_TYPE and update the IMAGE_URL column.
"},{"location":"badges/install/","title":"Installation","text":"The following section provides an overview of the installation process and the packages that are to be installed. For an experienced Connections administrator or IBM WebSphere Application Server administrator, we expect that this installation process should take no longer than a few hours.
The install process for Huddo involves the following steps:
Please Note: These steps are only applicable to a new install of Huddo. For information about upgrading, please see the Huddo Update Guide.
"},{"location":"badges/install/customising/","title":"Customising","text":""},{"location":"badges/install/customising/#customising-huddo-strings-properties-images-optional","title":"Customising Huddo Strings, Properties & Images (Optional)","text":"You only need to perform this step if you wish to customise the user interface strings used in Huddo or the default properties used by the application, e.g. to use a custom context root etc. If you do not wish to do any of the above, you do not need to follow this step.
"},{"location":"badges/install/customising/#customising-huddo-strings","title":"Customising Huddo Strings","text":"The files for customising Huddo Strings need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Please Note:
This step can be performed at any stage after the installation and is not required to complete the installation.
<installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultLang/{\n NAME_LABEL : \"User Name\",\n MESSAGE_LABEL : \"Notes\",\n MY_NETWORK : \"My Circle\",\n EVERYONE : \"All\",\n THIS_COMMUNITY : \"Community\",\n CONGRATULATIONS_PROFILE_COMPLETE_MSG : \"Congratulations on completing your profile!\",\n GRID_VIEW:\"Grid View\"\n}\nIf you wish to add specific customisations for different languages:
Example:
English: PROFILES_STATS_DIR/ HuddoStrings/en/UserInterfaceLang.js\nEnglish-UK: PROFILES_STATS_DIR/ HuddoStrings/en-gb/UserInterfaceLang.js\nFrench: PROFILES_STATS_DIR/ HuddoStrings/fr/UserInterfaceLang.js\nThe files for customising Huddo Properties need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Available properties files to customise:
Please Note:
<installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultProperties/The custom images need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Please Note:
This step can be performed at any stage after the installation and is not required to complete the installation.
Determine the image(s) to be customised in the HuddoImages folder from the location <installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultImages/
Common files customised include:\n kudos_stream.png (as seen in the Homepage Activity Stream)\n mobile_`<MOBILE_DEVICE>`.png (i.e. mobile_android.png etc \u2013 as seen for Huddo mobile)\nCreate a folder called HuddoImages in the directory given by the PROFILES_STATS_DIR Websphere Variable.
The Huddo Embedded Experience is installed in the same manner as the default Connections Embedded Experience Gadget & the Activity Stream Gadget.
As of Connections 4 CR3 a mechanism was introduced to simplify this process. Simply export the Widget configuration from Connections and import into the IBM Notes Widget Catalog as per documentation here or here.
For Connections 4 CR2 and earlier the process is manual (overview).
Huddo integrates into the Connections Mobile native application and allows users to utilise Huddo features from their mobile device. The integration is performed by modifying the mobile-config.xml configuration. This feature is optional.
"},{"location":"badges/install/mobile/#check-out-the-mobile-configxml-file","title":"Check out the mobile-config.xml file","text":"To add \u2018Huddo Badges\u2019 to the Connections mobile native app menu you must edit the mobile-config.xml file. To update this file, you must check the file out and, after making changes, you must check the file back in, as documented here.
The mobile-config.xml file is a standard Connections file that is used to define the configuration settings for the Connections Mobile native application. To update this file, you must check the file out and, after making changes, check the file back in during the same wsadmin session as the checkout for the changes to take effect.
"},{"location":"badges/install/mobile/#edit-the-mobile-configxml","title":"Edit the mobile-config.xml","text":"Then proceed to add the following Application definition under the <Applications> node
<Application name=\"Huddo\" enabled=\"true\">\n <ApplicationIcon>\n <Android>\n <Hdpi> **../../** Huddo/images/mobile_android.png</Hdpi>\n <Mdpi> **../../** Huddo/images/mobile_android.png</Mdpi>\n <Ldpi> **../../** Huddo/images/mobile_android.png</Ldpi>\n </Android>\n <IOS>\n <Reg> **../../** Huddo/images/mobile_iOS.png</Reg>\n <Retina> **../../** Huddo/images/mobile_iOS.png</Retina>\n </IOS>\n <DefaultLocation> **../../** Huddo/images/mobile_default.png</DefaultLocation>\n </ApplicationIcon>\n <ApplicationLabel>Huddo Badges</ApplicationLabel>\n <ApplicationURL>http://<YOUR_CONNECTIONS_SERVER>/Huddo/mobile</ApplicationURL>\n</Application>\nAdd the following to the <ApplicationList> or DefaultNavigationOrder node: Huddo.
The result should be similar to: <ApplicationsList>profiles,communities,files,wikis,activities,forums,blogs,bookmarks,Huddo</ApplicationsList> or <DefaultNavigationOrder>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Huddo</DefaultNavigationOrder>
Please Note: Make sure you replace <YOUR_CONNECTIONS_SERVER> in all places with the URL of your Connections Environment. If you use a custom context root for Huddo, please ensure you update the references above appropriately. You can customise the name/images shown in the Mobile application by changing the text/URLs above.
Now that you have modified the mobile-config.xml, it must be checked back in to Connections. Please refer to the Connections product documentation for instructions on how to check in the mobile-config.xml file, located here.
Note: the configuration file must be checked in during the same wsadmin session in which it was checked out.
"},{"location":"badges/install/add-widgets/","title":"Add Widgets","text":"So far, you have configured the location of the Huddo widgets. You will now add the widgets to the user interface.
"},{"location":"badges/install/add-widgets/#add-the-configurators-widgets-to-their-communities","title":"Add the Configurators Widgets to their Communities","text":"Login to Connections and navigate to the previously created Badges Configurator Community
Click Community Actions then 'Add Apps' from the drop down menu
Select the Configurator(s) to add to the Community
Click X
The Configurators will now be added to the main view.
Repeat the above steps for each configurator community you created.
We recommend removing all the default widgets from the main page (i.e. Forums, Bookmarks, Files and Feeds) to conserve screen real-estate, and making use of the Configurator widget easier. The default widgets may be removed or added back at any stage.
"},{"location":"badges/install/add-widgets/#remove-the-default-widgets-optional","title":"Remove the Default Widgets (Optional)","text":"Click the Actions drop-down and select Delete
Fill in the required data then click Ok on the Delete prompt
"},{"location":"badges/install/add-widgets/#add-the-huddo-analytics-widget-to-communities","title":"Add the Huddo Analytics Widget to Communities","text":"Login to Connections and navigate to the Huddo Analytics Community
Click Community Actions then 'Add Apps' from the drop down menu
Select HuddoAnalytics
Click X
We recommend removing all the default widgets from the main page (i.e. Forums, Bookmarks, Files and Feeds) to conserve screen real-estate, and making use of the Analytics widgets easier. The default widgets may be removed or added back at any stage.
Your first Huddo Analytics widget will now be added to the main view.
The default view shows the report categories. Once a report category is selected, default report instances for that category can be selected.
Once the report instance is selected, further options for that report can be selected.
The report currently configured is previewed below the options and can be saved for quick viewing on all subsequent page loads.
In the Huddo Analytics community, the Huddo Analytics widgets provide access to Connections Administrator level reports. In other communities, the Huddo Analytics widgets can be added to provide access to Community Manager level reports.
Multiple Huddo Analytics widgets are designed to exist in each community.
"},{"location":"badges/install/add-widgets/#add-the-widgets-to-the-home-page","title":"Add the Widgets to the Home page","text":"The Huddo Leaderboard Widget allows users to view the top 10 contributors either in the entire organisation or in a specific user\u2019s network. Adding the Huddo Leaderboard to all users Home page provides easy access for users to view their progress and drive their behaviour.
By defining the Huddo News Gadget in the Homepage Administration tab, the Huddo News Gadget will be made available to the end users. The following diagram shows how the gadget will be embedded.
Adding widgets to the Home page of Connections is done through the Connections Web page.
Login to Connections as a user assigned to the admin security role of the Homepage application and navigate to the Administration tab.
Click the 'Add another app' button and enter the following details. Once you have defined each widget, click Save and then click the 'Add another widget' button to add the next.
Widget Type Widget Title URL Address Use HCL Connections specific tags Display on My Page Display on Updates Pages Opened by Default Multiple apps Prerequisites Leaderboard iWidget Huddo Leaderboard https://<CONNECTIONS_SERVER_URL>/Huddo/RankingDisplay.xml False False True True False profiles News Gadget Open Social Gadget Huddo News Gadget https://<CONNECTIONS_SERVER_URL>/Huddo/HuddoNewsGadget.xml True False False True False oauthprovider, oauth, opensocial, webresources Awarder iWidget Huddo Awarder https://<CONNECTIONS_SERVER_URL>/Huddo/HuddoAwarder.xml False True False False False - User Analytics iWidget Huddo User Analytics https://<CONNECTIONS_SERVER_URL>/Huddo/AnalyticsDashboard.xml False True False False True - For the Open Social Gadget, select the following:
Click the Add Mapping button.
Highlight each Huddo widget individually in the Disabled widgets section and click Enable
The Huddo widgets will now show in the Enabled widgets list.
It will also show on the Updates and Widgets tabs, if these options were selected.
"},{"location":"badges/install/add-widgets/#add-the-huddo-awarder-widget-to-my-page","title":"Add the Huddo Awarder Widget to My Page","text":"Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.
Open My Page through the Sidebar link or Home button and select Customize
Select Huddo Awarder. If you cannot find it, look under the 'Other' category.
Click X
You will now have the Huddo Awarder Widget displayed in the My Page section. Please Note: The Huddo Awarder cannot be used by a user until they have been allocated awards for distribution. See the User Guide for further information.
"},{"location":"badges/install/add-widgets/#add-the-huddo-user-analytics-widget-to-my-page","title":"Add the Huddo User Analytics Widget to My Page","text":"This step will ensure the User Analytics widget was defined successfully in the Administration section, and is working as expected. This step is a good introduction to User Reports, however is optional.
Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.
Open My Page through the Sidebar link or Home button and select Customize
Select Huddo User Analytics. If you cannot find it, look under the 'Other' category.
Click X
You will now have your first Huddo User Analytics Widget displayed in the My Page section. From here you can start using Analytics by selecting a report category, and then a specific reports instance.
Multiple Huddo User Analytics widgets are designed to exist on My Page.
"},{"location":"badges/install/app/","title":"WebSphere Application","text":"The Huddo Application is provided as a .war file that is to be installed as a WebSphere Application in your Connections server environment. The application provides the Huddo Badges & Analytics engines that drives the reward and recognition of user performance, as well as the widgets for user interaction.
"},{"location":"badges/install/app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"Login to the WebSphere Integrated Solution Console for your Connections environment via a webbrowser.
Enter your administrator User ID and Password, then click the \u201cLog in\u201d button.
"},{"location":"badges/install/app/#install-the-huddowar-file","title":"Install the Huddo.war file","text":"Navigate to Applications \u2192 Application Types \u2192 WebSphere enterprise applications
Click the Install button
Browse the Local File System Path for the downloaded Huddo.war file then Click Next
Check the Fast Path Option then Click Next
Change the Application name to Huddo then Click Next
Highlight the Nodes for the Application, including the IHS Node. Select the Badges Module, click Apply then Next.
Please Note: It\u2019s recommended that you create a separate cluster for Huddo if your Connections install is bigger than 10,000 users. You can do this via the ISC by clicking on Servers > Clusters > WebSphere application server clusters and then clicking New.
Click on Browse and map the default resources as shown. Click Next.
Enter Huddo as the Context Root, then click Next.
Please Note: The Huddo Installation guide assumes that the Context Root is set as \u2018/Huddo\u2019. If you set the Context Root to something other than \u2018/Huddo\u2019, then make sure that you replace \u2018/Huddo\u2019 with your Context Root when entering addresses.
Review the Installation Summary. Click Finish.
Review the Installation Results. Click Save.
Review the Synchronisation Summary. Click OK.
You have now successfully installed Huddo as a WebSphere Enterprise Application. Next, you will need to edit the security settings.
"},{"location":"badges/install/app/#modify-the-huddo-application-security-role-assignments","title":"Modify the Huddo Application Security Role assignments","text":"During this step, we will be defining the authenticated users/groups for each Security Role.
Find Huddo in the list of enterprise applications and click on Huddo to open the application configuration screen
Click Security role to user/group mapping
To ensure that only authorised users have access to Huddo and its data, modify the mapping of the AllServlets and Reader roles to the Special Subjects: All Authenticated in Application/Trusted Realm, then Click OK
Please note: You may set the Reader role to Everyone to grant read-only access to Huddo widget data to unauthenticated users.
"},{"location":"badges/install/app/#ensure-the-signer-certificate-for-the-connections-url-is-trusted","title":"Ensure the Signer Certificate for the Connections URL is Trusted","text":"In order for Huddo to post entries into the Homepage Activity Stream, WebSphere must trust the certificate for the secure URL of your Connections Environment. During this step, we will be importing the environment certificate into the CellDefaultTrustStore.
Navigate to Security \u2192 SSL certificate and key management and then select Key stores and certificates
Select CellDefaultTrustStore
Select Signer certificates
You will now see a list of all trusted certificates.
If the URL of your Connections Environment is listed, skip to Add Huddo Related Strings to Connections
We will now import the public certificate from the IBM HTTP Server to the default trust store in IBM WebSphere Application Server
Click Retrieve from port
Enter the following details of the web server, then click Retrieve Signer Information:
The certificate will now be retrieved. Please confirm the details of the certificate, Click OK. The root certificate is then added to the list of signer certificates.
"},{"location":"badges/install/app/#add-huddo-related-strings-to-connections","title":"Add Huddo Related Strings to Connections","text":"This change will not be picked up by Connections until the servers are restarted. This will be performed at the end of the configuration.
Copy the .properties files from the folder Huddo.ear/Huddo.war/installFiles to the Connections strings customisation directory: /strings Where CONNECTIONS_CUSTOMIZATION_PATH is defined by the WebSphere variable. e.g. /opt/Connections/data/shared/customization/strings
IMPORTANT: If a file of the same name already exists, merge the contents into the existing file.
"},{"location":"badges/install/apply-changes/","title":"Apply Changes","text":"The clusters must be restarted for the widget & mobile configuration changes to take effect.
"},{"location":"badges/install/apply-changes/#restart-the-clusters","title":"Restart the Clusters","text":"Login to the Integrated Solution Console
Navigate to Servers \u2192 Clusters \u2192 WebSphere Application Server Clusters
Select all of the Connections Clusters
Click Ripplestart.
"},{"location":"badges/install/awards/","title":"Awards","text":"Within Huddo Awards, each Award is configurable to only allow a selected group of people to award and receive the award, allowing for better control of Awards. To this effect the Award definitions contain two fields \u2013 Groups with Access : Groups who have access to award this badge; and Awardees: Groups who can be awarded this badge. As part of this step you will need to configure these attributes for each Award definition for your environment.
"},{"location":"badges/install/awards/#create-groups-for-access-control-via-the-badge-configurator","title":"Create groups for access control via the Badge Configurator","text":"Open the User Groups Tab in the Badges Configurator widget and create groups required to set access control permissions for Awards.
Groups can now be created by selecting people, Communities, other groups, importing a CSV file of emails or advanced profile attributes.
Examples:
Open the Awards Tab in the Badges Configurator widget and for each of the Award definitions listed in the table perform the following steps:
Set the Groups with Access field: Select the groups who you wish to grant permissions to Award this badge; i.e. Who can award this badge?
Note : Users selected in this step will need to add the Huddo Awarder widget to their widgets page as per
Set the Awardees field: Select the groups who you wish this Award to be made applicable to, i.e. Who can be awarded this badge. The people selected in this step will see this Award under the HuddoAwards tab in their Profiles as an achievable award.
Note : If you wish to disable a badge, so that it doesn\u2019t appear in anyone\u2019s profile, simply remove all groups from the Awardees field.
Click Save to save your changes.
At this stage, the Huddo Configuration Widgets show in the Communities Customization Palette for all Communities. This means they can be added to any community. However, they are restriced to function only in their respective Community created during this installation process. This message will be shown if theyare added to any other community.
It is possible to remove these Widgets from the Customizations Palette, so that users cannot see/add them to their Communties. This requires modifying the Configuration Widget definitions we created earlier in the widgets-config.xml file and restarting the clusters again.
Checkout and edit the widgets-config.xml file:
Connections 5.5
Connections 6.0
Connections 6.5
Locate the Configuration Widget definitions under the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
Add the attribute showInPalette=\"false\" to each Configurator you wish to hide from the Customizations page. We could not define this attribute earlier, as otherwise we wouldn\u2019t have been able to add the Widgets to the Configuration Communities.
Add the attribute loginRequired=\"true\" to each Community widget if you wish to hide the widgets from users that are not logged in. This is only applicable if your security settings for the Communities application allow users to view communities without logging in.
Your configuration should now look like this:
<widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"MetricsConfigurator\" description=\"metricsConfigurator\" modes=\"view fullpage\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/MetricsConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_METRICS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"FiltersConfigurator\" description=\"filtersConfigurator\" modes=\"view fullpage\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/FiltersConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_FILTERS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoCommunity\" modes=\"view\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/CommunityRankingDisplay.xml\" themes=\"wpthemeNarrow wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"communityId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\nCheck in the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
Then Restart the clusters.
"},{"location":"badges/install/engine/","title":"Engine","text":"Now that you have loaded the default metrics and badges you are ready to start awarding the badges to users. By default, Huddo Badges will start awarding badges at midnight each day. However, if you would like to start awarding badges immediately rather than waiting until the next scheduled run, you can click the Award Badges Now button.
"},{"location":"badges/install/engine/#award-badges-now","title":"Award Badges Now","text":"Login to Connections and navigate to the Badges Configurator Community
Select the Settings tab in the BadgesConfigurator widget
Click the Award Badges Now button.
Note: If you are installing Huddo Badges to a Connections environment for testing purposes, it is recommended that the following settings are disabled:
The Huddo Widgets provide the interface for user interaction within Connections. During this step, we will be configuring communities for secure access to the configuration interfaces for Badges and Metrics, as well as provisioning the Analytics widget, Badges/Thanks/Awards Summaries and Leaderboard widgets for end users as well as the Huddo News Gadget.
"},{"location":"badges/install/install-widgets/#create-the-configurator-communities","title":"Create the Configurator Communities","text":"The Huddo Badges Configurator Widget is the widget that allows users to define and configure what badges are available for award, and how they are awarded.
The Huddo Metrics Configurator widget allows users to define and configure Huddo Metrics. These metrics monitor Connections usage (as well as external systems) and determine how Huddo are awarded. This involves the use of technical concepts such as JDBC connections and SQL queries.
The Huddo Filters Configurator widget allows users to define and configure Huddo Filters. These filters are then applied to Base Metrics to monitor Connections usage (as well as external systems) and determine how Huddo are awarded. This involves the use of technical concepts such as JDBC connections and SQL queries.
As such, the Configurators have been designed such that it is available to a specific Connections community where membership can be maintained, and hence the configurators can be secured. The Analytics Interface has been designed with the same concept, which is why the following steps will ask you to create four new communities. For smaller environments, you may wish to have a single community for the Badges, Metrics and Filters configurators.
Login to Connections, navigate to Communities and click Create a Community
Enter a name, such as Badges Configurator
Set Access to Restricted
Specify Members as those people you wish to be able to edit Badge definitions. Users can be specified after clicking the Access Advanced Features link.
Enter any tags, web address and description you wish then click Save.
Note: Configurators requires a large column community layout to function properly. Either \u20183 Columns with side menu and banner\u2019, \u20183 Columns with side menu\u2019 or \u20182 Columns with side menu\u2019.
You have now created the first Huddo Configurator Community.
Take note of the CommunityUUID in the URL address, as we will need this later.
Please repeat the above steps for the Metrics & Filters communities if you are not using the same Community for these. If you are using the same Community, please move to Create the Huddo Analytics Administrator Community
"},{"location":"badges/install/install-widgets/#create-the-huddo-analytics-administrator-community","title":"Create the Huddo Analytics Administrator Community","text":"The Huddo Analytics widget allows users to review Connections Usage data over specified time periods. Users have access to both reporting and graph functionalities. The following community will be used to host the Connections Administrator level reports and graphs.
Login to Connections, navigate to Communities and click Start a Community.
Enter a name, such as Huddo Analytics.
Set Access to Restricted.
Specify Members as those people you wish to be able to access Connections Administrator level reports and graphs. In Connections 5+, users can be specified after clicking the Access Advanced Features link.
Enter any tags, web address and description you wish and click Save.
You have now created the Huddo Analytics Administrator Community.
Take note of the CommunityUUID in the URL address, as we will need this later.
"},{"location":"badges/install/install-widgets/#check-out-the-widgets-configxml-file","title":"Check out the widgets-config.xml file","text":"To install most of the Widgets you must edit the widgets-config.xml file for Profiles. This file contains the settings for each defined widget. To update this file, you must check the file out and, after making changes, you must check the file back in, as documented in the links below.
The widgets-config.xml file is a standard Connections file that is used to define the configuration settings for each of the widgets supported by Profiles and Communities. To update settings in the file, you must check the file out and, after making changes, you must check the file back during the same wsadmin session as the checkout for the changes to take effect.
Checking Out the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
"},{"location":"badges/install/install-widgets/#configure-the-profile-widgets","title":"Configure the Profile Widgets","text":"By updating the widgets-config.xml with the code supplied below, the Huddo Badges, Huddo Summary, Profile Progress, Huddo Awards, Award Summary, Huddo Thanks and Thanks Summary widgets will be made available to the end users. The following diagram shows where the widgets will be placed.
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"profiles\" ... >, then under <widgets>, then within <definitions> add the following:
IMPORTANT: Don\u2019t forget to substitute the following placeholders with the corresponding values! CONNECTIONS_SERVER_NAME
<widgetDef defId=\"HuddoSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgeSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n <item name=\"NumberBadges\" value=\"12\"/>\n <item name=\"BadgeViewAllWidgetId\" value=\"HuddoBadges\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoBadges\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgeViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n <item name=\"NumberBadges\" value=\"0\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"ProfileProgress\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ProfileProgress.xml\" modes=\"view\" themes=\"wpthemeNarrow\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"ThanksSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ThanksSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n <item name=\"NumberThanks\" value=\"12\"/>\n <item name=\"ThanksWidgetId\" value=\"HuddoThanks\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"AwardSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AwardSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n <item name=\"NumberBadges\" value=\"12\"/>\n <item name=\"AwardViewAllWidgetId\" value=\"HuddoAwards\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoAwards\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AwardViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoThanks\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ThanksViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\nWe recommend using absolute URLs in widget-config.xml for reduced configuration complexity. If you have a requirement for the use of relative URLs and are unsure of the implications, you may discuss this with our support team.
Next you must define where to put the instances of the Widgets on the page. This is achieved by adding the following lines to the widgets-config.xml file in:
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"profiles\" ... >, then under <layout ... resourceSubType=\"default\" ... >, then within <page ... pageId=\"profilesView\" ... > add the following:
<widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoBadges\"/>\n<widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoThanks\"/>\n<widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoAwards\"/>\n<widgetInstance uiLocation=\"col1\" defIdRef=\"ProfileProgress\"/>\n<widgetInstance uiLocation=\"col3\" defIdRef=\"HuddoSummary\"/>\n<widgetInstance uiLocation=\"col3\" defIdRef=\"ThanksSummary\"/>\n<widgetInstance uiLocation=\"col3\" defIdRef=\"AwardSummary\"/>\nThe order in which you insert these two instance declarations is the order in which they show on the page. For example, you might wish to show the Summary Tab before the Links widget, and the Huddo Badges, Thanks & Awards Widgets as the last tabs, which would be configured as per the image below. Also make sure that the uiLocation\u2019s match the other ids. If not, then modify to suit your environment.
"},{"location":"badges/install/install-widgets/#configure-configurators-and-community-leaderboard-widgets","title":"Configure Configurators and Community Leaderboard Widgets","text":"By updating the widgets-config.xml with the code supplied below, the Badges Configurator, Metrics Configurator, Filters Configurator, Huddo Community Analytics and Huddo Community Leaderboard widgets will be made available. This will allow them to be placed into Connections Communities, as shown in the following image.
You must define the Widgets and where to find their associated .xml files. You will need the CommunityUuids you took note of earlier.
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
IMPORTANT: Don\u2019t forget to substitute the following placeholders with the corresponding values! YOUR_METRICS_COMMUNITY_UUID, YOUR_BADGES_COMMUNITY_UUID, YOUR_FILTERS_COMMUNITY_UUID , YOUR_ANALYTICS_COMMUNITY_UUID, CONNECTIONS_SERVER_NAME
<widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"MetricsConfigurator\" description=\"metricsConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/MetricsConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_METRICS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"FiltersConfigurator\" description=\"filtersConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/FiltersConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_FILTERS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoAnalytics\" description=\"HuddoAnalytics\" modes=\"view edit\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AnalyticsDashboard.xml\" uniqueInstance=\"false\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"adminCommunityId\" value=\"YOUR_ANALYTICS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoCommunity\" modes=\"view\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/CommunityRankingDisplay.xml\" showInPalette=\"false\" themes=\"wpthemeNarrow wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"communityId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\nWe recommend using absolute URLs in widget-config.xml for reduced configuration complexity. If you have a requirement for the use of relative URLs and are unsure of the implications, you may discuss this with our support team.
Next you must define where to put the instance of the Community Leaderboard Widget on the Community page. This is done by adding the following lines to the widgets-config.xml file, in:
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <layout ... resourceSubType=\"default\" ... >, then within <page ... pageId=\"communityOverview\" ... > add the following:
<widgetInstance uiLocation=\"col3\" defIdRef=\"HuddoCommunity\"/>\nNow that you have modified the widgets-config.xml, it must be checked back in to Connections. Please refer to the Connections product documentation for instructions on how to check in the widgets-config.xml file, located below.
Checking In the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
"},{"location":"badges/install/install-widgets/#register-widgets-connections-60-cr1-onwards","title":"Register Widgets (Connections 6.0 CR1 onwards)","text":"Since Connections 6.0 CR1 it is now required to register third-party widgets in the widget-container for increased security. We have scripts and instructions for this here.
"},{"location":"badges/install/install-widgets/#add-huddo-configuration-jsp-to-the-header","title":"Add Huddo configuration JSP to the header","text":"(And add \u2018Give Thanks\u2019 Link in the navigation bar - Optional)
Perform this task to add Huddo Configuration information to Connections pages and to add a link to the Thanks Awarder widget in the Header Menu as shown
below. You need to perform this step even if you do not wish to add the \u2018Give Thanks\u2019 link in order to attach the Huddo Config JSP to the header:
This is achieved by customising the header.jsp file, used for customizing the Connections Navigation bar.
If you have not customised the header.jsp file for your connections environment, please make a copy of the file from:
<WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/Homepage.ear/homepage.war/nav/templates
Paste the copy into the common\\nav\\templates subdirectory in the customization directory: <installdir>\\data\\shared\\customization\\common\\nav\\templates\\header.jsp
Edit the header.jsp file in the customisations directory add the following lines after the Moderation link and before the </ul> HTML tag as shown:
To add the Huddo Config JSP
--%><c:if test=\"${'communities' == appName || 'homepage' == appName || 'profiles' == appName}\"><%--\n --%><c:catch var=\"e\"><c:import var=\"kudosConfig\" url=\"http://${pageContext.request.serverName}/Kudos/kudosConfig.jsp\"/></c:catch><%--\n --%><c:if test=\"${empty e}\"><script type=\"text/javascript\">${kudosConfig}</script></c:if><%--\n--%></c:if><%--\nTo add the Give Thanks link \u2013 This step is OPTIONAL
--%><script type=\"text/javascript\" src=\"/Huddo/scripts/widgets/ThanksAwarderHeader.js\" charset=\"utf-8\"></script><%--\n--%><li id=\"lotusBannerThankSomeone\"><a href=\"javascript:giveThanks('${urlProfiles}');\"><fmt:message key=\"label.header.kudos.givethanks\"/></a></li><%--\nSave and close the file, the changes will take effect when the clusters are restarted. (See next task)
"},{"location":"badges/install/install-widgets/#specify-huddo-analytics-admin-community-for-security","title":"Specify Huddo Analytics Admin Community for Security","text":"This change will not be picked up by Connections until the Huddo Application is restarted. This will be performed at the end of the configuration.
Create the resource.properties file in the Profiles Statistics customisation directory: <PROFILES_STATS_DIR>/HuddoProperties Where PROFILES_STATS_DIR is defined by the WebSphere variable: e.g. /opt/IBM/Connections/data/shared/profiles/statistics/HuddoProperties
Put the following line in the file, replacing <KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID> with the ID of the Huddo Analytics Community created in Task 2.4:
analyticsAdminCommunityID=<KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID>\nIMPORTANT: If a file of the same name already exists, merge the contents into the existing file.
"},{"location":"badges/install/leaderboard/","title":"Leaderboard","text":"In the Install Widgets step you made the Huddo Leaderboard widget available on the Home page for all users. This step meant that any new user would automatically see the Leaderboard widget, and any existing user would be able to add the widget by customizing the page. This step provides a button where you can publish the widget to the homepage of all existing users without them needing to manually add it themselves.
"},{"location":"badges/install/leaderboard/#add-leaderboard-to-homepage","title":"Add Leaderboard to Homepage","text":"Login to Connections and navigate to the Badges Configurator Community
Select the Settings tab in the BdagesConfigurator widget
Click the Add Leaderboard to Users Homepage button
For the proceeding prompt boxes:
All versions of Huddo Badges and Analytics require a licence to function. If you do not have a licence file, please contact us at support@huddo.com
"},{"location":"badges/install/licence/#upload-your-licence-file-in-the-badges-configurator","title":"Upload your licence file in the Badges Configurator","text":"Login to Connections Navigate to the Badges Configurator Community.
Select the Settings tab in the BadgesConfigurator widget. If there are no tabs, this is the default view.
Click the Update Licence button.
Click Choose File and browse to your Huddo.licence file and click Upload.
"},{"location":"badges/install/load-defaults/","title":"Defaults","text":"Huddo Badges is supplied with a set of default metrics and badges to kickstart performance measurement and reward within your organisation. This step loads the supplied metrics and badge definitions into your Connections database, where the widgets and gamification engine can access the definitions to measure and reward.
"},{"location":"badges/install/load-defaults/#load-defaults","title":"Load Defaults","text":"Login to Connections and navigate to the Badges Configurator Community
Select the Settings tab in the BadgesConfigurator widget, scroll to the bottom and click the 'Load Defaults' button
Select:
Note: You will need to have the corresponding Connections Applications installed. As well as have a Standard or Enterprise Licence for Huddo.
Click Save
There is a lot of data that needs to be copied to the database at this point. Therefore this operation may take a couple of minutes, please be patient.
"},{"location":"badges/update/","title":"Update","text":"The following section provides an overview of the update process and the new components that are to be installed. For an experienced Connections administrator or IBM WebSphere Application Server administrator, we expect that this update process should take no longer than one hour.
The update process for Huddo involves the following steps:
Update the Huddo Application in Websphere Application Server
Refresh the Widget Cache
Please Note: The Huddo update guide assumes that the Huddo application in the WebSphere Application server is using the Context Root /Huddo. If the Context Root has been set to something other than /Huddo, then make sure that you replace /Huddo with your Context Root when entering any URLs specified in this document.
There are two methods to perform this. Using wsadmin by following the documentation or through the homepage administration. It is recommended that if you have more than one node to use wsadmin.
Access the Homepage -> Administration setting. Click the \u2018Refresh cache\u2019 option. This may need to be done on each server running Huddo to ensure that each of the node\u2019s caches are properly refreshed.
In order to access Administration section, please ensure the logged in user is in the Homepage \u2018admin\u2019 security role.
"},{"location":"badges/update/update_app/","title":"Update the Application","text":"In order to update Huddo, the Huddo.war file in the application needs to be replaced with the new version through the Web-Sphere Integrated Solutions Console. The .war file contains all the new default data and all other application components.
"},{"location":"badges/update/update_app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"Login to the WebSphere Integrated Solution Console for your Connections environment via a web browser.
"},{"location":"badges/update/update_app/#replace-the-huddowar-file","title":"Replace the Huddo.war file","text":"Navigate to Applications -> Application Types -> WebSphere enterprise applications
Select the Huddo application and click Update.
Select Replace or add a single module option.
Type in Huddo.war in the text field. Note: This is case-sensitive!
Click Browse, navigate to and select the new Huddo.war file.
Follow the prompts clicking Next.
If prompted, click Browse and map the default resources as shown.
Follow the prompts clicking Next.
Click Finish.
Click Save directly to master configuration.
If the Nodes have automatically synchronized and you see this screen - Click OK and move to Restart the Huddo Application. Otherwise continue to Synchronize the nodes.
"},{"location":"badges/update/update_app/#synchronize-the-nodes","title":"Synchronize the nodes","text":"To complete the update process we need to Synchronize all the nodes so that the new version of Huddo is available to them all. You can skip this Task if you have Synchronize changes with Nodes option enabled and you received a synchronization summary as shown above.
Go to System Administration > Nodes.
Select the node that Huddo is installed on. (If you are unsure you may select all the nodes)
Click on Full Resynchronize and wait for the completion message.
"},{"location":"badges/update/update_app/#restart-the-huddo-application","title":"Restart the Huddo Application","text":"Go to Applications > WebSphere Enterprise Applications
Select the Huddo Application Checkbox.
Click Stop and wait for the Application Status column to display the Stopped icon.
Select the Huddo Application Checkbox.
Click Start and wait for the Application Status column to display the Started icon.
"},{"location":"badges/update/updatev6tov7/","title":"Updatev6tov7","text":"The following steps provides an overview of the update process needed for the initial upgrade from v6.0.0 to 7.0.0. These steps should be done in addition to the usual update steps. For an experienced Connections administrator or IBM WebSphere Application Server administrator, we expect that this update process should take no longer than one hour.
"},{"location":"badges/update/updatev6tov7/#update-context-root","title":"Update Context Root","text":""},{"location":"badges/update/updatev6tov7/#update-widgets","title":"Update Widgets","text":""},{"location":"badges/update/updatev6tov7/#homepage","title":"Homepage","text":"Open the Administration tab (on the Homepage) and browse to the Enabled Widgets list. For each Kudos Widget listed, select it and edit.
OLD Widget Title OLD URL Address NEW Widget Title NEW URL Address Leaderboard Kudos Leaderboard https://<CONNECTIONS_SERVER_URL>/Kudos/RankingDisplay.xml Huddo Leaderboard https://<CONNECTIONS_SERVER_URL>/Huddo/RankingDisplay.xml News Gadget Kudos News Gadget https://<CONNECTIONS_SERVER_URL>/Kudos/KudosNewsGadget.xml Huddo News Gadget https://<CONNECTIONS_SERVER_URL>/Huddo/HuddoNewsGadget.xml Awarder Kudos Awarder https://<CONNECTIONS_SERVER_URL>/Kudos/KudosAwarder.xml Huddo Awarder https://<CONNECTIONS_SERVER_URL>/Huddo/HuddoAwarder.xml User Analytics Kudos User Analytics https://<CONNECTIONS_SERVER_URL>/Kudos/AnalyticsDashboard.xml Huddo User Analytics https://<CONNECTIONS_SERVER_URL>/Huddo/AnalyticsDashboard.xml"},{"location":"badges/update/updatev6tov7/#profile-community","title":"Profile & Community","text":""},{"location":"badges/update/updatev6tov7/#update-headerjsp","title":"Update header.jsp","text":""},{"location":"badges/update/updatev6tov7/#update-mobile","title":"Update Mobile","text":""},{"location":"badges/update/updatev6tov7/#update-database","title":"Update Database","text":"Note
The Huddo update guide assumes that the Huddo application in the WebSphere Application server is using the Context Root \u2018/Huddo\u2019. If the Context Root has been set to something other than \u2018/Huddo\u2019, then make sure that you replace \u2018/Huddo\u2019 with your Context Root when entering any URLs specified in this document.
"},{"location":"boards/","title":"Huddo Boards Versions","text":"We are proud to say that Huddo Boards is able to run in many configurations to suit your individual requirements.
This version is hosted by the ISW Huddo team at https://boards.huddo.com. Free trials are available!
Advantages
See here for more information.
"},{"location":"boards/#boards-self-hosted-on-premise","title":"Boards Self-Hosted (On-Premise)","text":"Our Boards Cloud product, installed locally in your infrastructure
Advantages
See install details for Kubernetes or HCL Connections Component Pack.
"},{"location":"boards/#boards-hybrid","title":"Boards Hybrid","text":"(Cloud integrated with HCL Connections On-Premise.)
This version is the best of both worlds if you already have HCL Connections but want the latest and greatest Boards functionality without managing more servers! Huddo Boards Cloud can integrate with your existing HCL Connections on-premise installation.
Advantages
Looks and feels like another application similar to Communities/Blogs etc with:
Requirements
See installation details for more information.
Browser Support
We support the most recent two versions of the following browsers:
Huddo Boards Docker has been tested and confirmed working with the following versions
Minimum Maximum Kubernetesv1.16 v1.27.7 MongoDB v4.0 v7.0.4 Redis v4.0 v6.x"},{"location":"boards/compatibility/#known-incompatible","title":"Known Incompatible","text":""},{"location":"boards/compatibility/#azure-cosmos-db","title":"Azure Cosmos DB","text":"Issue
Unfortunately the Azure Cosmos DB only supports a subset of the MongoDB API. They are working on reducing the gaps. There have been many requests to handle nested indexes and we believe Microsoft are working on it;
https://feedback.azure.com/d365community/idea/3ddf6028-0f25-ec11-b6e6-000d3a4f0858
https://feedback.azure.com/d365community/idea/ad9a64e6-0e25-ec11-b6e6-000d3a4f0858
Suggestion
If Azure is a requirement, we would suggest looking at MongoDB Atlas on Microsoft Azure. This is a fully feature compliant MongoDB hosted in Azure.
Please contact us at support@huddo.com if you need further information.
"},{"location":"boards/helm-charts-kudos/","title":"Helm Chart History (Deprecated)","text":"Warning
These charts are deprecated. Please see the new charts
Release notes for each Helm chart utilised by Boards (for Component Pack vs standalone, and Activity Migration)
"},{"location":"boards/helm-charts-kudos/#standalone-kubernetes","title":"Standalone Kubernetes","text":""},{"location":"boards/helm-charts-kudos/#kudos-boards","title":"kudos-boards","text":"3.0.0 - Webhooks, Annotations for Socket cookie, support service.nodePort
This chart includes a new Boards service. In order to use the image from our repository with the component pack v3 chart you must add the new image tag.
As of release 2021-06-09 you must move all the NOTIFIER_* environment variables from core to events. See our documentation for all supported options.
For example:
events:\n image:\n name: \"\"\n tag: boards-event\n env:\n NOTIFIER_EMAIL_HOST: <smtp-email-host>\n NOTIFIER_EMAIL_USERNAME: <smtp-email-username>\n NOTIFIER_EMAIL_PASSWORD: <smtp-email-password>\n # plus all other NOTIFIER options previously defined in core\n3.0.1 - Minio root credentials, nfs mountOptions
Release notes for each Helm chart utilised by Boards (for Component Pack vs standalone, and Activity Migration)
Important
As of January 2023 we have moved our image hosting. Please follow this guide to configure your Kubernetes with access to our images hosted in Quay.io.
"},{"location":"boards/helm-charts/#standalone-kubernetes","title":"Standalone Kubernetes","text":""},{"location":"boards/helm-charts/#huddo-boards","title":"huddo-boards","text":"Danger
As of huddo-boards-cp-1.0.0.tgz we have changed the Minio pods to run as user 1000 instead of root. You must perform the following command on the shared drive (/pv-connections file system) before using this new chart. The change is backwards compatible.
cd /pv-connections/kudos-boards-minio/\nchown 1000:1000 -R .\nInfo
The previous chart information has moved here
"},{"location":"boards/hybrid/","title":"Boards Hybrid","text":"Hybrid = Cloud integrated with HCL Connections On-Premise
This version is the best of both worlds if you already have HCL Connections but want the latest and greatest Boards functionality without managing more servers! Huddo Boards Cloud can integrate with your existing HCL Connections on-premise installation.
For a comparison of Boards versions please see here
Setting up the Hybrid Boards Cloud involves:
Configure Authentication
Review Security
Contact the Huddo Team with these details
Company name:\nContact name:\nContact email address:\nCONNECTIONS_URL: https://connections.example.com\nCONNECTIONS_CLIENT_ID: huddoboards\nCONNECTIONS_CLIENT_SECRET: [VALUE_PRINTED]\nCONNECTIONS_HOSTNAME_BASE64:\nConfigure HCL Connections extensions
You can get the latest versions of Huddo Boards Docker by subscribing to our own repository in Quay.io as follows:
Create a Quay.io - Red Hat account if you do not already have one.
Email support@huddo.com requesting access to Huddo Boards Docker repository, include your Quay.io account name in the email. We will reply when this is configured on our end.
Get secret to use in Kubernetes
Open Quay.io, In the user menu, click on 'Account Settings'
Click Generate Encrypted Password
Enter your password and click Verify
Download the secret.yml file. Take note of the name of the secret for later use
Use the file downloaded to create the secret (in the required namespace). For example:
# for CP installs\nkubectl create -f username-secret.yml --namespace=connections\n\n# for other Kubernetes installs\nkubectl create -f username-secret.yml --namespace=boards\nImportant - new image hosting
As of January 2023 we have moved our image hosting. Please follow this guide to configure your Kubernetes with access to our images hosted in Quay.io. We have provided new Huddo charts to utilise these images.
Please use the appropriate update command with the latest helm chart. For example:
Huddo Boards in Kubernetes
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nComponent Pack (Activities Plus)
Tip
To upgrade from images in the Component Pack to images hosted by us please follow this guide.
Danger
New chart for Component Pack
As of huddo-boards-cp-1.0.0.tgz we have changed the Minio pods to run as user 1000 instead of root. You must perform the following command on the shared drive (/pv-connections file system) before using this new chart. The change is backwards compatible.
cd /pv-connections/kudos-boards-minio/\nchown 1000:1000 -R .\nhelm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections\nNote
Updates may include minor schema migrations at any time. If you have a need to downgrade versions then we recommend performing a back-up of the Mongo database before you update versions.
"},{"location":"boards/releases/#2023","title":"2023","text":""},{"location":"boards/releases/#2023-12-18","title":"2023-12-18","text":"Feature:
Improvements:
Fixes:
Features:
Support for Domino by REST API
Tip
Please follow this guide to migrate from your existing Proton based Domino authentication
Improvements:
Fixes:
Improvements:
Accessibility
API for Member deletion
Fixes:
--
"},{"location":"boards/releases/#2023-10-31","title":"2023-10-31","text":"Improvements:
Fixes:
Danger
When deployed, this release (and all subsequent) will perform a once-off schema migration for Boards notification/event data in the Mongo database. We recommend performing a back-up of the database before you update versions
Features
Improvements:
Fixes:
Improvements:
Fixes:
KNOWN ISSUE
Danger
When deployed, this release (and all subsequent) will perform major once-off schema migrations for Boards data in the Mongo database. We recommend performing a back-up of the database before you update versions.
Features:
Improvements:
API performance (faster response, less data) of the
Users with the author role now have full edit access on cards that are assigned to them (rather than complete and comment access only)
Fixes:
Improvements:
Microsoft Teams
Fixes:
Danger
When deployed, this release (and all subsequent) will perform major once-off schema migrations for Boards data in the Mongo database. We recommend performing a back-up of the database before you update versions.
Features:
Improvements:
Drag and drop of lists
Fixes:
Card drag and drop
Issue with exporting Board as CSV with special characters (e.g. Umlaut)
Fixes:
Improvements:
Fixes:
Improvements:
Dockerhub
Improvements:
Fixes:
/boardsDockerhub
Improvements:
Fixes:
Dockerhub
Improvements:
Dockerhub
Features:
Performance:
Improvements:
> In browser console, you can enter `boards.setDebug(true)` and press Enter to enable this, then reload the page.\n> You will then get debug logs in the console for all websocket and description lock events.\n> Use `boards.setDebug(false)` to turn this off when done.\nFixes:
Dockerhub
Improvements:
Timeline:
Fixes:
Dockerhub
Fixes:
Dockerhub
API Updates:
PATCH method for /node/{nodeId} to allow changing any attribute of a card or list/webhook/card-moved/{boardId})Translations:
Features / Fixes:
Dockerhub
Security Update:
Dockerhub
Features:
Dockerhub
Features:
Fixes:
Dockerhub
Improvements:
Fixes:
Dockerhub
Features:
Improvements:
Fixes:
Dockerhub
Features:
Improvements:
Fixes:
Dockerhub
Features:
Login to Boards using Single Sign On (SSO) in Microsoft Teams
Note: you will need to:
Fixes:
Dockerhub
Improvements:
Fixes:
Activity Migration:
Dockerhub
Improvements:
Fixes:
Dockerhub
Improvements:
Fixes:
Activity Migration:
Dockerhub
Features:
Improvements:
Fixes:
Activity Migration:
Dockerhub
"},{"location":"boards/releases/#file-store-migration","title":"File store migration","text":"CAUTION: When deployed, this release (and all subsequent) will migrate the minio file store, changing it's structure permanently, we recommend performing a backup of the file store (/pv-connections/kudos-boards-minio) before installation in case there is any need to roll back.
Improvements:
Fixes:
Dockerhub
Fixes:
2021-12-17 Dockerhub
Improvements:
Fixes:
2021-11-23 Dockerhub
Features:
Improvements:
Fixes:
2021-11-18 Dockerhub
Updates:
2021-11-02 Dockerhub
Fixes:
2021-10-26 Dockerhub
Fixes:
2021-10-22 Dockerhub
Features:
Improvements:
Fixes:
2021-09-29 Dockerhub
Improvements:
Reduce reliance on Communities application
Undo / Redo option in Rich Text editor
Fixes:
providerID_1 with new options2021-09-24 Dockerhub
Improvements:
Fixes:
2021-09-17 Dockerhub
Note: this update performs several schema changes on start-up as a once-off. Board content may be temporarily unavailable for a few minutes. Also be aware that downgrading to a previous release will cause access issues in Community boards with role 'inherit'. Please contact us if you have any issues at support@huddo.com
Note: if you encounter 400 bad requests when loading /boards, please see this troubleshooting guide.
Features:
Improvements:
Fixes:
2021-06-24 Dockerhub
Fixes:
FORCE_POLLING in webfront to avoid issues seen when using IHS as reverse proxy/api-boards/2021-06-09 Dockerhub
Breaking change:
Emails are now sent by the events service. You must move the NOTIFIER_* environment variables from core to events as shown in v3 of our chart
Images:
iswkudos/kudos-boards:user-2021-06-09\niswkudos/kudos-boards:provider-2021-06-09\niswkudos/kudos-boards:licence-2021-06-09\niswkudos/kudos-boards:notification-2021-06-09\niswkudos/kudos-boards:webfront-2021-06-09\niswkudos/kudos-boards:core-2021-06-09\niswkudos/kudos-boards:boards-2021-06-09\niswkudos/kudos-boards:activity-migration-2021-06-09\niswkudos/kudos-boards:boards-event-2021-06-09\nNew Features:
Improvements:
Fixes
2021-06-02 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-06-02\niswkudos/kudos-boards:provider-2021-06-02\niswkudos/kudos-boards:licence-2021-06-02\niswkudos/kudos-boards:notification-2021-06-02\niswkudos/kudos-boards:webfront-2021-06-02\niswkudos/kudos-boards:core-2021-06-02\niswkudos/kudos-boards:boards-2021-06-02\niswkudos/kudos-boards:activity-migration-2021-06-02\niswkudos/kudos-boards:boards-event-2021-06-02\nImprovements:
Fixes
2021-05-31 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-05-31\niswkudos/kudos-boards:provider-2021-05-31\niswkudos/kudos-boards:licence-2021-05-31\niswkudos/kudos-boards:notification-2021-05-31\niswkudos/kudos-boards:webfront-2021-05-31\niswkudos/kudos-boards:core-2021-05-31\niswkudos/kudos-boards:boards-2021-05-31\niswkudos/kudos-boards:activity-migration-2021-05-31\niswkudos/kudos-boards:boards-event-2021-05-31\nImprovements:
Fixes:
2021-05-13 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-05-13\niswkudos/kudos-boards:provider-2021-05-13\niswkudos/kudos-boards:licence-2021-05-13\niswkudos/kudos-boards:notification-2021-05-13\niswkudos/kudos-boards:webfront-2021-05-13\niswkudos/kudos-boards:core-2021-05-13\niswkudos/kudos-boards:boards-2021-05-13\niswkudos/kudos-boards:activity-migration-2021-05-13\niswkudos/kudos-boards:boards-event-2021-05-13\nImprovements:
Link to Files / Upload to Files
Allow custom NodeMailer email options (insecure tls etc)
core.env.NOTIFIER_EMAIL_OPTIONS: \"{\\\"ignoreTLS\\\": true,\\\"tls\\\":{\\\"rejectUnauthorized\\\":false}}\"
Fixes:
2021-05-04 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-05-04\niswkudos/kudos-boards:provider-2021-05-04\niswkudos/kudos-boards:licence-2021-05-04\niswkudos/kudos-boards:notification-2021-05-04\niswkudos/kudos-boards:webfront-2021-05-04\niswkudos/kudos-boards:core-2021-05-04\niswkudos/kudos-boards:boards-2021-05-04\niswkudos/kudos-boards:activity-migration-2021-05-04\niswkudos/kudos-boards:boards-event-2021-05-04\nImprovements:
Fixes:
2021-04-29 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-04-29\niswkudos/kudos-boards:provider-2021-04-29\niswkudos/kudos-boards:licence-2021-04-29\niswkudos/kudos-boards:notification-2021-04-29\niswkudos/kudos-boards:webfront-2021-04-29\niswkudos/kudos-boards:core-2021-04-29\niswkudos/kudos-boards:boards-2021-04-29\niswkudos/kudos-boards:activity-migration-2021-04-29\niswkudos/kudos-boards:boards-event-2021-04-29\nNew:
Fixes:
2021-04-26 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-04-26\niswkudos/kudos-boards:provider-2021-04-26\niswkudos/kudos-boards:licence-2021-04-26\niswkudos/kudos-boards:notification-2021-04-26\niswkudos/kudos-boards:webfront-2021-04-26\niswkudos/kudos-boards:core-2021-04-26\niswkudos/kudos-boards:boards-2021-04-26\niswkudos/kudos-boards:activity-migration-2021-04-26\nImprovements:
Fixes:
Activity Migration
2021-03-22 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-22\niswkudos/kudos-boards:provider-2021-03-22\niswkudos/kudos-boards:licence-2021-03-22\niswkudos/kudos-boards:notification-2021-03-22\niswkudos/kudos-boards:webfront-2021-03-22\niswkudos/kudos-boards:core-2021-03-22\niswkudos/kudos-boards:boards-2021-03-22\niswkudos/kudos-boards:activity-migration-2021-03-22\nImprovements:
Fixes:
2021-03-16 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-16\niswkudos/kudos-boards:provider-2021-03-16\niswkudos/kudos-boards:licence-2021-03-16\niswkudos/kudos-boards:notification-2021-03-16\niswkudos/kudos-boards:webfront-2021-03-16\niswkudos/kudos-boards:core-2021-03-16\niswkudos/kudos-boards:boards-2021-03-16\niswkudos/kudos-boards:activity-migration-2021-03-16\nImprovements:
Ability to transition between providers
Fixes:
2021-03-10 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-10\niswkudos/kudos-boards:provider-2021-03-10\niswkudos/kudos-boards:licence-2021-03-10\niswkudos/kudos-boards:notification-2021-03-10\niswkudos/kudos-boards:webfront-2021-03-10\niswkudos/kudos-boards:core-2021-03-10\niswkudos/kudos-boards:boards-2021-03-10\niswkudos/kudos-boards:activity-migration-2021-03-10\nFixes:
Activity Migration:
2021-03-05 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-05\niswkudos/kudos-boards:provider-2021-03-05\niswkudos/kudos-boards:licence-2021-03-05\niswkudos/kudos-boards:notification-2021-03-05\niswkudos/kudos-boards:webfront-2021-03-05\niswkudos/kudos-boards:core-2021-03-05\niswkudos/kudos-boards:boards-2021-03-05\niswkudos/kudos-boards:activity-migration-2021-03-05\nFeatures:
API integrations with
Leave a Board
Fixes:
2021-03-04 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-04\niswkudos/kudos-boards:provider-2021-03-04\niswkudos/kudos-boards:licence-2021-03-04\niswkudos/kudos-boards:notification-2021-03-04\niswkudos/kudos-boards:webfront-2021-03-04\niswkudos/kudos-boards:core-2021-03-04\niswkudos/kudos-boards:boards-2021-03-04\niswkudos/kudos-boards:activity-migration-2021-03-04\nFixes:
2021-03-03 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-03\niswkudos/kudos-boards:provider-2021-03-03\niswkudos/kudos-boards:licence-2021-03-03\niswkudos/kudos-boards:notification-2021-03-03\niswkudos/kudos-boards:webfront-2021-03-03\niswkudos/kudos-boards:core-2021-03-03\niswkudos/kudos-boards:boards-2021-03-03\niswkudos/kudos-boards:activity-migration-2021-03-03\nImprovements:
Fixes:
2021-02-19 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-02-19\niswkudos/kudos-boards:provider-2021-02-19\niswkudos/kudos-boards:licence-2021-02-19\niswkudos/kudos-boards:notification-2021-02-19\niswkudos/kudos-boards:webfront-2021-02-19\niswkudos/kudos-boards:core-2021-02-19\niswkudos/kudos-boards:boards-2021-02-19\niswkudos/kudos-boards:activity-migration-2021-02-19\nImprovements:
Fixes:
2021-01-19 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-01-19\niswkudos/kudos-boards:provider-2021-01-19\niswkudos/kudos-boards:licence-2021-01-19\niswkudos/kudos-boards:notification-2021-01-19\niswkudos/kudos-boards:webfront-2021-01-19\niswkudos/kudos-boards:core-2021-01-19\niswkudos/kudos-boards:boards-2021-01-19\niswkudos/kudos-boards:activity-migration-2021-01-19\nImprovements:
Fixes:
2020-12-14
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-12-14\niswkudos/kudos-boards:provider-2020-12-14\niswkudos/kudos-boards:licence-2020-12-14\niswkudos/kudos-boards:notification-2020-12-14\niswkudos/kudos-boards:webfront-2020-12-14\niswkudos/kudos-boards:core-2020-12-14\niswkudos/kudos-boards:boards-2020-12-14\niswkudos/kudos-boards:activity-migration-2020-12-14\nFeatures:
Added fix for Activities that had already been imported and used the equivalent permission set in Activities
boards.yaml
migration:\n env:\n # test = report activities and board membership that can be updated\n # true = run the fix and report results\n FIX_COMMUNITY_OWNERS_ONLY: test|true\n2020-12-12
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-12-12\niswkudos/kudos-boards:provider-2020-12-12\niswkudos/kudos-boards:licence-2020-12-12\niswkudos/kudos-boards:notification-2020-12-12\niswkudos/kudos-boards:webfront-2020-12-12\niswkudos/kudos-boards:core-2020-12-12\niswkudos/kudos-boards:boards-2020-12-12\niswkudos/kudos-boards:activity-migration-2020-12-12\nFeatures:
2020-11-13
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-11-13\niswkudos/kudos-boards:provider-2020-11-13\niswkudos/kudos-boards:licence-2020-11-13\niswkudos/kudos-boards:notification-2020-11-13\niswkudos/kudos-boards:webfront-2020-11-13\niswkudos/kudos-boards:core-2020-11-13\niswkudos/kudos-boards:boards-2020-11-13\niswkudos/kudos-boards:activity-migration-2020-11-13\nImprovements:
2020-11-02
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-11-02\niswkudos/kudos-boards:provider-2020-11-02\niswkudos/kudos-boards:licence-2020-11-02\niswkudos/kudos-boards:notification-2020-11-02\niswkudos/kudos-boards:webfront-2020-11-02\niswkudos/kudos-boards:core-2020-11-02\niswkudos/kudos-boards:boards-2020-11-02\niswkudos/kudos-boards:activity-migration-2020-11-02\nImprovements:
Fixes:
2020-10-14
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-10-14\niswkudos/kudos-boards:provider-2020-10-14\niswkudos/kudos-boards:licence-2020-10-14\niswkudos/kudos-boards:notification-2020-10-14\niswkudos/kudos-boards:webfront-2020-10-14\niswkudos/kudos-boards:core-2020-10-14\niswkudos/kudos-boards:boards-2020-10-14\niswkudos/kudos-boards:activity-migration-2020-10-14\nImprovements:
Fixes:
2020-10-05
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-10-05\niswkudos/kudos-boards:provider-2020-10-05\niswkudos/kudos-boards:licence-2020-10-05\niswkudos/kudos-boards:notification-2020-10-05\niswkudos/kudos-boards:webfront-2020-10-05\niswkudos/kudos-boards:core-2020-10-05\niswkudos/kudos-boards:boards-2020-10-05\niswkudos/kudos-boards:activity-migration-2020-10-05\nFeatures:
Improvements:
Fixes:
2020-09-18
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-09-18\niswkudos/kudos-boards:provider-2020-09-18\niswkudos/kudos-boards:licence-2020-09-18\niswkudos/kudos-boards:notification-2020-09-18\niswkudos/kudos-boards:webfront-2020-09-18\niswkudos/kudos-boards:core-2020-09-18\niswkudos/kudos-boards:boards-2020-09-18\niswkudos/kudos-boards:activity-migration-2020-09-18\nFeatures:
Improvements:
Fixes:
2020-08-24
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-08-24\niswkudos/kudos-boards:provider-2020-08-24\niswkudos/kudos-boards:licence-2020-08-24\niswkudos/kudos-boards:notification-2020-08-24\niswkudos/kudos-boards:webfront-2020-08-24\niswkudos/kudos-boards:core-2020-08-24\niswkudos/kudos-boards:boards-2020-08-24\niswkudos/kudos-boards:activity-migration-2020-08-24\nFeatures:
Improvements:
Fixes:
2020-07-10
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-07-10\niswkudos/kudos-boards:provider-2020-07-10\niswkudos/kudos-boards:licence-2020-07-10\niswkudos/kudos-boards:notification-2020-07-10\niswkudos/kudos-boards:webfront-2020-07-10\niswkudos/kudos-boards:core-2020-07-10\niswkudos/kudos-boards:boards-2020-07-10\niswkudos/kudos-boards:activity-migration-2020-07-10\nImprovements:
Activity Migration:
2020-06-17
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-06-17\niswkudos/kudos-boards:provider-2020-06-17\niswkudos/kudos-boards:licence-2020-06-17\niswkudos/kudos-boards:notification-2020-06-17\niswkudos/kudos-boards:webfront-2020-06-17\niswkudos/kudos-boards:core-2020-06-17\niswkudos/kudos-boards:boards-2020-06-17\niswkudos/kudos-boards:activity-migration-2020-06-17\nFixes:
Activity Migration:
2020-06-05
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-06-05\niswkudos/kudos-boards:provider-2020-06-05\niswkudos/kudos-boards:licence-2020-06-05\niswkudos/kudos-boards:notification-2020-06-05\niswkudos/kudos-boards:webfront-2020-06-05\niswkudos/kudos-boards:core-2020-06-05\niswkudos/kudos-boards:boards-2020-06-05\nPlease see our Cloud blog
Improvements:
New Features:
Fixes:
2020-04-09
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-04-09\niswkudos/kudos-boards:provider-2020-04-09\niswkudos/kudos-boards:licence-2020-04-09\niswkudos/kudos-boards:notification-2020-04-09\niswkudos/kudos-boards:webfront-2020-04-09\niswkudos/kudos-boards:core-2020-04-09\niswkudos/kudos-boards:boards-2020-04-09\nFixes:
2020-03-06
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-03-06\niswkudos/kudos-boards:provider-2020-03-06\niswkudos/kudos-boards:licence-2020-03-06\niswkudos/kudos-boards:notification-2020-03-06\niswkudos/kudos-boards:webfront-2020-03-06\niswkudos/kudos-boards:core-2020-03-06\niswkudos/kudos-boards:boards-2020-03-06\nFixes:
Language support:
\"supported\": {\n \"ar\":[],\n \"bg\":[],\n \"ca\":[],\n \"cs\":[],\n \"da\":[],\n \"de\": [],\n \"el\":[],\n \"en\": [\"US\"],\n \"es\":[],\n \"fi\":[],\n \"fr\":[],\n \"he\":[],\n \"hr\":[],\n \"hu\":[],\n \"it\":[],\n \"ja\":[],\n \"kk\":[],\n \"ko\":[],\n \"nb\":[],\n \"nl\":[],\n \"pl\":[],\n \"pt\":[],\n \"ro\":[],\n \"ru\":[],\n \"sk\":[],\n \"sl\":[],\n \"sv\":[],\n \"th\":[],\n \"tr\":[],\n \"zh\":[\"TW\"]\n },\n \"default\": \"en\"\nMost data is stored in MongoDB hosted by MongoDB Atlas in a Google Cloud datacentre (EU West). User images are stored in Google Cloud Object storage.
"},{"location":"boards/security/#mongodb-atlas-is-secured-by","title":"MongoDB Atlas is secured by:","text":"There are NO passwords stored by the app.
"},{"location":"boards/standalone/","title":"Boards Standalone Deployment","text":"This document outlines a standalone (all in one) deployment of Huddo Boards. This can be used as a proof of concept, staging deployment or even a production deployment for a limited number of users (e.g. < 500).
You may run all services including database and file storage on one server, or you can use an external mongo database or s3 file store.
Like all other deployments of Huddo Boards, this requires configuration of 2 domains: Application and API. e.g. boards.huddo.com and boards.api.huddo.com
"},{"location":"boards/standalone/#server-requirements","title":"Server requirements","text":"RHEL (or Centos 7) server with:
Please follow this guide to get access to our images in Quay.io so that we may give you access to our repositories and templates.
"},{"location":"boards/standalone/#options","title":"Options","text":""},{"location":"boards/standalone/#network","title":"Network","text":"You may use an external proxy or send traffic directly to the server. If you are sending traffic directly to the server, you will need pem encoded certificate (with full chain) and key.
"},{"location":"boards/standalone/#persistence","title":"Persistence","text":"Boards uses 3 types of persistent data: mongodb, s3 file store and redis cache.
Each of these may use external services or the included services in the template (this hugely changes the server demand).
If using the included services, you will need to map directories for mongo and s3 containers to the data drive above, this data drive should be backed up however you currently backup data
"},{"location":"boards/standalone/#environment-variables","title":"Environment Variables","text":"Most required variables are in the template, for more information see the Kubernetes docs
You can create your own tours by calling the boards.setTours() function in console.
Open dev tools with Cmd-Shift-I or Ctrl-Shift-I then got to the console tab
Tours are currently disabled by default, to enable them type boards.enableTours() then press Enter, now reload your page and the tours will be available.
boards.setTours([{\n id: 'create-first-board-mobile',\n routes: ['/', '/my', '/public'],\n sizes: ['isMobile'],\n disabled: false,\n disableAnimation: false,\n steps: [\n {\n spotlight: '.create-board-fab button',\n title: 'Welcome to Boards',\n body: [\"Let's get started\", 'Click here'],\n actions: [\n { title: 'More information', url: 'https://huddo.com/boards' },\n ],\n },\n {\n spotlight: '.template-dialog .HuddoMuiPaper-root',\n when: '.template-dialog .HuddoMuiPaper-root .step-1',\n title: 'Pick a template',\n body: \"Boards can have a template. Select one and click 'Next'\",\n hideArrow: true,\n placement: 'bottom-end',\n },\n {\n spotlight: '.template-dialog .HuddoMuiPaper-root',\n when: '.template-dialog .HuddoMuiPaper-root .step-2',\n title: 'Name the Board',\n body: 'Invite other members to collaborate with you in this Board.',\n },\n ],\n}])\nOrganisation administrators can view a list of all boards in their organisation, with actions available to manage these boards and their members. To access the new view in
a) Boards Cloud
On the Huddo Boards homepage / My Boards page, click your organisation on the left sidebar, then click the Boards tab to view the list of boards:
b) Boards On-Premise
Open Admin Settings, then your organisation
Under Content management click Boards
The boards data can be sorted by clicking on the column headers:
"},{"location":"boards/admin/content-member-management/#searching","title":"Searching","text":"Boards can be searched by board name or by owner.
Click the search icon to the left of the column name to search:
"},{"location":"boards/admin/content-member-management/#by-board-name","title":"By Board Name","text":"Type a board name to filter the results:
"},{"location":"boards/admin/content-member-management/#by-owner","title":"By Owner","text":"Search for a group or user and then select an entity to show only boards that have that owner:
"},{"location":"boards/admin/content-member-management/#showhide-archived-boards","title":"Show/hide archived boards","text":"Archived boards can be shown or hidden by using the switch in the Archived column header:
Members for each individual board can be viewed and modified by clicking the Edit Members button on the right of the board row:
Clicking on a board in the list will select it. All boards can be selected using the top-most checkbox in the header. Once boards are selected, options become available to action on those boards:
"},{"location":"boards/admin/content-member-management/#archive","title":"Archive","text":"Archive the selected boards.
"},{"location":"boards/admin/content-member-management/#restore","title":"Restore","text":"Restore boards that are archived.
"},{"location":"boards/admin/content-member-management/#manage-ownership","title":"Manage Ownership","text":"This action will show a dialog allowing new owners to be added and/or existing owners removed from the boards that are selected:
"},{"location":"boards/admin/content-member-management/#delete","title":"Delete","text":"Danger
Use this action cautiously and at your own risk.
Delete the selected boards and all their data permanently.
"},{"location":"boards/admin/content-member-management/#find-and-replace-owner-on-all-boards","title":"Find and replace owner on all boards","text":"It may be necessary to replace a board owner with someone else across all boards in the organisation, for example if an employee has left the company and the boards data needs to be accessed by their replacement. To do this:
Click the Find and replace owner on all boards button to bring up a dialog:
Search for and select the current owner to replace and the new/replacement owner. Groups can be selected:
Click the Replace Owner button to confirm the owner replacement:
Note
an undo action will temporarily appear at the bottom left of screen if you wish to cancel this action
Remove OAuth ClientID from user.env
Comment out the CLIENT_ID for the provider to be deactivated:
user:\n env:\n # CONNECTIONS_CLIENT_ID\n # MSGRAPH_CLIENT_ID\nRedeploy the Helm chart
For example:
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nReload webpage
The login option should be removed
Note: admins only - on premise
This process allows you to link user accounts across multiple login methods by their email address. This gives the user the ability to login with either account, and more importanly collaborate with users in either system (ie Connections, Microsoft etc).
"},{"location":"boards/admin/link-users/#prerequisites","title":"Prerequisites","text":"Profiles are synchronised
In order to link accounts it is highly recommended to synchronise accounts to ensure they exist in the Boards database. Please follow these instructions first
user microservicereplicaCount: 1You can view the logs of the user service to see an output of changes
The command is safe to run multiple times. The list of already linked should show the previous links, and there will be no new changes unless more users have been imported into the Boards DB.
Environment variables
This process links users in 2 difference clients. We utilise environment variables to initialise the process, e.g.
user:\n replicaCount: 1\n env:\n PROFILE_LINK_CLIENT_PRIMARY: 5ef2d52f6283afc12efd55a4\n PROFILE_LINK_CLIENT_SECONDARY: 5fd6974dd7c5ede08711432d\n # Determines if user accounts are linked on the email prefix (before the @ symbol), default is false\n # i.e. jsmith@huddo.com & jsmith@isw.net.au\n # PROFILE_LINK_EMAIL_PREFIX_ONLY: true\nRedeploy the Helm chart
For example:
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nReview the logs
The logs should output in this format. Note the users who have been updated/ignored. On subsequent runs the people in updated will appear in noChange instead.
Remove Environment variables above and redeploy the Helm chart
Licence management is available at an organisation level for Huddo Boards.
To access these settings, sign in to Huddo Boards as an administrator of your organisation. Click your profile image and then Admin Settings:
The licence(s) for your org will be shown, each one can be opened for more information.
Here you can see all the users who have been assigned a licence.
'Named Users' licences can be specifically added, removed or reassigned. 'Open Licence' is available to any user in an organisation on a first come first serve basis. These can also be reassigned if required.
Note that Org Configs are created automatically for all orgs with default settings.
"},{"location":"boards/admin/manage-licences/#buy-huddo-boards-via-admin-settings","title":"Buy Huddo Boards via Admin Settings","text":"For users accessing Huddo Boards via O365, HCL Connections (hybrid and collab.cloud), Apple ID, Google, LinkedIn and Facebook, subscriptions can be purchased via the Huddo Boards Admin Settings in your web browser.
Navigate to Admin Settings and then select to 'Buy Online'.
Your subscription will be updated automatically.
"},{"location":"boards/admin/manage-licences/#buy-huddo-boards-via-ms-teams","title":"Buy Huddo Boards via MS teams","text":"As an O365 administrator, you can buy Huddo Boards for your organisation via MS Teams.
Navigate to Huddo Boards MyBoards Dashboard via More Added Apps in MS Teams and under your profile image locate Admin Settings.
Click Organisation to see your org details.
Under 'Licences' select to 'Buy Online.'
On-premise Huddo Boards installs can contact us for quote requests and licence activation keys at hello@huddo.com
Huddo Boards cloud users can request a quote via Huddo Boards Admin Settings in web or MS Teams, or via email at hello@huddo.com. Please do not hesitate to ask questions or request a call to discuss your subscription requirements further.
In addition to online check out, we can receive purchase orders and provide invoices for payment.
Pricing can be found here https://www.huddo.com/pricing
"},{"location":"boards/admin/org-config/","title":"Manage Config","text":""},{"location":"boards/admin/org-config/#manage-organisation-config","title":"Manage Organisation Config","text":"Configuration options are available at an organisation level for Huddo Boards. Changing these settings will affect all Huddo Boards users in your organisation.
To access these settings, sign in to Huddo Boards as an administrator of your organisation. Click your profile image and then Admin Settings:
The config for your org will be shown, hover on the info (i) icons for more information on each setting
Changing a setting will immediately save/update the Org Config for all users.
Note: Org Configs are created automatically for all orgs with default settings.
"},{"location":"boards/admin/replace-group-membership/","title":"Replacing Group Membership","text":"Note: admins only - on premise
This service is designed to replace Board memberships for groups in one login client with replacement groups in another login client.
For example; in order to remove login via Connections but still retain access to all your boards, you will need to replace the group based memberships with replacement groups. For example Sharepoint sites instead of Communities.
"},{"location":"boards/admin/replace-group-membership/#important-notes","title":"Important Notes","text":"target ID below should be set as the ID for your intended login method (ie Microsoft), and the source that of the login method being removed (ie Connections). These IDs are visible in the URL of the admin page.replicaCount: 1boards-app microservice to see an output of changes to source/target groupsYou have created replacement groups in the target system and have records of the old ID to the new ID.
"},{"location":"boards/admin/replace-group-membership/#process","title":"Process","text":"Create CSV Map File
This process utilises a CSV file to define a map between the old ID and new ID, in the format:
<NAME_OF_GROUP>,<COMMUNITY_ID>,<SHAREPOINT_SITE_ID>\nFor example:
group-map.csv
Huddo Team,95bf5326-ee35-4e4a-b121-9b6970f86931,532fbe3d-239e-4421-b8c0-4c4d2eb87204\nSecret with CSV
Create a secret in the Boards namespace (ie boards) from your CSV file
kubectl create secret generic group-map-secret --from-file=./group-map.csv -n boards\nEnvironment variables
Set the following environment variables to mount the secret created above at a file path in the pod.
app:\n replicaCount: 1\n volumes:\n - name: group-map-volume\n secret:\n secretName: group-map-secret\n volumeMounts:\n - name: group-map-volume\n mountPath: /usr/share/groupmapsecret\n env:\n GROUP_MAP_CSV: groupmapsecret/group-map.csv\n GROUP_MAP_TARGET_CLIENT: 5fd6974dd7c5ede08711432d\n GROUP_MAP_SOURCE_CLIENT: 5ef2d52f6283afc12efd55a4\nRedeploy the Helm chart
For example:
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nReview the logs
The logs should output in this format. See that each group was mapped from a Source to a Target and how many members/nodes were updated with the new value.
Remove Environment variables above and redeploy the Helm chart
When a user leaves the organisation, you may want to deactivate their current login sessions with Boards. You may also need to remove their private information (name, email and image) from the Boards database. This can be achieved with the following steps:
Open Admin Settings, then your Organisation
Under User management click Revoke
Select whether to Anonymise the user name, email and image
Search and select the user to revoke, click Revoke
This process ensures that all users in your Connections/Microsoft accounts exist in the Boards database.
Note: this is only necessary if you are linking user accounts in bulk
"},{"location":"boards/admin/sync-profiles/#connections","title":"Connections","text":"You can now synchronise all user profiles from Connections by opening the Admin => Org => Connections client page (e.g. /admin/5eeff4a3b7adaab62352362f/client/5fd6974dd7c5ede08711432d) This service utilises the Connections Profiles Admin API which is only basic auth, so you need to add credentials for a user (eg wasadmin) who has the Admin role on the Profiles application.
Similarly, on the Microsoft client page there is another UI control for synchronising users; this uses the current user OAuth session (assuming Advanced Features have been approved)
"},{"location":"boards/admin/sync-profiles/#process","title":"Process","text":"Both of these controls allow you to run a 'test' which reports back how many new users it found, before running the process for real.
"},{"location":"boards/admin/transfer-ownership-unlink/","title":"Transfer Ownership & Unlink User Accounts","text":"Note: admins only - on premise
In the user interface a user can unlink an account alias and transferring content ownership to their primary. This process is designed to perform the same action in bulk for all users which belong to specific clients (login methods) who have linked accounts.
"},{"location":"boards/admin/transfer-ownership-unlink/#important-notes","title":"Important Notes","text":"to client target ID below should be set as the ID for your intended login method (ie Microsoft), and the from that of the login method being removed (ie Connections). These IDs are visible in the URL of the admin page.replicaCount: 1boards-app microservice to see an output of changes to source/target groupsEnvironment variables
Set the following environment variables
app:\n replicaCount: 1\n env:\n TRANSFER_AND_UNLINK_TO_CLIENT: 5fd6974dd7c5ede08711432d\n TRANSFER_AND_UNLINK_FROM_CLIENT: 5ef2d52f6283afc12efd55a4\nRedeploy the Helm chart
For example:
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nReview the logs
The logs should output information in this format. Note each transfer of content ownership from => to and the number of associated nodes/members/invites that were updated, before the alias is unlinked from the primary.
Remove Environment variables above and redeploy the Helm chart
Note: admins only - on premise
This process is designed for migrating away from a provider but keeping access to Boards. e.g. Connections to Sharepoint Sites. Please follow the steps very carefully.
When the URL of the on-prem hosting environment changes, content stored in Huddo Boards may also need to be updated.
The below will change all URLs in the names, descriptions and links for each node (card/board/comment). Replace both the domain and newDomain with your old and new URLs. The domain variable is a regular expression (regex) that needs the initial / and trailing /ig; in place and any special characters escaped with \\, such as in the example below.
Connect to the Mongo DB hosting the Boards database and run the following in the mongo shell
show dbs\n// select to the boards database (name is different for CP)\nuse kudos-boards-service OR boards-app\n\ndomain = /host\\.example\\.com/ig\nnewDomain = 'host.company.com'\nEach 2 lines of code (nodeNames, nodeDesc & nodeLinks) updates one bit of a node and can be run independently of each other.
"},{"location":"boards/admin/url-update/#node-names","title":"Node Names","text":"nodeNames = db.nodes.find({ name: { $regex: domain }}, { name: 1 }).toArray();\nnodeNames.forEach(n => db.nodes.updateOne({ _id: n._id }, { $set: { name: n.name.replace(domain, newDomain) }}) )\nnodeDesc = db.nodes.find({ description: { $regex: domain }}, { description: 1 }).toArray();\nnodeDesc.forEach(n => db.nodes.updateOne({ _id: n._id }, { $set: { description: n.description.replace(domain, newDomain) }}) )\nnodeLinks = db.nodes.find({ 'links.url': { $regex: domain }}, { links: 1 }).toArray();\nnodeLinks.forEach(n => db.nodes.updateOne({ _id: n._id }, { $set: { links: n.links.map(link => { link.url = link.url.replace(domain, newDomain); return link; })}}) )\nThis integration enables you to manage users in Auth0 for login to Huddo Boards. Auth0 will maintain a directory of your users for Huddo Boards. This enables standalone use of Huddo Boards if you do not have any of the other supported authentication providers in your business.
You may switch to using one of our other supported authentication providers at a later stage should you wish.
"},{"location":"boards/auth0/#setting-up-a-new-auth0-tenant-for-use-with-huddo-boards","title":"Setting up a new Auth0 tenant for use with Huddo Boards","text":"Huddo Boards for the name and choose Regular Web Applications as the type.In the table below, copy your auth0 domain (listed at the top of the page) into the relevant fields, replacing <domain> with 'your-domain.au.auth0.com' where applicable
Field Value Application Logo https://boards.huddo.com/img/logo-small.png Token Endpoint Authentication Method Post Allowed Callback URLs https://boards.huddo.com/auth/auth0/<domain>/callback Allowed Web Origins https://boards.huddo.com Allowed Origins (CORS) https://*.huddo.comImplicit, Authorization Code, Refresh Token and Client CredentialsIn order to allow your users to find each other, we need to enable one of Auth0's api features.
APIs and next to the Auth0 Management API Click the settings button.Machine to Machine Applications and next to Huddo Boards click the AUTHORIZED slider so it is enabled as below.> next to the slider aboveread:users scope then click UPDATECreate New User and provide the email and password for the user you wish to add. Leave the Connection as Username-Password-AuthenticationIf you aren't redirected to the users page, click them to open it
Edit under the users nameSaveOnce your Auth0 tenant has been activated you will get an email from our support team with confirmation, you may then go to Huddo Boards and use your Auth0 domain as the team name to login.
After submitting your Team Name, you'll be asked for the email address and password associated with your Auth0 user account, to finalise your login.
"},{"location":"boards/auth0/migrating/","title":"Migrating","text":""},{"location":"boards/auth0/migrating/#migrating-your-auth0-tenant-from-kudos-to-huddo","title":"Migrating your Auth0 tenant from Kudos to Huddo","text":"To start using your Auth0 tenant in Huddo Boards, you need to make a few changes to allow login at the new address.
Login to Auth0 and go to the applications list
Click your Kudos Boards application and change the following fields
In the table below, copy your auth0 domain (listed at the top of the page) into the relevant fields, replacing <domain> with 'your-domain.au.auth0.com' where applicable
Field Value Application Logo https://boards.huddo.com/img/logo-small.png Token Endpoint Authentication Method Post Allowed Callback URLs https://boards.huddo.com/auth/auth0/<domain>/callback Allowed Web Origins https://boards.huddo.com Allowed Origins (CORS) https://*.huddo.com"},{"location":"boards/cloud/","title":"Boards Cloud","text":"Boards Cloud is Huddo Boards as a service hosted and managed by the Huddo Team. Accessible now at boards.huddo.com.
You can start using Boards Cloud immediately! Look for the enterprise collaboration platform you want to integrate with in the documentation menu for instructions on getting started.
"},{"location":"boards/cloud/updates/","title":"Boards Cloud Updates","text":"Please see here for recent changes to Huddo Boards Cloud
"},{"location":"boards/cloud/updates/#2024","title":"2024","text":""},{"location":"boards/cloud/updates/#january","title":"January","text":"2024-01-09
Improvements:
Microsoft Teams integrations
faster opening of cards
Fixes:
2024-01-04
Fixes:
2023-12-22
Fixes:
2023-12-18
Improvements:
Fixes:
2023-12-13
Improvements:
2023-12-12
Fixes:
Fixes:
2023-12-07
Fixes:
2023-12-04
Feature:
2023-12-01
Fixes:
2023-11-29
Feature:
Fixes:
2023-11-28
Fixes:
Improvements:
2023-11-23
Fixes:
2023-11-13
Improvements:
Accessibility
2023-11-09
Improvements:
Fixes:
2023-10-31
Improvements:
Fixes:
2023-10-25
Improvements:
Fixes:
2023-10-23
Features:
2023-10-20
Fixes:
2023-10-19
Improvements:
2023-09-29
Improvements:
Fixes:
2023-09-22
Improvements:
Fixes:
2023-09-19
busboy dependency used for file upload (includes security patches, node support etc)2023-09-14
Improvements:
Fixes:
2023-09-12
Improvments:
2023-09-08
Fixes:
2023-09-07
Features:
Improvements:
Fixes:
2023-08-15
Fixes:
2023-08-09
Fixes:
2023-08-07
Improvements:
Fixes:
2023-07-14
Fixes:
2023-07-12
Fixes:
2023-07-05
Fixes:
2023-07-04
Fixes:
2023-07-03
Improvements:
Microsoft Teams
Fixes:
2023-06-26
Improvements:
Fixes:
2023-06-21
Fixes:
2023-06-19
Fixes:
2023-06-15
Improvements:
Fixes:
2023-06-06
Improvements:
Fixes:
2023-05-26
Features:
2023-05-23
Improvements:
Drag and drop of lists
Cards can be Archived+Deleted from the card modal toolbar.
Fixes:
Card drag and drop
Button for copying a template says \"Copy Template\" instead of \"Copy Board\"
2023-05-16
Improvements:
Organisation view of members & groups
localised format of dates in CSV export
Fixes:
2023-05-05
Features:
Improvements:
Fixes:
2023-04-21
Features:
Fixes:
2023-04-12
Features:
2023-03-20
Fixes:
2023-03-17
Improvements:
2023-03-15
Improvements:
Fixes:
2023-03-10
Features:
Fixes:
2023-02-20
Fixes:
2023-01-31
Features:
Improvements:
2023-01-24
Improvements:
2022-12-14
Improvements:
Fixes:
2022-11-29
Improvements:
Fixes:
2022-11-08
Features:
Performance:
Improvements:
Fixes:
2022-10-17
Updates for Timeline
2022-10-05
2022-10-04
2022-09-27
2022-09-05
2022-07-08
2022-06-23
2022-06-21
2022-06-10
2022-06-07
2022-05-20
2022-05-10
2022-05-09
2022-04-28
2022-04-19
2022-04-07
2022-04-06
2022-03-21
2022-03-11
2022-03-09
2022-03-03
2022-02-17
2022-01-31
2022-01-14
2022-01-04
2021-12
2021-11
2021-10
2021-09
2021-08
2021-07
2021-06
If you have not customised the apps.jsp file for your connections environment, please make a copy of the file.
You can access the file from:
<WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/Homepage.ear/homepage.war/nav/templates/menu\nPaste the copy into the common\\nav\\templates subdirectory in the customization directory:
<installdir>\\data\\shared\\customization\\common\\nav\\templates\\menu\\apps.jsp\nTo add the Huddo Boards App Link add the following lines towards the bottom of the apps.jsp file before the </table> element
--%><tr><%--\n --%><th scope=\"row\" class=\"lotusNowrap\"><%--\n --%><img width=\"16\" src=\"https://boards.huddo.com/img/logo-small.png\" /><%--\n --%><a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]\"><%--\n --%><strong><fmt:message key=\"connections.component.name.kudos.boards\" /></strong><%--\n --%></a><%--\n --%></th><%--\n --%><td class=\"lotusNowrap lotusLastCell\"><%--\n --%><a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]?redirect_to=/todos/assigned\"><%--\n --%><fmt:message key=\"label.menu.kudos.boards.todos\" /><%--\n --%></a><%--\n --%></td><%--\n --%><td class=\"lotusNowrap lotusLastCell\"><%--\n --%><a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]?redirect_to=/templates/public\"><%--\n --%><fmt:message key=\"label.menu.kudos.boards.templates\" /><%--\n --%></a><%--\n --%></td><%--\n--%></tr><%--\nWhere [CONNECTIONS_HOSTNAME_BASE64]is
connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20= There are many free online services to do this, ie hereSave and close the file
Add the Huddo Boards Strings for the Apps Menu
Download the strings files and extract the files to the Connections strings customisation directory:
<CONNECTIONS_CUSTOMIZATION_PATH>/strings\nNote: Please append the lines to the files if they already exist. Extra languages can also be added
The changes will take effect when the cluster(s) are restarted
If you have not customised the apps.jsp file for your connections environment, please make a copy of the file.
You can access the file from:
<WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/Homepage.ear/homepage.war/nav/templates/menu\nPaste the copy into the common\\nav\\templates subdirectory in the customization directory:
<installdir>\\data\\shared\\customization\\common\\nav\\templates\\menu\\apps.jsp\nTo add the Huddo Boards app links add the following lines towards the bottom of the apps.jsp file before the </table> element
--%><tr><%--\n --%><th scope=\"row\" class=\"lotusNowrap\"><%--\n --%><img width=\"16\" src=\"https://[CONNECTIONS_URL]/boards/img/logo-small.png\" /><%--\n --%><a href=\"https://[CONNECTIONS_URL]/boards/auth/connections\"><%--\n --%><strong><fmt:message key=\"connections.component.name.kudos.boards\"/></strong><%--\n --%></a><%--\n --%></th><%--\n --%><td class=\"lotusNowrap lotusLastCell\"><%--\n --%><a href=\"https://[CONNECTIONS_URL]/boards/auth/connections?redirect_to=/todos/assigned\"><%--\n --%><fmt:message key=\"label.menu.kudos.boards.todos\"/><%--\n --%></a><%--\n --%></td><%--\n --%><td class=\"lotusNowrap lotusLastCell\"><%--\n --%><a href=\"https://[CONNECTIONS_URL]/boards/auth/connections?redirect_to=/templates/public\"><%--\n --%><fmt:message key=\"label.menu.kudos.boards.templates\"/><%--\n --%></a><%--\n --%></td><%--\n--%></tr><%--\nNote: you must replace [CONNECTIONS_URL]
Save and close the file
Add the Huddo Boards Strings for the Apps Menu
Download the strings files and extract the files to the Connections strings customisation directory:
<CONNECTIONS_CUSTOMIZATION_PATH>/strings\nNote: Please append the lines to the files if they already exist. Extra languages can also be added
The changes will take effect when the cluster(s) are restarted
In order for Huddo Boards to authenticate with your Connections environment, you must define a new OAuth widget.
SSH to the HCL Connections Deployment Manager (substitute the alias)
ssh root@[DEPLOY_MANAGER_ALIAS]\nStart wsadmin (substitute your credentials)
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/\n./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd\nRegister the new application definition
execfile('oauthAdmin.py')\nOAuthApplicationRegistrationService.addApplication('huddoboards', 'Huddo Boards', 'https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]/callback')\nWhere [CONNECTIONS_HOSTNAME_BASE64]is
connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20= There are many free online services to do this, ie hereTo view the uniquely created client clientSecret
OAuthApplicationRegistrationService.getApplicationById('huddoboards')\nThese commands will print the definition. Please take note of the clientSecret. We will use this later on as
CONNECTIONS_URL=https://connections.example.com\nCONNECTIONS_CLIENT_ID=huddoboards\nCONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]\nSteps to configure the Huddo Boards application for auto-authorize (also documented here)
Tip
this step is optional but recommended and can be done at any time.
Add the new line to the following section in [cellname]/oauth20/connectionsProvider.xml
Note: keep any existing values and add the new line for huddoboards
<parameter name=\"oauth20.autoauthorize.clients\" type=\"ws\" customizable=\"true\">\n <value>huddoboards</value>\n</parameter>\nRecreate the provider via this command:
Note: update the wsadmin credentials and the [PATH_TO_CONFIG_FILE]
./wsadmin.sh -lang jython -conntype SOAP -c \"print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')\" -user connectionsadmin -password passw0rd\nRestart the WebSphere servers
In order for Huddo Boards to authenticate with your Connections environment, you must define a new OAuth widget.
SSH to the HCL Connections Deployment Manager (substitute the alias)
ssh root@[DEPLOY_MANAGER_ALIAS]\nStart wsadmin (substitute your credentials)
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/\n./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd\nRegister the new application definition
execfile('oauthAdmin.py')\nOAuthApplicationRegistrationService.addApplication('huddoboards', 'Huddo Boards', 'https://[BOARDS_URL]/auth/connections/callback')\nWhere [BOARDS_URL] is the URL of the Boards installation specified previously
To view the uniquely created client clientSecret
OAuthApplicationRegistrationService.getApplicationById('huddoboards')\nThese commands will print the definition. Please take note of the clientSecret. We will use this later on as
CONNECTIONS_URL=https://connections.example.com\nCONNECTIONS_CLIENT_ID=huddoboards\nCONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]\nSteps to configure the Huddo Boards application for auto-authorize (also documented here)
Tip
this step is optional but recommended and can be done at any time.
Add the new line to the following section in [cellname]/oauth20/connectionsProvider.xml
Note: keep any existing values and add the new line for huddoboards
<parameter name=\"oauth20.autoauthorize.clients\" type=\"ws\" customizable=\"true\">\n <value>huddoboards</value>\n</parameter>\nRecreate the provider via this command:
Note: update the wsadmin credentials and the [PATH_TO_CONFIG_FILE]
./wsadmin.sh -lang jython -conntype SOAP -c \"print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')\" -user connectionsadmin -password passw0rd\nRestart the WebSphere servers
Note
This step is optional
"},{"location":"boards/connections/header-hybrid/#connections-header-via-sso","title":"Connections Header via SSO","text":"To integrate yours Connections Header into Huddo Boards Cloud please follow these steps:
Reverse Proxy Config
Please follow the instructions as part of the HTTP Proxy config.
Enable in Boards
Open the Boards admin page, select your Organisation, and then the Connections client
Tick the checkbox for Load Connections Header via SSO and click Save
Once you reload the page you should see the Connections header!
Warning
This option is no longer recommended.
Download the Application
The latest .ear from here
Login to WebSphere ISC
This is usually accessible through a URL like:
https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\nOpen Environment -> WebSphere variables
Ensure the scope is selected as the Cell
Click New
Set the following details and click OK
EXTERNAL_APPS_CONFIG\n{\"boards\":\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]\"}\nWhere [CONNECTIONS_HOSTNAME_BASE64] is
connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=The config may require saving. Click Save if presented
Open Applications -> Application Types -> WebSphere enterprise applications
Click Install
Select the file and click Next
You can rename the App if you wish, then click Next
Select the checkbox for the module
Hold shift while selecting both the WebServer and the AppsCluster from the list
Click Apply
The Servers should update on the right hand side
Click Next
Click Next
Click Finish
The config may prompt to save. Click Save
The application should now be installed
Start the Header App
Tick the box next to the app name, and click Start
The app should now start. Congratulations, you have installed the app!
You should now be able to load app can now be loaded at this path
https://[CONNECTIONS_URL]/boards\nFor example:
https://connections.example.com/boards\nImportant
This step is only required if you are hosting Huddo Boards on a different domain to HCL Connections.
"},{"location":"boards/connections/header-on-prem/#connections-header-via-sso","title":"Connections Header via SSO","text":"If you are running Boards on a standalone domain we recommend integrating with the Connections Header using SSO. Please follow these steps:
Reverse Proxy Config
Please follow the instructions as part of the HTTP Proxy config.
Enable in Boards
Open the Boards admin page, select your Organisation, and then the Connections client
Tick the checkbox for Load Connections Header via SSO and click Save
Once you reload the page you should see the Connections header!
Warning
This option is no longer recommended.
Download the Application
The latest .ear from here
Login to WebSphere ISC
This is usually accessible through a URL like:
https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\nOpen Environment -> WebSphere variables
Ensure the scope is selected as the Cell
Click New
Set the following details and click OK
EXTERNAL_APPS_CONFIG\n{\"boards\":\"https://[BOARDS_URL]/auth/connections\"}\nWhere [BOARDS_URL] is the URL of the Boards installation specified previously
The config may require saving. Click Save if presented
Open Applications -> Application Types -> WebSphere enterprise applications
Click Install
Select the file and click Next
You can rename the App if you wish, then click Next
Select the checkbox for the module
Hold shift while selecting both the WebServer and the AppsCluster from the list
Click Apply
The Servers should update on the right hand side
Click Next
Click Next
Click Finish
The config may prompt to save. Click Save
The application should now be installed
Start the Header App
Tick the box next to the app name, and click Start
The app should now start. Congratulations, you have installed the app!
Open Boards
You should now be able to load the Boards app with HCL Connections header at this path:
https://[CONNECTIONS_URL]/boards\nFor example:
https://connections.example.com/boards\nOpen WebSphere ISC
This is usually accessible through a URL like:
https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\nOpen Servers -> Server Types => Web servers
Click on the name of your web server
Click Edit on the http.conf
Boards can be configured either as a standalone domain, or on the same domain as HCL Connections. For details on these config options please see here. Please follow the appropriate instructions below:
"},{"location":"boards/connections/httpd/#a-new-boards-domain","title":"a) New Boards Domain","text":"The following configuration should be set when Huddo Boards is deployed as a new domain.
<VirtualHost *:443>\n ServerName [BOARDS-URL]\n ProxyPreserveHost On\n ProxyPass / http://[KUBERNETES_NAME]/\n ProxyPassReverse / http://[KUBERNETES_NAME]/\n\n SSLEnable\n # Disable SSLv2\n SSLProtocolDisable SSLv2\n # Set strong ciphers\n SSLCipherSpec TLS_RSA_WITH_AES_128_CBC_SHA\n SSLCipherSpec TLS_RSA_WITH_AES_256_CBC_SHA\n SSLCipherSpec SSL_RSA_WITH_3DES_EDE_CBC_SHA\n</VirtualHost>\nInfo
The following configuration is required to load the Connections Header via SSO from the Boards domain.
Note
Customise the SetEnvIf domain below as required for your Boards domain.
# Huddo Boards - allow CORS related access control headers in requests for\nHeader unset Access-Control-Allow-Origin\nSetEnvIf Origin \"https://(boards\\.huddo\\.com)$\" AccessControlAllowOrigin=$0\nHeader always set Access-Control-Allow-Origin %{AccessControlAllowOrigin}e env=AccessControlAllowOrigin\nHeader always set Access-Control-Allow-Credentials \"true\" env=AccessControlAllowOrigin\nHeader always set Access-Control-Allow-Methods \"POST, GET, OPTIONS, DELETE, PUT\"\nHeader always set Access-Control-Allow-Headers \"x-requested-with, Content-Type, origin, authorization, accept, client-security-token, Cache-Control, Content-Language, Expires, Last-Modified, Pragma, slug, X-Update-Nonce,x-ic-cre-request-origin,x-ic-cre-user,x-lconn-auth,x-shindig-st\"\nHeader always set Access-Control-Expose-Headers \"Content-Disposition, Content-Encoding, Content-Length, Date, Transfer-Encoding, Vary, ETag, Set-Cookie, Location, Connection, X-UA-Compatible, X-LConn-Auth, X-LConn-UserId, Authorization,x-ic-cre-user\" env=AccessControlAllowOrigin\n\n# Allow LtpaToken usage from Boards domain\nHeader edit Set-Cookie ^(.*)$ \"$1; Secure; SameSite=None\"\nYou may need to apply similar changes anywhere that the LtpaToken is issued. For example:
via an nginx proxy:
# Allow LtpaToken usage from Boards domain\nproxy_cookie_flags LtpaToken Secure SameSite=None;\nproxy_cookie_flags LtpaToken2 Secure SameSite=None;\nVerse integration - see HCL Domino documentation
Tip
Users may need to logout and login to Connections again for the LtpaToken cookie to be re-issued with SSO enabled
"},{"location":"boards/connections/httpd/#b-existing-hcl-connections-domain","title":"b) Existing HCL Connections domain","text":"The following configuration should be set when Huddo Boards is deployed at a context root under the existing HCL Connections domain.
<VirtualHost *:443>\n ServerName [CONNECTIONS_URL]\n\n #Huddo Boards\n ProxyPass \"/boards\" \"http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/boards\"\n ProxyPassReverse \"/boards\" \"http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/boards\"\n ProxyPass \"/api-boards\" \"http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/api-boards\"\n ProxyPassReverse \"/api-boards\" \"http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/api-boards\"\n #End Huddo Boards\n</VirtualHost>\nWhere:
[BOARDS-URL] is the URL of your Boards deployment (as a domain)[CONNECTIONS-URL] is the URL of your HCL Connections deployment[KUBERNETES_NAME] is the hostname/IP of the master in your cluster[KUBERNETES_PORT] is the port of your Ingress Controller (ie 32080)For an on-premise (component pack) installation of Huddo Boards, you may use an external Keycloak server to provide authentication. To achieve this, you need to setup a new application in the same keycloak realm as connections. This new application must issue access_tokens that have full access to the connections api.
When using this approch, Huddo Boards will get tokens from keycloak but will still validate them against connections using the url /connections/opensocial/oauth/rest/people/@me/@self
The following ENV variables should be set to achieve this:
Key Descriptionuser.env.CONNECTIONS_CLIENT_ID Your Keycloak application client-id user.env.CONNECTIONS_CLIENT_SECRET Your Keycloak application client-secret user.env.CONNECTIONS_URL HCL Connections URL, e.g. https://connections.example.com user.env.CONNECTIONS_KEYCLOAK_URL Your Keycloak URL e.g. https://login.example.com user.env.CONNECTIONS_KEYCLOAK_REALM Your Keycloak realm user.env.CONNECTIONS_KEYCLOAK_PATH Optional: Keycloak pathDefault: /auth/realmsCustomise this to /realms as of Keycloak v22"},{"location":"boards/connections/migration/","title":"Migration of Activities to Huddo Boards (using standalone Mongo/Redis)","text":"Tip
If you are using Component Pack please follow this guide
As part of the installation process for Huddo Boards you can run the migration service to move the existing Activities into Huddo Boards.
Info
Please review the Roles page for details on how Community Activity membership is interpreted & presented by Boards
"},{"location":"boards/connections/migration/#difference-between-the-individual-import","title":"Difference between the individual import","text":"There is an individual import, when you hover over the orange Create button and click Import from Activities. It can be accessed by end-users, but only usess the Activities API. While this works for basic Activitiy functionality, it doesn't include any extra features from Huddo Boards for WebSphere. Card colors are one example of those features.
So you'll need to use the migration service described here to import all data in the new Boards.
"},{"location":"boards/connections/migration/#process-overview","title":"Process Overview","text":"This service will:
Ensure you have updated the following variables as applicable in the global.env section of your boards.yaml file downloaded previously
sharedDrive.server 192.168.10.1 or websphereNode1 IP or Hostname of the server with the Connections shared drive mount sharedDrive.path /opt/HCL/Connections/data/shared or /nfs/data/shared Path on the mount to the Connections shared drive sharedDrive.storage 10Gi (optional) The capacity of the PV and PVC sharedDrive.accessMode ReadOnlyMany (optional) The accessMode of the PV and PVC sharedDrive.volumeMode Filesystem (optional) The volumeMode of the PV and PVC sharedDrive.persistentVolumeReclaimPolicy Retain (optional) The persistentVolumeReclaimPolicy of the PV and PVC sharedDrive.storageClassName manual (optional) The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) sharedDrive.spec Example Using a fully custom spec - e.g. FlexVolume or hostPath env.CONNECTIONS_URL httsp://connections.example.com URL of your Connections environment env.FILE_PATH_ACTIVITIES_CONTENT_STORE /data/activities/content Path of the Activities content store relative to the Connections shared drive.Must start with /data as the Connections shared drive is mounted at /dataEnsure you set the IP and path for the NFS volume mount. env.API_GATEWAY https://[CONNECTIONS_URL]/api-boards URL of the Boards API.Used by files attached to a board. URL. env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME connectionsadmin Credentials for user with admin role on the Activities application.See ISC => Applications => Activities => Security role to user mapping env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD adminpassword Password for the Activities administrator env.CONNECTIONS_DB_TYPE db2 or mssql or oracle SQL database type hosting Activities. env.CONNECTIONS_DB_HOST dbserver.company.com SQL Server hostname env.CONNECTIONS_DB_PORT 50000 or 1433 or 1531 SQL Server connection port env.CONNECTIONS_DB_USER dbuser SQL Server user name env.CONNECTIONS_DB_PASSWORD dbpassword SQL Server user password env.CONNECTIONS_DB_SID DATABASE SQL Server SIDNote: applicable to Oracle env.CONNECTIONS_DB_DOMAIN domain SQL Server connection stringNote: applicable to Microsoft SQL env.CONNECTIONS_DB_CONNECT_STRING HOSTNAME=<host>;PROTOCOL=... or <host>:<port>/<sid> SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle env.PROCESSING_PAGE_SIZE 10 (default) Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database env.PROCESSING_LOG_EVERY 50 (default) The migration process logs every 50 Activities completed env.IMMEDIATELY_PROCESS_ALL false (default) Process ALL Activities on service startup. env.COMPLETE_ACTIVITY_AFTER_MIGRATED false Mark the old Activity data as complete env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED false Create link to new Board in old Activity Example:
migration:\n # configure access to the Connections Shared mount\n sharedDrive:\n # Replace with IP address for the NFS server\n server: 192.168.10.1\n # for example \"/opt/HCL/Connections/data/shared\" or \"/nfs/data/shared\"\n path: /nfs/data/shared\n env:\n FILE_PATH_ACTIVITIES_CONTENT_STORE: /data/activities/content\n API_GATEWAY: https://example.com/api-boards\n CONNECTIONS_URL: httsp://connections.example.com\n CONNECTIONS_ACTIVITIES_ADMIN_USERNAME: connectionsadmin\n CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD: adminpassword\n CONNECTIONS_DB_TYPE: db2\n CONNECTIONS_DB_HOST: cnx-db.internal\n CONNECTIONS_DB_PORT: 50000\n CONNECTIONS_DB_USER: lcuser\n CONNECTIONS_DB_PASSWORD: xxx\n # ...\nPlease deploy the following chart with the same configuration boards.yaml file used to deploy the huddo-boards chart
helm upgrade huddo-boards-activity-migration https://docs.huddo.com/assets/config/kubernetes/huddo-boards-activity-migration-1.0.0.tgz -i -f ./boards.yaml --namespace boards --recreate-pods\nNote: the new sharedDrive parameters described above. You may also need to delete the previously name chart
The migration interface is accessible at https://[BOARDS_URL]/admin/migration to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.
You can also set the global.env.IMMEDIATELY_PROCESS_ALL variable if you wish to migrate every Activity without the UI.
You can check the pod logs for the activity-migration to see progress of the running migration:
kubectl logs -n boards -f $(kubectl get pod -n boards | grep activity-migration | awk '{print $1}')\nWhen the helm chart was installed in another namespace (helm upgrade ... --namespace my-boards), change -n boards to your modified namespace like -n my-boards. To stop following the logs, press [Ctrl] + [C].
For example
"},{"location":"boards/connections/migration/#after-migration-complete","title":"After Migration Complete","text":"The Migration service can be removed. Please use the following command
helm delete huddo-boards-activity-migration --purge\nTurn off the Activities application in WebSphere ISC
Basic instructions for adding Huddo Boards into the HCL Connections mobile application
"},{"location":"boards/connections/mobile-app-hybrid/#mobile-app-integration","title":"Mobile App Integration","text":"Check-out mobile-config.xml
execfile(\"mobileAdmin.py\")\nMobileConfigService.checkOutConfig(\"/LCCheckedOut\", AdminControl.getCell())\nEdit mobile-config.xml
Applications element and add the following Application:<Application name=\"Boards\" enabled=\"true\">\n <ApplicationIcon>\n <Android>\n <Hdpi>http://boards.huddo.com/img/logo-small.png</Hdpi>\n <Mdpi>http://boards.huddo.com/img/logo-small.png</Mdpi>\n <Ldpi>http://boards.huddo.com/img/logo-small.png</Ldpi>\n </Android>\n <IOS>\n <Reg>http://boards.huddo.com/img/logo-small.png</Reg>\n <Retina>http://boards.huddo.com/img/logo-small.png</Retina>\n </IOS>\n <DefaultLocation>http://boards.huddo.com/img/logo-small.png</DefaultLocation>\n </ApplicationIcon>\n <ApplicationLabel>Huddo Boards</ApplicationLabel>\n <ApplicationURL>https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]</ApplicationURL>\n</Application>\nwhere [CONNECTIONS_HOSTNAME_BASE64] is your Connections hostname base64 encoded. E.g. connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=
ApplicationsList or DefaultNavigationOrder element and append Boards. For example:<ApplicationsList>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards</ApplicationsList>\nor
<DefaultNavigationOrder>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards</DefaultNavigationOrder>\nSave and check-in mobile-config.xml
MobileConfigService.checkInConfig(\"/LCCheckedOut\", AdminControl.getCell())\nSync the Nodes as required
Basic instructions for adding Huddo Boards into the HCL Connections mobile application
"},{"location":"boards/connections/mobile-app-on-prem/#mobile-app-integration","title":"Mobile App Integration","text":"Check out mobile-config.xml
execfile(\"mobileAdmin.py\")\nMobileConfigService.checkOutConfig(\"/LCCheckedOut\", AdminControl.getCell())\nEdit mobile-config.xml
Find the Applications element and add the following Application:
<Application name=\"Boards\" enabled=\"true\">\n <ApplicationIcon>\n <Android>\n <Hdpi>http://[BOARDS_URL]/img/logo-small.png</Hdpi>\n <Mdpi>http://[BOARDS_URL]/img/logo-small.png</Mdpi>\n <Ldpi>http://[BOARDS_URL]/img/logo-small.png</Ldpi>\n </Android>\n <IOS>\n <Reg>http://[BOARDS_URL]/img/logo-small.png</Reg>\n <Retina>http://[BOARDS_URL]/img/logo-small.png</Retina>\n </IOS>\n <DefaultLocation>http://[BOARDS_URL]/img/logo-small.png</DefaultLocation>\n </ApplicationIcon>\n <ApplicationLabel>Huddo Boards</ApplicationLabel>\n <ApplicationURL>https://[BOARDS_URL]/auth/connections</ApplicationURL>\n</Application>\nwhere [BOARDS_URL] is your configured URL for Boards.
Find the ApplicationsList or DefaultNavigationOrder element and append Boards. For example:
<ApplicationsList>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards</ApplicationsList>\nor
<DefaultNavigationOrder>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards</DefaultNavigationOrder>\nSave and check-in mobile-config.xml
MobileConfigService.checkInConfig(\"/LCCheckedOut\", AdminControl.getCell())\nSync the Nodes as required
Huddo Boards connects to your Connections servers over HTTPS via OAuth.
"},{"location":"boards/connections/security/#ip-allow-list","title":"IP Allow List","text":"Our servers use a static outbound IP address. If your environment uses a firewall to access the Connections servers you will need to add the following IP to your allow-list
34.91.118.129/32 GCloud Prod EU Cluster NAT\n34.129.215.36/32 GCloud Staging Cluster NAT\nWe communicate over HTTPS, so the port 443 must be allowed
Add Huddo Boards Hybrid widgets into HCL Connections on-premise environments
"},{"location":"boards/connections/widgets-hybrid/#community-widget","title":"Community Widget","text":"SSH to the WAS Deployment Manager
Start wsadmin
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin\n./wsadmin.sh -lang jython -user wasadmin -password <password-here>\nCheck out the widgets-config.xml file.
execfile(\"profilesAdmin.py\")\nProfilesConfigService.checkOutWidgetConfig(\"/LCCheckedOut\", AdminControl.getCell())\nEdit the widgets-config.xml file.
Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
<!-- Huddo Boards -->\n<widgetDef defId=\"HuddoBoards\" modes=\"view fullpage\" url=\"{webresourcesSvcRef}/web/com.ibm.social.urliWidget.web.resources/widget/urlWidget.xml\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"width\" value=\"100%\"/>\n <item name=\"height\" value=\"500px\"/>\n <item name=\"url\" value=\"https://boards.huddo.com/community/connections\"/>\n </itemSet>\n</widgetDef>\n<!-- END Huddo Boards -->\nCheck in the widgets-config.xml file.
ProfilesConfigService.checkInWidgetConfig()\nRestart the Communities application via the ISC
Optional. Install the extensions for Connections Customizer. This includes a fix for the Community Widget that enables attachments to be downloaded as well as multiple new integrations for Connections.
Open Homepage => Administration
Click Add another app
Select the following:
OpenSocial GadgetTrusted and Use SSOShow for Activity Stream eventsAll serversClick the Add Mapping button.
Enter values:
conn-eeconnections_serviceClick Ok
Enter the following:
Field Value App Title Huddo Boards Stream URL Addresshttps://boards.huddo.com/widgets/connections/url-gadget.xml Icon URL https://boards.huddo.com/favicon.ico Scroll down and click Save
Select the newly defined app and click Enable
Huddo Boards integrates with Connections Engagement Center
Download the Boards Hybrid widget definition file
Open the CEC (XCC) main admin page
i.e. https://connections.company.com/xcc/main
Click Customize, Engagement Center Settings, expand Customization Files & click Upload File
Note: you must have the admin role for the Customize button to appear
Select the custom.js downloaded previously
Note: the file must have this name. If you already have a custom.js file you must manually merge the contents. Copy the HuddoBoards() function and make sure to call it in init()
To validate:
Highlights application in a CommunityClick Customize, Widgets and Huddo Boards
The Boards Highlights widget should now appear at the end of the page
Add Huddo Boards Docker widgets into HCL Connections on-premise environments
"},{"location":"boards/connections/widgets-on-prem/#community-widget","title":"Community Widget","text":"SSH to the WAS Deployment Manager
Start wsadmin
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin\n./wsadmin.sh -lang jython -user wasadmin -password <password-here>\nCheck out the widgets-config.xml file.
execfile(\"profilesAdmin.py\")\nProfilesConfigService.checkOutWidgetConfig(\"/LCCheckedOut\", AdminControl.getCell())\nEdit the widgets-config.xml file.
Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following, replacing [BOARDS_URL] with your URL:
<!-- Huddo Boards -->\n<widgetDef defId=\"HuddoBoards\" modes=\"view fullpage\" url=\"{webresourcesSvcRef}/web/com.ibm.social.urliWidget.web.resources/widget/urlWidget.xml\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"width\" value=\"100%\"/>\n <item name=\"height\" value=\"500px\"/>\n <item name=\"url\" value=\"https://[BOARDS_URL]/boards/community/connections\"/>\n </itemSet>\n</widgetDef>\n<!-- END Huddo Boards -->\nDisable Community Activity widget
Tip
this is optional but highly recommended for CP installations of Activities Plus
Once Activities are migrated into Boards, it is recommended that the Community Activity widget is disabled to prevent confusion around the old data.
Find and comment out the Activity widget with defId=\"Activities\"
Check in the widgets-config.xml file.
ProfilesConfigService.checkInWidgetConfig()\nRestart the Communities application via the ISC
Tip
If widgets no longer load in Communities and you see errors in the browser console like:
The following error occurs when retrieving widgetProcess production.\ncom.ibm.jsse2.util.h: PKIX path building failed: com.ibm.security.cert.IBMCertPathBuilderException: unable to find valid certification path to requested target\nthen please ensure the Connections domain root certificate is trusted in the WebSphere ISC. This can be added using Retrieve from port under SSL certificate and key management > Key stores and certificates > CellDefaultTrustStore > Signer certificates
Optional. Install the extensions for Connections Customizer. This includes a fix for the Community Widget that enables attachments to be downloaded as well as multiple new integrations for Connections.
Open Homepage => Administration
Click Add another app
Select the following:
OpenSocial GadgetTrusted and Use SSOShow for Activity Stream eventsAll serversClick the Add Mapping button.
Enter values:
conn-eeconnections_serviceClick Ok
Enter the following, replacing [BOARDS_URL] with your URL:
https://[BOARDS_URL]/widgets/connections/url-gadget.xml Icon URL https://[BOARDS_URL]/favicon.ico Icon Secure URL https://[BOARDS_URL]/favicon.ico Scroll down and click Save
Select the newly defined app and click Enable
Huddo Boards integrates with Connections Engagement Center
Download the Boards CP widget definition file
Open the CEC (XCC) main admin page
i.e. https://connections.company.com/xcc/main
Click Customize, Engagement Center Settings, expand Customization Files & click Upload File
Note: you must have the admin role for the Customize button to appear
Select the custom.js downloaded previously
Note: the file must have this name. If you already have a custom.js file you must manually merge the contents. Copy the HuddoBoards() function and make sure to call it in init()
To validate:
Highlights application in a CommunityClick Customize, Widgets and Huddo Boards
The Boards Highlights widget should now appear at the end of the page
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.
"},{"location":"boards/connections/customizer/customizer-integrations-package/#installation","title":"Installation","text":""},{"location":"boards/connections/customizer/customizer-integrations-package/#customizer-reverse-proxy-configuration","title":"Customizer Reverse Proxy Configuration","text":"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\nmw-proxy Server","text":"mw-proxy server. e.g. via sshmkdir /pv-connections/customizations/boards-extensions if it doesn't exist.cd /pv-connections/customizations/boards-extensions/pv-connections/customizations/boards-extensions.cat settings.js and check that the \"boardsURL\" property has been set to the URL of your Boards deployment.\"type\": \"com.hcl.connections.nav\"). If you already have nav customizations, you must remove the \"Tasks Nav Button\" extension from manifest.json and merge it in to your existing nav customization. Otherwise only one of your nav customisations will take effect.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.
"},{"location":"boards/connections/customizer/customizer-integrations-package/#updating","title":"Updating","text":"Remove all files in /pv-connections/customizations/boards-extensions. Repeat the above steps, overwriting the manifest in appreg.
Deploying Huddo Boards into HCL Connections Component Pack (Kubernetes)
Release Information
"},{"location":"boards/cp/#prerequisites","title":"Prerequisites","text":"Huddo Boards in Connections Component Pack (CP) uses the existing CP infrastructure.
The UI and API each require a unique route:
[CONNECTIONS_URL]/boards. We will refer to this as BOARDS_URL[CONNECTIONS_URL]/api-boards. We will refer to this as API_URLFor more details on configuring an IBM HTTP WebServer as reverse proxy, please see here
"},{"location":"boards/cp/#setup-oauth","title":"Setup OAuth","text":"You will need to setup an OAuth application with one (or more) of these providers for Huddo Boards to function. please refer to the following documentation:
Provider Registration / Documentation Callback URL HCL Connections(on premise) Huddo instructionshttps://[CONNECTIONS_URL]/boards/auth/connections/callback Microsoft Office 365 Huddo instructions https://[CONNECTIONS_URL]/boards/auth/msgraph/callback"},{"location":"boards/cp/#configure-kubectl","title":"Configure kubectl","text":"Instructions Kubernetes copy ~/kube/.config from the Kubernetes master server to the same location locally(backup any existing local config)"},{"location":"boards/cp/#storage","title":"Storage","text":""},{"location":"boards/cp/#s3","title":"S3","text":"Huddo Boards for Component Pack deploys a Minio service. Please follow S3 storage details here to configure the NFS mount.
"},{"location":"boards/cp/#mongo","title":"Mongo","text":"Huddo Boards uses the Mongo database already deployed inside the Component Pack. There is no configuration required.
"},{"location":"boards/cp/#licence-key","title":"Licence Key","text":"Huddo Boards / Activities Plus is a free entitlement however it requires a licence key from https://store.huddo.com. For more details see here.
"},{"location":"boards/cp/#update-config-file","title":"Update Config file","text":"Download our config file and update all the values inside. Descriptions as below.
Kubernetes variables:
Key Descriptionglobal.env.APP_URI https://[BOARDS_URL] (e.g. https://connections.example.com/boards) webfront.ingress.hosts [CONNECTIONS_URL] (no protocol, e.g. connections.example.com) core.ingress.hosts [API_URL] (no protocol, e.g. connections.example.com/api-boards) minio.nfs.server IP address of the NFS Server file mount (e.g. 192.168.10.20) minio.storageClassName (Optional) name of the storage class when using dynamic provisioning Boards variables:
Are detailed here.
Customising Boards notifications:
Some elements of the Boards notifications that are sent out can be customised.
Activity migration variables:
The Activity migration chart will be deployed separately but use the same config file. The variables are described here.
"},{"location":"boards/cp/#deploy-boards-helm-chart","title":"Deploy Boards Helm Chart","text":"Install the Boards services via our Helm chart
helm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\nNote: --recreate-pods ensures all images are up to date. This will cause downtime.
in the linked document you should use the IP of your kubernetes manager and the http port for your ingress (32080 for default component pack installs)
Please follow these instructions
"},{"location":"boards/cp/#integrations","title":"Integrations","text":""},{"location":"boards/cp/#hcl-connections","title":"HCL Connections","text":"Please follow the instructions here
"},{"location":"boards/cp/#subscribing-to-latest-updates-from-huddo-team","title":"Subscribing to latest updates from Huddo Team","text":"Guide here
"},{"location":"boards/cp/dockerhub/","title":"Latest Boards releases directly from Dockerhub","text":"Warning
These instructions are in the process of being deprecated. We are moving to hosting our images in Quay.io instead of Dockerhub. Please see these instructions.
You can get the latest versions of Huddo Boards Docker by subscribing to our own repository in dockerhub as follows:
Create kubernetes secret with your dockerhub account credentials
kubectl create secret docker-registry dockerhub --docker-server=docker.io --docker-username=[user] --docker-password=[password] --docker-email=[email] --namespace=connections\nOnce confirmed by reply email, update your boards-cp.yaml file as per this example.
At the top set
global.imagePullSecret to dockerhubglobal.repositoryglobal.imageTagSuffix as the date of our latest release and uncomment itAdd image.name (blank) and image.tag for each service as per this example.
Tip
Some of the services (app, provider, notification) might not be in your boards-cp.yaml file, you must add them.
Run helm to apply the changes.
helm upgrade kudos-boards-cp https://docs.huddo.com/assets/config/kubernetes/kudos-boards-cp-3.1.4.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\nThis document describes how to setup the proxy for serving the Boards application hosted in the Component pack by your Connections IHS
It also includes a proxy rewrite rule, to serve the migrated Board when the legacy Activity URL is requested.
Open WebSphere ISC
This is usually accessible through a URL like:
https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\nOpen Servers -> Server Types => Web servers
Click on the name of your web server
Click Edit on the http.conf
Define the Virtual Host Reverse Proxy
Note: combine this with the existing VirtualHost entry
<VirtualHost *:443>\n ServerName [CONNECTIONS_URL]\n\n RewriteEngine On\n RewriteRule ^/activities/service/html/(.*)$ /boards/activities/service/html/$1 [R]\n\n ProxyPass \"/boards\" \"http://[KUBERNETES_NAME]:32080/boards\"\n ProxyPassReverse \"/boards\" \"http://[KUBERNETES_NAME]:32080/boards\"\n ProxyPass \"/api-boards\" \"http://[KUBERNETES_NAME]:32080/api-boards\"\n ProxyPassReverse \"/api-boards\" \"http://[KUBERNETES_NAME]:32080/api-boards\"\n</VirtualHost>\nWhere:
[CONNECTIONS-URL] is the URL of your HCL Connections deployment [KUBERNETES_NAME] is the hostname/IP of the master in your cluster [KUBERNETES_PORT] is the port of your Ingress Controller (ie 32080)
For example:
<VirtualHost *:443>\n ServerName connections.example.com\n\n #Huddo Boards\n ProxyPass \"/boards\" \"http://kube-master.company.com:32080/boards\"\n ProxyPassReverse \"/boards\" \"http://kube-master.company.com:32080/boards\"\n ProxyPass \"/api-boards\" \"http://kube-master.company.com:32080/api-boards\"\n ProxyPassReverse \"/api-boards\" \"http://kube-master.company.com:32080/api-boards\"\n #End Huddo Boards\n</VirtualHost>\nFollow this guide to configure your Kubernetes with access to our images hosted in Quay.io.
Once confirmed by reply email, update your boards-cp.yaml file as per this example. At the top set
global.imageTag as the date of our latest releaseglobal.imagePullSecret to the name of the secret you created
e.g. <USERNAME>-pull-secret
Run the Helm upgrade command with our new Huddo chart to apply the changes.
helm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections\nNote
The chart name has changed. You may need to helm delete kudos-boards-cp first
Create the folder on the nfs.server
sudo mkdir /pv-connections/kudos-boards-minio\nsudo chmod 755 /pv-connections/kudos-boards-minio\nEnsure each Node in your Kubernetes cluster can mount this location.
Please modify the file /etc/exports on your NFS Server to include this line
/pv-connections/kudos-boards-minio <IP_RANGE_OF_YOUR_SERVERS>/<SUBNET_MASK>(rw,no_root_squash)\nFor example:
/pv-connections/kudos-boards-minio 192.168.0.0/255.255.0.0(rw,no_root_squash)\nApply new NFS storage to exports
exportfs -ra\nThis page has moved here
"},{"location":"boards/cp/store/","title":"Huddo Apps Store","text":"To obtain licences for Huddo Boards, you need to register your organisation at https://store.huddo.com.
All customers are eligible for a free licence to use our Activity view.
Obtaining your licence key:
Register for our store with your Name and email address.
Click the link in the email we sent to verify your account.
Create Your Organisation and Login client, details below.
Click Create Activities+ Licence
Click Download Licences
You will need to provide the following information to setup you Organisation in the store.
When creating your Login client(s) refer to the table below for details:
Provider Text Field HCL Connections Your Connections URL Microsoft 365 Your Office 365 tenant ID"},{"location":"boards/cp/migration/","title":"Migration of Activities to Huddo Boards (with Component Pack)","text":"Tip
If you are not using Component Pack please follow this guide
As part of the installation process for Huddo Boards (Activities Plus) you must run the migration service to move the existing Activities into Huddo Boards.
Info
Please review the Roles page for details on how Community Activity membership is interpreted & presented by Boards
"},{"location":"boards/cp/migration/#process-overview","title":"Process Overview","text":"This service will:
Ensure you have updated the following variables as applicable in your boards-cp.yaml file downloaded previously
sharedDrive.server 192.168.10.1 or websphereNode1 IP or Hostname of the server with the Connections shared drive mount sharedDrive.path /opt/HCL/Connections/data/shared or /nfs/data/shared Path on the mount to the Connections shared drive sharedDrive.mountOptions -nfsvers=4.1 (optional) Any additional sharedDrive mountOptions. All yaml is passed through drive sharedDrive.storage 10Gi (optional) The capacity of the PV and PVC sharedDrive.accessMode ReadOnlyMany (optional) The accessMode of the PV and PVC sharedDrive.volumeMode Filesystem (optional) The volumeMode of the PV and PVC sharedDrive.persistentVolumeReclaimPolicy Retain (optional) The persistentVolumeReclaimPolicy of the PV and PVC sharedDrive.storageClassName manual (optional) The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) sharedDrive.spec See below Using a fully custom spec - e.g. FlexVolume or hostPath env.FILE_PATH_ACTIVITIES_CONTENT_STORE /data/activities/content Path of the Activities content store relative to the Connections shared drive.Must start with /data as the Connections shared drive is mounted at /dataEnsure you set the IP and path for the NFS volume mount. env.API_GATEWAY https://[CONNECTIONS_URL]/api-boards URL of the Boards API.Used by files attached to a board. URL. env.TZ Europe/London or Australia/Hobart etc 'Local' TimezoneUsed for date interpretation. See full list of supported timezones env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME connectionsadmin Credentials for user with admin role on the Activities application.See ISC => Applications => Activities => Security role to user mapping env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD adminpassword Password for the Activities administrator env.CONNECTIONS_DB_TYPE db2 or mssql or oracle SQL database type hosting Activities. env.CONNECTIONS_DB_HOST dbserver.company.com SQL Server hostname env.CONNECTIONS_DB_PORT 50000 or 1433 or 1531 SQL Server connection port env.CONNECTIONS_DB_USER dbuser SQL Server user name env.CONNECTIONS_DB_PASSWORD dbpassword SQL Server user password env.CONNECTIONS_DB_SID DATABASE SQL Server SIDNote: applicable to Oracle env.CONNECTIONS_DB_DOMAIN domain SQL Server connection stringNote: applicable to Microsoft SQL env.CONNECTIONS_DB_CONNECT_STRING HOSTNAME=<host>;PROTOCOL=... or <host>:<port>/<sid> SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle env.PROCESSING_PAGE_SIZE 10 (default) Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database env.PROCESSING_LOG_EVERY 50 (default) The migration process logs every 50 Activities completed env.IMMEDIATELY_PROCESS_ALL false (default) Process ALL Activities on service startup. env.COMPLETE_ACTIVITY_AFTER_MIGRATED false Mark the old Activity data as complete env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED false Create link to new Board in old Activity"},{"location":"boards/cp/migration/#custom-persistent-volume","title":"Custom Persistent Volume","text":"The default chart values use an NFS mount. Below are examples custom configuration of the persisent volume definition for access to the Shared Drive using other methods.
Note
We recommend running the helm chart with --dry-run --debug to confirm the yaml output
Host path
Tip
This can be used in conjunction with existing linux methods (e.g. cifs-utils, smbclient etc) to mount a Windows Samba share directly onto the Kubernetes Node(s).
Please read the Kubernetes documentation.
migration:\n sharedDrive:\n storageClassName: manual\n spec:\n hostPath:\n path: /data/shared\nKubernetes CIFS Volume Driver (for Samba shares).
Please read the CIFS documentation
migration:\n sharedDrive:\n spec:\n flexVolume:\n driver: juliohm/cifs\n options:\n opts: sec=ntlm,uid=1000\n server: my-cifs-host\n share: /MySharedDirectory\n secretRef:\n name: my-secret\nAdditional for Windows
This migration is designed to be a once-off operation. If you are using Windows SMB shares and neither option above is appropriate for your environment, we would recommend:
<SHARED_DRIVE>/activities/content (e.g. /opt/HCL/connections/data/shared/activities/content) to an existing Linux accessible drive (e.g. /pv-connections/activitystore).sharedDrive.server & sharedDrive.path to mount this path at /data in the containersmigration.env.FILE_PATH_ACTIVITIES_CONTENT_STORE: \"/data\"Please deploy the following chart with the same configuration boards-cp.yaml file used to deploy the huddo-boards-cp chart
helm upgrade huddo-boards-cp-activity-migration https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-activity-migration-1.0.0.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\nNote: the configuration file has changed as of the v3 chart. Please add the new sharedDrive parameters described above
The migration interface is accessible at https://[CONNECTIONS_URL]/boards/admin/migration to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.
You can also set the env.IMMEDIATELY_PROCESS_ALL if you wish to migrate every Activity without the UI.
You can check the pod logs for the activity-migration to see progress of the running migration
For example
"},{"location":"boards/cp/migration/#after-migration-complete","title":"After Migration Complete","text":"The Migration service can be removed. Please use the following command
helm delete huddo-boards-cp-activity-migration --purge\nTurn off the Activities application in WebSphere ISC
The REMAINING tab is where you can select from Activities that have not been migrated and initiate the process for migrating them into Huddo Boards.
"},{"location":"boards/cp/migration/interface/#activities-table","title":"Activities Table","text":"Select Activities to migrate by clicking the checkboxs next to each activity.
The table can be sorted by clicking the headers for each column.
The number of rows per page can be increased using the Rows dropdown.
There are multiple filters that can be applied that will remove activities from the table and the activities included when choosing MIGRATE ALL.
Notice that when filters are applied, the total number in the table and MIGRATE ALL button changes.
"},{"location":"boards/cp/migration/interface/#options","title":"Options","text":"Near the MIGRATE buttons, there is an Options panel to for enabling features that will affect this migration.
WARNING: These options will irreversibly modify your Activities.
Option Description Add Link to Activity This will create an entry in each activity that provides a link to the new Huddo Board. This corresponds to theCREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED environment variable when running a headless migration. Mark Activity Complete This will mark the Activity as complete after migrating it to Huddo Boards. This corresponds to the COMPLETE_ACTIVITY_AFTER_MIGRATED environment variable when running a headless migration."},{"location":"boards/cp/migration/interface/#control-buttons","title":"Control Buttons","text":"Button Description Migrate Selected This will process all Activities which are checked in the view Migrate ALL All currently visible Activities (on all pages) will be migrated. Note: filters affect how many are visible. For example, completed/deleted can be ignored."},{"location":"boards/cp/migration/interface/#done-tab","title":"Done Tab","text":"This tab shows all of the activities that have been migrated into Huddo Boards. The Activity Name is a link to the Activity. The Board column has links to each Board in Huddo Boards.
If you're migrating from an environment that has previously been using Huddo Boards WebSphere, you can use this tab to start the process of migrating Boards User Data into Huddo Boards Docker.
Each user who has used Huddo Boards WebSphere is likely to have created some of this data. It includes:
If the user already exists in Huddo Boards Docker:
This process only needs to be run once. Subsequent runs will import any data for new Boards WebSphere users and overwrite the previously imported data from the last run.
"},{"location":"boards/cp/roles/","title":"Roles","text":""},{"location":"boards/cp/roles/#member-roles","title":"Member Roles","text":"Boards has the following membership roles
Role Description Applicable for Community Membership Owner All members have full control over the Board. Shared with Owned by Editor All members have access to create new content, and edit all content. Shared with Author All members have access to create new content, and edit content they created. Shared with Reader All members can only read content (no create or edit). Any tasks they are assigned to, they can comment on and complete. Shared with Owners & Editors Owners of the Community haveOwner role. Members of the Community have Editor role Owned by Owners & Authors Owners of the Community have Owner role. Members of the Community have Author role Shared with Owned by Owners & Readers Owners of the Community have Owner role. Members of the Community have Reader role Owned by Community Owner Only Owners of the Community have Owner role. Note: Community Members will see the title of the Board in the main list, but not be able to open/view/edit. Owned by"},{"location":"boards/cp/roles/#community-membership-types","title":"Community Membership Types","text":"Type Description Applicable Role Options Owned by Boards created from inside a Community Shared with Boards created standalone, and then shared with a community"},{"location":"boards/cp/roles/#migration-examples","title":"Migration Examples","text":"When migrating from Activities, the permissions will be maintained. Below are some examples of permissions set in Activities and their equivalent in Boards / Activities Plus after migration.
"},{"location":"boards/cp/roles/#activity-in-community","title":"Activity in Community","text":"Activities Boards Owners & Members assigned the Owner role Owner role is assigned to the entire community Members are Authors Role isOwners & Authors as per above Members are Readers Role is Owners & Readers as per above As above, with users specified Each user is migrated with their role Members have NO access Role is Community Owners Only as per above"},{"location":"boards/cp/roles/#standalone-activity","title":"Standalone Activity","text":"Activities Boards"},{"location":"boards/domino/callback/","title":"Domino Callback URL","text":"Huddo Boards Cloud: Boards cloud uses a base64 encoded version of your Domino Server domain, you can use a service like https://www.base64encode.org/ to achieve this, the callback format looks like this: https://boards.huddo.com/auth/domino/[ encoded domain ]/callback
e.g. for domain proton.example.com the callback url would be https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback
Huddo Boards On Prem: For an on premise installation we use a global authentication setup so the callback url does not need an id. depending on your deployment it could look like one of the following:
https://boards.your.domain.com/auth/domino/callbackhttps://your.domain.com/boards/auth/domino/callback if you have a context root (i.e. you would access boards application at /boards).Huddo Boards Cloud supports authentication, user and group lookup with HCL Domino.
Tip
See Domino REST API for Boards On-Premise for Boards On Premise installations.
"},{"location":"boards/domino/cloud/#prerequisites","title":"Prerequisites","text":"Configure OAuth
URLs
Boards Cloud uses a base64 encoded version of your Domino Server domain, you can use a service like https://www.base64encode.org/ to achieve this.
// callback URL\nhttps://boards.huddo.com/auth/domino/[ encoded domain ]/callback\n\n// startup page\nhttps://boards.huddo.com/auth/domino/[ encoded domain ]\ne.g. the callback url would look like this: https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback
Please determine the URL for your environment and then follow this guide.
Configure Schema
Configure Scope
Please email support@huddo.com with the following details
Item Detail / example DOMINO_AUTH_URL HCL Domino REST API URL. E.g. https://domino.example.com:8080 DOMINO_CLIENT_ID The IAM Application client id DOMINO_CLIENT_SECRET The IAM Application client secret"},{"location":"boards/domino/on-prem/","title":"HCL Domino REST API for Boards On-Premise","text":"Huddo Boards supports authentication, user and group lookup with HCL Domino.
Tip
See Domino REST API for Boards Cloud for integration with Boards Cloud (hybrid installations).
Using the old Proton configuration?
See our migration guide.
"},{"location":"boards/domino/on-prem/#prerequisites","title":"Prerequisites","text":"Configure OAuth
URLs
For an on premise installation the callback url & startup page is simple:
https://<BOARDS_URL>/auth/domino/callback\nhttps://<BOARDS_URL>/auth/domino\nFor example:
https://boards.your.domain.com/auth/domino/callback\nhttps://boards.your.domain.com/auth/domino\n\n// if you have a context root (i.e. you would access boards application at /boards)\nhttps://your.domain.com/boards/auth/domino/callback\nhttps://your.domain.com/boards/auth/domino\nPlease determine the URL for your environment and then follow this guide.
Configure Schema
Configure Scope
Please email support@huddo.com with the following details
Item Detail / example Boards URL Your licence will be tied to this url DOMINO_AUTH_URL HCL Domino REST API URL. e.g. https://domino.example.com:8080 DOMINO_CLIENT_ID The Domino Auth client id DOMINO_CLIENT_SECRET The Domino Auth client secret"},{"location":"boards/domino/proton/","title":"Huddo Boards for HCL Domino Proton (DEPRECATED)","text":"Warning
These instructions are deprecated. Please see the new Domino REST API for new installations. For existing installations we recommend following our migration guide.
Huddo Boards supports authentication, user and group lookup with HCL Domino.
"},{"location":"boards/domino/proton/#prerequisites","title":"Prerequisites","text":"We will require 2 domains from you
Callback URL
Huddo Boards Cloud: Boards cloud uses a base64 encoded version of your Domino Server domain, you can use a service like https://www.base64encode.org/ to achieve this, the callback format looks like this: https://boards.huddo.com/auth/domino/[ encoded domain ]/callback
e.g. for domain proton.example.com the callback url would be https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback
Huddo Boards On Prem: For an on premise installation we use a global authentication setup so the callback url does not need an id. depending on your deployment it could look like one of the following:
https://boards.your.domain.com/auth/domino/callbackhttps://your.domain.com/boards/auth/domino/callback if you have a context root (i.e. you would access boards application at /boards).You will need to setup an Application in the IAM Service with the following details
Item Details Application Name Huddo Boards Application Home Page https://boards.huddo.com (or your boards url for an on-premise installation) Authorization Callback URL Callback URL above Proton Access Domino Database Access Functional ID LDAP CN for IAM application user Scopes Offline Access"},{"location":"boards/domino/proton/#proton-user","title":"Proton User","text":"The boards application backend uses a single user to access your names.nsf directory, you will need to setup a user with appropriate access and import a PEM Certificate as detailed below, for more information, see HCL's Documentation
"},{"location":"boards/domino/proton/#application-process","title":"Application Process","text":"Please email support@huddo.com with the following details
Item Detail / example IAM domain https://iam.example.com Domino domain https://proton.example.com Boards url For on-premise installations (your licence will be tied to this url) Proton Port 3002 client_id The IAM Application client id client_secret The IAM Application client secret user_certificate PEM encoded certificate that represents the Proton User above user_key Private Key for the above certificate group_search Please indicate whether you would like us to search Groups in your directory"},{"location":"boards/domino/migration/","title":"Migration from Domino Proton to REST API","text":""},{"location":"boards/domino/migration/#prerequisites","title":"Prerequisites","text":"Check Release date
Ensure you are running images after 30 November 2023
Danger
This step must be performed before any user tries to login with the new Domino OAuth client to ensure you maintain ownership of the current Boards data.
Open Admin Settings, then your organisation
Open Domino client
Edit Domino client
Tip
Save a copy of the old values in case you need to reverse the changes.
Change the old Proton values to new Domino REST API values as configured
Comment Domino URLhttps://<NEW_DOMINO_REST_API> ExternalId base64 encoded value of the hostname part of Domino URL(this is automatically set when you change Domino URL) Global OAuth ensure this box is checked Domino Hostname - PROTON ONLY (LEGACY) delete this value - it must be empty to enable the new REST API functionality. For example:
Click Save
boards.yaml configuration file which you have deployedSet environment variables for the user service as follows (substituting the values above)
user:\n env:\n DOMINO_AUTH_URL: https://<NEW_DOMINO_REST_API>\n DOMINO_CLIENT_ID: <CLIENT_ID>\n DOMINO_CLIENT_SECRET: <CLIENT_SECRET>\n DOMINO_USE_PROFILE_IMAGE_ATTACHMENTS: 'true'\nRun your deploy command (e.g. helm upgrade..., docker compose up)
Warning
We recommend you perform the validation steps below in a new Incognito window (or different browser) to test without logging out of your existing session. This way you can reverse the client changes in your existing session if required.
Open a new Boards session
Click Domino
Enter your credentials for the new REST API
Once Authenticated, you should see the approval request
Click Allow
This guide will describe how to add a new OAuth application for Boards users to login via Domino.
"},{"location":"boards/domino/oauth/#steps","title":"Steps","text":"Open the REST API and click Configuration
Login
Click Application Management - OAUTH
Click Add Application
Enter the following details and click ADD
Determine the appropriate URL for your environment as per our guide.
Huddo BoardsCallback URL, e.g.
https://<ON_PREM_BOARDS_URL>/auth/domino/callback\nhttps://boards.huddo.com/auth/domino/[encoded domain]/callback\nStartup Page, e.g.
https://<ON_PREM_BOARDS_URL>/auth/domino\nhttps://boards.huddo.com/auth/domino/[encoded domain]\nScope: $DATA (click + icon)
<YOUR_EMAIL>Click the generate application secret icon.
Copy both the App Id and App Secret
These will be referred to later as CLIENT_ID and CLIENT_SECRET
This guide will describe how to add a new Schema called directory to access the names.nsf database. Boards uses the $Users & $Groups views of this database. This section will configure the database forms.
Open the REST API and click Configuration
Click Database Management - REST API
Click Add Schema
Enter the following details and click ADD
Tip
If you cannot see names.nsf in the list, please see the HCL documentation
names.nsf and click itdirectorydomino directorynames.nsfOpen the new Schema and click the Source tab
Download this file and paste the contents into the editor
This guide will describe how to add a new Scope called directorylookup to allow reader access to the names.nsf database. Boards uses the $Users & $Groups views of this database.
Open the REST API and click Configuration
Click Database Management - REST API
Click the Scopes icon in the right menu, click Add Scope
Enter the following details and click ADD
names.nsf. Click directorydirectorylookupDirectory LookupReaderPlease set the following environment variables in your config file as required
Key Descriptionglobal.env.API_GATEWAY Fully qualified URL of the API in the format https://[API_URL] webfront.env.DEFAULT_TEAM Name of the team users will primarily login with.This will be shown on the login page.Optional: Only set if you are authenticating with multiple providers. events.env.NOTIFIER_EMAIL_HOST SMTP gateway hostname, e.g. smtp.ethereal.com events.env.NOTIFIER_EMAIL_USERNAME Optional: SMTP gateway authentication.Setting a value will enable auth and use the default port of 587 events.env.NOTIFIER_EMAIL_PASSWORD Optional: SMTP gateway authentication password events.env.NOTIFIER_EMAIL_PORT Optional: SMTP gateway port. Default: 25 (OR 587 if NOTIFIER_EMAIL_USERNAME is set) events.env.NOTIFIER_EMAIL_FROM_NAME Optional: Emails are sent from this name.Default: Huddo Boards events.env.NOTIFIER_EMAIL_FROM_EMAIL Optional: Emails are sent from this email address.Default: no-reply@huddo.com events.env.NOTIFIER_EMAIL_SUPPORT_EMAIL Optional: Support link shown in emails.Default: support@huddo.com events.env.NOTIFIER_EMAIL_HELP_URL Optional: Help link shown in new user welcome email.Default: https://docs.huddo.com/boards/howto/knowledgebase/ events.env.NOTIFIER_EMAIL_OPTIONS Optional: Custom NodeMailer email options (insecure tls etc).For example: \"{\\\"ignoreTLS\\\": true,\\\"tls\\\":{\\\"rejectUnauthorized\\\":false}}\" user.env.DISABLE_WELCOME_EMAIL Optional: Set to disable welcome emails for users"},{"location":"boards/env/common/#for-connections","title":"For Connections","text":"Key Description provider.env.WIDGET_ID Optional: ID of the Community widget configured in this step user.env.CONNECTIONS_NAME Optional: If you refer to 'Connections' by another name, set it here user.env.CONNECTIONS_CLIENT_ID oAuth client-id, usually huddoboards user.env.CONNECTIONS_CLIENT_SECRET oAuth client-secret as configured in this step user.env.CONNECTIONS_URL HCL Connections URL, e.g. https://connections.example.com user.env.CONNECTIONS_ADMINS Emails or GUIDs of users to grant admin permissions.e.g. \"[\\\"admin1@company.example.com\\\", \\\"PROF_GUID_2\\\"]\" user.env.CONNECTIONS_KEYCLOAK_URL Optional: See keycloak authentication for more information user.env.CONNECTIONS_KEYCLOAK_REALM Optional: See keycloak authentication for more information"},{"location":"boards/env/common/#for-domino","title":"For Domino","text":"Key Description user.env.DOMINO_AUTH_URL Optional: HCL Domino REST API URL. See domino authentication for more information user.env.DOMINO_CLIENT_ID Optional: oAuth client-id, see domino authentication for more information user.env.DOMINO_CLIENT_SECRET Optional: oAuth client-secret, see domino authentication for more information user.env.DOMINO_ADMINS Optional: Emails or GUIDs of users to grant admin permissions.See domino authentication for more information user.env.DOMINO_USE_PROFILE_IMAGE_ATTACHMENTS Optional: set true to enable using profile imagesSee domino authentication for more information user.env.DOMINO_PROFILE_IMAGE_NAME Optional: file name of profile images. Uses first image attached if not setSee domino authentication for more information user.env.DOMINO_AUTH_SCOPE Optional: defaults to $DATASee domino authentication for more information user.env.DOMINO_REST_SCOPE Optional: defaults to directorylookupSee domino authentication for more information"},{"location":"boards/env/notifications/","title":"Customise Emails","text":"The notifications sent out from Huddo Boards can be customised to include company logos, links and support email addresses. The custom values are set as ENV variables in the config file.
The image below shows the items that can be customised within notifications:
"},{"location":"boards/env/notifications/#from-name","title":"From Name","text":"Use events.env.NOTIFIER_EMAIL_FROM_NAME to set the from name for emails Default: Huddo Boards
Use events.env.NOTIFIER_EMAIL_FROM_EMAIL to set the sent from email address Default: no-reply@huddo.com
Specify a URL to point to a hosted logo image by specifying events.env.APP_LOGO_URL in the config. For example: https://company.com/assets/logo.png
Note that an inline base64 encoded data URL can also be used for this variable.
"},{"location":"boards/env/notifications/#brand-logo","title":"Brand Logo","text":"Specify a URL to point to a hosted logo image by specifying events.env.BRAND_LOGO_URL in the config. For example: https://company.com/assets/logo.png
Note that an inline base64 encoded data URL can also be used for this variable.
"},{"location":"boards/env/notifications/#social-links","title":"Social Links","text":"The links below the brand logo can be customised. These do not necessarily need to be displayed as images/icons and can be text based links.
The standard/default Huddo social links can be replaced by setting the events.env.SOCIAL_LINKS variable. Specifying an empty array will remove all social links.
The links are specified in a JSON array of objects with the format:
{\n name: \"Link Name/Text\", \n link: \"Link URL\", \n icon: \"(Optional) Hosted Icon URL or data URL\"\n}\ne.g.:
\"[{\\\"name\\\": \\\"Intranet\\\",\\\"link\\\":\\\"https://company.com/intranet/\\\"}, \n { \\\"name\\\": \\\"Support\\\", \\\"link\\\": \\\"https://company.com/support\\\", \n \\\"icon\\\": \\\"https://company.com/assets/support_icon.png\\\"}]\"\nUse events.env.APP_NAME to specify the app name.Default: Huddo Boards
The support email address can be specified in events.env.NOTIFIER_EMAIL_SUPPORT_EMAILDefault: support@huddo.com
events:\n env:\n NOTIFIER_EMAIL_FROM_NAME: My Company\n NOTIFIER_EMAIL_FROM_EMAIL: boards@company.com\n APP_LOGO_URL: https://company.com/assets/company_logo.png\n BRAND_LOGO_URL: https://company.com/assets/logo.png\n SOCIAL_LINKS: \"[{\\\"name\\\": \\\"Intranet\\\",\\\"link\\\":\\\"https://company.com/intranet/\\\"}, { \\\"name\\\": \\\"Support\\\", \\\"link\\\": \\\"https://company.com/support\\\", \n \\\"icon\\\": \\\"https://company.com/assets/support_icon.png\\\"}]\"\n APP_NAME: Boards for My Company\n NOTIFIER_EMAIL_SUPPORT_EMAIL: support@company.com\nHuddo Boards supports many languages so our clients all around the world can easily use our product with minimal understanding issues.
Our default language is English. While we endeavour to keep all languages up to date we frequently update and release new features so some sections may display in the default language for a time.
Langauge Code Arabic ar Bulgarian bg Catalan ca Czech cs Danish da German de Greek el English en Spanish es Finnish fi French fr Hebrew he Croation hr Hungarian hu Italian it Japanese ja Kazakh kk Korean ko Norwegian nb Dutch nl Polish pl Portuguese pt Romanian ro Russian ru Slovak sk Slovenian sl Swedish sv Thai th Turkish tr Chinese zh-tw"},{"location":"boards/faq/notifications/","title":"Huddo Boards Notifications","text":"Below are the notifications that Huddo Boards sends it's users to keep them up to date with their content, we try not to send too many of these and keep them short and relevant.
"},{"location":"boards/faq/notifications/#new-user","title":"New User","text":"Trigger First Sign in Recipients User Methods Email
"},{"location":"boards/faq/notifications/#user-invite","title":"User Invite","text":"Trigger Inviting a user to a board by their email address Recipients Invitee Methods Email
"},{"location":"boards/faq/notifications/#added-to-board","title":"Added to Board","text":"Trigger Adding user/group to a board Recipients Invitee Methods Email, Teams bot, Community stream
"},{"location":"boards/faq/notifications/#assigned-task","title":"Assigned Task","text":"Trigger Assigning a user to a card
Recipients Assignee Methods Email
Recipients Groups that are members Methods Teams bot, Community stream
"},{"location":"boards/faq/notifications/#commented","title":"Commented","text":"Trigger Adding a comment Recipients Commenter (if another user replies), Anyone assigned, The card creator, Anyone @Mentioned, Groups that are members Methods Email, Teams bot, Community stream
"},{"location":"boards/faq/notifications/#mentioned","title":"Mentioned","text":"Trigger @Mentioning another member in a board description Recipients Anyone @Mentioned, Groups that are members Methods Email, Teams bot, Community stream
"},{"location":"boards/faq/notifications/#group-notifications","title":"Group Notifications","text":"For boards that have groups as members, these notifications are sent to each group.
Trigger Creating a new card, Changing properties of a board/card, Completing a board/card Recipients Group Methods Teams bot, Community stream
"},{"location":"boards/faq/notifications/#licence-notifications","title":"Licence Notifications","text":"Trigger Quote Request, Payment Success/Failure, Licence created/updated Recipients Organisation Admins Methods Email
"},{"location":"boards/howto/","title":"User Guides","text":"We have many guides for using Huddo Boards. Please contact us if you have any questions that are not covered.
"},{"location":"boards/howto/knowledgebase/","title":"Knowledge Base & Support","text":""},{"location":"boards/howto/knowledgebase/#knowledge-base","title":"Knowledge Base","text":"Huddo Boards is a intutive to learn and easy to master. It is a powerful addition to any business, whether you're looking to increase your personal productivity, super charge your teams', or collaborate with external parties. Learn quick tips and tricks from our help guides to get the most out of boards. Let's get started!
Here are some quick how to guides to help you get started with Huddo Boards.\u00a0
\u2b05 Click on the menu options to see more!
"},{"location":"boards/howto/knowledgebase/#customer-support","title":"Customer Support","text":""},{"location":"boards/howto/knowledgebase/#troubleshooting","title":"Troubleshooting","text":"If you require support using Huddo Boards, contact us at support@huddo.com
"},{"location":"boards/howto/mobile-app/","title":"Mobile app","text":"You can access and work with Huddo Boards Cloud on your mobile device.
"},{"location":"boards/howto/mobile-app/#download-the-app-to-your-device","title":"Download the app to your device","text":"Download the Huddo Boards Cloud App from either Apple App Store or Google Play Store.
"},{"location":"boards/howto/mobile-app/#login-to-the-huddo-boards-app","title":"Login to the Huddo Boards App","text":"
When you start the app and reach the login screen you have multiple options on how to identify yourself towards Activities Plus and Huddo Boards.
You are in! Now you see all your existing Activities and Boards and can immediately start working!
"},{"location":"boards/howto/use-auth0/","title":"Login with Auth0","text":""},{"location":"boards/howto/use-auth0/#huddo-boards-and-auth0","title":"Huddo Boards and Auth0","text":"Admin Guide to setting up Auth0 tenant.
"},{"location":"boards/howto/use-auth0/#sign-in-to-huddo-boards-with-your-auth0-tenant","title":"Sign in to Huddo Boards with your Auth0 Tenant","text":"Once your Auth0 tenant has been activated you will get an email from our support team with confirmation, you may then go to Huddo Boards and use your Auth0 domain as the team name to login.
You'll then be asked to enter your email address and password.
If you're not sure which email address and password to use, check with your IT administrator, or the person who created the Auth0 domain.
"},{"location":"boards/howto/use-verse/","title":"HCL Verse","text":""},{"location":"boards/howto/use-verse/#huddo-boards-integration-points-for-hcl-verse","title":"Huddo Boards integration points for HCL Verse","text":"Huddo Boards provides 2 integration points with HCL Verse:
"},{"location":"boards/howto/use-verse/#save-email-as-a-card-in-boards","title":"Save email as a card in Boards","text":""},{"location":"boards/howto/use-verse/#attach-card-from-boards-to-an-email-in-verse","title":"Attach card from Boards to an email in Verse","text":""},{"location":"boards/howto/adding-members/","title":"Adding Members","text":"Adding members to your board allows you to collaborate with your team, your whole organisation and even external parties outside of your company. There is no limit to the number of people you can have as members of a board.
"},{"location":"boards/howto/adding-members/#adding-members-to-a-new-board","title":"Adding Members to a New Board","text":"You can add members when you first create a board.
In the New Board creation phase, type in the name of any colleague or group in your organisation in the Add People field, or type in an email address of someone who is external to your organisation.
You can also decide if you would like the board to have Public Access, meaning anyone in your organisation will be able to view the board and participate depending on what level of permission you have set (reader, author, editor.)
"},{"location":"boards/howto/adding-members/#adding-members-to-an-existing-board","title":"Adding Members to an Existing Board","text":"At any stage of your work, you can add members to a board.
From within your board, select Members from the menu on the right-hand side. From here, you\u2019ll be able to see current members or add new ones. Type in the name of any colleague or group in your organisation in the add members field, or type in an email address of someone who is external to your organisation.
Don\u2019t forget to click the Add Members button before closing the window.
New members will be notified that they have been invited to your board.
"},{"location":"boards/howto/adding-members/#managing-members-in-a-microsoft-team-channel-and-board","title":"Managing Members in a Microsoft Team Channel and Board","text":"A board can be added to a channel within Teams to help track progress on tasks and create a collaborative work environment.
Members of a Team or a Channel will be inherited automatically in to your Huddo Board.
You can also add members directly to the board by searching them in the Members area on the right hand side of the board. Adding members this way, be they in your organisation or external to your organisation, will add them just to the board. Not to the Channel or Team.
Archiving gives you the ability to remove a card, list or board from your screen. Cards, lists and boards that have been archived, can be restored.
Permanently deleting a card, list or board will remove them completely from the system. They cannot be retrieved if you change your mind. Only use this option if you are sure you want to delete an item forever.
"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-card","title":"How do I Archive a Card?","text":"Click in to the card you want to archive. Use the Archive button at the top of the right-hand corner to archive the card. The screen will show it has been archived and when you click away from it, it will disappear from the board.
Example of an archived card:
Archived the card by mistake? If you're still in archived card screen, use the Restore button in the top right corner to bring the card back to the board.
To Archive a list, click the vertical ... icon on the right-hand side of the blue list header and select Archive.
You'll notice that you also have options to archive the list and cards, or just the cards in the list.
"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-restore-permanently-delete-a-card-or-a-list","title":"How do I Restore / Permanently Delete a Card or a List?","text":"If you\u2019ve moved away from the archiving window above, but need to restore / delete a card or list, click the Archived button in the right-hand side menu. It will bring up a window where you can see your archived cards and lists. Hover over the card or list then click the Restore button to return it to the board or the Delete to permanently delete it.
Only use the Delete option if you don't need to access the card or list ever again. For example, if you made a mistake. You cannot retrieve permanently deleted items.
"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-board","title":"How do I Archive a Board?","text":"Open the board you intend to archive. Navigate to Open Board Options found in the title of your board, to the left of the search bar.
In the board options you\u2019ll see the Archive button in the actions shown at the top. Click this button to archive the board.
The board will change appearance to indicate it has been archived.
"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-permanently-delete-a-board","title":"How do I permanently delete a board?","text":"Warning
You can\u2019t restore or retrieve the board or any of the cards in it, if you delete permanently
Option 1: If you\u2019re still within the screen above, you can use the Delete button to delete the board. If you\u2019ve navigated out of that screen but remain in the board, click the board title to Open Board Options and use the Delete button.
Option 2: Delete any board you\u2019ve archived by navigating to the Archive tab on your My Boards dashboard page. Click in to the board you want to delete, click the board title to Open Board Options, and click Delete.
Option 1: If you\u2019re still within the screen above, you can use the Restore button to restore the board. If you\u2019ve navigated out of that screen but remain in the board, click the board title to Open Board Options and use the Restore button.
Option 2: Restore any board you\u2019ve archived by navigating to the Archive tab on your My Boards dashboard page. Click in to the board you want to restore, click the board title to Open Board Options, and click Restore.
Within a template, you can create Assignment Roles that can be assigned to tasks just like members. When creating a board from this template, you can assign the members of this new board to these roles and they will be responsible for completing the tasks the role had been assigned.
"},{"location":"boards/howto/assignment-roles/assignment-roles/#create-a-template-with-assignment-roles","title":"Create a Template with Assignment Roles","text":"Start off by creating a template following the steps in the Create a Template article.
Once your template has been created and opened, open the Members dialog by clicking on Members in the right side bar.
In the dialog that opens, there will be a section for Assignment Roles. Click the Create button to create a new role.
Give your role a name and select an icon. A color will be automatically assigned to the role. Click Save to create the role.
Now in the members dialog, you can see the roles that have been created. You can click these roles if you need to edit them.
You can assign roles to tasks just as you would a board member.
See the section on using a template to see how Assignment Roles are used when creating a board from a template.
"},{"location":"boards/howto/attaching-files/","title":"Attaching Files to Cards","text":"Huddo Boards allows files under 50MB to be attached to cards directly.
Anyone who has access to view the card will be able to view and download the attachment.
Tip
This feature can be disabled organisation wide by an administrator if desired.
"},{"location":"boards/howto/attaching-files/#office-365-onedrive-hcl-connections-files","title":"Office 365 (OneDrive) & HCL Connections (Files)","text":"If you use Office 365 or HCL Connections as your authentication method, you may also upload files to those services directly, in this case the files and security will be managed by your respective provider. Huddo Boards will only save a link to open these.
"},{"location":"boards/howto/attaching-files/#attaching-a-file-to-a-card","title":"Attaching a File to a Card","text":"Once you have opened your desired card, you can drag&drop a file to upload it, otherwise you can use the UI by:
Clicking the Links and Attachments
In the menu that appears, choose Upload to this board.
Locate the file(s) you wish to attach and click open.
Your file will now appear in the Links and Attachments list.
"},{"location":"boards/howto/attaching-files/#removing-an-attached-file","title":"Removing an Attached File","text":"To remove an attached file, navigate to the ... to the right of the attachment. Click and select Delete to remove the file. The file will be deleted and the link will no longer work. Please ensure you still have a copy of the file if needed before doing this.
Anyone who can edit the card can also remove the attached files.
"},{"location":"boards/howto/attaching-files/#where-are-files-stored","title":"Where are Files Stored?","text":"Files attached to cards in Huddo Boards Cloud with Auth0, Google, Facebook, LinkedIn authentication providers are stored in a Google Cloud Storage.
If you are hosting Huddo Boards yourself then files are stored in the default file storage as defined in your environment.
If you are using Office 365 or HCL Connections, your files are stored within these environments.
"},{"location":"boards/howto/attaching-files/#deleting-a-card-that-has-attachments","title":"Deleting a Card that has Attachments","text":"When you archive a card, the attachments will still be accessible however, if you delete the card permanently then the attachments will also be deleted.
"},{"location":"boards/howto/attaching-files/#adding-emails-as-files","title":"Adding Emails as Files","text":"Huddo Boards is an eml dropzone such that you are able to drag & drop emails out of email programs that support dragging as eml and drop them on an open card in Huddo to upload them as a file.
"},{"location":"boards/howto/attaching-files/#outlook","title":"Outlook","text":"In order to allow Outlook to do this, we are aware of the Outlook2Web program that can facilitate this.
"},{"location":"boards/howto/connections/connections-ui/","title":"HCL Connections UI Integrations","text":"Huddo Boards can integrate features directly in to HCL Connections user interface that enable you to:
If you're an administrator looking for how to set this up, see the install documentation here.
"},{"location":"boards/howto/connections/connections-ui/#related-tasks","title":"Related Tasks","text":"You can create and view tasks related to the HCL Connections page you're currently viewing. Look for the Huddo Boards icon in the Connections header and file viewer.
Huddo Boards in the Connections Header Huddo Boards in the file viewer"},{"location":"boards/howto/connections/connections-ui/#huddo-boards-in-search-results","title":"Huddo Boards in Search Results","text":"Search results from Huddo Boards can be included in HCL Connections search results. Just search as normal and results from Huddo Boards will appear if there are any.
Huddo Boards results when searching all content Huddo Boards results when searching from the sidebar"},{"location":"boards/howto/dependencies/","title":"Task Dependencies","text":""},{"location":"boards/howto/dependencies/#task-dependencies-in-huddo-boards","title":"Task Dependencies in Huddo Boards","text":"Huddo Boards supports the use of task dependencies within boards. A task dependency is where a task relies on another task or tasks to be completed before it can be completed itself. A single task can be dependant on multiple tasks and multiple tasks can be dependant on a single task.
"},{"location":"boards/howto/dependencies/#creating-a-task-dependency","title":"Creating a Task Dependency","text":"Task dependencies can be created in several ways:
"},{"location":"boards/howto/dependencies/#within-an-open-task","title":"Within an open task","text":"Find and click the Add Dependency button in the task bar:
Add Dependency Button:Add Dependency buttons will also be available within the task details view here:The Add Dependency Dialog will be shown:
Select a task that you want to add as a dependency for the current task. The dependency you choose will need to be completed before the current task can be completed.
Swap Direction button Add button to create the task dependency.Timeline view of your board.Drop the icon onto the intended task and the dependency relationship will be created.
6. Once the dependency has been created then dependency icons can be observed on both the parent and child of the dependency.
Opening a (either a child or parent) task with dependencies will list those dependencies on the task details view.
Dependencies for a particular task can be displayed/visualised in various ways depending on what view you are using to display your board.
"},{"location":"boards/howto/dependencies/#board-view","title":"Board view","text":"Timeline view is the best way to visually observe dependencies as arrows drawn between scheduled tasks.
There are several options available for showing dependency arrows in the timeline view, controlled by settings in the right hand sidebar:
"},{"location":"boards/howto/dependencies/#show-all-dependency-arrows","title":"Show all dependency arrows","text":"This is the default setting and will show all dependencies as blue arrows at all times. The arrows will recalculate themselves if tasks are moved or resized, or if dependencies are added or removed.
"},{"location":"boards/howto/dependencies/#hide-dependency-arrows","title":"Hide dependency arrows","text":"Use this option to hide all dependency arrows in Timeline. Hovering on a task to show its dependency chain can still be achieved when arrows are hidden, depending on the setting below.
"},{"location":"boards/howto/dependencies/#hover-on-a-task-to-highlight-its-dependency-chain","title":"Hover on a task to highlight its dependency chain","text":"Hover anywhere for a few moments on a task/card that has dependencies to highlight dependent tasks and also visualise the chain of dependency links as arrows to and from the dependant cards. Note that numbers also appear in the top right of the highlighted cards to indicate the order that they need to be completed.
When Hover on a task to highlight its dependency chain is enabled, the arrow display depth slider will be shown, and can be used to increase the number of \"levels\" (backwards and forwards from the hovered card) to show a chain of dependency link arrows in the Timeline view, originating from the card that is being hovered on.
See the animation below as an example of 2 levels of dependency depth.
"},{"location":"boards/howto/dependencies/#completing-a-task-that-has-dependencies","title":"Completing a task that has dependencies","text":"Attempting to complete a task that has incomplete dependencies will trigger the following dialog:
*Note that individual tasks cannot be completed from this view.
"},{"location":"boards/howto/dependencies/#available-actions","title":"Available actions","text":""},{"location":"boards/howto/dependencies/#complete-all-task-dependencies-and-this-task","title":"Complete all Task Dependencies and this task","text":"Click this to complete the task after completing all of its preceding dependencies as displayed in the dialog.
"},{"location":"boards/howto/dependencies/#cancel","title":"Cancel","text":"Close the dialog without taking an action.
"},{"location":"boards/howto/getting-started/","title":"Getting Started","text":""},{"location":"boards/howto/getting-started/#getting-started","title":"Getting Started","text":"Huddo Boards is a intutive to learn and easy to master. It is a powerful addition to any business, whether you're looking to increase your personal productivity, super charge your teams', or collaborate with external parties. Learn quick tips and tricks from our help guides to get the most out of boards. Let's get started!
If you have signed in to Huddo Boards for the very first time as an individual user without a licence, see Starting a trial of Huddo Boards
Here are some quick instructions to help you get started with Huddo Boards.
"},{"location":"boards/howto/getting-started/#create-a-board","title":"Create A Board","text":"New Board button, or use the + buttons as indicated below.Enter a name and description for your new board. Don't worry you can edit these later.
Select any users or groups you would like to add to your board. Also select if you would like to share this board with the rest of your team. These settings can be changed after a board has been created as well.
Blank to choose your own adventure!Kanban, Mindmap and Timeline. Note that the view of the board can be switched at any point in time.CreateAdd lists to a board to categorise todos and entries. Click on Add a list to add a new list to your board.
Click on Add a card in any list to add a card to that list.
Add cards to your lists to represent Tasks, Work Items, Decisions, Ideas, Notes, Options, Sub-lists - Really anything you need them to represent. The beauty of this design is that you can use lists and cards to mean anything you need to for the task at hand.
"},{"location":"boards/howto/getting-started/#assign-tasks-to-others","title":"Assign Tasks To Others","text":"Assign Tasks to people in the board by either dragging their photo from the members panel in the right side bar. Or use the Assign Users control from the card details view. When you assign a card to a person, they are notified of the assignment via email and also via any news feeds that board has access to (Workspace chat, Connections activity stream, etc.).
"},{"location":"boards/howto/getting-started/#plan-your-tasks","title":"Plan Your Tasks","text":"Boards lets you assign due dates to a card, as well as start and end dates, to help you better plan your tasks. Go to the Timeline View in a board to view the cards according to their start and end dates. To modify the start/end/duration of a card, simply drag the card to a new date, or drag the edges to individually change the start or end date.
"},{"location":"boards/howto/getting-started/#view-card-details","title":"View Card Details","text":"Click on a card to open it. The card details popup gives you access to a whole range of information and controls for the card. It lets you view and edit the card's name, completion status, description, tags, attachments, comments, due date, colour labels, fields and much more!
"},{"location":"boards/howto/getting-started/#edit-board-options","title":"Edit Board Options","text":"Click on the Edit icon on the top right of the board to open the Board details view. This view lets you edit the board's name, description, tags, due date and more. It also let's you create a templates and archive the board.
"},{"location":"boards/howto/getting-started/#add-and-remove-board-members","title":"Add and Remove Board Members","text":"Click on Members in the right sidebar to open the Board Members view. You can view all the orgs, individuals and groups who have access to this board. If you have Owner role for the board, you can also add and remove members from this view. It is also possible to invite a user to the board using their email address.
"},{"location":"boards/howto/getting-started/#colour-code-your-cards","title":"Colour Code Your Cards","text":"Huddo Boards allows you to colour code your tasks by simply dragging and dropping the colours from the right sidebar onto cards. You can also assign custom text labels to each of the colours by simply clicking the edit icon in the Colour Labels section in the right sidebar. These labels are set at the board level and everyone in the board will see the same labels.
"},{"location":"boards/howto/getting-started/#_1","title":"Getting Started","text":""},{"location":"boards/howto/getting-started/#colour-code-your-boards-in-myboards-dashboard","title":"Colour Code Your Boards in MyBoards Dashboard","text":"Huddo Boards let's you colour code all your boards to help you personally manage and categorise your work. To colour code a board tile in the MyBoards Dashboard, simply drag a colour from the left sidebar and drop it on a board. Much like card colour labels, you can also add custom text labels to these colours, however, this is for your personal organisation and as such will only be visible to you. To edit the board colour labels, click the edit icon in the Colours section in the left sidebar. Filter to see boards from one or more specific colours by clicking on the colour.
To see your boards organised by colour, set your View to Colours.
The picture below shows the Myboards Dashboard. This is your start / home page with colourful tiles. Each tile is one Board with a name, when it was last accessed, progress on tasks and more.
"},{"location":"boards/howto/homepage/#on-this-start-page-you-can","title":"On this start page you can:","text":"Create a new Board by clicking on the Plus sign and Create
Open an existing Board by clicking on one of the tiles
Search for a Board by entering the search word in the Search Boards field at the top
Filter Boards by My, Public and Archive
Sort Boards by Recent and Last accessed
Colours These are colour tags you can drag and drop onto the tiles. Click on the menu to edit the tags.
Add tags to the Boards for easy sorting and filtering in the same way as with colours above.
See all your collected tasks from all your Boards by clicking on Todos
Find the template library by clicking on Templates
If there are scheduled tasks in a board, a calendar feed can be enabled allowing you or others to subscribe to the feed of board tasks as events in your calendar app.
Calendar applications such as Microsoft Outlook will perform regular synchronisation with the feed, so any changes made to the scheduled tasks in Boards will be updated in your calendar automatically.
"},{"location":"boards/howto/ical/board/#enabling-a-calendar-feed-for-a-board","title":"Enabling a calendar feed for a board","text":"Navigate to Open Board Options found in the title of your board, to the left of the search bar.
Underneath the action bar on the right hand sideyou will see an iCalendar feed box with an Enable button. Click this to enable the calendar feed for this board.
After clicking enable, additional buttons will become available for subscribing to, copying the link for, or disabling the calendar feed:
Subscribe to open your chosen calendar app for your operating system and subscribe to the feed.Click Copy feed link to copy the link to the feed to your clipboard. This may be useful for pasting into a calendar application, or sharing the calendar feed to people who are not listed as board members.
Info
You may experience an error similar to the following when attempting to subscribe to a board calendar feed within Microsoft Outlook for Windows.
In this case, follow the steps shown here to disable shared calendar improvements. After restarting Outlook, the calendar subscription should now work.
Click Disable to disable the feed for the board. The feed will no longer be available and any subscriptions to this board feed will not continue to sync.
A calendar feed can be subscribed to for all scheduled tasks you are assigned to within Huddo Boards.
Calendar applications such as Microsoft Outlook will perform regular synchronisation with the feed, so any changes made to the scheduled tasks in Boards will be updated in your calendar automatically.
"},{"location":"boards/howto/ical/personal/#subscribing-to-your-personal-calendar-feed","title":"Subscribing to your personal calendar feed","text":"From the My Boards Dashboard/Homepage, navigate to my Todos found in the left hand side menu.
Once in the Todos view you will see an iCalendar feed section at the bottom of the left hand side menu.
Subscribe to open your chosen calendar app for your operating system and subscribe to the feed.Copy feed link to copy the link to the feed to your clipboard. This may be useful for pasting into a calendar application.Info
You may experience an error similar to the following when attempting to subscribe to a calendar feed within Microsoft Outlook for Windows.
In this case, follow the steps shown here to disable shared calendar improvements. After restarting Outlook, the calendar subscription should now work.
Activities that already exist in HCL Connections can be individually imported into Huddo Boards.
First, hover over the 'Create Board' button in the bottom right and select the 'Import from Activities' option that appears
From here, you can search for the Activity you wish to import, either previewing the result or just importing directly. A new card will be created at the start which indicates this has been done as well as a link to the Board.
"},{"location":"boards/howto/microsoft/onedrive/","title":"Microsoft OneDrive","text":""},{"location":"boards/howto/microsoft/onedrive/#huddo-boards-and-microsoft-onedrive","title":"Huddo Boards and Microsoft OneDrive","text":"The Huddo Boards integration with Microsoft OneDrive allows you to find files that you have added to boards, conveniently located in your OneDrive.
In the example below, a file titled \"Best Melbourne Restaurants\" has been added to the board, Food Objectives 2019.
The file will be added to OneDrive for easy access and location.
In the example above, the board is part of a Teams Channel called \"Places to Eat 2019\", and as a result, a shared library has been created to hold those files.
Files will be added to OneDrive whether they are from private or shared boards.
"},{"location":"boards/howto/microsoft/outlook/","title":"Microsoft Outlook","text":""},{"location":"boards/howto/microsoft/outlook/#huddo-boards-in-microsoft-outlook","title":"Huddo Boards in Microsoft Outlook","text":"Huddo Boards' integration with Microsoft Office 365 allows you to create cards on a board directly from an email in your inbox, and share cards, lists, or an entire board, within an email.
"},{"location":"boards/howto/microsoft/outlook/#create-a-card-from-an-email","title":"Create a Card From an Email","text":""},{"location":"boards/howto/microsoft/outlook/#desktop-outlook","title":"Desktop Outlook","text":"Navigate to the email you would like to attach as a card to a board. Click the Save email as card button in the Home ribbon.
The title of the email will automatically be filled, however you have the opportunity to change this if you wish. Select to Include email body so the contents of your email are included in your card. A board and list will automatically be recommended to you however you can change this selection by clicking on the board and list fields and making a new selection.
Click Create.
In the next window, click the Open in Boards button to be taken to the board and see the card. It will look something like this:
Navigate to the email you would like to attach as a card to a board. Click the ... for more actions and scroll down to select Huddo Boards.
The title of the email will automatically be filled, however you have the opportunity to change this if you wish. Select to Include email body so the contents of your email are included in your card. A board and list will automatically be recommended to you however you can change this selection by clicking on the board and list fields and making a new selection.
Click Create.
In the next window, click the Open in Boards button to be taken to the board and see the card. It will look something like this:
To include a card, list, or board, in an email, create a new email, or select reply or forward of an existing email already in your inbox.
On Desktop Outlook, you'll find the Attach Board/Card button in the Message ribbon.
In the side panel that appears, you'll have the option to select your desired board and the lists or cards you would like to include. You can select an entire board, or simply a card or list (or multiple cards and lists to attach). Click Attach when you've made your selection. Continue to add more by repeating the same selection process and attaching to the email.
To include a card, list, board, in an email, create a new email, or select reply or forward of an existing email already in your inbox.
Click the ... at the bottom of the email and select Huddo Boards.
In the side panel that appears, you'll have the option to select your desired board and the lists or cards you would like to include. You can select an entire board, or simply a card or list (or multiple cards and lists to attach). Click Attach when you've made your selection. Continue to add more by repeating the same selection process and attaching to the email.
Huddo Boards' integration with Microsoft Office 365 allows you to add Huddo Boards to a SharePoint site page and work directly on the board from the page.
In the example below, we've created a site page called \"Where to Eat in Melbourne\" and added our Food Objectives 2019 board to it. When added, you and your colleagues can work directly from a site page on a board.
Before proceeding, you will need a site admin to enable security settings as described here
From Sharepoint main menu, go to Pages -> New -> Site Page
Give your page a name, then click the +
Choose Embed from the drop down menu
Open Huddo Boards and select the board you wish to embed in the sharepoint page. Click the Board Options button
Click Copy embed code
Go back to sharepoint and paste the code you copied in the box provided
Tip
If you don't see the input box above, you can get it back by clicking the embed you added previously and clicking it's edit button.
To make a small amount of extra room on your page, you may wish to edit the title and choose Plain as it's layout.
Once you are happy with the page, click 'Publish' to make it visible to other members of your site.
Promote your new page by following the recommendations
The Mind Map layout in Huddo Boards is a unique view that allows you to have a visual overview of all your tasks from one board. Mind Map is ideal for strategic planning, brainstorming, inventing, R&D, marketing, and more.
"},{"location":"boards/howto/mindmap/#accessing-the-mind-map-view","title":"Accessing the Mind Map View","text":"The Mind Map view can be set as the Starting View when you create a board or it can be switched to at any time during your work on a Board.
In your board creation phase, select Mind Map from the Starting View drop down.
If your board is already created in either the Timeline or Board view, it is simply a matter of selecting the Mind Map view from the right-hand side menu.
In this example, we\u2019ll create a new mind map and select Blank as the template, so we can populate it entirely ourselves. Alternatively, you can select one of the preloaded templates like Classic, Weekdays, Departments, or Meetings.
When you create a new mind map, you\u2019ll see the title of the board, sitting front and center on the page. You\u2019ll notice that just above the boxed title, there are two icons. The icon on the left creates a new sub-card. Since we\u2019ve just begun our board, this will first create lists.
You can add as many lists as you like and at any stage of your mind map. Then add cards to your list areas, as you would on the Kanban Board view. Use the Add a Sub-Card icon on your desired list to add cards.
You can add as many cards to the blue list titles as you like. Using the Add a Sub-Card icon on a card, will create a sub-card.
As with a board and timeline, you can drag and drop colour labels and members on to your mind map.
"},{"location":"boards/howto/mindmap/#mind-map-views-and-layouts","title":"Mind Map Views and Layouts","text":"On the right-hand side menu, you have tools that can change the layout of your Mind Map.
Re-Centre: If you\u2019ve focused in one section of your mind map, clicking Re-Centre will bring you back to a big picture view of your map.
Layout: Radial
Layout: Horizontal
Layout: Vertical
Mirror / Reverse: Flip the layout of your mind map between mirror and reverse.
Type: Use Type to dictate how your lists, cards, and sub-cards are connected to each other.
Type: Free
Type: Step
Curve
Type: Line
"},{"location":"boards/howto/permissions/","title":"Member Permissions","text":""},{"location":"boards/howto/permissions/#permissions-in-huddo-boards","title":"Permissions in Huddo Boards","text":"When you invite colleagues, teams, or external parties to collaborate in your board, you can decide what level of permission to allocate to them. Below, permissions are listed from the lowest access to the highest.
"},{"location":"boards/howto/permissions/#reader","title":"Reader","text":"A person allocated a Reader permission, has read-only access.
"},{"location":"boards/howto/permissions/#author","title":"Author","text":"A member with Author permissions, has the ability to create new cards, edit their cards, and any cards assigned to them. They cannot edit existing cards.
"},{"location":"boards/howto/permissions/#editor","title":"Editor","text":"An Editor has the ability to edit existing content, and create new content. Editors can invite and manage other members with the roles Reader, Author and Editor (they cannot change Owners)
"},{"location":"boards/howto/permissions/#owner","title":"Owner","text":"Owners have full rights to all properties on a board, they can add, edit and delete all other members, lists and cards in the board.
Find out more about how to add members to a board.
"},{"location":"boards/howto/permissions/#making-your-board-public","title":"Making Your Board Public","text":"When you activate Public Access, your board will be discoverable by anyone in your organisation. You'll be asked to select Reader, Author, or Editor to decide what level of access your organisation can have to the board. Additionally, updates that you make on your board may be included in linked activity streams such as HCL Connections, or Microsoft Teams.
To give your board public access, navigate to your desired board. Select Members and then select Public Access. Decide what level of access, Reader, Author or Editor, your organisation will have.
You can @mention a team member within the description or comments area of a card to get their attention. This will send them a notification that they\u2019ve been mentioned and can take action on what you\u2019ve written.
"},{"location":"boards/howto/quick-tips/#move-between-board-mind-map-and-timeline","title":"Move between Board, Mind Map, and Timeline","text":"Chose the Kanban view setting up your board, but decided a Mind Map would be better for brainstorming ideas? No worries!
Using the right-hand side menu, transform the view of your board between the Kanban Board, Mind Map, and Timeline. Information in your board remains the same, only your view will change. Change as often as you like or depending on your needs.
"},{"location":"boards/howto/quick-tips/#add-members-to-a-board","title":"Add Members to a Board","text":"When you start a new board, you can choose to invite members to participate. But if you\u2019ve got a board you\u2019re already working on, you can also invite members at any point of your work on the board.
Use the right-hand menu and select Members.
Start typing an individual, group name, or email address to bring up people in your organisation.
To invite people external to your organisation, type in their email address. Don\u2019t forget to click Add Members before closing the screen.
This screen allows you to choose the type of rights your members will have: Owner, Editor, Author, Reader.
You can also decide if you want the board to be Public Access, which will enable anyone from your organisation to see it.
"},{"location":"boards/howto/quick-tips/#use-colour-labels-to-categorise-and-filter","title":"Use Colour Labels to Categorise and Filter","text":"You can use the Colour Labels on the right-hand side menu to help categorise your board.
Click the pencil to the right of Colour Labels, then update the colours with your desired label names.
Drag and drop the colour labels on to a card. Do the same action to remove the colour from the card.
You can also click on a colour or multiple colours to filter the cards.
"},{"location":"boards/howto/start-a-trial/","title":"Starting a trial","text":""},{"location":"boards/howto/start-a-trial/#starting-a-trial-of-huddo-boards-cloud","title":"Starting a trial of Huddo Boards Cloud","text":"You can use your O365, LinkedIn, Facebook, AppleID or HCL Connections Collab Cloud to access Huddo Boards Cloud.
The first time you log in to Huddo Boards Cloud as an individual user, you will not have access to the Huddo Boards Premium Views (Kanban Board, MindMap, and Timeline), only the free Activity View (simple drop down list).
There are two ways to activate a free 30 day trial in order to access the premium views.
"},{"location":"boards/howto/start-a-trial/#activate-free-trial-via-myboards-dashboard","title":"Activate free trial via MyBoards Dashboard:","text":"User Options and then select View Subscriptions. Start My Trial to activate your free 30 day trial. You can return to View Subscription at any point to purchase a licence for Huddo Boards for yourself or for a number of people in your organisation.
Create button to start a new board. Save when you are done. Board MindMap and Timeline in the right hand menu will be greyed out with the words Preview Available under each. Select any of these and follow prompts to start your free trial. Boards has integrated seamlessly with Microsoft Office 365 Teams so you can supercharge your existing collaboration environments.
Add boards to Microsoft Teams as an administrator.
"},{"location":"boards/howto/teams/adding-boards/#accessing-all-of-your-boards-in-microsoft-teams","title":"Accessing all of your Boards in Microsoft Teams","text":"When you open Microsoft Teams, click the \u2026 icon in the left-hand side menu and select Add More Apps.
In the Store search bar, type in Huddo Boards. Click the Huddo Boards icon. The following window will appear:
You can choose if you wish to add to a specific team, but for the moment, we want to have all of our Boards accessible in one place. So keep the options as represented here. Click Install.
Press the X in the next window as installation has now been completed.
You can now access all your Boards in one place, by navigating to the \u2026 on the left-hand side, and selecting Huddo Boards.
From here, select the My Boards tab, next to Conversation. You\u2019ll have access to all your Boards via the My Boards dashboard as normal, but conveniently located within Microsoft Teams.
You can work on Boards from within Channels. To add a Board to a channel, click on the + sign in the top menu next to Wiki.
You can select the Huddo Boards icon or search it if it doesn\u2019t appear directly.
In the next window, select your preferences, to either
Enter the board information and click Save.
Your Board will now appear in its own tab alongside Wiki. Add multiple boards by repeating the same process.
"},{"location":"boards/howto/teams/disable-notifications/","title":"Teams - Disable Notifications","text":"If you find that your Microsoft Teams team Conversations tab is getting a bit crowded with all the updates your team are making in Huddo Boards, it is possible to control whether or not team notifications are posted in Conversations for each board in your team.
To do this, firstly open a board within a Teams tab.
Click the Open Board Properties button in the top-left corner of the board:
In the board properties you will see a Disable team notifications for this board button. (note that this may take a few seconds to appear):
Click this to disable all notifications for the board from coming up in the Conversations tab of your team.
Note that the notifications for the board can be enabled again by clicking the Enable team notifications for this board button in the same location of the board properties dialog:
Made a fantastic board and want to keep a copy for future use? Save time and brain power by creating a template of your board.
"},{"location":"boards/howto/templates/creating/#create-a-template-from-an-existing-board","title":"Create a Template From an Existing Board","text":"Within your board, click the title of your board to Open Board Options. Find this located between the Huddo Boards logo and the search bar. Next, click, Create Template from Board.
In the next window, you can update the name, description, and choose to keep Board Members as is, remove or add Board Members. Click Save. The template will open in a new screen.
You\u2019ll be able to locate your template in your template library via the MyBoards Dashboard or when you create a new board and search the name.
Important: When the template opens in a new screen, any editing you do will apply to the template. Click in to the Open Board Options icon as you did above and select, Create Board from Template. When the new window opens, you\u2019ll start a new board instead of editing the template you\u2019ve just created.
From your main MyBoards dashboard, navigate to Templates via the left-hand side menu. You\u2019ll land on the My Templates page and see templates you have created.
Click the + New Template button to start your creation. You have the option to select Source Board / Template in the creation process, meaning you can make a template from another template that already exists. Leave this blank if you prefer to build your template from scratch in the board.
Public Template Access: Making a template in the public area, will not automatically make it public. Within the template you create, you\u2019ll be able to select if you wish for it to be public. You can do this in the template creation window or later when it is created by finding Public in the Members section on the right-hand side menu.
Complete the required information for your template, then click Create.
Your new template will open as a blank board template or with lists and cards if you selected from a Source Board/Template. From here, customise your template by editing or adding required lists, cards, colour labels, tags and more.
In future, when creating a new board, type in the template name in the Search All Templates field, during the New Board creation phase.
Note: Opening a board via the template library will mean you are editing the template. You can create a new board from the template by:
Open Board Options, then selecting, Create Board from Template; orSearch All Templates search bar.You can access a library of global templates already available from Huddo Boards to use as inspiration for your own work.
When you start a New Board, click Explore the Template Library.
This will open a new window with available templates.
Feel free to click in to different templates to see what they contain.
When you\u2019ve found the template you\u2019re looking for, return to your original New Board screen and start typing in the template name. It will appear and you can select it.
You still have the option to select the Starting View, from Kanban, MindMap, Timeline or Activty.
Click Next to give your board a name and then Save and you\u2019ll be taken to your new Board.
When creating a Board from a template that contains dates (due, start or end dates), you have the option move all of the dates so that the first or last date is on a particular day. For example, if you have a template for preparing for a business trip, you can reschedule your template so that all of your tasks are due before your date of departure.
On the My Boards page, click the + Create button. The New Board window will open. Search templates by name and select your template that contains dates.
Click Next.
You'll see an option to choose a Starts on or Finishes on date. Select the one that makes sense for your template. (This won't appear if there are no dates in your template.) Use the date picker to choose which day you'd like your dates to start or finish.
Click Save. Your new Board will be created.
Timeline view.Board -> Todos by Date view.Instead of people assigned to tasks, templates can have roles assigned to tasks. When creating a board from this template, you can assign the members of this new board to these roles and they will be responsible for completing the tasks the role had been assigned. For how to create templates like this, see Create a Template with Assignment Roles.
After you've selected a template and chosen some members to add to your board, you'll see the Assign Roles step if your template includes Assignment Roles assigned to tasks.
Drag and drop members on to the roles to assign them to the role. You can assign multiple members to a role and a member to multiple roles.
Once you've created the board, you will see members assigned to the tasks that had roles assigned.
"},{"location":"boards/howto/timeline/","title":"Timeline","text":"
Huddo Boards has multiple views to help you get your tasks done, whether you\u2019re working individually, as a team or as an organisation. The Timeline view is a unique component of Boards and we\u2019ll explore it here, to demonstrate how it can help you stay on track to meet your deadlines.
"},{"location":"boards/howto/timeline/#accessing-the-timeline-view","title":"Accessing the Timeline View","text":"The Timeline view can be set as the Starting View when you create a new board or it can be switched to at any time during your work on a board.
In your board creation phase, selectTimeline from the Starting View drop down.
If your board is already created in either the Mind Map or the Kanban Board view, it is simply a matter of selecting the Timeline view from the right-hand side menu.
Whether you\u2019re starting a new board, or using an existing board, for cards to appear on the timeline, they\u2019ll need to have a start and finish date. From the Timeline view, these dates can be added in two ways:
If you have cards that are sitting in the Unscheduled Cards area on the bottom right-hand side, you can drag and drop them on to the timeline. To begin, cards can only be dropped in to the list they have been created in and will by default, be allocated to three days from start to finish.
Once you\u2019ve dropped a card in to its list, you can move it along the timeline in either direction, shorten or lengthen its start and finish dates, or move to a different list.
Cards sitting in the Unscheduled Cards area can be clicked on to bring up the detailed card view. From here, select Set Dates, from the right-hand side menu. Add in a start and finish date under the card title for it to appear on the Timeline. The finish date will automatically fill to three days after start date, but this can be edited.
Note: In the Kanban Board view or Mind Map view, you also have the option to add dates to cards, by clicking in to the detailed card view, selecting Set Dates, and adding a Start Date and End Date. If you then switch over to the Timeline view, your cards will automatically fall on the timeline to the dates you have selected.
The default view of Timeline is to group by Lists. But you have the option to view the cards on the board by Colour, Label, and by Assigned. Use the drop-down menu in the top left corner next to Group By to select from List, Colour, or Assigned.
Boards has many integration options to suit your needs. Please contact us if you have any specific requirements that are not covered.
"},{"location":"boards/integrations/developing/related-tasks/","title":"Use Huddo Boards Related Task Microapp","text":"To display this use the following pattern to load and use the microapp
<boardsURL>/app/linkedcards?title=<boardsCardTitle>&url=<boardsPrimaryLink>
where - <boardsURL> is the URL of your Huddo Boards installation (boards.huddo.com for Boards Cloud) - <boardsCardTitle> is the default title for the task when created which users can change, fully escaped - <boardsPrimaryLink> is the URL of the page you want to show tasks related to, fully escaped
e.g. https://boards.huddo.com/app/linkedcards?title=Card%20Name&url=https%3A%2F%2Fexample.com
There is also a message sent with the current number of related tasks if you wish to display this.
The event data is in the format huddo-task-count=0
Example for JavaScript:
window.addEventListener(\"message\", (event) => {\n\n if(event.origin !== <boardsURL>)\n return;\n\n let eventData = event.data;\n\n //huddo-task-count=0\n if(typeof eventData === \"string\" && eventData.includes(\"huddo-task-count\"))\n {\n boardsNumTasks = event.data.split('=')[1];\n }\n}\nDeploying Huddo Boards into Kubernetes -or- IBM Cloud Private for on-premise environments
"},{"location":"boards/kubernetes/#prerequisites","title":"Prerequisites","text":"kubectl configured
Instructions Kubernetes copy~/kube/.config from the Kubernetes master server to the same location locally(backup any existing local config) IBM Cloud Private - Open ICP Console- Go to Admin (top right)- Click Config Client- Copy the contents shown- Open your command line / terminal- Paste the commands copied earlier and press enter Kubernetes for on-premise environments requires a reverse proxy to route traffic. There are a number of different ways this reverse proxy can be configured and Huddo Boards aims to match whatever you already have in place. Some examples of network routing:
New domain Path on existing domain Example ofBOARDS_URL boards.example.com example.com/boards Example of API_URL api.example.com example.com/api-boards Requirement 1. Reverse proxy able to match any current domains as well as the new one for Huddo Boards (either by using SNI or a compatible certificate for all domains).2. Certificate coverage for the 2 domains. Ability to proxy the 2 paths Certificate Resolution a) in your proxy and forward the unencrypted traffic to kubernetes-OR-b) forward the encrypted traffic and perform the certificate resolution in kubernetes (described in config below). All certificate resolution on the proxy server Notes IBM HTTP WebServer supports only one certificate. You must have a Wildcard certificate to cover all of your domains including the new Boards domains (ie *.example.com). Additional config required to make Boards webfront handle redirects, details below. For Connections Header Additional WebSphere application must be installed - Please decide on which configuration will suit your environment best and the corresponding BOARDS_URL & API_URL. These values will then be used in the following documentation.
For more details on configuring an IBM HTTP WebServer as reverse proxy, please see here
"},{"location":"boards/kubernetes/#oauth","title":"OAuth","text":"Huddo Boards currently supports the following oAuth providers for authentication and integration: HCL Connections (on premise), IBM Connections Cloud and Microsoft Office 365.
You will need to setup an OAuth application with one (or more) of these providers for Huddo Boards to function. please refer to the following documentation:
Provider Registration / Documentation Callback URL HCL Connections(on premise) Huddo instructionshttps://[BOARDS_URL]/auth/connections/callback Microsoft Office 365 Azure app registrations https://[BOARDS_URL]/auth/msgraph/callback Google Google Console https://[BOARDS_URL]/auth/google/callback LinkedIn LinkedIn https://[BOARDS_URL]/auth/linkedin/callback Facebook Facebook developer centre https://[BOARDS_URL]/auth/facebook/callback"},{"location":"boards/kubernetes/#huddo-boards-namespace","title":"Huddo Boards namespace","text":"kubectl create namespace boards\nHuddo Boards requires a Mongo database and an S3 file storage. If you already have equivalent services already then you can use your existing details in the config below, otherwise you may follow our instructions to deploy one or both of these services as follows:
Note: these tasks are very similar to each other and can be performed simultaneously
"},{"location":"boards/kubernetes/#secrets","title":"Secrets","text":"Follow this guide to get access to our images in Quay.io
SSL certificate details
Only perform this step if you need to resolve certificates in kubernetes
kubectl create secret tls huddoboards-domain-secret --key </path/to/keyfile> --cert </path/to/certificate> --namespace=boards\nDownload our config file and update all example values as required. Details as below.
Kubernetes Variables:
Key Descriptionglobal.env.APP_URI https://[BOARDS_URL] global.env.MONGO_USER MongoDB userIf using our storage above you may leave this commented out global.env.MONGO_PASSWORD MongoDB passwordIf using our storage above you may leave this commented out global.env.MONGO_HOST MongoDB hostIf using our storage above you may leave the default global.env.MONGO_PARAMS MongoDB request parametersIf using our storage above you may leave the default global.env.S3_ENDPOINT S3 URLIf using our storage above you may leave the default global.env.S3_ACCESS_KEY S3 Access KeyIf using our storage above you may leave the default global.env.S3_SECRET_KEY S3 Secret KeyIf using our storage above you may leave the default webfront.ingress.hosts [BOARDS_URL] (no protocol) core.ingress.hosts [API_URL] (no protocol, e.g. api.huddoboards.com) Boards Variables:
Follow instructions on this page
"},{"location":"boards/kubernetes/#deploy-boards-chart","title":"Deploy Boards Chart","text":"Install the Boards services via our Helm chart
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards --recreate-pods\nNote: --recreate-pods ensures all images are up to date. This will cause downtime.
in the linked document you should use the IP of your kubernetes manager and the http port for your ingress (32080 if you have component pack installed)
Please follow these instructions
"},{"location":"boards/kubernetes/#connections-cloud-or-microsoft-office-365","title":"Connections Cloud or Microsoft Office 365","text":"Add a reverse proxy entry in your network that resolves your certificates and forwards your 2 domains to the IP of the kubernetes manager and the http port for your ingress. If any assistance is required
"},{"location":"boards/kubernetes/#hcl-connections-integrations","title":"HCL Connections integrations","text":"Huddo Boards requires a Mongo database.
Warning
The example below is suitable for a Small Scale Deployment, e.g. a proof of concept, staging deployment or even a production deployment for a limited number of users/data.
Tip
For Large Scale Deployments (HA) please use either MongoDB:
bitnami/mongodb offer a decent wrapper to initialise a replicaset with their Helm chart.This documentation will deploy a MongoDB replicaSet into your Kubernetes setup.
If you already have externally hosted Mongo database please skip to the Outcomes section to determine your equivalent connection parameters.
You can also email us for support at support@huddo.com
"},{"location":"boards/kubernetes/deploy-mongo/#prerequisites","title":"Prerequisites","text":"nfs.path /pv-kudos/mongo Path to storage location 22 nfs.server [STORAGE_SERVER_IP] IP of NFS serverie 192.168.10.50"},{"location":"boards/kubernetes/deploy-mongo/#deploy-instructions","title":"Deploy instructions","text":"Create the folder at nfs.path location on the nfs.server with access 777
Note: please ensure sufficient storage is available (ie 100GB)
Ensure each Node in your Kubernetes cluster can mount this location.
Please modify the file /etc/exports on your NFS Server to include this line
<NFS_PATH_FOR_MONGO> <IP_RANGE_OF_YOUR_SERVERS>/<SUBNET_MASK>(rw,no_root_squash)\nFor example:
/pv-kudos/mongo 192.168.0.0/255.255.0.0(rw,no_root_squash)\nApply new NFS storage to exports
exportfs -ra\nInstall Mongo
kubectl apply -f ./mongo.yaml\nThe following are the parameters required to connect to this database. You will need these later in the application setup. If you have your own MongoDB deployment, please substitute your values.
Key Default Value DescriptionMONGO_PROTOCOL mongo Protocol used in your Connections String MONGO_HOST mongo-service:27017 Hostname of your Mongo service MONGO_PARAMS replicaSet=replicaset Request parameters (ie ?) MONGO_USER None Username to connect.Authentication is disabled in this private deployment MONGO_PASSWORD None Password to connect.Authentication is disabled in this private deployment Alternatively, these parameters can be set with MONGO_URI which is built from:
[MONGO_PROTOCOL]://[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]\n\nmongo://mongo-service:27017/database?replicaSet=replicaset\nOr with optional credentials:
[MONGO_PROTOCOL]://[MONGO_USER]:[MONGO_PASSWORD]@[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]\n\nmongo://user:passw0rd@mongo-service:27017/database?replicaSet=replicaset\nHuddo Boards requires an S3 object store. This documentation will deploy a Minio S3 storage container into the Kubernetes setup.
If you already have externally hosted S3 storage please skip to the Outcomes section to determine your equivalent connection parameters.
You can also email us for support at support@huddo.com
"},{"location":"boards/kubernetes/minio/#prerequisites","title":"Prerequisites","text":"nfs.path /pv-kudos/minio Path to storage location 22 nfs.server STORAGE_SERVER_IP IP of NFS serverie 192.168.10.50 69 MINIO_ACCESS_KEY ioueygr4t589 Access credential 71 MINIO_SECRET_KEY 7a863d41-2d8f-4143-bc8a-02501edbea6f Access credential"},{"location":"boards/kubernetes/minio/#deploy-instructions","title":"Deploy instructions","text":"Create the folder at nfs.path location on the nfs.server with access 777
Note: please ensure sufficient storage is available (ie 100GB)
Ensure each Node in your Kubernetes cluster can mount this location.
Please modify the file /etc/exports on your NFS Server to include this line
<NFS_PATH_FOR_MINIO> <IP_RANGE_OF_YOUR_SERVERS>/<SUBNET_MASK>(rw,no_root_squash)\nFor example:
/pv-kudos/minio 192.168.0.0/255.255.0.0(rw,no_root_squash)\nApply new NFS storage to exports
exportfs -ra\nInstall Minio
kubectl apply -f ./minio.yaml\nThe following are the parameters required to connect to this S3 storage. You will need these later in the application setup. If you have your own S3 storage, please substitute your values.
Key Default Value DescriptionS3_ENDPOINT minio-service Hostname of this service(as per line 84 of config) S3_ACCESS_KEY ioueygr4t589 Credential configured above S3_SECRET_KEY 7a863d41-2d8f-4143-bc8a-02501edbea6f Credential configured above S3_BUCKET kudos-boards Default storage bucket"},{"location":"boards/kubernetes/prerequisites/","title":"Prerequisites","text":"Requirements and considerations before installation of Kubernetes and Huddo Boards
"},{"location":"boards/kubernetes/prerequisites/#servers","title":"Servers","text":"This solution is designed to run a cloud-like environment locally in your data centre. You should expect to configure a minimum of 3 servers.
This solution is ideal if you already have kubernetes (or IBM Component Pack for connections) as it can run in your existing environment. If this is the case, please reach out to Team Huddo for support.
"},{"location":"boards/kubernetes/prerequisites/#existing-infrastructure","title":"Existing Infrastructure","text":"In addition to the above, Huddo Boards for Kubernetes is able to take advantage of existing services in your network, if you have any of the following and would like to take advantage of them, please ensure you have all relevant access documented.
Service Requirements MongoDB URL, username and password S3 Storage URL, Bucket name, username and password NFS Server IP address or hostname, must be accessible to all swarm servers"},{"location":"boards/kubernetes/prerequisites/#stmp-for-email-notifications","title":"STMP for email notifications","text":"If you would like to send emails, Huddo Boards docker requires details of a forwarding SMTP server in your environment (or other email provider sich as sendgrid)
"},{"location":"boards/kubernetes/prerequisites/#ssl-certificates-and-domain-names-for-hosting","title":"SSL Certificates and domain names for hosting","text":"In the examples below, replace example.com with your actual company domain
Huddo Boards requires 2 domains (or redirects) in your network, one for the web application and one for the api. You can use a new domain or subdomain for this or you can use a path on an existing service.
For example:
Domain Path Web boards.example.com example.com/boards API api-boards.example.com example.com/api-boardsWe'll refer to these throughout installation as [BOARDS_URL] and [API_URL]
You will need a reverse proxy in place to forward network requests to the kubernetes master. This proxy should be able to resolve certificates that cover all domains used.
"},{"location":"boards/kubernetes/prerequisites/#ssh-access","title":"SSH Access","text":"To perform the installation, you need to setup some config files on a local machine that has ssh access to the servers. You should ssh to each server manually before proceeding to ensure they are trusted.
"},{"location":"boards/kubernetes/prerequisites/#authentication","title":"Authentication","text":"Huddo Boards is designed to be integrated into your current user management system. Before you are able to login you will need to configure OAuth for one (or more) of the following providers (detailed instructions here):
Provider Registration / Documentation HCL Connections (on premise) IBM Knowledge Center IBM Connections Cloud IBM Knowledge Center Microsoft Office 365 Azure app registrations Google Google Console LinkedIn LinkedIn Facebook Facebook developer centre"},{"location":"boards/kubernetes/prerequisites/#access-to-docker-images","title":"Access to Docker Images","text":"Follow this guide to get access to our images
"},{"location":"boards/kubernetes/prerequisites/#ansible","title":"Ansible","text":"We use Red Hat Ansible to script the installs. Please ensure this is installed as per our guide prior to the kubernetes / boards install
"},{"location":"boards/msgraph/","title":"Index","text":"Huddo Boards offers extensions for integrating with your Microsoft product
"},{"location":"boards/msgraph/#custom-tile","title":"Custom Tile","text":""},{"location":"boards/msgraph/#teams-integration","title":"Teams Integration","text":""},{"location":"boards/msgraph/#outlook-plugin","title":"Outlook Plugin","text":""},{"location":"boards/msgraph/overview/","title":"Overview","text":"Huddo Boards is tailored for working with Office 365 in the following ways:
"},{"location":"boards/msgraph/overview/#login","title":"Login","text":"Use your existing Microsoft credentials
"},{"location":"boards/msgraph/overview/#collaboration","title":"Collaboration","text":"Share and collaborate with individuals and groups in your office tenant
"},{"location":"boards/msgraph/overview/#easy-access","title":"Easy Access","text":"Access Boards from your Office menu, and access other Office apps from the menu in Boards
Admin setup guide
"},{"location":"boards/msgraph/overview/#onedrive","title":"OneDrive","text":"Share files and folders from Onedrive within the context of a Board
"},{"location":"boards/msgraph/overview/#teams","title":"Teams","text":"Teams integration admin guide
Add boards tabs to Microsoft Teams
See all of the boards your team is working on.
Access Huddo Boards directly from Teams as a personal app
Receive notifications as the board updates
"},{"location":"boards/msgraph/overview/#outlook","title":"Outlook","text":"You can add the Outlook add-in just for yourself (Outlook plugin user guide) Or for your whole Microsoft 365 tenant (Outlook plugin admin guide)
Save emails from Outlook as a card in your board
Attach boards, lists and cards to an email.
"},{"location":"boards/msgraph/overview/#_1","title":"Overview","text":""},{"location":"boards/msgraph/overview/#sharepoint","title":"Sharepoint","text":"Embed boards as pages in Sharepoint.
Sharepoint pages setup guide
"},{"location":"boards/msgraph/auth/","title":"Authenticating Huddo Boards with Office 365","text":"This document details the process to enable login to your private instance of Huddo Boards with your private Office 365 tenant.
"},{"location":"boards/msgraph/auth/#register-oauth-application","title":"Register OAuth Application","text":"You must configure an OAuth Application in your Office 365 Tenant in order to use Huddo Boards with O365. To access this configuration you must be logged in as a Microsoft tenant admin
"},{"location":"boards/msgraph/auth/#open-the-azure-app-portal","title":"Open the Azure App Portal","text":"Click New Registration
Enter the values below and click Register
Huddo Boards\nhttps://[BOARDS_URL]/auth/msgraph/callback\nWhere BOARDS_URL is the URL to access your main Huddo Boards page. For example:
https://connections.example.com/boards/auth/msgraph/callback ORhttps://boards.example.com/auth/msgraph/callbackClick Register
Open the Manifest section
Replace the requiredResourceAccess section as per below
\"requiredResourceAccess\": [\n {\n \"resourceAppId\": \"00000003-0000-0000-c000-000000000000\",\n \"resourceAccess\": [\n {\n \"id\": \"06da0dbc-49e2-44d2-8312-53f166ab848a\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"64a6cdd6-aab1-4aaf-94b8-3cc8405e90d0\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"863451e7-0667-486c-a5d6-d135439485f0\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"4e46008b-f24c-477d-8fff-7bb4ec7aafe0\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"7427e0e9-2fba-42fe-b0c0-848c9e6a8182\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"37f7f235-527c-4136-accd-4a02d197296e\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"ba47897c-39ec-4d83-8086-ee8256fa737d\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"14dad69e-099b-42c9-810b-d002981feec1\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"205e70e5-aba6-4c52-a976-6d2d46c48043\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"e1fe6dd8-ba31-4d61-89e7-88639da4683d\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"b340eb25-3456-403f-be2f-af7a0d370277\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"59a6b24b-4225-4393-8165-ebaec5f55d7a\",\n \"type\": \"Role\"\n },\n {\n \"id\": \"3b55498e-47ec-484f-8136-9013221c06a9\",\n \"type\": \"Role\"\n }\n ]\n }\n],\nClick Save
Open the API permissions section. Notice that all the scopes are now pre-filled.
Click Grant admin consent for kudosdev
Click Yes
Note: These steps are extracted from the official Microsoft guide: steps 5-12
Note: This step is optional, but recommended to remove the Sign in with page when accessing Huddo Boards.
At the end of this step you should have the following:
Click Expose an API
Set the Application ID URI as per:
api://<DOMAIN_HOSTING_BOARDS>/<CLIENT_ID>
where :
DOMAIN_HOSTING_BOARDS is the domain hosting boards, e.g. boards.company.com or company.comCLIENT_ID is the Application (client) ID, shown on the Overview pageFor example:
api://boards.huddo.com/5554fe8f-34b6-4694-a09d-6349e6ab6ec9
Note: this requires the domain name to be added & verified in the Azure Portal under Azure Active Directory -> Custom domain names. See read the official Microsoft documentation for more information.
Click Add a scope
Set the following values:
access_as_userAdmins and usersTeams can access the user\u2019s profile.Teams can call the app\u2019s web APIs as the current user.Teams can access your profile and make requests on your behalf.Teams can call this app\u2019s APIs with the same rights as you have.EnabledClick Save
Add the following Authorized client applications
1fec8e78-bce4-4aaf-ab1b-5451cc387264 for Teams mobile or desktop application.5e3ce6c0-2b1f-4285-8d4b-75ee78787346 for Teams web application.Open the Overview section
Copy Application (client) ID & Directory (tenant) ID
Open the Certificates & secrets section
Click New client secret
Select Never expire and click Add
Copy the secret value shown
Add OAuth and Tenant values to YAML config (ie boards.yaml or boards-cp.yaml)
global:\n env:\n MSGRAPH_CLIENT_ID: \"<your-application-id>\"\n MSGRAPH_CLIENT_SECRET: \"<your-application-secret>\"\n MSGRAPH_LOGIN_TENANT: \"<your-tenant-id>\"\nRedeploy Boards Helm Chart as per command for Huddo Boards:
HCL Component Pack
helm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections\nfor Docker - Kubernetes
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nNote: --recreate-pods is not required this time as this is only an env variable change
Open your Huddo Boards environment.
Click the Office 365 option and login with a Tenant Administrator account
Once logged in, a prompt will appear in Huddo Boards. Click Approve
Click Accept on the following popup to grant the required permissions for Huddo Boards
Congratulations! All users in your tenant can now login to Huddo Boards via Office 365!
Follow these steps by Microsoft which we have also outlined below.
Open 365 Admin Centre
Click Settings -> Org Settings -> Organization Profile
Click Custom app laucher tiles
Click Add a custom tile
Enter the following details & click Save
Huddo Boards\nhttps://boards.huddo.com/auth/msgraph\nhttps://boards.huddo.com/img/logo-small.png\nSocial collaboration\nHuddo Boards will now appear in the list. Click Close
Go to https://www.office.com
Open the Apps menu and click All apps
Huddo Boards should be shown in the list.
Users can now pin this to their menu. This may take 10 minutes to appear
To get the most out of Huddo Boards in your Office 365 tenant, there are a few steps to take to make the experience seamless for your users.
The Steps on this page (other than just logging in) require that you are an admin in your Office 365 tenant. If you are not an admin, please refer this page to your Administrator, Manager or IT department.
"},{"location":"boards/msgraph/getting-started/#login","title":"Login","text":"Huddo Boards uses OAuth for login and user access. This means your users can just click the Office 365 logo at boards.huddo.com and use their existing Microsoft credentials.
If you would like to link to Huddo Boards from another site, you can use https://boards.huddo.com/auth/msgraph which will skip the list of login options.
"},{"location":"boards/msgraph/getting-started/#admin-approval","title":"Admin Approval","text":"Microsofts API requires that you grant admin access to Huddo Boards before your users are able to search for groups, to enable this log into Huddo Boards and you should be prompted to grant admin approval.
After clicking Approve, you may be asked to login to Office 365 again, then you will be prompted to approve Huddo Boards access on behalf of your organisation.
Note: you can revoke this approval at any stage via the Office 365 admin app.
The requested permissions are:
Permission Use in Huddo Boards Maintain access to data you have given it access to Allows us to remember who you are logged in as, so you don't have to login every time you use Huddo Boards Sign in and read user profile Allows login to Huddo Boards Read all users' basic profiles Allows us to get names and profile pictures of others in your tenant Read directory data As Above Read users' relevant people lists As Above Read and write all groups Allows us to search for groups you are a member of. Write access is only used to add Huddo Boards bot to a Group in Microsoft Teams Have full access to all files user can access Allows us to link to your OneDrive files Read items in all site collections Allows us to link to OneDrive files owned by your Groups or TeamsYou can also go to Your Admin Page to approve the above.
"},{"location":"boards/msgraph/getting-started/#start-a-free-trial","title":"Start a free trial","text":"After logging in, you will also be prompted to start a free (30 day) trial. Enabling this will allow other users in your Office 365 tenant to login and use Huddo Boards.
You may also go to Your Admin Page to Start Your free trial, get a Quote or Purchase licences online.
"},{"location":"boards/msgraph/getting-started/#enable-integrations-between-huddo-boards-and-office-365","title":"Enable Integrations between Huddo Boards and Office 365","text":"These guides also require admin access and enable some advanced features of Huddo Boards in your Office 365 environment.
These are also in the side menu of this page
Note
Desktop Outlook requires the Microsoft Edge WebView2 Runtime.
Open 365 Admin Centre
Click Settings -> Integrated apps -> Upload custom apps
Select Provide link to manifest file
https://boards.huddo.com/office/outlook/add-in.xml\nClick Validate then click Next
Specify who has access and click Next
Finish DeploymentClick Done
Open Outlook
You should now see the Huddo Boards option in the menu of an email
The instructions on this page use 'The new Outlook' however you can also add and use this plugin from 'classic Outlook' or Outlook desktop.
Microsoft 365 admins can add this for all users in their tenant, instructions here
Open Outlook and click New Message
Click the ... menu -> Get Add-ins
Click My Add-ins then Add a custom add-in -> Add from URL
Provide the url: https://boards.huddo.com/office/outlook/add-in.xml and click OK.
Click Install then close the add-in dialogue.
Verify the add-in is installed by clicking the ... menu again.
You will now be able to:
Save emails from Outlook as a card in your board
Attach boards, lists and cards to an email.
Before proceeding, you will need a site admin to enable security settings as described here
From Sharepoint main menu, go to Pages -> New -> Site Page
Give your page a name, then click the +
Choose Embed from the drop down menu
Open Huddo Boards and select the board you wish to embed in the sharepoint page. Click the Board Options button
Click Copy embed code
Go back to sharepoint and paste the code you copied in the box provided
Tip
If you don't see the input box above, you can get it back by clicking the embed you added previously and clicking it's edit button.
To make a small amount of extra room on your page, you may wish to edit the title and choose Plain as it's layout.
Once you are happy with the page, click 'Publish' to make it visible to other members of your site.
Promote your new page by following the recommendations
Embedding Huddo Boards in sharepoint requires iframe permissions for users, it is common (default) for the permitted domains to be limited, if this is the case, you can add Huddo Boards to the restricted list as below.
Admin access is required for these steps
Site SettingsOR choose Site information then View all site settings
HTML Field SecurityAddOKHuddo Boards is available freely in the Microsoft Teams App Store to add as either a personal app or to a team.
"},{"location":"boards/msgraph/teams/#add-to-a-team","title":"Add to a Team","text":"You can add Huddo Boards to MS Teams in two ways. Follow these steps to Huddo Boards as a tab in a Team Channel.
Open the Teams App and go to the team you wish to add Huddo Boards to.
Click the + (add a tab) button
Search for huddo to find Huddo Boards
Note that if Huddo Boards cannot be found, it has not yet been added before in your organisation and needs to be added by finding it within the Teams App Store. Click More Apps in this case:
Again, search for huddo to find the Huddo Boards App in the entire store.
Once you have located and clicked on the Huddo Boards App, click the Add button to add it to the team:
The Huddo Boards app will now be added to the team, and you will be given the ability to add a new tab:
more added apps area.","text":"To add Huddo Boards as a personal app follow these steps:
Open Teams and click the Apps button. Type huddo to find the Huddo Boards app:
Click Huddo Boards then click Add to add it as a personal app:
This bot will be used to post notification to Microsoft Teams triggered by actions performed in Huddo Boards.
Note: this step is optional and cannot be achieved if you do not meet the prerequisites.
"},{"location":"boards/msgraph/teams/notification-bot/#prerequisites","title":"Prerequisites","text":"Note: Microsoft Teams notifications requires 2-way web communication.
For example, the following URL must be accessible by Microsoft's servers: https://[BOARDS_URL]/webhook/teams
Open Bot Registration and sign-in with a Microsoft Tenant admin
Enter the following values
Huddo Boards\nhuddoboards\nhttps://[BOARDS_URL]/webhook/teams\n[MSGRAPH_CLIENT_ID]\nWhere:
[BOARDS_URL] is the URL to your Huddo Boards installation
i.e. https://connections.example.com/boards/webhook/teams or https://boards.company.example.com/webhook/teams
[MSGRAPH_CLIENT_ID] is the OAuth Client ID from Auth setup
For example:
Huddo Boards\nhuddoboards\nhttps://connections.example.com/boards/webhook/teams\nb0e1e4a3-3df0-4c0a-8a2a-c1d630bb52b8\nScroll down, read/agree to the terms and click Register
Click the Teams icon
Click Save
The bot setup is complete
See Installing the Huddo Boards Teams App
"},{"location":"boards/msgraph/teams/on-prem/","title":"Huddo Boards On-Premise in Microsoft Teams","text":""},{"location":"boards/msgraph/teams/on-prem/#prerequisites","title":"Prerequisites","text":"Office 365 Tenant admin account.
Office 365 OAuth client. See instructions
Notification bot (optional). See instructions
Note: notifications are optional as the bot cannot be configured for internal Huddo Boards deployments
Login to Huddo Boards with your Microsoft Tenant Admin account
Click the Configuration icon and then Manage Org
Click on your Organisation
Click on your Microsoft client
Click the download button for your configuration
App with Notifications (if you can and have enabled the notification bot)
App for Internal Boards Deployment (if you do not want notifications)
Open the Teams App
Click Apps -> Upload a custom app -> Upload for [COMPANY_NAME]
where [COMPANY_NAME] is the name of your company
Upload the Zip file you downloaded above
The Huddo Boards app will now appear under the section Built for [COMPANY_NAME]
Open Team Apps in your web browser
Click on Built for [COMPANY_NAME] => Huddo Boards
Click Add
Huddo Boards personal will now open
Copy the App ID from the URL. We will use this shortly.
Open the Boards Helm Chart config used for deployment
Add the following environment variable to provider (uncomment or add the section as required):
provider:\n env:\n MSGRAPH_TEAMS_APP_ID: \"<your_app_id>\"\nRedeploy Boards helm chart as per command for Huddo Boards:
HCL Component Pack
helm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections\nfor Docker - Kubernetes
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nNote: --recreate-pods is not required this time as this is only an env variable change
For a full guide on using Huddo Boards in Microsoft Teams, please see our documentation.
"},{"location":"boards/swarm/","title":"Boards for Docker Swarm (DEPRECATED)","text":"Warning
These instructions are deprecated. Please see standalone guide if you do not have either Kubernetes or Component Pack
Basic instructions for deploying Huddo Boards into Docker Swarm for on-premise IBM Connections environments
"},{"location":"boards/swarm/#prerequisites","title":"Prerequisites","text":"Dockerhub account with access to Huddo Boards repository.
Send your account details to support@huddo.com if you don't already have this.
SSL certificate - You will need to use a certificate that covers at least the 2 domains you plan to use, for example Huddo Boards cloud uses the domains https://boards.huddo.com and https://api.boards.huddo.com. The certificate should be pem encoded with a separate key file.
Huddo Boards currently supports the following oAuth providers for authentication and integration: HCL Connections (on premise), IBM Connections Cloud and Microsoft Office 365.
You will need to setup an OAuth application with one (or more) of these providers for Huddo Boards to function. please refer to the following documentation:
Provider Registration / Documentation Callback URL IBM Connections (on premise) Huddo instructionshttps://[BOARDS_URL]/auth/connections/callback Microsoft Office 365 Azure app registrations https://[BOARDS_URL]/auth/msgraph/callback Google Google Console https://[BOARDS_URL]/auth/google/callback LinkedIn LinkedIn https://[BOARDS_URL]/auth/linkedin/callback Facebook Facebook developer centre https://[BOARDS_URL]/auth/facebook/callback"},{"location":"boards/swarm/#update-config-file","title":"Update config file","text":"Swarm Variables:
Key Descriptionx-minio-access Minio ACCESS_KEY as defined in your docker swarm config x-minio-secret Minio SECRET_KEY as defined in your docker swarm config x-app-env.APP_URI https://[BOARDS_URL] services.webfront.deploy.labels Update the traefik.frontend.rule your [BOARDS_URL] (no protocol) services.core.deploy.labels Update the traefik.frontend.rule with your [API_URL] (no protocol) Boards Variables:
Follow instructions on this page
"},{"location":"boards/swarm/#deploy","title":"Deploy","text":"Update DNS records with a CNAME entry pointing to your swarm URL.
For example:
boards.huddo.com -> swarm.isw.net.au\nboards.api.huddo.com -> swarm.isw.net.au\nPlease follow these instructions
You can also run Huddo Boards with externally hosted mongo database and/or S3 storage. For assistance with this contact support@huddo.com
"},{"location":"boards/swarm/#updates","title":"Updates","text":"The Boards services can be updated through the Portainer interface, or alternatively these commands should force latest images to run
docker service update --force --image redis:latest boards/redis\ndocker service update --force --image iswkudos/kudos-boards-docker:webfront boards/webfront\ndocker service update --force --image iswkudos/kudos-boards-docker:core boards/core\ndocker service update --force --image iswkudos/kudos-boards-docker:boards boards/app\ndocker service update --force --image iswkudos/kudos-boards-docker:user boards/user\ndocker service update --force --image iswkudos/kudos-boards-docker:licence boards/licence\ndocker service update --force --image iswkudos/kudos-boards-docker:provider boards/provider\ndocker service update --force --image iswkudos/kudos-boards-docker:notification boards/notification\nIf you must update the Portainer/Traefik images, try these commands:
docker service update --force --image portainer/portainer:latest portainer/portainer\ndocker service update --force --image portainer/agent:latest portainer/agent\ndocker service update --force --image traefik:alpine proxy/proxy\nWarning
These instructions are deprecated. Please see standalone guide if you do not have either Kubernetes or Component Pack
"},{"location":"boards/swarm/prerequisites/#servers","title":"Servers","text":"This solution is designed to be a lightweight, cloud-like setup running locally in your data centre. You should expect to configure a minimum of 4 very small servers, see Swarm Installation for a table showing the requirements.
"},{"location":"boards/swarm/prerequisites/#existing-infrastructure","title":"Existing Infrastructure","text":"Huddo Boards for Docker Swarm is able to take advantage of existing services in your network, if you have any of the following and would like to take advantage of them, please ensure you have all relevant access documented.
Service Requirements MongoDB URL, username and password S3 Storage URL, Bucket name, username and password NFS Server IP address or hostname, must be accessible to all swarm servers SNI Capable reverse proxy admin access to proxy to configure all domains (see SSL Certificate below)"},{"location":"boards/swarm/prerequisites/#stmp-for-email-notifications","title":"STMP for email notifications","text":"If you would like to send emails, Huddo Boards docker requires details of a forwarding SMTP server in your environment (or other email provider sich as sendgrid)
"},{"location":"boards/swarm/prerequisites/#ssl-certificates-dns","title":"SSL Certificates / DNS","text":"You will need to have certificates and DNS entries that cover the following domains:
Replace example.com with your actual company domain
To perform the installation, you need to setup some config files on a local machine that has ssh access to the servers. You should ssh to each server manually before proceeding to ensure they are trusted.
"},{"location":"boards/swarm/prerequisites/#authentication","title":"Authentication","text":"Huddo Boards is designed to be integrated into your current user management system. Before you are able to login you will need to configure OAuth for one (or more) of the following providers (detailed instructions here):
Provider Registration / Documentation IBM Connections (on premise) IBM Knowledge Center IBM Connections Cloud IBM Knowledge Center Microsoft Office 365 Azure app registrations Google Google Console LinkedIn LinkedIn Facebook Facebook developer centre"},{"location":"boards/swarm/prerequisites/#dockerhub-deprecated","title":"Dockerhub (Deprecated)","text":"Access to the images for Boards is provided through dockerhub. Please provide us with your username to grant access and have the credentials at hand for the install.
"},{"location":"boards/swarm/prerequisites/#ansible","title":"Ansible","text":"We use Red Hat Ansible to script the installs. Please ensure this is installed as per our guide prior to the swarm / boards install
"},{"location":"boards/troubleshooting/activities-plus-install/","title":"Activities Plus Install FAQ","text":"If you are following the HCL install documentation, these notes need to be applied during the relevant sections. We recommend using our install documentation instead.
There are also some more notes and insights from one of our partners which is a great read.
"},{"location":"boards/troubleshooting/activities-plus-install/#installing-activities-plus-services","title":"Installing Activities Plus services","text":"If you do not have them enabled, you will need to enable the following modules by uncommenting them (remove the '#'):
LoadModule proxy_module modules/mod_proxy.so\nLoadModule proxy_connect_module modules/mod_proxy_connect.so\nLoadModule proxy_ftp_module modules/mod_proxy_ftp.so\nLoadModule proxy_http_module modules/mod_proxy_http.so\n\nLoadModule rewrite_module modules/mod_rewrite.so\nIf you have not specified earlier (such as during other component-pack app installs), please set ProxyPreserveHost On before the Huddo Boards section in the VirtualHost
The helm upgrade command needs to be run from the directory containing boards-cp.yaml and the correct command is:
helm upgrade kudos-boards-cp-activity-migration path_to_helm_charts/kudos-boards-cp-activity-migration-1.0.0-20191120-214007.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\ne.g.
helm upgrade kudos-boards-cp-activity-migration /root/microservices_connections/hybridcloud/helmbuilds/kudos-boards-cp-activity-migration-1.0.0-20191120-214007.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\nWhen (re)deploying the Boards CP Chart you may see this warning:
W0612 09:17:16.153629 21276 warnings.go:70] spec.template.spec.containers[0].env[2].name: duplicate name \"MONGO_HOST\"\nThis is an expected behaviour. Connections 8 added a new hostname for Mongo v5. Our v1.1.0 helm chart uses this in addition to the old hostname to maintain backwards compatibility. This warning can be safely ignored.
"},{"location":"boards/troubleshooting/activity-migration/","title":"Activity Migration","text":""},{"location":"boards/troubleshooting/activity-migration/#pod-will-not-start-port-in-use","title":"Pod will not start - Port in use","text":"Sometimes the pod fails to start with an error listen EACCES: permission denied. For example:
checkActitiviesFileStore: found valid content store\ncheckOrg: Found 1 OrgId: [ 'a' ]\ncheckTenant: Found 1 Tenant: [ '00000000-0000-0000-0000-040508202233' ]\nPlease open the UI at 'https://company.example.com/boards/admin/migration' or set env.IMMEDIATELY_PROCESS_ALL='true' to migrate all of your Activities without UI\nevents.js:377\nthrow er; // Unhandled 'error' event\n^\nError: listen EACCES: permission denied tcp://10.100.200.104:2641\nat Server.setupListenHandle [as _listen2] (net.js:1314:21)\nat listenInCluster (net.js:1379:12)\nat Server.listen (net.js:1476:5)\nat listen (/usr/src/app/dist/index.js:62:10)\nat /usr/src/app/dist/index.js:106:3\nat processTicksAndRejections (internal/process/task_queues.js:95:5)\nEmitted 'error' event on Server instance at:\nat emitErrorNT (net.js:1358:8)\nat processTicksAndRejections (internal/process/task_queues.js:82:21) {\ncode: 'EACCES',\nerrno: -13,\nsyscall: 'listen',\naddress: 'tcp://10.240.27.7:2641',\nport: -1\n}\nerror Command failed with exit code 1.\ninfo Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.\nThis is because the port is already in use. We must change the default port which
"},{"location":"boards/troubleshooting/activity-migration/#resolution","title":"Resolution","text":"Open your Boards yaml file
Set the new port as per below (merging into existing)
global:\n env:\n ACTIVITY_MIGRATION_PORT: '2651'\n\nmigration:\n balancer:\n port: 2651\n targetPort: 2651\nRedeploy both the Boards helm chart and the Activity Migration charts with the updated yaml
Confirm the pod start successfully or change to another random higher port if conflicts still occur.
This process will find and fix cards with long descriptions which were not imported correctly due to an incorrect HTTP 404 response from the HCL Connections API
Note: this requires Boards images with date tags on or after 2021-03-22
"},{"location":"boards/troubleshooting/activity-migration/#process-overview","title":"Process Overview","text":"This service will:
/downloadExtended/ in the URL)Note: any changes made to the description (rich text area) by users since the migration will be over-written by the loaded content. If there are any cards which you want to keep the existing, simply delete the link to \"Long Description\" before running this process.
"},{"location":"boards/troubleshooting/activity-migration/#steps","title":"Steps","text":"Add the volume, volume mount & FILE_PATH_ACTIVITIES_CONTENT_STORE to the boards yaml config. For example:
migration:\n # configure access to the Connections Shared mount\n sharedDrive:\n # Replace with IP address for the NFS server\n server: 192.168.10.56\n # for example \"/opt/HCL/Connections/data/shared\" or \"/nfs/data/shared\"\n path: /nfs/data/shared\n env:\n # the extension after /data can be found from the WebSphere ACTIVITIES_CONTENT_DIR variable\n FILE_PATH_ACTIVITIES_CONTENT_STORE: /data/activities/content\nReplace the sharedDrive.server IP and the sharedDrive.path to the shared drive (e.g. /nfs/data/shared or /opt/HCL/data/shared etc)
When migrating very large activities sometimes you may encounter an OutOfMemory error.
"},{"location":"boards/troubleshooting/activity-migration/#resolution_1","title":"Resolution","text":"In the migration YAML chart you can set following to reduce the amount of concurrent data accessed in memory:
migration.env.PROCESSING_PAGE_SIZE: 1\nmigration.env.FIELDS_PAGE_SIZE: 1\nOnce these values are set you need to deploy the chart again to make them take effect.
You will also need to increase the amount of memory available to NodeJS by adding the environment variables in the migration YAML:
resources.requests.memory: 2024M\nresources.limits.memory: 8192M\nenv.NODE_OPTIONS: \"--max-old-space-size=8192\"\nIf the migration service crashes while migrating an activity some activiites can be in a 'stuck' state where they cannot be tasked to be migrated again. In the migration YAML chart you can set PURGE_INCOMPLETE to remove the flags.
migration.env.PURGE_INCOMPLETE: \"true\"\nYou are also able to delete already migrated activities by setting PURGE_MIGRATED_ACTIVITY_IDS so they can be migrated again.
migration.env.PURGE_MIGRATED_ACTIVITY_IDS: \"acitivityId,activityId2,activityId3,...,activityIdN\"\nOnce these values are set you need to deploy the chart again to make them take effect. Please be aware to remove the \"PURGE_MIGRATED_ACTIVITY_IDS\" after it is done or any subsequent deployments/restarts will delete them again!
"},{"location":"boards/troubleshooting/aplus-auth/","title":"Aplus auth","text":""},{"location":"boards/troubleshooting/aplus-auth/#testing-an-oauth2-connections-configuration","title":"Testing an oauth2 connections configuration","text":"The steps below will test a Huddo Boards / Activities Plus oauth setup.
We will prepare a request in an api testing tool, then get a response code from connections and finally use that code in the prepared response to get an auth token. It is important to do in this order as the code is only valid for a minute.
"},{"location":"boards/troubleshooting/aplus-auth/#block-requests-to-boards","title":"Block requests to boards","text":"Update WAS httpd.conf
change ProxyPass and ProxyPassReverse entries for /boards to use a different (invalid) port number.
Method: POST
Request URL: https://(connections url)/oauth2/endpoint/connectionsProvider/token
On the Body tab, select x-www-form-urlencoded and fill in the following:
replace connections url in both places below
https://(connections url)/oauth2/endpoint/connectionsProvider/authorize?client_id=huddoboards&redirect_uri=https%3A%2F%2F(connections url)%2Fapi-boards%2Fauth%2Fconnections%2Fcallback&response_type=code&state=1234\nThe loaded page should error, that is expected.
"},{"location":"boards/troubleshooting/aplus-auth/#copy-code-from-redirected-url","title":"Copy code from redirected url","text":""},{"location":"boards/troubleshooting/aplus-auth/#paste-the-code-into-postman-and-hit-send-you-should-get-a-response-as-below","title":"Paste the code into postman and hit Send, you should get a response as below:","text":"{\n \"access_token\": \"s67MkH8LYMMKiP0q2gtVKQxkD0gBcXJJlSCdvQw3\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 43199,\n \"scope\": \"\",\n \"refresh_token\": \"EcO9hDYdU3tL2BE0xRSPNlYIGvZhYV9yezb14YKNglkFPwq4St\"\n}\nOpen a new tab in postman and update:
Method: GET
Request URL: https://(connections url)/connections/opensocial/oauth/rest/people/@me/@self
Authorization Tab
TYPE: Bearer Token
Token: (Paste in the access_token from the previous request)
Hit Send, You should get a json response describing your profile.
"},{"location":"boards/troubleshooting/aplus-auth/#reset-was-httpdconf","title":"Reset WAS httpd.conf","text":"Make sure to put the port numbers back to their original values.
"},{"location":"boards/troubleshooting/conn-hybrid/","title":"Huddo Boards Hybrid","text":""},{"location":"boards/troubleshooting/conn-hybrid/#authentication","title":"Authentication","text":""},{"location":"boards/troubleshooting/conn-hybrid/#logging-in-doesnt-work","title":"Logging-in doesn't work","text":"Please revoke your OAuth access to Huddo Boards Cloud within HCL Connections. Go to https://<YOUR_CONNECTIONS_URL>/connections/oauth/apps (replacing <YOUR_CONNECTIONS_URL>) and press 'Revoke'
Please revoke your OAuth access to Huddo Boards Cloud within HCL Connections. Go to https://<YOUR_CONNECTIONS_URL>/connections/oauth/apps (replacing <YOUR_CONNECTIONS_URL>) and press 'Revoke'
To check the version of the ingress controller run this command
kubectl get pods --all-namespaces | grep ingress-controller\nkubectl exec -it <POD_NAME> -n <NAMESPACE> -- /nginx-ingress-controller --version\nwhere
<POD_NAME> is the name of the Ingress controller pod<NAMESPACE> is the namespace of the Ingress controller pod. e.g. kube-system or connectionsFor example
kubectl get pods --all-namespaces | grep ingress\nkubectl exec -it nginx-ingress-controller-84d4dfc9b-7gv4m -n kube-system -- /nginx-ingress-controller --version\nExample
-------------------------------------------------------------------------------\nNGINX Ingress controller\n Release: 0.23.0\n Build: git-be1329b22\n Repository: https://github.com/kubernetes/ingress-nginx\n-------------------------------------------------------------------------------\nAs of 0.22.0 the Ingress controller rewrite-target definition changed. If Boards is installed at a context root, the format must include a regular expression which is now set as the default as of the helm chart v2.0.1. We recommend using the latest huddo-boards-cp-1.2.0.tgz which includes all required annotations (including socket.io cookie fix).
If you have an older Ingress controller version (i.e. 0.20) you will need to apply the following customisations to fix the ingress with charts as of v2.0.1
webfront:\n ingress:\n path: /boards\n annotations:\n nginx.ingress.kubernetes.io/rewrite-target: /\n\ncore:\n ingress:\n path: /api-boards\n annotations:\n nginx.ingress.kubernetes.io/rewrite-target: /\n nginx.ingress.kubernetes.io/session-cookie-path: /api-boards; Secure\n nginx.ingress.kubernetes.io/affinity: cookie\n nginx.ingress.kubernetes.io/proxy-body-size: 50m\n nginx.ingress.kubernetes.io/proxy-read-timeout: \"3600\"\n nginx.ingress.kubernetes.io/proxy-send-timeout: \"3600\"\nIf you wish to deploy boards at a path other than /boards & /api-boards please see this example file of all the variables to merge into your YAML config file.
Note: If you are using an older version of the Ingress controller (< 0.22) you will need to use example above
Note: please see this example again if you encounter the error
Ignoring ingress because of error while validating ingress class\" ingress=\"connections/kudos-boards-cp-webfront\" error=\"ingress does not contain a valid IngressClass\"\nSome deployments may encounter an issue where you are unable to see any real time updates. If this is the case, it is likely that the socket is unable to connect or authenticate. Please update to the latest Boards helm chart which includes annotations for increased browser cookie security requirements.
Note: if you have a core.annotations section in your yaml configuration our updates will be overwritten. Custom annotations should only be required when customizing the context root as per above. Please remove the annotations section otherwise.
If you are using WebSphere IHS as your reverse proxy in front of Boards, please set the following environment variables to force polling instead of sockets
webfront:\n env:\n FORCE_POLLING: true\nIf the Minio service fails to start with the following error:
ERROR Unable to initialize backend: found backend fs, expected xl\nPlease update to kudos-boards-cp-3.1.4.tgz which includes a different image of Minio which supports your existing 'fs' file system.
"},{"location":"boards/troubleshooting/docker/#react-minified-issue","title":"React Minified Issue","text":"This has been successfully fixed in all reported cases by clearing the local storage of the user's browser. There is also a change to handle this better in this release
"},{"location":"boards/troubleshooting/docker/#itm-render-issue","title":"ITM Render Issue","text":"Connections 8 CR1/2 changes how the ITM bar is displayed. This causes an issue in Boards where is loads to the left and not the right.
You can add this to your custom css in the header/customiser (which is then injected into Boards).
.gt-sm.cnx8-ui.itm-bar-open .itm-section {\n position: absolute;\n right: 0;\n}\nYou may need to connect to Mongo for validation or other changes. To connect to Kubernetes Mongo:
In Component Pack
kubectl exec -it mongo-0 -c mongo -n connections -- mongo --ssl --sslPEMKeyFile /etc/mongodb/x509/user_admin.pem --sslCAFile /etc/mongodb/x509/mongo-CA-cert.crt --host mongo-0.mongo.connections.svc.cluster.local --authenticationMechanism=MONGODB-X509 --authenticationDatabase '$external' -u C=IE,ST=Ireland,L=Dublin,O=IBM,OU=Connections-Middleware-Clients,CN=admin,emailAddress=admin@mongodb\n\n# CP Mongo5\nkubectl exec -it mongo5-0 -c mongo5 -n connections -- mongosh --tls --tlsCertificateKeyFile /etc/ca/user_admin.pem --tlsCAFile /etc/ca/internal-ca-chain.cert.pem --host mongo5-0.mongo5.connections.svc.cluster.local --authenticationMechanism=MONGODB-X509 --authenticationDatabase '$external' -u C=IE,ST=Ireland,L=Dublin,O=IBM,OU=Connections-Middleware-Clients,CN=admin,emailAddress=admin@mongodb\nStandalone deployment
get the name of the mongo pod
kubectl get pods --all-namespaces\n\nNAMESPACE \u00a0 \u00a0 NAME \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 READY \u00a0 STATUS \u00a0 \u00a0RESTARTS \u00a0 AGE\nboards \u00a0 \u00a0 \u00a0 \u00a0mongo-67696548c-xpdqh \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a01/1 \u00a0 \u00a0 Running \u00a0 0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a035s\nexec into the pod using the mongosh (or mongo) command - replacing pod name and namespace
kubectl exec -it mongo-67696548c-xpdqh -n boards -- mongosh --host mongo-service:27017\ncheck the database names
show dbs\nopen the db containing board nodes (select as appropriate)
# CP\nuse boards-app\n\n# Standalone\nuse kudos-boards-service\nfind all boards
db.nodes.find({ type: 'board' })\nfind a board from a particular activitity
db.nodes.find({ providerID: 'activities-id-goes-here' })\nfind the members for a particular board
db.boardmembers.find({ board: ObjectId(\"_id-of-board-found-above\") })\nopen the db containing users (select as appropriate)
# CP\nuse boards-user\n\n# Standalone\nuse kudos-user-service\nfind the users in question, e.g Andrew & Nicky
db.users.find({ name: \"Andrew Welch\" })\n{ \"_id\" : ObjectId(\"617891eae72f26802c4bec5e\"), \"email\" : \"awelch@isw.net.au\", ....\n\ndb.users.find({ name: \"Nicky Tope\" })\n{ \"_id\" : ObjectId(\"617891ed660876da990253b7\"), \"email\": \"ntope@isw.net.au\", .....\nswitch to the boards app
find the members for a particular board (substitute the ID)
db.boardmembers.find({ board: ObjectId(\"<BOARD_ID>\") })\nreplace user A with user B, e.g. Andrew with Nicky
db.boardmembers.updateOne({ board: ObjectId(\"<BOARD_ID>\"), 'entity.kind': 'User', 'entity.id': '617891eae72f26802c4bec5e' }, { $set: { 'entity.id': '617891ed660876da990253b7' }})\nNginx has strict rules around the headers allowed on requests. If you encounter a 400 Bad Request response in your environment when accessing /boards it is likely caused by incorrect headers set in the upsteam proxy(s) before Boards.
To debug the cause, please views the logs for the webfront pods (as of build 20210924). You will see logs like:
setting core: https://devconn7.internal.isw.net.au/api-boards\n setting buildId: 198\n setting product info url: https://huddo.com/boards\n setting force polling: true\n setting html base: /boards\n 2021/09/24 01:10:49 [notice] 1#1: using the \"epoll\" event method\n 2021/09/24 01:10:49 [notice] 1#1: nginx/1.21.3\n 2021/09/24 01:10:49 [notice] 1#1: built by gcc 10.3.1 20210424 (Alpine 10.3.1_git20210424)\n 2021/09/24 01:10:49 [notice] 1#1: OS: Linux 3.10.0-1160.15.2.el7.x86_64\n 2021/09/24 01:10:49 [notice] 1#1: getrlimit(RLIMIT_NOFILE): 1048576:1048576\n 2021/09/24 01:10:49 [notice] 1#1: start worker processes\n 2021/09/24 01:10:49 [notice] 1#1: start worker process 20\n 2021/09/24 01:10:49 [notice] 1#1: start worker process 21\n 2021/09/24 01:10:49 [notice] 1#1: start worker process 22\n 2021/09/24 01:10:49 [notice] 1#1: start worker process 23\n 2021/09/24 01:15:37 [info] 20#20: *1 client 10.244.115.83 closed keepalive connection\n 2021/09/24 01:15:38 [info] 31#31: *118 client sent invalid host header while reading client request headers, client: 172.20.0.1, server: boards.company.com, request: \"GET / HTTP/1.1\", host: \"boards.company.com, boards.company.com\"\nIn this example, the client sent invalid host header while reading client request headers. You can see the host is included twice. This can occur if the host is set twice, or in some instances when the X-Forwarded-Host is also set.
Please read this error carefully and make sure your environment complies with the latest NGINX specification.
"},{"location":"boards/troubleshooting/notifications/","title":"Troubleshooting Huddo Boards Notifications","text":""},{"location":"boards/troubleshooting/notifications/#huddo-boards-docker","title":"Huddo Boards Docker","text":"If notifications are not sending, please ensure that the core and notifications pod can talk to each other
kubectl exec -n connections -it (boards core pod) -- sh\nenv | grep NOTIFI\nvi src/test.js (content below)\nnode src/test.js\nContent for test.js:
const fetch = require('node-fetch');\nfetch(process.env.NOTIFICATION_HOST+':'+process.env.NOTIFICATION_PORT+'/health').then(console.log).catch(console.log);\nIf 200 status:
bash kubectl delete pod -n boards (core pod1) kubectl delete pod -n boards (core pod2)
If a user is unable to login to Huddo, especially after it working previously and they get an Error 500 there may be too many tokens in the OAuth table in Connections for them. To resolve this, check if this is the case by shorting the oh2p_cache table for 250 entries for the user.
SELECT count(lookupkey) FROM homepage.oh2p_cache WHERE username ='<username>' AND clientid='<huddo_client_id>'\nClearing the oh2p cache allows the user to login again.
DELETE from homepage.oh2p_cache where username='<username>' and clientid='<huddo_client_id>'\nPlease Note: You need to replace <username> and <huddo_client_id> with the correct values
For more details, please see a blog post here.
"},{"location":"boards/troubleshooting/safari/","title":"Safari","text":""},{"location":"boards/troubleshooting/safari/#hcl-connections-community-widget","title":"HCL Connections Community Widget","text":"There is a limitation imposed by Apple which stops the Huddo Boards Community Widget from getting users cookies and therefore is stopping Authentication between Huddo Boards Cloud and HCL Connections.
The only solution is to disable the \"Prevent cross-site tracking\" option on the user's computer under Safari => Preferences => Privacy.
"},{"location":"boards/troubleshooting/websphere/","title":"Boards for HCL Connections in WebSphere (Legacy)","text":"Issue Resolution JMS Topic not initialised Please check that the cluster Huddo Boards is installed on has the messaging bus/engine set. Cannot enter Activity Stream Credentials Please ensure that the user that you are entering can log into Connections and view the homepage activity stream. Unable to Retrieve Members This error can appear if you are logged into more than one environment at the same time, such as a TEST and PROD server. Please open the environment that Huddo Boards is installed into in a clean browser without any existing cookies or sessions. This can be easily achieved by using incognito/private mode.All membership functionality is provided by the IBM SBT so please ensure this is setup correctly, as well as making sure the Activities application is started."},{"location":"boards/troubleshooting/office365/","title":"Boards in Microsoft Office 365 for Business","text":""},{"location":"boards/troubleshooting/office365/#microsoft-teams","title":"Microsoft Teams","text":""},{"location":"boards/troubleshooting/office365/#administrator-approval-required-to-add-huddo-boards-as-a-teams-tab","title":"Administrator approval required to add Huddo Boards as a Teams Tab","text":"You may find that as a non-administrator Office 365 user, you cannot add Huddo Boards as a Teams Tab. In this case, after signing in to Huddo Boards in the tab configuration dialog view, the view will look like the screenshot below and all actions will be disabled.
Note that Huddo Boards can still be used as a Microsoft Teams personal app whilst in this state
"},{"location":"boards/troubleshooting/office365/#resolution","title":"Resolution","text":"A user that has administrative capabilities within your Microsoft Office 365 organisation will need to sign in to Huddo Boards (either inside the Microsoft Teams configuration view or by going directly to boards.huddo.com). They will then be presented with the following prompt:
After clicking Approve, the administrator will be directed to an approval screen that will allow them to accept all of the required permissions that Huddo Boards requires, on behalf of the entire organisation:
Once these permissions have been accepted on behalf of the organisation, all users in the organisation will now be able to add Huddo Boards as a Microsoft Teams Tab.
"},{"location":"boards/troubleshooting/office365/#force-administrative-approval-for-organisation","title":"Force Administrative Approval for Organisation","text":"Administrative users for your Office 365 organisation can also force an approval of all permissions for the organisation from within the Org Administration screen by following these steps:
Access the Configuration Page and click through your Office 365 client under 'Authentication Clients'.
Click the Approve Advanced Features button:
This will direct you to the Microsoft Office 365 Permissions requested - Accept for your organisation page, allowing you to force the consent of all permissions that Huddo Boards needs for your organisation:
"},{"location":"boards/troubleshooting/office365/#huddo-boards-app-not-showing-in-teams-store","title":"Huddo Boards App not showing in Teams store","text":"If you search for Huddo Boards but you cannot see it in the Teams Store, it is likely that third-party apps are blocked in your tenant.
"},{"location":"boards/troubleshooting/office365/#resolution_1","title":"Resolution","text":"You will need to go to the Admin Dashboard to view the settings.
Under 'Third-party apps' you can see the settings for your tenant. Here you can set your users to be able to access Huddo Boards through the Teams Store.
"},{"location":"boards/verse/verse-extension/","title":"HCL Verse","text":""},{"location":"boards/verse/verse-extension/#installation-in-verse-on-premise","title":"Installation in Verse On Premise","text":"verse/application.json file.verse/application.json as plain text to confirm the \"url\" fields contain the URL for your Boards deployment.This documentation has been copied in below.
"},{"location":"boards/verse/verse-extension/#deploying-extensions-using-the-built-in-endpoint","title":"Deploying extensions using the built-in endpoint","text":"Verse On-Premises implemented a built-in endpoint to serve the application\u2019s JSON data from a local file or an HTTP hosted file. If storing the applications JSON data as a static file works for you, this is the way to go.
Two data providers are implemented in the built-in endpoint:
Local file data provider: Serves the applications JSON data from a local file on the Domino server. This allows you to deploy extensions without dependency on another server. The path of the file can be specified using a notes.ini parameter VOP_Extensibility_Applications_Json_FilePath.
HTTP data provider: Serves the applications JSON data from an HTTP hosted file. This allows you to deploy applications.json to a centralized HTTP server. The HTTP URL of the file can be specified using notes.ini parameter VOP_Extensibility_Applications_Json_URL.
The notes.ini parameter VOP_Extensibility_Data_Provider_Name controls which data provider to use, either localFileProvider or httpDataProvider. By default, if none is specified, localFileProvider will be used. In either case, the data provider will periodically check the source applications.json file for updates, so you don\u2019t have to restart the server after a new version of applications.json is deployed.
To use the local file data provider:
Make sure notes.ini parameter VOP_Extensibility_Data_Provider_Name is either clear or set to localFileProvider.
Deploy applications.json to the Domino server.
Make sure notes.ini parameter VOP_Extensibility_Applications_Json_FilePath is set to the file path of applications.json. For example:
VOP_Extensibility_Applications_Json_FilePath=D:\\data\\applications.json\nTo use the HTTP data provider:
Make sure notes.ini parameter VOP_Extensibility_Data_Provider_Name is set to httpDataProvider.
VOP_Extensibility_Data_Provider_Name=httpDataProvider\nDeploy applications.json to the HTTP server.
Make sure notes.ini parameter VOP_Extensibility_Applications_Json_URL is set to the HTTP URL of applications.json. For example:
VOP_Extensibility_Applications_Json_URL=https://files.renovations.com/vop/applications.json\nThis document describes the file structure used when either migrating to the file system, or exporting metadata during migration to Connections Files.
"},{"location":"ccm-migrator/export-fs/#rationale","title":"Rationale","text":"There's a fair chance of files in different CCM libraries and/or folders having the same file name. CCM files exported to the OS file system are therefore placed in separate directories if they came from different libraries and/or folders, to minimise the chance of filename conflicts.
The export process must create additional files to record metadata which isn't contained in the CCM files themselves. Examples of metadata are tags, comments, names of file owners, and create/update timestamps. Other files are also required for versions.
Metadata and version files must all be named in a way that unambiguously identifies the files to which they relate, but there's a chance that any of these extra files could conflict with other filenames from the same CCM folder. We create a separate file-system directory for each CCM file to contain metadata related to that file, with the directory name having \".meta\" appended to the filename, and we also put all metadata directories and files in a top-level directory separate to the current-version files. This removes any chance of metadata filenames conflicting with CCM filenames, and the \".meta\" suffix on the directory name should minimise the chance of a directory-name conflict.
"},{"location":"ccm-migrator/export-fs/#directory-structure","title":"Directory structure","text":"When migrating to the file system, all folders in a library and the current version of all files are placed in a directory structure like the following: <Community Name>/files/<Library Name>/<Folder>/<Subfolder>
When either migrating to the file system, or exporting metadata during a migration to Connections Files, metadata files and folders will be placed in a directory structure like the following: <Community Name>/metadata/<Library Name>/<Folder>/<Subfolder>
The metadata location is also used to export most file versions excluding the current version, when migrating to the file system.
In both cases above, <Subfolder> may be repeated for as many subfolder levels as were present in CCM.
Within the metadata structure, there will be:
Versions of a CCM file have version numbers in their filename. Version numbers will be exactly as reported by CCM, which typically uses a major/minor decimal format like \"1.0\".
The filename format for versions will be: <Original filename>_v<version number><extension>
"},{"location":"ccm-migrator/export-fs/#example","title":"Example:","text":"If the current version is Proposal.docx, then version 1 (superseded) will be Proposal_v1.0.docx in the Proposal.docx.meta subdirectory.
"},{"location":"ccm-migrator/export-fs/#user-access","title":"User access","text":"Files named members.csv list members (user access) for each community, library, folder, and file.
These files will be formatted as comma-separated values with one record (user/group) per line, with five fields per record. The fields will be:
The users/groups listed in members.csv will be those with explicit access, plus some special user names as follows:
The metadata directory for each CCM file (directory name ending with \".meta\") contains files named comments.csv and meta.csv. Directories representing CCM folders within the metadata structure will also contain a meta.csv file.
comments.csv contains all comments for the file. Comma-separated fields for each comment are:
meta.csv contains any metadata which isn't comments or members. Comma-separated fields for each line are:
CSV files created by CCM Migrator conform to Microsoft Excel's CSV format, with details as follows:
This is a brief list of the features we have implemented or plan to implement in the future.
If you want to know more you're very welcome to open an issue on GitHub or contact your favourite Huddo team member.
Name Status Community browser/picker \u2705 Migrate Library to Community Files \u2705 Migrate Multiple Libraries to Community Files \u2705 Migrate Library in to Files Folder \u2705 Pre-migration information (Test Mode) \u2705 Auto conflicting file rename \u2705 Auto invalid character replacement \u2705 Migration history log \u2705 Detailed migration logging \u2705 Migration roll-back by community \u2705 Migrate between two Connections environments \u2705 Export CCM data to file system \u2705 Migrate library to sub-community files \u2705 Export data for URL redirection \u2705"},{"location":"ccm-migrator/install/","title":"Installation","text":"Log into the WebSphere Integrated Solutions Console (ISC) for your HCL Connections Environment.
"},{"location":"ccm-migrator/install/#gathering-required-information","title":"Gathering required information","text":"Before starting installation, it's required to know the \"JNDI name\" for a JDBC data source for the Filenet Object Store database. If you already know this, proceed to Installing the Application for the first time, otherwise review the following.
In the ISC, navigate to Resources \\ JDBC \\ Data sources.
Determine which data source relates to the Filenet Object Store database, and note the JNDI name for that data source. The image below shows an example where the data source name and JNDI name are \"FNOSDS\", but it may be different in your environment.
If you're not sure which is the correct data source, check the details of each data source as follows:
If you can't determine the correct JNDI name, the only impact is that CCM Migrator will be unable to migrate file follows, but the installation process requires a JNDI name to be entered regardless.
"},{"location":"ccm-migrator/install/#installing-the-application-for-the-first-time","title":"Installing the Application for the first time","text":"In the ISC, navigate to Applications \\ Application Types \\ WebSphere enterprise applications and click \"Install\".
Locate the \"isw-connections-ccm.ear\" file on your local file system and click \"Next\".
Select \"Fast Path\" and click \"Next\".
Step 1: Leave the default values, update the Application Name if required, and click \"Next\".
Step 2: Map the module to a single application server or cluster, and at least one web server, then click \"Next\". Our example uses \"UtilCluster\" and \"WebServer1\", but these names may be different in your environment.
Note that after installation and before first use, the application requires users to specify a server file-system location for storing log files. If the application is mapped to a cluster, it's best if the cluster only has one server or the file-system location is synchronized between all servers in the cluster, to ensure that the log files are up to date regardless of which server the application runs on.
Step 3: Enter the JNDI name for the Filenet Object Store database, which you should have obtained as described under Gathering required information.
Step 4: Leave the default values and click \"Next\".
Step 5: Check summary and Complete installation.
Save the master configuration once complete.
"},{"location":"ccm-migrator/install/#updating-the-web-server-plug-in","title":"Updating the Web Server Plug-in","text":"The procedure in this section may or may not be required depending on the configuration of your Connections environment.
In the ISC, navigate to Servers \\ Server types \\ Web servers.
Select the web server, and click \"Generate Plug-in\". (If your environment has multiple web servers, you should be able to select them all for this step.)
When the above step completes, select the web server again, and click \"Propagate Plug-in\". (If your environment has multiple web servers, you should be able to select them all for this step.)
"},{"location":"ccm-migrator/install/#configuring-the-application","title":"Configuring the Application","text":""},{"location":"ccm-migrator/install/#licence-key","title":"Licence Key","text":"Without a licence applied, the application can only be used in test mode, where files and folders are reported but not actually migrated.
When requesting a licence you will need to supply:
After receiving your key, you will need to create name space bindings for CCM Migrator using the exact values provided by the Huddo team. Please ensure you use the exact case and spelling for the name space bindings as stated below. All licensed installs require iswCCMLicenceKey. Limited licences also require iswCCMLicenceCommunities.
iswCCMLicenceKey Licence key stringe.g. A+gAAACsrdTGobh6+PNOTAREALKEYjpVT/6AgMY4SxyOM2ZQ iswCCMLicenceCommunities Comma delimited list of community ids without white spacee.g. 4f4847e3-fdda-4da4-a1b7-2829111a694b,4f4847e3-fdda-4da4-a1b7-2829111a694c,4f4847e3-fdda-4da4-a1b7-2829111a694d You may follow the steps below for how to create name space bindings.
In the ISC, navigate to Environment \\ Naming \\ Name space bindings.
Select the \"Cell\" scope, then click \"New\".
Set the binding type to \"String\", then click \"Next\".
Set both the \"Binding identifier\" and \"Name in name space\" fields to \"iswCCMLicenceKey\". Enter your licence key in the \"String value\" field.
Click \"Next\", then click \"Finish\", then save the master configuration. Repeat these steps for iswCCMLicenceCommunities.
In the ISC, navigate to Applications \\ Application Types \\ WebSphere enterprise applications, and click the \"isw-connections-ccm\" application in the list.
Navigate to Configuration \\ Detail Properties \\ Security role to user/group mapping.
Select the \"AdminUsers\" role and Map users/groups per your requirements. It is suggested that only one or a small number of users are given access to this application.
Click \"OK\" and save the changes to the configuration.
Start the application by checking the select box for it from the list and clicking \"Start\".
"},{"location":"ccm-migrator/supported-data/","title":"Data Supported in Migrations","text":"This document is intended to be a comprehensive list of every piece of metadata in CCM that CCM Migrator can extract and whether is is supported when migrating to Connections Community Files or to a Filesystem.
If you want to know more, something is missing or if something has been completed, you're very welcome to open an issue on GitHub or contact your favorite Huddo team member.
CCM Data Connections Community Files Filesystem File Data \u2705 \u2705 File Name \u2705 \u2705 Folders \u2705 \u2705 Versions \u2705 \u2705 Version Filenames \u2705 \u2705 Drafts \u2705 \u2705 Tags \u2705 \u2705 Description \u2705 \u2705 Comments \u2705 \u2705 Comment Related Version \u2705 \u2705 Total Likes \u2705 \u2705 Liked by \u2705 \u274c Follows \u2705 \u274c Created by \u2705 \u2705 Created date \u2705 \u2705 Updated by \u2705 \u2705 Updated date \u2705 \u2705 Custom Metadata \ud83d\uddc3 \u2705 Document Types \ud83d\uddc3 \u2705 Total Downloads \u274c \u2705 Downloaded by \u274c \u274c Library/Folder/File permissions \u274c \u2705 Approval workflow state \u274c \u274c\ud83d\uddc3 - Exported to file system
"},{"location":"ccm-migrator/update/","title":"Update","text":""},{"location":"ccm-migrator/update/#updating-the-application","title":"Updating the Application","text":"This part of the documentation only applies if you have been provided with a new version of the application for the purpose of fixing bugs or adding features.
Log into the ISC for your HCL Connections environment.
If you're updating from a version of CCM Migrator which can't migrate file follows (before 8 July 2022) to a version which can migrate file follows, the update process requires some extra information. This is described under Gathering required information at the top of the installation document.
Navigate to Applications \\ Application Types \\ WebSphere enterprise applications.
Select the \"isw-connections-ccm\" application from the list, and click \"Update\".
Using the default option (\"Replace the entire application\"), select the new \"isw-connections-ccm.ear\" file, and click \"Next\".
Click \"Next\" at the bottom of most subsequent screens, leaving all options at the default, except that you may need to enter the JNDI name for the Filenet Object Store database at \"Step 3: Map resource environment references to resources\".
Click \"Finish\" upon reaching the \"Summary\" stage. This may be labelled as \"Step 3\" or \"Step 4\" depending on whether you needed to enter a JNDI name as above.
After clicking \"Finish\", there will be some delay while the next screen fills in. Click the \"Save\" link when it appears.
Depending on your WebSphere configuration, the nodes may synchronize immediately or there may be some delay (typically up to 1 minute) while they synchronize in the background. Changes to the application only take effect after nodes have synchronized.
After updating the application and synchronizing nodes, and before using the application again, any users of the application should clear their web browser cache to ensure that changes to client-side files take effect. It is only necessary to clear the cache or \"temporary internet files\". Clearing cookies or logins is unnecessary.
"},{"location":"ccm-migrator/update/#updating-the-licence","title":"Updating the Licence","text":"After receiving your new key, you will need to update the name space bindings for CCM Migrator using the exact values provided by the Huddo team. Please ensure you use the exact case and spelling for the name space bindings as stated below. All licensed installs require iswCCMLicenceKey. Limited licences also require iswCCMLicenceCommunities.
iswCCMLicenceKey Licence key stringe.g. A+gAAACsrdTGobh6+PNOTAREALKEYjpVT/6AgMY4SxyOM2ZQ iswCCMLicenceCommunities Comma delimited list of community ids without white spacee.g. 4f4847e3-fdda-4da4-a1b7-2829111a694b,4f4847e3-fdda-4da4-a1b7-2829111a694c,4f4847e3-fdda-4da4-a1b7-2829111a694d You may follow the steps below for how to update name space bindings.
In the ISC, navigate to Environment \\ Naming \\ Name space bindings.
Select the iswCCMLicenceKey binding.
Update the \"String\" with the new value, then click \"OK\".
Then save the master configuration. Repeat these steps for iswCCMLicenceCommunities if this also needs to be updated.
The application can be accessed from your HCL Connections site using a URL like {connections domain}/isw-connections-ccm/, where {connections domain} is the protocol and domain name of your Connections site.
On first use, the application loads on its \"API Settings\" page, and requires settings to be confirmed before it can be used. Most settings have sensible defaults, but some may need to be changed depending on your environment and on how you intend to use the application. Particularly note:
Other API Settings are described below, but should never need to be changed for normal operation:
Once the settings are confirmed by clicking \"Confirm Settings\" at the bottom of the page, the \"Home\" page will load. The application saves all settings in the web browser's local storage, so it will remember settings and will load the \"Home\" page by default on all subsequent use in the same browser, unless local storage is cleared.
"},{"location":"ccm-migrator/usage/#analysis-and-migration","title":"Analysis and Migration","text":"On first use before migrating, it's necessary to perform an analysis to build a list of communities. Click \"Analyze Communities\" to do this.
By default, analysis retrieves the following information for each community:
With this default behaviour, analysis running time is proportional to the number of communities in your environment. As a rough guide to performance, analysis in an ISW test environment with 270 communities takes about 20 seconds.
The left-hand pane of the \"Home\" page contains several options under the heading \"Migration Settings\". Most of these options only apply to migration, but the option \"Analysis reads library size\" applies to analysis and causes it to also retrieve and display the total size of CCM Libraries in each community. Note this is very slow as it's greatly affected by the number of folders and files in all CCM Libraries. For example in the ISW test environment where analysis takes 20 seconds without this option, it takes about 5 minutes with this option, for a total of about 8000 files.
Once analysis is complete, the list of Communities will be displayed. This includes filtering that defaults to show only Communities valid for migration from CCM to Files.
At this point, you can migrate any number of communities by checking the box next to each Community name and clicking \"Migrate Communities\", but you should first review the \"Migration Settings\" in the left-hand pane. The settings are:
The \"Status Log\" provides details while processing. For each community, it lists all Library files (including what folder they belong to) and existing folders in the Files app during an information-gathering phase, then (if Test Mode is disabled) performs the actual migration, listing all files again with an icon and text indicating whether each file was migrated. This log persists after migration, but is cleared if either an analysis is performed or the application is restarted on the server.
Once a Migration run has completed, an entry for each migrated community is added to the \"History\" page of the application, showing the community title and migration status. A file containing the history is saved under the \"Temporary Files Storage\" location on the server, and persists unless deleted by some means outside the application.
"},{"location":"ccm-migrator/usage/#regarding-file-name-conflicts","title":"Regarding file name conflicts","text":"When migrating files, the application makes some attempt to work around file name conflicts. This is particularly worth noting when either:
HCL Connections Files permits files of the same name in different folders, but doesn't permit a top-level file (not in any folders) to have the same name as a file in a folder.
By default, if CCM Migrator tries to migrate a file and finds that there is already a file of that name in Community Files, it will rename the new migrated file by appending an underscore (_) followed by a number. It will use the number 2 for the first renamed file, increasing the number if the first rename also produces a conflict, and will try up to 20 renames on each conflicting file before giving up. For example, if the file name \"My Document.doc\" conflicts with an existing Community File, it will be renamed to \"My Document_2.doc\".
Additionally, for each community, the application checks whether a migration was previously attempted for that community, and avoids repeatedly migrating files which were previously migrated. This means that if a migration of one community was partially successful, but some error prevented completion, the error can be fixed and the migration repeated without having to clear out previously migrated files or producing duplicates. Important: Migrations performed before this functionality was added to CCM Migrator (on 11 Feb 2019) will not be detected, due to the reliance on a new style of system logging.
The application's user-interface provides options to change the above behaviour, and those options are listed earlier in this document.
"},{"location":"ccm-migrator/usage/#roll-back","title":"Roll-back","text":"As of 5 April 2022, CCM Migrator has the ability to roll back migrated communities. Roll-back is only supported when migrating to Connections Files. A file-system migration can be rolled back manually by deleting the export from the server file system.
Perform a roll-back by selecting desired communities and clicking the \"Roll-back Communities\" button. This will only work for communities which were previously migrated.
If Test Mode is enabled, nothing will be rolled back, and the Status Log will just report the number of files and folders which can be rolled back.
Roll-back only removes files and folders created by migration, and won't remove folders which still contain files or subfolders when the roll-back is otherwise complete.
Roll-back also only works for communities which were migrated after the roll-back functionality was implemented, because it depends on additional data stored in the migration logs on the server. If necessary to roll back an older migration then, as long as the migrated files and folders weren't deleted or moved, simply repeat the migration. This will create a new migration log which contains the required additional data and allows roll-back.
"},{"location":"tools/ansible/","title":"Ansible","text":""},{"location":"tools/ansible/#setup-ansible","title":"Setup Ansible","text":"Throughout the guides on this site we use ansible to setup servers and manage servers and deployments in both kubernetes and docker swarm.
If you have access to a Mac or Linux machine, follow these instructions to get up and running.
Whilst that document states windows is not supported, We have had success running ansible under windows by enabling WSL (Windows subsystem for Linux), installing Ubuntu from the windows store and proceeding with the Ubuntu instructions linked.
Refer to this document from Microsoft for more information on WSL and the windows store options.
"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#docs","title":"Docs","text":"This site contains technical and user documentation for Huddo Apps. For purchase and product information visit huddo.com.
For the status of Huddo Boards Cloud, please see our status page.
"},{"location":"log4j/","title":"Log4j","text":"Recently a severe vulnerability was discovered in the log4j package. Details of that are here and Apache mitigation/patching details are here.
The status of the Huddo Applications in regard to the vulnerability are below.
"},{"location":"log4j/#badges","title":"Badges","text":"Badges does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.
"},{"location":"log4j/#analytics","title":"Analytics","text":"Analytics does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.
"},{"location":"log4j/#boards-websphere","title":"Boards WebSphere","text":"Boards WebSphere does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.
"},{"location":"log4j/#boards-dockercomponent-pack","title":"Boards Docker/Component Pack","text":"Boards Docker does not contain any Java and as such is not affected by this vulnerability.
"},{"location":"log4j/#boards-cloud","title":"Boards Cloud","text":"Boards Cloud does not contain any Java and as such is not affected by this vulnerability.
"},{"location":"log4j/#ccm-migrator","title":"CCM Migrator","text":"CCM Migrator does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.
"},{"location":"status/","title":"Status","text":"This page provides information on the status of our cloud services.
Huddo Boards Cloud - OnlinePlanned MaintenanceOffline
"},{"location":"analytics/install/add-widgets/","title":"Add Widgets","text":"So far, you have configured the location of the Huddo widgets. You will now add the widgets to the user interface.
"},{"location":"analytics/install/add-widgets/#add-the-configurators-widgets-to-their-communities","title":"Add the Configurators Widgets to their Communities","text":"Login to Connections and navigate to the previously created Badges Configurator Community
Click Community Actions then 'Add Apps' from the drop down menu
Select the Configurator to add to the Community
Click X
The Configurator will now be added to the main view.
We recommend removing all the default widgets from the main page (i.e. Forums, Bookmarks, Files and Feeds) to conserve screen real-estate, and making use of the Configurator widget easier. The default widgets may be removed or added back at any stage.
"},{"location":"analytics/install/add-widgets/#remove-the-default-widgets-optional","title":"Remove the Default Widgets (Optional)","text":"Click the Actions drop-down and select Delete
Fill in the required data then click Ok on the Delete prompt
"},{"location":"analytics/install/add-widgets/#add-the-huddo-analytics-widget-to-communities","title":"Add the Huddo Analytics Widget to Communities","text":"Login to Connections and navigate to the Huddo Analytics Community
Click Community Actions then 'Add Apps' from the drop down menu
Select HuddoAnalytics
Click X
We recommend removing all the default widgets from the main page (i.e. Forums, Bookmarks, Files and Feeds) to conserve screen real-estate, and making use of the Analytics widgets easier. The default widgets may be removed or added back at any stage.
Your first Huddo Analytics widget will now be added to the main view.
The default view shows the report categories. Once a report category is selected, default report instances for that category can be selected.
Once the report instance is selected, further options for that report can be selected.
The report currently configured is previewed below the options and can be saved for quick viewing on all subsequent page loads.
In the Huddo Analytics community, the Huddo Analytics widgets provide access to Connections Administrator level reports. In other communities, the Huddo Analytics widgets can be added to provide access to Community Manager level reports.
Multiple Huddo Analytics widgets are designed to exist in each community.
"},{"location":"analytics/install/add-widgets/#add-the-user-analytics-widget-to-the-home-page","title":"Add the User Analytics Widget to the Home page","text":"Adding widgets to the Home page of Connections is done through the Connections Web page.
Login to Connections as a user assigned to the admin security role of the Homepage application and navigate to the Administration tab.
Click the 'Add another app' button and enter the following details. Once you have defined each widget, click Save and then click the 'Add another widget' button to add the next.
Widget Type Widget Title URL Address Use HCL Connections specific tags Display on My Page Display on Updates Pages Opened by Default Multiple apps Prerequisites User Analytics iWidget Huddo User Analytics https://<CONNECTIONS_SERVER_URL>/Huddo/AnalyticsDashboard.xml False True False False True - Highlight the Huddo User Analytics widget in the Disabled widgets section and click Enable and it will now show in the Enabled widgets list.
It will also show on the Updates and Widgets tabs, if these options were selected.
"},{"location":"analytics/install/add-widgets/#add-the-huddo-user-analytics-widget-to-my-page","title":"Add the Huddo User Analytics Widget to My Page","text":"This step will ensure the User Analytics widget was defined successfully in the Administration section, and is working as expected. This step is a good introduction to User Reports, however is optional.
Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.
Open My Page through the Sidebar link or Home button and select Customize
Select Huddo User Analytics. If you cannot find it, look under the 'Other' category.
Click X
You will now have your first Huddo User Analytics Widget displayed in the My Page section. From here you can start using Analytics by selecting a report category, and then a specific reports instance.
Multiple Huddo User Analytics widgets are designed to exist on My Page.
"},{"location":"analytics/install/app/","title":"Install Application","text":"The Huddo Analytics Application is provided as a .war file that is to be installed as a WebSphere Application in your Connections server environment. The application provides the Huddo Analytics engine, as well as the widgets for user interaction.
"},{"location":"analytics/install/app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"Login to the WebSphere Integrated Solution Console for your Connections environment via a webbrowser.
Enter your administrator User ID and Password, then click the \u201cLog in\u201d button.
"},{"location":"analytics/install/app/#install-the-huddowar-file","title":"Install the Huddo.war file","text":"Navigate to Applications \u2192 Application Types \u2192 WebSphere enterprise applications
Click the Install button
Browse the Local File System Path for the downloaded Huddo.war file then Click Next
Check the Fast Path Option then Click Next
Change the Application name to Huddo then Click Next
Highlight the Nodes for the Application, including the IHS Node. Select the Badges Module, click Apply then Next.
Please Note: It\u2019s recommended that you create a separate cluster for Huddo if your Connections install is bigger than 10,000 users. You can do this via the ISC by clicking on Servers > Clusters > WebSphere application server clusters and then clicking New.
Click on Browse and map the default resources as shown. Click Next.
Enter Huddo as the Context Root, then click Next.
Please Note: The Huddo Installation guide assumes that the Context Root is set as \u2018/Huddo\u2019. If you set the Context Root to something other than \u2018/Huddo\u2019, then make sure that you replace \u2018/Huddo\u2019 with your Context Root when entering addresses.
Review the Installation Summary. Click Finish.
Review the Installation Results. Click Save.
Review the Synchronisation Summary. Click OK.
You have now successfully installed Huddo as a WebSphere Enterprise Application. Next, you will need to edit the security settings.
"},{"location":"analytics/install/app/#modify-the-huddo-application-security-role-assignments","title":"Modify the Huddo Application Security Role assignments","text":"During this step, we will be defining the authenticated users/groups for each Security Role.
Find Huddo in the list of enterprise applications and click on Huddo to open the application configuration screen
Click Security role to user/group mapping
To ensure that only authorised users have access to Huddo and its data, modify the mapping of the AllServlets and Reader roles to the Special Subjects: All Authenticated in Application/Trusted Realm, then Click OK
Please note: You may set the Reader role to Everyone to grant read-only access to Huddo widget data to unauthenticated users.
"},{"location":"analytics/install/apply-changes/","title":"Apply Changes","text":"The clusters must be restarted for the widget configuration changes to take effect.
"},{"location":"analytics/install/apply-changes/#restart-the-clusters","title":"Restart the Clusters","text":"Login to the Integrated Solution Console
Navigate to Servers \u2192 Clusters \u2192 WebSphere Application Server Clusters
Select all of the Connections Clusters
Click Ripplestart.
"},{"location":"analytics/install/comm-properties/","title":"Community Properties","text":""},{"location":"analytics/install/comm-properties/#step-6-additional-properties-for-communities-widgets-optional","title":"Step 6: Additional properties for Communities Widgets (OPTIONAL)","text":"At this stage, the Huddo Configuration Widget shows in the Communities Customization Palette for all Communities. This means they can be added to any community. However, they are restriced to function only in their respective Community created during this installation process. This message will be shown if theyare added to any other community.
It is possible to remove these Widgets from the Customizations Palette, so that users cannot see/add them to their Communties. This requires modifying the Configuration Widget definitions we created earlier in the widgets-config.xml file and restarting the clusters again.
Checkout and edit the widgets-config.xml file:
Connections 5.5
Connections 6.0
Connections 6.5
Locate the Configuration Widget definitions under the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
Add the attribute showInPalette=\"false\" to each Configurator you wish to hide from the Customizations page. We could not define this attribute earlier, as otherwise we wouldn\u2019t have been able to add the Widgets to the Configuration Communities.
Add the attribute loginRequired=\"true\" to each Community widget if you wish to hide the widgets from users that are not logged in. This is only applicable if your security settings for the Communities application allow users to view communities without logging in.
Your configuration should now look like this:
<widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\nCheck in the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
Then Restart the clusters.
"},{"location":"analytics/install/customising/","title":"Customising","text":""},{"location":"analytics/install/customising/#customising-huddo-strings-properties-images-optional","title":"Customising Huddo Strings, Properties & Images (Optional)","text":"You only need to perform this step if you wish to customise the user interface strings used in Huddo or the default properties used by the application, e.g. to use a custom context root etc. If you do not wish to do any of the above, you do not need to follow this step.
"},{"location":"analytics/install/customising/#customising-huddo-strings","title":"Customising Huddo Strings","text":"The files for customising Huddo Strings need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Please Note:
This step can be performed at any stage after the installation and is not required to complete the installation.
<installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultLang/{\n NAME_LABEL : \"User Name\",\n MESSAGE_LABEL : \"Notes\",\n MY_NETWORK : \"My Circle\",\n EVERYONE : \"All\",\n THIS_COMMUNITY : \"Community\",\n CONGRATULATIONS_PROFILE_COMPLETE_MSG : \"Congratulations on completing your profile!\",\n GRID_VIEW:\"Grid View\"\n}\nIf you wish to add specific customisations for different languages:
Example:
English: PROFILES_STATS_DIR/ HuddoStrings/en/UserInterfaceLang.js\nEnglish-UK: PROFILES_STATS_DIR/ HuddoStrings/en-gb/UserInterfaceLang.js\nFrench: PROFILES_STATS_DIR/ HuddoStrings/fr/UserInterfaceLang.js\nThe files for customising Huddo Properties need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Available properties files to customise:
Please Note:
<installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultProperties/The custom images need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Please Note:
This step can be performed at any stage after the installation and is not required to complete the installation.
Determine the image(s) to be customised in the HuddoImages folder from the location <installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultImages/
Common files customised include:\n kudos_stream.png (as seen in the Homepage Activity Stream)\n mobile_`<MOBILE_DEVICE>`.png (i.e. mobile_android.png etc \u2013 as seen for Huddo mobile)\nCreate a folder called HuddoImages in the directory given by the PROFILES_STATS_DIR Websphere Variable.
The Huddo Widgets provide the interface for user interaction within Connections. During this step, we will be configuring communities for secure access to the configuration interfaces for Badges and Metrics, as well as provisioning the Analytics widget, Badges/Thanks/Awards Summaries and Leaderboard widgets for end users as well as the Huddo News Gadget.
"},{"location":"analytics/install/install-widgets/#create-the-configurator-community","title":"Create the Configurator Community","text":"The Badges Configurator Widget is the widget that allows users to perform admin-level configuration of Huddo. The widget has been designed such that it is available to a specific Connections community where membership can be maintained, thereby securing access to the configurator. The HUddo Analytics Admin-level reports interface has been designed with the same concept, which is why the following steps will ask you to create 2 new communities.
Login to Connections, navigate to Communities and click Create a Community
Enter a name, such as Huddo Configurator
Set Access to Restricted
Specify Members as those people you wish to be able to edit Badge definitions. Users can be specified after clicking the Access Advanced Features link.
Enter any tags, web address and description you wish then click Save.
Note: Configurators requires a large column community layout to function properly. Either \u20183 Columns with side menu and banner\u2019, \u20183 Columns with side menu\u2019 or \u20182 Columns with side menu\u2019.
You have now created the Huddo Configurator Community.
Take note of the CommunityUUID in the URL address, as we will need this later.
"},{"location":"analytics/install/install-widgets/#create-the-huddo-analytics-administrator-community","title":"Create the Huddo Analytics Administrator Community","text":"The Huddo Analytics widget allows users to review Connections Usage data over specified time periods. Users have access to both reporting and graph functionalities. The following community will be used to host the Connections Administrator level reports and graphs.
Login to Connections, navigate to Communities and click Start a Community.
Enter a name, such as Huddo Analytics.
Set Access to Restricted.
Specify Members as those people you wish to be able to access Connections Administrator level reports and graphs. In Connections 5+, users can be specified after clicking the Access Advanced Features link.
Enter any tags, web address and description you wish and click Save.
You have now created the Huddo Analytics Administrator Community.
Take note of the CommunityUUID in the URL address, as we will need this later.
"},{"location":"analytics/install/install-widgets/#check-out-the-widgets-configxml-file","title":"Check out the widgets-config.xml file","text":"To install most of the Widgets you must edit the widgets-config.xml file for Profiles. This file contains the settings for each defined widget. To update this file, you must check the file out and, after making changes, you must check the file back in, as documented in the links below.
The widgets-config.xml file is a standard Connections file that is used to define the configuration settings for each of the widgets supported by Profiles and Communities. To update settings in the file, you must check the file out and, after making changes, you must check the file back during the same wsadmin session as the checkout for the changes to take effect.
Checking Out the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
"},{"location":"analytics/install/install-widgets/#configure-configurator-and-community-leaderboard-widgets","title":"Configure Configurator and Community Leaderboard Widgets","text":"By updating the widgets-config.xml with the code supplied below, the Badges Configurator and Huddo Community Analytics widgets will be made available. This will allow them to be placed into Connections Communities.
You must define the Widgets and where to find their associated .xml files. You will need the CommunityUuids you took note of earlier.
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
IMPORTANT: Don\u2019t forget to substitute the following placeholders with the corresponding values! YOUR_METRICS_COMMUNITY_UUID, YOUR_BADGES_COMMUNITY_UUID, YOUR_FILTERS_COMMUNITY_UUID , YOUR_ANALYTICS_COMMUNITY_UUID, CONNECTIONS_SERVER_NAME
<widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoAnalytics\" description=\"HuddoAnalytics\" modes=\"view edit\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AnalyticsDashboard.xml\" uniqueInstance=\"false\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"adminCommunityId\" value=\"YOUR_ANALYTICS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\nWe recommend using absolute URLs in widget-config.xml for reduced configuration complexity. If you have a requirement for the use of relative URLs and are unsure of the implications, you may discuss this with our support team.
"},{"location":"analytics/install/install-widgets/#check-in-the-widgets-configxml-file","title":"Check in the widgets-config.xml file","text":"Now that you have modified the widgets-config.xml, it must be checked back in to Connections. Please refer to the Connections product documentation for instructions on how to check in the widgets-config.xml file, located below.
Checking In the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
"},{"location":"analytics/install/install-widgets/#register-widgets-connections-60-cr1-onwards","title":"Register Widgets (Connections 6.0 CR1 onwards)","text":"Since Connections 6.0 CR1 it is now required to register third-party widgets in the widget-container for increased security. We have scripts and instructions for this here.
"},{"location":"analytics/install/install-widgets/#add-huddo-configuration-jsp-to-the-header","title":"Add Huddo configuration JSP to the header","text":"Perform this task to add Huddo Configuration information to Connections pages.
This is achieved by customising the header.jsp file, used for customizing the Connections Navigation bar.
If you have not customised the header.jsp file for your connections environment, please make a copy of the file from:
<WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/Homepage.ear/homepage.war/nav/templates
Paste the copy into the common\\nav\\templates subdirectory in the customization directory: <installdir>\\data\\shared\\customization\\common\\nav\\templates\\header.jsp
Edit the header.jsp file in the customisations directory add the following lines after the Moderation link and before the </ul> HTML tag as shown:
To add the Huddo Config JSP
--%><c:if test=\"${'communities' == appName || 'homepage' == appName || 'profiles' == appName}\"><%--\n --%><c:catch var=\"e\"><c:import var=\"kudosConfig\" url=\"http://${pageContext.request.serverName}/Kudos/kudosConfig.jsp\"/></c:catch><%--\n --%><c:if test=\"${empty e}\"><script type=\"text/javascript\">${kudosConfig}</script></c:if><%--\n--%></c:if><%--\nSave and close the file, the changes will take effect when the clusters are restarted. (See next task)
"},{"location":"analytics/install/install-widgets/#specify-huddo-analytics-admin-community-for-security","title":"Specify Huddo Analytics Admin Community for Security","text":"This change will not be picked up by Connections until the Huddo Application is restarted. This will be performed at the end of the configuration.
Create the resource.properties file in the Profiles Statistics customisation directory: <PROFILES_STATS_DIR>/HuddoProperties Where PROFILES_STATS_DIR is defined by the WebSphere variable: e.g. /opt/IBM/Connections/data/shared/profiles/statistics/HuddoProperties
Put the following line in the file, replacing <KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID> with the ID of the Huddo Analytics Community created in Task 2.4:
analyticsAdminCommunityID=<KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID>\nIMPORTANT: If a file of the same name already exists, merge the contents into the existing file.
"},{"location":"analytics/install/licence/","title":"Licence","text":"All versions of Huddo Badges and Analytics require a licence to function. If you do not have a licence file, please contact us at support@huddo.com
"},{"location":"analytics/install/licence/#upload-your-licence-file-in-the-badges-configurator","title":"Upload your licence file in the Badges Configurator","text":"Login to Connections Navigate to the Huddo Configurator Community.
Select the Settings tab in the BadgesConfigurator widget. If there are no tabs, this is the default view.
Click the Update Licence button.
Click Choose File and browse to your Huddo.licence file and click Upload.
"},{"location":"analytics/install/overview/","title":"Overview","text":"The following section provides an overview of the installation process and the packages that are to be installed. For an experienced Connections administrator or IBM WebSphere Application Server administrator, we expect that this installation process should take no longer than a couple of hours.
The install process for Huddo Analytics involves the following steps:
Please Note: These steps are only applicable to a new install of Huddo Analytics. For information about upgrading, please see the Huddo Analytics Update Guide.
"},{"location":"analytics/install/websphere-faq/","title":"Huddo Analytics Installation FAQ","text":""},{"location":"analytics/install/websphere-faq/#installation","title":"Installation","text":""},{"location":"analytics/install/websphere-faq/#images-do-not-work","title":"Images do not work","text":"Please go to the BadgesConfigurator->Settings tab then restart the Huddo Application.
"},{"location":"analytics/install/websphere-faq/#scheduler-not-running","title":"Scheduler not running","text":"Issue is with the timerManager in WAS. Create a new one to resolve issue.
"},{"location":"analytics/install/websphere-faq/#performance-tuning","title":"Performance tuning","text":"Review this guide for changes that can be made.
"},{"location":"analytics/install/websphere-faq/#connections-8-ui","title":"Connections 8 UI","text":"The new UI that comes with Connections 8 breaks some CSS of Analytics. Please use the below to fix it up, which can be applied as per the HCL Docs.t_admin_navbar_change_style.html)
.ConnectionsRankDropDown {\n border: 1px solid !important;\n}\n\n.KudosAnalyticsOptionSelect {\n border: 1px solid !important;\n}\n\n.AnalyticsCategoryList li div {\n font-size: 10px !important;\n}\n\n.KudosAnalyticsField .dijitReset.dijitInputField.dijitArrowButtonInner {\n width: 16px !important;\n}\nThis section covers the fundamental how-tos for accessing reports within Huddo Analytics
"},{"location":"analytics/user-guide/access-reports/#view-reports","title":"View Reports","text":"In order to view a report, you will need to add the Analytics widget applicable to your access level, select a report category and select a report.
"},{"location":"analytics/user-guide/access-reports/#add-an-analytics-widget","title":"Add an Analytics Widget","text":"This step will add the Huddo Analytics widget to the main view. The widget may be added in one of two ways based on your access level.
"},{"location":"analytics/user-guide/access-reports/#user-level","title":"User Level","text":"Open Homepage -> My Page -> Customize
Select Huddo User Analytics and Click X
"},{"location":"analytics/user-guide/access-reports/#community-level","title":"Community Level","text":"Open Community -> Community Actions -> Customize
Select Huddo Analytics then Click X
"},{"location":"analytics/user-guide/access-reports/#administration-level","title":"Administration Level","text":"Open Huddo Analytics Community -> Community Actions -> Customize
Select Huddo Analytics then Click X
"},{"location":"analytics/user-guide/access-reports/#select-a-report-category","title":"Select a Report Category","text":"The Huddo Analytics Widget should now be visible in the main view displaying an icon for each category of reports available. Please note that the categories visible to you may vary based on your access level. You may select a category by clicking on the icon to bring up the report selection menu.
"},{"location":"analytics/user-guide/access-reports/#select-a-report","title":"Select a Report","text":"A report menu containing reports relating to that category will now be visible below the icons. Select a report from the menu to preview it.
"},{"location":"analytics/user-guide/access-reports/#customise-reports","title":"Customise Reports","text":"All reports offer a range of options and filters to allow viewers to customise and personalise the report.
All reports have Query Parameters that define the context and scope of the underlying query for the report.
Table reports also have column filters (for filtering by value) and the ability to enable/disable columns (right click on column headers).
"},{"location":"analytics/user-guide/access-reports/#saving-reports","title":"Saving Reports","text":"Once you are satisfied with your report selection you can Save it. Click Save.
Personalise the report by specifying a custom title and description and click OK.
On save, the widget will switch to view-mode, hiding the query parameters. This report will now be loaded as per the saved configuration any time the page is opened.
"},{"location":"analytics/user-guide/access-reports/#managing-reports","title":"Managing Reports","text":"Reports can be managed at any stage during their lifecycle. The button in the top right hand corner provides access to the following functions:
"},{"location":"analytics/user-guide/access-reports/#refresh","title":"Refresh","text":"Reloads the widget. The report interface can be refreshed at any stage. Please be aware that most Connections environment data is refreshed on a schedule and will not be affected by this button.
"},{"location":"analytics/user-guide/access-reports/#edit","title":"Edit","text":"Reopens the report in edit-mode for customising. Any changes to the report parameters that are made to the report and saved will overwrite the existing report. Please ensure you add a new widget if you wish to keep the existing report.
"},{"location":"analytics/user-guide/access-reports/#move-updown","title":"Move Up/Down","text":"Reports can be positioned in any order. They can also be dragged and dropped. This is based on the Connections widget layout.
"},{"location":"analytics/user-guide/access-reports/#remove","title":"Remove","text":"If you no longer require the current report you can remove it. Note: this cannot be undone.
"},{"location":"analytics/user-guide/available-reports/","title":"Available Reports","text":""},{"location":"analytics/user-guide/available-reports/#reporting-access-levels","title":"Reporting Access Levels","text":"The Reports within Huddo Analytics are divided into 3 separate access levels based on the role of a User within Connections, to allow for more targeted and relevant reporting.
"},{"location":"analytics/user-guide/available-reports/#personal-analytics","title":"Personal Analytics","text":"All users are presented with reports about their own activity and content to allow them to analyse and understand their own usage of Connections. These reports can be accessed through the \u2018My Page\u2019 area in the Homepage application.
Examples - My Most visited Blogs, My Recent Network Contact, My Recent Followers, etc.
"},{"location":"analytics/user-guide/available-reports/#community-level-analytics","title":"Community Level Analytics","text":"Community managers/owners are presented with reports that help monitor their Community\u2019s usage and adoption. These reports can be accessed through the Huddo Community Analytics widget. These reports can only be accessed and customised by the Owners of the Community.
Examples \u2013 Most Popular Ideas, Number of Visits Over Time, Most Recent Members, etc.
"},{"location":"analytics/user-guide/available-reports/#overall-admin-connections-analytics","title":"Overall (admin) Connections Analytics","text":"Overall Connections Reports focus on usage and adoption of the entire Connections environment. These reports are accessed in a very similar way to Community reports but they are only available within the \u2018Huddo Analytics\u2019 community as defined in the widgets-config.xml file during installation. Please see the Installation guide for more details.
Examples - Most Active Users, Most Active Content, Percentage of Users Active in BUILDING, Connections Usage by Application, etc.
"},{"location":"analytics/user-guide/available-reports/#categories-of-reports","title":"Categories of Reports","text":"Huddo Analytics includes over 100 pre-defined graphs and data reports to help monitor user-adoption and usage within Connections. In addition, further reports can be created by Connections Administrators and Community Managers using the Custom Report templates. Most reports are organised into the five main categories as listed below.
Connections - Reports in this category provide an overview of user activity within Connections e.g. Number of Visit Events Over Time, Number of Create Events by Application
Demographics - These Reports are based on user groups defined by Profile attributes e.g. _Connections Usage by Country, Connections Usage by Building, Percentage of Users Active in Each Building
Content Content Reports provide an insight into the different types of content as well as content with specific attributes within Connections e.g. Most Created Types of Content, Most Followed Content, Most Visited Content
User - These Reports \u2013 are aimed at enabling the viewer to identify users based on their usage of Connections e.g. Inactive Users, Users Ranked by Number of Visits, Most Active Users
Community Community reports help identify communities based on usage and adoption related attributes such as size, contributions e.g. Largest Communities, Most Active Communities usage
There is also a Huddo report category for Huddo Badges/Thanks/Awards.
Huddo Huddo reports help quantify Badges/Thanks/Awards received on Badge and User e.g. Total Awarded Badges, Thanks Awarded usage, Huddo Summary Report
"},{"location":"analytics/user-guide/available-reports/#default-available-reports","title":"Default Available Reports","text":"Below is a full list of all reports provided as part of Huddo Analytics, organised by Report Access Level and Category.
"},{"location":"analytics/user-guide/available-reports/#personal-analytics_1","title":"Personal Analytics","text":""},{"location":"analytics/user-guide/available-reports/#huddo","title":"Huddo","text":"Name Type Purpose My Huddo Badges (Last Month) Table Displays the Huddo Badges awarded to users in the previous month My Huddo Thanks (Last Month) Table Displays your Huddo Thanks given and received in the previous month My Huddo Awards (Last 6 Months) Table Displays your Huddo Awards received in the previous 6 months My Colleagues Recently Awarded Badges Table Displays the Huddo Badges recently awarded to my colleagues"},{"location":"analytics/user-guide/available-reports/#connections","title":"Connections","text":"Name Type Purpose My Application Usage Pie A pie chart showing your activity for each Application as a percentage of the total activity My Connections Visits Trend A trend line showing the number of visits made by you over time My Connections Contributions Trend A trend line showing the number of contributions made by you over time My Status Updates Over Time Trend A cumulative trend line showing the number of status updates created by you #### Content Name Type Purpose My Activities by Users Bar Ranks your Activities by Number of Users My Blogs Posts by Visits Bar Ranks your Blogs Posts by number of visits My Blogs by Posts Bar Ranks your Blogs by Posts My Bookmarks by Visits Bar Ranks your Bookmarks by Visit My Ideation Blogs by Ideas Bar Ranks your Ideation Blogs by Ideas My Ideas by Votes Bar Ranks your Ideas by Votes My File Folders by Contents Bar Ranks your File Folders by Contents My Files by Download Bar Ranks your Files by Downloads My Files by Shares Bar Ranks your Files by Shares My File Library Visitors Bar Users visiting your File Library My Forums by Visits Bar Ranks your Forums by Visit My Forums by Topics Bar Ranks your Forums by Topics My Forum Topics by Visits Bar Ranks your Forum Topics by Visits My Forum Topics by Replies Bar Ranks your Forum Topics by Replies My Wiki Pages by User Visits Bar Ranks your Wiki Pages by User Visits My Wiki Pages by User Updates Bar Ranks your Wiki Pages by User Updates My Most Creates Types of Content Bar A bar chart showing your most created types of content My Most Active Content Table Ranks Content Created by you by the amount of user activity My Least Active Content Table Ranks content created by you by the amount of user activity My Most Followed Content Table Ranks your content by number of followers My Most Active Community Content Table Ranks Content in communities that you own by the amount of user activity My Lease Active Community Content Table Ranks Content in communities that you own by the amount of user activity"},{"location":"analytics/user-guide/available-reports/#user","title":"User","text":"Name Type Purpose My Recent Network Contacts Table List your Recent Network Contacts My Recent Followers Table Lists your Recent Followers My Recent Content Followers Table Displays Connections Users following your content"},{"location":"analytics/user-guide/available-reports/#community","title":"Community","text":"Name Type Purpose My Most Active Communities Bar Bar chart showing Communities you own by the amount of user activity My Most Visited Communities Bar Bar chart showing the most visited communities owned by you My Communities by Contributions Bar Bar chart showing your Communities with the most number of content being created My Lease Active Communities Table Table showing Communities you own by the amount of user activity Most Recent Public Communities Table Table showing the most recently created Public Communities"},{"location":"analytics/user-guide/available-reports/#community-level-analytics_1","title":"Community Level Analytics","text":""},{"location":"analytics/user-guide/available-reports/#connections_1","title":"Connections","text":"Name Type Purpose Total Number of Events by Application Pie Displays activity within each Application as a percentage of total activity Number of VISIT Events by Application Pie Displays number of VISIT events within each Application as a percentage of total number of VISIT events Number of CREATE Events by Application Pie Displays number of CREATE events within each Application as a percentage of total number of VISIT Unique Users VISIT Events by Application Pie Bar chart showing the number of Unique Users VISIT events for each application Unique Users CREATE Events by Application Pie Bar chart showing the number of Unique Users CREATE events for each application Unique User Events by Application Pie Pie chart showing the number of Unique User events for each application Number of VISIT Events Over Time Trend Graph showing the total number VISIT events over a selected time period Number of CREATE Events Over Time Trend Graph showing the total number CREATE events over a selected time period Unique User VISIT Events Over Time Trend Trend line showing the number of Unique User VISIT events over a selected time period Unique User CREATE Events Over Time Trend Trend line showing the number of Unique Users CREATE events over a selected time period First VISIT Events Over Time Trend Trend line showing the number of first-time user VISIT events over a selected time period First CREATE Events Over Time Trend Trend line showing the number of first-time user CREATE events over a selected time period. Can be filtered by Community Source, Item Type and Event Type Total Number of Events by Device Pie Displays activity from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Number of VISIT Events by Device Pie Displays number of VISIT events from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Number of CREATE Events by Device Pie Displays number of CREATE events from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Unique Users VISIT Events by Device Pie Displays number of Unique Users CREATE events for each Device. Data available from Connections 5.0 onwards Unique Users CREATE Events by Device Pie Displays number of Unique User events for each Device. Data available from Connections 5 onwards Unique User Events by Device Pie Displays activity from each Device as a percentage of total activity. Data available from Connections 5.0 onwards"},{"location":"analytics/user-guide/available-reports/#content","title":"Content","text":"Name Type Purpose Most Created Types of Content Bar Graph showing the most created content types in this Community Most Visited Bookmarks Bar Chart showing the bookmarks that have the most visits Most Popular Ideas Bar Chart showing the Ideas that have received the most votes Most Downloaded Files Bar Chart showing the Most downloaded files in the Community Forums with Most Topics Bar Graph showing the Forums with most topics in the Community Forum Topics with Most Replies Bar Graph showing Forum Topics with the most replies Most Updated Wiki Pages Bar Graph showing Wiki Pages in the community by number of UPDATE events Activities with Most Number of Users Bar Chart showing the activities with the most number of users Unique Visitors to the File Library Over Time Trend Trend line showing the number of Unique Visitors to the Community's File Library Most Active Content Table Table showing content with the most number of events generated Most Followed Content Table Table showing content with the most number of followers Most Recent Content Table Table showing the most recently created content Custom Content Report Table Table for creating custom Content-related reports"},{"location":"analytics/user-guide/available-reports/#user_1","title":"User","text":"Name Type Purpose Users Ranked by Number of Visits Bar Chart showing Users who have the most VISIT events in this community Users Ranked by Number of Contributions Bar Chart showing Users who have the most CREATE events in this community Most Recent Members Table Table listing the most recent Members of this Community Most Recent Followers Table Table listing the most recent Followers of this Community Custom User Report Table Table for creating custom Users-related reports"},{"location":"analytics/user-guide/available-reports/#demographics","title":"Demographics","text":"Name Type Purpose Community Usage by COUNTY Pie Pie chart showing the activity in each Country as a percentage of the total activity Number of Active Community Users by COUNTRY Bar Bar chart showing the number of Active Users in each Country Percentage of Community Users Active in COUNTRY Bar Bar chart showing the percentage of Active Users in each Country Community Usage by BUILDING Pie Pie chart showing the activity in each Building as a percentage of the total activity Number of Active Community Users by BUILDING Bar Bar chart showing the number of Active Users in each Building Percentage of Community Users Active in BUILDING Bar Bar chart showing the percentage of Active Users in each Building Community Usage by DEPARTMENT Pie Pie chart showing the activity in each Department as a percentage of the total activity Number of Active Community Users by DEPARTMENT Bar Bar chart showing the number of Active Users in each Department Percentage of Community Users Active in DEPARTMENT Bar Bar chart showing the percentage of Active Users in each Department Community Usage by FLOOR Pie Pie chart showing the activity in each Floor as a percentage of the total activity Number of Active Community Users by FLOOR Bar Bar chart showing the number of Active Users in each Floor Percentage of Community Users Active in FLOOR Bar Bar chart showing the percentage of Active Users in each Floor Usage Data Report by COUNTRY Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Country Usage Data Report by BUILDING Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Building Usage Data Report by DEPARTMENT Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Department Usage Data Report by FLOOR Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Floor"},{"location":"analytics/user-guide/available-reports/#overall-connections-analytics","title":"Overall Connections Analytics","text":""},{"location":"analytics/user-guide/available-reports/#connections_2","title":"Connections","text":"Name Type Purpose Total Number of Events by Application Pie Displays activity within each Application as a percentage of total activity Number of VISIT Events by Application Pie Displays number of VISIT events within each Application as a percentage of total number of VISIT events Number of CREATE Events by Application Pie Displays number of CREATE events within each Application as a percentage of total number of VISIT events Unique User Events by Application Pie Pie chart showing the number of Unique User events for each application Unique Users VISIT Events by Application Pie Bar chart showing the number of Unique Users VISIT events for each application Unique Users CREATE Events by Application Pie Bar chart showing the number of Unique Users CREATE events for each application Number of VISIT Events Over Time Trend Graph showing the total number VISIT events over a selected time period Number of CREATE Events Over Time Trend Graph showing the total number CREATE events over a selected time period Unique User VISIT Events Over Time Trend Trend line showing the number of Unique User VISIT events over a selected time period Unique User CREATE Events Over Time Trend Trend line showing the number of Unique Users CREATE events over a selected time period First VISIT Events Over Time Trend Trend line showing the number of first-time user VISIT events over a selected time period First CREATE Events Over Time Trend Trend line showing the number of first-time user CREATE events over a selected time period Total Number of Events by Device Pie Displays activity from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Number of VISIT Events by Device Pie Displays number of VISIT events from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Number of CREATE Events by Device Pie Displays number of CREATE events from each Device as a percentage of total activity. Data available from Connections 5.0 onwards Unique Users VISIT Events by Device Pie Displays number of Unique Users CREATE events for each Device. Data available from Connections 5.0 onwards Unique Users CREATE Events by Device Pie Displays number of Unique User events for each Device. Data available from Connections 5.0 onwards Unique User Events by Device Pie Displays activity from each Device as a percentage of total activity. Data available from Connections 5.0 onwards"},{"location":"analytics/user-guide/available-reports/#huddo_1","title":"Huddo","text":"Name Type Purpose Huddo Badges Distribution Column A histogram displaying the current distribution of users based on the number of Huddo Badges achieved by them. This can be filtered by Category Profile Progress Distribution Column A histogram displaying the current distribution of users based on the percentage of completion of their profiles as calculated by the Huddo Profile Progress widget Huddo Thanks Distribution Column A histogram displaying the current distribution of users based on the number of Huddo Thanks given and received by them Huddo Badges Awarded Table - Huddo Awards Awarded Table - Huddo Thanks Awarded Table - Huddo Badges Awarded by Users Table - Huddo Awards Awarded by Users Table - Huddo Thanks Awarded by Users Table - Huddo Summary Report Table - Profile Progress for Users Table -"},{"location":"analytics/user-guide/available-reports/#demographics_1","title":"Demographics","text":"Name Type Purpose Connections Usage by COUNTRY Pie Bar chart showing the activity in each Country as a percentage of the total activity Number of Active Users by COUNTRY Bar Bar chart showing the number of Active Users in each Country Percentage of Users Active in COUNTRY Bar Bar chart showing the percentage of Active Users in each Country Connections Usage by BUILDING Pie Bar chart showing the activity in each Building as a percentage of the total activity Number Active Users by BUILDING Bar Bar chart showing the number of Active Users in each Building Percentage of Users Active in BUILDING Bar Bar chart showing the percentage of Active Users in each Building Connections Usage by DEPARTMENT Pie Pie chart showing the activity in each Department as a percentage of the total activity Number of Active Users by DEPARTMENT Bar Bar chart showing the number of Active Users in each Department Percentage of Users Active in DEPARTMENT Bar Bar chart showing the percentage of Active Users in each Department Connections Usage by FLOOR Pie Pie chart showing the activity in each Floor as a percentage of the total activity Number of Active Connections Users by FLOOR Bar Bar chart showing the number of Active Users in each Floor Percentage of Connections Users Active in FLOOR Bar Bar chart showing the percentage of Active Users in each Floor Usage Data Report by COUNTRY Table Table showing number of active users, percentage of active users, total number of users, and percentage of activity each Country Usage Data Report by BUILDING Table Table showing number of active users, percentage of active users, total number of users, and percentage of activity each Building Usage Data Report by DEPARTMENT Table Table showing number of active community users, percentage of active community users total number of community users, and percentage of activity each Department Usage Data Report by FLOOR Table Table showing number of active community users, percentage of active community users, total number of community users, and percentage of activity each Floor"},{"location":"analytics/user-guide/available-reports/#content_1","title":"Content","text":"Name Type Purpose Most Created Types of Content Bar Graph showing the most created content types across Connections Number of Status Updates Created Over Time Trend Graph showing the total number of Status Updates posted over a selected period of time Most Active Content Table Table showing content with the most number of events generated Least Active Content Table Table showing content with the least number of events generated Most Visited Content Table Table showing content with the most number of visit and read events generated Most Followed Content Table Table showing content with the most number of followers File Libraries by Computed Size (MB) Table Table showing File Libraries with their Computed Size in Megabytes Custom Content Report Table Table for creating custom Content-related reports Custom Content Report Inc. Parent Table Table for creating Content-related reports which includes the Parent Name"},{"location":"analytics/user-guide/available-reports/#user_2","title":"User","text":"Name Type Purpose Users With Most Network Contacts Bar Chart of Users who have the most number of Network Contacts Most Active Users Table Table of users who have generated the most number of events in Connections in the selected time period Least Active Users Table Table of users who have generated the least number of events in Connections in the selected time period Inactive Users Table Table of Users who have no activity in Connections in the selected time period Recently Active Users Table Table of Users that have been active in the last week with Number of Events and Date of last activity Users with Most Contributions Table Table of Users with the most number of CREATE events in the selected time period First Time Users Table Table of Users showing the most recent first time Users New Users CREATE Events Table Table of Users who have recently made their first contribution to Connections, i.e. first CREATE event Custom User Report Table Table for creating custom Users-related reports"},{"location":"analytics/user-guide/available-reports/#community_1","title":"Community","text":"Name Type Purpose Communities with Most Events Bar Chart showing the Communities with the highest number of events Communities with Most VISIT Events Bar Bar Chart showing the Communities with the highest number of VISIT events Communities with Most CREATE events Bar Bar Chart showing Communities with the highest number of CREATE events Largest Communities Bar Bar Chart showing the Communities with the most number of Members Communities with Most Events Table Table of Communities with the most number of events in Connections in the selected time period Communities with Least Events Table Table of Communities with the least number of events in Connections in the selected time period Most Recent Communities Table Table showing the most recently created Communities Custom Community Report Table Table for creating custom Communities-related reports"},{"location":"analytics/user-guide/itemtype-map/","title":"Event Map","text":""},{"location":"analytics/user-guide/itemtype-map/#metrics-event-itemtype-map","title":"Metrics Event ItemType Map","text":"Below is a table displaying the Item Types applicable for each Event Type for each Connections Application. This is for advanced users who wish to further understand and take advantage of the Source, Event Type and Item Type filters provided in the reports query parameters. Please note that this is a guideline only. Event-ItemType associations may vary based on Connections version, environment variables, usage, installed applications etc.
"},{"location":"analytics/user-guide/itemtype-map/#activities","title":"Activities","text":"Event COMPLETE Activity ToDo COPY Activity Template CREATE Activity Attachment CommentEntrySectionTagTemplateTodo DELETE Activity Attachment CommentEntrySectionTemplateTodo FOLLOW Activity MOVE Section READ EntryTodo TAG Activity CommentEntrySectionTemplateTodo UNCOMPLETE Activity ToDo UNDELETE Activity CommentEntrySectionTodo UNFOLLOW Activity UNTAG Activity CommentEntrySectionTemplateTodo UPDATE Activity Attachment CommentEntryMembershipSectionTemplateTodo VISIT Activity Default Membership VISIT_DUP Activity DefaultNot Relevant: ADD, APPROVE, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, PIN, PREVIEW, RECOMMEND, REJECT, REMOVE, RESTORE, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#blogs","title":"Blogs","text":"Event ADD Membership APPROVE Comment Entry CREATE Blog Comment Entry File Tag Trackback DELETE Blog Comment Entry File Membership FOLLOW Blog READ Entry RECOMMEND Comment Entry REJECT Comment Entry RESTORE Comment Entry TAG Blog Comment Entry UNFOLLOW Blog UNRECOMMEND Entry UNTAG Blog Comment Entry UPDATE Blog Entry Membership VISIT Administration Blog Default ManageBlog VISIT_DUP Blog DefaultNot Relevant: COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, REMOVE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN,, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#bookmarks","title":"Bookmarks","text":"Event CREATE Bookmark Tag DELETE Bookmark READ Bookmark TAG Bookmark UNTAG Bookmark UNWATCH Person Tag UPDATE Bookmark VISIT Bookmark Default VISIT_DUP Bookmark Default WATCH Person TagNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, FOLLOW, GRADUATE, LOCK, MOVE, PIN, PREVIEW, RECOMMEND, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, VOTE
"},{"location":"analytics/user-guide/itemtype-map/#communities","title":"Communities","text":"Event ADD Invite Membership CREATE Bookmark Comment CommunityFeedTagWallpostWidget DECLINE Invite DELETE Bookmark Comment CommunityFeedInviteMembershipWallpostWidget FOLLOW Community RECOMMEND Wall RESTORE Community TAG Bookmark Community Feed UNFOLLOW Community UNRECOMMEND Wall UNTAG Bookmark Community Feed Membership UPDATE Bookmark CommunityFeedMembership VISIT Communities Community Default VISIT_DUP Communities Community DefaultNot Relevant: APPROVE, COMPLETE, COPY, DOWNLOAD, EMPTY, FOLLOW, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, REJECT, REMOVE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#files","title":"Files","text":"Event ADD CommunityFile Share CREATE Collection Comment FileLibraryMediafileTag DELETE Collection Comment FileFileversionLibraryMediafile DOWNLOAD File Mediafile EMPTY Trash FOLLOW Collection File Mediafile READ File RECOMMEND File REJECT Comment File REMOVE Collection CommunityFile RESTORE Comment File Filerversion TAG Collection Comment File Library UNDELETE File UNFOLLOW Collection File UNRECOMMEND File UNTAG Collection Comment File Library UPDATE Collection Comment FileLibraryMediafileMembership VISIT Default Folder Library VISIT_DUP Default LibraryNot Relevant: APPROVE, COMPLETE, COPY, DECLINE, GRADUATE, LOCK, MOVE, PIN, PREVIEW, UNCOMPLETE, UNLOCK, UNPIN, UNWATCH, VISIT, VISIT_DUP
"},{"location":"analytics/user-guide/itemtype-map/#forums","title":"Forums","text":"Event CREATE Attachment ForumReplyTagTopic DELETE Attachment ForumReplyTopic FOLLOW Forum Topic LOCK Forum Topic MOVE Forum Topic PIN Topic READ Reply Topic REJECT Forum Topic TAG Forum Reply Topic UNDELETE Forum Topic UNFOLLOW Forum Topic UNLOCK Forum Topic UNPIN Topic UNTAG Forum Reply Topic UPDATE Reply Topic VISIT Activity Default MembershipNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, PREVIEW, READ, REMOVE, RESTORE, UNCOMPLETE, UNRECOMMEND, UNWATCH, VISIT_DUP, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#homepage","title":"Homepage","text":"Event CREATE Tag Widget DELETE Widget TAG Watchlist UNTAG Watchlist VISIT Activitystream Activitystream.actionrequired Activitystream.atmentions Activitystream.discover Activitystream.imfollowing Activitystream.mynotifications Activitystream.saved Activitystream.statusupdates Default Gettingstarted Widgets VISIT_DUP Activitystream Activitystream.atmentions Activitystream.discover Activitystream.imfollowing Activitystream.mynotifications Activitystream.statusupdates Default Gettingstarted WidgetsNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, FOLLOW, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, RECOMMEND, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, UPDATE, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#ideation-blog","title":"Ideation Blog","text":"Event APPROVE Comment Idea CREATE Comment File Idea IdeationBlog Tag Trackback DELETE Comment File Idea IdeationBlog GRADUATE Idea READ Idea RECOMMEND Comment REJECT Comment Idea RESTORE Comment Idea TAG Comment Idea IdeationBlog UNTAG Comment Idea IdeationBlog UPDATE Idea IdeationBlog VISIT Default Ideationblog Manageblog VISIT_DUP Default Ideationblog VOTE IdeaNot Relevant: ADD, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, FOLLOW, LOCK, MOVE, PIN, PREVIEW, REMOVE, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, UPDATE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#media-gallery","title":"Media Gallery","text":"Event CREATE Mediafile DELETE Mediafile DOWNLOAD Mediafile FOLLOW Mediafile PREVIEW Mediafile READ Mediafile UPDATE Mediafile VISIT Default LibraryNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, EMPTY, GRADUATE, LOCK, MOVE, PIN, RECOMMEND, REJECT, REMOVE, RESTORE, TAG, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, UNTAG, UNWATCH, VISIT_DUP, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#profiles","title":"Profiles","text":"Event ADD Invitation Link CREATE Collegue Comment Status Tag Wallpost DELETE Collegue Comment Person Profile.audio Profile.photo Status Wallpost FOLLOW Person RECOMMEND Wall TAG Person Profile UNFOLLOW Person UNRECOMMEND Wall UNTAG Person Profile UPDATE Profile Profile.about Profile.audio Profile.photo VISIT Default Network Profiles Search VISIT_DUP DefaultNot Relevant: APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/itemtype-map/#wikis","title":"Wikis","text":"Event CREATE Attachment Comment Library Page Tag DELETE Attachment Comment Library Page PageVersion FOLLOW Library Page READ Page RECOMMEND Page TAG Comment Library Page UNDELETE Page UNFOLLOW Library Page UNRECOMMEND Page UNTAG Comment Library Page UPDATE Attachment Comment Library Membership Page VISIT Default Library Membership VISIT_DUP Default LibraryNot Relevant: ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH
"},{"location":"analytics/user-guide/terms/","title":"Glossary of Terms","text":""},{"location":"analytics/user-guide/terms/#events","title":"Events","text":"Any action or occurence performed by the user in Connections. Typical event types are VISIT, CREATE, READ, UPDATE, DELETE. Here is a summary of common events:
EVENT Description ACKCOM Acknowledgment of a platform command ADD To add an existing item to a new place, e.g. a User as a new member of a Community, or Sharing a File with other users APPROVE Approval of content for moderation COMMAND Invocation of a platform command COMPLETE To mark an Activity or Todo as completed COPY To duplicate an Activity or Activity Template CREATE To create a new item, e.g. a Blog Entry or Bookmark DELETE To delete an existing item, e.g. an Entry/Section from an Activity or a Widget from Homepage/Communities DOWNLOAD To download a File or Media File FOLLOW To follow an item (changes/comments etc), e.g. a File, Community, Forum Topic or Wiki Page GRADUATE To graduate an Idea in an Ideation Blog to the next level MEMBERSHIP Modification of membership or access control for a given resource MOVE To move a section in an Activity PIN To pin a Topic in a Forum PREVIEW To preview a Media File in the Media Gallery READ To read an item, e.g. a Blog Entry, Forum Topic or Wiki Page etc. RECOMMEND To recommend an item, e.g. a Blog Entry, File, or Wiki Page etc. RESTORE To restore a File from a previous version TAG To add a tag to an item, e.g. Activity Entry, Bookmark, File, Forum, Forum Topic etc. UNCOMPLETE To remove a previous \u2018Complete\u2019 from an Activity or Todo UNDELETE To restore a previously deleted Activity Entry UNFOLLOW To remove a previous \u2018follow\u2019 UNGRADUATE To remove a \u2018graduate\u2019 on an Idea UNPIN To unpin a Topic from a Forum UNRECOMMEND To remove a previous recommendation UNTAG To remove a previous tag UNVOTE To remove a vote previously cast in an Ideation Blog UNWATCH To remove a User from your Bookmarks Watchlist UPDATE To update an existing item, e.g. your Status, or change the name of a file VISIT To visit a Connections page, e.g. the Homepage VISIT_DUP Duplicate visits, e.g. Visits to the exact same place within a similar time frame VOTE To vote for an Idea in an Ideation Blog WATCH To add a User to your Bookmarks Watchlist"},{"location":"analytics/user-guide/terms/#reports","title":"Reports","text":"The visible data (graph or table) produced to analyse the use of your IBM Connections environment.
"},{"location":"analytics/user-guide/terms/#report-definition","title":"Report Definition","text":"The default instances provided with Huddo which can be used as-is (or customised) to create Reports
"},{"location":"analytics/user-guide/terms/#view-mode","title":"View mode","text":"The default mode of a saved Analytics widget. It only displays the graph or table, hiding all the configuration options for the report.
"},{"location":"analytics/user-guide/terms/#edit-mode","title":"Edit mode","text":"This is the default mode for newly added Analytics widgets, before a report is saved to them. This mode provides access to all the configuration options for reports allowing users to preview new reports and customise saved reports.
"},{"location":"analytics/user-guide/introduction/","title":"Introduction","text":""},{"location":"analytics/user-guide/introduction/#purpose-of-huddo-analytics","title":"Purpose of Huddo Analytics","text":"Huddo Analytics provides an insight into the usage of your Connections environment with the help of graphical and tabular reports. It primarily focuses on providing information that directly addresses important user-adoption concerns. Answer questions such as - Which features are being used? How many users are using each feature? How is each feature being used? Which aspects of a feature need focus?
"},{"location":"analytics/user-guide/introduction/#what-is-a-report","title":"What is a Report?","text":"A Report in Huddo Analytics presents a series of data pertaining to the usage of your Connections environment. There are several types of reports included in Huddo Analytics;
"},{"location":"analytics/user-guide/introduction/#table-reports","title":"Table Reports","text":"These reports show data in a tabular form, with the ability to sort and filter on column values and also to toggle entire columns.
"},{"location":"analytics/user-guide/introduction/#bar-charts","title":"Bar Charts","text":"Bar charts are great for visual comparisons between values.
"},{"location":"analytics/user-guide/introduction/#trend-reports","title":"Trend Reports","text":"These reports are used for showing values that change over time. They are a great tool for identifying usage trends over a period of time. They can be viewed as absolute or cumulative trends.
"},{"location":"analytics/user-guide/introduction/#column-charts","title":"Column Charts","text":"Column charts are great for representing a distribution.
"},{"location":"analytics/user-guide/introduction/#pie-charts","title":"Pie Charts","text":""},{"location":"analytics/user-guide/using-reports/","title":"Using Reports","text":""},{"location":"analytics/user-guide/using-reports/#analytics-dashboard","title":"Analytics Dashboard","text":"The Analytics Widget can be used to create and position multiple reports on a single page. Reports can be previewed and customised before being saved for ongoing use. This enables users to create a personalised dashboard of their favourite/most-viewed reports for easy, repeat access.
"},{"location":"analytics/user-guide/using-reports/#customise-reports-to-answer-specific-questions","title":"Customise Reports to Answer Specific Questions","text":"A Report also provides the capability to customise the query underlying its data to answer more specific questions. There are 4 main customisation options;
"},{"location":"analytics/user-guide/using-reports/#customise-query-parameters","title":"Customise Query Parameters","text":"Make reports more specific by specifying parameters such as who, when, where, what, etc. using filters for Community, User, Application, Time Period, Event Type, etc.
After you have set the parameters you desire, press 'Run' to apply them and update the report data.
"},{"location":"analytics/user-guide/using-reports/#sort-columns","title":"Sort Columns","text":"Tabular reports allowing sorting column data (ascending/descending) by clicking on the header name.
"},{"location":"analytics/user-guide/using-reports/#filtersearch-table-results-keyword-minmax","title":"Filter/Search table results (keyword, min/max)","text":"Search report table columns by Keywords, Min/Max values and Start/End dates.
"},{"location":"analytics/user-guide/using-reports/#enabledisable-columns","title":"Enable/Disable columns","text":"Some tabular reports allow you to hide unwanted columns to focus on the data you\u2019re interested in by right-clicking on the column header.
"},{"location":"badges/","title":"Index","text":"Huddo Badges can transform and accelerate organisations user adoption of Connections by encouraging users to leverage the full range of social services and drive user adoption and behaviour.
Huddo Badges for Connections is a flexible gamification engine for Connections. By providing achievements and rewards (Huddo Badges), rank and leaderboards (Huddo Rank), and missions (Huddo Missions), organisations can dramatically improve their user engagement and adoption of Connections.
In addition, Huddo Badges is an extensible platform that can leverage game theory to provide performance management mechanics and reward systems for applications outside of Connections such as HR, Sales Force Management, Help Desks, and many more.
Huddo also now includes a peer to peer and team recognition feature; Huddo Thanks.
"},{"location":"badges/#huddo-points","title":"Huddo Points","text":"Huddo Points are awarded to people for performing certain actions. For example you get a Huddo Point for posting a status update or making a comment. You get 5 Huddo Points for creating a blog, or 3 Huddo Points for having one of your files recommended by another person. You can even be awarded Huddo Points for achieving a particular badge or for completing a Huddo Mission or category of badges. The value of any particular action or reward can be configured so the points system can be tweaked to meet your needs. You can also be awarded Huddo Points for your actions outside of Connections helping to drive your organisations\u2019 performance management.
"},{"location":"badges/#huddo-metrics","title":"Huddo Metrics","text":"Metrics are at the heart of Huddo Badges. Metrics are basically a way of awarding and tracking Huddo that determine if a particular badge, mission, or achievement has been awarded. Metrics also award Huddo that add to the person\u2019s Huddo Rank and their leaderboard position.
Metrics are SQL statements that analyse information in your database. You can even define Metrics that count other Metrics! We provide many out of the box metrics for Connections that you can add to or modify. In addition you can also build your own custom metrics that capture actions and performance from external applications. You can then reward users based on their actions and behaviour outside of Connections.
"},{"location":"badges/#huddo-filters","title":"Huddo Filters","text":"Filters work alongside Metrics. Filters are also SQL statements, and they are applied to Metrics to, as the name suggests, filter the selected users using contextual parameters such as Time, Community, Name etc. For example, to select a user with the display name Joe Bloggs, we can use the Profile Like Metric with the filter Display Name Like with its parameter set to \u2018Joe Bloggs \u2019.
Like Metrics, we also provide many out of the box filters for Connections that you can modify or add to, and you can build your own custom filters for use with external applications.
"},{"location":"badges/#huddo-badges","title":"Huddo Badges","text":"Huddo Badges are rewards that users receive for performing certain actions. There are simple badges that are fairly easy to achieve and more complex badges that require significant effort. The Huddo Badges are designed to not only reward users but to also encourage progression and exploration of other features. Badges are grouped into categories and missions and are achieved by meeting the required metrics for each badge.
Badges are defined by selecting pre-configured Metrics, and specifying the upper and lower limits of the Huddo points returned by these Metrics, required to achieve that Badge. You can make Badges as simple or as complex as you wish by varying the amount of Metrics you are counting.
"},{"location":"badges/#huddo-awards","title":"Huddo Awards","text":"Huddo Awards is a reward and recognition system which provides the capability of directly awarding Badges to one or more users. Huddo provides a set of default Awards to reward loyalty, efficiency, expertise, etc. The default Awards have been designed to be generic and universally applicable, however they can be customised and/or replaced with ones more applicable to your environment.
"},{"location":"badges/#huddo-leaderboard","title":"Huddo Leaderboard","text":"The Huddo Badges Leaderboard enables users to view the top 10 contributors throughout Connections. You can filter the leaders to just people from your network, everyone, or even Community members (when viewing the Huddo Leaderboard in a Community).
You can also view a break-down of which categories the Points/Badges came from by simply selecting the user in the Leaderboard.
"},{"location":"badges/#huddo-configurators","title":"Huddo Configurators","text":"The Huddo Badges, Metrics & Filters Configurators allow the user to control and customise Badges, Metrics & Filters.
These Configurators are designed for use by Administrators, and not general users. As such controlling access to them is very important. Therefore we have built them to only operate in one specific Connections Community, which you can control. This means that the Community Administrators use the Members list to specify the users allowed access to each Configurator.
We will be creating three Communities; one for each Configurator. These Communities can be Stand-alone Communities or Sub-Communities of existing Communities if you wish.
"},{"location":"badges/#huddo-badges-summary","title":"Huddo Badges Summary","text":"The Huddo Summary Widget is added to everyone's profile so that others can see what achievements and rewards the person has received. When you mouse over each badge it provides you with details on why the badge was awarded and tasks that you can consider to try and win another badge! The idea is to not only reward people for their behaviour but to also provide them with guidance and education on what else they can do in Connections. When users click on the View All link it takes them to their Huddo Badges Progress and Detail Page.
"},{"location":"badges/#huddo-profile-progress-widget","title":"Huddo Profile Progress Widget","text":"Encourage the users to get started in Connections!
The Profile Progress Widget displays a progress bar indicating a Profile\u2019s maturity level and gives users ideas to improve it based on what the Profile is lacking. This widget uses existing metrics to measure in real-time the level of completion of a Profile. What makes this feature really powerful is that it is completely configurable allowing you to fine tune it to your environment!
"},{"location":"badges/#huddo-thanks","title":"Huddo Thanks","text":"There is nothing quite as simple as saying \"Thank You\" to provide some recognition of great work. Think about it for a moment...when somebody thanks you for your great idea, or for putting in that extra work to meet a deadline, or maybe for just being a good team mate, it makes you feel great and more motivated to stay engaged.
That is why ISW has developed Huddo Thanks, the peer to peer and team recognition tool for Connections.
Motivate your team We all do performance reviews (or we all should!), however often the problem is that the various achievements or small goals we meet throughout the year can be easily forgotten. Why wait for the next big meeting to provide some feedback to your team. Huddo Thanks enables you to provide real time feedback and to publically acknowledge great work quickly and easily. The recognition then stays visible on the person's profile so that peers and colleagues can see and recognise the value that is placed on a person\u2019s work.
Peer to Peer recognition Thanks don\u2019t always come from your boss either! Often having your direct peers\u2019 thank you for some great work can be a great motivator. With Huddo Thanks users of Connections can select from a range of Thanks related badges, choose who to award the thanks to, add a message and send it off! The thanks will appear on the users profile as well as integrate within their Activity Steam so that others can see as well.
Management or Team recognition Huddo also allows for Manager or Team Leader Thanks Badges. You can create your own special badges that only certain people can award such as employee of the month. And because Huddo Thanks is built to be social, within Connections peers and colleagues are able to see and add value to the recognition and thanks as well!
Thanks Badges Select from provided badges or create your own. You can even set how often a Thanks badge may be awarded to add more value.
Personalised Messages & Reputation\nYou can provide a personal message of recognition when awarding a thanks\nbadge. Thanks Received and Given remain on your profile so the recognition you\nreceive is not forgotten.\nThanks Allowance Control how often a Thanks badge may be awarded to add more value and create a greater impact.
Social Recognition & Notifications\nThanks given to users are published in the Discover Feed for everyone\nto see. An email notification is sent to the user as well to make sure they\nreceive your thanks.\nHuddo Groups allows administrators to group users.
These groups can then be used to control access to various parts of Huddo. For example in Thanks Badges, allowing you to define Thanks which can only be awarded by selected users. This allows you to define exclusive Management badges such as \u201cEmployee of the Month\u201d which can only be awarded by those you choose! You can also use Groups to exclude users from appearing in the Leaderboards!
"},{"location":"badges/#connections-activity-stream-integration","title":"Connections Activity Stream Integration","text":"Huddo now includes Embedded Experiences in the Activity Stream through use of the new Open Social Gadget standards. Now you can enjoy a richer Huddo experience, through the ability to Comment & Like on Awarded Badges and Thanks.
Awarded Badges\nAll awarded badges will now appear on the Discovery tab in the Activity Stream. Further details about the Badge can be viewed by opening\nthe Embedded Huddo Gadget.\nHuddo News Gadget
From the Huddo News Gadget users can now Like and Comment on Huddo Activity Stream Entries.
Liking Huddo Entries
When a User Likes the item, a new entry describing the Liking of the Content, is created in the Activity Stream and the original entry is rolled up into the new entry. If the user chooses to Undo this Like, then this new Stream Entry is removed and the previous Entry takes its place again.
Commenting on Huddo Entries
When a User Comments on the item, a new entry describing the Comment on the Content, is created in the Activity Stream and any previous entries are rolled up into the new entry. If the user chooses to remove this Comment, then the new Stream Entry is removed and the previous Entry takes its place again. Users can also edit their own comments after posting to correct any mistakes quickly and easily.
Recent Updates
All activity performed on the Stream Entries can be viewed on the Recent Updates tab of the Huddo News Gadget. This includes the creation of the original entry as well as all comments and likes on the entry. This allows you to see who responded and when. To make things even simpler, all timestamps are updated in real time, so you are never misinformed!
Thanks Given
All Thanks given by users will now appear in the Discovery tab in the Activity Stream. Further details about the Thanks, including the personal message of recognition, can be seen by opening the Embedded Huddo News Gadget.
Thanks Email Notifications
Users receiving Thanks will also be notified by email. Details about the Thanks, including the personal message of recognition, are included in this email.
"},{"location":"badges/update-images/","title":"Huddo Images","text":""},{"location":"badges/update-images/#update-kudos-images-to-huddo-images","title":"Update Kudos Images to Huddo Images","text":"Huddo Badges is supplied with a set of images for the default Badges, Thanks and Awards. There are updated images available to go with rebrand of Kudos -> Huddo. These will be available as the defaults in the rebranded version of Huddo Badges but existing clients can update these now.
"},{"location":"badges/update-images/#load-updated-images","title":"Load Updated Images","text":"Download the updated Huddo Images
Login to Connections and navigate to the Badges Configurator Community
Select the Settings tab in the BadgesConfigurator widget, scroll to the bottom and click the 'Import' button
Select the downloaded images.zip file and select 'Overwrite Customisations', then 'Upload'
You will get a prompt indicating that 281 records will be updated, press 'OK'
The images will now be updated.
"},{"location":"badges/websphere-faq/","title":"Huddo Badges Installation FAQ","text":""},{"location":"badges/websphere-faq/#installation","title":"Installation","text":""},{"location":"badges/websphere-faq/#activity-stream-items-not-posting","title":"Activity Stream items not posting","text":"Ensure SSL certificates correctly imported to the ISC & trust chain valid
"},{"location":"badges/websphere-faq/#images-do-not-work","title":"Images do not work","text":"Please go to the BadgesConfigurator->Settings tab then restart the Huddo Application.
"},{"location":"badges/websphere-faq/#news-gadget-icon-not-showing-after-updating-url","title":"News Gadget Icon not showing after updating URL","text":"The URL for this is set once, the first time, then never ever updated. Need to go to HOMEPAGE.NR_SOURCE_TYPE and update the IMAGE_URL column.
"},{"location":"badges/install/","title":"Installation","text":"The following section provides an overview of the installation process and the packages that are to be installed. For an experienced Connections administrator or IBM WebSphere Application Server administrator, we expect that this installation process should take no longer than a few hours.
The install process for Huddo involves the following steps:
Please Note: These steps are only applicable to a new install of Huddo. For information about upgrading, please see the Huddo Update Guide.
"},{"location":"badges/install/customising/","title":"Customising","text":""},{"location":"badges/install/customising/#customising-huddo-strings-properties-images-optional","title":"Customising Huddo Strings, Properties & Images (Optional)","text":"You only need to perform this step if you wish to customise the user interface strings used in Huddo or the default properties used by the application, e.g. to use a custom context root etc. If you do not wish to do any of the above, you do not need to follow this step.
"},{"location":"badges/install/customising/#customising-huddo-strings","title":"Customising Huddo Strings","text":"The files for customising Huddo Strings need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Please Note:
This step can be performed at any stage after the installation and is not required to complete the installation.
<installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultLang/{\n NAME_LABEL : \"User Name\",\n MESSAGE_LABEL : \"Notes\",\n MY_NETWORK : \"My Circle\",\n EVERYONE : \"All\",\n THIS_COMMUNITY : \"Community\",\n CONGRATULATIONS_PROFILE_COMPLETE_MSG : \"Congratulations on completing your profile!\",\n GRID_VIEW:\"Grid View\"\n}\nIf you wish to add specific customisations for different languages:
Example:
English: PROFILES_STATS_DIR/ HuddoStrings/en/UserInterfaceLang.js\nEnglish-UK: PROFILES_STATS_DIR/ HuddoStrings/en-gb/UserInterfaceLang.js\nFrench: PROFILES_STATS_DIR/ HuddoStrings/fr/UserInterfaceLang.js\nThe files for customising Huddo Properties need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Available properties files to customise:
Please Note:
<installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultProperties/The custom images need to be placed in the directory given by the Websphere Variable PROFILES_STATS_DIR. These files are then automatically copied into the application directory upon start up.
Please Note:
This step can be performed at any stage after the installation and is not required to complete the installation.
Determine the image(s) to be customised in the HuddoImages folder from the location <installedAppsDir>/<cell name>/Huddo.ear/Huddo.war/defaultImages/
Common files customised include:\n kudos_stream.png (as seen in the Homepage Activity Stream)\n mobile_`<MOBILE_DEVICE>`.png (i.e. mobile_android.png etc \u2013 as seen for Huddo mobile)\nCreate a folder called HuddoImages in the directory given by the PROFILES_STATS_DIR Websphere Variable.
The Huddo Embedded Experience is installed in the same manner as the default Connections Embedded Experience Gadget & the Activity Stream Gadget.
As of Connections 4 CR3 a mechanism was introduced to simplify this process. Simply export the Widget configuration from Connections and import into the IBM Notes Widget Catalog as per documentation here or here.
For Connections 4 CR2 and earlier the process is manual (overview).
Huddo integrates into the Connections Mobile native application and allows users to utilise Huddo features from their mobile device. The integration is performed by modifying the mobile-config.xml configuration. This feature is optional.
"},{"location":"badges/install/mobile/#check-out-the-mobile-configxml-file","title":"Check out the mobile-config.xml file","text":"To add \u2018Huddo Badges\u2019 to the Connections mobile native app menu you must edit the mobile-config.xml file. To update this file, you must check the file out and, after making changes, you must check the file back in, as documented here.
The mobile-config.xml file is a standard Connections file that is used to define the configuration settings for the Connections Mobile native application. To update this file, you must check the file out and, after making changes, check the file back in during the same wsadmin session as the checkout for the changes to take effect.
"},{"location":"badges/install/mobile/#edit-the-mobile-configxml","title":"Edit the mobile-config.xml","text":"Then proceed to add the following Application definition under the <Applications> node
<Application name=\"Huddo\" enabled=\"true\">\n <ApplicationIcon>\n <Android>\n <Hdpi> **../../** Huddo/images/mobile_android.png</Hdpi>\n <Mdpi> **../../** Huddo/images/mobile_android.png</Mdpi>\n <Ldpi> **../../** Huddo/images/mobile_android.png</Ldpi>\n </Android>\n <IOS>\n <Reg> **../../** Huddo/images/mobile_iOS.png</Reg>\n <Retina> **../../** Huddo/images/mobile_iOS.png</Retina>\n </IOS>\n <DefaultLocation> **../../** Huddo/images/mobile_default.png</DefaultLocation>\n </ApplicationIcon>\n <ApplicationLabel>Huddo Badges</ApplicationLabel>\n <ApplicationURL>http://<YOUR_CONNECTIONS_SERVER>/Huddo/mobile</ApplicationURL>\n</Application>\nAdd the following to the <ApplicationList> or DefaultNavigationOrder node: Huddo.
The result should be similar to: <ApplicationsList>profiles,communities,files,wikis,activities,forums,blogs,bookmarks,Huddo</ApplicationsList> or <DefaultNavigationOrder>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Huddo</DefaultNavigationOrder>
Please Note: Make sure you replace <YOUR_CONNECTIONS_SERVER> in all places with the URL of your Connections Environment. If you use a custom context root for Huddo, please ensure you update the references above appropriately. You can customise the name/images shown in the Mobile application by changing the text/URLs above.
Now that you have modified the mobile-config.xml, it must be checked back in to Connections. Please refer to the Connections product documentation for instructions on how to check in the mobile-config.xml file, located here.
Note: the configuration file must be checked in during the same wsadmin session in which it was checked out.
"},{"location":"badges/install/add-widgets/","title":"Add Widgets","text":"So far, you have configured the location of the Huddo widgets. You will now add the widgets to the user interface.
"},{"location":"badges/install/add-widgets/#add-the-configurators-widgets-to-their-communities","title":"Add the Configurators Widgets to their Communities","text":"Login to Connections and navigate to the previously created Badges Configurator Community
Click Community Actions then 'Add Apps' from the drop down menu
Select the Configurator(s) to add to the Community
Click X
The Configurators will now be added to the main view.
Repeat the above steps for each configurator community you created.
We recommend removing all the default widgets from the main page (i.e. Forums, Bookmarks, Files and Feeds) to conserve screen real-estate, and making use of the Configurator widget easier. The default widgets may be removed or added back at any stage.
"},{"location":"badges/install/add-widgets/#remove-the-default-widgets-optional","title":"Remove the Default Widgets (Optional)","text":"Click the Actions drop-down and select Delete
Fill in the required data then click Ok on the Delete prompt
"},{"location":"badges/install/add-widgets/#add-the-huddo-analytics-widget-to-communities","title":"Add the Huddo Analytics Widget to Communities","text":"Login to Connections and navigate to the Huddo Analytics Community
Click Community Actions then 'Add Apps' from the drop down menu
Select HuddoAnalytics
Click X
We recommend removing all the default widgets from the main page (i.e. Forums, Bookmarks, Files and Feeds) to conserve screen real-estate, and making use of the Analytics widgets easier. The default widgets may be removed or added back at any stage.
Your first Huddo Analytics widget will now be added to the main view.
The default view shows the report categories. Once a report category is selected, default report instances for that category can be selected.
Once the report instance is selected, further options for that report can be selected.
The report currently configured is previewed below the options and can be saved for quick viewing on all subsequent page loads.
In the Huddo Analytics community, the Huddo Analytics widgets provide access to Connections Administrator level reports. In other communities, the Huddo Analytics widgets can be added to provide access to Community Manager level reports.
Multiple Huddo Analytics widgets are designed to exist in each community.
"},{"location":"badges/install/add-widgets/#add-the-widgets-to-the-home-page","title":"Add the Widgets to the Home page","text":"The Huddo Leaderboard Widget allows users to view the top 10 contributors either in the entire organisation or in a specific user\u2019s network. Adding the Huddo Leaderboard to all users Home page provides easy access for users to view their progress and drive their behaviour.
By defining the Huddo News Gadget in the Homepage Administration tab, the Huddo News Gadget will be made available to the end users. The following diagram shows how the gadget will be embedded.
Adding widgets to the Home page of Connections is done through the Connections Web page.
Login to Connections as a user assigned to the admin security role of the Homepage application and navigate to the Administration tab.
Click the 'Add another app' button and enter the following details. Once you have defined each widget, click Save and then click the 'Add another widget' button to add the next.
Widget Type Widget Title URL Address Use HCL Connections specific tags Display on My Page Display on Updates Pages Opened by Default Multiple apps Prerequisites Leaderboard iWidget Huddo Leaderboard https://<CONNECTIONS_SERVER_URL>/Huddo/RankingDisplay.xml False False True True False profiles News Gadget Open Social Gadget Huddo News Gadget https://<CONNECTIONS_SERVER_URL>/Huddo/HuddoNewsGadget.xml True False False True False oauthprovider, oauth, opensocial, webresources Awarder iWidget Huddo Awarder https://<CONNECTIONS_SERVER_URL>/Huddo/HuddoAwarder.xml False True False False False - User Analytics iWidget Huddo User Analytics https://<CONNECTIONS_SERVER_URL>/Huddo/AnalyticsDashboard.xml False True False False True - For the Open Social Gadget, select the following:
Click the Add Mapping button.
Highlight each Huddo widget individually in the Disabled widgets section and click Enable
The Huddo widgets will now show in the Enabled widgets list.
It will also show on the Updates and Widgets tabs, if these options were selected.
"},{"location":"badges/install/add-widgets/#add-the-huddo-awarder-widget-to-my-page","title":"Add the Huddo Awarder Widget to My Page","text":"Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.
Open My Page through the Sidebar link or Home button and select Customize
Select Huddo Awarder. If you cannot find it, look under the 'Other' category.
Click X
You will now have the Huddo Awarder Widget displayed in the My Page section. Please Note: The Huddo Awarder cannot be used by a user until they have been allocated awards for distribution. See the User Guide for further information.
"},{"location":"badges/install/add-widgets/#add-the-huddo-user-analytics-widget-to-my-page","title":"Add the Huddo User Analytics Widget to My Page","text":"This step will ensure the User Analytics widget was defined successfully in the Administration section, and is working as expected. This step is a good introduction to User Reports, however is optional.
Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.
Open My Page through the Sidebar link or Home button and select Customize
Select Huddo User Analytics. If you cannot find it, look under the 'Other' category.
Click X
You will now have your first Huddo User Analytics Widget displayed in the My Page section. From here you can start using Analytics by selecting a report category, and then a specific reports instance.
Multiple Huddo User Analytics widgets are designed to exist on My Page.
"},{"location":"badges/install/app/","title":"WebSphere Application","text":"The Huddo Application is provided as a .war file that is to be installed as a WebSphere Application in your Connections server environment. The application provides the Huddo Badges & Analytics engines that drives the reward and recognition of user performance, as well as the widgets for user interaction.
"},{"location":"badges/install/app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"Login to the WebSphere Integrated Solution Console for your Connections environment via a webbrowser.
Enter your administrator User ID and Password, then click the \u201cLog in\u201d button.
"},{"location":"badges/install/app/#install-the-huddowar-file","title":"Install the Huddo.war file","text":"Navigate to Applications \u2192 Application Types \u2192 WebSphere enterprise applications
Click the Install button
Browse the Local File System Path for the downloaded Huddo.war file then Click Next
Check the Fast Path Option then Click Next
Change the Application name to Huddo then Click Next
Highlight the Nodes for the Application, including the IHS Node. Select the Badges Module, click Apply then Next.
Please Note: It\u2019s recommended that you create a separate cluster for Huddo if your Connections install is bigger than 10,000 users. You can do this via the ISC by clicking on Servers > Clusters > WebSphere application server clusters and then clicking New.
Click on Browse and map the default resources as shown. Click Next.
Enter Huddo as the Context Root, then click Next.
Please Note: The Huddo Installation guide assumes that the Context Root is set as \u2018/Huddo\u2019. If you set the Context Root to something other than \u2018/Huddo\u2019, then make sure that you replace \u2018/Huddo\u2019 with your Context Root when entering addresses.
Review the Installation Summary. Click Finish.
Review the Installation Results. Click Save.
Review the Synchronisation Summary. Click OK.
You have now successfully installed Huddo as a WebSphere Enterprise Application. Next, you will need to edit the security settings.
"},{"location":"badges/install/app/#modify-the-huddo-application-security-role-assignments","title":"Modify the Huddo Application Security Role assignments","text":"During this step, we will be defining the authenticated users/groups for each Security Role.
Find Huddo in the list of enterprise applications and click on Huddo to open the application configuration screen
Click Security role to user/group mapping
To ensure that only authorised users have access to Huddo and its data, modify the mapping of the AllServlets and Reader roles to the Special Subjects: All Authenticated in Application/Trusted Realm, then Click OK
Please note: You may set the Reader role to Everyone to grant read-only access to Huddo widget data to unauthenticated users.
"},{"location":"badges/install/app/#ensure-the-signer-certificate-for-the-connections-url-is-trusted","title":"Ensure the Signer Certificate for the Connections URL is Trusted","text":"In order for Huddo to post entries into the Homepage Activity Stream, WebSphere must trust the certificate for the secure URL of your Connections Environment. During this step, we will be importing the environment certificate into the CellDefaultTrustStore.
Navigate to Security \u2192 SSL certificate and key management and then select Key stores and certificates
Select CellDefaultTrustStore
Select Signer certificates
You will now see a list of all trusted certificates.
If the URL of your Connections Environment is listed, skip to Add Huddo Related Strings to Connections
We will now import the public certificate from the IBM HTTP Server to the default trust store in IBM WebSphere Application Server
Click Retrieve from port
Enter the following details of the web server, then click Retrieve Signer Information:
The certificate will now be retrieved. Please confirm the details of the certificate, Click OK. The root certificate is then added to the list of signer certificates.
"},{"location":"badges/install/app/#add-huddo-related-strings-to-connections","title":"Add Huddo Related Strings to Connections","text":"This change will not be picked up by Connections until the servers are restarted. This will be performed at the end of the configuration.
Copy the .properties files from the folder Huddo.ear/Huddo.war/installFiles to the Connections strings customisation directory: /strings Where CONNECTIONS_CUSTOMIZATION_PATH is defined by the WebSphere variable. e.g. /opt/Connections/data/shared/customization/strings
IMPORTANT: If a file of the same name already exists, merge the contents into the existing file.
"},{"location":"badges/install/apply-changes/","title":"Apply Changes","text":"The clusters must be restarted for the widget & mobile configuration changes to take effect.
"},{"location":"badges/install/apply-changes/#restart-the-clusters","title":"Restart the Clusters","text":"Login to the Integrated Solution Console
Navigate to Servers \u2192 Clusters \u2192 WebSphere Application Server Clusters
Select all of the Connections Clusters
Click Ripplestart.
"},{"location":"badges/install/awards/","title":"Awards","text":"Within Huddo Awards, each Award is configurable to only allow a selected group of people to award and receive the award, allowing for better control of Awards. To this effect the Award definitions contain two fields \u2013 Groups with Access : Groups who have access to award this badge; and Awardees: Groups who can be awarded this badge. As part of this step you will need to configure these attributes for each Award definition for your environment.
"},{"location":"badges/install/awards/#create-groups-for-access-control-via-the-badge-configurator","title":"Create groups for access control via the Badge Configurator","text":"Open the User Groups Tab in the Badges Configurator widget and create groups required to set access control permissions for Awards.
Groups can now be created by selecting people, Communities, other groups, importing a CSV file of emails or advanced profile attributes.
Examples:
Open the Awards Tab in the Badges Configurator widget and for each of the Award definitions listed in the table perform the following steps:
Set the Groups with Access field: Select the groups who you wish to grant permissions to Award this badge; i.e. Who can award this badge?
Note : Users selected in this step will need to add the Huddo Awarder widget to their widgets page as per
Set the Awardees field: Select the groups who you wish this Award to be made applicable to, i.e. Who can be awarded this badge. The people selected in this step will see this Award under the HuddoAwards tab in their Profiles as an achievable award.
Note : If you wish to disable a badge, so that it doesn\u2019t appear in anyone\u2019s profile, simply remove all groups from the Awardees field.
Click Save to save your changes.
At this stage, the Huddo Configuration Widgets show in the Communities Customization Palette for all Communities. This means they can be added to any community. However, they are restriced to function only in their respective Community created during this installation process. This message will be shown if theyare added to any other community.
It is possible to remove these Widgets from the Customizations Palette, so that users cannot see/add them to their Communties. This requires modifying the Configuration Widget definitions we created earlier in the widgets-config.xml file and restarting the clusters again.
Checkout and edit the widgets-config.xml file:
Connections 5.5
Connections 6.0
Connections 6.5
Locate the Configuration Widget definitions under the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
Add the attribute showInPalette=\"false\" to each Configurator you wish to hide from the Customizations page. We could not define this attribute earlier, as otherwise we wouldn\u2019t have been able to add the Widgets to the Configuration Communities.
Add the attribute loginRequired=\"true\" to each Community widget if you wish to hide the widgets from users that are not logged in. This is only applicable if your security settings for the Communities application allow users to view communities without logging in.
Your configuration should now look like this:
<widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"MetricsConfigurator\" description=\"metricsConfigurator\" modes=\"view fullpage\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/MetricsConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_METRICS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"FiltersConfigurator\" description=\"filtersConfigurator\" modes=\"view fullpage\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/FiltersConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_FILTERS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoCommunity\" modes=\"view\" url=\"https://<CONNECTIONS_SERVER_URL>/Huddo/CommunityRankingDisplay.xml\" themes=\"wpthemeNarrow wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\">\n <itemSet>\n <item name=\"communityId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\nCheck in the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
Then Restart the clusters.
"},{"location":"badges/install/engine/","title":"Engine","text":"Now that you have loaded the default metrics and badges you are ready to start awarding the badges to users. By default, Huddo Badges will start awarding badges at midnight each day. However, if you would like to start awarding badges immediately rather than waiting until the next scheduled run, you can click the Award Badges Now button.
"},{"location":"badges/install/engine/#award-badges-now","title":"Award Badges Now","text":"Login to Connections and navigate to the Badges Configurator Community
Select the Settings tab in the BadgesConfigurator widget
Click the Award Badges Now button.
Note: If you are installing Huddo Badges to a Connections environment for testing purposes, it is recommended that the following settings are disabled:
The Huddo Widgets provide the interface for user interaction within Connections. During this step, we will be configuring communities for secure access to the configuration interfaces for Badges and Metrics, as well as provisioning the Analytics widget, Badges/Thanks/Awards Summaries and Leaderboard widgets for end users as well as the Huddo News Gadget.
"},{"location":"badges/install/install-widgets/#create-the-configurator-communities","title":"Create the Configurator Communities","text":"The Huddo Badges Configurator Widget is the widget that allows users to define and configure what badges are available for award, and how they are awarded.
The Huddo Metrics Configurator widget allows users to define and configure Huddo Metrics. These metrics monitor Connections usage (as well as external systems) and determine how Huddo are awarded. This involves the use of technical concepts such as JDBC connections and SQL queries.
The Huddo Filters Configurator widget allows users to define and configure Huddo Filters. These filters are then applied to Base Metrics to monitor Connections usage (as well as external systems) and determine how Huddo are awarded. This involves the use of technical concepts such as JDBC connections and SQL queries.
As such, the Configurators have been designed such that it is available to a specific Connections community where membership can be maintained, and hence the configurators can be secured. The Analytics Interface has been designed with the same concept, which is why the following steps will ask you to create four new communities. For smaller environments, you may wish to have a single community for the Badges, Metrics and Filters configurators.
Login to Connections, navigate to Communities and click Create a Community
Enter a name, such as Badges Configurator
Set Access to Restricted
Specify Members as those people you wish to be able to edit Badge definitions. Users can be specified after clicking the Access Advanced Features link.
Enter any tags, web address and description you wish then click Save.
Note: Configurators requires a large column community layout to function properly. Either \u20183 Columns with side menu and banner\u2019, \u20183 Columns with side menu\u2019 or \u20182 Columns with side menu\u2019.
You have now created the first Huddo Configurator Community.
Take note of the CommunityUUID in the URL address, as we will need this later.
Please repeat the above steps for the Metrics & Filters communities if you are not using the same Community for these. If you are using the same Community, please move to Create the Huddo Analytics Administrator Community
"},{"location":"badges/install/install-widgets/#create-the-huddo-analytics-administrator-community","title":"Create the Huddo Analytics Administrator Community","text":"The Huddo Analytics widget allows users to review Connections Usage data over specified time periods. Users have access to both reporting and graph functionalities. The following community will be used to host the Connections Administrator level reports and graphs.
Login to Connections, navigate to Communities and click Start a Community.
Enter a name, such as Huddo Analytics.
Set Access to Restricted.
Specify Members as those people you wish to be able to access Connections Administrator level reports and graphs. In Connections 5+, users can be specified after clicking the Access Advanced Features link.
Enter any tags, web address and description you wish and click Save.
You have now created the Huddo Analytics Administrator Community.
Take note of the CommunityUUID in the URL address, as we will need this later.
"},{"location":"badges/install/install-widgets/#check-out-the-widgets-configxml-file","title":"Check out the widgets-config.xml file","text":"To install most of the Widgets you must edit the widgets-config.xml file for Profiles. This file contains the settings for each defined widget. To update this file, you must check the file out and, after making changes, you must check the file back in, as documented in the links below.
The widgets-config.xml file is a standard Connections file that is used to define the configuration settings for each of the widgets supported by Profiles and Communities. To update settings in the file, you must check the file out and, after making changes, you must check the file back during the same wsadmin session as the checkout for the changes to take effect.
Checking Out the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
"},{"location":"badges/install/install-widgets/#configure-the-profile-widgets","title":"Configure the Profile Widgets","text":"By updating the widgets-config.xml with the code supplied below, the Huddo Badges, Huddo Summary, Profile Progress, Huddo Awards, Award Summary, Huddo Thanks and Thanks Summary widgets will be made available to the end users. The following diagram shows where the widgets will be placed.
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"profiles\" ... >, then under <widgets>, then within <definitions> add the following:
IMPORTANT: Don\u2019t forget to substitute the following placeholders with the corresponding values! CONNECTIONS_SERVER_NAME
<widgetDef defId=\"HuddoSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgeSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n <item name=\"NumberBadges\" value=\"12\"/>\n <item name=\"BadgeViewAllWidgetId\" value=\"HuddoBadges\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoBadges\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgeViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n <item name=\"NumberBadges\" value=\"0\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"ProfileProgress\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ProfileProgress.xml\" modes=\"view\" themes=\"wpthemeNarrow\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"ThanksSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ThanksSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n <item name=\"NumberThanks\" value=\"12\"/>\n <item name=\"ThanksWidgetId\" value=\"HuddoThanks\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"AwardSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AwardSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n <item name=\"NumberBadges\" value=\"12\"/>\n <item name=\"AwardViewAllWidgetId\" value=\"HuddoAwards\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoAwards\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AwardViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoThanks\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ThanksViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\">\n <itemSet>\n <item name=\"ProfilesId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\nWe recommend using absolute URLs in widget-config.xml for reduced configuration complexity. If you have a requirement for the use of relative URLs and are unsure of the implications, you may discuss this with our support team.
Next you must define where to put the instances of the Widgets on the page. This is achieved by adding the following lines to the widgets-config.xml file in:
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"profiles\" ... >, then under <layout ... resourceSubType=\"default\" ... >, then within <page ... pageId=\"profilesView\" ... > add the following:
<widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoBadges\"/>\n<widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoThanks\"/>\n<widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoAwards\"/>\n<widgetInstance uiLocation=\"col1\" defIdRef=\"ProfileProgress\"/>\n<widgetInstance uiLocation=\"col3\" defIdRef=\"HuddoSummary\"/>\n<widgetInstance uiLocation=\"col3\" defIdRef=\"ThanksSummary\"/>\n<widgetInstance uiLocation=\"col3\" defIdRef=\"AwardSummary\"/>\nThe order in which you insert these two instance declarations is the order in which they show on the page. For example, you might wish to show the Summary Tab before the Links widget, and the Huddo Badges, Thanks & Awards Widgets as the last tabs, which would be configured as per the image below. Also make sure that the uiLocation\u2019s match the other ids. If not, then modify to suit your environment.
"},{"location":"badges/install/install-widgets/#configure-configurators-and-community-leaderboard-widgets","title":"Configure Configurators and Community Leaderboard Widgets","text":"By updating the widgets-config.xml with the code supplied below, the Badges Configurator, Metrics Configurator, Filters Configurator, Huddo Community Analytics and Huddo Community Leaderboard widgets will be made available. This will allow them to be placed into Connections Communities, as shown in the following image.
You must define the Widgets and where to find their associated .xml files. You will need the CommunityUuids you took note of earlier.
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
IMPORTANT: Don\u2019t forget to substitute the following placeholders with the corresponding values! YOUR_METRICS_COMMUNITY_UUID, YOUR_BADGES_COMMUNITY_UUID, YOUR_FILTERS_COMMUNITY_UUID , YOUR_ANALYTICS_COMMUNITY_UUID, CONNECTIONS_SERVER_NAME
<widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"MetricsConfigurator\" description=\"metricsConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/MetricsConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_METRICS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"FiltersConfigurator\" description=\"filtersConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/FiltersConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"communityId\" value=\"YOUR_FILTERS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoAnalytics\" description=\"HuddoAnalytics\" modes=\"view edit\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AnalyticsDashboard.xml\" uniqueInstance=\"false\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"adminCommunityId\" value=\"YOUR_ANALYTICS_COMMUNITY_UUID\"/>\n </itemSet>\n</widgetDef>\n<widgetDef defId=\"HuddoCommunity\" modes=\"view\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/CommunityRankingDisplay.xml\" showInPalette=\"false\" themes=\"wpthemeNarrow wpthemeWide\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"communityId\" value=\"{resourceId}\"/>\n </itemSet>\n</widgetDef>\nWe recommend using absolute URLs in widget-config.xml for reduced configuration complexity. If you have a requirement for the use of relative URLs and are unsure of the implications, you may discuss this with our support team.
Next you must define where to put the instance of the Community Leaderboard Widget on the Community page. This is done by adding the following lines to the widgets-config.xml file, in:
Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <layout ... resourceSubType=\"default\" ... >, then within <page ... pageId=\"communityOverview\" ... > add the following:
<widgetInstance uiLocation=\"col3\" defIdRef=\"HuddoCommunity\"/>\nNow that you have modified the widgets-config.xml, it must be checked back in to Connections. Please refer to the Connections product documentation for instructions on how to check in the widgets-config.xml file, located below.
Checking In the Widgets-Config.xml File:
Connections 5.5
Connections 6.0
Connections 6.5
"},{"location":"badges/install/install-widgets/#register-widgets-connections-60-cr1-onwards","title":"Register Widgets (Connections 6.0 CR1 onwards)","text":"Since Connections 6.0 CR1 it is now required to register third-party widgets in the widget-container for increased security. We have scripts and instructions for this here.
"},{"location":"badges/install/install-widgets/#add-huddo-configuration-jsp-to-the-header","title":"Add Huddo configuration JSP to the header","text":"(And add \u2018Give Thanks\u2019 Link in the navigation bar - Optional)
Perform this task to add Huddo Configuration information to Connections pages and to add a link to the Thanks Awarder widget in the Header Menu as shown
below. You need to perform this step even if you do not wish to add the \u2018Give Thanks\u2019 link in order to attach the Huddo Config JSP to the header:
This is achieved by customising the header.jsp file, used for customizing the Connections Navigation bar.
If you have not customised the header.jsp file for your connections environment, please make a copy of the file from:
<WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/Homepage.ear/homepage.war/nav/templates
Paste the copy into the common\\nav\\templates subdirectory in the customization directory: <installdir>\\data\\shared\\customization\\common\\nav\\templates\\header.jsp
Edit the header.jsp file in the customisations directory add the following lines after the Moderation link and before the </ul> HTML tag as shown:
To add the Huddo Config JSP
--%><c:if test=\"${'communities' == appName || 'homepage' == appName || 'profiles' == appName}\"><%--\n --%><c:catch var=\"e\"><c:import var=\"kudosConfig\" url=\"http://${pageContext.request.serverName}/Kudos/kudosConfig.jsp\"/></c:catch><%--\n --%><c:if test=\"${empty e}\"><script type=\"text/javascript\">${kudosConfig}</script></c:if><%--\n--%></c:if><%--\nTo add the Give Thanks link \u2013 This step is OPTIONAL
--%><script type=\"text/javascript\" src=\"/Huddo/scripts/widgets/ThanksAwarderHeader.js\" charset=\"utf-8\"></script><%--\n--%><li id=\"lotusBannerThankSomeone\"><a href=\"javascript:giveThanks('${urlProfiles}');\"><fmt:message key=\"label.header.kudos.givethanks\"/></a></li><%--\nSave and close the file, the changes will take effect when the clusters are restarted. (See next task)
"},{"location":"badges/install/install-widgets/#specify-huddo-analytics-admin-community-for-security","title":"Specify Huddo Analytics Admin Community for Security","text":"This change will not be picked up by Connections until the Huddo Application is restarted. This will be performed at the end of the configuration.
Create the resource.properties file in the Profiles Statistics customisation directory: <PROFILES_STATS_DIR>/HuddoProperties Where PROFILES_STATS_DIR is defined by the WebSphere variable: e.g. /opt/IBM/Connections/data/shared/profiles/statistics/HuddoProperties
Put the following line in the file, replacing <KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID> with the ID of the Huddo Analytics Community created in Task 2.4:
analyticsAdminCommunityID=<KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID>\nIMPORTANT: If a file of the same name already exists, merge the contents into the existing file.
"},{"location":"badges/install/leaderboard/","title":"Leaderboard","text":"In the Install Widgets step you made the Huddo Leaderboard widget available on the Home page for all users. This step meant that any new user would automatically see the Leaderboard widget, and any existing user would be able to add the widget by customizing the page. This step provides a button where you can publish the widget to the homepage of all existing users without them needing to manually add it themselves.
"},{"location":"badges/install/leaderboard/#add-leaderboard-to-homepage","title":"Add Leaderboard to Homepage","text":"Login to Connections and navigate to the Badges Configurator Community
Select the Settings tab in the BdagesConfigurator widget
Click the Add Leaderboard to Users Homepage button
For the proceeding prompt boxes:
All versions of Huddo Badges and Analytics require a licence to function. If you do not have a licence file, please contact us at support@huddo.com
"},{"location":"badges/install/licence/#upload-your-licence-file-in-the-badges-configurator","title":"Upload your licence file in the Badges Configurator","text":"Login to Connections Navigate to the Badges Configurator Community.
Select the Settings tab in the BadgesConfigurator widget. If there are no tabs, this is the default view.
Click the Update Licence button.
Click Choose File and browse to your Huddo.licence file and click Upload.
"},{"location":"badges/install/load-defaults/","title":"Defaults","text":"Huddo Badges is supplied with a set of default metrics and badges to kickstart performance measurement and reward within your organisation. This step loads the supplied metrics and badge definitions into your Connections database, where the widgets and gamification engine can access the definitions to measure and reward.
"},{"location":"badges/install/load-defaults/#load-defaults","title":"Load Defaults","text":"Login to Connections and navigate to the Badges Configurator Community
Select the Settings tab in the BadgesConfigurator widget, scroll to the bottom and click the 'Load Defaults' button
Select:
Note: You will need to have the corresponding Connections Applications installed. As well as have a Standard or Enterprise Licence for Huddo.
Click Save
There is a lot of data that needs to be copied to the database at this point. Therefore this operation may take a couple of minutes, please be patient.
"},{"location":"badges/update/","title":"Update","text":"The following section provides an overview of the update process and the new components that are to be installed. For an experienced Connections administrator or IBM WebSphere Application Server administrator, we expect that this update process should take no longer than one hour.
The update process for Huddo involves the following steps:
Update the Huddo Application in Websphere Application Server
Refresh the Widget Cache
Please Note: The Huddo update guide assumes that the Huddo application in the WebSphere Application server is using the Context Root /Huddo. If the Context Root has been set to something other than /Huddo, then make sure that you replace /Huddo with your Context Root when entering any URLs specified in this document.
There are two methods to perform this. Using wsadmin by following the documentation or through the homepage administration. It is recommended that if you have more than one node to use wsadmin.
Access the Homepage -> Administration setting. Click the \u2018Refresh cache\u2019 option. This may need to be done on each server running Huddo to ensure that each of the node\u2019s caches are properly refreshed.
In order to access Administration section, please ensure the logged in user is in the Homepage \u2018admin\u2019 security role.
"},{"location":"badges/update/update_app/","title":"Update the Application","text":"In order to update Huddo, the Huddo.war file in the application needs to be replaced with the new version through the Web-Sphere Integrated Solutions Console. The .war file contains all the new default data and all other application components.
"},{"location":"badges/update/update_app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"Login to the WebSphere Integrated Solution Console for your Connections environment via a web browser.
"},{"location":"badges/update/update_app/#replace-the-huddowar-file","title":"Replace the Huddo.war file","text":"Navigate to Applications -> Application Types -> WebSphere enterprise applications
Select the Huddo application and click Update.
Select Replace or add a single module option.
Type in Huddo.war in the text field. Note: This is case-sensitive!
Click Browse, navigate to and select the new Huddo.war file.
Follow the prompts clicking Next.
If prompted, click Browse and map the default resources as shown.
Follow the prompts clicking Next.
Click Finish.
Click Save directly to master configuration.
If the Nodes have automatically synchronized and you see this screen - Click OK and move to Restart the Huddo Application. Otherwise continue to Synchronize the nodes.
"},{"location":"badges/update/update_app/#synchronize-the-nodes","title":"Synchronize the nodes","text":"To complete the update process we need to Synchronize all the nodes so that the new version of Huddo is available to them all. You can skip this Task if you have Synchronize changes with Nodes option enabled and you received a synchronization summary as shown above.
Go to System Administration > Nodes.
Select the node that Huddo is installed on. (If you are unsure you may select all the nodes)
Click on Full Resynchronize and wait for the completion message.
"},{"location":"badges/update/update_app/#restart-the-huddo-application","title":"Restart the Huddo Application","text":"Go to Applications > WebSphere Enterprise Applications
Select the Huddo Application Checkbox.
Click Stop and wait for the Application Status column to display the Stopped icon.
Select the Huddo Application Checkbox.
Click Start and wait for the Application Status column to display the Started icon.
"},{"location":"badges/update/updatev6tov7/","title":"Updatev6tov7","text":"The following steps provides an overview of the update process needed for the initial upgrade from v6.0.0 to 7.0.0. These steps should be done in addition to the usual update steps. For an experienced Connections administrator or IBM WebSphere Application Server administrator, we expect that this update process should take no longer than one hour.
"},{"location":"badges/update/updatev6tov7/#update-context-root","title":"Update Context Root","text":""},{"location":"badges/update/updatev6tov7/#update-widgets","title":"Update Widgets","text":""},{"location":"badges/update/updatev6tov7/#homepage","title":"Homepage","text":"Open the Administration tab (on the Homepage) and browse to the Enabled Widgets list. For each Kudos Widget listed, select it and edit.
OLD Widget Title OLD URL Address NEW Widget Title NEW URL Address Leaderboard Kudos Leaderboard https://<CONNECTIONS_SERVER_URL>/Kudos/RankingDisplay.xml Huddo Leaderboard https://<CONNECTIONS_SERVER_URL>/Huddo/RankingDisplay.xml News Gadget Kudos News Gadget https://<CONNECTIONS_SERVER_URL>/Kudos/KudosNewsGadget.xml Huddo News Gadget https://<CONNECTIONS_SERVER_URL>/Huddo/HuddoNewsGadget.xml Awarder Kudos Awarder https://<CONNECTIONS_SERVER_URL>/Kudos/KudosAwarder.xml Huddo Awarder https://<CONNECTIONS_SERVER_URL>/Huddo/HuddoAwarder.xml User Analytics Kudos User Analytics https://<CONNECTIONS_SERVER_URL>/Kudos/AnalyticsDashboard.xml Huddo User Analytics https://<CONNECTIONS_SERVER_URL>/Huddo/AnalyticsDashboard.xml"},{"location":"badges/update/updatev6tov7/#profile-community","title":"Profile & Community","text":""},{"location":"badges/update/updatev6tov7/#update-headerjsp","title":"Update header.jsp","text":""},{"location":"badges/update/updatev6tov7/#update-mobile","title":"Update Mobile","text":""},{"location":"badges/update/updatev6tov7/#update-database","title":"Update Database","text":"Note
The Huddo update guide assumes that the Huddo application in the WebSphere Application server is using the Context Root \u2018/Huddo\u2019. If the Context Root has been set to something other than \u2018/Huddo\u2019, then make sure that you replace \u2018/Huddo\u2019 with your Context Root when entering any URLs specified in this document.
"},{"location":"boards/","title":"Huddo Boards Versions","text":"We are proud to say that Huddo Boards is able to run in many configurations to suit your individual requirements.
This version is hosted by the ISW Huddo team at https://boards.huddo.com. Free trials are available!
Advantages
See here for more information.
"},{"location":"boards/#boards-self-hosted-on-premise","title":"Boards Self-Hosted (On-Premise)","text":"Our Boards Cloud product, installed locally in your infrastructure
Advantages
See install details for Kubernetes or HCL Connections Component Pack.
"},{"location":"boards/#boards-hybrid","title":"Boards Hybrid","text":"(Cloud integrated with HCL Connections On-Premise.)
This version is the best of both worlds if you already have HCL Connections but want the latest and greatest Boards functionality without managing more servers! Huddo Boards Cloud can integrate with your existing HCL Connections on-premise installation.
Advantages
Looks and feels like another application similar to Communities/Blogs etc with:
Requirements
See installation details for more information.
Browser Support
We support the most recent two versions of the following browsers:
Huddo Boards Docker has been tested and confirmed working with the following versions
Minimum Maximum Kubernetesv1.16 v1.27.7 MongoDB v4.0 v7.0.4 Redis v4.0 v6.x"},{"location":"boards/compatibility/#known-incompatible","title":"Known Incompatible","text":""},{"location":"boards/compatibility/#azure-cosmos-db","title":"Azure Cosmos DB","text":"Issue
Unfortunately the Azure Cosmos DB only supports a subset of the MongoDB API. They are working on reducing the gaps. There have been many requests to handle nested indexes and we believe Microsoft are working on it;
https://feedback.azure.com/d365community/idea/3ddf6028-0f25-ec11-b6e6-000d3a4f0858
https://feedback.azure.com/d365community/idea/ad9a64e6-0e25-ec11-b6e6-000d3a4f0858
Suggestion
If Azure is a requirement, we would suggest looking at MongoDB Atlas on Microsoft Azure. This is a fully feature compliant MongoDB hosted in Azure.
Please contact us at support@huddo.com if you need further information.
"},{"location":"boards/helm-charts-kudos/","title":"Helm Chart History (Deprecated)","text":"Warning
These charts are deprecated. Please see the new charts
Release notes for each Helm chart utilised by Boards (for Component Pack vs standalone, and Activity Migration)
"},{"location":"boards/helm-charts-kudos/#standalone-kubernetes","title":"Standalone Kubernetes","text":""},{"location":"boards/helm-charts-kudos/#kudos-boards","title":"kudos-boards","text":"3.0.0 - Webhooks, Annotations for Socket cookie, support service.nodePort
This chart includes a new Boards service. In order to use the image from our repository with the component pack v3 chart you must add the new image tag.
As of release 2021-06-09 you must move all the NOTIFIER_* environment variables from core to events. See our documentation for all supported options.
For example:
events:\n image:\n name: \"\"\n tag: boards-event\n env:\n NOTIFIER_EMAIL_HOST: <smtp-email-host>\n NOTIFIER_EMAIL_USERNAME: <smtp-email-username>\n NOTIFIER_EMAIL_PASSWORD: <smtp-email-password>\n # plus all other NOTIFIER options previously defined in core\n3.0.1 - Minio root credentials, nfs mountOptions
Release notes for each Helm chart utilised by Boards (for Component Pack vs standalone, and Activity Migration)
Important
As of January 2023 we have moved our image hosting. Please follow this guide to configure your Kubernetes with access to our images hosted in Quay.io.
"},{"location":"boards/helm-charts/#standalone-kubernetes","title":"Standalone Kubernetes","text":""},{"location":"boards/helm-charts/#huddo-boards","title":"huddo-boards","text":"Danger
As of huddo-boards-cp-1.0.0.tgz we have changed the Minio pods to run as user 1000 instead of root. You must perform the following command on the shared drive (/pv-connections file system) before using this new chart. The change is backwards compatible.
cd /pv-connections/kudos-boards-minio/\nchown 1000:1000 -R .\nInfo
The previous chart information has moved here
"},{"location":"boards/hybrid/","title":"Boards Hybrid","text":"Hybrid = Cloud integrated with HCL Connections On-Premise
This version is the best of both worlds if you already have HCL Connections but want the latest and greatest Boards functionality without managing more servers! Huddo Boards Cloud can integrate with your existing HCL Connections on-premise installation.
For a comparison of Boards versions please see here
Setting up the Hybrid Boards Cloud involves:
Configure Authentication
Review Security
Contact the Huddo Team with these details
Company name:\nContact name:\nContact email address:\nCONNECTIONS_URL: https://connections.example.com\nCONNECTIONS_CLIENT_ID: huddoboards\nCONNECTIONS_CLIENT_SECRET: [VALUE_PRINTED]\nCONNECTIONS_HOSTNAME_BASE64:\nConfigure HCL Connections extensions
You can get the latest versions of Huddo Boards Docker by subscribing to our own repository in Quay.io as follows:
Create a Quay.io - Red Hat account if you do not already have one.
Email support@huddo.com requesting access to Huddo Boards Docker repository, include your Quay.io account name in the email. We will reply when this is configured on our end.
Get secret to use in Kubernetes
Open Quay.io, In the user menu, click on 'Account Settings'
Click Generate Encrypted Password
Enter your password and click Verify
Download the secret.yml file. Take note of the name of the secret for later use
Use the file downloaded to create the secret (in the required namespace). For example:
# for CP installs\nkubectl create -f username-secret.yml --namespace=connections\n\n# for other Kubernetes installs\nkubectl create -f username-secret.yml --namespace=boards\nImportant - new image hosting
As of January 2023 we have moved our image hosting. Please follow this guide to configure your Kubernetes with access to our images hosted in Quay.io. We have provided new Huddo charts to utilise these images.
Please use the appropriate update command with the latest helm chart. For example:
Huddo Boards in Kubernetes
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nComponent Pack (Activities Plus)
Tip
To upgrade from images in the Component Pack to images hosted by us please follow this guide.
Danger
New chart for Component Pack
As of huddo-boards-cp-1.0.0.tgz we have changed the Minio pods to run as user 1000 instead of root. You must perform the following command on the shared drive (/pv-connections file system) before using this new chart. The change is backwards compatible.
cd /pv-connections/kudos-boards-minio/\nchown 1000:1000 -R .\nhelm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections\nNote
Updates may include minor schema migrations at any time. If you have a need to downgrade versions then we recommend performing a back-up of the Mongo database before you update versions.
"},{"location":"boards/releases/#2023","title":"2023","text":""},{"location":"boards/releases/#2023-12-18","title":"2023-12-18","text":"Feature:
Improvements:
Fixes:
Features:
Support for Domino by REST API
Tip
Please follow this guide to migrate from your existing Proton based Domino authentication
Improvements:
Fixes:
Improvements:
Accessibility
API for Member deletion
Fixes:
--
"},{"location":"boards/releases/#2023-10-31","title":"2023-10-31","text":"Improvements:
Fixes:
Danger
When deployed, this release (and all subsequent) will perform a once-off schema migration for Boards notification/event data in the Mongo database. We recommend performing a back-up of the database before you update versions
Features
Improvements:
Fixes:
Improvements:
Fixes:
KNOWN ISSUE
Danger
When deployed, this release (and all subsequent) will perform major once-off schema migrations for Boards data in the Mongo database. We recommend performing a back-up of the database before you update versions.
Features:
Improvements:
API performance (faster response, less data) of the
Users with the author role now have full edit access on cards that are assigned to them (rather than complete and comment access only)
Fixes:
Improvements:
Microsoft Teams
Fixes:
Danger
When deployed, this release (and all subsequent) will perform major once-off schema migrations for Boards data in the Mongo database. We recommend performing a back-up of the database before you update versions.
Features:
Improvements:
Drag and drop of lists
Fixes:
Card drag and drop
Issue with exporting Board as CSV with special characters (e.g. Umlaut)
Fixes:
Improvements:
Fixes:
Improvements:
Dockerhub
Improvements:
Fixes:
/boardsDockerhub
Improvements:
Fixes:
Dockerhub
Improvements:
Dockerhub
Features:
Performance:
Improvements:
> In browser console, you can enter `boards.setDebug(true)` and press Enter to enable this, then reload the page.\n> You will then get debug logs in the console for all websocket and description lock events.\n> Use `boards.setDebug(false)` to turn this off when done.\nFixes:
Dockerhub
Improvements:
Timeline:
Fixes:
Dockerhub
Fixes:
Dockerhub
API Updates:
PATCH method for /node/{nodeId} to allow changing any attribute of a card or list/webhook/card-moved/{boardId})Translations:
Features / Fixes:
Dockerhub
Security Update:
Dockerhub
Features:
Dockerhub
Features:
Fixes:
Dockerhub
Improvements:
Fixes:
Dockerhub
Features:
Improvements:
Fixes:
Dockerhub
Features:
Improvements:
Fixes:
Dockerhub
Features:
Login to Boards using Single Sign On (SSO) in Microsoft Teams
Note: you will need to:
Fixes:
Dockerhub
Improvements:
Fixes:
Activity Migration:
Dockerhub
Improvements:
Fixes:
Dockerhub
Improvements:
Fixes:
Activity Migration:
Dockerhub
Features:
Improvements:
Fixes:
Activity Migration:
Dockerhub
"},{"location":"boards/releases/#file-store-migration","title":"File store migration","text":"CAUTION: When deployed, this release (and all subsequent) will migrate the minio file store, changing it's structure permanently, we recommend performing a backup of the file store (/pv-connections/kudos-boards-minio) before installation in case there is any need to roll back.
Improvements:
Fixes:
Dockerhub
Fixes:
2021-12-17 Dockerhub
Improvements:
Fixes:
2021-11-23 Dockerhub
Features:
Improvements:
Fixes:
2021-11-18 Dockerhub
Updates:
2021-11-02 Dockerhub
Fixes:
2021-10-26 Dockerhub
Fixes:
2021-10-22 Dockerhub
Features:
Improvements:
Fixes:
2021-09-29 Dockerhub
Improvements:
Reduce reliance on Communities application
Undo / Redo option in Rich Text editor
Fixes:
providerID_1 with new options2021-09-24 Dockerhub
Improvements:
Fixes:
2021-09-17 Dockerhub
Note: this update performs several schema changes on start-up as a once-off. Board content may be temporarily unavailable for a few minutes. Also be aware that downgrading to a previous release will cause access issues in Community boards with role 'inherit'. Please contact us if you have any issues at support@huddo.com
Note: if you encounter 400 bad requests when loading /boards, please see this troubleshooting guide.
Features:
Improvements:
Fixes:
2021-06-24 Dockerhub
Fixes:
FORCE_POLLING in webfront to avoid issues seen when using IHS as reverse proxy/api-boards/2021-06-09 Dockerhub
Breaking change:
Emails are now sent by the events service. You must move the NOTIFIER_* environment variables from core to events as shown in v3 of our chart
Images:
iswkudos/kudos-boards:user-2021-06-09\niswkudos/kudos-boards:provider-2021-06-09\niswkudos/kudos-boards:licence-2021-06-09\niswkudos/kudos-boards:notification-2021-06-09\niswkudos/kudos-boards:webfront-2021-06-09\niswkudos/kudos-boards:core-2021-06-09\niswkudos/kudos-boards:boards-2021-06-09\niswkudos/kudos-boards:activity-migration-2021-06-09\niswkudos/kudos-boards:boards-event-2021-06-09\nNew Features:
Improvements:
Fixes
2021-06-02 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-06-02\niswkudos/kudos-boards:provider-2021-06-02\niswkudos/kudos-boards:licence-2021-06-02\niswkudos/kudos-boards:notification-2021-06-02\niswkudos/kudos-boards:webfront-2021-06-02\niswkudos/kudos-boards:core-2021-06-02\niswkudos/kudos-boards:boards-2021-06-02\niswkudos/kudos-boards:activity-migration-2021-06-02\niswkudos/kudos-boards:boards-event-2021-06-02\nImprovements:
Fixes
2021-05-31 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-05-31\niswkudos/kudos-boards:provider-2021-05-31\niswkudos/kudos-boards:licence-2021-05-31\niswkudos/kudos-boards:notification-2021-05-31\niswkudos/kudos-boards:webfront-2021-05-31\niswkudos/kudos-boards:core-2021-05-31\niswkudos/kudos-boards:boards-2021-05-31\niswkudos/kudos-boards:activity-migration-2021-05-31\niswkudos/kudos-boards:boards-event-2021-05-31\nImprovements:
Fixes:
2021-05-13 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-05-13\niswkudos/kudos-boards:provider-2021-05-13\niswkudos/kudos-boards:licence-2021-05-13\niswkudos/kudos-boards:notification-2021-05-13\niswkudos/kudos-boards:webfront-2021-05-13\niswkudos/kudos-boards:core-2021-05-13\niswkudos/kudos-boards:boards-2021-05-13\niswkudos/kudos-boards:activity-migration-2021-05-13\niswkudos/kudos-boards:boards-event-2021-05-13\nImprovements:
Link to Files / Upload to Files
Allow custom NodeMailer email options (insecure tls etc)
core.env.NOTIFIER_EMAIL_OPTIONS: \"{\\\"ignoreTLS\\\": true,\\\"tls\\\":{\\\"rejectUnauthorized\\\":false}}\"
Fixes:
2021-05-04 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-05-04\niswkudos/kudos-boards:provider-2021-05-04\niswkudos/kudos-boards:licence-2021-05-04\niswkudos/kudos-boards:notification-2021-05-04\niswkudos/kudos-boards:webfront-2021-05-04\niswkudos/kudos-boards:core-2021-05-04\niswkudos/kudos-boards:boards-2021-05-04\niswkudos/kudos-boards:activity-migration-2021-05-04\niswkudos/kudos-boards:boards-event-2021-05-04\nImprovements:
Fixes:
2021-04-29 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-04-29\niswkudos/kudos-boards:provider-2021-04-29\niswkudos/kudos-boards:licence-2021-04-29\niswkudos/kudos-boards:notification-2021-04-29\niswkudos/kudos-boards:webfront-2021-04-29\niswkudos/kudos-boards:core-2021-04-29\niswkudos/kudos-boards:boards-2021-04-29\niswkudos/kudos-boards:activity-migration-2021-04-29\niswkudos/kudos-boards:boards-event-2021-04-29\nNew:
Fixes:
2021-04-26 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-04-26\niswkudos/kudos-boards:provider-2021-04-26\niswkudos/kudos-boards:licence-2021-04-26\niswkudos/kudos-boards:notification-2021-04-26\niswkudos/kudos-boards:webfront-2021-04-26\niswkudos/kudos-boards:core-2021-04-26\niswkudos/kudos-boards:boards-2021-04-26\niswkudos/kudos-boards:activity-migration-2021-04-26\nImprovements:
Fixes:
Activity Migration
2021-03-22 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-22\niswkudos/kudos-boards:provider-2021-03-22\niswkudos/kudos-boards:licence-2021-03-22\niswkudos/kudos-boards:notification-2021-03-22\niswkudos/kudos-boards:webfront-2021-03-22\niswkudos/kudos-boards:core-2021-03-22\niswkudos/kudos-boards:boards-2021-03-22\niswkudos/kudos-boards:activity-migration-2021-03-22\nImprovements:
Fixes:
2021-03-16 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-16\niswkudos/kudos-boards:provider-2021-03-16\niswkudos/kudos-boards:licence-2021-03-16\niswkudos/kudos-boards:notification-2021-03-16\niswkudos/kudos-boards:webfront-2021-03-16\niswkudos/kudos-boards:core-2021-03-16\niswkudos/kudos-boards:boards-2021-03-16\niswkudos/kudos-boards:activity-migration-2021-03-16\nImprovements:
Ability to transition between providers
Fixes:
2021-03-10 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-10\niswkudos/kudos-boards:provider-2021-03-10\niswkudos/kudos-boards:licence-2021-03-10\niswkudos/kudos-boards:notification-2021-03-10\niswkudos/kudos-boards:webfront-2021-03-10\niswkudos/kudos-boards:core-2021-03-10\niswkudos/kudos-boards:boards-2021-03-10\niswkudos/kudos-boards:activity-migration-2021-03-10\nFixes:
Activity Migration:
2021-03-05 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-05\niswkudos/kudos-boards:provider-2021-03-05\niswkudos/kudos-boards:licence-2021-03-05\niswkudos/kudos-boards:notification-2021-03-05\niswkudos/kudos-boards:webfront-2021-03-05\niswkudos/kudos-boards:core-2021-03-05\niswkudos/kudos-boards:boards-2021-03-05\niswkudos/kudos-boards:activity-migration-2021-03-05\nFeatures:
API integrations with
Leave a Board
Fixes:
2021-03-04 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-04\niswkudos/kudos-boards:provider-2021-03-04\niswkudos/kudos-boards:licence-2021-03-04\niswkudos/kudos-boards:notification-2021-03-04\niswkudos/kudos-boards:webfront-2021-03-04\niswkudos/kudos-boards:core-2021-03-04\niswkudos/kudos-boards:boards-2021-03-04\niswkudos/kudos-boards:activity-migration-2021-03-04\nFixes:
2021-03-03 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-03-03\niswkudos/kudos-boards:provider-2021-03-03\niswkudos/kudos-boards:licence-2021-03-03\niswkudos/kudos-boards:notification-2021-03-03\niswkudos/kudos-boards:webfront-2021-03-03\niswkudos/kudos-boards:core-2021-03-03\niswkudos/kudos-boards:boards-2021-03-03\niswkudos/kudos-boards:activity-migration-2021-03-03\nImprovements:
Fixes:
2021-02-19 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-02-19\niswkudos/kudos-boards:provider-2021-02-19\niswkudos/kudos-boards:licence-2021-02-19\niswkudos/kudos-boards:notification-2021-02-19\niswkudos/kudos-boards:webfront-2021-02-19\niswkudos/kudos-boards:core-2021-02-19\niswkudos/kudos-boards:boards-2021-02-19\niswkudos/kudos-boards:activity-migration-2021-02-19\nImprovements:
Fixes:
2021-01-19 Dockerhub
Images:
iswkudos/kudos-boards:user-2021-01-19\niswkudos/kudos-boards:provider-2021-01-19\niswkudos/kudos-boards:licence-2021-01-19\niswkudos/kudos-boards:notification-2021-01-19\niswkudos/kudos-boards:webfront-2021-01-19\niswkudos/kudos-boards:core-2021-01-19\niswkudos/kudos-boards:boards-2021-01-19\niswkudos/kudos-boards:activity-migration-2021-01-19\nImprovements:
Fixes:
2020-12-14
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-12-14\niswkudos/kudos-boards:provider-2020-12-14\niswkudos/kudos-boards:licence-2020-12-14\niswkudos/kudos-boards:notification-2020-12-14\niswkudos/kudos-boards:webfront-2020-12-14\niswkudos/kudos-boards:core-2020-12-14\niswkudos/kudos-boards:boards-2020-12-14\niswkudos/kudos-boards:activity-migration-2020-12-14\nFeatures:
Added fix for Activities that had already been imported and used the equivalent permission set in Activities
boards.yaml
migration:\n env:\n # test = report activities and board membership that can be updated\n # true = run the fix and report results\n FIX_COMMUNITY_OWNERS_ONLY: test|true\n2020-12-12
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-12-12\niswkudos/kudos-boards:provider-2020-12-12\niswkudos/kudos-boards:licence-2020-12-12\niswkudos/kudos-boards:notification-2020-12-12\niswkudos/kudos-boards:webfront-2020-12-12\niswkudos/kudos-boards:core-2020-12-12\niswkudos/kudos-boards:boards-2020-12-12\niswkudos/kudos-boards:activity-migration-2020-12-12\nFeatures:
2020-11-13
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-11-13\niswkudos/kudos-boards:provider-2020-11-13\niswkudos/kudos-boards:licence-2020-11-13\niswkudos/kudos-boards:notification-2020-11-13\niswkudos/kudos-boards:webfront-2020-11-13\niswkudos/kudos-boards:core-2020-11-13\niswkudos/kudos-boards:boards-2020-11-13\niswkudos/kudos-boards:activity-migration-2020-11-13\nImprovements:
2020-11-02
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-11-02\niswkudos/kudos-boards:provider-2020-11-02\niswkudos/kudos-boards:licence-2020-11-02\niswkudos/kudos-boards:notification-2020-11-02\niswkudos/kudos-boards:webfront-2020-11-02\niswkudos/kudos-boards:core-2020-11-02\niswkudos/kudos-boards:boards-2020-11-02\niswkudos/kudos-boards:activity-migration-2020-11-02\nImprovements:
Fixes:
2020-10-14
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-10-14\niswkudos/kudos-boards:provider-2020-10-14\niswkudos/kudos-boards:licence-2020-10-14\niswkudos/kudos-boards:notification-2020-10-14\niswkudos/kudos-boards:webfront-2020-10-14\niswkudos/kudos-boards:core-2020-10-14\niswkudos/kudos-boards:boards-2020-10-14\niswkudos/kudos-boards:activity-migration-2020-10-14\nImprovements:
Fixes:
2020-10-05
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-10-05\niswkudos/kudos-boards:provider-2020-10-05\niswkudos/kudos-boards:licence-2020-10-05\niswkudos/kudos-boards:notification-2020-10-05\niswkudos/kudos-boards:webfront-2020-10-05\niswkudos/kudos-boards:core-2020-10-05\niswkudos/kudos-boards:boards-2020-10-05\niswkudos/kudos-boards:activity-migration-2020-10-05\nFeatures:
Improvements:
Fixes:
2020-09-18
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-09-18\niswkudos/kudos-boards:provider-2020-09-18\niswkudos/kudos-boards:licence-2020-09-18\niswkudos/kudos-boards:notification-2020-09-18\niswkudos/kudos-boards:webfront-2020-09-18\niswkudos/kudos-boards:core-2020-09-18\niswkudos/kudos-boards:boards-2020-09-18\niswkudos/kudos-boards:activity-migration-2020-09-18\nFeatures:
Improvements:
Fixes:
2020-08-24
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-08-24\niswkudos/kudos-boards:provider-2020-08-24\niswkudos/kudos-boards:licence-2020-08-24\niswkudos/kudos-boards:notification-2020-08-24\niswkudos/kudos-boards:webfront-2020-08-24\niswkudos/kudos-boards:core-2020-08-24\niswkudos/kudos-boards:boards-2020-08-24\niswkudos/kudos-boards:activity-migration-2020-08-24\nFeatures:
Improvements:
Fixes:
2020-07-10
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-07-10\niswkudos/kudos-boards:provider-2020-07-10\niswkudos/kudos-boards:licence-2020-07-10\niswkudos/kudos-boards:notification-2020-07-10\niswkudos/kudos-boards:webfront-2020-07-10\niswkudos/kudos-boards:core-2020-07-10\niswkudos/kudos-boards:boards-2020-07-10\niswkudos/kudos-boards:activity-migration-2020-07-10\nImprovements:
Activity Migration:
2020-06-17
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-06-17\niswkudos/kudos-boards:provider-2020-06-17\niswkudos/kudos-boards:licence-2020-06-17\niswkudos/kudos-boards:notification-2020-06-17\niswkudos/kudos-boards:webfront-2020-06-17\niswkudos/kudos-boards:core-2020-06-17\niswkudos/kudos-boards:boards-2020-06-17\niswkudos/kudos-boards:activity-migration-2020-06-17\nFixes:
Activity Migration:
2020-06-05
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-06-05\niswkudos/kudos-boards:provider-2020-06-05\niswkudos/kudos-boards:licence-2020-06-05\niswkudos/kudos-boards:notification-2020-06-05\niswkudos/kudos-boards:webfront-2020-06-05\niswkudos/kudos-boards:core-2020-06-05\niswkudos/kudos-boards:boards-2020-06-05\nPlease see our Cloud blog
Improvements:
New Features:
Fixes:
2020-04-09
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-04-09\niswkudos/kudos-boards:provider-2020-04-09\niswkudos/kudos-boards:licence-2020-04-09\niswkudos/kudos-boards:notification-2020-04-09\niswkudos/kudos-boards:webfront-2020-04-09\niswkudos/kudos-boards:core-2020-04-09\niswkudos/kudos-boards:boards-2020-04-09\nFixes:
2020-03-06
Dockerhub
Images:
iswkudos/kudos-boards:user-2020-03-06\niswkudos/kudos-boards:provider-2020-03-06\niswkudos/kudos-boards:licence-2020-03-06\niswkudos/kudos-boards:notification-2020-03-06\niswkudos/kudos-boards:webfront-2020-03-06\niswkudos/kudos-boards:core-2020-03-06\niswkudos/kudos-boards:boards-2020-03-06\nFixes:
Language support:
\"supported\": {\n \"ar\":[],\n \"bg\":[],\n \"ca\":[],\n \"cs\":[],\n \"da\":[],\n \"de\": [],\n \"el\":[],\n \"en\": [\"US\"],\n \"es\":[],\n \"fi\":[],\n \"fr\":[],\n \"he\":[],\n \"hr\":[],\n \"hu\":[],\n \"it\":[],\n \"ja\":[],\n \"kk\":[],\n \"ko\":[],\n \"nb\":[],\n \"nl\":[],\n \"pl\":[],\n \"pt\":[],\n \"ro\":[],\n \"ru\":[],\n \"sk\":[],\n \"sl\":[],\n \"sv\":[],\n \"th\":[],\n \"tr\":[],\n \"zh\":[\"TW\"]\n },\n \"default\": \"en\"\nMost data is stored in MongoDB hosted by MongoDB Atlas in a Google Cloud datacentre (EU West). User images are stored in Google Cloud Object storage.
"},{"location":"boards/security/#mongodb-atlas-is-secured-by","title":"MongoDB Atlas is secured by:","text":"There are NO passwords stored by the app.
"},{"location":"boards/standalone/","title":"Boards Standalone Deployment","text":"Tip
This document outlines a standalone (all in one) deployment of Huddo Boards using docker-compose. This can be used as a proof of concept, staging deployment or even a production deployment for a limited number of users (e.g. < 500).
You may run all services including database and file storage on one server, or you can use an external Mongo database or S3 file store.
Like all other deployments of Huddo Boards, this requires configuration of 2 domains: Application and API. e.g. boards.huddo.com and boards.api.huddo.com
RHEL (or Centos 7) server with:
You may use an external proxy or send traffic directly to the server. If you are sending traffic directly to the server, you will need pem encoded certificate (with full chain) and key.
The implementation of this will require 2 domains in your environment (typically \"boards.\" and \"boards-api.\" subdomains), one for the web app and one for the API.
"},{"location":"boards/standalone/#persistence","title":"Persistence","text":"Boards uses 3 types of persistent data:
Each of these may use external services (e.g. Mongo Atlas) or the included services in the template (this hugely changes the server demand).
Warning
If using the included services, you must have a separate mount point on your server for persistent data with a directory each for mongo and s3(minio) storage. You will need to map directories for mongo and s3 containers to this data drive. This data drive should be backed up however you currently backup data.
"},{"location":"boards/standalone/#deployment","title":"Deployment","text":""},{"location":"boards/standalone/#access-to-images","title":"Access to Images","text":"Please follow this guide to get access to our images in Quay.io so that we may give you access to our repositories and templates. Once you have access please run the docker login command available from the Quay.io interface, for example:
docker login -u=\"<username>\" -p=\"<encrypted-password>\" quay.io\ndownload the configuration files:
update all example values in both files as required. Most required variables are in the template, for more information see the Kubernetes docs
The minio credentials are are used to both set in the minio service and access it from other services, the x-minio-access field is used as the username in minio and the x-minio-secret is used as the password you can view minios documentation on these fields here: https://docs.min.io/minio/baremetal/reference/minio-server/minio-server.html#root-credentials and an example of the values used here: https://docs.min.io/docs/minio-docker-quickstart-guide.html the standard seems to be around 20 characters all caps/numbers for the username and around 40 characters any case / number for the password.
The nginx proxy setup assumes that you will have 2 subdomains as stated above with a shared (wildcard) ssl certificate, both the certificate and key file for these domains need to be accessible to the server and the path filled in under the proxy section. you may use separate certificates if needed by mounting them both in the proxy service with appropriate naming and using the new mounted files in the nginx.conf.
Tip
Authentication: the user environment variables in the compose file assume you are installing this in a Connections environment, these can be removed or replaced with a Microsoft 365 tenant info as shown here. For more info on other authentication methods contact the huddo team. The default variables for Domino are also included and can be uncommented as required.
Start the deployment using the following command
docker-compose -f ./boards.yml up -d\nThe mount point on your system for the mongo data needs to include user 1001 with read/write access, see bitnami/mongodb for more info and full documentation.
if your setup is not running, first check the db logs and make sure it is not complaining about permissions to write the files it needs docker-compose logs mongo
To remove any other network configuration/hops on the docker server you should be able to: curl -H \"Host: your.web.url\" --insecure https://localhost This should return the html from webfront curl -H \"Host: your.api.url\" --insecure https://localhost This should return the html for the swagger api documentation curl -H \"Host: your.api.url\" --insecure https://localhost/health This should return \"{listening: 3001}\"
If the above works then you may have configuration issues with a proxy / dns not pointing traffic to the docker server properly If it does not work then the local nginx proxy is probably not working, check docker-compose logs nginx to see if it points out any misconfiguration
The core image has ping enabled and has access to all others so you can use it to test connectivity
docker-compose exec -it core sh\nping user\nping mongo\n... etc\nYou can create your own tours by calling the boards.setTours() function in console.
Open dev tools with Cmd-Shift-I or Ctrl-Shift-I then got to the console tab
Tours are currently disabled by default, to enable them type boards.enableTours() then press Enter, now reload your page and the tours will be available.
boards.setTours([{\n id: 'create-first-board-mobile',\n routes: ['/', '/my', '/public'],\n sizes: ['isMobile'],\n disabled: false,\n disableAnimation: false,\n steps: [\n {\n spotlight: '.create-board-fab button',\n title: 'Welcome to Boards',\n body: [\"Let's get started\", 'Click here'],\n actions: [\n { title: 'More information', url: 'https://huddo.com/boards' },\n ],\n },\n {\n spotlight: '.template-dialog .HuddoMuiPaper-root',\n when: '.template-dialog .HuddoMuiPaper-root .step-1',\n title: 'Pick a template',\n body: \"Boards can have a template. Select one and click 'Next'\",\n hideArrow: true,\n placement: 'bottom-end',\n },\n {\n spotlight: '.template-dialog .HuddoMuiPaper-root',\n when: '.template-dialog .HuddoMuiPaper-root .step-2',\n title: 'Name the Board',\n body: 'Invite other members to collaborate with you in this Board.',\n },\n ],\n}])\nOrganisation administrators can view a list of all boards in their organisation, with actions available to manage these boards and their members. To access the new view in
a) Boards Cloud
On the Huddo Boards homepage / My Boards page, click your organisation on the left sidebar, then click the Boards tab to view the list of boards:
b) Boards On-Premise
Open Admin Settings, then your organisation
Under Content management click Boards
The boards data can be sorted by clicking on the column headers:
"},{"location":"boards/admin/content-member-management/#searching","title":"Searching","text":"Boards can be searched by board name or by owner.
Click the search icon to the left of the column name to search:
"},{"location":"boards/admin/content-member-management/#by-board-name","title":"By Board Name","text":"Type a board name to filter the results:
"},{"location":"boards/admin/content-member-management/#by-owner","title":"By Owner","text":"Search for a group or user and then select an entity to show only boards that have that owner:
"},{"location":"boards/admin/content-member-management/#showhide-archived-boards","title":"Show/hide archived boards","text":"Archived boards can be shown or hidden by using the switch in the Archived column header:
Members for each individual board can be viewed and modified by clicking the Edit Members button on the right of the board row:
Clicking on a board in the list will select it. All boards can be selected using the top-most checkbox in the header. Once boards are selected, options become available to action on those boards:
"},{"location":"boards/admin/content-member-management/#archive","title":"Archive","text":"Archive the selected boards.
"},{"location":"boards/admin/content-member-management/#restore","title":"Restore","text":"Restore boards that are archived.
"},{"location":"boards/admin/content-member-management/#manage-ownership","title":"Manage Ownership","text":"This action will show a dialog allowing new owners to be added and/or existing owners removed from the boards that are selected:
"},{"location":"boards/admin/content-member-management/#delete","title":"Delete","text":"Danger
Use this action cautiously and at your own risk.
Delete the selected boards and all their data permanently.
"},{"location":"boards/admin/content-member-management/#find-and-replace-owner-on-all-boards","title":"Find and replace owner on all boards","text":"It may be necessary to replace a board owner with someone else across all boards in the organisation, for example if an employee has left the company and the boards data needs to be accessed by their replacement. To do this:
Click the Find and replace owner on all boards button to bring up a dialog:
Search for and select the current owner to replace and the new/replacement owner. Groups can be selected:
Click the Replace Owner button to confirm the owner replacement:
Note
an undo action will temporarily appear at the bottom left of screen if you wish to cancel this action
Remove OAuth ClientID from user.env
Comment out the CLIENT_ID for the provider to be deactivated:
user:\n env:\n # CONNECTIONS_CLIENT_ID\n # MSGRAPH_CLIENT_ID\nRedeploy the Helm chart
For example:
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nReload webpage
The login option should be removed
Note: admins only - on premise
This process allows you to link user accounts across multiple login methods by their email address. This gives the user the ability to login with either account, and more importanly collaborate with users in either system (ie Connections, Microsoft etc).
"},{"location":"boards/admin/link-users/#prerequisites","title":"Prerequisites","text":"Profiles are synchronised
In order to link accounts it is highly recommended to synchronise accounts to ensure they exist in the Boards database. Please follow these instructions first
user microservicereplicaCount: 1You can view the logs of the user service to see an output of changes
The command is safe to run multiple times. The list of already linked should show the previous links, and there will be no new changes unless more users have been imported into the Boards DB.
Environment variables
This process links users in 2 difference clients. We utilise environment variables to initialise the process, e.g.
user:\n replicaCount: 1\n env:\n PROFILE_LINK_CLIENT_PRIMARY: 5ef2d52f6283afc12efd55a4\n PROFILE_LINK_CLIENT_SECONDARY: 5fd6974dd7c5ede08711432d\n # Determines if user accounts are linked on the email prefix (before the @ symbol), default is false\n # i.e. jsmith@huddo.com & jsmith@isw.net.au\n # PROFILE_LINK_EMAIL_PREFIX_ONLY: true\nRedeploy the Helm chart
For example:
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nReview the logs
The logs should output in this format. Note the users who have been updated/ignored. On subsequent runs the people in updated will appear in noChange instead.
Remove Environment variables above and redeploy the Helm chart
Licence management is available at an organisation level for Huddo Boards.
To access these settings, sign in to Huddo Boards as an administrator of your organisation. Click your profile image and then Admin Settings:
The licence(s) for your org will be shown, each one can be opened for more information.
Here you can see all the users who have been assigned a licence.
'Named Users' licences can be specifically added, removed or reassigned. 'Open Licence' is available to any user in an organisation on a first come first serve basis. These can also be reassigned if required.
Note that Org Configs are created automatically for all orgs with default settings.
"},{"location":"boards/admin/manage-licences/#buy-huddo-boards-via-admin-settings","title":"Buy Huddo Boards via Admin Settings","text":"For users accessing Huddo Boards via O365, HCL Connections (hybrid and collab.cloud), Apple ID, Google, LinkedIn and Facebook, subscriptions can be purchased via the Huddo Boards Admin Settings in your web browser.
Navigate to Admin Settings and then select to 'Buy Online'.
Your subscription will be updated automatically.
"},{"location":"boards/admin/manage-licences/#buy-huddo-boards-via-ms-teams","title":"Buy Huddo Boards via MS teams","text":"As an O365 administrator, you can buy Huddo Boards for your organisation via MS Teams.
Navigate to Huddo Boards MyBoards Dashboard via More Added Apps in MS Teams and under your profile image locate Admin Settings.
Click Organisation to see your org details.
Under 'Licences' select to 'Buy Online.'
On-premise Huddo Boards installs can contact us for quote requests and licence activation keys at hello@huddo.com
Huddo Boards cloud users can request a quote via Huddo Boards Admin Settings in web or MS Teams, or via email at hello@huddo.com. Please do not hesitate to ask questions or request a call to discuss your subscription requirements further.
In addition to online check out, we can receive purchase orders and provide invoices for payment.
Pricing can be found here https://www.huddo.com/pricing
"},{"location":"boards/admin/org-config/","title":"Manage Config","text":""},{"location":"boards/admin/org-config/#manage-organisation-config","title":"Manage Organisation Config","text":"Configuration options are available at an organisation level for Huddo Boards. Changing these settings will affect all Huddo Boards users in your organisation.
To access these settings, sign in to Huddo Boards as an administrator of your organisation. Click your profile image and then Admin Settings:
The config for your org will be shown, hover on the info (i) icons for more information on each setting
Changing a setting will immediately save/update the Org Config for all users.
Note: Org Configs are created automatically for all orgs with default settings.
"},{"location":"boards/admin/replace-group-membership/","title":"Replacing Group Membership","text":"Note: admins only - on premise
This service is designed to replace Board memberships for groups in one login client with replacement groups in another login client.
For example; in order to remove login via Connections but still retain access to all your boards, you will need to replace the group based memberships with replacement groups. For example Sharepoint sites instead of Communities.
"},{"location":"boards/admin/replace-group-membership/#important-notes","title":"Important Notes","text":"target ID below should be set as the ID for your intended login method (ie Microsoft), and the source that of the login method being removed (ie Connections). These IDs are visible in the URL of the admin page.replicaCount: 1boards-app microservice to see an output of changes to source/target groupsYou have created replacement groups in the target system and have records of the old ID to the new ID.
"},{"location":"boards/admin/replace-group-membership/#process","title":"Process","text":"Create CSV Map File
This process utilises a CSV file to define a map between the old ID and new ID, in the format:
<NAME_OF_GROUP>,<COMMUNITY_ID>,<SHAREPOINT_SITE_ID>\nFor example:
group-map.csv
Huddo Team,95bf5326-ee35-4e4a-b121-9b6970f86931,532fbe3d-239e-4421-b8c0-4c4d2eb87204\nSecret with CSV
Create a secret in the Boards namespace (ie boards) from your CSV file
kubectl create secret generic group-map-secret --from-file=./group-map.csv -n boards\nEnvironment variables
Set the following environment variables to mount the secret created above at a file path in the pod.
app:\n replicaCount: 1\n volumes:\n - name: group-map-volume\n secret:\n secretName: group-map-secret\n volumeMounts:\n - name: group-map-volume\n mountPath: /usr/share/groupmapsecret\n env:\n GROUP_MAP_CSV: groupmapsecret/group-map.csv\n GROUP_MAP_TARGET_CLIENT: 5fd6974dd7c5ede08711432d\n GROUP_MAP_SOURCE_CLIENT: 5ef2d52f6283afc12efd55a4\nRedeploy the Helm chart
For example:
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nReview the logs
The logs should output in this format. See that each group was mapped from a Source to a Target and how many members/nodes were updated with the new value.
Remove Environment variables above and redeploy the Helm chart
When a user leaves the organisation, you may want to deactivate their current login sessions with Boards. You may also need to remove their private information (name, email and image) from the Boards database. This can be achieved with the following steps:
Open Admin Settings, then your Organisation
Under User management click Revoke
Select whether to Anonymise the user name, email and image
Search and select the user to revoke, click Revoke
This process ensures that all users in your Connections/Microsoft accounts exist in the Boards database.
Note: this is only necessary if you are linking user accounts in bulk
"},{"location":"boards/admin/sync-profiles/#connections","title":"Connections","text":"You can now synchronise all user profiles from Connections by opening the Admin => Org => Connections client page (e.g. /admin/5eeff4a3b7adaab62352362f/client/5fd6974dd7c5ede08711432d) This service utilises the Connections Profiles Admin API which is only basic auth, so you need to add credentials for a user (eg wasadmin) who has the Admin role on the Profiles application.
Similarly, on the Microsoft client page there is another UI control for synchronising users; this uses the current user OAuth session (assuming Advanced Features have been approved)
"},{"location":"boards/admin/sync-profiles/#process","title":"Process","text":"Both of these controls allow you to run a 'test' which reports back how many new users it found, before running the process for real.
"},{"location":"boards/admin/transfer-ownership-unlink/","title":"Transfer Ownership & Unlink User Accounts","text":"Note: admins only - on premise
In the user interface a user can unlink an account alias and transferring content ownership to their primary. This process is designed to perform the same action in bulk for all users which belong to specific clients (login methods) who have linked accounts.
"},{"location":"boards/admin/transfer-ownership-unlink/#important-notes","title":"Important Notes","text":"to client target ID below should be set as the ID for your intended login method (ie Microsoft), and the from that of the login method being removed (ie Connections). These IDs are visible in the URL of the admin page.replicaCount: 1boards-app microservice to see an output of changes to source/target groupsEnvironment variables
Set the following environment variables
app:\n replicaCount: 1\n env:\n TRANSFER_AND_UNLINK_TO_CLIENT: 5fd6974dd7c5ede08711432d\n TRANSFER_AND_UNLINK_FROM_CLIENT: 5ef2d52f6283afc12efd55a4\nRedeploy the Helm chart
For example:
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nReview the logs
The logs should output information in this format. Note each transfer of content ownership from => to and the number of associated nodes/members/invites that were updated, before the alias is unlinked from the primary.
Remove Environment variables above and redeploy the Helm chart
Note: admins only - on premise
This process is designed for migrating away from a provider but keeping access to Boards. e.g. Connections to Sharepoint Sites. Please follow the steps very carefully.
When the URL of the on-prem hosting environment changes, content stored in Huddo Boards may also need to be updated.
The below will change all URLs in the names, descriptions and links for each node (card/board/comment). Replace both the domain and newDomain with your old and new URLs. The domain variable is a regular expression (regex) that needs the initial / and trailing /ig; in place and any special characters escaped with \\, such as in the example below.
Connect to the Mongo DB hosting the Boards database and run the following in the mongo shell
show dbs\n// select to the boards database (name is different for CP)\nuse kudos-boards-service OR boards-app\n\ndomain = /host\\.example\\.com/ig\nnewDomain = 'host.company.com'\nEach 2 lines of code (nodeNames, nodeDesc & nodeLinks) updates one bit of a node and can be run independently of each other.
"},{"location":"boards/admin/url-update/#node-names","title":"Node Names","text":"nodeNames = db.nodes.find({ name: { $regex: domain }}, { name: 1 }).toArray();\nnodeNames.forEach(n => db.nodes.updateOne({ _id: n._id }, { $set: { name: n.name.replace(domain, newDomain) }}) )\nnodeDesc = db.nodes.find({ description: { $regex: domain }}, { description: 1 }).toArray();\nnodeDesc.forEach(n => db.nodes.updateOne({ _id: n._id }, { $set: { description: n.description.replace(domain, newDomain) }}) )\nnodeLinks = db.nodes.find({ 'links.url': { $regex: domain }}, { links: 1 }).toArray();\nnodeLinks.forEach(n => db.nodes.updateOne({ _id: n._id }, { $set: { links: n.links.map(link => { link.url = link.url.replace(domain, newDomain); return link; })}}) )\nThis integration enables you to manage users in Auth0 for login to Huddo Boards. Auth0 will maintain a directory of your users for Huddo Boards. This enables standalone use of Huddo Boards if you do not have any of the other supported authentication providers in your business.
You may switch to using one of our other supported authentication providers at a later stage should you wish.
"},{"location":"boards/auth0/#setting-up-a-new-auth0-tenant-for-use-with-huddo-boards","title":"Setting up a new Auth0 tenant for use with Huddo Boards","text":"Huddo Boards for the name and choose Regular Web Applications as the type.In the table below, copy your auth0 domain (listed at the top of the page) into the relevant fields, replacing <domain> with 'your-domain.au.auth0.com' where applicable
Field Value Application Logo https://boards.huddo.com/img/logo-small.png Token Endpoint Authentication Method Post Allowed Callback URLs https://boards.huddo.com/auth/auth0/<domain>/callback Allowed Web Origins https://boards.huddo.com Allowed Origins (CORS) https://*.huddo.comImplicit, Authorization Code, Refresh Token and Client CredentialsIn order to allow your users to find each other, we need to enable one of Auth0's api features.
APIs and next to the Auth0 Management API Click the settings button.Machine to Machine Applications and next to Huddo Boards click the AUTHORIZED slider so it is enabled as below.> next to the slider aboveread:users scope then click UPDATECreate New User and provide the email and password for the user you wish to add. Leave the Connection as Username-Password-AuthenticationIf you aren't redirected to the users page, click them to open it
Edit under the users nameSaveOnce your Auth0 tenant has been activated you will get an email from our support team with confirmation, you may then go to Huddo Boards and use your Auth0 domain as the team name to login.
After submitting your Team Name, you'll be asked for the email address and password associated with your Auth0 user account, to finalise your login.
"},{"location":"boards/auth0/migrating/","title":"Migrating","text":""},{"location":"boards/auth0/migrating/#migrating-your-auth0-tenant-from-kudos-to-huddo","title":"Migrating your Auth0 tenant from Kudos to Huddo","text":"To start using your Auth0 tenant in Huddo Boards, you need to make a few changes to allow login at the new address.
Login to Auth0 and go to the applications list
Click your Kudos Boards application and change the following fields
In the table below, copy your auth0 domain (listed at the top of the page) into the relevant fields, replacing <domain> with 'your-domain.au.auth0.com' where applicable
Field Value Application Logo https://boards.huddo.com/img/logo-small.png Token Endpoint Authentication Method Post Allowed Callback URLs https://boards.huddo.com/auth/auth0/<domain>/callback Allowed Web Origins https://boards.huddo.com Allowed Origins (CORS) https://*.huddo.com"},{"location":"boards/cloud/","title":"Boards Cloud","text":"Boards Cloud is Huddo Boards as a service hosted and managed by the Huddo Team. Accessible now at boards.huddo.com.
You can start using Boards Cloud immediately! Look for the enterprise collaboration platform you want to integrate with in the documentation menu for instructions on getting started.
"},{"location":"boards/cloud/updates/","title":"Boards Cloud Updates","text":"Please see here for recent changes to Huddo Boards Cloud
"},{"location":"boards/cloud/updates/#2024","title":"2024","text":""},{"location":"boards/cloud/updates/#january","title":"January","text":"2024-01-09
Improvements:
Microsoft Teams integrations
faster opening of cards
Fixes:
2024-01-04
Fixes:
2023-12-22
Fixes:
2023-12-18
Improvements:
Fixes:
2023-12-13
Improvements:
2023-12-12
Fixes:
Fixes:
2023-12-07
Fixes:
2023-12-04
Feature:
2023-12-01
Fixes:
2023-11-29
Feature:
Fixes:
2023-11-28
Fixes:
Improvements:
2023-11-23
Fixes:
2023-11-13
Improvements:
Accessibility
2023-11-09
Improvements:
Fixes:
2023-10-31
Improvements:
Fixes:
2023-10-25
Improvements:
Fixes:
2023-10-23
Features:
2023-10-20
Fixes:
2023-10-19
Improvements:
2023-09-29
Improvements:
Fixes:
2023-09-22
Improvements:
Fixes:
2023-09-19
busboy dependency used for file upload (includes security patches, node support etc)2023-09-14
Improvements:
Fixes:
2023-09-12
Improvments:
2023-09-08
Fixes:
2023-09-07
Features:
Improvements:
Fixes:
2023-08-15
Fixes:
2023-08-09
Fixes:
2023-08-07
Improvements:
Fixes:
2023-07-14
Fixes:
2023-07-12
Fixes:
2023-07-05
Fixes:
2023-07-04
Fixes:
2023-07-03
Improvements:
Microsoft Teams
Fixes:
2023-06-26
Improvements:
Fixes:
2023-06-21
Fixes:
2023-06-19
Fixes:
2023-06-15
Improvements:
Fixes:
2023-06-06
Improvements:
Fixes:
2023-05-26
Features:
2023-05-23
Improvements:
Drag and drop of lists
Cards can be Archived+Deleted from the card modal toolbar.
Fixes:
Card drag and drop
Button for copying a template says \"Copy Template\" instead of \"Copy Board\"
2023-05-16
Improvements:
Organisation view of members & groups
localised format of dates in CSV export
Fixes:
2023-05-05
Features:
Improvements:
Fixes:
2023-04-21
Features:
Fixes:
2023-04-12
Features:
2023-03-20
Fixes:
2023-03-17
Improvements:
2023-03-15
Improvements:
Fixes:
2023-03-10
Features:
Fixes:
2023-02-20
Fixes:
2023-01-31
Features:
Improvements:
2023-01-24
Improvements:
2022-12-14
Improvements:
Fixes:
2022-11-29
Improvements:
Fixes:
2022-11-08
Features:
Performance:
Improvements:
Fixes:
2022-10-17
Updates for Timeline
2022-10-05
2022-10-04
2022-09-27
2022-09-05
2022-07-08
2022-06-23
2022-06-21
2022-06-10
2022-06-07
2022-05-20
2022-05-10
2022-05-09
2022-04-28
2022-04-19
2022-04-07
2022-04-06
2022-03-21
2022-03-11
2022-03-09
2022-03-03
2022-02-17
2022-01-31
2022-01-14
2022-01-04
2021-12
2021-11
2021-10
2021-09
2021-08
2021-07
2021-06
If you have not customised the apps.jsp file for your connections environment, please make a copy of the file.
You can access the file from:
<WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/Homepage.ear/homepage.war/nav/templates/menu\nPaste the copy into the common\\nav\\templates subdirectory in the customization directory:
<installdir>\\data\\shared\\customization\\common\\nav\\templates\\menu\\apps.jsp\nTo add the Huddo Boards App Link add the following lines towards the bottom of the apps.jsp file before the </table> element
--%><tr><%--\n --%><th scope=\"row\" class=\"lotusNowrap\"><%--\n --%><img width=\"16\" src=\"https://boards.huddo.com/img/logo-small.png\" /><%--\n --%><a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]\"><%--\n --%><strong><fmt:message key=\"connections.component.name.kudos.boards\" /></strong><%--\n --%></a><%--\n --%></th><%--\n --%><td class=\"lotusNowrap lotusLastCell\"><%--\n --%><a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]?redirect_to=/todos/assigned\"><%--\n --%><fmt:message key=\"label.menu.kudos.boards.todos\" /><%--\n --%></a><%--\n --%></td><%--\n --%><td class=\"lotusNowrap lotusLastCell\"><%--\n --%><a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]?redirect_to=/templates/public\"><%--\n --%><fmt:message key=\"label.menu.kudos.boards.templates\" /><%--\n --%></a><%--\n --%></td><%--\n--%></tr><%--\nWhere [CONNECTIONS_HOSTNAME_BASE64]is
connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20= There are many free online services to do this, ie hereSave and close the file
Add the Huddo Boards Strings for the Apps Menu
Download the strings files and extract the files to the Connections strings customisation directory:
<CONNECTIONS_CUSTOMIZATION_PATH>/strings\nNote: Please append the lines to the files if they already exist. Extra languages can also be added
The changes will take effect when the cluster(s) are restarted
If you have not customised the apps.jsp file for your connections environment, please make a copy of the file.
You can access the file from:
<WAS_home>/profiles/<profile_name>/installedApps/<cell_name>/Homepage.ear/homepage.war/nav/templates/menu\nPaste the copy into the common\\nav\\templates subdirectory in the customization directory:
<installdir>\\data\\shared\\customization\\common\\nav\\templates\\menu\\apps.jsp\nTo add the Huddo Boards app links add the following lines towards the bottom of the apps.jsp file before the </table> element
--%><tr><%--\n --%><th scope=\"row\" class=\"lotusNowrap\"><%--\n --%><img width=\"16\" src=\"https://[CONNECTIONS_URL]/boards/img/logo-small.png\" /><%--\n --%><a href=\"https://[CONNECTIONS_URL]/boards/auth/connections\"><%--\n --%><strong><fmt:message key=\"connections.component.name.kudos.boards\"/></strong><%--\n --%></a><%--\n --%></th><%--\n --%><td class=\"lotusNowrap lotusLastCell\"><%--\n --%><a href=\"https://[CONNECTIONS_URL]/boards/auth/connections?redirect_to=/todos/assigned\"><%--\n --%><fmt:message key=\"label.menu.kudos.boards.todos\"/><%--\n --%></a><%--\n --%></td><%--\n --%><td class=\"lotusNowrap lotusLastCell\"><%--\n --%><a href=\"https://[CONNECTIONS_URL]/boards/auth/connections?redirect_to=/templates/public\"><%--\n --%><fmt:message key=\"label.menu.kudos.boards.templates\"/><%--\n --%></a><%--\n --%></td><%--\n--%></tr><%--\nNote: you must replace [CONNECTIONS_URL]
Save and close the file
Add the Huddo Boards Strings for the Apps Menu
Download the strings files and extract the files to the Connections strings customisation directory:
<CONNECTIONS_CUSTOMIZATION_PATH>/strings\nNote: Please append the lines to the files if they already exist. Extra languages can also be added
The changes will take effect when the cluster(s) are restarted
In order for Huddo Boards to authenticate with your Connections environment, you must define a new OAuth widget.
SSH to the HCL Connections Deployment Manager (substitute the alias)
ssh root@[DEPLOY_MANAGER_ALIAS]\nStart wsadmin (substitute your credentials)
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/\n./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd\nRegister the new application definition
execfile('oauthAdmin.py')\nOAuthApplicationRegistrationService.addApplication('huddoboards', 'Huddo Boards', 'https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]/callback')\nWhere [CONNECTIONS_HOSTNAME_BASE64]is
connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20= There are many free online services to do this, ie hereTo view the uniquely created client clientSecret
OAuthApplicationRegistrationService.getApplicationById('huddoboards')\nThese commands will print the definition. Please take note of the clientSecret. We will use this later on as
CONNECTIONS_URL=https://connections.example.com\nCONNECTIONS_CLIENT_ID=huddoboards\nCONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]\nSteps to configure the Huddo Boards application for auto-authorize (also documented here)
Tip
this step is optional but recommended and can be done at any time.
Add the new line to the following section in [cellname]/oauth20/connectionsProvider.xml
Note: keep any existing values and add the new line for huddoboards
<parameter name=\"oauth20.autoauthorize.clients\" type=\"ws\" customizable=\"true\">\n <value>huddoboards</value>\n</parameter>\nRecreate the provider via this command:
Note: update the wsadmin credentials and the [PATH_TO_CONFIG_FILE]
./wsadmin.sh -lang jython -conntype SOAP -c \"print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')\" -user connectionsadmin -password passw0rd\nRestart the WebSphere servers
In order for Huddo Boards to authenticate with your Connections environment, you must define a new OAuth widget.
SSH to the HCL Connections Deployment Manager (substitute the alias)
ssh root@[DEPLOY_MANAGER_ALIAS]\nStart wsadmin (substitute your credentials)
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/\n./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd\nRegister the new application definition
execfile('oauthAdmin.py')\nOAuthApplicationRegistrationService.addApplication('huddoboards', 'Huddo Boards', 'https://[BOARDS_URL]/auth/connections/callback')\nWhere [BOARDS_URL] is the URL of the Boards installation specified previously
To view the uniquely created client clientSecret
OAuthApplicationRegistrationService.getApplicationById('huddoboards')\nThese commands will print the definition. Please take note of the clientSecret. We will use this later on as
CONNECTIONS_URL=https://connections.example.com\nCONNECTIONS_CLIENT_ID=huddoboards\nCONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]\nSteps to configure the Huddo Boards application for auto-authorize (also documented here)
Tip
this step is optional but recommended and can be done at any time.
Add the new line to the following section in [cellname]/oauth20/connectionsProvider.xml
Note: keep any existing values and add the new line for huddoboards
<parameter name=\"oauth20.autoauthorize.clients\" type=\"ws\" customizable=\"true\">\n <value>huddoboards</value>\n</parameter>\nRecreate the provider via this command:
Note: update the wsadmin credentials and the [PATH_TO_CONFIG_FILE]
./wsadmin.sh -lang jython -conntype SOAP -c \"print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')\" -user connectionsadmin -password passw0rd\nRestart the WebSphere servers
Note
This step is optional
"},{"location":"boards/connections/header-hybrid/#connections-header-via-sso","title":"Connections Header via SSO","text":"To integrate yours Connections Header into Huddo Boards Cloud please follow these steps:
Reverse Proxy Config
Please follow the instructions as part of the HTTP Proxy config.
Enable in Boards
Open the Boards admin page, select your Organisation, and then the Connections client
Tick the checkbox for Load Connections Header via SSO and click Save
Once you reload the page you should see the Connections header!
Warning
This option is no longer recommended.
Download the Application
The latest .ear from here
Login to WebSphere ISC
This is usually accessible through a URL like:
https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\nOpen Environment -> WebSphere variables
Ensure the scope is selected as the Cell
Click New
Set the following details and click OK
EXTERNAL_APPS_CONFIG\n{\"boards\":\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]\"}\nWhere [CONNECTIONS_HOSTNAME_BASE64] is
connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=The config may require saving. Click Save if presented
Open Applications -> Application Types -> WebSphere enterprise applications
Click Install
Select the file and click Next
You can rename the App if you wish, then click Next
Select the checkbox for the module
Hold shift while selecting both the WebServer and the AppsCluster from the list
Click Apply
The Servers should update on the right hand side
Click Next
Click Next
Click Finish
The config may prompt to save. Click Save
The application should now be installed
Start the Header App
Tick the box next to the app name, and click Start
The app should now start. Congratulations, you have installed the app!
You should now be able to load app can now be loaded at this path
https://[CONNECTIONS_URL]/boards\nFor example:
https://connections.example.com/boards\nImportant
This step is only required if you are hosting Huddo Boards on a different domain to HCL Connections.
"},{"location":"boards/connections/header-on-prem/#connections-header-via-sso","title":"Connections Header via SSO","text":"If you are running Boards on a standalone domain we recommend integrating with the Connections Header using SSO. Please follow these steps:
Reverse Proxy Config
Please follow the instructions as part of the HTTP Proxy config.
Enable in Boards
Open the Boards admin page, select your Organisation, and then the Connections client
Tick the checkbox for Load Connections Header via SSO and click Save
Once you reload the page you should see the Connections header!
Warning
This option is no longer recommended.
Download the Application
The latest .ear from here
Login to WebSphere ISC
This is usually accessible through a URL like:
https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\nOpen Environment -> WebSphere variables
Ensure the scope is selected as the Cell
Click New
Set the following details and click OK
EXTERNAL_APPS_CONFIG\n{\"boards\":\"https://[BOARDS_URL]/auth/connections\"}\nWhere [BOARDS_URL] is the URL of the Boards installation specified previously
The config may require saving. Click Save if presented
Open Applications -> Application Types -> WebSphere enterprise applications
Click Install
Select the file and click Next
You can rename the App if you wish, then click Next
Select the checkbox for the module
Hold shift while selecting both the WebServer and the AppsCluster from the list
Click Apply
The Servers should update on the right hand side
Click Next
Click Next
Click Finish
The config may prompt to save. Click Save
The application should now be installed
Start the Header App
Tick the box next to the app name, and click Start
The app should now start. Congratulations, you have installed the app!
Open Boards
You should now be able to load the Boards app with HCL Connections header at this path:
https://[CONNECTIONS_URL]/boards\nFor example:
https://connections.example.com/boards\nOpen WebSphere ISC
This is usually accessible through a URL like:
https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\nOpen Servers -> Server Types => Web servers
Click on the name of your web server
Click Edit on the http.conf
Boards can be configured either as a standalone domain, or on the same domain as HCL Connections. For details on these config options please see here. Please follow the appropriate instructions below:
"},{"location":"boards/connections/httpd/#a-new-boards-domain","title":"a) New Boards Domain","text":"The following configuration should be set when Huddo Boards is deployed as a new domain.
<VirtualHost *:443>\n ServerName [BOARDS-URL]\n ProxyPreserveHost On\n ProxyPass / http://[KUBERNETES_NAME]/\n ProxyPassReverse / http://[KUBERNETES_NAME]/\n\n SSLEnable\n # Disable SSLv2\n SSLProtocolDisable SSLv2\n # Set strong ciphers\n SSLCipherSpec TLS_RSA_WITH_AES_128_CBC_SHA\n SSLCipherSpec TLS_RSA_WITH_AES_256_CBC_SHA\n SSLCipherSpec SSL_RSA_WITH_3DES_EDE_CBC_SHA\n</VirtualHost>\nInfo
The following configuration is required to load the Connections Header via SSO from the Boards domain.
Note
Customise the SetEnvIf domain below as required for your Boards domain.
# Huddo Boards - allow CORS related access control headers in requests for\nHeader unset Access-Control-Allow-Origin\nSetEnvIf Origin \"https://(boards\\.huddo\\.com)$\" AccessControlAllowOrigin=$0\nHeader always set Access-Control-Allow-Origin %{AccessControlAllowOrigin}e env=AccessControlAllowOrigin\nHeader always set Access-Control-Allow-Credentials \"true\" env=AccessControlAllowOrigin\nHeader always set Access-Control-Allow-Methods \"POST, GET, OPTIONS, DELETE, PUT\"\nHeader always set Access-Control-Allow-Headers \"x-requested-with, Content-Type, origin, authorization, accept, client-security-token, Cache-Control, Content-Language, Expires, Last-Modified, Pragma, slug, X-Update-Nonce,x-ic-cre-request-origin,x-ic-cre-user,x-lconn-auth,x-shindig-st\"\nHeader always set Access-Control-Expose-Headers \"Content-Disposition, Content-Encoding, Content-Length, Date, Transfer-Encoding, Vary, ETag, Set-Cookie, Location, Connection, X-UA-Compatible, X-LConn-Auth, X-LConn-UserId, Authorization,x-ic-cre-user\" env=AccessControlAllowOrigin\n\n# Allow LtpaToken usage from Boards domain\nHeader edit Set-Cookie ^(.*)$ \"$1; Secure; SameSite=None\"\nYou may need to apply similar changes anywhere that the LtpaToken is issued. For example:
via an nginx proxy:
# Allow LtpaToken usage from Boards domain\nproxy_cookie_flags LtpaToken Secure SameSite=None;\nproxy_cookie_flags LtpaToken2 Secure SameSite=None;\nVerse integration - see HCL Domino documentation
Tip
Users may need to logout and login to Connections again for the LtpaToken cookie to be re-issued with SSO enabled
"},{"location":"boards/connections/httpd/#b-existing-hcl-connections-domain","title":"b) Existing HCL Connections domain","text":"The following configuration should be set when Huddo Boards is deployed at a context root under the existing HCL Connections domain.
<VirtualHost *:443>\n ServerName [CONNECTIONS_URL]\n\n #Huddo Boards\n ProxyPass \"/boards\" \"http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/boards\"\n ProxyPassReverse \"/boards\" \"http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/boards\"\n ProxyPass \"/api-boards\" \"http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/api-boards\"\n ProxyPassReverse \"/api-boards\" \"http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/api-boards\"\n #End Huddo Boards\n</VirtualHost>\nWhere:
[BOARDS-URL] is the URL of your Boards deployment (as a domain)[CONNECTIONS-URL] is the URL of your HCL Connections deployment[KUBERNETES_NAME] is the hostname/IP of the master in your cluster[KUBERNETES_PORT] is the port of your Ingress Controller (ie 32080)For an on-premise (component pack) installation of Huddo Boards, you may use an external Keycloak server to provide authentication. To achieve this, you need to setup a new application in the same keycloak realm as connections. This new application must issue access_tokens that have full access to the connections api.
When using this approch, Huddo Boards will get tokens from keycloak but will still validate them against connections using the url /connections/opensocial/oauth/rest/people/@me/@self
The following ENV variables should be set to achieve this:
Key Descriptionuser.env.CONNECTIONS_CLIENT_ID Your Keycloak application client-id user.env.CONNECTIONS_CLIENT_SECRET Your Keycloak application client-secret user.env.CONNECTIONS_URL HCL Connections URL, e.g. https://connections.example.com user.env.CONNECTIONS_KEYCLOAK_URL Your Keycloak URL e.g. https://login.example.com user.env.CONNECTIONS_KEYCLOAK_REALM Your Keycloak realm user.env.CONNECTIONS_KEYCLOAK_PATH Optional: Keycloak pathDefault: /auth/realmsCustomise this to /realms as of Keycloak v22"},{"location":"boards/connections/migration/","title":"Migration of Activities to Huddo Boards (using standalone Mongo/Redis)","text":"Tip
If you are using Component Pack please follow this guide
As part of the installation process for Huddo Boards you can run the migration service to move the existing Activities into Huddo Boards.
Info
Please review the Roles page for details on how Community Activity membership is interpreted & presented by Boards
"},{"location":"boards/connections/migration/#difference-between-the-individual-import","title":"Difference between the individual import","text":"There is an individual import, when you hover over the orange Create button and click Import from Activities. It can be accessed by end-users, but only usess the Activities API. While this works for basic Activitiy functionality, it doesn't include any extra features from Huddo Boards for WebSphere. Card colors are one example of those features.
So you'll need to use the migration service described here to import all data in the new Boards.
"},{"location":"boards/connections/migration/#process-overview","title":"Process Overview","text":"This service will:
Ensure you have updated the following variables as applicable in the global.env section of your boards.yaml file downloaded previously
sharedDrive.server 192.168.10.1 or websphereNode1 IP or Hostname of the server with the Connections shared drive mount sharedDrive.path /opt/HCL/Connections/data/shared or /nfs/data/shared Path on the mount to the Connections shared drive sharedDrive.storage 10Gi (optional) The capacity of the PV and PVC sharedDrive.accessMode ReadOnlyMany (optional) The accessMode of the PV and PVC sharedDrive.volumeMode Filesystem (optional) The volumeMode of the PV and PVC sharedDrive.persistentVolumeReclaimPolicy Retain (optional) The persistentVolumeReclaimPolicy of the PV and PVC sharedDrive.storageClassName manual (optional) The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) sharedDrive.spec Example Using a fully custom spec - e.g. FlexVolume or hostPath env.CONNECTIONS_URL httsp://connections.example.com URL of your Connections environment env.FILE_PATH_ACTIVITIES_CONTENT_STORE /data/activities/content Path of the Activities content store relative to the Connections shared drive.Must start with /data as the Connections shared drive is mounted at /dataEnsure you set the IP and path for the NFS volume mount. env.API_GATEWAY https://[CONNECTIONS_URL]/api-boards URL of the Boards API.Used by files attached to a board. URL. env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME connectionsadmin Credentials for user with admin role on the Activities application.See ISC => Applications => Activities => Security role to user mapping env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD adminpassword Password for the Activities administrator env.CONNECTIONS_DB_TYPE db2 or mssql or oracle SQL database type hosting Activities. env.CONNECTIONS_DB_HOST dbserver.company.com SQL Server hostname env.CONNECTIONS_DB_PORT 50000 or 1433 or 1531 SQL Server connection port env.CONNECTIONS_DB_USER dbuser SQL Server user name env.CONNECTIONS_DB_PASSWORD dbpassword SQL Server user password env.CONNECTIONS_DB_SID DATABASE SQL Server SIDNote: applicable to Oracle env.CONNECTIONS_DB_DOMAIN domain SQL Server connection stringNote: applicable to Microsoft SQL env.CONNECTIONS_DB_CONNECT_STRING HOSTNAME=<host>;PROTOCOL=... or <host>:<port>/<sid> SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle env.PROCESSING_PAGE_SIZE 10 (default) Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database env.PROCESSING_LOG_EVERY 50 (default) The migration process logs every 50 Activities completed env.IMMEDIATELY_PROCESS_ALL false (default) Process ALL Activities on service startup. env.COMPLETE_ACTIVITY_AFTER_MIGRATED false Mark the old Activity data as complete env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED false Create link to new Board in old Activity Example:
migration:\n # configure access to the Connections Shared mount\n sharedDrive:\n # Replace with IP address for the NFS server\n server: 192.168.10.1\n # for example \"/opt/HCL/Connections/data/shared\" or \"/nfs/data/shared\"\n path: /nfs/data/shared\n env:\n FILE_PATH_ACTIVITIES_CONTENT_STORE: /data/activities/content\n API_GATEWAY: https://example.com/api-boards\n CONNECTIONS_URL: httsp://connections.example.com\n CONNECTIONS_ACTIVITIES_ADMIN_USERNAME: connectionsadmin\n CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD: adminpassword\n CONNECTIONS_DB_TYPE: db2\n CONNECTIONS_DB_HOST: cnx-db.internal\n CONNECTIONS_DB_PORT: 50000\n CONNECTIONS_DB_USER: lcuser\n CONNECTIONS_DB_PASSWORD: xxx\n # ...\nPlease deploy the following chart with the same configuration boards.yaml file used to deploy the huddo-boards chart
helm upgrade huddo-boards-activity-migration https://docs.huddo.com/assets/config/kubernetes/huddo-boards-activity-migration-1.0.0.tgz -i -f ./boards.yaml --namespace boards --recreate-pods\nNote: the new sharedDrive parameters described above. You may also need to delete the previously name chart
The migration interface is accessible at https://[BOARDS_URL]/admin/migration to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.
You can also set the global.env.IMMEDIATELY_PROCESS_ALL variable if you wish to migrate every Activity without the UI.
You can check the pod logs for the activity-migration to see progress of the running migration:
kubectl logs -n boards -f $(kubectl get pod -n boards | grep activity-migration | awk '{print $1}')\nWhen the helm chart was installed in another namespace (helm upgrade ... --namespace my-boards), change -n boards to your modified namespace like -n my-boards. To stop following the logs, press [Ctrl] + [C].
For example
"},{"location":"boards/connections/migration/#after-migration-complete","title":"After Migration Complete","text":"The Migration service can be removed. Please use the following command
helm delete huddo-boards-activity-migration --purge\nTurn off the Activities application in WebSphere ISC
Basic instructions for adding Huddo Boards into the HCL Connections mobile application
"},{"location":"boards/connections/mobile-app-hybrid/#mobile-app-integration","title":"Mobile App Integration","text":"Check-out mobile-config.xml
execfile(\"mobileAdmin.py\")\nMobileConfigService.checkOutConfig(\"/LCCheckedOut\", AdminControl.getCell())\nEdit mobile-config.xml
Applications element and add the following Application:<Application name=\"Boards\" enabled=\"true\">\n <ApplicationIcon>\n <Android>\n <Hdpi>http://boards.huddo.com/img/logo-small.png</Hdpi>\n <Mdpi>http://boards.huddo.com/img/logo-small.png</Mdpi>\n <Ldpi>http://boards.huddo.com/img/logo-small.png</Ldpi>\n </Android>\n <IOS>\n <Reg>http://boards.huddo.com/img/logo-small.png</Reg>\n <Retina>http://boards.huddo.com/img/logo-small.png</Retina>\n </IOS>\n <DefaultLocation>http://boards.huddo.com/img/logo-small.png</DefaultLocation>\n </ApplicationIcon>\n <ApplicationLabel>Huddo Boards</ApplicationLabel>\n <ApplicationURL>https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]</ApplicationURL>\n</Application>\nwhere [CONNECTIONS_HOSTNAME_BASE64] is your Connections hostname base64 encoded. E.g. connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=
ApplicationsList or DefaultNavigationOrder element and append Boards. For example:<ApplicationsList>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards</ApplicationsList>\nor
<DefaultNavigationOrder>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards</DefaultNavigationOrder>\nSave and check-in mobile-config.xml
MobileConfigService.checkInConfig(\"/LCCheckedOut\", AdminControl.getCell())\nSync the Nodes as required
Basic instructions for adding Huddo Boards into the HCL Connections mobile application
"},{"location":"boards/connections/mobile-app-on-prem/#mobile-app-integration","title":"Mobile App Integration","text":"Check out mobile-config.xml
execfile(\"mobileAdmin.py\")\nMobileConfigService.checkOutConfig(\"/LCCheckedOut\", AdminControl.getCell())\nEdit mobile-config.xml
Find the Applications element and add the following Application:
<Application name=\"Boards\" enabled=\"true\">\n <ApplicationIcon>\n <Android>\n <Hdpi>http://[BOARDS_URL]/img/logo-small.png</Hdpi>\n <Mdpi>http://[BOARDS_URL]/img/logo-small.png</Mdpi>\n <Ldpi>http://[BOARDS_URL]/img/logo-small.png</Ldpi>\n </Android>\n <IOS>\n <Reg>http://[BOARDS_URL]/img/logo-small.png</Reg>\n <Retina>http://[BOARDS_URL]/img/logo-small.png</Retina>\n </IOS>\n <DefaultLocation>http://[BOARDS_URL]/img/logo-small.png</DefaultLocation>\n </ApplicationIcon>\n <ApplicationLabel>Huddo Boards</ApplicationLabel>\n <ApplicationURL>https://[BOARDS_URL]/auth/connections</ApplicationURL>\n</Application>\nwhere [BOARDS_URL] is your configured URL for Boards.
Find the ApplicationsList or DefaultNavigationOrder element and append Boards. For example:
<ApplicationsList>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards</ApplicationsList>\nor
<DefaultNavigationOrder>profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards</DefaultNavigationOrder>\nSave and check-in mobile-config.xml
MobileConfigService.checkInConfig(\"/LCCheckedOut\", AdminControl.getCell())\nSync the Nodes as required
Huddo Boards connects to your Connections servers over HTTPS via OAuth.
"},{"location":"boards/connections/security/#ip-allow-list","title":"IP Allow List","text":"Our servers use a static outbound IP address. If your environment uses a firewall to access the Connections servers you will need to add the following IP to your allow-list
34.91.118.129/32 GCloud Prod EU Cluster NAT\n34.129.215.36/32 GCloud Staging Cluster NAT\nWe communicate over HTTPS, so the port 443 must be allowed
Add Huddo Boards Hybrid widgets into HCL Connections on-premise environments
"},{"location":"boards/connections/widgets-hybrid/#community-widget","title":"Community Widget","text":"SSH to the WAS Deployment Manager
Start wsadmin
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin\n./wsadmin.sh -lang jython -user wasadmin -password <password-here>\nCheck out the widgets-config.xml file.
execfile(\"profilesAdmin.py\")\nProfilesConfigService.checkOutWidgetConfig(\"/LCCheckedOut\", AdminControl.getCell())\nEdit the widgets-config.xml file.
Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following:
<!-- Huddo Boards -->\n<widgetDef defId=\"HuddoBoards\" modes=\"view fullpage\" url=\"{webresourcesSvcRef}/web/com.ibm.social.urliWidget.web.resources/widget/urlWidget.xml\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"width\" value=\"100%\"/>\n <item name=\"height\" value=\"500px\"/>\n <item name=\"url\" value=\"https://boards.huddo.com/community/connections\"/>\n </itemSet>\n</widgetDef>\n<!-- END Huddo Boards -->\nCheck in the widgets-config.xml file.
ProfilesConfigService.checkInWidgetConfig()\nRestart the Communities application via the ISC
Optional. Install the extensions for Connections Customizer. This includes a fix for the Community Widget that enables attachments to be downloaded as well as multiple new integrations for Connections.
Open Homepage => Administration
Click Add another app
Select the following:
OpenSocial GadgetTrusted and Use SSOShow for Activity Stream eventsAll serversClick the Add Mapping button.
Enter values:
conn-eeconnections_serviceClick Ok
Enter the following:
Field Value App Title Huddo Boards Stream URL Addresshttps://boards.huddo.com/widgets/connections/url-gadget.xml Icon URL https://boards.huddo.com/favicon.ico Scroll down and click Save
Select the newly defined app and click Enable
Huddo Boards integrates with Connections Engagement Center
Download the Boards Hybrid widget definition file
Open the CEC (XCC) main admin page
i.e. https://connections.company.com/xcc/main
Click Customize, Engagement Center Settings, expand Customization Files & click Upload File
Note: you must have the admin role for the Customize button to appear
Select the custom.js downloaded previously
Note: the file must have this name. If you already have a custom.js file you must manually merge the contents. Copy the HuddoBoards() function and make sure to call it in init()
To validate:
Highlights application in a CommunityClick Customize, Widgets and Huddo Boards
The Boards Highlights widget should now appear at the end of the page
Add Huddo Boards Docker widgets into HCL Connections on-premise environments
"},{"location":"boards/connections/widgets-on-prem/#community-widget","title":"Community Widget","text":"SSH to the WAS Deployment Manager
Start wsadmin
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin\n./wsadmin.sh -lang jython -user wasadmin -password <password-here>\nCheck out the widgets-config.xml file.
execfile(\"profilesAdmin.py\")\nProfilesConfigService.checkOutWidgetConfig(\"/LCCheckedOut\", AdminControl.getCell())\nEdit the widgets-config.xml file.
Find the resource element with the type of community, e.g. <resource ... type=\"community\" ... >, then under <widgets>, then within <definitions> add the following, replacing [BOARDS_URL] with your URL:
<!-- Huddo Boards -->\n<widgetDef defId=\"HuddoBoards\" modes=\"view fullpage\" url=\"{webresourcesSvcRef}/web/com.ibm.social.urliWidget.web.resources/widget/urlWidget.xml\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\" uniqueInstance=\"true\">\n <itemSet>\n <item name=\"resourceId\" value=\"{resourceId}\"/>\n <item name=\"width\" value=\"100%\"/>\n <item name=\"height\" value=\"500px\"/>\n <item name=\"url\" value=\"https://[BOARDS_URL]/boards/community/connections\"/>\n </itemSet>\n</widgetDef>\n<!-- END Huddo Boards -->\nDisable Community Activity widget
Tip
this is optional but highly recommended for CP installations of Activities Plus
Once Activities are migrated into Boards, it is recommended that the Community Activity widget is disabled to prevent confusion around the old data.
Find and comment out the Activity widget with defId=\"Activities\"
Check in the widgets-config.xml file.
ProfilesConfigService.checkInWidgetConfig()\nRestart the Communities application via the ISC
Tip
If widgets no longer load in Communities and you see errors in the browser console like:
The following error occurs when retrieving widgetProcess production.\ncom.ibm.jsse2.util.h: PKIX path building failed: com.ibm.security.cert.IBMCertPathBuilderException: unable to find valid certification path to requested target\nthen please ensure the Connections domain root certificate is trusted in the WebSphere ISC. This can be added using Retrieve from port under SSL certificate and key management > Key stores and certificates > CellDefaultTrustStore > Signer certificates
Optional. Install the extensions for Connections Customizer. This includes a fix for the Community Widget that enables attachments to be downloaded as well as multiple new integrations for Connections.
Open Homepage => Administration
Click Add another app
Select the following:
OpenSocial GadgetTrusted and Use SSOShow for Activity Stream eventsAll serversClick the Add Mapping button.
Enter values:
conn-eeconnections_serviceClick Ok
Enter the following, replacing [BOARDS_URL] with your URL:
https://[BOARDS_URL]/widgets/connections/url-gadget.xml Icon URL https://[BOARDS_URL]/favicon.ico Icon Secure URL https://[BOARDS_URL]/favicon.ico Scroll down and click Save
Select the newly defined app and click Enable
Huddo Boards integrates with Connections Engagement Center
Download the Boards CP widget definition file
Open the CEC (XCC) main admin page
i.e. https://connections.company.com/xcc/main
Click Customize, Engagement Center Settings, expand Customization Files & click Upload File
Note: you must have the admin role for the Customize button to appear
Select the custom.js downloaded previously
Note: the file must have this name. If you already have a custom.js file you must manually merge the contents. Copy the HuddoBoards() function and make sure to call it in init()
To validate:
Highlights application in a CommunityClick Customize, Widgets and Huddo Boards
The Boards Highlights widget should now appear at the end of the page
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.
"},{"location":"boards/connections/customizer/customizer-integrations-package/#installation","title":"Installation","text":""},{"location":"boards/connections/customizer/customizer-integrations-package/#customizer-reverse-proxy-configuration","title":"Customizer Reverse Proxy Configuration","text":"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\nmw-proxy Server","text":"mw-proxy server. e.g. via sshmkdir /pv-connections/customizations/boards-extensions if it doesn't exist.cd /pv-connections/customizations/boards-extensions/pv-connections/customizations/boards-extensions.cat settings.js and check that the \"boardsURL\" property has been set to the URL of your Boards deployment.\"type\": \"com.hcl.connections.nav\"). If you already have nav customizations, you must remove the \"Tasks Nav Button\" extension from manifest.json and merge it in to your existing nav customization. Otherwise only one of your nav customisations will take effect.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.
"},{"location":"boards/connections/customizer/customizer-integrations-package/#updating","title":"Updating","text":"Remove all files in /pv-connections/customizations/boards-extensions. Repeat the above steps, overwriting the manifest in appreg.
Deploying Huddo Boards into HCL Connections Component Pack (Kubernetes)
Release Information
"},{"location":"boards/cp/#prerequisites","title":"Prerequisites","text":"Huddo Boards in Connections Component Pack (CP) uses the existing CP infrastructure.
The UI and API each require a unique route:
[CONNECTIONS_URL]/boards. We will refer to this as BOARDS_URL[CONNECTIONS_URL]/api-boards. We will refer to this as API_URLFor more details on configuring an IBM HTTP WebServer as reverse proxy, please see here
"},{"location":"boards/cp/#setup-oauth","title":"Setup OAuth","text":"You will need to setup an OAuth application with one (or more) of these providers for Huddo Boards to function. please refer to the following documentation:
Provider Registration / Documentation Callback URL HCL Connections(on premise) Huddo instructionshttps://[CONNECTIONS_URL]/boards/auth/connections/callback Microsoft Office 365 Huddo instructions https://[CONNECTIONS_URL]/boards/auth/msgraph/callback"},{"location":"boards/cp/#configure-kubectl","title":"Configure kubectl","text":"Instructions Kubernetes copy ~/kube/.config from the Kubernetes master server to the same location locally(backup any existing local config)"},{"location":"boards/cp/#storage","title":"Storage","text":""},{"location":"boards/cp/#s3","title":"S3","text":"Huddo Boards for Component Pack deploys a Minio service. Please follow S3 storage details here to configure the NFS mount.
"},{"location":"boards/cp/#mongo","title":"Mongo","text":"Huddo Boards uses the Mongo database already deployed inside the Component Pack. There is no configuration required.
"},{"location":"boards/cp/#licence-key","title":"Licence Key","text":"Huddo Boards / Activities Plus is a free entitlement however it requires a licence key from https://store.huddo.com. For more details see here.
"},{"location":"boards/cp/#update-config-file","title":"Update Config file","text":"Download our config file and update all the values inside. Descriptions as below.
Kubernetes variables:
Key Descriptionglobal.env.APP_URI https://[BOARDS_URL] (e.g. https://connections.example.com/boards) webfront.ingress.hosts [CONNECTIONS_URL] (no protocol, e.g. connections.example.com) core.ingress.hosts [API_URL] (no protocol, e.g. connections.example.com/api-boards) minio.nfs.server IP address of the NFS Server file mount (e.g. 192.168.10.20) minio.storageClassName (Optional) name of the storage class when using dynamic provisioning Boards variables:
Are detailed here.
Customising Boards notifications:
Some elements of the Boards notifications that are sent out can be customised.
Activity migration variables:
The Activity migration chart will be deployed separately but use the same config file. The variables are described here.
"},{"location":"boards/cp/#deploy-boards-helm-chart","title":"Deploy Boards Helm Chart","text":"Install the Boards services via our Helm chart
helm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\nNote: --recreate-pods ensures all images are up to date. This will cause downtime.
in the linked document you should use the IP of your kubernetes manager and the http port for your ingress (32080 for default component pack installs)
Please follow these instructions
"},{"location":"boards/cp/#integrations","title":"Integrations","text":""},{"location":"boards/cp/#hcl-connections","title":"HCL Connections","text":"Please follow the instructions here
"},{"location":"boards/cp/#subscribing-to-latest-updates-from-huddo-team","title":"Subscribing to latest updates from Huddo Team","text":"Guide here
"},{"location":"boards/cp/dockerhub/","title":"Latest Boards releases directly from Dockerhub","text":"Warning
These instructions are in the process of being deprecated. We are moving to hosting our images in Quay.io instead of Dockerhub. Please see these instructions.
You can get the latest versions of Huddo Boards Docker by subscribing to our own repository in dockerhub as follows:
Create kubernetes secret with your dockerhub account credentials
kubectl create secret docker-registry dockerhub --docker-server=docker.io --docker-username=[user] --docker-password=[password] --docker-email=[email] --namespace=connections\nOnce confirmed by reply email, update your boards-cp.yaml file as per this example.
At the top set
global.imagePullSecret to dockerhubglobal.repositoryglobal.imageTagSuffix as the date of our latest release and uncomment itAdd image.name (blank) and image.tag for each service as per this example.
Tip
Some of the services (app, provider, notification) might not be in your boards-cp.yaml file, you must add them.
Run helm to apply the changes.
helm upgrade kudos-boards-cp https://docs.huddo.com/assets/config/kubernetes/kudos-boards-cp-3.1.4.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\nThis document describes how to setup the proxy for serving the Boards application hosted in the Component pack by your Connections IHS
It also includes a proxy rewrite rule, to serve the migrated Board when the legacy Activity URL is requested.
Open WebSphere ISC
This is usually accessible through a URL like:
https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\nOpen Servers -> Server Types => Web servers
Click on the name of your web server
Click Edit on the http.conf
Define the Virtual Host Reverse Proxy
Note: combine this with the existing VirtualHost entry
<VirtualHost *:443>\n ServerName [CONNECTIONS_URL]\n\n RewriteEngine On\n RewriteRule ^/activities/service/html/(.*)$ /boards/activities/service/html/$1 [R]\n\n ProxyPass \"/boards\" \"http://[KUBERNETES_NAME]:32080/boards\"\n ProxyPassReverse \"/boards\" \"http://[KUBERNETES_NAME]:32080/boards\"\n ProxyPass \"/api-boards\" \"http://[KUBERNETES_NAME]:32080/api-boards\"\n ProxyPassReverse \"/api-boards\" \"http://[KUBERNETES_NAME]:32080/api-boards\"\n</VirtualHost>\nWhere:
[CONNECTIONS-URL] is the URL of your HCL Connections deployment [KUBERNETES_NAME] is the hostname/IP of the master in your cluster [KUBERNETES_PORT] is the port of your Ingress Controller (ie 32080)
For example:
<VirtualHost *:443>\n ServerName connections.example.com\n\n #Huddo Boards\n ProxyPass \"/boards\" \"http://kube-master.company.com:32080/boards\"\n ProxyPassReverse \"/boards\" \"http://kube-master.company.com:32080/boards\"\n ProxyPass \"/api-boards\" \"http://kube-master.company.com:32080/api-boards\"\n ProxyPassReverse \"/api-boards\" \"http://kube-master.company.com:32080/api-boards\"\n #End Huddo Boards\n</VirtualHost>\nFollow this guide to configure your Kubernetes with access to our images hosted in Quay.io.
Once confirmed by reply email, update your boards-cp.yaml file as per this example. At the top set
global.imageTag as the date of our latest releaseglobal.imagePullSecret to the name of the secret you created
e.g. <USERNAME>-pull-secret
Run the Helm upgrade command with our new Huddo chart to apply the changes.
helm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections\nNote
The chart name has changed. You may need to helm delete kudos-boards-cp first
Create the folder on the nfs.server
sudo mkdir /pv-connections/kudos-boards-minio\nsudo chmod 755 /pv-connections/kudos-boards-minio\nEnsure each Node in your Kubernetes cluster can mount this location.
Please modify the file /etc/exports on your NFS Server to include this line
/pv-connections/kudos-boards-minio <IP_RANGE_OF_YOUR_SERVERS>/<SUBNET_MASK>(rw,no_root_squash)\nFor example:
/pv-connections/kudos-boards-minio 192.168.0.0/255.255.0.0(rw,no_root_squash)\nApply new NFS storage to exports
exportfs -ra\nThis page has moved here
"},{"location":"boards/cp/store/","title":"Huddo Apps Store","text":"To obtain licences for Huddo Boards, you need to register your organisation at https://store.huddo.com.
All customers are eligible for a free licence to use our Activity view.
Obtaining your licence key:
Register for our store with your Name and email address.
Click the link in the email we sent to verify your account.
Create Your Organisation and Login client, details below.
Click Create Activities+ Licence
Click Download Licences
You will need to provide the following information to setup you Organisation in the store.
When creating your Login client(s) refer to the table below for details:
Provider Text Field HCL Connections Your Connections URL Microsoft 365 Your Office 365 tenant ID"},{"location":"boards/cp/migration/","title":"Migration of Activities to Huddo Boards (with Component Pack)","text":"Tip
If you are not using Component Pack please follow this guide
As part of the installation process for Huddo Boards (Activities Plus) you must run the migration service to move the existing Activities into Huddo Boards.
Info
Please review the Roles page for details on how Community Activity membership is interpreted & presented by Boards
"},{"location":"boards/cp/migration/#process-overview","title":"Process Overview","text":"This service will:
Ensure you have updated the following variables as applicable in your boards-cp.yaml file downloaded previously
sharedDrive.server 192.168.10.1 or websphereNode1 IP or Hostname of the server with the Connections shared drive mount sharedDrive.path /opt/HCL/Connections/data/shared or /nfs/data/shared Path on the mount to the Connections shared drive sharedDrive.mountOptions -nfsvers=4.1 (optional) Any additional sharedDrive mountOptions. All yaml is passed through drive sharedDrive.storage 10Gi (optional) The capacity of the PV and PVC sharedDrive.accessMode ReadOnlyMany (optional) The accessMode of the PV and PVC sharedDrive.volumeMode Filesystem (optional) The volumeMode of the PV and PVC sharedDrive.persistentVolumeReclaimPolicy Retain (optional) The persistentVolumeReclaimPolicy of the PV and PVC sharedDrive.storageClassName manual (optional) The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) sharedDrive.spec See below Using a fully custom spec - e.g. FlexVolume or hostPath env.FILE_PATH_ACTIVITIES_CONTENT_STORE /data/activities/content Path of the Activities content store relative to the Connections shared drive.Must start with /data as the Connections shared drive is mounted at /dataEnsure you set the IP and path for the NFS volume mount. env.API_GATEWAY https://[CONNECTIONS_URL]/api-boards URL of the Boards API.Used by files attached to a board. URL. env.TZ Europe/London or Australia/Hobart etc 'Local' TimezoneUsed for date interpretation. See full list of supported timezones env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME connectionsadmin Credentials for user with admin role on the Activities application.See ISC => Applications => Activities => Security role to user mapping env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD adminpassword Password for the Activities administrator env.CONNECTIONS_DB_TYPE db2 or mssql or oracle SQL database type hosting Activities. env.CONNECTIONS_DB_HOST dbserver.company.com SQL Server hostname env.CONNECTIONS_DB_PORT 50000 or 1433 or 1531 SQL Server connection port env.CONNECTIONS_DB_USER dbuser SQL Server user name env.CONNECTIONS_DB_PASSWORD dbpassword SQL Server user password env.CONNECTIONS_DB_SID DATABASE SQL Server SIDNote: applicable to Oracle env.CONNECTIONS_DB_DOMAIN domain SQL Server connection stringNote: applicable to Microsoft SQL env.CONNECTIONS_DB_CONNECT_STRING HOSTNAME=<host>;PROTOCOL=... or <host>:<port>/<sid> SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle env.PROCESSING_PAGE_SIZE 10 (default) Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database env.PROCESSING_LOG_EVERY 50 (default) The migration process logs every 50 Activities completed env.IMMEDIATELY_PROCESS_ALL false (default) Process ALL Activities on service startup. env.COMPLETE_ACTIVITY_AFTER_MIGRATED false Mark the old Activity data as complete env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED false Create link to new Board in old Activity"},{"location":"boards/cp/migration/#custom-persistent-volume","title":"Custom Persistent Volume","text":"The default chart values use an NFS mount. Below are examples custom configuration of the persisent volume definition for access to the Shared Drive using other methods.
Note
We recommend running the helm chart with --dry-run --debug to confirm the yaml output
Host path
Tip
This can be used in conjunction with existing linux methods (e.g. cifs-utils, smbclient etc) to mount a Windows Samba share directly onto the Kubernetes Node(s).
Please read the Kubernetes documentation.
migration:\n sharedDrive:\n storageClassName: manual\n spec:\n hostPath:\n path: /data/shared\nKubernetes CIFS Volume Driver (for Samba shares).
Please read the CIFS documentation
migration:\n sharedDrive:\n spec:\n flexVolume:\n driver: juliohm/cifs\n options:\n opts: sec=ntlm,uid=1000\n server: my-cifs-host\n share: /MySharedDirectory\n secretRef:\n name: my-secret\nAdditional for Windows
This migration is designed to be a once-off operation. If you are using Windows SMB shares and neither option above is appropriate for your environment, we would recommend:
<SHARED_DRIVE>/activities/content (e.g. /opt/HCL/connections/data/shared/activities/content) to an existing Linux accessible drive (e.g. /pv-connections/activitystore).sharedDrive.server & sharedDrive.path to mount this path at /data in the containersmigration.env.FILE_PATH_ACTIVITIES_CONTENT_STORE: \"/data\"Please deploy the following chart with the same configuration boards-cp.yaml file used to deploy the huddo-boards-cp chart
helm upgrade huddo-boards-cp-activity-migration https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-activity-migration-1.0.0.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\nNote: the configuration file has changed as of the v3 chart. Please add the new sharedDrive parameters described above
The migration interface is accessible at https://[CONNECTIONS_URL]/boards/admin/migration to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.
You can also set the env.IMMEDIATELY_PROCESS_ALL if you wish to migrate every Activity without the UI.
You can check the pod logs for the activity-migration to see progress of the running migration
For example
"},{"location":"boards/cp/migration/#after-migration-complete","title":"After Migration Complete","text":"The Migration service can be removed. Please use the following command
helm delete huddo-boards-cp-activity-migration --purge\nTurn off the Activities application in WebSphere ISC
The REMAINING tab is where you can select from Activities that have not been migrated and initiate the process for migrating them into Huddo Boards.
"},{"location":"boards/cp/migration/interface/#activities-table","title":"Activities Table","text":"Select Activities to migrate by clicking the checkboxs next to each activity.
The table can be sorted by clicking the headers for each column.
The number of rows per page can be increased using the Rows dropdown.
There are multiple filters that can be applied that will remove activities from the table and the activities included when choosing MIGRATE ALL.
Notice that when filters are applied, the total number in the table and MIGRATE ALL button changes.
"},{"location":"boards/cp/migration/interface/#options","title":"Options","text":"Near the MIGRATE buttons, there is an Options panel to for enabling features that will affect this migration.
WARNING: These options will irreversibly modify your Activities.
Option Description Add Link to Activity This will create an entry in each activity that provides a link to the new Huddo Board. This corresponds to theCREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED environment variable when running a headless migration. Mark Activity Complete This will mark the Activity as complete after migrating it to Huddo Boards. This corresponds to the COMPLETE_ACTIVITY_AFTER_MIGRATED environment variable when running a headless migration."},{"location":"boards/cp/migration/interface/#control-buttons","title":"Control Buttons","text":"Button Description Migrate Selected This will process all Activities which are checked in the view Migrate ALL All currently visible Activities (on all pages) will be migrated. Note: filters affect how many are visible. For example, completed/deleted can be ignored."},{"location":"boards/cp/migration/interface/#done-tab","title":"Done Tab","text":"This tab shows all of the activities that have been migrated into Huddo Boards. The Activity Name is a link to the Activity. The Board column has links to each Board in Huddo Boards.
If you're migrating from an environment that has previously been using Huddo Boards WebSphere, you can use this tab to start the process of migrating Boards User Data into Huddo Boards Docker.
Each user who has used Huddo Boards WebSphere is likely to have created some of this data. It includes:
If the user already exists in Huddo Boards Docker:
This process only needs to be run once. Subsequent runs will import any data for new Boards WebSphere users and overwrite the previously imported data from the last run.
"},{"location":"boards/cp/roles/","title":"Roles","text":""},{"location":"boards/cp/roles/#member-roles","title":"Member Roles","text":"Boards has the following membership roles
Role Description Applicable for Community Membership Owner All members have full control over the Board. Shared with Owned by Editor All members have access to create new content, and edit all content. Shared with Author All members have access to create new content, and edit content they created. Shared with Reader All members can only read content (no create or edit). Any tasks they are assigned to, they can comment on and complete. Shared with Owners & Editors Owners of the Community haveOwner role. Members of the Community have Editor role Owned by Owners & Authors Owners of the Community have Owner role. Members of the Community have Author role Shared with Owned by Owners & Readers Owners of the Community have Owner role. Members of the Community have Reader role Owned by Community Owner Only Owners of the Community have Owner role. Note: Community Members will see the title of the Board in the main list, but not be able to open/view/edit. Owned by"},{"location":"boards/cp/roles/#community-membership-types","title":"Community Membership Types","text":"Type Description Applicable Role Options Owned by Boards created from inside a Community Shared with Boards created standalone, and then shared with a community"},{"location":"boards/cp/roles/#migration-examples","title":"Migration Examples","text":"When migrating from Activities, the permissions will be maintained. Below are some examples of permissions set in Activities and their equivalent in Boards / Activities Plus after migration.
"},{"location":"boards/cp/roles/#activity-in-community","title":"Activity in Community","text":"Activities Boards Owners & Members assigned the Owner role Owner role is assigned to the entire community Members are Authors Role isOwners & Authors as per above Members are Readers Role is Owners & Readers as per above As above, with users specified Each user is migrated with their role Members have NO access Role is Community Owners Only as per above"},{"location":"boards/cp/roles/#standalone-activity","title":"Standalone Activity","text":"Activities Boards"},{"location":"boards/domino/callback/","title":"Domino Callback URL","text":"Huddo Boards Cloud: Boards cloud uses a base64 encoded version of your Domino Server domain, you can use a service like https://www.base64encode.org/ to achieve this, the callback format looks like this: https://boards.huddo.com/auth/domino/[ encoded domain ]/callback
e.g. for domain proton.example.com the callback url would be https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback
Huddo Boards On Prem: For an on premise installation we use a global authentication setup so the callback url does not need an id. depending on your deployment it could look like one of the following:
https://boards.your.domain.com/auth/domino/callbackhttps://your.domain.com/boards/auth/domino/callback if you have a context root (i.e. you would access boards application at /boards).Huddo Boards Cloud supports authentication, user and group lookup with HCL Domino.
Tip
See Domino REST API for Boards On-Premise for Boards On Premise installations.
"},{"location":"boards/domino/cloud/#prerequisites","title":"Prerequisites","text":"Configure OAuth
URLs
Boards Cloud uses a base64 encoded version of your Domino Server domain, you can use a service like https://www.base64encode.org/ to achieve this.
// callback URL\nhttps://boards.huddo.com/auth/domino/[ encoded domain ]/callback\n\n// startup page\nhttps://boards.huddo.com/auth/domino/[ encoded domain ]\ne.g. the callback url would look like this: https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback
Please determine the URL for your environment and then follow this guide.
Configure Schema
Configure Scope
Please email support@huddo.com with the following details
Item Detail / example DOMINO_AUTH_URL HCL Domino REST API URL. E.g. https://domino.example.com:8080 DOMINO_CLIENT_ID The IAM Application client id DOMINO_CLIENT_SECRET The IAM Application client secret"},{"location":"boards/domino/on-prem/","title":"HCL Domino REST API for Boards On-Premise","text":"Huddo Boards supports authentication, user and group lookup with HCL Domino.
Tip
See Domino REST API for Boards Cloud for integration with Boards Cloud (hybrid installations).
Using the old Proton configuration?
See our migration guide.
"},{"location":"boards/domino/on-prem/#prerequisites","title":"Prerequisites","text":"Configure OAuth
URLs
For an on premise installation the callback url & startup page is simple:
https://<BOARDS_URL>/auth/domino/callback\nhttps://<BOARDS_URL>/auth/domino\nFor example:
https://boards.your.domain.com/auth/domino/callback\nhttps://boards.your.domain.com/auth/domino\n\n// if you have a context root (i.e. you would access boards application at /boards)\nhttps://your.domain.com/boards/auth/domino/callback\nhttps://your.domain.com/boards/auth/domino\nPlease determine the URL for your environment and then follow this guide.
Configure Schema
Configure Scope
Please email support@huddo.com with the following details
Item Detail / example Boards URL Your licence will be tied to this url DOMINO_AUTH_URL HCL Domino REST API URL. e.g. https://domino.example.com:8080 DOMINO_CLIENT_ID The Domino Auth client id DOMINO_CLIENT_SECRET The Domino Auth client secret"},{"location":"boards/domino/proton/","title":"Huddo Boards for HCL Domino Proton (DEPRECATED)","text":"Warning
These instructions are deprecated. Please see the new Domino REST API for new installations. For existing installations we recommend following our migration guide.
Huddo Boards supports authentication, user and group lookup with HCL Domino.
"},{"location":"boards/domino/proton/#prerequisites","title":"Prerequisites","text":"We will require 2 domains from you
Callback URL
Huddo Boards Cloud: Boards cloud uses a base64 encoded version of your Domino Server domain, you can use a service like https://www.base64encode.org/ to achieve this, the callback format looks like this: https://boards.huddo.com/auth/domino/[ encoded domain ]/callback
e.g. for domain proton.example.com the callback url would be https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback
Huddo Boards On Prem: For an on premise installation we use a global authentication setup so the callback url does not need an id. depending on your deployment it could look like one of the following:
https://boards.your.domain.com/auth/domino/callbackhttps://your.domain.com/boards/auth/domino/callback if you have a context root (i.e. you would access boards application at /boards).You will need to setup an Application in the IAM Service with the following details
Item Details Application Name Huddo Boards Application Home Page https://boards.huddo.com (or your boards url for an on-premise installation) Authorization Callback URL Callback URL above Proton Access Domino Database Access Functional ID LDAP CN for IAM application user Scopes Offline Access"},{"location":"boards/domino/proton/#proton-user","title":"Proton User","text":"The boards application backend uses a single user to access your names.nsf directory, you will need to setup a user with appropriate access and import a PEM Certificate as detailed below, for more information, see HCL's Documentation
"},{"location":"boards/domino/proton/#application-process","title":"Application Process","text":"Please email support@huddo.com with the following details
Item Detail / example IAM domain https://iam.example.com Domino domain https://proton.example.com Boards url For on-premise installations (your licence will be tied to this url) Proton Port 3002 client_id The IAM Application client id client_secret The IAM Application client secret user_certificate PEM encoded certificate that represents the Proton User above user_key Private Key for the above certificate group_search Please indicate whether you would like us to search Groups in your directory"},{"location":"boards/domino/migration/","title":"Migration from Domino Proton to REST API","text":""},{"location":"boards/domino/migration/#prerequisites","title":"Prerequisites","text":"Check Release date
Ensure you are running images after 30 November 2023
Danger
This step must be performed before any user tries to login with the new Domino OAuth client to ensure you maintain ownership of the current Boards data.
Open Admin Settings, then your organisation
Open Domino client
Edit Domino client
Tip
Save a copy of the old values in case you need to reverse the changes.
Change the old Proton values to new Domino REST API values as configured
Comment Domino URLhttps://<NEW_DOMINO_REST_API> ExternalId base64 encoded value of the hostname part of Domino URL(this is automatically set when you change Domino URL) Global OAuth ensure this box is checked Domino Hostname - PROTON ONLY (LEGACY) delete this value - it must be empty to enable the new REST API functionality. For example:
Click Save
boards.yaml configuration file which you have deployedSet environment variables for the user service as follows (substituting the values above)
user:\n env:\n DOMINO_AUTH_URL: https://<NEW_DOMINO_REST_API>\n DOMINO_CLIENT_ID: <CLIENT_ID>\n DOMINO_CLIENT_SECRET: <CLIENT_SECRET>\n DOMINO_USE_PROFILE_IMAGE_ATTACHMENTS: 'true'\nRun your deploy command (e.g. helm upgrade..., docker compose up)
Warning
We recommend you perform the validation steps below in a new Incognito window (or different browser) to test without logging out of your existing session. This way you can reverse the client changes in your existing session if required.
Open a new Boards session
Click Domino
Enter your credentials for the new REST API
Once Authenticated, you should see the approval request
Click Allow
This guide will describe how to add a new OAuth application for Boards users to login via Domino.
"},{"location":"boards/domino/oauth/#steps","title":"Steps","text":"Open the REST API and click Configuration
Login
Click Application Management - OAUTH
Click Add Application
Enter the following details and click ADD
Determine the appropriate URL for your environment as per our guide.
Huddo BoardsCallback URL, e.g.
https://<ON_PREM_BOARDS_URL>/auth/domino/callback\nhttps://boards.huddo.com/auth/domino/[encoded domain]/callback\nStartup Page, e.g.
https://<ON_PREM_BOARDS_URL>/auth/domino\nhttps://boards.huddo.com/auth/domino/[encoded domain]\nScope: $DATA (click + icon)
<YOUR_EMAIL>Click the generate application secret icon.
Copy both the App Id and App Secret
These will be referred to later as CLIENT_ID and CLIENT_SECRET
This guide will describe how to add a new Schema called directory to access the names.nsf database. Boards uses the $Users & $Groups views of this database. This section will configure the database forms.
Open the REST API and click Configuration
Click Database Management - REST API
Click Add Schema
Enter the following details and click ADD
Tip
If you cannot see names.nsf in the list, please see the HCL documentation
names.nsf and click itdirectorydomino directorynames.nsfOpen the new Schema and click the Source tab
Download this file and paste the contents into the editor
This guide will describe how to add a new Scope called directorylookup to allow reader access to the names.nsf database. Boards uses the $Users & $Groups views of this database.
Open the REST API and click Configuration
Click Database Management - REST API
Click the Scopes icon in the right menu, click Add Scope
Enter the following details and click ADD
names.nsf. Click directorydirectorylookupDirectory LookupReaderPlease set the following environment variables in your config file as required
Key Descriptionglobal.env.API_GATEWAY Fully qualified URL of the API in the format https://[API_URL] webfront.env.DEFAULT_TEAM Name of the team users will primarily login with.This will be shown on the login page.Optional: Only set if you are authenticating with multiple providers. events.env.NOTIFIER_EMAIL_HOST SMTP gateway hostname, e.g. smtp.ethereal.com events.env.NOTIFIER_EMAIL_USERNAME Optional: SMTP gateway authentication.Setting a value will enable auth and use the default port of 587 events.env.NOTIFIER_EMAIL_PASSWORD Optional: SMTP gateway authentication password events.env.NOTIFIER_EMAIL_PORT Optional: SMTP gateway port. Default: 25 (OR 587 if NOTIFIER_EMAIL_USERNAME is set) events.env.NOTIFIER_EMAIL_FROM_NAME Optional: Emails are sent from this name.Default: Huddo Boards events.env.NOTIFIER_EMAIL_FROM_EMAIL Optional: Emails are sent from this email address.Default: no-reply@huddo.com events.env.NOTIFIER_EMAIL_SUPPORT_EMAIL Optional: Support link shown in emails.Default: support@huddo.com events.env.NOTIFIER_EMAIL_HELP_URL Optional: Help link shown in new user welcome email.Default: https://docs.huddo.com/boards/howto/knowledgebase/ events.env.NOTIFIER_EMAIL_OPTIONS Optional: Custom NodeMailer email options (insecure tls etc).For example: \"{\\\"ignoreTLS\\\": true,\\\"tls\\\":{\\\"rejectUnauthorized\\\":false}}\" user.env.DISABLE_WELCOME_EMAIL Optional: Set to disable welcome emails for users"},{"location":"boards/env/common/#for-connections","title":"For Connections","text":"Key Description provider.env.WIDGET_ID Optional: ID of the Community widget configured in this step user.env.CONNECTIONS_NAME Optional: If you refer to 'Connections' by another name, set it here user.env.CONNECTIONS_CLIENT_ID oAuth client-id, usually huddoboards user.env.CONNECTIONS_CLIENT_SECRET oAuth client-secret as configured in this step user.env.CONNECTIONS_URL HCL Connections URL, e.g. https://connections.example.com user.env.CONNECTIONS_ADMINS Emails or GUIDs of users to grant admin permissions.e.g. \"[\\\"admin1@company.example.com\\\", \\\"PROF_GUID_2\\\"]\" user.env.CONNECTIONS_KEYCLOAK_URL Optional: See keycloak authentication for more information user.env.CONNECTIONS_KEYCLOAK_REALM Optional: See keycloak authentication for more information"},{"location":"boards/env/common/#for-domino","title":"For Domino","text":"Key Description user.env.DOMINO_AUTH_URL Optional: HCL Domino REST API URL. See domino authentication for more information user.env.DOMINO_CLIENT_ID Optional: oAuth client-id, see domino authentication for more information user.env.DOMINO_CLIENT_SECRET Optional: oAuth client-secret, see domino authentication for more information user.env.DOMINO_ADMINS Optional: Emails or GUIDs of users to grant admin permissions.See domino authentication for more information user.env.DOMINO_USE_PROFILE_IMAGE_ATTACHMENTS Optional: set true to enable using profile imagesSee domino authentication for more information user.env.DOMINO_PROFILE_IMAGE_NAME Optional: file name of profile images. Uses first image attached if not setSee domino authentication for more information user.env.DOMINO_AUTH_SCOPE Optional: defaults to $DATASee domino authentication for more information user.env.DOMINO_REST_SCOPE Optional: defaults to directorylookupSee domino authentication for more information"},{"location":"boards/env/notifications/","title":"Customise Emails","text":"The notifications sent out from Huddo Boards can be customised to include company logos, links and support email addresses. The custom values are set as ENV variables in the config file.
The image below shows the items that can be customised within notifications:
"},{"location":"boards/env/notifications/#from-name","title":"From Name","text":"Use events.env.NOTIFIER_EMAIL_FROM_NAME to set the from name for emails Default: Huddo Boards
Use events.env.NOTIFIER_EMAIL_FROM_EMAIL to set the sent from email address Default: no-reply@huddo.com
Specify a URL to point to a hosted logo image by specifying events.env.APP_LOGO_URL in the config. For example: https://company.com/assets/logo.png
Note that an inline base64 encoded data URL can also be used for this variable.
"},{"location":"boards/env/notifications/#brand-logo","title":"Brand Logo","text":"Specify a URL to point to a hosted logo image by specifying events.env.BRAND_LOGO_URL in the config. For example: https://company.com/assets/logo.png
Note that an inline base64 encoded data URL can also be used for this variable.
"},{"location":"boards/env/notifications/#social-links","title":"Social Links","text":"The links below the brand logo can be customised. These do not necessarily need to be displayed as images/icons and can be text based links.
The standard/default Huddo social links can be replaced by setting the events.env.SOCIAL_LINKS variable. Specifying an empty array will remove all social links.
The links are specified in a JSON array of objects with the format:
{\n name: \"Link Name/Text\", \n link: \"Link URL\", \n icon: \"(Optional) Hosted Icon URL or data URL\"\n}\ne.g.:
\"[{\\\"name\\\": \\\"Intranet\\\",\\\"link\\\":\\\"https://company.com/intranet/\\\"}, \n { \\\"name\\\": \\\"Support\\\", \\\"link\\\": \\\"https://company.com/support\\\", \n \\\"icon\\\": \\\"https://company.com/assets/support_icon.png\\\"}]\"\nUse events.env.APP_NAME to specify the app name.Default: Huddo Boards
The support email address can be specified in events.env.NOTIFIER_EMAIL_SUPPORT_EMAILDefault: support@huddo.com
events:\n env:\n NOTIFIER_EMAIL_FROM_NAME: My Company\n NOTIFIER_EMAIL_FROM_EMAIL: boards@company.com\n APP_LOGO_URL: https://company.com/assets/company_logo.png\n BRAND_LOGO_URL: https://company.com/assets/logo.png\n SOCIAL_LINKS: \"[{\\\"name\\\": \\\"Intranet\\\",\\\"link\\\":\\\"https://company.com/intranet/\\\"}, { \\\"name\\\": \\\"Support\\\", \\\"link\\\": \\\"https://company.com/support\\\", \n \\\"icon\\\": \\\"https://company.com/assets/support_icon.png\\\"}]\"\n APP_NAME: Boards for My Company\n NOTIFIER_EMAIL_SUPPORT_EMAIL: support@company.com\nHuddo Boards supports many languages so our clients all around the world can easily use our product with minimal understanding issues.
Our default language is English. While we endeavour to keep all languages up to date we frequently update and release new features so some sections may display in the default language for a time.
Langauge Code Arabic ar Bulgarian bg Catalan ca Czech cs Danish da German de Greek el English en Spanish es Finnish fi French fr Hebrew he Croation hr Hungarian hu Italian it Japanese ja Kazakh kk Korean ko Norwegian nb Dutch nl Polish pl Portuguese pt Romanian ro Russian ru Slovak sk Slovenian sl Swedish sv Thai th Turkish tr Chinese zh-tw"},{"location":"boards/faq/notifications/","title":"Huddo Boards Notifications","text":"Below are the notifications that Huddo Boards sends it's users to keep them up to date with their content, we try not to send too many of these and keep them short and relevant.
"},{"location":"boards/faq/notifications/#new-user","title":"New User","text":"Trigger First Sign in Recipients User Methods Email
"},{"location":"boards/faq/notifications/#user-invite","title":"User Invite","text":"Trigger Inviting a user to a board by their email address Recipients Invitee Methods Email
"},{"location":"boards/faq/notifications/#added-to-board","title":"Added to Board","text":"Trigger Adding user/group to a board Recipients Invitee Methods Email, Teams bot, Community stream
"},{"location":"boards/faq/notifications/#assigned-task","title":"Assigned Task","text":"Trigger Assigning a user to a card
Recipients Assignee Methods Email
Recipients Groups that are members Methods Teams bot, Community stream
"},{"location":"boards/faq/notifications/#commented","title":"Commented","text":"Trigger Adding a comment Recipients Commenter (if another user replies), Anyone assigned, The card creator, Anyone @Mentioned, Groups that are members Methods Email, Teams bot, Community stream
"},{"location":"boards/faq/notifications/#mentioned","title":"Mentioned","text":"Trigger @Mentioning another member in a board description Recipients Anyone @Mentioned, Groups that are members Methods Email, Teams bot, Community stream
"},{"location":"boards/faq/notifications/#group-notifications","title":"Group Notifications","text":"For boards that have groups as members, these notifications are sent to each group.
Trigger Creating a new card, Changing properties of a board/card, Completing a board/card Recipients Group Methods Teams bot, Community stream
"},{"location":"boards/faq/notifications/#licence-notifications","title":"Licence Notifications","text":"Trigger Quote Request, Payment Success/Failure, Licence created/updated Recipients Organisation Admins Methods Email
"},{"location":"boards/howto/","title":"User Guides","text":"We have many guides for using Huddo Boards. Please contact us if you have any questions that are not covered.
"},{"location":"boards/howto/knowledgebase/","title":"Knowledge Base & Support","text":""},{"location":"boards/howto/knowledgebase/#knowledge-base","title":"Knowledge Base","text":"Huddo Boards is a intutive to learn and easy to master. It is a powerful addition to any business, whether you're looking to increase your personal productivity, super charge your teams', or collaborate with external parties. Learn quick tips and tricks from our help guides to get the most out of boards. Let's get started!
Here are some quick how to guides to help you get started with Huddo Boards.\u00a0
\u2b05 Click on the menu options to see more!
"},{"location":"boards/howto/knowledgebase/#customer-support","title":"Customer Support","text":""},{"location":"boards/howto/knowledgebase/#troubleshooting","title":"Troubleshooting","text":"If you require support using Huddo Boards, contact us at support@huddo.com
"},{"location":"boards/howto/mobile-app/","title":"Mobile app","text":"You can access and work with Huddo Boards Cloud on your mobile device.
"},{"location":"boards/howto/mobile-app/#download-the-app-to-your-device","title":"Download the app to your device","text":"Download the Huddo Boards Cloud App from either Apple App Store or Google Play Store.
"},{"location":"boards/howto/mobile-app/#login-to-the-huddo-boards-app","title":"Login to the Huddo Boards App","text":"
When you start the app and reach the login screen you have multiple options on how to identify yourself towards Activities Plus and Huddo Boards.
You are in! Now you see all your existing Activities and Boards and can immediately start working!
"},{"location":"boards/howto/use-auth0/","title":"Login with Auth0","text":""},{"location":"boards/howto/use-auth0/#huddo-boards-and-auth0","title":"Huddo Boards and Auth0","text":"Admin Guide to setting up Auth0 tenant.
"},{"location":"boards/howto/use-auth0/#sign-in-to-huddo-boards-with-your-auth0-tenant","title":"Sign in to Huddo Boards with your Auth0 Tenant","text":"Once your Auth0 tenant has been activated you will get an email from our support team with confirmation, you may then go to Huddo Boards and use your Auth0 domain as the team name to login.
You'll then be asked to enter your email address and password.
If you're not sure which email address and password to use, check with your IT administrator, or the person who created the Auth0 domain.
"},{"location":"boards/howto/use-verse/","title":"HCL Verse","text":""},{"location":"boards/howto/use-verse/#huddo-boards-integration-points-for-hcl-verse","title":"Huddo Boards integration points for HCL Verse","text":"Huddo Boards provides 2 integration points with HCL Verse:
"},{"location":"boards/howto/use-verse/#save-email-as-a-card-in-boards","title":"Save email as a card in Boards","text":""},{"location":"boards/howto/use-verse/#attach-card-from-boards-to-an-email-in-verse","title":"Attach card from Boards to an email in Verse","text":""},{"location":"boards/howto/adding-members/","title":"Adding Members","text":"Adding members to your board allows you to collaborate with your team, your whole organisation and even external parties outside of your company. There is no limit to the number of people you can have as members of a board.
"},{"location":"boards/howto/adding-members/#adding-members-to-a-new-board","title":"Adding Members to a New Board","text":"You can add members when you first create a board.
In the New Board creation phase, type in the name of any colleague or group in your organisation in the Add People field, or type in an email address of someone who is external to your organisation.
You can also decide if you would like the board to have Public Access, meaning anyone in your organisation will be able to view the board and participate depending on what level of permission you have set (reader, author, editor.)
"},{"location":"boards/howto/adding-members/#adding-members-to-an-existing-board","title":"Adding Members to an Existing Board","text":"At any stage of your work, you can add members to a board.
From within your board, select Members from the menu on the right-hand side. From here, you\u2019ll be able to see current members or add new ones. Type in the name of any colleague or group in your organisation in the add members field, or type in an email address of someone who is external to your organisation.
Don\u2019t forget to click the Add Members button before closing the window.
New members will be notified that they have been invited to your board.
"},{"location":"boards/howto/adding-members/#managing-members-in-a-microsoft-team-channel-and-board","title":"Managing Members in a Microsoft Team Channel and Board","text":"A board can be added to a channel within Teams to help track progress on tasks and create a collaborative work environment.
Members of a Team or a Channel will be inherited automatically in to your Huddo Board.
You can also add members directly to the board by searching them in the Members area on the right hand side of the board. Adding members this way, be they in your organisation or external to your organisation, will add them just to the board. Not to the Channel or Team.
Archiving gives you the ability to remove a card, list or board from your screen. Cards, lists and boards that have been archived, can be restored.
Permanently deleting a card, list or board will remove them completely from the system. They cannot be retrieved if you change your mind. Only use this option if you are sure you want to delete an item forever.
"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-card","title":"How do I Archive a Card?","text":"Click in to the card you want to archive. Use the Archive button at the top of the right-hand corner to archive the card. The screen will show it has been archived and when you click away from it, it will disappear from the board.
Example of an archived card:
Archived the card by mistake? If you're still in archived card screen, use the Restore button in the top right corner to bring the card back to the board.
To Archive a list, click the vertical ... icon on the right-hand side of the blue list header and select Archive.
You'll notice that you also have options to archive the list and cards, or just the cards in the list.
"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-restore-permanently-delete-a-card-or-a-list","title":"How do I Restore / Permanently Delete a Card or a List?","text":"If you\u2019ve moved away from the archiving window above, but need to restore / delete a card or list, click the Archived button in the right-hand side menu. It will bring up a window where you can see your archived cards and lists. Hover over the card or list then click the Restore button to return it to the board or the Delete to permanently delete it.
Only use the Delete option if you don't need to access the card or list ever again. For example, if you made a mistake. You cannot retrieve permanently deleted items.
"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-board","title":"How do I Archive a Board?","text":"Open the board you intend to archive. Navigate to Open Board Options found in the title of your board, to the left of the search bar.
In the board options you\u2019ll see the Archive button in the actions shown at the top. Click this button to archive the board.
The board will change appearance to indicate it has been archived.
"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-permanently-delete-a-board","title":"How do I permanently delete a board?","text":"Warning
You can\u2019t restore or retrieve the board or any of the cards in it, if you delete permanently
Option 1: If you\u2019re still within the screen above, you can use the Delete button to delete the board. If you\u2019ve navigated out of that screen but remain in the board, click the board title to Open Board Options and use the Delete button.
Option 2: Delete any board you\u2019ve archived by navigating to the Archive tab on your My Boards dashboard page. Click in to the board you want to delete, click the board title to Open Board Options, and click Delete.
Option 1: If you\u2019re still within the screen above, you can use the Restore button to restore the board. If you\u2019ve navigated out of that screen but remain in the board, click the board title to Open Board Options and use the Restore button.
Option 2: Restore any board you\u2019ve archived by navigating to the Archive tab on your My Boards dashboard page. Click in to the board you want to restore, click the board title to Open Board Options, and click Restore.
Within a template, you can create Assignment Roles that can be assigned to tasks just like members. When creating a board from this template, you can assign the members of this new board to these roles and they will be responsible for completing the tasks the role had been assigned.
"},{"location":"boards/howto/assignment-roles/assignment-roles/#create-a-template-with-assignment-roles","title":"Create a Template with Assignment Roles","text":"Start off by creating a template following the steps in the Create a Template article.
Once your template has been created and opened, open the Members dialog by clicking on Members in the right side bar.
In the dialog that opens, there will be a section for Assignment Roles. Click the Create button to create a new role.
Give your role a name and select an icon. A color will be automatically assigned to the role. Click Save to create the role.
Now in the members dialog, you can see the roles that have been created. You can click these roles if you need to edit them.
You can assign roles to tasks just as you would a board member.
See the section on using a template to see how Assignment Roles are used when creating a board from a template.
"},{"location":"boards/howto/attaching-files/","title":"Attaching Files to Cards","text":"Huddo Boards allows files under 50MB to be attached to cards directly.
Anyone who has access to view the card will be able to view and download the attachment.
Tip
This feature can be disabled organisation wide by an administrator if desired.
"},{"location":"boards/howto/attaching-files/#office-365-onedrive-hcl-connections-files","title":"Office 365 (OneDrive) & HCL Connections (Files)","text":"If you use Office 365 or HCL Connections as your authentication method, you may also upload files to those services directly, in this case the files and security will be managed by your respective provider. Huddo Boards will only save a link to open these.
"},{"location":"boards/howto/attaching-files/#attaching-a-file-to-a-card","title":"Attaching a File to a Card","text":"Once you have opened your desired card, you can drag&drop a file to upload it, otherwise you can use the UI by:
Clicking the Links and Attachments
In the menu that appears, choose Upload to this board.
Locate the file(s) you wish to attach and click open.
Your file will now appear in the Links and Attachments list.
"},{"location":"boards/howto/attaching-files/#removing-an-attached-file","title":"Removing an Attached File","text":"To remove an attached file, navigate to the ... to the right of the attachment. Click and select Delete to remove the file. The file will be deleted and the link will no longer work. Please ensure you still have a copy of the file if needed before doing this.
Anyone who can edit the card can also remove the attached files.
"},{"location":"boards/howto/attaching-files/#where-are-files-stored","title":"Where are Files Stored?","text":"Files attached to cards in Huddo Boards Cloud with Auth0, Google, Facebook, LinkedIn authentication providers are stored in a Google Cloud Storage.
If you are hosting Huddo Boards yourself then files are stored in the default file storage as defined in your environment.
If you are using Office 365 or HCL Connections, your files are stored within these environments.
"},{"location":"boards/howto/attaching-files/#deleting-a-card-that-has-attachments","title":"Deleting a Card that has Attachments","text":"When you archive a card, the attachments will still be accessible however, if you delete the card permanently then the attachments will also be deleted.
"},{"location":"boards/howto/attaching-files/#adding-emails-as-files","title":"Adding Emails as Files","text":"Huddo Boards is an eml dropzone such that you are able to drag & drop emails out of email programs that support dragging as eml and drop them on an open card in Huddo to upload them as a file.
"},{"location":"boards/howto/attaching-files/#outlook","title":"Outlook","text":"In order to allow Outlook to do this, we are aware of the Outlook2Web program that can facilitate this.
"},{"location":"boards/howto/connections/connections-ui/","title":"HCL Connections UI Integrations","text":"Huddo Boards can integrate features directly in to HCL Connections user interface that enable you to:
If you're an administrator looking for how to set this up, see the install documentation here.
"},{"location":"boards/howto/connections/connections-ui/#related-tasks","title":"Related Tasks","text":"You can create and view tasks related to the HCL Connections page you're currently viewing. Look for the Huddo Boards icon in the Connections header and file viewer.
Huddo Boards in the Connections Header Huddo Boards in the file viewer"},{"location":"boards/howto/connections/connections-ui/#huddo-boards-in-search-results","title":"Huddo Boards in Search Results","text":"Search results from Huddo Boards can be included in HCL Connections search results. Just search as normal and results from Huddo Boards will appear if there are any.
Huddo Boards results when searching all content Huddo Boards results when searching from the sidebar"},{"location":"boards/howto/dependencies/","title":"Task Dependencies","text":""},{"location":"boards/howto/dependencies/#task-dependencies-in-huddo-boards","title":"Task Dependencies in Huddo Boards","text":"Huddo Boards supports the use of task dependencies within boards. A task dependency is where a task relies on another task or tasks to be completed before it can be completed itself. A single task can be dependant on multiple tasks and multiple tasks can be dependant on a single task.
"},{"location":"boards/howto/dependencies/#creating-a-task-dependency","title":"Creating a Task Dependency","text":"Task dependencies can be created in several ways:
"},{"location":"boards/howto/dependencies/#within-an-open-task","title":"Within an open task","text":"Find and click the Add Dependency button in the task bar:
Add Dependency Button:Add Dependency buttons will also be available within the task details view here:The Add Dependency Dialog will be shown:
Select a task that you want to add as a dependency for the current task. The dependency you choose will need to be completed before the current task can be completed.
Swap Direction button Add button to create the task dependency.Timeline view of your board.Drop the icon onto the intended task and the dependency relationship will be created.
6. Once the dependency has been created then dependency icons can be observed on both the parent and child of the dependency.
Opening a (either a child or parent) task with dependencies will list those dependencies on the task details view.
Dependencies for a particular task can be displayed/visualised in various ways depending on what view you are using to display your board.
"},{"location":"boards/howto/dependencies/#board-view","title":"Board view","text":"Timeline view is the best way to visually observe dependencies as arrows drawn between scheduled tasks.
There are several options available for showing dependency arrows in the timeline view, controlled by settings in the right hand sidebar:
"},{"location":"boards/howto/dependencies/#show-all-dependency-arrows","title":"Show all dependency arrows","text":"This is the default setting and will show all dependencies as blue arrows at all times. The arrows will recalculate themselves if tasks are moved or resized, or if dependencies are added or removed.
"},{"location":"boards/howto/dependencies/#hide-dependency-arrows","title":"Hide dependency arrows","text":"Use this option to hide all dependency arrows in Timeline. Hovering on a task to show its dependency chain can still be achieved when arrows are hidden, depending on the setting below.
"},{"location":"boards/howto/dependencies/#hover-on-a-task-to-highlight-its-dependency-chain","title":"Hover on a task to highlight its dependency chain","text":"Hover anywhere for a few moments on a task/card that has dependencies to highlight dependent tasks and also visualise the chain of dependency links as arrows to and from the dependant cards. Note that numbers also appear in the top right of the highlighted cards to indicate the order that they need to be completed.
When Hover on a task to highlight its dependency chain is enabled, the arrow display depth slider will be shown, and can be used to increase the number of \"levels\" (backwards and forwards from the hovered card) to show a chain of dependency link arrows in the Timeline view, originating from the card that is being hovered on.
See the animation below as an example of 2 levels of dependency depth.
"},{"location":"boards/howto/dependencies/#completing-a-task-that-has-dependencies","title":"Completing a task that has dependencies","text":"Attempting to complete a task that has incomplete dependencies will trigger the following dialog:
*Note that individual tasks cannot be completed from this view.
"},{"location":"boards/howto/dependencies/#available-actions","title":"Available actions","text":""},{"location":"boards/howto/dependencies/#complete-all-task-dependencies-and-this-task","title":"Complete all Task Dependencies and this task","text":"Click this to complete the task after completing all of its preceding dependencies as displayed in the dialog.
"},{"location":"boards/howto/dependencies/#cancel","title":"Cancel","text":"Close the dialog without taking an action.
"},{"location":"boards/howto/getting-started/","title":"Getting Started","text":""},{"location":"boards/howto/getting-started/#getting-started","title":"Getting Started","text":"Huddo Boards is a intutive to learn and easy to master. It is a powerful addition to any business, whether you're looking to increase your personal productivity, super charge your teams', or collaborate with external parties. Learn quick tips and tricks from our help guides to get the most out of boards. Let's get started!
If you have signed in to Huddo Boards for the very first time as an individual user without a licence, see Starting a trial of Huddo Boards
Here are some quick instructions to help you get started with Huddo Boards.
"},{"location":"boards/howto/getting-started/#create-a-board","title":"Create A Board","text":"New Board button, or use the + buttons as indicated below.Enter a name and description for your new board. Don't worry you can edit these later.
Select any users or groups you would like to add to your board. Also select if you would like to share this board with the rest of your team. These settings can be changed after a board has been created as well.
Blank to choose your own adventure!Kanban, Mindmap and Timeline. Note that the view of the board can be switched at any point in time.CreateAdd lists to a board to categorise todos and entries. Click on Add a list to add a new list to your board.
Click on Add a card in any list to add a card to that list.
Add cards to your lists to represent Tasks, Work Items, Decisions, Ideas, Notes, Options, Sub-lists - Really anything you need them to represent. The beauty of this design is that you can use lists and cards to mean anything you need to for the task at hand.
"},{"location":"boards/howto/getting-started/#assign-tasks-to-others","title":"Assign Tasks To Others","text":"Assign Tasks to people in the board by either dragging their photo from the members panel in the right side bar. Or use the Assign Users control from the card details view. When you assign a card to a person, they are notified of the assignment via email and also via any news feeds that board has access to (Workspace chat, Connections activity stream, etc.).
"},{"location":"boards/howto/getting-started/#plan-your-tasks","title":"Plan Your Tasks","text":"Boards lets you assign due dates to a card, as well as start and end dates, to help you better plan your tasks. Go to the Timeline View in a board to view the cards according to their start and end dates. To modify the start/end/duration of a card, simply drag the card to a new date, or drag the edges to individually change the start or end date.
"},{"location":"boards/howto/getting-started/#view-card-details","title":"View Card Details","text":"Click on a card to open it. The card details popup gives you access to a whole range of information and controls for the card. It lets you view and edit the card's name, completion status, description, tags, attachments, comments, due date, colour labels, fields and much more!
"},{"location":"boards/howto/getting-started/#edit-board-options","title":"Edit Board Options","text":"Click on the Edit icon on the top right of the board to open the Board details view. This view lets you edit the board's name, description, tags, due date and more. It also let's you create a templates and archive the board.
"},{"location":"boards/howto/getting-started/#add-and-remove-board-members","title":"Add and Remove Board Members","text":"Click on Members in the right sidebar to open the Board Members view. You can view all the orgs, individuals and groups who have access to this board. If you have Owner role for the board, you can also add and remove members from this view. It is also possible to invite a user to the board using their email address.
"},{"location":"boards/howto/getting-started/#colour-code-your-cards","title":"Colour Code Your Cards","text":"Huddo Boards allows you to colour code your tasks by simply dragging and dropping the colours from the right sidebar onto cards. You can also assign custom text labels to each of the colours by simply clicking the edit icon in the Colour Labels section in the right sidebar. These labels are set at the board level and everyone in the board will see the same labels.
"},{"location":"boards/howto/getting-started/#_1","title":"Getting Started","text":""},{"location":"boards/howto/getting-started/#colour-code-your-boards-in-myboards-dashboard","title":"Colour Code Your Boards in MyBoards Dashboard","text":"Huddo Boards let's you colour code all your boards to help you personally manage and categorise your work. To colour code a board tile in the MyBoards Dashboard, simply drag a colour from the left sidebar and drop it on a board. Much like card colour labels, you can also add custom text labels to these colours, however, this is for your personal organisation and as such will only be visible to you. To edit the board colour labels, click the edit icon in the Colours section in the left sidebar. Filter to see boards from one or more specific colours by clicking on the colour.
To see your boards organised by colour, set your View to Colours.
The picture below shows the Myboards Dashboard. This is your start / home page with colourful tiles. Each tile is one Board with a name, when it was last accessed, progress on tasks and more.
"},{"location":"boards/howto/homepage/#on-this-start-page-you-can","title":"On this start page you can:","text":"Create a new Board by clicking on the Plus sign and Create
Open an existing Board by clicking on one of the tiles
Search for a Board by entering the search word in the Search Boards field at the top
Filter Boards by My, Public and Archive
Sort Boards by Recent and Last accessed
Colours These are colour tags you can drag and drop onto the tiles. Click on the menu to edit the tags.
Add tags to the Boards for easy sorting and filtering in the same way as with colours above.
See all your collected tasks from all your Boards by clicking on Todos
Find the template library by clicking on Templates
If there are scheduled tasks in a board, a calendar feed can be enabled allowing you or others to subscribe to the feed of board tasks as events in your calendar app.
Calendar applications such as Microsoft Outlook will perform regular synchronisation with the feed, so any changes made to the scheduled tasks in Boards will be updated in your calendar automatically.
"},{"location":"boards/howto/ical/board/#enabling-a-calendar-feed-for-a-board","title":"Enabling a calendar feed for a board","text":"Navigate to Open Board Options found in the title of your board, to the left of the search bar.
Underneath the action bar on the right hand sideyou will see an iCalendar feed box with an Enable button. Click this to enable the calendar feed for this board.
After clicking enable, additional buttons will become available for subscribing to, copying the link for, or disabling the calendar feed:
Subscribe to open your chosen calendar app for your operating system and subscribe to the feed.Click Copy feed link to copy the link to the feed to your clipboard. This may be useful for pasting into a calendar application, or sharing the calendar feed to people who are not listed as board members.
Info
You may experience an error similar to the following when attempting to subscribe to a board calendar feed within Microsoft Outlook for Windows.
In this case, follow the steps shown here to disable shared calendar improvements. After restarting Outlook, the calendar subscription should now work.
Click Disable to disable the feed for the board. The feed will no longer be available and any subscriptions to this board feed will not continue to sync.
A calendar feed can be subscribed to for all scheduled tasks you are assigned to within Huddo Boards.
Calendar applications such as Microsoft Outlook will perform regular synchronisation with the feed, so any changes made to the scheduled tasks in Boards will be updated in your calendar automatically.
"},{"location":"boards/howto/ical/personal/#subscribing-to-your-personal-calendar-feed","title":"Subscribing to your personal calendar feed","text":"From the My Boards Dashboard/Homepage, navigate to my Todos found in the left hand side menu.
Once in the Todos view you will see an iCalendar feed section at the bottom of the left hand side menu.
Subscribe to open your chosen calendar app for your operating system and subscribe to the feed.Copy feed link to copy the link to the feed to your clipboard. This may be useful for pasting into a calendar application.Info
You may experience an error similar to the following when attempting to subscribe to a calendar feed within Microsoft Outlook for Windows.
In this case, follow the steps shown here to disable shared calendar improvements. After restarting Outlook, the calendar subscription should now work.
Activities that already exist in HCL Connections can be individually imported into Huddo Boards.
First, hover over the 'Create Board' button in the bottom right and select the 'Import from Activities' option that appears
From here, you can search for the Activity you wish to import, either previewing the result or just importing directly. A new card will be created at the start which indicates this has been done as well as a link to the Board.
"},{"location":"boards/howto/microsoft/onedrive/","title":"Microsoft OneDrive","text":""},{"location":"boards/howto/microsoft/onedrive/#huddo-boards-and-microsoft-onedrive","title":"Huddo Boards and Microsoft OneDrive","text":"The Huddo Boards integration with Microsoft OneDrive allows you to find files that you have added to boards, conveniently located in your OneDrive.
In the example below, a file titled \"Best Melbourne Restaurants\" has been added to the board, Food Objectives 2019.
The file will be added to OneDrive for easy access and location.
In the example above, the board is part of a Teams Channel called \"Places to Eat 2019\", and as a result, a shared library has been created to hold those files.
Files will be added to OneDrive whether they are from private or shared boards.
"},{"location":"boards/howto/microsoft/outlook/","title":"Microsoft Outlook","text":""},{"location":"boards/howto/microsoft/outlook/#huddo-boards-in-microsoft-outlook","title":"Huddo Boards in Microsoft Outlook","text":"Huddo Boards' integration with Microsoft Office 365 allows you to create cards on a board directly from an email in your inbox, and share cards, lists, or an entire board, within an email.
"},{"location":"boards/howto/microsoft/outlook/#create-a-card-from-an-email","title":"Create a Card From an Email","text":""},{"location":"boards/howto/microsoft/outlook/#desktop-outlook","title":"Desktop Outlook","text":"Navigate to the email you would like to attach as a card to a board. Click the Save email as card button in the Home ribbon.
The title of the email will automatically be filled, however you have the opportunity to change this if you wish. Select to Include email body so the contents of your email are included in your card. A board and list will automatically be recommended to you however you can change this selection by clicking on the board and list fields and making a new selection.
Click Create.
In the next window, click the Open in Boards button to be taken to the board and see the card. It will look something like this:
Navigate to the email you would like to attach as a card to a board. Click the ... for more actions and scroll down to select Huddo Boards.
The title of the email will automatically be filled, however you have the opportunity to change this if you wish. Select to Include email body so the contents of your email are included in your card. A board and list will automatically be recommended to you however you can change this selection by clicking on the board and list fields and making a new selection.
Click Create.
In the next window, click the Open in Boards button to be taken to the board and see the card. It will look something like this:
To include a card, list, or board, in an email, create a new email, or select reply or forward of an existing email already in your inbox.
On Desktop Outlook, you'll find the Attach Board/Card button in the Message ribbon.
In the side panel that appears, you'll have the option to select your desired board and the lists or cards you would like to include. You can select an entire board, or simply a card or list (or multiple cards and lists to attach). Click Attach when you've made your selection. Continue to add more by repeating the same selection process and attaching to the email.
To include a card, list, board, in an email, create a new email, or select reply or forward of an existing email already in your inbox.
Click the ... at the bottom of the email and select Huddo Boards.
In the side panel that appears, you'll have the option to select your desired board and the lists or cards you would like to include. You can select an entire board, or simply a card or list (or multiple cards and lists to attach). Click Attach when you've made your selection. Continue to add more by repeating the same selection process and attaching to the email.
Huddo Boards' integration with Microsoft Office 365 allows you to add Huddo Boards to a SharePoint site page and work directly on the board from the page.
In the example below, we've created a site page called \"Where to Eat in Melbourne\" and added our Food Objectives 2019 board to it. When added, you and your colleagues can work directly from a site page on a board.
Before proceeding, you will need a site admin to enable security settings as described here
From Sharepoint main menu, go to Pages -> New -> Site Page
Give your page a name, then click the +
Choose Embed from the drop down menu
Open Huddo Boards and select the board you wish to embed in the sharepoint page. Click the Board Options button
Click Copy embed code
Go back to sharepoint and paste the code you copied in the box provided
Tip
If you don't see the input box above, you can get it back by clicking the embed you added previously and clicking it's edit button.
To make a small amount of extra room on your page, you may wish to edit the title and choose Plain as it's layout.
Once you are happy with the page, click 'Publish' to make it visible to other members of your site.
Promote your new page by following the recommendations
The Mind Map layout in Huddo Boards is a unique view that allows you to have a visual overview of all your tasks from one board. Mind Map is ideal for strategic planning, brainstorming, inventing, R&D, marketing, and more.
"},{"location":"boards/howto/mindmap/#accessing-the-mind-map-view","title":"Accessing the Mind Map View","text":"The Mind Map view can be set as the Starting View when you create a board or it can be switched to at any time during your work on a Board.
In your board creation phase, select Mind Map from the Starting View drop down.
If your board is already created in either the Timeline or Board view, it is simply a matter of selecting the Mind Map view from the right-hand side menu.
In this example, we\u2019ll create a new mind map and select Blank as the template, so we can populate it entirely ourselves. Alternatively, you can select one of the preloaded templates like Classic, Weekdays, Departments, or Meetings.
When you create a new mind map, you\u2019ll see the title of the board, sitting front and center on the page. You\u2019ll notice that just above the boxed title, there are two icons. The icon on the left creates a new sub-card. Since we\u2019ve just begun our board, this will first create lists.
You can add as many lists as you like and at any stage of your mind map. Then add cards to your list areas, as you would on the Kanban Board view. Use the Add a Sub-Card icon on your desired list to add cards.
You can add as many cards to the blue list titles as you like. Using the Add a Sub-Card icon on a card, will create a sub-card.
As with a board and timeline, you can drag and drop colour labels and members on to your mind map.
"},{"location":"boards/howto/mindmap/#mind-map-views-and-layouts","title":"Mind Map Views and Layouts","text":"On the right-hand side menu, you have tools that can change the layout of your Mind Map.
Re-Centre: If you\u2019ve focused in one section of your mind map, clicking Re-Centre will bring you back to a big picture view of your map.
Layout: Radial
Layout: Horizontal
Layout: Vertical
Mirror / Reverse: Flip the layout of your mind map between mirror and reverse.
Type: Use Type to dictate how your lists, cards, and sub-cards are connected to each other.
Type: Free
Type: Step
Curve
Type: Line
"},{"location":"boards/howto/permissions/","title":"Member Permissions","text":""},{"location":"boards/howto/permissions/#permissions-in-huddo-boards","title":"Permissions in Huddo Boards","text":"When you invite colleagues, teams, or external parties to collaborate in your board, you can decide what level of permission to allocate to them. Below, permissions are listed from the lowest access to the highest.
"},{"location":"boards/howto/permissions/#reader","title":"Reader","text":"A person allocated a Reader permission, has read-only access.
"},{"location":"boards/howto/permissions/#author","title":"Author","text":"A member with Author permissions, has the ability to create new cards, edit their cards, and any cards assigned to them. They cannot edit existing cards.
"},{"location":"boards/howto/permissions/#editor","title":"Editor","text":"An Editor has the ability to edit existing content, and create new content. Editors can invite and manage other members with the roles Reader, Author and Editor (they cannot change Owners)
"},{"location":"boards/howto/permissions/#owner","title":"Owner","text":"Owners have full rights to all properties on a board, they can add, edit and delete all other members, lists and cards in the board.
Find out more about how to add members to a board.
"},{"location":"boards/howto/permissions/#making-your-board-public","title":"Making Your Board Public","text":"When you activate Public Access, your board will be discoverable by anyone in your organisation. You'll be asked to select Reader, Author, or Editor to decide what level of access your organisation can have to the board. Additionally, updates that you make on your board may be included in linked activity streams such as HCL Connections, or Microsoft Teams.
To give your board public access, navigate to your desired board. Select Members and then select Public Access. Decide what level of access, Reader, Author or Editor, your organisation will have.
You can @mention a team member within the description or comments area of a card to get their attention. This will send them a notification that they\u2019ve been mentioned and can take action on what you\u2019ve written.
"},{"location":"boards/howto/quick-tips/#move-between-board-mind-map-and-timeline","title":"Move between Board, Mind Map, and Timeline","text":"Chose the Kanban view setting up your board, but decided a Mind Map would be better for brainstorming ideas? No worries!
Using the right-hand side menu, transform the view of your board between the Kanban Board, Mind Map, and Timeline. Information in your board remains the same, only your view will change. Change as often as you like or depending on your needs.
"},{"location":"boards/howto/quick-tips/#add-members-to-a-board","title":"Add Members to a Board","text":"When you start a new board, you can choose to invite members to participate. But if you\u2019ve got a board you\u2019re already working on, you can also invite members at any point of your work on the board.
Use the right-hand menu and select Members.
Start typing an individual, group name, or email address to bring up people in your organisation.
To invite people external to your organisation, type in their email address. Don\u2019t forget to click Add Members before closing the screen.
This screen allows you to choose the type of rights your members will have: Owner, Editor, Author, Reader.
You can also decide if you want the board to be Public Access, which will enable anyone from your organisation to see it.
"},{"location":"boards/howto/quick-tips/#use-colour-labels-to-categorise-and-filter","title":"Use Colour Labels to Categorise and Filter","text":"You can use the Colour Labels on the right-hand side menu to help categorise your board.
Click the pencil to the right of Colour Labels, then update the colours with your desired label names.
Drag and drop the colour labels on to a card. Do the same action to remove the colour from the card.
You can also click on a colour or multiple colours to filter the cards.
"},{"location":"boards/howto/start-a-trial/","title":"Starting a trial","text":""},{"location":"boards/howto/start-a-trial/#starting-a-trial-of-huddo-boards-cloud","title":"Starting a trial of Huddo Boards Cloud","text":"You can use your O365, LinkedIn, Facebook, AppleID or HCL Connections Collab Cloud to access Huddo Boards Cloud.
The first time you log in to Huddo Boards Cloud as an individual user, you will not have access to the Huddo Boards Premium Views (Kanban Board, MindMap, and Timeline), only the free Activity View (simple drop down list).
There are two ways to activate a free 30 day trial in order to access the premium views.
"},{"location":"boards/howto/start-a-trial/#activate-free-trial-via-myboards-dashboard","title":"Activate free trial via MyBoards Dashboard:","text":"User Options and then select View Subscriptions. Start My Trial to activate your free 30 day trial. You can return to View Subscription at any point to purchase a licence for Huddo Boards for yourself or for a number of people in your organisation.
Create button to start a new board. Save when you are done. Board MindMap and Timeline in the right hand menu will be greyed out with the words Preview Available under each. Select any of these and follow prompts to start your free trial. Boards has integrated seamlessly with Microsoft Office 365 Teams so you can supercharge your existing collaboration environments.
Add boards to Microsoft Teams as an administrator.
"},{"location":"boards/howto/teams/adding-boards/#accessing-all-of-your-boards-in-microsoft-teams","title":"Accessing all of your Boards in Microsoft Teams","text":"When you open Microsoft Teams, click the \u2026 icon in the left-hand side menu and select Add More Apps.
In the Store search bar, type in Huddo Boards. Click the Huddo Boards icon. The following window will appear:
You can choose if you wish to add to a specific team, but for the moment, we want to have all of our Boards accessible in one place. So keep the options as represented here. Click Install.
Press the X in the next window as installation has now been completed.
You can now access all your Boards in one place, by navigating to the \u2026 on the left-hand side, and selecting Huddo Boards.
From here, select the My Boards tab, next to Conversation. You\u2019ll have access to all your Boards via the My Boards dashboard as normal, but conveniently located within Microsoft Teams.
You can work on Boards from within Channels. To add a Board to a channel, click on the + sign in the top menu next to Wiki.
You can select the Huddo Boards icon or search it if it doesn\u2019t appear directly.
In the next window, select your preferences, to either
Enter the board information and click Save.
Your Board will now appear in its own tab alongside Wiki. Add multiple boards by repeating the same process.
"},{"location":"boards/howto/teams/disable-notifications/","title":"Teams - Disable Notifications","text":"If you find that your Microsoft Teams team Conversations tab is getting a bit crowded with all the updates your team are making in Huddo Boards, it is possible to control whether or not team notifications are posted in Conversations for each board in your team.
To do this, firstly open a board within a Teams tab.
Click the Open Board Properties button in the top-left corner of the board:
In the board properties you will see a Disable team notifications for this board button. (note that this may take a few seconds to appear):
Click this to disable all notifications for the board from coming up in the Conversations tab of your team.
Note that the notifications for the board can be enabled again by clicking the Enable team notifications for this board button in the same location of the board properties dialog:
Made a fantastic board and want to keep a copy for future use? Save time and brain power by creating a template of your board.
"},{"location":"boards/howto/templates/creating/#create-a-template-from-an-existing-board","title":"Create a Template From an Existing Board","text":"Within your board, click the title of your board to Open Board Options. Find this located between the Huddo Boards logo and the search bar. Next, click, Create Template from Board.
In the next window, you can update the name, description, and choose to keep Board Members as is, remove or add Board Members. Click Save. The template will open in a new screen.
You\u2019ll be able to locate your template in your template library via the MyBoards Dashboard or when you create a new board and search the name.
Important: When the template opens in a new screen, any editing you do will apply to the template. Click in to the Open Board Options icon as you did above and select, Create Board from Template. When the new window opens, you\u2019ll start a new board instead of editing the template you\u2019ve just created.
From your main MyBoards dashboard, navigate to Templates via the left-hand side menu. You\u2019ll land on the My Templates page and see templates you have created.
Click the + New Template button to start your creation. You have the option to select Source Board / Template in the creation process, meaning you can make a template from another template that already exists. Leave this blank if you prefer to build your template from scratch in the board.
Public Template Access: Making a template in the public area, will not automatically make it public. Within the template you create, you\u2019ll be able to select if you wish for it to be public. You can do this in the template creation window or later when it is created by finding Public in the Members section on the right-hand side menu.
Complete the required information for your template, then click Create.
Your new template will open as a blank board template or with lists and cards if you selected from a Source Board/Template. From here, customise your template by editing or adding required lists, cards, colour labels, tags and more.
In future, when creating a new board, type in the template name in the Search All Templates field, during the New Board creation phase.
Note: Opening a board via the template library will mean you are editing the template. You can create a new board from the template by:
Open Board Options, then selecting, Create Board from Template; orSearch All Templates search bar.You can access a library of global templates already available from Huddo Boards to use as inspiration for your own work.
When you start a New Board, click Explore the Template Library.
This will open a new window with available templates.
Feel free to click in to different templates to see what they contain.
When you\u2019ve found the template you\u2019re looking for, return to your original New Board screen and start typing in the template name. It will appear and you can select it.
You still have the option to select the Starting View, from Kanban, MindMap, Timeline or Activty.
Click Next to give your board a name and then Save and you\u2019ll be taken to your new Board.
When creating a Board from a template that contains dates (due, start or end dates), you have the option move all of the dates so that the first or last date is on a particular day. For example, if you have a template for preparing for a business trip, you can reschedule your template so that all of your tasks are due before your date of departure.
On the My Boards page, click the + Create button. The New Board window will open. Search templates by name and select your template that contains dates.
Click Next.
You'll see an option to choose a Starts on or Finishes on date. Select the one that makes sense for your template. (This won't appear if there are no dates in your template.) Use the date picker to choose which day you'd like your dates to start or finish.
Click Save. Your new Board will be created.
Timeline view.Board -> Todos by Date view.Instead of people assigned to tasks, templates can have roles assigned to tasks. When creating a board from this template, you can assign the members of this new board to these roles and they will be responsible for completing the tasks the role had been assigned. For how to create templates like this, see Create a Template with Assignment Roles.
After you've selected a template and chosen some members to add to your board, you'll see the Assign Roles step if your template includes Assignment Roles assigned to tasks.
Drag and drop members on to the roles to assign them to the role. You can assign multiple members to a role and a member to multiple roles.
Once you've created the board, you will see members assigned to the tasks that had roles assigned.
"},{"location":"boards/howto/timeline/","title":"Timeline","text":"
Huddo Boards has multiple views to help you get your tasks done, whether you\u2019re working individually, as a team or as an organisation. The Timeline view is a unique component of Boards and we\u2019ll explore it here, to demonstrate how it can help you stay on track to meet your deadlines.
"},{"location":"boards/howto/timeline/#accessing-the-timeline-view","title":"Accessing the Timeline View","text":"The Timeline view can be set as the Starting View when you create a new board or it can be switched to at any time during your work on a board.
In your board creation phase, selectTimeline from the Starting View drop down.
If your board is already created in either the Mind Map or the Kanban Board view, it is simply a matter of selecting the Timeline view from the right-hand side menu.
Whether you\u2019re starting a new board, or using an existing board, for cards to appear on the timeline, they\u2019ll need to have a start and finish date. From the Timeline view, these dates can be added in two ways:
If you have cards that are sitting in the Unscheduled Cards area on the bottom right-hand side, you can drag and drop them on to the timeline. To begin, cards can only be dropped in to the list they have been created in and will by default, be allocated to three days from start to finish.
Once you\u2019ve dropped a card in to its list, you can move it along the timeline in either direction, shorten or lengthen its start and finish dates, or move to a different list.
Cards sitting in the Unscheduled Cards area can be clicked on to bring up the detailed card view. From here, select Set Dates, from the right-hand side menu. Add in a start and finish date under the card title for it to appear on the Timeline. The finish date will automatically fill to three days after start date, but this can be edited.
Note: In the Kanban Board view or Mind Map view, you also have the option to add dates to cards, by clicking in to the detailed card view, selecting Set Dates, and adding a Start Date and End Date. If you then switch over to the Timeline view, your cards will automatically fall on the timeline to the dates you have selected.
The default view of Timeline is to group by Lists. But you have the option to view the cards on the board by Colour, Label, and by Assigned. Use the drop-down menu in the top left corner next to Group By to select from List, Colour, or Assigned.
Boards has many integration options to suit your needs. Please contact us if you have any specific requirements that are not covered.
"},{"location":"boards/integrations/developing/related-tasks/","title":"Use Huddo Boards Related Task Microapp","text":"To display this use the following pattern to load and use the microapp
<boardsURL>/app/linkedcards?title=<boardsCardTitle>&url=<boardsPrimaryLink>
where - <boardsURL> is the URL of your Huddo Boards installation (boards.huddo.com for Boards Cloud) - <boardsCardTitle> is the default title for the task when created which users can change, fully escaped - <boardsPrimaryLink> is the URL of the page you want to show tasks related to, fully escaped
e.g. https://boards.huddo.com/app/linkedcards?title=Card%20Name&url=https%3A%2F%2Fexample.com
There is also a message sent with the current number of related tasks if you wish to display this.
The event data is in the format huddo-task-count=0
Example for JavaScript:
window.addEventListener(\"message\", (event) => {\n\n if(event.origin !== <boardsURL>)\n return;\n\n let eventData = event.data;\n\n //huddo-task-count=0\n if(typeof eventData === \"string\" && eventData.includes(\"huddo-task-count\"))\n {\n boardsNumTasks = event.data.split('=')[1];\n }\n}\nDeploying Huddo Boards into Kubernetes -or- IBM Cloud Private for on-premise environments
"},{"location":"boards/kubernetes/#prerequisites","title":"Prerequisites","text":"kubectl configured
Instructions Kubernetes copy~/kube/.config from the Kubernetes master server to the same location locally(backup any existing local config) IBM Cloud Private - Open ICP Console- Go to Admin (top right)- Click Config Client- Copy the contents shown- Open your command line / terminal- Paste the commands copied earlier and press enter Kubernetes for on-premise environments requires a reverse proxy to route traffic. There are a number of different ways this reverse proxy can be configured and Huddo Boards aims to match whatever you already have in place. Some examples of network routing:
New domain Path on existing domain Example ofBOARDS_URL boards.example.com example.com/boards Example of API_URL api.example.com example.com/api-boards Requirement 1. Reverse proxy able to match any current domains as well as the new one for Huddo Boards (either by using SNI or a compatible certificate for all domains).2. Certificate coverage for the 2 domains. Ability to proxy the 2 paths Certificate Resolution a) in your proxy and forward the unencrypted traffic to kubernetes-OR-b) forward the encrypted traffic and perform the certificate resolution in kubernetes (described in config below). All certificate resolution on the proxy server Notes IBM HTTP WebServer supports only one certificate. You must have a Wildcard certificate to cover all of your domains including the new Boards domains (ie *.example.com). Additional config required to make Boards webfront handle redirects, details below. For Connections Header Additional WebSphere application must be installed - Please decide on which configuration will suit your environment best and the corresponding BOARDS_URL & API_URL. These values will then be used in the following documentation.
For more details on configuring an IBM HTTP WebServer as reverse proxy, please see here
"},{"location":"boards/kubernetes/#oauth","title":"OAuth","text":"Huddo Boards currently supports the following oAuth providers for authentication and integration: HCL Connections (on premise), IBM Connections Cloud and Microsoft Office 365.
You will need to setup an OAuth application with one (or more) of these providers for Huddo Boards to function. please refer to the following documentation:
Provider Registration / Documentation Callback URL HCL Connections(on premise) Huddo instructionshttps://[BOARDS_URL]/auth/connections/callback Microsoft Office 365 Azure app registrations https://[BOARDS_URL]/auth/msgraph/callback Google Google Console https://[BOARDS_URL]/auth/google/callback LinkedIn LinkedIn https://[BOARDS_URL]/auth/linkedin/callback Facebook Facebook developer centre https://[BOARDS_URL]/auth/facebook/callback"},{"location":"boards/kubernetes/#huddo-boards-namespace","title":"Huddo Boards namespace","text":"kubectl create namespace boards\nHuddo Boards requires a Mongo database and an S3 file storage. If you already have equivalent services already then you can use your existing details in the config below, otherwise you may follow our instructions to deploy one or both of these services as follows:
Note: these tasks are very similar to each other and can be performed simultaneously
"},{"location":"boards/kubernetes/#secrets","title":"Secrets","text":"Follow this guide to get access to our images in Quay.io
SSL certificate details
Only perform this step if you need to resolve certificates in kubernetes
kubectl create secret tls huddoboards-domain-secret --key </path/to/keyfile> --cert </path/to/certificate> --namespace=boards\nDownload our config file and update all example values as required. Details as below.
Kubernetes Variables:
Key Descriptionglobal.env.APP_URI https://[BOARDS_URL] global.env.MONGO_USER MongoDB userIf using our storage above you may leave this commented out global.env.MONGO_PASSWORD MongoDB passwordIf using our storage above you may leave this commented out global.env.MONGO_HOST MongoDB hostIf using our storage above you may leave the default global.env.MONGO_PARAMS MongoDB request parametersIf using our storage above you may leave the default global.env.S3_ENDPOINT S3 URLIf using our storage above you may leave the default global.env.S3_ACCESS_KEY S3 Access KeyIf using our storage above you may leave the default global.env.S3_SECRET_KEY S3 Secret KeyIf using our storage above you may leave the default webfront.ingress.hosts [BOARDS_URL] (no protocol) core.ingress.hosts [API_URL] (no protocol, e.g. api.huddoboards.com) Boards Variables:
Follow instructions on this page
"},{"location":"boards/kubernetes/#deploy-boards-chart","title":"Deploy Boards Chart","text":"Install the Boards services via our Helm chart
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards --recreate-pods\nNote: --recreate-pods ensures all images are up to date. This will cause downtime.
in the linked document you should use the IP of your kubernetes manager and the http port for your ingress (32080 if you have component pack installed)
Please follow these instructions
"},{"location":"boards/kubernetes/#connections-cloud-or-microsoft-office-365","title":"Connections Cloud or Microsoft Office 365","text":"Add a reverse proxy entry in your network that resolves your certificates and forwards your 2 domains to the IP of the kubernetes manager and the http port for your ingress. If any assistance is required
"},{"location":"boards/kubernetes/#hcl-connections-integrations","title":"HCL Connections integrations","text":"Huddo Boards requires a Mongo database.
Warning
The example below is suitable for a Small Scale Deployment, e.g. a proof of concept, staging deployment or even a production deployment for a limited number of users/data.
Tip
For Large Scale Deployments (HA) please use either MongoDB:
bitnami/mongodb offer a decent wrapper to initialise a replicaset with their Helm chart.This documentation will deploy a MongoDB replicaSet into your Kubernetes setup.
If you already have externally hosted Mongo database please skip to the Outcomes section to determine your equivalent connection parameters.
You can also email us for support at support@huddo.com
"},{"location":"boards/kubernetes/deploy-mongo/#prerequisites","title":"Prerequisites","text":"nfs.path /pv-kudos/mongo Path to storage location 22 nfs.server [STORAGE_SERVER_IP] IP of NFS serverie 192.168.10.50"},{"location":"boards/kubernetes/deploy-mongo/#deploy-instructions","title":"Deploy instructions","text":"Create the folder at nfs.path location on the nfs.server with access 777
Note: please ensure sufficient storage is available (ie 100GB)
Ensure each Node in your Kubernetes cluster can mount this location.
Please modify the file /etc/exports on your NFS Server to include this line
<NFS_PATH_FOR_MONGO> <IP_RANGE_OF_YOUR_SERVERS>/<SUBNET_MASK>(rw,no_root_squash)\nFor example:
/pv-kudos/mongo 192.168.0.0/255.255.0.0(rw,no_root_squash)\nApply new NFS storage to exports
exportfs -ra\nInstall Mongo
kubectl apply -f ./mongo.yaml\nThe following are the parameters required to connect to this database. You will need these later in the application setup. If you have your own MongoDB deployment, please substitute your values.
Key Default Value DescriptionMONGO_PROTOCOL mongo Protocol used in your Connections String MONGO_HOST mongo-service:27017 Hostname of your Mongo service MONGO_PARAMS replicaSet=replicaset Request parameters (ie ?) MONGO_USER None Username to connect.Authentication is disabled in this private deployment MONGO_PASSWORD None Password to connect.Authentication is disabled in this private deployment Alternatively, these parameters can be set with MONGO_URI which is built from:
[MONGO_PROTOCOL]://[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]\n\nmongo://mongo-service:27017/database?replicaSet=replicaset\nOr with optional credentials:
[MONGO_PROTOCOL]://[MONGO_USER]:[MONGO_PASSWORD]@[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]\n\nmongo://user:passw0rd@mongo-service:27017/database?replicaSet=replicaset\nHuddo Boards requires an S3 object store. This documentation will deploy a Minio S3 storage container into the Kubernetes setup.
If you already have externally hosted S3 storage please skip to the Outcomes section to determine your equivalent connection parameters.
You can also email us for support at support@huddo.com
"},{"location":"boards/kubernetes/minio/#prerequisites","title":"Prerequisites","text":"nfs.path /pv-kudos/minio Path to storage location 22 nfs.server STORAGE_SERVER_IP IP of NFS serverie 192.168.10.50 69 MINIO_ACCESS_KEY ioueygr4t589 Access credential 71 MINIO_SECRET_KEY 7a863d41-2d8f-4143-bc8a-02501edbea6f Access credential"},{"location":"boards/kubernetes/minio/#deploy-instructions","title":"Deploy instructions","text":"Create the folder at nfs.path location on the nfs.server with access 777
Note: please ensure sufficient storage is available (ie 100GB)
Ensure each Node in your Kubernetes cluster can mount this location.
Please modify the file /etc/exports on your NFS Server to include this line
<NFS_PATH_FOR_MINIO> <IP_RANGE_OF_YOUR_SERVERS>/<SUBNET_MASK>(rw,no_root_squash)\nFor example:
/pv-kudos/minio 192.168.0.0/255.255.0.0(rw,no_root_squash)\nApply new NFS storage to exports
exportfs -ra\nInstall Minio
kubectl apply -f ./minio.yaml\nThe following are the parameters required to connect to this S3 storage. You will need these later in the application setup. If you have your own S3 storage, please substitute your values.
Key Default Value DescriptionS3_ENDPOINT minio-service Hostname of this service(as per line 84 of config) S3_ACCESS_KEY ioueygr4t589 Credential configured above S3_SECRET_KEY 7a863d41-2d8f-4143-bc8a-02501edbea6f Credential configured above S3_BUCKET kudos-boards Default storage bucket"},{"location":"boards/kubernetes/prerequisites/","title":"Prerequisites","text":"Requirements and considerations before installation of Kubernetes and Huddo Boards
"},{"location":"boards/kubernetes/prerequisites/#servers","title":"Servers","text":"This solution is designed to run a cloud-like environment locally in your data centre. You should expect to configure a minimum of 3 servers.
This solution is ideal if you already have kubernetes (or IBM Component Pack for connections) as it can run in your existing environment. If this is the case, please reach out to Team Huddo for support.
"},{"location":"boards/kubernetes/prerequisites/#existing-infrastructure","title":"Existing Infrastructure","text":"In addition to the above, Huddo Boards for Kubernetes is able to take advantage of existing services in your network, if you have any of the following and would like to take advantage of them, please ensure you have all relevant access documented.
Service Requirements MongoDB URL, username and password S3 Storage URL, Bucket name, username and password NFS Server IP address or hostname, must be accessible to all swarm servers"},{"location":"boards/kubernetes/prerequisites/#stmp-for-email-notifications","title":"STMP for email notifications","text":"If you would like to send emails, Huddo Boards docker requires details of a forwarding SMTP server in your environment (or other email provider sich as sendgrid)
"},{"location":"boards/kubernetes/prerequisites/#ssl-certificates-and-domain-names-for-hosting","title":"SSL Certificates and domain names for hosting","text":"In the examples below, replace example.com with your actual company domain
Huddo Boards requires 2 domains (or redirects) in your network, one for the web application and one for the api. You can use a new domain or subdomain for this or you can use a path on an existing service.
For example:
Domain Path Web boards.example.com example.com/boards API api-boards.example.com example.com/api-boardsWe'll refer to these throughout installation as [BOARDS_URL] and [API_URL]
You will need a reverse proxy in place to forward network requests to the kubernetes master. This proxy should be able to resolve certificates that cover all domains used.
"},{"location":"boards/kubernetes/prerequisites/#ssh-access","title":"SSH Access","text":"To perform the installation, you need to setup some config files on a local machine that has ssh access to the servers. You should ssh to each server manually before proceeding to ensure they are trusted.
"},{"location":"boards/kubernetes/prerequisites/#authentication","title":"Authentication","text":"Huddo Boards is designed to be integrated into your current user management system. Before you are able to login you will need to configure OAuth for one (or more) of the following providers (detailed instructions here):
Provider Registration / Documentation HCL Connections (on premise) IBM Knowledge Center IBM Connections Cloud IBM Knowledge Center Microsoft Office 365 Azure app registrations Google Google Console LinkedIn LinkedIn Facebook Facebook developer centre"},{"location":"boards/kubernetes/prerequisites/#access-to-docker-images","title":"Access to Docker Images","text":"Follow this guide to get access to our images
"},{"location":"boards/kubernetes/prerequisites/#ansible","title":"Ansible","text":"We use Red Hat Ansible to script the installs. Please ensure this is installed as per our guide prior to the kubernetes / boards install
"},{"location":"boards/msgraph/","title":"Index","text":"Huddo Boards offers extensions for integrating with your Microsoft product
"},{"location":"boards/msgraph/#custom-tile","title":"Custom Tile","text":""},{"location":"boards/msgraph/#teams-integration","title":"Teams Integration","text":""},{"location":"boards/msgraph/#outlook-plugin","title":"Outlook Plugin","text":""},{"location":"boards/msgraph/overview/","title":"Overview","text":"Huddo Boards is tailored for working with Office 365 in the following ways:
"},{"location":"boards/msgraph/overview/#login","title":"Login","text":"Use your existing Microsoft credentials
"},{"location":"boards/msgraph/overview/#collaboration","title":"Collaboration","text":"Share and collaborate with individuals and groups in your office tenant
"},{"location":"boards/msgraph/overview/#easy-access","title":"Easy Access","text":"Access Boards from your Office menu, and access other Office apps from the menu in Boards
Admin setup guide
"},{"location":"boards/msgraph/overview/#onedrive","title":"OneDrive","text":"Share files and folders from Onedrive within the context of a Board
"},{"location":"boards/msgraph/overview/#teams","title":"Teams","text":"Teams integration admin guide
Add boards tabs to Microsoft Teams
See all of the boards your team is working on.
Access Huddo Boards directly from Teams as a personal app
Receive notifications as the board updates
"},{"location":"boards/msgraph/overview/#outlook","title":"Outlook","text":"You can add the Outlook add-in just for yourself (Outlook plugin user guide) Or for your whole Microsoft 365 tenant (Outlook plugin admin guide)
Save emails from Outlook as a card in your board
Attach boards, lists and cards to an email.
"},{"location":"boards/msgraph/overview/#_1","title":"Overview","text":""},{"location":"boards/msgraph/overview/#sharepoint","title":"Sharepoint","text":"Embed boards as pages in Sharepoint.
Sharepoint pages setup guide
"},{"location":"boards/msgraph/auth/","title":"Authenticating Huddo Boards with Office 365","text":"This document details the process to enable login to your private instance of Huddo Boards with your private Office 365 tenant.
"},{"location":"boards/msgraph/auth/#register-oauth-application","title":"Register OAuth Application","text":"You must configure an OAuth Application in your Office 365 Tenant in order to use Huddo Boards with O365. To access this configuration you must be logged in as a Microsoft tenant admin
"},{"location":"boards/msgraph/auth/#open-the-azure-app-portal","title":"Open the Azure App Portal","text":"Click New Registration
Enter the values below and click Register
Huddo Boards\nhttps://[BOARDS_URL]/auth/msgraph/callback\nWhere BOARDS_URL is the URL to access your main Huddo Boards page. For example:
https://connections.example.com/boards/auth/msgraph/callback ORhttps://boards.example.com/auth/msgraph/callbackClick Register
Open the Manifest section
Replace the requiredResourceAccess section as per below
\"requiredResourceAccess\": [\n {\n \"resourceAppId\": \"00000003-0000-0000-c000-000000000000\",\n \"resourceAccess\": [\n {\n \"id\": \"06da0dbc-49e2-44d2-8312-53f166ab848a\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"64a6cdd6-aab1-4aaf-94b8-3cc8405e90d0\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"863451e7-0667-486c-a5d6-d135439485f0\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"4e46008b-f24c-477d-8fff-7bb4ec7aafe0\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"7427e0e9-2fba-42fe-b0c0-848c9e6a8182\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"37f7f235-527c-4136-accd-4a02d197296e\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"ba47897c-39ec-4d83-8086-ee8256fa737d\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"14dad69e-099b-42c9-810b-d002981feec1\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"205e70e5-aba6-4c52-a976-6d2d46c48043\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"e1fe6dd8-ba31-4d61-89e7-88639da4683d\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"b340eb25-3456-403f-be2f-af7a0d370277\",\n \"type\": \"Scope\"\n },\n {\n \"id\": \"59a6b24b-4225-4393-8165-ebaec5f55d7a\",\n \"type\": \"Role\"\n },\n {\n \"id\": \"3b55498e-47ec-484f-8136-9013221c06a9\",\n \"type\": \"Role\"\n }\n ]\n }\n],\nClick Save
Open the API permissions section. Notice that all the scopes are now pre-filled.
Click Grant admin consent for kudosdev
Click Yes
Note: These steps are extracted from the official Microsoft guide: steps 5-12
Note: This step is optional, but recommended to remove the Sign in with page when accessing Huddo Boards.
At the end of this step you should have the following:
Click Expose an API
Set the Application ID URI as per:
api://<DOMAIN_HOSTING_BOARDS>/<CLIENT_ID>
where :
DOMAIN_HOSTING_BOARDS is the domain hosting boards, e.g. boards.company.com or company.comCLIENT_ID is the Application (client) ID, shown on the Overview pageFor example:
api://boards.huddo.com/5554fe8f-34b6-4694-a09d-6349e6ab6ec9
Note: this requires the domain name to be added & verified in the Azure Portal under Azure Active Directory -> Custom domain names. See read the official Microsoft documentation for more information.
Click Add a scope
Set the following values:
access_as_userAdmins and usersTeams can access the user\u2019s profile.Teams can call the app\u2019s web APIs as the current user.Teams can access your profile and make requests on your behalf.Teams can call this app\u2019s APIs with the same rights as you have.EnabledClick Save
Add the following Authorized client applications
1fec8e78-bce4-4aaf-ab1b-5451cc387264 for Teams mobile or desktop application.5e3ce6c0-2b1f-4285-8d4b-75ee78787346 for Teams web application.Open the Overview section
Copy Application (client) ID & Directory (tenant) ID
Open the Certificates & secrets section
Click New client secret
Select Never expire and click Add
Copy the secret value shown
Add OAuth and Tenant values to YAML config (ie boards.yaml or boards-cp.yaml)
global:\n env:\n MSGRAPH_CLIENT_ID: \"<your-application-id>\"\n MSGRAPH_CLIENT_SECRET: \"<your-application-secret>\"\n MSGRAPH_LOGIN_TENANT: \"<your-tenant-id>\"\nRedeploy Boards Helm Chart as per command for Huddo Boards:
HCL Component Pack
helm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections\nfor Docker - Kubernetes
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nNote: --recreate-pods is not required this time as this is only an env variable change
Open your Huddo Boards environment.
Click the Office 365 option and login with a Tenant Administrator account
Once logged in, a prompt will appear in Huddo Boards. Click Approve
Click Accept on the following popup to grant the required permissions for Huddo Boards
Congratulations! All users in your tenant can now login to Huddo Boards via Office 365!
Follow these steps by Microsoft which we have also outlined below.
Open 365 Admin Centre
Click Settings -> Org Settings -> Organization Profile
Click Custom app laucher tiles
Click Add a custom tile
Enter the following details & click Save
Huddo Boards\nhttps://boards.huddo.com/auth/msgraph\nhttps://boards.huddo.com/img/logo-small.png\nSocial collaboration\nHuddo Boards will now appear in the list. Click Close
Go to https://www.office.com
Open the Apps menu and click All apps
Huddo Boards should be shown in the list.
Users can now pin this to their menu. This may take 10 minutes to appear
To get the most out of Huddo Boards in your Office 365 tenant, there are a few steps to take to make the experience seamless for your users.
The Steps on this page (other than just logging in) require that you are an admin in your Office 365 tenant. If you are not an admin, please refer this page to your Administrator, Manager or IT department.
"},{"location":"boards/msgraph/getting-started/#login","title":"Login","text":"Huddo Boards uses OAuth for login and user access. This means your users can just click the Office 365 logo at boards.huddo.com and use their existing Microsoft credentials.
If you would like to link to Huddo Boards from another site, you can use https://boards.huddo.com/auth/msgraph which will skip the list of login options.
"},{"location":"boards/msgraph/getting-started/#admin-approval","title":"Admin Approval","text":"Microsofts API requires that you grant admin access to Huddo Boards before your users are able to search for groups, to enable this log into Huddo Boards and you should be prompted to grant admin approval.
After clicking Approve, you may be asked to login to Office 365 again, then you will be prompted to approve Huddo Boards access on behalf of your organisation.
Note: you can revoke this approval at any stage via the Office 365 admin app.
The requested permissions are:
Permission Use in Huddo Boards Maintain access to data you have given it access to Allows us to remember who you are logged in as, so you don't have to login every time you use Huddo Boards Sign in and read user profile Allows login to Huddo Boards Read all users' basic profiles Allows us to get names and profile pictures of others in your tenant Read directory data As Above Read users' relevant people lists As Above Read and write all groups Allows us to search for groups you are a member of. Write access is only used to add Huddo Boards bot to a Group in Microsoft Teams Have full access to all files user can access Allows us to link to your OneDrive files Read items in all site collections Allows us to link to OneDrive files owned by your Groups or TeamsYou can also go to Your Admin Page to approve the above.
"},{"location":"boards/msgraph/getting-started/#start-a-free-trial","title":"Start a free trial","text":"After logging in, you will also be prompted to start a free (30 day) trial. Enabling this will allow other users in your Office 365 tenant to login and use Huddo Boards.
You may also go to Your Admin Page to Start Your free trial, get a Quote or Purchase licences online.
"},{"location":"boards/msgraph/getting-started/#enable-integrations-between-huddo-boards-and-office-365","title":"Enable Integrations between Huddo Boards and Office 365","text":"These guides also require admin access and enable some advanced features of Huddo Boards in your Office 365 environment.
These are also in the side menu of this page
Note
Desktop Outlook requires the Microsoft Edge WebView2 Runtime.
Open 365 Admin Centre
Click Settings -> Integrated apps -> Upload custom apps
Select Provide link to manifest file
https://boards.huddo.com/office/outlook/add-in.xml\nClick Validate then click Next
Specify who has access and click Next
Finish DeploymentClick Done
Open Outlook
You should now see the Huddo Boards option in the menu of an email
The instructions on this page use 'The new Outlook' however you can also add and use this plugin from 'classic Outlook' or Outlook desktop.
Microsoft 365 admins can add this for all users in their tenant, instructions here
Open Outlook and click New Message
Click the ... menu -> Get Add-ins
Click My Add-ins then Add a custom add-in -> Add from URL
Provide the url: https://boards.huddo.com/office/outlook/add-in.xml and click OK.
Click Install then close the add-in dialogue.
Verify the add-in is installed by clicking the ... menu again.
You will now be able to:
Save emails from Outlook as a card in your board
Attach boards, lists and cards to an email.
Before proceeding, you will need a site admin to enable security settings as described here
From Sharepoint main menu, go to Pages -> New -> Site Page
Give your page a name, then click the +
Choose Embed from the drop down menu
Open Huddo Boards and select the board you wish to embed in the sharepoint page. Click the Board Options button
Click Copy embed code
Go back to sharepoint and paste the code you copied in the box provided
Tip
If you don't see the input box above, you can get it back by clicking the embed you added previously and clicking it's edit button.
To make a small amount of extra room on your page, you may wish to edit the title and choose Plain as it's layout.
Once you are happy with the page, click 'Publish' to make it visible to other members of your site.
Promote your new page by following the recommendations
Embedding Huddo Boards in sharepoint requires iframe permissions for users, it is common (default) for the permitted domains to be limited, if this is the case, you can add Huddo Boards to the restricted list as below.
Admin access is required for these steps
Site SettingsOR choose Site information then View all site settings
HTML Field SecurityAddOKHuddo Boards is available freely in the Microsoft Teams App Store to add as either a personal app or to a team.
"},{"location":"boards/msgraph/teams/#add-to-a-team","title":"Add to a Team","text":"You can add Huddo Boards to MS Teams in two ways. Follow these steps to Huddo Boards as a tab in a Team Channel.
Open the Teams App and go to the team you wish to add Huddo Boards to.
Click the + (add a tab) button
Search for huddo to find Huddo Boards
Note that if Huddo Boards cannot be found, it has not yet been added before in your organisation and needs to be added by finding it within the Teams App Store. Click More Apps in this case:
Again, search for huddo to find the Huddo Boards App in the entire store.
Once you have located and clicked on the Huddo Boards App, click the Add button to add it to the team:
The Huddo Boards app will now be added to the team, and you will be given the ability to add a new tab:
more added apps area.","text":"To add Huddo Boards as a personal app follow these steps:
Open Teams and click the Apps button. Type huddo to find the Huddo Boards app:
Click Huddo Boards then click Add to add it as a personal app:
This bot will be used to post notification to Microsoft Teams triggered by actions performed in Huddo Boards.
Note: this step is optional and cannot be achieved if you do not meet the prerequisites.
"},{"location":"boards/msgraph/teams/notification-bot/#prerequisites","title":"Prerequisites","text":"Note: Microsoft Teams notifications requires 2-way web communication.
For example, the following URL must be accessible by Microsoft's servers: https://[BOARDS_URL]/webhook/teams
Open Bot Registration and sign-in with a Microsoft Tenant admin
Enter the following values
Huddo Boards\nhuddoboards\nhttps://[BOARDS_URL]/webhook/teams\n[MSGRAPH_CLIENT_ID]\nWhere:
[BOARDS_URL] is the URL to your Huddo Boards installation
i.e. https://connections.example.com/boards/webhook/teams or https://boards.company.example.com/webhook/teams
[MSGRAPH_CLIENT_ID] is the OAuth Client ID from Auth setup
For example:
Huddo Boards\nhuddoboards\nhttps://connections.example.com/boards/webhook/teams\nb0e1e4a3-3df0-4c0a-8a2a-c1d630bb52b8\nScroll down, read/agree to the terms and click Register
Click the Teams icon
Click Save
The bot setup is complete
See Installing the Huddo Boards Teams App
"},{"location":"boards/msgraph/teams/on-prem/","title":"Huddo Boards On-Premise in Microsoft Teams","text":""},{"location":"boards/msgraph/teams/on-prem/#prerequisites","title":"Prerequisites","text":"Office 365 Tenant admin account.
Office 365 OAuth client. See instructions
Notification bot (optional). See instructions
Note: notifications are optional as the bot cannot be configured for internal Huddo Boards deployments
Login to Huddo Boards with your Microsoft Tenant Admin account
Click the Configuration icon and then Manage Org
Click on your Organisation
Click on your Microsoft client
Click the download button for your configuration
App with Notifications (if you can and have enabled the notification bot)
App for Internal Boards Deployment (if you do not want notifications)
Open the Teams App
Click Apps -> Upload a custom app -> Upload for [COMPANY_NAME]
where [COMPANY_NAME] is the name of your company
Upload the Zip file you downloaded above
The Huddo Boards app will now appear under the section Built for [COMPANY_NAME]
Open Team Apps in your web browser
Click on Built for [COMPANY_NAME] => Huddo Boards
Click Add
Huddo Boards personal will now open
Copy the App ID from the URL. We will use this shortly.
Open the Boards Helm Chart config used for deployment
Add the following environment variable to provider (uncomment or add the section as required):
provider:\n env:\n MSGRAPH_TEAMS_APP_ID: \"<your_app_id>\"\nRedeploy Boards helm chart as per command for Huddo Boards:
HCL Component Pack
helm upgrade huddo-boards-cp https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-1.2.0.tgz -i -f ./boards-cp.yaml --namespace connections\nfor Docker - Kubernetes
helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\nNote: --recreate-pods is not required this time as this is only an env variable change
For a full guide on using Huddo Boards in Microsoft Teams, please see our documentation.
"},{"location":"boards/swarm/","title":"Boards for Docker Swarm (DEPRECATED)","text":"Warning
These instructions are deprecated. Please see standalone guide if you do not have either Kubernetes or Component Pack
Basic instructions for deploying Huddo Boards into Docker Swarm for on-premise IBM Connections environments
"},{"location":"boards/swarm/#prerequisites","title":"Prerequisites","text":"Dockerhub account with access to Huddo Boards repository.
Send your account details to support@huddo.com if you don't already have this.
SSL certificate - You will need to use a certificate that covers at least the 2 domains you plan to use, for example Huddo Boards cloud uses the domains https://boards.huddo.com and https://api.boards.huddo.com. The certificate should be pem encoded with a separate key file.
Huddo Boards currently supports the following oAuth providers for authentication and integration: HCL Connections (on premise), IBM Connections Cloud and Microsoft Office 365.
You will need to setup an OAuth application with one (or more) of these providers for Huddo Boards to function. please refer to the following documentation:
Provider Registration / Documentation Callback URL IBM Connections (on premise) Huddo instructionshttps://[BOARDS_URL]/auth/connections/callback Microsoft Office 365 Azure app registrations https://[BOARDS_URL]/auth/msgraph/callback Google Google Console https://[BOARDS_URL]/auth/google/callback LinkedIn LinkedIn https://[BOARDS_URL]/auth/linkedin/callback Facebook Facebook developer centre https://[BOARDS_URL]/auth/facebook/callback"},{"location":"boards/swarm/#update-config-file","title":"Update config file","text":"Swarm Variables:
Key Descriptionx-minio-access Minio ACCESS_KEY as defined in your docker swarm config x-minio-secret Minio SECRET_KEY as defined in your docker swarm config x-app-env.APP_URI https://[BOARDS_URL] services.webfront.deploy.labels Update the traefik.frontend.rule your [BOARDS_URL] (no protocol) services.core.deploy.labels Update the traefik.frontend.rule with your [API_URL] (no protocol) Boards Variables:
Follow instructions on this page
"},{"location":"boards/swarm/#deploy","title":"Deploy","text":"Update DNS records with a CNAME entry pointing to your swarm URL.
For example:
boards.huddo.com -> swarm.isw.net.au\nboards.api.huddo.com -> swarm.isw.net.au\nPlease follow these instructions
You can also run Huddo Boards with externally hosted mongo database and/or S3 storage. For assistance with this contact support@huddo.com
"},{"location":"boards/swarm/#updates","title":"Updates","text":"The Boards services can be updated through the Portainer interface, or alternatively these commands should force latest images to run
docker service update --force --image redis:latest boards/redis\ndocker service update --force --image iswkudos/kudos-boards-docker:webfront boards/webfront\ndocker service update --force --image iswkudos/kudos-boards-docker:core boards/core\ndocker service update --force --image iswkudos/kudos-boards-docker:boards boards/app\ndocker service update --force --image iswkudos/kudos-boards-docker:user boards/user\ndocker service update --force --image iswkudos/kudos-boards-docker:licence boards/licence\ndocker service update --force --image iswkudos/kudos-boards-docker:provider boards/provider\ndocker service update --force --image iswkudos/kudos-boards-docker:notification boards/notification\nIf you must update the Portainer/Traefik images, try these commands:
docker service update --force --image portainer/portainer:latest portainer/portainer\ndocker service update --force --image portainer/agent:latest portainer/agent\ndocker service update --force --image traefik:alpine proxy/proxy\nWarning
These instructions are deprecated. Please see standalone guide if you do not have either Kubernetes or Component Pack
"},{"location":"boards/swarm/prerequisites/#servers","title":"Servers","text":"This solution is designed to be a lightweight, cloud-like setup running locally in your data centre. You should expect to configure a minimum of 4 very small servers, see Swarm Installation for a table showing the requirements.
"},{"location":"boards/swarm/prerequisites/#existing-infrastructure","title":"Existing Infrastructure","text":"Huddo Boards for Docker Swarm is able to take advantage of existing services in your network, if you have any of the following and would like to take advantage of them, please ensure you have all relevant access documented.
Service Requirements MongoDB URL, username and password S3 Storage URL, Bucket name, username and password NFS Server IP address or hostname, must be accessible to all swarm servers SNI Capable reverse proxy admin access to proxy to configure all domains (see SSL Certificate below)"},{"location":"boards/swarm/prerequisites/#stmp-for-email-notifications","title":"STMP for email notifications","text":"If you would like to send emails, Huddo Boards docker requires details of a forwarding SMTP server in your environment (or other email provider sich as sendgrid)
"},{"location":"boards/swarm/prerequisites/#ssl-certificates-dns","title":"SSL Certificates / DNS","text":"You will need to have certificates and DNS entries that cover the following domains:
Replace example.com with your actual company domain
To perform the installation, you need to setup some config files on a local machine that has ssh access to the servers. You should ssh to each server manually before proceeding to ensure they are trusted.
"},{"location":"boards/swarm/prerequisites/#authentication","title":"Authentication","text":"Huddo Boards is designed to be integrated into your current user management system. Before you are able to login you will need to configure OAuth for one (or more) of the following providers (detailed instructions here):
Provider Registration / Documentation IBM Connections (on premise) IBM Knowledge Center IBM Connections Cloud IBM Knowledge Center Microsoft Office 365 Azure app registrations Google Google Console LinkedIn LinkedIn Facebook Facebook developer centre"},{"location":"boards/swarm/prerequisites/#dockerhub-deprecated","title":"Dockerhub (Deprecated)","text":"Access to the images for Boards is provided through dockerhub. Please provide us with your username to grant access and have the credentials at hand for the install.
"},{"location":"boards/swarm/prerequisites/#ansible","title":"Ansible","text":"We use Red Hat Ansible to script the installs. Please ensure this is installed as per our guide prior to the swarm / boards install
"},{"location":"boards/troubleshooting/activities-plus-install/","title":"Activities Plus Install FAQ","text":"If you are following the HCL install documentation, these notes need to be applied during the relevant sections. We recommend using our install documentation instead.
There are also some more notes and insights from one of our partners which is a great read.
"},{"location":"boards/troubleshooting/activities-plus-install/#installing-activities-plus-services","title":"Installing Activities Plus services","text":"If you do not have them enabled, you will need to enable the following modules by uncommenting them (remove the '#'):
LoadModule proxy_module modules/mod_proxy.so\nLoadModule proxy_connect_module modules/mod_proxy_connect.so\nLoadModule proxy_ftp_module modules/mod_proxy_ftp.so\nLoadModule proxy_http_module modules/mod_proxy_http.so\n\nLoadModule rewrite_module modules/mod_rewrite.so\nIf you have not specified earlier (such as during other component-pack app installs), please set ProxyPreserveHost On before the Huddo Boards section in the VirtualHost
The helm upgrade command needs to be run from the directory containing boards-cp.yaml and the correct command is:
helm upgrade kudos-boards-cp-activity-migration path_to_helm_charts/kudos-boards-cp-activity-migration-1.0.0-20191120-214007.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\ne.g.
helm upgrade kudos-boards-cp-activity-migration /root/microservices_connections/hybridcloud/helmbuilds/kudos-boards-cp-activity-migration-1.0.0-20191120-214007.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods\nWhen (re)deploying the Boards CP Chart you may see this warning:
W0612 09:17:16.153629 21276 warnings.go:70] spec.template.spec.containers[0].env[2].name: duplicate name \"MONGO_HOST\"\nThis is an expected behaviour. Connections 8 added a new hostname for Mongo v5. Our v1.1.0 helm chart uses this in addition to the old hostname to maintain backwards compatibility. This warning can be safely ignored.
"},{"location":"boards/troubleshooting/activity-migration/","title":"Activity Migration","text":""},{"location":"boards/troubleshooting/activity-migration/#pod-will-not-start-port-in-use","title":"Pod will not start - Port in use","text":"Sometimes the pod fails to start with an error listen EACCES: permission denied. For example:
checkActitiviesFileStore: found valid content store\ncheckOrg: Found 1 OrgId: [ 'a' ]\ncheckTenant: Found 1 Tenant: [ '00000000-0000-0000-0000-040508202233' ]\nPlease open the UI at 'https://company.example.com/boards/admin/migration' or set env.IMMEDIATELY_PROCESS_ALL='true' to migrate all of your Activities without UI\nevents.js:377\nthrow er; // Unhandled 'error' event\n^\nError: listen EACCES: permission denied tcp://10.100.200.104:2641\nat Server.setupListenHandle [as _listen2] (net.js:1314:21)\nat listenInCluster (net.js:1379:12)\nat Server.listen (net.js:1476:5)\nat listen (/usr/src/app/dist/index.js:62:10)\nat /usr/src/app/dist/index.js:106:3\nat processTicksAndRejections (internal/process/task_queues.js:95:5)\nEmitted 'error' event on Server instance at:\nat emitErrorNT (net.js:1358:8)\nat processTicksAndRejections (internal/process/task_queues.js:82:21) {\ncode: 'EACCES',\nerrno: -13,\nsyscall: 'listen',\naddress: 'tcp://10.240.27.7:2641',\nport: -1\n}\nerror Command failed with exit code 1.\ninfo Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.\nThis is because the port is already in use. We must change the default port which
"},{"location":"boards/troubleshooting/activity-migration/#resolution","title":"Resolution","text":"Open your Boards yaml file
Set the new port as per below (merging into existing)
global:\n env:\n ACTIVITY_MIGRATION_PORT: '2651'\n\nmigration:\n balancer:\n port: 2651\n targetPort: 2651\nRedeploy both the Boards helm chart and the Activity Migration charts with the updated yaml
Confirm the pod start successfully or change to another random higher port if conflicts still occur.
This process will find and fix cards with long descriptions which were not imported correctly due to an incorrect HTTP 404 response from the HCL Connections API
Note: this requires Boards images with date tags on or after 2021-03-22
"},{"location":"boards/troubleshooting/activity-migration/#process-overview","title":"Process Overview","text":"This service will:
/downloadExtended/ in the URL)Note: any changes made to the description (rich text area) by users since the migration will be over-written by the loaded content. If there are any cards which you want to keep the existing, simply delete the link to \"Long Description\" before running this process.
"},{"location":"boards/troubleshooting/activity-migration/#steps","title":"Steps","text":"Add the volume, volume mount & FILE_PATH_ACTIVITIES_CONTENT_STORE to the boards yaml config. For example:
migration:\n # configure access to the Connections Shared mount\n sharedDrive:\n # Replace with IP address for the NFS server\n server: 192.168.10.56\n # for example \"/opt/HCL/Connections/data/shared\" or \"/nfs/data/shared\"\n path: /nfs/data/shared\n env:\n # the extension after /data can be found from the WebSphere ACTIVITIES_CONTENT_DIR variable\n FILE_PATH_ACTIVITIES_CONTENT_STORE: /data/activities/content\nReplace the sharedDrive.server IP and the sharedDrive.path to the shared drive (e.g. /nfs/data/shared or /opt/HCL/data/shared etc)
When migrating very large activities sometimes you may encounter an OutOfMemory error.
"},{"location":"boards/troubleshooting/activity-migration/#resolution_1","title":"Resolution","text":"In the migration YAML chart you can set following to reduce the amount of concurrent data accessed in memory:
migration.env.PROCESSING_PAGE_SIZE: 1\nmigration.env.FIELDS_PAGE_SIZE: 1\nOnce these values are set you need to deploy the chart again to make them take effect.
You will also need to increase the amount of memory available to NodeJS by adding the environment variables in the migration YAML:
resources.requests.memory: 2024M\nresources.limits.memory: 8192M\nenv.NODE_OPTIONS: \"--max-old-space-size=8192\"\nIf the migration service crashes while migrating an activity some activiites can be in a 'stuck' state where they cannot be tasked to be migrated again. In the migration YAML chart you can set PURGE_INCOMPLETE to remove the flags.
migration.env.PURGE_INCOMPLETE: \"true\"\nYou are also able to delete already migrated activities by setting PURGE_MIGRATED_ACTIVITY_IDS so they can be migrated again.
migration.env.PURGE_MIGRATED_ACTIVITY_IDS: \"acitivityId,activityId2,activityId3,...,activityIdN\"\nOnce these values are set you need to deploy the chart again to make them take effect. Please be aware to remove the \"PURGE_MIGRATED_ACTIVITY_IDS\" after it is done or any subsequent deployments/restarts will delete them again!
"},{"location":"boards/troubleshooting/aplus-auth/","title":"Aplus auth","text":""},{"location":"boards/troubleshooting/aplus-auth/#testing-an-oauth2-connections-configuration","title":"Testing an oauth2 connections configuration","text":"The steps below will test a Huddo Boards / Activities Plus oauth setup.
We will prepare a request in an api testing tool, then get a response code from connections and finally use that code in the prepared response to get an auth token. It is important to do in this order as the code is only valid for a minute.
"},{"location":"boards/troubleshooting/aplus-auth/#block-requests-to-boards","title":"Block requests to boards","text":"Update WAS httpd.conf
change ProxyPass and ProxyPassReverse entries for /boards to use a different (invalid) port number.
Method: POST
Request URL: https://(connections url)/oauth2/endpoint/connectionsProvider/token
On the Body tab, select x-www-form-urlencoded and fill in the following:
replace connections url in both places below
https://(connections url)/oauth2/endpoint/connectionsProvider/authorize?client_id=huddoboards&redirect_uri=https%3A%2F%2F(connections url)%2Fapi-boards%2Fauth%2Fconnections%2Fcallback&response_type=code&state=1234\nThe loaded page should error, that is expected.
"},{"location":"boards/troubleshooting/aplus-auth/#copy-code-from-redirected-url","title":"Copy code from redirected url","text":""},{"location":"boards/troubleshooting/aplus-auth/#paste-the-code-into-postman-and-hit-send-you-should-get-a-response-as-below","title":"Paste the code into postman and hit Send, you should get a response as below:","text":"{\n \"access_token\": \"s67MkH8LYMMKiP0q2gtVKQxkD0gBcXJJlSCdvQw3\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 43199,\n \"scope\": \"\",\n \"refresh_token\": \"EcO9hDYdU3tL2BE0xRSPNlYIGvZhYV9yezb14YKNglkFPwq4St\"\n}\nOpen a new tab in postman and update:
Method: GET
Request URL: https://(connections url)/connections/opensocial/oauth/rest/people/@me/@self
Authorization Tab
TYPE: Bearer Token
Token: (Paste in the access_token from the previous request)
Hit Send, You should get a json response describing your profile.
"},{"location":"boards/troubleshooting/aplus-auth/#reset-was-httpdconf","title":"Reset WAS httpd.conf","text":"Make sure to put the port numbers back to their original values.
"},{"location":"boards/troubleshooting/conn-hybrid/","title":"Huddo Boards Hybrid","text":""},{"location":"boards/troubleshooting/conn-hybrid/#authentication","title":"Authentication","text":""},{"location":"boards/troubleshooting/conn-hybrid/#logging-in-doesnt-work","title":"Logging-in doesn't work","text":"Please revoke your OAuth access to Huddo Boards Cloud within HCL Connections. Go to https://<YOUR_CONNECTIONS_URL>/connections/oauth/apps (replacing <YOUR_CONNECTIONS_URL>) and press 'Revoke'
Please revoke your OAuth access to Huddo Boards Cloud within HCL Connections. Go to https://<YOUR_CONNECTIONS_URL>/connections/oauth/apps (replacing <YOUR_CONNECTIONS_URL>) and press 'Revoke'
To check the version of the ingress controller run this command
kubectl get pods --all-namespaces | grep ingress-controller\nkubectl exec -it <POD_NAME> -n <NAMESPACE> -- /nginx-ingress-controller --version\nwhere
<POD_NAME> is the name of the Ingress controller pod<NAMESPACE> is the namespace of the Ingress controller pod. e.g. kube-system or connectionsFor example
kubectl get pods --all-namespaces | grep ingress\nkubectl exec -it nginx-ingress-controller-84d4dfc9b-7gv4m -n kube-system -- /nginx-ingress-controller --version\nExample
-------------------------------------------------------------------------------\nNGINX Ingress controller\n Release: 0.23.0\n Build: git-be1329b22\n Repository: https://github.com/kubernetes/ingress-nginx\n-------------------------------------------------------------------------------\nAs of 0.22.0 the Ingress controller rewrite-target definition changed. If Boards is installed at a context root, the format must include a regular expression which is now set as the default as of the helm chart v2.0.1. We recommend using the latest huddo-boards-cp-1.2.0.tgz which includes all required annotations (including socket.io cookie fix).
If you have an older Ingress controller version (i.e. 0.20) you will need to apply the following customisations to fix the ingress with charts as of v2.0.1
webfront:\n ingress:\n path: /boards\n annotations:\n nginx.ingress.kubernetes.io/rewrite-target: /\n\ncore:\n ingress:\n path: /api-boards\n annotations:\n nginx.ingress.kubernetes.io/rewrite-target: /\n nginx.ingress.kubernetes.io/session-cookie-path: /api-boards; Secure\n nginx.ingress.kubernetes.io/affinity: cookie\n nginx.ingress.kubernetes.io/proxy-body-size: 50m\n nginx.ingress.kubernetes.io/proxy-read-timeout: \"3600\"\n nginx.ingress.kubernetes.io/proxy-send-timeout: \"3600\"\nIf you wish to deploy boards at a path other than /boards & /api-boards please see this example file of all the variables to merge into your YAML config file.
Note: If you are using an older version of the Ingress controller (< 0.22) you will need to use example above
Note: please see this example again if you encounter the error
Ignoring ingress because of error while validating ingress class\" ingress=\"connections/kudos-boards-cp-webfront\" error=\"ingress does not contain a valid IngressClass\"\nSome deployments may encounter an issue where you are unable to see any real time updates. If this is the case, it is likely that the socket is unable to connect or authenticate. Please update to the latest Boards helm chart which includes annotations for increased browser cookie security requirements.
Note: if you have a core.annotations section in your yaml configuration our updates will be overwritten. Custom annotations should only be required when customizing the context root as per above. Please remove the annotations section otherwise.
If you are using WebSphere IHS as your reverse proxy in front of Boards, please set the following environment variables to force polling instead of sockets
webfront:\n env:\n FORCE_POLLING: true\nIf the Minio service fails to start with the following error:
ERROR Unable to initialize backend: found backend fs, expected xl\nPlease update to kudos-boards-cp-3.1.4.tgz which includes a different image of Minio which supports your existing 'fs' file system.
"},{"location":"boards/troubleshooting/docker/#react-minified-issue","title":"React Minified Issue","text":"This has been successfully fixed in all reported cases by clearing the local storage of the user's browser. There is also a change to handle this better in this release
"},{"location":"boards/troubleshooting/docker/#itm-render-issue","title":"ITM Render Issue","text":"Connections 8 CR1/2 changes how the ITM bar is displayed. This causes an issue in Boards where is loads to the left and not the right.
You can add this to your custom css in the header/customiser (which is then injected into Boards).
.gt-sm.cnx8-ui.itm-bar-open .itm-section {\n position: absolute;\n right: 0;\n}\nYou may need to connect to Mongo for validation or other changes. To connect to Kubernetes Mongo:
In Component Pack
kubectl exec -it mongo-0 -c mongo -n connections -- mongo --ssl --sslPEMKeyFile /etc/mongodb/x509/user_admin.pem --sslCAFile /etc/mongodb/x509/mongo-CA-cert.crt --host mongo-0.mongo.connections.svc.cluster.local --authenticationMechanism=MONGODB-X509 --authenticationDatabase '$external' -u C=IE,ST=Ireland,L=Dublin,O=IBM,OU=Connections-Middleware-Clients,CN=admin,emailAddress=admin@mongodb\n\n# CP Mongo5\nkubectl exec -it mongo5-0 -c mongo5 -n connections -- mongosh --tls --tlsCertificateKeyFile /etc/ca/user_admin.pem --tlsCAFile /etc/ca/internal-ca-chain.cert.pem --host mongo5-0.mongo5.connections.svc.cluster.local --authenticationMechanism=MONGODB-X509 --authenticationDatabase '$external' -u C=IE,ST=Ireland,L=Dublin,O=IBM,OU=Connections-Middleware-Clients,CN=admin,emailAddress=admin@mongodb\nStandalone deployment
get the name of the mongo pod
kubectl get pods --all-namespaces\n\nNAMESPACE \u00a0 \u00a0 NAME \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 READY \u00a0 STATUS \u00a0 \u00a0RESTARTS \u00a0 AGE\nboards \u00a0 \u00a0 \u00a0 \u00a0mongo-67696548c-xpdqh \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a01/1 \u00a0 \u00a0 Running \u00a0 0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a035s\nexec into the pod using the mongosh (or mongo) command - replacing pod name and namespace
kubectl exec -it mongo-67696548c-xpdqh -n boards -- mongosh --host mongo-service:27017\ncheck the database names
show dbs\nopen the db containing board nodes (select as appropriate)
# CP\nuse boards-app\n\n# Standalone\nuse kudos-boards-service\nfind all boards
db.nodes.find({ type: 'board' })\nfind a board from a particular activitity
db.nodes.find({ providerID: 'activities-id-goes-here' })\nfind the members for a particular board
db.boardmembers.find({ board: ObjectId(\"_id-of-board-found-above\") })\nopen the db containing users (select as appropriate)
# CP\nuse boards-user\n\n# Standalone\nuse kudos-user-service\nfind the users in question, e.g Andrew & Nicky
db.users.find({ name: \"Andrew Welch\" })\n{ \"_id\" : ObjectId(\"617891eae72f26802c4bec5e\"), \"email\" : \"awelch@isw.net.au\", ....\n\ndb.users.find({ name: \"Nicky Tope\" })\n{ \"_id\" : ObjectId(\"617891ed660876da990253b7\"), \"email\": \"ntope@isw.net.au\", .....\nswitch to the boards app
find the members for a particular board (substitute the ID)
db.boardmembers.find({ board: ObjectId(\"<BOARD_ID>\") })\nreplace user A with user B, e.g. Andrew with Nicky
db.boardmembers.updateOne({ board: ObjectId(\"<BOARD_ID>\"), 'entity.kind': 'User', 'entity.id': '617891eae72f26802c4bec5e' }, { $set: { 'entity.id': '617891ed660876da990253b7' }})\nNginx has strict rules around the headers allowed on requests. If you encounter a 400 Bad Request response in your environment when accessing /boards it is likely caused by incorrect headers set in the upsteam proxy(s) before Boards.
To debug the cause, please views the logs for the webfront pods (as of build 20210924). You will see logs like:
setting core: https://devconn7.internal.isw.net.au/api-boards\n setting buildId: 198\n setting product info url: https://huddo.com/boards\n setting force polling: true\n setting html base: /boards\n 2021/09/24 01:10:49 [notice] 1#1: using the \"epoll\" event method\n 2021/09/24 01:10:49 [notice] 1#1: nginx/1.21.3\n 2021/09/24 01:10:49 [notice] 1#1: built by gcc 10.3.1 20210424 (Alpine 10.3.1_git20210424)\n 2021/09/24 01:10:49 [notice] 1#1: OS: Linux 3.10.0-1160.15.2.el7.x86_64\n 2021/09/24 01:10:49 [notice] 1#1: getrlimit(RLIMIT_NOFILE): 1048576:1048576\n 2021/09/24 01:10:49 [notice] 1#1: start worker processes\n 2021/09/24 01:10:49 [notice] 1#1: start worker process 20\n 2021/09/24 01:10:49 [notice] 1#1: start worker process 21\n 2021/09/24 01:10:49 [notice] 1#1: start worker process 22\n 2021/09/24 01:10:49 [notice] 1#1: start worker process 23\n 2021/09/24 01:15:37 [info] 20#20: *1 client 10.244.115.83 closed keepalive connection\n 2021/09/24 01:15:38 [info] 31#31: *118 client sent invalid host header while reading client request headers, client: 172.20.0.1, server: boards.company.com, request: \"GET / HTTP/1.1\", host: \"boards.company.com, boards.company.com\"\nIn this example, the client sent invalid host header while reading client request headers. You can see the host is included twice. This can occur if the host is set twice, or in some instances when the X-Forwarded-Host is also set.
Please read this error carefully and make sure your environment complies with the latest NGINX specification.
"},{"location":"boards/troubleshooting/notifications/","title":"Troubleshooting Huddo Boards Notifications","text":""},{"location":"boards/troubleshooting/notifications/#huddo-boards-docker","title":"Huddo Boards Docker","text":"If notifications are not sending, please ensure that the core and notifications pod can talk to each other
kubectl exec -n connections -it (boards core pod) -- sh\nenv | grep NOTIFI\nvi src/test.js (content below)\nnode src/test.js\nContent for test.js:
const fetch = require('node-fetch');\nfetch(process.env.NOTIFICATION_HOST+':'+process.env.NOTIFICATION_PORT+'/health').then(console.log).catch(console.log);\nIf 200 status:
bash kubectl delete pod -n boards (core pod1) kubectl delete pod -n boards (core pod2)
If a user is unable to login to Huddo, especially after it working previously and they get an Error 500 there may be too many tokens in the OAuth table in Connections for them. To resolve this, check if this is the case by shorting the oh2p_cache table for 250 entries for the user.
SELECT count(lookupkey) FROM homepage.oh2p_cache WHERE username ='<username>' AND clientid='<huddo_client_id>'\nClearing the oh2p cache allows the user to login again.
DELETE from homepage.oh2p_cache where username='<username>' and clientid='<huddo_client_id>'\nPlease Note: You need to replace <username> and <huddo_client_id> with the correct values
For more details, please see a blog post here.
"},{"location":"boards/troubleshooting/safari/","title":"Safari","text":""},{"location":"boards/troubleshooting/safari/#hcl-connections-community-widget","title":"HCL Connections Community Widget","text":"There is a limitation imposed by Apple which stops the Huddo Boards Community Widget from getting users cookies and therefore is stopping Authentication between Huddo Boards Cloud and HCL Connections.
The only solution is to disable the \"Prevent cross-site tracking\" option on the user's computer under Safari => Preferences => Privacy.
"},{"location":"boards/troubleshooting/websphere/","title":"Boards for HCL Connections in WebSphere (Legacy)","text":"Issue Resolution JMS Topic not initialised Please check that the cluster Huddo Boards is installed on has the messaging bus/engine set. Cannot enter Activity Stream Credentials Please ensure that the user that you are entering can log into Connections and view the homepage activity stream. Unable to Retrieve Members This error can appear if you are logged into more than one environment at the same time, such as a TEST and PROD server. Please open the environment that Huddo Boards is installed into in a clean browser without any existing cookies or sessions. This can be easily achieved by using incognito/private mode.All membership functionality is provided by the IBM SBT so please ensure this is setup correctly, as well as making sure the Activities application is started."},{"location":"boards/troubleshooting/office365/","title":"Boards in Microsoft Office 365 for Business","text":""},{"location":"boards/troubleshooting/office365/#microsoft-teams","title":"Microsoft Teams","text":""},{"location":"boards/troubleshooting/office365/#administrator-approval-required-to-add-huddo-boards-as-a-teams-tab","title":"Administrator approval required to add Huddo Boards as a Teams Tab","text":"You may find that as a non-administrator Office 365 user, you cannot add Huddo Boards as a Teams Tab. In this case, after signing in to Huddo Boards in the tab configuration dialog view, the view will look like the screenshot below and all actions will be disabled.
Note that Huddo Boards can still be used as a Microsoft Teams personal app whilst in this state
"},{"location":"boards/troubleshooting/office365/#resolution","title":"Resolution","text":"A user that has administrative capabilities within your Microsoft Office 365 organisation will need to sign in to Huddo Boards (either inside the Microsoft Teams configuration view or by going directly to boards.huddo.com). They will then be presented with the following prompt:
After clicking Approve, the administrator will be directed to an approval screen that will allow them to accept all of the required permissions that Huddo Boards requires, on behalf of the entire organisation:
Once these permissions have been accepted on behalf of the organisation, all users in the organisation will now be able to add Huddo Boards as a Microsoft Teams Tab.
"},{"location":"boards/troubleshooting/office365/#force-administrative-approval-for-organisation","title":"Force Administrative Approval for Organisation","text":"Administrative users for your Office 365 organisation can also force an approval of all permissions for the organisation from within the Org Administration screen by following these steps:
Access the Configuration Page and click through your Office 365 client under 'Authentication Clients'.
Click the Approve Advanced Features button:
This will direct you to the Microsoft Office 365 Permissions requested - Accept for your organisation page, allowing you to force the consent of all permissions that Huddo Boards needs for your organisation:
"},{"location":"boards/troubleshooting/office365/#huddo-boards-app-not-showing-in-teams-store","title":"Huddo Boards App not showing in Teams store","text":"If you search for Huddo Boards but you cannot see it in the Teams Store, it is likely that third-party apps are blocked in your tenant.
"},{"location":"boards/troubleshooting/office365/#resolution_1","title":"Resolution","text":"You will need to go to the Admin Dashboard to view the settings.
Under 'Third-party apps' you can see the settings for your tenant. Here you can set your users to be able to access Huddo Boards through the Teams Store.
"},{"location":"boards/verse/verse-extension/","title":"HCL Verse","text":""},{"location":"boards/verse/verse-extension/#installation-in-verse-on-premise","title":"Installation in Verse On Premise","text":"verse/application.json file.verse/application.json as plain text to confirm the \"url\" fields contain the URL for your Boards deployment.This documentation has been copied in below.
"},{"location":"boards/verse/verse-extension/#deploying-extensions-using-the-built-in-endpoint","title":"Deploying extensions using the built-in endpoint","text":"Verse On-Premises implemented a built-in endpoint to serve the application\u2019s JSON data from a local file or an HTTP hosted file. If storing the applications JSON data as a static file works for you, this is the way to go.
Two data providers are implemented in the built-in endpoint:
Local file data provider: Serves the applications JSON data from a local file on the Domino server. This allows you to deploy extensions without dependency on another server. The path of the file can be specified using a notes.ini parameter VOP_Extensibility_Applications_Json_FilePath.
HTTP data provider: Serves the applications JSON data from an HTTP hosted file. This allows you to deploy applications.json to a centralized HTTP server. The HTTP URL of the file can be specified using notes.ini parameter VOP_Extensibility_Applications_Json_URL.
The notes.ini parameter VOP_Extensibility_Data_Provider_Name controls which data provider to use, either localFileProvider or httpDataProvider. By default, if none is specified, localFileProvider will be used. In either case, the data provider will periodically check the source applications.json file for updates, so you don\u2019t have to restart the server after a new version of applications.json is deployed.
To use the local file data provider:
Make sure notes.ini parameter VOP_Extensibility_Data_Provider_Name is either clear or set to localFileProvider.
Deploy applications.json to the Domino server.
Make sure notes.ini parameter VOP_Extensibility_Applications_Json_FilePath is set to the file path of applications.json. For example:
VOP_Extensibility_Applications_Json_FilePath=D:\\data\\applications.json\nTo use the HTTP data provider:
Make sure notes.ini parameter VOP_Extensibility_Data_Provider_Name is set to httpDataProvider.
VOP_Extensibility_Data_Provider_Name=httpDataProvider\nDeploy applications.json to the HTTP server.
Make sure notes.ini parameter VOP_Extensibility_Applications_Json_URL is set to the HTTP URL of applications.json. For example:
VOP_Extensibility_Applications_Json_URL=https://files.renovations.com/vop/applications.json\nThis document describes the file structure used when either migrating to the file system, or exporting metadata during migration to Connections Files.
"},{"location":"ccm-migrator/export-fs/#rationale","title":"Rationale","text":"There's a fair chance of files in different CCM libraries and/or folders having the same file name. CCM files exported to the OS file system are therefore placed in separate directories if they came from different libraries and/or folders, to minimise the chance of filename conflicts.
The export process must create additional files to record metadata which isn't contained in the CCM files themselves. Examples of metadata are tags, comments, names of file owners, and create/update timestamps. Other files are also required for versions.
Metadata and version files must all be named in a way that unambiguously identifies the files to which they relate, but there's a chance that any of these extra files could conflict with other filenames from the same CCM folder. We create a separate file-system directory for each CCM file to contain metadata related to that file, with the directory name having \".meta\" appended to the filename, and we also put all metadata directories and files in a top-level directory separate to the current-version files. This removes any chance of metadata filenames conflicting with CCM filenames, and the \".meta\" suffix on the directory name should minimise the chance of a directory-name conflict.
"},{"location":"ccm-migrator/export-fs/#directory-structure","title":"Directory structure","text":"When migrating to the file system, all folders in a library and the current version of all files are placed in a directory structure like the following: <Community Name>/files/<Library Name>/<Folder>/<Subfolder>
When either migrating to the file system, or exporting metadata during a migration to Connections Files, metadata files and folders will be placed in a directory structure like the following: <Community Name>/metadata/<Library Name>/<Folder>/<Subfolder>
The metadata location is also used to export most file versions excluding the current version, when migrating to the file system.
In both cases above, <Subfolder> may be repeated for as many subfolder levels as were present in CCM.
Within the metadata structure, there will be:
Versions of a CCM file have version numbers in their filename. Version numbers will be exactly as reported by CCM, which typically uses a major/minor decimal format like \"1.0\".
The filename format for versions will be: <Original filename>_v<version number><extension>
"},{"location":"ccm-migrator/export-fs/#example","title":"Example:","text":"If the current version is Proposal.docx, then version 1 (superseded) will be Proposal_v1.0.docx in the Proposal.docx.meta subdirectory.
"},{"location":"ccm-migrator/export-fs/#user-access","title":"User access","text":"Files named members.csv list members (user access) for each community, library, folder, and file.
These files will be formatted as comma-separated values with one record (user/group) per line, with five fields per record. The fields will be:
The users/groups listed in members.csv will be those with explicit access, plus some special user names as follows:
The metadata directory for each CCM file (directory name ending with \".meta\") contains files named comments.csv and meta.csv. Directories representing CCM folders within the metadata structure will also contain a meta.csv file.
comments.csv contains all comments for the file. Comma-separated fields for each comment are:
meta.csv contains any metadata which isn't comments or members. Comma-separated fields for each line are:
CSV files created by CCM Migrator conform to Microsoft Excel's CSV format, with details as follows:
This is a brief list of the features we have implemented or plan to implement in the future.
If you want to know more you're very welcome to open an issue on GitHub or contact your favourite Huddo team member.
Name Status Community browser/picker \u2705 Migrate Library to Community Files \u2705 Migrate Multiple Libraries to Community Files \u2705 Migrate Library in to Files Folder \u2705 Pre-migration information (Test Mode) \u2705 Auto conflicting file rename \u2705 Auto invalid character replacement \u2705 Migration history log \u2705 Detailed migration logging \u2705 Migration roll-back by community \u2705 Migrate between two Connections environments \u2705 Export CCM data to file system \u2705 Migrate library to sub-community files \u2705 Export data for URL redirection \u2705"},{"location":"ccm-migrator/install/","title":"Installation","text":"Log into the WebSphere Integrated Solutions Console (ISC) for your HCL Connections Environment.
"},{"location":"ccm-migrator/install/#gathering-required-information","title":"Gathering required information","text":"Before starting installation, it's required to know the \"JNDI name\" for a JDBC data source for the Filenet Object Store database. If you already know this, proceed to Installing the Application for the first time, otherwise review the following.
In the ISC, navigate to Resources \\ JDBC \\ Data sources.
Determine which data source relates to the Filenet Object Store database, and note the JNDI name for that data source. The image below shows an example where the data source name and JNDI name are \"FNOSDS\", but it may be different in your environment.
If you're not sure which is the correct data source, check the details of each data source as follows:
If you can't determine the correct JNDI name, the only impact is that CCM Migrator will be unable to migrate file follows, but the installation process requires a JNDI name to be entered regardless.
"},{"location":"ccm-migrator/install/#installing-the-application-for-the-first-time","title":"Installing the Application for the first time","text":"In the ISC, navigate to Applications \\ Application Types \\ WebSphere enterprise applications and click \"Install\".
Locate the \"isw-connections-ccm.ear\" file on your local file system and click \"Next\".
Select \"Fast Path\" and click \"Next\".
Step 1: Leave the default values, update the Application Name if required, and click \"Next\".
Step 2: Map the module to a single application server or cluster, and at least one web server, then click \"Next\". Our example uses \"UtilCluster\" and \"WebServer1\", but these names may be different in your environment.
Note that after installation and before first use, the application requires users to specify a server file-system location for storing log files. If the application is mapped to a cluster, it's best if the cluster only has one server or the file-system location is synchronized between all servers in the cluster, to ensure that the log files are up to date regardless of which server the application runs on.
Step 3: Enter the JNDI name for the Filenet Object Store database, which you should have obtained as described under Gathering required information.
Step 4: Leave the default values and click \"Next\".
Step 5: Check summary and Complete installation.
Save the master configuration once complete.
"},{"location":"ccm-migrator/install/#updating-the-web-server-plug-in","title":"Updating the Web Server Plug-in","text":"The procedure in this section may or may not be required depending on the configuration of your Connections environment.
In the ISC, navigate to Servers \\ Server types \\ Web servers.
Select the web server, and click \"Generate Plug-in\". (If your environment has multiple web servers, you should be able to select them all for this step.)
When the above step completes, select the web server again, and click \"Propagate Plug-in\". (If your environment has multiple web servers, you should be able to select them all for this step.)
"},{"location":"ccm-migrator/install/#configuring-the-application","title":"Configuring the Application","text":""},{"location":"ccm-migrator/install/#licence-key","title":"Licence Key","text":"Without a licence applied, the application can only be used in test mode, where files and folders are reported but not actually migrated.
When requesting a licence you will need to supply:
After receiving your key, you will need to create name space bindings for CCM Migrator using the exact values provided by the Huddo team. Please ensure you use the exact case and spelling for the name space bindings as stated below. All licensed installs require iswCCMLicenceKey. Limited licences also require iswCCMLicenceCommunities.
iswCCMLicenceKey Licence key stringe.g. A+gAAACsrdTGobh6+PNOTAREALKEYjpVT/6AgMY4SxyOM2ZQ iswCCMLicenceCommunities Comma delimited list of community ids without white spacee.g. 4f4847e3-fdda-4da4-a1b7-2829111a694b,4f4847e3-fdda-4da4-a1b7-2829111a694c,4f4847e3-fdda-4da4-a1b7-2829111a694d You may follow the steps below for how to create name space bindings.
In the ISC, navigate to Environment \\ Naming \\ Name space bindings.
Select the \"Cell\" scope, then click \"New\".
Set the binding type to \"String\", then click \"Next\".
Set both the \"Binding identifier\" and \"Name in name space\" fields to \"iswCCMLicenceKey\". Enter your licence key in the \"String value\" field.
Click \"Next\", then click \"Finish\", then save the master configuration. Repeat these steps for iswCCMLicenceCommunities.
In the ISC, navigate to Applications \\ Application Types \\ WebSphere enterprise applications, and click the \"isw-connections-ccm\" application in the list.
Navigate to Configuration \\ Detail Properties \\ Security role to user/group mapping.
Select the \"AdminUsers\" role and Map users/groups per your requirements. It is suggested that only one or a small number of users are given access to this application.
Click \"OK\" and save the changes to the configuration.
Start the application by checking the select box for it from the list and clicking \"Start\".
"},{"location":"ccm-migrator/supported-data/","title":"Data Supported in Migrations","text":"This document is intended to be a comprehensive list of every piece of metadata in CCM that CCM Migrator can extract and whether is is supported when migrating to Connections Community Files or to a Filesystem.
If you want to know more, something is missing or if something has been completed, you're very welcome to open an issue on GitHub or contact your favorite Huddo team member.
CCM Data Connections Community Files Filesystem File Data \u2705 \u2705 File Name \u2705 \u2705 Folders \u2705 \u2705 Versions \u2705 \u2705 Version Filenames \u2705 \u2705 Drafts \u2705 \u2705 Tags \u2705 \u2705 Description \u2705 \u2705 Comments \u2705 \u2705 Comment Related Version \u2705 \u2705 Total Likes \u2705 \u2705 Liked by \u2705 \u274c Follows \u2705 \u274c Created by \u2705 \u2705 Created date \u2705 \u2705 Updated by \u2705 \u2705 Updated date \u2705 \u2705 Custom Metadata \ud83d\uddc3 \u2705 Document Types \ud83d\uddc3 \u2705 Total Downloads \u274c \u2705 Downloaded by \u274c \u274c Library/Folder/File permissions \u274c \u2705 Approval workflow state \u274c \u274c\ud83d\uddc3 - Exported to file system
"},{"location":"ccm-migrator/update/","title":"Update","text":""},{"location":"ccm-migrator/update/#updating-the-application","title":"Updating the Application","text":"This part of the documentation only applies if you have been provided with a new version of the application for the purpose of fixing bugs or adding features.
Log into the ISC for your HCL Connections environment.
If you're updating from a version of CCM Migrator which can't migrate file follows (before 8 July 2022) to a version which can migrate file follows, the update process requires some extra information. This is described under Gathering required information at the top of the installation document.
Navigate to Applications \\ Application Types \\ WebSphere enterprise applications.
Select the \"isw-connections-ccm\" application from the list, and click \"Update\".
Using the default option (\"Replace the entire application\"), select the new \"isw-connections-ccm.ear\" file, and click \"Next\".
Click \"Next\" at the bottom of most subsequent screens, leaving all options at the default, except that you may need to enter the JNDI name for the Filenet Object Store database at \"Step 3: Map resource environment references to resources\".
Click \"Finish\" upon reaching the \"Summary\" stage. This may be labelled as \"Step 3\" or \"Step 4\" depending on whether you needed to enter a JNDI name as above.
After clicking \"Finish\", there will be some delay while the next screen fills in. Click the \"Save\" link when it appears.
Depending on your WebSphere configuration, the nodes may synchronize immediately or there may be some delay (typically up to 1 minute) while they synchronize in the background. Changes to the application only take effect after nodes have synchronized.
After updating the application and synchronizing nodes, and before using the application again, any users of the application should clear their web browser cache to ensure that changes to client-side files take effect. It is only necessary to clear the cache or \"temporary internet files\". Clearing cookies or logins is unnecessary.
"},{"location":"ccm-migrator/update/#updating-the-licence","title":"Updating the Licence","text":"After receiving your new key, you will need to update the name space bindings for CCM Migrator using the exact values provided by the Huddo team. Please ensure you use the exact case and spelling for the name space bindings as stated below. All licensed installs require iswCCMLicenceKey. Limited licences also require iswCCMLicenceCommunities.
iswCCMLicenceKey Licence key stringe.g. A+gAAACsrdTGobh6+PNOTAREALKEYjpVT/6AgMY4SxyOM2ZQ iswCCMLicenceCommunities Comma delimited list of community ids without white spacee.g. 4f4847e3-fdda-4da4-a1b7-2829111a694b,4f4847e3-fdda-4da4-a1b7-2829111a694c,4f4847e3-fdda-4da4-a1b7-2829111a694d You may follow the steps below for how to update name space bindings.
In the ISC, navigate to Environment \\ Naming \\ Name space bindings.
Select the iswCCMLicenceKey binding.
Update the \"String\" with the new value, then click \"OK\".
Then save the master configuration. Repeat these steps for iswCCMLicenceCommunities if this also needs to be updated.
The application can be accessed from your HCL Connections site using a URL like {connections domain}/isw-connections-ccm/, where {connections domain} is the protocol and domain name of your Connections site.
On first use, the application loads on its \"API Settings\" page, and requires settings to be confirmed before it can be used. Most settings have sensible defaults, but some may need to be changed depending on your environment and on how you intend to use the application. Particularly note:
Other API Settings are described below, but should never need to be changed for normal operation:
Once the settings are confirmed by clicking \"Confirm Settings\" at the bottom of the page, the \"Home\" page will load. The application saves all settings in the web browser's local storage, so it will remember settings and will load the \"Home\" page by default on all subsequent use in the same browser, unless local storage is cleared.
"},{"location":"ccm-migrator/usage/#analysis-and-migration","title":"Analysis and Migration","text":"On first use before migrating, it's necessary to perform an analysis to build a list of communities. Click \"Analyze Communities\" to do this.
By default, analysis retrieves the following information for each community:
With this default behaviour, analysis running time is proportional to the number of communities in your environment. As a rough guide to performance, analysis in an ISW test environment with 270 communities takes about 20 seconds.
The left-hand pane of the \"Home\" page contains several options under the heading \"Migration Settings\". Most of these options only apply to migration, but the option \"Analysis reads library size\" applies to analysis and causes it to also retrieve and display the total size of CCM Libraries in each community. Note this is very slow as it's greatly affected by the number of folders and files in all CCM Libraries. For example in the ISW test environment where analysis takes 20 seconds without this option, it takes about 5 minutes with this option, for a total of about 8000 files.
Once analysis is complete, the list of Communities will be displayed. This includes filtering that defaults to show only Communities valid for migration from CCM to Files.
At this point, you can migrate any number of communities by checking the box next to each Community name and clicking \"Migrate Communities\", but you should first review the \"Migration Settings\" in the left-hand pane. The settings are:
The \"Status Log\" provides details while processing. For each community, it lists all Library files (including what folder they belong to) and existing folders in the Files app during an information-gathering phase, then (if Test Mode is disabled) performs the actual migration, listing all files again with an icon and text indicating whether each file was migrated. This log persists after migration, but is cleared if either an analysis is performed or the application is restarted on the server.
Once a Migration run has completed, an entry for each migrated community is added to the \"History\" page of the application, showing the community title and migration status. A file containing the history is saved under the \"Temporary Files Storage\" location on the server, and persists unless deleted by some means outside the application.
"},{"location":"ccm-migrator/usage/#regarding-file-name-conflicts","title":"Regarding file name conflicts","text":"When migrating files, the application makes some attempt to work around file name conflicts. This is particularly worth noting when either:
HCL Connections Files permits files of the same name in different folders, but doesn't permit a top-level file (not in any folders) to have the same name as a file in a folder.
By default, if CCM Migrator tries to migrate a file and finds that there is already a file of that name in Community Files, it will rename the new migrated file by appending an underscore (_) followed by a number. It will use the number 2 for the first renamed file, increasing the number if the first rename also produces a conflict, and will try up to 20 renames on each conflicting file before giving up. For example, if the file name \"My Document.doc\" conflicts with an existing Community File, it will be renamed to \"My Document_2.doc\".
Additionally, for each community, the application checks whether a migration was previously attempted for that community, and avoids repeatedly migrating files which were previously migrated. This means that if a migration of one community was partially successful, but some error prevented completion, the error can be fixed and the migration repeated without having to clear out previously migrated files or producing duplicates. Important: Migrations performed before this functionality was added to CCM Migrator (on 11 Feb 2019) will not be detected, due to the reliance on a new style of system logging.
The application's user-interface provides options to change the above behaviour, and those options are listed earlier in this document.
"},{"location":"ccm-migrator/usage/#roll-back","title":"Roll-back","text":"As of 5 April 2022, CCM Migrator has the ability to roll back migrated communities. Roll-back is only supported when migrating to Connections Files. A file-system migration can be rolled back manually by deleting the export from the server file system.
Perform a roll-back by selecting desired communities and clicking the \"Roll-back Communities\" button. This will only work for communities which were previously migrated.
If Test Mode is enabled, nothing will be rolled back, and the Status Log will just report the number of files and folders which can be rolled back.
Roll-back only removes files and folders created by migration, and won't remove folders which still contain files or subfolders when the roll-back is otherwise complete.
Roll-back also only works for communities which were migrated after the roll-back functionality was implemented, because it depends on additional data stored in the migration logs on the server. If necessary to roll back an older migration then, as long as the migrated files and folders weren't deleted or moved, simply repeat the migration. This will create a new migration log which contains the required additional data and allows roll-back.
"},{"location":"tools/ansible/","title":"Ansible","text":""},{"location":"tools/ansible/#setup-ansible","title":"Setup Ansible","text":"Throughout the guides on this site we use ansible to setup servers and manage servers and deployments in both kubernetes and docker swarm.
If you have access to a Mac or Linux machine, follow these instructions to get up and running.
Whilst that document states windows is not supported, We have had success running ansible under windows by enabling WSL (Windows subsystem for Linux), installing Ubuntu from the windows store and proceeding with the Ubuntu instructions linked.
Refer to this document from Microsoft for more information on WSL and the windows store options.
"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index afb2f53c5..7fc07ccfa 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,847 +2,847 @@