Creating a Connections Customizer app

Create a Customizer app by writing it in JSON and then importing the code into HCL Connections™.

Procedure

Follow these steps to create an app and extensions for Connections Customizer.

Create an app.

The app itself is a container that includes one or more extensions. Use a text editor and create a file that you can save with the .json extension, and provide information that describes the application. The application fields provide information such as a unique ID for the app, and the list of services where it applies (in this case, the only allowed service is called Customizer).

When you write the app, you must include at least the fields that are listed in the table following the example:

{
  "services": [
    "Customizer"
  ],
  "name": "Simple Customizer Sample",
  "title": "My First Customizer App",
  "description": "Perform a modification to the Connections Homepage",
  "extensions": [
    {
      "name": "Hello World Extension",
      "type": "com.ibm.customizer.ui",
      "path": "homepage",
      "payload": {
        "include-files": [
          "helloWorld/helloWorld.user.js"
        ]
      }
    }
  ]
}

Table 1. Application information for a Connections Customizer app
Include this field	To describe this aspect	Example
Service	The Connections component where this app will be used. For Customizer apps, you must specify "Customizer" as the component.	`"services": [ "Customizer" ],`
Name	A name for the application; the name can contain up to 100 characters. The name displays in the list of applications on the administration page, but users do not see it.	`"name": "Simple Customizer Sample",`
Title	A text label that refers to this application. The title displays in the list of applications on the administration page, but users do not see it.	`"title": "My First Customizer App",`
Description	A brief summary of the application's purpose. The description displays in the list of applications on the administration page, but users do not see it.	`"description": "Perform a modification to the Connections Homepage",`
Extensions	The extensions must be included between the square brackets [ ] in the extensions field. This example contains one extension.	`"extensions": [ { "name": "Hello World Extension", "type": "com.ibm.customizer.ui", "path": "homepage", "payload": { "include-files": [ "helloWorld/helloWorld.user.js" ] } } ]`

Create an extension within the application.

For Connections Customizer, each extension targets a specific component and uses its included resource files to modify the HTML page being returned by Connections. This sample extension (from the app above) displays the text "Hello World" on the user's Homepage.

"extensions": [
  {
    "name": "Hello World Extension",
    "type": "com.ibm.customizer.ui",
    "path": "homepage",
    "payload": {
      "include-files": [
        "helloWorld/helloWorld.user.js"
      ]
    }
  }
]

Table 2. Extension information for a Connections Customizer app
Include this field	To describe this aspect	Example
Name	A name for the extension; the name can contain up to 100 characters.	`"name": "Hello World Extension",`
Extension type	The action being performed; for Customizer, the only allowed type is com.ibm.customizer.ui.	`"type": "com.ibm.customizer.ui",`
Path	The Connections component whose UI is being modified through this Customizer app. You can create Customizer apps for the following standard Connections components: activities blogs communities files forums global homepage mycontacts news profiles search viewer wikis Note: The global path allows you to apply the Customizer app across all of the Connections components. Unlike the other path values, global does not represent a real URL path element. It is a keyword meaning "match all URLs."	`"path": "homepage",`
Match (target users)	A description of the users who will receive the modification to their UI. If you omit the match property, the modification affects all users. You can specify the match using any of the following formats: match: url match: user-name match: user-id match: user-email match:profile-type Note: When testing your app, you can provide a list of specific users who will see the customization and verify it. When you are ready to deploy the app to your organization, update or remove the match property. For information on the match property, see Using "match: url" to refine the "path" property.	`"match": { "user-name":[ "Samantha Darryn", "Sam Curman" ] }`
Payload	The information that you are providing to Connections so that it can perform your modification. For Connections Customizer, the payload consists of a list of resource files (include-files), which contain code (JavaScript™, CSS, and so on) that will be injected into the HTML page that is returned to the user. In this example, there is a single JavaScript™ file, stored in the pv-connections/customizations persistent volume on the Storage node, that injects the text "Hello World" directly onto the Homepage that is displayed to the user.	`"payload": { "include-files": ["helloWorld/helloWorld.user.js"] }`
Payload (for iFrame)	Note: The type parameter must be set to "type": "com.ibm.customizer.ui.container" to inject iFrames Supported iFrame parameters url: the url to be injected sandbox: takes the standard sandbox parameters width: specify the width of the iframe in % or px height: specify the height of the iframe in % or px locator: anchor point for the iframe takes class selectors. Defaults to '.lotusMain .lotusContent'	`"type": "com.ibm.customizer.ui.container", "payload": { "url": "https://some-url", "sandbox": "allow-scripts allow-same-origin" }`

Save the app and its extensions as a .json file.
Test your app.
Register the app with Connections.