From ca1fe4fb39c6c04e510c5d6c51a32f91c1cd0fb1 Mon Sep 17 00:00:00 2001
From:  <>
Date: Wed, 19 Jun 2024 00:02:11 +0000
Subject: [PATCH] Deployed 70e59dee with MkDocs version: 1.6.0

---
 boards/cloud/updates/index.html |   7 +-
 search/search_index.json        |   2 +-
 sitemap.xml                     | 374 ++++++++++++++++----------------
 sitemap.xml.gz                  | Bin 1621 -> 1621 bytes
 4 files changed, 194 insertions(+), 189 deletions(-)

diff --git a/boards/cloud/updates/index.html b/boards/cloud/updates/index.html
index cb209ff69..db335db7e 100644
--- a/boards/cloud/updates/index.html
+++ b/boards/cloud/updates/index.html
@@ -6382,6 +6382,11 @@ <h1 id="boards-cloud-updates">Boards Cloud Updates<a class="headerlink" href="#b
 <p>Please see here for recent changes to <a href="https://boards.huddo.com">Huddo Boards Cloud</a></p>
 <h2 id="2024">2024<a class="headerlink" href="#2024" title="Permanent link">&para;</a></h2>
 <h3 id="june">June<a class="headerlink" href="#june" title="Permanent link">&para;</a></h3>
+<p>2024-06-19</p>
+<p>Fixes:</p>
+<ul>
+<li>Parse email to card when dragging from HCL Notes</li>
+</ul>
 <p>2024-06-13</p>
 <p>Improvements:</p>
 <ul>
@@ -7551,7 +7556,7 @@ <h2 id="2021">2021<a class="headerlink" href="#2021" title="Permanent link">&par
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
     </span>
-    2024-06-13
+    2024-06-19
   </span>
 
     
diff --git a/search/search_index.json b/search/search_index.json
index ffe585aff..86111a4d7 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#docs","title":"Docs","text":"<p>This site contains technical and user documentation for Huddo Apps. For purchase and product information visit huddo.com.</p>"},{"location":"#quick-links","title":"Quick Links","text":"<ol> <li> <p>Boards Cloud</p> <ul> <li>Recent Updates</li> <li>Status</li> </ul> </li> <li> <p>Boards On-Premise</p> <ul> <li>Latest Releases</li> </ul> </li> <li> <p>Huddo Boards for</p> <ul> <li>HCL Connections</li> <li>HCL Domino</li> <li>HCL Digital Experience (DX)</li> </ul> </li> </ol>"},{"location":"log4j/","title":"Log4j","text":"<p>Recently a severe vulnerability was discovered in the log4j package. Details of that are here and Apache mitigation/patching details are here.</p> <p>The status of the Huddo Applications in regard to the vulnerability are below.</p>"},{"location":"log4j/#badges","title":"Badges","text":"<p>Badges does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.</p>"},{"location":"log4j/#analytics","title":"Analytics","text":"<p>Analytics does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.</p>"},{"location":"log4j/#boards-websphere","title":"Boards WebSphere","text":"<p>Boards WebSphere does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.</p>"},{"location":"log4j/#boards-dockercomponent-pack","title":"Boards Docker/Component Pack","text":"<p>Boards Docker does not contain any Java and as such is not affected by this vulnerability.</p>"},{"location":"log4j/#boards-cloud","title":"Boards Cloud","text":"<p>Boards Cloud does not contain any Java and as such is not affected by this vulnerability.</p>"},{"location":"log4j/#ccm-migrator","title":"CCM Migrator","text":"<p>CCM Migrator does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.</p>"},{"location":"status/","title":"Status","text":"<p>This page provides information on the status of our cloud services.</p> <p>Huddo Boards Cloud - OnlinePlanned MaintenanceOffline</p>"},{"location":"analytics/install/","title":"Overview","text":"<p>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.</p> <p>The install process for Huddo Analytics involves the following steps:</p> <ul> <li>Install the Huddo Analytics Application</li> <li>Define Widgets</li> <li>Apply Changes</li> <li>Add Widgets to Connections Interface</li> <li>Community Widget Properties</li> <li>Upload your Licence file</li> <li>Customising</li> <li>FAQ</li> </ul> <p>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.</p>"},{"location":"analytics/install/add-widgets/","title":"Add Widgets","text":"<p>So far, you have configured the location of the Huddo widgets. You will now add the widgets to the user interface.</p>"},{"location":"analytics/install/add-widgets/#add-the-configurators-widgets-to-their-communities","title":"Add the Configurators Widgets to their Communities","text":"<p>Login to Connections and navigate to the previously created Badges Configurator Community</p> <ol> <li> <p>Click Community Actions then 'Add Apps' from the drop down menu</p> <p></p> </li> <li> <p>Select the Configurator to add to the Community</p> <p></p> </li> <li> <p>Click X</p> </li> </ol> <p>The Configurator will now be added to the main view.</p> <p>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.</p>"},{"location":"analytics/install/add-widgets/#remove-the-default-widgets-optional","title":"Remove the Default Widgets (Optional)","text":"<p>Click the Actions drop-down and select Delete     </p> <p>Fill in the required data then click Ok on the Delete prompt     </p>"},{"location":"analytics/install/add-widgets/#add-the-huddo-analytics-widget-to-communities","title":"Add the Huddo Analytics Widget to Communities","text":"<p>Login to Connections and navigate to the Huddo Analytics Community</p> <p>Click Community Actions then 'Add Apps' from the drop down menu</p> <p></p> <p>Select HuddoAnalytics</p> <p></p> <p>Click X</p> <p>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.</p> <p>Your first Huddo Analytics widget will now be added to the main view.</p> <p>The default view shows the report categories. Once a report category is selected, default report instances for that category can be selected.</p> <p>Once the report instance is selected, further options for that report can be selected.</p> <p>The report currently configured is previewed below the options and can be saved for quick viewing on all subsequent page loads.</p> <p>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.</p> <p>Multiple Huddo Analytics widgets are designed to exist in each community.</p>"},{"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":"<p>Adding widgets to the Home page of Connections is done through the Connections Web page. </p> <p>Login to Connections as a user assigned to the admin security role of the Homepage application and navigate to the Administration tab.</p> <p>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.</p> <p></p> 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://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/AnalyticsDashboard.xml False True False False True - <p>Highlight the Huddo User Analytics widget in the Disabled widgets section and click Enable and it will now show in the Enabled widgets list.</p> <p>It will also show on the Updates and Widgets tabs, if these options were selected.</p>"},{"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":"<p>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.</p> <p>Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.</p> <p>Open My Page through the Sidebar link or Home button and select Customize</p> <p></p> <p>Select Huddo User Analytics. If you cannot find it, look under the 'Other' category.</p> <p></p> <p>Click X</p> <p>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.</p> <p>Multiple Huddo User Analytics widgets are designed to exist on My Page.</p>"},{"location":"analytics/install/app/","title":"Install Application","text":"<p>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.</p>"},{"location":"analytics/install/app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"<p>Login to the WebSphere Integrated Solution Console for your Connections environment via a webbrowser.</p> <p>Enter your administrator User ID and Password, then click the \u201cLog in\u201d button.</p> <p></p>"},{"location":"analytics/install/app/#install-the-huddowar-file","title":"Install the Huddo.war file","text":"<p>Navigate to Applications \u2192 Application Types \u2192 WebSphere enterprise applications</p> <p></p> <p>Click the Install button</p> <p></p> <p>Browse the Local File System Path for the downloaded Huddo.war file then Click Next</p> <p></p> <p>Check the Fast Path Option then Click Next</p> <p></p> <p>Change the Application name to Huddo then Click Next</p> <p></p> <p>Highlight the Nodes for the Application, including the IHS Node. Select the Badges Module, click Apply then Next.</p> <p>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 &gt; Clusters &gt; WebSphere application server clusters and then clicking New.</p> <p></p> <p>Click on Browse and map the default resources as shown. Click Next.</p> <p></p> <p>Enter Huddo as the Context Root, then click Next.</p> <p>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.</p> <p></p> <p>Review the Installation Summary. Click Finish.</p> <p></p> <p>Review the Installation Results. Click Save.</p> <p></p> <p>Review the Synchronisation Summary. Click OK.</p> <p>You have now successfully installed Huddo as a WebSphere Enterprise Application. Next, you will need to edit the security settings.</p>"},{"location":"analytics/install/app/#modify-the-huddo-application-security-role-assignments","title":"Modify the Huddo Application Security Role assignments","text":"<p>During this step, we will be defining the authenticated users/groups for each Security Role.</p> <p>Find Huddo in the list of enterprise applications and click on Huddo to open the application configuration screen</p> <p></p> <p>Click Security role to user/group mapping</p> <p></p> <p>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</p> <p>Please note: You may set the Reader role to Everyone to grant read-only access to Huddo widget data to unauthenticated users.</p> <p></p>"},{"location":"analytics/install/apply-changes/","title":"Apply Changes","text":"<p>The clusters must be restarted for the widget configuration changes to take effect.</p>"},{"location":"analytics/install/apply-changes/#restart-the-clusters","title":"Restart the Clusters","text":"<p>Login to the Integrated Solution Console</p> <p>Navigate to Servers \u2192 Clusters \u2192 WebSphere Application Server Clusters</p> <p>Select all of the Connections Clusters</p> <p>Click Ripplestart.</p> <p></p>"},{"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":"<p>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.</p> <p></p> <p>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.</p> <p>Checkout and edit the widgets-config.xml file:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p> <p>Locate the Configuration Widget definitions under the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>Add the attribute <code>showInPalette=\"false\"</code> 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.</p> <p>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.</p> <p>Your configuration should now look like this:</p> <pre><code>&lt;widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>Check in the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p> <p>Then Restart the clusters.</p>"},{"location":"analytics/install/customising/","title":"Customising","text":""},{"location":"analytics/install/customising/#customising-huddo-strings-properties-images-optional","title":"Customising Huddo Strings, Properties &amp; Images (Optional)","text":"<p>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.</p>"},{"location":"analytics/install/customising/#customising-huddo-strings","title":"Customising Huddo Strings","text":"<p>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.</p> <p>Please Note:</p> <ul> <li>These files are in JSON format and it is critical that the syntax of these files is valid for the customisation to take effect.</li> <li> <p>This step can be performed at any stage after the installation and is not required to complete the installation.</p> <ol> <li>Create a folder called HuddoStrings in the directory given by the PROFILES_STATS_DIR WebSphere Variable.</li> <li>Create a text file called UserInterfaceLang.js in the HuddoStrings directory.</li> <li>Open the default UserInterfaceLang.js file from the location <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultLang/</li> <li>Add the strings you wish to customise to the newly created UserInterfaceLang.js file from the original file while maintaining a similar format.     e.g.: below is a sample customised UserInterfaceLang.js file which overwrites 7 properties:</li> </ol> </li> </ul> <p><pre><code>{\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}\n</code></pre> Note: only add the strings you wish to customise as this procedure will overwrite the existing strings for all other languages with the provided values.</p> <p>If you wish to add specific customisations for different languages:</p> <ol> <li>Create a sub-folder with the locale name within the HuddoStrings directory (See List of Language Codes)</li> <li>Create a language specific version of UserInterfaceLang.js file as per Steps 3 &amp; 4 above.</li> <li>Place it in the locale sub-folder.</li> </ol> <p>Example:</p> <pre><code>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\n</code></pre> <ol> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol>"},{"location":"analytics/install/customising/#customising-huddo-properties","title":"Customising Huddo Properties","text":"<p>The 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.</p> <p>Available properties files to customise:</p> <ul> <li>applicationConfig.js \u2013 Context roots for Connections &amp; Huddo</li> <li>messages.properties \u2013 Strings used in Huddo emails &amp; Activity Stream entries</li> <li>resource.properties \u2013 Miscellaneous settings, i.e. database aliases etc.</li> </ul> <p>Please Note:</p> <ul> <li>These files are in JSON format and it is critical that the syntax of these files is valid for the customisation to take effect.</li> <li>This step can be performed at any stage after the installation and is not required to complete the installation.<ol> <li>Create a folder called HuddoProperties in the directory given by the PROFILES_STATS_DIR Websphere Variable.</li> <li>Copy the property file(s) to be edited into the HuddoProperties folder from the location    <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultProperties/</li> <li>Open the HuddoProperties folder\u2019s newly copied files and edit the properties as required before saving.</li> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol> </li> </ul>"},{"location":"analytics/install/customising/#customising-huddo-images","title":"Customising Huddo Images","text":"<p>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.</p> <p>Please Note:</p> <ul> <li> <p>This step can be performed at any stage after the installation and is not required to complete the installation.</p> <ol> <li> <p>Determine the image(s) to be customised in the HuddoImages folder from the location    <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultImages/</p> <pre><code>Common files customised include:\n    kudos_stream.png (as seen in the Homepage Activity Stream)\n    mobile_`&lt;MOBILE_DEVICE&gt;`.png (i.e. mobile_android.png etc \u2013 as seen for Huddo mobile)\n</code></pre> </li> <li> <p>Create a folder called HuddoImages in the directory given by the PROFILES_STATS_DIR Websphere Variable.</p> </li> <li>Place a copy of the custom image into the HuddoImages folder with the same name as the image file you wish to overwrite.</li> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol> </li> </ul>"},{"location":"analytics/install/install-widgets/","title":"Widgets","text":"<p>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.</p>"},{"location":"analytics/install/install-widgets/#create-the-configurator-community","title":"Create the Configurator Community","text":"<p>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.</p> <ol> <li> <p>Login to Connections, navigate to Communities and click Create a Community</p> <p></p> </li> <li> <p>Enter a name, such as Huddo Configurator</p> </li> <li> <p>Set Access to Restricted</p> </li> <li> <p>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.</p> </li> <li> <p>Enter any tags, web address and description you wish then click Save.</p> <p></p> </li> </ol> <p>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.</p> <p>You have now created the Huddo Configurator Community.</p> <p>Take note of the CommunityUUID in the URL address, as we will need this later.</p>"},{"location":"analytics/install/install-widgets/#create-the-huddo-analytics-administrator-community","title":"Create the Huddo Analytics Administrator Community","text":"<p>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.</p> <ol> <li> <p>Login to Connections, navigate to Communities and click Start a Community.</p> <p></p> </li> <li> <p>Enter a name, such as Huddo Analytics.</p> </li> <li> <p>Set Access to Restricted.</p> </li> <li> <p>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.</p> </li> <li> <p>Enter any tags, web address and description you wish and click Save.</p> <p></p> </li> </ol> <p>You have now created the Huddo Analytics Administrator Community.</p> <p>Take note of the CommunityUUID in the URL address, as we will need this later.</p>"},{"location":"analytics/install/install-widgets/#check-out-the-widgets-configxml-file","title":"Check out the widgets-config.xml file","text":"<p>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.</p> <p>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.</p> <p>Checking Out the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p>"},{"location":"analytics/install/install-widgets/#configure-configurator-and-community-leaderboard-widgets","title":"Configure Configurator and Community Leaderboard Widgets","text":"<p>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.</p> <p>You must define the Widgets and where to find their associated .xml files. You will need the CommunityUuids you took note of earlier. </p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>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</p> <pre><code>&lt;widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoAnalytics\" description=\"HuddoAnalytics\" modes=\"view edit\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AnalyticsDashboard.xml\" uniqueInstance=\"false\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"adminCommunityId\" value=\"YOUR_ANALYTICS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>We 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.</p>"},{"location":"analytics/install/install-widgets/#check-in-the-widgets-configxml-file","title":"Check in the widgets-config.xml file","text":"<p>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.</p> <p>Checking In the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p>"},{"location":"analytics/install/install-widgets/#register-widgets-connections-60-cr1-onwards","title":"Register Widgets (Connections 6.0 CR1 onwards)","text":"<p>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.</p>"},{"location":"analytics/install/install-widgets/#add-huddo-configuration-jsp-to-the-header","title":"Add Huddo configuration JSP to the header","text":"<p>Perform this task to add Huddo Configuration information to Connections pages.</p> <p>This is achieved by customising the header.jsp file, used for customizing the Connections Navigation bar.</p> <p>If you have not customised the header.jsp file for your connections environment, please make a copy of the file from:</p> <p><code>&lt;WAS_home&gt;</code>/profiles/<code>&lt;profile_name&gt;</code>/installedApps/<code>&lt;cell_name&gt;</code>/Homepage.ear/homepage.war/nav/templates</p> <p>Paste the copy into the common\\nav\\templates subdirectory in the customization directory: <code>&lt;installdir&gt;</code>\\data\\shared\\customization\\common\\nav\\templates\\header.jsp</p> <p>Edit the header.jsp file in the customisations directory add the following lines after the Moderation link and before the <code>&lt;/ul&gt;</code> HTML tag as shown:</p> <p></p> <p>To add the Huddo Config JSP</p> <pre><code>--%&gt;&lt;c:if test=\"${'communities' == appName || 'homepage' == appName || 'profiles' == appName}\"&gt;&lt;%--\n    --%&gt;&lt;c:catch var=\"e\"&gt;&lt;c:import var=\"kudosConfig\" url=\"http://${pageContext.request.serverName}/Kudos/kudosConfig.jsp\"/&gt;&lt;/c:catch&gt;&lt;%--\n    --%&gt;&lt;c:if test=\"${empty e}\"&gt;&lt;script type=\"text/javascript\"&gt;${kudosConfig}&lt;/script&gt;&lt;/c:if&gt;&lt;%--\n--%&gt;&lt;/c:if&gt;&lt;%--\n</code></pre> <p>Save and close the file, the changes will take effect when the clusters are restarted. (See next task)</p>"},{"location":"analytics/install/install-widgets/#specify-huddo-analytics-admin-community-for-security","title":"Specify Huddo Analytics Admin Community for Security","text":"<p>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.</p> <p>Create the resource.properties file in the Profiles Statistics customisation directory: <code>&lt;PROFILES_STATS_DIR&gt;</code>/HuddoProperties Where PROFILES_STATS_DIR is defined by the WebSphere variable: e.g. /opt/IBM/Connections/data/shared/profiles/statistics/HuddoProperties</p> <p>Put the following line in the file, replacing <code>&lt;KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID&gt;</code> with the ID of the Huddo Analytics Community created in Task 2.4:</p> <pre><code>analyticsAdminCommunityID=&lt;KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID&gt;\n</code></pre> <p>IMPORTANT: If a file of the same name already exists, merge the contents into the existing file.</p>"},{"location":"analytics/install/licence/","title":"Licence","text":"<p>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 </p>"},{"location":"analytics/install/licence/#upload-your-licence-file-in-the-badges-configurator","title":"Upload your licence file in the Badges Configurator","text":"<p>Login to Connections Navigate to the Huddo Configurator Community.</p> <p>Select the Settings tab in the BadgesConfigurator widget. If there are no tabs, this is the default view.</p> <p>Click the Update Licence button.</p> <p></p> <p>Click Choose File and browse to your Huddo.licence file and click Upload.</p> <p></p>"},{"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":"<p>Please go to the BadgesConfigurator-&gt;Settings tab then restart the Huddo Application.</p>"},{"location":"analytics/install/websphere-faq/#scheduler-not-running","title":"Scheduler not running","text":"<p>Issue is with the timerManager in WAS. Create a new one to resolve issue.</p>"},{"location":"analytics/install/websphere-faq/#performance-tuning","title":"Performance tuning","text":"<p>Review this guide for changes that can be made.</p>"},{"location":"analytics/install/websphere-faq/#connections-8-ui","title":"Connections 8 UI","text":"<p>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)</p> <pre><code>.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}\n</code></pre>"},{"location":"analytics/user-guide/access-reports/","title":"How to Access Reports","text":"<p>This section covers the fundamental how-tos for accessing reports within Huddo Analytics</p>"},{"location":"analytics/user-guide/access-reports/#view-reports","title":"View Reports","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#add-an-analytics-widget","title":"Add an Analytics Widget","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#user-level","title":"User Level","text":"<p>Open Homepage -&gt; My Page -&gt; Customize</p> <p>Select Huddo User Analytics and Click X</p>"},{"location":"analytics/user-guide/access-reports/#community-level","title":"Community Level","text":"<p>Open Community -&gt; Community Actions -&gt; Customize</p> <p>Select Huddo Analytics then Click X</p>"},{"location":"analytics/user-guide/access-reports/#administration-level","title":"Administration Level","text":"<p>Open Huddo Analytics Community -&gt; Community Actions -&gt; Customize</p> <p>Select Huddo Analytics then Click X</p>"},{"location":"analytics/user-guide/access-reports/#select-a-report-category","title":"Select a Report Category","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#select-a-report","title":"Select a Report","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#customise-reports","title":"Customise Reports","text":"<p>All reports offer a range of options and filters to allow viewers to customise and personalise the report.</p> <p>All reports have Query Parameters that define the context and scope of the underlying query for the report.</p> <p>Table reports also have column filters (for filtering by value) and the ability to enable/disable columns (right click on column headers).</p>"},{"location":"analytics/user-guide/access-reports/#saving-reports","title":"Saving Reports","text":"<p>Once you are satisfied with your report selection you can Save it. Click Save.</p> <p>Personalise the report by specifying a custom title and description and click OK.</p> <p>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.</p>"},{"location":"analytics/user-guide/access-reports/#managing-reports","title":"Managing Reports","text":"<p>Reports can be managed at any stage during their lifecycle. The button in the top right hand corner provides access to the following functions:</p>"},{"location":"analytics/user-guide/access-reports/#refresh","title":"Refresh","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#edit","title":"Edit","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#move-updown","title":"Move Up/Down","text":"<p>Reports can be positioned in any order. They can also be dragged and dropped. This is based on the Connections widget layout.</p>"},{"location":"analytics/user-guide/access-reports/#remove","title":"Remove","text":"<p>If you no longer require the current report you can remove it. Note: this cannot be undone.</p>"},{"location":"analytics/user-guide/available-reports/","title":"Available Reports","text":""},{"location":"analytics/user-guide/available-reports/#reporting-access-levels","title":"Reporting Access Levels","text":"<p>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.</p>"},{"location":"analytics/user-guide/available-reports/#personal-analytics","title":"Personal Analytics","text":"<p>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.</p> <p>Examples - My Most visited Blogs, My Recent Network Contact, My Recent Followers, etc.</p>"},{"location":"analytics/user-guide/available-reports/#community-level-analytics","title":"Community Level Analytics","text":"<p>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.</p> <p>Examples \u2013 Most Popular Ideas, Number of Visits Over Time, Most Recent Members, etc.</p>"},{"location":"analytics/user-guide/available-reports/#overall-admin-connections-analytics","title":"Overall (admin) Connections Analytics","text":"<p>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.</p> <p>Examples - Most Active Users, Most Active Content, Percentage of Users Active in BUILDING, Connections Usage by Application, etc.</p>"},{"location":"analytics/user-guide/available-reports/#categories-of-reports","title":"Categories of Reports","text":"<p>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.</p> <p>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</p> <p>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</p> <p>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</p> <p>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</p> <p>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</p> <p>There is also a Huddo report category for Huddo Badges/Thanks/Awards.</p> <p>Huddo Huddo reports help quantify Badges/Thanks/Awards received on Badge and User e.g. Total Awarded Badges, Thanks Awarded usage, Huddo Summary Report</p>"},{"location":"analytics/user-guide/available-reports/#default-available-reports","title":"Default Available Reports","text":"<p>Below is a full list of all reports provided as part of Huddo Analytics, organised by Report Access Level and Category.</p>"},{"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":"<p>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.</p>"},{"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  Default <p>Not Relevant: ADD, APPROVE, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, PIN, PREVIEW, RECOMMEND, REJECT, REMOVE, RESTORE, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, VOTE, WATCH</p>"},{"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  Default <p>Not Relevant: COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, REMOVE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN,, UNWATCH, VOTE, WATCH</p>"},{"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  Tag <p>Not 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</p>"},{"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  Default <p>Not Relevant:  APPROVE, COMPLETE, COPY, DOWNLOAD, EMPTY, FOLLOW, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, REJECT, REMOVE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH</p>"},{"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  Library <p>Not Relevant:  APPROVE, COMPLETE, COPY, DECLINE, GRADUATE, LOCK, MOVE, PIN, PREVIEW, UNCOMPLETE, UNLOCK, UNPIN, UNWATCH, VISIT, VISIT_DUP</p>"},{"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 Membership <p>Not Relevant:  ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, PREVIEW, READ, REMOVE, RESTORE, UNCOMPLETE, UNRECOMMEND, UNWATCH, VISIT_DUP, VOTE, WATCH</p>"},{"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  Widgets <p>Not 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</p>"},{"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 Idea <p>Not Relevant:  ADD, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, FOLLOW, LOCK, MOVE, PIN, PREVIEW, REMOVE, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, UPDATE, WATCH</p>"},{"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 Library <p>Not 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</p>"},{"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 Default <p>Not Relevant:  APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH</p>"},{"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  Library <p>Not Relevant:  ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH</p>"},{"location":"analytics/user-guide/terms/","title":"Glossary of Terms","text":""},{"location":"analytics/user-guide/terms/#events","title":"Events","text":"<p>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:</p> 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":"<p>The visible data (graph or table) produced to analyse the use of your IBM Connections environment.</p>"},{"location":"analytics/user-guide/terms/#report-definition","title":"Report Definition","text":"<p>The default instances provided with Huddo which can be used as-is (or customised) to create Reports</p>"},{"location":"analytics/user-guide/terms/#view-mode","title":"View mode","text":"<p>The default mode of a saved Analytics widget. It only displays the graph or table, hiding all the configuration options for the report.</p>"},{"location":"analytics/user-guide/terms/#edit-mode","title":"Edit mode","text":"<p>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.</p>"},{"location":"analytics/user-guide/introduction/","title":"Introduction","text":""},{"location":"analytics/user-guide/introduction/#purpose-of-huddo-analytics","title":"Purpose of Huddo Analytics","text":"<p>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?</p> <p></p>"},{"location":"analytics/user-guide/introduction/#what-is-a-report","title":"What is a Report?","text":"<p>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;</p>"},{"location":"analytics/user-guide/introduction/#table-reports","title":"Table Reports","text":"<p>These reports show data in a tabular form, with the ability to sort and filter on column values and also to toggle entire columns.</p> <p></p>"},{"location":"analytics/user-guide/introduction/#bar-charts","title":"Bar Charts","text":"<p>Bar charts are great for visual comparisons between values.</p> <p></p>"},{"location":"analytics/user-guide/introduction/#trend-reports","title":"Trend Reports","text":"<p>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.</p> <p></p>"},{"location":"analytics/user-guide/introduction/#column-charts","title":"Column Charts","text":"<p>Column charts are great for representing a distribution.</p> <p></p>"},{"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":"<p>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.</p> <p></p>"},{"location":"analytics/user-guide/using-reports/#customise-reports-to-answer-specific-questions","title":"Customise Reports to Answer Specific Questions","text":"<p>A Report also provides the capability to customise the query underlying its data to answer more specific questions. There are 4 main customisation options;</p>"},{"location":"analytics/user-guide/using-reports/#customise-query-parameters","title":"Customise Query Parameters","text":"<p>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.</p> <p></p> <p>After you have set the parameters you desire, press 'Run' to apply them and update the report data.</p> <p></p>"},{"location":"analytics/user-guide/using-reports/#sort-columns","title":"Sort Columns","text":"<p>Tabular reports allowing sorting column data (ascending/descending) by clicking on the header name.</p> <p></p>"},{"location":"analytics/user-guide/using-reports/#filtersearch-table-results-keyword-minmax","title":"Filter/Search table results (keyword, min/max)","text":"<p>Search report table columns by Keywords, Min/Max values and Start/End dates.</p> <p></p>"},{"location":"analytics/user-guide/using-reports/#enabledisable-columns","title":"Enable/Disable columns","text":"<p>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.</p> <p></p>"},{"location":"badges/","title":"Index","text":"<p>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.</p> <p>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.</p> <p>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.</p> <p>Huddo also now includes a peer to peer and team recognition feature; Huddo Thanks.</p>"},{"location":"badges/#huddo-points","title":"Huddo Points","text":"<p>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.</p>"},{"location":"badges/#huddo-metrics","title":"Huddo Metrics","text":"<p>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.</p> <p>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.</p>"},{"location":"badges/#huddo-filters","title":"Huddo Filters","text":"<p>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.</p> <p>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.</p>"},{"location":"badges/#huddo-badges","title":"Huddo Badges","text":"<p>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.</p> <p>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.</p>"},{"location":"badges/#huddo-awards","title":"Huddo Awards","text":"<p>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.</p>"},{"location":"badges/#huddo-leaderboard","title":"Huddo Leaderboard","text":"<p>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).</p> <p>You can also view a break-down of which categories the Points/Badges came from by simply selecting the user in the Leaderboard.</p>"},{"location":"badges/#huddo-configurators","title":"Huddo Configurators","text":"<p>The Huddo Badges, Metrics &amp; Filters Configurators allow the user to control and customise Badges, Metrics &amp; Filters.</p> <p>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.</p> <p>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.</p>"},{"location":"badges/#huddo-badges-summary","title":"Huddo Badges Summary","text":"<p>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.</p>"},{"location":"badges/#huddo-profile-progress-widget","title":"Huddo Profile Progress Widget","text":"<p>Encourage the users to get started in Connections!</p> <p>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!</p>"},{"location":"badges/#huddo-thanks","title":"Huddo Thanks","text":"<p>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.</p> <p>That is why ISW has developed Huddo Thanks, the peer to peer and team recognition tool for Connections.</p> <p>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.</p> <p>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.</p> <p>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!</p> <p>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.</p> <pre><code>Personalised Messages &amp; 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.\n</code></pre> <p>Thanks Allowance Control how often a Thanks badge may be awarded to add more value and create a greater impact.</p> <pre><code>Social Recognition &amp; 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.\n</code></pre>"},{"location":"badges/#huddo-groups","title":"Huddo Groups","text":"<p>Huddo Groups allows administrators to group users.</p> <p>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!</p>"},{"location":"badges/#connections-activity-stream-integration","title":"Connections Activity Stream Integration","text":"<p>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 &amp; Like on Awarded Badges and Thanks.</p> <p><pre><code>Awarded Badges\n</code></pre> <pre><code>All 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.\n</code></pre></p> <p>Huddo News Gadget</p> <p>From the Huddo News Gadget users can now Like and Comment on Huddo Activity Stream Entries.</p> <p>Liking Huddo Entries</p> <p>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.</p> <p>Commenting on Huddo Entries</p> <p>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.</p> <p>Recent Updates</p> <p>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!</p> <p>Thanks Given</p> <p>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.</p> <p>Thanks Email Notifications</p> <p>Users receiving Thanks will also be notified by email. Details about the Thanks, including the personal message of recognition, are included in this email.</p>"},{"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":"<p>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 -&gt; Huddo. These will be available as the defaults in the rebranded version of Huddo Badges but existing clients can update these now.</p>"},{"location":"badges/update-images/#load-updated-images","title":"Load Updated Images","text":"<p>Download the updated Huddo Images</p> <p>Login to Connections and navigate to the Badges Configurator Community</p> <p>Select the Settings tab in the BadgesConfigurator widget, scroll to the bottom and click the 'Import' button</p> <p></p> <p>Select the downloaded images.zip file and select 'Overwrite Customisations', then 'Upload'</p> <p></p> <p>You will get a prompt indicating that 281 records will be updated, press 'OK'</p> <p>The images will now be updated.</p>"},{"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":"<p>Ensure SSL certificates correctly imported to the ISC &amp; trust chain valid</p>"},{"location":"badges/websphere-faq/#images-do-not-work","title":"Images do not work","text":"<p>Please go to the BadgesConfigurator-&gt;Settings tab then restart the Huddo Application.</p>"},{"location":"badges/websphere-faq/#news-gadget-icon-not-showing-after-updating-url","title":"News Gadget Icon not showing after updating URL","text":"<p>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.</p>"},{"location":"badges/install/","title":"Installation","text":"<p>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.</p> <p>The install process for Huddo involves the following steps:</p> <ul> <li>Install the Huddo Application</li> <li>Define widgets</li> <li>Install Huddo Mobile (Optional)</li> <li>Apply changes</li> <li>Add Widgets to Connections interface</li> <li>Community Widget Properties</li> <li>Upload your Licence file</li> <li>Import Default Badges</li> <li>Make the Leaderboard Widget enabled by Default</li> <li>Set Award Permissions</li> <li>Run the Badge Engine to Award the Badges</li> <li>Customising</li> </ul> <p>Please Note: These steps are only applicable to a new install of Huddo. For information about upgrading, please see the Huddo Update Guide.</p>"},{"location":"badges/install/customising/","title":"Customising","text":""},{"location":"badges/install/customising/#customising-huddo-strings-properties-images-optional","title":"Customising Huddo Strings, Properties &amp; Images (Optional)","text":"<p>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.</p>"},{"location":"badges/install/customising/#customising-huddo-strings","title":"Customising Huddo Strings","text":"<p>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.</p> <p>Please Note:</p> <ul> <li>These files are in JSON format and it is critical that the syntax of these files is valid for the customisation to take effect.</li> <li> <p>This step can be performed at any stage after the installation and is not required to complete the installation.</p> <ol> <li>Create a folder called HuddoStrings in the directory given by the PROFILES_STATS_DIR WebSphere Variable.</li> <li>Create a text file called UserInterfaceLang.js in the HuddoStrings directory.</li> <li>Open the default UserInterfaceLang.js file from the location <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultLang/</li> <li>Add the strings you wish to customise to the newly created UserInterfaceLang.js file from the original file while maintaining a similar format.     e.g.: below is a sample customised UserInterfaceLang.js file which overwrites 7 properties:</li> </ol> </li> </ul> <p><pre><code>{\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}\n</code></pre> Note: only add the strings you wish to customise as this procedure will overwrite the existing strings for all other languages with the provided values.</p> <p>If you wish to add specific customisations for different languages:</p> <ol> <li>Create a sub-folder with the locale name within the HuddoStrings directory (See List of Language Codes)</li> <li>Create a language specific version of UserInterfaceLang.js file as per Steps 3 &amp; 4 above.</li> <li>Place it in the locale sub-folder.</li> </ol> <p>Example:</p> <pre><code>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\n</code></pre> <ol> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol>"},{"location":"badges/install/customising/#customising-huddo-properties","title":"Customising Huddo Properties","text":"<p>The 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.</p> <p>Available properties files to customise:</p> <ul> <li>applicationConfig.js \u2013 Context roots for Connections &amp; Huddo</li> <li>messages.properties \u2013 Strings used in Huddo emails &amp; Activity Stream entries</li> <li>resource.properties \u2013 Miscellaneous settings, i.e. database aliases etc.</li> </ul> <p>Please Note:</p> <ul> <li>These files are in JSON format and it is critical that the syntax of these files is valid for the customisation to take effect.</li> <li>This step can be performed at any stage after the installation and is not required to complete the installation.<ol> <li>Create a folder called HuddoProperties in the directory given by the PROFILES_STATS_DIR Websphere Variable.</li> <li>Copy the property file(s) to be edited into the HuddoProperties folder from the location    <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultProperties/</li> <li>Open the HuddoProperties folder\u2019s newly copied files and edit the properties as required before saving.</li> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol> </li> </ul>"},{"location":"badges/install/customising/#customising-huddo-images","title":"Customising Huddo Images","text":"<p>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.</p> <p>Please Note:</p> <ul> <li> <p>This step can be performed at any stage after the installation and is not required to complete the installation.</p> <ol> <li> <p>Determine the image(s) to be customised in the HuddoImages folder from the location    <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultImages/</p> <pre><code>Common files customised include:\n    kudos_stream.png (as seen in the Homepage Activity Stream)\n    mobile_`&lt;MOBILE_DEVICE&gt;`.png (i.e. mobile_android.png etc \u2013 as seen for Huddo mobile)\n</code></pre> </li> <li> <p>Create a folder called HuddoImages in the directory given by the PROFILES_STATS_DIR Websphere Variable.</p> </li> <li>Place a copy of the custom image into the HuddoImages folder with the same name as the image file you wish to overwrite.</li> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol> </li> </ul>"},{"location":"badges/install/embedded-exp/","title":"Embedded exp","text":""},{"location":"badges/install/embedded-exp/#install-huddo-embedded-experience-into-notesinotes-9-optional","title":"Install Huddo Embedded Experience into Notes/iNotes 9 (Optional)","text":"<p>The Huddo Embedded Experience is installed in the same manner as the default Connections Embedded Experience Gadget &amp; the Activity Stream Gadget.</p> <p>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.</p> <p>For Connections 4 CR2 and earlier the process is manual (overview).</p> <ol> <li>Make sure an OAuth client exists for Domino in Connections (link)</li> <li>Create the Huddo OpenSocial Widget in Notes (link) using the gadget URL: https:///Huddo/HuddoNewsGadget.xml and publish it to the     IBM Notes Widget Catalog. Note : You must replace  with the URL of your Connections environment. <li>Approve the Huddo Widget to the Catalog with the necessary proxy and OAuth data (link)</li>"},{"location":"badges/install/mobile/","title":"Mobile","text":"<p>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.</p>"},{"location":"badges/install/mobile/#check-out-the-mobile-configxml-file","title":"Check out the mobile-config.xml file","text":"<p>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.</p> <p>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.</p>"},{"location":"badges/install/mobile/#edit-the-mobile-configxml","title":"Edit the mobile-config.xml","text":"<p>Then proceed to add the following Application definition under the <code>&lt;Applications&gt;</code> node</p> <pre><code>&lt;Application name=\"Huddo\" enabled=\"true\"&gt;\n    &lt;ApplicationIcon&gt;\n        &lt;Android&gt;\n            &lt;Hdpi&gt; **../../** Huddo/images/mobile_android.png&lt;/Hdpi&gt;\n            &lt;Mdpi&gt; **../../** Huddo/images/mobile_android.png&lt;/Mdpi&gt;\n            &lt;Ldpi&gt; **../../** Huddo/images/mobile_android.png&lt;/Ldpi&gt;\n        &lt;/Android&gt;\n        &lt;IOS&gt;\n            &lt;Reg&gt; **../../** Huddo/images/mobile_iOS.png&lt;/Reg&gt;\n            &lt;Retina&gt; **../../** Huddo/images/mobile_iOS.png&lt;/Retina&gt;\n        &lt;/IOS&gt;\n        &lt;DefaultLocation&gt; **../../** Huddo/images/mobile_default.png&lt;/DefaultLocation&gt;\n    &lt;/ApplicationIcon&gt;\n    &lt;ApplicationLabel&gt;Huddo Badges&lt;/ApplicationLabel&gt;\n    &lt;ApplicationURL&gt;http://&lt;YOUR_CONNECTIONS_SERVER&gt;/Huddo/mobile&lt;/ApplicationURL&gt;\n&lt;/Application&gt;\n</code></pre> <p>Add the following to the <code>&lt;ApplicationList&gt;</code> or <code>DefaultNavigationOrder</code> node: Huddo.</p> <p>The result should be similar to: <code>&lt;ApplicationsList&gt;profiles,communities,files,wikis,activities,forums,blogs,bookmarks,Huddo&lt;/ApplicationsList&gt;</code> or <code>&lt;DefaultNavigationOrder&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Huddo&lt;/DefaultNavigationOrder&gt;</code></p> <p>Please Note: Make sure you replace <code>&lt;YOUR_CONNECTIONS_SERVER&gt;</code> 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.</p>"},{"location":"badges/install/mobile/#check-in-the-mobile-configxml-file","title":"Check in the mobile-config.xml file","text":"<p>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.</p> <p>Note: the configuration file must be checked in during the same wsadmin session in which it was checked out.</p>"},{"location":"badges/install/add-widgets/","title":"Add Widgets","text":"<p>So far, you have configured the location of the Huddo widgets. You will now add the widgets to the user interface.</p>"},{"location":"badges/install/add-widgets/#add-the-configurators-widgets-to-their-communities","title":"Add the Configurators Widgets to their Communities","text":"<p>Login to Connections and navigate to the previously created Badges Configurator Community</p> <ol> <li> <p>Click Community Actions then 'Add Apps' from the drop down menu</p> <p></p> </li> <li> <p>Select the Configurator(s) to add to the Community</p> <p></p> </li> <li> <p>Click X</p> </li> </ol> <p>The Configurators will now be added to the main view.</p> <p>Repeat the above steps for each configurator community you created.</p> <p>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.</p>"},{"location":"badges/install/add-widgets/#remove-the-default-widgets-optional","title":"Remove the Default Widgets (Optional)","text":"<p>Click the Actions drop-down and select Delete     </p> <p>Fill in the required data then click Ok on the Delete prompt     </p>"},{"location":"badges/install/add-widgets/#add-the-huddo-analytics-widget-to-communities","title":"Add the Huddo Analytics Widget to Communities","text":"<p>Login to Connections and navigate to the Huddo Analytics Community</p> <p>Click Community Actions then 'Add Apps' from the drop down menu</p> <p></p> <p>Select HuddoAnalytics</p> <p></p> <p>Click X</p> <p>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.</p> <p>Your first Huddo Analytics widget will now be added to the main view.</p> <p>The default view shows the report categories. Once a report category is selected, default report instances for that category can be selected.</p> <p>Once the report instance is selected, further options for that report can be selected.</p> <p>The report currently configured is previewed below the options and can be saved for quick viewing on all subsequent page loads.</p> <p>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.</p> <p>Multiple Huddo Analytics widgets are designed to exist in each community.</p>"},{"location":"badges/install/add-widgets/#add-the-widgets-to-the-home-page","title":"Add the Widgets to the Home page","text":"<p>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.</p> <p>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.</p> <p>Adding widgets to the Home page of Connections is done through the Connections Web page. </p> <p>Login to Connections as a user assigned to the admin security role of the Homepage application and navigate to the Administration tab.</p> <p>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.</p> <p></p> 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://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/RankingDisplay.xml False False True True False profiles News Gadget Open Social Gadget Huddo News Gadget https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/HuddoNewsGadget.xml True False False True False oauthprovider, oauth, opensocial, webresources Awarder iWidget Huddo Awarder https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/HuddoAwarder.xml False True False False False - User Analytics iWidget Huddo User Analytics https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/AnalyticsDashboard.xml False True False False True - <p>For the Open Social Gadget, select the following:</p> <ul> <li>Open Social Gadget</li> <li>Trusted and Use SSO</li> <li>Show for Activity Stream events</li> <li>All servers</li> </ul> <p>Click the Add Mapping button.</p> <ul> <li>Add a Mapping for the Huddo service to the Huddo client. Ensure OAuth Client is set to Huddo and the Service name is Huddo.</li> </ul> <p>Highlight each Huddo widget individually in the Disabled widgets section and click Enable</p> <p>The Huddo widgets will now show in the Enabled widgets list.</p> <p>It will also show on the Updates and Widgets tabs, if these options were selected.</p>"},{"location":"badges/install/add-widgets/#add-the-huddo-awarder-widget-to-my-page","title":"Add the Huddo Awarder Widget to My Page","text":"<p>Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.</p> <p>Open My Page through the Sidebar link or Home button and select Customize</p> <p></p> <p>Select Huddo Awarder. If you cannot find it, look under the 'Other' category.</p> <p></p> <p>Click X</p> <p>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.</p>"},{"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":"<p>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.</p> <p>Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.</p> <p>Open My Page through the Sidebar link or Home button and select Customize</p> <p></p> <p>Select Huddo User Analytics. If you cannot find it, look under the 'Other' category.</p> <p></p> <p>Click X</p> <p>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.</p> <p>Multiple Huddo User Analytics widgets are designed to exist on My Page.</p>"},{"location":"badges/install/app/","title":"WebSphere Application","text":"<p>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 &amp; Analytics engines that drives the reward and recognition of user performance, as well as the widgets for user interaction.</p>"},{"location":"badges/install/app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"<p>Login to the WebSphere Integrated Solution Console for your Connections environment via a webbrowser.</p> <p>Enter your administrator User ID and Password, then click the \u201cLog in\u201d button.</p> <p></p>"},{"location":"badges/install/app/#install-the-huddowar-file","title":"Install the Huddo.war file","text":"<p>Navigate to Applications \u2192 Application Types \u2192 WebSphere enterprise applications</p> <p></p> <p>Click the Install button</p> <p></p> <p>Browse the Local File System Path for the downloaded Huddo.war file then Click Next</p> <p></p> <p>Check the Fast Path Option then Click Next</p> <p></p> <p>Change the Application name to Huddo then Click Next</p> <p></p> <p>Highlight the Nodes for the Application, including the IHS Node. Select the Badges Module, click Apply then Next.</p> <p>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 &gt; Clusters &gt; WebSphere application server clusters and then clicking New.</p> <p></p> <p>Click on Browse and map the default resources as shown. Click Next.</p> <p></p> <p>Enter Huddo as the Context Root, then click Next.</p> <p>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.</p> <p></p> <p>Review the Installation Summary. Click Finish.</p> <p></p> <p>Review the Installation Results. Click Save.</p> <p></p> <p>Review the Synchronisation Summary. Click OK.</p> <p>You have now successfully installed Huddo as a WebSphere Enterprise Application. Next, you will need to edit the security settings.</p>"},{"location":"badges/install/app/#modify-the-huddo-application-security-role-assignments","title":"Modify the Huddo Application Security Role assignments","text":"<p>During this step, we will be defining the authenticated users/groups for each Security Role.</p> <p>Find Huddo in the list of enterprise applications and click on Huddo to open the application configuration screen</p> <p></p> <p>Click Security role to user/group mapping</p> <p></p> <p>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</p> <p>Please note: You may set the Reader role to Everyone to grant read-only access to Huddo widget data to unauthenticated users.</p> <p></p>"},{"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":"<p>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.</p> <p>Navigate to Security \u2192 SSL certificate and key management and then select Key stores and certificates</p> <p></p> <p>Select CellDefaultTrustStore</p> <p></p> <p>Select Signer certificates</p> <p></p> <p>You will now see a list of all trusted certificates.</p> <p>If the URL of your Connections Environment is listed, skip to Add Huddo Related Strings to Connections</p> <p>We will now import the public certificate from the IBM HTTP Server to the default trust store in IBM WebSphere Application Server</p> <p>Click Retrieve from port</p> <p></p> <p>Enter the following details of the web server, then click Retrieve Signer Information:</p> <ul> <li>Host (e.g. connections.company.com)</li> <li>SSL Port (443)</li> <li>Alias</li> </ul> <p></p> <p>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.</p>"},{"location":"badges/install/app/#add-huddo-related-strings-to-connections","title":"Add Huddo Related Strings to Connections","text":"<p>This change will not be picked up by Connections until the servers are restarted. This will be performed at the end of the configuration.</p> <p>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 <p>IMPORTANT: If a file of the same name already exists, merge the contents into the existing file.</p> <p></p>"},{"location":"badges/install/apply-changes/","title":"Apply Changes","text":"<p>The clusters must be restarted for the widget &amp; mobile configuration changes to take effect.</p>"},{"location":"badges/install/apply-changes/#restart-the-clusters","title":"Restart the Clusters","text":"<p>Login to the Integrated Solution Console</p> <p>Navigate to Servers \u2192 Clusters \u2192 WebSphere Application Server Clusters</p> <p>Select all of the Connections Clusters</p> <p>Click Ripplestart.</p> <p></p>"},{"location":"badges/install/awards/","title":"Awards","text":"<p>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.</p>"},{"location":"badges/install/awards/#create-groups-for-access-control-via-the-badge-configurator","title":"Create groups for access control via the Badge Configurator","text":"<p>Open the User Groups Tab in the Badges Configurator widget and create groups required to set access control permissions for Awards.</p> <p>Groups can now be created by selecting people, Communities, other groups, importing a CSV file of emails or advanced profile attributes.</p> <p>Examples:</p> <ul> <li>Create a Management Group to award the Employee of the year Award</li> <li>A Sales Group to add as the Awardees to the Salesman of the Year Award; etc.</li> </ul> <p></p>"},{"location":"badges/install/awards/#set-the-access-groups-for-each-of-the-awards","title":"Set the access groups for each of the Awards","text":"<p>Open the Awards Tab in the Badges Configurator widget and for each of the Award definitions listed in the table perform the following steps:</p> <ol> <li>Click on the Award definition to open it for editing.</li> <li> <p>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?</p> <p>Note : Users selected in this step will need to add the Huddo Awarder widget to their widgets page as per</p> </li> <li> <p>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.</p> <p>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.</p> </li> <li> <p>Click Save to save your changes.</p> </li> </ol> <p></p>"},{"location":"badges/install/comm-properties/","title":"Community Properties","text":""},{"location":"badges/install/comm-properties/#step-6-additional-properties-for-communities-widgets-optional","title":"Step 6: Additional properties for Communities Widgets (OPTIONAL)","text":"<p>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.</p> <p></p> <p>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.</p> <p>Checkout and edit the widgets-config.xml file:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p> <p>Locate the Configuration Widget definitions under the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>Add the attribute <code>showInPalette=\"false\"</code> 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.</p> <p>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.</p> <p>Your configuration should now look like this:</p> <pre><code>&lt;widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"MetricsConfigurator\" description=\"metricsConfigurator\" modes=\"view fullpage\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/MetricsConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_METRICS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"FiltersConfigurator\" description=\"filtersConfigurator\" modes=\"view fullpage\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/FiltersConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_FILTERS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoCommunity\" modes=\"view\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/CommunityRankingDisplay.xml\" themes=\"wpthemeNarrow wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"communityId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>Check in the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p> <p>Then Restart the clusters.</p>"},{"location":"badges/install/engine/","title":"Engine","text":"<p>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.</p>"},{"location":"badges/install/engine/#award-badges-now","title":"Award Badges Now","text":"<p>Login to Connections and navigate to the Badges Configurator Community</p> <p>Select the Settings tab in the BadgesConfigurator widget</p> <p>Click the Award Badges Now button.</p> <p>Note: If you are installing Huddo Badges to a Connections environment for testing purposes, it is recommended that the following settings are disabled:</p> <ul> <li>Enable Email Notifications for Badges/Awards</li> <li>Enable Email Notifications for Thanks</li> </ul> <p></p>"},{"location":"badges/install/install-widgets/","title":"Widgets","text":"<p>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.</p>"},{"location":"badges/install/install-widgets/#create-the-configurator-communities","title":"Create the Configurator Communities","text":"<p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p> <ol> <li> <p>Login to Connections, navigate to Communities and click Create a Community</p> <p></p> </li> <li> <p>Enter a name, such as Badges Configurator</p> </li> <li> <p>Set Access to Restricted</p> </li> <li> <p>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.</p> </li> <li> <p>Enter any tags, web address and description you wish then click Save.</p> <p></p> </li> </ol> <p>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.</p> <p>You have now created the first Huddo Configurator Community.</p> <p>Take note of the CommunityUUID in the URL address, as we will need this later.</p> <p>Please repeat the above steps for the Metrics &amp; 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</p>"},{"location":"badges/install/install-widgets/#create-the-huddo-analytics-administrator-community","title":"Create the Huddo Analytics Administrator Community","text":"<p>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.</p> <ol> <li> <p>Login to Connections, navigate to Communities and click Start a Community.</p> <p></p> </li> <li> <p>Enter a name, such as Huddo Analytics.</p> </li> <li> <p>Set Access to Restricted.</p> </li> <li> <p>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.</p> </li> <li> <p>Enter any tags, web address and description you wish and click Save.</p> <p></p> </li> </ol> <p>You have now created the Huddo Analytics Administrator Community.</p> <p>Take note of the CommunityUUID in the URL address, as we will need this later.</p>"},{"location":"badges/install/install-widgets/#check-out-the-widgets-configxml-file","title":"Check out the widgets-config.xml file","text":"<p>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.</p> <p>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.</p> <p>Checking Out the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p>"},{"location":"badges/install/install-widgets/#configure-the-profile-widgets","title":"Configure the Profile Widgets","text":"<p>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.</p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"profiles\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>IMPORTANT: Don\u2019t forget to substitute the following placeholders with the corresponding values! CONNECTIONS_SERVER_NAME</p> <pre><code>&lt;widgetDef defId=\"HuddoSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgeSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n    &lt;item name=\"NumberBadges\" value=\"12\"/&gt;\n    &lt;item name=\"BadgeViewAllWidgetId\" value=\"HuddoBadges\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoBadges\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgeViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"NumberBadges\" value=\"0\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"ProfileProgress\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ProfileProgress.xml\" modes=\"view\" themes=\"wpthemeNarrow\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"ThanksSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ThanksSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"NumberThanks\" value=\"12\"/&gt;\n        &lt;item name=\"ThanksWidgetId\" value=\"HuddoThanks\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"AwardSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AwardSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"NumberBadges\" value=\"12\"/&gt;\n        &lt;item name=\"AwardViewAllWidgetId\" value=\"HuddoAwards\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoAwards\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AwardViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoThanks\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ThanksViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>We 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.</p> <p>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:</p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"profiles\" ... &gt;</code>, then under <code>&lt;layout ...  resourceSubType=\"default\" ... &gt;</code>, then within <code>&lt;page ... pageId=\"profilesView\" ... &gt;</code> add the following:</p> <pre><code>&lt;widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoBadges\"/&gt;\n&lt;widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoThanks\"/&gt;\n&lt;widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoAwards\"/&gt;\n&lt;widgetInstance uiLocation=\"col1\" defIdRef=\"ProfileProgress\"/&gt;\n&lt;widgetInstance uiLocation=\"col3\" defIdRef=\"HuddoSummary\"/&gt;\n&lt;widgetInstance uiLocation=\"col3\" defIdRef=\"ThanksSummary\"/&gt;\n&lt;widgetInstance uiLocation=\"col3\" defIdRef=\"AwardSummary\"/&gt;\n</code></pre> <p>The 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 &amp; 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.</p> <p></p>"},{"location":"badges/install/install-widgets/#configure-configurators-and-community-leaderboard-widgets","title":"Configure Configurators and Community Leaderboard Widgets","text":"<p>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.</p> <p>You must define the Widgets and where to find their associated .xml files. You will need the CommunityUuids you took note of earlier.</p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>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</p> <pre><code>&lt;widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"MetricsConfigurator\" description=\"metricsConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/MetricsConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_METRICS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"FiltersConfigurator\" description=\"filtersConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/FiltersConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_FILTERS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoAnalytics\" description=\"HuddoAnalytics\" modes=\"view edit\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AnalyticsDashboard.xml\" uniqueInstance=\"false\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"adminCommunityId\" value=\"YOUR_ANALYTICS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoCommunity\" modes=\"view\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/CommunityRankingDisplay.xml\" showInPalette=\"false\" themes=\"wpthemeNarrow wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"communityId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>We 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.</p> <p>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:</p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;layout ... resourceSubType=\"default\" ... &gt;</code>, then within <code>&lt;page ... pageId=\"communityOverview\" ... &gt;</code> add the following:</p> <pre><code>&lt;widgetInstance uiLocation=\"col3\" defIdRef=\"HuddoCommunity\"/&gt;\n</code></pre>"},{"location":"badges/install/install-widgets/#check-in-the-widgets-configxml-file","title":"Check in the widgets-config.xml file","text":"<p>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.</p> <p>Checking In the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p>"},{"location":"badges/install/install-widgets/#register-widgets-connections-60-cr1-onwards","title":"Register Widgets (Connections 6.0 CR1 onwards)","text":"<p>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.</p>"},{"location":"badges/install/install-widgets/#add-huddo-configuration-jsp-to-the-header","title":"Add Huddo configuration JSP to the header","text":"<p>(And add \u2018Give Thanks\u2019 Link in the navigation bar - Optional)</p> <p>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</p> <p>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:</p> <p>This is achieved by customising the header.jsp file, used for customizing the Connections Navigation bar.</p> <p>If you have not customised the header.jsp file for your connections environment, please make a copy of the file from:</p> <p><code>&lt;WAS_home&gt;</code>/profiles/<code>&lt;profile_name&gt;</code>/installedApps/<code>&lt;cell_name&gt;</code>/Homepage.ear/homepage.war/nav/templates</p> <p>Paste the copy into the common\\nav\\templates subdirectory in the customization directory: <code>&lt;installdir&gt;</code>\\data\\shared\\customization\\common\\nav\\templates\\header.jsp</p> <p>Edit the header.jsp file in the customisations directory add the following lines after the Moderation link and before the <code>&lt;/ul&gt;</code> HTML tag as shown:</p> <p></p> <p>To add the Huddo Config JSP</p> <pre><code>--%&gt;&lt;c:if test=\"${'communities' == appName || 'homepage' == appName || 'profiles' == appName}\"&gt;&lt;%--\n    --%&gt;&lt;c:catch var=\"e\"&gt;&lt;c:import var=\"kudosConfig\" url=\"http://${pageContext.request.serverName}/Kudos/kudosConfig.jsp\"/&gt;&lt;/c:catch&gt;&lt;%--\n    --%&gt;&lt;c:if test=\"${empty e}\"&gt;&lt;script type=\"text/javascript\"&gt;${kudosConfig}&lt;/script&gt;&lt;/c:if&gt;&lt;%--\n--%&gt;&lt;/c:if&gt;&lt;%--\n</code></pre> <p>To add the Give Thanks link \u2013 This step is OPTIONAL</p> <pre><code>--%&gt;&lt;script type=\"text/javascript\" src=\"/Huddo/scripts/widgets/ThanksAwarderHeader.js\" charset=\"utf-8\"&gt;&lt;/script&gt;&lt;%--\n--%&gt;&lt;li id=\"lotusBannerThankSomeone\"&gt;&lt;a href=\"javascript:giveThanks('${urlProfiles}');\"&gt;&lt;fmt:message key=\"label.header.kudos.givethanks\"/&gt;&lt;/a&gt;&lt;/li&gt;&lt;%--\n</code></pre> <p>Save and close the file, the changes will take effect when the clusters are restarted. (See next task)</p>"},{"location":"badges/install/install-widgets/#specify-huddo-analytics-admin-community-for-security","title":"Specify Huddo Analytics Admin Community for Security","text":"<p>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.</p> <p>Create the resource.properties file in the Profiles Statistics customisation directory: <code>&lt;PROFILES_STATS_DIR&gt;</code>/HuddoProperties Where PROFILES_STATS_DIR is defined by the WebSphere variable: e.g. /opt/IBM/Connections/data/shared/profiles/statistics/HuddoProperties</p> <p>Put the following line in the file, replacing <code>&lt;KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID&gt;</code> with the ID of the Huddo Analytics Community created in Task 2.4:</p> <pre><code>analyticsAdminCommunityID=&lt;KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID&gt;\n</code></pre> <p>IMPORTANT: If a file of the same name already exists, merge the contents into the existing file.</p>"},{"location":"badges/install/leaderboard/","title":"Leaderboard","text":"<p>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.</p>"},{"location":"badges/install/leaderboard/#add-leaderboard-to-homepage","title":"Add Leaderboard to Homepage","text":"<p>Login to Connections and navigate to the Badges Configurator Community</p> <p>Select the Settings tab in the BdagesConfigurator widget</p> <p>Click the Add Leaderboard to Users Homepage button</p> <p>For the proceeding prompt boxes:</p> <ul> <li>Enter position for Leaderboard:     Specify the Leaderboard\u2019s position numerically or leave as default, click OK.</li> <li>Enter name of Leaderboard:     Specify the Leaderboard\u2019s name or leave as default, click OK.</li> </ul> <p></p>"},{"location":"badges/install/licence/","title":"Licence","text":"<p>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 </p>"},{"location":"badges/install/licence/#upload-your-licence-file-in-the-badges-configurator","title":"Upload your licence file in the Badges Configurator","text":"<p>Login to Connections Navigate to the Badges Configurator Community.</p> <p>Select the Settings tab in the BadgesConfigurator widget. If there are no tabs, this is the default view.</p> <p>Click the Update Licence button.</p> <p></p> <p>Click Choose File and browse to your Huddo.licence file and click Upload.</p> <p></p>"},{"location":"badges/install/load-defaults/","title":"Defaults","text":"<p>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.</p>"},{"location":"badges/install/load-defaults/#load-defaults","title":"Load Defaults","text":"<p>Login to Connections and navigate to the Badges Configurator Community</p> <p>Select the Settings tab in the BadgesConfigurator widget, scroll to the bottom and click the 'Load Defaults' button</p> <p></p> <p>Select:</p> <ul> <li>Badges_Achiever</li> <li>Badges_Culture</li> <li>Badges_Loyalty</li> <li>Badges_Thanks (or) Thanks</li> <li>Badges_Profiles</li> <li>Badges_Superstar</li> <li>Profile_Progress</li> <li>Images</li> <li>Filters</li> <li>Metrics</li> <li>Structure</li> <li>any other Badge Categories you wish to install (most installations would select all)</li> </ul> <p>Note: You will need to have the corresponding Connections Applications installed. As well as have a Standard or Enterprise Licence for Huddo.</p> <p></p> <p>Click Save</p> <p>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.</p>"},{"location":"badges/update/","title":"Update","text":"<p>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.</p> <p>The update process for Huddo involves the following steps:</p> <p>Update the Huddo Application in Websphere Application Server</p> <p>Refresh the Widget Cache</p> <ul> <li>If your Huddo application utilises a Custom Context Root in the WebSphere Application Server, then follow Installation Guide Step 11 to make necessary     modifications for default properties.</li> </ul> <p>Please Note: The Huddo update guide assumes that the Huddo application in the WebSphere Application server is using the Context Root <code>/Huddo</code>. If the Context Root has been set to something other than <code>/Huddo</code>, then make sure that you replace <code>/Huddo</code> with your Context Root when entering any URLs specified in this document.</p>"},{"location":"badges/update/refresh_cache/","title":"Refresh Widget Cache","text":"<p>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.</p> <p>Access the Homepage -&gt; 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.</p> <p></p> <p>In order to access Administration section, please ensure the logged in user is in the Homepage \u2018admin\u2019 security role.</p>"},{"location":"badges/update/update_app/","title":"Update the Application","text":"<p>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.</p>"},{"location":"badges/update/update_app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"<p>Login to the WebSphere Integrated Solution Console for your Connections environment via a web browser.</p> <p></p>"},{"location":"badges/update/update_app/#replace-the-huddowar-file","title":"Replace the Huddo.war file","text":"<p>Navigate to Applications -&gt; Application Types -&gt; WebSphere enterprise applications</p> <p></p> <p>Select the Huddo application and click Update.</p> <p></p> <p>Select Replace or add a single module option.</p> <p>Type in Huddo.war in the text field. Note: This is case-sensitive!</p> <p>Click Browse, navigate to and select the new Huddo.war file.</p> <p></p> <p>Follow the prompts clicking Next.</p> <p>If prompted, click Browse and map the default resources as shown.</p> <p></p> <p>Follow the prompts clicking Next.</p> <p>Click Finish.</p> <p>Click Save directly to master configuration.</p> <p>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.</p>"},{"location":"badges/update/update_app/#synchronize-the-nodes","title":"Synchronize the nodes","text":"<p>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.</p> <p>Go to System Administration &gt; Nodes.</p> <p>Select the node that Huddo is installed on. (If you are unsure you may select all the nodes)</p> <p>Click on Full Resynchronize and wait for the completion message.</p> <p></p>"},{"location":"badges/update/update_app/#restart-the-huddo-application","title":"Restart the Huddo Application","text":"<p>Go to Applications &gt; WebSphere Enterprise Applications</p> <p>Select the Huddo Application Checkbox.</p> <p>Click Stop and wait for the Application Status column to display the Stopped icon.</p> <p>Select the Huddo Application Checkbox.</p> <p>Click Start and wait for the Application Status column to display the Started icon.</p> <p></p>"},{"location":"badges/update/updatev6tov7/","title":"Updatev6tov7","text":"<p>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.</p>"},{"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":"<p>Open the Administration tab (on the Homepage) and browse to the Enabled Widgets list. For each Kudos Widget listed, select it and edit.</p> <p></p> OLD Widget Title OLD URL Address NEW Widget Title NEW URL Address Leaderboard Kudos Leaderboard https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Kudos/RankingDisplay.xml Huddo Leaderboard https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/RankingDisplay.xml News Gadget Kudos News Gadget https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Kudos/KudosNewsGadget.xml Huddo News Gadget https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/HuddoNewsGadget.xml Awarder Kudos Awarder https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Kudos/KudosAwarder.xml Huddo Awarder https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/HuddoAwarder.xml User Analytics Kudos User Analytics https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Kudos/AnalyticsDashboard.xml Huddo User Analytics https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/AnalyticsDashboard.xml"},{"location":"badges/update/updatev6tov7/#profile-community","title":"Profile &amp; 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":"<p>Note</p> <p>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.</p>"},{"location":"boards/","title":"Huddo Boards","text":""},{"location":"boards/#versions","title":"Versions","text":"<p>We are proud to say that Huddo Boards is able to run in many configurations to suit your individual requirements.</p> <ol> <li>Boards Cloud</li> <li>Boards Self-Hosted (On-Premise)<ul> <li>HCL Connections Component Pack</li> <li>Kubernetes</li> <li>Docker - All In One</li> </ul> </li> <li>Boards Hybrid (Boards Cloud integrated with On-Premise)</li> </ol>"},{"location":"boards/#quick-links","title":"Quick Links","text":"<ol> <li>Boards Cloud - Recent Updates</li> <li>On-Premise - Latest Releases</li> <li> <p>Huddo Boards for</p> <ul> <li>HCL Connections</li> <li>HCL Domino</li> <li>HCL Digital Experience (DX)</li> </ul> </li> </ol>"},{"location":"boards/#how-to-decide-which-version","title":"How To Decide Which Version?","text":""},{"location":"boards/#boards-cloud","title":"Boards Cloud","text":"<p>This version is hosted by the ISW Huddo team at https://boards.huddo.com. Free trials are available!</p> <p>Advantages</p> <ul> <li>Hosted and managed by Team Huddo</li> <li>Always up to date with the latest functionality</li> <li>Backup strategies already in place</li> </ul> <p>See here for more information.</p>"},{"location":"boards/#boards-self-hosted-on-premise","title":"Boards Self-Hosted (On-Premise)","text":"<p>Our Boards Cloud product, installed locally in your infrastructure</p> <p>Advantages</p> <ul> <li>Can be installed in any existing Kubernetes environment (ie HCL Connections Component Pack)</li> <li>Can use the same Component Pack Mongo database</li> <li>Control over your own data and backup strategies</li> <li>Simple to update</li> </ul> <p>See install details for Kubernetes or HCL Connections Component Pack.</p>"},{"location":"boards/#boards-hybrid","title":"Boards Hybrid","text":"<p>(Cloud integrated with HCL Connections On-Premise.)</p> <p>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.</p> <p>Advantages</p> <ul> <li>All of the benefits of the Cloud above (hosted, managed, backed up)!!</li> <li>Integrates into your existing HCL Connections On-Premise (WebSphere)</li> <li> <p>Looks and feels like another application similar to Communities/Blogs etc with:</p> <ul> <li>Connections Apps menu link to 'Huddo Boards'</li> <li>Connections header</li> <li>Search and collaborate with your existing users</li> <li>Search and utilise your existing Communities</li> <li>Updates posted to your Activity Streams (Homepage, Social, Community)</li> <li>Ability to import existing Activities into Boards</li> </ul> </li> </ul> <p>Requirements</p> <ul> <li>Your HCL Connections URL must be accessible from the web (no VPN)</li> </ul> <p>See installation details for more information.</p> <p>Browser Support</p> <p>We support the most recent two versions of the following browsers:</p> <ul> <li>Chrome</li> <li>Safari</li> <li>Firefox</li> <li>Microsoft Edge</li> </ul>"},{"location":"boards/compatibility/","title":"Compatibility with Huddo Boards Docker","text":""},{"location":"boards/compatibility/#known-compatible","title":"Known Compatible","text":"<p>Huddo Boards Docker has been tested and confirmed working with the following versions</p> Minimum Maximum Kubernetes <code>v1.16</code> <code>v1.27.7</code> MongoDB <code>v4.0</code> <code>v7.0.4</code> Redis <code>v4.0</code> <code>v6.x</code>"},{"location":"boards/compatibility/#known-incompatible","title":"Known Incompatible","text":""},{"location":"boards/compatibility/#azure-cosmos-db","title":"Azure Cosmos DB","text":"<p>Issue</p> <p>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;</p> <p>https://feedback.azure.com/d365community/idea/3ddf6028-0f25-ec11-b6e6-000d3a4f0858</p> <p>https://feedback.azure.com/d365community/idea/ad9a64e6-0e25-ec11-b6e6-000d3a4f0858</p> <p>Suggestion</p> <p>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.</p> <p>Please contact us at support@huddo.com if you need further information.</p>"},{"location":"boards/helm-charts-kudos/","title":"Helm Chart History (Deprecated)","text":"<p>Warning</p> <p>These charts are deprecated. Please see the new charts</p> <p>Release notes for each Helm chart utilised by Boards (for Component Pack vs standalone, and Activity Migration)</p>"},{"location":"boards/helm-charts-kudos/#standalone-kubernetes","title":"Standalone Kubernetes","text":""},{"location":"boards/helm-charts-kudos/#kudos-boards","title":"kudos-boards","text":"<ul> <li>4.0.0 - Load Balancer (no cote), LivenessProbes, StartupProbes, Rename balancer dns defaults, add Activity Migration env &amp; remove podIP, global.legacyKube</li> <li>5.0.0 - Boards Notifications (webhooks), support service.nodePort</li> <li>5.2.0 - Kube 1.22 support (use Capabilities.APIVersions)</li> <li>5.2.1 - Added default Ingress.class annotation 'nginx'</li> </ul>"},{"location":"boards/helm-charts-kudos/#kudos-boards-activity-migration","title":"kudos-boards-activity-migration","text":"<ul> <li>4.0.0 - Load balancer (no cote), add Activity Migration env &amp; remove podIP, global.legacyKube</li> <li>5.0.0 - Support service.nodePort, default volume &amp; mount for share drive</li> <li>5.2.0 - use Capabilities.APIVersions instead of legacyKube</li> <li>5.2.1 - support custom spec &amp; custom accessMode/volumeMode/persistentVolumeReclaimPolicy</li> <li>5.2.2 - fix support of storageClassName on PVC</li> </ul>"},{"location":"boards/helm-charts-kudos/#for-component-pack","title":"For Component Pack","text":""},{"location":"boards/helm-charts-kudos/#kudos-boards-cp","title":"kudos-boards-cp","text":"<ul> <li>1.0.0 - Boards CP</li> <li>1.1.1 - Kube v1.17 support - minio v1.1.1</li> <li>2.0.0 - Kube v1.17 support, HTTP Requester/Responder, LivenessProbes, legacyKube</li> <li>2.0.1 - Ingress controller 0.22+ support</li> <li> <p>3.0.0 - Webhooks, Annotations for Socket cookie, support service.nodePort</p> <p>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.</p> <p>As of release 2021-06-09 you must move all the NOTIFIER_* environment variables from <code>core</code> to <code>events</code>. See our documentation for all supported options.</p> <p>For example:</p> <pre><code>events:\n    image:\n        name: \"\"\n        tag: boards-event\n    env:\n        NOTIFIER_EMAIL_HOST: &lt;smtp-email-host&gt;\n        NOTIFIER_EMAIL_USERNAME: &lt;smtp-email-username&gt;\n        NOTIFIER_EMAIL_PASSWORD: &lt;smtp-email-password&gt;\n        # plus all other NOTIFIER options previously defined in core\n</code></pre> </li> <li> <p>3.0.1 - Minio root credentials, nfs mountOptions</p> </li> <li>3.1.0 - Kube 1.22 support (use Capabilities.APIVersions)</li> <li>3.1.1 - Added default Ingress.class annotation 'nginx'</li> <li>3.1.2 - Fix Ingress pathType annotation for old kube versions (v17 etc)</li> <li>3.1.3 - support Kube v1.25 - remove policy/v1beta/PodSecurityPolicy (in minio) and add ingress.ingressClassName</li> <li>3.1.4 - version lock Minio for 'fs' storage type support</li> </ul>"},{"location":"boards/helm-charts-kudos/#kudos-boards-cp-activity-migration","title":"kudos-boards-cp-activity-migration","text":"<ul> <li>1.0.0 - Boards CP Activity Migration</li> <li>1.1.0 - Kude v1.17 support</li> <li>2.0.0 - Kube v1.17 support, HTTP Requester/Responder, LivenessProbes</li> <li>3.0.0 - Support service.nodePort, default volume &amp; mount for share drive</li> <li>3.0.1 - Support mountOptions for share drive</li> <li>3.1.0 - use Capabilities.APIVersions instead of legacyKube</li> <li>3.1.1 - support custom spec &amp; custom accessMode/volumeMode/persistentVolumeReclaimPolicy</li> <li>3.1.2 - fix support of storageClassName on PVC</li> </ul>"},{"location":"boards/helm-charts/","title":"Helm Chart History","text":"<p>Release notes for each Helm chart utilised by Boards (for Component Pack vs standalone, and Activity Migration)</p> <p>Important</p> <p>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.</p>"},{"location":"boards/helm-charts/#standalone-kubernetes","title":"Standalone Kubernetes","text":""},{"location":"boards/helm-charts/#huddo-boards","title":"huddo-boards","text":"<ul> <li>1.0.0</li> </ul>"},{"location":"boards/helm-charts/#huddo-boards-activity-migration","title":"huddo-boards-activity-migration","text":"<ul> <li>1.0.0</li> </ul>"},{"location":"boards/helm-charts/#for-component-pack","title":"For Component Pack","text":""},{"location":"boards/helm-charts/#huddo-boards-cp","title":"huddo-boards-cp","text":"<p>Danger</p> <p>As of <code>huddo-boards-cp-1.0.0.tgz</code> we have changed the Minio pods to run as <code>user 1000</code> instead of <code>root</code>. You must perform the following command on the shared drive (<code>/pv-connections</code> file system) before using this new chart. The change is backwards compatible.</p> <pre><code>cd /pv-connections/kudos-boards-minio/\nchown 1000:1000 -R .\n</code></pre> <ul> <li>1.0.0</li> <li>1.1.0 - CNX 8 fix for Mongo 5</li> <li>1.1.1 - Support custom storageClassName instead of PV</li> <li>1.2.0 - Added readiness probes on each service</li> </ul>"},{"location":"boards/helm-charts/#huddo-boards-cp-activity-migration","title":"huddo-boards-cp-activity-migration","text":"<ul> <li>1.0.0</li> <li>1.1.0 - CNX 8 fix for Mongo 5</li> </ul> <p>Info</p> <p>The previous chart information has moved here</p>"},{"location":"boards/hybrid/","title":"Boards Hybrid","text":"<p>Hybrid = Cloud integrated with HCL Connections On-Premise</p> <p></p> <p>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.</p> <p>For a comparison of Boards versions please see here</p> <p>Setting up the Hybrid Boards Cloud involves:</p> <ol> <li> <p>Configure Authentication</p> </li> <li> <p>Review Security</p> </li> <li> <p>Contact the Huddo Team with these details</p> <pre><code>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:\n</code></pre> </li> <li> <p>Configure HCL Connections extensions</p> <ul> <li>Connections Header</li> <li>Customise Apps menu</li> <li>Customise Widgets</li> <li>Add to Mobile App</li> </ul> </li> </ol>"},{"location":"boards/images/","title":"Using latest releases directly from Huddo","text":"<p>You can get the latest versions of Huddo Boards Docker by subscribing to our own repository in Quay.io as follows:</p> <ol> <li> <p>Create a Quay.io - Red Hat account if you do not already have one.</p> </li> <li> <p>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.</p> </li> <li> <p>Get secret to use in Kubernetes</p> <ol> <li> <p>Open Quay.io, In the user menu, click on 'Account Settings'</p> <p></p> </li> <li> <p>Click <code>Generate Encrypted Password</code></p> <p></p> </li> <li> <p>Enter your password and click <code>Verify</code></p> <p></p> </li> <li> <p>Download the secret.yml file. Take note of the name of the secret for later use</p> <p></p> </li> </ol> </li> <li> <p>Use the file downloaded to create the secret (in the required namespace). For example:</p> <pre><code># 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\n</code></pre> </li> </ol>"},{"location":"boards/releases-archive/","title":"Boards Self-Hosted Releases (Archive)","text":"<p>Tip</p> <p>Documentation for recent releases can be found here.</p>"},{"location":"boards/releases-archive/#2022","title":"2022","text":""},{"location":"boards/releases-archive/#2022-12-15","title":"2022-12-15","text":"<p>Improvements:</p> <ul> <li>synchronise dependencies in real time</li> <li>faster creation of multi cards</li> <li>presence of users open on card without board open</li> <li>link to API documentation</li> <li>adding dependencies between private cards</li> <li>handling of dependencies where not accessible</li> <li>make associated comments public when card is made public</li> <li>synchronise my private tasks between my windows</li> </ul> <p>Fixes:</p> <ul> <li>issue opening board \"Error: Minified React error #185\"</li> <li>issue where Community widget shows 'my' boards incorrectly</li> <li>issue where someone online in board remained online if page reloaded</li> <li>issue where lists hidden when previewing Kanban view while creating a Board</li> <li>issue where page crashed on logout in Node view</li> <li>issue where page crashed on logout in Timeline view</li> <li>issue where files couldn't be downloaded</li> <li>issue where page reloaded in admin view</li> </ul>"},{"location":"boards/releases-archive/#2022-11-15","title":"2022-11-15","text":"<p>Improvements:</p> <ul> <li>Redis client reuse</li> <li>Ensure Redis is available on startup</li> </ul>"},{"location":"boards/releases-archive/#2022-11-09","title":"2022-11-09","text":"<p>Features:</p> <ul> <li>installable web app</li> </ul> <p>Performance:</p> <ul> <li>faster load</li> <li>added virtual scroll for Kanban</li> <li>smoother drag and drop</li> <li>faster filtering/searching inside a Board</li> </ul> <p>Improvements:</p> <ul> <li>improved new user experience in integrations</li> <li>hide dependency lines while dragging &amp; resizing</li> <li>usability of tile color label edit/selection</li> <li>stop auto redirecting expired account</li> <li>debugging added for socket connections and description locking<pre><code>&gt; In browser console, you can enter `boards.setDebug(true)` and press Enter to enable this, then reload the page.\n&gt; You will then get debug logs in the console for all websocket and description lock events.\n&gt; Use `boards.setDebug(false)` to turn this off when done.\n</code></pre> </li> </ul> <p>Fixes:</p> <ul> <li>fix for drag scrolling lists on mobile</li> <li>fix editing link titles</li> <li>fix positioning of timeline arrows caused by swimlane animations</li> <li>fix double click to add list</li> </ul>"},{"location":"boards/releases-archive/#2022-10-24","title":"2022-10-24","text":"<p>Improvements:</p> <ul> <li>reduced processing whilst dragging cards</li> <li>/app/createcard micro app - new users can now create a board instead of being stuck with no board to choose</li> </ul> <p>Timeline:</p> <ul> <li>animate expand/collapse of scheduled lanes</li> <li>fix for hidden cards on timeline when duplicated (eg multiple colors/assignments)</li> <li>highlight multiple instances of same card on hover</li> <li>remember last view (list/color/members)</li> <li>live updates of list names, color labels and members</li> <li>show color labels</li> </ul> <p>Fixes:</p> <ul> <li>webhook api events may not have fired in a specific situation for users with linked accounts</li> </ul>"},{"location":"boards/releases-archive/#2022-10-10","title":"2022-10-10","text":"<p>Fixes:</p> <ul> <li>API documentation page no longer using local config (all \"Try it out\" routes would fail).</li> </ul>"},{"location":"boards/releases-archive/#2022-10-07","title":"2022-10-07","text":"<p>API Updates:</p> <ul> <li>Add <code>PATCH</code> method for <code>/node/{nodeId}</code> to allow changing any attribute of a card or list</li> <li>Add webhook for card-moved events (<code>/webhook/card-moved/{boardId}</code>)</li> </ul> <p>Translations:</p> <ul> <li>Full translation run for all supported languages</li> </ul> <p>Features / Fixes:</p> <ul> <li>Fixed scolling in the Timeline view when you have too many lists to fit in the view</li> <li>Changed colours on the Timeline view to better show cards when dragging</li> <li>Fix for closing date picker on touch screens</li> <li>Remade the drag preview on timeline to look more like a card</li> <li>Build process refactor - docker images are much smaller after this update</li> <li>All images updated to pass latest security scan requirements</li> </ul>"},{"location":"boards/releases-archive/#2022-09-07","title":"2022-09-07","text":"<p>Security Update:</p> <ul> <li>Full node.js package audit and update</li> </ul>"},{"location":"boards/releases-archive/#2022-08-25","title":"2022-08-25","text":"<p>Features:</p> <ul> <li>Added translations for Dependencies feature</li> <li>Added translations for all email templates</li> </ul>"},{"location":"boards/releases-archive/#2022-08-16","title":"2022-08-16","text":"<p>Features:</p> <ul> <li>Domino authentication More info here</li> </ul> <p>Fixes:</p> <ul> <li>Distorted profile image if not square</li> </ul>"},{"location":"boards/releases-archive/#2022-08-09","title":"2022-08-09","text":"<p>Improvements:</p> <ul> <li>Compatibility for private channels in Teams</li> </ul> <p>Fixes:</p> <ul> <li>Attach Card with remembered previous selection</li> </ul>"},{"location":"boards/releases-archive/#2022-06-24","title":"2022-06-24","text":"<p>Features:</p> <ul> <li>Dependencies feature</li> </ul> <p>Improvements:</p> <ul> <li>Printing in Board View</li> <li>Highlights widget opening fullpage</li> <li>Updated Recent Boards in side toolbar</li> <li>Viewing card title when user presence is also displayed</li> <li>Visibility of Owners Only group Boards</li> </ul> <p>Fixes:</p> <ul> <li>Styling of user presence when multiple</li> <li>Card toolbar on smaller resolutions</li> <li>Community widget now works if user has no email</li> <li>'Commented on' recent updates not syncing in real-time</li> <li>Auth loop when using Connections Header</li> <li>Loading ToDo View &amp; 'View' by 'Groups' when a group has been deleted</li> <li>Description not saving in certain window changing scenarios</li> </ul>"},{"location":"boards/releases-archive/#2022-05-13","title":"2022-05-13","text":"<p>Features:</p> <ul> <li>Auto login to Boards if only one provider configured</li> </ul> <p>Improvements:</p> <ul> <li>Prevent closing page when still editing description</li> <li>Styling of description locked alert for visibility when scrolled</li> <li>New Teams welcome message card</li> <li>New Teams notification cards</li> </ul> <p>Fixes:</p> <ul> <li>Clickable links in description</li> <li>Moving focus between description and comments</li> <li>Saving description changes when focusing new comment</li> <li>Truncation of comment when posting in some circumstances</li> <li>Prevent authors attempting to edit descriptions when not allowed</li> <li>@mentions on new lines created with shift+enter</li> <li>Showing bubble editor when select all text in comment (ctrl+a)</li> <li>Issue with attachments from EML uploads (e.g. drag from HCL Notes)</li> </ul>"},{"location":"boards/releases-archive/#2022-04-20","title":"2022-04-20","text":"<p>Features:</p> <ul> <li> <p>Login to Boards using Single Sign On (SSO) in Microsoft Teams</p> <p>Note: you will need to:</p> <ol> <li>Configure SSO in Teams in your existing Azure OAuth application definition</li> <li>follow this guide to download the latest app definition and update it in Teams.</li> </ol> </li> </ul> <p>Fixes:</p> <ul> <li>Issue loading Activity Stream gadget</li> <li>Issue with Moderated Community access</li> <li>Issue when updating Board title</li> <li>Issue with lock of description in communities</li> </ul>"},{"location":"boards/releases-archive/#2022-04-07","title":"2022-04-07","text":"<p>Improvements:</p> <ul> <li>Reduced number of simultaneous MongoDB connections</li> </ul> <p>Fixes:</p> <ul> <li>Issue with comment stream entry for Orient Me</li> <li>Issue with updating card title from Boards view in FireFox</li> <li>Issue with deeplinked Connections Community widgets</li> <li>Issue with Boards Search styling</li> <li>Issue with opening filters via icon</li> <li>Issue with Moderated Community ACL</li> <li>Issue with Teams login popup not closing</li> </ul> <p>Activity Migration:</p> <ul> <li>Fix invisible top level task/entries</li> </ul>"},{"location":"boards/releases-archive/#2022-03-21","title":"2022-03-21","text":"<p>Improvements:</p> <ul> <li>File upload feedback (eg when socket unavailable)</li> </ul> <p>Fixes:</p> <ul> <li>WebSocket failure fallback to Polling</li> <li>Prevent duplicates appearing in history from live events</li> <li>First comments not live displaying</li> <li>Issue where Timeline displaying some cards a day out</li> <li>Issue where Subscriber Redis crashes after too many concurrent events</li> </ul>"},{"location":"boards/releases-archive/#2022-03-09","title":"2022-03-09","text":"<p>Improvements:</p> <ul> <li>Upgraded libraries for performance/security/support (e.g. Material UI, Redis)</li> <li>Improved loading perfomance (reduced bundle size)</li> </ul> <p>Fixes:</p> <ul> <li>issue where comments disappear in certain scenarios</li> <li>issue where pasting into edited comment clears comment</li> <li>issue where loading a Community widget where the Board has been deleted causing an inifinite loop</li> </ul> <p>Activity Migration:</p> <ul> <li>Added optional variables to reprocess migrated files which had encoding issues</li> </ul>"},{"location":"boards/releases-archive/#2022-02-17","title":"2022-02-17","text":"<p>Features:</p> <ul> <li>Ability to change Private cards to Public</li> </ul> <p>Improvements:</p> <ul> <li>Updated Date pickers with month/year selection</li> <li>Updated Material UI library to latest</li> <li>Better internationalisation of dates</li> </ul> <p>Fixes:</p> <ul> <li>Fix for saving description on modal closure</li> <li>Fix for transfer membership</li> <li>Fix detection of descriptions migrated from Activities</li> <li>Fix for entry styling when Visual Update One applied</li> </ul> <p>Activity Migration:</p> <ul> <li>Uses new FileInfo meta structure</li> <li>Fix to flag cards with description</li> </ul>"},{"location":"boards/releases-archive/#2022-02-10","title":"2022-02-10","text":""},{"location":"boards/releases-archive/#file-store-migration","title":"File store migration","text":"<p>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.</p> <p>Improvements:</p> <ul> <li>File uploads have better user feedback, showing a partial file and track the upload progress</li> <li>File downloads make better use of the original mimetype and no longer use the file name in the url</li> <li>When setting Due, Start and End Dates the picker now supports clicking in the header to choose a year</li> </ul> <p>Fixes:</p> <ul> <li>Cards created from Outlook / Verse can crash a board</li> <li>Date \"chips\" on card view need to be clicked twice</li> <li>Pasting an image can wipe a description</li> <li>Boards in a community / team no longer show \"My Boards\" on error</li> <li>Clicking \"Private\" sometimes does nothing</li> <li>File size calculation now allows a full 50mb file</li> </ul>"},{"location":"boards/releases-archive/#2022-01-07","title":"2022-01-07","text":"<p>Fixes:</p> <ul> <li>Issue where notifications of comments not sent to other commenters</li> <li>Issue where emails sent to content creators when users are no longer Board members</li> <li>Issue when completing tasks when multi-assign has been removed</li> <li>Issue where sub cards not loading when opening a card via url</li> <li>Issue where card breadcrumbs (ancestors) not displaying when opening a card via url</li> </ul>"},{"location":"boards/releases-archive/#2021","title":"2021","text":"<p>2021-12-17</p> <p>Improvements:</p> <ul> <li>Throttle lookups of members from Communities application</li> <li>Improved description of scheduled cards in Recent Updates history</li> <li>Arabic language updates</li> </ul> <p>Fixes:</p> <ul> <li>Issue when adding Tag with same starting letter as previous</li> <li>Issue when moving Cards in MindMap</li> <li>Issue where Board title overflowed in MindMap</li> <li>Issue where removing description was not synchronised to other users with modal open</li> </ul> <p>2021-11-23</p> <p>Features:</p> <ul> <li>Recent Updates (board level and inside cards)</li> </ul> <p>Improvements:</p> <ul> <li>Arabic language updates</li> <li>MSGraph user searching (inc Guests)</li> <li>Activity Migration: better feedback when invalid content store data</li> </ul> <p>Fixes:</p> <ul> <li>Assigning a user by drag/drop creates second card from profile image</li> </ul> <p>2021-11-18</p> <p>Updates:</p> <ul> <li>All services have been updated to the latest LTS version on Node.js, all dependencies have been updated to their latest supported versions.</li> <li>Updated translations for Arabic and German.</li> </ul> <p>2021-11-02</p> <p>Fixes:</p> <ul> <li>Licence not found errors when adding or removing licences in the LICENCE key environment variable.</li> </ul> <p>2021-10-26</p> <p>Fixes:</p> <ul> <li>SSL Issue connecting to Component Pack Mongo</li> </ul> <p>2021-10-22</p> <p>Features:</p> <ul> <li>User Presence</li> <li>Private Cards</li> </ul> <p>Improvements:</p> <ul> <li>Load performance by reducing page size</li> <li>Activities View performance</li> <li>Optional API Rate Limiting</li> <li>Better handling of conflicting CSS from Visual Update One</li> <li>Enhancement for Microsoft Graph groups which are not teams (owner vs member)</li> </ul> <p>Fixes:</p> <ul> <li>Issue when adding Connections Communities as members</li> <li>Issue when changing user account tries to loads the previous open Board</li> <li>Issue where link is inserted at start of description</li> <li>Issue with authenticated webhooks</li> <li>Issue with S3 \"bucket-already-exists\" race condition</li> <li>Issue where multiple toasts in quick succession never auto closed</li> </ul> <p>2021-09-29</p> <p>Improvements:</p> <ul> <li> <p>Reduce reliance on Communities application</p> <ul> <li>Reduce member lookups</li> <li>Increase page size of Communities requests</li> <li>Throttles simultaneous requests to Communities</li> <li>Increase caching of responses</li> </ul> </li> <li> <p>Undo / Redo option in Rich Text editor</p> </li> </ul> <p>Fixes:</p> <ul> <li>Indexing issue when recreating <code>providerID_1</code> with new options</li> </ul> <p>2021-09-24</p> <p>Improvements:</p> <ul> <li>Debug logging of 400 errors in webfront</li> </ul> <p>Fixes:</p> <ul> <li>issue with index in Component Pack mongo when assigned task name too long</li> </ul> <p>2021-09-17</p> <p>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</p> <p>Note: if you encounter 400 bad requests when loading <code>/boards</code>, please see this troubleshooting guide.</p> <p>Features:</p> <ul> <li>Private Cards</li> </ul> <p>Improvements:</p> <ul> <li>Board load performance</li> <li>User/Group search performance</li> <li>more granular user permissions for group membership</li> <li>ability to set group permissions for a Board on create in the group</li> <li>Community name search improvements (handling of names with special characters)</li> <li>added missing German translations</li> <li>MongoDB - refined and reduced total indexes. Be aware that this update will cause a heavy re-index.</li> </ul> <p>Fixes:</p> <ul> <li>issue where you could not change level of community members</li> <li>issue assigning colours in quick succession</li> <li>issue when removing filters on ToDo view</li> <li>teams notifications turning back on when they are disabled</li> <li>issue accepting email invites for guest/external users</li> </ul> <p>2021-06-24</p> <p>Fixes:</p> <ul> <li>Added environment variable <code>FORCE_POLLING</code> in webfront to avoid issues seen when using IHS as reverse proxy</li> <li>API documentation should now work for cp releases, see <code>/api-boards/</code></li> </ul> <p>2021-06-09</p> <p>Breaking change:</p> <p>Emails are now sent by the <code>events</code> service. You must move the NOTIFIER_* environment variables from <code>core</code> to <code>events</code> as shown in v3 of our chart</p> <p>New Features:</p> <ul> <li>Due Date reminder emails</li> <li>Email notification controls</li> <li>Product Tours</li> </ul> <p>Improvements:</p> <ul> <li>New email styling &amp; full Card/Board representation</li> </ul> <p>Fixes</p> <ul> <li>Visibility of assignment completion (ticks) when multi-complete</li> <li>Issue where description was hidden if other card attribute updated</li> <li>UI feedback when completing task on Todos view</li> <li>Completion logic when completing last assignment</li> <li>Missing description when post comment, export Board as CSV, create Board from Template (since 06-02)</li> <li>Logout issue (since 06-02)</li> </ul> <p>2021-06-02</p> <p>Improvements:</p> <ul> <li>Only load Descriptions when required (less data, faster loading times)</li> <li>Styling/positioning of Date selection</li> </ul> <p>Fixes</p> <ul> <li>Missing Boards when viewed by Color (if never opened)</li> </ul> <p>2021-05-31</p> <p>Improvements:</p> <ul> <li>Microsoft (Teams &amp; Sharepoint) - detect owners vs members (authors)</li> <li>Creating board in Sharepoint sites</li> <li>Comment create/delete UI performance</li> <li>Card completion performance</li> </ul> <p>Fixes:</p> <ul> <li>ACL for Readers/Commenters</li> <li>Protect against removing an assignment while still creating</li> <li>Showing image pasted in description with no text</li> <li>Linking to files in folders</li> <li>Description lock issues when framed (Connections, Sharepoint etc)</li> <li>Wrap long comments instead of sideways scrolling</li> </ul> <p>2021-05-13</p> <p>Improvements:</p> <ul> <li> <p>Link to Files / Upload to Files</p> <ul> <li>Show options for all member Groups (Communities)</li> <li>Updated defaults for private Boards</li> <li>Alphabetic ordering of Connections files</li> <li>Type to filter</li> </ul> </li> <li> <p>Allow custom NodeMailer email options (insecure tls etc)</p> <p><code>core.env.NOTIFIER_EMAIL_OPTIONS: \"{\\\"ignoreTLS\\\": true,\\\"tls\\\":{\\\"rejectUnauthorized\\\":false}}\"</code></p> </li> </ul> <p>Fixes:</p> <ul> <li>Color tag menu positioning on small screen</li> <li>Boards image on file uploads (context root)</li> </ul> <p>2021-05-04</p> <p>Improvements:</p> <ul> <li>User feedback when assigning tasks to multiple users (no flickering)</li> <li>Reconnect live events after service updates</li> <li>API docs only at root, send 404 for missing/incorrect routes</li> <li>Reduce height of background event loading progress bar</li> </ul> <p>Fixes:</p> <ul> <li>Archive view loading animation</li> <li>Adding an Admin by email search</li> <li>Dot in Node modal above name input visible with a theme</li> <li>Outlook add-in file updates</li> <li>Deep linking to Community Boards widget in Highlights app</li> <li>Authors can no longer assign users to tasks they did not create</li> <li>Authors and Readers can complete 'All Must Complete' tasks they are assigned to</li> </ul> <p>2021-04-29</p> <p>New:</p> <ul> <li>Boards Event service</li> </ul> <p>Fixes:</p> <ul> <li>Allow editing of rich text when sockets fail</li> <li>Opening cards with html imported from Outlook</li> <li>Member assignment on click in menu</li> <li>Remove card theme when deleting file set as card theme</li> <li>Multiple assignments in rapid succession</li> </ul> <p>2021-04-26</p> <p>Improvements:</p> <ul> <li>Updates to Rich Text Editor &amp; editor locking mechanism</li> <li>Card icon for scheduled start/end dates</li> <li>Admin revoke &amp; anonymise user function</li> <li>API for email to Card/Entry parsing</li> <li>API for file upload as new Card</li> </ul> <p>Fixes:</p> <ul> <li>Highlights widget update for C7</li> <li>Updated German translation</li> </ul> <p>Activity Migration</p> <ul> <li>Use Connections Shared Drive to load Activity long descriptions and files (new variables &amp; volume/mount required in yaml)</li> </ul> <p>2021-03-22</p> <p>Improvements:</p> <ul> <li>Board loading performance</li> </ul> <p>Fixes:</p> <ul> <li>Locking of description when socket fails</li> <li>Activity migration - protect against old public data</li> </ul> <p>2021-03-16</p> <p>Improvements:</p> <ul> <li>Handle legacy Boards WebSphere URL redirect (hashes)</li> <li> <p>Ability to transition between providers</p> <ul> <li>Link User accounts by full email address</li> <li>Map Groups by CSV file</li> <li>Transfer Ownership &amp; Unlink accounts</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Verse integration</li> </ul> <p>2021-03-10</p> <p>Fixes:</p> <ul> <li>Groups not saving expanded members (affects imported Activities)</li> <li>Issue where homepage didnt reload after login from secondary alias</li> <li>Improved support for imported community owner + reader role</li> </ul> <p>Activity Migration:</p> <ul> <li>Updated Mongoose version to fix 'module exports inside circular dependency' warning</li> </ul> <p>2021-03-05</p> <p>Features:</p> <ul> <li>New Huddo branding!</li> <li>New API with docs!</li> <li> <p>API integrations with</p> <ul> <li>Zapier</li> <li>Power Automate</li> </ul> </li> <li> <p>Leave a Board</p> </li> <li>Card description lock (one-at-a-time editing)</li> <li>Embed Cards/Boards in third party apps (e.g. Sharepoint)</li> </ul> <p>Fixes:</p> <ul> <li>Prevent file upload with zero size</li> <li>Support migrated folders</li> </ul> <p>2021-03-04</p> <p>Fixes:</p> <ul> <li>Connections login no longer sends redirect_uri (connections will use the one configred in wsadmin)</li> </ul> <p>2021-03-03</p> <p>Improvements:</p> <ul> <li>Ability to sync profiles from Connections &amp; Microsoft (please follow the steps on the Admin page of each Client)</li> <li>Ability to automatically link user aliases in 2 different clients (eg Connections &amp; Microsoft)</li> <li>Support for Activity URL with entryId</li> </ul> <p>Fixes:</p> <ul> <li>Redirect to login if required when accessing Activity URL</li> <li>Board ACL updates for membership escallation</li> </ul> <p>2021-02-19</p> <p>Improvements:</p> <ul> <li>Todos view<ul> <li>hide sub-cards which are not applicable</li> <li>hide multi-assigned tasks I have completed (assigned view)</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Disable notification for Communities with 'owner-only' membership</li> <li>Notifications when creating a Board &amp; members at the same time</li> <li>Protect against imported data for assignments without users &amp; nodes without creator</li> <li>Mindmap - expand/collapse icons</li> <li>Redirect from Activity URL to Board URL in the Connections header frame</li> <li>Show all public members when multiple</li> </ul> <p>2021-01-19</p> <p>Improvements:</p> <ul> <li>Show login page on file download when unauthorized</li> <li>Login options for Verse/Outlook integration</li> </ul> <p>Fixes:</p> <ul> <li>Tile color popup positioning and scrolling for small screens</li> <li>Protect against null assignment value after import</li> <li>PDF downloads inside the community widget</li> <li>Show new cards added in assignments view</li> <li>Show assigned cards in Timeline view (only affects some users with multiple linked accounts)</li> </ul>"},{"location":"boards/releases-archive/#2020","title":"2020","text":"<p>2020-12-14</p> <p>Features:</p> <ul> <li>Updated migration service to support the new \"Community Owners only\" option</li> <li> <p>Added fix for Activities that had already been imported and used the equivalent permission set in Activities</p> <p><code>boards.yaml</code></p> <pre><code>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\n</code></pre> </li> </ul> <p>2020-12-12</p> <p>Features:</p> <ul> <li>Added group membership option \"Community Owners Only\" which makes the community owners have owner rights in a board but does not allow any other community members access. This option is available for boards created in a community widget only.</li> </ul> <p>2020-11-13</p> <p>Improvements:</p> <ul> <li>Increase multi-lingual coverage</li> </ul> <p>2020-11-02</p> <p>Improvements:</p> <ul> <li>Increase multi-lingual coverage</li> <li>Creating Board from template includes members/description</li> <li>Option to disable Welcome emails (user.env.DISABLE_WELCOME_EMAIL)</li> </ul> <p>Fixes:</p> <ul> <li>Uploading file in iOS Safari</li> </ul> <p>2020-10-14</p> <p>Improvements:</p> <ul> <li>Updated Rich Text Editor</li> </ul> <p>Fixes:</p> <ul> <li>Re-open last board view</li> <li>User trial reminder</li> <li>Extension of user trials</li> <li>Download linked files with .odt extension</li> </ul> <p>2020-10-05</p> <p>Features:</p> <ul> <li>Board Search<ul> <li>Increase visibility of filters</li> <li>Maintain filters after page reload</li> <li>Hide Completed Todos</li> <li>Hide Empty Lists</li> </ul> </li> <li>Preview Files, support for<ul> <li>Excel (xlsx, xls)</li> <li>PDF</li> </ul> </li> </ul> <p>Improvements:</p> <ul> <li>Rich Text Editor - allow indenting paragraphs</li> <li>Logging updates</li> <li>Activity Migration - add default link type</li> </ul> <p>Fixes:</p> <ul> <li>Default handling of links from migrated Activities</li> <li>User Avatar initials fallback</li> <li>Include current user as option in user licence search &amp; custom field person</li> </ul> <p>2020-09-18</p> <p>Features:</p> <ul> <li>New rich text editor with improved handling for<ul> <li>tables</li> <li>whitepace</li> <li>paste from office</li> <li>font, font size, font color</li> <li>file upload feedback</li> </ul> </li> <li>Search Board by Custom Fields (Text &amp; People)</li> <li>Search improvements - show sub-tasks when parent match filter</li> </ul> <p>Improvements:</p> <ul> <li>UI feedback for Chrome Incognito third-party security exception</li> <li>Microsoft Teams file preview</li> <li>Microsoft Teams file links</li> <li>Internal microservice communication (Note: this requires a new Helm Chart V2)</li> <li>Updated HCL Connections icon</li> </ul> <p>Fixes:</p> <ul> <li>Issue where page reloads constantly in Connections frame</li> <li>Outlook integration issue</li> <li>File Preview in Safari</li> <li>Board Properties toolbar 'more' menu</li> <li>API update for completing a task already completed</li> </ul> <p>2020-08-24</p> <p>Features:</p> <ul> <li>Live Board Tile views (my/public/groups)</li> <li>Export Board/Cards as CSV</li> <li>Upload multiple files at once</li> <li>Drag and drop multiple emails into an open card</li> <li>Link to Board/List/Card - copies a direct URL to clipboard</li> </ul> <p>Improvements:</p> <ul> <li>Performance (loading times)</li> <li>Use local font files (no external URLs)</li> <li>Focused people search results in Connections</li> <li>Previewing linked files has link to Connections file info</li> <li>Loading Community images</li> <li>Support nested comments imported from Activities</li> <li>Support pasting images in comments</li> <li>Support long board names in left sidenav</li> <li>Scroll members area in right sidenav when long</li> <li>Show summary numbers in Members dialog</li> <li>UI feedback while saving custom fields</li> <li>Cookie handling (SameSite)</li> <li>Firefox scrollbar styling</li> </ul> <p>Fixes:</p> <ul> <li>Saving of description on reload &amp; modal change</li> <li>Comment duplicate while saving</li> <li>Support non-english @mentions</li> <li>@mention overflow issue</li> <li>Recent boards in left sidenav</li> <li>Move and not open page crash issue</li> <li>Ordering of links in a card</li> <li>Sharing my private file with a public folder</li> <li>Previewing of linked Community files</li> <li>Activities imported with unknown user assignments</li> <li>Dragging color onto tiles</li> <li>Allow unassigning users who are no longer members</li> <li>Ordering issue on cards created using past</li> </ul> <p>2020-07-10</p> <p>Improvements:</p> <ul> <li>Activity Stream deep-linking to Community Boards</li> <li>Community Boards - open board links in fullpage</li> <li>Fix searching individual Activity imports</li> <li>Update individual Activity import grouping of top level entries</li> <li>Fix loading of some imported Activities</li> </ul> <p>Activity Migration:</p> <ul> <li>Support migration of Activity files with unicode &amp; whitespace characters in name</li> <li>Performance &amp; stability improvements (large activities &amp; filesets, rollback files on failure, extra logging, retry logic)</li> </ul> <p>2020-06-17</p> <p>Fixes:</p> <ul> <li>Show newly created comments in Todo view</li> <li>Support Activity URL redirects</li> <li>Community Boards loading issue</li> </ul> <p>Activity Migration:</p> <ul> <li>UI control options fix</li> <li>Support migration of Activity files with special characters in name</li> <li>Support for Activity links</li> <li>Protect against system tenant IDs '-Ignore-Organization-ID-' etc</li> <li>DB2 support for PEOPLEDB on secondary host</li> </ul> <p>2020-06-05</p> <p>Please see our Cloud blog</p> <p>Improvements:</p> <ul> <li>Loading performance</li> <li>Rendering performance</li> <li>Reduce size of application</li> <li>Node view UI refresh</li> </ul> <p>New Features:</p> <ul> <li>Card theme from uploaded images</li> <li>Preview uploaded files (images, docx, pdf, html etc)</li> <li>Todos Overview - filtering to selected Boards</li> <li>Drag and drop Email into Cards (ie from HCL Notes)</li> <li>Activity Stream Gadget for Boards - config updates required</li> <li>Multiple Assignment options for Cards</li> </ul> <p>Fixes:</p> <ul> <li>Email notifications for invited collaborators</li> </ul> <p>2020-04-09</p> <p>Fixes:</p> <ul> <li>Connections OAuth issue - missing scope</li> </ul> <p>2020-03-06</p> <p>Fixes:</p> <ul> <li>Updating cards permissions</li> <li>Boards list - show completed &amp; deleted</li> <li>individual import of Activity with emails</li> <li>member issue when moving card into new board</li> <li>Archived cards appear twice</li> <li>Powered by Huddo image</li> </ul> <p>Language support:</p> <pre><code>  \"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\"\n</code></pre>"},{"location":"boards/releases/","title":"Boards Self-Hosted Releases (change log)","text":""},{"location":"boards/releases/#how-to-upgrade","title":"How To Upgrade","text":"<p>Important - new image hosting</p> <p>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.</p> <p>Please use the appropriate update command with the latest helm chart. For example:</p> <ol> <li> <p>Huddo Boards in Kubernetes</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Component Pack (Activities Plus)</p> <p>Tip</p> <p>To upgrade from images in the Component Pack to images hosted by us please follow this guide.</p> <p>Danger</p> <p>New chart for Component Pack</p> <p>As of <code>huddo-boards-cp-1.0.0.tgz</code> we have changed the Minio pods to run as <code>user 1000</code> instead of <code>root</code>. You must perform the following command on the shared drive (<code>/pv-connections</code> file system) before using this new chart. The change is backwards compatible.</p> <pre><code>cd /pv-connections/kudos-boards-minio/\nchown 1000:1000 -R .\n</code></pre> <pre><code>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\n</code></pre> </li> </ol>"},{"location":"boards/releases/#releases","title":"Releases","text":"<p>Note</p> <p>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.</p>"},{"location":"boards/releases/#2024","title":"2024","text":""},{"location":"boards/releases/#2024-05-27","title":"2024-05-27","text":"<p>Features:</p> <ul> <li>Drag and drop of cards between browser tabs/windows</li> <li>Drag and drop bookmarks into Board lists/cards</li> </ul> <p>Activity Migration:</p> <ul> <li>MSSQL: Support for authentication per database</li> </ul>"},{"location":"boards/releases/#2024-05-17","title":"2024-05-17","text":""},{"location":"boards/releases/#hcl-dx","title":"HCL DX","text":"<p>As announced at Engage 2024 - Huddo Boards for HCL Digital Experience (DX). Learn more.</p> <p>Features:</p> <ul> <li>Card and Board recent updates feed - filter to show all or comments/updates only</li> </ul> <p>Improvements:</p> <ul> <li>add a permanent but closable info level toast when board is read-only</li> <li>update rich text editor to latest version</li> <li>card details view improvements<ul> <li>show card fields/data in defined sections in a grid formation with headings and add buttons</li> <li>change \"add a comment\" action to start as a button</li> </ul> </li> <li>tooltips on date picker</li> <li>add invalid date error message</li> <li>primary session expired message - show as info alert</li> <li>tab color and style improvements</li> <li>more consistent use of primary/secondary action colours on buttons</li> <li>no collapse for empty lists activity todo pivot views</li> <li>auto collapse empty lists initially and after a card is dragged out of them</li> <li>New Board Wizard - more specific label for board name and template name</li> <li> <p>Activity view improvements</p> <ul> <li>styling (shadows, spacing, border edges when expanded/collapsed)</li> <li>drop cards on list header (highlight like shadow)</li> <li>add card at top hides the bottom add card</li> </ul> </li> <li> <p>Usability:</p> <ul> <li>Timeline: add zoom -+ controls that increment zoom levels</li> <li> <p>Mindmap accessibility</p> <ul> <li>1st tab selects board node, allow arrow key nav, and tab to access actions from there</li> <li>sidebar controls - use mui checkboxes + ensure hover effects on buttons</li> <li>clear node selection on escape keypress</li> <li>fix text cutoff/ensure ellipsis on longer node titles</li> <li>add help link to sidebar</li> <li>allow keyboard pan and zoom using shift+arrow and +- keys</li> </ul> </li> <li> <p>add contact support button to error catch page</p> </li> <li>add severity levels when showing toasts, fade transition</li> <li>ensure board creator is displayed as a non-editable owner on board/template creation</li> <li>ensure board tile labels are sorted in selection menu</li> <li>make 'Recent' heading in sidebar look less like other actionable items</li> <li>use delete icon (bin) for remove actions for member tiles, dates, tags, and board tile labels</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Board tile label delete - ensure tile label is deleted from the label object in store</li> <li>update material-ui libraries to fix date picker display issues on small screens</li> <li>ensure card header theme displays correctly when card is opened via direct link</li> <li>minor styling fix for dependencies section on a node</li> <li>board/activity lists - more precise and consistent footer spacing/padding</li> <li>create card and add comment actions - ensure entered text persists on unfocus + other focus related fixes</li> <li>issue with exporting a board in Teams client</li> <li>date picker error on mobile/touch devices</li> <li>issue with format of dates in date picker</li> <li>issues in list header title - not full width, no-wrap ellipsis, use correct cursors</li> <li>don't show grab cursor on lists in todos / pivoted views</li> <li>issue saving tags when creating new template</li> <li>ensure tags are copied from template/source</li> <li> <p>Accessibility fixes:</p> <ul> <li>Focus highlighting overrides</li> <li>use focus outline rather than background colour</li> <li>Fix for keyboard access to CreateCard app clear buttons to choose board/list</li> <li>MenuHelper.jsx - pass the disabled prop to the button</li> <li>position of assign members menu</li> <li>better focus styling for add board tile button</li> <li>better contrast when focusing on boards logo</li> <li>board tiles sort dropdowns - use defined focus bg and colours</li> <li>minor fixes for focused input controls</li> </ul> </li> </ul> <p>Activity Migration:</p> <ul> <li>Support custom DB names in MSSQL</li> </ul>"},{"location":"boards/releases/#2024-04-03","title":"2024-04-03","text":"<p>Features:</p> <ul> <li> <p>Emoji reactions on comments</p> <ul> <li> <p>Quick selection</p> <p></p> </li> <li> <p>Picker</p> <p></p> </li> </ul> </li> <li> <p>Micro Apps</p> <ul> <li>My Next Tasks Summary</li> <li>My Next Tasks</li> </ul> </li> </ul> <p>API Documentation:</p> <ul> <li><code>/todos/next</code></li> <li><code>/todos/summary</code></li> <li><code>/board/{boardId}/labels</code></li> <li><code>/board/labels</code></li> <li><code>/user/auth/{provider}/{externalId}/apitoken</code></li> </ul> <p>Improvements:</p> <ul> <li>Streamlined <code>/todos/assigned</code> &amp; <code>/todos/created</code> API, separating out the Board labels to <code>/board/labels</code> &amp; <code>/board/{boardId}/labels</code> endpoints</li> <li>Loading feedback when creating a board</li> <li>Editing of comments on mobile (focus at end of text, save/cancel buttons)</li> <li>Loading feedback of recent boards sidebar</li> <li>Card link opening behavious (links to other boards open in same tab)</li> <li>Teams board links open tabs</li> <li>Show loading spinner while waiting on clicked link to open in a teams tab</li> <li>Add copy/paste list option in list menu</li> <li>Add duplication list option in list menu</li> <li>More comprehensive history feed details for moving or reordering cards</li> </ul> <p>Fixes:</p> <ul> <li>Create board from template when opened and only a reader</li> <li>Creating Board in group restricts to the group's Organisation</li> <li>Better handling of authentication when provider session changes user account</li> <li>Visibility of 'Embed Link' when viewing Boards by Group</li> <li>Creation of Board in Group when using /group/{groupId} route (embedded)</li> <li>View cards in fullscreen on small screens</li> <li>Issue when deleting all Boards tile colors</li> <li>Links to card ancestors (Todo view)</li> <li>Prevent date selection incorrectly showing today when no date set</li> <li>Upload files to Teams private channel OneDrive</li> <li>Scroll to bottom of a list when creating a new card</li> <li>Delete action in card dialog / in archive view</li> <li>Add card section in a list delays retract/height change to prevent card drag issues</li> <li>Dragging empty colour labels in Firefox</li> <li>Filter/search by list name</li> <li>Unauthorised error when adding existing board as Teams tab</li> <li>Fix potential onEnter errors in rich text editor</li> <li>Prevent overflow on file preview</li> <li>Load board members on fullscreen list view (for @mentions)</li> <li>Fix potential onBlur errors in rich text editor</li> <li>Don't show iCalendar feed options in Teams</li> </ul> <p>Activity Migration:</p> <ul> <li>Security updates</li> <li> <p>Oracle DB</p> <ul> <li>Update to use new v6 thin client</li> <li>allow different credentials for PEOPLEDB</li> </ul> </li> <li> <p>MSSQL</p> <ul> <li>Update to v10</li> <li>allow self-signed certificates with CONNECTIONS_DB_OPTIONS variable</li> </ul> </li> </ul>"},{"location":"boards/releases/#2024-02-14","title":"2024-02-14","text":"<p>Fixes:</p> <ul> <li>Connections SSO header scripts - Notifications panel</li> <li>Missing translations caused by load race condition</li> <li>Translation of timeline months headers</li> </ul>"},{"location":"boards/releases/#2024-02-07","title":"2024-02-07","text":"<p>Fixes:</p> <ul> <li>Issue with Board Content Admin on Mongo v3</li> <li>Microsoft Teams private channels<ul> <li>Link to File will now show the private channel's files.</li> <li>Owner/Author access level was setting all members to Author.</li> </ul> </li> <li>Microsoft Teams Mobile: Removed licence related cards in org admin view.</li> <li>Microsoft Teams: Removed obsolete \"Disable Notifications\" button.</li> <li>Rich text editor dialog - allow scroll on overflow</li> <li>Use SMTP email address before using Exchange address when parsing email attachments</li> <li>Don't show organisation admin links from Boards sidebar menu in Teams on a mobile device</li> <li>Activity view scrolling issue</li> </ul>"},{"location":"boards/releases/#2024-01-16","title":"2024-01-16","text":"<p>Improvements:</p> <ul> <li> <p>Microsoft Teams integrations</p> <ul> <li>UI redesign when adding new Boards tab</li> <li>Onboarding Tours</li> </ul> </li> <li> <p>faster opening of cards</p> </li> <li>allow clicking links in description when content locked for editing</li> <li>allow reordering private cards</li> <li>US English updates</li> <li>organisation plan loading feedback</li> </ul> <p>Fixes:</p> <ul> <li>issue loading licence caused by race condition in Licence service startup</li> <li>issue where completing a new task showed incorrect icon</li> <li>issue where Board content deleted when hovered and press Ctrl+Alt+Delete</li> <li>issue when opening a card by link, then a subcard within that card</li> <li>issue when reordering cards with filtered (hidden) content</li> <li>visibility of card title in header breadcrumb (Component Pack)</li> <li>RichText saving when used @symbol (but not an @mention)</li> <li>@mentions keyboard navigation improvements (home/end, up to bottom, down back to top), escape without closing modal</li> <li>@mentions only considered new on first save</li> <li>issue where mentions popup partially hidden at top</li> <li>issue where could not mention users when opening a card directly by link</li> <li>hide private cards when viewing board by assignments</li> <li>create card from Outlook/Verse - fix toggle of attach body, ordering of recent boards</li> <li>drag dependency links in Firefox</li> </ul>"},{"location":"boards/releases/#2023","title":"2023","text":""},{"location":"boards/releases/#2023-12-18","title":"2023-12-18","text":"<p>Feature:</p> <ul> <li>Drag emails from Outlook to create as card</li> <li>Support for latest MongoDB (v7)</li> <li>API documentation for /user/{userId}, /user/group/{groupId} etc</li> </ul> <p>Improvements:</p> <ul> <li>Accessibility (keyboard navigation - colors/members dialog, aria-labels, popover, html.lang attribute, improved roles, aria-selected, aria-expanded, hover/focus on cards)</li> <li>Drag email to card - attach .eml and .msg file</li> <li>Positioning of unscheduled cards in Timeline</li> <li>Improved document titles based on context</li> <li>Smoother drag scroll on Kanban</li> <li>Ensure grab cursor for Kanban drag scroll</li> <li>Update childcounts in activity lists when filtering</li> <li>Visibility of selected board filters</li> <li>Searching for a board includes the description</li> </ul> <p>Fixes:</p> <ul> <li>Card label overflow issue when 5 lines</li> <li>Issue where comment events sent to mentioned users</li> <li>Link to File dialog options</li> <li>Issue saving card name when editing it directly on the card</li> <li>Issue when focusing on boards search input</li> </ul>"},{"location":"boards/releases/#2023-11-30","title":"2023-11-30","text":"<p>Features:</p> <ul> <li> <p>Support for Domino by REST API</p> <p>Tip</p> <p>Please follow this guide to migrate from your existing Proton based Domino authentication</p> </li> </ul> <p>Improvements:</p> <ul> <li>Minor accessibility improvement - add aria-labels</li> <li>Security updates (Node v20)</li> <li>allow running webfront pods as random user id</li> </ul> <p>Fixes:</p> <ul> <li>Fix template description not showing in new board wizard</li> <li>Debounce User/Group searching</li> <li>Issue where menu buttons in the open card view were not overflowing to the 'more' menu correctly and causing a flickering effect</li> <li>Issue where lists in board view could not easily be dragged to re-order</li> <li>Issue with board title button long text overflowing</li> <li>Issue with card background images</li> </ul>"},{"location":"boards/releases/#2023-11-14","title":"2023-11-14","text":"<p>Improvements:</p> <ul> <li> <p>Accessibility</p> <ul> <li>more consistent tooltips (for screen readers and better explanation of functionality)</li> <li>Keyboard navigation (particularly in the Board Tiles, Kanban view, Card dialog) - (vision &amp; motor impaired)</li> <li>better screen reader information (vision impaired)</li> <li>improved colour contrast (low vision users)</li> </ul> </li> <li> <p>API for Member deletion</p> </li> <li>Support Keycloak v22 custom path</li> </ul> <p>Fixes:</p> <ul> <li>Email for mentions missing fields</li> </ul>"},{"location":"boards/releases/#2023-10-31","title":"2023-10-31","text":"<p>Improvements:</p> <ul> <li>Translations (German and English US)</li> <li>Use https protocol for iCal feed instead of webcals</li> <li>Hide unusable Colors button when read-only access when sidebar collapsed</li> <li>Consistency of Board colour feature naming</li> </ul> <p>Fixes:</p> <ul> <li>Issue where iCal feed dates off by 1 due to timezone differences</li> <li>Issue where page blank in Firefox when loading with Connections 7 header via SSO</li> </ul>"},{"location":"boards/releases/#2023-10-25","title":"2023-10-25","text":"<p>Danger</p> <p>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</p> <p>Features</p> <ul> <li>Board iCalendar feed</li> <li>Personal iCalendar feed</li> </ul> <p>Improvements:</p> <ul> <li>Show Member/Labels buttons in collapsed sidebar</li> <li>Added translations to missing access role fields</li> <li>loading of Board task stats on tiles as required</li> <li>performance of loading My Boards</li> <li>redirect in place for expired session of Collab/Connections with SSO header</li> </ul> <p>Fixes:</p> <ul> <li>Connections Header about.jsp issue for older environments (regression in 2023-10-17)</li> <li>Issue where page crashed when reloaded page with Card open, then opening member dialog</li> </ul>"},{"location":"boards/releases/#2023-10-17","title":"2023-10-17","text":"<p>Improvements:</p> <ul> <li>updated German translations (UI and emails)</li> <li>expired session handling when using SSO</li> </ul> <p>Fixes:</p> <ul> <li>showing CNX8 notification action center in sidebar</li> <li>pasting image in rich text field (desciption and comments)</li> <li>support SafeLinx cookie auth on manifest.json</li> <li>issue where dependencies change view after deletion</li> <li>allow assigned author to assign/unassign</li> </ul> <p>KNOWN ISSUE</p> <ul> <li>Connections Header loading via SSO loading in older environments (eg CNX7)</li> </ul>"},{"location":"boards/releases/#2023-09-14","title":"2023-09-14","text":""},{"location":"boards/releases/#mongo-schema-migrations","title":"Mongo schema migrations","text":"<p>Danger</p> <p>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.</p> <p>Features:</p> <ul> <li>Organisation content administration &amp; membership management</li> <li>Labels pivot view for Board and Activity views</li> <li>Pasting URLs into description and comments automatically converted to clickable link</li> </ul> <p>Improvements:</p> <ul> <li>support HCL Connections 8 CR3 style changes</li> <li> <p>API performance (faster response, less data) of the</p> <ul> <li>'My/Public Boards' data</li> <li>cards in a Board</li> </ul> </li> <li> <p>Users with the author role now have full edit access on cards that are assigned to them (rather than complete and comment access only)</p> </li> <li>consistency of sidebar icon positioning when collapsed/expanded</li> </ul> <p>Fixes:</p> <ul> <li>public member creation when creating Board</li> <li>issues in dependency arrow positioning</li> <li>auto reschedule dependencies when dates change</li> <li>selecting the same file to upload after cancelling</li> <li>expand/collapse lists when pivoted by dates/assignment</li> <li>Ensure assignments are duplicated when copying and pasting tasks</li> <li>Prevent cards from being moved to another list at the same time they are archived by dragging to the archive button</li> <li>Ensure the current user has the correct actions available according to their board role when opening cards from the My Todos view</li> <li>Drag &amp; Drop from rich email clients onto a list</li> <li>Activity list missing action menu</li> </ul>"},{"location":"boards/releases/#2023-07-04","title":"2023-07-04","text":"<p>Improvements:</p> <ul> <li>Readers can now select text in descriptions</li> <li>General reader experience</li> <li>Improved author experience - restrict to allowed actions</li> <li>Board title/board options button - styling and usability improvements</li> <li>Current member role now highlighted in members dialog and links added to member permissions documentation</li> <li>Improved randomisation and readability of Assignment Role colours</li> <li>Added tooltips to Assignment Role avatars</li> <li> <p>Microsoft Teams</p> <ul> <li>detect members in private sub channels (OAuth Admin consent must be certified again)</li> <li>fix for creating Board in private sub channels</li> <li>loading spinner positioning</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Connections 8 styling fixes (support banner and nav customisations)</li> <li>Fixed coloured role borders when assigning member roles</li> <li>Fix URLs pointing to old docs pages</li> <li>Issue detecting highest licence when multiple</li> <li>Minor fixes to Welcome and Plan Selection dialogs</li> <li>Template role assignment on touch devices</li> <li>Assignments to non-primary aliases</li> </ul>"},{"location":"boards/releases/#2023-06-22","title":"2023-06-22","text":""},{"location":"boards/releases/#mongo-schema-migrations_1","title":"Mongo schema migrations","text":"<p>Danger</p> <p>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.</p> <p>Features:</p> <ul> <li>Template Rescheduling</li> <li>Template Roles</li> <li>Custom Colours - colours and tags have been merged. You are now able to create as many colours as you like in a Board.</li> <li>Button to assign all sub-tasks as dependencies of parent</li> <li>Drag &amp; Drop assignments from parent to sub-cards in modal</li> <li>Drag card to archive</li> </ul> <p>Improvements:</p> <ul> <li>Readers no longer see actions they cannot perform</li> <li>Outlook attachments using plugin</li> <li>Copy/Paste functionality (buttons &amp; menu items)</li> <li>UI for member adding on Mobile</li> <li>Timeline card title always visible</li> <li>Auto-move dependency parent</li> <li>Expand all in activity view</li> <li>Hide edit options on archived card</li> <li>Localised format of dates in CSV export</li> <li>Cards can be Archived+Deleted from the card modal toolbar.</li> <li> <p>Drag and drop of lists</p> <ul> <li>drag by header</li> <li>fix blank list when scrolled and dragged</li> <li>prevent scrolling of list in drag mode</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Styling of ITM sidebar in Connections 8 CR1/CR2</li> <li>Connections 8 integrations when Boards on different domain</li> <li>Getting members from private sub-channels (teams)</li> <li>Attachments are moved in child nodes when the parent is moved</li> <li>Updated attachments to correctly show when their parent had been moved</li> <li>Kanban Printing</li> <li>Timeline calendar shifting when opening a card</li> <li>Removed Connections community members not removed from Board membership</li> <li>Dragging card from assigned user created user image as card</li> <li>Sending duplicate due date reminders</li> <li> <p>Card drag and drop</p> <ul> <li>issue where a duplicate card appears when drag to end</li> <li>issue where card jumps back to top when dragging a card to end of same list</li> </ul> </li> <li> <p>Issue with exporting Board as CSV with special characters (e.g. Umlaut)</p> </li> <li>German translations with extra '}' character</li> </ul>"},{"location":"boards/releases/#2023-05-12","title":"2023-05-12","text":"<p>Fixes:</p> <ul> <li>Security issue affecting external users and public communities</li> </ul>"},{"location":"boards/releases/#2023-01-24","title":"2023-01-24","text":"<p>Improvements:</p> <ul> <li>Handling of default profile images in Connections</li> <li>Detect language from Connections dropdown</li> </ul> <p>Fixes:</p> <ul> <li>Styling for HCL Connections 8 'Important-to-Me' sidebar</li> <li>Handling of licence with new organisation in store</li> </ul>"},{"location":"boards/releases/#2023-01-17","title":"2023-01-17","text":"<p>Improvements:</p> <ul> <li>Styling for HCL Connections 8 new UI</li> </ul>"},{"location":"boards/releases/#2023-01-03","title":"2023-01-03","text":"<p>Improvements:</p> <ul> <li>Security updates (node 18)</li> </ul> <p>Fixes:</p> <ul> <li>Issue with blank page served on <code>/boards</code></li> </ul>"},{"location":"boards/releases/#archive","title":"Archive","text":"<p>For release history before 2023 please see here.</p>"},{"location":"boards/security/","title":"Boards Cloud Security","text":""},{"location":"boards/security/#how-does-an-end-user-login-to-boards","title":"How does an end user login to Boards?","text":"<ul> <li>Users login by authenticating via OAuth 2.0 with Connections Cloud, Office365, Facebook, Google, LinkedIn, Connections on-premise or Auth0.</li> <li>This starts a token-based session with Boards Cloud used to authenticates all future requests.</li> </ul>"},{"location":"boards/security/#what-kind-of-provider-connections-cloud-office365-etc-data-will-be-stored-by-boards-cloud","title":"What kind of Provider (Connections Cloud, Office365 etc) data will be stored by Boards Cloud?","text":"<ul> <li>Basic user profile data (display name, email, subscriberId, customerId)</li> <li>User/community photo</li> <li>Community/Space name and members</li> <li>Links to Files</li> <li>Clone of Connections Activities data after imported by the user</li> </ul>"},{"location":"boards/security/#what-is-the-security-of-data-in-motion","title":"What is the security of data in motion?","text":""},{"location":"boards/security/#requests-between-the-user-and-boards-cloud-servers-are-secured-by","title":"Requests between the User and Boards Cloud servers are secured by:","text":"<ul> <li>Encrypted by HTTPS (SSL)</li> <li>Authenticated using both</li> <li>token-based sessions for all API data</li> <li>cookie-based session for all images</li> </ul>"},{"location":"boards/security/#requests-between-boards-cloud-servers-and-mongo-database-are-secured-by","title":"Requests between Boards Cloud servers and Mongo database are secured by:","text":"<ul> <li>Encrypted by HTTPS (SSL)</li> <li>Authenticated using username/password</li> <li>IP whitelisting</li> </ul>"},{"location":"boards/security/#requests-between-boards-cloud-servers-and-google-cloud-s3-object-storage-are-secured-by","title":"Requests between Boards Cloud servers and Google Cloud S3 Object Storage are secured by:","text":"<ul> <li>Encrypted by HTTPS (SSL)</li> <li>Authenticated using username/password</li> <li>Internal Google network - data is not communicated over the public internet</li> </ul>"},{"location":"boards/security/#requests-between-boards-cloud-servers-and-providers-connections-office365-etc-are-secured-by","title":"Requests between Boards Cloud servers and providers (Connections, Office365 etc) are secured by:","text":"<ul> <li>Encrypted by HTTPS (SSL)</li> <li>Authenticated using OAuth2 access tokens</li> </ul>"},{"location":"boards/security/#other-remarks","title":"Other remarks:","text":"<ul> <li>Boards Cloud is hosted by Google Cloud in the EU West region</li> <li>CSRF is not a threat as all our APIs are strictly JSON and we don't support CORS.</li> <li>We use token based express-sessions and helmetJS for express to provide additional security around XSS, framing, and sessions. Tokens are JWT encoded with secret keys.</li> <li>SQL injection is not relevant as we are not using any SQL dbs.</li> <li>We use Content-Security-Policy headers to limit framing to only be self and Connections Cloud to prevent clickjacking</li> <li>We add X-Content-Type header 'nosniff' to prevent Content sniffing</li> <li>We use a standard REST API pattern. Entity IDs are passed as URL params where applicable for all http requests (GET, POST, PUT, DELETE). No actual data is passed as URL params or query params.</li> </ul>"},{"location":"boards/security/#what-is-the-security-of-data-at-rest","title":"What is the security of data at rest?","text":"<p>Most 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.</p>"},{"location":"boards/security/#mongodb-atlas-is-secured-by","title":"MongoDB Atlas is secured by:","text":"<ul> <li>Two Factor Authentication</li> <li>IP Whitelist</li> <li>Encryption at rest - AWS Key Management Service (AWS KMS) to encrypt storage engines and cloud provider backups</li> <li>Each MongoDB Atlas group is provisioned into its own VPC, thus isolating your data and underlying systems from other MongoDB Atlas users</li> <li>Network encryption and access control</li> <li>All security-specific updates to the operating system and database of the underlying instances are automatically applied by MongoDB engineers.</li> <li>MongoDB, Inc. is also certified under the EU-US Privacy Shield.</li> <li>More information about MongoDB Cloud Services Compliance and Privacy can be obtained here</li> </ul>"},{"location":"boards/security/#google-cloud-object-storage-is-secured-by","title":"Google Cloud Object storage is secured by:","text":"<ul> <li>No external access other than our server</li> <li>S3 standard token/secret authentication</li> <li>Encrypted by HTTPS (SSL)</li> </ul>"},{"location":"boards/security/#are-there-any-passwords-saved-by-boards-cloud","title":"Are there any passwords saved by Boards Cloud?","text":"<p>There are NO passwords stored by the app.</p>"},{"location":"boards/tours/","title":"Tours","text":""},{"location":"boards/tours/#boards-tours","title":"Boards Tours","text":"<p>You can create your own tours by calling the <code>boards.setTours()</code> function in console.</p> <p>Open dev tools with <code>Cmd-Shift-I</code> or <code>Ctrl-Shift-I</code> then got to the console tab</p> <p>Tours are currently disabled by default, to enable them type <code>boards.enableTours()</code> then press Enter, now reload your page and the tours will be available.</p>"},{"location":"boards/tours/#tour-definition","title":"Tour Definition","text":"Field Description required id unique identifier yes routes the URLs which make the tour applicable (* is a wildcard) yes sizes Supported screen sizes no disabled Disables this tour no disableAnimation Disables animation for this tour no steps the parts of the tour to step through yes"},{"location":"boards/tours/#step-definition","title":"Step Definition","text":"Field Description required spotlight query selector identifying the element on the page to highlight yes when query selector looking for an element on the page, when the element is present we will automatically move to this step no title tour popup title yes body the paragraphs to show below that yes actions any urls to link to no placement defines where to place the tour step in relation to the spotlighted element no hideArrow hides the arrow pointing to the spotlighted element no"},{"location":"boards/tours/#placement-options","title":"Placement options","text":"<ul> <li>top, top-start, top-end</li> <li>bottom, bottom-start, bottom-end</li> <li>left, left-start, left-end</li> <li>right, right-start, right-end</li> <li>auto (it will choose the best position)</li> <li>center (set the target to body)</li> </ul>"},{"location":"boards/tours/#full-example","title":"Full example","text":"<pre><code>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}])\n</code></pre>"},{"location":"boards/admin/content-member-management/","title":"Boards Content and Member Management","text":"<p>Organisation 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</p> <ul> <li> <p>a) Boards Cloud</p> <p>On the Huddo Boards homepage / My Boards page, click your organisation on the left sidebar, then click the <code>Boards</code> tab to view the list of boards:</p> <p></p> </li> <li> <p>b) Boards On-Premise</p> <p>Open <code>Admin Settings</code>, then your organisation</p> <p></p> <p>Under <code>Content management</code> click <code>Boards</code></p> <p></p> </li> </ul>"},{"location":"boards/admin/content-member-management/#sorting","title":"Sorting","text":"<p>The boards data can be sorted by clicking on the column headers:</p> <p></p>"},{"location":"boards/admin/content-member-management/#searching","title":"Searching","text":"<p>Boards can be searched by board name or by owner.</p> <p>Click the search icon to the left of the column name to search:</p> <p></p>"},{"location":"boards/admin/content-member-management/#by-board-name","title":"By Board Name","text":"<p>Type a board name to filter the results:</p> <p></p>"},{"location":"boards/admin/content-member-management/#by-owner","title":"By Owner","text":"<p>Search for a group or user and then select an entity to show only boards that have that owner:</p> <p></p>"},{"location":"boards/admin/content-member-management/#showhide-archived-boards","title":"Show/hide archived boards","text":"<p>Archived boards can be shown or hidden by using the switch in the <code>Archived</code> column header:</p> <p></p>"},{"location":"boards/admin/content-member-management/#edit-members-of-a-board","title":"Edit members of a board","text":"<p>Members for each individual board can be viewed and modified by clicking the <code>Edit Members</code> button on the right of the board row:</p> <p></p> <p></p>"},{"location":"boards/admin/content-member-management/#selected-board-options","title":"Selected board options","text":"<p>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:</p> <p></p>"},{"location":"boards/admin/content-member-management/#archive","title":"Archive","text":"<p>Archive the selected boards.</p>"},{"location":"boards/admin/content-member-management/#restore","title":"Restore","text":"<p>Restore boards that are archived.</p>"},{"location":"boards/admin/content-member-management/#manage-ownership","title":"Manage Ownership","text":"<p>This action will show a dialog allowing new owners to be added and/or existing owners removed from the boards that are selected:</p> <p></p>"},{"location":"boards/admin/content-member-management/#delete","title":"Delete","text":"<p>Danger</p> <p>Use this action cautiously and at your own risk.</p> <p>Delete the selected boards and all their data permanently.</p> <p></p>"},{"location":"boards/admin/content-member-management/#find-and-replace-owner-on-all-boards","title":"Find and replace owner on all boards","text":"<p>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:</p> <ol> <li> <p>Click the <code>Find and replace owner on all boards</code> button to bring up a dialog:</p> <p></p> </li> <li> <p>Search for and select the current owner to replace and the new/replacement owner. Groups can be selected:</p> <p></p> </li> <li> <p>Click the <code>Replace Owner</code> button to confirm the owner replacement:</p> <p></p> <p>Note</p> <p>an undo action will temporarily appear at the bottom left of screen if you wish to cancel this action</p> </li> </ol>"},{"location":"boards/admin/deactivate-login/","title":"Deactivate Login","text":""},{"location":"boards/admin/deactivate-login/#process","title":"Process","text":"<ol> <li> <p>Remove OAuth ClientID from user.env</p> <p>Comment out the CLIENT_ID for the provider to be deactivated:</p> <pre><code>user:\n  env:\n    # CONNECTIONS_CLIENT_ID\n    # MSGRAPH_CLIENT_ID\n</code></pre> </li> <li> <p>Redeploy the Helm chart</p> <p>For example:</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Reload webpage</p> <p>The login option should be removed</p> </li> </ol>"},{"location":"boards/admin/link-users/","title":"Link User Accounts","text":"<p>Note: admins only - on premise</p> <p>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).</p>"},{"location":"boards/admin/link-users/#prerequisites","title":"Prerequisites","text":"<ol> <li> <p>Profiles are synchronised</p> <p>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</p> </li> </ol>"},{"location":"boards/admin/link-users/#important-notes","title":"Important Notes","text":"<ul> <li>Please be aware that if you intend to remove login then the primary ID should be set as the ID for your intended login client (ie Microsoft), and the secondary that of the login method you to plan to remove (eg Connections). These IDs are visible in the URL of the admin page visited in the profile linking step.</li> <li>Accounts are matched on email address</li> <li>The process is run immediately on the next deployment of the <code>user</code> microservice</li> <li>Only run one replica to avoid conflicts, hence <code>replicaCount: 1</code></li> <li> <p>You can view the logs of the user service to see an output of changes </p> <ul> <li>users who were found in both clients</li> <li>users who could not be matched by their email prefix</li> <li>users who are already linked</li> <li>users who have been linked as a result of the command</li> </ul> </li> <li> <p>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.</p> </li> </ul>"},{"location":"boards/admin/link-users/#process","title":"Process","text":"<ol> <li> <p>Environment variables</p> <p>This process links users in 2 difference clients.  We utilise environment variables to initialise the process, e.g.</p> <pre><code>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 &amp; jsmith@isw.net.au\n    # PROFILE_LINK_EMAIL_PREFIX_ONLY: true\n</code></pre> </li> <li> <p>Redeploy the Helm chart</p> <p>For example:</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Review the logs</p> <p>The logs should output in this format. Note the users who have been <code>updated</code>/<code>ignored</code>. On subsequent runs the people in <code>updated</code> will appear in <code>noChange</code> instead.</p> <p></p> </li> <li> <p>Remove Environment variables above and redeploy the Helm chart</p> </li> </ol>"},{"location":"boards/admin/manage-licences/","title":"Manage Licences","text":""},{"location":"boards/admin/manage-licences/#manage-licences","title":"Manage Licences","text":"<p>Licence management is available at an organisation level for Huddo Boards.</p> <p>To access these settings, sign in to Huddo Boards as an administrator of your organisation. Click your profile image and then <code>Admin Settings</code>:</p> <p></p> <p>The licence(s) for your org will be shown, each one can be opened for more information.</p> <p></p> <p>Here you can see all the users who have been assigned a licence.</p> <p>'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.</p> <p></p> <p>Note that Org Configs are created automatically for all orgs with default settings.</p>"},{"location":"boards/admin/manage-licences/#buy-huddo-boards-via-admin-settings","title":"Buy Huddo Boards via Admin Settings","text":"<p>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.</p> <p>Navigate to <code>Admin Settings</code> and then select to 'Buy Online'.</p> <ul> <li>Specify your type of licence - Named Users Licence or Open Licences.</li> <li>Select your billing preference - Monthly or Annually (note: annual subscriptions include a 15% discount)</li> <li>Quantity of licences to purchase</li> <li>Review your order summary, agree to the terms and conditions and select Continue, to move to the online check out.</li> </ul> <p> </p> <p>Your subscription will be updated automatically.</p>"},{"location":"boards/admin/manage-licences/#buy-huddo-boards-via-microsoft-teams","title":"Buy Huddo Boards via Microsoft Teams","text":"<p>As an O365 administrator, you can buy Huddo Boards for your organisation via Microsoft Teams.</p> <p>Navigate to Huddo Boards MyBoards Dashboard via More Added Apps in Microsoft Teams and under your profile image locate <code>Admin Settings.</code></p> <p></p> <p>Click Organisation to see your org details.</p> <p></p> <p>Under 'Licences' select to 'Buy Online.'</p> <p></p> <ul> <li>Specify your type of licence - Named Users Licence or Open Licences.</li> <li>Select your billing preference - Monthly or Annually (note: annual subscriptions include a 15% discount)</li> <li>Quantity of licences to purchase</li> <li>Review your order summary, agree to the terms and conditions and select Continue, to move to the online check out.</li> </ul> <p></p>"},{"location":"boards/admin/manage-licences/#request-a-quote-or-invoice-for-payment","title":"Request a Quote or Invoice for Payment","text":"<p>On-premise Huddo Boards installs can contact us for quote requests and licence activation keys at <code>hello@huddo.com</code></p> <p>Huddo Boards cloud users can request a quote via Huddo Boards Admin Settings in web or Microsoft Teams, or via email at <code>hello@huddo.com</code>. Please do not hesitate to ask questions or request a call to discuss your subscription requirements further.</p> <p>In addition to online check out, we can receive purchase orders and provide invoices for payment.</p> <p>Pricing can be found here https://www.huddo.com/pricing</p>"},{"location":"boards/admin/org-config/","title":"Manage Config","text":""},{"location":"boards/admin/org-config/#manage-organisation-config","title":"Manage Organisation Config","text":"<p>Configuration options are available at an organisation level for Huddo Boards. Changing these settings will affect all Huddo Boards users in your organisation.</p> <p>To access these settings, sign in to Huddo Boards as an administrator of your organisation. Click your profile image and then <code>Admin Settings</code>:</p> <p></p> <p>The config for your org will be shown, hover on the info (i) icons for more information on each setting</p> <p></p> <p>Changing a setting will immediately save/update the Org Config for all users.</p> <p>Note: Org Configs are created automatically for all orgs with default settings.</p>"},{"location":"boards/admin/replace-group-membership/","title":"Replacing Group Membership","text":"<p>Note: admins only - on premise</p> <p>This service is designed to replace Board memberships for groups in one login client with replacement groups in another login client.</p> <p>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.</p>"},{"location":"boards/admin/replace-group-membership/#important-notes","title":"Important Notes","text":"<ul> <li>Please be aware that the <code>target</code> ID below should be set as the ID for your intended login method (ie Microsoft), and the <code>source</code> that of the login method being removed (ie Connections). These IDs are visible in the URL of the admin page.</li> <li>The process is run immediately on the next deployment of the boards app.</li> <li>Only run one replica to avoid conflicts, hence <code>replicaCount: 1</code></li> <li>You can view the logs of the <code>boards-app</code> microservice to see an output of changes to source/target groups</li> <li>The command is safe to run multiple times. There will be no new changes unless more group memberships have been imported into the Boards DB.</li> </ul>"},{"location":"boards/admin/replace-group-membership/#prerequisites","title":"Prerequisites","text":"<p>You have created replacement groups in the target system and have records of the old ID to the new ID.</p>"},{"location":"boards/admin/replace-group-membership/#process","title":"Process","text":"<ol> <li> <p>Create CSV Map File</p> <p>This process utilises a CSV file to define a map between the old ID and new ID, in the format:</p> <pre><code>&lt;NAME_OF_GROUP&gt;,&lt;COMMUNITY_ID&gt;,&lt;SHAREPOINT_SITE_ID&gt;\n</code></pre> <p>For example:</p> <p><code>group-map.csv</code></p> <pre><code>Huddo Team,95bf5326-ee35-4e4a-b121-9b6970f86931,532fbe3d-239e-4421-b8c0-4c4d2eb87204\n</code></pre> </li> <li> <p>Secret with CSV</p> <p>Create a secret in the Boards namespace (ie boards) from your CSV file</p> <pre><code>kubectl create secret generic group-map-secret --from-file=./group-map.csv -n boards\n</code></pre> </li> <li> <p>Environment variables</p> <p>Set the following environment variables to mount the secret created above at a file path in the pod.</p> <pre><code>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\n</code></pre> </li> <li> <p>Redeploy the Helm chart</p> <p>For example:</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Review the logs</p> <p>The logs should output in this format. See that each group was mapped from a <code>Source</code> to a <code>Target</code> and how many <code>members</code>/<code>nodes</code> were updated with the new value.</p> <p></p> </li> <li> <p>Remove Environment variables above and redeploy the Helm chart</p> </li> </ol>"},{"location":"boards/admin/revoke-users/","title":"Revoke Users","text":"<p>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:</p> <ol> <li> <p>Open <code>Admin Settings</code>, then your <code>Organisation</code></p> <p></p> </li> <li> <p>Under <code>User management</code> click <code>Revoke</code></p> <p></p> </li> <li> <p>Select whether to <code>Anonymise the user name, email and image</code></p> <p></p> </li> <li> <p>Search and select the user to revoke, click <code>Revoke</code></p> <p></p> </li> </ol>"},{"location":"boards/admin/sync-profiles/","title":"Synchronise User Profiles","text":"<p>This process ensures that all users in your Connections/Microsoft accounts exist in the Boards database.</p> <p>Note: this is only necessary if you are linking user accounts in bulk</p>"},{"location":"boards/admin/sync-profiles/#connections","title":"Connections","text":"<p>You can now synchronise all user profiles from Connections by opening the <code>Admin =&gt; Org =&gt; Connections</code> client page (e.g. <code>/admin/5eeff4a3b7adaab62352362f/client/5fd6974dd7c5ede08711432d</code>) This service utilises the Connections Profiles Admin API which is only basic auth, so you need to add credentials for a user (eg <code>wasadmin</code>) who has the Admin role on the Profiles application.</p> <p></p>"},{"location":"boards/admin/sync-profiles/#microsoft","title":"Microsoft","text":"<p>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)</p> <p></p>"},{"location":"boards/admin/sync-profiles/#process","title":"Process","text":"<p>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.</p>"},{"location":"boards/admin/transfer-ownership-unlink/","title":"Transfer Ownership &amp; Unlink User Accounts","text":"<p>Note: admins only - on premise</p> <p>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. </p>"},{"location":"boards/admin/transfer-ownership-unlink/#important-notes","title":"Important Notes","text":"<ul> <li>Please be aware that the <code>to</code> client target ID below should be set as the ID for your intended login method (ie Microsoft), and the <code>from</code> that of the login method being removed (ie Connections). These IDs are visible in the URL of the admin page.</li> <li>The process is run immediately on the next deployment of the boards app.</li> <li>Only run one replica to avoid conflicts, hence <code>replicaCount: 1</code></li> <li>You can view the logs of the <code>boards-app</code> microservice to see an output of changes to source/target groups</li> <li>The command is safe to run multiple times. There will be no new changes unless more user accounts have been linked.</li> </ul>"},{"location":"boards/admin/transfer-ownership-unlink/#process","title":"Process","text":"<ol> <li> <p>Environment variables</p> <p>Set the following environment variables</p> <pre><code>app:\n  replicaCount: 1\n  env:\n    TRANSFER_AND_UNLINK_TO_CLIENT: 5fd6974dd7c5ede08711432d\n    TRANSFER_AND_UNLINK_FROM_CLIENT: 5ef2d52f6283afc12efd55a4\n</code></pre> </li> <li> <p>Redeploy the Helm chart</p> <p>For example:</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Review the logs</p> <p>The logs should output information in this format. Note each transfer of content ownership <code>from</code> =&gt; <code>to</code> and the number of associated nodes/members/invites that were updated, before the alias is unlinked from the primary.</p> <p></p> </li> <li> <p>Remove Environment variables above and redeploy the Helm chart</p> </li> </ol>"},{"location":"boards/admin/transition-between-providers/","title":"How To Transition between Providers","text":"<p>Note: admins only - on premise</p> <p>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.</p> <ol> <li>Backup the Boards mongo database</li> <li>Synchronise user profiles</li> <li>Link users accounts</li> <li>Replace group membership</li> <li>Transfer ownership &amp; unlink user accounts</li> <li>Deactivate login with original provider</li> </ol>"},{"location":"boards/admin/url-update/","title":"URL Update","text":""},{"location":"boards/admin/url-update/#update-content-urls-in-database","title":"Update content URLs in database","text":"<p>When the URL of the on-prem hosting environment changes, content stored in Huddo Boards may also need to be updated.</p> <p>The below will change all URLs in the names, descriptions and links for each node (card/board/comment). Replace both the <code>domain</code> and <code>newDomain</code> with your old and new URLs. The domain variable is a regular expression (regex) that needs the initial <code>/</code> and trailing <code>/ig</code>; in place and any special characters escaped with <code>\\</code>, such as in the example below.</p> <p>Connect to the Mongo DB hosting the Boards database and run the following in the mongo shell</p> <pre><code>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'\n</code></pre> <p>Each 2 lines of code (nodeNames, nodeDesc &amp; nodeLinks) updates one bit of a node and can be run independently of each other.</p>"},{"location":"boards/admin/url-update/#node-names","title":"Node Names","text":"<pre><code>nodeNames = db.nodes.find({ name: { $regex: domain }}, { name: 1 }).toArray();\nnodeNames.forEach(n =&gt; db.nodes.updateOne({ _id: n._id }, { $set: { name: n.name.replace(domain, newDomain) }}) )\n</code></pre>"},{"location":"boards/admin/url-update/#node-descriptions","title":"Node Descriptions","text":"<pre><code>nodeDesc = db.nodes.find({ description: { $regex: domain }}, { description: 1 }).toArray();\nnodeDesc.forEach(n =&gt; db.nodes.updateOne({ _id: n._id }, { $set: { description: n.description.replace(domain, newDomain) }}) )\n</code></pre>"},{"location":"boards/admin/url-update/#node-links","title":"Node Links","text":"<pre><code>nodeLinks = db.nodes.find({ 'links.url': { $regex: domain }}, { links: 1 }).toArray();\nnodeLinks.forEach(n =&gt; db.nodes.updateOne({ _id: n._id }, { $set: { links: n.links.map(link =&gt; { link.url = link.url.replace(domain, newDomain); return link; })}}) )\n</code></pre>"},{"location":"boards/aio/","title":"Huddo Boards All-in-One (AIO) Docker setup","text":"<p>Tip</p> <p>This document outlines a standalone (all in one) deployment of Huddo Boards using <code>docker-compose</code>. This can be used as a proof of concept, staging deployment or even a production deployment for a limited number of users (e.g. &lt; 500).</p> <p>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.</p>"},{"location":"boards/aio/#server-requirements","title":"Server requirements","text":"<p>RHEL (or Centos 7) server with:</p> <ul> <li>8gb ram minimum</li> <li>4 vCPUs</li> <li>40gb system drive</li> <li>100gb data drive (will be shared for database and file store) <sup>*see Data/Services below</sup></li> <li>docker and docker-compose</li> </ul>"},{"location":"boards/aio/#options","title":"Options","text":""},{"location":"boards/aio/#network","title":"Network","text":"<p>The implementation of this can be either:</p> Deployment Type Example URLs Comments Paths <code>yourdomain.com/boards.com</code> <code>yourdomain.com/api-boards</code> use your existing domain, no additional certificates, easier SSO integration of HCL Connections header. Subdomain <code>boards.yourdomain.com</code><code>boards-api.yourdomain.com</code> requires 2 domains (and therefore certificates) in your environment."},{"location":"boards/aio/#dataservices","title":"Data/Services","text":"<p>Boards utilises 3 types of data services:</p> <ol> <li>Mongodb (persistent data)</li> <li>S3 file store (persistent data)</li> <li>Redis cache.</li> </ol> <p>Each of these may use external services (e.g. Mongo Atlas) or the included services in the template (this hugely changes the server demand).</p>"},{"location":"boards/aio/#backups","title":"Backups","text":"<p>Warning</p> <p>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.</p>"},{"location":"boards/aio/#deployment","title":"Deployment","text":""},{"location":"boards/aio/#access-to-images","title":"Access to Images","text":"<p>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 <code>docker login</code> command available from the Quay.io interface, for example:</p> <pre><code>docker login -u=\"&lt;username&gt;\" -p=\"&lt;encrypted-password&gt;\" quay.io\n</code></pre>"},{"location":"boards/aio/#configuration","title":"Configuration","text":"<p>Download the appropriate configuration files for your deployment type:</p> Deployment Type URL Files Paths <code>/boards</code>, <code>/api-boards</code> docker-compose.ymlnginx proxy conf Subdomain <code>boards.yourdomain.com</code>,<code>boards-api.yourdomain.com</code> docker-compose.ymlnginx proxy conf <p>Update all example values in both files as required. Most required variables are in the template, for more information see the Kubernetes docs</p> <ul> <li>Global config</li> <li>Boards variables</li> </ul>"},{"location":"boards/aio/#s3-storage","title":"S3 Storage","text":"<p>The minio credentials are are used to both set in the minio service and access it from other services;</p> <ul> <li><code>x-minio-access</code> is used as the username in minio</li> <li><code>x-minio-secret</code> is used as the password.</li> </ul> <p>See the minios documentation on these fields, and an example of the values used here. The standard seems to be around 20 characters all caps/numbers for the username and around 40 characters any case / number for the password.</p>"},{"location":"boards/aio/#authentication","title":"Authentication","text":"<p>The <code>user</code> env variables in the compose file assume you are installing this in an HCL Connections environment. These can be removed or replaced with 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.</p>"},{"location":"boards/aio/#dns-proxy","title":"DNS / Proxy","text":"<p>Please follow the instructions for your chosen deployment type:</p> <ul> <li>Paths</li> <li>Subdomain</li> </ul>"},{"location":"boards/aio/#start","title":"Start","text":"<p>Once you have updated the appropriate <code>docker-compose.yml</code> and <code>nginx.conf</code> with your environment details, you can start the services with:</p> <pre><code>docker-compose up -d\n</code></pre>"},{"location":"boards/aio/#debugging","title":"Debugging","text":"<p>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.</p> <p>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 <code>docker-compose logs mongo</code></p> <p>To remove any other network configuration/hops on the docker server you should be able to: <code>curl -H \"Host: your.web.url\" --insecure https://localhost</code> This should return the html from webfront <code>curl -H \"Host: your.api.url\" --insecure https://localhost</code> This should return the html for the swagger api documentation <code>curl -H \"Host: your.api.url\" --insecure https://localhost/health</code> This should return \"{listening: 3001}\"</p> <p>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 <code>docker-compose logs nginx</code> to see if it points out any misconfiguration</p> <p>The core image has ping enabled and has access to all others so you can use it to test connectivity</p> <pre><code>docker-compose exec -it core sh\nping user\nping mongo\n... etc\n</code></pre>"},{"location":"boards/aio/paths/","title":"Proxy Configuration","text":"<p>The following configuration should be set when Huddo Boards is deployed at a context root under an existing domain (e.g. HCL Connections).</p>"},{"location":"boards/aio/paths/#nginx","title":"nginx","text":"<p>Please add the following location blocks to your proxy <code>server</code> -&gt; <code>listen 443</code> blocks:</p> <pre><code># Boards UI\nlocation /boards {\n    proxy_pass http://[DOCKER_COMPOSE_HOSTNAME]:80/boards;\n}\n\n# Boards API (including WebSocket support)\nlocation /api-boards {\n    proxy_pass http://[DOCKER_COMPOSE_HOSTNAME]:80/api-boards;\n    proxy_http_version 1.1;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection \"upgrade\";\n    proxy_set_header Host $host;\n}\n</code></pre> <p>Where:</p> <ul> <li><code>[DOCKER_COMPOSE_HOSTNAME]</code> is the hostname/IP of the server running the Docker Compose</li> </ul>"},{"location":"boards/aio/paths/#httpd","title":"httpd","text":"<p>Please add the following Proxy rules to the VirtualHost 443 block:</p> <pre><code>&lt;VirtualHost *:443&gt;\n    ServerName [HOST_DOMAIN]\n\n    #Huddo Boards\n    ProxyPass \"/boards\" \"http://[DOCKER_COMPOSE_HOSTNAME]:80/boards\"\n    ProxyPassReverse \"/boards\" \"http://[DOCKER_COMPOSE_HOSTNAME]:80/boards\"\n    ProxyPass \"/api-boards\" \"http://[DOCKER_COMPOSE_HOSTNAME]:80/api-boards\"\n    ProxyPassReverse \"/api-boards\" \"http://[DOCKER_COMPOSE_HOSTNAME]:80/api-boards\"\n    #End Huddo Boards\n&lt;/VirtualHost&gt;\n</code></pre> <p>Where:</p> <ul> <li><code>[HOST_DOMAIN]</code> is the URL of your environment, e.g. HCL Connections deployment</li> <li><code>[DOCKER_COMPOSE_HOSTNAME]</code> is the hostname/IP of the server running the Docker Compose</li> </ul>"},{"location":"boards/aio/subdomain/","title":"Subdomain","text":"<p>This setup assumes that you will have 2 subdomains 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 file.</p>"},{"location":"boards/aio/subdomain/#setup","title":"Setup","text":"<ol> <li>Configure your DNS to point the subdomains to the server running docker compose.</li> </ol>"},{"location":"boards/api/","title":"Using the Boards API","text":"<p>Boards has a REST API that allows you to access and manage your boards data. The API documentation is available online from Boards Cloud and also from your Boards deployment (including in-built Swagger documentation).</p> <p>The API is documented using OpenAPI (Swagger) and can be explored using the Swagger UI.</p>"},{"location":"boards/api/#determine-your-api-url","title":"Determine your API URL","text":"<p>The API URL is based on your Boards deployment:</p> <ul> <li>Boards Cloud - https://boards.api.huddo.com</li> <li> <p>On-Premise - for example:</p> <ul> <li>https://connections.company.com/api-boards/</li> <li>https://boards-api.company.com</li> </ul> </li> </ul>"},{"location":"boards/api/#authentication","title":"Authentication","text":"<p>The API requires authentication via the user's API Token. To get your API Token:</p> <ol> <li> <p>login to your Boards environment</p> </li> <li> <p>open the user menu, expand <code>Advanced</code>, and click <code>Huddo Boards API</code></p> <p></p> </li> <li> <p>copy the token</p> <p></p> </li> <li> <p>include this token to requests to the Boards API in the <code>Authorization</code> header</p> <p>For example:</p> <ul> <li>Method: <code>GET</code></li> <li>URL: <code>https://&lt;BOARDS_URL&gt;/user/me</code></li> <li>Headers: <code>Authorization: Bearer &lt;token&gt;</code></li> </ul> <p></p> </li> </ol>"},{"location":"boards/api/powerautomate/","title":"Huddo Boards Power Automate Integration","text":"<p>Tip</p> <p>This feature is only available for Huddo Boards Cloud.</p>"},{"location":"boards/api/powerautomate/#what-is-microsoft-power-automate","title":"What is Microsoft Power Automate?","text":"<p>Power Automate is a platform which allows end users to set up \"Flows\" which are workflows that connect two or more applications (like Huddo Boards). Each Flow consists of a \"Trigger\" and one or more \"Actions\". When the trigger event occurs, Power Automate automatically performs the actions.</p>"},{"location":"boards/api/powerautomate/#huddo-boards-connector","title":"Huddo Boards Connector","text":"<p>Huddo Boards is now available as a connector in Microsoft Power Automate. Create simple or complex flows to help you work across multiple applications and save time on repeatable tasks. Have you found a flow that works for you? Share it with us and we\u2019ll turn it in to a template.</p> <p></p>"},{"location":"boards/api/powerautomate/#triggers-webhooks","title":"Triggers / Webhooks","text":"<p>See the available Triggers / Webhooks.</p>"},{"location":"boards/api/powerautomate/#actions","title":"Actions","text":"<p>See the available Actions.</p>"},{"location":"boards/api/zapier/","title":"Huddo Boards Zapier Integration","text":"<p>Tip</p> <p>This feature is only available for Huddo Boards Cloud.</p>"},{"location":"boards/api/zapier/#what-is-zapier","title":"What is Zapier?","text":"<p>Zapier is a platform which allows end users to set up \"Zaps\" which are workflows that connect two or more applications (like Huddo Boards). Each Zap consists of a \"Trigger\" and one or more \"Actions\". When the trigger event occurs, Zapier automatically performs the actions.</p>"},{"location":"boards/api/zapier/#huddo-boards-zaps","title":"Huddo Boards Zaps","text":"<p>See the Huddo Boards Zapier Integration on the Zapier website.</p> <p></p>"},{"location":"boards/api/zapier/#triggers","title":"Triggers","text":"<p>Huddo Boards provides a Zapier integration that allows you to trigger Zaps based on events in Boards. The following are some of the triggers which are available:</p> Trigger Description New Board Triggers when a new board is created. New Card Triggers when a new card is created. Assigned Task Triggers when a task is assigned to a user. Task Completed Triggers when a task is completed. Member added to Board Triggers when a member is added to a board. My Task Completed Triggers when a task assigned to the user is completed."},{"location":"boards/api/zapier/#actions","title":"Actions","text":"<p>Huddo Boards provides a Zapier integration that allows you to perform actions in Boards. The following are some of the actions which are available:</p> Action Description Create Board Creates a new board. Create Card Creates a new card (entry/task in a Board). Create Comment on Card Adds a comment to a card. Assign Task to Member Assigns a task to a member of the board. Complete Task Completes a task. Add Member to Board Adds a member to a board. Find a Task by name and mark as complete Finds a task by name and marks it as complete. Find a Task by name and mark as incomplete Finds a task by name and marks it as incomplete. Move Card Moves a card to a different list or subtask. Change Card or Board Dates Change Start, End or Due dates on a Card / Board"},{"location":"boards/api/zapier/#searches","title":"Searches","text":"<p>Huddo Boards provides a Zapier integration that allows you to search for data in Boards. The following are some of the searchs which are available:</p> Search Description Find a Board by name Finds a board by name. Find a Card in a Board by name Finds a card in a board by name. Find a Task assigned to Me by name Finds a task assigned to the user by name. Find Board Members Gets all members of a board. Find a Board Member by name Finds a member of a board by name. Find all Cards in a Board Gets all cards in a board. Find Comments on a Card Gets all comments on a card. Find Me Gets the user details. Find User by name Finds a user by name. Find a Board or Card URL in a block of text Finds a Board or Card URL in a block of text."},{"location":"boards/apps/","title":"Boards Micro Apps","text":"<p>Huddo Boards includes a number of micro applications that can be used to integrate the functionality of Boards within other systems. If you have a specific requirement that is not covered by the micro apps below, please contact us to discuss.</p>"},{"location":"boards/apps/#typical-integration","title":"Typical Integration","text":"<p>To integrate a micro app into your system, you can use an iframe. It is best practice to include authentication details required for your environment. For example:</p> <p><code>&lt;iframe src=\"https://&lt;BOARDS_URL&gt;/auth/&lt;PROVIDER&gt;/&lt;CLIENTID&gt;?redirect_to=&lt;APP_URL&gt;\" width=\"600\" height=\"800px\"/&gt;</code></p>"},{"location":"boards/apps/#available-apps","title":"Available Apps","text":""},{"location":"boards/apps/#my-next-tasks-summary","title":"My Next Tasks Summary","text":"<p>This app displays a summary of the user's next tasks in a compact format.</p> <p>APP_URL: <code>/app/tasks/summary</code></p> <p></p>"},{"location":"boards/apps/#my-next-tasks","title":"My Next Tasks","text":"<p>This app displays the user's next tasks in a list format.</p> <p>APP_URL: <code>/app/tasks/next</code></p> <p></p>"},{"location":"boards/apps/#create-card","title":"Create Card","text":"<p>This app allows users to create a new card in a specific board.</p> <p>APP_URL: <code>/app/createcard</code></p> <p></p>"},{"location":"boards/apps/#attach-card","title":"Attach Card","text":"<p>This app allows users to attach a link to a board, list or card. This integration is useful in applications sending email (e.g. Outlook/Verse).</p> <p>APP_URL: <code>/app/attachcard</code></p> <p>Board:</p> <p></p> <p>Card:</p> <p></p>"},{"location":"boards/apps/#linked-cards","title":"Linked Cards","text":"<p>This app displays a list of cards which have links (bookmarks) of the URL specified in the query parameter.</p> <p>APP_URL: <code>/app/linkedcards?url=&lt;ENCODED_URL&gt;</code></p> <p>Where <code>&lt;ENCODED_URL&gt;</code> is the <code>encodeURIComponent(url)</code> of the URL to search for,</p> <p>e.g. <code>/app/linkedcards?url=https%3A%2F%2Fgoogle.com</code></p> <p></p>"},{"location":"boards/auth0/","title":"Auth0","text":"<p>This 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.</p> <p>You may switch to using one of our other supported authentication providers at a later stage should you wish.</p>"},{"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":"<ul> <li>Sign up at Auth0 by providing your email and a suitable password.</li> </ul> <ul> <li>Choose a tenant domain and region</li> </ul> <ul> <li>Fill in your company details</li> </ul> <ul> <li>Create a new application, providing <code>Huddo Boards</code> for the name and choose <code>Regular Web Applications</code> as the type.</li> </ul> <ul> <li>Open your application and go to the settings tab.</li> </ul> <ul> <li>Provide the rest of the details as below:</li> </ul> <p>In the table below, copy your auth0 domain (listed at the top of the page) into the relevant fields, replacing &lt;domain&gt; with 'your-domain.au.auth0.com' where applicable</p> 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/&lt;domain&gt;/callback Allowed Web Origins https://boards.huddo.com Allowed Origins (CORS) https://*.huddo.com <ul> <li>Click Show Advanced Settings -&gt; Grant Types and tick <code>Implicit</code>, <code>Authorization Code</code>, <code>Refresh Token</code> and <code>Client Credentials</code></li> <li>Click Save Changes</li> <li>Send An email to support@huddo.com with your domain, Client ID and Client Secret.</li> </ul>"},{"location":"boards/auth0/#enable-user-searching","title":"Enable user searching","text":"<p>In order to allow your users to find each other, we need to enable one of Auth0's api features.</p> <ul> <li>Click <code>APIs</code> and next to the Auth0 Management API Click the settings button.</li> </ul> <p></p> <ul> <li>Click <code>Machine to Machine Applications</code> and next to Huddo Boards click the <code>AUTHORIZED</code> slider so it is enabled as below.</li> </ul> <p></p> <ul> <li>The Scopes should automatically open as below, if they do not click the <code>&gt;</code> next to the slider above</li> <li>Find and tick the <code>read:users</code> scope then click <code>UPDATE</code></li> </ul> <p></p>"},{"location":"boards/auth0/#adding-users-to-your-auth0-tenant","title":"Adding Users to your Auth0 tenant","text":"<ul> <li>Login or Sign up to Auth0</li> <li>Click Users under Users and Roles</li> <li>Click <code>Create New User</code> and provide the email and password for the user you wish to add. Leave the Connection as Username-Password-Authentication</li> </ul> <p>If you aren't redirected to the users page, click them to open it</p> <ul> <li>Click <code>Edit</code> under the users name</li> </ul> <p></p> <ul> <li>Update the users full name and click <code>Save</code></li> </ul> <p></p>"},{"location":"boards/auth0/#sign-in-to-huddo-boards-with-your-auth0-tenant","title":"Sign in to Huddo Boards with your Auth0 Tenant","text":"<p>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.</p> <p></p> <p>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.</p> <p></p>"},{"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":"<p>To start using your Auth0 tenant in Huddo Boards, you need to make a few changes to allow login at the new address.</p> <p>Login to Auth0 and go to the applications list</p> <p></p> <p>Click your Kudos Boards application and change the following fields</p> <p>In the table below, copy your auth0 domain (listed at the top of the page) into the relevant fields, replacing &lt;domain&gt; with 'your-domain.au.auth0.com' where applicable</p> 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/&lt;domain&gt;/callback Allowed Web Origins https://boards.huddo.com Allowed Origins (CORS) https://*.huddo.com"},{"location":"boards/cloud/","title":"Boards Cloud","text":"<p>Boards Cloud is Huddo Boards as a service hosted and managed by the Huddo Team. Accessible now at boards.huddo.com.</p> <p>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.</p>"},{"location":"boards/cloud/updates/","title":"Boards Cloud Updates","text":"<p>Please see here for recent changes to Huddo Boards Cloud</p>"},{"location":"boards/cloud/updates/#2024","title":"2024","text":""},{"location":"boards/cloud/updates/#june","title":"June","text":"<p>2024-06-13</p> <p>Improvements:</p> <ul> <li>Mobile: save/cancel buttons when creating comments</li> <li>Mobile (Android): fix for keyboard covering input fields</li> </ul> <p>Fixes:</p> <ul> <li>loading wrong page/route when logging in with multiple windows (e.g. Community widget &amp; Related Tasks)</li> </ul>"},{"location":"boards/cloud/updates/#may","title":"May","text":"<p>2024-05-31</p> <p>Improvements:</p> <ul> <li>only allow link on card to bookmark (not uploaded files)</li> <li>performance of data selection from redux</li> <li>mobile: always show rich text editor toolbar in comments (to access @mentions)</li> </ul> <p>Fixes:</p> <ul> <li>issue where dual tooltips in collapsed Board sidebar</li> <li>Assign Member list overflowing on phone</li> <li>issue with text overflow in card links</li> <li>issue with center alignment of login page on small extra screen devices</li> <li>issue with toolbar position for comments (balloon) under header when adding new comment in sidebar</li> </ul> <p>2024-05-27</p> <p>Features:</p> <ul> <li>Drag and drop of cards between browser tabs/windows</li> <li>Drag and drop bookmarks into Board lists/cards</li> </ul> <p>2024-05-17</p> <p>Accessibility fixes:</p> <ul> <li>Focus highlighting overrides</li> <li>use focus outline rather than background colour</li> <li>Fix for keyboard access to CreateCard app clear buttons to choose board/list</li> <li>MenuHelper.jsx - pass the disabled prop to the button</li> <li>position of assign members menu</li> <li>better focus styling for add board tile button</li> <li>better contrast when focusing on boards logo</li> <li>board tiles sort dropdowns - use defined focus bg and colours</li> <li>minor fixes for focused input controls</li> </ul> <p>2024-05-07</p> <p>Improvements:</p> <ul> <li>Collab Cloud header integration for Cnx8</li> </ul> <p>2024-05-06</p> <p>Usability improvements:</p> <ul> <li>Timeline: add zoom -+ controls that increment zoom levels</li> <li> <p>Mindmap accessibility</p> <ul> <li>1st tab selects board node, allow arrow key nav, and tab to access actions from there</li> <li>sidebar controls - use mui checkboxes + ensure hover effects on buttons</li> <li>clear node selection on escape keypress</li> <li>fix text cutoff/ensure ellipsis on longer node titles</li> <li>add help link to sidebar</li> <li>allow keyboard pan and zoom using shift+arrow and +- keys</li> </ul> </li> <li> <p>add contact support button to error catch page</p> </li> <li>add severity levels when showing toasts, fade transition</li> <li>ensure board creator is displayed as a non-editable owner on board/template creation</li> <li>ensure board tile labels are sorted in selection menu</li> <li>make 'Recent' heading in sidebar look less like other actionable items</li> <li>use delete icon (bin) for remove actions for member tiles, dates, tags, and board tile labels</li> </ul> <p>Fixes:</p> <ul> <li>Board tile label delete - ensure tile label is deleted from the label object in store</li> </ul> <p>2024-05-03</p> <p>Features</p> <ul> <li>Card and Board recent updates feed - filter to show all or comments/updates only</li> </ul> <p>Improvements</p> <ul> <li>add a permanent but closable info level toast when board is read-only</li> <li>update rich text editor to latest version</li> </ul>"},{"location":"boards/cloud/updates/#april","title":"April","text":"<p>2024-04-29</p> <p>Fixes:</p> <ul> <li>update material-ui libraries to fix date picker display issues on small screens</li> <li>ensure card header theme displays correctly when card is opened via direct link</li> </ul> <p>2024-04-24</p> <p>Improvements:</p> <ul> <li>card details view improvements<ul> <li>show card fields/data in defined sections in a grid formation with headings and add buttons</li> <li>change \"add a comment\" action to start as a button</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>minor styling fix for dependencies section on a node</li> <li>board/activity lists - more precise and consistent footer spacing/padding</li> <li>create card and add comment actions - ensure entered text persists on unfocus + other focus related fixes</li> </ul> <p>2024-04-17</p> <p>Fixes:</p> <ul> <li>issue with exporting a board in Teams client</li> <li>date picker error on mobile/touch devices</li> </ul> <p>2024-04-11</p> <p>Improvements</p> <ul> <li>tooltips on date picker</li> <li>add invalid date error message</li> <li>primary session expired message - show as info alert</li> <li>tab color and style improvements</li> <li>more consistent use of primary/secondary action colours on buttons</li> <li>no collapse for empty lists activity todo pivot views</li> <li>auto collapse empty lists initially and after a card is dragged out of them</li> <li>New Board Wizard - more specific label for board name and template name</li> <li> <p>Activity view improvements</p> <ul> <li>styling (shadows, spacing, border edges when expanded/collapsed)</li> <li>drop cards on list header (highlight like shadow)</li> <li>add card at top hides the bottom add card</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>issue with format of dates in date picker</li> <li>issues in list header title - not full width, no-wrap ellipsis, use correct cursors</li> <li>don't show grab cursor on lists in todos / pivoted views</li> <li>issue saving tags when creating new template</li> <li>ensure tags are copied from template/source</li> </ul> <p>2024-04-02</p> <p>Improvements:</p> <ul> <li>Streamlined <code>/todos/assigned</code> &amp; <code>/todos/created</code> API, separating out the Board labels to <code>/board/labels</code> &amp; <code>/board/{boardId}/labels</code> endpoints</li> <li>Loading feedback when creating a board</li> </ul> <p>Fixes:</p> <ul> <li>Issue with board label history</li> <li>create board from template when opened and only a reader</li> </ul>"},{"location":"boards/cloud/updates/#march","title":"March","text":"<p>2024-03-25</p> <p>Features:</p> <ul> <li> <p>Emoji reactions on comments</p> <ul> <li> <p>Quick selection</p> <p></p> </li> <li> <p>Picker</p> <p></p> </li> </ul> </li> </ul> <p>Improvements:</p> <ul> <li>Editing of comments on mobile (focus at end of text, save/cancel buttons)</li> </ul> <p>Fixes:</p> <ul> <li>Creating Board in group restricts to the group's Organisation</li> <li>Better handling of authentication when provider session changes user account</li> <li>Visibility of 'Embed Link' when viewing Boards by Group</li> <li>Creation of Board in Group when using /group/{groupId} route (embedded)</li> </ul> <p>2024-03-21</p> <p>API Documentation:</p> <ul> <li>/todos/next</li> <li>/todos/summary</li> <li>/board/{boardId}/labels</li> <li>/board/labels</li> <li>/user/auth/{provider}/{externalId}/apitoken</li> </ul> <p>2024-03-20</p> <p>Fixes:</p> <ul> <li>View cards in fullscreen on small screens</li> </ul> <p>2024-03-15</p> <p>Features:</p> <ul> <li>My Tasks Summary micro app</li> <li>My Next Tasks micro app</li> </ul> <p>Fixes:</p> <ul> <li>Issue when deleting all Boards tile colors</li> <li>Links to card ancestors (Todo view)</li> <li>Prevent date selection incorrectly showing today when no date set</li> </ul> <p>2024-03-06</p> <p>Fixes:</p> <ul> <li>Issue with communication between Boards and Collab Cloud</li> </ul> <p>2024-03-05</p> <p>Fixes:</p> <ul> <li>Upload files to Teams private channel OneDrive</li> </ul> <p>2024-03-04</p> <p>Improvements:</p> <ul> <li>Loading feedback of recent boards sidebar</li> <li>Card link opening behavious (links to other boards open in same tab)</li> <li>Teams board links open tabs</li> <li>Show loading spinner while waiting on clicked link to open in a teams tab</li> </ul>"},{"location":"boards/cloud/updates/#february","title":"February","text":"<p>2024-02-28</p> <p>Improvements:</p> <ul> <li>Add copy/paste list option in list menu</li> <li>Add duplication list option in list menu</li> <li>More comprehensive history feed details for moving or reordering cards</li> </ul> <p>Fixes:</p> <ul> <li>Scroll to bottom of a list when creating a new card</li> <li>Delete action in card dialog / in archive view</li> <li>Add card section in a list delays retract/height change to prevent card drag issues</li> <li>Dragging empty colour labels in Firefox</li> <li>Filter/search by list name</li> </ul> <p>2024-02-22</p> <p>Fixes:</p> <ul> <li>Unauthorised error when adding existing board as Teams tab</li> <li>Fix potential onEnter errors in rich text editor</li> <li>Prevent overflow on file preview</li> <li>Load board members on fullscreen list view (for @mentions)</li> </ul> <p>2024-02-16</p> <p>Fixes:</p> <ul> <li>Fix potential onBlur errors in rich text editor</li> <li>Don't show iCalendar feed options in Teams</li> </ul> <p>2024-02-14</p> <p>Fixes:</p> <ul> <li>Translation fixes<ul> <li>Move translations inside functions to help prevent premature translate calls</li> <li>Use date-fns locales to show months in user's language</li> <li>German translation amendments</li> <li>Other translation fixes and improvements</li> </ul> </li> </ul> <p>2024-02-08</p> <p>Fixes:</p> <ul> <li>Microsoft Teams private channels<ul> <li>Link to File will now show the private channel's files.</li> <li>Owner/Author access level was setting all members to Author.</li> </ul> </li> <li>Microsoft Teams Mobile: Removed licence related cards in org admin view.</li> <li>Microsoft Teams: Removed obsolete \"Disable Notifications\" button.</li> <li>Rich text editor dialog - allow scroll on overflow</li> </ul>"},{"location":"boards/cloud/updates/#january","title":"January","text":"<p>2024-01-25</p> <p>Fixes:</p> <ul> <li>Use SMTP email address before using Exchange address when parsing email attachments</li> <li>Don't show organisation admin links from Boards sidebar menu in Teams on a mobile device</li> </ul> <p>2024-01-17</p> <p>Fixes:</p> <ul> <li>Activity view scrolling issue</li> </ul> <p>2024-01-09</p> <p>Improvements:</p> <ul> <li> <p>Microsoft Teams integrations</p> <ul> <li>UI redesign when adding new Boards tab</li> <li>Onboarding Tours</li> </ul> </li> <li> <p>faster opening of cards</p> </li> <li>allow clicking links in description when content locked for editing</li> <li>allow reordering private cards</li> <li>US English updates</li> <li>organisation plan loading feedback</li> </ul> <p>Fixes:</p> <ul> <li>issue where completing a new task showed incorrect icon</li> <li>issue where Board content deleted when hovered and press Ctrl+Alt+Delete</li> <li>issue when opening a card by link, then a subcard within that card</li> <li>issue when reordering cards with filtered (hidden) content</li> <li>visibility of card title in header breadcrumb (Component Pack)</li> </ul> <p>2024-01-04</p> <p>Fixes:</p> <ul> <li>RichText saving when used @symbol (but not an @mention)</li> <li>@mentions keyboard navigation improvements (home/end, up to bottom, down back to top), escape without closing modal</li> <li>@mentions only considered new on first save</li> </ul>"},{"location":"boards/cloud/updates/#2023","title":"2023","text":""},{"location":"boards/cloud/updates/#december","title":"December","text":"<p>2023-12-22</p> <p>Fixes:</p> <ul> <li>issue where mentions popup partially hidden at top</li> <li>issue where could not mention users when opening a card directly by link</li> <li>hide private cards when viewing board by assignments</li> <li>create card from Outlook/Verse - fix toggle of attach body, ordering of recent boards</li> <li>drag dependency links in Firefox</li> </ul> <p>2023-12-18</p> <p>Improvements:</p> <ul> <li>Accessibility (keyboard navigation - colors/members dialog, aria-labels, popover, html.lang attribute, improved roles, aria-selected, aria-expanded, hover/focus on cards)</li> <li>Drag email to card - attach .eml and .msg file</li> <li>Positioning of unscheduled cards in Timeline</li> <li>Improved document titles based on context</li> <li>Smoother drag scroll on Kanban</li> <li>Ensure grab cursor for Kanban drag scroll</li> <li>Update childcounts in activity lists when filtering</li> <li>Visibility of selected board filters</li> <li>Searching for a board includes the description</li> </ul> <p>Fixes:</p> <ul> <li>Card label overflow issue when 5 lines</li> <li>Issue where comment events sent to mentioned users</li> </ul> <p>2023-12-13</p> <p>Improvements:</p> <ul> <li>API documentation for /user/{userId}, /user/group/{groupId} etc</li> <li>Support for latest MongoDB (v7)</li> </ul> <p>2023-12-12</p> <p>Fixes:</p> <ul> <li>Link to File dialog options</li> </ul> <p>Fixes:</p> <p>2023-12-07</p> <p>Fixes:</p> <ul> <li>Issue saving card name when editing it directly on the card</li> </ul> <p>2023-12-04</p> <p>Feature:</p> <ul> <li>Drag emails from Outlook to create as card</li> </ul> <p>2023-12-01</p> <p>Fixes:</p> <ul> <li>Issue when focusing on boards search input</li> </ul>"},{"location":"boards/cloud/updates/#november","title":"November","text":"<p>2023-11-29</p> <p>Feature:</p> <ul> <li>Support for Domino by REST API</li> </ul> <p>Fixes:</p> <ul> <li>Debounce User/Group searching</li> </ul> <p>2023-11-28</p> <p>Fixes:</p> <ul> <li>Issue where menu buttons in the open card view were not overflowing to the 'more' menu correctly and causing a flickering effect</li> <li>Issue where lists in board view could not easily be dragged to re-order</li> <li>Issue with board title button long text overflowing</li> <li>Issue with card background images</li> </ul> <p>Improvements:</p> <ul> <li>Minor accessibility improvement - add aria-labels</li> </ul> <p>2023-11-23</p> <p>Fixes:</p> <ul> <li>Fix template description not showing in new board wizard</li> </ul> <p>2023-11-13</p> <p>Improvements:</p> <ul> <li> <p>Accessibility</p> <ul> <li>more consistent tooltips (for screen readers and better explanation of functionality)</li> <li>Keyboard navigation (particularly in the Board Tiles, Kanban view, Card dialog) - (vision &amp; motor impaired)</li> <li>better screen reader information (vision impaired)</li> <li>improved colour contrast (low vision users)</li> </ul> </li> </ul> <p>2023-11-09</p> <p>Improvements:</p> <ul> <li>API for Member deletion</li> </ul> <p>Fixes:</p> <ul> <li>Email for mentions missing fields</li> </ul>"},{"location":"boards/cloud/updates/#october","title":"October","text":"<p>2023-10-31</p> <p>Improvements:</p> <ul> <li>Translations (German and English US)</li> <li>Use https protocol for iCal feed instead of webcals</li> <li>Hide unusable Colors button when read-only access when sidebar collapsed</li> <li>Consistency of Board colour feature naming</li> </ul> <p>Fixes:</p> <ul> <li>Issue where iCal feed dates off by 1 due to timezone differences</li> <li>Issue where page blank in Firefox when loading with Connections 7 header via SSO</li> </ul> <p>2023-10-25</p> <p>Improvements:</p> <ul> <li>Show Member/Labels buttons in collapsed sidebar</li> <li>added translations to missing fields</li> </ul> <p>Fixes:</p> <ul> <li>Issue where page crashed when reloaded page with Card open, then opening member dialog</li> </ul> <p>2023-10-23</p> <p>Features:</p> <ul> <li>Board iCalendar feed</li> <li>Personal iCalendar feed</li> </ul> <p>2023-10-20</p> <p>Fixes:</p> <ul> <li>Collab header regression</li> </ul> <p>2023-10-19</p> <p>Improvements:</p> <ul> <li>loading of Board task stats on tiles as required</li> <li>performance of loading My Boards</li> <li>redirect in place for expired session of Collab/Connections with SSO header</li> </ul>"},{"location":"boards/cloud/updates/#september","title":"September","text":"<p>2023-09-29</p> <p>Improvements:</p> <ul> <li>More German language translations</li> </ul> <p>Fixes:</p> <ul> <li>Ability to paste images into descriptions</li> </ul> <p>2023-09-22</p> <p>Improvements:</p> <ul> <li>API security, added 'Strict-Transport-Security' &amp; 'X-Content-Type-Options'</li> </ul> <p>Fixes:</p> <ul> <li>(regression) encoding of file names when uploading special charactors (e.g. Japanese)</li> <li>issue where deleting a dependency changes the current view</li> </ul> <p>2023-09-19</p> <ul> <li>update of <code>busboy</code> dependency used for file upload (includes security patches, node support etc)</li> </ul> <p>2023-09-14</p> <p>Improvements:</p> <ul> <li>consistency of sidebar icon positioning when collapsed/expanded</li> <li>allow case insensitive Collab login</li> <li>update to teams-js v2</li> <li>open filesin Teams in-place (deep links)</li> </ul> <p>Fixes:</p> <ul> <li>public member creation when creating Board</li> <li>whitespace of cards in Activity list</li> <li>HCL Connections 8 CR3 whitespace</li> </ul> <p>2023-09-12</p> <p>Improvments:</p> <ul> <li>loading speed of the 'My Boards' data</li> </ul> <p>2023-09-08</p> <p>Fixes:</p> <ul> <li>membership role options when created inside a Team/Community</li> </ul> <p>2023-09-07</p> <p>Features:</p> <ul> <li>Organisation content administration &amp; membership management</li> <li>Labels pivot view for Board and Activity views</li> </ul> <p>Improvements:</p> <ul> <li>Pasting URLs into description and comments automatically converted to clickable link</li> </ul> <p>Fixes:</p> <ul> <li>issues in dependency arrow positioning</li> <li>auto reschedule dependencies when dates change</li> <li>selecting the same file to upload after cancelling</li> <li>expand/collapse lists when pivoted by dates/assignment</li> </ul>"},{"location":"boards/cloud/updates/#august","title":"August","text":"<p>2023-08-15</p> <p>Fixes:</p> <ul> <li>Reload loop during login with Firefox</li> </ul> <p>2023-08-09</p> <p>Fixes:</p> <ul> <li>Ensure assignments are duplicated when copying and pasting tasks</li> </ul> <p>2023-08-07</p> <p>Improvements:</p> <ul> <li>Users with the author role now have full edit access on cards that are assigned to them (rather than complete and comment access only)</li> </ul> <p>Fixes:</p> <ul> <li>Prevent cards from being moved to another list at the same time they are archived by dragging to the archive button</li> <li>Ensure the current user has the correct actions available according to their board role when opening cards from the My Todos view</li> </ul>"},{"location":"boards/cloud/updates/#july","title":"July","text":"<p>2023-07-14</p> <p>Fixes:</p> <ul> <li>Drag &amp; Drop from rich email clients onto a list</li> </ul> <p>2023-07-12</p> <p>Fixes:</p> <ul> <li>Activity list missing action menu</li> </ul> <p>2023-07-05</p> <p>Fixes:</p> <ul> <li>Ability to edit nodes when opened directly</li> </ul> <p>2023-07-04</p> <p>Fixes:</p> <ul> <li>Assignments to non-primary aliases</li> </ul> <p>2023-07-03</p> <p>Improvements:</p> <ul> <li>Improved author experience - restrict to allowed actions</li> <li>Board title/board options button - styling and usability improvements</li> <li>Current member role now highlighted in members dialog and links added to member permissions documentation</li> <li>Improved randomisation and readability of Assignment Role colours</li> <li>Added tooltips to Assignment Role avatars</li> <li> <p>Microsoft Teams</p> <ul> <li>detect members in private sub channels (OAuth Admin consent must be certified again)</li> <li>fix for creating Board in private sub channels</li> <li>loading spinner positioning</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Connections 8 styling fixes</li> <li>Fixed coloured role borders when assigning member roles</li> <li>Fix URLs pointing to old docs pages</li> <li>Issue detecting highest licence when multiple</li> <li>Minor fixes to Welcome and Plan Selection dialogs</li> </ul>"},{"location":"boards/cloud/updates/#june_1","title":"June","text":"<p>2023-06-26</p> <p>Improvements:</p> <ul> <li>Readers can now select text in descriptions</li> <li>General reader experience</li> </ul> <p>Fixes:</p> <ul> <li>Tours appearing incorrectly</li> <li>Template role assignment on touch devices</li> </ul> <p>2023-06-21</p> <p>Fixes:</p> <ul> <li>Move button now appears again</li> </ul> <p>2023-06-19</p> <p>Fixes:</p> <ul> <li>Timeline group-by colours</li> </ul> <p>2023-06-15</p> <p>Improvements:</p> <ul> <li>Readers no longer see actions they cannot perform</li> </ul> <p>Fixes:</p> <ul> <li>Getting members from private sub-channels</li> </ul> <p>2023-06-06</p> <p>Improvements:</p> <ul> <li>Member promotion emails - add invite and membership details to give more context</li> <li>New configuration option to enable/disable member promotion requests</li> <li>Do not clear edited name/description when changing templates</li> <li>Ability to create new organisation from guest is reader popup</li> </ul> <p>Fixes:</p> <ul> <li>Issue with exporting Board as CSV with special characters (e.g. Umlaut)</li> <li>Issue affecting Org config when user has multiple orgs</li> <li>Color selection/editing on small screens (e.g. mobiles)</li> <li>German translations with extra '}' character</li> <li>Issues with Role Assignments (duplicates etc)</li> <li>Collab - fix for offering user org trial</li> <li>Issue in create first board tour</li> </ul>"},{"location":"boards/cloud/updates/#may_1","title":"May","text":"<p>2023-05-26</p> <p>Features:</p> <ul> <li>Organisation Guests are now treated as Reader</li> <li>Ability for guest to request a promotion to member, sent to admins via email &amp; socket</li> </ul> <p>2023-05-23</p> <p>Improvements:</p> <ul> <li> <p>Drag and drop of lists</p> <ul> <li>drag by header</li> <li>fix blank list when scrolled and dragged</li> <li>prevent scrolling of list in drag mode</li> </ul> </li> <li> <p>Cards can be Archived+Deleted from the card modal toolbar.</p> </li> <li>Enable \"Assign to Roles\" when creating a new Board via 'Create Template from Board' button.</li> <li>More compact Board Members view on small (phone) screens.</li> </ul> <p>Fixes:</p> <ul> <li>Issue with blank tile label</li> <li>Issue with empty Assign Roles in new Board wizard</li> <li>Board Tiles sidebar shadow regression bug</li> <li> <p>Card drag and drop</p> <ul> <li>issue where a duplicate card appears when drag to end</li> <li>issue where card jumps back to top when dragging a card to end of same list</li> </ul> </li> <li> <p>Button for copying a template says \"Copy Template\" instead of \"Copy Board\"</p> </li> <li>Fixed loading of template description in to board description field in the new board wizard.</li> <li>Deleting an open template now redirects to template list instead of board list.</li> <li>Fixed \"Assign to Roles\" screen appearing in Board wizard without any roles to assign members.</li> <li>When creating a new Board, edited name and description fields are not lost when changing the selected template.</li> </ul> <p>2023-05-16</p> <p>Improvements:</p> <ul> <li> <p>Organisation view of members &amp; groups</p> <ul> <li>loading feedback</li> <li>virtualised scroll for faster render</li> <li>show membership of linked aliases</li> <li>prevent duplicates of invites to org</li> </ul> </li> <li> <p>localised format of dates in CSV export</p> </li> </ul> <p>Fixes:</p> <ul> <li>Security issue affecting external users and public communities (Connections)</li> <li>issue where Organisation invites not visible if members with linked aliases</li> </ul> <p>2023-05-05</p> <p>Features:</p> <ul> <li>Drag card to archive</li> </ul> <p>Improvements:</p> <ul> <li>Auto-move dependency parent</li> <li>Expand all in activity view</li> <li>Hide edit options on archived card</li> <li>Performance improvements related to icons used on Template Roles</li> <li>Show count of tasks assigned to Role in Board Members view</li> </ul> <p>Fixes:</p> <ul> <li>Dragging card from assigned user created user image as card</li> <li>Sending duplicate due date reminders</li> </ul>"},{"location":"boards/cloud/updates/#april_1","title":"April","text":"<p>2023-04-21</p> <p>Features:</p> <ul> <li>Button to assign all sub-tasks as dependencies of parent</li> <li>Template Roles - base functionality</li> </ul> <p>Fixes:</p> <ul> <li>Removed Connections community members not removed from Board membership</li> <li>Deleting an assigned label</li> </ul> <p>2023-04-12</p> <p>Features:</p> <ul> <li>Custom Colours. Colours and tags have been merged. You are now able to create as many colours as you like in a Board</li> </ul>"},{"location":"boards/cloud/updates/#march_1","title":"March","text":"<p>2023-03-20</p> <p>Fixes:</p> <ul> <li>Group member changes not being picked up</li> </ul> <p>2023-03-17</p> <p>Improvements:</p> <ul> <li>Timeline card title always visible</li> </ul> <p>2023-03-15</p> <p>Improvements:</p> <ul> <li>UI for member adding on Mobile</li> </ul> <p>Fixes:</p> <ul> <li>Kanban Printing</li> <li>Timeline calendar shifting when opening a card</li> </ul> <p>2023-03-10</p> <p>Features:</p> <ul> <li>Template Rescheduling</li> <li>Drag &amp; Drop assignments from parent to sub-cards in modal</li> </ul> <p>Fixes:</p> <ul> <li>Assign users to a named licence</li> </ul>"},{"location":"boards/cloud/updates/#february_1","title":"February","text":"<p>2023-02-20</p> <p>Fixes:</p> <ul> <li>Attachments are moved in child nodes when the parent is moved</li> <li>Updated attachments to correctly show when their parent had been moved</li> </ul>"},{"location":"boards/cloud/updates/#january_1","title":"January","text":"<p>2023-01-31</p> <p>Features:</p> <ul> <li>New Organisation summary view</li> </ul> <p>Improvements:</p> <ul> <li>Outlook attachments using plugin</li> <li>Copy/Paste functionality</li> </ul> <p>2023-01-24</p> <p>Improvements:</p> <ul> <li>Styling for HCL Connections 8 new UI</li> <li>Handling of default profile images in Connections</li> <li>Detect language from Connections dropdown</li> <li>Security updates (node 18)</li> </ul>"},{"location":"boards/cloud/updates/#2022","title":"2022","text":""},{"location":"boards/cloud/updates/#december_1","title":"December","text":"<p>2022-12-14</p> <p>Improvements:</p> <ul> <li>synchronise dependencies in real time</li> <li>faster creation of multi cards</li> <li>presence of users open on card without board open</li> <li>adding dependencies between private cards</li> <li>handling of dependencies where not accessible</li> <li>make associated comments public when card is made public</li> <li>synchronise my private tasks between my windows</li> </ul> <p>Fixes:</p> <ul> <li>issue opening board \"Error: Minified React error #185\"</li> <li>issue where Community widget shows 'my' boards incorrectly</li> <li>issue where someone online in board remained online if page reloaded</li> <li>issue where lists hidden when previewing Kanban view while creating a Board</li> <li>issue where page crashed on logout in Node view</li> <li>issue where page crashed on logout in Timeline view</li> <li>issue where files couldn't be downloaded</li> <li>issue where page reloaded in admin view</li> </ul>"},{"location":"boards/cloud/updates/#november_1","title":"November","text":"<p>2022-11-29</p> <p>Improvements:</p> <ul> <li>synchronise dependencies in real time</li> <li>faster creation of multi cards</li> <li>presence of users open on card without board open</li> <li>link to API documentation</li> <li>adding dependencies between private cards</li> <li>handling of dependencies where not accessible</li> <li>make associated comments public when card is made public</li> <li>synchronise my private tasks between my windows</li> </ul> <p>Fixes:</p> <ul> <li>issue where someone online in board remained online if page reloaded</li> <li>issue where lists hidden when previewing Kanban view while creating a Board</li> <li>issue where page crashed on logout in Node view</li> <li>issue where page crashed on logout in Timeline view</li> <li>issue where files couldn't be downloaded</li> <li>issue where page reloaded in admin view</li> </ul> <p>2022-11-08</p> <p>Features:</p> <ul> <li>installable web app</li> </ul> <p>Performance:</p> <ul> <li>faster load</li> <li>added virtual scroll for Kanban</li> <li>smoother drag and drop</li> <li>faster filtering/searching inside a Board</li> </ul> <p>Improvements:</p> <ul> <li>improved new user experience in integrations</li> <li>hide dependency lines while dragging &amp; resizing</li> <li>usability of tile color label edit/selection</li> <li>stop auto redirecting expired account</li> </ul> <p>Fixes:</p> <ul> <li>fix for drag scrolling lists on mobile</li> <li>fix editing link titles</li> <li>fix positioning of timeline arrows caused by swimlane animations</li> <li>fix double click to add list</li> </ul>"},{"location":"boards/cloud/updates/#october_1","title":"October","text":"<p>2022-10-17</p> <ul> <li> <p>Updates for Timeline</p> <ul> <li>animate expand/collapse of scheduled lanes</li> <li>fix for hidden cards on timeline when duplicated (eg multiple colors/assignments)</li> <li>highlight multiple instances of same card on hover</li> <li>remember last view (list/color/members)</li> <li>live updates of list names, color labels and members</li> <li>show color labels</li> </ul> </li> </ul> <p>2022-10-05</p> <ul> <li>Fix for opening 'Owners Only' community boards</li> </ul> <p>2022-10-04</p> <ul> <li>Fix for timeline lists not scrolling</li> <li>Updated translations</li> </ul>"},{"location":"boards/cloud/updates/#september_1","title":"September","text":"<p>2022-09-27</p> <ul> <li>Fix for not being able to close date picker on mobile</li> </ul> <p>2022-09-05</p> <ul> <li>Updated translations including notifications</li> </ul>"},{"location":"boards/cloud/updates/#july_1","title":"July","text":"<p>2022-07-08</p> <ul> <li>Compatibility for private channels in Teams</li> </ul>"},{"location":"boards/cloud/updates/#june_2","title":"June","text":"<p>2022-06-23</p> <ul> <li>Print feature for Board View</li> <li>Fix for loading ToDo View with deleted groups</li> <li>Fix for 'View' by 'Groups'</li> <li>Fix for description not saving in certain window changing scenarios</li> <li>Fix for character encoding in update streams</li> </ul> <p>2022-06-21</p> <ul> <li>Fix for viewing user presence</li> <li>Fix for viewing card title when user presence is also displayed</li> <li>Fix for 'Commented on' recent updates not syncing in real-time</li> <li>Fix for displaying changes made in Activity View</li> <li>Updated Recent Boards in side toolbar</li> <li>Fix for auth loop when using Connections Header</li> </ul> <p>2022-06-10</p> <ul> <li>Fix for card toolbar on smaller resolutions</li> <li>Community widget now works if user has no email</li> <li>Highlights widget fix for opening fullpage</li> <li>Fix for visibility of Owners Only group Boards</li> </ul> <p>2022-06-07</p> <ul> <li>Fix for readers not being able to complete cards</li> <li>Fix for dependencies in Todos view</li> </ul>"},{"location":"boards/cloud/updates/#may_2","title":"May","text":"<p>2022-05-20</p> <ul> <li>NEW Dependencies feature</li> </ul> <p>2022-05-10</p> <ul> <li>Fix for Microsoft admin approval</li> </ul> <p>2022-05-09</p> <ul> <li>Can no longer close a page when editing a description</li> <li>Description locking alert moved for better visibility</li> <li>Authors no longer appear to be able to edit descriptions when unable to</li> <li>Fix for opening links in description</li> <li>Fix for comment truncation issue in rare circumstances</li> <li>Fix for new line @mentions</li> <li>Fix for focused description loss when immediately moving to comments</li> <li>Fix for showing editor toolbar when selecting all using keyboard</li> </ul>"},{"location":"boards/cloud/updates/#april_2","title":"April","text":"<p>2022-04-28</p> <ul> <li>Updated RTE to latest</li> <li>New Teams welcome message card</li> <li>New Teams notification cards</li> <li>Fix for email attachments not attaching</li> </ul> <p>2022-04-19</p> <ul> <li>Updated fix for Moderated Community access</li> <li>Fix for crash when updating Board title</li> <li>Fix for description locking in communities</li> </ul> <p>2022-04-07</p> <ul> <li>Fix for Moderated Community access</li> </ul> <p>2022-04-06</p> <ul> <li>NEW linked-cards micro-app</li> <li>Fix for comment stream entry for Orient Me</li> <li>Fix for updating card title from Boards view in FireFox</li> <li>Fix for deeplinked Connections Community widgets</li> <li>Fix for Boards Search styling</li> <li>Fix for opening filters via icon</li> <li>Fix for Teams login popup not closing</li> </ul>"},{"location":"boards/cloud/updates/#march_2","title":"March","text":"<p>2022-03-21</p> <ul> <li>Improve file upload feedback (eg when socket unavailable)</li> <li>Fix duplicates appearing in history from live events</li> <li>Fix first comments not live displaying</li> </ul> <p>2022-03-11</p> <ul> <li>Fix for timeline cards sometimes showing a day off</li> <li>Fix when loading a Community widget where the Board has been deleted causing an inifinite loop</li> </ul> <p>2022-03-09</p> <ul> <li>Fix for pasting into edited comment clears comment</li> <li>Fix for loading subscriptions</li> <li>Reducing browser console noise</li> </ul> <p>2022-03-03</p> <ul> <li>Fix for crashing when tours are dismissed</li> <li>Fix for private card toggle</li> </ul>"},{"location":"boards/cloud/updates/#february_2","title":"February","text":"<p>2022-02-17</p> <ul> <li>Ability to change Private cards to Public</li> <li>Updated Date pickers with month/year selection</li> <li>Updated Material UI library to latest</li> <li>Fix for saving description on modal closure</li> <li>Fix for transfer membership</li> </ul>"},{"location":"boards/cloud/updates/#january_2","title":"January","text":"<p>2022-01-31</p> <ul> <li>Fix for welcome message in Microsoft Teams Bot</li> <li>Fix for lost descriptions on first edit when pasting an image</li> <li>Improved file upload feedback</li> <li>Fix where you could not upload the full 50MB for a file</li> <li>Fix for going to the Boards homepage not group list when in group context</li> <li>Performance improvements</li> </ul> <p>2022-01-14</p> <ul> <li>Fix link format in card history</li> <li>Fix opening URL from MS-Office add-in</li> <li>Update SunEditor to latest</li> </ul> <p>2022-01-04</p> <ul> <li>Fix for notifications on comments to other commenters</li> <li>Fix for emails when users are no longer Board members</li> </ul>"},{"location":"boards/cloud/updates/#2021","title":"2021","text":"<p>2021-12</p> <ul> <li>Fix for child nodes not loading when loading a node directly</li> <li>Fix for completing tasks when multi-assign has been removed</li> <li>Fix for breadcrumbs not displaying when opening a card node directly</li> <li>Adding generic Create Card functionality</li> <li>Fix for requesting too many Connections community members at once</li> <li>Fix for adding tags with the same starting letter</li> <li>Mindmap move card &amp; Board name overflow fixes</li> <li>Update comment count when deleting comment</li> <li>Syncing when description is deleted</li> <li>Board history max card title height</li> <li>Updated Arabic translations</li> </ul> <p>2021-11</p> <ul> <li>Fix for background when RTE in fullscreen mode</li> <li>Fix for opening cards with a theme set</li> <li>Updated Arabic translations</li> <li>Fix for drag&amp;drop assignments creating extra cards</li> <li>Added Recent Updates Feed</li> </ul> <p>2021-10</p> <ul> <li>Updated German translations</li> <li>Microsoft Teams login fix</li> <li>Fix for issue where link is inserted at start of description</li> <li>Fix for issue when changing user account tries to loads the previous open Board</li> <li>Fix for issue when adding group as board member</li> <li>Added user images by API</li> <li>Fix for copy/paste lists in Activity view</li> <li>Fix for compatibility with Visual Update One (Collab Cloud)</li> <li>Fix for issue where multiple toasts in quick succession never auto closed</li> <li>Fix for starting Zaps/Flows with Huddo Boards</li> <li>Auto Premium Trial</li> <li>Enhancement for msgraph groups which are not teams (owner != member)</li> <li>Unsubscribe emails link</li> <li>Fix for logout/login socket issue</li> <li>Fix for Activity view interact to create list</li> <li>Fix for adding Connections/Collab Cloud Communities as members</li> <li>Improved performance by reducing page load size</li> <li>User Presence on cards</li> <li>Improved Activities View performance</li> <li>Improved private card creation process</li> </ul> <p>2021-09</p> <ul> <li>Adding undo/redo buttons to description toolbar</li> <li>Fix for trial dialog opening</li> <li>Better caching and performance of my/public groups</li> <li>Integromat integration</li> <li>User search performance</li> <li>Community name search improvements</li> <li>Admin page crash fix</li> <li>Fix for Teams notifications turning back on when they are disabled</li> </ul> <p>2021-08</p> <ul> <li>Private Card feature</li> <li>Fix for group membership for private groups</li> <li>Improved invite handling</li> <li>Ability to set group permissions for a Board on create in the group</li> <li>More granular user permissions for group membership</li> <li>Fix for ToDo view filtering</li> <li>Update to user subscriptions allowing emails to be applied</li> <li>User subscriptions now default to purchasing user</li> <li>User subscriptions are now named, not first-come-first-serve</li> <li>Better management options for user subscriptions</li> <li>Fix for error thrown when assigning colours in a Board</li> <li>Small screen icon positions, in particular for attached files</li> <li>Various performance updates</li> </ul> <p>2021-07</p> <ul> <li>Fix for access to Boards in Teams</li> <li>Fix for issue where you could not change level of community members</li> <li>Fix for issue when accepting email invites for guest/external users</li> <li>Performance relating to loading times</li> </ul> <p>2021-06</p> <ul> <li>Initial version of this page</li> </ul>"},{"location":"boards/connections/","title":"HCL Connections","text":"<p>Huddo Boards (Activities Plus) for HCL Connections can be deployed in one of two ways:</p> <ol> <li> <p>In HCL Connections Component Pack (CP)</p> <p>Tip</p> <p>This is the recommended approach as the CP includes a Kubernetes environment with an existing Mongo database and S3 storage. Please follow the Component Pack instructions to deploy Huddo Boards.</p> </li> <li> <p>Standalone Kubernetes environment</p> <p>Info</p> <p>This is a more complex setup as you will need to provide/deploy your own Mongo database and S3 storage. Please follow the Kubernetes instructions to deploy Huddo Boards.</p> </li> </ol>"},{"location":"boards/connections/apps-menu-hybrid/","title":"Apps Menu","text":""},{"location":"boards/connections/apps-menu-hybrid/#add-to-apps-menu","title":"Add to Apps Menu","text":"<ul> <li> <p>If you have not customised the apps.jsp file for your connections environment, please make a copy of the file.</p> <ul> <li> <p>You can access the file from:</p> <pre><code>&lt;WAS_home&gt;/profiles/&lt;profile_name&gt;/installedApps/&lt;cell_name&gt;/Homepage.ear/homepage.war/nav/templates/menu\n</code></pre> </li> <li> <p>Paste the copy into the common\\nav\\templates subdirectory in the customization directory:</p> <pre><code>&lt;installdir&gt;\\data\\shared\\customization\\common\\nav\\templates\\menu\\apps.jsp\n</code></pre> </li> </ul> </li> <li> <p>To add the Huddo Boards App Link add the following lines towards the bottom of the apps.jsp file before the <code>&lt;/table&gt;</code> element</p> <pre><code>--%&gt;&lt;tr&gt;&lt;%--\n  --%&gt;&lt;th scope=\"row\" class=\"lotusNowrap\"&gt;&lt;%--\n    --%&gt;&lt;img width=\"16\" src=\"https://boards.huddo.com/img/logo-small.png\" /&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]\"&gt;&lt;%--\n      --%&gt;&lt;strong&gt;&lt;fmt:message key=\"connections.component.name.kudos.boards\" /&gt;&lt;/strong&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/th&gt;&lt;%--\n  --%&gt;&lt;td class=\"lotusNowrap lotusLastCell\"&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]?redirect_to=/todos/assigned\"&gt;&lt;%--\n      --%&gt;&lt;fmt:message key=\"label.menu.kudos.boards.todos\" /&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/td&gt;&lt;%--\n  --%&gt;&lt;td class=\"lotusNowrap lotusLastCell\"&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]?redirect_to=/templates/public\"&gt;&lt;%--\n      --%&gt;&lt;fmt:message key=\"label.menu.kudos.boards.templates\" /&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/td&gt;&lt;%--\n--%&gt;&lt;/tr&gt;&lt;%--\n</code></pre> <p>Where <code>[CONNECTIONS_HOSTNAME_BASE64]</code>is</p> <ul> <li>your Connections hostname base64 encoded.  E.g. <code>connections.example.com</code> =&gt; <code>Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=</code>     There are many free online services to do this, ie here</li> </ul> </li> <li> <p>Save and close the file</p> </li> <li> <p>Add the Huddo Boards Strings for the Apps Menu</p> <ul> <li> <p>Download the strings files and extract the files to the Connections strings customisation directory:</p> <pre><code>&lt;CONNECTIONS_CUSTOMIZATION_PATH&gt;/strings\n</code></pre> </li> <li> <p>Note: Please append the lines to the files if they already exist. Extra languages can also be added</p> </li> </ul> </li> <li> <p>The changes will take effect when the cluster(s) are restarted</p> </li> </ul>"},{"location":"boards/connections/apps-menu-on-prem/","title":"Apps Menu","text":""},{"location":"boards/connections/apps-menu-on-prem/#add-to-apps-menu","title":"Add to Apps Menu","text":"<ul> <li> <p>If you have not customised the apps.jsp file for your connections environment, please make a copy of the file.</p> <ul> <li> <p>You can access the file from:</p> <pre><code>&lt;WAS_home&gt;/profiles/&lt;profile_name&gt;/installedApps/&lt;cell_name&gt;/Homepage.ear/homepage.war/nav/templates/menu\n</code></pre> </li> <li> <p>Paste the copy into the common\\nav\\templates subdirectory in the customization directory:</p> <pre><code>&lt;installdir&gt;\\data\\shared\\customization\\common\\nav\\templates\\menu\\apps.jsp\n</code></pre> </li> </ul> </li> <li> <p>To add the Huddo Boards app links add the following lines towards the bottom of the apps.jsp file before the <code>&lt;/table&gt;</code> element</p> <pre><code>--%&gt;&lt;tr&gt;&lt;%--\n  --%&gt;&lt;th scope=\"row\" class=\"lotusNowrap\"&gt;&lt;%--\n    --%&gt;&lt;img width=\"16\" src=\"https://[CONNECTIONS_URL]/boards/img/logo-small.png\" /&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://[CONNECTIONS_URL]/boards/auth/connections\"&gt;&lt;%--\n      --%&gt;&lt;strong&gt;&lt;fmt:message key=\"connections.component.name.kudos.boards\"/&gt;&lt;/strong&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/th&gt;&lt;%--\n  --%&gt;&lt;td class=\"lotusNowrap lotusLastCell\"&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://[CONNECTIONS_URL]/boards/auth/connections?redirect_to=/todos/assigned\"&gt;&lt;%--\n      --%&gt;&lt;fmt:message key=\"label.menu.kudos.boards.todos\"/&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/td&gt;&lt;%--\n  --%&gt;&lt;td class=\"lotusNowrap lotusLastCell\"&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://[CONNECTIONS_URL]/boards/auth/connections?redirect_to=/templates/public\"&gt;&lt;%--\n      --%&gt;&lt;fmt:message key=\"label.menu.kudos.boards.templates\"/&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/td&gt;&lt;%--\n--%&gt;&lt;/tr&gt;&lt;%--\n</code></pre> <p>Note: you must replace <code>[CONNECTIONS_URL]</code></p> </li> <li> <p>Save and close the file</p> </li> <li> <p>Add the Huddo Boards Strings for the Apps Menu</p> <ul> <li> <p>Download the strings files and extract the files to the Connections strings customisation directory:</p> <pre><code>&lt;CONNECTIONS_CUSTOMIZATION_PATH&gt;/strings\n</code></pre> </li> <li> <p>Note: Please append the lines to the files if they already exist. Extra languages can also be added</p> </li> </ul> </li> <li> <p>The changes will take effect when the cluster(s) are restarted</p> </li> </ul>"},{"location":"boards/connections/auth-hybrid/","title":"Authenticating Huddo Boards Cloud with HCL Connections","text":""},{"location":"boards/connections/auth-hybrid/#register-oauth","title":"Register OAuth","text":"<p>In order for Huddo Boards to authenticate with your Connections environment, you must define a new OAuth widget.</p> <ol> <li> <p>SSH to the HCL Connections Deployment Manager (substitute the alias)</p> <pre><code>ssh root@[DEPLOY_MANAGER_ALIAS]\n</code></pre> </li> <li> <p>Start <code>wsadmin</code> (substitute your credentials)</p> <pre><code>cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/\n./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd\n</code></pre> </li> <li> <p>Register the new application definition</p> <pre><code>execfile('oauthAdmin.py')\nOAuthApplicationRegistrationService.addApplication('huddoboards', 'Huddo Boards', 'https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]/callback')\n</code></pre> <p>Where <code>[CONNECTIONS_HOSTNAME_BASE64]</code>is</p> <ul> <li>your Connections hostname base64 encoded. E.g. <code>connections.example.com</code> =&gt; <code>Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=</code>     There are many free online services to do this, ie here</li> </ul> </li> <li> <p>To view the uniquely created client clientSecret</p> <pre><code>OAuthApplicationRegistrationService.getApplicationById('huddoboards')\n</code></pre> <p>These commands will print the definition. Please take note of the <code>clientSecret</code>. We will use this later on as</p> <pre><code>CONNECTIONS_URL=https://connections.example.com\nCONNECTIONS_CLIENT_ID=huddoboards\nCONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]\n</code></pre> </li> </ol>"},{"location":"boards/connections/auth-hybrid/#configure-auto-auth","title":"Configure Auto Auth","text":"<p>Steps to configure the Huddo Boards application for auto-authorize (also documented here)</p> <p>Tip</p> <p>this step is optional but recommended and can be done at any time.</p> <ol> <li> <p>Add the new line to the following section in <code>[cellname]/oauth20/connectionsProvider.xml</code></p> <p>Note: keep any existing values and add the new line for <code>huddoboards</code></p> <pre><code>&lt;parameter name=\"oauth20.autoauthorize.clients\" type=\"ws\" customizable=\"true\"&gt;\n  &lt;value&gt;huddoboards&lt;/value&gt;\n&lt;/parameter&gt;\n</code></pre> </li> <li> <p>Recreate the provider via this command:</p> <p>Note: update the wsadmin credentials and the <code>[PATH_TO_CONFIG_FILE]</code></p> <pre><code>./wsadmin.sh -lang jython -conntype SOAP -c \"print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName  [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')\" -user connectionsadmin -password passw0rd\n</code></pre> </li> <li> <p>Restart the WebSphere servers</p> </li> </ol>"},{"location":"boards/connections/auth-on-prem/","title":"HCL Connections OAuth","text":""},{"location":"boards/connections/auth-on-prem/#register-oauth","title":"Register OAuth","text":"<p>In order for Huddo Boards to authenticate with your Connections environment, you must define a new OAuth widget.</p> <ol> <li> <p>SSH to the HCL Connections Deployment Manager (substitute the alias)</p> <pre><code>ssh root@[DEPLOY_MANAGER_ALIAS]\n</code></pre> </li> <li> <p>Start <code>wsadmin</code> (substitute your credentials)</p> <pre><code>cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/\n./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd\n</code></pre> </li> <li> <p>Register the new application definition</p> <pre><code>execfile('oauthAdmin.py')\nOAuthApplicationRegistrationService.addApplication('huddoboards', 'Huddo Boards', 'https://[BOARDS_URL]/auth/connections/callback')\n</code></pre> <p>Where <code>[BOARDS_URL]</code> is the URL of the Boards installation specified previously</p> </li> <li> <p>To view the uniquely created client clientSecret</p> <pre><code>OAuthApplicationRegistrationService.getApplicationById('huddoboards')\n</code></pre> <p>These commands will print the definition. Please take note of the <code>clientSecret</code>. We will use this later on as</p> <pre><code>CONNECTIONS_URL=https://connections.example.com\nCONNECTIONS_CLIENT_ID=huddoboards\nCONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]\n</code></pre> </li> </ol>"},{"location":"boards/connections/auth-on-prem/#configure-auto-auth","title":"Configure Auto Auth","text":"<p>Steps to configure the Huddo Boards application for auto-authorize (also documented here)</p> <p>Tip</p> <p>this step is optional but recommended and can be done at any time.</p> <ol> <li> <p>Add the new line to the following section in <code>[cellname]/oauth20/connectionsProvider.xml</code></p> <p>Note: keep any existing values and add the new line for <code>huddoboards</code></p> <pre><code>&lt;parameter name=\"oauth20.autoauthorize.clients\" type=\"ws\" customizable=\"true\"&gt;\n    &lt;value&gt;huddoboards&lt;/value&gt;\n&lt;/parameter&gt;\n</code></pre> </li> <li> <p>Recreate the provider via this command:</p> <p>Note: update the wsadmin credentials and the <code>[PATH_TO_CONFIG_FILE]</code></p> <pre><code>./wsadmin.sh -lang jython -conntype SOAP -c \"print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName  [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')\" -user connectionsadmin -password passw0rd\n</code></pre> </li> <li> <p>Restart the WebSphere servers</p> </li> </ol>"},{"location":"boards/connections/header-hybrid/","title":"HCL Connections Header","text":"<p>Note</p> <p>This step is optional</p> <p></p>"},{"location":"boards/connections/header-hybrid/#sso","title":"SSO","text":"<p>To integrate yours Connections Header into Huddo Boards Cloud please follow these steps:</p> <ol> <li> <p>Allow CORS - follow these instructions.</p> </li> <li> <p>Enable in Boards</p> <p>Open the Boards admin page, select your <code>Organisation</code>, and then the <code>Connections</code> client</p> <p></p> <p>Tick the checkbox for <code>Load Connections Header via SSO</code> and click <code>Save</code></p> <p></p> <p>Once you reload the page you should see the Connections header!</p> </li> </ol>"},{"location":"boards/connections/header-hybrid/#iframe-deprecated","title":"iFrame (Deprecated)","text":"<p>Warning</p> <p>This option is no longer recommended.</p> <ol> <li> <p>Download the Application</p> <p>The latest .ear from here</p> </li> <li> <p>Login to WebSphere ISC</p> <p>This is usually accessible through a URL like:</p> <pre><code>https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\n</code></pre> <p></p> </li> <li> <p>Open <code>Environment</code> -&gt; <code>WebSphere variables</code></p> <p>Ensure the scope is selected as the <code>Cell</code></p> <p>Click <code>New</code></p> <p></p> </li> <li> <p>Set the following details and click <code>OK</code></p> <pre><code>EXTERNAL_APPS_CONFIG\n{\"boards\":\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]\"}\n</code></pre> <p>Where <code>[CONNECTIONS_HOSTNAME_BASE64]</code> is</p> <ul> <li>your Connections hostname base64 encoded. E.g. <code>connections.example.com</code> =&gt; <code>Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=</code></li> </ul> <p></p> </li> <li> <p>The config may require saving. Click <code>Save</code> if presented</p> <p></p> </li> <li> <p>Open <code>Applications</code> -&gt; <code>Application Types</code> -&gt; <code>WebSphere enterprise applications</code></p> <p>Click <code>Install</code></p> <p></p> </li> <li> <p>Select the file and click <code>Next</code></p> <p></p> </li> <li> <p>You can rename the App if you wish, then click <code>Next</code></p> <p></p> </li> <li> <p>Select the checkbox for the module</p> <p>Hold shift while selecting both the <code>WebServer</code> and the <code>AppsCluster</code> from the list</p> <p>Click Apply</p> <p>The Servers should update on the right hand side</p> <p>Click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Finish</code></p> <p></p> </li> <li> <p>The config may prompt to save. Click <code>Save</code></p> <p></p> <p>The application should now be installed</p> </li> <li> <p>Start the Header App</p> <p>Tick the box next to the app name, and click <code>Start</code></p> <p></p> <p>The app should now start. Congratulations, you have installed the app!</p> <p></p> <p>You should now be able to load app can now be loaded at this path</p> <pre><code>https://[CONNECTIONS_URL]/boards\n</code></pre> <p>For example:</p> <pre><code>https://connections.example.com/boards\n</code></pre> </li> </ol>"},{"location":"boards/connections/header-on-prem/","title":"Connections Header Integration","text":"<p>Important</p> <p>This step is only required if you are hosting Huddo Boards on a different domain to HCL Connections.</p> <p></p>"},{"location":"boards/connections/header-on-prem/#connections-header-via-sso","title":"Connections Header via SSO","text":"<p>If you are running Boards on a standalone domain we recommend integrating with the Connections Header using SSO. Please follow these steps:</p> <ol> <li> <p>Allow CORS - follow these instructions.</p> </li> <li> <p>Enable in Boards</p> <p>Open the Boards admin page, select your <code>Organisation</code>, and then the <code>Connections</code> client</p> <p></p> <p>Tick the checkbox for <code>Load Connections Header via SSO</code> and click <code>Save</code></p> <p></p> <p>Once you reload the page you should see the Connections header!</p> </li> </ol>"},{"location":"boards/connections/header-on-prem/#iframe-app-deprecated","title":"iFrame App (Deprecated)","text":"<p>Warning</p> <p>This option is no longer recommended.</p> <ol> <li> <p>Download the Application</p> <p>The latest .ear from here</p> </li> <li> <p>Login to WebSphere ISC</p> <p>This is usually accessible through a URL like:</p> <pre><code>https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\n</code></pre> <p></p> </li> <li> <p>Open <code>Environment</code> -&gt; <code>WebSphere variables</code></p> <p>Ensure the scope is selected as the <code>Cell</code></p> <p>Click <code>New</code></p> <p></p> </li> <li> <p>Set the following details and click <code>OK</code></p> <pre><code>EXTERNAL_APPS_CONFIG\n{\"boards\":\"https://[BOARDS_URL]/auth/connections\"}\n</code></pre> <p>Where <code>[BOARDS_URL]</code> is the URL of the Boards installation specified previously</p> <p></p> </li> <li> <p>The config may require saving. Click <code>Save</code> if presented</p> <p></p> </li> <li> <p>Open <code>Applications</code> -&gt; <code>Application Types</code> -&gt; <code>WebSphere enterprise applications</code></p> <p>Click <code>Install</code></p> <p></p> </li> <li> <p>Select the file and click <code>Next</code></p> <p></p> </li> <li> <p>You can rename the App if you wish, then click <code>Next</code></p> <p></p> </li> <li> <p>Select the checkbox for the module</p> <p>Hold shift while selecting both the <code>WebServer</code> and the <code>AppsCluster</code> from the list</p> <p>Click Apply</p> <p>The Servers should update on the right hand side</p> <p>Click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Finish</code></p> <p></p> </li> <li> <p>The config may prompt to save. Click <code>Save</code></p> <p></p> <p>The application should now be installed</p> </li> <li> <p>Start the Header App</p> <p>Tick the box next to the app name, and click <code>Start</code></p> <p></p> <p>The app should now start. Congratulations, you have installed the app!</p> <p></p> </li> <li> <p>Open Boards</p> <p>You should now be able to load the Boards app with HCL Connections header at this path:</p> <pre><code>https://[CONNECTIONS_URL]/boards\n</code></pre> <p>For example:</p> <pre><code>https://connections.example.com/boards\n</code></pre> </li> </ol>"},{"location":"boards/connections/keycloak/","title":"Keycloak Authentication","text":"<p>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.</p> <p>When using this approch, Huddo Boards will get tokens from keycloak but will still validate them against connections using the url <code>/connections/opensocial/oauth/rest/people/@me/@self</code></p> <p>The following ENV variables should be set to achieve this:</p> Key Description <code>user.env.CONNECTIONS_CLIENT_ID</code> Your Keycloak application client-id <code>user.env.CONNECTIONS_CLIENT_SECRET</code> Your Keycloak application client-secret <code>user.env.CONNECTIONS_URL</code> HCL Connections URL, e.g. <code>https://connections.example.com</code> <code>user.env.CONNECTIONS_KEYCLOAK_URL</code> Your Keycloak URL e.g. <code>https://login.example.com</code> <code>user.env.CONNECTIONS_KEYCLOAK_REALM</code> Your Keycloak realm <code>user.env.CONNECTIONS_KEYCLOAK_PATH</code> Optional: Keycloak pathDefault: <code>/auth/realms</code>Customise this to <code>/realms</code> as of Keycloak v22"},{"location":"boards/connections/migration/","title":"Migration of Activities to Huddo Boards (using standalone Mongo/Redis)","text":"<p>Tip</p> <p>If you are using Component Pack please follow this guide</p> <p>As part of the installation process for Huddo Boards you can run the migration service to move the existing Activities into Huddo Boards.</p> <p>Info</p> <p>Please review the Roles page for details on how Community Activity membership is interpreted &amp; presented by Boards</p>"},{"location":"boards/connections/migration/#difference-between-the-individual-import","title":"Difference between the individual import","text":"<p>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.</p> <p>So you'll need to use the migration service described here to import all data in the new Boards.</p>"},{"location":"boards/connections/migration/#process-overview","title":"Process Overview","text":"<p>This service will:</p> <ol> <li>access Activities data in the existing Connections SQL database</li> <li>process the Activity into a Board</li> <li>get file attachments and long descriptions via mounting the Connections shared drive</li> <li>write Boards data into the Component Pack mongo database</li> <li>write file attachments into S3 storage</li> </ol> <p>Ensure you have updated the following variables as applicable in the <code>global.env</code> section of your <code>boards.yaml</code> file downloaded previously</p> Example Description <code>sharedDrive.server</code> <code>192.168.10.1</code> or <code>websphereNode1</code> IP or Hostname of the server with the Connections shared drive mount <code>sharedDrive.path</code> <code>/opt/HCL/Connections/data/shared</code> or <code>/nfs/data/shared</code> Path on the mount to the Connections shared drive <code>sharedDrive.storage</code> <code>10Gi</code> (optional) The capacity of the PV and PVC <code>sharedDrive.accessMode</code> <code>ReadOnlyMany</code> (optional) The accessMode of the PV and PVC <code>sharedDrive.volumeMode</code> <code>Filesystem</code> (optional) The volumeMode of the PV and PVC <code>sharedDrive.persistentVolumeReclaimPolicy</code> <code>Retain</code> (optional) The persistentVolumeReclaimPolicy of the PV and PVC <code>sharedDrive.storageClassName</code> <code>manual</code> (optional) The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) <code>sharedDrive.spec</code> Example Using a fully custom spec - e.g. FlexVolume or hostPath <code>env.CONNECTIONS_URL</code> <code>httsp://connections.example.com</code> URL of your Connections environment <code>env.FILE_PATH_ACTIVITIES_CONTENT_STORE</code> <code>/data/activities/content</code> 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. <code>env.API_GATEWAY</code> <code>https://[CONNECTIONS_URL]/api-boards</code> URL of the Boards API.Used by files attached to a board. URL. <code>env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME</code> <code>connectionsadmin</code> Credentials for user with <code>admin</code> role on the Activities application.See <code>ISC</code> =&gt; <code>Applications</code> =&gt; <code>Activities</code> =&gt; <code>Security role to user mapping</code> <code>env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD</code> <code>adminpassword</code> Password for the Activities administrator <code>env.CONNECTIONS_DB_TYPE</code> <code>db2</code> or <code>mssql</code> or <code>oracle</code> SQL database type hosting Activities. <code>env.CONNECTIONS_DB_HOST</code> <code>dbserver.company.com</code> SQL Server hostname <code>env.CONNECTIONS_DB_PORT</code> <code>50000</code> or <code>1433</code> or <code>1531</code> SQL Server connection port <code>env.CONNECTIONS_DB_USER</code> <code>dbuser</code> SQL Server user name <code>env.CONNECTIONS_DB_PASSWORD</code> <code>dbpassword</code> SQL Server user password <code>env.CONNECTIONS_DB_SID</code> <code>DATABASE</code> SQL Server SIDNote: applicable to Oracle <code>env.CONNECTIONS_DB_DOMAIN</code> <code>domain</code> SQL Server connection stringNote: applicable to Microsoft SQL <code>env.CONNECTIONS_DB_CONNECT_STRING</code> <code>HOSTNAME=&lt;host&gt;;PROTOCOL=...</code> or <code>&lt;host&gt;:&lt;port&gt;/&lt;sid&gt;</code> SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle <code>env.PROCESSING_PAGE_SIZE</code> <code>10</code> (default) Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database <code>env.PROCESSING_LOG_EVERY</code> <code>50</code> (default) The migration process logs every 50 Activities completed <code>env.IMMEDIATELY_PROCESS_ALL</code> <code>false</code> (default) Process ALL Activities on service startup. <code>env.COMPLETE_ACTIVITY_AFTER_MIGRATED</code> <code>false</code> Mark the old Activity data as complete <code>env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED</code> <code>false</code> Create link to new Board in old Activity <p>Example:</p> <pre><code>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    # ...\n</code></pre>"},{"location":"boards/connections/migration/#deploy-helm-chart","title":"Deploy Helm Chart","text":"<p>Please deploy the following chart with the same configuration <code>boards.yaml</code> file used to deploy the huddo-boards chart</p> <pre><code>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\n</code></pre> <p>Note: the new <code>sharedDrive</code> parameters described above. You may also need to delete the previously name chart</p>"},{"location":"boards/connections/migration/#migrate-activities","title":"Migrate Activities","text":"<p>The migration interface is accessible at <code>https://[BOARDS_URL]/admin/migration</code> to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.</p> <p>You can also set the <code>global.env.IMMEDIATELY_PROCESS_ALL</code> variable if you wish to migrate every Activity without the UI.</p>"},{"location":"boards/connections/migration/#logs","title":"Logs","text":"<p>You can check the pod logs for the activity-migration to see progress of the running migration:</p> <pre><code>kubectl logs -n boards -f $(kubectl get pod -n boards | grep activity-migration | awk '{print $1}')\n</code></pre> <p>When the helm chart was installed in another namespace (<code>helm upgrade ... --namespace my-boards</code>), change <code>-n boards</code> to your modified namespace like <code>-n my-boards</code>. To stop following the logs, press <code>[Ctrl] + [C]</code>.</p> <p>For example</p> <p></p>"},{"location":"boards/connections/migration/#after-migration-complete","title":"After Migration Complete","text":"<ol> <li> <p>The Migration service can be removed. Please use the following command</p> <pre><code>helm delete huddo-boards-activity-migration --purge\n</code></pre> </li> <li> <p>Turn off the Activities application in WebSphere ISC</p> </li> </ol>"},{"location":"boards/connections/mobile-app-hybrid/","title":"HCL Connections Mobile App Setup","text":"<p>Basic instructions for adding Huddo Boards into the HCL Connections mobile application</p>"},{"location":"boards/connections/mobile-app-hybrid/#mobile-app-integration","title":"Mobile App Integration","text":"<ol> <li> <p>Check-out <code>mobile-config.xml</code></p> <pre><code>execfile(\"mobileAdmin.py\")\nMobileConfigService.checkOutConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Edit <code>mobile-config.xml</code></p> <ul> <li>Find the <code>Applications</code> element and add the following <code>Application</code>:<pre><code>&lt;Application name=\"Boards\" enabled=\"true\"&gt;\n  &lt;ApplicationIcon&gt;\n    &lt;Android&gt;\n      &lt;Hdpi&gt;http://boards.huddo.com/img/logo-small.png&lt;/Hdpi&gt;\n      &lt;Mdpi&gt;http://boards.huddo.com/img/logo-small.png&lt;/Mdpi&gt;\n      &lt;Ldpi&gt;http://boards.huddo.com/img/logo-small.png&lt;/Ldpi&gt;\n    &lt;/Android&gt;\n    &lt;IOS&gt;\n      &lt;Reg&gt;http://boards.huddo.com/img/logo-small.png&lt;/Reg&gt;\n      &lt;Retina&gt;http://boards.huddo.com/img/logo-small.png&lt;/Retina&gt;\n    &lt;/IOS&gt;\n    &lt;DefaultLocation&gt;http://boards.huddo.com/img/logo-small.png&lt;/DefaultLocation&gt;\n  &lt;/ApplicationIcon&gt;\n  &lt;ApplicationLabel&gt;Huddo Boards&lt;/ApplicationLabel&gt;\n  &lt;ApplicationURL&gt;https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]&lt;/ApplicationURL&gt;\n&lt;/Application&gt;\n</code></pre> </li> </ul> <p>where <code>[CONNECTIONS_HOSTNAME_BASE64]</code> is your Connections hostname base64 encoded.  E.g. <code>connections.example.com</code> =&gt; <code>Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=</code></p> <ul> <li>Find the <code>ApplicationsList</code> or <code>DefaultNavigationOrder</code> element and append <code>Boards</code>. For example:<pre><code>&lt;ApplicationsList&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards&lt;/ApplicationsList&gt;\n</code></pre> <p>or</p> <pre><code>&lt;DefaultNavigationOrder&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards&lt;/DefaultNavigationOrder&gt;\n</code></pre> </li> </ul> </li> <li> <p>Save and check-in <code>mobile-config.xml</code></p> <pre><code>MobileConfigService.checkInConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Sync the <code>Nodes</code> as required</p> </li> </ol>"},{"location":"boards/connections/mobile-app-on-prem/","title":"HCL Connections Mobile App Setup","text":"<p>Basic instructions for adding Huddo Boards into the HCL Connections mobile application</p>"},{"location":"boards/connections/mobile-app-on-prem/#mobile-app-integration","title":"Mobile App Integration","text":"<ol> <li> <p>Check out <code>mobile-config.xml</code></p> <pre><code>execfile(\"mobileAdmin.py\")\nMobileConfigService.checkOutConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Edit <code>mobile-config.xml</code></p> <ul> <li> <p>Find the <code>Applications</code> element and add the following <code>Application</code>:</p> <pre><code>&lt;Application name=\"Boards\" enabled=\"true\"&gt;\n  &lt;ApplicationIcon&gt;\n    &lt;Android&gt;\n      &lt;Hdpi&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Hdpi&gt;\n      &lt;Mdpi&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Mdpi&gt;\n      &lt;Ldpi&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Ldpi&gt;\n    &lt;/Android&gt;\n    &lt;IOS&gt;\n      &lt;Reg&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Reg&gt;\n      &lt;Retina&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Retina&gt;\n    &lt;/IOS&gt;\n    &lt;DefaultLocation&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/DefaultLocation&gt;\n  &lt;/ApplicationIcon&gt;\n  &lt;ApplicationLabel&gt;Huddo Boards&lt;/ApplicationLabel&gt;\n  &lt;ApplicationURL&gt;https://[BOARDS_URL]/auth/connections&lt;/ApplicationURL&gt;\n&lt;/Application&gt;\n</code></pre> <p>where <code>[BOARDS_URL]</code> is your configured URL for Boards.</p> </li> <li> <p>Find the <code>ApplicationsList</code> or <code>DefaultNavigationOrder</code> element and append <code>Boards</code>. For example:</p> <pre><code>&lt;ApplicationsList&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards&lt;/ApplicationsList&gt;\n</code></pre> <p>or</p> <pre><code>&lt;DefaultNavigationOrder&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards&lt;/DefaultNavigationOrder&gt;\n</code></pre> </li> </ul> </li> <li> <p>Save and check-in <code>mobile-config.xml</code></p> <pre><code>MobileConfigService.checkInConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Sync the <code>Nodes</code> as required</p> </li> </ol>"},{"location":"boards/connections/security/","title":"Boards Hybrid Security","text":"<p>Huddo Boards connects to your Connections servers over HTTPS via OAuth.</p>"},{"location":"boards/connections/security/#ip-allow-list","title":"IP Allow List","text":"<p>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</p> <pre><code>34.91.118.129/32    GCloud Prod EU Cluster NAT\n34.129.215.36/32    GCloud Staging Cluster NAT\n</code></pre> <p>We communicate over HTTPS, so the port <code>443</code> must be allowed</p>"},{"location":"boards/connections/widgets-hybrid/","title":"HCL Connections Widget Setup","text":"<p>Add Huddo Boards Hybrid widgets into HCL Connections on-premise environments</p>"},{"location":"boards/connections/widgets-hybrid/#community-widget","title":"Community Widget","text":"<ol> <li> <p>SSH to the WAS Deployment Manager</p> </li> <li> <p>Start <code>wsadmin</code></p> <pre><code>cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin\n./wsadmin.sh -lang jython -user wasadmin -password &lt;password-here&gt;\n</code></pre> </li> <li> <p>Check out the <code>widgets-config.xml</code> file.</p> <pre><code>execfile(\"profilesAdmin.py\")\nProfilesConfigService.checkOutWidgetConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Edit the <code>widgets-config.xml</code> file.</p> <p>Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <pre><code>&lt;!-- Huddo Boards --&gt;\n&lt;widgetDef defId=\"HuddoBoards\" modes=\"view fullpage\" url=\"{webresourcesSvcRef}/web/com.ibm.social.urliWidget.web.resources/widget/urlWidget.xml\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"width\" value=\"100%\"/&gt;\n        &lt;item name=\"height\" value=\"500px\"/&gt;\n        &lt;item name=\"url\" value=\"https://boards.huddo.com/community/connections\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;!-- END Huddo Boards --&gt;\n</code></pre> </li> <li> <p>Check in the <code>widgets-config.xml</code> file.</p> <pre><code>ProfilesConfigService.checkInWidgetConfig()\n</code></pre> </li> <li> <p>Restart the <code>Communities</code> application via the ISC</p> </li> <li> <p>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.</p> </li> </ol>"},{"location":"boards/connections/widgets-hybrid/#activity-stream-widget","title":"Activity Stream widget","text":"<ol> <li> <p>Open <code>Homepage</code> =&gt; <code>Administration</code></p> <p>Click <code>Add another app</code></p> <p></p> </li> <li> <p>Select the following:</p> <ul> <li><code>OpenSocial Gadget</code></li> <li><code>Trusted</code> and <code>Use SSO</code></li> <li><code>Show for Activity Stream events</code></li> <li><code>All servers</code></li> </ul> <p>Click the <code>Add Mapping</code> button.</p> <p></p> </li> <li> <p>Enter values:</p> <ul> <li>OAuth Client: <code>conn-ee</code></li> <li>Service name: <code>connections_service</code></li> </ul> <p>Click <code>Ok</code></p> </li> <li> <p>Enter the following:</p> Field Value App Title Huddo Boards Stream URL Address <code>https://boards.huddo.com/widgets/connections/url-gadget.xml</code> Icon URL <code>https://boards.huddo.com/favicon.ico</code> </li> <li> <p>Scroll down and click <code>Save</code></p> </li> <li> <p>Select the newly defined app and click <code>Enable</code></p> <p></p> </li> </ol>"},{"location":"boards/connections/widgets-hybrid/#cec-community-highlights","title":"CEC (Community Highlights)","text":"<p>Huddo Boards integrates with Connections Engagement Center</p> <p></p> <ol> <li> <p>Download the Boards Hybrid widget definition file</p> </li> <li> <p>Open the CEC (XCC) main admin page</p> <p>i.e. <code>https://connections.company.com/xcc/main</code></p> </li> <li> <p>Click <code>Customize</code>, <code>Engagement Center Settings</code>, expand <code>Customization Files</code> &amp; click <code>Upload File</code></p> <p></p> <p>Note: you must have the admin role for the <code>Customize</code> button to appear</p> </li> <li> <p>Select the <code>custom.js</code> downloaded previously</p> <p>Note: the file must have this name. If you already have a <code>custom.js</code> file you must manually merge the contents. Copy the <code>HuddoBoards()</code> function and make sure to call it in <code>init()</code></p> </li> <li> <p>To validate:</p> <ol> <li>Open the <code>Highlights</code> application in a Community</li> <li> <p>Click <code>Customize</code>, <code>Widgets</code> and <code>Huddo Boards</code></p> <p></p> </li> <li> <p>The Boards Highlights widget should now appear at the end of the page</p> <p></p> </li> </ol> </li> </ol>"},{"location":"boards/connections/widgets-on-prem/","title":"HCL Connections Widget Setup","text":"<p>Add Huddo Boards Docker widgets into HCL Connections on-premise environments</p>"},{"location":"boards/connections/widgets-on-prem/#community-widget","title":"Community Widget","text":"<ol> <li> <p>SSH to the WAS Deployment Manager</p> </li> <li> <p>Start <code>wsadmin</code></p> <pre><code>cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin\n./wsadmin.sh -lang jython -user wasadmin -password &lt;password-here&gt;\n</code></pre> </li> <li> <p>Check out the <code>widgets-config.xml</code> file.</p> <pre><code>execfile(\"profilesAdmin.py\")\nProfilesConfigService.checkOutWidgetConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Edit the <code>widgets-config.xml</code> file.</p> <p>Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following, replacing <code>[BOARDS_URL]</code> with your URL:</p> <pre><code>&lt;!-- Huddo Boards --&gt;\n&lt;widgetDef defId=\"HuddoBoards\" modes=\"view fullpage\" url=\"{webresourcesSvcRef}/web/com.ibm.social.urliWidget.web.resources/widget/urlWidget.xml\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"width\" value=\"100%\"/&gt;\n        &lt;item name=\"height\" value=\"500px\"/&gt;\n        &lt;item name=\"url\" value=\"https://[BOARDS_URL]/boards/community/connections\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;!-- END Huddo Boards --&gt;\n</code></pre> </li> <li> <p>Disable Community Activity widget</p> <p>Tip</p> <p>this is optional but highly recommended for CP installations of Activities Plus</p> <p>Once Activities are migrated into Boards, it is recommended that the Community Activity widget is disabled to prevent confusion around the old data.</p> <p>Find and comment out the Activity widget with <code>defId=\"Activities\"</code></p> <p></p> </li> <li> <p>Check in the widgets-config.xml file.</p> <pre><code>ProfilesConfigService.checkInWidgetConfig()\n</code></pre> </li> <li> <p>Restart the <code>Communities</code> application via the ISC</p> <p>Tip</p> <p>If widgets no longer load in Communities and you see errors in the browser console like:</p> <pre><code>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\n</code></pre> <p>then please ensure the Connections domain root certificate is trusted in the WebSphere ISC. This can be added using <code>Retrieve from port</code> under <code>SSL certificate and key management</code> &gt; <code>Key stores and certificates</code> &gt; <code>CellDefaultTrustStore</code> &gt; <code>Signer certificates</code></p> </li> <li> <p>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.</p> </li> </ol>"},{"location":"boards/connections/widgets-on-prem/#activity-stream-widget","title":"Activity Stream widget","text":"<ol> <li> <p>Open <code>Homepage</code> =&gt; <code>Administration</code></p> <p>Click <code>Add another app</code></p> <p></p> </li> <li> <p>Select the following:</p> <ul> <li><code>OpenSocial Gadget</code></li> <li><code>Trusted</code> and <code>Use SSO</code></li> <li><code>Show for Activity Stream events</code></li> <li><code>All servers</code></li> </ul> <p>Click the <code>Add Mapping</code> button.</p> <p></p> </li> <li> <p>Enter values:</p> <ul> <li>OAuth Client: <code>conn-ee</code></li> <li>Service name: <code>connections_service</code></li> </ul> <p>Click <code>Ok</code></p> </li> <li> <p>Enter the following, replacing <code>[BOARDS_URL]</code> with your URL:</p> Field Value App Title Huddo Boards Stream URL Address <code>https://[BOARDS_URL]/widgets/connections/url-gadget.xml</code> Icon URL <code>https://[BOARDS_URL]/favicon.ico</code> Icon Secure URL <code>https://[BOARDS_URL]/favicon.ico</code> <p>Scroll down and click <code>Save</code></p> </li> <li> <p>Select the newly defined app and click <code>Enable</code></p> <p></p> </li> </ol>"},{"location":"boards/connections/widgets-on-prem/#cec-community-highlights","title":"CEC (Community Highlights)","text":"<p>Huddo Boards integrates with Connections Engagement Center</p> <p></p> <ol> <li> <p>Download the Boards CP widget definition file</p> </li> <li> <p>Open the CEC (XCC) main admin page</p> <p>i.e. <code>https://connections.company.com/xcc/main</code></p> </li> <li> <p>Click <code>Customize</code>, <code>Engagement Center Settings</code>, expand <code>Customization Files</code> &amp; click <code>Upload File</code></p> <p></p> <p>Note: you must have the admin role for the <code>Customize</code> button to appear</p> </li> <li> <p>Select the <code>custom.js</code> downloaded previously</p> <p>Note: the file must have this name. If you already have a <code>custom.js</code> file you must manually merge the contents. Copy the <code>HuddoBoards()</code> function and make sure to call it in <code>init()</code></p> </li> <li> <p>To validate:</p> <ol> <li>Open the <code>Highlights</code> application in a Community</li> <li> <p>Click <code>Customize</code>, <code>Widgets</code> and <code>Huddo Boards</code></p> <p></p> </li> <li> <p>The Boards Highlights widget should now appear at the end of the page</p> <p></p> </li> </ol> </li> </ol>"},{"location":"boards/connections/customizer/customizer-integrations-package/","title":"Customizer Integrations","text":"<p>Boards adds multiple features to other HCL Connections applications via Connections Customizer. For details about what features this adds, see the usage documentation.</p> <p>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.</p>"},{"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":"<p>Check the rules in your HTTP proxy that direct traffic to <code>mw-proxy</code> (customizer). See the relevant section from the install documentation.</p> <p>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.</p> <p>This example works well. If you have a suggestion for improvement, please open a GitHub issue.</p> <pre><code>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\n</code></pre>"},{"location":"boards/connections/customizer/customizer-integrations-package/#add-resources-to-mw-proxy-server","title":"Add Resources to <code>mw-proxy</code> Server","text":"<ol> <li>Get a terminal session to your <code>mw-proxy</code> server. e.g. via <code>ssh</code></li> <li><code>mkdir /pv-connections/customizations/boards-extensions</code> if it doesn't exist.</li> <li><code>cd /pv-connections/customizations/boards-extensions</code></li> <li>In a web browser, download your custom Boards Extensions package from Huddo Store.</li> <li>Extract this package to <code>/pv-connections/customizations/boards-extensions</code>.</li> <li><code>cat settings.js</code> and check that the \"boardsURL\" property has been set to the URL of your Boards deployment.</li> </ol>"},{"location":"boards/connections/customizer/customizer-integrations-package/#add-the-app-to-connections-app-registry","title":"Add the app to Connections App Registry","text":"<ol> <li>In a web browser, open <code>https://&lt;CONNECTIONS_URL&gt;/files/customizer/boards-extensions/manifest.json</code> You should see JSON similar to the screenshot below. Copy this JSON to the clipboard. If this file doesn't exist, please check you have performed the step above.</li> <li>Open the Connections Customizer App Registry in your environment at <code>https://&lt;CONNECTIONS_URL&gt;/appreg</code></li> <li>Click </li> <li>Open Code Editor</li> <li>Paste the JSON from the clipboard, in to the editor<ul> <li>Your screen should look something like this:   </li> </ul> </li> <li>Click Save Changes. You should see a notice about your changes being saved.</li> <li>Important: Connections customizer only supports one extension that customizes the Connections Navigation (<code>\"type\": \"com.hcl.connections.nav\"</code>). If you already have nav customizations, you must remove the \"Tasks Nav Button\" extension from <code>manifest.json</code> and merge it in to your existing nav customization. Otherwise only one of your nav customisations will take effect.</li> </ol>"},{"location":"boards/connections/customizer/customizer-integrations-package/#disabling-extensions","title":"Disabling Extensions","text":"<p>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.</p> <p>Keep in mind that any changes made will be discarded when following the Updating steps below. </p>"},{"location":"boards/connections/customizer/customizer-integrations-package/#updating","title":"Updating","text":"<p>Remove all files in <code>/pv-connections/customizations/boards-extensions</code>. Repeat the above steps, overwriting the manifest in appreg.</p>"},{"location":"boards/connections/httpd/","title":"Proxy (httpd)","text":"<p>Tip</p> <p>To edit the <code>httpd.conf</code>, please follow this guide.</p> <p>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:</p>"},{"location":"boards/connections/httpd/#a-new-domain","title":"a) New Domain","text":"<ul> <li> <p>Allow CORS - follow these instructions.</p> </li> <li> <p>httpd</p> <pre><code>&lt;VirtualHost *:443&gt;\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&lt;/VirtualHost&gt;\n</code></pre> </li> </ul>"},{"location":"boards/connections/httpd/#b-existing-domain","title":"b) Existing domain","text":"<p>Tip</p> <p>If you have an NGINX (e.g. customizer) in front of IHS use that instead to support websockets and use one less proxy. Follow this guide for nginx.</p> <p>The following configuration should be set when Huddo Boards is deployed at a context root under the existing HCL Connections domain.</p> <p>It also includes a proxy rewrite rule, to serve the migrated Board when the legacy Activity URL is requested.</p> <pre><code>&lt;VirtualHost *:443&gt;\n    ServerName [CONNECTIONS_URL]\n\n    # redirect Activities to Boards once migrated\n    RewriteEngine On\n    RewriteRule ^/activities/service/html/(.*)$ /boards/activities/service/html/$1  [R]\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&lt;/VirtualHost&gt;\n</code></pre> <p>Where:</p> <ul> <li><code>[CONNECTIONS_URL]</code> is the URL of your HCL Connections deployment</li> <li><code>[KUBERNETES_NAME]</code> is the hostname/IP of the master in your cluster</li> <li><code>[KUBERNETES_PORT]</code> is the port of your Ingress Controller (ie 32080)</li> </ul> <p>For example:</p> <pre><code>&lt;VirtualHost *:443&gt;\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&lt;/VirtualHost&gt;\n</code></pre>"},{"location":"boards/connections/httpd/edit/","title":"Edit","text":""},{"location":"boards/connections/httpd/edit/#open-proxy-config","title":"Open Proxy Config","text":"<ol> <li> <p>Open WebSphere ISC</p> <p>This is usually accessible through a URL like:</p> <pre><code>https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\n</code></pre> <p></p> </li> <li> <p>Open <code>Servers</code> -&gt; <code>Server Types</code> =&gt; <code>Web servers</code></p> <p>Click on the name of your web server</p> <p></p> </li> <li> <p>Click <code>Edit</code> on the <code>http.conf</code></p> <p></p> </li> </ol>"},{"location":"boards/connections/httpd/sso-header/","title":"Connections Header via SSO","text":"<p>The following configuration is required to load the Connections Header via SSO from the Boards domain.</p> <ol> <li> <p>Open the <code>httpd.conf</code> as per this guide.</p> </li> <li> <p>Add the following:</p> <p>Note</p> <p>Customise the <code>SetEnvIf</code> domain below as required for your Boards domain.</p> <pre><code># 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\"\n</code></pre> </li> <li> <p>Apply similar changes anywhere that the LtpaToken is issued. For example:</p> <ul> <li> <p>via an <code>nginx</code> proxy:</p> <pre><code># Allow LtpaToken usage from Boards domain\nproxy_cookie_flags LtpaToken Secure SameSite=None;\nproxy_cookie_flags LtpaToken2 Secure SameSite=None;\n</code></pre> </li> </ul> </li> </ol>"},{"location":"boards/connections/httpd/sso-header/#verse-integration","title":"Verse integration","text":"<p>See HCL Domino documentation for more details</p> <p>Tip</p> <p>Users may need to logout and login to Connections again for the LtpaToken cookie to be re-issued with SSO enabled</p>"},{"location":"boards/cp/","title":"Huddo Boards for HCL Connections CP","text":"<p>Info</p> <p>The HCL Connections Component Pack (CP) provides a MongoDB database and Redis cache. Huddo Boards for CP utilises these existing services.  This guide will walk you through the setup to deploy a Minio S3 service for storage, and the Huddo Boards services into your existing CP environment.</p>"},{"location":"boards/cp/#releases","title":"Releases","text":"<p>See the latest changes in our On-Premise Release notes.</p>"},{"location":"boards/cp/#prerequisites","title":"Prerequisites","text":"<ol> <li>HCL Component Pack is installed and running</li> <li>WebSphere environment with Web Server (or another reverse proxy)</li> <li>kubectl is installed and configured</li> <li>helm is installed</li> <li>SMTP gateway setup for email notifications if required</li> </ol>"},{"location":"boards/cp/#ssl-network-setup","title":"SSL / Network setup","text":"<p>Huddo Boards uses the existing CP infrastructure.</p> <p>The UI and API each require a unique route:</p> <ul> <li>UI for Boards: <code>[CONNECTIONS_URL]/boards</code>. We will refer to this as <code>BOARDS_URL</code></li> <li>API Gateway: <code>[CONNECTIONS_URL]/api-boards</code>. We will refer to this as <code>API_URL</code></li> </ul> <p>For more details on configuring a reverse proxy, please see below.</p>"},{"location":"boards/cp/#setup-oauth","title":"Setup OAuth","text":"<p>Please follow our instructions to setup HCL Connections OAuth for Huddo Boards.</p> <p>The OAuth Callback URL for this configuration is <code>https://[BOARDS_URL]/auth/connections/callback</code></p>"},{"location":"boards/cp/#storage","title":"Storage","text":""},{"location":"boards/cp/#s3","title":"S3","text":"<p>Huddo Boards for Component Pack deploys a Minio service. Please follow S3 storage details here to configure the NFS mount.</p>"},{"location":"boards/cp/#mongo","title":"Mongo","text":"<p>Huddo Boards uses the Mongo database already deployed inside the Component Pack. There is no configuration required.</p>"},{"location":"boards/cp/#licence-key","title":"Licence Key","text":"<p>Huddo Boards / Activities Plus is a free entitlement however it requires a licence key from https://store.huddo.com. For more details see here.</p>"},{"location":"boards/cp/#deployment","title":"Deployment","text":""},{"location":"boards/cp/#update-config-file","title":"Update Config file","text":"<p>Download our config file and update all the values inside. Descriptions as below.</p> <p>Kubernetes variables:</p> Key Description <code>global.env.APP_URI</code> <code>https://[BOARDS_URL]</code> (e.g. <code>https://connections.example.com/boards</code>) <code>webfront.ingress.hosts</code> <code>[CONNECTIONS_URL]</code> (no protocol, e.g. <code>connections.example.com</code>) <code>core.ingress.hosts</code> <code>[API_URL]</code> (no protocol, e.g. <code>connections.example.com/api-boards</code>) <code>minio.nfs.server</code> IP address of the NFS Server file mount (e.g. <code>192.168.10.20</code>) <code>minio.storageClassName</code> (Optional) name of the storage class when using dynamic provisioning <p>Boards variables:</p> <p>Are detailed here.</p> <p>Customising Boards notifications:</p> <p>Some elements of the Boards notifications that are sent out can be customised.</p> <p>Activity migration variables:</p> <p>The Activity migration chart will be deployed separately but use the same config file. The variables are described here.</p>"},{"location":"boards/cp/#install-boards-helm-chart","title":"Install Boards Helm Chart","text":"<p>Install the Boards services via our Helm chart</p> <pre><code>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\n</code></pre> <p>Note: <code>--recreate-pods</code> ensures all images are up to date. This will cause downtime.</p>"},{"location":"boards/cp/#proxy-config","title":"Proxy Config","text":"<p>For Connections on-premise you have two options:</p> <ol> <li> <p><code>nginx</code> - if you have an NGINX (e.g. customizer) in front of IHS use that instead to support websockets and use one less proxy. Follow these instructions.</p> </li> <li> <p><code>httpd</code> - please follow these instructions.</p> </li> </ol>"},{"location":"boards/cp/#integrations","title":"Integrations","text":""},{"location":"boards/cp/#hcl-connections","title":"HCL Connections","text":"<ul> <li>Apps Menu</li> <li>Widgets</li> <li>Customizer - Boards Search</li> </ul>"},{"location":"boards/cp/#microsoft-teams","title":"Microsoft Teams","text":"<ul> <li>Install On-Premise App</li> </ul>"},{"location":"boards/cp/#migrate-activities-data","title":"Migrate Activities data","text":"<p>Please follow the instructions here</p>"},{"location":"boards/cp/#subscribing-to-latest-updates-from-huddo-team","title":"Subscribing to latest updates from Huddo Team","text":"<p>Guide here</p>"},{"location":"boards/cp/dockerhub/","title":"Latest Boards releases directly from Dockerhub","text":"<p>Warning</p> <p>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.</p> <p>You can get the latest versions of Huddo Boards Docker by subscribing to our own repository in dockerhub as follows:</p> <ol> <li>Create a dockerhub account if you do not already have one.</li> <li>Email support@huddo.com requesting access to Huddo Boards Docker repository, include your dockerhub account name in the email.</li> <li> <p>Create kubernetes secret with your dockerhub account credentials</p> <pre><code>kubectl create secret docker-registry dockerhub --docker-server=docker.io --docker-username=[user] --docker-password=[password] --docker-email=[email] --namespace=connections\n</code></pre> </li> <li> <p>Once confirmed by reply email, update your <code>boards-cp.yaml</code> file as per this example.</p> <ol> <li> <p>At the top set</p> <ul> <li><code>global.imagePullSecret</code> to <code>dockerhub</code></li> <li>remove your customised <code>global.repository</code></li> <li><code>global.imageTagSuffix</code> as the date of our latest release and uncomment it</li> </ul> </li> <li> <p>Add <code>image.name</code> (blank) and <code>image.tag</code> for each service as per this example.</p> <p>Tip</p> <p>Some of the services (<code>app</code>, <code>provider</code>, <code>notification</code>) might not be in your <code>boards-cp.yaml</code> file, you must add them.</p> <p></p> </li> </ol> </li> <li> <p>Run helm to apply the changes.</p> <pre><code>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\n</code></pre> </li> </ol>"},{"location":"boards/cp/latest/","title":"Moving from your local HCL Connections repository to Huddo Boards latest releases.","text":"<ol> <li> <p>Follow this guide to configure your Kubernetes with access to our images hosted in Quay.io.</p> </li> <li> <p>Once confirmed by reply email, update your <code>boards-cp.yaml</code> file as per this example. At the top set</p> <ul> <li><code>global.imageTag</code> as the date of our latest release</li> <li> <p><code>global.imagePullSecret</code> to the name of the secret you created</p> <p>e.g. <code>&lt;USERNAME&gt;-pull-secret</code></p> <p></p> </li> </ul> </li> <li> <p>Run the Helm upgrade command with our new Huddo chart to apply the changes.</p> <pre><code>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\n</code></pre> <p>Note</p> <p>The chart name has changed. You may need to <code>helm delete kudos-boards-cp</code> first</p> </li> </ol>"},{"location":"boards/cp/minio/","title":"Configure CP S3 Storage Mount","text":""},{"location":"boards/cp/minio/#deploy-instructions","title":"Deploy instructions","text":"<ol> <li> <p>Create the folder on the <code>nfs.server</code></p> <pre><code>sudo mkdir /pv-connections/kudos-boards-minio\nsudo chmod 755 /pv-connections/kudos-boards-minio\n</code></pre> </li> <li> <p>Ensure each Node in your Kubernetes cluster can mount this location.</p> <p>Please modify the file <code>/etc/exports</code> on your NFS Server to include this line</p> <pre><code>/pv-connections/kudos-boards-minio &lt;IP_RANGE_OF_YOUR_SERVERS&gt;/&lt;SUBNET_MASK&gt;(rw,no_root_squash)\n</code></pre> <p>For example:</p> <pre><code>/pv-connections/kudos-boards-minio 192.168.0.0/255.255.0.0(rw,no_root_squash)\n</code></pre> </li> <li> <p>Apply new NFS storage to exports</p> <pre><code>exportfs -ra\n</code></pre> </li> </ol>"},{"location":"boards/cp/releases/","title":"Releases","text":"<p>This page has moved here</p>"},{"location":"boards/cp/migration/","title":"Migration of Activities to Huddo Boards (with Component Pack)","text":"<p>Tip</p> <p>If you are not using Component Pack please follow this guide</p> <p>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.</p> <p>Info</p> <p>Please review the Roles page for details on how Community Activity membership is interpreted &amp; presented by Boards</p>"},{"location":"boards/cp/migration/#process-overview","title":"Process Overview","text":"<p>This service will:</p> <ol> <li>access Activities data in the existing Connections SQL database</li> <li>process the Activity into a Board</li> <li>get file attachments and long descriptions via mounting the Connections shared drive</li> <li>write Boards data into the Component Pack mongo database</li> <li>write file attachments into S3 storage</li> </ol> <p>Ensure you have updated the following variables as applicable in your <code>boards-cp.yaml</code> file downloaded previously</p> Variable Example Description <code>sharedDrive.server</code> <code>192.168.10.1</code> or <code>websphereNode1</code> IP or Hostname of the server with the Connections shared drive mount <code>sharedDrive.path</code> <code>/opt/HCL/Connections/data/shared</code> or <code>/nfs/data/shared</code> Path on the mount to the Connections shared drive <code>sharedDrive.mountOptions</code> <code>-nfsvers=4.1</code> (optional) Any additional sharedDrive mountOptions. All yaml is passed through drive <code>sharedDrive.storage</code> <code>10Gi</code> (optional) The capacity of the PV and PVC <code>sharedDrive.accessMode</code> <code>ReadOnlyMany</code> (optional) The accessMode of the PV and PVC <code>sharedDrive.volumeMode</code> <code>Filesystem</code> (optional) The volumeMode of the PV and PVC <code>sharedDrive.persistentVolumeReclaimPolicy</code> <code>Retain</code> (optional) The persistentVolumeReclaimPolicy of the PV and PVC <code>sharedDrive.storageClassName</code> <code>manual</code> (optional) The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) <code>sharedDrive.spec</code> See below Using a fully custom spec - e.g. FlexVolume or hostPath <code>env.FILE_PATH_ACTIVITIES_CONTENT_STORE</code> <code>/data/activities/content</code> 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. <code>env.API_GATEWAY</code> <code>https://[CONNECTIONS_URL]/api-boards</code> URL of the Boards API.Used by files attached to a board. URL. <code>env.TZ</code> <code>Europe/London</code> or <code>Australia/Hobart</code> etc 'Local' TimezoneUsed for date interpretation. See full list of supported timezones <code>env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME</code> <code>connectionsadmin</code> Credentials for user with <code>admin</code> role on the Activities application.See <code>ISC</code> =&gt; <code>Applications</code> =&gt; <code>Activities</code> =&gt; <code>Security role to user mapping</code> <code>env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD</code> <code>adminpassword</code> Password for the Activities administrator <code>env.CONNECTIONS_DB_TYPE</code> <code>db2</code> or <code>mssql</code> or <code>oracle</code> SQL database type hosting Activities. <code>env.CONNECTIONS_DB_HOST</code> <code>dbserver.company.com</code> SQL Server hostname hostname <code>env.CONNECTIONS_DB_PORT</code> <code>50000</code> or <code>1433</code> or <code>1531</code> SQL Server connection port <code>env.CONNECTIONS_DB_USER</code> <code>dbuser</code> SQL Server user name <code>env.CONNECTIONS_DB_PASSWORD</code> <code>dbpassword</code> SQL Server password password <code>env.CONNECTIONS_DB_SID</code> <code>DATABASE</code> SQL Server SIDNote: applicable to Oracle <code>env.CONNECTIONS_DB_DOMAIN</code> <code>domain</code> SQL Server connection stringNote: applicable to Microsoft SQL <code>env.CONNECTIONS_DB_CONNECT_STRING</code> <code>HOSTNAME=&lt;host&gt;;PROTOCOL=...</code> or <code>&lt;host&gt;:&lt;port&gt;/&lt;sid&gt;</code> SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle <code>env.PROCESSING_PAGE_SIZE</code> <code>10</code> (default) Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database <code>env.PROCESSING_LOG_EVERY</code> <code>50</code> (default) The migration process logs every 50 Activities completed <code>env.IMMEDIATELY_PROCESS_ALL</code> <code>false</code> (default) Process ALL Activities on service startup. <code>env.COMPLETE_ACTIVITY_AFTER_MIGRATED</code> <code>false</code> Mark the old Activity data as complete <code>env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED</code> <code>false</code> Create link to new Board in old Activity"},{"location":"boards/cp/migration/#custom-db-names","title":"Custom DB Names","text":"<p>If you have a custom database names for either the Activities or Profiles database, you can override the defaults using the following variables:</p> Variable Default Description <code>env.CONNECTIONS_DB_ACTIVITIES</code> <code>OPNACT</code> Activities database <code>env.CONNECTIONS_PEOPLEDB_DATABASE</code> <code>PEOPLEDB</code> Profiles database"},{"location":"boards/cp/migration/#peopledb-acl","title":"PeopleDB ACL","text":"<p>Additional Properties for access to <code>PEOPLEDB</code> if separate host or authentication.</p> Variable Default Example Description <code>env.CONNECTIONS_PEOPLEDB_HOST</code> <code>env.CONNECTIONS_DB_HOST</code> <code>dbserver.company.com</code> SQL Server hostname <code>env.CONNECTIONS_PEOPLEDB_PORT</code> <code>env.CONNECTIONS_DB_PORT</code> <code>50000</code> or <code>1433</code> or <code>1531</code> SQL Server connection port <code>env.CONNECTIONS_PEOPLEDB_SID</code> <code>env.CONNECTIONS_DB_SID</code> <code>DATABASE</code> SQL Server SID (for Oracle) <code>env.CONNECTIONS_PEOPLEDB_USER</code> <code>env.CONNECTIONS_DB_USER</code> <code>dbuser</code> SQL Server user name <code>env.CONNECTIONS_PEOPLEDB_PASSWORD</code> <code>env.CONNECTIONS_DB_PASSWORD</code> <code>dbpassword</code> SQL Server user password <code>env.CONNECTIONS_PEOPLEDB_CONNECT_STRING</code> <code>env.CONNECTIONS_DB_CONNECT_STRING</code> <code>HOSTNAME=&lt;host&gt;;PROTOCOL=...</code> or <code>&lt;host&gt;:&lt;port&gt;/&lt;sid&gt;</code> SQL Server connection string"},{"location":"boards/cp/migration/#mssql","title":"MSSQL","text":"Variable Default Example Description <code>env.CONNECTIONS_DB_OPTIONS</code> undefined {\"trustServerCertificate\": true} JSON encoded options for the MS SQL Server connection string."},{"location":"boards/cp/migration/#custom-persistent-volume","title":"Custom Persistent Volume","text":"<p>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.</p> <p>Note</p> <p>We recommend running the helm chart with <code>--dry-run --debug</code> to confirm the yaml output</p> <ol> <li> <p>Host path</p> <p>Tip</p> <p>This can be used in conjunction with existing linux methods (e.g. <code>cifs-utils</code>, <code>smbclient</code> etc) to mount a Windows Samba share directly onto the Kubernetes Node(s).</p> <p>Please read the Kubernetes documentation.</p> <pre><code>migration:\n  sharedDrive:\n    storageClassName: manual\n    spec:\n      hostPath:\n        path: /data/shared\n</code></pre> </li> <li> <p>Kubernetes CIFS Volume Driver (for Samba shares).</p> <p>Please read the CIFS documentation</p> <pre><code>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\n</code></pre> </li> </ol> <p>Additional for Windows</p> <p>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:</p> <ol> <li>Temporarily copy the Activity Store content directory at <code>&lt;SHARED_DRIVE&gt;/activities/content</code> (e.g. <code>/opt/HCL/connections/data/shared/activities/content</code>) to an existing Linux accessible drive (e.g. <code>/pv-connections/activitystore</code>).</li> <li>Set the standard <code>sharedDrive.server</code> &amp; <code>sharedDrive.path</code> to mount this path at <code>/data</code> in the containers</li> <li>Set <code>migration.env.FILE_PATH_ACTIVITIES_CONTENT_STORE: \"/data\"</code></li> </ol>"},{"location":"boards/cp/migration/#deploy-helm-chart","title":"Deploy Helm Chart","text":"<p>Please deploy the following chart with the same configuration <code>boards-cp.yaml</code> file used to deploy the huddo-boards-cp chart</p> <pre><code>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\n</code></pre> <p>Note: the configuration file has changed as of the v3 chart. Please add the new <code>sharedDrive</code> parameters described above</p>"},{"location":"boards/cp/migration/#migrate-activities","title":"Migrate Activities","text":"<p>The migration interface is accessible at <code>https://[CONNECTIONS_URL]/boards/admin/migration</code> to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.</p> <p>You can also set the <code>env.IMMEDIATELY_PROCESS_ALL</code> if you wish to migrate every Activity without the UI.</p>"},{"location":"boards/cp/migration/#logs","title":"Logs","text":"<p>You can check the pod logs for the activity-migration to see progress of the running migration</p> <p>For example</p> <p></p>"},{"location":"boards/cp/migration/#after-migration-complete","title":"After Migration Complete","text":"<ol> <li> <p>The Migration service can be removed. Please use the following command</p> <pre><code>helm delete huddo-boards-cp-activity-migration --purge\n</code></pre> </li> <li> <p>Turn off the Activities application in WebSphere ISC</p> </li> </ol>"},{"location":"boards/cp/migration/interface/","title":"Activity Migration User Interface","text":""},{"location":"boards/cp/migration/interface/#remaining-tab","title":"Remaining Tab","text":"<p>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.</p>"},{"location":"boards/cp/migration/interface/#activities-table","title":"Activities Table","text":"<p>Select Activities to migrate by clicking the checkboxs next to each activity.</p> <p>The table can be sorted by clicking the headers for each column.</p> <p>The number of rows per page can be increased using the <code>Rows</code> dropdown.</p>"},{"location":"boards/cp/migration/interface/#filters","title":"Filters","text":"<p>There are multiple filters that can be applied that will remove activities from the table and the activities included when choosing MIGRATE ALL.</p> <p>Notice that when filters are applied, the total number in the table and MIGRATE ALL button changes.</p>"},{"location":"boards/cp/migration/interface/#options","title":"Options","text":"<p>Near the MIGRATE buttons, there is an Options panel to for enabling features that will affect this migration.</p> <p>WARNING: These options will irreversibly modify your Activities.</p> 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 the <code>CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED</code> 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 <code>COMPLETE_ACTIVITY_AFTER_MIGRATED</code> 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":"<p>This tab shows all of the activities that have been migrated into Huddo Boards. The <code>Activity Name</code> is a link to the Activity. The <code>Board</code> column has links to each Board in Huddo Boards.</p>"},{"location":"boards/cp/migration/interface/#boards-user-data-tab","title":"Boards User Data Tab","text":"<p>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.</p> <p>Each user who has used Huddo Boards WebSphere is likely to have created some of this data. It includes:</p> <ul> <li>The labels a user has assigned to colors which they apply to Board Tiles.</li> <li>The Categories a user has created which they apply to Board Tiles.</li> </ul> <p>If the user already exists in Huddo Boards Docker:</p> <ul> <li>Their color labels will be deleted and replaced with the labels from Boards WebSphere.</li> <li>Imported Categories will be added to their existing list of categories.</li> </ul> <p>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.</p>"},{"location":"boards/cp/roles/","title":"Roles","text":""},{"location":"boards/cp/roles/#member-roles","title":"Member Roles","text":"<p>Boards has the following membership roles</p> 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 &amp; Editors Owners of the Community have <code>Owner</code> role. Members of the Community have <code>Editor</code> role Owned by Owners &amp; Authors Owners of the Community have <code>Owner</code> role. Members of the Community have <code>Author</code> role Shared with  Owned by Owners &amp; Readers Owners of the Community have <code>Owner</code> role. Members of the Community have <code>Reader</code> role Owned by Community Owner Only Owners of the Community have <code>Owner</code> 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":"<p>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.</p>"},{"location":"boards/cp/roles/#activity-in-community","title":"Activity in Community","text":"Activities Boards Owners &amp; Members assigned the Owner role  Owner role is assigned to the entire community  Members are Authors  Role is <code>Owners &amp; Authors</code> as per above  Members are Readers  Role is <code>Owners &amp; Readers</code> as per above  As above, with users specified  Each user is migrated with their role  Members have NO access  Role is <code>Community Owners Only</code> as per above"},{"location":"boards/cp/roles/#standalone-activity","title":"Standalone Activity","text":"Activities Boards"},{"location":"boards/domino/","title":"Boards for HCL Domino (REST API)","text":"<p>Huddo Boards supports authentication, user and group lookup with HCL Domino.</p> <p></p> <p>Using the old Proton configuration?</p> <p>See our migration guide.</p>"},{"location":"boards/domino/#prerequisites","title":"Prerequisites","text":"<ol> <li>Domino REST API installed and configured. Ensure you setup the oauth.json file.</li> <li>Enabled access to names.nsf</li> </ol>"},{"location":"boards/domino/#setup","title":"Setup","text":"<ol> <li> <p>Configure OAuth</p> <p>URLs</p> <p>For an on premise installation the callback url &amp; startup page is simple:</p> <pre><code>https://&lt;BOARDS_URL&gt;/auth/domino/callback\nhttps://&lt;BOARDS_URL&gt;/auth/domino\n</code></pre> <p>For example:</p> <pre><code>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\n</code></pre> <p>Please determine the URL for your environment and then follow this guide.</p> </li> <li> <p>Configure Schema</p> </li> <li> <p>Configure Scope</p> </li> </ol>"},{"location":"boards/domino/#licence","title":"Licence","text":"<p>Huddo Boards requires a licence key from the Huddo Store. For more details see here.</p> <ol> <li>Register your account</li> <li>Create your Organisation</li> <li> <p>Add client details for your Domino server</p> <p></p> </li> <li> <p>Download licence key - this will be used in the environment variable <code>licence.env.LICENCE</code></p> </li> </ol>"},{"location":"boards/domino/#deployment","title":"Deployment","text":"<ol> <li> <p>Deploy Boards using the Domino values in either:</p> <ul> <li>Kubernetes or</li> <li>Docker</li> </ul> </li> </ol>"},{"location":"boards/domino/callback/","title":"Domino Callback URL","text":"<p>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: <code>https://boards.huddo.com/auth/domino/[ encoded domain ]/callback</code></p> <p>e.g. for domain proton.example.com the callback url would be https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback</p> <p>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:</p> <ul> <li><code>https://boards.your.domain.com/auth/domino/callback</code></li> <li><code>https://your.domain.com/boards/auth/domino/callback</code> if you have a context root (i.e. you would access boards application at /boards).</li> </ul>"},{"location":"boards/domino/cloud/","title":"HCL Domino REST API for Boards Cloud","text":"<p>Huddo Boards Cloud supports authentication, user and group lookup with HCL Domino.</p> <p>Tip</p> <p>See Domino REST API for Boards On-Premise for Boards On Premise installations.</p>"},{"location":"boards/domino/cloud/#prerequisites","title":"Prerequisites","text":"<ol> <li>Domino REST API installed and configured. Ensure you setup the oauth.json file.</li> <li>Enabled access to names.nsf</li> </ol>"},{"location":"boards/domino/cloud/#setup","title":"Setup","text":"<ol> <li> <p>Configure OAuth</p> <p>URLs</p> <p>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.</p> <pre><code>// callback URL\nhttps://boards.huddo.com/auth/domino/[ encoded domain ]/callback\n\n// startup page\nhttps://boards.huddo.com/auth/domino/[ encoded domain ]\n</code></pre> <p>e.g. the callback url would look like this: <code>https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback</code></p> <p>Please determine the URL for your environment and then follow this guide.</p> </li> <li> <p>Configure Schema</p> </li> <li> <p>Configure Scope</p> </li> </ol>"},{"location":"boards/domino/cloud/#application-process","title":"Application Process","text":"<p>Please email support@huddo.com with the following details</p> 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/proton/","title":"Huddo Boards for HCL Domino Proton (DEPRECATED)","text":"<p>Warning</p> <p>These instructions are deprecated. Please see the new Domino REST API for new installations. For existing installations we recommend following our migration guide.</p> <p>Huddo Boards supports authentication, user and group lookup with HCL Domino.</p>"},{"location":"boards/domino/proton/#prerequisites","title":"Prerequisites","text":"<ul> <li>Domino Proton (AppDev Pack &gt;= 1.0.12) Documentation</li> <li>Domino IAM service (AppDev Pack &gt;= 1.0.12) Overview</li> <li>User credentials (PEM certificate and Key) for an application user that Boards will use to read a names.nsf database via the Proton Service.</li> </ul>"},{"location":"boards/domino/proton/#setup","title":"Setup","text":"<p>We will require 2 domains from you</p> <ul> <li>Domino Server domain (that has Proton listening)</li> <li>IAM Server domain</li> </ul>"},{"location":"boards/domino/proton/#iam-setup","title":"IAM Setup","text":"<p>Callback URL</p> <p>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: <code>https://boards.huddo.com/auth/domino/[ encoded domain ]/callback</code></p> <p>e.g. for domain proton.example.com the callback url would be https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback</p> <p>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:</p> <ul> <li><code>https://boards.your.domain.com/auth/domino/callback</code></li> <li><code>https://your.domain.com/boards/auth/domino/callback</code> if you have a context root (i.e. you would access boards application at /boards).</li> </ul> <p>You will need to setup an Application in the IAM Service with the following details</p> 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":"<p>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</p>"},{"location":"boards/domino/proton/#application-process","title":"Application Process","text":"<p>Please email support@huddo.com with the following details</p> 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":"<p>Using the old Proton configuration?</p> <pre><code>If you are using the [old Proton configuration](../proton.md), you will need to migrate to the new Domino REST API configuration. This guide will help you through the process.\n</code></pre>"},{"location":"boards/domino/migration/#prerequisites","title":"Prerequisites","text":"<ol> <li>Domino REST API installed and configured. Ensure you setup the oauth.json file.</li> <li>Enabled access to names.nsf</li> <li>Configured Boards OAuth client</li> <li> <p>Check Release date</p> <p>Ensure you are running images after 30 November 2023</p> <p></p> </li> </ol>"},{"location":"boards/domino/migration/#migration-steps","title":"Migration Steps","text":""},{"location":"boards/domino/migration/#edit-domino-client","title":"Edit Domino Client","text":"<p>Danger</p> <p>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.</p> <ol> <li> <p>Open <code>Admin Settings</code>, then your organisation</p> <p></p> <p></p> </li> <li> <p>Open Domino client</p> <p></p> </li> <li> <p>Edit Domino client</p> <p>Tip</p> <p>Save a copy of the old values in case you need to reverse the changes.</p> <p>Change the old Proton values to new Domino REST API values as configured</p> Comment Domino URL <code>https://&lt;NEW_DOMINO_REST_API&gt;</code> 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. <p>For example:</p> <p></p> <p>Click <code>Save</code></p> </li> </ol>"},{"location":"boards/domino/migration/#deploy-oauth","title":"Deploy OAuth","text":"<ol> <li>Open the <code>boards.yaml</code> configuration file which you have deployed</li> <li> <p>Set environment variables for the user service as follows (substituting the values above)</p> <pre><code>user:\n    env:\n        DOMINO_AUTH_URL: https://&lt;NEW_DOMINO_REST_API&gt;\n        DOMINO_CLIENT_ID: &lt;CLIENT_ID&gt;\n        DOMINO_CLIENT_SECRET: &lt;CLIENT_SECRET&gt;\n        DOMINO_USE_PROFILE_IMAGE_ATTACHMENTS: 'true'\n</code></pre> </li> <li> <p>Run your deploy command (e.g. <code>helm upgrade...</code>, <code>docker compose up</code>)</p> </li> </ol>"},{"location":"boards/domino/migration/#validation","title":"Validation","text":"<p>Warning</p> <p>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.</p> <ol> <li> <p>Open a new Boards session</p> <p>Click <code>Domino</code></p> <p></p> </li> <li> <p>Enter your credentials for the new REST API</p> <p></p> </li> <li> <p>Once Authenticated, you should see the approval request</p> <p>Click <code>Allow</code></p> <p></p> </li> </ol>"},{"location":"boards/domino/oauth/","title":"Configure Domino OAuth (REST API)","text":"<p>This guide will describe how to add a new OAuth application for Boards users to login via Domino.</p> <p></p>"},{"location":"boards/domino/oauth/#steps","title":"Steps","text":"<ol> <li> <p>Open the REST API and click <code>Configuration</code></p> <p></p> </li> <li> <p>Login</p> <p></p> </li> <li> <p>Click <code>Application Management - OAUTH</code></p> <p></p> </li> <li> <p>Click <code>Add Application</code></p> <p></p> </li> <li> <p>Enter the following details and click <code>ADD</code></p> <p>Determine the appropriate URL for your environment as per our guide.</p> <ul> <li>Application Name: <code>Huddo Boards</code></li> <li> <p>Callback URL, e.g.</p> <pre><code>  https://&lt;ON_PREM_BOARDS_URL&gt;/auth/domino/callback\n  https://boards.huddo.com/auth/domino/[encoded domain]/callback\n</code></pre> </li> <li> <p>Startup Page, e.g.</p> <pre><code>  https://&lt;ON_PREM_BOARDS_URL&gt;/auth/domino\n  https://boards.huddo.com/auth/domino/[encoded domain]\n</code></pre> </li> <li> <p>Scope: <code>$DATA</code> (click <code>+</code> icon)</p> </li> <li>Contacts: <code>&lt;YOUR_EMAIL&gt;</code></li> </ul> <p></p> </li> <li> <p>Click the <code>generate application secret</code> icon.</p> <p></p> </li> <li> <p>Copy both the <code>App Id</code> and <code>App Secret</code></p> <p>These will be referred to later as <code>CLIENT_ID</code> and <code>CLIENT_SECRET</code></p> </li> </ol>"},{"location":"boards/domino/schema/","title":"Configure Domino Schema (REST API)","text":"<p>This guide will describe how to add a new Schema called <code>directory</code> to access the <code>names.nsf</code> database. Boards uses the <code>$Users</code> &amp; <code>$Groups</code> views of this database. This section will configure the database forms.</p> <p></p>"},{"location":"boards/domino/schema/#steps","title":"Steps","text":"<ol> <li> <p>Open the REST API and click <code>Configuration</code></p> <p></p> </li> <li> <p>Click <code>Database Management - REST API</code></p> <p></p> </li> <li> <p>Click <code>Add Schema</code></p> <p></p> </li> <li> <p>Enter the following details and click <code>ADD</code></p> <p>Tip</p> <p>If you cannot see <code>names.nsf</code> in the list, please see the HCL documentation</p> <ul> <li>Search Databases for <code>names.nsf</code> and click it</li> <li>Schema Name: <code>directory</code></li> <li>Description: <code>domino directory</code></li> <li>Formula Engine: <code>names.nsf</code></li> </ul> <p></p> </li> <li> <p>Open the new Schema and click the <code>Source</code> tab</p> <p></p> </li> <li> <p>Download this file and paste the contents into the editor</p> </li> </ol>"},{"location":"boards/domino/scope/","title":"Configure Domino Scope (REST API)","text":"<p>This guide will describe how to add a new Scope called <code>directorylookup</code> to allow reader access to the <code>names.nsf</code> database. Boards uses the <code>$Users</code> &amp; <code>$Groups</code> views of this database.</p> <p></p>"},{"location":"boards/domino/scope/#steps","title":"Steps","text":"<ol> <li> <p>Open the REST API and click <code>Configuration</code></p> <p></p> </li> <li> <p>Click <code>Database Management - REST API</code></p> <p></p> </li> <li> <p>Click the <code>Scopes</code> icon in the right menu, click <code>Add Scope</code></p> <p></p> </li> <li> <p>Enter the following details and click <code>ADD</code></p> <ul> <li>Expand the Schemas =&gt; <code>names.nsf</code>. Click <code>directory</code></li> <li>Scope Name: <code>directorylookup</code></li> <li>Description: <code>Directory Lookup</code></li> <li>Maximum Access Level: <code>Reader</code></li> </ul> <p></p> </li> </ol>"},{"location":"boards/dx/","title":"Boards for HCL Digital Experience (DX)","text":""},{"location":"boards/dx/#prerequisites","title":"Prerequisites","text":"<ol> <li>HCL DX environment</li> <li> <p>Environment to host Boards, either:</p> <ul> <li>Kubernetes cluster with <code>kubectl</code> installed &amp; authenticated, or</li> <li>Docker</li> </ul> </li> </ol>"},{"location":"boards/dx/#licence-key","title":"Licence Key","text":"<p>Huddo Boards / Activities Plus is a free entitlement for HCL DX Customers, however it requires a licence key from https://store.huddo.com. For more details see here.</p>"},{"location":"boards/dx/#steps","title":"Steps","text":"<ol> <li> <p>Setup WebSphere OAuth</p> </li> <li> <p>Deploy Boards in either:</p> <ul> <li>Kubernetes or</li> <li>Docker</li> </ul> </li> <li> <p>Configure SSO for Boards</p> </li> <li> <p>Install &amp; configure the Boards portlet</p> </li> </ol>"},{"location":"boards/dx/#integration-options","title":"Integration options","text":"<p>The Boards API is the simplest way of extending Boards into your HCL DX environment.</p> <p>To authenticate, you will need to use the user's API Token. This can be obtained on behalf of the user via SSO. Simply request the <code>/user/auth/dx/&lt;BASE64_HOSTNAME&gt;/apitoken</code> endpoint from the Boards API from the client-side (browser) and include the DX session cookies. Based on your deployment architecture this can be achieved in two ways;</p> <ol> <li> <p>Same Domain</p> <p>If your Boards API is deployed on the same domain as your DX server, you can simply request the API Token from the Boards API like this:</p> <pre><code>https://&lt;DX_SERVER&gt;/api-boards/user/auth/dx/&lt;BASE64_HOSTNAME&gt;/apitoken\n</code></pre> </li> <li> <p>Different Domain</p> <p>If your DX server is not on the same domain as the Boards server, you will need to configure the DX proxy to pass the request through your DX server to the Boards server.</p> <p>The URL will then look like this:</p> <pre><code>https://&lt;DX_SERVER&gt;/wps/proxy/https/&lt;BOARDS_URL&gt;/user/auth/dx/&lt;BASE64_HOSTNAME&gt;/apitoken\n</code></pre> <p>For example:</p> <pre><code>https://dx.company.com/wps/proxy/https/boards.api.huddo.com/user/auth/dx/ZHguY29tcGFueS5jb20=/apitoken\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/proxy/","title":"Proxy","text":"<p>Tip</p> <p>If you are running Boards on a different domain to DX, you may need to configure a proxy to allow DX to connect to Boards. This is because browsers enforce CORS (Cross-Origin Resource Sharing) which prevents DX from making requests to a different domain.</p> <p>DX includes \"Outbound HTTP\" rules which means you can proxy requests to 3rd party domains via DX, overcoming CORS issues in browsers.</p>"},{"location":"boards/dx/auth/proxy/#steps","title":"Steps","text":"<ol> <li> <p>Create a proxy policy for the domain hosting the Boards API (e.g. <code>*.huddo.com</code>)</p> <p><code>vi /opt/HCL/wp_profile/temp/huddo-com-policy.xml</code></p> <pre><code>&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;\n&lt;proxy-rules xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"http://www.ibm.com/xmlns/prod/sw/http/outbound/proxy-config/2.0\"&gt;\n    &lt;policy active=\"true\" basic-auth-support=\"true\" name=\"http_huddo_com_policy\" url=\"http://*.huddo.com*\"&gt;\n        &lt;actions&gt;\n            &lt;method&gt;GET&lt;/method&gt;\n            &lt;method&gt;POST&lt;/method&gt;\n            &lt;method&gt;PUT&lt;/method&gt;\n            &lt;method&gt;DELETE&lt;/method&gt;\n            &lt;method&gt;HEAD&lt;/method&gt;\n        &lt;/actions&gt;\n        &lt;cookie-rule name=\"http_huddo_com_cookies\"&gt;\n            &lt;cookie&gt;*&lt;/cookie&gt;\n            &lt;handling&gt;passthru&lt;/handling&gt;\n        &lt;/cookie-rule&gt;\n    &lt;/policy&gt;\n    &lt;policy active=\"true\" basic-auth-support=\"true\" name=\"https_huddo_com_policy\" url=\"https://*.huddo.com*\"&gt;\n        &lt;actions&gt;\n            &lt;method&gt;GET&lt;/method&gt;\n            &lt;method&gt;POST&lt;/method&gt;\n            &lt;method&gt;PUT&lt;/method&gt;\n            &lt;method&gt;DELETE&lt;/method&gt;\n            &lt;method&gt;HEAD&lt;/method&gt;\n        &lt;/actions&gt;\n        &lt;cookie-rule name=\"https_huddo_com_cookies\"&gt;\n            &lt;cookie&gt;*&lt;/cookie&gt;\n            &lt;handling&gt;passthru&lt;/handling&gt;\n        &lt;/cookie-rule&gt;\n    &lt;/policy&gt;\n&lt;/proxy-rules&gt;\n</code></pre> </li> <li> <p>Apply the policy usng the following command:</p> <pre><code>/opt/HCL/wp_profile/ConfigEngine/ConfigEngine.sh update-outbound-http-connection-config -DConfigFileName=/opt/HCL/wp_profile/temp/huddo-com-policy.xml -DPortalAdminId=YOUR_DX_ADMIN_ID -DPortalAdminPwd=YOUR_DX_ADMIN_PASSWORD -DWasUserId=YOUR_WAS_ADMIN_ID -DWasPassword=YOUR_WAS_ADMIN_PASSWORD\n</code></pre> </li> <li> <p>Import the SSL Certificate so DX can connect</p> <pre><code>/opt/HCL/AppServer/bin/wsadmin.sh -lang jython -username YOUR_WAS_ADMIN_ID -password YOUR_WAS_ADMIN_PASSWORD -c \"AdminTask.retrieveSignerFromPort(\\\"[-keyStoreName NodeDefaultTrustStore -keyStoreScope (cell):dockerCell:(node):dockerNode -host boards.api.huddo.com -port 443 -certificateAlias huddo-com.net -sslConfigName NodeDefaultSSLSettings -sslConfigScopeName (cell):dockerCell:(node):dockerNode ]\\\")\"\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/sso/","title":"Allow SSO for Boards","text":"<p>Tip</p> <p>This task is only required if Boards is hosted on a different domain to HCL DX</p>"},{"location":"boards/dx/auth/sso/#steps","title":"Steps","text":"<p>Complete the following steps for your applicable Proxy Server</p>"},{"location":"boards/dx/auth/sso/#haproxy","title":"haproxy","text":"<p>Edit the <code>haproxy.cfg</code> configuration using the following command</p> <pre><code>kubectl edit configmap &lt;DX_DEPLOYMENT&gt;-haproxy -n &lt;DX_NAMESPACE&gt; -o yaml\n</code></pre> <p>For example:</p> <pre><code>kubectl edit configmap hcl-dx-dev1-haproxy -n hcl-dx-dev1 -o yaml\n</code></pre> <p>Add the following line</p> <pre><code>http-response replace-header Set-Cookie ^(.*) \\1;\\ SameSite=None;\\ Secure\n</code></pre> <p>For example:</p> <p></p>"},{"location":"boards/dx/auth/sso/#httpd","title":"httpd","text":"<p>Edit the <code>httpd.conf</code> configuration file to include the following:</p> <pre><code>Header edit Set-Cookie ^(.*)$ \"$1; Secure; SameSite=None\"\n</code></pre>"},{"location":"boards/dx/auth/websphere/","title":"WebSphere OAuth Config","text":"<p>OAuth must be configured in IBM WebSphere for Boards to authenticate with HCL DX.</p> <p>Tip</p> <p>Remember to replace <code>&lt;username&gt;</code> &amp; <code>&lt;password&gt;</code> with valid credentials</p> <p>Connect to the core server, e.g on Kubernetes:</p> <pre><code>kubectl exec -it hcl-dx-dev1-core-0 core -n hcl-dx-dev1 -- sh\n</code></pre>"},{"location":"boards/dx/auth/websphere/#create-service-provider","title":"Create Service Provider","text":"<p>Note</p> <p>This step is based on the IBM WebSphere documentation - Creating an OAuth service provider.</p> <ol> <li> <p>Create the OAuth provider by using the wsadmin utility</p> <pre><code>cd /opt/HCL/AppServer/bin\n./wsadmin.sh -lang jython -username &lt;username&gt; -password &lt;password&gt;\n\nAdminTask.createOAuthProvider('[-providerName &lt;OAuthProviderName&gt; -fileName &lt;ProviderConfigFile&gt;]')\n</code></pre> <p>Where:</p> <ul> <li><code>&lt;OAuthProviderName&gt;</code> is the OAuth provider name (typically <code>OAuthConfig</code>)</li> <li><code>&lt;ProviderConfigFile&gt;</code> is the full path to the OAuth provider configuration file. Please download and use this DXProvider.xml configuration file which includes Auto Authorize setup for the <code>huddoboards</code> client.</li> </ul> <p>Tip</p> <p>The supplied DXProvider.xml file uses an in-memory store for token storage. You may choose to enable a JDBC database store instead.</p> <p>For example:</p> <pre><code>AdminTask.createOAuthProvider('[-providerName OAuthConfig -fileName /opt/HCL/AppServer/properties/DXProvider.xml]')\nAdminConfig.save()\nquit\n</code></pre> <p>This should copy the configuration file to <code>&lt;was_profile_root&gt;/config/cells/&lt;cell_name&gt;/oauth20</code></p> <p>Please confirm this file exists, e.g. <code>/opt/HCL/wp_profile/config/cells/dockerCell/oauth20/OAuthConfig.xml</code></p> </li> <li> <p>Restart the WebSphere Application Server</p> <pre><code>cd /opt/HCL/AppServer/bin\n./stopServer.sh WebSphere_Portal -profileName wp_profile -username &lt;username&gt; -password &lt;password&gt;\n./startServer.sh WebSphere_Portal -profileName wp_profile\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/websphere/#configure-tai-properties","title":"Configure TAI properties","text":"<ol> <li> <p>Open the ISC</p> <p>Click <code>Global security</code>, expand <code>Web and SIP security</code>, click <code>Trust association</code></p> <p></p> </li> <li> <p>Click <code>Interceptors</code></p> <p></p> </li> <li> <p>Ensure that <code>com.ibm.ws.security.oauth20.tai.OAuthTAI</code> exists</p> <p></p> <p>If not, click <code>New</code> enter the Interceptor class name <code>com.ibm.ws.security.oauth20.tai.OAuthTAI</code>, and click <code>OK</code></p> </li> <li> <p>Update the custom properties to match:</p> <pre><code>provider_1.name=OAuthConfig\nprovider_1.filter=Authorization%=Bearer\n</code></pre> <p>For example:</p> <p></p> </li> </ol>"},{"location":"boards/dx/auth/websphere/#register-oauth-client","title":"Register OAuth Client","text":"<p>Note</p> <p>This step is based on the IBM WebSphere documentation - Creating an OAuth service provider.</p> <ol> <li> <p>Copy default client definitions</p> <pre><code>cp &lt;app_server_root&gt;/properties/base.clients.xml &lt;was_profile_root&gt;/config/cells/&lt;cell_name&gt;/oauth20oauth20/\n</code></pre> <p>For example:</p> <pre><code>cp /opt/HCL/AppServer/properties/base.clients.xml /opt/HCL/wp_profile/config/cells/dockerCell/oauth20/\n</code></pre> </li> <li> <p>Edit file to include Huddo Boards client</p> <p><code>vi /opt/HCL/wp_profile/config/cells/dockerCell/oauth20/base.clients.xml</code></p> <pre><code>&lt;client id=\"huddoboards\" component=\"&lt;OAUTH_PROVIDER_NAME&gt;\" secret=\"&lt;OAUTH_SECRET&gt;\" displayname=\"Huddo Boards\" redirect=\"https://&lt;BOARDS_URL&gt;/auth/dx/&lt;BASE_64_ENCODED_DX_HOSTNAME&gt;/callback\" enabled=\"true\"&gt;\n&lt;/client&gt;\n</code></pre> <p>Where:</p> <ul> <li><code>&lt;OAUTH_PROVIDER_NAME&gt;</code> is the name of the Provider specified above, typically <code>OAuthConfig</code></li> <li><code>&lt;OAUTH_SECRET&gt;</code> is a complex, random secret, e.g. a UUID. This will be required later.</li> <li><code>&lt;BOARDS_URL&gt;</code> is the URL of the Boards deployment, e.g. <code>company.example.com/boards</code> or <code>boards.company.com</code></li> <li><code>&lt;BASE_64_ENCODED_DX_HOSTNAME&gt;</code> is a base64(dx-hostname) encoded string</li> </ul> <p>For example:</p> <pre><code>&lt;client id=\"huddoboards\" component=\"OAuthConfig\" secret=\"a2e3d8c3-7875-4512-a0da-8b5fd61f2245\" displayname=\"Huddo Boards\" redirect=\"https://boards.huddo.com/auth/dx/ZHguY29tcGFueS5jb20=/callback\" enabled=\"true\"&gt;\n&lt;/client&gt;\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/websphere/#install-oauth-application","title":"Install OAuth Application","text":"<p>Note</p> <p>This step is based on the IBM documentation - Enabling your system to use the OAuth 2.0 feature.</p> <ol> <li> <p>Install the OAuth 2.0 service provider application</p> <pre><code>cd /opt/HCL/AppServer/bin\n./wsadmin.sh -f ./installOAuth2Service.py install dockerNode WebSphere_Portal -profileName wp_profile -username &lt;username&gt; -password &lt;password&gt;\n</code></pre> </li> <li> <p>Enable OAuth 2.0 TAI</p> <pre><code>cd /opt/HCL/AppServer/bin\n./wsadmin.sh -lang jython -username &lt;username&gt; -password &lt;password&gt;\nAdminTask.enableOAuthTAI()\nAdminConfig.save()\nquit\n</code></pre> </li> <li> <p>Restart the WebSphere Application Server</p> <pre><code>cd /opt/HCL/AppServer/bin\n./stopServer.sh WebSphere_Portal -profileName wp_profile -username &lt;username&gt; -password &lt;password&gt;\n./startServer.sh WebSphere_Portal -profileName wp_profile\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/websphere/#troubleshooting","title":"Troubleshooting","text":"<p>Issue: SSL Error</p> <pre><code>ServletWrapper service CWSRV0014E: Uncaught service() exception root cause OAuth20EndpointServlet: javax.net.ssl.SSLHandshakeException: com.ibm.jsse2.util.j: PKIX path building failed: com.ibm.security.cert.IBMCertPathBuilderException: unable to find valid certification path to requested target\n</code></pre> <p>Resolution: Import the self-signed certificate into the WebSphere ISC</p>"},{"location":"boards/dx/portlet/","title":"Boards Portlet","text":""},{"location":"boards/dx/portlet/#overview","title":"Overview","text":"<p>The steps below install the Boards Portlet as an application in DX.</p> <p></p> <p></p>"},{"location":"boards/dx/portlet/#steps","title":"Steps","text":"<p>To install the Huddo Boards portlet, follow these steps:</p>"},{"location":"boards/dx/portlet/#install","title":"Install","text":"<ol> <li> <p>Download the Boards Portlet WAR file</p> </li> <li> <p>Open the DX <code>Administration</code> =&gt; <code>Web Modules</code>. Select the war file and click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Finish</code> to complete the installation</p> <p></p> </li> </ol>"},{"location":"boards/dx/portlet/#unique-id","title":"Unique ID","text":"<p>Note</p> <p>This step is suggested for best practice.</p> <ol> <li> <p>Go to <code>Settings</code> =&gt; <code>Custom Unique Names</code> and click <code>Portlets</code></p> <p></p> </li> <li> <p>Search for Title starts with <code>huddo</code> and click <code>Edit</code></p> <p></p> </li> <li> <p>Set the <code>Unique .ame</code> to <code>huddo.boards</code> and click <code>OK</code></p> <p></p> </li> </ol>"},{"location":"boards/dx/portlet/#acl","title":"ACL","text":""},{"location":"boards/dx/portlet/#web-module","title":"Web Module","text":"<ol> <li> <p>Find the newly installed <code>Boards</code> portlet, click <code>Assign access to Web module</code></p> <p></p> </li> <li> <p>Click <code>User</code> =&gt; <code>Edit Role</code></p> <p></p> </li> <li> <p>Click <code>Add</code></p> <p></p> </li> <li> <p>Check <code>All Authenticated Portal Users</code> and click <code>OK</code></p> <p></p> </li> </ol>"},{"location":"boards/dx/portlet/#application","title":"Application","text":"<ol> <li> <p>Open <code>Applications</code>, search by title for <code>boards</code>, click <code>Assign access to Web module</code></p> <p></p> </li> <li> <p>Click <code>User</code> =&gt; <code>Edit Role</code></p> <p></p> </li> <li> <p>Click <code>Add</code></p> <p></p> </li> <li> <p>Check <code>All Authenticated Portal Users</code> and click <code>OK</code></p> <p></p> </li> </ol>"},{"location":"boards/dx/portlet/#configure","title":"Configure","text":"<ol> <li> <p>Open the <code>Portlets</code> page, find Huddo Boards, click <code>Configure Portlet</code></p> <p></p> </li> <li> <p>Edit the cfg.BaseURL to <code>https://&lt;BOARDS_URL&gt;</code>.</p> <p>For example:</p> <ul> <li><code>https://boards.company.com</code> or</li> <li><code>https://company.example.com/boards</code></li> <li><code>https://boards.huddo.com</code> (hybrid customers)</li> </ul> <p></p> <p>Click <code>OK</code></p> </li> <li> <p>The <code>Huddo Boards</code> Portlet should now be accessible at</p> <p><code>Edit mode</code> =&gt; <code>Add</code> =&gt; <code>Applications</code></p> <p></p> </li> <li> <p>Add it to any page to get started!</p> <p></p> </li> </ol>"},{"location":"boards/env/common/","title":"Configuration Options","text":""},{"location":"boards/env/common/#shared-options","title":"Shared Options","text":"<p>Please set the following environment variables in your config file as required</p> Key Description <code>global.env.API_GATEWAY</code> Fully qualified URL of the API in the format <code>https://[API_URL]</code> <code>webfront.env.DEFAULT_TEAM</code> 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. <code>licence.env.LICENCE</code> Licence key obtained from the Huddo Store <code>events.env.NOTIFIER_EMAIL_HOST</code> SMTP gateway hostname, e.g. <code>smtp.ethereal.com</code> <code>events.env.NOTIFIER_EMAIL_USERNAME</code> Optional: SMTP gateway authentication.Setting a value will enable auth and use the default port of <code>587</code> <code>events.env.NOTIFIER_EMAIL_PASSWORD</code> Optional: SMTP gateway authentication password <code>events.env.NOTIFIER_EMAIL_PORT</code> Optional: SMTP gateway port. Default: <code>25</code> (OR <code>587</code> if <code>NOTIFIER_EMAIL_USERNAME</code> is set) <code>events.env.NOTIFIER_EMAIL_FROM_NAME</code> Optional: Emails are sent from this name.Default: <code>Huddo Boards</code> <code>events.env.NOTIFIER_EMAIL_FROM_EMAIL</code> Optional: Emails are sent from this email address.Default: <code>no-reply@huddo.com</code> <code>events.env.NOTIFIER_EMAIL_SUPPORT_EMAIL</code> Optional: Support link shown in emails.Default: <code>support@huddo.com</code> <code>events.env.NOTIFIER_EMAIL_HELP_URL</code> Optional: Help link shown in new user welcome email.Default: <code>https://docs.huddo.com/boards/howto/knowledgebase/</code> <code>events.env.NOTIFIER_EMAIL_OPTIONS</code> Optional: Custom NodeMailer email options (insecure tls etc).For example: <code>\"{\\\"ignoreTLS\\\": true,\\\"tls\\\":{\\\"rejectUnauthorized\\\":false}}\"</code> <code>user.env.DISABLE_WELCOME_EMAIL</code> Optional: Set to disable welcome emails for users"},{"location":"boards/env/common/#provider-specific-options","title":"Provider Specific Options","text":""},{"location":"boards/env/common/#hcl-connections","title":"HCL Connections","text":"<p>Tip</p> <p>Optional: These settings are only required if you are using HCL Connections as your authentication provider.</p> Key Description <code>provider.env.WIDGET_ID</code> Optional: ID of the Community widget configured in this step <code>user.env.CONNECTIONS_NAME</code> Optional: If you refer to 'Connections' by another name, set it here <code>user.env.CONNECTIONS_CLIENT_ID</code> oAuth client-id, usually <code>huddoboards</code> <code>user.env.CONNECTIONS_CLIENT_SECRET</code> oAuth client-secret as configured in this step <code>user.env.CONNECTIONS_URL</code> HCL Connections URL, e.g. <code>https://connections.example.com</code> <code>user.env.CONNECTIONS_ADMINS</code> Emails or GUIDs of users to grant admin permissions.e.g. <code>\"[\\\"admin1@company.example.com\\\", \\\"PROF_GUID_2\\\"]</code>\" <code>user.env.CONNECTIONS_KEYCLOAK_URL</code> Optional: See keycloak authentication for more information <code>user.env.CONNECTIONS_KEYCLOAK_REALM</code> Optional: See keycloak authentication for more information"},{"location":"boards/env/common/#hcl-domino","title":"HCL Domino","text":"<p>Tip</p> <p>Optional: These settings are only required if you are using HCL Domino as your authentication provider.</p> Key Description <code>user.env.DOMINO_AUTH_URL</code> HCL Domino REST API URL. See domino authentication for more information <code>user.env.DOMINO_CLIENT_ID</code> oAuth client-id, see domino authentication for more information <code>user.env.DOMINO_CLIENT_SECRET</code> oAuth client-secret, see domino authentication for more information <code>user.env.DOMINO_ADMINS</code> Optional: Emails or GUIDs of users to grant admin permissions.See domino authentication for more information <code>user.env.DOMINO_USE_PROFILE_IMAGE_ATTACHMENTS</code> Optional: set <code>true</code> to enable using profile imagesSee domino authentication for more information <code>user.env.DOMINO_PROFILE_IMAGE_NAME</code> Optional: file name of profile images. Uses first image attached if not setSee domino authentication for more information <code>user.env.DOMINO_AUTH_SCOPE</code> Optional: defaults to <code>$DATA</code>See domino authentication for more information <code>user.env.DOMINO_REST_SCOPE</code> Optional: defaults to <code>directorylookup</code>See domino authentication for more information"},{"location":"boards/env/common/#hcl-digital-experience-dx","title":"HCL Digital Experience (DX)","text":"<p>Tip</p> <p>Optional: These settings are only required if you are using HCL DX as your authentication provider.</p> Key Description <code>user.env.DX_URL</code> HCL DX URL, e.g. <code>https://dx.company.com</code> <code>user.env.DX_CLIENT_ID</code> oAuth client-id, see dx authentication for more information <code>user.env.DX_CLIENT_SECRET</code> oAuth client-secret, see dx authentication for more information <code>user.env.DX_ADMINS</code> Optional: Emails or GUIDs of users to grant admin permissions. <code>user.env.DX_AUTH_PROVIDER_NAME</code> Optional: name of the OAuth Service Provider. Defaults to <code>OAuthConfig</code>"},{"location":"boards/env/notifications/","title":"Customise Emails","text":"<p>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.</p> <p>The image below shows the items that can be customised within notifications: </p> <p></p>"},{"location":"boards/env/notifications/#from-name","title":"From Name","text":"<p>Use <code>events.env.NOTIFIER_EMAIL_FROM_NAME</code> to set the from name for emails Default: <code>Huddo Boards</code></p>"},{"location":"boards/env/notifications/#from-email","title":"From Email","text":"<p>Use <code>events.env.NOTIFIER_EMAIL_FROM_EMAIL</code> to set the sent from email address Default: <code>no-reply@huddo.com</code></p>"},{"location":"boards/env/notifications/#app-logo","title":"App Logo","text":"<p>Specify a URL to point to a hosted logo image by specifying <code>events.env.APP_LOGO_URL</code> in the config.  For example: <code>https://company.com/assets/logo.png</code></p> <p>Note that an inline base64 encoded data URL can also be used for this variable.</p>"},{"location":"boards/env/notifications/#brand-logo","title":"Brand Logo","text":"<p>Specify a URL to point to a hosted logo image by specifying <code>events.env.BRAND_LOGO_URL</code> in the config.  For example: <code>https://company.com/assets/logo.png</code></p> <p>Note that an inline base64 encoded data URL can also be used for this variable.</p>"},{"location":"boards/env/notifications/#social-links","title":"Social Links","text":"<p>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.</p> <p>The standard/default Huddo social links can be replaced by setting the <code>events.env.SOCIAL_LINKS</code> variable. Specifying an empty array will remove all social links.</p> <p>The links are specified in a JSON array of objects with the format: <pre><code> {\n  name: \"Link Name/Text\", \n  link: \"Link URL\", \n  icon: \"(Optional) Hosted Icon URL or data URL\"\n}\n</code></pre></p> <p>e.g.: <pre><code>\"[{\\\"name\\\": \\\"Intranet\\\",\\\"link\\\":\\\"https://company.com/intranet/\\\"}, \n  { \\\"name\\\": \\\"Support\\\", \\\"link\\\": \\\"https://company.com/support\\\", \n    \\\"icon\\\": \\\"https://company.com/assets/support_icon.png\\\"}]\"\n</code></pre></p>"},{"location":"boards/env/notifications/#app-name","title":"App Name","text":"<p>Use <code>events.env.APP_NAME</code> to specify the app name.Default: <code>Huddo Boards</code></p>"},{"location":"boards/env/notifications/#support-email","title":"Support Email","text":"<p>The support email address can be specified in <code>events.env.NOTIFIER_EMAIL_SUPPORT_EMAIL</code>Default: <code>support@huddo.com</code></p>"},{"location":"boards/env/notifications/#email-config-example-yaml","title":"Email Config Example (YAML)","text":"<pre><code>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\n</code></pre>"},{"location":"boards/faq/kubectl/","title":"Configure kubectl","text":"<p>To configure <code>kubectl</code> to connect to your Kubernetes cluster, you need to copy the <code>~/.kube/config</code> file from the Kubernetes master server to your local machine. Please backup any existing local config</p>"},{"location":"boards/faq/languages/","title":"Languages","text":"<p>Huddo Boards supports many languages so our clients all around the world can easily use our product with minimal understanding issues.</p> <p>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.</p> 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":"<p>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.</p>"},{"location":"boards/faq/notifications/#new-user","title":"New User","text":"<p>Trigger First Sign in Recipients User Methods Email</p>"},{"location":"boards/faq/notifications/#user-invite","title":"User Invite","text":"<p>Trigger Inviting a user to a board by their email address Recipients Invitee Methods Email</p>"},{"location":"boards/faq/notifications/#added-to-board","title":"Added to Board","text":"<p>Trigger Adding user/group to a board Recipients Invitee Methods Email, Teams bot, Community stream</p>"},{"location":"boards/faq/notifications/#assigned-task","title":"Assigned Task","text":"<p>Trigger Assigning a user to a card</p> <p>Recipients Assignee Methods Email</p> <p>Recipients Groups that are members Methods Teams bot, Community stream</p>"},{"location":"boards/faq/notifications/#commented","title":"Commented","text":"<p>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</p>"},{"location":"boards/faq/notifications/#mentioned","title":"Mentioned","text":"<p>Trigger @Mentioning another member in a board description Recipients Anyone @Mentioned, Groups that are members Methods Email, Teams bot, Community stream</p>"},{"location":"boards/faq/notifications/#group-notifications","title":"Group Notifications","text":"<p>For boards that have groups as members, these notifications are sent to each group.</p> <p>Trigger Creating a new card, Changing properties of a board/card, Completing a board/card Recipients Group Methods Teams bot, Community stream</p>"},{"location":"boards/faq/notifications/#licence-notifications","title":"Licence Notifications","text":"<p>Trigger Quote Request, Payment Success/Failure, Licence created/updated Recipients Organisation Admins Methods Email</p>"},{"location":"boards/faq/open-source-licences/","title":"Open Source Licences","text":"<p>Huddo Boards builds on many open source frameworks and libraries. These have various licences enabling us to use and distribute the code. We have collected these into an easy file for you to view all of the Open Source Licences.</p>"},{"location":"boards/howto/","title":"User Guides","text":"<p>We have many guides for using Huddo Boards. Please contact us if you have any questions that are not covered.</p>"},{"location":"boards/howto/knowledgebase/","title":"Knowledge Base & Support","text":""},{"location":"boards/howto/knowledgebase/#knowledge-base","title":"Knowledge Base","text":"<p>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!</p> <p>Here are some quick how to guides to help you get started with Huddo Boards.\u00a0</p> <p>\u2b05 Click on the menu options to see more!</p>"},{"location":"boards/howto/knowledgebase/#customer-support","title":"Customer Support","text":""},{"location":"boards/howto/knowledgebase/#troubleshooting","title":"Troubleshooting","text":"<ul> <li>Boards in Microsoft 365</li> </ul>"},{"location":"boards/howto/knowledgebase/#contact","title":"Contact","text":"<p>If you require support using Huddo Boards, contact us at support@huddo.com</p>"},{"location":"boards/howto/mobile-app/","title":"Mobile app","text":"<p>You can access and work with Huddo Boards Cloud on your mobile device.</p>"},{"location":"boards/howto/mobile-app/#download-the-app-to-your-device","title":"Download the app to your device","text":"<p>Download the Huddo Boards Cloud App from either Apple App Store or Google Play Store.</p> <p> </p>"},{"location":"boards/howto/mobile-app/#login-to-the-huddo-boards-app","title":"Login to the Huddo Boards App","text":"<p>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.</p> <p></p> <p>You are in! Now you see all your existing Activities and Boards and can immediately start working!</p>"},{"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":"<p>Admin Guide to setting up Auth0 tenant.</p>"},{"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":"<p>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.</p> <p></p> <p>You'll then be asked to enter your email address and password.</p> <p>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.</p> <p></p>"},{"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":"<p>Huddo Boards provides 2 integration points with HCL Verse:</p>"},{"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":"Index","text":"<p>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.</p>"},{"location":"boards/howto/adding-members/#adding-members-to-a-new-board","title":"Adding Members to a New Board","text":"<p>You can add members when you first create a board.</p> <p>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.</p> <p>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.)</p> <p></p>"},{"location":"boards/howto/adding-members/#adding-members-to-an-existing-board","title":"Adding Members to an Existing Board","text":"<p>At any stage of your work, you can add members to a board.</p> <p>From within your board, select <code>Members</code> 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.</p> <p>Don\u2019t forget to click the <code>Add Members</code> button before closing the window.</p> <p>New members will be notified that they have been invited to your board.  </p> <p></p>"},{"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":"<p>A board can be added to a channel within Teams to help track progress on tasks and create a collaborative work environment.</p> <p>Members of a Team or a Channel will be inherited automatically in to your Huddo Board. </p> <p></p> <p>You can also add members directly to the board by searching them in the <code>Members</code> 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. </p>"},{"location":"boards/howto/archiving-and-restoring/","title":"Index","text":""},{"location":"boards/howto/archiving-and-restoring/#archiving-and-restoring","title":"Archiving and Restoring","text":""},{"location":"boards/howto/archiving-and-restoring/#archiving-vs-permanently-deleting","title":"Archiving vs Permanently Deleting","text":"<p>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.</p> <p>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.</p>"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-card","title":"How do I Archive a Card?","text":"<p>Click in to the card you want to archive. Use the <code>Archive</code> 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.</p> <p></p> <p>Example of an archived card:</p> <p></p> <p>Archived the card by mistake? If you're still in archived card screen, use the <code>Restore</code> button in the top right corner to bring the card back to the board.</p>"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-list","title":"How do I Archive a List?","text":"<p>To Archive a list, click the vertical <code>...</code> icon on the right-hand side of the blue list header and select <code>Archive.</code></p> <p></p> <p>You'll notice that you also have options to archive the list and cards, or just the cards in the list.</p>"},{"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":"<p>If you\u2019ve moved away from the archiving window above, but need to restore / delete a card or list, click the <code>Archived</code> 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 <code>Restore</code> button to return it to the board or the <code>Delete</code> to permanently delete it.</p> <p>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.</p> <p></p>"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-board","title":"How do I Archive a Board?","text":"<p>Open the board you intend to archive. Navigate to <code>Open Board Options</code> found in the title of your board, to the left of the search bar.</p> <p></p> <p>In the board options you\u2019ll see the <code>Archive</code> button in the actions shown at the top. Click this button to archive the board.</p> <p></p> <p>The board will change appearance to indicate it has been archived.</p>"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-permanently-delete-a-board","title":"How do I permanently delete a board?","text":"<p>Warning</p> <p>You can\u2019t restore or retrieve the board or any of the cards in it, if you delete permanently</p> <p>Option 1: If you\u2019re still within the screen above, you can use the <code>Delete</code> button to delete the board. If you\u2019ve navigated out of that screen but remain in the board, click the board title to <code>Open Board Options</code> and use the <code>Delete</code> button.</p> <p>Option 2: Delete any board you\u2019ve archived by navigating to the <code>Archive</code> tab on your My Boards dashboard page. Click in to the board you want to delete, click the board title to <code>Open Board Options,</code> and click <code>Delete.</code></p>"},{"location":"boards/howto/archiving-and-restoring/#how-to-restore-a-board","title":"How to restore a board","text":"<p>Option 1: If you\u2019re still within the screen above, you can use the <code>Restore</code> button to restore the board. If you\u2019ve navigated out of that screen but remain in the board, click the board title to <code>Open Board Options</code> and use the <code>Restore</code> button.</p> <p>Option 2: Restore any board you\u2019ve archived by navigating to the <code>Archive</code> tab on your My Boards dashboard page. Click in to the board you want to restore, click the board title to <code>Open Board Options,</code> and click <code>Restore.</code></p> <p></p>"},{"location":"boards/howto/assignment-roles/assignment-roles/","title":"Assignment Roles","text":"<p>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.</p>"},{"location":"boards/howto/assignment-roles/assignment-roles/#create-a-template-with-assignment-roles","title":"Create a Template with Assignment Roles","text":"<p>Start off by creating a template following the steps in the Create a Template article. </p> <p>Once your template has been created and opened, open the Members dialog by clicking on Members in the right side bar.  </p> <p>In the dialog that opens, there will be a section for Assignment Roles. Click the Create button to create a new role.  </p> <p>Give your role a name and select an icon. A color will be automatically assigned to the role. Click Save to create the role.  </p> <p>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.</p> <p> </p> <p>You can assign roles to tasks just as you would a board member.</p> <p> </p> <p>See the section on using a template to see how Assignment Roles are used when creating a board from a template.</p>"},{"location":"boards/howto/attaching-files/","title":"Index","text":"<p>Huddo Boards allows files under <code>50MB</code> to be attached to cards directly.</p> <p>Anyone who has access to view the card will be able to view and download the attachment.</p> <p>Tip</p> <p>This feature can be disabled organisation wide by an administrator if desired.</p>"},{"location":"boards/howto/attaching-files/#microsoft-365-onedrive-hcl-connections-files","title":"Microsoft 365 (OneDrive) &amp; HCL Connections (Files)","text":"<p>If you use Microsoft 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.</p>"},{"location":"boards/howto/attaching-files/#attaching-a-file-to-a-card","title":"Attaching a File to a Card","text":"<p>Once you have opened your desired card, you can drag&amp;drop a file to upload it, otherwise you can use the UI by:</p> <p>Clicking the <code>Links and Attachments</code> </p> <p>In the menu that appears, choose <code>Upload to this board.</code></p> <p></p> <p>Locate the file(s) you wish to attach and click open.</p> <p>Your file will now appear in the Links and Attachments list.</p> <p></p>"},{"location":"boards/howto/attaching-files/#removing-an-attached-file","title":"Removing an Attached File","text":"<p>To remove an attached file, navigate to the <code>...</code> 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.</p>"},{"location":"boards/howto/attaching-files/#who-can-remove-files","title":"Who Can Remove Files?","text":"<p>Anyone who can edit the card can also remove the attached files.</p>"},{"location":"boards/howto/attaching-files/#where-are-files-stored","title":"Where are Files Stored?","text":"<p>Files attached to cards in Huddo Boards Cloud with Auth0, Google, Facebook, LinkedIn authentication providers are stored in a Google Cloud Storage.</p> <p>If you are hosting Huddo Boards yourself then files are stored in the default file storage as defined in your environment.</p> <p>If you are using Microsoft 365 or HCL Connections, your files are stored within these environments.</p>"},{"location":"boards/howto/attaching-files/#deleting-a-card-that-has-attachments","title":"Deleting a Card that has Attachments","text":"<p>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.</p>"},{"location":"boards/howto/attaching-files/#adding-emails-as-files","title":"Adding Emails as Files","text":"<p>Huddo Boards is an eml dropzone such that you are able to drag &amp; 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.</p>"},{"location":"boards/howto/attaching-files/#outlook","title":"Outlook","text":"<p>In order to allow Outlook to do this, we are aware of the Outlook2Web program that can facilitate this.</p>"},{"location":"boards/howto/connections/connections-ui/","title":"HCL Connections UI Integrations","text":"<p>Huddo Boards can integrate features directly in to HCL Connections user interface that enable you to:</p> <ul> <li>see tasks related to the current HCL Connections content</li> <li>share pages from HCL Connections to Huddo Boards</li> <li>show Huddo Boards data in search results</li> </ul> <p>If you're an administrator looking for how to set this up, see the install documentation here.</p>"},{"location":"boards/howto/connections/connections-ui/#related-tasks","title":"Related Tasks","text":"<p>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.</p> 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":"<p>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.</p> Huddo Boards results when searching all content Huddo Boards results when searching from the sidebar"},{"location":"boards/howto/dependencies/","title":"Index","text":""},{"location":"boards/howto/dependencies/#task-dependencies-in-huddo-boards","title":"Task Dependencies in Huddo Boards","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/dependencies/#creating-a-task-dependency","title":"Creating a Task Dependency","text":"<p>Task dependencies can be created in several ways:</p>"},{"location":"boards/howto/dependencies/#within-an-open-task","title":"Within an open task","text":"<ol> <li>Click on a task to open its details.</li> <li> <p>Find and click the <code>Add Dependency</code> button in the task bar:</p> <p></p> <ul> <li>Note that depending on your screen size, you may need to use the More... menu to access the <code>Add Dependency</code> Button:</li> </ul> <p></p> <ul> <li>Once dependencies have been added to a task, <code>Add Dependency</code> buttons will also be available within the task details view here:</li> </ul> <p></p> </li> <li> <p>The Add Dependency Dialog will be shown:</p> <p></p> </li> <li> <p>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. </p> <ul> <li>Note that this relationship can be reversed by clicking the <code>Swap Direction</code> button </li> </ul> </li> <li>Click the <code>Add</code> button to create the task dependency.</li> </ol>"},{"location":"boards/howto/dependencies/#drag-from-task-to-task-in-the-timeline-view","title":"Drag from task to task in the Timeline view","text":"<ol> <li>Open the <code>Timeline</code> view of your board.</li> <li>Ensure that the parent and child tasks for the dependency you want to create are scheduled and appear on the timeline.</li> <li>Dependencies can be created from child (starting task) to parent (ending task). The parent waits for child to be completed first. To create a new dependency, first hover the cursor over a task to see the add dependency drag icon appear on the bottom right edge (a blue arrow).</li> <li>Hover over the arrow icon, then click and drag it to the intended parent dependency task. An arrow will be drawn as you drag, and the task you have dragged onto will have a blue highlighted border.</li> <li> <p>Drop the icon onto the intended task and the dependency relationship will be created.</p> <ul> <li>Note that if the icon is dragged and dropped onto a task that is already a dependency of the originating task, then nothing will happen.</li> </ul> <p> 6. Once the dependency has been created then dependency icons can be observed on both the parent and child of the dependency.</p> <p></p> </li> </ol>"},{"location":"boards/howto/dependencies/#showing-dependencies-on-a-task","title":"Showing dependencies on a task","text":"<p>Opening a (either a child or parent) task with dependencies will list those dependencies on the task details view.</p> <p></p> <ul> <li>From this view, it is possible to remove a dependency by clicking the remove icon .</li> </ul> <p></p> <ul> <li>Dependant tasks can be completed in this view by clicking the complete task checkbox.</li> </ul> <p></p> <ul> <li>Clicking anywhere else on the dependant task will open up its task details.</li> </ul>"},{"location":"boards/howto/dependencies/#visualising-task-dependencies-on-a-board","title":"Visualising task dependencies on a board","text":"<p>Dependencies for a particular task can be displayed/visualised in various ways depending on what view you are using to display your board.</p>"},{"location":"boards/howto/dependencies/#board-view","title":"Board view","text":"<ul> <li>Hover on the dependencies icon on a task card for a moment to highlight its dependencies.  Note that numbers appear in the top right of the highlighted cards to indicate the order that they need to be completed. </li> </ul>"},{"location":"boards/howto/dependencies/#activity-view","title":"Activity view","text":"<ul> <li>Hover on the dependencies icon on a task card for a moment to highlight its dependencies.  Note that numbers appear in the top right of the highlighted cards to indicate the order that they need to be completed. </li> </ul>"},{"location":"boards/howto/dependencies/#mindmap","title":"Mindmap","text":"<ul> <li>Hover on the dependencies icon on a task card for a moment to highlight its dependencies.  Note that numbers appear in the top right of the highlighted cards to indicate the order that they need to be completed. </li> </ul>"},{"location":"boards/howto/dependencies/#timeline","title":"Timeline","text":"<p>Timeline view is the best way to visually observe dependencies as arrows drawn between scheduled tasks. </p> <p>There are several options available for showing dependency arrows in the timeline view, controlled by settings in the right hand sidebar:</p> <p></p>"},{"location":"boards/howto/dependencies/#show-all-dependency-arrows","title":"Show all dependency arrows","text":"<p>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. </p>"},{"location":"boards/howto/dependencies/#hide-dependency-arrows","title":"Hide dependency arrows","text":"<p>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.</p>"},{"location":"boards/howto/dependencies/#hover-on-a-task-to-highlight-its-dependency-chain","title":"Hover on a task to highlight its dependency chain","text":"<p>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. </p> <p> When <code>Hover on a task to highlight its dependency chain</code> 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. </p> <p> See the animation below as an example of 2 levels of dependency depth.</p> <p></p>"},{"location":"boards/howto/dependencies/#completing-a-task-that-has-dependencies","title":"Completing a task that has dependencies","text":"<p>Attempting to complete a task that has incomplete dependencies will trigger the following dialog: </p> <p>*Note that individual tasks cannot be completed from this view.</p>"},{"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":"<p>Click this to complete the task after completing all of its preceding dependencies as displayed in the dialog.</p>"},{"location":"boards/howto/dependencies/#cancel","title":"Cancel","text":"<p>Close the dialog without taking an action.</p>"},{"location":"boards/howto/getting-started/","title":"Getting Started","text":""},{"location":"boards/howto/getting-started/#getting-started","title":"Getting Started","text":"<p>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!</p> <p>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</p> <p>Here are some quick instructions to help you get started with Huddo Boards.</p>"},{"location":"boards/howto/getting-started/#create-a-board","title":"Create A Board","text":"<ol> <li>From the My Boards homepage, click on the <code>New Board</code> button, or use the <code>+</code> buttons as indicated below.</li> </ol> <ol> <li> <p>Enter a name and description for your new board. Don't worry you can edit these later.</p> </li> <li> <p>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.</p> </li> </ol> <p></p> <ol> <li>Select from our range of quick templates; Search the template library for a more sophisticated template; Or Select <code>Blank</code> to choose your own adventure!</li> <li>Select the starting view for your board from the three available options: <code>Kanban</code>, <code>Mindmap</code> and <code>Timeline</code>. Note that the view of the board can be switched at any point in time.</li> </ol> <p></p> <ol> <li>Click <code>Create</code></li> <li>The board is now ready to use!</li> </ol>"},{"location":"boards/howto/getting-started/#kanban-view-add-lists-and-cards","title":"Kanban View - Add Lists and Cards","text":"<p>Add lists to a board to categorise todos and entries. Click on Add a list to add a new list to your board.</p> <p></p> <p>Click on Add a card in any list to add a card to that list.</p> <p></p> <p>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.</p>"},{"location":"boards/howto/getting-started/#assign-tasks-to-others","title":"Assign Tasks To Others","text":"<p>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.).</p> <p></p>"},{"location":"boards/howto/getting-started/#plan-your-tasks","title":"Plan Your Tasks","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/getting-started/#view-card-details","title":"View Card Details","text":"<p>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!</p> <p></p>"},{"location":"boards/howto/getting-started/#edit-board-options","title":"Edit Board Options","text":"<p>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.</p>"},{"location":"boards/howto/getting-started/#add-and-remove-board-members","title":"Add and Remove Board Members","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/getting-started/#colour-code-your-cards","title":"Colour Code Your Cards","text":"<p>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.</p>"},{"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":"<p>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. </p> <p>To see your boards organised by colour, set your <code>View</code> to Colours.</p> <p></p>"},{"location":"boards/howto/homepage/","title":"Myboards Dashboard - Homepage","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/homepage/#on-this-start-page-you-can","title":"On this start page you can:","text":"<ul> <li> <p>Create a new Board by clicking on the Plus sign and Create</p> </li> <li> <p>Open an existing Board by clicking on one of the tiles</p> </li> <li> <p>Search for a Board by entering the search word in the Search Boards field at the top</p> </li> <li> <p>Filter Boards by My, Public and Archive</p> </li> <li> <p>Sort Boards by Recent and Last accessed</p> </li> <li> <p>Colours These are colour tags you can drag and drop onto the tiles. Click on the menu to edit the tags.</p> </li> <li> <p>Add tags to the Boards for easy sorting and filtering in the same way as with colours above.</p> </li> <li> <p>See all your collected tasks from all your Boards by clicking on Todos</p> </li> <li> <p>Find the template library by clicking on Templates</p> </li> </ul>"},{"location":"boards/howto/ical/board/","title":"Board","text":""},{"location":"boards/howto/ical/board/#board-icalendar-feed","title":"Board iCalendar feed","text":"<p>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.</p> <p>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.</p>"},{"location":"boards/howto/ical/board/#enabling-a-calendar-feed-for-a-board","title":"Enabling a calendar feed for a board","text":"<ol> <li> <p>Navigate to <code>Open Board Options</code> found in the title of your board, to the left of the search bar.</p> <p></p> </li> <li> <p>Underneath the action bar on the right hand sideyou will see an <code>iCalendar feed</code> box with an <code>Enable</code> button. Click this to enable the calendar feed for this board.</p> <p></p> </li> <li> <p>After clicking enable, additional buttons will become available for subscribing to, copying the link for, or disabling the calendar feed:</p> <p></p> <ol> <li>Click <code>Subscribe</code> to open your chosen calendar app for your operating system and subscribe to the feed.</li> <li> <p>Click <code>Copy feed link</code> 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.</p> <p>Info</p> <p>You may experience an error similar to the following when attempting to subscribe to a board calendar feed within Microsoft Outlook for Windows.</p> <p></p> <p>In this case, follow the steps shown here to disable shared calendar improvements. After restarting Outlook, the calendar subscription should now work.</p> </li> <li> <p>Click <code>Disable</code> 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.</p> </li> </ol> </li> </ol>"},{"location":"boards/howto/ical/personal/","title":"Personal","text":""},{"location":"boards/howto/ical/personal/#personal-icalendar-feed","title":"Personal iCalendar feed","text":"<p>A calendar feed can be subscribed to for all scheduled tasks you are assigned to within Huddo Boards.</p> <p>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.</p>"},{"location":"boards/howto/ical/personal/#subscribing-to-your-personal-calendar-feed","title":"Subscribing to your personal calendar feed","text":"<ol> <li> <p>From the My Boards Dashboard/Homepage, navigate to my <code>Todos</code> found in the left hand side menu.</p> <p></p> </li> <li> <p>Once in the Todos view you will see an iCalendar feed section at the bottom of the left hand side menu.</p> <p></p> <ol> <li>Click <code>Subscribe</code> to open your chosen calendar app for your operating system and subscribe to the feed.</li> <li>Click <code>Copy feed link</code> to copy the link to the feed to your clipboard. This may be useful for pasting into a calendar application.</li> </ol> <p>Info</p> <p>You may experience an error similar to the following when attempting to subscribe to a calendar feed within Microsoft Outlook for Windows.</p> <p></p> <p>In this case, follow the steps shown here to disable shared calendar improvements. After restarting Outlook, the calendar subscription should now work.</p> </li> </ol>"},{"location":"boards/howto/import-activity/import/","title":"Import Activities","text":""},{"location":"boards/howto/import-activity/import/#import-a-single-activity-for-hybrid-installations","title":"Import a single activity for Hybrid Installations","text":"<p>Activities that already exist in HCL Connections can be individually imported into Huddo Boards.</p> <p>First, hover over the 'Create Board' button in the bottom right and select the 'Import from Activities' option that appears</p> <p></p> <p>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.</p> <p></p> <p></p>"},{"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":"<p>The Huddo Boards integration with Microsoft OneDrive allows you to find files that you have added to boards, conveniently located in your OneDrive.</p> <p>In the example below, a file titled \"Best Melbourne Restaurants\" has been added to the board, Food Objectives 2019.</p> <p> </p> <p>The file will be added to OneDrive for easy access and location.</p> <p> </p> <p>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.</p> <p>Files will be added to OneDrive whether they are from private or shared boards.</p>"},{"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":"<p>Huddo Boards' integration with Microsoft 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.</p>"},{"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":"<p>Navigate to the email you would like to attach as a card to a board. Click the <code>Save email as card</code> button in the <code>Home</code> ribbon.</p> <p></p> <p>The title of the email will automatically be filled, however you have the opportunity to change this if you wish. Select to <code>Include email body</code> 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.</p> <p></p> <p>Click <code>Create</code>.</p> <p>In the next window, click the <code>Open in Boards</code> button to be taken to the board and see the card. It will look something like this:</p> <p></p>"},{"location":"boards/howto/microsoft/outlook/#web-outlook","title":"Web Outlook","text":"<p>Navigate to the email you would like to attach as a card to a board. Click the <code>...</code> for more actions and scroll down to select <code>Huddo Boards</code>.</p> <p></p> <p>The title of the email will automatically be filled, however you have the opportunity to change this if you wish. Select to <code>Include email body</code> 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.</p> <p>Click <code>Create</code>.</p> <p>In the next window, click the <code>Open in Boards</code> button to be taken to the board and see the card. It will look something like this:</p>"},{"location":"boards/howto/microsoft/outlook/#attach-a-card-list-or-board-to-an-email","title":"Attach a Card, List or Board to an Email","text":""},{"location":"boards/howto/microsoft/outlook/#desktop-outlook_1","title":"Desktop Outlook","text":"<p>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.</p> <p>On Desktop Outlook, you'll find the <code>Attach Board/Card</code> button in the <code>Message</code> ribbon.</p> <p>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 <code>Attach</code> when you've made your selection. Continue to add more by repeating the same selection process and attaching to the email.</p> <p></p>"},{"location":"boards/howto/microsoft/outlook/#web-outlook_1","title":"Web Outlook","text":"<p>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.</p> <p>Click the <code>...</code> at the bottom of the email and select <code>Huddo Boards</code>.</p> <p></p> <p>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 <code>Attach</code> when you've made your selection. Continue to add more by repeating the same selection process and attaching to the email.</p> <p></p>"},{"location":"boards/howto/microsoft/sharepoint/","title":"Microsoft SharePoint","text":""},{"location":"boards/howto/microsoft/sharepoint/#embedding-huddo-boards-in-a-sharepoint-site-page","title":"Embedding Huddo Boards in a SharePoint Site Page","text":"<p>Huddo Boards' integration with Microsoft 365 allows you to add Huddo Boards to a SharePoint site page and work directly on the board from the page.</p> <p>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.</p> <p></p> <p>Before proceeding, you will need a site admin to enable security settings as described here</p> <ol> <li> <p>From Sharepoint main menu, go to <code>Pages</code> -&gt; <code>New</code> -&gt; <code>Site Page</code></p> <p></p> </li> <li> <p>Give your page a name, then click the <code>+</code></p> <p></p> </li> <li> <p>Choose <code>Embed</code> from the drop down menu</p> <p></p> </li> <li> <p>Open Huddo Boards and select the board you wish to embed in the sharepoint page. Click the <code>Board Options</code> button</p> <p></p> </li> <li> <p>Click <code>Copy embed code</code></p> <p></p> </li> <li> <p>Go back to sharepoint and paste the code you copied in the box provided</p> <p></p> <p>Tip</p> <p> 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.</p> </li> <li> <p>To make a small amount of extra room on your page, you may wish to edit the title and choose <code>Plain</code> as it's layout.</p> <p></p> </li> <li> <p>Once you are happy with the page, click 'Publish' to make it visible to other members of your site.</p> <p></p> </li> <li> <p>Promote your new page by following the recommendations</p> <p></p> </li> </ol>"},{"location":"boards/howto/mindmap/","title":"Index","text":""},{"location":"boards/howto/mindmap/#mind-map-view","title":"Mind Map View","text":"<p>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&amp;D, marketing, and more.</p>"},{"location":"boards/howto/mindmap/#accessing-the-mind-map-view","title":"Accessing the Mind Map View","text":"<p>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.</p> <p>In your board creation phase, select <code>Mind Map</code> from the <code>Starting View</code> drop down.</p> <p></p> <p>If your board is already created in either the Timeline or Board view, it is simply a matter of selecting the <code>Mind Map</code> view from the right-hand side menu.</p> <p></p>"},{"location":"boards/howto/mindmap/#creating-a-new-mind-map","title":"Creating a New Mind Map","text":"<p>In this example, we\u2019ll create a new mind map and select <code>Blank</code> 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.</p> <p>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.</p> <p></p> <p>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 <code>Add a Sub-Card</code> icon on your desired list to add cards.</p> <p></p> <p>You can add as many cards to the blue list titles as you like. Using the <code>Add a Sub-Card</code> icon on a card, will create a sub-card.</p> <p>As with a board and timeline, you can drag and drop colour labels and members on to your mind map.</p>"},{"location":"boards/howto/mindmap/#mind-map-views-and-layouts","title":"Mind Map Views and Layouts","text":"<p>On the right-hand side menu, you have tools that can change the layout of your Mind Map.</p> <p>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.</p> <p></p> <p>Layout: Radial</p> <p></p> <p>Layout: Horizontal</p> <p></p> <p>Layout: Vertical</p> <p></p> <p>Mirror / Reverse: Flip the layout of your mind map between mirror and reverse.</p> <p>Type: Use Type to dictate how your lists, cards, and sub-cards are connected to each other.</p> <p>Type: Free</p> <p></p> <p>Type: Step</p> <p></p> <p>Curve</p> <p></p> <p>Type: Line</p> <p></p>"},{"location":"boards/howto/mindmap/#mind-map-keyboard-navigation","title":"Mind Map keyboard navigation","text":"<p>The cards in the mindmap view can be traversed and interacted with using the keyboard.</p>"},{"location":"boards/howto/mindmap/#focus-and-moving-between-cards","title":"Focus and moving between cards","text":"<p>When the mind map view is first loaded, you can focus on the central card element (the board) by pressing the <code>Tab</code> key.</p> <p>Focus can be moved to other cards by using the <code>Arrow Keys</code>. Movement along the tree is determined by the spatial position of the cards next the the currently focused card.</p> <p>To clear focus on a card, press the <code>Escape</code> key.</p>"},{"location":"boards/howto/mindmap/#accessing-card-actions","title":"Accessing card actions","text":"<p>Once focused on a card, the actions displayed above the card can be accessed by pressing the <code>Tab</code> key. As with regular browser keyboard navigation, keep pressing <code>Tab</code> to move to the next action, and use <code>Shift</code> + <code>Tab</code> to move back to the previous action. Press the <code>Enter</code> or <code>Spacebar</code> keys to execute the focused action.</p> <p>The potentially available actions on a card are: New card/sub-card, Edit title, Archive, and Mark complete.</p> <p>To cancel the creation of a new card, press the <code>Escape</code> key.</p>"},{"location":"boards/howto/mindmap/#archive-hotkey","title":"Archive hotkey","text":"<p>To archive the currently focused card, press the <code>delete</code> key.</p>"},{"location":"boards/howto/mindmap/#create-card-hotkey","title":"Create card hotkey","text":"<p>To enter the create a new card/subcard mode for the currently focused card, press <code>Spacebar</code>. To cancel, press the <code>Escape</code> key.</p>"},{"location":"boards/howto/mindmap/#mindmap-panzoom","title":"Mindmap pan/zoom","text":""},{"location":"boards/howto/mindmap/#panzoom-using-the-mouse","title":"Pan/zoom using the mouse","text":"<p>To pan the mindmap, click and drag on any blank space in the view area.</p> <p>Scrolling the mousewheel up will zoom in on the area that the mouse is pointing at. Similarly, scroll the mousewheel downwards to zoom out again.</p>"},{"location":"boards/howto/mindmap/#panzoom-using-the-keyboard","title":"Pan/zoom using the keyboard","text":"<p>To pan around the mindmap, hold the <code>Shift</code> key while pressing the <code>Arrow Keys</code> in the direction you want to pan in.</p> <p>To zoom in, hold the <code>Shift</code> key and press the <code>-/_</code> key. To zoom out, hold the <code>Shift</code> key and press the <code>=/+</code> key.</p>"},{"location":"boards/howto/permissions/","title":"Index","text":""},{"location":"boards/howto/permissions/#permissions-in-huddo-boards","title":"Permissions in Huddo Boards","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/permissions/#reader","title":"Reader","text":"<p>A person allocated a Reader permission, has read-only access.</p>"},{"location":"boards/howto/permissions/#author","title":"Author","text":"<p>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.</p>"},{"location":"boards/howto/permissions/#editor","title":"Editor","text":"<p>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)</p>"},{"location":"boards/howto/permissions/#owner","title":"Owner","text":"<p>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.</p> <p>Find out more about how to add members to a board.</p>"},{"location":"boards/howto/permissions/#making-your-board-public","title":"Making Your Board Public","text":"<p>When you activate <code>Public Access,</code> 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.</p> <p>To give your board public access, navigate to your desired board. Select <code>Members</code> and then select <code>Public Access.</code> Decide what level of access, Reader, Author or Editor, your organisation will have.  </p>"},{"location":"boards/howto/quick-tips/","title":"Quick Tips","text":""},{"location":"boards/howto/quick-tips/#quick-tips-for-boards","title":"Quick Tips for boards","text":""},{"location":"boards/howto/quick-tips/#mentions","title":"@Mentions","text":"<p>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.  </p> <p></p>"},{"location":"boards/howto/quick-tips/#move-between-board-mind-map-and-timeline","title":"Move between Board, Mind Map, and Timeline","text":"<p>Chose the Kanban view setting up your board, but decided a Mind Map would be better for brainstorming ideas? No worries!</p> <p>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.</p> <p></p>"},{"location":"boards/howto/quick-tips/#add-members-to-a-board","title":"Add Members to a Board","text":"<p>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.</p> <p>Use the right-hand menu and select <code>Members</code>.</p> <p>Start typing an individual, group name, or email address to bring up people in your organisation.</p> <p>To invite people external to your organisation, type in their email address.  Don\u2019t forget to click <code>Add Members</code> before closing the screen.</p> <p>This screen allows you to choose the type of rights your members will have: Owner, Editor, Author, Reader.</p> <p>You can also decide if you want the board to be Public Access, which will enable anyone from your organisation to see it.  </p> <p></p>"},{"location":"boards/howto/quick-tips/#use-colour-labels-to-categorise-and-filter","title":"Use Colour Labels to Categorise and Filter","text":"<p>You can use the Colour Labels on the right-hand side menu to help categorise your board.</p> <p>Click the pencil to the right of Colour Labels, then update the colours with your desired label names.</p> <p>Drag and drop the colour labels on to a card. Do the same action to remove the colour from the card.</p> <p>You can also click on a colour or multiple colours to filter the cards.</p> <p></p>"},{"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":"<p>You can use your O365, LinkedIn, Facebook, AppleID or HCL Connections Collab Cloud to access Huddo Boards Cloud.</p> <p>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). </p> <p>There are two ways to activate a free 30 day trial in order to access the premium views. </p>"},{"location":"boards/howto/start-a-trial/#activate-free-trial-via-myboards-dashboard","title":"Activate free trial via MyBoards Dashboard:","text":"<ol> <li>Login to boards.huddo.com to enter the MyBoards Dashboard.</li> <li>In the top right corner, click the profile icon to open <code>User Options</code> and then select <code>View Subscriptions</code>. </li> <li>Then select <code>Start My Trial</code> to activate your free 30 day trial. </li> </ol> <p>You can return to  <code>View Subscription</code> at any point to purchase a licence for Huddo Boards for yourself or for a number of people in your organisation.     </p> <p></p>"},{"location":"boards/howto/start-a-trial/#activate-free-trial-when-you-create-a-board","title":"Activate free trial when you create a board:","text":"<ol> <li>Login to boards.huddo.com to enter the MyBoards Dashboard.</li> <li>Use the <code>Create</code> button to start a new board. </li> <li>Follow the steps to creating a board, including selecting a template, adding a name, and more information like a description and members (these can also be added to your board later.) Click <code>Save</code> when you are done. </li> <li>When your new board opens, <code>Board</code> <code>MindMap</code> and <code>Timeline</code> in the right hand menu will be greyed out with the words <code>Preview Available</code> under each. Select any of these and follow prompts to start your free trial. </li> </ol>"},{"location":"boards/howto/teams/adding-boards/","title":"Microsoft Teams","text":""},{"location":"boards/howto/teams/adding-boards/#adding-boards-to-microsoft-teams","title":"Adding Boards to Microsoft Teams","text":"<p>Boards has integrated seamlessly with Microsoft 365 Teams so you can supercharge your existing collaboration environments.</p> <p>Add boards to Microsoft Teams as an administrator.</p>"},{"location":"boards/howto/teams/adding-boards/#accessing-all-of-your-boards-in-microsoft-teams","title":"Accessing all of your Boards in Microsoft Teams","text":"<p>When you open Microsoft Teams, click the <code>\u2026</code> icon in the left-hand side menu and select <code>Add More Apps.</code></p> <p></p> <p>In the Store search bar, type in Huddo Boards. Click the Huddo Boards icon. The following window will appear:</p> <p></p> <p>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 <code>Install</code>.  </p> <p>Press the <code>X</code> in the next window as installation has now been completed.</p> <p>You can now access all your Boards in one place, by navigating to the <code>\u2026</code> on the left-hand side, and selecting <code>Huddo Boards</code>.</p> <p></p> <p>From here, select the <code>My Boards</code> 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.  </p> <p></p>"},{"location":"boards/howto/teams/adding-boards/#adding-boards-to-a-channel","title":"Adding Boards to a Channel","text":"<p>You can work on Boards from within Channels. To add a Board to a channel, click on the <code>+</code> sign in the top menu next to Wiki.</p> <p></p> <p>You can select the Huddo Boards icon or search it if it doesn\u2019t appear directly.</p> <p>In the next window, select your preferences, to either</p> <ul> <li>Display an existing board (type in one that you\u2019ve already created)</li> <li>Create a new board</li> <li>Show all Boards for this team</li> </ul> <p>Enter the board information and click <code>Save</code>.</p> <p>Your Board will now appear in its own tab alongside Wiki. Add multiple boards by repeating the same process.</p> <p></p>"},{"location":"boards/howto/templates/creating/","title":"Create a Template","text":""},{"location":"boards/howto/templates/creating/#creating-templates","title":"Creating Templates","text":"<p>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.</p>"},{"location":"boards/howto/templates/creating/#create-a-template-from-an-existing-board","title":"Create a Template From an Existing Board","text":"<p>Within your board, click the title of your board to <code>Open Board Options.</code> Find this located between the Huddo Boards logo and the search bar. Next, click, <code>Create Template from Board.</code></p> <p></p> <p>In the next window, you can update the name, description, and choose to keep Board Members as is, remove or add Board Members. Click <code>Save.</code> The template will open in a new screen.</p> <p></p> <p>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.</p> <p>Important: When the template opens in a new screen, any editing you do will apply to the template. Click in to the <code>Open Board Options</code> icon as you did above and select, <code>Create Board from Template.</code> When the new window opens, you\u2019ll start a new board instead of editing the template you\u2019ve just created.</p>"},{"location":"boards/howto/templates/creating/#create-a-new-template-from-scratch","title":"Create a New Template from Scratch","text":"<p>From your main MyBoards dashboard, navigate to <code>Templates</code> via the left-hand side menu. You\u2019ll land on the My Templates page and see templates you have created.</p> <p></p> <p>Click the <code>+ New Template</code> button to start your creation. You have the option to select <code>Source Board / Template</code> 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. </p> <p>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 <code>Public</code> in the <code>Members</code> section on the right-hand side menu.</p> <p>Complete the required information for your template, then click <code>Create</code>.  </p> <p></p> <p>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.</p> <p>In future, when creating a new board, type in the template name in the <code>Search All Templates</code> field, during the New Board creation phase.</p> <p>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:</p> <ul> <li>Entering the template, clicking the pencil icon for <code>Open Board Options</code>, then selecting, <code>Create Board from Template</code>; or</li> <li>Creating a new board via your My Boards dashboard, and typing in the template name in the <code>Search All Templates</code> search bar.</li> <li>Find out more about Accessing Global Templates</li> </ul>"},{"location":"boards/howto/templates/global/","title":"Use a Template","text":""},{"location":"boards/howto/templates/global/#select-a-template","title":"Select a Template","text":"<p>You can access a library of global templates already available from Huddo Boards to use as inspiration for your own work.</p> <p>When you start a New Board, click <code>Explore the Template Library</code>.</p> <p> </p> <p>This will open a new window with available templates.</p> <p> </p> <p>Feel free to click in to different templates to see what they contain. </p> <p>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.</p> <p> </p> <p>You still have the option to select the Starting View, from Kanban, MindMap, Timeline or Activty.</p> <p>Click <code>Next</code> to give your board a name and then <code>Save</code> and you\u2019ll be taken to your new Board.</p>"},{"location":"boards/howto/templates/global/#template-scheduling","title":"Template Scheduling","text":"<p>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. </p> <p>On the My Boards page, click the <code>+ Create</code> button. The <code>New Board</code> window will open. Search templates by name and select your template that contains dates. </p> <p>Click <code>Next</code>. </p> <p>You'll see an option to choose a <code>Starts on</code> or <code>Finishes on</code> 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. </p> <p> </p> <p>Click <code>Save</code>. Your new Board will be created.</p> <ul> <li>If the dates in your template included Start and End dates on tasks, you can see these rescheduled items in the <code>Timeline</code> view.</li> <li>If your tasks included Due dates, you can see these rescheduled items in the <code>Board -&gt; Todos by Date</code> view.</li> </ul>"},{"location":"boards/howto/templates/global/#assign-to-roles","title":"Assign to Roles","text":"<p>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.</p> <p>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.</p> <p>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.</p> <p> <p></p> <p>Once you've created the board, you will see members assigned to the tasks that had roles assigned.</p> <p> </p>"},{"location":"boards/howto/timeline/","title":"Index","text":"<p>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.</p>"},{"location":"boards/howto/timeline/#accessing-the-timeline-view","title":"Accessing the Timeline View","text":"<p>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.</p> <p>In your board creation phase, select<code>Timeline</code> from the Starting View drop down.</p> <p></p> <p>If your board is already created in either the Mind Map or the Kanban Board view, it is simply a matter of selecting the <code>Timeline</code> view from the right-hand side menu.</p> <p></p>"},{"location":"boards/howto/timeline/#how-to-use-the-timeline","title":"How to use the Timeline","text":"<p>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:</p> <ul> <li>Drag and Drop Unscheduled Cards</li> </ul> <p>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.</p> <p>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.</p> <p></p> <ul> <li>Add Start and Finish Dates to a Card</li> </ul> <p>Cards sitting in the Unscheduled Cards area can be clicked on to bring up the detailed card view. From here, select <code>Set Dates</code>, 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.  </p> <p></p> <p>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 <code>Set Dates,</code> 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.</p>"},{"location":"boards/howto/timeline/#choose-how-you-view-your-timeline","title":"Choose how you view your Timeline","text":"<p>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 <code>List,</code> <code>Colour,</code> or <code>Assigned.</code></p> <p></p>"},{"location":"boards/howto/timeline/#helpful-hints-for-using-the-timeline","title":"Helpful Hints for Using the Timeline","text":"<ul> <li>Cards can run parallel and overlap other cards on the timeline</li> <li>Due dates will appear with a little clock icon on the card, and will show the date when hovered over with the mouse</li> <li>You can allocate members and colour labels to cards on a timeline as normal, using drag and drop</li> <li>You can create new lists on the left-hand side of the screen, using the Add a list button</li> <li>You can create new cards directly on the timeline by clicking on your preferred start date</li> <li>Not every card has to be appear on the timeline. Its normal to have cards that are unallocated, as they might not have specific start or finish dates. Use timelines in a way that works best   for you and your project.</li> </ul>"},{"location":"boards/integrations/","title":"Integrations","text":"<p>Boards has many integration options to suit your needs. Please contact us if you have any specific requirements that are not covered.</p>"},{"location":"boards/integrations/developing/related-tasks/","title":"Use Huddo Boards Related Task Microapp","text":"<p>To display this use the following pattern to load and use the microapp</p> <p><code>&lt;boardsURL&gt;/app/linkedcards?title=&lt;boardsCardTitle&gt;&amp;url=&lt;boardsPrimaryLink&gt;</code></p> <p>where  - <code>&lt;boardsURL&gt;</code> is the URL of your Huddo Boards installation (boards.huddo.com for Boards Cloud) - <code>&lt;boardsCardTitle&gt;</code> is the default title for the task when created which users can change, fully escaped - <code>&lt;boardsPrimaryLink&gt;</code> is the URL of the page you want to show tasks related to, fully escaped</p> <p>e.g. <code>https://boards.huddo.com/app/linkedcards?title=Card%20Name&amp;url=https%3A%2F%2Fexample.com</code></p> <p>There is also a message sent with the current number of related tasks if you wish to display this.</p> <p>The event data is in the format <code>huddo-task-count=0</code> </p> <p>Example for JavaScript: </p> <pre><code>window.addEventListener(\"message\", (event) =&gt; {\n\n    if(event.origin !== &lt;boardsURL&gt;)\n        return;\n\n    let eventData = event.data;\n\n    //huddo-task-count=0\n    if(typeof eventData === \"string\" &amp;&amp; eventData.includes(\"huddo-task-count\"))\n    {\n        boardsNumTasks = event.data.split('=')[1];\n    }\n}\n</code></pre>"},{"location":"boards/kubernetes/","title":"Huddo Boards for Kubernetes","text":"<p>Deploying Huddo Boards into Kubernetes for on-premise environments</p>"},{"location":"boards/kubernetes/#prerequisites","title":"Prerequisites","text":"<ol> <li>Kubernetes is installed and running</li> <li>WebSphere environment with Web Server (or another reverse proxy)</li> <li>kubectl is installed and configured</li> <li>helm is installed</li> <li>SMTP gateway setup for email notifications if required</li> <li>Quay.io - Red Hat account setup with access to the Huddo Boards repository. Please send your account details to support@huddo.com if you do not already have this.</li> </ol>"},{"location":"boards/kubernetes/#ssl-network","title":"SSL / Network","text":"<p>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:</p> New domain Path on existing domain <code>BOARDS_URL</code> <code>boards.example.com</code> <code>example.com/boards</code> <code>API_URL</code> <code>api.example.com</code> <code>example.com/api-boards</code> 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 - <p>Please decide on which configuration will suit your environment best and the corresponding <code>BOARDS_URL</code> &amp; <code>API_URL</code>. These values will then be used in the following documentation.</p> <p>For more details on configuring a reverse proxy, please see below.</p>"},{"location":"boards/kubernetes/#oauth","title":"OAuth","text":"<p>Huddo Boards currently supports the following oAuth providers for authentication and integration: HCL Connections (on premise), IBM Connections Cloud and Microsoft 365.</p> <p>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:</p> Provider Registration / Documentation Callback URL HCL Connections instructions <code>https://[BOARDS_URL]/auth/connections/callback</code> HCL Domino instructions <code>https://[BOARDS_URL]/auth/domino/callback</code> HCL DX instructions <code>https://[BOARDS_URL]/auth/dx/callback</code> Microsoft 365 Azure app registrations <code>https://[BOARDS_URL]/auth/msgraph/callback</code> Google Google Console <code>https://[BOARDS_URL]/auth/google/callback</code> LinkedIn LinkedIn <code>https://[BOARDS_URL]/auth/linkedin/callback</code> Facebook Facebook developer centre <code>https://[BOARDS_URL]/auth/facebook/callback</code>"},{"location":"boards/kubernetes/#huddo-boards-namespace","title":"Huddo Boards namespace","text":"<pre><code>kubectl create namespace boards\n</code></pre>"},{"location":"boards/kubernetes/#database-storage","title":"Database &amp; Storage","text":"<p>Huddo 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:</p> <ol> <li>Mongo database</li> <li>S3 storage</li> </ol> <p>Note: these tasks are very similar to each other and can be performed simultaneously</p>"},{"location":"boards/kubernetes/#secrets","title":"Secrets","text":"<ol> <li> <p>Follow this guide to get access to our images in Quay.io</p> </li> <li> <p>SSL certificate details</p> <p>Only perform this step if you need to resolve certificates in kubernetes</p> <pre><code>kubectl create secret tls huddoboards-domain-secret --key &lt;/path/to/keyfile&gt; --cert &lt;/path/to/certificate&gt; --namespace=boards\n</code></pre> </li> </ol>"},{"location":"boards/kubernetes/#configuration","title":"Configuration","text":"<p>Download our config file and update all example values as required. Details as below.</p> <p>Kubernetes Variables:</p> Key Description <code>global.env.APP_URI</code> <code>https://[BOARDS_URL]</code> <code>global.env.MONGO_USER</code> MongoDB userIf using our storage above you may leave this commented out <code>global.env.MONGO_PASSWORD</code> MongoDB passwordIf using our storage above you may leave this commented out <code>global.env.MONGO_HOST</code> MongoDB hostIf using our storage above you may leave the default <code>global.env.MONGO_PARAMS</code> MongoDB request parametersIf using our storage above you may leave the default <code>global.env.S3_ENDPOINT</code> S3 URLIf using our storage above you may leave the default <code>global.env.S3_ACCESS_KEY</code> S3 Access KeyIf using our storage above you may leave the default <code>global.env.S3_SECRET_KEY</code> S3 Secret KeyIf using our storage above you may leave the default <code>webfront.ingress.hosts</code> <code>[BOARDS_URL]</code> (no protocol) <code>core.ingress.hosts</code> <code>[API_URL]</code> (no protocol, e.g. api.huddoboards.com) <p>Boards Variables:</p> <p>Follow instructions on this page</p>"},{"location":"boards/kubernetes/#deploy-boards-chart","title":"Deploy Boards Chart","text":"<p>Install the Boards services via our Helm chart</p> <pre><code>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\n</code></pre> <p>Note: <code>--recreate-pods</code> ensures all images are up to date. This will cause downtime.</p>"},{"location":"boards/kubernetes/#proxy-config","title":"Proxy Config","text":""},{"location":"boards/kubernetes/#connections-on-premise","title":"Connections On Premise","text":"<p>For Connections on-premise you have two options:</p> <ol> <li> <p><code>nginx</code> - if you have an NGINX (e.g. customizer) in front of IHS use that instead to support websockets and use one less proxy. Follow these instructions.</p> </li> <li> <p><code>httpd</code> - please follow these instructions.</p> </li> </ol>"},{"location":"boards/kubernetes/#connections-cloud-or-microsoft-365","title":"Connections Cloud or Microsoft 365","text":"<p>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</p>"},{"location":"boards/kubernetes/#hcl-connections-integrations","title":"HCL Connections integrations","text":"<ul> <li>Header (Note: only required if Boards is hosted on a different domain to Connections)</li> <li>Apps Menu</li> <li>Widgets</li> <li>Migrate your Activities to Boards</li> </ul>"},{"location":"boards/kubernetes/deploy-mongo/","title":"Deploy MongoDB (Small Scale)","text":"<p>Huddo Boards requires a Mongo database.</p> <p>Warning</p> <p>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.</p> <p>Tip</p> <p>For Large Scale Deployments (HA) please use either MongoDB:</p> <ol> <li>hosted by a compatible cloud provider (e.g. Cloud Atlas)</li> <li>self hosted in a ReplicaSet architecture. For example, <code>bitnami/mongodb</code> offer a decent wrapper to initialise a replicaset with their Helm chart.</li> </ol> <p>This documentation will deploy a MongoDB replicaSet into your Kubernetes setup.</p> <p>If you already have externally hosted Mongo database please skip to the Outcomes section to determine your equivalent connection parameters.</p> <p>You can also email us for support at support@huddo.com</p>"},{"location":"boards/kubernetes/deploy-mongo/#prerequisites","title":"Prerequisites","text":"<ol> <li>Config file downloaded</li> </ol>"},{"location":"boards/kubernetes/deploy-mongo/#update-config-file","title":"Update config file","text":"Line Key Default Value Description 21 <code>nfs.path</code> <code>/pv-kudos/mongo</code> Path to storage location 22 <code>nfs.server</code> <code>[STORAGE_SERVER_IP]</code> IP of NFS serverie <code>192.168.10.50</code>"},{"location":"boards/kubernetes/deploy-mongo/#deploy-instructions","title":"Deploy instructions","text":"<ol> <li> <p>Create the folder at <code>nfs.path</code> location on the <code>nfs.server</code> with access <code>777</code></p> <p>Note: please ensure sufficient storage is available (ie 100GB)</p> </li> <li> <p>Ensure each Node in your Kubernetes cluster can mount this location.</p> <p>Please modify the file <code>/etc/exports</code> on your NFS Server to include this line</p> <pre><code>&lt;NFS_PATH_FOR_MONGO&gt; &lt;IP_RANGE_OF_YOUR_SERVERS&gt;/&lt;SUBNET_MASK&gt;(rw,no_root_squash)\n</code></pre> <p>For example:</p> <pre><code>/pv-kudos/mongo 192.168.0.0/255.255.0.0(rw,no_root_squash)\n</code></pre> <p>Apply new NFS storage to exports</p> <pre><code>exportfs -ra\n</code></pre> </li> <li> <p>Install Mongo</p> <pre><code>kubectl apply -f ./mongo.yaml\n</code></pre> </li> </ol>"},{"location":"boards/kubernetes/deploy-mongo/#outcomes","title":"Outcomes","text":"<p>The 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.</p> Key Default Value Description <code>MONGO_PROTOCOL</code> <code>mongo</code> Protocol used in your Connections String <code>MONGO_HOST</code> <code>mongo-service:27017</code> Hostname of your Mongo service <code>MONGO_PARAMS</code> <code>replicaSet=replicaset</code> Request parameters (ie ?) <code>MONGO_USER</code> None Username to connect.Authentication is disabled in this private deployment <code>MONGO_PASSWORD</code> None Password to connect.Authentication is disabled in this private deployment <p>Alternatively, these parameters can be set with <code>MONGO_URI</code> which is built from:</p> <pre><code>[MONGO_PROTOCOL]://[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]\n\nmongo://mongo-service:27017/database?replicaSet=replicaset\n</code></pre> <p>Or with optional credentials:</p> <pre><code>[MONGO_PROTOCOL]://[MONGO_USER]:[MONGO_PASSWORD]@[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]\n\nmongo://user:passw0rd@mongo-service:27017/database?replicaSet=replicaset\n</code></pre>"},{"location":"boards/kubernetes/minio/","title":"Deploy S3 Storage","text":"<p>Huddo Boards requires an S3 object store. This documentation will deploy a Minio S3 storage container into the Kubernetes setup.</p> <p>If you already have externally hosted S3 storage please skip to the Outcomes section to determine your equivalent connection parameters.</p> <p>You can also email us for support at support@huddo.com</p>"},{"location":"boards/kubernetes/minio/#prerequisites","title":"Prerequisites","text":"<ol> <li>Config file downloaded</li> </ol>"},{"location":"boards/kubernetes/minio/#update-config-file","title":"Update config file","text":"Line Key Default Value Description 21 <code>nfs.path</code> <code>/pv-kudos/minio</code> Path to storage location 22 <code>nfs.server</code> <code>STORAGE_SERVER_IP</code> IP of NFS serverie <code>192.168.10.50</code> 69 <code>MINIO_ACCESS_KEY</code> <code>ioueygr4t589</code> Access credential 71 <code>MINIO_SECRET_KEY</code> <code>7a863d41-2d8f-4143-bc8a-02501edbea6f</code> Access credential"},{"location":"boards/kubernetes/minio/#deploy-instructions","title":"Deploy instructions","text":"<ol> <li> <p>Create the folder at <code>nfs.path</code> location on the <code>nfs.server</code> with access <code>777</code></p> <p>Note: please ensure sufficient storage is available (ie 100GB)</p> </li> <li> <p>Ensure each Node in your Kubernetes cluster can mount this location.</p> <p>Please modify the file <code>/etc/exports</code> on your NFS Server to include this line</p> <pre><code>&lt;NFS_PATH_FOR_MINIO&gt; &lt;IP_RANGE_OF_YOUR_SERVERS&gt;/&lt;SUBNET_MASK&gt;(rw,no_root_squash)\n</code></pre> <p>For example:</p> <pre><code>/pv-kudos/minio 192.168.0.0/255.255.0.0(rw,no_root_squash)\n</code></pre> <p>Apply new NFS storage to exports</p> <pre><code>exportfs -ra\n</code></pre> </li> <li> <p>Install Minio</p> <pre><code>kubectl apply -f ./minio.yaml\n</code></pre> </li> </ol>"},{"location":"boards/kubernetes/minio/#outcomes","title":"Outcomes","text":"<p>The 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.</p> Key Default Value Description <code>S3_ENDPOINT</code> <code>minio-service</code> Hostname of this service(as per line 84 of config) <code>S3_ACCESS_KEY</code> <code>ioueygr4t589</code> Credential configured above <code>S3_SECRET_KEY</code> <code>7a863d41-2d8f-4143-bc8a-02501edbea6f</code> Credential configured above <code>S3_BUCKET</code> <code>kudos-boards</code> Default storage bucket"},{"location":"boards/kubernetes/prerequisites/","title":"Prerequisites","text":"<p>Requirements and considerations before installation of Kubernetes and Huddo Boards</p>"},{"location":"boards/kubernetes/prerequisites/#servers","title":"Servers","text":"<p>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.</p> <p>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.</p>"},{"location":"boards/kubernetes/prerequisites/#existing-infrastructure","title":"Existing Infrastructure","text":"<p>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.</p> 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":"<p>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)</p>"},{"location":"boards/kubernetes/prerequisites/#ssl-certificates-and-domain-names-for-hosting","title":"SSL Certificates and domain names for hosting","text":"<p>In the examples below, replace <code>example.com</code> with your actual company domain</p> <p>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.</p> <p>For example:</p> Domain Path Web boards.example.com example.com/boards API api-boards.example.com example.com/api-boards <p>We'll refer to these throughout installation as [BOARDS_URL] and [API_URL]</p> <p>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.</p>"},{"location":"boards/kubernetes/prerequisites/#ssh-access","title":"SSH Access","text":"<p>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.</p>"},{"location":"boards/kubernetes/prerequisites/#authentication","title":"Authentication","text":"<p>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):</p> Provider Registration / Documentation HCL Connections (on premise) IBM Knowledge Center IBM Connections Cloud IBM Knowledge Center Microsoft 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":"<p>Follow this guide to get access to our images</p>"},{"location":"boards/kubernetes/prerequisites/#ansible","title":"Ansible","text":"<p>We use Red Hat Ansible to script the installs. Please ensure this is installed as per our guide prior to the kubernetes / boards install</p>"},{"location":"boards/minio/","title":"Minio FS Mode","text":"<p>This is a workaround to revert Minio to legacy fs mode. This is not recommended for new installations.</p> <p>Place this file at /pv-connections/kudos-boards-minio/.minio.sys/</p> <p>Restart (delete) the minio pod to apply the changes.</p>"},{"location":"boards/msgraph/","title":"Overview","text":"<p>Huddo Boards is tailored for working with Microsoft 365 in the following ways:</p>"},{"location":"boards/msgraph/#login","title":"Login","text":"<p>Use your existing Microsoft credentials</p> <p></p>"},{"location":"boards/msgraph/#collaboration","title":"Collaboration","text":"<p>Share and collaborate with individuals and groups in your office tenant</p> <p></p>"},{"location":"boards/msgraph/#easy-access","title":"Easy Access","text":"<p>Access Boards from your Office menu, and access other Office apps from the menu in Boards</p> <p>Admin setup guide</p> <p></p>"},{"location":"boards/msgraph/#onedrive","title":"OneDrive","text":"<p>Share files and folders from Onedrive within the context of a Board</p> <p></p>"},{"location":"boards/msgraph/#teams","title":"Teams","text":"<p>Teams integration admin guide</p> <p>Add boards tabs to Microsoft Teams</p> <p></p> <p>See all of the boards your team is working on.</p> <p></p> <p>Access Huddo Boards directly from Teams as a personal app</p> <p></p> <p>Receive notifications as the board updates</p>"},{"location":"boards/msgraph/#outlook","title":"Outlook","text":"<p>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)</p> <p>Save emails from Outlook as a card in your board</p> <p></p> <p>Attach boards, lists and cards to an email.</p>"},{"location":"boards/msgraph/#_1","title":"Overview","text":""},{"location":"boards/msgraph/#sharepoint","title":"Sharepoint","text":"<p>Embed boards as pages in Sharepoint.</p> <p>Sharepoint pages setup guide</p> <p></p>"},{"location":"boards/msgraph/auth/","title":"Authenticating Huddo Boards with Microsoft 365","text":"<p>This document details the process to enable login to your private instance of Huddo Boards with your private Microsoft 365 tenant.</p> <p></p>"},{"location":"boards/msgraph/auth/#register-oauth-application","title":"Register OAuth Application","text":"<p>You must configure an OAuth Application in your Microsoft 365 Tenant in order to use Huddo Boards with O365. To access this configuration you must be logged in as a Microsoft tenant admin</p>"},{"location":"boards/msgraph/auth/#open-the-azure-app-portal","title":"Open the Azure App Portal","text":"<p>Click <code>New Registration</code></p> <p></p>"},{"location":"boards/msgraph/auth/#configure-redirect","title":"Configure Redirect","text":"<p>Enter the values below and click <code>Register</code></p> <p></p> <pre><code>Huddo Boards\nhttps://[BOARDS_URL]/auth/msgraph/callback\n</code></pre> <p>Where BOARDS_URL is the URL to access your main Huddo Boards page. For example:</p> <ul> <li><code>https://connections.example.com/boards/auth/msgraph/callback</code> OR</li> <li><code>https://boards.example.com/auth/msgraph/callback</code></li> </ul> <p>Click <code>Register</code></p>"},{"location":"boards/msgraph/auth/#configure-required-scopes","title":"Configure Required Scopes","text":"<ol> <li> <p>Open the <code>Manifest</code> section</p> </li> <li> <p>Replace the <code>requiredResourceAccess</code> section as per below</p> <p></p> <pre><code>\"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],\n</code></pre> <p>Click <code>Save</code></p> </li> </ol>"},{"location":"boards/msgraph/auth/#check-permissions","title":"Check Permissions","text":"<p>Open the <code>API permissions</code> section. Notice that all the scopes are now pre-filled.</p> <p>Click <code>Grant admin consent for kudosdev</code></p> <p></p> <p>Click <code>Yes</code></p> <p></p>"},{"location":"boards/msgraph/auth/#configure-sso-in-teams","title":"Configure SSO in Teams","text":"<p>Note: These steps are extracted from the official Microsoft guide: steps 5-12</p> <p>Note: This step is optional, but recommended to remove the <code>Sign in with</code> page when accessing Huddo Boards.</p> <p>At the end of this step you should have the following:</p> <p></p> <ol> <li> <p>Click <code>Expose an API</code></p> </li> <li> <p>Set the Application ID URI as per:</p> <p><code>api://&lt;DOMAIN_HOSTING_BOARDS&gt;/&lt;CLIENT_ID&gt;</code></p> <p>where :</p> <ul> <li><code>DOMAIN_HOSTING_BOARDS</code> is the domain hosting boards, e.g. <code>boards.company.com</code> or <code>company.com</code></li> <li><code>CLIENT_ID</code> is the <code>Application (client) ID</code>, shown on the <code>Overview</code> page</li> </ul> <p>For example:</p> <p><code>api://boards.huddo.com/5554fe8f-34b6-4694-a09d-6349e6ab6ec9</code></p> <p>Note: this requires the domain name to be added &amp; verified in the Azure Portal under <code>Azure Active Directory</code> -&gt; <code>Custom domain names</code>. See read the official Microsoft documentation for more information.</p> </li> <li> <p>Click <code>Add a scope</code></p> <p>Set the following values:</p> <p></p> <ul> <li>Scope name: <code>access_as_user</code></li> <li>Who can consent: <code>Admins and users</code></li> <li>Admin consent display name: <code>Teams can access the user\u2019s profile.</code></li> <li>Admin consent description: <code>Teams can call the app\u2019s web APIs as the current user.</code></li> <li>User consent display name: <code>Teams can access your profile and make requests on your behalf.</code></li> <li>User consent description: <code>Teams can call this app\u2019s APIs with the same rights as you have.</code></li> <li>State: <code>Enabled</code></li> </ul> <p>Click <code>Save</code></p> </li> <li> <p>Add the following Authorized client applications</p> <ul> <li><code>1fec8e78-bce4-4aaf-ab1b-5451cc387264</code> for Teams mobile or desktop application.</li> <li><code>5e3ce6c0-2b1f-4285-8d4b-75ee78787346</code> for Teams web application.</li> </ul> </li> </ol>"},{"location":"boards/msgraph/auth/#configure-oauth-in-boards","title":"Configure OAuth in Boards","text":"<ol> <li> <p>Open the <code>Overview</code> section</p> <p>Copy <code>Application (client) ID</code> &amp; <code>Directory (tenant) ID</code></p> <p></p> </li> <li> <p>Open the <code>Certificates &amp; secrets</code> section</p> <p>Click <code>New client secret</code></p> <p></p> <p>Select <code>Never</code> expire and click <code>Add</code></p> <p></p> <p>Copy the secret value shown</p> <p></p> </li> <li> <p>Add OAuth and Tenant values to YAML config (ie <code>boards.yaml</code> or <code>boards-cp.yaml</code>)</p> <pre><code>global:\n    env:\n        MSGRAPH_CLIENT_ID: \"&lt;your-application-id&gt;\"\n        MSGRAPH_CLIENT_SECRET: \"&lt;your-application-secret&gt;\"\n        MSGRAPH_LOGIN_TENANT: \"&lt;your-tenant-id&gt;\"\n</code></pre> </li> <li> <p>Redeploy Boards Helm Chart as per command for Huddo Boards:</p> <p>HCL Component Pack</p> <pre><code>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\n</code></pre> <p>for Docker - Kubernetes</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> <p>Note: <code>--recreate-pods</code> is not required this time as this is only an env variable change</p> </li> </ol>"},{"location":"boards/msgraph/auth/#approve-permissions","title":"Approve Permissions","text":"<ol> <li> <p>Open your Huddo Boards environment.</p> <p>Click the <code>Microsoft 365</code> option and login with a Tenant Administrator account</p> <p></p> </li> <li> <p>Once logged in, a prompt will appear in Huddo Boards. Click <code>Approve</code></p> <p></p> </li> <li> <p>Click <code>Accept</code> on the following popup to grant the required permissions for Huddo Boards</p> <p></p> <p>Congratulations! All users in your tenant can now login to Huddo Boards via Microsoft 365!</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/custom-tiles/","title":"App Tile","text":""},{"location":"boards/msgraph/custom-tiles/#add-huddo-boards-to-tiles","title":"Add Huddo Boards to tiles","text":"<p>Follow these steps by Microsoft which we have also outlined below.</p> <ol> <li> <p>Open 365 Admin Centre</p> <p>Click <code>Settings</code> -&gt; <code>Org Settings</code> -&gt; <code>Organization Profile</code></p> <p>Click <code>Custom app laucher tiles</code></p> <p></p> </li> <li> <p>Click <code>Add a custom tile</code></p> <p></p> </li> <li> <p>Enter the following details &amp; click <code>Save</code></p> <pre><code>Huddo Boards\nhttps://boards.huddo.com/auth/msgraph\nhttps://boards.huddo.com/img/logo-small.png\nSocial collaboration\n</code></pre> <p></p> </li> <li> <p>Huddo Boards will now appear in the list. Click <code>Close</code></p> <p></p> </li> <li> <p>Go to https://www.office.com</p> <p>Open the Apps menu and click <code>All apps</code></p> <p></p> </li> <li> <p>Huddo Boards should be shown in the list.</p> <p>Users can now pin this to their menu. This may take 10 minutes to appear</p> </li> </ol>"},{"location":"boards/msgraph/getting-started/","title":"Getting Started with Huddo Boards for Microsoft 365","text":"<p>Note</p> <p>If you're not a Microsoft 365 administrator, refer this document to your IT team or Microsoft 365 administrator and skip to Add Huddo Boards to Microsoft Teams.</p>"},{"location":"boards/msgraph/getting-started/#login","title":"Login","text":""},{"location":"boards/msgraph/getting-started/#microsoft-teams","title":"Microsoft Teams","text":"<p>Huddo Boards is deeply integrated in to Microsoft Teams. See Add Huddo Boards to Microsoft Teams.</p>"},{"location":"boards/msgraph/getting-started/#web-application","title":"Web Application","text":"<p>You can also access Huddo Boards via https://boards.huddo.com/. Use the dedicated Microsoft login URL (https://boards.huddo.com/auth/msgraph) to skip selecting Microsoft as the login method. </p>"},{"location":"boards/msgraph/getting-started/#microsoft-graph-api-permissions","title":"Microsoft Graph API Permissions","text":"<p>Huddo Boards requires permissions to be granted to access your Microsoft 365 data. </p> <p>Note</p> <p>Microsoft Tenants configured with strict security policies may require admin consent to enable any functionality.</p> Permission types Basic Permissions Most functionality is enabled with permissions that any Microsoft user can normally grant. Admin Permissions Some functionality requires an admin to grant permissions that give Boards broader access to data."},{"location":"boards/msgraph/getting-started/#admin-approval","title":"Admin Approval","text":"<p>Providing administrator consent gives Huddo Boards the Microsoft Graph permissions required to enable all functionality and allows users to skip a consent prompt when logging in.</p>"},{"location":"boards/msgraph/getting-started/#via-microsoft-entra","title":"Via Microsoft Entra","text":"<p>You can view the your currently granted permissions, grant admin consent and manage/revoke permissions on your Microsoft Entra | Huddo Boards | Permissions page. </p>"},{"location":"boards/msgraph/getting-started/#via-huddo-boards","title":"Via Huddo Boards","text":"<p>If admin consent has not been provided, you will be prompted within the Huddo Boards app:  </p> <p>After clicking Approve, you may be asked to login to Microsoft 365 again, then you will be prompted to approve Huddo Boards access on behalf of your organisation.</p> <p>You can revoke this approval at any stage via your Microsoft Entra | Huddo Boards | Permissions page. </p>"},{"location":"boards/msgraph/getting-started/#permissions-used-by-huddo-boards","title":"Permissions Used by Huddo Boards","text":"<p>These are the permissions what Huddo Boards uses. These will change as we implement new features and optimise the permissions we use. When permission requirements change, permissions must be granted by users/admins again. </p> Permission Name Permission Type Microsoft Description Admin consent required Boards Usage email delegated View users' email address false Basic permission that allows you to log in to Huddo Boards with your Microsoft account Files.Read.All delegated Read all files that user can access false Allows you to browse and share links to your files in Huddo Boards. Files.ReadWrite.All delegated Have full access to all files user can access false Allows you to store new files in OneDrive via the Huddo Boards app. offline_access delegated Maintain access to data you have given it access to false Allows us to remember who you are logged in as, so you don't have to login every time you use Huddo Boards openid delegated Sign users in false Basic permission that allows you to log in to Huddo Boards with your Microsoft account People.Read delegated Read users' relevant people lists false Basic permission that allows Huddo Boards to search for people in your tenant on your behalf. profile delegated View users' basic profile false Basic permission that allows you to log in to Huddo Boards with your Microsoft account - Allows Huddo Boards to read your profile Sites.Read.All delegated Read items in all site collections false Allows Huddo Boards to read the basic information about Sharepoint Sites you can access. Team.ReadBasic.All delegated Read the names and descriptions of teams false Allows Huddo Boards to read the basic information about Teams you can access. TeamsActivity.Send delegated Send a teamwork activity as the user false Allows Huddo Boards to send Activity Notifications to other Microsoft users on your behalf. User.Read delegated Sign in and read user profile false Basic permission that allows you to log in to Huddo Boards with your Microsoft account - Allows Huddo Boards to read your profile User.ReadBasic.All delegated Read all users' basic profiles false Allows Huddo Boards to read basic profile information of others in your tenant that you can access. Channel.ReadBasic.All application Read the names and descriptions of all channels true Allows Huddo Boards to read private channel details. ChannelMember.Read.All application Read the members of all channels true Allows Huddo Boards to read members of and function in private channels. Directory.Read.All delegated Read directory data true Allows Huddo Boards to read data in your organisation's directory, such as users, groups and apps. We intend to remove this permission in the future in favour of multiple more fine-grained permissions. Group.Read.All delegated Read all groups true Allows Huddo Boards to search the groups you have access to, read group details (image, description, installed apps,  etc) Group.ReadWrite.All delegated Read and write all groups true DEPRECATED: To be removed. Allows Huddo Boards to add  new team channel tabs without interaction with the Teams client."},{"location":"boards/msgraph/getting-started/#set-up-integrations","title":"Set up Integrations","text":"<p>These guides also require admin access and enable some advanced features of Huddo Boards in your Microsoft 365 environment. These are also in the side menu of this page.</p> <p>Office Menu App Tile Teams Outlook Sharepoint</p>"},{"location":"boards/msgraph/outlook/","title":"Outlook","text":""},{"location":"boards/msgraph/outlook/#add-huddo-boards-plugin","title":"Add Huddo Boards plugin","text":"<p>Note</p> <p>Desktop Outlook requires the Microsoft Edge WebView2 Runtime.</p> <ol> <li> <p>Open 365 Admin Centre</p> <p>Click <code>Settings</code> -&gt; <code>Integrated apps</code> -&gt; <code>Upload custom apps</code></p> <p></p> </li> <li> <p>Select <code>Provide link to manifest file</code></p> <pre><code>https://boards.huddo.com/office/outlook/add-in.xml\n</code></pre> <p>Click <code>Validate</code> then click <code>Next</code></p> <p></p> </li> <li> <p>Specify who has access and click <code>Next</code></p> <p></p> <ol> <li>Click <code>Finish Deployment</code></li> </ol> <p></p> </li> <li> <p>Click <code>Done</code></p> <p></p> </li> <li> <p>Open Outlook</p> <p>You should now see the <code>Huddo Boards</code> option in the menu of an email</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/outlook/personal/","title":"Personal","text":""},{"location":"boards/msgraph/outlook/personal/#huddo-boards-plugin-for-single-users","title":"Huddo Boards plugin (for single users)","text":"<p>The instructions on this page use 'The new Outlook' however you can also add and use this plugin from 'classic Outlook' or Outlook desktop.</p> <p>Microsoft 365 admins can add this for all users in their tenant, instructions here</p> <ol> <li> <p>Open Outlook and click <code>New Message</code></p> <p></p> </li> <li> <p>Click the <code>...</code> menu -&gt; <code>Get Add-ins</code></p> <p></p> </li> <li> <p>Click <code>My Add-ins</code> then <code>Add a custom add-in</code> -&gt; <code>Add from URL</code></p> <p></p> </li> <li> <p>Provide the url: <code>https://boards.huddo.com/office/outlook/add-in.xml</code> and click OK.</p> <p></p> </li> <li> <p>Click <code>Install</code> then close the add-in dialogue.</p> <p></p> </li> <li> <p>Verify the add-in is installed by clicking the <code>...</code> menu again.</p> <p></p> </li> <li> <p>You will now be able to:</p> <p>Save emails from Outlook as a card in your board</p> <p></p> <p>Attach boards, lists and cards to an email.</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/sharepoint/","title":"Sharepoint","text":""},{"location":"boards/msgraph/sharepoint/#embedding-huddo-boards-pages-in-sharepoint","title":"Embedding Huddo Boards pages in Sharepoint.","text":"<p>Before proceeding, you will need a site admin to enable security settings as described here</p> <p></p> <ol> <li> <p>From Sharepoint main menu, go to <code>Pages</code> -&gt; <code>New</code> -&gt; <code>Site Page</code></p> <p></p> </li> <li> <p>Give your page a name, then click the <code>+</code></p> <p></p> </li> <li> <p>Choose <code>Embed</code> from the drop down menu</p> <p></p> </li> <li> <p>Open Huddo Boards and select the board you wish to embed in the sharepoint page. Click the <code>Board Options</code> button</p> <p></p> </li> <li> <p>Click <code>Copy embed code</code></p> <p></p> </li> <li> <p>Go back to sharepoint and paste the code you copied in the box provided</p> <p></p> <p>Tip</p> <p> 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.</p> </li> <li> <p>To make a small amount of extra room on your page, you may wish to edit the title and choose <code>Plain</code> as it's layout.</p> <p></p> </li> <li> <p>Once you are happy with the page, click 'Publish' to make it visible to other members of your site.</p> <p></p> </li> <li> <p>Promote your new page by following the recommendations</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/sharepoint/admin/","title":"Admin","text":""},{"location":"boards/msgraph/sharepoint/admin/#enable-embedding-huddo-boards-pages-in-sharepoint","title":"Enable embedding Huddo Boards pages in Sharepoint.","text":"<p>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.</p> <p>Admin access is required for these steps</p> <ol> <li>Browse to the root of the sharepoint site, click the settings cog and choose <code>Site Settings</code></li> </ol> <p></p> <p>OR choose <code>Site information</code> then <code>View all site settings</code></p> <p> </p> <ol> <li>Click <code>HTML Field Security</code></li> </ol> <p></p> <ol> <li>Type in boards.huddo.com and click <code>Add</code></li> </ol> <p></p> <ol> <li>Click <code>OK</code></li> </ol> <p></p> <ol> <li>To add Site Pages for sharing Huddo Boards, follow the instructions here</li> </ol>"},{"location":"boards/msgraph/teams/","title":"Moved","text":"<p>to here</p>"},{"location":"boards/msgraph/teams/notification-bot/","title":"Microsoft Teams Notification Bot","text":"<p>This bot will be used to post notification to Microsoft Teams triggered by actions performed in Huddo Boards.</p> <p>Note: this step is optional and cannot be achieved if you do not meet the prerequisites.</p> <p></p>"},{"location":"boards/msgraph/teams/notification-bot/#prerequisites","title":"Prerequisites","text":"<ul> <li>Boards deployment is accessible from the web (no VPN)</li> </ul> <p>Note: Microsoft Teams notifications requires 2-way web communication.</p> <p>For example, the following URL must be accessible by Microsoft's servers: <code>https://[BOARDS_URL]/webhook/teams</code></p>"},{"location":"boards/msgraph/teams/notification-bot/#configure-bot","title":"Configure Bot","text":""},{"location":"boards/msgraph/teams/notification-bot/#create-bot","title":"Create Bot","text":"<ol> <li> <p>Open Bot Registration and sign-in with a Microsoft Tenant admin</p> </li> <li> <p>Enter the following values</p> <pre><code>Huddo Boards\nhuddoboards\nhttps://[BOARDS_URL]/webhook/teams\n[MSGRAPH_CLIENT_ID]\n</code></pre> <p>Where:</p> <ul> <li> <p><code>[BOARDS_URL]</code> is the URL to your Huddo Boards installation</p> <p>i.e. <code>https://connections.example.com/boards/webhook/teams</code> or <code>https://boards.company.example.com/webhook/teams</code></p> </li> <li> <p><code>[MSGRAPH_CLIENT_ID]</code> is the OAuth Client ID from Auth setup</p> </li> </ul> <p>For example:</p> <pre><code>Huddo Boards\nhuddoboards\nhttps://connections.example.com/boards/webhook/teams\nb0e1e4a3-3df0-4c0a-8a2a-c1d630bb52b8\n</code></pre> <p></p> </li> <li> <p>Scroll down, read/agree to the terms and click <code>Register</code></p> </li> </ol> <p></p>"},{"location":"boards/msgraph/teams/notification-bot/#connect-bot-to-teams","title":"Connect Bot to Teams","text":"<ol> <li> <p>Click the <code>Teams</code> icon</p> <p></p> </li> <li> <p>Click <code>Save</code></p> <p></p> </li> <li> <p>The bot setup is complete</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/teams/notification-bot/#next-steps","title":"Next Steps","text":"<p>See Installing the Huddo Boards Teams App</p>"},{"location":"boards/msgraph/teams/on-prem/","title":"Huddo Boards On-Premise in Microsoft Teams","text":""},{"location":"boards/msgraph/teams/on-prem/#contact-us","title":"Contact Us","text":"<p>Send an email to support@huddo.com with the following details:</p> <p>Hi! I'd like to set up the Huddo Boards Microsoft Teams app for my company, [COMPANY NAME]. Here are the details:</p> <ul> <li>(optional) Attach the <code>.zip</code> or <code>manifest.json</code> file of any previous Huddo Boards teams app you have used or been provided before.</li> <li>[ ] The Application ID of the Huddo Boards application you have already registered in Microsoft Entra. <sup>See Authenticating Huddo Boards with Microsoft 365</sup></li> <li>[ ] <code>APP_URI</code> value from your helm chart values.</li> <li>[ ] <code>API_GATEWAY</code> value from your helm chart values.</li> </ul> <p>We will generate your customized Huddo Boards Teams app and provide you up-to-date guidance on how to deploy it in your environment.</p> <p>Updates to the Huddo Boards Teams app may need to be re-deployed via another customised Teams app package. We have automation in place for generating updates for your Teams app, however a manual step will be required by you to deploy the update.</p> <p>Once you have your customised Teams app and advice from the Huddo team:</p> <ol> <li> <p>Open the Boards Helm Chart config used for deployment</p> <p>Add the following environment variable to <code>provider</code> (uncomment or add the section as required):</p> <pre><code>provider:\n    env:\n        MSGRAPH_TEAMS_MANIFEST_ID: \"&lt;id attribute from your teams app manifest.json&gt;\"\n</code></pre> </li> <li> <p>Redeploy Boards helm chart as per command for Huddo Boards:</p> <p>HCL Component Pack</p> <pre><code>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\n</code></pre> <p>for Docker - Kubernetes</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> <p>Note: <code>--recreate-pods</code> is not required this time as this is only an env variable change</p> </li> </ol>"},{"location":"boards/msgraph/teams/on-prem/#how-to-use","title":"How To Use","text":"<p>For a full guide on using Huddo Boards in Microsoft Teams, please see our documentation.</p>"},{"location":"boards/msgraph/teams/install/","title":"Teams","text":""},{"location":"boards/msgraph/teams/install/#add-huddo-boards-to-microsoft-teams","title":"Add Huddo Boards to Microsoft Teams","text":"<p>Note</p> <p>If you're a Microsoft 365 administrator, please see the section on providing admin consent.</p> <p>Huddo Boards is available in the Microsoft Teams App Store. Click here to open in Teams.</p> <ul> <li>Select Add to add Huddo Boards as a personal app.</li> <li>Select Add to a team to add a Huddo Boards tab to a team channel.     </li> </ul>"},{"location":"boards/msgraph/teams/install/#accept-updates-to-huddo-boards-in-microsoft-teams","title":"Accept Updates to Huddo Boards in Microsoft Teams","text":"<p>Some updates to Huddo Boards' Teams app need your approval within the Teams client.</p> <p>For detailed instructions, see Microsoft's support article for updating apps in Teams</p> <p>Here's a sample from Microsoft's article:</p> <ol> <li> <p>Select Apps on the left side of Teams.</p> </li> <li> <p>Near the bottom left of your screen, you'll see a little red bubble next to Manage your apps that shows the number of app updates waiting to resolve. Select that bubble.</p> </li> <li> <p>On the Manage your apps page, you'll see that your apps have been sorted so that the ones that need updates are at the top. Select Update for each app you want to update.    </p> </li> <li> <p>When you select Update for an app, a dialog with that app's details will appear, including a What's new tab describing how the latest updates change the app. If necessary, the What's new tab will also include a list of permissions for you to accept.</p> </li> <li> <p>Select Update now to accept the permissions and update the app!    Install Dialog - Update Now</p> </li> </ol>"},{"location":"boards/msgraph/teams/install/#within-the-teams-client","title":"Within the Teams Client","text":"<p>You can also find add Huddo Boards app for Teams within the Teams client by following the walkthroughs below.</p>"},{"location":"boards/msgraph/teams/install/#add-huddo-boards-to-a-team","title":"Add Huddo Boards to a Team","text":"<ol> <li> <p>Open the Teams App and go to the team you wish to add Huddo Boards to.</p> </li> <li> <p>Click the <code>+</code> (add a tab) button</p> <p></p> </li> <li> <p>Search for <code>huddo</code> to find Huddo Boards</p> <p></p> <p>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 <code>More Apps</code> in this case:</p> <p></p> <p>Again, search for <code>huddo</code> to find the Huddo Boards App in the entire store.</p> </li> <li> <p>Once you have located and clicked on the Huddo Boards App, click the <code>Add</code> button to add it to the team:</p> <p></p> </li> <li> <p>The Huddo Boards app will now be added to the team, and you will be given the ability to add a new tab:</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/teams/install/#add-the-huddo-boards-personal-app","title":"Add the Huddo Boards personal app","text":"<ol> <li> <p>Open Teams and click the Apps button. Type <code>huddo</code> to find the Huddo Boards app:</p> <p></p> </li> <li> <p>Click <code>Huddo Boards</code> then click <code>Add</code> to add it as a personal app:</p> <p></p> </li> </ol>"},{"location":"boards/proxy/nginx/","title":"Proxy (NGINX)","text":"<p>If you are running an NGINX proxy (e.g. customizer) then you can pass Boards traffic directly to your Kubernetes deployment.</p> <p>Please add the following location blocks to your <code>server</code> -&gt; <code>listen 443</code> blocks:</p> <pre><code># Redirect from HCL Connections Activities -&gt; Boards\nlocation ~ ^/activities/service/html/(.*)$ {\n  rewrite ^/activities/service/html/(.*)$ /boards/activities/service/html/$1 redirect;\n}\n\n# Boards UI\nlocation /boards {\n    proxy_pass http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/boards;\n}\n\n# Boards API (including WebSocket support)\nlocation /api-boards {\n    proxy_pass http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/api-boards;\n    proxy_http_version 1.1;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection \"upgrade\";\n    proxy_set_header Host $host;\n}\n</code></pre> <p>Where:</p> <ul> <li><code>[KUBERNETES_NAME]</code> is the hostname/IP of the master in your cluster</li> <li><code>[KUBERNETES_PORT]</code> is the port of your Ingress Controller (ie 32080)</li> </ul> <p>For example:</p> <p></p>"},{"location":"boards/store/","title":"Huddo Store","text":"<p>To obtain licences for Huddo Boards, you need to register your organisation at https://store.huddo.com.</p> <p>All HCL Connections customers are eligible for a free licence to use our Activity view.</p> <p>Obtaining your licence key:</p> <ol> <li> <p>Register for our store with your Name and email address.</p> </li> <li> <p>Click the link in the email we sent to verify your account.</p> </li> <li> <p>Create Your Organisation and Login client, details below.</p> </li> <li> <p>Click <code>Create Activities+ Licence</code></p> </li> <li> <p>Click <code>Download Licences</code></p> </li> </ol>"},{"location":"boards/store/#organisation-details","title":"Organisation Details","text":"<p>You will need to provide the following information to setup you Organisation in the store.</p> <p></p> <p>When creating your Login client(s) refer to the table below for details:</p> Provider Text Field HCL Connections Your Connections URL HCL Domino Your Domino server URL Microsoft 365 Your Microsoft 365 tenant ID"},{"location":"boards/swarm/","title":"Boards for Docker Swarm (DEPRECATED)","text":"<p>Warning</p> <p>These instructions are deprecated. Please see AIO guide if you do not have either Kubernetes or Component Pack</p> <p>Basic instructions for deploying Huddo Boards into Docker Swarm for on-premise IBM Connections environments</p>"},{"location":"boards/swarm/#prerequisites","title":"Prerequisites","text":"<ol> <li>Docker Swarm with Portainer installed. Guide here</li> <li>Storage - an accessible MongoDB and S3 object store.</li> <li>SMTP gateway setup for email notifications</li> <li>Config File downloaded</li> <li> <p>Dockerhub account with access to Huddo Boards repository.</p> <p>Send your account details to support@huddo.com if you don't already have this.</p> </li> <li> <p>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 <code>https://boards.huddo.com</code> and <code>https://api.boards.huddo.com</code>. The certificate should be pem encoded with a separate key file.</p> </li> </ol>"},{"location":"boards/swarm/#setup-oauth","title":"Setup OAuth","text":"<p>Huddo Boards currently supports the following oAuth providers for authentication and integration: HCL Connections (on premise), IBM Connections Cloud and Microsoft 365.</p> <p>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:</p> Provider Registration / Documentation Callback URL IBM Connections (on premise) Huddo instructions <code>https://[BOARDS_URL]/auth/connections/callback</code> Microsoft 365 Azure app registrations <code>https://[BOARDS_URL]/auth/msgraph/callback</code> Google Google Console <code>https://[BOARDS_URL]/auth/google/callback</code> LinkedIn LinkedIn <code>https://[BOARDS_URL]/auth/linkedin/callback</code> Facebook Facebook developer centre <code>https://[BOARDS_URL]/auth/facebook/callback</code>"},{"location":"boards/swarm/#update-config-file","title":"Update config file","text":"<p>Swarm Variables:</p> Key Description <code>x-minio-access</code> Minio <code>ACCESS_KEY</code> as defined in your docker swarm config <code>x-minio-secret</code> Minio <code>SECRET_KEY</code> as defined in your docker swarm config <code>x-app-env.APP_URI</code> <code>https://[BOARDS_URL]</code> <code>services.webfront.deploy.labels</code> Update the <code>traefik.frontend.rule</code> your <code>[BOARDS_URL]</code> (no protocol) <code>services.core.deploy.labels</code> Update the <code>traefik.frontend.rule</code> with your <code>[API_URL]</code> (no protocol) <p>Boards Variables:</p> <p>Follow instructions on this page</p>"},{"location":"boards/swarm/#deploy","title":"Deploy","text":"<ol> <li>Open Portainer and login</li> <li>Select your primary endpoint</li> <li>Choose Stacks from the side menu</li> <li>Click Add Stack</li> <li>Name your stack kudos-boards</li> <li>Browse to your customised config file</li> <li>Click \"Deploy the stack\"</li> </ol>"},{"location":"boards/swarm/#update-dns","title":"Update DNS","text":"<p>Update DNS records with a CNAME entry pointing to your swarm URL.</p> <p>For example:</p> <pre><code>boards.huddo.com -&gt; swarm.isw.net.au\nboards.api.huddo.com -&gt; swarm.isw.net.au\n</code></pre>"},{"location":"boards/swarm/#hcl-connections-integrations","title":"HCL Connections integrations","text":"<p>Please follow these instructions</p> <ul> <li>Header</li> <li>Apps Menu</li> <li>Widgets</li> </ul>"},{"location":"boards/swarm/#advanced","title":"Advanced","text":"<p>You can also run Huddo Boards with externally hosted mongo database and/or S3 storage. For assistance with this contact support@huddo.com</p>"},{"location":"boards/swarm/#updates","title":"Updates","text":"<p>The Boards services can be updated through the Portainer interface, or alternatively these commands should force latest images to run</p> <pre><code>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\n</code></pre> <p>If you must update the Portainer/Traefik images, try these commands:</p> <pre><code>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\n</code></pre>"},{"location":"boards/swarm/prerequisites/","title":"Requirements and considerations before installation of Docker Swarm and Huddo Boards (DEPRECATED)","text":"<p>Warning</p> <p>These instructions are deprecated. Please see AIO guide if you do not have either Kubernetes or Component Pack</p>"},{"location":"boards/swarm/prerequisites/#servers","title":"Servers","text":"<p>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 small servers.</p>"},{"location":"boards/swarm/prerequisites/#existing-infrastructure","title":"Existing Infrastructure","text":"<p>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.</p> 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":"<p>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)</p>"},{"location":"boards/swarm/prerequisites/#ssl-certificates-dns","title":"SSL Certificates / DNS","text":"<p>You will need to have certificates and DNS entries that cover the following domains:</p> <p>Replace <code>example.com</code> with your actual company domain</p> Service Example domain DNS Swarm swarm.example.com A record pointing to gateway server Boards boards.example.com CNAME swarm.example.com Boards API api-boards.example.com CNAME swarm.example.com"},{"location":"boards/swarm/prerequisites/#ssh-access","title":"SSH Access","text":"<p>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.</p>"},{"location":"boards/swarm/prerequisites/#authentication","title":"Authentication","text":"<p>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):</p> Provider Registration / Documentation IBM Connections (on premise) IBM Knowledge Center IBM Connections Cloud IBM Knowledge Center Microsoft 365 Azure app registrations Google Google Console LinkedIn LinkedIn Facebook Facebook developer centre"},{"location":"boards/swarm/prerequisites/#dockerhub-deprecated","title":"Dockerhub (Deprecated)","text":"<p>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.</p>"},{"location":"boards/swarm/prerequisites/#ansible","title":"Ansible","text":"<p>We use Red Hat Ansible to script the installs. Please ensure this is installed as per our guide prior to the swarm / boards install</p>"},{"location":"boards/troubleshooting/activities-plus-install/","title":"Activities Plus Install FAQ","text":"<p>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.</p> <p>There are also some more notes and insights from one of our partners which is a great read.</p>"},{"location":"boards/troubleshooting/activities-plus-install/#installing-activities-plus-services","title":"Installing Activities Plus services","text":"<ul> <li>Please see our documentation and the latest chart</li> </ul>"},{"location":"boards/troubleshooting/activities-plus-install/#configuring-ibm-http-server-as-reverse-proxy","title":"Configuring IBM HTTP Server as reverse proxy","text":"<ul> <li> <p>If you do not have them enabled, you will need to enable the following modules by uncommenting them (remove the '#'):</p> <pre><code>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\n</code></pre> </li> <li> <p>If you have not specified earlier (such as during other component-pack app installs), please set <code>ProxyPreserveHost On</code> before the Huddo Boards section in the VirtualHost</p> </li> </ul>"},{"location":"boards/troubleshooting/activities-plus-install/#updating-the-activities-plus-configuration-file","title":"Updating the Activities Plus configuration file","text":"<ul> <li>Please use this boards-cp.yaml NOT the one supplied with the component pack.</li> </ul>"},{"location":"boards/troubleshooting/activities-plus-install/#migrating-activities-data","title":"Migrating Activities data","text":"<ul> <li> <p>The helm upgrade command needs to be run from the directory containing boards-cp.yaml and the correct command is:</p> <pre><code>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\n</code></pre> <p>e.g.</p> <pre><code>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\n</code></pre> </li> </ul>"},{"location":"boards/troubleshooting/activities-plus-install/#duplicate-name-mongo_host","title":"Duplicate name MONGO_HOST","text":"<p>When (re)deploying the Boards CP Chart you may see this warning:</p> <pre><code>W0612 09:17:16.153629   21276 warnings.go:70] spec.template.spec.containers[0].env[2].name: duplicate name \"MONGO_HOST\"\n</code></pre> <p>This 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.</p>"},{"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":"<p>Sometimes the pod fails to start with an error <code>listen EACCES: permission denied</code>. For example:</p> <pre><code>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.\n</code></pre> <p>This is because the port is already in use. We must change the default port which </p>"},{"location":"boards/troubleshooting/activity-migration/#resolution","title":"Resolution","text":"<ol> <li> <p>Open your Boards yaml file</p> </li> <li> <p>Set the new port as per below (merging into existing)</p> <pre><code>global:\n  env:\n    ACTIVITY_MIGRATION_PORT: '2651'\n\nmigration:\n  balancer:\n    port: 2651\n    targetPort: 2651\n</code></pre> </li> <li> <p>Redeploy both the Boards helm chart and the Activity Migration charts with the updated yaml</p> </li> <li> <p>Confirm the pod start successfully or change to another random higher port if conflicts still occur.</p> </li> </ol>"},{"location":"boards/troubleshooting/activity-migration/#missing-long-descriptions","title":"Missing Long Descriptions","text":"<p>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</p> <p>Note: this requires Boards images with date tags on or after 2021-03-22</p>"},{"location":"boards/troubleshooting/activity-migration/#process-overview","title":"Process Overview","text":"<p>This service will:</p> <ol> <li>mount the Connections Shared drive</li> <li>find any migrated cards which have a link to the old \"Long Description\" (with <code>/downloadExtended/</code> in the URL)</li> <li>use the Connections database to locate the files' path on the NFS drive</li> <li>retrieve the file contents from the file path</li> <li>save this full content into the card and overwrite the short summary version which previously was used</li> <li>remove the link on the card to the Long Description</li> <li>log statistics on how many cards were fixed</li> </ol> <p>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.</p>"},{"location":"boards/troubleshooting/activity-migration/#steps","title":"Steps","text":"<ol> <li> <p>Add the volume, volume mount &amp; <code>FILE_PATH_ACTIVITIES_CONTENT_STORE</code> to the boards yaml config. For example:</p> <pre><code>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\n</code></pre> </li> <li> <p>Replace the <code>sharedDrive.server</code> IP and the <code>sharedDrive.path</code> to the shared drive (e.g. <code>/nfs/data/shared</code> or <code>/opt/HCL/data/shared</code> etc)</p> </li> <li>Deploy the Activity Migration chart applicable for your deployment (CP v3 or standalone Kubernetes v5)</li> <li>Review the pod logs for the status of how many long description were replaced</li> </ol>"},{"location":"boards/troubleshooting/activity-migration/#jvm-heap-size-oom","title":"JVM Heap Size OoM","text":"<p>When migrating very large activities sometimes you may encounter an OutOfMemory error.</p>"},{"location":"boards/troubleshooting/activity-migration/#resolution_1","title":"Resolution","text":"<p>In the migration YAML chart you can set following to reduce the amount of concurrent data accessed in memory:</p> <pre><code>migration.env.PROCESSING_PAGE_SIZE: 1\nmigration.env.FIELDS_PAGE_SIZE: 1\n</code></pre> <p>Once these values are set you need to deploy the chart again to make them take effect.</p> <p>You will also need to increase the amount of memory available to NodeJS by adding the environment variables in the migration YAML:</p> <pre><code>resources.requests.memory: 2024M\nresources.limits.memory: 8192M\nenv.NODE_OPTIONS: \"--max-old-space-size=8192\"\n</code></pre> <p></p>"},{"location":"boards/troubleshooting/activity-migration/#activity-stuck-in-pending-migration","title":"Activity stuck in pending migration","text":"<p>If 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.</p> <pre><code>migration.env.PURGE_INCOMPLETE: \"true\"\n</code></pre> <p>You are also able to delete already migrated activities by setting PURGE_MIGRATED_ACTIVITY_IDS so they can be migrated again.</p> <pre><code>migration.env.PURGE_MIGRATED_ACTIVITY_IDS: \"acitivityId,activityId2,activityId3,...,activityIdN\"\n</code></pre> <p>Once 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!</p>"},{"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":"<p>The steps below will test a Huddo Boards / Activities Plus oauth setup.</p> <p>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.</p>"},{"location":"boards/troubleshooting/aplus-auth/#block-requests-to-boards","title":"Block requests to boards","text":"<p>Update WAS httpd.conf</p> <p>change ProxyPass and ProxyPassReverse entries for <code>/boards</code> to use a different (invalid) port number.</p>"},{"location":"boards/troubleshooting/aplus-auth/#install-and-open-postman-or-another-api-testing-tool","title":"Install and open postman or another api testing tool","text":""},{"location":"boards/troubleshooting/aplus-auth/#in-postman-prepare-a-request-as-below","title":"In postman prepare a request as below","text":"<p>Method: POST</p> <p>Request URL: https://(connections url)/oauth2/endpoint/connectionsProvider/token</p> <p>On the Body tab, select <code>x-www-form-urlencoded</code> and fill in the following:</p> KEY VALUE client_id huddoboards client_secret your client secret redirect_uri https://(connections url)/boards/auth/connections/callback grant_type authorization_code code (paste the code from the next step here)"},{"location":"boards/troubleshooting/aplus-auth/#open-connections-auth","title":"Open connections auth","text":"<p>replace connections url in both places below</p> <pre><code>https://(connections url)/oauth2/endpoint/connectionsProvider/authorize?client_id=huddoboards&amp;redirect_uri=https%3A%2F%2F(connections url)%2Fapi-boards%2Fauth%2Fconnections%2Fcallback&amp;response_type=code&amp;state=1234\n</code></pre>"},{"location":"boards/troubleshooting/aplus-auth/#click-approve","title":"Click approve","text":"<p>The loaded page should error, that is expected.</p>"},{"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":"<pre><code>{\n  \"access_token\": \"s67MkH8LYMMKiP0q2gtVKQxkD0gBcXJJlSCdvQw3\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 43199,\n  \"scope\": \"\",\n  \"refresh_token\": \"EcO9hDYdU3tL2BE0xRSPNlYIGvZhYV9yezb14YKNglkFPwq4St\"\n}\n</code></pre>"},{"location":"boards/troubleshooting/aplus-auth/#use-the-token-to-request-your-profile","title":"Use the token to request your profile","text":"<p>Open a new tab in postman and update:</p> <p>Method: GET</p> <p>Request URL: https://(connections url)/connections/opensocial/oauth/rest/people/@me/@self</p> <p>Authorization Tab</p> <p>TYPE: Bearer Token</p> <p>Token: (Paste in the access_token from the previous request)</p> <p>Hit Send, You should get a json response describing your profile.</p>"},{"location":"boards/troubleshooting/aplus-auth/#reset-was-httpdconf","title":"Reset WAS httpd.conf","text":"<p>Make sure to put the port numbers back to their original values.</p>"},{"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":"<p>Please revoke your OAuth access to Huddo Boards Cloud within HCL Connections. Go to <code>https://&lt;YOUR_CONNECTIONS_URL&gt;/connections/oauth/apps</code> (replacing <code>&lt;YOUR_CONNECTIONS_URL&gt;</code>) and press 'Revoke'</p> <p></p>"},{"location":"boards/troubleshooting/docker/","title":"Huddo Boards Docker","text":""},{"location":"boards/troubleshooting/docker/#authentication","title":"Authentication","text":""},{"location":"boards/troubleshooting/docker/#logging-in-doesnt-work","title":"Logging-in doesn't work","text":"<p>Please revoke your OAuth access to Huddo Boards Cloud within HCL Connections. Go to <code>https://&lt;YOUR_CONNECTIONS_URL&gt;/connections/oauth/apps</code> (replacing <code>&lt;YOUR_CONNECTIONS_URL&gt;</code>) and press 'Revoke'</p> <p></p>"},{"location":"boards/troubleshooting/docker/#kubernetes-ingress-controller-version","title":"Kubernetes Ingress Controller Version","text":"<p>To check the version of the ingress controller run this command</p> <pre><code>kubectl get pods --all-namespaces | grep ingress-controller\nkubectl exec -it &lt;POD_NAME&gt; -n &lt;NAMESPACE&gt; -- /nginx-ingress-controller --version\n</code></pre> <p>where</p> <ul> <li><code>&lt;POD_NAME&gt;</code> is the name of the Ingress controller pod</li> <li><code>&lt;NAMESPACE&gt;</code> is the namespace of the Ingress controller pod. e.g. <code>kube-system</code> or <code>connections</code></li> </ul> <p>For example</p> <pre><code>kubectl get pods --all-namespaces | grep ingress\nkubectl exec -it nginx-ingress-controller-84d4dfc9b-7gv4m -n kube-system -- /nginx-ingress-controller --version\n</code></pre> <p>Example</p> <pre><code>-------------------------------------------------------------------------------\nNGINX Ingress controller\n  Release:    0.23.0\n  Build:      git-be1329b22\n  Repository: https://github.com/kubernetes/ingress-nginx\n-------------------------------------------------------------------------------\n</code></pre> <p>As 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 <code>huddo-boards-cp-1.2.0.tgz</code> which includes all required annotations (including socket.io cookie fix).</p> <p>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</p> <pre><code>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\"\n</code></pre>"},{"location":"boards/troubleshooting/docker/#customizing-boards-context-root","title":"Customizing Boards Context Root","text":"<p>If you wish to deploy boards at a path other than <code>/boards</code> &amp; <code>/api-boards</code> please see this example file of all the variables to merge into your YAML config file.</p> <p>Note: If you are using an older version of the Ingress controller (&lt; 0.22) you will need to use example above</p> <p>Note: please see this example again if you encounter the error</p> <pre><code>Ignoring ingress because of error while validating ingress class\" ingress=\"connections/kudos-boards-cp-webfront\" error=\"ingress does not contain a valid IngressClass\"\n</code></pre>"},{"location":"boards/troubleshooting/docker/#no-real-time-updates-eg-rich-text-not-editable","title":"No real time updates (eg Rich Text not editable)","text":"<p>Some 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.</p> <p>Note: if you have a <code>core.annotations</code> 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 <code>annotations</code> section otherwise.</p>"},{"location":"boards/troubleshooting/docker/#additional-for-websphere-ihs","title":"Additional for WebSphere IHS","text":"<p>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</p> <pre><code>webfront:\n    env:\n        FORCE_POLLING: true\n</code></pre>"},{"location":"boards/troubleshooting/docker/#minio-pods-fail-to-start-in-boards-cp","title":"Minio pods fail to start in Boards CP","text":"<p>If the Minio service fails to start with the following error:</p> <pre><code>ERROR Unable to initialize backend: found backend fs, expected xl\n</code></pre> <p>Please update to kudos-boards-cp-3.1.4.tgz which includes a different image of Minio which supports your existing 'fs' file system.</p>"},{"location":"boards/troubleshooting/docker/#react-minified-issue","title":"React Minified Issue","text":"<p>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 the 2022-12-15 release</p>"},{"location":"boards/troubleshooting/docker/#itm-render-issue","title":"ITM Render Issue","text":"<p>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.</p> <p>You can add this to your custom css in the header/customiser (which is then injected into Boards).</p> <pre><code>.gt-sm.cnx8-ui.itm-bar-open .itm-section {\n  position: absolute;\n  right: 0;\n}\n</code></pre>"},{"location":"boards/troubleshooting/mongo/","title":"Troubleshoot MongoDB","text":""},{"location":"boards/troubleshooting/mongo/#connect-to-mongo","title":"Connect to Mongo","text":"<p>You may need to connect to Mongo for validation or other changes. To connect to Kubernetes Mongo:</p> <ul> <li> <p>In Component Pack</p> <pre><code>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\n</code></pre> </li> <li> <p>Standalone deployment</p> <ol> <li> <p>get the name of the mongo pod</p> <pre><code>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\n</code></pre> </li> <li> <p>exec into the pod using the mongosh (or mongo) command - replacing pod name and namespace</p> <pre><code>kubectl exec -it mongo-67696548c-xpdqh -n boards -- mongosh --host mongo-service:27017\n</code></pre> </li> </ol> </li> </ul>"},{"location":"boards/troubleshooting/mongo/#access-boards-data","title":"Access Boards Data","text":"<ol> <li> <p>check the database names</p> <pre><code>show dbs\n</code></pre> </li> <li> <p>open the db containing board nodes (select as appropriate)</p> <pre><code># CP\nuse boards-app\n\n# Standalone\nuse kudos-boards-service\n</code></pre> </li> <li> <p>find all boards</p> <pre><code>db.nodes.find({ type: 'board' })\n</code></pre> </li> <li> <p>find a board from a particular activitity</p> <pre><code>db.nodes.find({ providerID: 'activities-id-goes-here' })\n</code></pre> </li> <li> <p>find the members for a particular board</p> <pre><code>db.boardmembers.find({ board: ObjectId(\"_id-of-board-found-above\") })\n</code></pre> </li> </ol>"},{"location":"boards/troubleshooting/mongo/#replace-member-of-a-board","title":"Replace Member of a Board","text":"<ol> <li> <p>open the db containing users (select as appropriate)</p> <pre><code># CP\nuse boards-user\n\n# Standalone\nuse kudos-user-service\n</code></pre> </li> <li> <p>find the users in question, e.g Andrew &amp; Nicky</p> <pre><code>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\", .....\n</code></pre> </li> <li> <p>switch to the boards app</p> </li> <li> <p>find the members for a particular board (substitute the ID)</p> <pre><code>db.boardmembers.find({ board: ObjectId(\"&lt;BOARD_ID&gt;\") })\n</code></pre> </li> <li> <p>replace <code>user A</code> with <code>user B</code>, e.g. Andrew with Nicky</p> <pre><code>db.boardmembers.updateOne({ board: ObjectId(\"&lt;BOARD_ID&gt;\"), 'entity.kind': 'User', 'entity.id': '617891eae72f26802c4bec5e' }, { $set: { 'entity.id': '617891ed660876da990253b7' }})\n</code></pre> </li> </ol>"},{"location":"boards/troubleshooting/nginx/","title":"NGINX Errors","text":""},{"location":"boards/troubleshooting/nginx/#400-bad-request","title":"400 Bad Request","text":"<p>Nginx has strict rules around the headers allowed on requests. If you encounter a <code>400 Bad Request</code> response in your environment when accessing <code>/boards</code> it is likely caused by incorrect headers set in the upsteam proxy(s) before Boards.</p> <p>To debug the cause, please views the logs for the webfront pods (as of build 20210924). You will see logs like:</p> <pre><code>  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\"\n</code></pre> <p>In this example, the <code>client sent invalid host header while reading client request headers</code>. You can see the host is included twice. This can occur if the host is set twice, or in some instances when the <code>X-Forwarded-Host</code> is also set.</p> <p>Please read this error carefully and make sure your environment complies with the latest NGINX specification.</p>"},{"location":"boards/troubleshooting/nginx/#ingress-proxy","title":"Ingress &amp; Proxy","text":"<p>To confirm if the problem is with the nginx layer above boards you can bypass it and directly test the Kubernetes ingress controller and deployment:</p> <pre><code>curl -H \"Host: [CONNECTIONS_URL]\" http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/boards\ncurl -H \"Host: [CONNECTIONS_URL]\" http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/api-boards\n</code></pre> <p>OR</p> <pre><code>ssh root@[KUBERNETES_MASTER]\ncurl -H \"Host: [CONNECTIONS_URL]\" http://localhost:32080/boards\ncurl -H \"Host: [CONNECTIONS_URL]\" http://localhost:32080/api-boards\n</code></pre> <p>For example:</p> <pre><code>curl -H \"Host: connections.company.com\" http://master.kube.company.com:32080/boards\ncurl -H \"Host: connections.company.com\" http://master.kube.company.com:32080/api-boards\n</code></pre>"},{"location":"boards/troubleshooting/notifications/","title":"Troubleshooting Huddo Boards Notifications","text":""},{"location":"boards/troubleshooting/notifications/#huddo-boards-docker","title":"Huddo Boards Docker","text":"<p>If notifications are not sending, please ensure that the core and notifications pod can talk to each other</p> <pre><code>kubectl exec -n connections -it (boards core pod) -- sh\nenv | grep NOTIFI\nvi src/test.js (content below)\nnode src/test.js\n</code></pre> <p>Content for test.js:</p> <pre><code>const fetch = require('node-fetch');\nfetch(process.env.NOTIFICATION_HOST+':'+process.env.NOTIFICATION_PORT+'/health').then(console.log).catch(console.log);\n</code></pre> <p>If 200 status:</p> <p><code>bash kubectl delete pod -n boards (core pod1) kubectl delete pod -n boards (core pod2)</code></p>"},{"location":"boards/troubleshooting/oauth/","title":"OAuth","text":""},{"location":"boards/troubleshooting/oauth/#error-500-srve0295e","title":"Error 500: SRVE0295E","text":"<p>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.</p> <pre><code>SELECT count(lookupkey) FROM homepage.oh2p_cache WHERE username ='&lt;username&gt;' AND clientid='&lt;huddo_client_id&gt;'\n</code></pre> <p>Clearing the oh2p cache allows the user to login again.</p> <pre><code>DELETE from homepage.oh2p_cache where username='&lt;username&gt;' and clientid='&lt;huddo_client_id&gt;'\n</code></pre> <p>Please Note: You need to replace <code>&lt;username&gt;</code> and <code>&lt;huddo_client_id&gt;</code> with the correct values</p> <p>For more details, please see a blog post here.</p>"},{"location":"boards/troubleshooting/safari/","title":"Safari","text":""},{"location":"boards/troubleshooting/safari/#hcl-connections-community-widget","title":"HCL Connections Community Widget","text":"<p>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.</p> <p>The only solution is to disable the \"Prevent cross-site tracking\" option on the user's computer under Safari =&gt; Preferences =&gt; Privacy.</p> <p></p>"},{"location":"boards/troubleshooting/ssl/","title":"SSL","text":""},{"location":"boards/troubleshooting/ssl/#self-signed-certificates","title":"Self Signed Certificates","text":"<p>Issues with self-signed certificates can be resolved in 2 different ways:</p> <ol> <li>Add the self-signed certificate</li> <li>Disable TLS validation</li> </ol>"},{"location":"boards/troubleshooting/ssl/#add-the-self-signed-certificate","title":"Add the self-signed certificate","text":"<p>To mount the certificate in the pods:</p> <ol> <li> <p>Create a secret containing the certificate</p> <pre><code>kubectl create secret generic internal-ca --from-file=./cert.pem -n connections\n</code></pre> <p>Where:</p> <ul> <li><code>cert.pem</code> is the name of your certificate file (this is also used below as the <code>subPath</code> in the volumeMounts section)</li> <li><code>connections</code> is the namespace where the Boards chart is installed (replace with your namespace)</li> </ul> </li> <li> <p>Mount the secret in each applicable deployment by adding the following <code>volume</code> &amp; <code>volumeMount</code> to your existing values yaml, then redeploy the Boards helm chart.</p> <pre><code>global:\n    env:\n        NODE_EXTRA_CA_CERTS: /etc/ssl/certs/internal-ca.pem\n\ncore:\n    volumes:\n        - name: ssl-cert-vol\n          secret:\n              secretName: internal-ca\n    volumeMounts:\n        - name: ssl-cert-vol\n          mountPath: /etc/ssl/certs/internal-ca.pem\n          subPath: cert.pem\n\nuser:\n    volumes:\n        - name: ssl-cert-vol\n          secret:\n              secretName: internal-ca\n    volumeMounts:\n        - name: ssl-cert-vol\n          mountPath: /etc/ssl/certs/internal-ca.pem\n          subPath: cert.pem\n\nprovider:\n    volumes:\n        - name: ssl-cert-vol\n          secret:\n              secretName: internal-ca\n    volumeMounts:\n        - name: ssl-cert-vol\n          mountPath: /etc/ssl/certs/internal-ca.pem\n          subPath: cert.pem\n\n# if your email service is also using Self Signed Certificates\nevents:\n    volumes:\n        - name: ssl-cert-vol\n          secret:\n              secretName: internal-ca\n    volumeMounts:\n        - name: ssl-cert-vol\n          mountPath: /etc/ssl/certs/internal-ca.pem\n          subPath: cert.pem\n</code></pre> </li> </ol>"},{"location":"boards/troubleshooting/ssl/#disable-tls-validation","title":"Disable TLS Validation","text":"<p>Warning</p> <p>This is not recommended for production environments.</p> <p>You can add the environment variable <code>NODE_TLS_REJECT_UNAUTHORIZED: '0'</code>.</p> <p>This value is required in <code>core</code>, <code>user</code> &amp; <code>provider</code> deployments (and possibly <code>events</code> depending on the email server configuration).</p> <pre><code>core:\n    env:\n        NODE_TLS_REJECT_UNAUTHORIZED: \"0\"\nuser:\n    env:\n        NODE_TLS_REJECT_UNAUTHORIZED: \"0\"\nprovider:\n    env:\n        NODE_TLS_REJECT_UNAUTHORIZED: \"0\"\n\n# if required for your email server\nevents:\n    env:\n        NODE_TLS_REJECT_UNAUTHORIZED: \"0\"\n</code></pre>"},{"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 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":"<p>You may find that as a non-administrator Microsoft 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.</p> <p></p> <p>Note that Huddo Boards can still be used as a Microsoft Teams personal app whilst in this state</p>"},{"location":"boards/troubleshooting/office365/#resolution","title":"Resolution","text":"<p>A user that has administrative capabilities within your Microsoft 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:</p> <p></p> <p>After clicking <code>Approve</code>, 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:</p> <p></p> <p>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.</p>"},{"location":"boards/troubleshooting/office365/#force-administrative-approval-for-organisation","title":"Force Administrative Approval for Organisation","text":"<p>Administrative users for your Microsoft 365 organisation can also force an approval of all permissions for the organisation from within the Org Administration screen by following these steps:</p> <p>Access the Configuration Page and click through your Microsoft 365 client under 'Authentication Clients'.</p> <p>Click the <code>Approve Advanced Features</code> button:</p> <p></p> <p>This will direct you to the Microsoft 365 Permissions requested - Accept for your organisation page, allowing you to force the consent of all permissions that Huddo Boards needs for your organisation:</p> <p></p>"},{"location":"boards/troubleshooting/office365/#huddo-boards-app-not-showing-in-teams-store","title":"Huddo Boards App not showing in Teams store","text":"<p>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.</p> <p></p>"},{"location":"boards/troubleshooting/office365/#resolution_1","title":"Resolution","text":"<p>You will need to go to the Admin Dashboard to view the settings.</p> <p></p> <p>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.</p> <p></p>"},{"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":"<ol> <li>Download your custom Huddo Boards Extensions package from the Huddo Store.</li> <li>Extract the package and find the <code>verse/application.json</code> file.</li> <li>View <code>verse/application.json</code> as plain text to confirm the \"url\" fields contain the URL for your Boards deployment.</li> <li>Use this file with the localFileProvider method described in the HCL Verse Developers documentation.</li> </ol> <p>This documentation has been copied in below.</p>"},{"location":"boards/verse/verse-extension/#deploying-extensions-using-the-built-in-endpoint","title":"Deploying extensions using the built-in endpoint","text":"<p>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.</p> <p>Two data providers are implemented in the built-in endpoint:</p> <ul> <li> <p>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 <code>notes.ini</code> parameter <code>VOP_Extensibility_Applications_Json_FilePath</code>.</p> </li> <li> <p>HTTP data provider: Serves the applications JSON data from an HTTP hosted file. This allows you to deploy <code>applications.json</code> to a centralized HTTP server. The HTTP URL of the file can be specified using <code>notes.ini</code> parameter <code>VOP_Extensibility_Applications_Json_URL</code>.</p> </li> </ul> <p>The <code>notes.ini</code> parameter <code>VOP_Extensibility_Data_Provider_Name</code> controls which data provider to use, either <code>localFileProvider</code> or <code>httpDataProvider</code>. By default, if none is specified, <code>localFileProvider</code> will be used. In either case, the data provider will periodically check the source <code>applications.json</code> file for updates, so you don\u2019t have to restart the server after a new version of <code>applications.json</code> is deployed.</p> <p>To use the local file data provider:</p> <ul> <li> <p>Make sure <code>notes.ini</code> parameter <code>VOP_Extensibility_Data_Provider_Name</code> is either clear or set to <code>localFileProvider</code>.</p> </li> <li> <p>Deploy <code>applications.json</code> to the Domino server.</p> </li> <li> <p>Make sure notes.ini parameter <code>VOP_Extensibility_Applications_Json_FilePath</code> is set to the file path of <code>applications.json</code>. For example:</p> <pre><code>VOP_Extensibility_Applications_Json_FilePath=D:\\data\\applications.json\n</code></pre> </li> </ul> <p>To use the HTTP data provider:</p> <ul> <li> <p>Make sure <code>notes.ini</code> parameter <code>VOP_Extensibility_Data_Provider_Name</code> is set to <code>httpDataProvider.</code></p> <pre><code>VOP_Extensibility_Data_Provider_Name=httpDataProvider\n</code></pre> </li> <li> <p>Deploy <code>applications.json</code> to the HTTP server.</p> </li> <li> <p>Make sure <code>notes.ini</code> parameter <code>VOP_Extensibility_Applications_Json_URL</code> is set to the HTTP URL of <code>applications.json</code>. For example:</p> <pre><code>VOP_Extensibility_Applications_Json_URL=https://files.renovations.com/vop/applications.json\n</code></pre> </li> </ul>"},{"location":"ccm-migrator/export-fs/","title":"File-system export structure","text":"<p>This document describes the file structure used when either migrating to the file system, or exporting metadata during migration to Connections Files.</p>"},{"location":"ccm-migrator/export-fs/#rationale","title":"Rationale","text":"<p>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.</p> <p>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.</p> <p>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.</p>"},{"location":"ccm-migrator/export-fs/#directory-structure","title":"Directory structure","text":"<p>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: &lt;Community Name&gt;/files/&lt;Library Name&gt;/&lt;Folder&gt;/&lt;Subfolder&gt;</p> <p>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: &lt;Community Name&gt;/metadata/&lt;Library Name&gt;/&lt;Folder&gt;/&lt;Subfolder&gt;</p> <p>The metadata location is also used to export most file versions excluding the current version, when migrating to the file system.</p> <p>In both cases above, &lt;Subfolder&gt; may be repeated for as many subfolder levels as were present in CCM.</p> <p>Within the metadata structure, there will be:</p> <ul> <li>A members.csv file in each library directory, listing the library members;</li> <li>members.csv and meta.csv files for each folder, listing the folder members and metadata; and</li> <li>Directories named like &lt;Filename&gt;&lt;extension&gt;.meta corresponding with each CCM file. This directory will contain versions of the CCM file, along with comments.csv, members.csv, and meta.csv files listing comments, members, and metadata for that file.</li> </ul> <p>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\".</p> <p>The filename format for versions will be: &lt;Original filename&gt;_v&lt;version number&gt;&lt;extension&gt;</p>"},{"location":"ccm-migrator/export-fs/#example","title":"Example:","text":"<p>If the current version is Proposal.docx, then version 1 (superseded) will be Proposal_v1.0.docx in the Proposal.docx.meta subdirectory.</p>"},{"location":"ccm-migrator/export-fs/#user-access","title":"User access","text":"<p>Files named members.csv list members (user access) for each community, library, folder, and file.</p> <p>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:</p> <ul> <li>User/group name;</li> <li>Unique user id;</li> <li>User email address;</li> <li>Type (either \"user\" or \"group\"); and</li> <li>Access level (one of \"member\" or \"owner\" for communities, or one of \"owner\", \"contributor\", \"editor\", or \"reader\" for libraries, folders, and files).</li> </ul> <p>The users/groups listed in members.csv will be those with explicit access, plus some special user names as follows:</p> <ul> <li>\"*Community Access*\", indicating the community access setting (one of \"public\", \"moderated\", or \"restricted\");</li> <li>\"*Community Members*\", indicating the access that community members have to a library, folder, or file.</li> <li>\"*Community Owners*\", indicating the access that community owners have to a library, folder, or file.</li> </ul>"},{"location":"ccm-migrator/export-fs/#comments-tags-and-other-metadata","title":"Comments, tags, and other metadata","text":"<p>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.</p> <p>comments.csv contains all comments for the file. Comma-separated fields for each comment are:</p> <ul> <li>File version on which the comment was made.</li> <li>Date/time, formatted as ISO 8601 in UTC (e.g. \"2021-02-26T09:00:00.000Z\");</li> <li>Commenter user name;</li> <li>Commenter unique user id;</li> <li>Commenter email address; and</li> <li>The comment text.</li> </ul> <p>meta.csv contains any metadata which isn't comments or members. Comma-separated fields for each line are:</p> <ul> <li>The type of metadata, one of:<ul> <li>\"uuid\" - CCM file/folder uuid;</li> <li>\"comm_uuid\" - Source community uuid;</li> <li>\"componentId\" - CCM component id (appears in CCM URLs);</li> <li>\"name\" - CCM file/folder name;</li> <li>\"renamed\" - Migrated file/folder name (always present even if the name wasn't changed);</li> <li>\"created\" - Creation date/time, formatted as ISO 8601 in UTC;</li> <li>\"author\" - Display name of author/creator;</li> <li>\"modified\" - Last-modified date/time, formatted as ISO 8601 in UTC;</li> <li>\"modifier\" - Display name of user who last modified the file/folder;</li> <li>\"summary\" - File description/summary;</li> <li>\"tag\" - File tags (this metadata type is repeated if there are multiple tags);</li> <li>\"draft\" - Has the value \"true\" if the current version is a draft, but is otherwise absent;</li> <li>\"likes\" - Number of likes;</li> <li>\"downloads\" - Number of downloads;</li> <li>\"link\" - CCM file/folder URL as reported by CCM API (may redirect to another URL when used in a web browser);</li> <li>\"link_alt\" - Alternate CCM file/folder URL;</li> <li>\"link_ibmscp\" - CCM file/folder URL for the ibmscp protocol (Connections Mobile);</li> <li>\"link_content\" - CCM file download URL;</li> <li>\"dest_uuid\" - Connections file/folder uuid (if migrated to Connections Files);</li> <li>\"dest_comm_uuid\" - Destination community uuid (if migrated to Connections Files);</li> <li>\"dest_link\" - Connections file/folder URL (if migrated to Connections Files);</li> <li>\"dest_link_content\" - Connections file download URL (if migrated to Connections Files);</li> <li>\"doc_type\" - CCM document type display name;</li> <li>\"doc_type_uuid\" - CCM document type uuid;</li> <li>Custom fields - Any metadata types different from those above are custom fields defined as part of the CCM document type.</li> </ul> </li> <li>The version number to which the metadata applies. This will be blank for the current version; and</li> <li>The metadata value.</li> </ul>"},{"location":"ccm-migrator/export-fs/#general-information-csv-files","title":"General information - CSV files","text":"<p>CSV files created by CCM Migrator conform to Microsoft Excel's CSV format, with details as follows:</p> <ul> <li>Fields are separated by commas.</li> <li>Text data is contained in double-quote characters.</li> <li>Text data can contain commas without any type of \"escape character\", because the enclosing double-quotes ensure those commas aren't interpreted as separators.</li> <li>Literal double-quote characters can be included in text data by doubling them. I.e. The double-quote character acts as an \"escape character\" for itself.</li> <li>Text data can contain literal line breaks, therefore any single record can use multiple lines. This is unlikely to occur in this application, but may be possible with metadata.</li> </ul>"},{"location":"ccm-migrator/features/","title":"Features","text":"<p>This is a brief list of the features we have implemented or plan to implement in the future.</p> <p>If you want to know more you're very welcome to open an issue on GitHub or contact your favourite Huddo team member.</p> 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":"<p>Log into the WebSphere Integrated Solutions Console (ISC) for your HCL Connections Environment.</p>"},{"location":"ccm-migrator/install/#gathering-required-information","title":"Gathering required information","text":"<p>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.</p> <p>In the ISC, navigate to Resources \\ JDBC \\ Data sources.</p> <p>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.</p> <p></p> <p>If you're not sure which is the correct data source, check the details of each data source as follows:</p> <ul> <li>Click a data source name in the data source table.</li> <li>Check the \"Common and required data source properties\" for the data source.</li> <li>The correct data source should have the database name \"FNOS\", and a server name matching your Filenet / CCM database server. Once you find this data source, note the JNDI name, and you can then proceed with installation.</li> </ul> <p>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.</p> <p></p>"},{"location":"ccm-migrator/install/#installing-the-application-for-the-first-time","title":"Installing the Application for the first time","text":"<p>In the ISC, navigate to Applications \\ Application Types \\ WebSphere enterprise applications and click \"Install\".</p> <p></p> <p>Locate the \"isw-connections-ccm.ear\" file on your local file system and click \"Next\".</p> <p></p> <p>Select \"Fast Path\" and click \"Next\".</p> <p>Step 1: Leave the default values, update the Application Name if required, and click \"Next\".</p> <p>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.</p> <p>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.</p> <p></p> <p>Step 3: Enter the JNDI name for the Filenet Object Store database, which you should have obtained as described under Gathering required information.</p> <p>Step 4: Leave the default values and click \"Next\".</p> <p>Step 5: Check summary and Complete installation.</p> <p>Save the master configuration once complete.</p>"},{"location":"ccm-migrator/install/#updating-the-web-server-plug-in","title":"Updating the Web Server Plug-in","text":"<p>The procedure in this section may or may not be required depending on the configuration of your Connections environment.</p> <p>In the ISC, navigate to Servers \\ Server types \\ Web servers.</p> <p></p> <p>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.)</p> <p></p> <p>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.)</p> <p></p>"},{"location":"ccm-migrator/install/#configuring-the-application","title":"Configuring the Application","text":""},{"location":"ccm-migrator/install/#licence-key","title":"Licence Key","text":"<p>Without a licence applied, the application can only be used in test mode, where files and folders are reported but not actually migrated.</p> <p>When requesting a licence you will need to supply:</p> <ul> <li>The domain name used to access the application in the browser.</li> <li>For limited (demo) licences: The community UUIDs that will be allowed to migrate their files.</li> </ul> <p>After receiving your key, you will need to create <code>name space bindings</code> 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 <code>iswCCMLicenceKey</code>. Limited licences also require <code>iswCCMLicenceCommunities</code>.</p> Binding identifier + Name in name space... String value <code>iswCCMLicenceKey</code> Licence key stringe.g. <code>A+gAAACsrdTGobh6+PNOTAREALKEYjpVT/6AgMY4SxyOM2ZQ</code> <code>iswCCMLicenceCommunities</code> Comma delimited list of community ids without white spacee.g. <code>4f4847e3-fdda-4da4-a1b7-2829111a694b,4f4847e3-fdda-4da4-a1b7-2829111a694c,4f4847e3-fdda-4da4-a1b7-2829111a694d</code> <p>You may follow the steps below for how to create name space bindings.</p> <p>In the ISC, navigate to Environment \\ Naming \\ Name space bindings.</p> <p></p> <p>Select the \"Cell\" scope, then click \"New\".</p> <p></p> <p>Set the binding type to \"String\", then click \"Next\".</p> <p></p> <p>Set both the \"Binding identifier\" and \"Name in name space\" fields to \"iswCCMLicenceKey\". Enter your licence key in the \"String value\" field.</p> <p></p> <p>Click \"Next\", then click \"Finish\", then save the master configuration. Repeat these steps for <code>iswCCMLicenceCommunities</code>.</p>"},{"location":"ccm-migrator/install/#security","title":"Security","text":"<p>In the ISC, navigate to Applications \\ Application Types \\ WebSphere enterprise applications, and click the \"isw-connections-ccm\" application in the list.</p> <p>Navigate to Configuration \\ Detail Properties \\ Security role to user/group mapping.</p> <p>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.</p> <p>Click \"OK\" and save the changes to the configuration.</p> <p>Start the application by checking the select box for it from the list and clicking \"Start\".</p>"},{"location":"ccm-migrator/supported-data/","title":"Data Supported in Migrations","text":"<p>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.</p> <p>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.</p> 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 <p>\ud83d\uddc3 - Exported to file system</p>"},{"location":"ccm-migrator/update/","title":"Update","text":""},{"location":"ccm-migrator/update/#updating-the-application","title":"Updating the Application","text":"<p>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.</p> <p>Log into the ISC for your HCL Connections environment.</p> <p>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.</p> <p>Navigate to Applications \\ Application Types \\ WebSphere enterprise applications.</p> <p>Select the \"isw-connections-ccm\" application from the list, and click \"Update\".</p> <p></p> <p>Using the default option (\"Replace the entire application\"), select the new \"isw-connections-ccm.ear\" file, and click \"Next\".</p> <p></p> <p>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\".</p> <p>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.</p> <p></p> <p>After clicking \"Finish\", there will be some delay while the next screen fills in. Click the \"Save\" link when it appears.</p> <p></p> <p>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.</p> <p>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.</p>"},{"location":"ccm-migrator/update/#updating-the-licence","title":"Updating the Licence","text":"<p>After receiving your new key, you will need to update the <code>name space bindings</code> 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 <code>iswCCMLicenceKey</code>. Limited licences also require <code>iswCCMLicenceCommunities</code>.</p> Binding identifier + Name in name space... String value <code>iswCCMLicenceKey</code> Licence key stringe.g. <code>A+gAAACsrdTGobh6+PNOTAREALKEYjpVT/6AgMY4SxyOM2ZQ</code> <code>iswCCMLicenceCommunities</code> Comma delimited list of community ids without white spacee.g. <code>4f4847e3-fdda-4da4-a1b7-2829111a694b,4f4847e3-fdda-4da4-a1b7-2829111a694c,4f4847e3-fdda-4da4-a1b7-2829111a694d</code> <p>You may follow the steps below for how to update name space bindings.</p> <p>In the ISC, navigate to Environment \\ Naming \\ Name space bindings.</p> <p></p> <p>Select the <code>iswCCMLicenceKey</code> binding.</p> <p></p> <p>Update the \"String\" with the new value, then click \"OK\".</p> <p></p> <p>Then save the master configuration. Repeat these steps for <code>iswCCMLicenceCommunities</code> if this also needs to be updated.</p>"},{"location":"ccm-migrator/usage/","title":"Using the Application","text":"<p>The application can be accessed from your HCL Connections site using a URL like <code>{connections domain}/isw-connections-ccm/</code>, where <code>{connections domain}</code> is the protocol and domain name of your Connections site.</p>"},{"location":"ccm-migrator/usage/#api-settings","title":"API Settings","text":"<p>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:</p> <ul> <li>\"Migration Path\" has no default and must be set before first use.</li> <li>\"Logs and Temporary File Path\" defaults to a subdirectory of the server's temporary files location (typically \"/tmp\" on Linux), but you may want to change this. As stated in the Installation document, this location should be synchronized between servers if the application runs on multiple servers in a cluster.</li> <li>\"Source Domain\" and \"Destination Domain\" must specify the protocol and domain of the Connections environments you're migrating from and to. These default to the domain where the app is installed, which will probably be correct if migrating within a single Connections environment, but you'll need to change at least one of these if migrating between two different environments. \"Destination Domain\" isn't used and is hidden if migrating to the OS file system.</li> <li>\"Source Auth Alias\" and \"Destination Auth Alias\" must be the names of J2C authentication aliases defined in the WebSphere ISC (under Security \\ Global Security \\ J2C authentication data) for your source and destination Connections domains. The aliases must contain credentials for a user with administrative access to Connections, because the app uses these credentials to authenticate with APIs and read/write content. \"Destination Auth Alias\" isn't used and is hidden if migrating to the OS file system.</li> <li>\"Output File Path\" should be a server file-system location where you want content and metadata exported. If migrating to the OS file system, all content and metadata is exported to this location. If migrating to Connections Files, metadata is exported to this location only if the migration setting to export metadata is enabled.</li> </ul> <p></p> <p>Other API Settings are described below, but should never need to be changed for normal operation:</p> <ul> <li>\"Number of Threads when building list of folders and files\" - Use with caution - Can cause server CPU starvation and crashes. The value 1 means that all server-side operations run in a single thread, while higher values (up to a maximum of 4) cause more threads to be used. Higher values should improve performance if all the following conditions are met, but may otherwise cause problems:<ul> <li>Application servers on which this application runs, along with CCM and database servers from which content will be read, have at least as many CPU threads as specified.</li> <li>Network connections between servers can handle the additional traffic.</li> </ul> </li> <li>\"HTTP Engine Settings\":<ul> <li>\"HTTP Request Handler\" - The default value of \"Apache HttpClient\" should always be best. The \"JVM default\" option is retained for testing because older versions of CCM Migrator had no other option.</li> <li>\"Maximum time to wait for data\" - HTTP read timeout in milliseconds. The default of -1 means to use an OS-dependent value which we understand to be 1 minute on many platforms. The default should be sufficient, but set it to either 0 (no timeout) or a value higher than 60000 if you observe timeouts occurring.</li> <li>\"Number of times to attempt each HTTP request\" - If set higher than 1 and a server-side HTTP request fails for a temporary reason (e.g. timeout or internal server error), the request will be attempted up to this many times. This setting exists because we observed seemingly-random HTTP request failures in one customer environment, but retries didn't help in that case.</li> <li>\"Delay before retrying failed HTTP request\" - Wait about this many milliseconds before retrying failed HTTP requests. Only has an effect if a HTTP request fails and the previous setting is 2 or higher.</li> </ul> </li> <li>\"Log Settings\":<ul> <li>\"Show username in server JVM logs\" - Makes messages written by CCM Migrator to the server's \"SystemOut.log\" and \"SystemErr.log\" files include the username of the user running Analysis, Migration, or Roll-back. The username is always recorded in CCM Migrator's application log files regardless of this setting.</li> </ul> </li> <li>\"Other Settings\":<ul> <li>\"Write XML to file system for CCM library entries\" - If enabled, raw XML representing \"feeds\" of CCM library entries will be written to the configured temporary files location. This setting exists only for debugging.</li> </ul> </li> </ul> <p>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.</p>"},{"location":"ccm-migrator/usage/#analysis-and-migration","title":"Analysis and Migration","text":"<p>On first use before migrating, it's necessary to perform an analysis to build a list of communities. Click \"Analyze Communities\" to do this.</p> <p>By default, analysis retrieves the following information for each community:</p> <ul> <li>Community title;</li> <li>Whether the community has any CCM Libraries;</li> <li>Whether the community has a Files app (which is the migration target unless migrating to file system);</li> <li>The total size of all files in the Files app; and</li> <li>The quota and quota usage of the Files app;</li> </ul> <p>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.</p> <p>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.</p> <p>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.</p> <p>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:</p> <ul> <li>\"Test Mode\" - Enabled by default. Performing migration with this enabled means that nothing is really migrated, but the migration process will retrieve and display a list of all folders and files in the selected communities. Note that a licence key is required to disable test mode and perform a real migration, and the licence key (if provided to you) must be installed as described in the Installation document.</li> <li>\"Per-library migration\" - If enabled, the communities table allows expanding each community to show libraries in the community, choosing individual libraries to migrate (instead of migrating all libraries in each community), and migrating libraries to subcommunities instead of to the community.</li> <li>\"Include Tags\" - Whether or not to migrate file tags.</li> <li>\"Include Comments\" - Whether or not to migrate file comments.</li> <li>\"Include Likes\" - Whether or not to migrate file likes.</li> <li>\"Include Follows\" - Whether or not to migrate file follows.</li> <li>\"Include Drafts\" - Whether or not to migrate draft files. Note that the Connections Files app doesn't allow drafts, so drafts from CCM will become the latest file version when migrated.</li> <li>\"Include Versions\" - Whether or not to migrate file versions. When enabled, you will also see an option to specify how many versions are migrated.</li> <li>\"Rename Conflicting Files\" - If enabled, and the Files app in a community already has files matching the name of files being migrated, the migrated files will be renamed by appending the specified \"Filename-Number Separator\" followed by a number. If disabled, files with a conflicting name won't be migrated. If a migrated folder matches the name of an existing folder in the File app, this option doesn't apply. The migration simply uses the existing folder.</li> <li>\"Replacement for Invalid Characters\" - If CCM folder or file names contain characters which aren't permitted in the Connections Files app, those characters are replaced by the specified replacement character.</li> <li>\"Migrate libraries to folders\" - Whether to migrate every library to a separate folder in the target community, regardless of how many libraries exist in the community. By default, CCM Migrator will only create a separate folder for each library if the community has two or more libraries.</li> <li>\"Export metadata to file-system\" - Whether to export extra metadata to the server file-system when migrating to Connections Files. The metadata includes CCM document types and custom fields, which can't be migrated to Connections Files, and is created in the \"Output File Path\" specified in API Settings. Click here for details of the export file structure.</li> </ul> <p>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.</p> <p>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.</p>"},{"location":"ccm-migrator/usage/#regarding-file-name-conflicts","title":"Regarding file name conflicts","text":"<p>When migrating files, the application makes some attempt to work around file name conflicts. This is particularly worth noting when either:</p> <ul> <li>One CCM library has files of the same name in different folders; or</li> <li>One community has two or more CCM libraries with files of the same name.</li> </ul> <p>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.</p> <p>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\".</p> <p>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.</p> <p>The application's user-interface provides options to change the above behaviour, and those options are listed earlier in this document.</p>"},{"location":"ccm-migrator/usage/#roll-back","title":"Roll-back","text":"<p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p>"},{"location":"tools/ansible/","title":"Ansible","text":""},{"location":"tools/ansible/#setup-ansible","title":"Setup Ansible","text":"<p>Throughout the guides on this site we use ansible to setup servers and manage servers and deployments in both kubernetes and docker swarm.</p> <p>If you have access to a Mac or Linux machine, follow these instructions to get up and running.</p> <p>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.</p> <p>Refer to this document from Microsoft for more information on WSL and the windows store options.</p>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#docs","title":"Docs","text":"<p>This site contains technical and user documentation for Huddo Apps. For purchase and product information visit huddo.com.</p>"},{"location":"#quick-links","title":"Quick Links","text":"<ol> <li> <p>Boards Cloud</p> <ul> <li>Recent Updates</li> <li>Status</li> </ul> </li> <li> <p>Boards On-Premise</p> <ul> <li>Latest Releases</li> </ul> </li> <li> <p>Huddo Boards for</p> <ul> <li>HCL Connections</li> <li>HCL Domino</li> <li>HCL Digital Experience (DX)</li> </ul> </li> </ol>"},{"location":"log4j/","title":"Log4j","text":"<p>Recently a severe vulnerability was discovered in the log4j package. Details of that are here and Apache mitigation/patching details are here.</p> <p>The status of the Huddo Applications in regard to the vulnerability are below.</p>"},{"location":"log4j/#badges","title":"Badges","text":"<p>Badges does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.</p>"},{"location":"log4j/#analytics","title":"Analytics","text":"<p>Analytics does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.</p>"},{"location":"log4j/#boards-websphere","title":"Boards WebSphere","text":"<p>Boards WebSphere does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.</p>"},{"location":"log4j/#boards-dockercomponent-pack","title":"Boards Docker/Component Pack","text":"<p>Boards Docker does not contain any Java and as such is not affected by this vulnerability.</p>"},{"location":"log4j/#boards-cloud","title":"Boards Cloud","text":"<p>Boards Cloud does not contain any Java and as such is not affected by this vulnerability.</p>"},{"location":"log4j/#ccm-migrator","title":"CCM Migrator","text":"<p>CCM Migrator does not use log4j directly. It does contain commons-logging which uses the underlying logging service in WAS.</p>"},{"location":"status/","title":"Status","text":"<p>This page provides information on the status of our cloud services.</p> <p>Huddo Boards Cloud - OnlinePlanned MaintenanceOffline</p>"},{"location":"analytics/install/","title":"Overview","text":"<p>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.</p> <p>The install process for Huddo Analytics involves the following steps:</p> <ul> <li>Install the Huddo Analytics Application</li> <li>Define Widgets</li> <li>Apply Changes</li> <li>Add Widgets to Connections Interface</li> <li>Community Widget Properties</li> <li>Upload your Licence file</li> <li>Customising</li> <li>FAQ</li> </ul> <p>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.</p>"},{"location":"analytics/install/add-widgets/","title":"Add Widgets","text":"<p>So far, you have configured the location of the Huddo widgets. You will now add the widgets to the user interface.</p>"},{"location":"analytics/install/add-widgets/#add-the-configurators-widgets-to-their-communities","title":"Add the Configurators Widgets to their Communities","text":"<p>Login to Connections and navigate to the previously created Badges Configurator Community</p> <ol> <li> <p>Click Community Actions then 'Add Apps' from the drop down menu</p> <p></p> </li> <li> <p>Select the Configurator to add to the Community</p> <p></p> </li> <li> <p>Click X</p> </li> </ol> <p>The Configurator will now be added to the main view.</p> <p>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.</p>"},{"location":"analytics/install/add-widgets/#remove-the-default-widgets-optional","title":"Remove the Default Widgets (Optional)","text":"<p>Click the Actions drop-down and select Delete     </p> <p>Fill in the required data then click Ok on the Delete prompt     </p>"},{"location":"analytics/install/add-widgets/#add-the-huddo-analytics-widget-to-communities","title":"Add the Huddo Analytics Widget to Communities","text":"<p>Login to Connections and navigate to the Huddo Analytics Community</p> <p>Click Community Actions then 'Add Apps' from the drop down menu</p> <p></p> <p>Select HuddoAnalytics</p> <p></p> <p>Click X</p> <p>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.</p> <p>Your first Huddo Analytics widget will now be added to the main view.</p> <p>The default view shows the report categories. Once a report category is selected, default report instances for that category can be selected.</p> <p>Once the report instance is selected, further options for that report can be selected.</p> <p>The report currently configured is previewed below the options and can be saved for quick viewing on all subsequent page loads.</p> <p>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.</p> <p>Multiple Huddo Analytics widgets are designed to exist in each community.</p>"},{"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":"<p>Adding widgets to the Home page of Connections is done through the Connections Web page. </p> <p>Login to Connections as a user assigned to the admin security role of the Homepage application and navigate to the Administration tab.</p> <p>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.</p> <p></p> 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://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/AnalyticsDashboard.xml False True False False True - <p>Highlight the Huddo User Analytics widget in the Disabled widgets section and click Enable and it will now show in the Enabled widgets list.</p> <p>It will also show on the Updates and Widgets tabs, if these options were selected.</p>"},{"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":"<p>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.</p> <p>Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.</p> <p>Open My Page through the Sidebar link or Home button and select Customize</p> <p></p> <p>Select Huddo User Analytics. If you cannot find it, look under the 'Other' category.</p> <p></p> <p>Click X</p> <p>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.</p> <p>Multiple Huddo User Analytics widgets are designed to exist on My Page.</p>"},{"location":"analytics/install/app/","title":"Install Application","text":"<p>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.</p>"},{"location":"analytics/install/app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"<p>Login to the WebSphere Integrated Solution Console for your Connections environment via a webbrowser.</p> <p>Enter your administrator User ID and Password, then click the \u201cLog in\u201d button.</p> <p></p>"},{"location":"analytics/install/app/#install-the-huddowar-file","title":"Install the Huddo.war file","text":"<p>Navigate to Applications \u2192 Application Types \u2192 WebSphere enterprise applications</p> <p></p> <p>Click the Install button</p> <p></p> <p>Browse the Local File System Path for the downloaded Huddo.war file then Click Next</p> <p></p> <p>Check the Fast Path Option then Click Next</p> <p></p> <p>Change the Application name to Huddo then Click Next</p> <p></p> <p>Highlight the Nodes for the Application, including the IHS Node. Select the Badges Module, click Apply then Next.</p> <p>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 &gt; Clusters &gt; WebSphere application server clusters and then clicking New.</p> <p></p> <p>Click on Browse and map the default resources as shown. Click Next.</p> <p></p> <p>Enter Huddo as the Context Root, then click Next.</p> <p>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.</p> <p></p> <p>Review the Installation Summary. Click Finish.</p> <p></p> <p>Review the Installation Results. Click Save.</p> <p></p> <p>Review the Synchronisation Summary. Click OK.</p> <p>You have now successfully installed Huddo as a WebSphere Enterprise Application. Next, you will need to edit the security settings.</p>"},{"location":"analytics/install/app/#modify-the-huddo-application-security-role-assignments","title":"Modify the Huddo Application Security Role assignments","text":"<p>During this step, we will be defining the authenticated users/groups for each Security Role.</p> <p>Find Huddo in the list of enterprise applications and click on Huddo to open the application configuration screen</p> <p></p> <p>Click Security role to user/group mapping</p> <p></p> <p>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</p> <p>Please note: You may set the Reader role to Everyone to grant read-only access to Huddo widget data to unauthenticated users.</p> <p></p>"},{"location":"analytics/install/apply-changes/","title":"Apply Changes","text":"<p>The clusters must be restarted for the widget configuration changes to take effect.</p>"},{"location":"analytics/install/apply-changes/#restart-the-clusters","title":"Restart the Clusters","text":"<p>Login to the Integrated Solution Console</p> <p>Navigate to Servers \u2192 Clusters \u2192 WebSphere Application Server Clusters</p> <p>Select all of the Connections Clusters</p> <p>Click Ripplestart.</p> <p></p>"},{"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":"<p>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.</p> <p></p> <p>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.</p> <p>Checkout and edit the widgets-config.xml file:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p> <p>Locate the Configuration Widget definitions under the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>Add the attribute <code>showInPalette=\"false\"</code> 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.</p> <p>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.</p> <p>Your configuration should now look like this:</p> <pre><code>&lt;widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>Check in the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p> <p>Then Restart the clusters.</p>"},{"location":"analytics/install/customising/","title":"Customising","text":""},{"location":"analytics/install/customising/#customising-huddo-strings-properties-images-optional","title":"Customising Huddo Strings, Properties &amp; Images (Optional)","text":"<p>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.</p>"},{"location":"analytics/install/customising/#customising-huddo-strings","title":"Customising Huddo Strings","text":"<p>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.</p> <p>Please Note:</p> <ul> <li>These files are in JSON format and it is critical that the syntax of these files is valid for the customisation to take effect.</li> <li> <p>This step can be performed at any stage after the installation and is not required to complete the installation.</p> <ol> <li>Create a folder called HuddoStrings in the directory given by the PROFILES_STATS_DIR WebSphere Variable.</li> <li>Create a text file called UserInterfaceLang.js in the HuddoStrings directory.</li> <li>Open the default UserInterfaceLang.js file from the location <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultLang/</li> <li>Add the strings you wish to customise to the newly created UserInterfaceLang.js file from the original file while maintaining a similar format.     e.g.: below is a sample customised UserInterfaceLang.js file which overwrites 7 properties:</li> </ol> </li> </ul> <p><pre><code>{\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}\n</code></pre> Note: only add the strings you wish to customise as this procedure will overwrite the existing strings for all other languages with the provided values.</p> <p>If you wish to add specific customisations for different languages:</p> <ol> <li>Create a sub-folder with the locale name within the HuddoStrings directory (See List of Language Codes)</li> <li>Create a language specific version of UserInterfaceLang.js file as per Steps 3 &amp; 4 above.</li> <li>Place it in the locale sub-folder.</li> </ol> <p>Example:</p> <pre><code>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\n</code></pre> <ol> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol>"},{"location":"analytics/install/customising/#customising-huddo-properties","title":"Customising Huddo Properties","text":"<p>The 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.</p> <p>Available properties files to customise:</p> <ul> <li>applicationConfig.js \u2013 Context roots for Connections &amp; Huddo</li> <li>messages.properties \u2013 Strings used in Huddo emails &amp; Activity Stream entries</li> <li>resource.properties \u2013 Miscellaneous settings, i.e. database aliases etc.</li> </ul> <p>Please Note:</p> <ul> <li>These files are in JSON format and it is critical that the syntax of these files is valid for the customisation to take effect.</li> <li>This step can be performed at any stage after the installation and is not required to complete the installation.<ol> <li>Create a folder called HuddoProperties in the directory given by the PROFILES_STATS_DIR Websphere Variable.</li> <li>Copy the property file(s) to be edited into the HuddoProperties folder from the location    <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultProperties/</li> <li>Open the HuddoProperties folder\u2019s newly copied files and edit the properties as required before saving.</li> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol> </li> </ul>"},{"location":"analytics/install/customising/#customising-huddo-images","title":"Customising Huddo Images","text":"<p>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.</p> <p>Please Note:</p> <ul> <li> <p>This step can be performed at any stage after the installation and is not required to complete the installation.</p> <ol> <li> <p>Determine the image(s) to be customised in the HuddoImages folder from the location    <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultImages/</p> <pre><code>Common files customised include:\n    kudos_stream.png (as seen in the Homepage Activity Stream)\n    mobile_`&lt;MOBILE_DEVICE&gt;`.png (i.e. mobile_android.png etc \u2013 as seen for Huddo mobile)\n</code></pre> </li> <li> <p>Create a folder called HuddoImages in the directory given by the PROFILES_STATS_DIR Websphere Variable.</p> </li> <li>Place a copy of the custom image into the HuddoImages folder with the same name as the image file you wish to overwrite.</li> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol> </li> </ul>"},{"location":"analytics/install/install-widgets/","title":"Widgets","text":"<p>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.</p>"},{"location":"analytics/install/install-widgets/#create-the-configurator-community","title":"Create the Configurator Community","text":"<p>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.</p> <ol> <li> <p>Login to Connections, navigate to Communities and click Create a Community</p> <p></p> </li> <li> <p>Enter a name, such as Huddo Configurator</p> </li> <li> <p>Set Access to Restricted</p> </li> <li> <p>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.</p> </li> <li> <p>Enter any tags, web address and description you wish then click Save.</p> <p></p> </li> </ol> <p>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.</p> <p>You have now created the Huddo Configurator Community.</p> <p>Take note of the CommunityUUID in the URL address, as we will need this later.</p>"},{"location":"analytics/install/install-widgets/#create-the-huddo-analytics-administrator-community","title":"Create the Huddo Analytics Administrator Community","text":"<p>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.</p> <ol> <li> <p>Login to Connections, navigate to Communities and click Start a Community.</p> <p></p> </li> <li> <p>Enter a name, such as Huddo Analytics.</p> </li> <li> <p>Set Access to Restricted.</p> </li> <li> <p>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.</p> </li> <li> <p>Enter any tags, web address and description you wish and click Save.</p> <p></p> </li> </ol> <p>You have now created the Huddo Analytics Administrator Community.</p> <p>Take note of the CommunityUUID in the URL address, as we will need this later.</p>"},{"location":"analytics/install/install-widgets/#check-out-the-widgets-configxml-file","title":"Check out the widgets-config.xml file","text":"<p>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.</p> <p>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.</p> <p>Checking Out the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p>"},{"location":"analytics/install/install-widgets/#configure-configurator-and-community-leaderboard-widgets","title":"Configure Configurator and Community Leaderboard Widgets","text":"<p>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.</p> <p>You must define the Widgets and where to find their associated .xml files. You will need the CommunityUuids you took note of earlier. </p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>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</p> <pre><code>&lt;widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoAnalytics\" description=\"HuddoAnalytics\" modes=\"view edit\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AnalyticsDashboard.xml\" uniqueInstance=\"false\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"adminCommunityId\" value=\"YOUR_ANALYTICS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>We 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.</p>"},{"location":"analytics/install/install-widgets/#check-in-the-widgets-configxml-file","title":"Check in the widgets-config.xml file","text":"<p>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.</p> <p>Checking In the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p>"},{"location":"analytics/install/install-widgets/#register-widgets-connections-60-cr1-onwards","title":"Register Widgets (Connections 6.0 CR1 onwards)","text":"<p>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.</p>"},{"location":"analytics/install/install-widgets/#add-huddo-configuration-jsp-to-the-header","title":"Add Huddo configuration JSP to the header","text":"<p>Perform this task to add Huddo Configuration information to Connections pages.</p> <p>This is achieved by customising the header.jsp file, used for customizing the Connections Navigation bar.</p> <p>If you have not customised the header.jsp file for your connections environment, please make a copy of the file from:</p> <p><code>&lt;WAS_home&gt;</code>/profiles/<code>&lt;profile_name&gt;</code>/installedApps/<code>&lt;cell_name&gt;</code>/Homepage.ear/homepage.war/nav/templates</p> <p>Paste the copy into the common\\nav\\templates subdirectory in the customization directory: <code>&lt;installdir&gt;</code>\\data\\shared\\customization\\common\\nav\\templates\\header.jsp</p> <p>Edit the header.jsp file in the customisations directory add the following lines after the Moderation link and before the <code>&lt;/ul&gt;</code> HTML tag as shown:</p> <p></p> <p>To add the Huddo Config JSP</p> <pre><code>--%&gt;&lt;c:if test=\"${'communities' == appName || 'homepage' == appName || 'profiles' == appName}\"&gt;&lt;%--\n    --%&gt;&lt;c:catch var=\"e\"&gt;&lt;c:import var=\"kudosConfig\" url=\"http://${pageContext.request.serverName}/Kudos/kudosConfig.jsp\"/&gt;&lt;/c:catch&gt;&lt;%--\n    --%&gt;&lt;c:if test=\"${empty e}\"&gt;&lt;script type=\"text/javascript\"&gt;${kudosConfig}&lt;/script&gt;&lt;/c:if&gt;&lt;%--\n--%&gt;&lt;/c:if&gt;&lt;%--\n</code></pre> <p>Save and close the file, the changes will take effect when the clusters are restarted. (See next task)</p>"},{"location":"analytics/install/install-widgets/#specify-huddo-analytics-admin-community-for-security","title":"Specify Huddo Analytics Admin Community for Security","text":"<p>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.</p> <p>Create the resource.properties file in the Profiles Statistics customisation directory: <code>&lt;PROFILES_STATS_DIR&gt;</code>/HuddoProperties Where PROFILES_STATS_DIR is defined by the WebSphere variable: e.g. /opt/IBM/Connections/data/shared/profiles/statistics/HuddoProperties</p> <p>Put the following line in the file, replacing <code>&lt;KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID&gt;</code> with the ID of the Huddo Analytics Community created in Task 2.4:</p> <pre><code>analyticsAdminCommunityID=&lt;KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID&gt;\n</code></pre> <p>IMPORTANT: If a file of the same name already exists, merge the contents into the existing file.</p>"},{"location":"analytics/install/licence/","title":"Licence","text":"<p>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 </p>"},{"location":"analytics/install/licence/#upload-your-licence-file-in-the-badges-configurator","title":"Upload your licence file in the Badges Configurator","text":"<p>Login to Connections Navigate to the Huddo Configurator Community.</p> <p>Select the Settings tab in the BadgesConfigurator widget. If there are no tabs, this is the default view.</p> <p>Click the Update Licence button.</p> <p></p> <p>Click Choose File and browse to your Huddo.licence file and click Upload.</p> <p></p>"},{"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":"<p>Please go to the BadgesConfigurator-&gt;Settings tab then restart the Huddo Application.</p>"},{"location":"analytics/install/websphere-faq/#scheduler-not-running","title":"Scheduler not running","text":"<p>Issue is with the timerManager in WAS. Create a new one to resolve issue.</p>"},{"location":"analytics/install/websphere-faq/#performance-tuning","title":"Performance tuning","text":"<p>Review this guide for changes that can be made.</p>"},{"location":"analytics/install/websphere-faq/#connections-8-ui","title":"Connections 8 UI","text":"<p>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)</p> <pre><code>.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}\n</code></pre>"},{"location":"analytics/user-guide/access-reports/","title":"How to Access Reports","text":"<p>This section covers the fundamental how-tos for accessing reports within Huddo Analytics</p>"},{"location":"analytics/user-guide/access-reports/#view-reports","title":"View Reports","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#add-an-analytics-widget","title":"Add an Analytics Widget","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#user-level","title":"User Level","text":"<p>Open Homepage -&gt; My Page -&gt; Customize</p> <p>Select Huddo User Analytics and Click X</p>"},{"location":"analytics/user-guide/access-reports/#community-level","title":"Community Level","text":"<p>Open Community -&gt; Community Actions -&gt; Customize</p> <p>Select Huddo Analytics then Click X</p>"},{"location":"analytics/user-guide/access-reports/#administration-level","title":"Administration Level","text":"<p>Open Huddo Analytics Community -&gt; Community Actions -&gt; Customize</p> <p>Select Huddo Analytics then Click X</p>"},{"location":"analytics/user-guide/access-reports/#select-a-report-category","title":"Select a Report Category","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#select-a-report","title":"Select a Report","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#customise-reports","title":"Customise Reports","text":"<p>All reports offer a range of options and filters to allow viewers to customise and personalise the report.</p> <p>All reports have Query Parameters that define the context and scope of the underlying query for the report.</p> <p>Table reports also have column filters (for filtering by value) and the ability to enable/disable columns (right click on column headers).</p>"},{"location":"analytics/user-guide/access-reports/#saving-reports","title":"Saving Reports","text":"<p>Once you are satisfied with your report selection you can Save it. Click Save.</p> <p>Personalise the report by specifying a custom title and description and click OK.</p> <p>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.</p>"},{"location":"analytics/user-guide/access-reports/#managing-reports","title":"Managing Reports","text":"<p>Reports can be managed at any stage during their lifecycle. The button in the top right hand corner provides access to the following functions:</p>"},{"location":"analytics/user-guide/access-reports/#refresh","title":"Refresh","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#edit","title":"Edit","text":"<p>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.</p>"},{"location":"analytics/user-guide/access-reports/#move-updown","title":"Move Up/Down","text":"<p>Reports can be positioned in any order. They can also be dragged and dropped. This is based on the Connections widget layout.</p>"},{"location":"analytics/user-guide/access-reports/#remove","title":"Remove","text":"<p>If you no longer require the current report you can remove it. Note: this cannot be undone.</p>"},{"location":"analytics/user-guide/available-reports/","title":"Available Reports","text":""},{"location":"analytics/user-guide/available-reports/#reporting-access-levels","title":"Reporting Access Levels","text":"<p>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.</p>"},{"location":"analytics/user-guide/available-reports/#personal-analytics","title":"Personal Analytics","text":"<p>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.</p> <p>Examples - My Most visited Blogs, My Recent Network Contact, My Recent Followers, etc.</p>"},{"location":"analytics/user-guide/available-reports/#community-level-analytics","title":"Community Level Analytics","text":"<p>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.</p> <p>Examples \u2013 Most Popular Ideas, Number of Visits Over Time, Most Recent Members, etc.</p>"},{"location":"analytics/user-guide/available-reports/#overall-admin-connections-analytics","title":"Overall (admin) Connections Analytics","text":"<p>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.</p> <p>Examples - Most Active Users, Most Active Content, Percentage of Users Active in BUILDING, Connections Usage by Application, etc.</p>"},{"location":"analytics/user-guide/available-reports/#categories-of-reports","title":"Categories of Reports","text":"<p>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.</p> <p>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</p> <p>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</p> <p>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</p> <p>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</p> <p>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</p> <p>There is also a Huddo report category for Huddo Badges/Thanks/Awards.</p> <p>Huddo Huddo reports help quantify Badges/Thanks/Awards received on Badge and User e.g. Total Awarded Badges, Thanks Awarded usage, Huddo Summary Report</p>"},{"location":"analytics/user-guide/available-reports/#default-available-reports","title":"Default Available Reports","text":"<p>Below is a full list of all reports provided as part of Huddo Analytics, organised by Report Access Level and Category.</p>"},{"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":"<p>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.</p>"},{"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  Default <p>Not Relevant: ADD, APPROVE, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, PIN, PREVIEW, RECOMMEND, REJECT, REMOVE, RESTORE, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, VOTE, WATCH</p>"},{"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  Default <p>Not Relevant: COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, REMOVE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN,, UNWATCH, VOTE, WATCH</p>"},{"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  Tag <p>Not 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</p>"},{"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  Default <p>Not Relevant:  APPROVE, COMPLETE, COPY, DOWNLOAD, EMPTY, FOLLOW, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, REJECT, REMOVE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH</p>"},{"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  Library <p>Not Relevant:  APPROVE, COMPLETE, COPY, DECLINE, GRADUATE, LOCK, MOVE, PIN, PREVIEW, UNCOMPLETE, UNLOCK, UNPIN, UNWATCH, VISIT, VISIT_DUP</p>"},{"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 Membership <p>Not Relevant:  ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, PREVIEW, READ, REMOVE, RESTORE, UNCOMPLETE, UNRECOMMEND, UNWATCH, VISIT_DUP, VOTE, WATCH</p>"},{"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  Widgets <p>Not 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</p>"},{"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 Idea <p>Not Relevant:  ADD, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, FOLLOW, LOCK, MOVE, PIN, PREVIEW, REMOVE, UNCOMPLETE, UNDELETE, UNFOLLOW, UNLOCK, UNPIN, UNRECOMMEND, UNWATCH, UPDATE, WATCH</p>"},{"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 Library <p>Not 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</p>"},{"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 Default <p>Not Relevant:  APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, READ, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNDELETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH</p>"},{"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  Library <p>Not Relevant:  ADD, APPROVE, COMPLETE, COPY, DECLINE, DOWNLOAD, EMPTY, GRADUATE, LOCK, MOVE, PIN, PREVIEW, REJECT, REMOVE, RESTORE, UNCOMPLETE, UNLOCK, UNPIN, UNWATCH, VOTE, WATCH</p>"},{"location":"analytics/user-guide/terms/","title":"Glossary of Terms","text":""},{"location":"analytics/user-guide/terms/#events","title":"Events","text":"<p>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:</p> 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":"<p>The visible data (graph or table) produced to analyse the use of your IBM Connections environment.</p>"},{"location":"analytics/user-guide/terms/#report-definition","title":"Report Definition","text":"<p>The default instances provided with Huddo which can be used as-is (or customised) to create Reports</p>"},{"location":"analytics/user-guide/terms/#view-mode","title":"View mode","text":"<p>The default mode of a saved Analytics widget. It only displays the graph or table, hiding all the configuration options for the report.</p>"},{"location":"analytics/user-guide/terms/#edit-mode","title":"Edit mode","text":"<p>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.</p>"},{"location":"analytics/user-guide/introduction/","title":"Introduction","text":""},{"location":"analytics/user-guide/introduction/#purpose-of-huddo-analytics","title":"Purpose of Huddo Analytics","text":"<p>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?</p> <p></p>"},{"location":"analytics/user-guide/introduction/#what-is-a-report","title":"What is a Report?","text":"<p>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;</p>"},{"location":"analytics/user-guide/introduction/#table-reports","title":"Table Reports","text":"<p>These reports show data in a tabular form, with the ability to sort and filter on column values and also to toggle entire columns.</p> <p></p>"},{"location":"analytics/user-guide/introduction/#bar-charts","title":"Bar Charts","text":"<p>Bar charts are great for visual comparisons between values.</p> <p></p>"},{"location":"analytics/user-guide/introduction/#trend-reports","title":"Trend Reports","text":"<p>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.</p> <p></p>"},{"location":"analytics/user-guide/introduction/#column-charts","title":"Column Charts","text":"<p>Column charts are great for representing a distribution.</p> <p></p>"},{"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":"<p>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.</p> <p></p>"},{"location":"analytics/user-guide/using-reports/#customise-reports-to-answer-specific-questions","title":"Customise Reports to Answer Specific Questions","text":"<p>A Report also provides the capability to customise the query underlying its data to answer more specific questions. There are 4 main customisation options;</p>"},{"location":"analytics/user-guide/using-reports/#customise-query-parameters","title":"Customise Query Parameters","text":"<p>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.</p> <p></p> <p>After you have set the parameters you desire, press 'Run' to apply them and update the report data.</p> <p></p>"},{"location":"analytics/user-guide/using-reports/#sort-columns","title":"Sort Columns","text":"<p>Tabular reports allowing sorting column data (ascending/descending) by clicking on the header name.</p> <p></p>"},{"location":"analytics/user-guide/using-reports/#filtersearch-table-results-keyword-minmax","title":"Filter/Search table results (keyword, min/max)","text":"<p>Search report table columns by Keywords, Min/Max values and Start/End dates.</p> <p></p>"},{"location":"analytics/user-guide/using-reports/#enabledisable-columns","title":"Enable/Disable columns","text":"<p>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.</p> <p></p>"},{"location":"badges/","title":"Index","text":"<p>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.</p> <p>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.</p> <p>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.</p> <p>Huddo also now includes a peer to peer and team recognition feature; Huddo Thanks.</p>"},{"location":"badges/#huddo-points","title":"Huddo Points","text":"<p>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.</p>"},{"location":"badges/#huddo-metrics","title":"Huddo Metrics","text":"<p>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.</p> <p>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.</p>"},{"location":"badges/#huddo-filters","title":"Huddo Filters","text":"<p>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.</p> <p>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.</p>"},{"location":"badges/#huddo-badges","title":"Huddo Badges","text":"<p>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.</p> <p>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.</p>"},{"location":"badges/#huddo-awards","title":"Huddo Awards","text":"<p>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.</p>"},{"location":"badges/#huddo-leaderboard","title":"Huddo Leaderboard","text":"<p>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).</p> <p>You can also view a break-down of which categories the Points/Badges came from by simply selecting the user in the Leaderboard.</p>"},{"location":"badges/#huddo-configurators","title":"Huddo Configurators","text":"<p>The Huddo Badges, Metrics &amp; Filters Configurators allow the user to control and customise Badges, Metrics &amp; Filters.</p> <p>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.</p> <p>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.</p>"},{"location":"badges/#huddo-badges-summary","title":"Huddo Badges Summary","text":"<p>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.</p>"},{"location":"badges/#huddo-profile-progress-widget","title":"Huddo Profile Progress Widget","text":"<p>Encourage the users to get started in Connections!</p> <p>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!</p>"},{"location":"badges/#huddo-thanks","title":"Huddo Thanks","text":"<p>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.</p> <p>That is why ISW has developed Huddo Thanks, the peer to peer and team recognition tool for Connections.</p> <p>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.</p> <p>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.</p> <p>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!</p> <p>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.</p> <pre><code>Personalised Messages &amp; 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.\n</code></pre> <p>Thanks Allowance Control how often a Thanks badge may be awarded to add more value and create a greater impact.</p> <pre><code>Social Recognition &amp; 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.\n</code></pre>"},{"location":"badges/#huddo-groups","title":"Huddo Groups","text":"<p>Huddo Groups allows administrators to group users.</p> <p>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!</p>"},{"location":"badges/#connections-activity-stream-integration","title":"Connections Activity Stream Integration","text":"<p>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 &amp; Like on Awarded Badges and Thanks.</p> <p><pre><code>Awarded Badges\n</code></pre> <pre><code>All 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.\n</code></pre></p> <p>Huddo News Gadget</p> <p>From the Huddo News Gadget users can now Like and Comment on Huddo Activity Stream Entries.</p> <p>Liking Huddo Entries</p> <p>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.</p> <p>Commenting on Huddo Entries</p> <p>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.</p> <p>Recent Updates</p> <p>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!</p> <p>Thanks Given</p> <p>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.</p> <p>Thanks Email Notifications</p> <p>Users receiving Thanks will also be notified by email. Details about the Thanks, including the personal message of recognition, are included in this email.</p>"},{"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":"<p>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 -&gt; Huddo. These will be available as the defaults in the rebranded version of Huddo Badges but existing clients can update these now.</p>"},{"location":"badges/update-images/#load-updated-images","title":"Load Updated Images","text":"<p>Download the updated Huddo Images</p> <p>Login to Connections and navigate to the Badges Configurator Community</p> <p>Select the Settings tab in the BadgesConfigurator widget, scroll to the bottom and click the 'Import' button</p> <p></p> <p>Select the downloaded images.zip file and select 'Overwrite Customisations', then 'Upload'</p> <p></p> <p>You will get a prompt indicating that 281 records will be updated, press 'OK'</p> <p>The images will now be updated.</p>"},{"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":"<p>Ensure SSL certificates correctly imported to the ISC &amp; trust chain valid</p>"},{"location":"badges/websphere-faq/#images-do-not-work","title":"Images do not work","text":"<p>Please go to the BadgesConfigurator-&gt;Settings tab then restart the Huddo Application.</p>"},{"location":"badges/websphere-faq/#news-gadget-icon-not-showing-after-updating-url","title":"News Gadget Icon not showing after updating URL","text":"<p>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.</p>"},{"location":"badges/install/","title":"Installation","text":"<p>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.</p> <p>The install process for Huddo involves the following steps:</p> <ul> <li>Install the Huddo Application</li> <li>Define widgets</li> <li>Install Huddo Mobile (Optional)</li> <li>Apply changes</li> <li>Add Widgets to Connections interface</li> <li>Community Widget Properties</li> <li>Upload your Licence file</li> <li>Import Default Badges</li> <li>Make the Leaderboard Widget enabled by Default</li> <li>Set Award Permissions</li> <li>Run the Badge Engine to Award the Badges</li> <li>Customising</li> </ul> <p>Please Note: These steps are only applicable to a new install of Huddo. For information about upgrading, please see the Huddo Update Guide.</p>"},{"location":"badges/install/customising/","title":"Customising","text":""},{"location":"badges/install/customising/#customising-huddo-strings-properties-images-optional","title":"Customising Huddo Strings, Properties &amp; Images (Optional)","text":"<p>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.</p>"},{"location":"badges/install/customising/#customising-huddo-strings","title":"Customising Huddo Strings","text":"<p>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.</p> <p>Please Note:</p> <ul> <li>These files are in JSON format and it is critical that the syntax of these files is valid for the customisation to take effect.</li> <li> <p>This step can be performed at any stage after the installation and is not required to complete the installation.</p> <ol> <li>Create a folder called HuddoStrings in the directory given by the PROFILES_STATS_DIR WebSphere Variable.</li> <li>Create a text file called UserInterfaceLang.js in the HuddoStrings directory.</li> <li>Open the default UserInterfaceLang.js file from the location <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultLang/</li> <li>Add the strings you wish to customise to the newly created UserInterfaceLang.js file from the original file while maintaining a similar format.     e.g.: below is a sample customised UserInterfaceLang.js file which overwrites 7 properties:</li> </ol> </li> </ul> <p><pre><code>{\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}\n</code></pre> Note: only add the strings you wish to customise as this procedure will overwrite the existing strings for all other languages with the provided values.</p> <p>If you wish to add specific customisations for different languages:</p> <ol> <li>Create a sub-folder with the locale name within the HuddoStrings directory (See List of Language Codes)</li> <li>Create a language specific version of UserInterfaceLang.js file as per Steps 3 &amp; 4 above.</li> <li>Place it in the locale sub-folder.</li> </ol> <p>Example:</p> <pre><code>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\n</code></pre> <ol> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol>"},{"location":"badges/install/customising/#customising-huddo-properties","title":"Customising Huddo Properties","text":"<p>The 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.</p> <p>Available properties files to customise:</p> <ul> <li>applicationConfig.js \u2013 Context roots for Connections &amp; Huddo</li> <li>messages.properties \u2013 Strings used in Huddo emails &amp; Activity Stream entries</li> <li>resource.properties \u2013 Miscellaneous settings, i.e. database aliases etc.</li> </ul> <p>Please Note:</p> <ul> <li>These files are in JSON format and it is critical that the syntax of these files is valid for the customisation to take effect.</li> <li>This step can be performed at any stage after the installation and is not required to complete the installation.<ol> <li>Create a folder called HuddoProperties in the directory given by the PROFILES_STATS_DIR Websphere Variable.</li> <li>Copy the property file(s) to be edited into the HuddoProperties folder from the location    <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultProperties/</li> <li>Open the HuddoProperties folder\u2019s newly copied files and edit the properties as required before saving.</li> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol> </li> </ul>"},{"location":"badges/install/customising/#customising-huddo-images","title":"Customising Huddo Images","text":"<p>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.</p> <p>Please Note:</p> <ul> <li> <p>This step can be performed at any stage after the installation and is not required to complete the installation.</p> <ol> <li> <p>Determine the image(s) to be customised in the HuddoImages folder from the location    <code>&lt;installedAppsDir&gt;</code>/<code>&lt;cell name&gt;</code>/Huddo.ear/Huddo.war/defaultImages/</p> <pre><code>Common files customised include:\n    kudos_stream.png (as seen in the Homepage Activity Stream)\n    mobile_`&lt;MOBILE_DEVICE&gt;`.png (i.e. mobile_android.png etc \u2013 as seen for Huddo mobile)\n</code></pre> </li> <li> <p>Create a folder called HuddoImages in the directory given by the PROFILES_STATS_DIR Websphere Variable.</p> </li> <li>Place a copy of the custom image into the HuddoImages folder with the same name as the image file you wish to overwrite.</li> <li>After all the string, property and image customisations are completed, restart the Huddo application via the WebSphere Application Server ISC.</li> </ol> </li> </ul>"},{"location":"badges/install/embedded-exp/","title":"Embedded exp","text":""},{"location":"badges/install/embedded-exp/#install-huddo-embedded-experience-into-notesinotes-9-optional","title":"Install Huddo Embedded Experience into Notes/iNotes 9 (Optional)","text":"<p>The Huddo Embedded Experience is installed in the same manner as the default Connections Embedded Experience Gadget &amp; the Activity Stream Gadget.</p> <p>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.</p> <p>For Connections 4 CR2 and earlier the process is manual (overview).</p> <ol> <li>Make sure an OAuth client exists for Domino in Connections (link)</li> <li>Create the Huddo OpenSocial Widget in Notes (link) using the gadget URL: https:///Huddo/HuddoNewsGadget.xml and publish it to the     IBM Notes Widget Catalog. Note : You must replace  with the URL of your Connections environment. <li>Approve the Huddo Widget to the Catalog with the necessary proxy and OAuth data (link)</li>"},{"location":"badges/install/mobile/","title":"Mobile","text":"<p>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.</p>"},{"location":"badges/install/mobile/#check-out-the-mobile-configxml-file","title":"Check out the mobile-config.xml file","text":"<p>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.</p> <p>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.</p>"},{"location":"badges/install/mobile/#edit-the-mobile-configxml","title":"Edit the mobile-config.xml","text":"<p>Then proceed to add the following Application definition under the <code>&lt;Applications&gt;</code> node</p> <pre><code>&lt;Application name=\"Huddo\" enabled=\"true\"&gt;\n    &lt;ApplicationIcon&gt;\n        &lt;Android&gt;\n            &lt;Hdpi&gt; **../../** Huddo/images/mobile_android.png&lt;/Hdpi&gt;\n            &lt;Mdpi&gt; **../../** Huddo/images/mobile_android.png&lt;/Mdpi&gt;\n            &lt;Ldpi&gt; **../../** Huddo/images/mobile_android.png&lt;/Ldpi&gt;\n        &lt;/Android&gt;\n        &lt;IOS&gt;\n            &lt;Reg&gt; **../../** Huddo/images/mobile_iOS.png&lt;/Reg&gt;\n            &lt;Retina&gt; **../../** Huddo/images/mobile_iOS.png&lt;/Retina&gt;\n        &lt;/IOS&gt;\n        &lt;DefaultLocation&gt; **../../** Huddo/images/mobile_default.png&lt;/DefaultLocation&gt;\n    &lt;/ApplicationIcon&gt;\n    &lt;ApplicationLabel&gt;Huddo Badges&lt;/ApplicationLabel&gt;\n    &lt;ApplicationURL&gt;http://&lt;YOUR_CONNECTIONS_SERVER&gt;/Huddo/mobile&lt;/ApplicationURL&gt;\n&lt;/Application&gt;\n</code></pre> <p>Add the following to the <code>&lt;ApplicationList&gt;</code> or <code>DefaultNavigationOrder</code> node: Huddo.</p> <p>The result should be similar to: <code>&lt;ApplicationsList&gt;profiles,communities,files,wikis,activities,forums,blogs,bookmarks,Huddo&lt;/ApplicationsList&gt;</code> or <code>&lt;DefaultNavigationOrder&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Huddo&lt;/DefaultNavigationOrder&gt;</code></p> <p>Please Note: Make sure you replace <code>&lt;YOUR_CONNECTIONS_SERVER&gt;</code> 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.</p>"},{"location":"badges/install/mobile/#check-in-the-mobile-configxml-file","title":"Check in the mobile-config.xml file","text":"<p>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.</p> <p>Note: the configuration file must be checked in during the same wsadmin session in which it was checked out.</p>"},{"location":"badges/install/add-widgets/","title":"Add Widgets","text":"<p>So far, you have configured the location of the Huddo widgets. You will now add the widgets to the user interface.</p>"},{"location":"badges/install/add-widgets/#add-the-configurators-widgets-to-their-communities","title":"Add the Configurators Widgets to their Communities","text":"<p>Login to Connections and navigate to the previously created Badges Configurator Community</p> <ol> <li> <p>Click Community Actions then 'Add Apps' from the drop down menu</p> <p></p> </li> <li> <p>Select the Configurator(s) to add to the Community</p> <p></p> </li> <li> <p>Click X</p> </li> </ol> <p>The Configurators will now be added to the main view.</p> <p>Repeat the above steps for each configurator community you created.</p> <p>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.</p>"},{"location":"badges/install/add-widgets/#remove-the-default-widgets-optional","title":"Remove the Default Widgets (Optional)","text":"<p>Click the Actions drop-down and select Delete     </p> <p>Fill in the required data then click Ok on the Delete prompt     </p>"},{"location":"badges/install/add-widgets/#add-the-huddo-analytics-widget-to-communities","title":"Add the Huddo Analytics Widget to Communities","text":"<p>Login to Connections and navigate to the Huddo Analytics Community</p> <p>Click Community Actions then 'Add Apps' from the drop down menu</p> <p></p> <p>Select HuddoAnalytics</p> <p></p> <p>Click X</p> <p>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.</p> <p>Your first Huddo Analytics widget will now be added to the main view.</p> <p>The default view shows the report categories. Once a report category is selected, default report instances for that category can be selected.</p> <p>Once the report instance is selected, further options for that report can be selected.</p> <p>The report currently configured is previewed below the options and can be saved for quick viewing on all subsequent page loads.</p> <p>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.</p> <p>Multiple Huddo Analytics widgets are designed to exist in each community.</p>"},{"location":"badges/install/add-widgets/#add-the-widgets-to-the-home-page","title":"Add the Widgets to the Home page","text":"<p>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.</p> <p>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.</p> <p>Adding widgets to the Home page of Connections is done through the Connections Web page. </p> <p>Login to Connections as a user assigned to the admin security role of the Homepage application and navigate to the Administration tab.</p> <p>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.</p> <p></p> 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://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/RankingDisplay.xml False False True True False profiles News Gadget Open Social Gadget Huddo News Gadget https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/HuddoNewsGadget.xml True False False True False oauthprovider, oauth, opensocial, webresources Awarder iWidget Huddo Awarder https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/HuddoAwarder.xml False True False False False - User Analytics iWidget Huddo User Analytics https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/AnalyticsDashboard.xml False True False False True - <p>For the Open Social Gadget, select the following:</p> <ul> <li>Open Social Gadget</li> <li>Trusted and Use SSO</li> <li>Show for Activity Stream events</li> <li>All servers</li> </ul> <p>Click the Add Mapping button.</p> <ul> <li>Add a Mapping for the Huddo service to the Huddo client. Ensure OAuth Client is set to Huddo and the Service name is Huddo.</li> </ul> <p>Highlight each Huddo widget individually in the Disabled widgets section and click Enable</p> <p>The Huddo widgets will now show in the Enabled widgets list.</p> <p>It will also show on the Updates and Widgets tabs, if these options were selected.</p>"},{"location":"badges/install/add-widgets/#add-the-huddo-awarder-widget-to-my-page","title":"Add the Huddo Awarder Widget to My Page","text":"<p>Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.</p> <p>Open My Page through the Sidebar link or Home button and select Customize</p> <p></p> <p>Select Huddo Awarder. If you cannot find it, look under the 'Other' category.</p> <p></p> <p>Click X</p> <p>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.</p>"},{"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":"<p>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.</p> <p>Please Note: A default widget provided by Connections is required on \u2018My Page\u2019 for the Huddo widgets to function.</p> <p>Open My Page through the Sidebar link or Home button and select Customize</p> <p></p> <p>Select Huddo User Analytics. If you cannot find it, look under the 'Other' category.</p> <p></p> <p>Click X</p> <p>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.</p> <p>Multiple Huddo User Analytics widgets are designed to exist on My Page.</p>"},{"location":"badges/install/app/","title":"WebSphere Application","text":"<p>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 &amp; Analytics engines that drives the reward and recognition of user performance, as well as the widgets for user interaction.</p>"},{"location":"badges/install/app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"<p>Login to the WebSphere Integrated Solution Console for your Connections environment via a webbrowser.</p> <p>Enter your administrator User ID and Password, then click the \u201cLog in\u201d button.</p> <p></p>"},{"location":"badges/install/app/#install-the-huddowar-file","title":"Install the Huddo.war file","text":"<p>Navigate to Applications \u2192 Application Types \u2192 WebSphere enterprise applications</p> <p></p> <p>Click the Install button</p> <p></p> <p>Browse the Local File System Path for the downloaded Huddo.war file then Click Next</p> <p></p> <p>Check the Fast Path Option then Click Next</p> <p></p> <p>Change the Application name to Huddo then Click Next</p> <p></p> <p>Highlight the Nodes for the Application, including the IHS Node. Select the Badges Module, click Apply then Next.</p> <p>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 &gt; Clusters &gt; WebSphere application server clusters and then clicking New.</p> <p></p> <p>Click on Browse and map the default resources as shown. Click Next.</p> <p></p> <p>Enter Huddo as the Context Root, then click Next.</p> <p>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.</p> <p></p> <p>Review the Installation Summary. Click Finish.</p> <p></p> <p>Review the Installation Results. Click Save.</p> <p></p> <p>Review the Synchronisation Summary. Click OK.</p> <p>You have now successfully installed Huddo as a WebSphere Enterprise Application. Next, you will need to edit the security settings.</p>"},{"location":"badges/install/app/#modify-the-huddo-application-security-role-assignments","title":"Modify the Huddo Application Security Role assignments","text":"<p>During this step, we will be defining the authenticated users/groups for each Security Role.</p> <p>Find Huddo in the list of enterprise applications and click on Huddo to open the application configuration screen</p> <p></p> <p>Click Security role to user/group mapping</p> <p></p> <p>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</p> <p>Please note: You may set the Reader role to Everyone to grant read-only access to Huddo widget data to unauthenticated users.</p> <p></p>"},{"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":"<p>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.</p> <p>Navigate to Security \u2192 SSL certificate and key management and then select Key stores and certificates</p> <p></p> <p>Select CellDefaultTrustStore</p> <p></p> <p>Select Signer certificates</p> <p></p> <p>You will now see a list of all trusted certificates.</p> <p>If the URL of your Connections Environment is listed, skip to Add Huddo Related Strings to Connections</p> <p>We will now import the public certificate from the IBM HTTP Server to the default trust store in IBM WebSphere Application Server</p> <p>Click Retrieve from port</p> <p></p> <p>Enter the following details of the web server, then click Retrieve Signer Information:</p> <ul> <li>Host (e.g. connections.company.com)</li> <li>SSL Port (443)</li> <li>Alias</li> </ul> <p></p> <p>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.</p>"},{"location":"badges/install/app/#add-huddo-related-strings-to-connections","title":"Add Huddo Related Strings to Connections","text":"<p>This change will not be picked up by Connections until the servers are restarted. This will be performed at the end of the configuration.</p> <p>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 <p>IMPORTANT: If a file of the same name already exists, merge the contents into the existing file.</p> <p></p>"},{"location":"badges/install/apply-changes/","title":"Apply Changes","text":"<p>The clusters must be restarted for the widget &amp; mobile configuration changes to take effect.</p>"},{"location":"badges/install/apply-changes/#restart-the-clusters","title":"Restart the Clusters","text":"<p>Login to the Integrated Solution Console</p> <p>Navigate to Servers \u2192 Clusters \u2192 WebSphere Application Server Clusters</p> <p>Select all of the Connections Clusters</p> <p>Click Ripplestart.</p> <p></p>"},{"location":"badges/install/awards/","title":"Awards","text":"<p>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.</p>"},{"location":"badges/install/awards/#create-groups-for-access-control-via-the-badge-configurator","title":"Create groups for access control via the Badge Configurator","text":"<p>Open the User Groups Tab in the Badges Configurator widget and create groups required to set access control permissions for Awards.</p> <p>Groups can now be created by selecting people, Communities, other groups, importing a CSV file of emails or advanced profile attributes.</p> <p>Examples:</p> <ul> <li>Create a Management Group to award the Employee of the year Award</li> <li>A Sales Group to add as the Awardees to the Salesman of the Year Award; etc.</li> </ul> <p></p>"},{"location":"badges/install/awards/#set-the-access-groups-for-each-of-the-awards","title":"Set the access groups for each of the Awards","text":"<p>Open the Awards Tab in the Badges Configurator widget and for each of the Award definitions listed in the table perform the following steps:</p> <ol> <li>Click on the Award definition to open it for editing.</li> <li> <p>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?</p> <p>Note : Users selected in this step will need to add the Huddo Awarder widget to their widgets page as per</p> </li> <li> <p>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.</p> <p>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.</p> </li> <li> <p>Click Save to save your changes.</p> </li> </ol> <p></p>"},{"location":"badges/install/comm-properties/","title":"Community Properties","text":""},{"location":"badges/install/comm-properties/#step-6-additional-properties-for-communities-widgets-optional","title":"Step 6: Additional properties for Communities Widgets (OPTIONAL)","text":"<p>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.</p> <p></p> <p>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.</p> <p>Checkout and edit the widgets-config.xml file:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p> <p>Locate the Configuration Widget definitions under the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>Add the attribute <code>showInPalette=\"false\"</code> 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.</p> <p>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.</p> <p>Your configuration should now look like this:</p> <pre><code>&lt;widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"MetricsConfigurator\" description=\"metricsConfigurator\" modes=\"view fullpage\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/MetricsConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_METRICS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"FiltersConfigurator\" description=\"filtersConfigurator\" modes=\"view fullpage\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/FiltersConfigurator.xml\" themes=\"wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_FILTERS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoCommunity\" modes=\"view\" url=\"https://&lt;CONNECTIONS_SERVER_URL&gt;/Huddo/CommunityRankingDisplay.xml\" themes=\"wpthemeNarrow wpthemeWide\" showInPalette=\"false\" loginRequired=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"communityId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>Check in the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p> <p>Then Restart the clusters.</p>"},{"location":"badges/install/engine/","title":"Engine","text":"<p>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.</p>"},{"location":"badges/install/engine/#award-badges-now","title":"Award Badges Now","text":"<p>Login to Connections and navigate to the Badges Configurator Community</p> <p>Select the Settings tab in the BadgesConfigurator widget</p> <p>Click the Award Badges Now button.</p> <p>Note: If you are installing Huddo Badges to a Connections environment for testing purposes, it is recommended that the following settings are disabled:</p> <ul> <li>Enable Email Notifications for Badges/Awards</li> <li>Enable Email Notifications for Thanks</li> </ul> <p></p>"},{"location":"badges/install/install-widgets/","title":"Widgets","text":"<p>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.</p>"},{"location":"badges/install/install-widgets/#create-the-configurator-communities","title":"Create the Configurator Communities","text":"<p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p> <ol> <li> <p>Login to Connections, navigate to Communities and click Create a Community</p> <p></p> </li> <li> <p>Enter a name, such as Badges Configurator</p> </li> <li> <p>Set Access to Restricted</p> </li> <li> <p>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.</p> </li> <li> <p>Enter any tags, web address and description you wish then click Save.</p> <p></p> </li> </ol> <p>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.</p> <p>You have now created the first Huddo Configurator Community.</p> <p>Take note of the CommunityUUID in the URL address, as we will need this later.</p> <p>Please repeat the above steps for the Metrics &amp; 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</p>"},{"location":"badges/install/install-widgets/#create-the-huddo-analytics-administrator-community","title":"Create the Huddo Analytics Administrator Community","text":"<p>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.</p> <ol> <li> <p>Login to Connections, navigate to Communities and click Start a Community.</p> <p></p> </li> <li> <p>Enter a name, such as Huddo Analytics.</p> </li> <li> <p>Set Access to Restricted.</p> </li> <li> <p>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.</p> </li> <li> <p>Enter any tags, web address and description you wish and click Save.</p> <p></p> </li> </ol> <p>You have now created the Huddo Analytics Administrator Community.</p> <p>Take note of the CommunityUUID in the URL address, as we will need this later.</p>"},{"location":"badges/install/install-widgets/#check-out-the-widgets-configxml-file","title":"Check out the widgets-config.xml file","text":"<p>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.</p> <p>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.</p> <p>Checking Out the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p>"},{"location":"badges/install/install-widgets/#configure-the-profile-widgets","title":"Configure the Profile Widgets","text":"<p>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.</p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"profiles\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>IMPORTANT: Don\u2019t forget to substitute the following placeholders with the corresponding values! CONNECTIONS_SERVER_NAME</p> <pre><code>&lt;widgetDef defId=\"HuddoSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgeSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n    &lt;item name=\"NumberBadges\" value=\"12\"/&gt;\n    &lt;item name=\"BadgeViewAllWidgetId\" value=\"HuddoBadges\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoBadges\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgeViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"NumberBadges\" value=\"0\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"ProfileProgress\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ProfileProgress.xml\" modes=\"view\" themes=\"wpthemeNarrow\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"ThanksSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ThanksSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"NumberThanks\" value=\"12\"/&gt;\n        &lt;item name=\"ThanksWidgetId\" value=\"HuddoThanks\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"AwardSummary\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AwardSummaryDisplay.xml\" modes=\"view\" themes=\"wpthemeNarrow\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"NumberBadges\" value=\"12\"/&gt;\n        &lt;item name=\"AwardViewAllWidgetId\" value=\"HuddoAwards\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoAwards\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AwardViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoThanks\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/ThanksViewAll.xml\" modes=\"view\" themes=\"wpthemeWide\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"ProfilesId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>We 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.</p> <p>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:</p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"profiles\" ... &gt;</code>, then under <code>&lt;layout ...  resourceSubType=\"default\" ... &gt;</code>, then within <code>&lt;page ... pageId=\"profilesView\" ... &gt;</code> add the following:</p> <pre><code>&lt;widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoBadges\"/&gt;\n&lt;widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoThanks\"/&gt;\n&lt;widgetInstance uiLocation=\"tabsWidget1\" defIdRef=\"HuddoAwards\"/&gt;\n&lt;widgetInstance uiLocation=\"col1\" defIdRef=\"ProfileProgress\"/&gt;\n&lt;widgetInstance uiLocation=\"col3\" defIdRef=\"HuddoSummary\"/&gt;\n&lt;widgetInstance uiLocation=\"col3\" defIdRef=\"ThanksSummary\"/&gt;\n&lt;widgetInstance uiLocation=\"col3\" defIdRef=\"AwardSummary\"/&gt;\n</code></pre> <p>The 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 &amp; 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.</p> <p></p>"},{"location":"badges/install/install-widgets/#configure-configurators-and-community-leaderboard-widgets","title":"Configure Configurators and Community Leaderboard Widgets","text":"<p>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.</p> <p>You must define the Widgets and where to find their associated .xml files. You will need the CommunityUuids you took note of earlier.</p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <p>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</p> <pre><code>&lt;widgetDef defId=\"BadgesConfigurator\" description=\"badgesConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/BadgesConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_BADGES_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"MetricsConfigurator\" description=\"metricsConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/MetricsConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_METRICS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"FiltersConfigurator\" description=\"filtersConfigurator\" modes=\"view fullpage\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/FiltersConfigurator.xml\" themes=\"wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"communityId\" value=\"YOUR_FILTERS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoAnalytics\" description=\"HuddoAnalytics\" modes=\"view edit\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/AnalyticsDashboard.xml\" uniqueInstance=\"false\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"adminCommunityId\" value=\"YOUR_ANALYTICS_COMMUNITY_UUID\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;widgetDef defId=\"HuddoCommunity\" modes=\"view\" url=\"https://CONNECTIONS_SERVER_NAME/Huddo/CommunityRankingDisplay.xml\" showInPalette=\"false\" themes=\"wpthemeNarrow wpthemeWide\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"communityId\" value=\"{resourceId}\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n</code></pre> <p>We 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.</p> <p>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:</p> <p>Edit the widgets-config.xml file. Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;layout ... resourceSubType=\"default\" ... &gt;</code>, then within <code>&lt;page ... pageId=\"communityOverview\" ... &gt;</code> add the following:</p> <pre><code>&lt;widgetInstance uiLocation=\"col3\" defIdRef=\"HuddoCommunity\"/&gt;\n</code></pre>"},{"location":"badges/install/install-widgets/#check-in-the-widgets-configxml-file","title":"Check in the widgets-config.xml file","text":"<p>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.</p> <p>Checking In the Widgets-Config.xml File:</p> <p>Connections 5.5</p> <p>Connections 6.0</p> <p>Connections 6.5</p>"},{"location":"badges/install/install-widgets/#register-widgets-connections-60-cr1-onwards","title":"Register Widgets (Connections 6.0 CR1 onwards)","text":"<p>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.</p>"},{"location":"badges/install/install-widgets/#add-huddo-configuration-jsp-to-the-header","title":"Add Huddo configuration JSP to the header","text":"<p>(And add \u2018Give Thanks\u2019 Link in the navigation bar - Optional)</p> <p>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</p> <p>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:</p> <p>This is achieved by customising the header.jsp file, used for customizing the Connections Navigation bar.</p> <p>If you have not customised the header.jsp file for your connections environment, please make a copy of the file from:</p> <p><code>&lt;WAS_home&gt;</code>/profiles/<code>&lt;profile_name&gt;</code>/installedApps/<code>&lt;cell_name&gt;</code>/Homepage.ear/homepage.war/nav/templates</p> <p>Paste the copy into the common\\nav\\templates subdirectory in the customization directory: <code>&lt;installdir&gt;</code>\\data\\shared\\customization\\common\\nav\\templates\\header.jsp</p> <p>Edit the header.jsp file in the customisations directory add the following lines after the Moderation link and before the <code>&lt;/ul&gt;</code> HTML tag as shown:</p> <p></p> <p>To add the Huddo Config JSP</p> <pre><code>--%&gt;&lt;c:if test=\"${'communities' == appName || 'homepage' == appName || 'profiles' == appName}\"&gt;&lt;%--\n    --%&gt;&lt;c:catch var=\"e\"&gt;&lt;c:import var=\"kudosConfig\" url=\"http://${pageContext.request.serverName}/Kudos/kudosConfig.jsp\"/&gt;&lt;/c:catch&gt;&lt;%--\n    --%&gt;&lt;c:if test=\"${empty e}\"&gt;&lt;script type=\"text/javascript\"&gt;${kudosConfig}&lt;/script&gt;&lt;/c:if&gt;&lt;%--\n--%&gt;&lt;/c:if&gt;&lt;%--\n</code></pre> <p>To add the Give Thanks link \u2013 This step is OPTIONAL</p> <pre><code>--%&gt;&lt;script type=\"text/javascript\" src=\"/Huddo/scripts/widgets/ThanksAwarderHeader.js\" charset=\"utf-8\"&gt;&lt;/script&gt;&lt;%--\n--%&gt;&lt;li id=\"lotusBannerThankSomeone\"&gt;&lt;a href=\"javascript:giveThanks('${urlProfiles}');\"&gt;&lt;fmt:message key=\"label.header.kudos.givethanks\"/&gt;&lt;/a&gt;&lt;/li&gt;&lt;%--\n</code></pre> <p>Save and close the file, the changes will take effect when the clusters are restarted. (See next task)</p>"},{"location":"badges/install/install-widgets/#specify-huddo-analytics-admin-community-for-security","title":"Specify Huddo Analytics Admin Community for Security","text":"<p>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.</p> <p>Create the resource.properties file in the Profiles Statistics customisation directory: <code>&lt;PROFILES_STATS_DIR&gt;</code>/HuddoProperties Where PROFILES_STATS_DIR is defined by the WebSphere variable: e.g. /opt/IBM/Connections/data/shared/profiles/statistics/HuddoProperties</p> <p>Put the following line in the file, replacing <code>&lt;KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID&gt;</code> with the ID of the Huddo Analytics Community created in Task 2.4:</p> <pre><code>analyticsAdminCommunityID=&lt;KUDOS_ANALYTICS_ADMIN_COMMUNITY_ID&gt;\n</code></pre> <p>IMPORTANT: If a file of the same name already exists, merge the contents into the existing file.</p>"},{"location":"badges/install/leaderboard/","title":"Leaderboard","text":"<p>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.</p>"},{"location":"badges/install/leaderboard/#add-leaderboard-to-homepage","title":"Add Leaderboard to Homepage","text":"<p>Login to Connections and navigate to the Badges Configurator Community</p> <p>Select the Settings tab in the BdagesConfigurator widget</p> <p>Click the Add Leaderboard to Users Homepage button</p> <p>For the proceeding prompt boxes:</p> <ul> <li>Enter position for Leaderboard:     Specify the Leaderboard\u2019s position numerically or leave as default, click OK.</li> <li>Enter name of Leaderboard:     Specify the Leaderboard\u2019s name or leave as default, click OK.</li> </ul> <p></p>"},{"location":"badges/install/licence/","title":"Licence","text":"<p>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 </p>"},{"location":"badges/install/licence/#upload-your-licence-file-in-the-badges-configurator","title":"Upload your licence file in the Badges Configurator","text":"<p>Login to Connections Navigate to the Badges Configurator Community.</p> <p>Select the Settings tab in the BadgesConfigurator widget. If there are no tabs, this is the default view.</p> <p>Click the Update Licence button.</p> <p></p> <p>Click Choose File and browse to your Huddo.licence file and click Upload.</p> <p></p>"},{"location":"badges/install/load-defaults/","title":"Defaults","text":"<p>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.</p>"},{"location":"badges/install/load-defaults/#load-defaults","title":"Load Defaults","text":"<p>Login to Connections and navigate to the Badges Configurator Community</p> <p>Select the Settings tab in the BadgesConfigurator widget, scroll to the bottom and click the 'Load Defaults' button</p> <p></p> <p>Select:</p> <ul> <li>Badges_Achiever</li> <li>Badges_Culture</li> <li>Badges_Loyalty</li> <li>Badges_Thanks (or) Thanks</li> <li>Badges_Profiles</li> <li>Badges_Superstar</li> <li>Profile_Progress</li> <li>Images</li> <li>Filters</li> <li>Metrics</li> <li>Structure</li> <li>any other Badge Categories you wish to install (most installations would select all)</li> </ul> <p>Note: You will need to have the corresponding Connections Applications installed. As well as have a Standard or Enterprise Licence for Huddo.</p> <p></p> <p>Click Save</p> <p>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.</p>"},{"location":"badges/update/","title":"Update","text":"<p>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.</p> <p>The update process for Huddo involves the following steps:</p> <p>Update the Huddo Application in Websphere Application Server</p> <p>Refresh the Widget Cache</p> <ul> <li>If your Huddo application utilises a Custom Context Root in the WebSphere Application Server, then follow Installation Guide Step 11 to make necessary     modifications for default properties.</li> </ul> <p>Please Note: The Huddo update guide assumes that the Huddo application in the WebSphere Application server is using the Context Root <code>/Huddo</code>. If the Context Root has been set to something other than <code>/Huddo</code>, then make sure that you replace <code>/Huddo</code> with your Context Root when entering any URLs specified in this document.</p>"},{"location":"badges/update/refresh_cache/","title":"Refresh Widget Cache","text":"<p>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.</p> <p>Access the Homepage -&gt; 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.</p> <p></p> <p>In order to access Administration section, please ensure the logged in user is in the Homepage \u2018admin\u2019 security role.</p>"},{"location":"badges/update/update_app/","title":"Update the Application","text":"<p>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.</p>"},{"location":"badges/update/update_app/#login-to-the-websphere-integrated-solution","title":"Login to the WebSphere Integrated Solution","text":"<p>Login to the WebSphere Integrated Solution Console for your Connections environment via a web browser.</p> <p></p>"},{"location":"badges/update/update_app/#replace-the-huddowar-file","title":"Replace the Huddo.war file","text":"<p>Navigate to Applications -&gt; Application Types -&gt; WebSphere enterprise applications</p> <p></p> <p>Select the Huddo application and click Update.</p> <p></p> <p>Select Replace or add a single module option.</p> <p>Type in Huddo.war in the text field. Note: This is case-sensitive!</p> <p>Click Browse, navigate to and select the new Huddo.war file.</p> <p></p> <p>Follow the prompts clicking Next.</p> <p>If prompted, click Browse and map the default resources as shown.</p> <p></p> <p>Follow the prompts clicking Next.</p> <p>Click Finish.</p> <p>Click Save directly to master configuration.</p> <p>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.</p>"},{"location":"badges/update/update_app/#synchronize-the-nodes","title":"Synchronize the nodes","text":"<p>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.</p> <p>Go to System Administration &gt; Nodes.</p> <p>Select the node that Huddo is installed on. (If you are unsure you may select all the nodes)</p> <p>Click on Full Resynchronize and wait for the completion message.</p> <p></p>"},{"location":"badges/update/update_app/#restart-the-huddo-application","title":"Restart the Huddo Application","text":"<p>Go to Applications &gt; WebSphere Enterprise Applications</p> <p>Select the Huddo Application Checkbox.</p> <p>Click Stop and wait for the Application Status column to display the Stopped icon.</p> <p>Select the Huddo Application Checkbox.</p> <p>Click Start and wait for the Application Status column to display the Started icon.</p> <p></p>"},{"location":"badges/update/updatev6tov7/","title":"Updatev6tov7","text":"<p>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.</p>"},{"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":"<p>Open the Administration tab (on the Homepage) and browse to the Enabled Widgets list. For each Kudos Widget listed, select it and edit.</p> <p></p> OLD Widget Title OLD URL Address NEW Widget Title NEW URL Address Leaderboard Kudos Leaderboard https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Kudos/RankingDisplay.xml Huddo Leaderboard https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/RankingDisplay.xml News Gadget Kudos News Gadget https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Kudos/KudosNewsGadget.xml Huddo News Gadget https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/HuddoNewsGadget.xml Awarder Kudos Awarder https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Kudos/KudosAwarder.xml Huddo Awarder https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/HuddoAwarder.xml User Analytics Kudos User Analytics https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Kudos/AnalyticsDashboard.xml Huddo User Analytics https://<code>&lt;CONNECTIONS_SERVER_URL&gt;</code>/Huddo/AnalyticsDashboard.xml"},{"location":"badges/update/updatev6tov7/#profile-community","title":"Profile &amp; 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":"<p>Note</p> <p>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.</p>"},{"location":"boards/","title":"Huddo Boards","text":""},{"location":"boards/#versions","title":"Versions","text":"<p>We are proud to say that Huddo Boards is able to run in many configurations to suit your individual requirements.</p> <ol> <li>Boards Cloud</li> <li>Boards Self-Hosted (On-Premise)<ul> <li>HCL Connections Component Pack</li> <li>Kubernetes</li> <li>Docker - All In One</li> </ul> </li> <li>Boards Hybrid (Boards Cloud integrated with On-Premise)</li> </ol>"},{"location":"boards/#quick-links","title":"Quick Links","text":"<ol> <li>Boards Cloud - Recent Updates</li> <li>On-Premise - Latest Releases</li> <li> <p>Huddo Boards for</p> <ul> <li>HCL Connections</li> <li>HCL Domino</li> <li>HCL Digital Experience (DX)</li> </ul> </li> </ol>"},{"location":"boards/#how-to-decide-which-version","title":"How To Decide Which Version?","text":""},{"location":"boards/#boards-cloud","title":"Boards Cloud","text":"<p>This version is hosted by the ISW Huddo team at https://boards.huddo.com. Free trials are available!</p> <p>Advantages</p> <ul> <li>Hosted and managed by Team Huddo</li> <li>Always up to date with the latest functionality</li> <li>Backup strategies already in place</li> </ul> <p>See here for more information.</p>"},{"location":"boards/#boards-self-hosted-on-premise","title":"Boards Self-Hosted (On-Premise)","text":"<p>Our Boards Cloud product, installed locally in your infrastructure</p> <p>Advantages</p> <ul> <li>Can be installed in any existing Kubernetes environment (ie HCL Connections Component Pack)</li> <li>Can use the same Component Pack Mongo database</li> <li>Control over your own data and backup strategies</li> <li>Simple to update</li> </ul> <p>See install details for Kubernetes or HCL Connections Component Pack.</p>"},{"location":"boards/#boards-hybrid","title":"Boards Hybrid","text":"<p>(Cloud integrated with HCL Connections On-Premise.)</p> <p>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.</p> <p>Advantages</p> <ul> <li>All of the benefits of the Cloud above (hosted, managed, backed up)!!</li> <li>Integrates into your existing HCL Connections On-Premise (WebSphere)</li> <li> <p>Looks and feels like another application similar to Communities/Blogs etc with:</p> <ul> <li>Connections Apps menu link to 'Huddo Boards'</li> <li>Connections header</li> <li>Search and collaborate with your existing users</li> <li>Search and utilise your existing Communities</li> <li>Updates posted to your Activity Streams (Homepage, Social, Community)</li> <li>Ability to import existing Activities into Boards</li> </ul> </li> </ul> <p>Requirements</p> <ul> <li>Your HCL Connections URL must be accessible from the web (no VPN)</li> </ul> <p>See installation details for more information.</p> <p>Browser Support</p> <p>We support the most recent two versions of the following browsers:</p> <ul> <li>Chrome</li> <li>Safari</li> <li>Firefox</li> <li>Microsoft Edge</li> </ul>"},{"location":"boards/compatibility/","title":"Compatibility with Huddo Boards Docker","text":""},{"location":"boards/compatibility/#known-compatible","title":"Known Compatible","text":"<p>Huddo Boards Docker has been tested and confirmed working with the following versions</p> Minimum Maximum Kubernetes <code>v1.16</code> <code>v1.27.7</code> MongoDB <code>v4.0</code> <code>v7.0.4</code> Redis <code>v4.0</code> <code>v6.x</code>"},{"location":"boards/compatibility/#known-incompatible","title":"Known Incompatible","text":""},{"location":"boards/compatibility/#azure-cosmos-db","title":"Azure Cosmos DB","text":"<p>Issue</p> <p>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;</p> <p>https://feedback.azure.com/d365community/idea/3ddf6028-0f25-ec11-b6e6-000d3a4f0858</p> <p>https://feedback.azure.com/d365community/idea/ad9a64e6-0e25-ec11-b6e6-000d3a4f0858</p> <p>Suggestion</p> <p>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.</p> <p>Please contact us at support@huddo.com if you need further information.</p>"},{"location":"boards/helm-charts-kudos/","title":"Helm Chart History (Deprecated)","text":"<p>Warning</p> <p>These charts are deprecated. Please see the new charts</p> <p>Release notes for each Helm chart utilised by Boards (for Component Pack vs standalone, and Activity Migration)</p>"},{"location":"boards/helm-charts-kudos/#standalone-kubernetes","title":"Standalone Kubernetes","text":""},{"location":"boards/helm-charts-kudos/#kudos-boards","title":"kudos-boards","text":"<ul> <li>4.0.0 - Load Balancer (no cote), LivenessProbes, StartupProbes, Rename balancer dns defaults, add Activity Migration env &amp; remove podIP, global.legacyKube</li> <li>5.0.0 - Boards Notifications (webhooks), support service.nodePort</li> <li>5.2.0 - Kube 1.22 support (use Capabilities.APIVersions)</li> <li>5.2.1 - Added default Ingress.class annotation 'nginx'</li> </ul>"},{"location":"boards/helm-charts-kudos/#kudos-boards-activity-migration","title":"kudos-boards-activity-migration","text":"<ul> <li>4.0.0 - Load balancer (no cote), add Activity Migration env &amp; remove podIP, global.legacyKube</li> <li>5.0.0 - Support service.nodePort, default volume &amp; mount for share drive</li> <li>5.2.0 - use Capabilities.APIVersions instead of legacyKube</li> <li>5.2.1 - support custom spec &amp; custom accessMode/volumeMode/persistentVolumeReclaimPolicy</li> <li>5.2.2 - fix support of storageClassName on PVC</li> </ul>"},{"location":"boards/helm-charts-kudos/#for-component-pack","title":"For Component Pack","text":""},{"location":"boards/helm-charts-kudos/#kudos-boards-cp","title":"kudos-boards-cp","text":"<ul> <li>1.0.0 - Boards CP</li> <li>1.1.1 - Kube v1.17 support - minio v1.1.1</li> <li>2.0.0 - Kube v1.17 support, HTTP Requester/Responder, LivenessProbes, legacyKube</li> <li>2.0.1 - Ingress controller 0.22+ support</li> <li> <p>3.0.0 - Webhooks, Annotations for Socket cookie, support service.nodePort</p> <p>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.</p> <p>As of release 2021-06-09 you must move all the NOTIFIER_* environment variables from <code>core</code> to <code>events</code>. See our documentation for all supported options.</p> <p>For example:</p> <pre><code>events:\n    image:\n        name: \"\"\n        tag: boards-event\n    env:\n        NOTIFIER_EMAIL_HOST: &lt;smtp-email-host&gt;\n        NOTIFIER_EMAIL_USERNAME: &lt;smtp-email-username&gt;\n        NOTIFIER_EMAIL_PASSWORD: &lt;smtp-email-password&gt;\n        # plus all other NOTIFIER options previously defined in core\n</code></pre> </li> <li> <p>3.0.1 - Minio root credentials, nfs mountOptions</p> </li> <li>3.1.0 - Kube 1.22 support (use Capabilities.APIVersions)</li> <li>3.1.1 - Added default Ingress.class annotation 'nginx'</li> <li>3.1.2 - Fix Ingress pathType annotation for old kube versions (v17 etc)</li> <li>3.1.3 - support Kube v1.25 - remove policy/v1beta/PodSecurityPolicy (in minio) and add ingress.ingressClassName</li> <li>3.1.4 - version lock Minio for 'fs' storage type support</li> </ul>"},{"location":"boards/helm-charts-kudos/#kudos-boards-cp-activity-migration","title":"kudos-boards-cp-activity-migration","text":"<ul> <li>1.0.0 - Boards CP Activity Migration</li> <li>1.1.0 - Kude v1.17 support</li> <li>2.0.0 - Kube v1.17 support, HTTP Requester/Responder, LivenessProbes</li> <li>3.0.0 - Support service.nodePort, default volume &amp; mount for share drive</li> <li>3.0.1 - Support mountOptions for share drive</li> <li>3.1.0 - use Capabilities.APIVersions instead of legacyKube</li> <li>3.1.1 - support custom spec &amp; custom accessMode/volumeMode/persistentVolumeReclaimPolicy</li> <li>3.1.2 - fix support of storageClassName on PVC</li> </ul>"},{"location":"boards/helm-charts/","title":"Helm Chart History","text":"<p>Release notes for each Helm chart utilised by Boards (for Component Pack vs standalone, and Activity Migration)</p> <p>Important</p> <p>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.</p>"},{"location":"boards/helm-charts/#standalone-kubernetes","title":"Standalone Kubernetes","text":""},{"location":"boards/helm-charts/#huddo-boards","title":"huddo-boards","text":"<ul> <li>1.0.0</li> </ul>"},{"location":"boards/helm-charts/#huddo-boards-activity-migration","title":"huddo-boards-activity-migration","text":"<ul> <li>1.0.0</li> </ul>"},{"location":"boards/helm-charts/#for-component-pack","title":"For Component Pack","text":""},{"location":"boards/helm-charts/#huddo-boards-cp","title":"huddo-boards-cp","text":"<p>Danger</p> <p>As of <code>huddo-boards-cp-1.0.0.tgz</code> we have changed the Minio pods to run as <code>user 1000</code> instead of <code>root</code>. You must perform the following command on the shared drive (<code>/pv-connections</code> file system) before using this new chart. The change is backwards compatible.</p> <pre><code>cd /pv-connections/kudos-boards-minio/\nchown 1000:1000 -R .\n</code></pre> <ul> <li>1.0.0</li> <li>1.1.0 - CNX 8 fix for Mongo 5</li> <li>1.1.1 - Support custom storageClassName instead of PV</li> <li>1.2.0 - Added readiness probes on each service</li> </ul>"},{"location":"boards/helm-charts/#huddo-boards-cp-activity-migration","title":"huddo-boards-cp-activity-migration","text":"<ul> <li>1.0.0</li> <li>1.1.0 - CNX 8 fix for Mongo 5</li> </ul> <p>Info</p> <p>The previous chart information has moved here</p>"},{"location":"boards/hybrid/","title":"Boards Hybrid","text":"<p>Hybrid = Cloud integrated with HCL Connections On-Premise</p> <p></p> <p>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.</p> <p>For a comparison of Boards versions please see here</p> <p>Setting up the Hybrid Boards Cloud involves:</p> <ol> <li> <p>Configure Authentication</p> </li> <li> <p>Review Security</p> </li> <li> <p>Contact the Huddo Team with these details</p> <pre><code>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:\n</code></pre> </li> <li> <p>Configure HCL Connections extensions</p> <ul> <li>Connections Header</li> <li>Customise Apps menu</li> <li>Customise Widgets</li> <li>Add to Mobile App</li> </ul> </li> </ol>"},{"location":"boards/images/","title":"Using latest releases directly from Huddo","text":"<p>You can get the latest versions of Huddo Boards Docker by subscribing to our own repository in Quay.io as follows:</p> <ol> <li> <p>Create a Quay.io - Red Hat account if you do not already have one.</p> </li> <li> <p>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.</p> </li> <li> <p>Get secret to use in Kubernetes</p> <ol> <li> <p>Open Quay.io, In the user menu, click on 'Account Settings'</p> <p></p> </li> <li> <p>Click <code>Generate Encrypted Password</code></p> <p></p> </li> <li> <p>Enter your password and click <code>Verify</code></p> <p></p> </li> <li> <p>Download the secret.yml file. Take note of the name of the secret for later use</p> <p></p> </li> </ol> </li> <li> <p>Use the file downloaded to create the secret (in the required namespace). For example:</p> <pre><code># 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\n</code></pre> </li> </ol>"},{"location":"boards/releases-archive/","title":"Boards Self-Hosted Releases (Archive)","text":"<p>Tip</p> <p>Documentation for recent releases can be found here.</p>"},{"location":"boards/releases-archive/#2022","title":"2022","text":""},{"location":"boards/releases-archive/#2022-12-15","title":"2022-12-15","text":"<p>Improvements:</p> <ul> <li>synchronise dependencies in real time</li> <li>faster creation of multi cards</li> <li>presence of users open on card without board open</li> <li>link to API documentation</li> <li>adding dependencies between private cards</li> <li>handling of dependencies where not accessible</li> <li>make associated comments public when card is made public</li> <li>synchronise my private tasks between my windows</li> </ul> <p>Fixes:</p> <ul> <li>issue opening board \"Error: Minified React error #185\"</li> <li>issue where Community widget shows 'my' boards incorrectly</li> <li>issue where someone online in board remained online if page reloaded</li> <li>issue where lists hidden when previewing Kanban view while creating a Board</li> <li>issue where page crashed on logout in Node view</li> <li>issue where page crashed on logout in Timeline view</li> <li>issue where files couldn't be downloaded</li> <li>issue where page reloaded in admin view</li> </ul>"},{"location":"boards/releases-archive/#2022-11-15","title":"2022-11-15","text":"<p>Improvements:</p> <ul> <li>Redis client reuse</li> <li>Ensure Redis is available on startup</li> </ul>"},{"location":"boards/releases-archive/#2022-11-09","title":"2022-11-09","text":"<p>Features:</p> <ul> <li>installable web app</li> </ul> <p>Performance:</p> <ul> <li>faster load</li> <li>added virtual scroll for Kanban</li> <li>smoother drag and drop</li> <li>faster filtering/searching inside a Board</li> </ul> <p>Improvements:</p> <ul> <li>improved new user experience in integrations</li> <li>hide dependency lines while dragging &amp; resizing</li> <li>usability of tile color label edit/selection</li> <li>stop auto redirecting expired account</li> <li>debugging added for socket connections and description locking<pre><code>&gt; In browser console, you can enter `boards.setDebug(true)` and press Enter to enable this, then reload the page.\n&gt; You will then get debug logs in the console for all websocket and description lock events.\n&gt; Use `boards.setDebug(false)` to turn this off when done.\n</code></pre> </li> </ul> <p>Fixes:</p> <ul> <li>fix for drag scrolling lists on mobile</li> <li>fix editing link titles</li> <li>fix positioning of timeline arrows caused by swimlane animations</li> <li>fix double click to add list</li> </ul>"},{"location":"boards/releases-archive/#2022-10-24","title":"2022-10-24","text":"<p>Improvements:</p> <ul> <li>reduced processing whilst dragging cards</li> <li>/app/createcard micro app - new users can now create a board instead of being stuck with no board to choose</li> </ul> <p>Timeline:</p> <ul> <li>animate expand/collapse of scheduled lanes</li> <li>fix for hidden cards on timeline when duplicated (eg multiple colors/assignments)</li> <li>highlight multiple instances of same card on hover</li> <li>remember last view (list/color/members)</li> <li>live updates of list names, color labels and members</li> <li>show color labels</li> </ul> <p>Fixes:</p> <ul> <li>webhook api events may not have fired in a specific situation for users with linked accounts</li> </ul>"},{"location":"boards/releases-archive/#2022-10-10","title":"2022-10-10","text":"<p>Fixes:</p> <ul> <li>API documentation page no longer using local config (all \"Try it out\" routes would fail).</li> </ul>"},{"location":"boards/releases-archive/#2022-10-07","title":"2022-10-07","text":"<p>API Updates:</p> <ul> <li>Add <code>PATCH</code> method for <code>/node/{nodeId}</code> to allow changing any attribute of a card or list</li> <li>Add webhook for card-moved events (<code>/webhook/card-moved/{boardId}</code>)</li> </ul> <p>Translations:</p> <ul> <li>Full translation run for all supported languages</li> </ul> <p>Features / Fixes:</p> <ul> <li>Fixed scolling in the Timeline view when you have too many lists to fit in the view</li> <li>Changed colours on the Timeline view to better show cards when dragging</li> <li>Fix for closing date picker on touch screens</li> <li>Remade the drag preview on timeline to look more like a card</li> <li>Build process refactor - docker images are much smaller after this update</li> <li>All images updated to pass latest security scan requirements</li> </ul>"},{"location":"boards/releases-archive/#2022-09-07","title":"2022-09-07","text":"<p>Security Update:</p> <ul> <li>Full node.js package audit and update</li> </ul>"},{"location":"boards/releases-archive/#2022-08-25","title":"2022-08-25","text":"<p>Features:</p> <ul> <li>Added translations for Dependencies feature</li> <li>Added translations for all email templates</li> </ul>"},{"location":"boards/releases-archive/#2022-08-16","title":"2022-08-16","text":"<p>Features:</p> <ul> <li>Domino authentication More info here</li> </ul> <p>Fixes:</p> <ul> <li>Distorted profile image if not square</li> </ul>"},{"location":"boards/releases-archive/#2022-08-09","title":"2022-08-09","text":"<p>Improvements:</p> <ul> <li>Compatibility for private channels in Teams</li> </ul> <p>Fixes:</p> <ul> <li>Attach Card with remembered previous selection</li> </ul>"},{"location":"boards/releases-archive/#2022-06-24","title":"2022-06-24","text":"<p>Features:</p> <ul> <li>Dependencies feature</li> </ul> <p>Improvements:</p> <ul> <li>Printing in Board View</li> <li>Highlights widget opening fullpage</li> <li>Updated Recent Boards in side toolbar</li> <li>Viewing card title when user presence is also displayed</li> <li>Visibility of Owners Only group Boards</li> </ul> <p>Fixes:</p> <ul> <li>Styling of user presence when multiple</li> <li>Card toolbar on smaller resolutions</li> <li>Community widget now works if user has no email</li> <li>'Commented on' recent updates not syncing in real-time</li> <li>Auth loop when using Connections Header</li> <li>Loading ToDo View &amp; 'View' by 'Groups' when a group has been deleted</li> <li>Description not saving in certain window changing scenarios</li> </ul>"},{"location":"boards/releases-archive/#2022-05-13","title":"2022-05-13","text":"<p>Features:</p> <ul> <li>Auto login to Boards if only one provider configured</li> </ul> <p>Improvements:</p> <ul> <li>Prevent closing page when still editing description</li> <li>Styling of description locked alert for visibility when scrolled</li> <li>New Teams welcome message card</li> <li>New Teams notification cards</li> </ul> <p>Fixes:</p> <ul> <li>Clickable links in description</li> <li>Moving focus between description and comments</li> <li>Saving description changes when focusing new comment</li> <li>Truncation of comment when posting in some circumstances</li> <li>Prevent authors attempting to edit descriptions when not allowed</li> <li>@mentions on new lines created with shift+enter</li> <li>Showing bubble editor when select all text in comment (ctrl+a)</li> <li>Issue with attachments from EML uploads (e.g. drag from HCL Notes)</li> </ul>"},{"location":"boards/releases-archive/#2022-04-20","title":"2022-04-20","text":"<p>Features:</p> <ul> <li> <p>Login to Boards using Single Sign On (SSO) in Microsoft Teams</p> <p>Note: you will need to:</p> <ol> <li>Configure SSO in Teams in your existing Azure OAuth application definition</li> <li>follow this guide to download the latest app definition and update it in Teams.</li> </ol> </li> </ul> <p>Fixes:</p> <ul> <li>Issue loading Activity Stream gadget</li> <li>Issue with Moderated Community access</li> <li>Issue when updating Board title</li> <li>Issue with lock of description in communities</li> </ul>"},{"location":"boards/releases-archive/#2022-04-07","title":"2022-04-07","text":"<p>Improvements:</p> <ul> <li>Reduced number of simultaneous MongoDB connections</li> </ul> <p>Fixes:</p> <ul> <li>Issue with comment stream entry for Orient Me</li> <li>Issue with updating card title from Boards view in FireFox</li> <li>Issue with deeplinked Connections Community widgets</li> <li>Issue with Boards Search styling</li> <li>Issue with opening filters via icon</li> <li>Issue with Moderated Community ACL</li> <li>Issue with Teams login popup not closing</li> </ul> <p>Activity Migration:</p> <ul> <li>Fix invisible top level task/entries</li> </ul>"},{"location":"boards/releases-archive/#2022-03-21","title":"2022-03-21","text":"<p>Improvements:</p> <ul> <li>File upload feedback (eg when socket unavailable)</li> </ul> <p>Fixes:</p> <ul> <li>WebSocket failure fallback to Polling</li> <li>Prevent duplicates appearing in history from live events</li> <li>First comments not live displaying</li> <li>Issue where Timeline displaying some cards a day out</li> <li>Issue where Subscriber Redis crashes after too many concurrent events</li> </ul>"},{"location":"boards/releases-archive/#2022-03-09","title":"2022-03-09","text":"<p>Improvements:</p> <ul> <li>Upgraded libraries for performance/security/support (e.g. Material UI, Redis)</li> <li>Improved loading perfomance (reduced bundle size)</li> </ul> <p>Fixes:</p> <ul> <li>issue where comments disappear in certain scenarios</li> <li>issue where pasting into edited comment clears comment</li> <li>issue where loading a Community widget where the Board has been deleted causing an inifinite loop</li> </ul> <p>Activity Migration:</p> <ul> <li>Added optional variables to reprocess migrated files which had encoding issues</li> </ul>"},{"location":"boards/releases-archive/#2022-02-17","title":"2022-02-17","text":"<p>Features:</p> <ul> <li>Ability to change Private cards to Public</li> </ul> <p>Improvements:</p> <ul> <li>Updated Date pickers with month/year selection</li> <li>Updated Material UI library to latest</li> <li>Better internationalisation of dates</li> </ul> <p>Fixes:</p> <ul> <li>Fix for saving description on modal closure</li> <li>Fix for transfer membership</li> <li>Fix detection of descriptions migrated from Activities</li> <li>Fix for entry styling when Visual Update One applied</li> </ul> <p>Activity Migration:</p> <ul> <li>Uses new FileInfo meta structure</li> <li>Fix to flag cards with description</li> </ul>"},{"location":"boards/releases-archive/#2022-02-10","title":"2022-02-10","text":""},{"location":"boards/releases-archive/#file-store-migration","title":"File store migration","text":"<p>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.</p> <p>Improvements:</p> <ul> <li>File uploads have better user feedback, showing a partial file and track the upload progress</li> <li>File downloads make better use of the original mimetype and no longer use the file name in the url</li> <li>When setting Due, Start and End Dates the picker now supports clicking in the header to choose a year</li> </ul> <p>Fixes:</p> <ul> <li>Cards created from Outlook / Verse can crash a board</li> <li>Date \"chips\" on card view need to be clicked twice</li> <li>Pasting an image can wipe a description</li> <li>Boards in a community / team no longer show \"My Boards\" on error</li> <li>Clicking \"Private\" sometimes does nothing</li> <li>File size calculation now allows a full 50mb file</li> </ul>"},{"location":"boards/releases-archive/#2022-01-07","title":"2022-01-07","text":"<p>Fixes:</p> <ul> <li>Issue where notifications of comments not sent to other commenters</li> <li>Issue where emails sent to content creators when users are no longer Board members</li> <li>Issue when completing tasks when multi-assign has been removed</li> <li>Issue where sub cards not loading when opening a card via url</li> <li>Issue where card breadcrumbs (ancestors) not displaying when opening a card via url</li> </ul>"},{"location":"boards/releases-archive/#2021","title":"2021","text":"<p>2021-12-17</p> <p>Improvements:</p> <ul> <li>Throttle lookups of members from Communities application</li> <li>Improved description of scheduled cards in Recent Updates history</li> <li>Arabic language updates</li> </ul> <p>Fixes:</p> <ul> <li>Issue when adding Tag with same starting letter as previous</li> <li>Issue when moving Cards in MindMap</li> <li>Issue where Board title overflowed in MindMap</li> <li>Issue where removing description was not synchronised to other users with modal open</li> </ul> <p>2021-11-23</p> <p>Features:</p> <ul> <li>Recent Updates (board level and inside cards)</li> </ul> <p>Improvements:</p> <ul> <li>Arabic language updates</li> <li>MSGraph user searching (inc Guests)</li> <li>Activity Migration: better feedback when invalid content store data</li> </ul> <p>Fixes:</p> <ul> <li>Assigning a user by drag/drop creates second card from profile image</li> </ul> <p>2021-11-18</p> <p>Updates:</p> <ul> <li>All services have been updated to the latest LTS version on Node.js, all dependencies have been updated to their latest supported versions.</li> <li>Updated translations for Arabic and German.</li> </ul> <p>2021-11-02</p> <p>Fixes:</p> <ul> <li>Licence not found errors when adding or removing licences in the LICENCE key environment variable.</li> </ul> <p>2021-10-26</p> <p>Fixes:</p> <ul> <li>SSL Issue connecting to Component Pack Mongo</li> </ul> <p>2021-10-22</p> <p>Features:</p> <ul> <li>User Presence</li> <li>Private Cards</li> </ul> <p>Improvements:</p> <ul> <li>Load performance by reducing page size</li> <li>Activities View performance</li> <li>Optional API Rate Limiting</li> <li>Better handling of conflicting CSS from Visual Update One</li> <li>Enhancement for Microsoft Graph groups which are not teams (owner vs member)</li> </ul> <p>Fixes:</p> <ul> <li>Issue when adding Connections Communities as members</li> <li>Issue when changing user account tries to loads the previous open Board</li> <li>Issue where link is inserted at start of description</li> <li>Issue with authenticated webhooks</li> <li>Issue with S3 \"bucket-already-exists\" race condition</li> <li>Issue where multiple toasts in quick succession never auto closed</li> </ul> <p>2021-09-29</p> <p>Improvements:</p> <ul> <li> <p>Reduce reliance on Communities application</p> <ul> <li>Reduce member lookups</li> <li>Increase page size of Communities requests</li> <li>Throttles simultaneous requests to Communities</li> <li>Increase caching of responses</li> </ul> </li> <li> <p>Undo / Redo option in Rich Text editor</p> </li> </ul> <p>Fixes:</p> <ul> <li>Indexing issue when recreating <code>providerID_1</code> with new options</li> </ul> <p>2021-09-24</p> <p>Improvements:</p> <ul> <li>Debug logging of 400 errors in webfront</li> </ul> <p>Fixes:</p> <ul> <li>issue with index in Component Pack mongo when assigned task name too long</li> </ul> <p>2021-09-17</p> <p>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</p> <p>Note: if you encounter 400 bad requests when loading <code>/boards</code>, please see this troubleshooting guide.</p> <p>Features:</p> <ul> <li>Private Cards</li> </ul> <p>Improvements:</p> <ul> <li>Board load performance</li> <li>User/Group search performance</li> <li>more granular user permissions for group membership</li> <li>ability to set group permissions for a Board on create in the group</li> <li>Community name search improvements (handling of names with special characters)</li> <li>added missing German translations</li> <li>MongoDB - refined and reduced total indexes. Be aware that this update will cause a heavy re-index.</li> </ul> <p>Fixes:</p> <ul> <li>issue where you could not change level of community members</li> <li>issue assigning colours in quick succession</li> <li>issue when removing filters on ToDo view</li> <li>teams notifications turning back on when they are disabled</li> <li>issue accepting email invites for guest/external users</li> </ul> <p>2021-06-24</p> <p>Fixes:</p> <ul> <li>Added environment variable <code>FORCE_POLLING</code> in webfront to avoid issues seen when using IHS as reverse proxy</li> <li>API documentation should now work for cp releases, see <code>/api-boards/</code></li> </ul> <p>2021-06-09</p> <p>Breaking change:</p> <p>Emails are now sent by the <code>events</code> service. You must move the NOTIFIER_* environment variables from <code>core</code> to <code>events</code> as shown in v3 of our chart</p> <p>New Features:</p> <ul> <li>Due Date reminder emails</li> <li>Email notification controls</li> <li>Product Tours</li> </ul> <p>Improvements:</p> <ul> <li>New email styling &amp; full Card/Board representation</li> </ul> <p>Fixes</p> <ul> <li>Visibility of assignment completion (ticks) when multi-complete</li> <li>Issue where description was hidden if other card attribute updated</li> <li>UI feedback when completing task on Todos view</li> <li>Completion logic when completing last assignment</li> <li>Missing description when post comment, export Board as CSV, create Board from Template (since 06-02)</li> <li>Logout issue (since 06-02)</li> </ul> <p>2021-06-02</p> <p>Improvements:</p> <ul> <li>Only load Descriptions when required (less data, faster loading times)</li> <li>Styling/positioning of Date selection</li> </ul> <p>Fixes</p> <ul> <li>Missing Boards when viewed by Color (if never opened)</li> </ul> <p>2021-05-31</p> <p>Improvements:</p> <ul> <li>Microsoft (Teams &amp; Sharepoint) - detect owners vs members (authors)</li> <li>Creating board in Sharepoint sites</li> <li>Comment create/delete UI performance</li> <li>Card completion performance</li> </ul> <p>Fixes:</p> <ul> <li>ACL for Readers/Commenters</li> <li>Protect against removing an assignment while still creating</li> <li>Showing image pasted in description with no text</li> <li>Linking to files in folders</li> <li>Description lock issues when framed (Connections, Sharepoint etc)</li> <li>Wrap long comments instead of sideways scrolling</li> </ul> <p>2021-05-13</p> <p>Improvements:</p> <ul> <li> <p>Link to Files / Upload to Files</p> <ul> <li>Show options for all member Groups (Communities)</li> <li>Updated defaults for private Boards</li> <li>Alphabetic ordering of Connections files</li> <li>Type to filter</li> </ul> </li> <li> <p>Allow custom NodeMailer email options (insecure tls etc)</p> <p><code>core.env.NOTIFIER_EMAIL_OPTIONS: \"{\\\"ignoreTLS\\\": true,\\\"tls\\\":{\\\"rejectUnauthorized\\\":false}}\"</code></p> </li> </ul> <p>Fixes:</p> <ul> <li>Color tag menu positioning on small screen</li> <li>Boards image on file uploads (context root)</li> </ul> <p>2021-05-04</p> <p>Improvements:</p> <ul> <li>User feedback when assigning tasks to multiple users (no flickering)</li> <li>Reconnect live events after service updates</li> <li>API docs only at root, send 404 for missing/incorrect routes</li> <li>Reduce height of background event loading progress bar</li> </ul> <p>Fixes:</p> <ul> <li>Archive view loading animation</li> <li>Adding an Admin by email search</li> <li>Dot in Node modal above name input visible with a theme</li> <li>Outlook add-in file updates</li> <li>Deep linking to Community Boards widget in Highlights app</li> <li>Authors can no longer assign users to tasks they did not create</li> <li>Authors and Readers can complete 'All Must Complete' tasks they are assigned to</li> </ul> <p>2021-04-29</p> <p>New:</p> <ul> <li>Boards Event service</li> </ul> <p>Fixes:</p> <ul> <li>Allow editing of rich text when sockets fail</li> <li>Opening cards with html imported from Outlook</li> <li>Member assignment on click in menu</li> <li>Remove card theme when deleting file set as card theme</li> <li>Multiple assignments in rapid succession</li> </ul> <p>2021-04-26</p> <p>Improvements:</p> <ul> <li>Updates to Rich Text Editor &amp; editor locking mechanism</li> <li>Card icon for scheduled start/end dates</li> <li>Admin revoke &amp; anonymise user function</li> <li>API for email to Card/Entry parsing</li> <li>API for file upload as new Card</li> </ul> <p>Fixes:</p> <ul> <li>Highlights widget update for C7</li> <li>Updated German translation</li> </ul> <p>Activity Migration</p> <ul> <li>Use Connections Shared Drive to load Activity long descriptions and files (new variables &amp; volume/mount required in yaml)</li> </ul> <p>2021-03-22</p> <p>Improvements:</p> <ul> <li>Board loading performance</li> </ul> <p>Fixes:</p> <ul> <li>Locking of description when socket fails</li> <li>Activity migration - protect against old public data</li> </ul> <p>2021-03-16</p> <p>Improvements:</p> <ul> <li>Handle legacy Boards WebSphere URL redirect (hashes)</li> <li> <p>Ability to transition between providers</p> <ul> <li>Link User accounts by full email address</li> <li>Map Groups by CSV file</li> <li>Transfer Ownership &amp; Unlink accounts</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Verse integration</li> </ul> <p>2021-03-10</p> <p>Fixes:</p> <ul> <li>Groups not saving expanded members (affects imported Activities)</li> <li>Issue where homepage didnt reload after login from secondary alias</li> <li>Improved support for imported community owner + reader role</li> </ul> <p>Activity Migration:</p> <ul> <li>Updated Mongoose version to fix 'module exports inside circular dependency' warning</li> </ul> <p>2021-03-05</p> <p>Features:</p> <ul> <li>New Huddo branding!</li> <li>New API with docs!</li> <li> <p>API integrations with</p> <ul> <li>Zapier</li> <li>Power Automate</li> </ul> </li> <li> <p>Leave a Board</p> </li> <li>Card description lock (one-at-a-time editing)</li> <li>Embed Cards/Boards in third party apps (e.g. Sharepoint)</li> </ul> <p>Fixes:</p> <ul> <li>Prevent file upload with zero size</li> <li>Support migrated folders</li> </ul> <p>2021-03-04</p> <p>Fixes:</p> <ul> <li>Connections login no longer sends redirect_uri (connections will use the one configred in wsadmin)</li> </ul> <p>2021-03-03</p> <p>Improvements:</p> <ul> <li>Ability to sync profiles from Connections &amp; Microsoft (please follow the steps on the Admin page of each Client)</li> <li>Ability to automatically link user aliases in 2 different clients (eg Connections &amp; Microsoft)</li> <li>Support for Activity URL with entryId</li> </ul> <p>Fixes:</p> <ul> <li>Redirect to login if required when accessing Activity URL</li> <li>Board ACL updates for membership escallation</li> </ul> <p>2021-02-19</p> <p>Improvements:</p> <ul> <li>Todos view<ul> <li>hide sub-cards which are not applicable</li> <li>hide multi-assigned tasks I have completed (assigned view)</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Disable notification for Communities with 'owner-only' membership</li> <li>Notifications when creating a Board &amp; members at the same time</li> <li>Protect against imported data for assignments without users &amp; nodes without creator</li> <li>Mindmap - expand/collapse icons</li> <li>Redirect from Activity URL to Board URL in the Connections header frame</li> <li>Show all public members when multiple</li> </ul> <p>2021-01-19</p> <p>Improvements:</p> <ul> <li>Show login page on file download when unauthorized</li> <li>Login options for Verse/Outlook integration</li> </ul> <p>Fixes:</p> <ul> <li>Tile color popup positioning and scrolling for small screens</li> <li>Protect against null assignment value after import</li> <li>PDF downloads inside the community widget</li> <li>Show new cards added in assignments view</li> <li>Show assigned cards in Timeline view (only affects some users with multiple linked accounts)</li> </ul>"},{"location":"boards/releases-archive/#2020","title":"2020","text":"<p>2020-12-14</p> <p>Features:</p> <ul> <li>Updated migration service to support the new \"Community Owners only\" option</li> <li> <p>Added fix for Activities that had already been imported and used the equivalent permission set in Activities</p> <p><code>boards.yaml</code></p> <pre><code>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\n</code></pre> </li> </ul> <p>2020-12-12</p> <p>Features:</p> <ul> <li>Added group membership option \"Community Owners Only\" which makes the community owners have owner rights in a board but does not allow any other community members access. This option is available for boards created in a community widget only.</li> </ul> <p>2020-11-13</p> <p>Improvements:</p> <ul> <li>Increase multi-lingual coverage</li> </ul> <p>2020-11-02</p> <p>Improvements:</p> <ul> <li>Increase multi-lingual coverage</li> <li>Creating Board from template includes members/description</li> <li>Option to disable Welcome emails (user.env.DISABLE_WELCOME_EMAIL)</li> </ul> <p>Fixes:</p> <ul> <li>Uploading file in iOS Safari</li> </ul> <p>2020-10-14</p> <p>Improvements:</p> <ul> <li>Updated Rich Text Editor</li> </ul> <p>Fixes:</p> <ul> <li>Re-open last board view</li> <li>User trial reminder</li> <li>Extension of user trials</li> <li>Download linked files with .odt extension</li> </ul> <p>2020-10-05</p> <p>Features:</p> <ul> <li>Board Search<ul> <li>Increase visibility of filters</li> <li>Maintain filters after page reload</li> <li>Hide Completed Todos</li> <li>Hide Empty Lists</li> </ul> </li> <li>Preview Files, support for<ul> <li>Excel (xlsx, xls)</li> <li>PDF</li> </ul> </li> </ul> <p>Improvements:</p> <ul> <li>Rich Text Editor - allow indenting paragraphs</li> <li>Logging updates</li> <li>Activity Migration - add default link type</li> </ul> <p>Fixes:</p> <ul> <li>Default handling of links from migrated Activities</li> <li>User Avatar initials fallback</li> <li>Include current user as option in user licence search &amp; custom field person</li> </ul> <p>2020-09-18</p> <p>Features:</p> <ul> <li>New rich text editor with improved handling for<ul> <li>tables</li> <li>whitepace</li> <li>paste from office</li> <li>font, font size, font color</li> <li>file upload feedback</li> </ul> </li> <li>Search Board by Custom Fields (Text &amp; People)</li> <li>Search improvements - show sub-tasks when parent match filter</li> </ul> <p>Improvements:</p> <ul> <li>UI feedback for Chrome Incognito third-party security exception</li> <li>Microsoft Teams file preview</li> <li>Microsoft Teams file links</li> <li>Internal microservice communication (Note: this requires a new Helm Chart V2)</li> <li>Updated HCL Connections icon</li> </ul> <p>Fixes:</p> <ul> <li>Issue where page reloads constantly in Connections frame</li> <li>Outlook integration issue</li> <li>File Preview in Safari</li> <li>Board Properties toolbar 'more' menu</li> <li>API update for completing a task already completed</li> </ul> <p>2020-08-24</p> <p>Features:</p> <ul> <li>Live Board Tile views (my/public/groups)</li> <li>Export Board/Cards as CSV</li> <li>Upload multiple files at once</li> <li>Drag and drop multiple emails into an open card</li> <li>Link to Board/List/Card - copies a direct URL to clipboard</li> </ul> <p>Improvements:</p> <ul> <li>Performance (loading times)</li> <li>Use local font files (no external URLs)</li> <li>Focused people search results in Connections</li> <li>Previewing linked files has link to Connections file info</li> <li>Loading Community images</li> <li>Support nested comments imported from Activities</li> <li>Support pasting images in comments</li> <li>Support long board names in left sidenav</li> <li>Scroll members area in right sidenav when long</li> <li>Show summary numbers in Members dialog</li> <li>UI feedback while saving custom fields</li> <li>Cookie handling (SameSite)</li> <li>Firefox scrollbar styling</li> </ul> <p>Fixes:</p> <ul> <li>Saving of description on reload &amp; modal change</li> <li>Comment duplicate while saving</li> <li>Support non-english @mentions</li> <li>@mention overflow issue</li> <li>Recent boards in left sidenav</li> <li>Move and not open page crash issue</li> <li>Ordering of links in a card</li> <li>Sharing my private file with a public folder</li> <li>Previewing of linked Community files</li> <li>Activities imported with unknown user assignments</li> <li>Dragging color onto tiles</li> <li>Allow unassigning users who are no longer members</li> <li>Ordering issue on cards created using past</li> </ul> <p>2020-07-10</p> <p>Improvements:</p> <ul> <li>Activity Stream deep-linking to Community Boards</li> <li>Community Boards - open board links in fullpage</li> <li>Fix searching individual Activity imports</li> <li>Update individual Activity import grouping of top level entries</li> <li>Fix loading of some imported Activities</li> </ul> <p>Activity Migration:</p> <ul> <li>Support migration of Activity files with unicode &amp; whitespace characters in name</li> <li>Performance &amp; stability improvements (large activities &amp; filesets, rollback files on failure, extra logging, retry logic)</li> </ul> <p>2020-06-17</p> <p>Fixes:</p> <ul> <li>Show newly created comments in Todo view</li> <li>Support Activity URL redirects</li> <li>Community Boards loading issue</li> </ul> <p>Activity Migration:</p> <ul> <li>UI control options fix</li> <li>Support migration of Activity files with special characters in name</li> <li>Support for Activity links</li> <li>Protect against system tenant IDs '-Ignore-Organization-ID-' etc</li> <li>DB2 support for PEOPLEDB on secondary host</li> </ul> <p>2020-06-05</p> <p>Please see our Cloud blog</p> <p>Improvements:</p> <ul> <li>Loading performance</li> <li>Rendering performance</li> <li>Reduce size of application</li> <li>Node view UI refresh</li> </ul> <p>New Features:</p> <ul> <li>Card theme from uploaded images</li> <li>Preview uploaded files (images, docx, pdf, html etc)</li> <li>Todos Overview - filtering to selected Boards</li> <li>Drag and drop Email into Cards (ie from HCL Notes)</li> <li>Activity Stream Gadget for Boards - config updates required</li> <li>Multiple Assignment options for Cards</li> </ul> <p>Fixes:</p> <ul> <li>Email notifications for invited collaborators</li> </ul> <p>2020-04-09</p> <p>Fixes:</p> <ul> <li>Connections OAuth issue - missing scope</li> </ul> <p>2020-03-06</p> <p>Fixes:</p> <ul> <li>Updating cards permissions</li> <li>Boards list - show completed &amp; deleted</li> <li>individual import of Activity with emails</li> <li>member issue when moving card into new board</li> <li>Archived cards appear twice</li> <li>Powered by Huddo image</li> </ul> <p>Language support:</p> <pre><code>  \"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\"\n</code></pre>"},{"location":"boards/releases/","title":"Boards Self-Hosted Releases (change log)","text":""},{"location":"boards/releases/#how-to-upgrade","title":"How To Upgrade","text":"<p>Important - new image hosting</p> <p>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.</p> <p>Please use the appropriate update command with the latest helm chart. For example:</p> <ol> <li> <p>Huddo Boards in Kubernetes</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Component Pack (Activities Plus)</p> <p>Tip</p> <p>To upgrade from images in the Component Pack to images hosted by us please follow this guide.</p> <p>Danger</p> <p>New chart for Component Pack</p> <p>As of <code>huddo-boards-cp-1.0.0.tgz</code> we have changed the Minio pods to run as <code>user 1000</code> instead of <code>root</code>. You must perform the following command on the shared drive (<code>/pv-connections</code> file system) before using this new chart. The change is backwards compatible.</p> <pre><code>cd /pv-connections/kudos-boards-minio/\nchown 1000:1000 -R .\n</code></pre> <pre><code>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\n</code></pre> </li> </ol>"},{"location":"boards/releases/#releases","title":"Releases","text":"<p>Note</p> <p>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.</p>"},{"location":"boards/releases/#2024","title":"2024","text":""},{"location":"boards/releases/#2024-05-27","title":"2024-05-27","text":"<p>Features:</p> <ul> <li>Drag and drop of cards between browser tabs/windows</li> <li>Drag and drop bookmarks into Board lists/cards</li> </ul> <p>Activity Migration:</p> <ul> <li>MSSQL: Support for authentication per database</li> </ul>"},{"location":"boards/releases/#2024-05-17","title":"2024-05-17","text":""},{"location":"boards/releases/#hcl-dx","title":"HCL DX","text":"<p>As announced at Engage 2024 - Huddo Boards for HCL Digital Experience (DX). Learn more.</p> <p>Features:</p> <ul> <li>Card and Board recent updates feed - filter to show all or comments/updates only</li> </ul> <p>Improvements:</p> <ul> <li>add a permanent but closable info level toast when board is read-only</li> <li>update rich text editor to latest version</li> <li>card details view improvements<ul> <li>show card fields/data in defined sections in a grid formation with headings and add buttons</li> <li>change \"add a comment\" action to start as a button</li> </ul> </li> <li>tooltips on date picker</li> <li>add invalid date error message</li> <li>primary session expired message - show as info alert</li> <li>tab color and style improvements</li> <li>more consistent use of primary/secondary action colours on buttons</li> <li>no collapse for empty lists activity todo pivot views</li> <li>auto collapse empty lists initially and after a card is dragged out of them</li> <li>New Board Wizard - more specific label for board name and template name</li> <li> <p>Activity view improvements</p> <ul> <li>styling (shadows, spacing, border edges when expanded/collapsed)</li> <li>drop cards on list header (highlight like shadow)</li> <li>add card at top hides the bottom add card</li> </ul> </li> <li> <p>Usability:</p> <ul> <li>Timeline: add zoom -+ controls that increment zoom levels</li> <li> <p>Mindmap accessibility</p> <ul> <li>1st tab selects board node, allow arrow key nav, and tab to access actions from there</li> <li>sidebar controls - use mui checkboxes + ensure hover effects on buttons</li> <li>clear node selection on escape keypress</li> <li>fix text cutoff/ensure ellipsis on longer node titles</li> <li>add help link to sidebar</li> <li>allow keyboard pan and zoom using shift+arrow and +- keys</li> </ul> </li> <li> <p>add contact support button to error catch page</p> </li> <li>add severity levels when showing toasts, fade transition</li> <li>ensure board creator is displayed as a non-editable owner on board/template creation</li> <li>ensure board tile labels are sorted in selection menu</li> <li>make 'Recent' heading in sidebar look less like other actionable items</li> <li>use delete icon (bin) for remove actions for member tiles, dates, tags, and board tile labels</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Board tile label delete - ensure tile label is deleted from the label object in store</li> <li>update material-ui libraries to fix date picker display issues on small screens</li> <li>ensure card header theme displays correctly when card is opened via direct link</li> <li>minor styling fix for dependencies section on a node</li> <li>board/activity lists - more precise and consistent footer spacing/padding</li> <li>create card and add comment actions - ensure entered text persists on unfocus + other focus related fixes</li> <li>issue with exporting a board in Teams client</li> <li>date picker error on mobile/touch devices</li> <li>issue with format of dates in date picker</li> <li>issues in list header title - not full width, no-wrap ellipsis, use correct cursors</li> <li>don't show grab cursor on lists in todos / pivoted views</li> <li>issue saving tags when creating new template</li> <li>ensure tags are copied from template/source</li> <li> <p>Accessibility fixes:</p> <ul> <li>Focus highlighting overrides</li> <li>use focus outline rather than background colour</li> <li>Fix for keyboard access to CreateCard app clear buttons to choose board/list</li> <li>MenuHelper.jsx - pass the disabled prop to the button</li> <li>position of assign members menu</li> <li>better focus styling for add board tile button</li> <li>better contrast when focusing on boards logo</li> <li>board tiles sort dropdowns - use defined focus bg and colours</li> <li>minor fixes for focused input controls</li> </ul> </li> </ul> <p>Activity Migration:</p> <ul> <li>Support custom DB names in MSSQL</li> </ul>"},{"location":"boards/releases/#2024-04-03","title":"2024-04-03","text":"<p>Features:</p> <ul> <li> <p>Emoji reactions on comments</p> <ul> <li> <p>Quick selection</p> <p></p> </li> <li> <p>Picker</p> <p></p> </li> </ul> </li> <li> <p>Micro Apps</p> <ul> <li>My Next Tasks Summary</li> <li>My Next Tasks</li> </ul> </li> </ul> <p>API Documentation:</p> <ul> <li><code>/todos/next</code></li> <li><code>/todos/summary</code></li> <li><code>/board/{boardId}/labels</code></li> <li><code>/board/labels</code></li> <li><code>/user/auth/{provider}/{externalId}/apitoken</code></li> </ul> <p>Improvements:</p> <ul> <li>Streamlined <code>/todos/assigned</code> &amp; <code>/todos/created</code> API, separating out the Board labels to <code>/board/labels</code> &amp; <code>/board/{boardId}/labels</code> endpoints</li> <li>Loading feedback when creating a board</li> <li>Editing of comments on mobile (focus at end of text, save/cancel buttons)</li> <li>Loading feedback of recent boards sidebar</li> <li>Card link opening behavious (links to other boards open in same tab)</li> <li>Teams board links open tabs</li> <li>Show loading spinner while waiting on clicked link to open in a teams tab</li> <li>Add copy/paste list option in list menu</li> <li>Add duplication list option in list menu</li> <li>More comprehensive history feed details for moving or reordering cards</li> </ul> <p>Fixes:</p> <ul> <li>Create board from template when opened and only a reader</li> <li>Creating Board in group restricts to the group's Organisation</li> <li>Better handling of authentication when provider session changes user account</li> <li>Visibility of 'Embed Link' when viewing Boards by Group</li> <li>Creation of Board in Group when using /group/{groupId} route (embedded)</li> <li>View cards in fullscreen on small screens</li> <li>Issue when deleting all Boards tile colors</li> <li>Links to card ancestors (Todo view)</li> <li>Prevent date selection incorrectly showing today when no date set</li> <li>Upload files to Teams private channel OneDrive</li> <li>Scroll to bottom of a list when creating a new card</li> <li>Delete action in card dialog / in archive view</li> <li>Add card section in a list delays retract/height change to prevent card drag issues</li> <li>Dragging empty colour labels in Firefox</li> <li>Filter/search by list name</li> <li>Unauthorised error when adding existing board as Teams tab</li> <li>Fix potential onEnter errors in rich text editor</li> <li>Prevent overflow on file preview</li> <li>Load board members on fullscreen list view (for @mentions)</li> <li>Fix potential onBlur errors in rich text editor</li> <li>Don't show iCalendar feed options in Teams</li> </ul> <p>Activity Migration:</p> <ul> <li>Security updates</li> <li> <p>Oracle DB</p> <ul> <li>Update to use new v6 thin client</li> <li>allow different credentials for PEOPLEDB</li> </ul> </li> <li> <p>MSSQL</p> <ul> <li>Update to v10</li> <li>allow self-signed certificates with CONNECTIONS_DB_OPTIONS variable</li> </ul> </li> </ul>"},{"location":"boards/releases/#2024-02-14","title":"2024-02-14","text":"<p>Fixes:</p> <ul> <li>Connections SSO header scripts - Notifications panel</li> <li>Missing translations caused by load race condition</li> <li>Translation of timeline months headers</li> </ul>"},{"location":"boards/releases/#2024-02-07","title":"2024-02-07","text":"<p>Fixes:</p> <ul> <li>Issue with Board Content Admin on Mongo v3</li> <li>Microsoft Teams private channels<ul> <li>Link to File will now show the private channel's files.</li> <li>Owner/Author access level was setting all members to Author.</li> </ul> </li> <li>Microsoft Teams Mobile: Removed licence related cards in org admin view.</li> <li>Microsoft Teams: Removed obsolete \"Disable Notifications\" button.</li> <li>Rich text editor dialog - allow scroll on overflow</li> <li>Use SMTP email address before using Exchange address when parsing email attachments</li> <li>Don't show organisation admin links from Boards sidebar menu in Teams on a mobile device</li> <li>Activity view scrolling issue</li> </ul>"},{"location":"boards/releases/#2024-01-16","title":"2024-01-16","text":"<p>Improvements:</p> <ul> <li> <p>Microsoft Teams integrations</p> <ul> <li>UI redesign when adding new Boards tab</li> <li>Onboarding Tours</li> </ul> </li> <li> <p>faster opening of cards</p> </li> <li>allow clicking links in description when content locked for editing</li> <li>allow reordering private cards</li> <li>US English updates</li> <li>organisation plan loading feedback</li> </ul> <p>Fixes:</p> <ul> <li>issue loading licence caused by race condition in Licence service startup</li> <li>issue where completing a new task showed incorrect icon</li> <li>issue where Board content deleted when hovered and press Ctrl+Alt+Delete</li> <li>issue when opening a card by link, then a subcard within that card</li> <li>issue when reordering cards with filtered (hidden) content</li> <li>visibility of card title in header breadcrumb (Component Pack)</li> <li>RichText saving when used @symbol (but not an @mention)</li> <li>@mentions keyboard navigation improvements (home/end, up to bottom, down back to top), escape without closing modal</li> <li>@mentions only considered new on first save</li> <li>issue where mentions popup partially hidden at top</li> <li>issue where could not mention users when opening a card directly by link</li> <li>hide private cards when viewing board by assignments</li> <li>create card from Outlook/Verse - fix toggle of attach body, ordering of recent boards</li> <li>drag dependency links in Firefox</li> </ul>"},{"location":"boards/releases/#2023","title":"2023","text":""},{"location":"boards/releases/#2023-12-18","title":"2023-12-18","text":"<p>Feature:</p> <ul> <li>Drag emails from Outlook to create as card</li> <li>Support for latest MongoDB (v7)</li> <li>API documentation for /user/{userId}, /user/group/{groupId} etc</li> </ul> <p>Improvements:</p> <ul> <li>Accessibility (keyboard navigation - colors/members dialog, aria-labels, popover, html.lang attribute, improved roles, aria-selected, aria-expanded, hover/focus on cards)</li> <li>Drag email to card - attach .eml and .msg file</li> <li>Positioning of unscheduled cards in Timeline</li> <li>Improved document titles based on context</li> <li>Smoother drag scroll on Kanban</li> <li>Ensure grab cursor for Kanban drag scroll</li> <li>Update childcounts in activity lists when filtering</li> <li>Visibility of selected board filters</li> <li>Searching for a board includes the description</li> </ul> <p>Fixes:</p> <ul> <li>Card label overflow issue when 5 lines</li> <li>Issue where comment events sent to mentioned users</li> <li>Link to File dialog options</li> <li>Issue saving card name when editing it directly on the card</li> <li>Issue when focusing on boards search input</li> </ul>"},{"location":"boards/releases/#2023-11-30","title":"2023-11-30","text":"<p>Features:</p> <ul> <li> <p>Support for Domino by REST API</p> <p>Tip</p> <p>Please follow this guide to migrate from your existing Proton based Domino authentication</p> </li> </ul> <p>Improvements:</p> <ul> <li>Minor accessibility improvement - add aria-labels</li> <li>Security updates (Node v20)</li> <li>allow running webfront pods as random user id</li> </ul> <p>Fixes:</p> <ul> <li>Fix template description not showing in new board wizard</li> <li>Debounce User/Group searching</li> <li>Issue where menu buttons in the open card view were not overflowing to the 'more' menu correctly and causing a flickering effect</li> <li>Issue where lists in board view could not easily be dragged to re-order</li> <li>Issue with board title button long text overflowing</li> <li>Issue with card background images</li> </ul>"},{"location":"boards/releases/#2023-11-14","title":"2023-11-14","text":"<p>Improvements:</p> <ul> <li> <p>Accessibility</p> <ul> <li>more consistent tooltips (for screen readers and better explanation of functionality)</li> <li>Keyboard navigation (particularly in the Board Tiles, Kanban view, Card dialog) - (vision &amp; motor impaired)</li> <li>better screen reader information (vision impaired)</li> <li>improved colour contrast (low vision users)</li> </ul> </li> <li> <p>API for Member deletion</p> </li> <li>Support Keycloak v22 custom path</li> </ul> <p>Fixes:</p> <ul> <li>Email for mentions missing fields</li> </ul>"},{"location":"boards/releases/#2023-10-31","title":"2023-10-31","text":"<p>Improvements:</p> <ul> <li>Translations (German and English US)</li> <li>Use https protocol for iCal feed instead of webcals</li> <li>Hide unusable Colors button when read-only access when sidebar collapsed</li> <li>Consistency of Board colour feature naming</li> </ul> <p>Fixes:</p> <ul> <li>Issue where iCal feed dates off by 1 due to timezone differences</li> <li>Issue where page blank in Firefox when loading with Connections 7 header via SSO</li> </ul>"},{"location":"boards/releases/#2023-10-25","title":"2023-10-25","text":"<p>Danger</p> <p>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</p> <p>Features</p> <ul> <li>Board iCalendar feed</li> <li>Personal iCalendar feed</li> </ul> <p>Improvements:</p> <ul> <li>Show Member/Labels buttons in collapsed sidebar</li> <li>Added translations to missing access role fields</li> <li>loading of Board task stats on tiles as required</li> <li>performance of loading My Boards</li> <li>redirect in place for expired session of Collab/Connections with SSO header</li> </ul> <p>Fixes:</p> <ul> <li>Connections Header about.jsp issue for older environments (regression in 2023-10-17)</li> <li>Issue where page crashed when reloaded page with Card open, then opening member dialog</li> </ul>"},{"location":"boards/releases/#2023-10-17","title":"2023-10-17","text":"<p>Improvements:</p> <ul> <li>updated German translations (UI and emails)</li> <li>expired session handling when using SSO</li> </ul> <p>Fixes:</p> <ul> <li>showing CNX8 notification action center in sidebar</li> <li>pasting image in rich text field (desciption and comments)</li> <li>support SafeLinx cookie auth on manifest.json</li> <li>issue where dependencies change view after deletion</li> <li>allow assigned author to assign/unassign</li> </ul> <p>KNOWN ISSUE</p> <ul> <li>Connections Header loading via SSO loading in older environments (eg CNX7)</li> </ul>"},{"location":"boards/releases/#2023-09-14","title":"2023-09-14","text":""},{"location":"boards/releases/#mongo-schema-migrations","title":"Mongo schema migrations","text":"<p>Danger</p> <p>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.</p> <p>Features:</p> <ul> <li>Organisation content administration &amp; membership management</li> <li>Labels pivot view for Board and Activity views</li> <li>Pasting URLs into description and comments automatically converted to clickable link</li> </ul> <p>Improvements:</p> <ul> <li>support HCL Connections 8 CR3 style changes</li> <li> <p>API performance (faster response, less data) of the</p> <ul> <li>'My/Public Boards' data</li> <li>cards in a Board</li> </ul> </li> <li> <p>Users with the author role now have full edit access on cards that are assigned to them (rather than complete and comment access only)</p> </li> <li>consistency of sidebar icon positioning when collapsed/expanded</li> </ul> <p>Fixes:</p> <ul> <li>public member creation when creating Board</li> <li>issues in dependency arrow positioning</li> <li>auto reschedule dependencies when dates change</li> <li>selecting the same file to upload after cancelling</li> <li>expand/collapse lists when pivoted by dates/assignment</li> <li>Ensure assignments are duplicated when copying and pasting tasks</li> <li>Prevent cards from being moved to another list at the same time they are archived by dragging to the archive button</li> <li>Ensure the current user has the correct actions available according to their board role when opening cards from the My Todos view</li> <li>Drag &amp; Drop from rich email clients onto a list</li> <li>Activity list missing action menu</li> </ul>"},{"location":"boards/releases/#2023-07-04","title":"2023-07-04","text":"<p>Improvements:</p> <ul> <li>Readers can now select text in descriptions</li> <li>General reader experience</li> <li>Improved author experience - restrict to allowed actions</li> <li>Board title/board options button - styling and usability improvements</li> <li>Current member role now highlighted in members dialog and links added to member permissions documentation</li> <li>Improved randomisation and readability of Assignment Role colours</li> <li>Added tooltips to Assignment Role avatars</li> <li> <p>Microsoft Teams</p> <ul> <li>detect members in private sub channels (OAuth Admin consent must be certified again)</li> <li>fix for creating Board in private sub channels</li> <li>loading spinner positioning</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Connections 8 styling fixes (support banner and nav customisations)</li> <li>Fixed coloured role borders when assigning member roles</li> <li>Fix URLs pointing to old docs pages</li> <li>Issue detecting highest licence when multiple</li> <li>Minor fixes to Welcome and Plan Selection dialogs</li> <li>Template role assignment on touch devices</li> <li>Assignments to non-primary aliases</li> </ul>"},{"location":"boards/releases/#2023-06-22","title":"2023-06-22","text":""},{"location":"boards/releases/#mongo-schema-migrations_1","title":"Mongo schema migrations","text":"<p>Danger</p> <p>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.</p> <p>Features:</p> <ul> <li>Template Rescheduling</li> <li>Template Roles</li> <li>Custom Colours - colours and tags have been merged. You are now able to create as many colours as you like in a Board.</li> <li>Button to assign all sub-tasks as dependencies of parent</li> <li>Drag &amp; Drop assignments from parent to sub-cards in modal</li> <li>Drag card to archive</li> </ul> <p>Improvements:</p> <ul> <li>Readers no longer see actions they cannot perform</li> <li>Outlook attachments using plugin</li> <li>Copy/Paste functionality (buttons &amp; menu items)</li> <li>UI for member adding on Mobile</li> <li>Timeline card title always visible</li> <li>Auto-move dependency parent</li> <li>Expand all in activity view</li> <li>Hide edit options on archived card</li> <li>Localised format of dates in CSV export</li> <li>Cards can be Archived+Deleted from the card modal toolbar.</li> <li> <p>Drag and drop of lists</p> <ul> <li>drag by header</li> <li>fix blank list when scrolled and dragged</li> <li>prevent scrolling of list in drag mode</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Styling of ITM sidebar in Connections 8 CR1/CR2</li> <li>Connections 8 integrations when Boards on different domain</li> <li>Getting members from private sub-channels (teams)</li> <li>Attachments are moved in child nodes when the parent is moved</li> <li>Updated attachments to correctly show when their parent had been moved</li> <li>Kanban Printing</li> <li>Timeline calendar shifting when opening a card</li> <li>Removed Connections community members not removed from Board membership</li> <li>Dragging card from assigned user created user image as card</li> <li>Sending duplicate due date reminders</li> <li> <p>Card drag and drop</p> <ul> <li>issue where a duplicate card appears when drag to end</li> <li>issue where card jumps back to top when dragging a card to end of same list</li> </ul> </li> <li> <p>Issue with exporting Board as CSV with special characters (e.g. Umlaut)</p> </li> <li>German translations with extra '}' character</li> </ul>"},{"location":"boards/releases/#2023-05-12","title":"2023-05-12","text":"<p>Fixes:</p> <ul> <li>Security issue affecting external users and public communities</li> </ul>"},{"location":"boards/releases/#2023-01-24","title":"2023-01-24","text":"<p>Improvements:</p> <ul> <li>Handling of default profile images in Connections</li> <li>Detect language from Connections dropdown</li> </ul> <p>Fixes:</p> <ul> <li>Styling for HCL Connections 8 'Important-to-Me' sidebar</li> <li>Handling of licence with new organisation in store</li> </ul>"},{"location":"boards/releases/#2023-01-17","title":"2023-01-17","text":"<p>Improvements:</p> <ul> <li>Styling for HCL Connections 8 new UI</li> </ul>"},{"location":"boards/releases/#2023-01-03","title":"2023-01-03","text":"<p>Improvements:</p> <ul> <li>Security updates (node 18)</li> </ul> <p>Fixes:</p> <ul> <li>Issue with blank page served on <code>/boards</code></li> </ul>"},{"location":"boards/releases/#archive","title":"Archive","text":"<p>For release history before 2023 please see here.</p>"},{"location":"boards/security/","title":"Boards Cloud Security","text":""},{"location":"boards/security/#how-does-an-end-user-login-to-boards","title":"How does an end user login to Boards?","text":"<ul> <li>Users login by authenticating via OAuth 2.0 with Connections Cloud, Office365, Facebook, Google, LinkedIn, Connections on-premise or Auth0.</li> <li>This starts a token-based session with Boards Cloud used to authenticates all future requests.</li> </ul>"},{"location":"boards/security/#what-kind-of-provider-connections-cloud-office365-etc-data-will-be-stored-by-boards-cloud","title":"What kind of Provider (Connections Cloud, Office365 etc) data will be stored by Boards Cloud?","text":"<ul> <li>Basic user profile data (display name, email, subscriberId, customerId)</li> <li>User/community photo</li> <li>Community/Space name and members</li> <li>Links to Files</li> <li>Clone of Connections Activities data after imported by the user</li> </ul>"},{"location":"boards/security/#what-is-the-security-of-data-in-motion","title":"What is the security of data in motion?","text":""},{"location":"boards/security/#requests-between-the-user-and-boards-cloud-servers-are-secured-by","title":"Requests between the User and Boards Cloud servers are secured by:","text":"<ul> <li>Encrypted by HTTPS (SSL)</li> <li>Authenticated using both</li> <li>token-based sessions for all API data</li> <li>cookie-based session for all images</li> </ul>"},{"location":"boards/security/#requests-between-boards-cloud-servers-and-mongo-database-are-secured-by","title":"Requests between Boards Cloud servers and Mongo database are secured by:","text":"<ul> <li>Encrypted by HTTPS (SSL)</li> <li>Authenticated using username/password</li> <li>IP whitelisting</li> </ul>"},{"location":"boards/security/#requests-between-boards-cloud-servers-and-google-cloud-s3-object-storage-are-secured-by","title":"Requests between Boards Cloud servers and Google Cloud S3 Object Storage are secured by:","text":"<ul> <li>Encrypted by HTTPS (SSL)</li> <li>Authenticated using username/password</li> <li>Internal Google network - data is not communicated over the public internet</li> </ul>"},{"location":"boards/security/#requests-between-boards-cloud-servers-and-providers-connections-office365-etc-are-secured-by","title":"Requests between Boards Cloud servers and providers (Connections, Office365 etc) are secured by:","text":"<ul> <li>Encrypted by HTTPS (SSL)</li> <li>Authenticated using OAuth2 access tokens</li> </ul>"},{"location":"boards/security/#other-remarks","title":"Other remarks:","text":"<ul> <li>Boards Cloud is hosted by Google Cloud in the EU West region</li> <li>CSRF is not a threat as all our APIs are strictly JSON and we don't support CORS.</li> <li>We use token based express-sessions and helmetJS for express to provide additional security around XSS, framing, and sessions. Tokens are JWT encoded with secret keys.</li> <li>SQL injection is not relevant as we are not using any SQL dbs.</li> <li>We use Content-Security-Policy headers to limit framing to only be self and Connections Cloud to prevent clickjacking</li> <li>We add X-Content-Type header 'nosniff' to prevent Content sniffing</li> <li>We use a standard REST API pattern. Entity IDs are passed as URL params where applicable for all http requests (GET, POST, PUT, DELETE). No actual data is passed as URL params or query params.</li> </ul>"},{"location":"boards/security/#what-is-the-security-of-data-at-rest","title":"What is the security of data at rest?","text":"<p>Most 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.</p>"},{"location":"boards/security/#mongodb-atlas-is-secured-by","title":"MongoDB Atlas is secured by:","text":"<ul> <li>Two Factor Authentication</li> <li>IP Whitelist</li> <li>Encryption at rest - AWS Key Management Service (AWS KMS) to encrypt storage engines and cloud provider backups</li> <li>Each MongoDB Atlas group is provisioned into its own VPC, thus isolating your data and underlying systems from other MongoDB Atlas users</li> <li>Network encryption and access control</li> <li>All security-specific updates to the operating system and database of the underlying instances are automatically applied by MongoDB engineers.</li> <li>MongoDB, Inc. is also certified under the EU-US Privacy Shield.</li> <li>More information about MongoDB Cloud Services Compliance and Privacy can be obtained here</li> </ul>"},{"location":"boards/security/#google-cloud-object-storage-is-secured-by","title":"Google Cloud Object storage is secured by:","text":"<ul> <li>No external access other than our server</li> <li>S3 standard token/secret authentication</li> <li>Encrypted by HTTPS (SSL)</li> </ul>"},{"location":"boards/security/#are-there-any-passwords-saved-by-boards-cloud","title":"Are there any passwords saved by Boards Cloud?","text":"<p>There are NO passwords stored by the app.</p>"},{"location":"boards/tours/","title":"Tours","text":""},{"location":"boards/tours/#boards-tours","title":"Boards Tours","text":"<p>You can create your own tours by calling the <code>boards.setTours()</code> function in console.</p> <p>Open dev tools with <code>Cmd-Shift-I</code> or <code>Ctrl-Shift-I</code> then got to the console tab</p> <p>Tours are currently disabled by default, to enable them type <code>boards.enableTours()</code> then press Enter, now reload your page and the tours will be available.</p>"},{"location":"boards/tours/#tour-definition","title":"Tour Definition","text":"Field Description required id unique identifier yes routes the URLs which make the tour applicable (* is a wildcard) yes sizes Supported screen sizes no disabled Disables this tour no disableAnimation Disables animation for this tour no steps the parts of the tour to step through yes"},{"location":"boards/tours/#step-definition","title":"Step Definition","text":"Field Description required spotlight query selector identifying the element on the page to highlight yes when query selector looking for an element on the page, when the element is present we will automatically move to this step no title tour popup title yes body the paragraphs to show below that yes actions any urls to link to no placement defines where to place the tour step in relation to the spotlighted element no hideArrow hides the arrow pointing to the spotlighted element no"},{"location":"boards/tours/#placement-options","title":"Placement options","text":"<ul> <li>top, top-start, top-end</li> <li>bottom, bottom-start, bottom-end</li> <li>left, left-start, left-end</li> <li>right, right-start, right-end</li> <li>auto (it will choose the best position)</li> <li>center (set the target to body)</li> </ul>"},{"location":"boards/tours/#full-example","title":"Full example","text":"<pre><code>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}])\n</code></pre>"},{"location":"boards/admin/content-member-management/","title":"Boards Content and Member Management","text":"<p>Organisation 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</p> <ul> <li> <p>a) Boards Cloud</p> <p>On the Huddo Boards homepage / My Boards page, click your organisation on the left sidebar, then click the <code>Boards</code> tab to view the list of boards:</p> <p></p> </li> <li> <p>b) Boards On-Premise</p> <p>Open <code>Admin Settings</code>, then your organisation</p> <p></p> <p>Under <code>Content management</code> click <code>Boards</code></p> <p></p> </li> </ul>"},{"location":"boards/admin/content-member-management/#sorting","title":"Sorting","text":"<p>The boards data can be sorted by clicking on the column headers:</p> <p></p>"},{"location":"boards/admin/content-member-management/#searching","title":"Searching","text":"<p>Boards can be searched by board name or by owner.</p> <p>Click the search icon to the left of the column name to search:</p> <p></p>"},{"location":"boards/admin/content-member-management/#by-board-name","title":"By Board Name","text":"<p>Type a board name to filter the results:</p> <p></p>"},{"location":"boards/admin/content-member-management/#by-owner","title":"By Owner","text":"<p>Search for a group or user and then select an entity to show only boards that have that owner:</p> <p></p>"},{"location":"boards/admin/content-member-management/#showhide-archived-boards","title":"Show/hide archived boards","text":"<p>Archived boards can be shown or hidden by using the switch in the <code>Archived</code> column header:</p> <p></p>"},{"location":"boards/admin/content-member-management/#edit-members-of-a-board","title":"Edit members of a board","text":"<p>Members for each individual board can be viewed and modified by clicking the <code>Edit Members</code> button on the right of the board row:</p> <p></p> <p></p>"},{"location":"boards/admin/content-member-management/#selected-board-options","title":"Selected board options","text":"<p>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:</p> <p></p>"},{"location":"boards/admin/content-member-management/#archive","title":"Archive","text":"<p>Archive the selected boards.</p>"},{"location":"boards/admin/content-member-management/#restore","title":"Restore","text":"<p>Restore boards that are archived.</p>"},{"location":"boards/admin/content-member-management/#manage-ownership","title":"Manage Ownership","text":"<p>This action will show a dialog allowing new owners to be added and/or existing owners removed from the boards that are selected:</p> <p></p>"},{"location":"boards/admin/content-member-management/#delete","title":"Delete","text":"<p>Danger</p> <p>Use this action cautiously and at your own risk.</p> <p>Delete the selected boards and all their data permanently.</p> <p></p>"},{"location":"boards/admin/content-member-management/#find-and-replace-owner-on-all-boards","title":"Find and replace owner on all boards","text":"<p>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:</p> <ol> <li> <p>Click the <code>Find and replace owner on all boards</code> button to bring up a dialog:</p> <p></p> </li> <li> <p>Search for and select the current owner to replace and the new/replacement owner. Groups can be selected:</p> <p></p> </li> <li> <p>Click the <code>Replace Owner</code> button to confirm the owner replacement:</p> <p></p> <p>Note</p> <p>an undo action will temporarily appear at the bottom left of screen if you wish to cancel this action</p> </li> </ol>"},{"location":"boards/admin/deactivate-login/","title":"Deactivate Login","text":""},{"location":"boards/admin/deactivate-login/#process","title":"Process","text":"<ol> <li> <p>Remove OAuth ClientID from user.env</p> <p>Comment out the CLIENT_ID for the provider to be deactivated:</p> <pre><code>user:\n  env:\n    # CONNECTIONS_CLIENT_ID\n    # MSGRAPH_CLIENT_ID\n</code></pre> </li> <li> <p>Redeploy the Helm chart</p> <p>For example:</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Reload webpage</p> <p>The login option should be removed</p> </li> </ol>"},{"location":"boards/admin/link-users/","title":"Link User Accounts","text":"<p>Note: admins only - on premise</p> <p>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).</p>"},{"location":"boards/admin/link-users/#prerequisites","title":"Prerequisites","text":"<ol> <li> <p>Profiles are synchronised</p> <p>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</p> </li> </ol>"},{"location":"boards/admin/link-users/#important-notes","title":"Important Notes","text":"<ul> <li>Please be aware that if you intend to remove login then the primary ID should be set as the ID for your intended login client (ie Microsoft), and the secondary that of the login method you to plan to remove (eg Connections). These IDs are visible in the URL of the admin page visited in the profile linking step.</li> <li>Accounts are matched on email address</li> <li>The process is run immediately on the next deployment of the <code>user</code> microservice</li> <li>Only run one replica to avoid conflicts, hence <code>replicaCount: 1</code></li> <li> <p>You can view the logs of the user service to see an output of changes </p> <ul> <li>users who were found in both clients</li> <li>users who could not be matched by their email prefix</li> <li>users who are already linked</li> <li>users who have been linked as a result of the command</li> </ul> </li> <li> <p>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.</p> </li> </ul>"},{"location":"boards/admin/link-users/#process","title":"Process","text":"<ol> <li> <p>Environment variables</p> <p>This process links users in 2 difference clients.  We utilise environment variables to initialise the process, e.g.</p> <pre><code>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 &amp; jsmith@isw.net.au\n    # PROFILE_LINK_EMAIL_PREFIX_ONLY: true\n</code></pre> </li> <li> <p>Redeploy the Helm chart</p> <p>For example:</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Review the logs</p> <p>The logs should output in this format. Note the users who have been <code>updated</code>/<code>ignored</code>. On subsequent runs the people in <code>updated</code> will appear in <code>noChange</code> instead.</p> <p></p> </li> <li> <p>Remove Environment variables above and redeploy the Helm chart</p> </li> </ol>"},{"location":"boards/admin/manage-licences/","title":"Manage Licences","text":""},{"location":"boards/admin/manage-licences/#manage-licences","title":"Manage Licences","text":"<p>Licence management is available at an organisation level for Huddo Boards.</p> <p>To access these settings, sign in to Huddo Boards as an administrator of your organisation. Click your profile image and then <code>Admin Settings</code>:</p> <p></p> <p>The licence(s) for your org will be shown, each one can be opened for more information.</p> <p></p> <p>Here you can see all the users who have been assigned a licence.</p> <p>'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.</p> <p></p> <p>Note that Org Configs are created automatically for all orgs with default settings.</p>"},{"location":"boards/admin/manage-licences/#buy-huddo-boards-via-admin-settings","title":"Buy Huddo Boards via Admin Settings","text":"<p>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.</p> <p>Navigate to <code>Admin Settings</code> and then select to 'Buy Online'.</p> <ul> <li>Specify your type of licence - Named Users Licence or Open Licences.</li> <li>Select your billing preference - Monthly or Annually (note: annual subscriptions include a 15% discount)</li> <li>Quantity of licences to purchase</li> <li>Review your order summary, agree to the terms and conditions and select Continue, to move to the online check out.</li> </ul> <p> </p> <p>Your subscription will be updated automatically.</p>"},{"location":"boards/admin/manage-licences/#buy-huddo-boards-via-microsoft-teams","title":"Buy Huddo Boards via Microsoft Teams","text":"<p>As an O365 administrator, you can buy Huddo Boards for your organisation via Microsoft Teams.</p> <p>Navigate to Huddo Boards MyBoards Dashboard via More Added Apps in Microsoft Teams and under your profile image locate <code>Admin Settings.</code></p> <p></p> <p>Click Organisation to see your org details.</p> <p></p> <p>Under 'Licences' select to 'Buy Online.'</p> <p></p> <ul> <li>Specify your type of licence - Named Users Licence or Open Licences.</li> <li>Select your billing preference - Monthly or Annually (note: annual subscriptions include a 15% discount)</li> <li>Quantity of licences to purchase</li> <li>Review your order summary, agree to the terms and conditions and select Continue, to move to the online check out.</li> </ul> <p></p>"},{"location":"boards/admin/manage-licences/#request-a-quote-or-invoice-for-payment","title":"Request a Quote or Invoice for Payment","text":"<p>On-premise Huddo Boards installs can contact us for quote requests and licence activation keys at <code>hello@huddo.com</code></p> <p>Huddo Boards cloud users can request a quote via Huddo Boards Admin Settings in web or Microsoft Teams, or via email at <code>hello@huddo.com</code>. Please do not hesitate to ask questions or request a call to discuss your subscription requirements further.</p> <p>In addition to online check out, we can receive purchase orders and provide invoices for payment.</p> <p>Pricing can be found here https://www.huddo.com/pricing</p>"},{"location":"boards/admin/org-config/","title":"Manage Config","text":""},{"location":"boards/admin/org-config/#manage-organisation-config","title":"Manage Organisation Config","text":"<p>Configuration options are available at an organisation level for Huddo Boards. Changing these settings will affect all Huddo Boards users in your organisation.</p> <p>To access these settings, sign in to Huddo Boards as an administrator of your organisation. Click your profile image and then <code>Admin Settings</code>:</p> <p></p> <p>The config for your org will be shown, hover on the info (i) icons for more information on each setting</p> <p></p> <p>Changing a setting will immediately save/update the Org Config for all users.</p> <p>Note: Org Configs are created automatically for all orgs with default settings.</p>"},{"location":"boards/admin/replace-group-membership/","title":"Replacing Group Membership","text":"<p>Note: admins only - on premise</p> <p>This service is designed to replace Board memberships for groups in one login client with replacement groups in another login client.</p> <p>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.</p>"},{"location":"boards/admin/replace-group-membership/#important-notes","title":"Important Notes","text":"<ul> <li>Please be aware that the <code>target</code> ID below should be set as the ID for your intended login method (ie Microsoft), and the <code>source</code> that of the login method being removed (ie Connections). These IDs are visible in the URL of the admin page.</li> <li>The process is run immediately on the next deployment of the boards app.</li> <li>Only run one replica to avoid conflicts, hence <code>replicaCount: 1</code></li> <li>You can view the logs of the <code>boards-app</code> microservice to see an output of changes to source/target groups</li> <li>The command is safe to run multiple times. There will be no new changes unless more group memberships have been imported into the Boards DB.</li> </ul>"},{"location":"boards/admin/replace-group-membership/#prerequisites","title":"Prerequisites","text":"<p>You have created replacement groups in the target system and have records of the old ID to the new ID.</p>"},{"location":"boards/admin/replace-group-membership/#process","title":"Process","text":"<ol> <li> <p>Create CSV Map File</p> <p>This process utilises a CSV file to define a map between the old ID and new ID, in the format:</p> <pre><code>&lt;NAME_OF_GROUP&gt;,&lt;COMMUNITY_ID&gt;,&lt;SHAREPOINT_SITE_ID&gt;\n</code></pre> <p>For example:</p> <p><code>group-map.csv</code></p> <pre><code>Huddo Team,95bf5326-ee35-4e4a-b121-9b6970f86931,532fbe3d-239e-4421-b8c0-4c4d2eb87204\n</code></pre> </li> <li> <p>Secret with CSV</p> <p>Create a secret in the Boards namespace (ie boards) from your CSV file</p> <pre><code>kubectl create secret generic group-map-secret --from-file=./group-map.csv -n boards\n</code></pre> </li> <li> <p>Environment variables</p> <p>Set the following environment variables to mount the secret created above at a file path in the pod.</p> <pre><code>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\n</code></pre> </li> <li> <p>Redeploy the Helm chart</p> <p>For example:</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Review the logs</p> <p>The logs should output in this format. See that each group was mapped from a <code>Source</code> to a <code>Target</code> and how many <code>members</code>/<code>nodes</code> were updated with the new value.</p> <p></p> </li> <li> <p>Remove Environment variables above and redeploy the Helm chart</p> </li> </ol>"},{"location":"boards/admin/revoke-users/","title":"Revoke Users","text":"<p>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:</p> <ol> <li> <p>Open <code>Admin Settings</code>, then your <code>Organisation</code></p> <p></p> </li> <li> <p>Under <code>User management</code> click <code>Revoke</code></p> <p></p> </li> <li> <p>Select whether to <code>Anonymise the user name, email and image</code></p> <p></p> </li> <li> <p>Search and select the user to revoke, click <code>Revoke</code></p> <p></p> </li> </ol>"},{"location":"boards/admin/sync-profiles/","title":"Synchronise User Profiles","text":"<p>This process ensures that all users in your Connections/Microsoft accounts exist in the Boards database.</p> <p>Note: this is only necessary if you are linking user accounts in bulk</p>"},{"location":"boards/admin/sync-profiles/#connections","title":"Connections","text":"<p>You can now synchronise all user profiles from Connections by opening the <code>Admin =&gt; Org =&gt; Connections</code> client page (e.g. <code>/admin/5eeff4a3b7adaab62352362f/client/5fd6974dd7c5ede08711432d</code>) This service utilises the Connections Profiles Admin API which is only basic auth, so you need to add credentials for a user (eg <code>wasadmin</code>) who has the Admin role on the Profiles application.</p> <p></p>"},{"location":"boards/admin/sync-profiles/#microsoft","title":"Microsoft","text":"<p>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)</p> <p></p>"},{"location":"boards/admin/sync-profiles/#process","title":"Process","text":"<p>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.</p>"},{"location":"boards/admin/transfer-ownership-unlink/","title":"Transfer Ownership &amp; Unlink User Accounts","text":"<p>Note: admins only - on premise</p> <p>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. </p>"},{"location":"boards/admin/transfer-ownership-unlink/#important-notes","title":"Important Notes","text":"<ul> <li>Please be aware that the <code>to</code> client target ID below should be set as the ID for your intended login method (ie Microsoft), and the <code>from</code> that of the login method being removed (ie Connections). These IDs are visible in the URL of the admin page.</li> <li>The process is run immediately on the next deployment of the boards app.</li> <li>Only run one replica to avoid conflicts, hence <code>replicaCount: 1</code></li> <li>You can view the logs of the <code>boards-app</code> microservice to see an output of changes to source/target groups</li> <li>The command is safe to run multiple times. There will be no new changes unless more user accounts have been linked.</li> </ul>"},{"location":"boards/admin/transfer-ownership-unlink/#process","title":"Process","text":"<ol> <li> <p>Environment variables</p> <p>Set the following environment variables</p> <pre><code>app:\n  replicaCount: 1\n  env:\n    TRANSFER_AND_UNLINK_TO_CLIENT: 5fd6974dd7c5ede08711432d\n    TRANSFER_AND_UNLINK_FROM_CLIENT: 5ef2d52f6283afc12efd55a4\n</code></pre> </li> <li> <p>Redeploy the Helm chart</p> <p>For example:</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> </li> <li> <p>Review the logs</p> <p>The logs should output information in this format. Note each transfer of content ownership <code>from</code> =&gt; <code>to</code> and the number of associated nodes/members/invites that were updated, before the alias is unlinked from the primary.</p> <p></p> </li> <li> <p>Remove Environment variables above and redeploy the Helm chart</p> </li> </ol>"},{"location":"boards/admin/transition-between-providers/","title":"How To Transition between Providers","text":"<p>Note: admins only - on premise</p> <p>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.</p> <ol> <li>Backup the Boards mongo database</li> <li>Synchronise user profiles</li> <li>Link users accounts</li> <li>Replace group membership</li> <li>Transfer ownership &amp; unlink user accounts</li> <li>Deactivate login with original provider</li> </ol>"},{"location":"boards/admin/url-update/","title":"URL Update","text":""},{"location":"boards/admin/url-update/#update-content-urls-in-database","title":"Update content URLs in database","text":"<p>When the URL of the on-prem hosting environment changes, content stored in Huddo Boards may also need to be updated.</p> <p>The below will change all URLs in the names, descriptions and links for each node (card/board/comment). Replace both the <code>domain</code> and <code>newDomain</code> with your old and new URLs. The domain variable is a regular expression (regex) that needs the initial <code>/</code> and trailing <code>/ig</code>; in place and any special characters escaped with <code>\\</code>, such as in the example below.</p> <p>Connect to the Mongo DB hosting the Boards database and run the following in the mongo shell</p> <pre><code>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'\n</code></pre> <p>Each 2 lines of code (nodeNames, nodeDesc &amp; nodeLinks) updates one bit of a node and can be run independently of each other.</p>"},{"location":"boards/admin/url-update/#node-names","title":"Node Names","text":"<pre><code>nodeNames = db.nodes.find({ name: { $regex: domain }}, { name: 1 }).toArray();\nnodeNames.forEach(n =&gt; db.nodes.updateOne({ _id: n._id }, { $set: { name: n.name.replace(domain, newDomain) }}) )\n</code></pre>"},{"location":"boards/admin/url-update/#node-descriptions","title":"Node Descriptions","text":"<pre><code>nodeDesc = db.nodes.find({ description: { $regex: domain }}, { description: 1 }).toArray();\nnodeDesc.forEach(n =&gt; db.nodes.updateOne({ _id: n._id }, { $set: { description: n.description.replace(domain, newDomain) }}) )\n</code></pre>"},{"location":"boards/admin/url-update/#node-links","title":"Node Links","text":"<pre><code>nodeLinks = db.nodes.find({ 'links.url': { $regex: domain }}, { links: 1 }).toArray();\nnodeLinks.forEach(n =&gt; db.nodes.updateOne({ _id: n._id }, { $set: { links: n.links.map(link =&gt; { link.url = link.url.replace(domain, newDomain); return link; })}}) )\n</code></pre>"},{"location":"boards/aio/","title":"Huddo Boards All-in-One (AIO) Docker setup","text":"<p>Tip</p> <p>This document outlines a standalone (all in one) deployment of Huddo Boards using <code>docker-compose</code>. This can be used as a proof of concept, staging deployment or even a production deployment for a limited number of users (e.g. &lt; 500).</p> <p>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.</p>"},{"location":"boards/aio/#server-requirements","title":"Server requirements","text":"<p>RHEL (or Centos 7) server with:</p> <ul> <li>8gb ram minimum</li> <li>4 vCPUs</li> <li>40gb system drive</li> <li>100gb data drive (will be shared for database and file store) <sup>*see Data/Services below</sup></li> <li>docker and docker-compose</li> </ul>"},{"location":"boards/aio/#options","title":"Options","text":""},{"location":"boards/aio/#network","title":"Network","text":"<p>The implementation of this can be either:</p> Deployment Type Example URLs Comments Paths <code>yourdomain.com/boards.com</code> <code>yourdomain.com/api-boards</code> use your existing domain, no additional certificates, easier SSO integration of HCL Connections header. Subdomain <code>boards.yourdomain.com</code><code>boards-api.yourdomain.com</code> requires 2 domains (and therefore certificates) in your environment."},{"location":"boards/aio/#dataservices","title":"Data/Services","text":"<p>Boards utilises 3 types of data services:</p> <ol> <li>Mongodb (persistent data)</li> <li>S3 file store (persistent data)</li> <li>Redis cache.</li> </ol> <p>Each of these may use external services (e.g. Mongo Atlas) or the included services in the template (this hugely changes the server demand).</p>"},{"location":"boards/aio/#backups","title":"Backups","text":"<p>Warning</p> <p>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.</p>"},{"location":"boards/aio/#deployment","title":"Deployment","text":""},{"location":"boards/aio/#access-to-images","title":"Access to Images","text":"<p>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 <code>docker login</code> command available from the Quay.io interface, for example:</p> <pre><code>docker login -u=\"&lt;username&gt;\" -p=\"&lt;encrypted-password&gt;\" quay.io\n</code></pre>"},{"location":"boards/aio/#configuration","title":"Configuration","text":"<p>Download the appropriate configuration files for your deployment type:</p> Deployment Type URL Files Paths <code>/boards</code>, <code>/api-boards</code> docker-compose.ymlnginx proxy conf Subdomain <code>boards.yourdomain.com</code>,<code>boards-api.yourdomain.com</code> docker-compose.ymlnginx proxy conf <p>Update all example values in both files as required. Most required variables are in the template, for more information see the Kubernetes docs</p> <ul> <li>Global config</li> <li>Boards variables</li> </ul>"},{"location":"boards/aio/#s3-storage","title":"S3 Storage","text":"<p>The minio credentials are are used to both set in the minio service and access it from other services;</p> <ul> <li><code>x-minio-access</code> is used as the username in minio</li> <li><code>x-minio-secret</code> is used as the password.</li> </ul> <p>See the minios documentation on these fields, and an example of the values used here. The standard seems to be around 20 characters all caps/numbers for the username and around 40 characters any case / number for the password.</p>"},{"location":"boards/aio/#authentication","title":"Authentication","text":"<p>The <code>user</code> env variables in the compose file assume you are installing this in an HCL Connections environment. These can be removed or replaced with 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.</p>"},{"location":"boards/aio/#dns-proxy","title":"DNS / Proxy","text":"<p>Please follow the instructions for your chosen deployment type:</p> <ul> <li>Paths</li> <li>Subdomain</li> </ul>"},{"location":"boards/aio/#start","title":"Start","text":"<p>Once you have updated the appropriate <code>docker-compose.yml</code> and <code>nginx.conf</code> with your environment details, you can start the services with:</p> <pre><code>docker-compose up -d\n</code></pre>"},{"location":"boards/aio/#debugging","title":"Debugging","text":"<p>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.</p> <p>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 <code>docker-compose logs mongo</code></p> <p>To remove any other network configuration/hops on the docker server you should be able to: <code>curl -H \"Host: your.web.url\" --insecure https://localhost</code> This should return the html from webfront <code>curl -H \"Host: your.api.url\" --insecure https://localhost</code> This should return the html for the swagger api documentation <code>curl -H \"Host: your.api.url\" --insecure https://localhost/health</code> This should return \"{listening: 3001}\"</p> <p>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 <code>docker-compose logs nginx</code> to see if it points out any misconfiguration</p> <p>The core image has ping enabled and has access to all others so you can use it to test connectivity</p> <pre><code>docker-compose exec -it core sh\nping user\nping mongo\n... etc\n</code></pre>"},{"location":"boards/aio/paths/","title":"Proxy Configuration","text":"<p>The following configuration should be set when Huddo Boards is deployed at a context root under an existing domain (e.g. HCL Connections).</p>"},{"location":"boards/aio/paths/#nginx","title":"nginx","text":"<p>Please add the following location blocks to your proxy <code>server</code> -&gt; <code>listen 443</code> blocks:</p> <pre><code># Boards UI\nlocation /boards {\n    proxy_pass http://[DOCKER_COMPOSE_HOSTNAME]:80/boards;\n}\n\n# Boards API (including WebSocket support)\nlocation /api-boards {\n    proxy_pass http://[DOCKER_COMPOSE_HOSTNAME]:80/api-boards;\n    proxy_http_version 1.1;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection \"upgrade\";\n    proxy_set_header Host $host;\n}\n</code></pre> <p>Where:</p> <ul> <li><code>[DOCKER_COMPOSE_HOSTNAME]</code> is the hostname/IP of the server running the Docker Compose</li> </ul>"},{"location":"boards/aio/paths/#httpd","title":"httpd","text":"<p>Please add the following Proxy rules to the VirtualHost 443 block:</p> <pre><code>&lt;VirtualHost *:443&gt;\n    ServerName [HOST_DOMAIN]\n\n    #Huddo Boards\n    ProxyPass \"/boards\" \"http://[DOCKER_COMPOSE_HOSTNAME]:80/boards\"\n    ProxyPassReverse \"/boards\" \"http://[DOCKER_COMPOSE_HOSTNAME]:80/boards\"\n    ProxyPass \"/api-boards\" \"http://[DOCKER_COMPOSE_HOSTNAME]:80/api-boards\"\n    ProxyPassReverse \"/api-boards\" \"http://[DOCKER_COMPOSE_HOSTNAME]:80/api-boards\"\n    #End Huddo Boards\n&lt;/VirtualHost&gt;\n</code></pre> <p>Where:</p> <ul> <li><code>[HOST_DOMAIN]</code> is the URL of your environment, e.g. HCL Connections deployment</li> <li><code>[DOCKER_COMPOSE_HOSTNAME]</code> is the hostname/IP of the server running the Docker Compose</li> </ul>"},{"location":"boards/aio/subdomain/","title":"Subdomain","text":"<p>This setup assumes that you will have 2 subdomains 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 file.</p>"},{"location":"boards/aio/subdomain/#setup","title":"Setup","text":"<ol> <li>Configure your DNS to point the subdomains to the server running docker compose.</li> </ol>"},{"location":"boards/api/","title":"Using the Boards API","text":"<p>Boards has a REST API that allows you to access and manage your boards data. The API documentation is available online from Boards Cloud and also from your Boards deployment (including in-built Swagger documentation).</p> <p>The API is documented using OpenAPI (Swagger) and can be explored using the Swagger UI.</p>"},{"location":"boards/api/#determine-your-api-url","title":"Determine your API URL","text":"<p>The API URL is based on your Boards deployment:</p> <ul> <li>Boards Cloud - https://boards.api.huddo.com</li> <li> <p>On-Premise - for example:</p> <ul> <li>https://connections.company.com/api-boards/</li> <li>https://boards-api.company.com</li> </ul> </li> </ul>"},{"location":"boards/api/#authentication","title":"Authentication","text":"<p>The API requires authentication via the user's API Token. To get your API Token:</p> <ol> <li> <p>login to your Boards environment</p> </li> <li> <p>open the user menu, expand <code>Advanced</code>, and click <code>Huddo Boards API</code></p> <p></p> </li> <li> <p>copy the token</p> <p></p> </li> <li> <p>include this token to requests to the Boards API in the <code>Authorization</code> header</p> <p>For example:</p> <ul> <li>Method: <code>GET</code></li> <li>URL: <code>https://&lt;BOARDS_URL&gt;/user/me</code></li> <li>Headers: <code>Authorization: Bearer &lt;token&gt;</code></li> </ul> <p></p> </li> </ol>"},{"location":"boards/api/powerautomate/","title":"Huddo Boards Power Automate Integration","text":"<p>Tip</p> <p>This feature is only available for Huddo Boards Cloud.</p>"},{"location":"boards/api/powerautomate/#what-is-microsoft-power-automate","title":"What is Microsoft Power Automate?","text":"<p>Power Automate is a platform which allows end users to set up \"Flows\" which are workflows that connect two or more applications (like Huddo Boards). Each Flow consists of a \"Trigger\" and one or more \"Actions\". When the trigger event occurs, Power Automate automatically performs the actions.</p>"},{"location":"boards/api/powerautomate/#huddo-boards-connector","title":"Huddo Boards Connector","text":"<p>Huddo Boards is now available as a connector in Microsoft Power Automate. Create simple or complex flows to help you work across multiple applications and save time on repeatable tasks. Have you found a flow that works for you? Share it with us and we\u2019ll turn it in to a template.</p> <p></p>"},{"location":"boards/api/powerautomate/#triggers-webhooks","title":"Triggers / Webhooks","text":"<p>See the available Triggers / Webhooks.</p>"},{"location":"boards/api/powerautomate/#actions","title":"Actions","text":"<p>See the available Actions.</p>"},{"location":"boards/api/zapier/","title":"Huddo Boards Zapier Integration","text":"<p>Tip</p> <p>This feature is only available for Huddo Boards Cloud.</p>"},{"location":"boards/api/zapier/#what-is-zapier","title":"What is Zapier?","text":"<p>Zapier is a platform which allows end users to set up \"Zaps\" which are workflows that connect two or more applications (like Huddo Boards). Each Zap consists of a \"Trigger\" and one or more \"Actions\". When the trigger event occurs, Zapier automatically performs the actions.</p>"},{"location":"boards/api/zapier/#huddo-boards-zaps","title":"Huddo Boards Zaps","text":"<p>See the Huddo Boards Zapier Integration on the Zapier website.</p> <p></p>"},{"location":"boards/api/zapier/#triggers","title":"Triggers","text":"<p>Huddo Boards provides a Zapier integration that allows you to trigger Zaps based on events in Boards. The following are some of the triggers which are available:</p> Trigger Description New Board Triggers when a new board is created. New Card Triggers when a new card is created. Assigned Task Triggers when a task is assigned to a user. Task Completed Triggers when a task is completed. Member added to Board Triggers when a member is added to a board. My Task Completed Triggers when a task assigned to the user is completed."},{"location":"boards/api/zapier/#actions","title":"Actions","text":"<p>Huddo Boards provides a Zapier integration that allows you to perform actions in Boards. The following are some of the actions which are available:</p> Action Description Create Board Creates a new board. Create Card Creates a new card (entry/task in a Board). Create Comment on Card Adds a comment to a card. Assign Task to Member Assigns a task to a member of the board. Complete Task Completes a task. Add Member to Board Adds a member to a board. Find a Task by name and mark as complete Finds a task by name and marks it as complete. Find a Task by name and mark as incomplete Finds a task by name and marks it as incomplete. Move Card Moves a card to a different list or subtask. Change Card or Board Dates Change Start, End or Due dates on a Card / Board"},{"location":"boards/api/zapier/#searches","title":"Searches","text":"<p>Huddo Boards provides a Zapier integration that allows you to search for data in Boards. The following are some of the searchs which are available:</p> Search Description Find a Board by name Finds a board by name. Find a Card in a Board by name Finds a card in a board by name. Find a Task assigned to Me by name Finds a task assigned to the user by name. Find Board Members Gets all members of a board. Find a Board Member by name Finds a member of a board by name. Find all Cards in a Board Gets all cards in a board. Find Comments on a Card Gets all comments on a card. Find Me Gets the user details. Find User by name Finds a user by name. Find a Board or Card URL in a block of text Finds a Board or Card URL in a block of text."},{"location":"boards/apps/","title":"Boards Micro Apps","text":"<p>Huddo Boards includes a number of micro applications that can be used to integrate the functionality of Boards within other systems. If you have a specific requirement that is not covered by the micro apps below, please contact us to discuss.</p>"},{"location":"boards/apps/#typical-integration","title":"Typical Integration","text":"<p>To integrate a micro app into your system, you can use an iframe. It is best practice to include authentication details required for your environment. For example:</p> <p><code>&lt;iframe src=\"https://&lt;BOARDS_URL&gt;/auth/&lt;PROVIDER&gt;/&lt;CLIENTID&gt;?redirect_to=&lt;APP_URL&gt;\" width=\"600\" height=\"800px\"/&gt;</code></p>"},{"location":"boards/apps/#available-apps","title":"Available Apps","text":""},{"location":"boards/apps/#my-next-tasks-summary","title":"My Next Tasks Summary","text":"<p>This app displays a summary of the user's next tasks in a compact format.</p> <p>APP_URL: <code>/app/tasks/summary</code></p> <p></p>"},{"location":"boards/apps/#my-next-tasks","title":"My Next Tasks","text":"<p>This app displays the user's next tasks in a list format.</p> <p>APP_URL: <code>/app/tasks/next</code></p> <p></p>"},{"location":"boards/apps/#create-card","title":"Create Card","text":"<p>This app allows users to create a new card in a specific board.</p> <p>APP_URL: <code>/app/createcard</code></p> <p></p>"},{"location":"boards/apps/#attach-card","title":"Attach Card","text":"<p>This app allows users to attach a link to a board, list or card. This integration is useful in applications sending email (e.g. Outlook/Verse).</p> <p>APP_URL: <code>/app/attachcard</code></p> <p>Board:</p> <p></p> <p>Card:</p> <p></p>"},{"location":"boards/apps/#linked-cards","title":"Linked Cards","text":"<p>This app displays a list of cards which have links (bookmarks) of the URL specified in the query parameter.</p> <p>APP_URL: <code>/app/linkedcards?url=&lt;ENCODED_URL&gt;</code></p> <p>Where <code>&lt;ENCODED_URL&gt;</code> is the <code>encodeURIComponent(url)</code> of the URL to search for,</p> <p>e.g. <code>/app/linkedcards?url=https%3A%2F%2Fgoogle.com</code></p> <p></p>"},{"location":"boards/auth0/","title":"Auth0","text":"<p>This 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.</p> <p>You may switch to using one of our other supported authentication providers at a later stage should you wish.</p>"},{"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":"<ul> <li>Sign up at Auth0 by providing your email and a suitable password.</li> </ul> <ul> <li>Choose a tenant domain and region</li> </ul> <ul> <li>Fill in your company details</li> </ul> <ul> <li>Create a new application, providing <code>Huddo Boards</code> for the name and choose <code>Regular Web Applications</code> as the type.</li> </ul> <ul> <li>Open your application and go to the settings tab.</li> </ul> <ul> <li>Provide the rest of the details as below:</li> </ul> <p>In the table below, copy your auth0 domain (listed at the top of the page) into the relevant fields, replacing &lt;domain&gt; with 'your-domain.au.auth0.com' where applicable</p> 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/&lt;domain&gt;/callback Allowed Web Origins https://boards.huddo.com Allowed Origins (CORS) https://*.huddo.com <ul> <li>Click Show Advanced Settings -&gt; Grant Types and tick <code>Implicit</code>, <code>Authorization Code</code>, <code>Refresh Token</code> and <code>Client Credentials</code></li> <li>Click Save Changes</li> <li>Send An email to support@huddo.com with your domain, Client ID and Client Secret.</li> </ul>"},{"location":"boards/auth0/#enable-user-searching","title":"Enable user searching","text":"<p>In order to allow your users to find each other, we need to enable one of Auth0's api features.</p> <ul> <li>Click <code>APIs</code> and next to the Auth0 Management API Click the settings button.</li> </ul> <p></p> <ul> <li>Click <code>Machine to Machine Applications</code> and next to Huddo Boards click the <code>AUTHORIZED</code> slider so it is enabled as below.</li> </ul> <p></p> <ul> <li>The Scopes should automatically open as below, if they do not click the <code>&gt;</code> next to the slider above</li> <li>Find and tick the <code>read:users</code> scope then click <code>UPDATE</code></li> </ul> <p></p>"},{"location":"boards/auth0/#adding-users-to-your-auth0-tenant","title":"Adding Users to your Auth0 tenant","text":"<ul> <li>Login or Sign up to Auth0</li> <li>Click Users under Users and Roles</li> <li>Click <code>Create New User</code> and provide the email and password for the user you wish to add. Leave the Connection as Username-Password-Authentication</li> </ul> <p>If you aren't redirected to the users page, click them to open it</p> <ul> <li>Click <code>Edit</code> under the users name</li> </ul> <p></p> <ul> <li>Update the users full name and click <code>Save</code></li> </ul> <p></p>"},{"location":"boards/auth0/#sign-in-to-huddo-boards-with-your-auth0-tenant","title":"Sign in to Huddo Boards with your Auth0 Tenant","text":"<p>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.</p> <p></p> <p>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.</p> <p></p>"},{"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":"<p>To start using your Auth0 tenant in Huddo Boards, you need to make a few changes to allow login at the new address.</p> <p>Login to Auth0 and go to the applications list</p> <p></p> <p>Click your Kudos Boards application and change the following fields</p> <p>In the table below, copy your auth0 domain (listed at the top of the page) into the relevant fields, replacing &lt;domain&gt; with 'your-domain.au.auth0.com' where applicable</p> 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/&lt;domain&gt;/callback Allowed Web Origins https://boards.huddo.com Allowed Origins (CORS) https://*.huddo.com"},{"location":"boards/cloud/","title":"Boards Cloud","text":"<p>Boards Cloud is Huddo Boards as a service hosted and managed by the Huddo Team. Accessible now at boards.huddo.com.</p> <p>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.</p>"},{"location":"boards/cloud/updates/","title":"Boards Cloud Updates","text":"<p>Please see here for recent changes to Huddo Boards Cloud</p>"},{"location":"boards/cloud/updates/#2024","title":"2024","text":""},{"location":"boards/cloud/updates/#june","title":"June","text":"<p>2024-06-19</p> <p>Fixes:</p> <ul> <li>Parse email to card when dragging from HCL Notes</li> </ul> <p>2024-06-13</p> <p>Improvements:</p> <ul> <li>Mobile: save/cancel buttons when creating comments</li> <li>Mobile (Android): fix for keyboard covering input fields</li> </ul> <p>Fixes:</p> <ul> <li>loading wrong page/route when logging in with multiple windows (e.g. Community widget &amp; Related Tasks)</li> </ul>"},{"location":"boards/cloud/updates/#may","title":"May","text":"<p>2024-05-31</p> <p>Improvements:</p> <ul> <li>only allow link on card to bookmark (not uploaded files)</li> <li>performance of data selection from redux</li> <li>mobile: always show rich text editor toolbar in comments (to access @mentions)</li> </ul> <p>Fixes:</p> <ul> <li>issue where dual tooltips in collapsed Board sidebar</li> <li>Assign Member list overflowing on phone</li> <li>issue with text overflow in card links</li> <li>issue with center alignment of login page on small extra screen devices</li> <li>issue with toolbar position for comments (balloon) under header when adding new comment in sidebar</li> </ul> <p>2024-05-27</p> <p>Features:</p> <ul> <li>Drag and drop of cards between browser tabs/windows</li> <li>Drag and drop bookmarks into Board lists/cards</li> </ul> <p>2024-05-17</p> <p>Accessibility fixes:</p> <ul> <li>Focus highlighting overrides</li> <li>use focus outline rather than background colour</li> <li>Fix for keyboard access to CreateCard app clear buttons to choose board/list</li> <li>MenuHelper.jsx - pass the disabled prop to the button</li> <li>position of assign members menu</li> <li>better focus styling for add board tile button</li> <li>better contrast when focusing on boards logo</li> <li>board tiles sort dropdowns - use defined focus bg and colours</li> <li>minor fixes for focused input controls</li> </ul> <p>2024-05-07</p> <p>Improvements:</p> <ul> <li>Collab Cloud header integration for Cnx8</li> </ul> <p>2024-05-06</p> <p>Usability improvements:</p> <ul> <li>Timeline: add zoom -+ controls that increment zoom levels</li> <li> <p>Mindmap accessibility</p> <ul> <li>1st tab selects board node, allow arrow key nav, and tab to access actions from there</li> <li>sidebar controls - use mui checkboxes + ensure hover effects on buttons</li> <li>clear node selection on escape keypress</li> <li>fix text cutoff/ensure ellipsis on longer node titles</li> <li>add help link to sidebar</li> <li>allow keyboard pan and zoom using shift+arrow and +- keys</li> </ul> </li> <li> <p>add contact support button to error catch page</p> </li> <li>add severity levels when showing toasts, fade transition</li> <li>ensure board creator is displayed as a non-editable owner on board/template creation</li> <li>ensure board tile labels are sorted in selection menu</li> <li>make 'Recent' heading in sidebar look less like other actionable items</li> <li>use delete icon (bin) for remove actions for member tiles, dates, tags, and board tile labels</li> </ul> <p>Fixes:</p> <ul> <li>Board tile label delete - ensure tile label is deleted from the label object in store</li> </ul> <p>2024-05-03</p> <p>Features</p> <ul> <li>Card and Board recent updates feed - filter to show all or comments/updates only</li> </ul> <p>Improvements</p> <ul> <li>add a permanent but closable info level toast when board is read-only</li> <li>update rich text editor to latest version</li> </ul>"},{"location":"boards/cloud/updates/#april","title":"April","text":"<p>2024-04-29</p> <p>Fixes:</p> <ul> <li>update material-ui libraries to fix date picker display issues on small screens</li> <li>ensure card header theme displays correctly when card is opened via direct link</li> </ul> <p>2024-04-24</p> <p>Improvements:</p> <ul> <li>card details view improvements<ul> <li>show card fields/data in defined sections in a grid formation with headings and add buttons</li> <li>change \"add a comment\" action to start as a button</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>minor styling fix for dependencies section on a node</li> <li>board/activity lists - more precise and consistent footer spacing/padding</li> <li>create card and add comment actions - ensure entered text persists on unfocus + other focus related fixes</li> </ul> <p>2024-04-17</p> <p>Fixes:</p> <ul> <li>issue with exporting a board in Teams client</li> <li>date picker error on mobile/touch devices</li> </ul> <p>2024-04-11</p> <p>Improvements</p> <ul> <li>tooltips on date picker</li> <li>add invalid date error message</li> <li>primary session expired message - show as info alert</li> <li>tab color and style improvements</li> <li>more consistent use of primary/secondary action colours on buttons</li> <li>no collapse for empty lists activity todo pivot views</li> <li>auto collapse empty lists initially and after a card is dragged out of them</li> <li>New Board Wizard - more specific label for board name and template name</li> <li> <p>Activity view improvements</p> <ul> <li>styling (shadows, spacing, border edges when expanded/collapsed)</li> <li>drop cards on list header (highlight like shadow)</li> <li>add card at top hides the bottom add card</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>issue with format of dates in date picker</li> <li>issues in list header title - not full width, no-wrap ellipsis, use correct cursors</li> <li>don't show grab cursor on lists in todos / pivoted views</li> <li>issue saving tags when creating new template</li> <li>ensure tags are copied from template/source</li> </ul> <p>2024-04-02</p> <p>Improvements:</p> <ul> <li>Streamlined <code>/todos/assigned</code> &amp; <code>/todos/created</code> API, separating out the Board labels to <code>/board/labels</code> &amp; <code>/board/{boardId}/labels</code> endpoints</li> <li>Loading feedback when creating a board</li> </ul> <p>Fixes:</p> <ul> <li>Issue with board label history</li> <li>create board from template when opened and only a reader</li> </ul>"},{"location":"boards/cloud/updates/#march","title":"March","text":"<p>2024-03-25</p> <p>Features:</p> <ul> <li> <p>Emoji reactions on comments</p> <ul> <li> <p>Quick selection</p> <p></p> </li> <li> <p>Picker</p> <p></p> </li> </ul> </li> </ul> <p>Improvements:</p> <ul> <li>Editing of comments on mobile (focus at end of text, save/cancel buttons)</li> </ul> <p>Fixes:</p> <ul> <li>Creating Board in group restricts to the group's Organisation</li> <li>Better handling of authentication when provider session changes user account</li> <li>Visibility of 'Embed Link' when viewing Boards by Group</li> <li>Creation of Board in Group when using /group/{groupId} route (embedded)</li> </ul> <p>2024-03-21</p> <p>API Documentation:</p> <ul> <li>/todos/next</li> <li>/todos/summary</li> <li>/board/{boardId}/labels</li> <li>/board/labels</li> <li>/user/auth/{provider}/{externalId}/apitoken</li> </ul> <p>2024-03-20</p> <p>Fixes:</p> <ul> <li>View cards in fullscreen on small screens</li> </ul> <p>2024-03-15</p> <p>Features:</p> <ul> <li>My Tasks Summary micro app</li> <li>My Next Tasks micro app</li> </ul> <p>Fixes:</p> <ul> <li>Issue when deleting all Boards tile colors</li> <li>Links to card ancestors (Todo view)</li> <li>Prevent date selection incorrectly showing today when no date set</li> </ul> <p>2024-03-06</p> <p>Fixes:</p> <ul> <li>Issue with communication between Boards and Collab Cloud</li> </ul> <p>2024-03-05</p> <p>Fixes:</p> <ul> <li>Upload files to Teams private channel OneDrive</li> </ul> <p>2024-03-04</p> <p>Improvements:</p> <ul> <li>Loading feedback of recent boards sidebar</li> <li>Card link opening behavious (links to other boards open in same tab)</li> <li>Teams board links open tabs</li> <li>Show loading spinner while waiting on clicked link to open in a teams tab</li> </ul>"},{"location":"boards/cloud/updates/#february","title":"February","text":"<p>2024-02-28</p> <p>Improvements:</p> <ul> <li>Add copy/paste list option in list menu</li> <li>Add duplication list option in list menu</li> <li>More comprehensive history feed details for moving or reordering cards</li> </ul> <p>Fixes:</p> <ul> <li>Scroll to bottom of a list when creating a new card</li> <li>Delete action in card dialog / in archive view</li> <li>Add card section in a list delays retract/height change to prevent card drag issues</li> <li>Dragging empty colour labels in Firefox</li> <li>Filter/search by list name</li> </ul> <p>2024-02-22</p> <p>Fixes:</p> <ul> <li>Unauthorised error when adding existing board as Teams tab</li> <li>Fix potential onEnter errors in rich text editor</li> <li>Prevent overflow on file preview</li> <li>Load board members on fullscreen list view (for @mentions)</li> </ul> <p>2024-02-16</p> <p>Fixes:</p> <ul> <li>Fix potential onBlur errors in rich text editor</li> <li>Don't show iCalendar feed options in Teams</li> </ul> <p>2024-02-14</p> <p>Fixes:</p> <ul> <li>Translation fixes<ul> <li>Move translations inside functions to help prevent premature translate calls</li> <li>Use date-fns locales to show months in user's language</li> <li>German translation amendments</li> <li>Other translation fixes and improvements</li> </ul> </li> </ul> <p>2024-02-08</p> <p>Fixes:</p> <ul> <li>Microsoft Teams private channels<ul> <li>Link to File will now show the private channel's files.</li> <li>Owner/Author access level was setting all members to Author.</li> </ul> </li> <li>Microsoft Teams Mobile: Removed licence related cards in org admin view.</li> <li>Microsoft Teams: Removed obsolete \"Disable Notifications\" button.</li> <li>Rich text editor dialog - allow scroll on overflow</li> </ul>"},{"location":"boards/cloud/updates/#january","title":"January","text":"<p>2024-01-25</p> <p>Fixes:</p> <ul> <li>Use SMTP email address before using Exchange address when parsing email attachments</li> <li>Don't show organisation admin links from Boards sidebar menu in Teams on a mobile device</li> </ul> <p>2024-01-17</p> <p>Fixes:</p> <ul> <li>Activity view scrolling issue</li> </ul> <p>2024-01-09</p> <p>Improvements:</p> <ul> <li> <p>Microsoft Teams integrations</p> <ul> <li>UI redesign when adding new Boards tab</li> <li>Onboarding Tours</li> </ul> </li> <li> <p>faster opening of cards</p> </li> <li>allow clicking links in description when content locked for editing</li> <li>allow reordering private cards</li> <li>US English updates</li> <li>organisation plan loading feedback</li> </ul> <p>Fixes:</p> <ul> <li>issue where completing a new task showed incorrect icon</li> <li>issue where Board content deleted when hovered and press Ctrl+Alt+Delete</li> <li>issue when opening a card by link, then a subcard within that card</li> <li>issue when reordering cards with filtered (hidden) content</li> <li>visibility of card title in header breadcrumb (Component Pack)</li> </ul> <p>2024-01-04</p> <p>Fixes:</p> <ul> <li>RichText saving when used @symbol (but not an @mention)</li> <li>@mentions keyboard navigation improvements (home/end, up to bottom, down back to top), escape without closing modal</li> <li>@mentions only considered new on first save</li> </ul>"},{"location":"boards/cloud/updates/#2023","title":"2023","text":""},{"location":"boards/cloud/updates/#december","title":"December","text":"<p>2023-12-22</p> <p>Fixes:</p> <ul> <li>issue where mentions popup partially hidden at top</li> <li>issue where could not mention users when opening a card directly by link</li> <li>hide private cards when viewing board by assignments</li> <li>create card from Outlook/Verse - fix toggle of attach body, ordering of recent boards</li> <li>drag dependency links in Firefox</li> </ul> <p>2023-12-18</p> <p>Improvements:</p> <ul> <li>Accessibility (keyboard navigation - colors/members dialog, aria-labels, popover, html.lang attribute, improved roles, aria-selected, aria-expanded, hover/focus on cards)</li> <li>Drag email to card - attach .eml and .msg file</li> <li>Positioning of unscheduled cards in Timeline</li> <li>Improved document titles based on context</li> <li>Smoother drag scroll on Kanban</li> <li>Ensure grab cursor for Kanban drag scroll</li> <li>Update childcounts in activity lists when filtering</li> <li>Visibility of selected board filters</li> <li>Searching for a board includes the description</li> </ul> <p>Fixes:</p> <ul> <li>Card label overflow issue when 5 lines</li> <li>Issue where comment events sent to mentioned users</li> </ul> <p>2023-12-13</p> <p>Improvements:</p> <ul> <li>API documentation for /user/{userId}, /user/group/{groupId} etc</li> <li>Support for latest MongoDB (v7)</li> </ul> <p>2023-12-12</p> <p>Fixes:</p> <ul> <li>Link to File dialog options</li> </ul> <p>Fixes:</p> <p>2023-12-07</p> <p>Fixes:</p> <ul> <li>Issue saving card name when editing it directly on the card</li> </ul> <p>2023-12-04</p> <p>Feature:</p> <ul> <li>Drag emails from Outlook to create as card</li> </ul> <p>2023-12-01</p> <p>Fixes:</p> <ul> <li>Issue when focusing on boards search input</li> </ul>"},{"location":"boards/cloud/updates/#november","title":"November","text":"<p>2023-11-29</p> <p>Feature:</p> <ul> <li>Support for Domino by REST API</li> </ul> <p>Fixes:</p> <ul> <li>Debounce User/Group searching</li> </ul> <p>2023-11-28</p> <p>Fixes:</p> <ul> <li>Issue where menu buttons in the open card view were not overflowing to the 'more' menu correctly and causing a flickering effect</li> <li>Issue where lists in board view could not easily be dragged to re-order</li> <li>Issue with board title button long text overflowing</li> <li>Issue with card background images</li> </ul> <p>Improvements:</p> <ul> <li>Minor accessibility improvement - add aria-labels</li> </ul> <p>2023-11-23</p> <p>Fixes:</p> <ul> <li>Fix template description not showing in new board wizard</li> </ul> <p>2023-11-13</p> <p>Improvements:</p> <ul> <li> <p>Accessibility</p> <ul> <li>more consistent tooltips (for screen readers and better explanation of functionality)</li> <li>Keyboard navigation (particularly in the Board Tiles, Kanban view, Card dialog) - (vision &amp; motor impaired)</li> <li>better screen reader information (vision impaired)</li> <li>improved colour contrast (low vision users)</li> </ul> </li> </ul> <p>2023-11-09</p> <p>Improvements:</p> <ul> <li>API for Member deletion</li> </ul> <p>Fixes:</p> <ul> <li>Email for mentions missing fields</li> </ul>"},{"location":"boards/cloud/updates/#october","title":"October","text":"<p>2023-10-31</p> <p>Improvements:</p> <ul> <li>Translations (German and English US)</li> <li>Use https protocol for iCal feed instead of webcals</li> <li>Hide unusable Colors button when read-only access when sidebar collapsed</li> <li>Consistency of Board colour feature naming</li> </ul> <p>Fixes:</p> <ul> <li>Issue where iCal feed dates off by 1 due to timezone differences</li> <li>Issue where page blank in Firefox when loading with Connections 7 header via SSO</li> </ul> <p>2023-10-25</p> <p>Improvements:</p> <ul> <li>Show Member/Labels buttons in collapsed sidebar</li> <li>added translations to missing fields</li> </ul> <p>Fixes:</p> <ul> <li>Issue where page crashed when reloaded page with Card open, then opening member dialog</li> </ul> <p>2023-10-23</p> <p>Features:</p> <ul> <li>Board iCalendar feed</li> <li>Personal iCalendar feed</li> </ul> <p>2023-10-20</p> <p>Fixes:</p> <ul> <li>Collab header regression</li> </ul> <p>2023-10-19</p> <p>Improvements:</p> <ul> <li>loading of Board task stats on tiles as required</li> <li>performance of loading My Boards</li> <li>redirect in place for expired session of Collab/Connections with SSO header</li> </ul>"},{"location":"boards/cloud/updates/#september","title":"September","text":"<p>2023-09-29</p> <p>Improvements:</p> <ul> <li>More German language translations</li> </ul> <p>Fixes:</p> <ul> <li>Ability to paste images into descriptions</li> </ul> <p>2023-09-22</p> <p>Improvements:</p> <ul> <li>API security, added 'Strict-Transport-Security' &amp; 'X-Content-Type-Options'</li> </ul> <p>Fixes:</p> <ul> <li>(regression) encoding of file names when uploading special charactors (e.g. Japanese)</li> <li>issue where deleting a dependency changes the current view</li> </ul> <p>2023-09-19</p> <ul> <li>update of <code>busboy</code> dependency used for file upload (includes security patches, node support etc)</li> </ul> <p>2023-09-14</p> <p>Improvements:</p> <ul> <li>consistency of sidebar icon positioning when collapsed/expanded</li> <li>allow case insensitive Collab login</li> <li>update to teams-js v2</li> <li>open filesin Teams in-place (deep links)</li> </ul> <p>Fixes:</p> <ul> <li>public member creation when creating Board</li> <li>whitespace of cards in Activity list</li> <li>HCL Connections 8 CR3 whitespace</li> </ul> <p>2023-09-12</p> <p>Improvments:</p> <ul> <li>loading speed of the 'My Boards' data</li> </ul> <p>2023-09-08</p> <p>Fixes:</p> <ul> <li>membership role options when created inside a Team/Community</li> </ul> <p>2023-09-07</p> <p>Features:</p> <ul> <li>Organisation content administration &amp; membership management</li> <li>Labels pivot view for Board and Activity views</li> </ul> <p>Improvements:</p> <ul> <li>Pasting URLs into description and comments automatically converted to clickable link</li> </ul> <p>Fixes:</p> <ul> <li>issues in dependency arrow positioning</li> <li>auto reschedule dependencies when dates change</li> <li>selecting the same file to upload after cancelling</li> <li>expand/collapse lists when pivoted by dates/assignment</li> </ul>"},{"location":"boards/cloud/updates/#august","title":"August","text":"<p>2023-08-15</p> <p>Fixes:</p> <ul> <li>Reload loop during login with Firefox</li> </ul> <p>2023-08-09</p> <p>Fixes:</p> <ul> <li>Ensure assignments are duplicated when copying and pasting tasks</li> </ul> <p>2023-08-07</p> <p>Improvements:</p> <ul> <li>Users with the author role now have full edit access on cards that are assigned to them (rather than complete and comment access only)</li> </ul> <p>Fixes:</p> <ul> <li>Prevent cards from being moved to another list at the same time they are archived by dragging to the archive button</li> <li>Ensure the current user has the correct actions available according to their board role when opening cards from the My Todos view</li> </ul>"},{"location":"boards/cloud/updates/#july","title":"July","text":"<p>2023-07-14</p> <p>Fixes:</p> <ul> <li>Drag &amp; Drop from rich email clients onto a list</li> </ul> <p>2023-07-12</p> <p>Fixes:</p> <ul> <li>Activity list missing action menu</li> </ul> <p>2023-07-05</p> <p>Fixes:</p> <ul> <li>Ability to edit nodes when opened directly</li> </ul> <p>2023-07-04</p> <p>Fixes:</p> <ul> <li>Assignments to non-primary aliases</li> </ul> <p>2023-07-03</p> <p>Improvements:</p> <ul> <li>Improved author experience - restrict to allowed actions</li> <li>Board title/board options button - styling and usability improvements</li> <li>Current member role now highlighted in members dialog and links added to member permissions documentation</li> <li>Improved randomisation and readability of Assignment Role colours</li> <li>Added tooltips to Assignment Role avatars</li> <li> <p>Microsoft Teams</p> <ul> <li>detect members in private sub channels (OAuth Admin consent must be certified again)</li> <li>fix for creating Board in private sub channels</li> <li>loading spinner positioning</li> </ul> </li> </ul> <p>Fixes:</p> <ul> <li>Connections 8 styling fixes</li> <li>Fixed coloured role borders when assigning member roles</li> <li>Fix URLs pointing to old docs pages</li> <li>Issue detecting highest licence when multiple</li> <li>Minor fixes to Welcome and Plan Selection dialogs</li> </ul>"},{"location":"boards/cloud/updates/#june_1","title":"June","text":"<p>2023-06-26</p> <p>Improvements:</p> <ul> <li>Readers can now select text in descriptions</li> <li>General reader experience</li> </ul> <p>Fixes:</p> <ul> <li>Tours appearing incorrectly</li> <li>Template role assignment on touch devices</li> </ul> <p>2023-06-21</p> <p>Fixes:</p> <ul> <li>Move button now appears again</li> </ul> <p>2023-06-19</p> <p>Fixes:</p> <ul> <li>Timeline group-by colours</li> </ul> <p>2023-06-15</p> <p>Improvements:</p> <ul> <li>Readers no longer see actions they cannot perform</li> </ul> <p>Fixes:</p> <ul> <li>Getting members from private sub-channels</li> </ul> <p>2023-06-06</p> <p>Improvements:</p> <ul> <li>Member promotion emails - add invite and membership details to give more context</li> <li>New configuration option to enable/disable member promotion requests</li> <li>Do not clear edited name/description when changing templates</li> <li>Ability to create new organisation from guest is reader popup</li> </ul> <p>Fixes:</p> <ul> <li>Issue with exporting Board as CSV with special characters (e.g. Umlaut)</li> <li>Issue affecting Org config when user has multiple orgs</li> <li>Color selection/editing on small screens (e.g. mobiles)</li> <li>German translations with extra '}' character</li> <li>Issues with Role Assignments (duplicates etc)</li> <li>Collab - fix for offering user org trial</li> <li>Issue in create first board tour</li> </ul>"},{"location":"boards/cloud/updates/#may_1","title":"May","text":"<p>2023-05-26</p> <p>Features:</p> <ul> <li>Organisation Guests are now treated as Reader</li> <li>Ability for guest to request a promotion to member, sent to admins via email &amp; socket</li> </ul> <p>2023-05-23</p> <p>Improvements:</p> <ul> <li> <p>Drag and drop of lists</p> <ul> <li>drag by header</li> <li>fix blank list when scrolled and dragged</li> <li>prevent scrolling of list in drag mode</li> </ul> </li> <li> <p>Cards can be Archived+Deleted from the card modal toolbar.</p> </li> <li>Enable \"Assign to Roles\" when creating a new Board via 'Create Template from Board' button.</li> <li>More compact Board Members view on small (phone) screens.</li> </ul> <p>Fixes:</p> <ul> <li>Issue with blank tile label</li> <li>Issue with empty Assign Roles in new Board wizard</li> <li>Board Tiles sidebar shadow regression bug</li> <li> <p>Card drag and drop</p> <ul> <li>issue where a duplicate card appears when drag to end</li> <li>issue where card jumps back to top when dragging a card to end of same list</li> </ul> </li> <li> <p>Button for copying a template says \"Copy Template\" instead of \"Copy Board\"</p> </li> <li>Fixed loading of template description in to board description field in the new board wizard.</li> <li>Deleting an open template now redirects to template list instead of board list.</li> <li>Fixed \"Assign to Roles\" screen appearing in Board wizard without any roles to assign members.</li> <li>When creating a new Board, edited name and description fields are not lost when changing the selected template.</li> </ul> <p>2023-05-16</p> <p>Improvements:</p> <ul> <li> <p>Organisation view of members &amp; groups</p> <ul> <li>loading feedback</li> <li>virtualised scroll for faster render</li> <li>show membership of linked aliases</li> <li>prevent duplicates of invites to org</li> </ul> </li> <li> <p>localised format of dates in CSV export</p> </li> </ul> <p>Fixes:</p> <ul> <li>Security issue affecting external users and public communities (Connections)</li> <li>issue where Organisation invites not visible if members with linked aliases</li> </ul> <p>2023-05-05</p> <p>Features:</p> <ul> <li>Drag card to archive</li> </ul> <p>Improvements:</p> <ul> <li>Auto-move dependency parent</li> <li>Expand all in activity view</li> <li>Hide edit options on archived card</li> <li>Performance improvements related to icons used on Template Roles</li> <li>Show count of tasks assigned to Role in Board Members view</li> </ul> <p>Fixes:</p> <ul> <li>Dragging card from assigned user created user image as card</li> <li>Sending duplicate due date reminders</li> </ul>"},{"location":"boards/cloud/updates/#april_1","title":"April","text":"<p>2023-04-21</p> <p>Features:</p> <ul> <li>Button to assign all sub-tasks as dependencies of parent</li> <li>Template Roles - base functionality</li> </ul> <p>Fixes:</p> <ul> <li>Removed Connections community members not removed from Board membership</li> <li>Deleting an assigned label</li> </ul> <p>2023-04-12</p> <p>Features:</p> <ul> <li>Custom Colours. Colours and tags have been merged. You are now able to create as many colours as you like in a Board</li> </ul>"},{"location":"boards/cloud/updates/#march_1","title":"March","text":"<p>2023-03-20</p> <p>Fixes:</p> <ul> <li>Group member changes not being picked up</li> </ul> <p>2023-03-17</p> <p>Improvements:</p> <ul> <li>Timeline card title always visible</li> </ul> <p>2023-03-15</p> <p>Improvements:</p> <ul> <li>UI for member adding on Mobile</li> </ul> <p>Fixes:</p> <ul> <li>Kanban Printing</li> <li>Timeline calendar shifting when opening a card</li> </ul> <p>2023-03-10</p> <p>Features:</p> <ul> <li>Template Rescheduling</li> <li>Drag &amp; Drop assignments from parent to sub-cards in modal</li> </ul> <p>Fixes:</p> <ul> <li>Assign users to a named licence</li> </ul>"},{"location":"boards/cloud/updates/#february_1","title":"February","text":"<p>2023-02-20</p> <p>Fixes:</p> <ul> <li>Attachments are moved in child nodes when the parent is moved</li> <li>Updated attachments to correctly show when their parent had been moved</li> </ul>"},{"location":"boards/cloud/updates/#january_1","title":"January","text":"<p>2023-01-31</p> <p>Features:</p> <ul> <li>New Organisation summary view</li> </ul> <p>Improvements:</p> <ul> <li>Outlook attachments using plugin</li> <li>Copy/Paste functionality</li> </ul> <p>2023-01-24</p> <p>Improvements:</p> <ul> <li>Styling for HCL Connections 8 new UI</li> <li>Handling of default profile images in Connections</li> <li>Detect language from Connections dropdown</li> <li>Security updates (node 18)</li> </ul>"},{"location":"boards/cloud/updates/#2022","title":"2022","text":""},{"location":"boards/cloud/updates/#december_1","title":"December","text":"<p>2022-12-14</p> <p>Improvements:</p> <ul> <li>synchronise dependencies in real time</li> <li>faster creation of multi cards</li> <li>presence of users open on card without board open</li> <li>adding dependencies between private cards</li> <li>handling of dependencies where not accessible</li> <li>make associated comments public when card is made public</li> <li>synchronise my private tasks between my windows</li> </ul> <p>Fixes:</p> <ul> <li>issue opening board \"Error: Minified React error #185\"</li> <li>issue where Community widget shows 'my' boards incorrectly</li> <li>issue where someone online in board remained online if page reloaded</li> <li>issue where lists hidden when previewing Kanban view while creating a Board</li> <li>issue where page crashed on logout in Node view</li> <li>issue where page crashed on logout in Timeline view</li> <li>issue where files couldn't be downloaded</li> <li>issue where page reloaded in admin view</li> </ul>"},{"location":"boards/cloud/updates/#november_1","title":"November","text":"<p>2022-11-29</p> <p>Improvements:</p> <ul> <li>synchronise dependencies in real time</li> <li>faster creation of multi cards</li> <li>presence of users open on card without board open</li> <li>link to API documentation</li> <li>adding dependencies between private cards</li> <li>handling of dependencies where not accessible</li> <li>make associated comments public when card is made public</li> <li>synchronise my private tasks between my windows</li> </ul> <p>Fixes:</p> <ul> <li>issue where someone online in board remained online if page reloaded</li> <li>issue where lists hidden when previewing Kanban view while creating a Board</li> <li>issue where page crashed on logout in Node view</li> <li>issue where page crashed on logout in Timeline view</li> <li>issue where files couldn't be downloaded</li> <li>issue where page reloaded in admin view</li> </ul> <p>2022-11-08</p> <p>Features:</p> <ul> <li>installable web app</li> </ul> <p>Performance:</p> <ul> <li>faster load</li> <li>added virtual scroll for Kanban</li> <li>smoother drag and drop</li> <li>faster filtering/searching inside a Board</li> </ul> <p>Improvements:</p> <ul> <li>improved new user experience in integrations</li> <li>hide dependency lines while dragging &amp; resizing</li> <li>usability of tile color label edit/selection</li> <li>stop auto redirecting expired account</li> </ul> <p>Fixes:</p> <ul> <li>fix for drag scrolling lists on mobile</li> <li>fix editing link titles</li> <li>fix positioning of timeline arrows caused by swimlane animations</li> <li>fix double click to add list</li> </ul>"},{"location":"boards/cloud/updates/#october_1","title":"October","text":"<p>2022-10-17</p> <ul> <li> <p>Updates for Timeline</p> <ul> <li>animate expand/collapse of scheduled lanes</li> <li>fix for hidden cards on timeline when duplicated (eg multiple colors/assignments)</li> <li>highlight multiple instances of same card on hover</li> <li>remember last view (list/color/members)</li> <li>live updates of list names, color labels and members</li> <li>show color labels</li> </ul> </li> </ul> <p>2022-10-05</p> <ul> <li>Fix for opening 'Owners Only' community boards</li> </ul> <p>2022-10-04</p> <ul> <li>Fix for timeline lists not scrolling</li> <li>Updated translations</li> </ul>"},{"location":"boards/cloud/updates/#september_1","title":"September","text":"<p>2022-09-27</p> <ul> <li>Fix for not being able to close date picker on mobile</li> </ul> <p>2022-09-05</p> <ul> <li>Updated translations including notifications</li> </ul>"},{"location":"boards/cloud/updates/#july_1","title":"July","text":"<p>2022-07-08</p> <ul> <li>Compatibility for private channels in Teams</li> </ul>"},{"location":"boards/cloud/updates/#june_2","title":"June","text":"<p>2022-06-23</p> <ul> <li>Print feature for Board View</li> <li>Fix for loading ToDo View with deleted groups</li> <li>Fix for 'View' by 'Groups'</li> <li>Fix for description not saving in certain window changing scenarios</li> <li>Fix for character encoding in update streams</li> </ul> <p>2022-06-21</p> <ul> <li>Fix for viewing user presence</li> <li>Fix for viewing card title when user presence is also displayed</li> <li>Fix for 'Commented on' recent updates not syncing in real-time</li> <li>Fix for displaying changes made in Activity View</li> <li>Updated Recent Boards in side toolbar</li> <li>Fix for auth loop when using Connections Header</li> </ul> <p>2022-06-10</p> <ul> <li>Fix for card toolbar on smaller resolutions</li> <li>Community widget now works if user has no email</li> <li>Highlights widget fix for opening fullpage</li> <li>Fix for visibility of Owners Only group Boards</li> </ul> <p>2022-06-07</p> <ul> <li>Fix for readers not being able to complete cards</li> <li>Fix for dependencies in Todos view</li> </ul>"},{"location":"boards/cloud/updates/#may_2","title":"May","text":"<p>2022-05-20</p> <ul> <li>NEW Dependencies feature</li> </ul> <p>2022-05-10</p> <ul> <li>Fix for Microsoft admin approval</li> </ul> <p>2022-05-09</p> <ul> <li>Can no longer close a page when editing a description</li> <li>Description locking alert moved for better visibility</li> <li>Authors no longer appear to be able to edit descriptions when unable to</li> <li>Fix for opening links in description</li> <li>Fix for comment truncation issue in rare circumstances</li> <li>Fix for new line @mentions</li> <li>Fix for focused description loss when immediately moving to comments</li> <li>Fix for showing editor toolbar when selecting all using keyboard</li> </ul>"},{"location":"boards/cloud/updates/#april_2","title":"April","text":"<p>2022-04-28</p> <ul> <li>Updated RTE to latest</li> <li>New Teams welcome message card</li> <li>New Teams notification cards</li> <li>Fix for email attachments not attaching</li> </ul> <p>2022-04-19</p> <ul> <li>Updated fix for Moderated Community access</li> <li>Fix for crash when updating Board title</li> <li>Fix for description locking in communities</li> </ul> <p>2022-04-07</p> <ul> <li>Fix for Moderated Community access</li> </ul> <p>2022-04-06</p> <ul> <li>NEW linked-cards micro-app</li> <li>Fix for comment stream entry for Orient Me</li> <li>Fix for updating card title from Boards view in FireFox</li> <li>Fix for deeplinked Connections Community widgets</li> <li>Fix for Boards Search styling</li> <li>Fix for opening filters via icon</li> <li>Fix for Teams login popup not closing</li> </ul>"},{"location":"boards/cloud/updates/#march_2","title":"March","text":"<p>2022-03-21</p> <ul> <li>Improve file upload feedback (eg when socket unavailable)</li> <li>Fix duplicates appearing in history from live events</li> <li>Fix first comments not live displaying</li> </ul> <p>2022-03-11</p> <ul> <li>Fix for timeline cards sometimes showing a day off</li> <li>Fix when loading a Community widget where the Board has been deleted causing an inifinite loop</li> </ul> <p>2022-03-09</p> <ul> <li>Fix for pasting into edited comment clears comment</li> <li>Fix for loading subscriptions</li> <li>Reducing browser console noise</li> </ul> <p>2022-03-03</p> <ul> <li>Fix for crashing when tours are dismissed</li> <li>Fix for private card toggle</li> </ul>"},{"location":"boards/cloud/updates/#february_2","title":"February","text":"<p>2022-02-17</p> <ul> <li>Ability to change Private cards to Public</li> <li>Updated Date pickers with month/year selection</li> <li>Updated Material UI library to latest</li> <li>Fix for saving description on modal closure</li> <li>Fix for transfer membership</li> </ul>"},{"location":"boards/cloud/updates/#january_2","title":"January","text":"<p>2022-01-31</p> <ul> <li>Fix for welcome message in Microsoft Teams Bot</li> <li>Fix for lost descriptions on first edit when pasting an image</li> <li>Improved file upload feedback</li> <li>Fix where you could not upload the full 50MB for a file</li> <li>Fix for going to the Boards homepage not group list when in group context</li> <li>Performance improvements</li> </ul> <p>2022-01-14</p> <ul> <li>Fix link format in card history</li> <li>Fix opening URL from MS-Office add-in</li> <li>Update SunEditor to latest</li> </ul> <p>2022-01-04</p> <ul> <li>Fix for notifications on comments to other commenters</li> <li>Fix for emails when users are no longer Board members</li> </ul>"},{"location":"boards/cloud/updates/#2021","title":"2021","text":"<p>2021-12</p> <ul> <li>Fix for child nodes not loading when loading a node directly</li> <li>Fix for completing tasks when multi-assign has been removed</li> <li>Fix for breadcrumbs not displaying when opening a card node directly</li> <li>Adding generic Create Card functionality</li> <li>Fix for requesting too many Connections community members at once</li> <li>Fix for adding tags with the same starting letter</li> <li>Mindmap move card &amp; Board name overflow fixes</li> <li>Update comment count when deleting comment</li> <li>Syncing when description is deleted</li> <li>Board history max card title height</li> <li>Updated Arabic translations</li> </ul> <p>2021-11</p> <ul> <li>Fix for background when RTE in fullscreen mode</li> <li>Fix for opening cards with a theme set</li> <li>Updated Arabic translations</li> <li>Fix for drag&amp;drop assignments creating extra cards</li> <li>Added Recent Updates Feed</li> </ul> <p>2021-10</p> <ul> <li>Updated German translations</li> <li>Microsoft Teams login fix</li> <li>Fix for issue where link is inserted at start of description</li> <li>Fix for issue when changing user account tries to loads the previous open Board</li> <li>Fix for issue when adding group as board member</li> <li>Added user images by API</li> <li>Fix for copy/paste lists in Activity view</li> <li>Fix for compatibility with Visual Update One (Collab Cloud)</li> <li>Fix for issue where multiple toasts in quick succession never auto closed</li> <li>Fix for starting Zaps/Flows with Huddo Boards</li> <li>Auto Premium Trial</li> <li>Enhancement for msgraph groups which are not teams (owner != member)</li> <li>Unsubscribe emails link</li> <li>Fix for logout/login socket issue</li> <li>Fix for Activity view interact to create list</li> <li>Fix for adding Connections/Collab Cloud Communities as members</li> <li>Improved performance by reducing page load size</li> <li>User Presence on cards</li> <li>Improved Activities View performance</li> <li>Improved private card creation process</li> </ul> <p>2021-09</p> <ul> <li>Adding undo/redo buttons to description toolbar</li> <li>Fix for trial dialog opening</li> <li>Better caching and performance of my/public groups</li> <li>Integromat integration</li> <li>User search performance</li> <li>Community name search improvements</li> <li>Admin page crash fix</li> <li>Fix for Teams notifications turning back on when they are disabled</li> </ul> <p>2021-08</p> <ul> <li>Private Card feature</li> <li>Fix for group membership for private groups</li> <li>Improved invite handling</li> <li>Ability to set group permissions for a Board on create in the group</li> <li>More granular user permissions for group membership</li> <li>Fix for ToDo view filtering</li> <li>Update to user subscriptions allowing emails to be applied</li> <li>User subscriptions now default to purchasing user</li> <li>User subscriptions are now named, not first-come-first-serve</li> <li>Better management options for user subscriptions</li> <li>Fix for error thrown when assigning colours in a Board</li> <li>Small screen icon positions, in particular for attached files</li> <li>Various performance updates</li> </ul> <p>2021-07</p> <ul> <li>Fix for access to Boards in Teams</li> <li>Fix for issue where you could not change level of community members</li> <li>Fix for issue when accepting email invites for guest/external users</li> <li>Performance relating to loading times</li> </ul> <p>2021-06</p> <ul> <li>Initial version of this page</li> </ul>"},{"location":"boards/connections/","title":"HCL Connections","text":"<p>Huddo Boards (Activities Plus) for HCL Connections can be deployed in one of two ways:</p> <ol> <li> <p>In HCL Connections Component Pack (CP)</p> <p>Tip</p> <p>This is the recommended approach as the CP includes a Kubernetes environment with an existing Mongo database and S3 storage. Please follow the Component Pack instructions to deploy Huddo Boards.</p> </li> <li> <p>Standalone Kubernetes environment</p> <p>Info</p> <p>This is a more complex setup as you will need to provide/deploy your own Mongo database and S3 storage. Please follow the Kubernetes instructions to deploy Huddo Boards.</p> </li> </ol>"},{"location":"boards/connections/apps-menu-hybrid/","title":"Apps Menu","text":""},{"location":"boards/connections/apps-menu-hybrid/#add-to-apps-menu","title":"Add to Apps Menu","text":"<ul> <li> <p>If you have not customised the apps.jsp file for your connections environment, please make a copy of the file.</p> <ul> <li> <p>You can access the file from:</p> <pre><code>&lt;WAS_home&gt;/profiles/&lt;profile_name&gt;/installedApps/&lt;cell_name&gt;/Homepage.ear/homepage.war/nav/templates/menu\n</code></pre> </li> <li> <p>Paste the copy into the common\\nav\\templates subdirectory in the customization directory:</p> <pre><code>&lt;installdir&gt;\\data\\shared\\customization\\common\\nav\\templates\\menu\\apps.jsp\n</code></pre> </li> </ul> </li> <li> <p>To add the Huddo Boards App Link add the following lines towards the bottom of the apps.jsp file before the <code>&lt;/table&gt;</code> element</p> <pre><code>--%&gt;&lt;tr&gt;&lt;%--\n  --%&gt;&lt;th scope=\"row\" class=\"lotusNowrap\"&gt;&lt;%--\n    --%&gt;&lt;img width=\"16\" src=\"https://boards.huddo.com/img/logo-small.png\" /&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]\"&gt;&lt;%--\n      --%&gt;&lt;strong&gt;&lt;fmt:message key=\"connections.component.name.kudos.boards\" /&gt;&lt;/strong&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/th&gt;&lt;%--\n  --%&gt;&lt;td class=\"lotusNowrap lotusLastCell\"&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]?redirect_to=/todos/assigned\"&gt;&lt;%--\n      --%&gt;&lt;fmt:message key=\"label.menu.kudos.boards.todos\" /&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/td&gt;&lt;%--\n  --%&gt;&lt;td class=\"lotusNowrap lotusLastCell\"&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]?redirect_to=/templates/public\"&gt;&lt;%--\n      --%&gt;&lt;fmt:message key=\"label.menu.kudos.boards.templates\" /&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/td&gt;&lt;%--\n--%&gt;&lt;/tr&gt;&lt;%--\n</code></pre> <p>Where <code>[CONNECTIONS_HOSTNAME_BASE64]</code>is</p> <ul> <li>your Connections hostname base64 encoded.  E.g. <code>connections.example.com</code> =&gt; <code>Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=</code>     There are many free online services to do this, ie here</li> </ul> </li> <li> <p>Save and close the file</p> </li> <li> <p>Add the Huddo Boards Strings for the Apps Menu</p> <ul> <li> <p>Download the strings files and extract the files to the Connections strings customisation directory:</p> <pre><code>&lt;CONNECTIONS_CUSTOMIZATION_PATH&gt;/strings\n</code></pre> </li> <li> <p>Note: Please append the lines to the files if they already exist. Extra languages can also be added</p> </li> </ul> </li> <li> <p>The changes will take effect when the cluster(s) are restarted</p> </li> </ul>"},{"location":"boards/connections/apps-menu-on-prem/","title":"Apps Menu","text":""},{"location":"boards/connections/apps-menu-on-prem/#add-to-apps-menu","title":"Add to Apps Menu","text":"<ul> <li> <p>If you have not customised the apps.jsp file for your connections environment, please make a copy of the file.</p> <ul> <li> <p>You can access the file from:</p> <pre><code>&lt;WAS_home&gt;/profiles/&lt;profile_name&gt;/installedApps/&lt;cell_name&gt;/Homepage.ear/homepage.war/nav/templates/menu\n</code></pre> </li> <li> <p>Paste the copy into the common\\nav\\templates subdirectory in the customization directory:</p> <pre><code>&lt;installdir&gt;\\data\\shared\\customization\\common\\nav\\templates\\menu\\apps.jsp\n</code></pre> </li> </ul> </li> <li> <p>To add the Huddo Boards app links add the following lines towards the bottom of the apps.jsp file before the <code>&lt;/table&gt;</code> element</p> <pre><code>--%&gt;&lt;tr&gt;&lt;%--\n  --%&gt;&lt;th scope=\"row\" class=\"lotusNowrap\"&gt;&lt;%--\n    --%&gt;&lt;img width=\"16\" src=\"https://[CONNECTIONS_URL]/boards/img/logo-small.png\" /&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://[CONNECTIONS_URL]/boards/auth/connections\"&gt;&lt;%--\n      --%&gt;&lt;strong&gt;&lt;fmt:message key=\"connections.component.name.kudos.boards\"/&gt;&lt;/strong&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/th&gt;&lt;%--\n  --%&gt;&lt;td class=\"lotusNowrap lotusLastCell\"&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://[CONNECTIONS_URL]/boards/auth/connections?redirect_to=/todos/assigned\"&gt;&lt;%--\n      --%&gt;&lt;fmt:message key=\"label.menu.kudos.boards.todos\"/&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/td&gt;&lt;%--\n  --%&gt;&lt;td class=\"lotusNowrap lotusLastCell\"&gt;&lt;%--\n    --%&gt;&lt;a href=\"https://[CONNECTIONS_URL]/boards/auth/connections?redirect_to=/templates/public\"&gt;&lt;%--\n      --%&gt;&lt;fmt:message key=\"label.menu.kudos.boards.templates\"/&gt;&lt;%--\n    --%&gt;&lt;/a&gt;&lt;%--\n  --%&gt;&lt;/td&gt;&lt;%--\n--%&gt;&lt;/tr&gt;&lt;%--\n</code></pre> <p>Note: you must replace <code>[CONNECTIONS_URL]</code></p> </li> <li> <p>Save and close the file</p> </li> <li> <p>Add the Huddo Boards Strings for the Apps Menu</p> <ul> <li> <p>Download the strings files and extract the files to the Connections strings customisation directory:</p> <pre><code>&lt;CONNECTIONS_CUSTOMIZATION_PATH&gt;/strings\n</code></pre> </li> <li> <p>Note: Please append the lines to the files if they already exist. Extra languages can also be added</p> </li> </ul> </li> <li> <p>The changes will take effect when the cluster(s) are restarted</p> </li> </ul>"},{"location":"boards/connections/auth-hybrid/","title":"Authenticating Huddo Boards Cloud with HCL Connections","text":""},{"location":"boards/connections/auth-hybrid/#register-oauth","title":"Register OAuth","text":"<p>In order for Huddo Boards to authenticate with your Connections environment, you must define a new OAuth widget.</p> <ol> <li> <p>SSH to the HCL Connections Deployment Manager (substitute the alias)</p> <pre><code>ssh root@[DEPLOY_MANAGER_ALIAS]\n</code></pre> </li> <li> <p>Start <code>wsadmin</code> (substitute your credentials)</p> <pre><code>cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/\n./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd\n</code></pre> </li> <li> <p>Register the new application definition</p> <pre><code>execfile('oauthAdmin.py')\nOAuthApplicationRegistrationService.addApplication('huddoboards', 'Huddo Boards', 'https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]/callback')\n</code></pre> <p>Where <code>[CONNECTIONS_HOSTNAME_BASE64]</code>is</p> <ul> <li>your Connections hostname base64 encoded. E.g. <code>connections.example.com</code> =&gt; <code>Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=</code>     There are many free online services to do this, ie here</li> </ul> </li> <li> <p>To view the uniquely created client clientSecret</p> <pre><code>OAuthApplicationRegistrationService.getApplicationById('huddoboards')\n</code></pre> <p>These commands will print the definition. Please take note of the <code>clientSecret</code>. We will use this later on as</p> <pre><code>CONNECTIONS_URL=https://connections.example.com\nCONNECTIONS_CLIENT_ID=huddoboards\nCONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]\n</code></pre> </li> </ol>"},{"location":"boards/connections/auth-hybrid/#configure-auto-auth","title":"Configure Auto Auth","text":"<p>Steps to configure the Huddo Boards application for auto-authorize (also documented here)</p> <p>Tip</p> <p>this step is optional but recommended and can be done at any time.</p> <ol> <li> <p>Add the new line to the following section in <code>[cellname]/oauth20/connectionsProvider.xml</code></p> <p>Note: keep any existing values and add the new line for <code>huddoboards</code></p> <pre><code>&lt;parameter name=\"oauth20.autoauthorize.clients\" type=\"ws\" customizable=\"true\"&gt;\n  &lt;value&gt;huddoboards&lt;/value&gt;\n&lt;/parameter&gt;\n</code></pre> </li> <li> <p>Recreate the provider via this command:</p> <p>Note: update the wsadmin credentials and the <code>[PATH_TO_CONFIG_FILE]</code></p> <pre><code>./wsadmin.sh -lang jython -conntype SOAP -c \"print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName  [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')\" -user connectionsadmin -password passw0rd\n</code></pre> </li> <li> <p>Restart the WebSphere servers</p> </li> </ol>"},{"location":"boards/connections/auth-on-prem/","title":"HCL Connections OAuth","text":""},{"location":"boards/connections/auth-on-prem/#register-oauth","title":"Register OAuth","text":"<p>In order for Huddo Boards to authenticate with your Connections environment, you must define a new OAuth widget.</p> <ol> <li> <p>SSH to the HCL Connections Deployment Manager (substitute the alias)</p> <pre><code>ssh root@[DEPLOY_MANAGER_ALIAS]\n</code></pre> </li> <li> <p>Start <code>wsadmin</code> (substitute your credentials)</p> <pre><code>cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/\n./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd\n</code></pre> </li> <li> <p>Register the new application definition</p> <pre><code>execfile('oauthAdmin.py')\nOAuthApplicationRegistrationService.addApplication('huddoboards', 'Huddo Boards', 'https://[BOARDS_URL]/auth/connections/callback')\n</code></pre> <p>Where <code>[BOARDS_URL]</code> is the URL of the Boards installation specified previously</p> </li> <li> <p>To view the uniquely created client clientSecret</p> <pre><code>OAuthApplicationRegistrationService.getApplicationById('huddoboards')\n</code></pre> <p>These commands will print the definition. Please take note of the <code>clientSecret</code>. We will use this later on as</p> <pre><code>CONNECTIONS_URL=https://connections.example.com\nCONNECTIONS_CLIENT_ID=huddoboards\nCONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]\n</code></pre> </li> </ol>"},{"location":"boards/connections/auth-on-prem/#configure-auto-auth","title":"Configure Auto Auth","text":"<p>Steps to configure the Huddo Boards application for auto-authorize (also documented here)</p> <p>Tip</p> <p>this step is optional but recommended and can be done at any time.</p> <ol> <li> <p>Add the new line to the following section in <code>[cellname]/oauth20/connectionsProvider.xml</code></p> <p>Note: keep any existing values and add the new line for <code>huddoboards</code></p> <pre><code>&lt;parameter name=\"oauth20.autoauthorize.clients\" type=\"ws\" customizable=\"true\"&gt;\n    &lt;value&gt;huddoboards&lt;/value&gt;\n&lt;/parameter&gt;\n</code></pre> </li> <li> <p>Recreate the provider via this command:</p> <p>Note: update the wsadmin credentials and the <code>[PATH_TO_CONFIG_FILE]</code></p> <pre><code>./wsadmin.sh -lang jython -conntype SOAP -c \"print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName  [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')\" -user connectionsadmin -password passw0rd\n</code></pre> </li> <li> <p>Restart the WebSphere servers</p> </li> </ol>"},{"location":"boards/connections/header-hybrid/","title":"HCL Connections Header","text":"<p>Note</p> <p>This step is optional</p> <p></p>"},{"location":"boards/connections/header-hybrid/#sso","title":"SSO","text":"<p>To integrate yours Connections Header into Huddo Boards Cloud please follow these steps:</p> <ol> <li> <p>Allow CORS - follow these instructions.</p> </li> <li> <p>Enable in Boards</p> <p>Open the Boards admin page, select your <code>Organisation</code>, and then the <code>Connections</code> client</p> <p></p> <p>Tick the checkbox for <code>Load Connections Header via SSO</code> and click <code>Save</code></p> <p></p> <p>Once you reload the page you should see the Connections header!</p> </li> </ol>"},{"location":"boards/connections/header-hybrid/#iframe-deprecated","title":"iFrame (Deprecated)","text":"<p>Warning</p> <p>This option is no longer recommended.</p> <ol> <li> <p>Download the Application</p> <p>The latest .ear from here</p> </li> <li> <p>Login to WebSphere ISC</p> <p>This is usually accessible through a URL like:</p> <pre><code>https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\n</code></pre> <p></p> </li> <li> <p>Open <code>Environment</code> -&gt; <code>WebSphere variables</code></p> <p>Ensure the scope is selected as the <code>Cell</code></p> <p>Click <code>New</code></p> <p></p> </li> <li> <p>Set the following details and click <code>OK</code></p> <pre><code>EXTERNAL_APPS_CONFIG\n{\"boards\":\"https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]\"}\n</code></pre> <p>Where <code>[CONNECTIONS_HOSTNAME_BASE64]</code> is</p> <ul> <li>your Connections hostname base64 encoded. E.g. <code>connections.example.com</code> =&gt; <code>Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=</code></li> </ul> <p></p> </li> <li> <p>The config may require saving. Click <code>Save</code> if presented</p> <p></p> </li> <li> <p>Open <code>Applications</code> -&gt; <code>Application Types</code> -&gt; <code>WebSphere enterprise applications</code></p> <p>Click <code>Install</code></p> <p></p> </li> <li> <p>Select the file and click <code>Next</code></p> <p></p> </li> <li> <p>You can rename the App if you wish, then click <code>Next</code></p> <p></p> </li> <li> <p>Select the checkbox for the module</p> <p>Hold shift while selecting both the <code>WebServer</code> and the <code>AppsCluster</code> from the list</p> <p>Click Apply</p> <p>The Servers should update on the right hand side</p> <p>Click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Finish</code></p> <p></p> </li> <li> <p>The config may prompt to save. Click <code>Save</code></p> <p></p> <p>The application should now be installed</p> </li> <li> <p>Start the Header App</p> <p>Tick the box next to the app name, and click <code>Start</code></p> <p></p> <p>The app should now start. Congratulations, you have installed the app!</p> <p></p> <p>You should now be able to load app can now be loaded at this path</p> <pre><code>https://[CONNECTIONS_URL]/boards\n</code></pre> <p>For example:</p> <pre><code>https://connections.example.com/boards\n</code></pre> </li> </ol>"},{"location":"boards/connections/header-on-prem/","title":"Connections Header Integration","text":"<p>Important</p> <p>This step is only required if you are hosting Huddo Boards on a different domain to HCL Connections.</p> <p></p>"},{"location":"boards/connections/header-on-prem/#connections-header-via-sso","title":"Connections Header via SSO","text":"<p>If you are running Boards on a standalone domain we recommend integrating with the Connections Header using SSO. Please follow these steps:</p> <ol> <li> <p>Allow CORS - follow these instructions.</p> </li> <li> <p>Enable in Boards</p> <p>Open the Boards admin page, select your <code>Organisation</code>, and then the <code>Connections</code> client</p> <p></p> <p>Tick the checkbox for <code>Load Connections Header via SSO</code> and click <code>Save</code></p> <p></p> <p>Once you reload the page you should see the Connections header!</p> </li> </ol>"},{"location":"boards/connections/header-on-prem/#iframe-app-deprecated","title":"iFrame App (Deprecated)","text":"<p>Warning</p> <p>This option is no longer recommended.</p> <ol> <li> <p>Download the Application</p> <p>The latest .ear from here</p> </li> <li> <p>Login to WebSphere ISC</p> <p>This is usually accessible through a URL like:</p> <pre><code>https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\n</code></pre> <p></p> </li> <li> <p>Open <code>Environment</code> -&gt; <code>WebSphere variables</code></p> <p>Ensure the scope is selected as the <code>Cell</code></p> <p>Click <code>New</code></p> <p></p> </li> <li> <p>Set the following details and click <code>OK</code></p> <pre><code>EXTERNAL_APPS_CONFIG\n{\"boards\":\"https://[BOARDS_URL]/auth/connections\"}\n</code></pre> <p>Where <code>[BOARDS_URL]</code> is the URL of the Boards installation specified previously</p> <p></p> </li> <li> <p>The config may require saving. Click <code>Save</code> if presented</p> <p></p> </li> <li> <p>Open <code>Applications</code> -&gt; <code>Application Types</code> -&gt; <code>WebSphere enterprise applications</code></p> <p>Click <code>Install</code></p> <p></p> </li> <li> <p>Select the file and click <code>Next</code></p> <p></p> </li> <li> <p>You can rename the App if you wish, then click <code>Next</code></p> <p></p> </li> <li> <p>Select the checkbox for the module</p> <p>Hold shift while selecting both the <code>WebServer</code> and the <code>AppsCluster</code> from the list</p> <p>Click Apply</p> <p>The Servers should update on the right hand side</p> <p>Click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Finish</code></p> <p></p> </li> <li> <p>The config may prompt to save. Click <code>Save</code></p> <p></p> <p>The application should now be installed</p> </li> <li> <p>Start the Header App</p> <p>Tick the box next to the app name, and click <code>Start</code></p> <p></p> <p>The app should now start. Congratulations, you have installed the app!</p> <p></p> </li> <li> <p>Open Boards</p> <p>You should now be able to load the Boards app with HCL Connections header at this path:</p> <pre><code>https://[CONNECTIONS_URL]/boards\n</code></pre> <p>For example:</p> <pre><code>https://connections.example.com/boards\n</code></pre> </li> </ol>"},{"location":"boards/connections/keycloak/","title":"Keycloak Authentication","text":"<p>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.</p> <p>When using this approch, Huddo Boards will get tokens from keycloak but will still validate them against connections using the url <code>/connections/opensocial/oauth/rest/people/@me/@self</code></p> <p>The following ENV variables should be set to achieve this:</p> Key Description <code>user.env.CONNECTIONS_CLIENT_ID</code> Your Keycloak application client-id <code>user.env.CONNECTIONS_CLIENT_SECRET</code> Your Keycloak application client-secret <code>user.env.CONNECTIONS_URL</code> HCL Connections URL, e.g. <code>https://connections.example.com</code> <code>user.env.CONNECTIONS_KEYCLOAK_URL</code> Your Keycloak URL e.g. <code>https://login.example.com</code> <code>user.env.CONNECTIONS_KEYCLOAK_REALM</code> Your Keycloak realm <code>user.env.CONNECTIONS_KEYCLOAK_PATH</code> Optional: Keycloak pathDefault: <code>/auth/realms</code>Customise this to <code>/realms</code> as of Keycloak v22"},{"location":"boards/connections/migration/","title":"Migration of Activities to Huddo Boards (using standalone Mongo/Redis)","text":"<p>Tip</p> <p>If you are using Component Pack please follow this guide</p> <p>As part of the installation process for Huddo Boards you can run the migration service to move the existing Activities into Huddo Boards.</p> <p>Info</p> <p>Please review the Roles page for details on how Community Activity membership is interpreted &amp; presented by Boards</p>"},{"location":"boards/connections/migration/#difference-between-the-individual-import","title":"Difference between the individual import","text":"<p>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.</p> <p>So you'll need to use the migration service described here to import all data in the new Boards.</p>"},{"location":"boards/connections/migration/#process-overview","title":"Process Overview","text":"<p>This service will:</p> <ol> <li>access Activities data in the existing Connections SQL database</li> <li>process the Activity into a Board</li> <li>get file attachments and long descriptions via mounting the Connections shared drive</li> <li>write Boards data into the Component Pack mongo database</li> <li>write file attachments into S3 storage</li> </ol> <p>Ensure you have updated the following variables as applicable in the <code>global.env</code> section of your <code>boards.yaml</code> file downloaded previously</p> Example Description <code>sharedDrive.server</code> <code>192.168.10.1</code> or <code>websphereNode1</code> IP or Hostname of the server with the Connections shared drive mount <code>sharedDrive.path</code> <code>/opt/HCL/Connections/data/shared</code> or <code>/nfs/data/shared</code> Path on the mount to the Connections shared drive <code>sharedDrive.storage</code> <code>10Gi</code> (optional) The capacity of the PV and PVC <code>sharedDrive.accessMode</code> <code>ReadOnlyMany</code> (optional) The accessMode of the PV and PVC <code>sharedDrive.volumeMode</code> <code>Filesystem</code> (optional) The volumeMode of the PV and PVC <code>sharedDrive.persistentVolumeReclaimPolicy</code> <code>Retain</code> (optional) The persistentVolumeReclaimPolicy of the PV and PVC <code>sharedDrive.storageClassName</code> <code>manual</code> (optional) The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) <code>sharedDrive.spec</code> Example Using a fully custom spec - e.g. FlexVolume or hostPath <code>env.CONNECTIONS_URL</code> <code>httsp://connections.example.com</code> URL of your Connections environment <code>env.FILE_PATH_ACTIVITIES_CONTENT_STORE</code> <code>/data/activities/content</code> 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. <code>env.API_GATEWAY</code> <code>https://[CONNECTIONS_URL]/api-boards</code> URL of the Boards API.Used by files attached to a board. URL. <code>env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME</code> <code>connectionsadmin</code> Credentials for user with <code>admin</code> role on the Activities application.See <code>ISC</code> =&gt; <code>Applications</code> =&gt; <code>Activities</code> =&gt; <code>Security role to user mapping</code> <code>env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD</code> <code>adminpassword</code> Password for the Activities administrator <code>env.CONNECTIONS_DB_TYPE</code> <code>db2</code> or <code>mssql</code> or <code>oracle</code> SQL database type hosting Activities. <code>env.CONNECTIONS_DB_HOST</code> <code>dbserver.company.com</code> SQL Server hostname <code>env.CONNECTIONS_DB_PORT</code> <code>50000</code> or <code>1433</code> or <code>1531</code> SQL Server connection port <code>env.CONNECTIONS_DB_USER</code> <code>dbuser</code> SQL Server user name <code>env.CONNECTIONS_DB_PASSWORD</code> <code>dbpassword</code> SQL Server user password <code>env.CONNECTIONS_DB_SID</code> <code>DATABASE</code> SQL Server SIDNote: applicable to Oracle <code>env.CONNECTIONS_DB_DOMAIN</code> <code>domain</code> SQL Server connection stringNote: applicable to Microsoft SQL <code>env.CONNECTIONS_DB_CONNECT_STRING</code> <code>HOSTNAME=&lt;host&gt;;PROTOCOL=...</code> or <code>&lt;host&gt;:&lt;port&gt;/&lt;sid&gt;</code> SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle <code>env.PROCESSING_PAGE_SIZE</code> <code>10</code> (default) Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database <code>env.PROCESSING_LOG_EVERY</code> <code>50</code> (default) The migration process logs every 50 Activities completed <code>env.IMMEDIATELY_PROCESS_ALL</code> <code>false</code> (default) Process ALL Activities on service startup. <code>env.COMPLETE_ACTIVITY_AFTER_MIGRATED</code> <code>false</code> Mark the old Activity data as complete <code>env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED</code> <code>false</code> Create link to new Board in old Activity <p>Example:</p> <pre><code>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    # ...\n</code></pre>"},{"location":"boards/connections/migration/#deploy-helm-chart","title":"Deploy Helm Chart","text":"<p>Please deploy the following chart with the same configuration <code>boards.yaml</code> file used to deploy the huddo-boards chart</p> <pre><code>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\n</code></pre> <p>Note: the new <code>sharedDrive</code> parameters described above. You may also need to delete the previously name chart</p>"},{"location":"boards/connections/migration/#migrate-activities","title":"Migrate Activities","text":"<p>The migration interface is accessible at <code>https://[BOARDS_URL]/admin/migration</code> to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.</p> <p>You can also set the <code>global.env.IMMEDIATELY_PROCESS_ALL</code> variable if you wish to migrate every Activity without the UI.</p>"},{"location":"boards/connections/migration/#logs","title":"Logs","text":"<p>You can check the pod logs for the activity-migration to see progress of the running migration:</p> <pre><code>kubectl logs -n boards -f $(kubectl get pod -n boards | grep activity-migration | awk '{print $1}')\n</code></pre> <p>When the helm chart was installed in another namespace (<code>helm upgrade ... --namespace my-boards</code>), change <code>-n boards</code> to your modified namespace like <code>-n my-boards</code>. To stop following the logs, press <code>[Ctrl] + [C]</code>.</p> <p>For example</p> <p></p>"},{"location":"boards/connections/migration/#after-migration-complete","title":"After Migration Complete","text":"<ol> <li> <p>The Migration service can be removed. Please use the following command</p> <pre><code>helm delete huddo-boards-activity-migration --purge\n</code></pre> </li> <li> <p>Turn off the Activities application in WebSphere ISC</p> </li> </ol>"},{"location":"boards/connections/mobile-app-hybrid/","title":"HCL Connections Mobile App Setup","text":"<p>Basic instructions for adding Huddo Boards into the HCL Connections mobile application</p>"},{"location":"boards/connections/mobile-app-hybrid/#mobile-app-integration","title":"Mobile App Integration","text":"<ol> <li> <p>Check-out <code>mobile-config.xml</code></p> <pre><code>execfile(\"mobileAdmin.py\")\nMobileConfigService.checkOutConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Edit <code>mobile-config.xml</code></p> <ul> <li>Find the <code>Applications</code> element and add the following <code>Application</code>:<pre><code>&lt;Application name=\"Boards\" enabled=\"true\"&gt;\n  &lt;ApplicationIcon&gt;\n    &lt;Android&gt;\n      &lt;Hdpi&gt;http://boards.huddo.com/img/logo-small.png&lt;/Hdpi&gt;\n      &lt;Mdpi&gt;http://boards.huddo.com/img/logo-small.png&lt;/Mdpi&gt;\n      &lt;Ldpi&gt;http://boards.huddo.com/img/logo-small.png&lt;/Ldpi&gt;\n    &lt;/Android&gt;\n    &lt;IOS&gt;\n      &lt;Reg&gt;http://boards.huddo.com/img/logo-small.png&lt;/Reg&gt;\n      &lt;Retina&gt;http://boards.huddo.com/img/logo-small.png&lt;/Retina&gt;\n    &lt;/IOS&gt;\n    &lt;DefaultLocation&gt;http://boards.huddo.com/img/logo-small.png&lt;/DefaultLocation&gt;\n  &lt;/ApplicationIcon&gt;\n  &lt;ApplicationLabel&gt;Huddo Boards&lt;/ApplicationLabel&gt;\n  &lt;ApplicationURL&gt;https://boards.huddo.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]&lt;/ApplicationURL&gt;\n&lt;/Application&gt;\n</code></pre> </li> </ul> <p>where <code>[CONNECTIONS_HOSTNAME_BASE64]</code> is your Connections hostname base64 encoded.  E.g. <code>connections.example.com</code> =&gt; <code>Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=</code></p> <ul> <li>Find the <code>ApplicationsList</code> or <code>DefaultNavigationOrder</code> element and append <code>Boards</code>. For example:<pre><code>&lt;ApplicationsList&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards&lt;/ApplicationsList&gt;\n</code></pre> <p>or</p> <pre><code>&lt;DefaultNavigationOrder&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards&lt;/DefaultNavigationOrder&gt;\n</code></pre> </li> </ul> </li> <li> <p>Save and check-in <code>mobile-config.xml</code></p> <pre><code>MobileConfigService.checkInConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Sync the <code>Nodes</code> as required</p> </li> </ol>"},{"location":"boards/connections/mobile-app-on-prem/","title":"HCL Connections Mobile App Setup","text":"<p>Basic instructions for adding Huddo Boards into the HCL Connections mobile application</p>"},{"location":"boards/connections/mobile-app-on-prem/#mobile-app-integration","title":"Mobile App Integration","text":"<ol> <li> <p>Check out <code>mobile-config.xml</code></p> <pre><code>execfile(\"mobileAdmin.py\")\nMobileConfigService.checkOutConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Edit <code>mobile-config.xml</code></p> <ul> <li> <p>Find the <code>Applications</code> element and add the following <code>Application</code>:</p> <pre><code>&lt;Application name=\"Boards\" enabled=\"true\"&gt;\n  &lt;ApplicationIcon&gt;\n    &lt;Android&gt;\n      &lt;Hdpi&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Hdpi&gt;\n      &lt;Mdpi&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Mdpi&gt;\n      &lt;Ldpi&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Ldpi&gt;\n    &lt;/Android&gt;\n    &lt;IOS&gt;\n      &lt;Reg&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Reg&gt;\n      &lt;Retina&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/Retina&gt;\n    &lt;/IOS&gt;\n    &lt;DefaultLocation&gt;http://[BOARDS_URL]/img/logo-small.png&lt;/DefaultLocation&gt;\n  &lt;/ApplicationIcon&gt;\n  &lt;ApplicationLabel&gt;Huddo Boards&lt;/ApplicationLabel&gt;\n  &lt;ApplicationURL&gt;https://[BOARDS_URL]/auth/connections&lt;/ApplicationURL&gt;\n&lt;/Application&gt;\n</code></pre> <p>where <code>[BOARDS_URL]</code> is your configured URL for Boards.</p> </li> <li> <p>Find the <code>ApplicationsList</code> or <code>DefaultNavigationOrder</code> element and append <code>Boards</code>. For example:</p> <pre><code>&lt;ApplicationsList&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards&lt;/ApplicationsList&gt;\n</code></pre> <p>or</p> <pre><code>&lt;DefaultNavigationOrder&gt;profiles,communities,files,filesync,wikis,activities,forums,blogs,bookmarks,Boards&lt;/DefaultNavigationOrder&gt;\n</code></pre> </li> </ul> </li> <li> <p>Save and check-in <code>mobile-config.xml</code></p> <pre><code>MobileConfigService.checkInConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Sync the <code>Nodes</code> as required</p> </li> </ol>"},{"location":"boards/connections/security/","title":"Boards Hybrid Security","text":"<p>Huddo Boards connects to your Connections servers over HTTPS via OAuth.</p>"},{"location":"boards/connections/security/#ip-allow-list","title":"IP Allow List","text":"<p>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</p> <pre><code>34.91.118.129/32    GCloud Prod EU Cluster NAT\n34.129.215.36/32    GCloud Staging Cluster NAT\n</code></pre> <p>We communicate over HTTPS, so the port <code>443</code> must be allowed</p>"},{"location":"boards/connections/widgets-hybrid/","title":"HCL Connections Widget Setup","text":"<p>Add Huddo Boards Hybrid widgets into HCL Connections on-premise environments</p>"},{"location":"boards/connections/widgets-hybrid/#community-widget","title":"Community Widget","text":"<ol> <li> <p>SSH to the WAS Deployment Manager</p> </li> <li> <p>Start <code>wsadmin</code></p> <pre><code>cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin\n./wsadmin.sh -lang jython -user wasadmin -password &lt;password-here&gt;\n</code></pre> </li> <li> <p>Check out the <code>widgets-config.xml</code> file.</p> <pre><code>execfile(\"profilesAdmin.py\")\nProfilesConfigService.checkOutWidgetConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Edit the <code>widgets-config.xml</code> file.</p> <p>Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following:</p> <pre><code>&lt;!-- Huddo Boards --&gt;\n&lt;widgetDef defId=\"HuddoBoards\" modes=\"view fullpage\" url=\"{webresourcesSvcRef}/web/com.ibm.social.urliWidget.web.resources/widget/urlWidget.xml\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"width\" value=\"100%\"/&gt;\n        &lt;item name=\"height\" value=\"500px\"/&gt;\n        &lt;item name=\"url\" value=\"https://boards.huddo.com/community/connections\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;!-- END Huddo Boards --&gt;\n</code></pre> </li> <li> <p>Check in the <code>widgets-config.xml</code> file.</p> <pre><code>ProfilesConfigService.checkInWidgetConfig()\n</code></pre> </li> <li> <p>Restart the <code>Communities</code> application via the ISC</p> </li> <li> <p>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.</p> </li> </ol>"},{"location":"boards/connections/widgets-hybrid/#activity-stream-widget","title":"Activity Stream widget","text":"<ol> <li> <p>Open <code>Homepage</code> =&gt; <code>Administration</code></p> <p>Click <code>Add another app</code></p> <p></p> </li> <li> <p>Select the following:</p> <ul> <li><code>OpenSocial Gadget</code></li> <li><code>Trusted</code> and <code>Use SSO</code></li> <li><code>Show for Activity Stream events</code></li> <li><code>All servers</code></li> </ul> <p>Click the <code>Add Mapping</code> button.</p> <p></p> </li> <li> <p>Enter values:</p> <ul> <li>OAuth Client: <code>conn-ee</code></li> <li>Service name: <code>connections_service</code></li> </ul> <p>Click <code>Ok</code></p> </li> <li> <p>Enter the following:</p> Field Value App Title Huddo Boards Stream URL Address <code>https://boards.huddo.com/widgets/connections/url-gadget.xml</code> Icon URL <code>https://boards.huddo.com/favicon.ico</code> </li> <li> <p>Scroll down and click <code>Save</code></p> </li> <li> <p>Select the newly defined app and click <code>Enable</code></p> <p></p> </li> </ol>"},{"location":"boards/connections/widgets-hybrid/#cec-community-highlights","title":"CEC (Community Highlights)","text":"<p>Huddo Boards integrates with Connections Engagement Center</p> <p></p> <ol> <li> <p>Download the Boards Hybrid widget definition file</p> </li> <li> <p>Open the CEC (XCC) main admin page</p> <p>i.e. <code>https://connections.company.com/xcc/main</code></p> </li> <li> <p>Click <code>Customize</code>, <code>Engagement Center Settings</code>, expand <code>Customization Files</code> &amp; click <code>Upload File</code></p> <p></p> <p>Note: you must have the admin role for the <code>Customize</code> button to appear</p> </li> <li> <p>Select the <code>custom.js</code> downloaded previously</p> <p>Note: the file must have this name. If you already have a <code>custom.js</code> file you must manually merge the contents. Copy the <code>HuddoBoards()</code> function and make sure to call it in <code>init()</code></p> </li> <li> <p>To validate:</p> <ol> <li>Open the <code>Highlights</code> application in a Community</li> <li> <p>Click <code>Customize</code>, <code>Widgets</code> and <code>Huddo Boards</code></p> <p></p> </li> <li> <p>The Boards Highlights widget should now appear at the end of the page</p> <p></p> </li> </ol> </li> </ol>"},{"location":"boards/connections/widgets-on-prem/","title":"HCL Connections Widget Setup","text":"<p>Add Huddo Boards Docker widgets into HCL Connections on-premise environments</p>"},{"location":"boards/connections/widgets-on-prem/#community-widget","title":"Community Widget","text":"<ol> <li> <p>SSH to the WAS Deployment Manager</p> </li> <li> <p>Start <code>wsadmin</code></p> <pre><code>cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin\n./wsadmin.sh -lang jython -user wasadmin -password &lt;password-here&gt;\n</code></pre> </li> <li> <p>Check out the <code>widgets-config.xml</code> file.</p> <pre><code>execfile(\"profilesAdmin.py\")\nProfilesConfigService.checkOutWidgetConfig(\"/LCCheckedOut\", AdminControl.getCell())\n</code></pre> </li> <li> <p>Edit the <code>widgets-config.xml</code> file.</p> <p>Find the resource element with the type of community, e.g. <code>&lt;resource ... type=\"community\" ... &gt;</code>, then under <code>&lt;widgets&gt;</code>, then within <code>&lt;definitions&gt;</code> add the following, replacing <code>[BOARDS_URL]</code> with your URL:</p> <pre><code>&lt;!-- Huddo Boards --&gt;\n&lt;widgetDef defId=\"HuddoBoards\" modes=\"view fullpage\" url=\"{webresourcesSvcRef}/web/com.ibm.social.urliWidget.web.resources/widget/urlWidget.xml\" themes=\"wpthemeNarrow wpthemeWide wpthemeBanner\" uniqueInstance=\"true\"&gt;\n    &lt;itemSet&gt;\n        &lt;item name=\"resourceId\" value=\"{resourceId}\"/&gt;\n        &lt;item name=\"width\" value=\"100%\"/&gt;\n        &lt;item name=\"height\" value=\"500px\"/&gt;\n        &lt;item name=\"url\" value=\"https://[BOARDS_URL]/boards/community/connections\"/&gt;\n    &lt;/itemSet&gt;\n&lt;/widgetDef&gt;\n&lt;!-- END Huddo Boards --&gt;\n</code></pre> </li> <li> <p>Disable Community Activity widget</p> <p>Tip</p> <p>this is optional but highly recommended for CP installations of Activities Plus</p> <p>Once Activities are migrated into Boards, it is recommended that the Community Activity widget is disabled to prevent confusion around the old data.</p> <p>Find and comment out the Activity widget with <code>defId=\"Activities\"</code></p> <p></p> </li> <li> <p>Check in the widgets-config.xml file.</p> <pre><code>ProfilesConfigService.checkInWidgetConfig()\n</code></pre> </li> <li> <p>Restart the <code>Communities</code> application via the ISC</p> <p>Tip</p> <p>If widgets no longer load in Communities and you see errors in the browser console like:</p> <pre><code>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\n</code></pre> <p>then please ensure the Connections domain root certificate is trusted in the WebSphere ISC. This can be added using <code>Retrieve from port</code> under <code>SSL certificate and key management</code> &gt; <code>Key stores and certificates</code> &gt; <code>CellDefaultTrustStore</code> &gt; <code>Signer certificates</code></p> </li> <li> <p>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.</p> </li> </ol>"},{"location":"boards/connections/widgets-on-prem/#activity-stream-widget","title":"Activity Stream widget","text":"<ol> <li> <p>Open <code>Homepage</code> =&gt; <code>Administration</code></p> <p>Click <code>Add another app</code></p> <p></p> </li> <li> <p>Select the following:</p> <ul> <li><code>OpenSocial Gadget</code></li> <li><code>Trusted</code> and <code>Use SSO</code></li> <li><code>Show for Activity Stream events</code></li> <li><code>All servers</code></li> </ul> <p>Click the <code>Add Mapping</code> button.</p> <p></p> </li> <li> <p>Enter values:</p> <ul> <li>OAuth Client: <code>conn-ee</code></li> <li>Service name: <code>connections_service</code></li> </ul> <p>Click <code>Ok</code></p> </li> <li> <p>Enter the following, replacing <code>[BOARDS_URL]</code> with your URL:</p> Field Value App Title Huddo Boards Stream URL Address <code>https://[BOARDS_URL]/widgets/connections/url-gadget.xml</code> Icon URL <code>https://[BOARDS_URL]/favicon.ico</code> Icon Secure URL <code>https://[BOARDS_URL]/favicon.ico</code> <p>Scroll down and click <code>Save</code></p> </li> <li> <p>Select the newly defined app and click <code>Enable</code></p> <p></p> </li> </ol>"},{"location":"boards/connections/widgets-on-prem/#cec-community-highlights","title":"CEC (Community Highlights)","text":"<p>Huddo Boards integrates with Connections Engagement Center</p> <p></p> <ol> <li> <p>Download the Boards CP widget definition file</p> </li> <li> <p>Open the CEC (XCC) main admin page</p> <p>i.e. <code>https://connections.company.com/xcc/main</code></p> </li> <li> <p>Click <code>Customize</code>, <code>Engagement Center Settings</code>, expand <code>Customization Files</code> &amp; click <code>Upload File</code></p> <p></p> <p>Note: you must have the admin role for the <code>Customize</code> button to appear</p> </li> <li> <p>Select the <code>custom.js</code> downloaded previously</p> <p>Note: the file must have this name. If you already have a <code>custom.js</code> file you must manually merge the contents. Copy the <code>HuddoBoards()</code> function and make sure to call it in <code>init()</code></p> </li> <li> <p>To validate:</p> <ol> <li>Open the <code>Highlights</code> application in a Community</li> <li> <p>Click <code>Customize</code>, <code>Widgets</code> and <code>Huddo Boards</code></p> <p></p> </li> <li> <p>The Boards Highlights widget should now appear at the end of the page</p> <p></p> </li> </ol> </li> </ol>"},{"location":"boards/connections/customizer/customizer-integrations-package/","title":"Customizer Integrations","text":"<p>Boards adds multiple features to other HCL Connections applications via Connections Customizer. For details about what features this adds, see the usage documentation.</p> <p>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.</p>"},{"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":"<p>Check the rules in your HTTP proxy that direct traffic to <code>mw-proxy</code> (customizer). See the relevant section from the install documentation.</p> <p>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.</p> <p>This example works well. If you have a suggestion for improvement, please open a GitHub issue.</p> <pre><code>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\n</code></pre>"},{"location":"boards/connections/customizer/customizer-integrations-package/#add-resources-to-mw-proxy-server","title":"Add Resources to <code>mw-proxy</code> Server","text":"<ol> <li>Get a terminal session to your <code>mw-proxy</code> server. e.g. via <code>ssh</code></li> <li><code>mkdir /pv-connections/customizations/boards-extensions</code> if it doesn't exist.</li> <li><code>cd /pv-connections/customizations/boards-extensions</code></li> <li>In a web browser, download your custom Boards Extensions package from Huddo Store.</li> <li>Extract this package to <code>/pv-connections/customizations/boards-extensions</code>.</li> <li><code>cat settings.js</code> and check that the \"boardsURL\" property has been set to the URL of your Boards deployment.</li> </ol>"},{"location":"boards/connections/customizer/customizer-integrations-package/#add-the-app-to-connections-app-registry","title":"Add the app to Connections App Registry","text":"<ol> <li>In a web browser, open <code>https://&lt;CONNECTIONS_URL&gt;/files/customizer/boards-extensions/manifest.json</code> You should see JSON similar to the screenshot below. Copy this JSON to the clipboard. If this file doesn't exist, please check you have performed the step above.</li> <li>Open the Connections Customizer App Registry in your environment at <code>https://&lt;CONNECTIONS_URL&gt;/appreg</code></li> <li>Click </li> <li>Open Code Editor</li> <li>Paste the JSON from the clipboard, in to the editor<ul> <li>Your screen should look something like this:   </li> </ul> </li> <li>Click Save Changes. You should see a notice about your changes being saved.</li> <li>Important: Connections customizer only supports one extension that customizes the Connections Navigation (<code>\"type\": \"com.hcl.connections.nav\"</code>). If you already have nav customizations, you must remove the \"Tasks Nav Button\" extension from <code>manifest.json</code> and merge it in to your existing nav customization. Otherwise only one of your nav customisations will take effect.</li> </ol>"},{"location":"boards/connections/customizer/customizer-integrations-package/#disabling-extensions","title":"Disabling Extensions","text":"<p>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.</p> <p>Keep in mind that any changes made will be discarded when following the Updating steps below. </p>"},{"location":"boards/connections/customizer/customizer-integrations-package/#updating","title":"Updating","text":"<p>Remove all files in <code>/pv-connections/customizations/boards-extensions</code>. Repeat the above steps, overwriting the manifest in appreg.</p>"},{"location":"boards/connections/httpd/","title":"Proxy (httpd)","text":"<p>Tip</p> <p>To edit the <code>httpd.conf</code>, please follow this guide.</p> <p>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:</p>"},{"location":"boards/connections/httpd/#a-new-domain","title":"a) New Domain","text":"<ul> <li> <p>Allow CORS - follow these instructions.</p> </li> <li> <p>httpd</p> <pre><code>&lt;VirtualHost *:443&gt;\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&lt;/VirtualHost&gt;\n</code></pre> </li> </ul>"},{"location":"boards/connections/httpd/#b-existing-domain","title":"b) Existing domain","text":"<p>Tip</p> <p>If you have an NGINX (e.g. customizer) in front of IHS use that instead to support websockets and use one less proxy. Follow this guide for nginx.</p> <p>The following configuration should be set when Huddo Boards is deployed at a context root under the existing HCL Connections domain.</p> <p>It also includes a proxy rewrite rule, to serve the migrated Board when the legacy Activity URL is requested.</p> <pre><code>&lt;VirtualHost *:443&gt;\n    ServerName [CONNECTIONS_URL]\n\n    # redirect Activities to Boards once migrated\n    RewriteEngine On\n    RewriteRule ^/activities/service/html/(.*)$ /boards/activities/service/html/$1  [R]\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&lt;/VirtualHost&gt;\n</code></pre> <p>Where:</p> <ul> <li><code>[CONNECTIONS_URL]</code> is the URL of your HCL Connections deployment</li> <li><code>[KUBERNETES_NAME]</code> is the hostname/IP of the master in your cluster</li> <li><code>[KUBERNETES_PORT]</code> is the port of your Ingress Controller (ie 32080)</li> </ul> <p>For example:</p> <pre><code>&lt;VirtualHost *:443&gt;\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&lt;/VirtualHost&gt;\n</code></pre>"},{"location":"boards/connections/httpd/edit/","title":"Edit","text":""},{"location":"boards/connections/httpd/edit/#open-proxy-config","title":"Open Proxy Config","text":"<ol> <li> <p>Open WebSphere ISC</p> <p>This is usually accessible through a URL like:</p> <pre><code>https://[DEPLOY_MANAGER_ALIAS]:9043/ibm/console/logon.jsp\n</code></pre> <p></p> </li> <li> <p>Open <code>Servers</code> -&gt; <code>Server Types</code> =&gt; <code>Web servers</code></p> <p>Click on the name of your web server</p> <p></p> </li> <li> <p>Click <code>Edit</code> on the <code>http.conf</code></p> <p></p> </li> </ol>"},{"location":"boards/connections/httpd/sso-header/","title":"Connections Header via SSO","text":"<p>The following configuration is required to load the Connections Header via SSO from the Boards domain.</p> <ol> <li> <p>Open the <code>httpd.conf</code> as per this guide.</p> </li> <li> <p>Add the following:</p> <p>Note</p> <p>Customise the <code>SetEnvIf</code> domain below as required for your Boards domain.</p> <pre><code># 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\"\n</code></pre> </li> <li> <p>Apply similar changes anywhere that the LtpaToken is issued. For example:</p> <ul> <li> <p>via an <code>nginx</code> proxy:</p> <pre><code># Allow LtpaToken usage from Boards domain\nproxy_cookie_flags LtpaToken Secure SameSite=None;\nproxy_cookie_flags LtpaToken2 Secure SameSite=None;\n</code></pre> </li> </ul> </li> </ol>"},{"location":"boards/connections/httpd/sso-header/#verse-integration","title":"Verse integration","text":"<p>See HCL Domino documentation for more details</p> <p>Tip</p> <p>Users may need to logout and login to Connections again for the LtpaToken cookie to be re-issued with SSO enabled</p>"},{"location":"boards/cp/","title":"Huddo Boards for HCL Connections CP","text":"<p>Info</p> <p>The HCL Connections Component Pack (CP) provides a MongoDB database and Redis cache. Huddo Boards for CP utilises these existing services.  This guide will walk you through the setup to deploy a Minio S3 service for storage, and the Huddo Boards services into your existing CP environment.</p>"},{"location":"boards/cp/#releases","title":"Releases","text":"<p>See the latest changes in our On-Premise Release notes.</p>"},{"location":"boards/cp/#prerequisites","title":"Prerequisites","text":"<ol> <li>HCL Component Pack is installed and running</li> <li>WebSphere environment with Web Server (or another reverse proxy)</li> <li>kubectl is installed and configured</li> <li>helm is installed</li> <li>SMTP gateway setup for email notifications if required</li> </ol>"},{"location":"boards/cp/#ssl-network-setup","title":"SSL / Network setup","text":"<p>Huddo Boards uses the existing CP infrastructure.</p> <p>The UI and API each require a unique route:</p> <ul> <li>UI for Boards: <code>[CONNECTIONS_URL]/boards</code>. We will refer to this as <code>BOARDS_URL</code></li> <li>API Gateway: <code>[CONNECTIONS_URL]/api-boards</code>. We will refer to this as <code>API_URL</code></li> </ul> <p>For more details on configuring a reverse proxy, please see below.</p>"},{"location":"boards/cp/#setup-oauth","title":"Setup OAuth","text":"<p>Please follow our instructions to setup HCL Connections OAuth for Huddo Boards.</p> <p>The OAuth Callback URL for this configuration is <code>https://[BOARDS_URL]/auth/connections/callback</code></p>"},{"location":"boards/cp/#storage","title":"Storage","text":""},{"location":"boards/cp/#s3","title":"S3","text":"<p>Huddo Boards for Component Pack deploys a Minio service. Please follow S3 storage details here to configure the NFS mount.</p>"},{"location":"boards/cp/#mongo","title":"Mongo","text":"<p>Huddo Boards uses the Mongo database already deployed inside the Component Pack. There is no configuration required.</p>"},{"location":"boards/cp/#licence-key","title":"Licence Key","text":"<p>Huddo Boards / Activities Plus is a free entitlement however it requires a licence key from https://store.huddo.com. For more details see here.</p>"},{"location":"boards/cp/#deployment","title":"Deployment","text":""},{"location":"boards/cp/#update-config-file","title":"Update Config file","text":"<p>Download our config file and update all the values inside. Descriptions as below.</p> <p>Kubernetes variables:</p> Key Description <code>global.env.APP_URI</code> <code>https://[BOARDS_URL]</code> (e.g. <code>https://connections.example.com/boards</code>) <code>webfront.ingress.hosts</code> <code>[CONNECTIONS_URL]</code> (no protocol, e.g. <code>connections.example.com</code>) <code>core.ingress.hosts</code> <code>[API_URL]</code> (no protocol, e.g. <code>connections.example.com/api-boards</code>) <code>minio.nfs.server</code> IP address of the NFS Server file mount (e.g. <code>192.168.10.20</code>) <code>minio.storageClassName</code> (Optional) name of the storage class when using dynamic provisioning <p>Boards variables:</p> <p>Are detailed here.</p> <p>Customising Boards notifications:</p> <p>Some elements of the Boards notifications that are sent out can be customised.</p> <p>Activity migration variables:</p> <p>The Activity migration chart will be deployed separately but use the same config file. The variables are described here.</p>"},{"location":"boards/cp/#install-boards-helm-chart","title":"Install Boards Helm Chart","text":"<p>Install the Boards services via our Helm chart</p> <pre><code>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\n</code></pre> <p>Note: <code>--recreate-pods</code> ensures all images are up to date. This will cause downtime.</p>"},{"location":"boards/cp/#proxy-config","title":"Proxy Config","text":"<p>For Connections on-premise you have two options:</p> <ol> <li> <p><code>nginx</code> - if you have an NGINX (e.g. customizer) in front of IHS use that instead to support websockets and use one less proxy. Follow these instructions.</p> </li> <li> <p><code>httpd</code> - please follow these instructions.</p> </li> </ol>"},{"location":"boards/cp/#integrations","title":"Integrations","text":""},{"location":"boards/cp/#hcl-connections","title":"HCL Connections","text":"<ul> <li>Apps Menu</li> <li>Widgets</li> <li>Customizer - Boards Search</li> </ul>"},{"location":"boards/cp/#microsoft-teams","title":"Microsoft Teams","text":"<ul> <li>Install On-Premise App</li> </ul>"},{"location":"boards/cp/#migrate-activities-data","title":"Migrate Activities data","text":"<p>Please follow the instructions here</p>"},{"location":"boards/cp/#subscribing-to-latest-updates-from-huddo-team","title":"Subscribing to latest updates from Huddo Team","text":"<p>Guide here</p>"},{"location":"boards/cp/dockerhub/","title":"Latest Boards releases directly from Dockerhub","text":"<p>Warning</p> <p>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.</p> <p>You can get the latest versions of Huddo Boards Docker by subscribing to our own repository in dockerhub as follows:</p> <ol> <li>Create a dockerhub account if you do not already have one.</li> <li>Email support@huddo.com requesting access to Huddo Boards Docker repository, include your dockerhub account name in the email.</li> <li> <p>Create kubernetes secret with your dockerhub account credentials</p> <pre><code>kubectl create secret docker-registry dockerhub --docker-server=docker.io --docker-username=[user] --docker-password=[password] --docker-email=[email] --namespace=connections\n</code></pre> </li> <li> <p>Once confirmed by reply email, update your <code>boards-cp.yaml</code> file as per this example.</p> <ol> <li> <p>At the top set</p> <ul> <li><code>global.imagePullSecret</code> to <code>dockerhub</code></li> <li>remove your customised <code>global.repository</code></li> <li><code>global.imageTagSuffix</code> as the date of our latest release and uncomment it</li> </ul> </li> <li> <p>Add <code>image.name</code> (blank) and <code>image.tag</code> for each service as per this example.</p> <p>Tip</p> <p>Some of the services (<code>app</code>, <code>provider</code>, <code>notification</code>) might not be in your <code>boards-cp.yaml</code> file, you must add them.</p> <p></p> </li> </ol> </li> <li> <p>Run helm to apply the changes.</p> <pre><code>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\n</code></pre> </li> </ol>"},{"location":"boards/cp/latest/","title":"Moving from your local HCL Connections repository to Huddo Boards latest releases.","text":"<ol> <li> <p>Follow this guide to configure your Kubernetes with access to our images hosted in Quay.io.</p> </li> <li> <p>Once confirmed by reply email, update your <code>boards-cp.yaml</code> file as per this example. At the top set</p> <ul> <li><code>global.imageTag</code> as the date of our latest release</li> <li> <p><code>global.imagePullSecret</code> to the name of the secret you created</p> <p>e.g. <code>&lt;USERNAME&gt;-pull-secret</code></p> <p></p> </li> </ul> </li> <li> <p>Run the Helm upgrade command with our new Huddo chart to apply the changes.</p> <pre><code>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\n</code></pre> <p>Note</p> <p>The chart name has changed. You may need to <code>helm delete kudos-boards-cp</code> first</p> </li> </ol>"},{"location":"boards/cp/minio/","title":"Configure CP S3 Storage Mount","text":""},{"location":"boards/cp/minio/#deploy-instructions","title":"Deploy instructions","text":"<ol> <li> <p>Create the folder on the <code>nfs.server</code></p> <pre><code>sudo mkdir /pv-connections/kudos-boards-minio\nsudo chmod 755 /pv-connections/kudos-boards-minio\n</code></pre> </li> <li> <p>Ensure each Node in your Kubernetes cluster can mount this location.</p> <p>Please modify the file <code>/etc/exports</code> on your NFS Server to include this line</p> <pre><code>/pv-connections/kudos-boards-minio &lt;IP_RANGE_OF_YOUR_SERVERS&gt;/&lt;SUBNET_MASK&gt;(rw,no_root_squash)\n</code></pre> <p>For example:</p> <pre><code>/pv-connections/kudos-boards-minio 192.168.0.0/255.255.0.0(rw,no_root_squash)\n</code></pre> </li> <li> <p>Apply new NFS storage to exports</p> <pre><code>exportfs -ra\n</code></pre> </li> </ol>"},{"location":"boards/cp/releases/","title":"Releases","text":"<p>This page has moved here</p>"},{"location":"boards/cp/migration/","title":"Migration of Activities to Huddo Boards (with Component Pack)","text":"<p>Tip</p> <p>If you are not using Component Pack please follow this guide</p> <p>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.</p> <p>Info</p> <p>Please review the Roles page for details on how Community Activity membership is interpreted &amp; presented by Boards</p>"},{"location":"boards/cp/migration/#process-overview","title":"Process Overview","text":"<p>This service will:</p> <ol> <li>access Activities data in the existing Connections SQL database</li> <li>process the Activity into a Board</li> <li>get file attachments and long descriptions via mounting the Connections shared drive</li> <li>write Boards data into the Component Pack mongo database</li> <li>write file attachments into S3 storage</li> </ol> <p>Ensure you have updated the following variables as applicable in your <code>boards-cp.yaml</code> file downloaded previously</p> Variable Example Description <code>sharedDrive.server</code> <code>192.168.10.1</code> or <code>websphereNode1</code> IP or Hostname of the server with the Connections shared drive mount <code>sharedDrive.path</code> <code>/opt/HCL/Connections/data/shared</code> or <code>/nfs/data/shared</code> Path on the mount to the Connections shared drive <code>sharedDrive.mountOptions</code> <code>-nfsvers=4.1</code> (optional) Any additional sharedDrive mountOptions. All yaml is passed through drive <code>sharedDrive.storage</code> <code>10Gi</code> (optional) The capacity of the PV and PVC <code>sharedDrive.accessMode</code> <code>ReadOnlyMany</code> (optional) The accessMode of the PV and PVC <code>sharedDrive.volumeMode</code> <code>Filesystem</code> (optional) The volumeMode of the PV and PVC <code>sharedDrive.persistentVolumeReclaimPolicy</code> <code>Retain</code> (optional) The persistentVolumeReclaimPolicy of the PV and PVC <code>sharedDrive.storageClassName</code> <code>manual</code> (optional) The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) <code>sharedDrive.spec</code> See below Using a fully custom spec - e.g. FlexVolume or hostPath <code>env.FILE_PATH_ACTIVITIES_CONTENT_STORE</code> <code>/data/activities/content</code> 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. <code>env.API_GATEWAY</code> <code>https://[CONNECTIONS_URL]/api-boards</code> URL of the Boards API.Used by files attached to a board. URL. <code>env.TZ</code> <code>Europe/London</code> or <code>Australia/Hobart</code> etc 'Local' TimezoneUsed for date interpretation. See full list of supported timezones <code>env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME</code> <code>connectionsadmin</code> Credentials for user with <code>admin</code> role on the Activities application.See <code>ISC</code> =&gt; <code>Applications</code> =&gt; <code>Activities</code> =&gt; <code>Security role to user mapping</code> <code>env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD</code> <code>adminpassword</code> Password for the Activities administrator <code>env.CONNECTIONS_DB_TYPE</code> <code>db2</code> or <code>mssql</code> or <code>oracle</code> SQL database type hosting Activities. <code>env.CONNECTIONS_DB_HOST</code> <code>dbserver.company.com</code> SQL Server hostname hostname <code>env.CONNECTIONS_DB_PORT</code> <code>50000</code> or <code>1433</code> or <code>1531</code> SQL Server connection port <code>env.CONNECTIONS_DB_USER</code> <code>dbuser</code> SQL Server user name <code>env.CONNECTIONS_DB_PASSWORD</code> <code>dbpassword</code> SQL Server password password <code>env.CONNECTIONS_DB_SID</code> <code>DATABASE</code> SQL Server SIDNote: applicable to Oracle <code>env.CONNECTIONS_DB_DOMAIN</code> <code>domain</code> SQL Server connection stringNote: applicable to Microsoft SQL <code>env.CONNECTIONS_DB_CONNECT_STRING</code> <code>HOSTNAME=&lt;host&gt;;PROTOCOL=...</code> or <code>&lt;host&gt;:&lt;port&gt;/&lt;sid&gt;</code> SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle <code>env.PROCESSING_PAGE_SIZE</code> <code>10</code> (default) Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database <code>env.PROCESSING_LOG_EVERY</code> <code>50</code> (default) The migration process logs every 50 Activities completed <code>env.IMMEDIATELY_PROCESS_ALL</code> <code>false</code> (default) Process ALL Activities on service startup. <code>env.COMPLETE_ACTIVITY_AFTER_MIGRATED</code> <code>false</code> Mark the old Activity data as complete <code>env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED</code> <code>false</code> Create link to new Board in old Activity"},{"location":"boards/cp/migration/#custom-db-names","title":"Custom DB Names","text":"<p>If you have a custom database names for either the Activities or Profiles database, you can override the defaults using the following variables:</p> Variable Default Description <code>env.CONNECTIONS_DB_ACTIVITIES</code> <code>OPNACT</code> Activities database <code>env.CONNECTIONS_PEOPLEDB_DATABASE</code> <code>PEOPLEDB</code> Profiles database"},{"location":"boards/cp/migration/#peopledb-acl","title":"PeopleDB ACL","text":"<p>Additional Properties for access to <code>PEOPLEDB</code> if separate host or authentication.</p> Variable Default Example Description <code>env.CONNECTIONS_PEOPLEDB_HOST</code> <code>env.CONNECTIONS_DB_HOST</code> <code>dbserver.company.com</code> SQL Server hostname <code>env.CONNECTIONS_PEOPLEDB_PORT</code> <code>env.CONNECTIONS_DB_PORT</code> <code>50000</code> or <code>1433</code> or <code>1531</code> SQL Server connection port <code>env.CONNECTIONS_PEOPLEDB_SID</code> <code>env.CONNECTIONS_DB_SID</code> <code>DATABASE</code> SQL Server SID (for Oracle) <code>env.CONNECTIONS_PEOPLEDB_USER</code> <code>env.CONNECTIONS_DB_USER</code> <code>dbuser</code> SQL Server user name <code>env.CONNECTIONS_PEOPLEDB_PASSWORD</code> <code>env.CONNECTIONS_DB_PASSWORD</code> <code>dbpassword</code> SQL Server user password <code>env.CONNECTIONS_PEOPLEDB_CONNECT_STRING</code> <code>env.CONNECTIONS_DB_CONNECT_STRING</code> <code>HOSTNAME=&lt;host&gt;;PROTOCOL=...</code> or <code>&lt;host&gt;:&lt;port&gt;/&lt;sid&gt;</code> SQL Server connection string"},{"location":"boards/cp/migration/#mssql","title":"MSSQL","text":"Variable Default Example Description <code>env.CONNECTIONS_DB_OPTIONS</code> undefined {\"trustServerCertificate\": true} JSON encoded options for the MS SQL Server connection string."},{"location":"boards/cp/migration/#custom-persistent-volume","title":"Custom Persistent Volume","text":"<p>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.</p> <p>Note</p> <p>We recommend running the helm chart with <code>--dry-run --debug</code> to confirm the yaml output</p> <ol> <li> <p>Host path</p> <p>Tip</p> <p>This can be used in conjunction with existing linux methods (e.g. <code>cifs-utils</code>, <code>smbclient</code> etc) to mount a Windows Samba share directly onto the Kubernetes Node(s).</p> <p>Please read the Kubernetes documentation.</p> <pre><code>migration:\n  sharedDrive:\n    storageClassName: manual\n    spec:\n      hostPath:\n        path: /data/shared\n</code></pre> </li> <li> <p>Kubernetes CIFS Volume Driver (for Samba shares).</p> <p>Please read the CIFS documentation</p> <pre><code>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\n</code></pre> </li> </ol> <p>Additional for Windows</p> <p>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:</p> <ol> <li>Temporarily copy the Activity Store content directory at <code>&lt;SHARED_DRIVE&gt;/activities/content</code> (e.g. <code>/opt/HCL/connections/data/shared/activities/content</code>) to an existing Linux accessible drive (e.g. <code>/pv-connections/activitystore</code>).</li> <li>Set the standard <code>sharedDrive.server</code> &amp; <code>sharedDrive.path</code> to mount this path at <code>/data</code> in the containers</li> <li>Set <code>migration.env.FILE_PATH_ACTIVITIES_CONTENT_STORE: \"/data\"</code></li> </ol>"},{"location":"boards/cp/migration/#deploy-helm-chart","title":"Deploy Helm Chart","text":"<p>Please deploy the following chart with the same configuration <code>boards-cp.yaml</code> file used to deploy the huddo-boards-cp chart</p> <pre><code>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\n</code></pre> <p>Note: the configuration file has changed as of the v3 chart. Please add the new <code>sharedDrive</code> parameters described above</p>"},{"location":"boards/cp/migration/#migrate-activities","title":"Migrate Activities","text":"<p>The migration interface is accessible at <code>https://[CONNECTIONS_URL]/boards/admin/migration</code> to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.</p> <p>You can also set the <code>env.IMMEDIATELY_PROCESS_ALL</code> if you wish to migrate every Activity without the UI.</p>"},{"location":"boards/cp/migration/#logs","title":"Logs","text":"<p>You can check the pod logs for the activity-migration to see progress of the running migration</p> <p>For example</p> <p></p>"},{"location":"boards/cp/migration/#after-migration-complete","title":"After Migration Complete","text":"<ol> <li> <p>The Migration service can be removed. Please use the following command</p> <pre><code>helm delete huddo-boards-cp-activity-migration --purge\n</code></pre> </li> <li> <p>Turn off the Activities application in WebSphere ISC</p> </li> </ol>"},{"location":"boards/cp/migration/interface/","title":"Activity Migration User Interface","text":""},{"location":"boards/cp/migration/interface/#remaining-tab","title":"Remaining Tab","text":"<p>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.</p>"},{"location":"boards/cp/migration/interface/#activities-table","title":"Activities Table","text":"<p>Select Activities to migrate by clicking the checkboxs next to each activity.</p> <p>The table can be sorted by clicking the headers for each column.</p> <p>The number of rows per page can be increased using the <code>Rows</code> dropdown.</p>"},{"location":"boards/cp/migration/interface/#filters","title":"Filters","text":"<p>There are multiple filters that can be applied that will remove activities from the table and the activities included when choosing MIGRATE ALL.</p> <p>Notice that when filters are applied, the total number in the table and MIGRATE ALL button changes.</p>"},{"location":"boards/cp/migration/interface/#options","title":"Options","text":"<p>Near the MIGRATE buttons, there is an Options panel to for enabling features that will affect this migration.</p> <p>WARNING: These options will irreversibly modify your Activities.</p> 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 the <code>CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED</code> 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 <code>COMPLETE_ACTIVITY_AFTER_MIGRATED</code> 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":"<p>This tab shows all of the activities that have been migrated into Huddo Boards. The <code>Activity Name</code> is a link to the Activity. The <code>Board</code> column has links to each Board in Huddo Boards.</p>"},{"location":"boards/cp/migration/interface/#boards-user-data-tab","title":"Boards User Data Tab","text":"<p>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.</p> <p>Each user who has used Huddo Boards WebSphere is likely to have created some of this data. It includes:</p> <ul> <li>The labels a user has assigned to colors which they apply to Board Tiles.</li> <li>The Categories a user has created which they apply to Board Tiles.</li> </ul> <p>If the user already exists in Huddo Boards Docker:</p> <ul> <li>Their color labels will be deleted and replaced with the labels from Boards WebSphere.</li> <li>Imported Categories will be added to their existing list of categories.</li> </ul> <p>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.</p>"},{"location":"boards/cp/roles/","title":"Roles","text":""},{"location":"boards/cp/roles/#member-roles","title":"Member Roles","text":"<p>Boards has the following membership roles</p> 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 &amp; Editors Owners of the Community have <code>Owner</code> role. Members of the Community have <code>Editor</code> role Owned by Owners &amp; Authors Owners of the Community have <code>Owner</code> role. Members of the Community have <code>Author</code> role Shared with  Owned by Owners &amp; Readers Owners of the Community have <code>Owner</code> role. Members of the Community have <code>Reader</code> role Owned by Community Owner Only Owners of the Community have <code>Owner</code> 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":"<p>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.</p>"},{"location":"boards/cp/roles/#activity-in-community","title":"Activity in Community","text":"Activities Boards Owners &amp; Members assigned the Owner role  Owner role is assigned to the entire community  Members are Authors  Role is <code>Owners &amp; Authors</code> as per above  Members are Readers  Role is <code>Owners &amp; Readers</code> as per above  As above, with users specified  Each user is migrated with their role  Members have NO access  Role is <code>Community Owners Only</code> as per above"},{"location":"boards/cp/roles/#standalone-activity","title":"Standalone Activity","text":"Activities Boards"},{"location":"boards/domino/","title":"Boards for HCL Domino (REST API)","text":"<p>Huddo Boards supports authentication, user and group lookup with HCL Domino.</p> <p></p> <p>Using the old Proton configuration?</p> <p>See our migration guide.</p>"},{"location":"boards/domino/#prerequisites","title":"Prerequisites","text":"<ol> <li>Domino REST API installed and configured. Ensure you setup the oauth.json file.</li> <li>Enabled access to names.nsf</li> </ol>"},{"location":"boards/domino/#setup","title":"Setup","text":"<ol> <li> <p>Configure OAuth</p> <p>URLs</p> <p>For an on premise installation the callback url &amp; startup page is simple:</p> <pre><code>https://&lt;BOARDS_URL&gt;/auth/domino/callback\nhttps://&lt;BOARDS_URL&gt;/auth/domino\n</code></pre> <p>For example:</p> <pre><code>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\n</code></pre> <p>Please determine the URL for your environment and then follow this guide.</p> </li> <li> <p>Configure Schema</p> </li> <li> <p>Configure Scope</p> </li> </ol>"},{"location":"boards/domino/#licence","title":"Licence","text":"<p>Huddo Boards requires a licence key from the Huddo Store. For more details see here.</p> <ol> <li>Register your account</li> <li>Create your Organisation</li> <li> <p>Add client details for your Domino server</p> <p></p> </li> <li> <p>Download licence key - this will be used in the environment variable <code>licence.env.LICENCE</code></p> </li> </ol>"},{"location":"boards/domino/#deployment","title":"Deployment","text":"<ol> <li> <p>Deploy Boards using the Domino values in either:</p> <ul> <li>Kubernetes or</li> <li>Docker</li> </ul> </li> </ol>"},{"location":"boards/domino/callback/","title":"Domino Callback URL","text":"<p>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: <code>https://boards.huddo.com/auth/domino/[ encoded domain ]/callback</code></p> <p>e.g. for domain proton.example.com the callback url would be https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback</p> <p>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:</p> <ul> <li><code>https://boards.your.domain.com/auth/domino/callback</code></li> <li><code>https://your.domain.com/boards/auth/domino/callback</code> if you have a context root (i.e. you would access boards application at /boards).</li> </ul>"},{"location":"boards/domino/cloud/","title":"HCL Domino REST API for Boards Cloud","text":"<p>Huddo Boards Cloud supports authentication, user and group lookup with HCL Domino.</p> <p>Tip</p> <p>See Domino REST API for Boards On-Premise for Boards On Premise installations.</p>"},{"location":"boards/domino/cloud/#prerequisites","title":"Prerequisites","text":"<ol> <li>Domino REST API installed and configured. Ensure you setup the oauth.json file.</li> <li>Enabled access to names.nsf</li> </ol>"},{"location":"boards/domino/cloud/#setup","title":"Setup","text":"<ol> <li> <p>Configure OAuth</p> <p>URLs</p> <p>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.</p> <pre><code>// callback URL\nhttps://boards.huddo.com/auth/domino/[ encoded domain ]/callback\n\n// startup page\nhttps://boards.huddo.com/auth/domino/[ encoded domain ]\n</code></pre> <p>e.g. the callback url would look like this: <code>https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback</code></p> <p>Please determine the URL for your environment and then follow this guide.</p> </li> <li> <p>Configure Schema</p> </li> <li> <p>Configure Scope</p> </li> </ol>"},{"location":"boards/domino/cloud/#application-process","title":"Application Process","text":"<p>Please email support@huddo.com with the following details</p> 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/proton/","title":"Huddo Boards for HCL Domino Proton (DEPRECATED)","text":"<p>Warning</p> <p>These instructions are deprecated. Please see the new Domino REST API for new installations. For existing installations we recommend following our migration guide.</p> <p>Huddo Boards supports authentication, user and group lookup with HCL Domino.</p>"},{"location":"boards/domino/proton/#prerequisites","title":"Prerequisites","text":"<ul> <li>Domino Proton (AppDev Pack &gt;= 1.0.12) Documentation</li> <li>Domino IAM service (AppDev Pack &gt;= 1.0.12) Overview</li> <li>User credentials (PEM certificate and Key) for an application user that Boards will use to read a names.nsf database via the Proton Service.</li> </ul>"},{"location":"boards/domino/proton/#setup","title":"Setup","text":"<p>We will require 2 domains from you</p> <ul> <li>Domino Server domain (that has Proton listening)</li> <li>IAM Server domain</li> </ul>"},{"location":"boards/domino/proton/#iam-setup","title":"IAM Setup","text":"<p>Callback URL</p> <p>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: <code>https://boards.huddo.com/auth/domino/[ encoded domain ]/callback</code></p> <p>e.g. for domain proton.example.com the callback url would be https://boards.huddo.com/auth/domino/cHJvdG9uLmV4YW1wbGUuY29t/callback</p> <p>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:</p> <ul> <li><code>https://boards.your.domain.com/auth/domino/callback</code></li> <li><code>https://your.domain.com/boards/auth/domino/callback</code> if you have a context root (i.e. you would access boards application at /boards).</li> </ul> <p>You will need to setup an Application in the IAM Service with the following details</p> 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":"<p>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</p>"},{"location":"boards/domino/proton/#application-process","title":"Application Process","text":"<p>Please email support@huddo.com with the following details</p> 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":"<p>Using the old Proton configuration?</p> <pre><code>If you are using the [old Proton configuration](../proton.md), you will need to migrate to the new Domino REST API configuration. This guide will help you through the process.\n</code></pre>"},{"location":"boards/domino/migration/#prerequisites","title":"Prerequisites","text":"<ol> <li>Domino REST API installed and configured. Ensure you setup the oauth.json file.</li> <li>Enabled access to names.nsf</li> <li>Configured Boards OAuth client</li> <li> <p>Check Release date</p> <p>Ensure you are running images after 30 November 2023</p> <p></p> </li> </ol>"},{"location":"boards/domino/migration/#migration-steps","title":"Migration Steps","text":""},{"location":"boards/domino/migration/#edit-domino-client","title":"Edit Domino Client","text":"<p>Danger</p> <p>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.</p> <ol> <li> <p>Open <code>Admin Settings</code>, then your organisation</p> <p></p> <p></p> </li> <li> <p>Open Domino client</p> <p></p> </li> <li> <p>Edit Domino client</p> <p>Tip</p> <p>Save a copy of the old values in case you need to reverse the changes.</p> <p>Change the old Proton values to new Domino REST API values as configured</p> Comment Domino URL <code>https://&lt;NEW_DOMINO_REST_API&gt;</code> 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. <p>For example:</p> <p></p> <p>Click <code>Save</code></p> </li> </ol>"},{"location":"boards/domino/migration/#deploy-oauth","title":"Deploy OAuth","text":"<ol> <li>Open the <code>boards.yaml</code> configuration file which you have deployed</li> <li> <p>Set environment variables for the user service as follows (substituting the values above)</p> <pre><code>user:\n    env:\n        DOMINO_AUTH_URL: https://&lt;NEW_DOMINO_REST_API&gt;\n        DOMINO_CLIENT_ID: &lt;CLIENT_ID&gt;\n        DOMINO_CLIENT_SECRET: &lt;CLIENT_SECRET&gt;\n        DOMINO_USE_PROFILE_IMAGE_ATTACHMENTS: 'true'\n</code></pre> </li> <li> <p>Run your deploy command (e.g. <code>helm upgrade...</code>, <code>docker compose up</code>)</p> </li> </ol>"},{"location":"boards/domino/migration/#validation","title":"Validation","text":"<p>Warning</p> <p>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.</p> <ol> <li> <p>Open a new Boards session</p> <p>Click <code>Domino</code></p> <p></p> </li> <li> <p>Enter your credentials for the new REST API</p> <p></p> </li> <li> <p>Once Authenticated, you should see the approval request</p> <p>Click <code>Allow</code></p> <p></p> </li> </ol>"},{"location":"boards/domino/oauth/","title":"Configure Domino OAuth (REST API)","text":"<p>This guide will describe how to add a new OAuth application for Boards users to login via Domino.</p> <p></p>"},{"location":"boards/domino/oauth/#steps","title":"Steps","text":"<ol> <li> <p>Open the REST API and click <code>Configuration</code></p> <p></p> </li> <li> <p>Login</p> <p></p> </li> <li> <p>Click <code>Application Management - OAUTH</code></p> <p></p> </li> <li> <p>Click <code>Add Application</code></p> <p></p> </li> <li> <p>Enter the following details and click <code>ADD</code></p> <p>Determine the appropriate URL for your environment as per our guide.</p> <ul> <li>Application Name: <code>Huddo Boards</code></li> <li> <p>Callback URL, e.g.</p> <pre><code>  https://&lt;ON_PREM_BOARDS_URL&gt;/auth/domino/callback\n  https://boards.huddo.com/auth/domino/[encoded domain]/callback\n</code></pre> </li> <li> <p>Startup Page, e.g.</p> <pre><code>  https://&lt;ON_PREM_BOARDS_URL&gt;/auth/domino\n  https://boards.huddo.com/auth/domino/[encoded domain]\n</code></pre> </li> <li> <p>Scope: <code>$DATA</code> (click <code>+</code> icon)</p> </li> <li>Contacts: <code>&lt;YOUR_EMAIL&gt;</code></li> </ul> <p></p> </li> <li> <p>Click the <code>generate application secret</code> icon.</p> <p></p> </li> <li> <p>Copy both the <code>App Id</code> and <code>App Secret</code></p> <p>These will be referred to later as <code>CLIENT_ID</code> and <code>CLIENT_SECRET</code></p> </li> </ol>"},{"location":"boards/domino/schema/","title":"Configure Domino Schema (REST API)","text":"<p>This guide will describe how to add a new Schema called <code>directory</code> to access the <code>names.nsf</code> database. Boards uses the <code>$Users</code> &amp; <code>$Groups</code> views of this database. This section will configure the database forms.</p> <p></p>"},{"location":"boards/domino/schema/#steps","title":"Steps","text":"<ol> <li> <p>Open the REST API and click <code>Configuration</code></p> <p></p> </li> <li> <p>Click <code>Database Management - REST API</code></p> <p></p> </li> <li> <p>Click <code>Add Schema</code></p> <p></p> </li> <li> <p>Enter the following details and click <code>ADD</code></p> <p>Tip</p> <p>If you cannot see <code>names.nsf</code> in the list, please see the HCL documentation</p> <ul> <li>Search Databases for <code>names.nsf</code> and click it</li> <li>Schema Name: <code>directory</code></li> <li>Description: <code>domino directory</code></li> <li>Formula Engine: <code>names.nsf</code></li> </ul> <p></p> </li> <li> <p>Open the new Schema and click the <code>Source</code> tab</p> <p></p> </li> <li> <p>Download this file and paste the contents into the editor</p> </li> </ol>"},{"location":"boards/domino/scope/","title":"Configure Domino Scope (REST API)","text":"<p>This guide will describe how to add a new Scope called <code>directorylookup</code> to allow reader access to the <code>names.nsf</code> database. Boards uses the <code>$Users</code> &amp; <code>$Groups</code> views of this database.</p> <p></p>"},{"location":"boards/domino/scope/#steps","title":"Steps","text":"<ol> <li> <p>Open the REST API and click <code>Configuration</code></p> <p></p> </li> <li> <p>Click <code>Database Management - REST API</code></p> <p></p> </li> <li> <p>Click the <code>Scopes</code> icon in the right menu, click <code>Add Scope</code></p> <p></p> </li> <li> <p>Enter the following details and click <code>ADD</code></p> <ul> <li>Expand the Schemas =&gt; <code>names.nsf</code>. Click <code>directory</code></li> <li>Scope Name: <code>directorylookup</code></li> <li>Description: <code>Directory Lookup</code></li> <li>Maximum Access Level: <code>Reader</code></li> </ul> <p></p> </li> </ol>"},{"location":"boards/dx/","title":"Boards for HCL Digital Experience (DX)","text":""},{"location":"boards/dx/#prerequisites","title":"Prerequisites","text":"<ol> <li>HCL DX environment</li> <li> <p>Environment to host Boards, either:</p> <ul> <li>Kubernetes cluster with <code>kubectl</code> installed &amp; authenticated, or</li> <li>Docker</li> </ul> </li> </ol>"},{"location":"boards/dx/#licence-key","title":"Licence Key","text":"<p>Huddo Boards / Activities Plus is a free entitlement for HCL DX Customers, however it requires a licence key from https://store.huddo.com. For more details see here.</p>"},{"location":"boards/dx/#steps","title":"Steps","text":"<ol> <li> <p>Setup WebSphere OAuth</p> </li> <li> <p>Deploy Boards in either:</p> <ul> <li>Kubernetes or</li> <li>Docker</li> </ul> </li> <li> <p>Configure SSO for Boards</p> </li> <li> <p>Install &amp; configure the Boards portlet</p> </li> </ol>"},{"location":"boards/dx/#integration-options","title":"Integration options","text":"<p>The Boards API is the simplest way of extending Boards into your HCL DX environment.</p> <p>To authenticate, you will need to use the user's API Token. This can be obtained on behalf of the user via SSO. Simply request the <code>/user/auth/dx/&lt;BASE64_HOSTNAME&gt;/apitoken</code> endpoint from the Boards API from the client-side (browser) and include the DX session cookies. Based on your deployment architecture this can be achieved in two ways;</p> <ol> <li> <p>Same Domain</p> <p>If your Boards API is deployed on the same domain as your DX server, you can simply request the API Token from the Boards API like this:</p> <pre><code>https://&lt;DX_SERVER&gt;/api-boards/user/auth/dx/&lt;BASE64_HOSTNAME&gt;/apitoken\n</code></pre> </li> <li> <p>Different Domain</p> <p>If your DX server is not on the same domain as the Boards server, you will need to configure the DX proxy to pass the request through your DX server to the Boards server.</p> <p>The URL will then look like this:</p> <pre><code>https://&lt;DX_SERVER&gt;/wps/proxy/https/&lt;BOARDS_URL&gt;/user/auth/dx/&lt;BASE64_HOSTNAME&gt;/apitoken\n</code></pre> <p>For example:</p> <pre><code>https://dx.company.com/wps/proxy/https/boards.api.huddo.com/user/auth/dx/ZHguY29tcGFueS5jb20=/apitoken\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/proxy/","title":"Proxy","text":"<p>Tip</p> <p>If you are running Boards on a different domain to DX, you may need to configure a proxy to allow DX to connect to Boards. This is because browsers enforce CORS (Cross-Origin Resource Sharing) which prevents DX from making requests to a different domain.</p> <p>DX includes \"Outbound HTTP\" rules which means you can proxy requests to 3rd party domains via DX, overcoming CORS issues in browsers.</p>"},{"location":"boards/dx/auth/proxy/#steps","title":"Steps","text":"<ol> <li> <p>Create a proxy policy for the domain hosting the Boards API (e.g. <code>*.huddo.com</code>)</p> <p><code>vi /opt/HCL/wp_profile/temp/huddo-com-policy.xml</code></p> <pre><code>&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;\n&lt;proxy-rules xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"http://www.ibm.com/xmlns/prod/sw/http/outbound/proxy-config/2.0\"&gt;\n    &lt;policy active=\"true\" basic-auth-support=\"true\" name=\"http_huddo_com_policy\" url=\"http://*.huddo.com*\"&gt;\n        &lt;actions&gt;\n            &lt;method&gt;GET&lt;/method&gt;\n            &lt;method&gt;POST&lt;/method&gt;\n            &lt;method&gt;PUT&lt;/method&gt;\n            &lt;method&gt;DELETE&lt;/method&gt;\n            &lt;method&gt;HEAD&lt;/method&gt;\n        &lt;/actions&gt;\n        &lt;cookie-rule name=\"http_huddo_com_cookies\"&gt;\n            &lt;cookie&gt;*&lt;/cookie&gt;\n            &lt;handling&gt;passthru&lt;/handling&gt;\n        &lt;/cookie-rule&gt;\n    &lt;/policy&gt;\n    &lt;policy active=\"true\" basic-auth-support=\"true\" name=\"https_huddo_com_policy\" url=\"https://*.huddo.com*\"&gt;\n        &lt;actions&gt;\n            &lt;method&gt;GET&lt;/method&gt;\n            &lt;method&gt;POST&lt;/method&gt;\n            &lt;method&gt;PUT&lt;/method&gt;\n            &lt;method&gt;DELETE&lt;/method&gt;\n            &lt;method&gt;HEAD&lt;/method&gt;\n        &lt;/actions&gt;\n        &lt;cookie-rule name=\"https_huddo_com_cookies\"&gt;\n            &lt;cookie&gt;*&lt;/cookie&gt;\n            &lt;handling&gt;passthru&lt;/handling&gt;\n        &lt;/cookie-rule&gt;\n    &lt;/policy&gt;\n&lt;/proxy-rules&gt;\n</code></pre> </li> <li> <p>Apply the policy usng the following command:</p> <pre><code>/opt/HCL/wp_profile/ConfigEngine/ConfigEngine.sh update-outbound-http-connection-config -DConfigFileName=/opt/HCL/wp_profile/temp/huddo-com-policy.xml -DPortalAdminId=YOUR_DX_ADMIN_ID -DPortalAdminPwd=YOUR_DX_ADMIN_PASSWORD -DWasUserId=YOUR_WAS_ADMIN_ID -DWasPassword=YOUR_WAS_ADMIN_PASSWORD\n</code></pre> </li> <li> <p>Import the SSL Certificate so DX can connect</p> <pre><code>/opt/HCL/AppServer/bin/wsadmin.sh -lang jython -username YOUR_WAS_ADMIN_ID -password YOUR_WAS_ADMIN_PASSWORD -c \"AdminTask.retrieveSignerFromPort(\\\"[-keyStoreName NodeDefaultTrustStore -keyStoreScope (cell):dockerCell:(node):dockerNode -host boards.api.huddo.com -port 443 -certificateAlias huddo-com.net -sslConfigName NodeDefaultSSLSettings -sslConfigScopeName (cell):dockerCell:(node):dockerNode ]\\\")\"\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/sso/","title":"Allow SSO for Boards","text":"<p>Tip</p> <p>This task is only required if Boards is hosted on a different domain to HCL DX</p>"},{"location":"boards/dx/auth/sso/#steps","title":"Steps","text":"<p>Complete the following steps for your applicable Proxy Server</p>"},{"location":"boards/dx/auth/sso/#haproxy","title":"haproxy","text":"<p>Edit the <code>haproxy.cfg</code> configuration using the following command</p> <pre><code>kubectl edit configmap &lt;DX_DEPLOYMENT&gt;-haproxy -n &lt;DX_NAMESPACE&gt; -o yaml\n</code></pre> <p>For example:</p> <pre><code>kubectl edit configmap hcl-dx-dev1-haproxy -n hcl-dx-dev1 -o yaml\n</code></pre> <p>Add the following line</p> <pre><code>http-response replace-header Set-Cookie ^(.*) \\1;\\ SameSite=None;\\ Secure\n</code></pre> <p>For example:</p> <p></p>"},{"location":"boards/dx/auth/sso/#httpd","title":"httpd","text":"<p>Edit the <code>httpd.conf</code> configuration file to include the following:</p> <pre><code>Header edit Set-Cookie ^(.*)$ \"$1; Secure; SameSite=None\"\n</code></pre>"},{"location":"boards/dx/auth/websphere/","title":"WebSphere OAuth Config","text":"<p>OAuth must be configured in IBM WebSphere for Boards to authenticate with HCL DX.</p> <p>Tip</p> <p>Remember to replace <code>&lt;username&gt;</code> &amp; <code>&lt;password&gt;</code> with valid credentials</p> <p>Connect to the core server, e.g on Kubernetes:</p> <pre><code>kubectl exec -it hcl-dx-dev1-core-0 core -n hcl-dx-dev1 -- sh\n</code></pre>"},{"location":"boards/dx/auth/websphere/#create-service-provider","title":"Create Service Provider","text":"<p>Note</p> <p>This step is based on the IBM WebSphere documentation - Creating an OAuth service provider.</p> <ol> <li> <p>Create the OAuth provider by using the wsadmin utility</p> <pre><code>cd /opt/HCL/AppServer/bin\n./wsadmin.sh -lang jython -username &lt;username&gt; -password &lt;password&gt;\n\nAdminTask.createOAuthProvider('[-providerName &lt;OAuthProviderName&gt; -fileName &lt;ProviderConfigFile&gt;]')\n</code></pre> <p>Where:</p> <ul> <li><code>&lt;OAuthProviderName&gt;</code> is the OAuth provider name (typically <code>OAuthConfig</code>)</li> <li><code>&lt;ProviderConfigFile&gt;</code> is the full path to the OAuth provider configuration file. Please download and use this DXProvider.xml configuration file which includes Auto Authorize setup for the <code>huddoboards</code> client.</li> </ul> <p>Tip</p> <p>The supplied DXProvider.xml file uses an in-memory store for token storage. You may choose to enable a JDBC database store instead.</p> <p>For example:</p> <pre><code>AdminTask.createOAuthProvider('[-providerName OAuthConfig -fileName /opt/HCL/AppServer/properties/DXProvider.xml]')\nAdminConfig.save()\nquit\n</code></pre> <p>This should copy the configuration file to <code>&lt;was_profile_root&gt;/config/cells/&lt;cell_name&gt;/oauth20</code></p> <p>Please confirm this file exists, e.g. <code>/opt/HCL/wp_profile/config/cells/dockerCell/oauth20/OAuthConfig.xml</code></p> </li> <li> <p>Restart the WebSphere Application Server</p> <pre><code>cd /opt/HCL/AppServer/bin\n./stopServer.sh WebSphere_Portal -profileName wp_profile -username &lt;username&gt; -password &lt;password&gt;\n./startServer.sh WebSphere_Portal -profileName wp_profile\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/websphere/#configure-tai-properties","title":"Configure TAI properties","text":"<ol> <li> <p>Open the ISC</p> <p>Click <code>Global security</code>, expand <code>Web and SIP security</code>, click <code>Trust association</code></p> <p></p> </li> <li> <p>Click <code>Interceptors</code></p> <p></p> </li> <li> <p>Ensure that <code>com.ibm.ws.security.oauth20.tai.OAuthTAI</code> exists</p> <p></p> <p>If not, click <code>New</code> enter the Interceptor class name <code>com.ibm.ws.security.oauth20.tai.OAuthTAI</code>, and click <code>OK</code></p> </li> <li> <p>Update the custom properties to match:</p> <pre><code>provider_1.name=OAuthConfig\nprovider_1.filter=Authorization%=Bearer\n</code></pre> <p>For example:</p> <p></p> </li> </ol>"},{"location":"boards/dx/auth/websphere/#register-oauth-client","title":"Register OAuth Client","text":"<p>Note</p> <p>This step is based on the IBM WebSphere documentation - Creating an OAuth service provider.</p> <ol> <li> <p>Copy default client definitions</p> <pre><code>cp &lt;app_server_root&gt;/properties/base.clients.xml &lt;was_profile_root&gt;/config/cells/&lt;cell_name&gt;/oauth20oauth20/\n</code></pre> <p>For example:</p> <pre><code>cp /opt/HCL/AppServer/properties/base.clients.xml /opt/HCL/wp_profile/config/cells/dockerCell/oauth20/\n</code></pre> </li> <li> <p>Edit file to include Huddo Boards client</p> <p><code>vi /opt/HCL/wp_profile/config/cells/dockerCell/oauth20/base.clients.xml</code></p> <pre><code>&lt;client id=\"huddoboards\" component=\"&lt;OAUTH_PROVIDER_NAME&gt;\" secret=\"&lt;OAUTH_SECRET&gt;\" displayname=\"Huddo Boards\" redirect=\"https://&lt;BOARDS_URL&gt;/auth/dx/&lt;BASE_64_ENCODED_DX_HOSTNAME&gt;/callback\" enabled=\"true\"&gt;\n&lt;/client&gt;\n</code></pre> <p>Where:</p> <ul> <li><code>&lt;OAUTH_PROVIDER_NAME&gt;</code> is the name of the Provider specified above, typically <code>OAuthConfig</code></li> <li><code>&lt;OAUTH_SECRET&gt;</code> is a complex, random secret, e.g. a UUID. This will be required later.</li> <li><code>&lt;BOARDS_URL&gt;</code> is the URL of the Boards deployment, e.g. <code>company.example.com/boards</code> or <code>boards.company.com</code></li> <li><code>&lt;BASE_64_ENCODED_DX_HOSTNAME&gt;</code> is a base64(dx-hostname) encoded string</li> </ul> <p>For example:</p> <pre><code>&lt;client id=\"huddoboards\" component=\"OAuthConfig\" secret=\"a2e3d8c3-7875-4512-a0da-8b5fd61f2245\" displayname=\"Huddo Boards\" redirect=\"https://boards.huddo.com/auth/dx/ZHguY29tcGFueS5jb20=/callback\" enabled=\"true\"&gt;\n&lt;/client&gt;\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/websphere/#install-oauth-application","title":"Install OAuth Application","text":"<p>Note</p> <p>This step is based on the IBM documentation - Enabling your system to use the OAuth 2.0 feature.</p> <ol> <li> <p>Install the OAuth 2.0 service provider application</p> <pre><code>cd /opt/HCL/AppServer/bin\n./wsadmin.sh -f ./installOAuth2Service.py install dockerNode WebSphere_Portal -profileName wp_profile -username &lt;username&gt; -password &lt;password&gt;\n</code></pre> </li> <li> <p>Enable OAuth 2.0 TAI</p> <pre><code>cd /opt/HCL/AppServer/bin\n./wsadmin.sh -lang jython -username &lt;username&gt; -password &lt;password&gt;\nAdminTask.enableOAuthTAI()\nAdminConfig.save()\nquit\n</code></pre> </li> <li> <p>Restart the WebSphere Application Server</p> <pre><code>cd /opt/HCL/AppServer/bin\n./stopServer.sh WebSphere_Portal -profileName wp_profile -username &lt;username&gt; -password &lt;password&gt;\n./startServer.sh WebSphere_Portal -profileName wp_profile\n</code></pre> </li> </ol>"},{"location":"boards/dx/auth/websphere/#troubleshooting","title":"Troubleshooting","text":"<p>Issue: SSL Error</p> <pre><code>ServletWrapper service CWSRV0014E: Uncaught service() exception root cause OAuth20EndpointServlet: javax.net.ssl.SSLHandshakeException: com.ibm.jsse2.util.j: PKIX path building failed: com.ibm.security.cert.IBMCertPathBuilderException: unable to find valid certification path to requested target\n</code></pre> <p>Resolution: Import the self-signed certificate into the WebSphere ISC</p>"},{"location":"boards/dx/portlet/","title":"Boards Portlet","text":""},{"location":"boards/dx/portlet/#overview","title":"Overview","text":"<p>The steps below install the Boards Portlet as an application in DX.</p> <p></p> <p></p>"},{"location":"boards/dx/portlet/#steps","title":"Steps","text":"<p>To install the Huddo Boards portlet, follow these steps:</p>"},{"location":"boards/dx/portlet/#install","title":"Install","text":"<ol> <li> <p>Download the Boards Portlet WAR file</p> </li> <li> <p>Open the DX <code>Administration</code> =&gt; <code>Web Modules</code>. Select the war file and click <code>Next</code></p> <p></p> </li> <li> <p>Click <code>Finish</code> to complete the installation</p> <p></p> </li> </ol>"},{"location":"boards/dx/portlet/#unique-id","title":"Unique ID","text":"<p>Note</p> <p>This step is suggested for best practice.</p> <ol> <li> <p>Go to <code>Settings</code> =&gt; <code>Custom Unique Names</code> and click <code>Portlets</code></p> <p></p> </li> <li> <p>Search for Title starts with <code>huddo</code> and click <code>Edit</code></p> <p></p> </li> <li> <p>Set the <code>Unique .ame</code> to <code>huddo.boards</code> and click <code>OK</code></p> <p></p> </li> </ol>"},{"location":"boards/dx/portlet/#acl","title":"ACL","text":""},{"location":"boards/dx/portlet/#web-module","title":"Web Module","text":"<ol> <li> <p>Find the newly installed <code>Boards</code> portlet, click <code>Assign access to Web module</code></p> <p></p> </li> <li> <p>Click <code>User</code> =&gt; <code>Edit Role</code></p> <p></p> </li> <li> <p>Click <code>Add</code></p> <p></p> </li> <li> <p>Check <code>All Authenticated Portal Users</code> and click <code>OK</code></p> <p></p> </li> </ol>"},{"location":"boards/dx/portlet/#application","title":"Application","text":"<ol> <li> <p>Open <code>Applications</code>, search by title for <code>boards</code>, click <code>Assign access to Web module</code></p> <p></p> </li> <li> <p>Click <code>User</code> =&gt; <code>Edit Role</code></p> <p></p> </li> <li> <p>Click <code>Add</code></p> <p></p> </li> <li> <p>Check <code>All Authenticated Portal Users</code> and click <code>OK</code></p> <p></p> </li> </ol>"},{"location":"boards/dx/portlet/#configure","title":"Configure","text":"<ol> <li> <p>Open the <code>Portlets</code> page, find Huddo Boards, click <code>Configure Portlet</code></p> <p></p> </li> <li> <p>Edit the cfg.BaseURL to <code>https://&lt;BOARDS_URL&gt;</code>.</p> <p>For example:</p> <ul> <li><code>https://boards.company.com</code> or</li> <li><code>https://company.example.com/boards</code></li> <li><code>https://boards.huddo.com</code> (hybrid customers)</li> </ul> <p></p> <p>Click <code>OK</code></p> </li> <li> <p>The <code>Huddo Boards</code> Portlet should now be accessible at</p> <p><code>Edit mode</code> =&gt; <code>Add</code> =&gt; <code>Applications</code></p> <p></p> </li> <li> <p>Add it to any page to get started!</p> <p></p> </li> </ol>"},{"location":"boards/env/common/","title":"Configuration Options","text":""},{"location":"boards/env/common/#shared-options","title":"Shared Options","text":"<p>Please set the following environment variables in your config file as required</p> Key Description <code>global.env.API_GATEWAY</code> Fully qualified URL of the API in the format <code>https://[API_URL]</code> <code>webfront.env.DEFAULT_TEAM</code> 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. <code>licence.env.LICENCE</code> Licence key obtained from the Huddo Store <code>events.env.NOTIFIER_EMAIL_HOST</code> SMTP gateway hostname, e.g. <code>smtp.ethereal.com</code> <code>events.env.NOTIFIER_EMAIL_USERNAME</code> Optional: SMTP gateway authentication.Setting a value will enable auth and use the default port of <code>587</code> <code>events.env.NOTIFIER_EMAIL_PASSWORD</code> Optional: SMTP gateway authentication password <code>events.env.NOTIFIER_EMAIL_PORT</code> Optional: SMTP gateway port. Default: <code>25</code> (OR <code>587</code> if <code>NOTIFIER_EMAIL_USERNAME</code> is set) <code>events.env.NOTIFIER_EMAIL_FROM_NAME</code> Optional: Emails are sent from this name.Default: <code>Huddo Boards</code> <code>events.env.NOTIFIER_EMAIL_FROM_EMAIL</code> Optional: Emails are sent from this email address.Default: <code>no-reply@huddo.com</code> <code>events.env.NOTIFIER_EMAIL_SUPPORT_EMAIL</code> Optional: Support link shown in emails.Default: <code>support@huddo.com</code> <code>events.env.NOTIFIER_EMAIL_HELP_URL</code> Optional: Help link shown in new user welcome email.Default: <code>https://docs.huddo.com/boards/howto/knowledgebase/</code> <code>events.env.NOTIFIER_EMAIL_OPTIONS</code> Optional: Custom NodeMailer email options (insecure tls etc).For example: <code>\"{\\\"ignoreTLS\\\": true,\\\"tls\\\":{\\\"rejectUnauthorized\\\":false}}\"</code> <code>user.env.DISABLE_WELCOME_EMAIL</code> Optional: Set to disable welcome emails for users"},{"location":"boards/env/common/#provider-specific-options","title":"Provider Specific Options","text":""},{"location":"boards/env/common/#hcl-connections","title":"HCL Connections","text":"<p>Tip</p> <p>Optional: These settings are only required if you are using HCL Connections as your authentication provider.</p> Key Description <code>provider.env.WIDGET_ID</code> Optional: ID of the Community widget configured in this step <code>user.env.CONNECTIONS_NAME</code> Optional: If you refer to 'Connections' by another name, set it here <code>user.env.CONNECTIONS_CLIENT_ID</code> oAuth client-id, usually <code>huddoboards</code> <code>user.env.CONNECTIONS_CLIENT_SECRET</code> oAuth client-secret as configured in this step <code>user.env.CONNECTIONS_URL</code> HCL Connections URL, e.g. <code>https://connections.example.com</code> <code>user.env.CONNECTIONS_ADMINS</code> Emails or GUIDs of users to grant admin permissions.e.g. <code>\"[\\\"admin1@company.example.com\\\", \\\"PROF_GUID_2\\\"]</code>\" <code>user.env.CONNECTIONS_KEYCLOAK_URL</code> Optional: See keycloak authentication for more information <code>user.env.CONNECTIONS_KEYCLOAK_REALM</code> Optional: See keycloak authentication for more information"},{"location":"boards/env/common/#hcl-domino","title":"HCL Domino","text":"<p>Tip</p> <p>Optional: These settings are only required if you are using HCL Domino as your authentication provider.</p> Key Description <code>user.env.DOMINO_AUTH_URL</code> HCL Domino REST API URL. See domino authentication for more information <code>user.env.DOMINO_CLIENT_ID</code> oAuth client-id, see domino authentication for more information <code>user.env.DOMINO_CLIENT_SECRET</code> oAuth client-secret, see domino authentication for more information <code>user.env.DOMINO_ADMINS</code> Optional: Emails or GUIDs of users to grant admin permissions.See domino authentication for more information <code>user.env.DOMINO_USE_PROFILE_IMAGE_ATTACHMENTS</code> Optional: set <code>true</code> to enable using profile imagesSee domino authentication for more information <code>user.env.DOMINO_PROFILE_IMAGE_NAME</code> Optional: file name of profile images. Uses first image attached if not setSee domino authentication for more information <code>user.env.DOMINO_AUTH_SCOPE</code> Optional: defaults to <code>$DATA</code>See domino authentication for more information <code>user.env.DOMINO_REST_SCOPE</code> Optional: defaults to <code>directorylookup</code>See domino authentication for more information"},{"location":"boards/env/common/#hcl-digital-experience-dx","title":"HCL Digital Experience (DX)","text":"<p>Tip</p> <p>Optional: These settings are only required if you are using HCL DX as your authentication provider.</p> Key Description <code>user.env.DX_URL</code> HCL DX URL, e.g. <code>https://dx.company.com</code> <code>user.env.DX_CLIENT_ID</code> oAuth client-id, see dx authentication for more information <code>user.env.DX_CLIENT_SECRET</code> oAuth client-secret, see dx authentication for more information <code>user.env.DX_ADMINS</code> Optional: Emails or GUIDs of users to grant admin permissions. <code>user.env.DX_AUTH_PROVIDER_NAME</code> Optional: name of the OAuth Service Provider. Defaults to <code>OAuthConfig</code>"},{"location":"boards/env/notifications/","title":"Customise Emails","text":"<p>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.</p> <p>The image below shows the items that can be customised within notifications: </p> <p></p>"},{"location":"boards/env/notifications/#from-name","title":"From Name","text":"<p>Use <code>events.env.NOTIFIER_EMAIL_FROM_NAME</code> to set the from name for emails Default: <code>Huddo Boards</code></p>"},{"location":"boards/env/notifications/#from-email","title":"From Email","text":"<p>Use <code>events.env.NOTIFIER_EMAIL_FROM_EMAIL</code> to set the sent from email address Default: <code>no-reply@huddo.com</code></p>"},{"location":"boards/env/notifications/#app-logo","title":"App Logo","text":"<p>Specify a URL to point to a hosted logo image by specifying <code>events.env.APP_LOGO_URL</code> in the config.  For example: <code>https://company.com/assets/logo.png</code></p> <p>Note that an inline base64 encoded data URL can also be used for this variable.</p>"},{"location":"boards/env/notifications/#brand-logo","title":"Brand Logo","text":"<p>Specify a URL to point to a hosted logo image by specifying <code>events.env.BRAND_LOGO_URL</code> in the config.  For example: <code>https://company.com/assets/logo.png</code></p> <p>Note that an inline base64 encoded data URL can also be used for this variable.</p>"},{"location":"boards/env/notifications/#social-links","title":"Social Links","text":"<p>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.</p> <p>The standard/default Huddo social links can be replaced by setting the <code>events.env.SOCIAL_LINKS</code> variable. Specifying an empty array will remove all social links.</p> <p>The links are specified in a JSON array of objects with the format: <pre><code> {\n  name: \"Link Name/Text\", \n  link: \"Link URL\", \n  icon: \"(Optional) Hosted Icon URL or data URL\"\n}\n</code></pre></p> <p>e.g.: <pre><code>\"[{\\\"name\\\": \\\"Intranet\\\",\\\"link\\\":\\\"https://company.com/intranet/\\\"}, \n  { \\\"name\\\": \\\"Support\\\", \\\"link\\\": \\\"https://company.com/support\\\", \n    \\\"icon\\\": \\\"https://company.com/assets/support_icon.png\\\"}]\"\n</code></pre></p>"},{"location":"boards/env/notifications/#app-name","title":"App Name","text":"<p>Use <code>events.env.APP_NAME</code> to specify the app name.Default: <code>Huddo Boards</code></p>"},{"location":"boards/env/notifications/#support-email","title":"Support Email","text":"<p>The support email address can be specified in <code>events.env.NOTIFIER_EMAIL_SUPPORT_EMAIL</code>Default: <code>support@huddo.com</code></p>"},{"location":"boards/env/notifications/#email-config-example-yaml","title":"Email Config Example (YAML)","text":"<pre><code>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\n</code></pre>"},{"location":"boards/faq/kubectl/","title":"Configure kubectl","text":"<p>To configure <code>kubectl</code> to connect to your Kubernetes cluster, you need to copy the <code>~/.kube/config</code> file from the Kubernetes master server to your local machine. Please backup any existing local config</p>"},{"location":"boards/faq/languages/","title":"Languages","text":"<p>Huddo Boards supports many languages so our clients all around the world can easily use our product with minimal understanding issues.</p> <p>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.</p> 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":"<p>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.</p>"},{"location":"boards/faq/notifications/#new-user","title":"New User","text":"<p>Trigger First Sign in Recipients User Methods Email</p>"},{"location":"boards/faq/notifications/#user-invite","title":"User Invite","text":"<p>Trigger Inviting a user to a board by their email address Recipients Invitee Methods Email</p>"},{"location":"boards/faq/notifications/#added-to-board","title":"Added to Board","text":"<p>Trigger Adding user/group to a board Recipients Invitee Methods Email, Teams bot, Community stream</p>"},{"location":"boards/faq/notifications/#assigned-task","title":"Assigned Task","text":"<p>Trigger Assigning a user to a card</p> <p>Recipients Assignee Methods Email</p> <p>Recipients Groups that are members Methods Teams bot, Community stream</p>"},{"location":"boards/faq/notifications/#commented","title":"Commented","text":"<p>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</p>"},{"location":"boards/faq/notifications/#mentioned","title":"Mentioned","text":"<p>Trigger @Mentioning another member in a board description Recipients Anyone @Mentioned, Groups that are members Methods Email, Teams bot, Community stream</p>"},{"location":"boards/faq/notifications/#group-notifications","title":"Group Notifications","text":"<p>For boards that have groups as members, these notifications are sent to each group.</p> <p>Trigger Creating a new card, Changing properties of a board/card, Completing a board/card Recipients Group Methods Teams bot, Community stream</p>"},{"location":"boards/faq/notifications/#licence-notifications","title":"Licence Notifications","text":"<p>Trigger Quote Request, Payment Success/Failure, Licence created/updated Recipients Organisation Admins Methods Email</p>"},{"location":"boards/faq/open-source-licences/","title":"Open Source Licences","text":"<p>Huddo Boards builds on many open source frameworks and libraries. These have various licences enabling us to use and distribute the code. We have collected these into an easy file for you to view all of the Open Source Licences.</p>"},{"location":"boards/howto/","title":"User Guides","text":"<p>We have many guides for using Huddo Boards. Please contact us if you have any questions that are not covered.</p>"},{"location":"boards/howto/knowledgebase/","title":"Knowledge Base & Support","text":""},{"location":"boards/howto/knowledgebase/#knowledge-base","title":"Knowledge Base","text":"<p>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!</p> <p>Here are some quick how to guides to help you get started with Huddo Boards.\u00a0</p> <p>\u2b05 Click on the menu options to see more!</p>"},{"location":"boards/howto/knowledgebase/#customer-support","title":"Customer Support","text":""},{"location":"boards/howto/knowledgebase/#troubleshooting","title":"Troubleshooting","text":"<ul> <li>Boards in Microsoft 365</li> </ul>"},{"location":"boards/howto/knowledgebase/#contact","title":"Contact","text":"<p>If you require support using Huddo Boards, contact us at support@huddo.com</p>"},{"location":"boards/howto/mobile-app/","title":"Mobile app","text":"<p>You can access and work with Huddo Boards Cloud on your mobile device.</p>"},{"location":"boards/howto/mobile-app/#download-the-app-to-your-device","title":"Download the app to your device","text":"<p>Download the Huddo Boards Cloud App from either Apple App Store or Google Play Store.</p> <p> </p>"},{"location":"boards/howto/mobile-app/#login-to-the-huddo-boards-app","title":"Login to the Huddo Boards App","text":"<p>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.</p> <p></p> <p>You are in! Now you see all your existing Activities and Boards and can immediately start working!</p>"},{"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":"<p>Admin Guide to setting up Auth0 tenant.</p>"},{"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":"<p>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.</p> <p></p> <p>You'll then be asked to enter your email address and password.</p> <p>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.</p> <p></p>"},{"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":"<p>Huddo Boards provides 2 integration points with HCL Verse:</p>"},{"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":"Index","text":"<p>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.</p>"},{"location":"boards/howto/adding-members/#adding-members-to-a-new-board","title":"Adding Members to a New Board","text":"<p>You can add members when you first create a board.</p> <p>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.</p> <p>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.)</p> <p></p>"},{"location":"boards/howto/adding-members/#adding-members-to-an-existing-board","title":"Adding Members to an Existing Board","text":"<p>At any stage of your work, you can add members to a board.</p> <p>From within your board, select <code>Members</code> 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.</p> <p>Don\u2019t forget to click the <code>Add Members</code> button before closing the window.</p> <p>New members will be notified that they have been invited to your board.  </p> <p></p>"},{"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":"<p>A board can be added to a channel within Teams to help track progress on tasks and create a collaborative work environment.</p> <p>Members of a Team or a Channel will be inherited automatically in to your Huddo Board. </p> <p></p> <p>You can also add members directly to the board by searching them in the <code>Members</code> 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. </p>"},{"location":"boards/howto/archiving-and-restoring/","title":"Index","text":""},{"location":"boards/howto/archiving-and-restoring/#archiving-and-restoring","title":"Archiving and Restoring","text":""},{"location":"boards/howto/archiving-and-restoring/#archiving-vs-permanently-deleting","title":"Archiving vs Permanently Deleting","text":"<p>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.</p> <p>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.</p>"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-card","title":"How do I Archive a Card?","text":"<p>Click in to the card you want to archive. Use the <code>Archive</code> 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.</p> <p></p> <p>Example of an archived card:</p> <p></p> <p>Archived the card by mistake? If you're still in archived card screen, use the <code>Restore</code> button in the top right corner to bring the card back to the board.</p>"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-list","title":"How do I Archive a List?","text":"<p>To Archive a list, click the vertical <code>...</code> icon on the right-hand side of the blue list header and select <code>Archive.</code></p> <p></p> <p>You'll notice that you also have options to archive the list and cards, or just the cards in the list.</p>"},{"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":"<p>If you\u2019ve moved away from the archiving window above, but need to restore / delete a card or list, click the <code>Archived</code> 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 <code>Restore</code> button to return it to the board or the <code>Delete</code> to permanently delete it.</p> <p>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.</p> <p></p>"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-archive-a-board","title":"How do I Archive a Board?","text":"<p>Open the board you intend to archive. Navigate to <code>Open Board Options</code> found in the title of your board, to the left of the search bar.</p> <p></p> <p>In the board options you\u2019ll see the <code>Archive</code> button in the actions shown at the top. Click this button to archive the board.</p> <p></p> <p>The board will change appearance to indicate it has been archived.</p>"},{"location":"boards/howto/archiving-and-restoring/#how-do-i-permanently-delete-a-board","title":"How do I permanently delete a board?","text":"<p>Warning</p> <p>You can\u2019t restore or retrieve the board or any of the cards in it, if you delete permanently</p> <p>Option 1: If you\u2019re still within the screen above, you can use the <code>Delete</code> button to delete the board. If you\u2019ve navigated out of that screen but remain in the board, click the board title to <code>Open Board Options</code> and use the <code>Delete</code> button.</p> <p>Option 2: Delete any board you\u2019ve archived by navigating to the <code>Archive</code> tab on your My Boards dashboard page. Click in to the board you want to delete, click the board title to <code>Open Board Options,</code> and click <code>Delete.</code></p>"},{"location":"boards/howto/archiving-and-restoring/#how-to-restore-a-board","title":"How to restore a board","text":"<p>Option 1: If you\u2019re still within the screen above, you can use the <code>Restore</code> button to restore the board. If you\u2019ve navigated out of that screen but remain in the board, click the board title to <code>Open Board Options</code> and use the <code>Restore</code> button.</p> <p>Option 2: Restore any board you\u2019ve archived by navigating to the <code>Archive</code> tab on your My Boards dashboard page. Click in to the board you want to restore, click the board title to <code>Open Board Options,</code> and click <code>Restore.</code></p> <p></p>"},{"location":"boards/howto/assignment-roles/assignment-roles/","title":"Assignment Roles","text":"<p>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.</p>"},{"location":"boards/howto/assignment-roles/assignment-roles/#create-a-template-with-assignment-roles","title":"Create a Template with Assignment Roles","text":"<p>Start off by creating a template following the steps in the Create a Template article. </p> <p>Once your template has been created and opened, open the Members dialog by clicking on Members in the right side bar.  </p> <p>In the dialog that opens, there will be a section for Assignment Roles. Click the Create button to create a new role.  </p> <p>Give your role a name and select an icon. A color will be automatically assigned to the role. Click Save to create the role.  </p> <p>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.</p> <p> </p> <p>You can assign roles to tasks just as you would a board member.</p> <p> </p> <p>See the section on using a template to see how Assignment Roles are used when creating a board from a template.</p>"},{"location":"boards/howto/attaching-files/","title":"Index","text":"<p>Huddo Boards allows files under <code>50MB</code> to be attached to cards directly.</p> <p>Anyone who has access to view the card will be able to view and download the attachment.</p> <p>Tip</p> <p>This feature can be disabled organisation wide by an administrator if desired.</p>"},{"location":"boards/howto/attaching-files/#microsoft-365-onedrive-hcl-connections-files","title":"Microsoft 365 (OneDrive) &amp; HCL Connections (Files)","text":"<p>If you use Microsoft 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.</p>"},{"location":"boards/howto/attaching-files/#attaching-a-file-to-a-card","title":"Attaching a File to a Card","text":"<p>Once you have opened your desired card, you can drag&amp;drop a file to upload it, otherwise you can use the UI by:</p> <p>Clicking the <code>Links and Attachments</code> </p> <p>In the menu that appears, choose <code>Upload to this board.</code></p> <p></p> <p>Locate the file(s) you wish to attach and click open.</p> <p>Your file will now appear in the Links and Attachments list.</p> <p></p>"},{"location":"boards/howto/attaching-files/#removing-an-attached-file","title":"Removing an Attached File","text":"<p>To remove an attached file, navigate to the <code>...</code> 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.</p>"},{"location":"boards/howto/attaching-files/#who-can-remove-files","title":"Who Can Remove Files?","text":"<p>Anyone who can edit the card can also remove the attached files.</p>"},{"location":"boards/howto/attaching-files/#where-are-files-stored","title":"Where are Files Stored?","text":"<p>Files attached to cards in Huddo Boards Cloud with Auth0, Google, Facebook, LinkedIn authentication providers are stored in a Google Cloud Storage.</p> <p>If you are hosting Huddo Boards yourself then files are stored in the default file storage as defined in your environment.</p> <p>If you are using Microsoft 365 or HCL Connections, your files are stored within these environments.</p>"},{"location":"boards/howto/attaching-files/#deleting-a-card-that-has-attachments","title":"Deleting a Card that has Attachments","text":"<p>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.</p>"},{"location":"boards/howto/attaching-files/#adding-emails-as-files","title":"Adding Emails as Files","text":"<p>Huddo Boards is an eml dropzone such that you are able to drag &amp; 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.</p>"},{"location":"boards/howto/attaching-files/#outlook","title":"Outlook","text":"<p>In order to allow Outlook to do this, we are aware of the Outlook2Web program that can facilitate this.</p>"},{"location":"boards/howto/connections/connections-ui/","title":"HCL Connections UI Integrations","text":"<p>Huddo Boards can integrate features directly in to HCL Connections user interface that enable you to:</p> <ul> <li>see tasks related to the current HCL Connections content</li> <li>share pages from HCL Connections to Huddo Boards</li> <li>show Huddo Boards data in search results</li> </ul> <p>If you're an administrator looking for how to set this up, see the install documentation here.</p>"},{"location":"boards/howto/connections/connections-ui/#related-tasks","title":"Related Tasks","text":"<p>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.</p> 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":"<p>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.</p> Huddo Boards results when searching all content Huddo Boards results when searching from the sidebar"},{"location":"boards/howto/dependencies/","title":"Index","text":""},{"location":"boards/howto/dependencies/#task-dependencies-in-huddo-boards","title":"Task Dependencies in Huddo Boards","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/dependencies/#creating-a-task-dependency","title":"Creating a Task Dependency","text":"<p>Task dependencies can be created in several ways:</p>"},{"location":"boards/howto/dependencies/#within-an-open-task","title":"Within an open task","text":"<ol> <li>Click on a task to open its details.</li> <li> <p>Find and click the <code>Add Dependency</code> button in the task bar:</p> <p></p> <ul> <li>Note that depending on your screen size, you may need to use the More... menu to access the <code>Add Dependency</code> Button:</li> </ul> <p></p> <ul> <li>Once dependencies have been added to a task, <code>Add Dependency</code> buttons will also be available within the task details view here:</li> </ul> <p></p> </li> <li> <p>The Add Dependency Dialog will be shown:</p> <p></p> </li> <li> <p>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. </p> <ul> <li>Note that this relationship can be reversed by clicking the <code>Swap Direction</code> button </li> </ul> </li> <li>Click the <code>Add</code> button to create the task dependency.</li> </ol>"},{"location":"boards/howto/dependencies/#drag-from-task-to-task-in-the-timeline-view","title":"Drag from task to task in the Timeline view","text":"<ol> <li>Open the <code>Timeline</code> view of your board.</li> <li>Ensure that the parent and child tasks for the dependency you want to create are scheduled and appear on the timeline.</li> <li>Dependencies can be created from child (starting task) to parent (ending task). The parent waits for child to be completed first. To create a new dependency, first hover the cursor over a task to see the add dependency drag icon appear on the bottom right edge (a blue arrow).</li> <li>Hover over the arrow icon, then click and drag it to the intended parent dependency task. An arrow will be drawn as you drag, and the task you have dragged onto will have a blue highlighted border.</li> <li> <p>Drop the icon onto the intended task and the dependency relationship will be created.</p> <ul> <li>Note that if the icon is dragged and dropped onto a task that is already a dependency of the originating task, then nothing will happen.</li> </ul> <p> 6. Once the dependency has been created then dependency icons can be observed on both the parent and child of the dependency.</p> <p></p> </li> </ol>"},{"location":"boards/howto/dependencies/#showing-dependencies-on-a-task","title":"Showing dependencies on a task","text":"<p>Opening a (either a child or parent) task with dependencies will list those dependencies on the task details view.</p> <p></p> <ul> <li>From this view, it is possible to remove a dependency by clicking the remove icon .</li> </ul> <p></p> <ul> <li>Dependant tasks can be completed in this view by clicking the complete task checkbox.</li> </ul> <p></p> <ul> <li>Clicking anywhere else on the dependant task will open up its task details.</li> </ul>"},{"location":"boards/howto/dependencies/#visualising-task-dependencies-on-a-board","title":"Visualising task dependencies on a board","text":"<p>Dependencies for a particular task can be displayed/visualised in various ways depending on what view you are using to display your board.</p>"},{"location":"boards/howto/dependencies/#board-view","title":"Board view","text":"<ul> <li>Hover on the dependencies icon on a task card for a moment to highlight its dependencies.  Note that numbers appear in the top right of the highlighted cards to indicate the order that they need to be completed. </li> </ul>"},{"location":"boards/howto/dependencies/#activity-view","title":"Activity view","text":"<ul> <li>Hover on the dependencies icon on a task card for a moment to highlight its dependencies.  Note that numbers appear in the top right of the highlighted cards to indicate the order that they need to be completed. </li> </ul>"},{"location":"boards/howto/dependencies/#mindmap","title":"Mindmap","text":"<ul> <li>Hover on the dependencies icon on a task card for a moment to highlight its dependencies.  Note that numbers appear in the top right of the highlighted cards to indicate the order that they need to be completed. </li> </ul>"},{"location":"boards/howto/dependencies/#timeline","title":"Timeline","text":"<p>Timeline view is the best way to visually observe dependencies as arrows drawn between scheduled tasks. </p> <p>There are several options available for showing dependency arrows in the timeline view, controlled by settings in the right hand sidebar:</p> <p></p>"},{"location":"boards/howto/dependencies/#show-all-dependency-arrows","title":"Show all dependency arrows","text":"<p>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. </p>"},{"location":"boards/howto/dependencies/#hide-dependency-arrows","title":"Hide dependency arrows","text":"<p>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.</p>"},{"location":"boards/howto/dependencies/#hover-on-a-task-to-highlight-its-dependency-chain","title":"Hover on a task to highlight its dependency chain","text":"<p>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. </p> <p> When <code>Hover on a task to highlight its dependency chain</code> 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. </p> <p> See the animation below as an example of 2 levels of dependency depth.</p> <p></p>"},{"location":"boards/howto/dependencies/#completing-a-task-that-has-dependencies","title":"Completing a task that has dependencies","text":"<p>Attempting to complete a task that has incomplete dependencies will trigger the following dialog: </p> <p>*Note that individual tasks cannot be completed from this view.</p>"},{"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":"<p>Click this to complete the task after completing all of its preceding dependencies as displayed in the dialog.</p>"},{"location":"boards/howto/dependencies/#cancel","title":"Cancel","text":"<p>Close the dialog without taking an action.</p>"},{"location":"boards/howto/getting-started/","title":"Getting Started","text":""},{"location":"boards/howto/getting-started/#getting-started","title":"Getting Started","text":"<p>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!</p> <p>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</p> <p>Here are some quick instructions to help you get started with Huddo Boards.</p>"},{"location":"boards/howto/getting-started/#create-a-board","title":"Create A Board","text":"<ol> <li>From the My Boards homepage, click on the <code>New Board</code> button, or use the <code>+</code> buttons as indicated below.</li> </ol> <ol> <li> <p>Enter a name and description for your new board. Don't worry you can edit these later.</p> </li> <li> <p>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.</p> </li> </ol> <p></p> <ol> <li>Select from our range of quick templates; Search the template library for a more sophisticated template; Or Select <code>Blank</code> to choose your own adventure!</li> <li>Select the starting view for your board from the three available options: <code>Kanban</code>, <code>Mindmap</code> and <code>Timeline</code>. Note that the view of the board can be switched at any point in time.</li> </ol> <p></p> <ol> <li>Click <code>Create</code></li> <li>The board is now ready to use!</li> </ol>"},{"location":"boards/howto/getting-started/#kanban-view-add-lists-and-cards","title":"Kanban View - Add Lists and Cards","text":"<p>Add lists to a board to categorise todos and entries. Click on Add a list to add a new list to your board.</p> <p></p> <p>Click on Add a card in any list to add a card to that list.</p> <p></p> <p>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.</p>"},{"location":"boards/howto/getting-started/#assign-tasks-to-others","title":"Assign Tasks To Others","text":"<p>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.).</p> <p></p>"},{"location":"boards/howto/getting-started/#plan-your-tasks","title":"Plan Your Tasks","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/getting-started/#view-card-details","title":"View Card Details","text":"<p>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!</p> <p></p>"},{"location":"boards/howto/getting-started/#edit-board-options","title":"Edit Board Options","text":"<p>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.</p>"},{"location":"boards/howto/getting-started/#add-and-remove-board-members","title":"Add and Remove Board Members","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/getting-started/#colour-code-your-cards","title":"Colour Code Your Cards","text":"<p>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.</p>"},{"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":"<p>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. </p> <p>To see your boards organised by colour, set your <code>View</code> to Colours.</p> <p></p>"},{"location":"boards/howto/homepage/","title":"Myboards Dashboard - Homepage","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/homepage/#on-this-start-page-you-can","title":"On this start page you can:","text":"<ul> <li> <p>Create a new Board by clicking on the Plus sign and Create</p> </li> <li> <p>Open an existing Board by clicking on one of the tiles</p> </li> <li> <p>Search for a Board by entering the search word in the Search Boards field at the top</p> </li> <li> <p>Filter Boards by My, Public and Archive</p> </li> <li> <p>Sort Boards by Recent and Last accessed</p> </li> <li> <p>Colours These are colour tags you can drag and drop onto the tiles. Click on the menu to edit the tags.</p> </li> <li> <p>Add tags to the Boards for easy sorting and filtering in the same way as with colours above.</p> </li> <li> <p>See all your collected tasks from all your Boards by clicking on Todos</p> </li> <li> <p>Find the template library by clicking on Templates</p> </li> </ul>"},{"location":"boards/howto/ical/board/","title":"Board","text":""},{"location":"boards/howto/ical/board/#board-icalendar-feed","title":"Board iCalendar feed","text":"<p>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.</p> <p>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.</p>"},{"location":"boards/howto/ical/board/#enabling-a-calendar-feed-for-a-board","title":"Enabling a calendar feed for a board","text":"<ol> <li> <p>Navigate to <code>Open Board Options</code> found in the title of your board, to the left of the search bar.</p> <p></p> </li> <li> <p>Underneath the action bar on the right hand sideyou will see an <code>iCalendar feed</code> box with an <code>Enable</code> button. Click this to enable the calendar feed for this board.</p> <p></p> </li> <li> <p>After clicking enable, additional buttons will become available for subscribing to, copying the link for, or disabling the calendar feed:</p> <p></p> <ol> <li>Click <code>Subscribe</code> to open your chosen calendar app for your operating system and subscribe to the feed.</li> <li> <p>Click <code>Copy feed link</code> 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.</p> <p>Info</p> <p>You may experience an error similar to the following when attempting to subscribe to a board calendar feed within Microsoft Outlook for Windows.</p> <p></p> <p>In this case, follow the steps shown here to disable shared calendar improvements. After restarting Outlook, the calendar subscription should now work.</p> </li> <li> <p>Click <code>Disable</code> 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.</p> </li> </ol> </li> </ol>"},{"location":"boards/howto/ical/personal/","title":"Personal","text":""},{"location":"boards/howto/ical/personal/#personal-icalendar-feed","title":"Personal iCalendar feed","text":"<p>A calendar feed can be subscribed to for all scheduled tasks you are assigned to within Huddo Boards.</p> <p>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.</p>"},{"location":"boards/howto/ical/personal/#subscribing-to-your-personal-calendar-feed","title":"Subscribing to your personal calendar feed","text":"<ol> <li> <p>From the My Boards Dashboard/Homepage, navigate to my <code>Todos</code> found in the left hand side menu.</p> <p></p> </li> <li> <p>Once in the Todos view you will see an iCalendar feed section at the bottom of the left hand side menu.</p> <p></p> <ol> <li>Click <code>Subscribe</code> to open your chosen calendar app for your operating system and subscribe to the feed.</li> <li>Click <code>Copy feed link</code> to copy the link to the feed to your clipboard. This may be useful for pasting into a calendar application.</li> </ol> <p>Info</p> <p>You may experience an error similar to the following when attempting to subscribe to a calendar feed within Microsoft Outlook for Windows.</p> <p></p> <p>In this case, follow the steps shown here to disable shared calendar improvements. After restarting Outlook, the calendar subscription should now work.</p> </li> </ol>"},{"location":"boards/howto/import-activity/import/","title":"Import Activities","text":""},{"location":"boards/howto/import-activity/import/#import-a-single-activity-for-hybrid-installations","title":"Import a single activity for Hybrid Installations","text":"<p>Activities that already exist in HCL Connections can be individually imported into Huddo Boards.</p> <p>First, hover over the 'Create Board' button in the bottom right and select the 'Import from Activities' option that appears</p> <p></p> <p>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.</p> <p></p> <p></p>"},{"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":"<p>The Huddo Boards integration with Microsoft OneDrive allows you to find files that you have added to boards, conveniently located in your OneDrive.</p> <p>In the example below, a file titled \"Best Melbourne Restaurants\" has been added to the board, Food Objectives 2019.</p> <p> </p> <p>The file will be added to OneDrive for easy access and location.</p> <p> </p> <p>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.</p> <p>Files will be added to OneDrive whether they are from private or shared boards.</p>"},{"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":"<p>Huddo Boards' integration with Microsoft 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.</p>"},{"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":"<p>Navigate to the email you would like to attach as a card to a board. Click the <code>Save email as card</code> button in the <code>Home</code> ribbon.</p> <p></p> <p>The title of the email will automatically be filled, however you have the opportunity to change this if you wish. Select to <code>Include email body</code> 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.</p> <p></p> <p>Click <code>Create</code>.</p> <p>In the next window, click the <code>Open in Boards</code> button to be taken to the board and see the card. It will look something like this:</p> <p></p>"},{"location":"boards/howto/microsoft/outlook/#web-outlook","title":"Web Outlook","text":"<p>Navigate to the email you would like to attach as a card to a board. Click the <code>...</code> for more actions and scroll down to select <code>Huddo Boards</code>.</p> <p></p> <p>The title of the email will automatically be filled, however you have the opportunity to change this if you wish. Select to <code>Include email body</code> 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.</p> <p>Click <code>Create</code>.</p> <p>In the next window, click the <code>Open in Boards</code> button to be taken to the board and see the card. It will look something like this:</p>"},{"location":"boards/howto/microsoft/outlook/#attach-a-card-list-or-board-to-an-email","title":"Attach a Card, List or Board to an Email","text":""},{"location":"boards/howto/microsoft/outlook/#desktop-outlook_1","title":"Desktop Outlook","text":"<p>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.</p> <p>On Desktop Outlook, you'll find the <code>Attach Board/Card</code> button in the <code>Message</code> ribbon.</p> <p>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 <code>Attach</code> when you've made your selection. Continue to add more by repeating the same selection process and attaching to the email.</p> <p></p>"},{"location":"boards/howto/microsoft/outlook/#web-outlook_1","title":"Web Outlook","text":"<p>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.</p> <p>Click the <code>...</code> at the bottom of the email and select <code>Huddo Boards</code>.</p> <p></p> <p>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 <code>Attach</code> when you've made your selection. Continue to add more by repeating the same selection process and attaching to the email.</p> <p></p>"},{"location":"boards/howto/microsoft/sharepoint/","title":"Microsoft SharePoint","text":""},{"location":"boards/howto/microsoft/sharepoint/#embedding-huddo-boards-in-a-sharepoint-site-page","title":"Embedding Huddo Boards in a SharePoint Site Page","text":"<p>Huddo Boards' integration with Microsoft 365 allows you to add Huddo Boards to a SharePoint site page and work directly on the board from the page.</p> <p>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.</p> <p></p> <p>Before proceeding, you will need a site admin to enable security settings as described here</p> <ol> <li> <p>From Sharepoint main menu, go to <code>Pages</code> -&gt; <code>New</code> -&gt; <code>Site Page</code></p> <p></p> </li> <li> <p>Give your page a name, then click the <code>+</code></p> <p></p> </li> <li> <p>Choose <code>Embed</code> from the drop down menu</p> <p></p> </li> <li> <p>Open Huddo Boards and select the board you wish to embed in the sharepoint page. Click the <code>Board Options</code> button</p> <p></p> </li> <li> <p>Click <code>Copy embed code</code></p> <p></p> </li> <li> <p>Go back to sharepoint and paste the code you copied in the box provided</p> <p></p> <p>Tip</p> <p> 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.</p> </li> <li> <p>To make a small amount of extra room on your page, you may wish to edit the title and choose <code>Plain</code> as it's layout.</p> <p></p> </li> <li> <p>Once you are happy with the page, click 'Publish' to make it visible to other members of your site.</p> <p></p> </li> <li> <p>Promote your new page by following the recommendations</p> <p></p> </li> </ol>"},{"location":"boards/howto/mindmap/","title":"Index","text":""},{"location":"boards/howto/mindmap/#mind-map-view","title":"Mind Map View","text":"<p>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&amp;D, marketing, and more.</p>"},{"location":"boards/howto/mindmap/#accessing-the-mind-map-view","title":"Accessing the Mind Map View","text":"<p>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.</p> <p>In your board creation phase, select <code>Mind Map</code> from the <code>Starting View</code> drop down.</p> <p></p> <p>If your board is already created in either the Timeline or Board view, it is simply a matter of selecting the <code>Mind Map</code> view from the right-hand side menu.</p> <p></p>"},{"location":"boards/howto/mindmap/#creating-a-new-mind-map","title":"Creating a New Mind Map","text":"<p>In this example, we\u2019ll create a new mind map and select <code>Blank</code> 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.</p> <p>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.</p> <p></p> <p>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 <code>Add a Sub-Card</code> icon on your desired list to add cards.</p> <p></p> <p>You can add as many cards to the blue list titles as you like. Using the <code>Add a Sub-Card</code> icon on a card, will create a sub-card.</p> <p>As with a board and timeline, you can drag and drop colour labels and members on to your mind map.</p>"},{"location":"boards/howto/mindmap/#mind-map-views-and-layouts","title":"Mind Map Views and Layouts","text":"<p>On the right-hand side menu, you have tools that can change the layout of your Mind Map.</p> <p>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.</p> <p></p> <p>Layout: Radial</p> <p></p> <p>Layout: Horizontal</p> <p></p> <p>Layout: Vertical</p> <p></p> <p>Mirror / Reverse: Flip the layout of your mind map between mirror and reverse.</p> <p>Type: Use Type to dictate how your lists, cards, and sub-cards are connected to each other.</p> <p>Type: Free</p> <p></p> <p>Type: Step</p> <p></p> <p>Curve</p> <p></p> <p>Type: Line</p> <p></p>"},{"location":"boards/howto/mindmap/#mind-map-keyboard-navigation","title":"Mind Map keyboard navigation","text":"<p>The cards in the mindmap view can be traversed and interacted with using the keyboard.</p>"},{"location":"boards/howto/mindmap/#focus-and-moving-between-cards","title":"Focus and moving between cards","text":"<p>When the mind map view is first loaded, you can focus on the central card element (the board) by pressing the <code>Tab</code> key.</p> <p>Focus can be moved to other cards by using the <code>Arrow Keys</code>. Movement along the tree is determined by the spatial position of the cards next the the currently focused card.</p> <p>To clear focus on a card, press the <code>Escape</code> key.</p>"},{"location":"boards/howto/mindmap/#accessing-card-actions","title":"Accessing card actions","text":"<p>Once focused on a card, the actions displayed above the card can be accessed by pressing the <code>Tab</code> key. As with regular browser keyboard navigation, keep pressing <code>Tab</code> to move to the next action, and use <code>Shift</code> + <code>Tab</code> to move back to the previous action. Press the <code>Enter</code> or <code>Spacebar</code> keys to execute the focused action.</p> <p>The potentially available actions on a card are: New card/sub-card, Edit title, Archive, and Mark complete.</p> <p>To cancel the creation of a new card, press the <code>Escape</code> key.</p>"},{"location":"boards/howto/mindmap/#archive-hotkey","title":"Archive hotkey","text":"<p>To archive the currently focused card, press the <code>delete</code> key.</p>"},{"location":"boards/howto/mindmap/#create-card-hotkey","title":"Create card hotkey","text":"<p>To enter the create a new card/subcard mode for the currently focused card, press <code>Spacebar</code>. To cancel, press the <code>Escape</code> key.</p>"},{"location":"boards/howto/mindmap/#mindmap-panzoom","title":"Mindmap pan/zoom","text":""},{"location":"boards/howto/mindmap/#panzoom-using-the-mouse","title":"Pan/zoom using the mouse","text":"<p>To pan the mindmap, click and drag on any blank space in the view area.</p> <p>Scrolling the mousewheel up will zoom in on the area that the mouse is pointing at. Similarly, scroll the mousewheel downwards to zoom out again.</p>"},{"location":"boards/howto/mindmap/#panzoom-using-the-keyboard","title":"Pan/zoom using the keyboard","text":"<p>To pan around the mindmap, hold the <code>Shift</code> key while pressing the <code>Arrow Keys</code> in the direction you want to pan in.</p> <p>To zoom in, hold the <code>Shift</code> key and press the <code>-/_</code> key. To zoom out, hold the <code>Shift</code> key and press the <code>=/+</code> key.</p>"},{"location":"boards/howto/permissions/","title":"Index","text":""},{"location":"boards/howto/permissions/#permissions-in-huddo-boards","title":"Permissions in Huddo Boards","text":"<p>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.</p> <p></p>"},{"location":"boards/howto/permissions/#reader","title":"Reader","text":"<p>A person allocated a Reader permission, has read-only access.</p>"},{"location":"boards/howto/permissions/#author","title":"Author","text":"<p>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.</p>"},{"location":"boards/howto/permissions/#editor","title":"Editor","text":"<p>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)</p>"},{"location":"boards/howto/permissions/#owner","title":"Owner","text":"<p>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.</p> <p>Find out more about how to add members to a board.</p>"},{"location":"boards/howto/permissions/#making-your-board-public","title":"Making Your Board Public","text":"<p>When you activate <code>Public Access,</code> 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.</p> <p>To give your board public access, navigate to your desired board. Select <code>Members</code> and then select <code>Public Access.</code> Decide what level of access, Reader, Author or Editor, your organisation will have.  </p>"},{"location":"boards/howto/quick-tips/","title":"Quick Tips","text":""},{"location":"boards/howto/quick-tips/#quick-tips-for-boards","title":"Quick Tips for boards","text":""},{"location":"boards/howto/quick-tips/#mentions","title":"@Mentions","text":"<p>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.  </p> <p></p>"},{"location":"boards/howto/quick-tips/#move-between-board-mind-map-and-timeline","title":"Move between Board, Mind Map, and Timeline","text":"<p>Chose the Kanban view setting up your board, but decided a Mind Map would be better for brainstorming ideas? No worries!</p> <p>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.</p> <p></p>"},{"location":"boards/howto/quick-tips/#add-members-to-a-board","title":"Add Members to a Board","text":"<p>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.</p> <p>Use the right-hand menu and select <code>Members</code>.</p> <p>Start typing an individual, group name, or email address to bring up people in your organisation.</p> <p>To invite people external to your organisation, type in their email address.  Don\u2019t forget to click <code>Add Members</code> before closing the screen.</p> <p>This screen allows you to choose the type of rights your members will have: Owner, Editor, Author, Reader.</p> <p>You can also decide if you want the board to be Public Access, which will enable anyone from your organisation to see it.  </p> <p></p>"},{"location":"boards/howto/quick-tips/#use-colour-labels-to-categorise-and-filter","title":"Use Colour Labels to Categorise and Filter","text":"<p>You can use the Colour Labels on the right-hand side menu to help categorise your board.</p> <p>Click the pencil to the right of Colour Labels, then update the colours with your desired label names.</p> <p>Drag and drop the colour labels on to a card. Do the same action to remove the colour from the card.</p> <p>You can also click on a colour or multiple colours to filter the cards.</p> <p></p>"},{"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":"<p>You can use your O365, LinkedIn, Facebook, AppleID or HCL Connections Collab Cloud to access Huddo Boards Cloud.</p> <p>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). </p> <p>There are two ways to activate a free 30 day trial in order to access the premium views. </p>"},{"location":"boards/howto/start-a-trial/#activate-free-trial-via-myboards-dashboard","title":"Activate free trial via MyBoards Dashboard:","text":"<ol> <li>Login to boards.huddo.com to enter the MyBoards Dashboard.</li> <li>In the top right corner, click the profile icon to open <code>User Options</code> and then select <code>View Subscriptions</code>. </li> <li>Then select <code>Start My Trial</code> to activate your free 30 day trial. </li> </ol> <p>You can return to  <code>View Subscription</code> at any point to purchase a licence for Huddo Boards for yourself or for a number of people in your organisation.     </p> <p></p>"},{"location":"boards/howto/start-a-trial/#activate-free-trial-when-you-create-a-board","title":"Activate free trial when you create a board:","text":"<ol> <li>Login to boards.huddo.com to enter the MyBoards Dashboard.</li> <li>Use the <code>Create</code> button to start a new board. </li> <li>Follow the steps to creating a board, including selecting a template, adding a name, and more information like a description and members (these can also be added to your board later.) Click <code>Save</code> when you are done. </li> <li>When your new board opens, <code>Board</code> <code>MindMap</code> and <code>Timeline</code> in the right hand menu will be greyed out with the words <code>Preview Available</code> under each. Select any of these and follow prompts to start your free trial. </li> </ol>"},{"location":"boards/howto/teams/adding-boards/","title":"Microsoft Teams","text":""},{"location":"boards/howto/teams/adding-boards/#adding-boards-to-microsoft-teams","title":"Adding Boards to Microsoft Teams","text":"<p>Boards has integrated seamlessly with Microsoft 365 Teams so you can supercharge your existing collaboration environments.</p> <p>Add boards to Microsoft Teams as an administrator.</p>"},{"location":"boards/howto/teams/adding-boards/#accessing-all-of-your-boards-in-microsoft-teams","title":"Accessing all of your Boards in Microsoft Teams","text":"<p>When you open Microsoft Teams, click the <code>\u2026</code> icon in the left-hand side menu and select <code>Add More Apps.</code></p> <p></p> <p>In the Store search bar, type in Huddo Boards. Click the Huddo Boards icon. The following window will appear:</p> <p></p> <p>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 <code>Install</code>.  </p> <p>Press the <code>X</code> in the next window as installation has now been completed.</p> <p>You can now access all your Boards in one place, by navigating to the <code>\u2026</code> on the left-hand side, and selecting <code>Huddo Boards</code>.</p> <p></p> <p>From here, select the <code>My Boards</code> 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.  </p> <p></p>"},{"location":"boards/howto/teams/adding-boards/#adding-boards-to-a-channel","title":"Adding Boards to a Channel","text":"<p>You can work on Boards from within Channels. To add a Board to a channel, click on the <code>+</code> sign in the top menu next to Wiki.</p> <p></p> <p>You can select the Huddo Boards icon or search it if it doesn\u2019t appear directly.</p> <p>In the next window, select your preferences, to either</p> <ul> <li>Display an existing board (type in one that you\u2019ve already created)</li> <li>Create a new board</li> <li>Show all Boards for this team</li> </ul> <p>Enter the board information and click <code>Save</code>.</p> <p>Your Board will now appear in its own tab alongside Wiki. Add multiple boards by repeating the same process.</p> <p></p>"},{"location":"boards/howto/templates/creating/","title":"Create a Template","text":""},{"location":"boards/howto/templates/creating/#creating-templates","title":"Creating Templates","text":"<p>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.</p>"},{"location":"boards/howto/templates/creating/#create-a-template-from-an-existing-board","title":"Create a Template From an Existing Board","text":"<p>Within your board, click the title of your board to <code>Open Board Options.</code> Find this located between the Huddo Boards logo and the search bar. Next, click, <code>Create Template from Board.</code></p> <p></p> <p>In the next window, you can update the name, description, and choose to keep Board Members as is, remove or add Board Members. Click <code>Save.</code> The template will open in a new screen.</p> <p></p> <p>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.</p> <p>Important: When the template opens in a new screen, any editing you do will apply to the template. Click in to the <code>Open Board Options</code> icon as you did above and select, <code>Create Board from Template.</code> When the new window opens, you\u2019ll start a new board instead of editing the template you\u2019ve just created.</p>"},{"location":"boards/howto/templates/creating/#create-a-new-template-from-scratch","title":"Create a New Template from Scratch","text":"<p>From your main MyBoards dashboard, navigate to <code>Templates</code> via the left-hand side menu. You\u2019ll land on the My Templates page and see templates you have created.</p> <p></p> <p>Click the <code>+ New Template</code> button to start your creation. You have the option to select <code>Source Board / Template</code> 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. </p> <p>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 <code>Public</code> in the <code>Members</code> section on the right-hand side menu.</p> <p>Complete the required information for your template, then click <code>Create</code>.  </p> <p></p> <p>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.</p> <p>In future, when creating a new board, type in the template name in the <code>Search All Templates</code> field, during the New Board creation phase.</p> <p>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:</p> <ul> <li>Entering the template, clicking the pencil icon for <code>Open Board Options</code>, then selecting, <code>Create Board from Template</code>; or</li> <li>Creating a new board via your My Boards dashboard, and typing in the template name in the <code>Search All Templates</code> search bar.</li> <li>Find out more about Accessing Global Templates</li> </ul>"},{"location":"boards/howto/templates/global/","title":"Use a Template","text":""},{"location":"boards/howto/templates/global/#select-a-template","title":"Select a Template","text":"<p>You can access a library of global templates already available from Huddo Boards to use as inspiration for your own work.</p> <p>When you start a New Board, click <code>Explore the Template Library</code>.</p> <p> </p> <p>This will open a new window with available templates.</p> <p> </p> <p>Feel free to click in to different templates to see what they contain. </p> <p>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.</p> <p> </p> <p>You still have the option to select the Starting View, from Kanban, MindMap, Timeline or Activty.</p> <p>Click <code>Next</code> to give your board a name and then <code>Save</code> and you\u2019ll be taken to your new Board.</p>"},{"location":"boards/howto/templates/global/#template-scheduling","title":"Template Scheduling","text":"<p>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. </p> <p>On the My Boards page, click the <code>+ Create</code> button. The <code>New Board</code> window will open. Search templates by name and select your template that contains dates. </p> <p>Click <code>Next</code>. </p> <p>You'll see an option to choose a <code>Starts on</code> or <code>Finishes on</code> 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. </p> <p> </p> <p>Click <code>Save</code>. Your new Board will be created.</p> <ul> <li>If the dates in your template included Start and End dates on tasks, you can see these rescheduled items in the <code>Timeline</code> view.</li> <li>If your tasks included Due dates, you can see these rescheduled items in the <code>Board -&gt; Todos by Date</code> view.</li> </ul>"},{"location":"boards/howto/templates/global/#assign-to-roles","title":"Assign to Roles","text":"<p>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.</p> <p>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.</p> <p>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.</p> <p> <p></p> <p>Once you've created the board, you will see members assigned to the tasks that had roles assigned.</p> <p> </p>"},{"location":"boards/howto/timeline/","title":"Index","text":"<p>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.</p>"},{"location":"boards/howto/timeline/#accessing-the-timeline-view","title":"Accessing the Timeline View","text":"<p>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.</p> <p>In your board creation phase, select<code>Timeline</code> from the Starting View drop down.</p> <p></p> <p>If your board is already created in either the Mind Map or the Kanban Board view, it is simply a matter of selecting the <code>Timeline</code> view from the right-hand side menu.</p> <p></p>"},{"location":"boards/howto/timeline/#how-to-use-the-timeline","title":"How to use the Timeline","text":"<p>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:</p> <ul> <li>Drag and Drop Unscheduled Cards</li> </ul> <p>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.</p> <p>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.</p> <p></p> <ul> <li>Add Start and Finish Dates to a Card</li> </ul> <p>Cards sitting in the Unscheduled Cards area can be clicked on to bring up the detailed card view. From here, select <code>Set Dates</code>, 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.  </p> <p></p> <p>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 <code>Set Dates,</code> 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.</p>"},{"location":"boards/howto/timeline/#choose-how-you-view-your-timeline","title":"Choose how you view your Timeline","text":"<p>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 <code>List,</code> <code>Colour,</code> or <code>Assigned.</code></p> <p></p>"},{"location":"boards/howto/timeline/#helpful-hints-for-using-the-timeline","title":"Helpful Hints for Using the Timeline","text":"<ul> <li>Cards can run parallel and overlap other cards on the timeline</li> <li>Due dates will appear with a little clock icon on the card, and will show the date when hovered over with the mouse</li> <li>You can allocate members and colour labels to cards on a timeline as normal, using drag and drop</li> <li>You can create new lists on the left-hand side of the screen, using the Add a list button</li> <li>You can create new cards directly on the timeline by clicking on your preferred start date</li> <li>Not every card has to be appear on the timeline. Its normal to have cards that are unallocated, as they might not have specific start or finish dates. Use timelines in a way that works best   for you and your project.</li> </ul>"},{"location":"boards/integrations/","title":"Integrations","text":"<p>Boards has many integration options to suit your needs. Please contact us if you have any specific requirements that are not covered.</p>"},{"location":"boards/integrations/developing/related-tasks/","title":"Use Huddo Boards Related Task Microapp","text":"<p>To display this use the following pattern to load and use the microapp</p> <p><code>&lt;boardsURL&gt;/app/linkedcards?title=&lt;boardsCardTitle&gt;&amp;url=&lt;boardsPrimaryLink&gt;</code></p> <p>where  - <code>&lt;boardsURL&gt;</code> is the URL of your Huddo Boards installation (boards.huddo.com for Boards Cloud) - <code>&lt;boardsCardTitle&gt;</code> is the default title for the task when created which users can change, fully escaped - <code>&lt;boardsPrimaryLink&gt;</code> is the URL of the page you want to show tasks related to, fully escaped</p> <p>e.g. <code>https://boards.huddo.com/app/linkedcards?title=Card%20Name&amp;url=https%3A%2F%2Fexample.com</code></p> <p>There is also a message sent with the current number of related tasks if you wish to display this.</p> <p>The event data is in the format <code>huddo-task-count=0</code> </p> <p>Example for JavaScript: </p> <pre><code>window.addEventListener(\"message\", (event) =&gt; {\n\n    if(event.origin !== &lt;boardsURL&gt;)\n        return;\n\n    let eventData = event.data;\n\n    //huddo-task-count=0\n    if(typeof eventData === \"string\" &amp;&amp; eventData.includes(\"huddo-task-count\"))\n    {\n        boardsNumTasks = event.data.split('=')[1];\n    }\n}\n</code></pre>"},{"location":"boards/kubernetes/","title":"Huddo Boards for Kubernetes","text":"<p>Deploying Huddo Boards into Kubernetes for on-premise environments</p>"},{"location":"boards/kubernetes/#prerequisites","title":"Prerequisites","text":"<ol> <li>Kubernetes is installed and running</li> <li>WebSphere environment with Web Server (or another reverse proxy)</li> <li>kubectl is installed and configured</li> <li>helm is installed</li> <li>SMTP gateway setup for email notifications if required</li> <li>Quay.io - Red Hat account setup with access to the Huddo Boards repository. Please send your account details to support@huddo.com if you do not already have this.</li> </ol>"},{"location":"boards/kubernetes/#ssl-network","title":"SSL / Network","text":"<p>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:</p> New domain Path on existing domain <code>BOARDS_URL</code> <code>boards.example.com</code> <code>example.com/boards</code> <code>API_URL</code> <code>api.example.com</code> <code>example.com/api-boards</code> 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 - <p>Please decide on which configuration will suit your environment best and the corresponding <code>BOARDS_URL</code> &amp; <code>API_URL</code>. These values will then be used in the following documentation.</p> <p>For more details on configuring a reverse proxy, please see below.</p>"},{"location":"boards/kubernetes/#oauth","title":"OAuth","text":"<p>Huddo Boards currently supports the following oAuth providers for authentication and integration: HCL Connections (on premise), IBM Connections Cloud and Microsoft 365.</p> <p>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:</p> Provider Registration / Documentation Callback URL HCL Connections instructions <code>https://[BOARDS_URL]/auth/connections/callback</code> HCL Domino instructions <code>https://[BOARDS_URL]/auth/domino/callback</code> HCL DX instructions <code>https://[BOARDS_URL]/auth/dx/callback</code> Microsoft 365 Azure app registrations <code>https://[BOARDS_URL]/auth/msgraph/callback</code> Google Google Console <code>https://[BOARDS_URL]/auth/google/callback</code> LinkedIn LinkedIn <code>https://[BOARDS_URL]/auth/linkedin/callback</code> Facebook Facebook developer centre <code>https://[BOARDS_URL]/auth/facebook/callback</code>"},{"location":"boards/kubernetes/#huddo-boards-namespace","title":"Huddo Boards namespace","text":"<pre><code>kubectl create namespace boards\n</code></pre>"},{"location":"boards/kubernetes/#database-storage","title":"Database &amp; Storage","text":"<p>Huddo 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:</p> <ol> <li>Mongo database</li> <li>S3 storage</li> </ol> <p>Note: these tasks are very similar to each other and can be performed simultaneously</p>"},{"location":"boards/kubernetes/#secrets","title":"Secrets","text":"<ol> <li> <p>Follow this guide to get access to our images in Quay.io</p> </li> <li> <p>SSL certificate details</p> <p>Only perform this step if you need to resolve certificates in kubernetes</p> <pre><code>kubectl create secret tls huddoboards-domain-secret --key &lt;/path/to/keyfile&gt; --cert &lt;/path/to/certificate&gt; --namespace=boards\n</code></pre> </li> </ol>"},{"location":"boards/kubernetes/#configuration","title":"Configuration","text":"<p>Download our config file and update all example values as required. Details as below.</p> <p>Kubernetes Variables:</p> Key Description <code>global.env.APP_URI</code> <code>https://[BOARDS_URL]</code> <code>global.env.MONGO_USER</code> MongoDB userIf using our storage above you may leave this commented out <code>global.env.MONGO_PASSWORD</code> MongoDB passwordIf using our storage above you may leave this commented out <code>global.env.MONGO_HOST</code> MongoDB hostIf using our storage above you may leave the default <code>global.env.MONGO_PARAMS</code> MongoDB request parametersIf using our storage above you may leave the default <code>global.env.S3_ENDPOINT</code> S3 URLIf using our storage above you may leave the default <code>global.env.S3_ACCESS_KEY</code> S3 Access KeyIf using our storage above you may leave the default <code>global.env.S3_SECRET_KEY</code> S3 Secret KeyIf using our storage above you may leave the default <code>webfront.ingress.hosts</code> <code>[BOARDS_URL]</code> (no protocol) <code>core.ingress.hosts</code> <code>[API_URL]</code> (no protocol, e.g. api.huddoboards.com) <p>Boards Variables:</p> <p>Follow instructions on this page</p>"},{"location":"boards/kubernetes/#deploy-boards-chart","title":"Deploy Boards Chart","text":"<p>Install the Boards services via our Helm chart</p> <pre><code>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\n</code></pre> <p>Note: <code>--recreate-pods</code> ensures all images are up to date. This will cause downtime.</p>"},{"location":"boards/kubernetes/#proxy-config","title":"Proxy Config","text":""},{"location":"boards/kubernetes/#connections-on-premise","title":"Connections On Premise","text":"<p>For Connections on-premise you have two options:</p> <ol> <li> <p><code>nginx</code> - if you have an NGINX (e.g. customizer) in front of IHS use that instead to support websockets and use one less proxy. Follow these instructions.</p> </li> <li> <p><code>httpd</code> - please follow these instructions.</p> </li> </ol>"},{"location":"boards/kubernetes/#connections-cloud-or-microsoft-365","title":"Connections Cloud or Microsoft 365","text":"<p>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</p>"},{"location":"boards/kubernetes/#hcl-connections-integrations","title":"HCL Connections integrations","text":"<ul> <li>Header (Note: only required if Boards is hosted on a different domain to Connections)</li> <li>Apps Menu</li> <li>Widgets</li> <li>Migrate your Activities to Boards</li> </ul>"},{"location":"boards/kubernetes/deploy-mongo/","title":"Deploy MongoDB (Small Scale)","text":"<p>Huddo Boards requires a Mongo database.</p> <p>Warning</p> <p>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.</p> <p>Tip</p> <p>For Large Scale Deployments (HA) please use either MongoDB:</p> <ol> <li>hosted by a compatible cloud provider (e.g. Cloud Atlas)</li> <li>self hosted in a ReplicaSet architecture. For example, <code>bitnami/mongodb</code> offer a decent wrapper to initialise a replicaset with their Helm chart.</li> </ol> <p>This documentation will deploy a MongoDB replicaSet into your Kubernetes setup.</p> <p>If you already have externally hosted Mongo database please skip to the Outcomes section to determine your equivalent connection parameters.</p> <p>You can also email us for support at support@huddo.com</p>"},{"location":"boards/kubernetes/deploy-mongo/#prerequisites","title":"Prerequisites","text":"<ol> <li>Config file downloaded</li> </ol>"},{"location":"boards/kubernetes/deploy-mongo/#update-config-file","title":"Update config file","text":"Line Key Default Value Description 21 <code>nfs.path</code> <code>/pv-kudos/mongo</code> Path to storage location 22 <code>nfs.server</code> <code>[STORAGE_SERVER_IP]</code> IP of NFS serverie <code>192.168.10.50</code>"},{"location":"boards/kubernetes/deploy-mongo/#deploy-instructions","title":"Deploy instructions","text":"<ol> <li> <p>Create the folder at <code>nfs.path</code> location on the <code>nfs.server</code> with access <code>777</code></p> <p>Note: please ensure sufficient storage is available (ie 100GB)</p> </li> <li> <p>Ensure each Node in your Kubernetes cluster can mount this location.</p> <p>Please modify the file <code>/etc/exports</code> on your NFS Server to include this line</p> <pre><code>&lt;NFS_PATH_FOR_MONGO&gt; &lt;IP_RANGE_OF_YOUR_SERVERS&gt;/&lt;SUBNET_MASK&gt;(rw,no_root_squash)\n</code></pre> <p>For example:</p> <pre><code>/pv-kudos/mongo 192.168.0.0/255.255.0.0(rw,no_root_squash)\n</code></pre> <p>Apply new NFS storage to exports</p> <pre><code>exportfs -ra\n</code></pre> </li> <li> <p>Install Mongo</p> <pre><code>kubectl apply -f ./mongo.yaml\n</code></pre> </li> </ol>"},{"location":"boards/kubernetes/deploy-mongo/#outcomes","title":"Outcomes","text":"<p>The 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.</p> Key Default Value Description <code>MONGO_PROTOCOL</code> <code>mongo</code> Protocol used in your Connections String <code>MONGO_HOST</code> <code>mongo-service:27017</code> Hostname of your Mongo service <code>MONGO_PARAMS</code> <code>replicaSet=replicaset</code> Request parameters (ie ?) <code>MONGO_USER</code> None Username to connect.Authentication is disabled in this private deployment <code>MONGO_PASSWORD</code> None Password to connect.Authentication is disabled in this private deployment <p>Alternatively, these parameters can be set with <code>MONGO_URI</code> which is built from:</p> <pre><code>[MONGO_PROTOCOL]://[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]\n\nmongo://mongo-service:27017/database?replicaSet=replicaset\n</code></pre> <p>Or with optional credentials:</p> <pre><code>[MONGO_PROTOCOL]://[MONGO_USER]:[MONGO_PASSWORD]@[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]\n\nmongo://user:passw0rd@mongo-service:27017/database?replicaSet=replicaset\n</code></pre>"},{"location":"boards/kubernetes/minio/","title":"Deploy S3 Storage","text":"<p>Huddo Boards requires an S3 object store. This documentation will deploy a Minio S3 storage container into the Kubernetes setup.</p> <p>If you already have externally hosted S3 storage please skip to the Outcomes section to determine your equivalent connection parameters.</p> <p>You can also email us for support at support@huddo.com</p>"},{"location":"boards/kubernetes/minio/#prerequisites","title":"Prerequisites","text":"<ol> <li>Config file downloaded</li> </ol>"},{"location":"boards/kubernetes/minio/#update-config-file","title":"Update config file","text":"Line Key Default Value Description 21 <code>nfs.path</code> <code>/pv-kudos/minio</code> Path to storage location 22 <code>nfs.server</code> <code>STORAGE_SERVER_IP</code> IP of NFS serverie <code>192.168.10.50</code> 69 <code>MINIO_ACCESS_KEY</code> <code>ioueygr4t589</code> Access credential 71 <code>MINIO_SECRET_KEY</code> <code>7a863d41-2d8f-4143-bc8a-02501edbea6f</code> Access credential"},{"location":"boards/kubernetes/minio/#deploy-instructions","title":"Deploy instructions","text":"<ol> <li> <p>Create the folder at <code>nfs.path</code> location on the <code>nfs.server</code> with access <code>777</code></p> <p>Note: please ensure sufficient storage is available (ie 100GB)</p> </li> <li> <p>Ensure each Node in your Kubernetes cluster can mount this location.</p> <p>Please modify the file <code>/etc/exports</code> on your NFS Server to include this line</p> <pre><code>&lt;NFS_PATH_FOR_MINIO&gt; &lt;IP_RANGE_OF_YOUR_SERVERS&gt;/&lt;SUBNET_MASK&gt;(rw,no_root_squash)\n</code></pre> <p>For example:</p> <pre><code>/pv-kudos/minio 192.168.0.0/255.255.0.0(rw,no_root_squash)\n</code></pre> <p>Apply new NFS storage to exports</p> <pre><code>exportfs -ra\n</code></pre> </li> <li> <p>Install Minio</p> <pre><code>kubectl apply -f ./minio.yaml\n</code></pre> </li> </ol>"},{"location":"boards/kubernetes/minio/#outcomes","title":"Outcomes","text":"<p>The 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.</p> Key Default Value Description <code>S3_ENDPOINT</code> <code>minio-service</code> Hostname of this service(as per line 84 of config) <code>S3_ACCESS_KEY</code> <code>ioueygr4t589</code> Credential configured above <code>S3_SECRET_KEY</code> <code>7a863d41-2d8f-4143-bc8a-02501edbea6f</code> Credential configured above <code>S3_BUCKET</code> <code>kudos-boards</code> Default storage bucket"},{"location":"boards/kubernetes/prerequisites/","title":"Prerequisites","text":"<p>Requirements and considerations before installation of Kubernetes and Huddo Boards</p>"},{"location":"boards/kubernetes/prerequisites/#servers","title":"Servers","text":"<p>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.</p> <p>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.</p>"},{"location":"boards/kubernetes/prerequisites/#existing-infrastructure","title":"Existing Infrastructure","text":"<p>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.</p> 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":"<p>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)</p>"},{"location":"boards/kubernetes/prerequisites/#ssl-certificates-and-domain-names-for-hosting","title":"SSL Certificates and domain names for hosting","text":"<p>In the examples below, replace <code>example.com</code> with your actual company domain</p> <p>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.</p> <p>For example:</p> Domain Path Web boards.example.com example.com/boards API api-boards.example.com example.com/api-boards <p>We'll refer to these throughout installation as [BOARDS_URL] and [API_URL]</p> <p>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.</p>"},{"location":"boards/kubernetes/prerequisites/#ssh-access","title":"SSH Access","text":"<p>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.</p>"},{"location":"boards/kubernetes/prerequisites/#authentication","title":"Authentication","text":"<p>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):</p> Provider Registration / Documentation HCL Connections (on premise) IBM Knowledge Center IBM Connections Cloud IBM Knowledge Center Microsoft 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":"<p>Follow this guide to get access to our images</p>"},{"location":"boards/kubernetes/prerequisites/#ansible","title":"Ansible","text":"<p>We use Red Hat Ansible to script the installs. Please ensure this is installed as per our guide prior to the kubernetes / boards install</p>"},{"location":"boards/minio/","title":"Minio FS Mode","text":"<p>This is a workaround to revert Minio to legacy fs mode. This is not recommended for new installations.</p> <p>Place this file at /pv-connections/kudos-boards-minio/.minio.sys/</p> <p>Restart (delete) the minio pod to apply the changes.</p>"},{"location":"boards/msgraph/","title":"Overview","text":"<p>Huddo Boards is tailored for working with Microsoft 365 in the following ways:</p>"},{"location":"boards/msgraph/#login","title":"Login","text":"<p>Use your existing Microsoft credentials</p> <p></p>"},{"location":"boards/msgraph/#collaboration","title":"Collaboration","text":"<p>Share and collaborate with individuals and groups in your office tenant</p> <p></p>"},{"location":"boards/msgraph/#easy-access","title":"Easy Access","text":"<p>Access Boards from your Office menu, and access other Office apps from the menu in Boards</p> <p>Admin setup guide</p> <p></p>"},{"location":"boards/msgraph/#onedrive","title":"OneDrive","text":"<p>Share files and folders from Onedrive within the context of a Board</p> <p></p>"},{"location":"boards/msgraph/#teams","title":"Teams","text":"<p>Teams integration admin guide</p> <p>Add boards tabs to Microsoft Teams</p> <p></p> <p>See all of the boards your team is working on.</p> <p></p> <p>Access Huddo Boards directly from Teams as a personal app</p> <p></p> <p>Receive notifications as the board updates</p>"},{"location":"boards/msgraph/#outlook","title":"Outlook","text":"<p>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)</p> <p>Save emails from Outlook as a card in your board</p> <p></p> <p>Attach boards, lists and cards to an email.</p>"},{"location":"boards/msgraph/#_1","title":"Overview","text":""},{"location":"boards/msgraph/#sharepoint","title":"Sharepoint","text":"<p>Embed boards as pages in Sharepoint.</p> <p>Sharepoint pages setup guide</p> <p></p>"},{"location":"boards/msgraph/auth/","title":"Authenticating Huddo Boards with Microsoft 365","text":"<p>This document details the process to enable login to your private instance of Huddo Boards with your private Microsoft 365 tenant.</p> <p></p>"},{"location":"boards/msgraph/auth/#register-oauth-application","title":"Register OAuth Application","text":"<p>You must configure an OAuth Application in your Microsoft 365 Tenant in order to use Huddo Boards with O365. To access this configuration you must be logged in as a Microsoft tenant admin</p>"},{"location":"boards/msgraph/auth/#open-the-azure-app-portal","title":"Open the Azure App Portal","text":"<p>Click <code>New Registration</code></p> <p></p>"},{"location":"boards/msgraph/auth/#configure-redirect","title":"Configure Redirect","text":"<p>Enter the values below and click <code>Register</code></p> <p></p> <pre><code>Huddo Boards\nhttps://[BOARDS_URL]/auth/msgraph/callback\n</code></pre> <p>Where BOARDS_URL is the URL to access your main Huddo Boards page. For example:</p> <ul> <li><code>https://connections.example.com/boards/auth/msgraph/callback</code> OR</li> <li><code>https://boards.example.com/auth/msgraph/callback</code></li> </ul> <p>Click <code>Register</code></p>"},{"location":"boards/msgraph/auth/#configure-required-scopes","title":"Configure Required Scopes","text":"<ol> <li> <p>Open the <code>Manifest</code> section</p> </li> <li> <p>Replace the <code>requiredResourceAccess</code> section as per below</p> <p></p> <pre><code>\"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],\n</code></pre> <p>Click <code>Save</code></p> </li> </ol>"},{"location":"boards/msgraph/auth/#check-permissions","title":"Check Permissions","text":"<p>Open the <code>API permissions</code> section. Notice that all the scopes are now pre-filled.</p> <p>Click <code>Grant admin consent for kudosdev</code></p> <p></p> <p>Click <code>Yes</code></p> <p></p>"},{"location":"boards/msgraph/auth/#configure-sso-in-teams","title":"Configure SSO in Teams","text":"<p>Note: These steps are extracted from the official Microsoft guide: steps 5-12</p> <p>Note: This step is optional, but recommended to remove the <code>Sign in with</code> page when accessing Huddo Boards.</p> <p>At the end of this step you should have the following:</p> <p></p> <ol> <li> <p>Click <code>Expose an API</code></p> </li> <li> <p>Set the Application ID URI as per:</p> <p><code>api://&lt;DOMAIN_HOSTING_BOARDS&gt;/&lt;CLIENT_ID&gt;</code></p> <p>where :</p> <ul> <li><code>DOMAIN_HOSTING_BOARDS</code> is the domain hosting boards, e.g. <code>boards.company.com</code> or <code>company.com</code></li> <li><code>CLIENT_ID</code> is the <code>Application (client) ID</code>, shown on the <code>Overview</code> page</li> </ul> <p>For example:</p> <p><code>api://boards.huddo.com/5554fe8f-34b6-4694-a09d-6349e6ab6ec9</code></p> <p>Note: this requires the domain name to be added &amp; verified in the Azure Portal under <code>Azure Active Directory</code> -&gt; <code>Custom domain names</code>. See read the official Microsoft documentation for more information.</p> </li> <li> <p>Click <code>Add a scope</code></p> <p>Set the following values:</p> <p></p> <ul> <li>Scope name: <code>access_as_user</code></li> <li>Who can consent: <code>Admins and users</code></li> <li>Admin consent display name: <code>Teams can access the user\u2019s profile.</code></li> <li>Admin consent description: <code>Teams can call the app\u2019s web APIs as the current user.</code></li> <li>User consent display name: <code>Teams can access your profile and make requests on your behalf.</code></li> <li>User consent description: <code>Teams can call this app\u2019s APIs with the same rights as you have.</code></li> <li>State: <code>Enabled</code></li> </ul> <p>Click <code>Save</code></p> </li> <li> <p>Add the following Authorized client applications</p> <ul> <li><code>1fec8e78-bce4-4aaf-ab1b-5451cc387264</code> for Teams mobile or desktop application.</li> <li><code>5e3ce6c0-2b1f-4285-8d4b-75ee78787346</code> for Teams web application.</li> </ul> </li> </ol>"},{"location":"boards/msgraph/auth/#configure-oauth-in-boards","title":"Configure OAuth in Boards","text":"<ol> <li> <p>Open the <code>Overview</code> section</p> <p>Copy <code>Application (client) ID</code> &amp; <code>Directory (tenant) ID</code></p> <p></p> </li> <li> <p>Open the <code>Certificates &amp; secrets</code> section</p> <p>Click <code>New client secret</code></p> <p></p> <p>Select <code>Never</code> expire and click <code>Add</code></p> <p></p> <p>Copy the secret value shown</p> <p></p> </li> <li> <p>Add OAuth and Tenant values to YAML config (ie <code>boards.yaml</code> or <code>boards-cp.yaml</code>)</p> <pre><code>global:\n    env:\n        MSGRAPH_CLIENT_ID: \"&lt;your-application-id&gt;\"\n        MSGRAPH_CLIENT_SECRET: \"&lt;your-application-secret&gt;\"\n        MSGRAPH_LOGIN_TENANT: \"&lt;your-tenant-id&gt;\"\n</code></pre> </li> <li> <p>Redeploy Boards Helm Chart as per command for Huddo Boards:</p> <p>HCL Component Pack</p> <pre><code>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\n</code></pre> <p>for Docker - Kubernetes</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> <p>Note: <code>--recreate-pods</code> is not required this time as this is only an env variable change</p> </li> </ol>"},{"location":"boards/msgraph/auth/#approve-permissions","title":"Approve Permissions","text":"<ol> <li> <p>Open your Huddo Boards environment.</p> <p>Click the <code>Microsoft 365</code> option and login with a Tenant Administrator account</p> <p></p> </li> <li> <p>Once logged in, a prompt will appear in Huddo Boards. Click <code>Approve</code></p> <p></p> </li> <li> <p>Click <code>Accept</code> on the following popup to grant the required permissions for Huddo Boards</p> <p></p> <p>Congratulations! All users in your tenant can now login to Huddo Boards via Microsoft 365!</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/custom-tiles/","title":"App Tile","text":""},{"location":"boards/msgraph/custom-tiles/#add-huddo-boards-to-tiles","title":"Add Huddo Boards to tiles","text":"<p>Follow these steps by Microsoft which we have also outlined below.</p> <ol> <li> <p>Open 365 Admin Centre</p> <p>Click <code>Settings</code> -&gt; <code>Org Settings</code> -&gt; <code>Organization Profile</code></p> <p>Click <code>Custom app laucher tiles</code></p> <p></p> </li> <li> <p>Click <code>Add a custom tile</code></p> <p></p> </li> <li> <p>Enter the following details &amp; click <code>Save</code></p> <pre><code>Huddo Boards\nhttps://boards.huddo.com/auth/msgraph\nhttps://boards.huddo.com/img/logo-small.png\nSocial collaboration\n</code></pre> <p></p> </li> <li> <p>Huddo Boards will now appear in the list. Click <code>Close</code></p> <p></p> </li> <li> <p>Go to https://www.office.com</p> <p>Open the Apps menu and click <code>All apps</code></p> <p></p> </li> <li> <p>Huddo Boards should be shown in the list.</p> <p>Users can now pin this to their menu. This may take 10 minutes to appear</p> </li> </ol>"},{"location":"boards/msgraph/getting-started/","title":"Getting Started with Huddo Boards for Microsoft 365","text":"<p>Note</p> <p>If you're not a Microsoft 365 administrator, refer this document to your IT team or Microsoft 365 administrator and skip to Add Huddo Boards to Microsoft Teams.</p>"},{"location":"boards/msgraph/getting-started/#login","title":"Login","text":""},{"location":"boards/msgraph/getting-started/#microsoft-teams","title":"Microsoft Teams","text":"<p>Huddo Boards is deeply integrated in to Microsoft Teams. See Add Huddo Boards to Microsoft Teams.</p>"},{"location":"boards/msgraph/getting-started/#web-application","title":"Web Application","text":"<p>You can also access Huddo Boards via https://boards.huddo.com/. Use the dedicated Microsoft login URL (https://boards.huddo.com/auth/msgraph) to skip selecting Microsoft as the login method. </p>"},{"location":"boards/msgraph/getting-started/#microsoft-graph-api-permissions","title":"Microsoft Graph API Permissions","text":"<p>Huddo Boards requires permissions to be granted to access your Microsoft 365 data. </p> <p>Note</p> <p>Microsoft Tenants configured with strict security policies may require admin consent to enable any functionality.</p> Permission types Basic Permissions Most functionality is enabled with permissions that any Microsoft user can normally grant. Admin Permissions Some functionality requires an admin to grant permissions that give Boards broader access to data."},{"location":"boards/msgraph/getting-started/#admin-approval","title":"Admin Approval","text":"<p>Providing administrator consent gives Huddo Boards the Microsoft Graph permissions required to enable all functionality and allows users to skip a consent prompt when logging in.</p>"},{"location":"boards/msgraph/getting-started/#via-microsoft-entra","title":"Via Microsoft Entra","text":"<p>You can view the your currently granted permissions, grant admin consent and manage/revoke permissions on your Microsoft Entra | Huddo Boards | Permissions page. </p>"},{"location":"boards/msgraph/getting-started/#via-huddo-boards","title":"Via Huddo Boards","text":"<p>If admin consent has not been provided, you will be prompted within the Huddo Boards app:  </p> <p>After clicking Approve, you may be asked to login to Microsoft 365 again, then you will be prompted to approve Huddo Boards access on behalf of your organisation.</p> <p>You can revoke this approval at any stage via your Microsoft Entra | Huddo Boards | Permissions page. </p>"},{"location":"boards/msgraph/getting-started/#permissions-used-by-huddo-boards","title":"Permissions Used by Huddo Boards","text":"<p>These are the permissions what Huddo Boards uses. These will change as we implement new features and optimise the permissions we use. When permission requirements change, permissions must be granted by users/admins again. </p> Permission Name Permission Type Microsoft Description Admin consent required Boards Usage email delegated View users' email address false Basic permission that allows you to log in to Huddo Boards with your Microsoft account Files.Read.All delegated Read all files that user can access false Allows you to browse and share links to your files in Huddo Boards. Files.ReadWrite.All delegated Have full access to all files user can access false Allows you to store new files in OneDrive via the Huddo Boards app. offline_access delegated Maintain access to data you have given it access to false Allows us to remember who you are logged in as, so you don't have to login every time you use Huddo Boards openid delegated Sign users in false Basic permission that allows you to log in to Huddo Boards with your Microsoft account People.Read delegated Read users' relevant people lists false Basic permission that allows Huddo Boards to search for people in your tenant on your behalf. profile delegated View users' basic profile false Basic permission that allows you to log in to Huddo Boards with your Microsoft account - Allows Huddo Boards to read your profile Sites.Read.All delegated Read items in all site collections false Allows Huddo Boards to read the basic information about Sharepoint Sites you can access. Team.ReadBasic.All delegated Read the names and descriptions of teams false Allows Huddo Boards to read the basic information about Teams you can access. TeamsActivity.Send delegated Send a teamwork activity as the user false Allows Huddo Boards to send Activity Notifications to other Microsoft users on your behalf. User.Read delegated Sign in and read user profile false Basic permission that allows you to log in to Huddo Boards with your Microsoft account - Allows Huddo Boards to read your profile User.ReadBasic.All delegated Read all users' basic profiles false Allows Huddo Boards to read basic profile information of others in your tenant that you can access. Channel.ReadBasic.All application Read the names and descriptions of all channels true Allows Huddo Boards to read private channel details. ChannelMember.Read.All application Read the members of all channels true Allows Huddo Boards to read members of and function in private channels. Directory.Read.All delegated Read directory data true Allows Huddo Boards to read data in your organisation's directory, such as users, groups and apps. We intend to remove this permission in the future in favour of multiple more fine-grained permissions. Group.Read.All delegated Read all groups true Allows Huddo Boards to search the groups you have access to, read group details (image, description, installed apps,  etc) Group.ReadWrite.All delegated Read and write all groups true DEPRECATED: To be removed. Allows Huddo Boards to add  new team channel tabs without interaction with the Teams client."},{"location":"boards/msgraph/getting-started/#set-up-integrations","title":"Set up Integrations","text":"<p>These guides also require admin access and enable some advanced features of Huddo Boards in your Microsoft 365 environment. These are also in the side menu of this page.</p> <p>Office Menu App Tile Teams Outlook Sharepoint</p>"},{"location":"boards/msgraph/outlook/","title":"Outlook","text":""},{"location":"boards/msgraph/outlook/#add-huddo-boards-plugin","title":"Add Huddo Boards plugin","text":"<p>Note</p> <p>Desktop Outlook requires the Microsoft Edge WebView2 Runtime.</p> <ol> <li> <p>Open 365 Admin Centre</p> <p>Click <code>Settings</code> -&gt; <code>Integrated apps</code> -&gt; <code>Upload custom apps</code></p> <p></p> </li> <li> <p>Select <code>Provide link to manifest file</code></p> <pre><code>https://boards.huddo.com/office/outlook/add-in.xml\n</code></pre> <p>Click <code>Validate</code> then click <code>Next</code></p> <p></p> </li> <li> <p>Specify who has access and click <code>Next</code></p> <p></p> <ol> <li>Click <code>Finish Deployment</code></li> </ol> <p></p> </li> <li> <p>Click <code>Done</code></p> <p></p> </li> <li> <p>Open Outlook</p> <p>You should now see the <code>Huddo Boards</code> option in the menu of an email</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/outlook/personal/","title":"Personal","text":""},{"location":"boards/msgraph/outlook/personal/#huddo-boards-plugin-for-single-users","title":"Huddo Boards plugin (for single users)","text":"<p>The instructions on this page use 'The new Outlook' however you can also add and use this plugin from 'classic Outlook' or Outlook desktop.</p> <p>Microsoft 365 admins can add this for all users in their tenant, instructions here</p> <ol> <li> <p>Open Outlook and click <code>New Message</code></p> <p></p> </li> <li> <p>Click the <code>...</code> menu -&gt; <code>Get Add-ins</code></p> <p></p> </li> <li> <p>Click <code>My Add-ins</code> then <code>Add a custom add-in</code> -&gt; <code>Add from URL</code></p> <p></p> </li> <li> <p>Provide the url: <code>https://boards.huddo.com/office/outlook/add-in.xml</code> and click OK.</p> <p></p> </li> <li> <p>Click <code>Install</code> then close the add-in dialogue.</p> <p></p> </li> <li> <p>Verify the add-in is installed by clicking the <code>...</code> menu again.</p> <p></p> </li> <li> <p>You will now be able to:</p> <p>Save emails from Outlook as a card in your board</p> <p></p> <p>Attach boards, lists and cards to an email.</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/sharepoint/","title":"Sharepoint","text":""},{"location":"boards/msgraph/sharepoint/#embedding-huddo-boards-pages-in-sharepoint","title":"Embedding Huddo Boards pages in Sharepoint.","text":"<p>Before proceeding, you will need a site admin to enable security settings as described here</p> <p></p> <ol> <li> <p>From Sharepoint main menu, go to <code>Pages</code> -&gt; <code>New</code> -&gt; <code>Site Page</code></p> <p></p> </li> <li> <p>Give your page a name, then click the <code>+</code></p> <p></p> </li> <li> <p>Choose <code>Embed</code> from the drop down menu</p> <p></p> </li> <li> <p>Open Huddo Boards and select the board you wish to embed in the sharepoint page. Click the <code>Board Options</code> button</p> <p></p> </li> <li> <p>Click <code>Copy embed code</code></p> <p></p> </li> <li> <p>Go back to sharepoint and paste the code you copied in the box provided</p> <p></p> <p>Tip</p> <p> 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.</p> </li> <li> <p>To make a small amount of extra room on your page, you may wish to edit the title and choose <code>Plain</code> as it's layout.</p> <p></p> </li> <li> <p>Once you are happy with the page, click 'Publish' to make it visible to other members of your site.</p> <p></p> </li> <li> <p>Promote your new page by following the recommendations</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/sharepoint/admin/","title":"Admin","text":""},{"location":"boards/msgraph/sharepoint/admin/#enable-embedding-huddo-boards-pages-in-sharepoint","title":"Enable embedding Huddo Boards pages in Sharepoint.","text":"<p>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.</p> <p>Admin access is required for these steps</p> <ol> <li>Browse to the root of the sharepoint site, click the settings cog and choose <code>Site Settings</code></li> </ol> <p></p> <p>OR choose <code>Site information</code> then <code>View all site settings</code></p> <p> </p> <ol> <li>Click <code>HTML Field Security</code></li> </ol> <p></p> <ol> <li>Type in boards.huddo.com and click <code>Add</code></li> </ol> <p></p> <ol> <li>Click <code>OK</code></li> </ol> <p></p> <ol> <li>To add Site Pages for sharing Huddo Boards, follow the instructions here</li> </ol>"},{"location":"boards/msgraph/teams/","title":"Moved","text":"<p>to here</p>"},{"location":"boards/msgraph/teams/notification-bot/","title":"Microsoft Teams Notification Bot","text":"<p>This bot will be used to post notification to Microsoft Teams triggered by actions performed in Huddo Boards.</p> <p>Note: this step is optional and cannot be achieved if you do not meet the prerequisites.</p> <p></p>"},{"location":"boards/msgraph/teams/notification-bot/#prerequisites","title":"Prerequisites","text":"<ul> <li>Boards deployment is accessible from the web (no VPN)</li> </ul> <p>Note: Microsoft Teams notifications requires 2-way web communication.</p> <p>For example, the following URL must be accessible by Microsoft's servers: <code>https://[BOARDS_URL]/webhook/teams</code></p>"},{"location":"boards/msgraph/teams/notification-bot/#configure-bot","title":"Configure Bot","text":""},{"location":"boards/msgraph/teams/notification-bot/#create-bot","title":"Create Bot","text":"<ol> <li> <p>Open Bot Registration and sign-in with a Microsoft Tenant admin</p> </li> <li> <p>Enter the following values</p> <pre><code>Huddo Boards\nhuddoboards\nhttps://[BOARDS_URL]/webhook/teams\n[MSGRAPH_CLIENT_ID]\n</code></pre> <p>Where:</p> <ul> <li> <p><code>[BOARDS_URL]</code> is the URL to your Huddo Boards installation</p> <p>i.e. <code>https://connections.example.com/boards/webhook/teams</code> or <code>https://boards.company.example.com/webhook/teams</code></p> </li> <li> <p><code>[MSGRAPH_CLIENT_ID]</code> is the OAuth Client ID from Auth setup</p> </li> </ul> <p>For example:</p> <pre><code>Huddo Boards\nhuddoboards\nhttps://connections.example.com/boards/webhook/teams\nb0e1e4a3-3df0-4c0a-8a2a-c1d630bb52b8\n</code></pre> <p></p> </li> <li> <p>Scroll down, read/agree to the terms and click <code>Register</code></p> </li> </ol> <p></p>"},{"location":"boards/msgraph/teams/notification-bot/#connect-bot-to-teams","title":"Connect Bot to Teams","text":"<ol> <li> <p>Click the <code>Teams</code> icon</p> <p></p> </li> <li> <p>Click <code>Save</code></p> <p></p> </li> <li> <p>The bot setup is complete</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/teams/notification-bot/#next-steps","title":"Next Steps","text":"<p>See Installing the Huddo Boards Teams App</p>"},{"location":"boards/msgraph/teams/on-prem/","title":"Huddo Boards On-Premise in Microsoft Teams","text":""},{"location":"boards/msgraph/teams/on-prem/#contact-us","title":"Contact Us","text":"<p>Send an email to support@huddo.com with the following details:</p> <p>Hi! I'd like to set up the Huddo Boards Microsoft Teams app for my company, [COMPANY NAME]. Here are the details:</p> <ul> <li>(optional) Attach the <code>.zip</code> or <code>manifest.json</code> file of any previous Huddo Boards teams app you have used or been provided before.</li> <li>[ ] The Application ID of the Huddo Boards application you have already registered in Microsoft Entra. <sup>See Authenticating Huddo Boards with Microsoft 365</sup></li> <li>[ ] <code>APP_URI</code> value from your helm chart values.</li> <li>[ ] <code>API_GATEWAY</code> value from your helm chart values.</li> </ul> <p>We will generate your customized Huddo Boards Teams app and provide you up-to-date guidance on how to deploy it in your environment.</p> <p>Updates to the Huddo Boards Teams app may need to be re-deployed via another customised Teams app package. We have automation in place for generating updates for your Teams app, however a manual step will be required by you to deploy the update.</p> <p>Once you have your customised Teams app and advice from the Huddo team:</p> <ol> <li> <p>Open the Boards Helm Chart config used for deployment</p> <p>Add the following environment variable to <code>provider</code> (uncomment or add the section as required):</p> <pre><code>provider:\n    env:\n        MSGRAPH_TEAMS_MANIFEST_ID: \"&lt;id attribute from your teams app manifest.json&gt;\"\n</code></pre> </li> <li> <p>Redeploy Boards helm chart as per command for Huddo Boards:</p> <p>HCL Component Pack</p> <pre><code>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\n</code></pre> <p>for Docker - Kubernetes</p> <pre><code>helm upgrade huddo-boards https://docs.huddo.com/assets/config/kubernetes/huddo-boards-1.0.0.tgz -i -f ./boards.yaml --namespace boards\n</code></pre> <p>Note: <code>--recreate-pods</code> is not required this time as this is only an env variable change</p> </li> </ol>"},{"location":"boards/msgraph/teams/on-prem/#how-to-use","title":"How To Use","text":"<p>For a full guide on using Huddo Boards in Microsoft Teams, please see our documentation.</p>"},{"location":"boards/msgraph/teams/install/","title":"Teams","text":""},{"location":"boards/msgraph/teams/install/#add-huddo-boards-to-microsoft-teams","title":"Add Huddo Boards to Microsoft Teams","text":"<p>Note</p> <p>If you're a Microsoft 365 administrator, please see the section on providing admin consent.</p> <p>Huddo Boards is available in the Microsoft Teams App Store. Click here to open in Teams.</p> <ul> <li>Select Add to add Huddo Boards as a personal app.</li> <li>Select Add to a team to add a Huddo Boards tab to a team channel.     </li> </ul>"},{"location":"boards/msgraph/teams/install/#accept-updates-to-huddo-boards-in-microsoft-teams","title":"Accept Updates to Huddo Boards in Microsoft Teams","text":"<p>Some updates to Huddo Boards' Teams app need your approval within the Teams client.</p> <p>For detailed instructions, see Microsoft's support article for updating apps in Teams</p> <p>Here's a sample from Microsoft's article:</p> <ol> <li> <p>Select Apps on the left side of Teams.</p> </li> <li> <p>Near the bottom left of your screen, you'll see a little red bubble next to Manage your apps that shows the number of app updates waiting to resolve. Select that bubble.</p> </li> <li> <p>On the Manage your apps page, you'll see that your apps have been sorted so that the ones that need updates are at the top. Select Update for each app you want to update.    </p> </li> <li> <p>When you select Update for an app, a dialog with that app's details will appear, including a What's new tab describing how the latest updates change the app. If necessary, the What's new tab will also include a list of permissions for you to accept.</p> </li> <li> <p>Select Update now to accept the permissions and update the app!    Install Dialog - Update Now</p> </li> </ol>"},{"location":"boards/msgraph/teams/install/#within-the-teams-client","title":"Within the Teams Client","text":"<p>You can also find add Huddo Boards app for Teams within the Teams client by following the walkthroughs below.</p>"},{"location":"boards/msgraph/teams/install/#add-huddo-boards-to-a-team","title":"Add Huddo Boards to a Team","text":"<ol> <li> <p>Open the Teams App and go to the team you wish to add Huddo Boards to.</p> </li> <li> <p>Click the <code>+</code> (add a tab) button</p> <p></p> </li> <li> <p>Search for <code>huddo</code> to find Huddo Boards</p> <p></p> <p>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 <code>More Apps</code> in this case:</p> <p></p> <p>Again, search for <code>huddo</code> to find the Huddo Boards App in the entire store.</p> </li> <li> <p>Once you have located and clicked on the Huddo Boards App, click the <code>Add</code> button to add it to the team:</p> <p></p> </li> <li> <p>The Huddo Boards app will now be added to the team, and you will be given the ability to add a new tab:</p> <p></p> </li> </ol>"},{"location":"boards/msgraph/teams/install/#add-the-huddo-boards-personal-app","title":"Add the Huddo Boards personal app","text":"<ol> <li> <p>Open Teams and click the Apps button. Type <code>huddo</code> to find the Huddo Boards app:</p> <p></p> </li> <li> <p>Click <code>Huddo Boards</code> then click <code>Add</code> to add it as a personal app:</p> <p></p> </li> </ol>"},{"location":"boards/proxy/nginx/","title":"Proxy (NGINX)","text":"<p>If you are running an NGINX proxy (e.g. customizer) then you can pass Boards traffic directly to your Kubernetes deployment.</p> <p>Please add the following location blocks to your <code>server</code> -&gt; <code>listen 443</code> blocks:</p> <pre><code># Redirect from HCL Connections Activities -&gt; Boards\nlocation ~ ^/activities/service/html/(.*)$ {\n  rewrite ^/activities/service/html/(.*)$ /boards/activities/service/html/$1 redirect;\n}\n\n# Boards UI\nlocation /boards {\n    proxy_pass http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/boards;\n}\n\n# Boards API (including WebSocket support)\nlocation /api-boards {\n    proxy_pass http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/api-boards;\n    proxy_http_version 1.1;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection \"upgrade\";\n    proxy_set_header Host $host;\n}\n</code></pre> <p>Where:</p> <ul> <li><code>[KUBERNETES_NAME]</code> is the hostname/IP of the master in your cluster</li> <li><code>[KUBERNETES_PORT]</code> is the port of your Ingress Controller (ie 32080)</li> </ul> <p>For example:</p> <p></p>"},{"location":"boards/store/","title":"Huddo Store","text":"<p>To obtain licences for Huddo Boards, you need to register your organisation at https://store.huddo.com.</p> <p>All HCL Connections customers are eligible for a free licence to use our Activity view.</p> <p>Obtaining your licence key:</p> <ol> <li> <p>Register for our store with your Name and email address.</p> </li> <li> <p>Click the link in the email we sent to verify your account.</p> </li> <li> <p>Create Your Organisation and Login client, details below.</p> </li> <li> <p>Click <code>Create Activities+ Licence</code></p> </li> <li> <p>Click <code>Download Licences</code></p> </li> </ol>"},{"location":"boards/store/#organisation-details","title":"Organisation Details","text":"<p>You will need to provide the following information to setup you Organisation in the store.</p> <p></p> <p>When creating your Login client(s) refer to the table below for details:</p> Provider Text Field HCL Connections Your Connections URL HCL Domino Your Domino server URL Microsoft 365 Your Microsoft 365 tenant ID"},{"location":"boards/swarm/","title":"Boards for Docker Swarm (DEPRECATED)","text":"<p>Warning</p> <p>These instructions are deprecated. Please see AIO guide if you do not have either Kubernetes or Component Pack</p> <p>Basic instructions for deploying Huddo Boards into Docker Swarm for on-premise IBM Connections environments</p>"},{"location":"boards/swarm/#prerequisites","title":"Prerequisites","text":"<ol> <li>Docker Swarm with Portainer installed. Guide here</li> <li>Storage - an accessible MongoDB and S3 object store.</li> <li>SMTP gateway setup for email notifications</li> <li>Config File downloaded</li> <li> <p>Dockerhub account with access to Huddo Boards repository.</p> <p>Send your account details to support@huddo.com if you don't already have this.</p> </li> <li> <p>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 <code>https://boards.huddo.com</code> and <code>https://api.boards.huddo.com</code>. The certificate should be pem encoded with a separate key file.</p> </li> </ol>"},{"location":"boards/swarm/#setup-oauth","title":"Setup OAuth","text":"<p>Huddo Boards currently supports the following oAuth providers for authentication and integration: HCL Connections (on premise), IBM Connections Cloud and Microsoft 365.</p> <p>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:</p> Provider Registration / Documentation Callback URL IBM Connections (on premise) Huddo instructions <code>https://[BOARDS_URL]/auth/connections/callback</code> Microsoft 365 Azure app registrations <code>https://[BOARDS_URL]/auth/msgraph/callback</code> Google Google Console <code>https://[BOARDS_URL]/auth/google/callback</code> LinkedIn LinkedIn <code>https://[BOARDS_URL]/auth/linkedin/callback</code> Facebook Facebook developer centre <code>https://[BOARDS_URL]/auth/facebook/callback</code>"},{"location":"boards/swarm/#update-config-file","title":"Update config file","text":"<p>Swarm Variables:</p> Key Description <code>x-minio-access</code> Minio <code>ACCESS_KEY</code> as defined in your docker swarm config <code>x-minio-secret</code> Minio <code>SECRET_KEY</code> as defined in your docker swarm config <code>x-app-env.APP_URI</code> <code>https://[BOARDS_URL]</code> <code>services.webfront.deploy.labels</code> Update the <code>traefik.frontend.rule</code> your <code>[BOARDS_URL]</code> (no protocol) <code>services.core.deploy.labels</code> Update the <code>traefik.frontend.rule</code> with your <code>[API_URL]</code> (no protocol) <p>Boards Variables:</p> <p>Follow instructions on this page</p>"},{"location":"boards/swarm/#deploy","title":"Deploy","text":"<ol> <li>Open Portainer and login</li> <li>Select your primary endpoint</li> <li>Choose Stacks from the side menu</li> <li>Click Add Stack</li> <li>Name your stack kudos-boards</li> <li>Browse to your customised config file</li> <li>Click \"Deploy the stack\"</li> </ol>"},{"location":"boards/swarm/#update-dns","title":"Update DNS","text":"<p>Update DNS records with a CNAME entry pointing to your swarm URL.</p> <p>For example:</p> <pre><code>boards.huddo.com -&gt; swarm.isw.net.au\nboards.api.huddo.com -&gt; swarm.isw.net.au\n</code></pre>"},{"location":"boards/swarm/#hcl-connections-integrations","title":"HCL Connections integrations","text":"<p>Please follow these instructions</p> <ul> <li>Header</li> <li>Apps Menu</li> <li>Widgets</li> </ul>"},{"location":"boards/swarm/#advanced","title":"Advanced","text":"<p>You can also run Huddo Boards with externally hosted mongo database and/or S3 storage. For assistance with this contact support@huddo.com</p>"},{"location":"boards/swarm/#updates","title":"Updates","text":"<p>The Boards services can be updated through the Portainer interface, or alternatively these commands should force latest images to run</p> <pre><code>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\n</code></pre> <p>If you must update the Portainer/Traefik images, try these commands:</p> <pre><code>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\n</code></pre>"},{"location":"boards/swarm/prerequisites/","title":"Requirements and considerations before installation of Docker Swarm and Huddo Boards (DEPRECATED)","text":"<p>Warning</p> <p>These instructions are deprecated. Please see AIO guide if you do not have either Kubernetes or Component Pack</p>"},{"location":"boards/swarm/prerequisites/#servers","title":"Servers","text":"<p>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 small servers.</p>"},{"location":"boards/swarm/prerequisites/#existing-infrastructure","title":"Existing Infrastructure","text":"<p>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.</p> 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":"<p>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)</p>"},{"location":"boards/swarm/prerequisites/#ssl-certificates-dns","title":"SSL Certificates / DNS","text":"<p>You will need to have certificates and DNS entries that cover the following domains:</p> <p>Replace <code>example.com</code> with your actual company domain</p> Service Example domain DNS Swarm swarm.example.com A record pointing to gateway server Boards boards.example.com CNAME swarm.example.com Boards API api-boards.example.com CNAME swarm.example.com"},{"location":"boards/swarm/prerequisites/#ssh-access","title":"SSH Access","text":"<p>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.</p>"},{"location":"boards/swarm/prerequisites/#authentication","title":"Authentication","text":"<p>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):</p> Provider Registration / Documentation IBM Connections (on premise) IBM Knowledge Center IBM Connections Cloud IBM Knowledge Center Microsoft 365 Azure app registrations Google Google Console LinkedIn LinkedIn Facebook Facebook developer centre"},{"location":"boards/swarm/prerequisites/#dockerhub-deprecated","title":"Dockerhub (Deprecated)","text":"<p>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.</p>"},{"location":"boards/swarm/prerequisites/#ansible","title":"Ansible","text":"<p>We use Red Hat Ansible to script the installs. Please ensure this is installed as per our guide prior to the swarm / boards install</p>"},{"location":"boards/troubleshooting/activities-plus-install/","title":"Activities Plus Install FAQ","text":"<p>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.</p> <p>There are also some more notes and insights from one of our partners which is a great read.</p>"},{"location":"boards/troubleshooting/activities-plus-install/#installing-activities-plus-services","title":"Installing Activities Plus services","text":"<ul> <li>Please see our documentation and the latest chart</li> </ul>"},{"location":"boards/troubleshooting/activities-plus-install/#configuring-ibm-http-server-as-reverse-proxy","title":"Configuring IBM HTTP Server as reverse proxy","text":"<ul> <li> <p>If you do not have them enabled, you will need to enable the following modules by uncommenting them (remove the '#'):</p> <pre><code>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\n</code></pre> </li> <li> <p>If you have not specified earlier (such as during other component-pack app installs), please set <code>ProxyPreserveHost On</code> before the Huddo Boards section in the VirtualHost</p> </li> </ul>"},{"location":"boards/troubleshooting/activities-plus-install/#updating-the-activities-plus-configuration-file","title":"Updating the Activities Plus configuration file","text":"<ul> <li>Please use this boards-cp.yaml NOT the one supplied with the component pack.</li> </ul>"},{"location":"boards/troubleshooting/activities-plus-install/#migrating-activities-data","title":"Migrating Activities data","text":"<ul> <li> <p>The helm upgrade command needs to be run from the directory containing boards-cp.yaml and the correct command is:</p> <pre><code>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\n</code></pre> <p>e.g.</p> <pre><code>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\n</code></pre> </li> </ul>"},{"location":"boards/troubleshooting/activities-plus-install/#duplicate-name-mongo_host","title":"Duplicate name MONGO_HOST","text":"<p>When (re)deploying the Boards CP Chart you may see this warning:</p> <pre><code>W0612 09:17:16.153629   21276 warnings.go:70] spec.template.spec.containers[0].env[2].name: duplicate name \"MONGO_HOST\"\n</code></pre> <p>This 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.</p>"},{"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":"<p>Sometimes the pod fails to start with an error <code>listen EACCES: permission denied</code>. For example:</p> <pre><code>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.\n</code></pre> <p>This is because the port is already in use. We must change the default port which </p>"},{"location":"boards/troubleshooting/activity-migration/#resolution","title":"Resolution","text":"<ol> <li> <p>Open your Boards yaml file</p> </li> <li> <p>Set the new port as per below (merging into existing)</p> <pre><code>global:\n  env:\n    ACTIVITY_MIGRATION_PORT: '2651'\n\nmigration:\n  balancer:\n    port: 2651\n    targetPort: 2651\n</code></pre> </li> <li> <p>Redeploy both the Boards helm chart and the Activity Migration charts with the updated yaml</p> </li> <li> <p>Confirm the pod start successfully or change to another random higher port if conflicts still occur.</p> </li> </ol>"},{"location":"boards/troubleshooting/activity-migration/#missing-long-descriptions","title":"Missing Long Descriptions","text":"<p>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</p> <p>Note: this requires Boards images with date tags on or after 2021-03-22</p>"},{"location":"boards/troubleshooting/activity-migration/#process-overview","title":"Process Overview","text":"<p>This service will:</p> <ol> <li>mount the Connections Shared drive</li> <li>find any migrated cards which have a link to the old \"Long Description\" (with <code>/downloadExtended/</code> in the URL)</li> <li>use the Connections database to locate the files' path on the NFS drive</li> <li>retrieve the file contents from the file path</li> <li>save this full content into the card and overwrite the short summary version which previously was used</li> <li>remove the link on the card to the Long Description</li> <li>log statistics on how many cards were fixed</li> </ol> <p>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.</p>"},{"location":"boards/troubleshooting/activity-migration/#steps","title":"Steps","text":"<ol> <li> <p>Add the volume, volume mount &amp; <code>FILE_PATH_ACTIVITIES_CONTENT_STORE</code> to the boards yaml config. For example:</p> <pre><code>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\n</code></pre> </li> <li> <p>Replace the <code>sharedDrive.server</code> IP and the <code>sharedDrive.path</code> to the shared drive (e.g. <code>/nfs/data/shared</code> or <code>/opt/HCL/data/shared</code> etc)</p> </li> <li>Deploy the Activity Migration chart applicable for your deployment (CP v3 or standalone Kubernetes v5)</li> <li>Review the pod logs for the status of how many long description were replaced</li> </ol>"},{"location":"boards/troubleshooting/activity-migration/#jvm-heap-size-oom","title":"JVM Heap Size OoM","text":"<p>When migrating very large activities sometimes you may encounter an OutOfMemory error.</p>"},{"location":"boards/troubleshooting/activity-migration/#resolution_1","title":"Resolution","text":"<p>In the migration YAML chart you can set following to reduce the amount of concurrent data accessed in memory:</p> <pre><code>migration.env.PROCESSING_PAGE_SIZE: 1\nmigration.env.FIELDS_PAGE_SIZE: 1\n</code></pre> <p>Once these values are set you need to deploy the chart again to make them take effect.</p> <p>You will also need to increase the amount of memory available to NodeJS by adding the environment variables in the migration YAML:</p> <pre><code>resources.requests.memory: 2024M\nresources.limits.memory: 8192M\nenv.NODE_OPTIONS: \"--max-old-space-size=8192\"\n</code></pre> <p></p>"},{"location":"boards/troubleshooting/activity-migration/#activity-stuck-in-pending-migration","title":"Activity stuck in pending migration","text":"<p>If 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.</p> <pre><code>migration.env.PURGE_INCOMPLETE: \"true\"\n</code></pre> <p>You are also able to delete already migrated activities by setting PURGE_MIGRATED_ACTIVITY_IDS so they can be migrated again.</p> <pre><code>migration.env.PURGE_MIGRATED_ACTIVITY_IDS: \"acitivityId,activityId2,activityId3,...,activityIdN\"\n</code></pre> <p>Once 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!</p>"},{"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":"<p>The steps below will test a Huddo Boards / Activities Plus oauth setup.</p> <p>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.</p>"},{"location":"boards/troubleshooting/aplus-auth/#block-requests-to-boards","title":"Block requests to boards","text":"<p>Update WAS httpd.conf</p> <p>change ProxyPass and ProxyPassReverse entries for <code>/boards</code> to use a different (invalid) port number.</p>"},{"location":"boards/troubleshooting/aplus-auth/#install-and-open-postman-or-another-api-testing-tool","title":"Install and open postman or another api testing tool","text":""},{"location":"boards/troubleshooting/aplus-auth/#in-postman-prepare-a-request-as-below","title":"In postman prepare a request as below","text":"<p>Method: POST</p> <p>Request URL: https://(connections url)/oauth2/endpoint/connectionsProvider/token</p> <p>On the Body tab, select <code>x-www-form-urlencoded</code> and fill in the following:</p> KEY VALUE client_id huddoboards client_secret your client secret redirect_uri https://(connections url)/boards/auth/connections/callback grant_type authorization_code code (paste the code from the next step here)"},{"location":"boards/troubleshooting/aplus-auth/#open-connections-auth","title":"Open connections auth","text":"<p>replace connections url in both places below</p> <pre><code>https://(connections url)/oauth2/endpoint/connectionsProvider/authorize?client_id=huddoboards&amp;redirect_uri=https%3A%2F%2F(connections url)%2Fapi-boards%2Fauth%2Fconnections%2Fcallback&amp;response_type=code&amp;state=1234\n</code></pre>"},{"location":"boards/troubleshooting/aplus-auth/#click-approve","title":"Click approve","text":"<p>The loaded page should error, that is expected.</p>"},{"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":"<pre><code>{\n  \"access_token\": \"s67MkH8LYMMKiP0q2gtVKQxkD0gBcXJJlSCdvQw3\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 43199,\n  \"scope\": \"\",\n  \"refresh_token\": \"EcO9hDYdU3tL2BE0xRSPNlYIGvZhYV9yezb14YKNglkFPwq4St\"\n}\n</code></pre>"},{"location":"boards/troubleshooting/aplus-auth/#use-the-token-to-request-your-profile","title":"Use the token to request your profile","text":"<p>Open a new tab in postman and update:</p> <p>Method: GET</p> <p>Request URL: https://(connections url)/connections/opensocial/oauth/rest/people/@me/@self</p> <p>Authorization Tab</p> <p>TYPE: Bearer Token</p> <p>Token: (Paste in the access_token from the previous request)</p> <p>Hit Send, You should get a json response describing your profile.</p>"},{"location":"boards/troubleshooting/aplus-auth/#reset-was-httpdconf","title":"Reset WAS httpd.conf","text":"<p>Make sure to put the port numbers back to their original values.</p>"},{"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":"<p>Please revoke your OAuth access to Huddo Boards Cloud within HCL Connections. Go to <code>https://&lt;YOUR_CONNECTIONS_URL&gt;/connections/oauth/apps</code> (replacing <code>&lt;YOUR_CONNECTIONS_URL&gt;</code>) and press 'Revoke'</p> <p></p>"},{"location":"boards/troubleshooting/docker/","title":"Huddo Boards Docker","text":""},{"location":"boards/troubleshooting/docker/#authentication","title":"Authentication","text":""},{"location":"boards/troubleshooting/docker/#logging-in-doesnt-work","title":"Logging-in doesn't work","text":"<p>Please revoke your OAuth access to Huddo Boards Cloud within HCL Connections. Go to <code>https://&lt;YOUR_CONNECTIONS_URL&gt;/connections/oauth/apps</code> (replacing <code>&lt;YOUR_CONNECTIONS_URL&gt;</code>) and press 'Revoke'</p> <p></p>"},{"location":"boards/troubleshooting/docker/#kubernetes-ingress-controller-version","title":"Kubernetes Ingress Controller Version","text":"<p>To check the version of the ingress controller run this command</p> <pre><code>kubectl get pods --all-namespaces | grep ingress-controller\nkubectl exec -it &lt;POD_NAME&gt; -n &lt;NAMESPACE&gt; -- /nginx-ingress-controller --version\n</code></pre> <p>where</p> <ul> <li><code>&lt;POD_NAME&gt;</code> is the name of the Ingress controller pod</li> <li><code>&lt;NAMESPACE&gt;</code> is the namespace of the Ingress controller pod. e.g. <code>kube-system</code> or <code>connections</code></li> </ul> <p>For example</p> <pre><code>kubectl get pods --all-namespaces | grep ingress\nkubectl exec -it nginx-ingress-controller-84d4dfc9b-7gv4m -n kube-system -- /nginx-ingress-controller --version\n</code></pre> <p>Example</p> <pre><code>-------------------------------------------------------------------------------\nNGINX Ingress controller\n  Release:    0.23.0\n  Build:      git-be1329b22\n  Repository: https://github.com/kubernetes/ingress-nginx\n-------------------------------------------------------------------------------\n</code></pre> <p>As 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 <code>huddo-boards-cp-1.2.0.tgz</code> which includes all required annotations (including socket.io cookie fix).</p> <p>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</p> <pre><code>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\"\n</code></pre>"},{"location":"boards/troubleshooting/docker/#customizing-boards-context-root","title":"Customizing Boards Context Root","text":"<p>If you wish to deploy boards at a path other than <code>/boards</code> &amp; <code>/api-boards</code> please see this example file of all the variables to merge into your YAML config file.</p> <p>Note: If you are using an older version of the Ingress controller (&lt; 0.22) you will need to use example above</p> <p>Note: please see this example again if you encounter the error</p> <pre><code>Ignoring ingress because of error while validating ingress class\" ingress=\"connections/kudos-boards-cp-webfront\" error=\"ingress does not contain a valid IngressClass\"\n</code></pre>"},{"location":"boards/troubleshooting/docker/#no-real-time-updates-eg-rich-text-not-editable","title":"No real time updates (eg Rich Text not editable)","text":"<p>Some 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.</p> <p>Note: if you have a <code>core.annotations</code> 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 <code>annotations</code> section otherwise.</p>"},{"location":"boards/troubleshooting/docker/#additional-for-websphere-ihs","title":"Additional for WebSphere IHS","text":"<p>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</p> <pre><code>webfront:\n    env:\n        FORCE_POLLING: true\n</code></pre>"},{"location":"boards/troubleshooting/docker/#minio-pods-fail-to-start-in-boards-cp","title":"Minio pods fail to start in Boards CP","text":"<p>If the Minio service fails to start with the following error:</p> <pre><code>ERROR Unable to initialize backend: found backend fs, expected xl\n</code></pre> <p>Please update to kudos-boards-cp-3.1.4.tgz which includes a different image of Minio which supports your existing 'fs' file system.</p>"},{"location":"boards/troubleshooting/docker/#react-minified-issue","title":"React Minified Issue","text":"<p>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 the 2022-12-15 release</p>"},{"location":"boards/troubleshooting/docker/#itm-render-issue","title":"ITM Render Issue","text":"<p>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.</p> <p>You can add this to your custom css in the header/customiser (which is then injected into Boards).</p> <pre><code>.gt-sm.cnx8-ui.itm-bar-open .itm-section {\n  position: absolute;\n  right: 0;\n}\n</code></pre>"},{"location":"boards/troubleshooting/mongo/","title":"Troubleshoot MongoDB","text":""},{"location":"boards/troubleshooting/mongo/#connect-to-mongo","title":"Connect to Mongo","text":"<p>You may need to connect to Mongo for validation or other changes. To connect to Kubernetes Mongo:</p> <ul> <li> <p>In Component Pack</p> <pre><code>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\n</code></pre> </li> <li> <p>Standalone deployment</p> <ol> <li> <p>get the name of the mongo pod</p> <pre><code>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\n</code></pre> </li> <li> <p>exec into the pod using the mongosh (or mongo) command - replacing pod name and namespace</p> <pre><code>kubectl exec -it mongo-67696548c-xpdqh -n boards -- mongosh --host mongo-service:27017\n</code></pre> </li> </ol> </li> </ul>"},{"location":"boards/troubleshooting/mongo/#access-boards-data","title":"Access Boards Data","text":"<ol> <li> <p>check the database names</p> <pre><code>show dbs\n</code></pre> </li> <li> <p>open the db containing board nodes (select as appropriate)</p> <pre><code># CP\nuse boards-app\n\n# Standalone\nuse kudos-boards-service\n</code></pre> </li> <li> <p>find all boards</p> <pre><code>db.nodes.find({ type: 'board' })\n</code></pre> </li> <li> <p>find a board from a particular activitity</p> <pre><code>db.nodes.find({ providerID: 'activities-id-goes-here' })\n</code></pre> </li> <li> <p>find the members for a particular board</p> <pre><code>db.boardmembers.find({ board: ObjectId(\"_id-of-board-found-above\") })\n</code></pre> </li> </ol>"},{"location":"boards/troubleshooting/mongo/#replace-member-of-a-board","title":"Replace Member of a Board","text":"<ol> <li> <p>open the db containing users (select as appropriate)</p> <pre><code># CP\nuse boards-user\n\n# Standalone\nuse kudos-user-service\n</code></pre> </li> <li> <p>find the users in question, e.g Andrew &amp; Nicky</p> <pre><code>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\", .....\n</code></pre> </li> <li> <p>switch to the boards app</p> </li> <li> <p>find the members for a particular board (substitute the ID)</p> <pre><code>db.boardmembers.find({ board: ObjectId(\"&lt;BOARD_ID&gt;\") })\n</code></pre> </li> <li> <p>replace <code>user A</code> with <code>user B</code>, e.g. Andrew with Nicky</p> <pre><code>db.boardmembers.updateOne({ board: ObjectId(\"&lt;BOARD_ID&gt;\"), 'entity.kind': 'User', 'entity.id': '617891eae72f26802c4bec5e' }, { $set: { 'entity.id': '617891ed660876da990253b7' }})\n</code></pre> </li> </ol>"},{"location":"boards/troubleshooting/nginx/","title":"NGINX Errors","text":""},{"location":"boards/troubleshooting/nginx/#400-bad-request","title":"400 Bad Request","text":"<p>Nginx has strict rules around the headers allowed on requests. If you encounter a <code>400 Bad Request</code> response in your environment when accessing <code>/boards</code> it is likely caused by incorrect headers set in the upsteam proxy(s) before Boards.</p> <p>To debug the cause, please views the logs for the webfront pods (as of build 20210924). You will see logs like:</p> <pre><code>  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\"\n</code></pre> <p>In this example, the <code>client sent invalid host header while reading client request headers</code>. You can see the host is included twice. This can occur if the host is set twice, or in some instances when the <code>X-Forwarded-Host</code> is also set.</p> <p>Please read this error carefully and make sure your environment complies with the latest NGINX specification.</p>"},{"location":"boards/troubleshooting/nginx/#ingress-proxy","title":"Ingress &amp; Proxy","text":"<p>To confirm if the problem is with the nginx layer above boards you can bypass it and directly test the Kubernetes ingress controller and deployment:</p> <pre><code>curl -H \"Host: [CONNECTIONS_URL]\" http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/boards\ncurl -H \"Host: [CONNECTIONS_URL]\" http://[KUBERNETES_NAME]:[KUBERNETES_PORT]/api-boards\n</code></pre> <p>OR</p> <pre><code>ssh root@[KUBERNETES_MASTER]\ncurl -H \"Host: [CONNECTIONS_URL]\" http://localhost:32080/boards\ncurl -H \"Host: [CONNECTIONS_URL]\" http://localhost:32080/api-boards\n</code></pre> <p>For example:</p> <pre><code>curl -H \"Host: connections.company.com\" http://master.kube.company.com:32080/boards\ncurl -H \"Host: connections.company.com\" http://master.kube.company.com:32080/api-boards\n</code></pre>"},{"location":"boards/troubleshooting/notifications/","title":"Troubleshooting Huddo Boards Notifications","text":""},{"location":"boards/troubleshooting/notifications/#huddo-boards-docker","title":"Huddo Boards Docker","text":"<p>If notifications are not sending, please ensure that the core and notifications pod can talk to each other</p> <pre><code>kubectl exec -n connections -it (boards core pod) -- sh\nenv | grep NOTIFI\nvi src/test.js (content below)\nnode src/test.js\n</code></pre> <p>Content for test.js:</p> <pre><code>const fetch = require('node-fetch');\nfetch(process.env.NOTIFICATION_HOST+':'+process.env.NOTIFICATION_PORT+'/health').then(console.log).catch(console.log);\n</code></pre> <p>If 200 status:</p> <p><code>bash kubectl delete pod -n boards (core pod1) kubectl delete pod -n boards (core pod2)</code></p>"},{"location":"boards/troubleshooting/oauth/","title":"OAuth","text":""},{"location":"boards/troubleshooting/oauth/#error-500-srve0295e","title":"Error 500: SRVE0295E","text":"<p>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.</p> <pre><code>SELECT count(lookupkey) FROM homepage.oh2p_cache WHERE username ='&lt;username&gt;' AND clientid='&lt;huddo_client_id&gt;'\n</code></pre> <p>Clearing the oh2p cache allows the user to login again.</p> <pre><code>DELETE from homepage.oh2p_cache where username='&lt;username&gt;' and clientid='&lt;huddo_client_id&gt;'\n</code></pre> <p>Please Note: You need to replace <code>&lt;username&gt;</code> and <code>&lt;huddo_client_id&gt;</code> with the correct values</p> <p>For more details, please see a blog post here.</p>"},{"location":"boards/troubleshooting/safari/","title":"Safari","text":""},{"location":"boards/troubleshooting/safari/#hcl-connections-community-widget","title":"HCL Connections Community Widget","text":"<p>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.</p> <p>The only solution is to disable the \"Prevent cross-site tracking\" option on the user's computer under Safari =&gt; Preferences =&gt; Privacy.</p> <p></p>"},{"location":"boards/troubleshooting/ssl/","title":"SSL","text":""},{"location":"boards/troubleshooting/ssl/#self-signed-certificates","title":"Self Signed Certificates","text":"<p>Issues with self-signed certificates can be resolved in 2 different ways:</p> <ol> <li>Add the self-signed certificate</li> <li>Disable TLS validation</li> </ol>"},{"location":"boards/troubleshooting/ssl/#add-the-self-signed-certificate","title":"Add the self-signed certificate","text":"<p>To mount the certificate in the pods:</p> <ol> <li> <p>Create a secret containing the certificate</p> <pre><code>kubectl create secret generic internal-ca --from-file=./cert.pem -n connections\n</code></pre> <p>Where:</p> <ul> <li><code>cert.pem</code> is the name of your certificate file (this is also used below as the <code>subPath</code> in the volumeMounts section)</li> <li><code>connections</code> is the namespace where the Boards chart is installed (replace with your namespace)</li> </ul> </li> <li> <p>Mount the secret in each applicable deployment by adding the following <code>volume</code> &amp; <code>volumeMount</code> to your existing values yaml, then redeploy the Boards helm chart.</p> <pre><code>global:\n    env:\n        NODE_EXTRA_CA_CERTS: /etc/ssl/certs/internal-ca.pem\n\ncore:\n    volumes:\n        - name: ssl-cert-vol\n          secret:\n              secretName: internal-ca\n    volumeMounts:\n        - name: ssl-cert-vol\n          mountPath: /etc/ssl/certs/internal-ca.pem\n          subPath: cert.pem\n\nuser:\n    volumes:\n        - name: ssl-cert-vol\n          secret:\n              secretName: internal-ca\n    volumeMounts:\n        - name: ssl-cert-vol\n          mountPath: /etc/ssl/certs/internal-ca.pem\n          subPath: cert.pem\n\nprovider:\n    volumes:\n        - name: ssl-cert-vol\n          secret:\n              secretName: internal-ca\n    volumeMounts:\n        - name: ssl-cert-vol\n          mountPath: /etc/ssl/certs/internal-ca.pem\n          subPath: cert.pem\n\n# if your email service is also using Self Signed Certificates\nevents:\n    volumes:\n        - name: ssl-cert-vol\n          secret:\n              secretName: internal-ca\n    volumeMounts:\n        - name: ssl-cert-vol\n          mountPath: /etc/ssl/certs/internal-ca.pem\n          subPath: cert.pem\n</code></pre> </li> </ol>"},{"location":"boards/troubleshooting/ssl/#disable-tls-validation","title":"Disable TLS Validation","text":"<p>Warning</p> <p>This is not recommended for production environments.</p> <p>You can add the environment variable <code>NODE_TLS_REJECT_UNAUTHORIZED: '0'</code>.</p> <p>This value is required in <code>core</code>, <code>user</code> &amp; <code>provider</code> deployments (and possibly <code>events</code> depending on the email server configuration).</p> <pre><code>core:\n    env:\n        NODE_TLS_REJECT_UNAUTHORIZED: \"0\"\nuser:\n    env:\n        NODE_TLS_REJECT_UNAUTHORIZED: \"0\"\nprovider:\n    env:\n        NODE_TLS_REJECT_UNAUTHORIZED: \"0\"\n\n# if required for your email server\nevents:\n    env:\n        NODE_TLS_REJECT_UNAUTHORIZED: \"0\"\n</code></pre>"},{"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 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":"<p>You may find that as a non-administrator Microsoft 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.</p> <p></p> <p>Note that Huddo Boards can still be used as a Microsoft Teams personal app whilst in this state</p>"},{"location":"boards/troubleshooting/office365/#resolution","title":"Resolution","text":"<p>A user that has administrative capabilities within your Microsoft 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:</p> <p></p> <p>After clicking <code>Approve</code>, 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:</p> <p></p> <p>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.</p>"},{"location":"boards/troubleshooting/office365/#force-administrative-approval-for-organisation","title":"Force Administrative Approval for Organisation","text":"<p>Administrative users for your Microsoft 365 organisation can also force an approval of all permissions for the organisation from within the Org Administration screen by following these steps:</p> <p>Access the Configuration Page and click through your Microsoft 365 client under 'Authentication Clients'.</p> <p>Click the <code>Approve Advanced Features</code> button:</p> <p></p> <p>This will direct you to the Microsoft 365 Permissions requested - Accept for your organisation page, allowing you to force the consent of all permissions that Huddo Boards needs for your organisation:</p> <p></p>"},{"location":"boards/troubleshooting/office365/#huddo-boards-app-not-showing-in-teams-store","title":"Huddo Boards App not showing in Teams store","text":"<p>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.</p> <p></p>"},{"location":"boards/troubleshooting/office365/#resolution_1","title":"Resolution","text":"<p>You will need to go to the Admin Dashboard to view the settings.</p> <p></p> <p>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.</p> <p></p>"},{"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":"<ol> <li>Download your custom Huddo Boards Extensions package from the Huddo Store.</li> <li>Extract the package and find the <code>verse/application.json</code> file.</li> <li>View <code>verse/application.json</code> as plain text to confirm the \"url\" fields contain the URL for your Boards deployment.</li> <li>Use this file with the localFileProvider method described in the HCL Verse Developers documentation.</li> </ol> <p>This documentation has been copied in below.</p>"},{"location":"boards/verse/verse-extension/#deploying-extensions-using-the-built-in-endpoint","title":"Deploying extensions using the built-in endpoint","text":"<p>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.</p> <p>Two data providers are implemented in the built-in endpoint:</p> <ul> <li> <p>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 <code>notes.ini</code> parameter <code>VOP_Extensibility_Applications_Json_FilePath</code>.</p> </li> <li> <p>HTTP data provider: Serves the applications JSON data from an HTTP hosted file. This allows you to deploy <code>applications.json</code> to a centralized HTTP server. The HTTP URL of the file can be specified using <code>notes.ini</code> parameter <code>VOP_Extensibility_Applications_Json_URL</code>.</p> </li> </ul> <p>The <code>notes.ini</code> parameter <code>VOP_Extensibility_Data_Provider_Name</code> controls which data provider to use, either <code>localFileProvider</code> or <code>httpDataProvider</code>. By default, if none is specified, <code>localFileProvider</code> will be used. In either case, the data provider will periodically check the source <code>applications.json</code> file for updates, so you don\u2019t have to restart the server after a new version of <code>applications.json</code> is deployed.</p> <p>To use the local file data provider:</p> <ul> <li> <p>Make sure <code>notes.ini</code> parameter <code>VOP_Extensibility_Data_Provider_Name</code> is either clear or set to <code>localFileProvider</code>.</p> </li> <li> <p>Deploy <code>applications.json</code> to the Domino server.</p> </li> <li> <p>Make sure notes.ini parameter <code>VOP_Extensibility_Applications_Json_FilePath</code> is set to the file path of <code>applications.json</code>. For example:</p> <pre><code>VOP_Extensibility_Applications_Json_FilePath=D:\\data\\applications.json\n</code></pre> </li> </ul> <p>To use the HTTP data provider:</p> <ul> <li> <p>Make sure <code>notes.ini</code> parameter <code>VOP_Extensibility_Data_Provider_Name</code> is set to <code>httpDataProvider.</code></p> <pre><code>VOP_Extensibility_Data_Provider_Name=httpDataProvider\n</code></pre> </li> <li> <p>Deploy <code>applications.json</code> to the HTTP server.</p> </li> <li> <p>Make sure <code>notes.ini</code> parameter <code>VOP_Extensibility_Applications_Json_URL</code> is set to the HTTP URL of <code>applications.json</code>. For example:</p> <pre><code>VOP_Extensibility_Applications_Json_URL=https://files.renovations.com/vop/applications.json\n</code></pre> </li> </ul>"},{"location":"ccm-migrator/export-fs/","title":"File-system export structure","text":"<p>This document describes the file structure used when either migrating to the file system, or exporting metadata during migration to Connections Files.</p>"},{"location":"ccm-migrator/export-fs/#rationale","title":"Rationale","text":"<p>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.</p> <p>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.</p> <p>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.</p>"},{"location":"ccm-migrator/export-fs/#directory-structure","title":"Directory structure","text":"<p>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: &lt;Community Name&gt;/files/&lt;Library Name&gt;/&lt;Folder&gt;/&lt;Subfolder&gt;</p> <p>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: &lt;Community Name&gt;/metadata/&lt;Library Name&gt;/&lt;Folder&gt;/&lt;Subfolder&gt;</p> <p>The metadata location is also used to export most file versions excluding the current version, when migrating to the file system.</p> <p>In both cases above, &lt;Subfolder&gt; may be repeated for as many subfolder levels as were present in CCM.</p> <p>Within the metadata structure, there will be:</p> <ul> <li>A members.csv file in each library directory, listing the library members;</li> <li>members.csv and meta.csv files for each folder, listing the folder members and metadata; and</li> <li>Directories named like &lt;Filename&gt;&lt;extension&gt;.meta corresponding with each CCM file. This directory will contain versions of the CCM file, along with comments.csv, members.csv, and meta.csv files listing comments, members, and metadata for that file.</li> </ul> <p>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\".</p> <p>The filename format for versions will be: &lt;Original filename&gt;_v&lt;version number&gt;&lt;extension&gt;</p>"},{"location":"ccm-migrator/export-fs/#example","title":"Example:","text":"<p>If the current version is Proposal.docx, then version 1 (superseded) will be Proposal_v1.0.docx in the Proposal.docx.meta subdirectory.</p>"},{"location":"ccm-migrator/export-fs/#user-access","title":"User access","text":"<p>Files named members.csv list members (user access) for each community, library, folder, and file.</p> <p>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:</p> <ul> <li>User/group name;</li> <li>Unique user id;</li> <li>User email address;</li> <li>Type (either \"user\" or \"group\"); and</li> <li>Access level (one of \"member\" or \"owner\" for communities, or one of \"owner\", \"contributor\", \"editor\", or \"reader\" for libraries, folders, and files).</li> </ul> <p>The users/groups listed in members.csv will be those with explicit access, plus some special user names as follows:</p> <ul> <li>\"*Community Access*\", indicating the community access setting (one of \"public\", \"moderated\", or \"restricted\");</li> <li>\"*Community Members*\", indicating the access that community members have to a library, folder, or file.</li> <li>\"*Community Owners*\", indicating the access that community owners have to a library, folder, or file.</li> </ul>"},{"location":"ccm-migrator/export-fs/#comments-tags-and-other-metadata","title":"Comments, tags, and other metadata","text":"<p>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.</p> <p>comments.csv contains all comments for the file. Comma-separated fields for each comment are:</p> <ul> <li>File version on which the comment was made.</li> <li>Date/time, formatted as ISO 8601 in UTC (e.g. \"2021-02-26T09:00:00.000Z\");</li> <li>Commenter user name;</li> <li>Commenter unique user id;</li> <li>Commenter email address; and</li> <li>The comment text.</li> </ul> <p>meta.csv contains any metadata which isn't comments or members. Comma-separated fields for each line are:</p> <ul> <li>The type of metadata, one of:<ul> <li>\"uuid\" - CCM file/folder uuid;</li> <li>\"comm_uuid\" - Source community uuid;</li> <li>\"componentId\" - CCM component id (appears in CCM URLs);</li> <li>\"name\" - CCM file/folder name;</li> <li>\"renamed\" - Migrated file/folder name (always present even if the name wasn't changed);</li> <li>\"created\" - Creation date/time, formatted as ISO 8601 in UTC;</li> <li>\"author\" - Display name of author/creator;</li> <li>\"modified\" - Last-modified date/time, formatted as ISO 8601 in UTC;</li> <li>\"modifier\" - Display name of user who last modified the file/folder;</li> <li>\"summary\" - File description/summary;</li> <li>\"tag\" - File tags (this metadata type is repeated if there are multiple tags);</li> <li>\"draft\" - Has the value \"true\" if the current version is a draft, but is otherwise absent;</li> <li>\"likes\" - Number of likes;</li> <li>\"downloads\" - Number of downloads;</li> <li>\"link\" - CCM file/folder URL as reported by CCM API (may redirect to another URL when used in a web browser);</li> <li>\"link_alt\" - Alternate CCM file/folder URL;</li> <li>\"link_ibmscp\" - CCM file/folder URL for the ibmscp protocol (Connections Mobile);</li> <li>\"link_content\" - CCM file download URL;</li> <li>\"dest_uuid\" - Connections file/folder uuid (if migrated to Connections Files);</li> <li>\"dest_comm_uuid\" - Destination community uuid (if migrated to Connections Files);</li> <li>\"dest_link\" - Connections file/folder URL (if migrated to Connections Files);</li> <li>\"dest_link_content\" - Connections file download URL (if migrated to Connections Files);</li> <li>\"doc_type\" - CCM document type display name;</li> <li>\"doc_type_uuid\" - CCM document type uuid;</li> <li>Custom fields - Any metadata types different from those above are custom fields defined as part of the CCM document type.</li> </ul> </li> <li>The version number to which the metadata applies. This will be blank for the current version; and</li> <li>The metadata value.</li> </ul>"},{"location":"ccm-migrator/export-fs/#general-information-csv-files","title":"General information - CSV files","text":"<p>CSV files created by CCM Migrator conform to Microsoft Excel's CSV format, with details as follows:</p> <ul> <li>Fields are separated by commas.</li> <li>Text data is contained in double-quote characters.</li> <li>Text data can contain commas without any type of \"escape character\", because the enclosing double-quotes ensure those commas aren't interpreted as separators.</li> <li>Literal double-quote characters can be included in text data by doubling them. I.e. The double-quote character acts as an \"escape character\" for itself.</li> <li>Text data can contain literal line breaks, therefore any single record can use multiple lines. This is unlikely to occur in this application, but may be possible with metadata.</li> </ul>"},{"location":"ccm-migrator/features/","title":"Features","text":"<p>This is a brief list of the features we have implemented or plan to implement in the future.</p> <p>If you want to know more you're very welcome to open an issue on GitHub or contact your favourite Huddo team member.</p> 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":"<p>Log into the WebSphere Integrated Solutions Console (ISC) for your HCL Connections Environment.</p>"},{"location":"ccm-migrator/install/#gathering-required-information","title":"Gathering required information","text":"<p>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.</p> <p>In the ISC, navigate to Resources \\ JDBC \\ Data sources.</p> <p>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.</p> <p></p> <p>If you're not sure which is the correct data source, check the details of each data source as follows:</p> <ul> <li>Click a data source name in the data source table.</li> <li>Check the \"Common and required data source properties\" for the data source.</li> <li>The correct data source should have the database name \"FNOS\", and a server name matching your Filenet / CCM database server. Once you find this data source, note the JNDI name, and you can then proceed with installation.</li> </ul> <p>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.</p> <p></p>"},{"location":"ccm-migrator/install/#installing-the-application-for-the-first-time","title":"Installing the Application for the first time","text":"<p>In the ISC, navigate to Applications \\ Application Types \\ WebSphere enterprise applications and click \"Install\".</p> <p></p> <p>Locate the \"isw-connections-ccm.ear\" file on your local file system and click \"Next\".</p> <p></p> <p>Select \"Fast Path\" and click \"Next\".</p> <p>Step 1: Leave the default values, update the Application Name if required, and click \"Next\".</p> <p>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.</p> <p>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.</p> <p></p> <p>Step 3: Enter the JNDI name for the Filenet Object Store database, which you should have obtained as described under Gathering required information.</p> <p>Step 4: Leave the default values and click \"Next\".</p> <p>Step 5: Check summary and Complete installation.</p> <p>Save the master configuration once complete.</p>"},{"location":"ccm-migrator/install/#updating-the-web-server-plug-in","title":"Updating the Web Server Plug-in","text":"<p>The procedure in this section may or may not be required depending on the configuration of your Connections environment.</p> <p>In the ISC, navigate to Servers \\ Server types \\ Web servers.</p> <p></p> <p>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.)</p> <p></p> <p>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.)</p> <p></p>"},{"location":"ccm-migrator/install/#configuring-the-application","title":"Configuring the Application","text":""},{"location":"ccm-migrator/install/#licence-key","title":"Licence Key","text":"<p>Without a licence applied, the application can only be used in test mode, where files and folders are reported but not actually migrated.</p> <p>When requesting a licence you will need to supply:</p> <ul> <li>The domain name used to access the application in the browser.</li> <li>For limited (demo) licences: The community UUIDs that will be allowed to migrate their files.</li> </ul> <p>After receiving your key, you will need to create <code>name space bindings</code> 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 <code>iswCCMLicenceKey</code>. Limited licences also require <code>iswCCMLicenceCommunities</code>.</p> Binding identifier + Name in name space... String value <code>iswCCMLicenceKey</code> Licence key stringe.g. <code>A+gAAACsrdTGobh6+PNOTAREALKEYjpVT/6AgMY4SxyOM2ZQ</code> <code>iswCCMLicenceCommunities</code> Comma delimited list of community ids without white spacee.g. <code>4f4847e3-fdda-4da4-a1b7-2829111a694b,4f4847e3-fdda-4da4-a1b7-2829111a694c,4f4847e3-fdda-4da4-a1b7-2829111a694d</code> <p>You may follow the steps below for how to create name space bindings.</p> <p>In the ISC, navigate to Environment \\ Naming \\ Name space bindings.</p> <p></p> <p>Select the \"Cell\" scope, then click \"New\".</p> <p></p> <p>Set the binding type to \"String\", then click \"Next\".</p> <p></p> <p>Set both the \"Binding identifier\" and \"Name in name space\" fields to \"iswCCMLicenceKey\". Enter your licence key in the \"String value\" field.</p> <p></p> <p>Click \"Next\", then click \"Finish\", then save the master configuration. Repeat these steps for <code>iswCCMLicenceCommunities</code>.</p>"},{"location":"ccm-migrator/install/#security","title":"Security","text":"<p>In the ISC, navigate to Applications \\ Application Types \\ WebSphere enterprise applications, and click the \"isw-connections-ccm\" application in the list.</p> <p>Navigate to Configuration \\ Detail Properties \\ Security role to user/group mapping.</p> <p>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.</p> <p>Click \"OK\" and save the changes to the configuration.</p> <p>Start the application by checking the select box for it from the list and clicking \"Start\".</p>"},{"location":"ccm-migrator/supported-data/","title":"Data Supported in Migrations","text":"<p>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.</p> <p>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.</p> 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 <p>\ud83d\uddc3 - Exported to file system</p>"},{"location":"ccm-migrator/update/","title":"Update","text":""},{"location":"ccm-migrator/update/#updating-the-application","title":"Updating the Application","text":"<p>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.</p> <p>Log into the ISC for your HCL Connections environment.</p> <p>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.</p> <p>Navigate to Applications \\ Application Types \\ WebSphere enterprise applications.</p> <p>Select the \"isw-connections-ccm\" application from the list, and click \"Update\".</p> <p></p> <p>Using the default option (\"Replace the entire application\"), select the new \"isw-connections-ccm.ear\" file, and click \"Next\".</p> <p></p> <p>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\".</p> <p>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.</p> <p></p> <p>After clicking \"Finish\", there will be some delay while the next screen fills in. Click the \"Save\" link when it appears.</p> <p></p> <p>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.</p> <p>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.</p>"},{"location":"ccm-migrator/update/#updating-the-licence","title":"Updating the Licence","text":"<p>After receiving your new key, you will need to update the <code>name space bindings</code> 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 <code>iswCCMLicenceKey</code>. Limited licences also require <code>iswCCMLicenceCommunities</code>.</p> Binding identifier + Name in name space... String value <code>iswCCMLicenceKey</code> Licence key stringe.g. <code>A+gAAACsrdTGobh6+PNOTAREALKEYjpVT/6AgMY4SxyOM2ZQ</code> <code>iswCCMLicenceCommunities</code> Comma delimited list of community ids without white spacee.g. <code>4f4847e3-fdda-4da4-a1b7-2829111a694b,4f4847e3-fdda-4da4-a1b7-2829111a694c,4f4847e3-fdda-4da4-a1b7-2829111a694d</code> <p>You may follow the steps below for how to update name space bindings.</p> <p>In the ISC, navigate to Environment \\ Naming \\ Name space bindings.</p> <p></p> <p>Select the <code>iswCCMLicenceKey</code> binding.</p> <p></p> <p>Update the \"String\" with the new value, then click \"OK\".</p> <p></p> <p>Then save the master configuration. Repeat these steps for <code>iswCCMLicenceCommunities</code> if this also needs to be updated.</p>"},{"location":"ccm-migrator/usage/","title":"Using the Application","text":"<p>The application can be accessed from your HCL Connections site using a URL like <code>{connections domain}/isw-connections-ccm/</code>, where <code>{connections domain}</code> is the protocol and domain name of your Connections site.</p>"},{"location":"ccm-migrator/usage/#api-settings","title":"API Settings","text":"<p>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:</p> <ul> <li>\"Migration Path\" has no default and must be set before first use.</li> <li>\"Logs and Temporary File Path\" defaults to a subdirectory of the server's temporary files location (typically \"/tmp\" on Linux), but you may want to change this. As stated in the Installation document, this location should be synchronized between servers if the application runs on multiple servers in a cluster.</li> <li>\"Source Domain\" and \"Destination Domain\" must specify the protocol and domain of the Connections environments you're migrating from and to. These default to the domain where the app is installed, which will probably be correct if migrating within a single Connections environment, but you'll need to change at least one of these if migrating between two different environments. \"Destination Domain\" isn't used and is hidden if migrating to the OS file system.</li> <li>\"Source Auth Alias\" and \"Destination Auth Alias\" must be the names of J2C authentication aliases defined in the WebSphere ISC (under Security \\ Global Security \\ J2C authentication data) for your source and destination Connections domains. The aliases must contain credentials for a user with administrative access to Connections, because the app uses these credentials to authenticate with APIs and read/write content. \"Destination Auth Alias\" isn't used and is hidden if migrating to the OS file system.</li> <li>\"Output File Path\" should be a server file-system location where you want content and metadata exported. If migrating to the OS file system, all content and metadata is exported to this location. If migrating to Connections Files, metadata is exported to this location only if the migration setting to export metadata is enabled.</li> </ul> <p></p> <p>Other API Settings are described below, but should never need to be changed for normal operation:</p> <ul> <li>\"Number of Threads when building list of folders and files\" - Use with caution - Can cause server CPU starvation and crashes. The value 1 means that all server-side operations run in a single thread, while higher values (up to a maximum of 4) cause more threads to be used. Higher values should improve performance if all the following conditions are met, but may otherwise cause problems:<ul> <li>Application servers on which this application runs, along with CCM and database servers from which content will be read, have at least as many CPU threads as specified.</li> <li>Network connections between servers can handle the additional traffic.</li> </ul> </li> <li>\"HTTP Engine Settings\":<ul> <li>\"HTTP Request Handler\" - The default value of \"Apache HttpClient\" should always be best. The \"JVM default\" option is retained for testing because older versions of CCM Migrator had no other option.</li> <li>\"Maximum time to wait for data\" - HTTP read timeout in milliseconds. The default of -1 means to use an OS-dependent value which we understand to be 1 minute on many platforms. The default should be sufficient, but set it to either 0 (no timeout) or a value higher than 60000 if you observe timeouts occurring.</li> <li>\"Number of times to attempt each HTTP request\" - If set higher than 1 and a server-side HTTP request fails for a temporary reason (e.g. timeout or internal server error), the request will be attempted up to this many times. This setting exists because we observed seemingly-random HTTP request failures in one customer environment, but retries didn't help in that case.</li> <li>\"Delay before retrying failed HTTP request\" - Wait about this many milliseconds before retrying failed HTTP requests. Only has an effect if a HTTP request fails and the previous setting is 2 or higher.</li> </ul> </li> <li>\"Log Settings\":<ul> <li>\"Show username in server JVM logs\" - Makes messages written by CCM Migrator to the server's \"SystemOut.log\" and \"SystemErr.log\" files include the username of the user running Analysis, Migration, or Roll-back. The username is always recorded in CCM Migrator's application log files regardless of this setting.</li> </ul> </li> <li>\"Other Settings\":<ul> <li>\"Write XML to file system for CCM library entries\" - If enabled, raw XML representing \"feeds\" of CCM library entries will be written to the configured temporary files location. This setting exists only for debugging.</li> </ul> </li> </ul> <p>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.</p>"},{"location":"ccm-migrator/usage/#analysis-and-migration","title":"Analysis and Migration","text":"<p>On first use before migrating, it's necessary to perform an analysis to build a list of communities. Click \"Analyze Communities\" to do this.</p> <p>By default, analysis retrieves the following information for each community:</p> <ul> <li>Community title;</li> <li>Whether the community has any CCM Libraries;</li> <li>Whether the community has a Files app (which is the migration target unless migrating to file system);</li> <li>The total size of all files in the Files app; and</li> <li>The quota and quota usage of the Files app;</li> </ul> <p>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.</p> <p>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.</p> <p>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.</p> <p>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:</p> <ul> <li>\"Test Mode\" - Enabled by default. Performing migration with this enabled means that nothing is really migrated, but the migration process will retrieve and display a list of all folders and files in the selected communities. Note that a licence key is required to disable test mode and perform a real migration, and the licence key (if provided to you) must be installed as described in the Installation document.</li> <li>\"Per-library migration\" - If enabled, the communities table allows expanding each community to show libraries in the community, choosing individual libraries to migrate (instead of migrating all libraries in each community), and migrating libraries to subcommunities instead of to the community.</li> <li>\"Include Tags\" - Whether or not to migrate file tags.</li> <li>\"Include Comments\" - Whether or not to migrate file comments.</li> <li>\"Include Likes\" - Whether or not to migrate file likes.</li> <li>\"Include Follows\" - Whether or not to migrate file follows.</li> <li>\"Include Drafts\" - Whether or not to migrate draft files. Note that the Connections Files app doesn't allow drafts, so drafts from CCM will become the latest file version when migrated.</li> <li>\"Include Versions\" - Whether or not to migrate file versions. When enabled, you will also see an option to specify how many versions are migrated.</li> <li>\"Rename Conflicting Files\" - If enabled, and the Files app in a community already has files matching the name of files being migrated, the migrated files will be renamed by appending the specified \"Filename-Number Separator\" followed by a number. If disabled, files with a conflicting name won't be migrated. If a migrated folder matches the name of an existing folder in the File app, this option doesn't apply. The migration simply uses the existing folder.</li> <li>\"Replacement for Invalid Characters\" - If CCM folder or file names contain characters which aren't permitted in the Connections Files app, those characters are replaced by the specified replacement character.</li> <li>\"Migrate libraries to folders\" - Whether to migrate every library to a separate folder in the target community, regardless of how many libraries exist in the community. By default, CCM Migrator will only create a separate folder for each library if the community has two or more libraries.</li> <li>\"Export metadata to file-system\" - Whether to export extra metadata to the server file-system when migrating to Connections Files. The metadata includes CCM document types and custom fields, which can't be migrated to Connections Files, and is created in the \"Output File Path\" specified in API Settings. Click here for details of the export file structure.</li> </ul> <p>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.</p> <p>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.</p>"},{"location":"ccm-migrator/usage/#regarding-file-name-conflicts","title":"Regarding file name conflicts","text":"<p>When migrating files, the application makes some attempt to work around file name conflicts. This is particularly worth noting when either:</p> <ul> <li>One CCM library has files of the same name in different folders; or</li> <li>One community has two or more CCM libraries with files of the same name.</li> </ul> <p>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.</p> <p>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\".</p> <p>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.</p> <p>The application's user-interface provides options to change the above behaviour, and those options are listed earlier in this document.</p>"},{"location":"ccm-migrator/usage/#roll-back","title":"Roll-back","text":"<p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p>"},{"location":"tools/ansible/","title":"Ansible","text":""},{"location":"tools/ansible/#setup-ansible","title":"Setup Ansible","text":"<p>Throughout the guides on this site we use ansible to setup servers and manage servers and deployments in both kubernetes and docker swarm.</p> <p>If you have access to a Mac or Linux machine, follow these instructions to get up and running.</p> <p>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.</p> <p>Refer to this document from Microsoft for more information on WSL and the windows store options.</p>"}]}
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
index 87e7b219c..adfe58e34 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -2,937 +2,937 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://docs.huddo.com/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/log4j/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/status/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/add-widgets/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/app/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/apply-changes/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/comm-properties/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/customising/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/install-widgets/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/licence/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/install/websphere-faq/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/user-guide/access-reports/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/user-guide/available-reports/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/user-guide/itemtype-map/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/user-guide/terms/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/user-guide/introduction/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/analytics/user-guide/using-reports/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/update-images/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/websphere-faq/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/customising/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/embedded-exp/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/mobile/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/add-widgets/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/app/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/apply-changes/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/awards/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/comm-properties/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/engine/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/install-widgets/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/leaderboard/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/licence/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/install/load-defaults/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/update/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/update/refresh_cache/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/update/update_app/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/badges/update/updatev6tov7/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/compatibility/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/helm-charts-kudos/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/helm-charts/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/hybrid/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/images/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/releases-archive/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/releases/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/security/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/tours/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/content-member-management/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/deactivate-login/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/link-users/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/manage-licences/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/org-config/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/replace-group-membership/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/revoke-users/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/sync-profiles/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/transfer-ownership-unlink/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/transition-between-providers/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/admin/url-update/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/aio/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/aio/paths/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/aio/subdomain/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/api/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/api/powerautomate/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/api/zapier/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/apps/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/auth0/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/auth0/migrating/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cloud/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cloud/updates/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/apps-menu-hybrid/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/apps-menu-on-prem/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/auth-hybrid/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/auth-on-prem/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/header-hybrid/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/header-on-prem/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/keycloak/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/migration/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/mobile-app-hybrid/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/mobile-app-on-prem/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/security/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/widgets-hybrid/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/widgets-on-prem/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/customizer/customizer-integrations-package/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/httpd/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/httpd/edit/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/connections/httpd/sso-header/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cp/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cp/dockerhub/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cp/latest/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cp/minio/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cp/releases/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cp/migration/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cp/migration/interface/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/cp/roles/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/domino/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/domino/callback/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/domino/cloud/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/domino/proton/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/domino/migration/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/domino/oauth/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/domino/schema/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/domino/scope/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/dx/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/dx/auth/proxy/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/dx/auth/sso/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/dx/auth/websphere/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/dx/portlet/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/env/common/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/env/notifications/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/faq/kubectl/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/faq/languages/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/faq/notifications/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/faq/open-source-licences/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/knowledgebase/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/mobile-app/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/use-auth0/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/use-verse/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/adding-members/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/archiving-and-restoring/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/assignment-roles/assignment-roles/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/attaching-files/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/connections/connections-ui/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/dependencies/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/getting-started/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/homepage/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/ical/board/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/ical/personal/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/import-activity/import/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/microsoft/onedrive/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/microsoft/outlook/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/microsoft/sharepoint/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/mindmap/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/permissions/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/quick-tips/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/start-a-trial/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/teams/adding-boards/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/templates/creating/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/templates/global/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/howto/timeline/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/integrations/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/integrations/developing/related-tasks/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/kubernetes/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/kubernetes/deploy-mongo/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/kubernetes/minio/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/kubernetes/prerequisites/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/minio/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/auth/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/custom-tiles/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/getting-started/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/outlook/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/outlook/personal/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/sharepoint/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/sharepoint/admin/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/teams/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/teams/notification-bot/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/teams/on-prem/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/msgraph/teams/install/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/proxy/nginx/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/store/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/swarm/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/swarm/prerequisites/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/activities-plus-install/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/activity-migration/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/aplus-auth/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/conn-hybrid/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/docker/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/mongo/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/nginx/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/notifications/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/oauth/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/safari/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/ssl/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/websphere/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/troubleshooting/office365/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/boards/verse/verse-extension/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/ccm-migrator/export-fs/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/ccm-migrator/features/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/ccm-migrator/install/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/ccm-migrator/supported-data/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/ccm-migrator/update/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/ccm-migrator/usage/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.huddo.com/tools/ansible/</loc>
-         <lastmod>2024-06-18</lastmod>
+         <lastmod>2024-06-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index 7e50482aa03960963076b937b445d5e5fa5e7d74..e1fc8e909e9425c05f1fb659b835fd92413b7495 100644
GIT binary patch
delta 79
zcmV-V0I>hn4Al$=ABzYGfFE*^2Ot49ktjtizu$g-eDhGEOO$WqWS>6WPC17^y6$*9
l-X)u9)*;<-9J@43@*#EG!S4R<<FT5v1qcJ&4?IA8001$XBNzYx

delta 79
zcmV-V0I>hn4Al$=ABzYG0M2lc2Ot5aktjtiA8$WDzIiCoCCWE)vQM9Gr<}tdU3WYl
l?~=_l>yYj^j$Ili`H;HpV0VA_`>~p{1qi@71EoNG008A|A+G=c