Visual Update 1 for IBM Connections

Preview available in the App Catalog!

About the App

The Connections Design Team is crafting new design specifications for Connections. You can preview the new visual styles by installing the application, from the IBM Connections Cloud App Catalog, which leverages the Connections Customizer technology. There is not an App Catalog for IBM Connections on premises at this time.

Prerequisites

Customizer is available on IBM Connections Cloud for tenants of the North America and Europe data centers. Before using Customizer your organization must first register for the service by sending an email with some simple information. Refer to section 3 of the IBM Connections Customizer documentation for more details.

What's included in the Preview

Because this is a Preview, it is recommended that you enable the application for a sub-set of users.

This release is a preview and has limitations, which include:

Updates

We periodically release updates to fix defects and add styling to more applications and pages.

Review what's new and update history

Install and Configure the App

Find Visual Update 1 for IBM Connections in the App Catalog. Get the app and configure it.

Important notes before installing

Enable for no users or a sub-set of users

You can install the application and enable it for no users or a sub-set of users. This way you control who will see the new visual updates.

To enable for no users or a sub-set of users, customize the extension that was installed when you enabled the app.

  1. After installing the application, in Administration, go to Organization Extensions.
  2. At the top of the page, follow the new Apps Manager link.
  3. Click on the name of the app to edit the extension.
  4. Edit the json to add "match", "user-email", and values to the payload section, as follows.
  5. Enable for no users by adding a fake email address inside "user-email":

        "payload": {
          "match": {
            "user-email": [
              "userid1@example.com"
            ]
          },
          "include-files":[
            "periscope.js"
          ],
          "include-repo": {
            "name":"periscope"
          }
        },
        

    Enable for a sub-set of users by adding email addresses inside "user-email":

      "payload": {
        "match": {
          "user-email": [
            "userid1@example.com",
            "userid2@example.com"
          ]
        },
        "include-files":[
          "periscope.js"
        ],
        "include-repo": {
          "name":"periscope"
        }
      },
      

Disable the application

Use caution before disabling a customized application. If you disable the application, your customizations will be lost. Save the customized json to another location before disabling the application.

To disable the application:

  1. After installing the application, in Administration, go to Apps.
  2. Go to My Apps and locate Visual Update 1 for IBM Connections.
  3. In the overflow menu select Disable.
  4. Confirm that you want to disable the application because this will remove the Organization Extension and any customizations you made.

Enable for entire organization

If you have previously enabled for a sub-set of users, edit the json again and remove the "match" and "user-email" matches in the payload section.

  1. Go to Organization Extensions.
  2. At the top of the page, follow the new Apps Manager link.
  3. Click on the name of the app to edit the extension.
  4. Edit the json to remove "match", "user-email", and specific email addresses in the payload section, as follows.
  5.   "payload": {
        "include-files":[
          "periscope.js"
        ],
        "include-repo": {
          "name":"periscope"
        }
      },
      

Support

FAQ

Why don't I see Visual Update 1 changes?

Question: Why don't I see any visual updates after I enable Visual Update 1?

Answer: Check the following things:

Which customizations appear if both an org extension and Visual Update 1 are enabled?

Question: Which customizations appear or win if an Organization extension with company updates and the Visual Update 1 for IBM Connections application are enabled? Put another way, what is the sequence or order of changes when enabling Apps and extensions.

Answer: Which customizations appear or win is based on the order in which extensions get injected into the page by Connections Customizer. Customizer makes a request to the App Registry and it returns a list of extensions by name, in alphabetical order. The changes are applied in alphabetical order, overriding changes made earlier in the alphabet.

The App Registry includes the Visual Update 1 for IBM Connections application. A company adds an extension to the App Registry, to override styles, and it is called "Xtended Company Theme". The Visual Update 1 for IBM Connections application is loaded and applied first. Next the "Xtended Company Theme" gets loaded with its CSS and/or JS overriding any of the Visual Update 1 for IBM Connections changes.

What is supported

The Visual Update 1 for IBM Connections is supported only for implementations where the application is installed and configured directly from the IBM Connections App Catalog and in which all of the following criteria are met: (1) Only the Verse Theme (Default) is enabled (2) No additional customizations are configured. Implementations added manually through an organization extension, combined with additional customizations, and/or contained code which was modified from its original state will not receive support considerations.

Due to the preview nature of the application, PMRs will not be accepted and resolved by IBM. Questions and support requests, however, can be posted directly on the support forum located here. IBM will not assist with making modifications to the open source code provided for this application nor modifications created to add additional customizations in lieu of the Visual Update 1 for IBM Connections.

While the application is in preview, bi-directional language support will not be included. Visual updates will apply only to applications stated in official communications and will not extend to custom widgets added to Connections. IBM plans to regularly add new Connections applications to the visual update and will share communications accordingly.

Getting support

Ask questions and view answers tagged with 'cnx-custom-theme' on dW Answers.

Copyright 2017, 2018, IBM Corporation