IBM Connections 5.0: Profiles Customization

  • View

  • Download

Embed Size (px)


1. IBM Connections 5.0 Author: Paul Godby Business Development & ISVs Last Updated: June 19, 2015 Duration: 60 minutes IBM Connections Lab Manual Profiles Customization COPYRIGHT IBM CORPORATION 2015. ALL RIGHTS RESERVED. 1 2. IBM Connections 5.0 Introduction: In IBM Connections, you have the ability to customize the Profiles application. This allows you to define the core data model for people within your deployment and tailor the presentation of Profiles content to meet your organization's requirements. You can populate the Profiles database with data from external systems and configure Profiles to display this data. You also have the ability to create Profile Types. So, for example, you could create a different layout for different types of employees in the organization. Generally speaking, you will first want to populate the Profiles database with your custom user data. You do this by modifying existing TDI scripts to import extra data from your current directories or by creating new scripts to import data from other systems. This data will get added to a special extensions table in the Profiles database and will link to each user via his/her internal IBM Connections ID. After you import custom data, you must then customize the Profiles data model. This is an easy process that involves referencing the new data in your Profiles database in the Profiles XML configuration file. After you've defined your new data in Profiles, you can then go about the process of updating the user interface by making changes to the supplied template files. You can choose to modify the set of standard and extension attributes that are rendered in the user interface for a profile record. You can also modify the structure of the layout of content using the flexibility provided by the FreeMarker Template Language. After you create your new user interface in the, you might also need to update the Profiles widget configuration file to display the content from the template file. For example, if you want this data to appear in a new tab, you will need to define that new tab in the widget XML configuration file. Description: IBM Connections Profiles has always supported customization of a Profile's layout in the web application using a widget-based model. In recent releases, the Profiles user interface supports an additional level of customization via a set of presentation templates that can be modified by the administrator to meet a diverse set of customization requirements. By leveraging a template language, administrators are able to support a more dynamic level of customization than what was offered in the past via static XML configuration. Templates support dynamic reloading so customizations are easier to develop and, as a result, the deployment of a customized Profiles component is faster to realize. Objective: This lab will explain the following tasks: How to populate the Profiles database with custom extension data using TDI How to use a strings properties file to provide user interface labels for your new data How to add the new extension data to the Profiles application How to display the new extension data in the Profiles application COPYRIGHT IBM CORPORATION 2015. ALL RIGHTS RESERVED. 2 3. IBM Connections 5.0 Procedure: BEFORE YOU BEGIN Step 1 Workshop: This lab exercise was originally created as part of the following workshop. At the end of this document you will find instructions and links for accessing the materials. IBM Connections 5.0 Customization Workshop Step 2 Prerequisites: You must complete the following labs before proceeding with this exercise: There are no prerequisite labs. Step 3 Solutions Files: This lab may require additional files. If you are asked to write code or configure an XML file, there may be snippets available for you to review or copy/paste text to/from your lab environment. These files are located at: /labs/solutions/ess.ui.profiles Step 4 Important! Review the workshop setup document for instructions on configuring the SoftLayer device for this lab. You should also review the information about user accounts and permissions. The lab instructions will assume you are using the proper user account(s)! COPYRIGHT IBM CORPORATION 2015. ALL RIGHTS RESERVED. 3 4. IBM Connections 5.0 REVIEW THE DEFAULT USER INTERFACE IN PROFILES Before you start making changes to the Profiles application, you should review the default interface. This will allow you to better visualize and plan your upcoming changes. Step 5 In a web browser, navigate to URL: https:///profiles/html/ Step 6 Log in with the following credentials Field Value User name dmisawa Password passw0rd Step 7 By default, you should see a Recent Updates, Contact Information, and Background tab. Step 8 Click the Contact Information tab. Step 9 In this environment, there are not many attributes populated, configured, and shown. In this lab, you will add a new entry to the Contact Information tab. You will also add an additional tab to show information about the user's identify in other social networks. COPYRIGHT IBM CORPORATION 2015. ALL RIGHTS RESERVED. 4 5. IBM Connections 5.0 Step 10 Locate the current user's name and hover over it with your cursor: Step 11 When you hover over the name, the business card should appear: Step 12 As you can see, the default business card contains a limited set of information. In this lab, you will learn how to add additional metadata to the card. Step 13 Leave the browser open and proceed to the next section. COPYRIGHT IBM CORPORATION 2015. ALL RIGHTS RESERVED. 5 6. IBM Connections 5.0 POPULATE THE PROFILES DATABASE WITH EXTENSION DATA Before you customize Profiles, you first need to identify the source of the new data. This new data can come from any source or could be some additional fields in your LDAP directory. Regardless of the source, you will need to populate the Profiles database with this new data using Tivoli Directory Integrator. To map custom extension attributes to fields in your source LDAP directory, configure settings in the tdi-profiles-config.xml file for each custom extension attribute. Step 14 You will need to update the TDI Profiles configuration file to add your new extensions to the data model. Using your favorite text editor, open file tdi-profiles-config.xml from location /opt/IBM/TDI/V7.1.1/TDISOL/TDI/conf/LotusConnections-config Step 15 In the profileExtensionAttributes section, add the following extension. In later steps, you will add this extension to the Contact Information tab in the Profiles user interface. A description of the XML elements can be found in the table: Attribute Value extensionId Internal ID for identifying this extension in other configuration areas length The number of bytes to allocate in the Profiles database sourceKey The LDAP attribute that maps to this extension Step 16 In the profileExtensionAttributes section, add the following extensions. In later steps, you will add these extensions to a new tab in the Profiles user interface: Note: In this lab environment, there currently are NO attributes in LDAP for external social services. To simulate the process, you will instead just be inserting seemingly random LDAP attributes into these fields. Thank you for your understanding :) COPYRIGHT IBM CORPORATION 2015. ALL RIGHTS RESERVED. 6 7. IBM Connections 5.0 Step 17 When finished, your XML file should contain the following lines inside the profileextensionattributes tags. Step 18 Save and close the file. Close the text editor. Step 19 Next, you must also update the TDI profiles types configuration in order for all of the data to properly propagate to the Profiles database. From the same location as before, open file profiles-types.xml Step 20 As you can see, this XML is just a big list of properties indicating which Profiles data is available to the current profile type, whether it is editable, and whether or not it is hidden. Scroll down to the bottom and add the following additional properties. locationreadfalsegooglereadfalsefacebookreadfalsetwitterreadfalse Step 21 Save and close the file. Close the text editor. Step 22 Open a terminal window. Run the following commands to synchronize LDAP data into the Profiles database. The synchronization process will recognize your new extensions and populate this new data into Profiles. cd /opt/IBM/TDI/V7.1.1/TDISOL/TDI ./ COPYRIGHT IBM CORPORATION 2015. ALL RIGHTS RESERVED. 7 8. IBM Connections 5.0 Step 23 After the script completes, you should receive a message that records were modified. CREATE A STRINGS RESOURCE BUNDLE As of right now, everything is mapped to internal keys. You will want to provide some user friendly labels in the Connections interface for these new extensions. You can do this by creating a new strings properties file. Step 24 Create a new properties file named in location /opt/IBM/Connections/data/shared/customization/strings Step 25 In this new file, enter the following lines. As you can see, you will be providing a label for each of your new extensions. While you're at it, you will also enter a key-value pair that will be used to provide text for a new tab in the Profiles interface. essSocialServices=Social Services label.location=Location: label.facebook=Facebook: label.twitter=Twitter: Step 26 Save the file but do not close it (yet!). You just created the default properties file. In a production environment, you will need to create additional properties files for each supported language. You can do this by creating a new strings file (in the same directory) with the language code appended to the name. In this example, you can create a new strings properties file for the English language by creating a new file named: Step 27 Save and close the file(s). Close the text editor. COPYRIGHT IBM CORPORATION 2015. ALL RIGHTS RESERVED. 8 9. IBM Connections 5.0 REG