6.3 Customizing the Profiles business card 

Previous

The customization of IBM Connections Profiles business card helps in meeting organization requirements. You can alter Profiles business card using the following methods:

• Adding or removing the links that display at the top of the card.
• Customizing the contact and location information that displays in the main section of the card.
• Adding or removing the action links that display at the bottom of the card.

Adding and removing third-party links through the XML configuration file

You can add or remove a third-party application link the Profiles business card by changing the \profiles\\config\cells\\LotusConnections-config \LotusConnections-config.xml file.

Procedure
Follow these steps to add link to the Profiles business card:

1. Check out the Lotus Connections configuration file:
   The general process of checking out and checking in the configuration files is described in Publishing customizations with the wsadmin tool. Adapt the following example commands for your system:
   

   cd e:\IBM\WebSphere\AppServer\profiles\Dmgr01\bin
   

   wsadmin -lang jython -user wasmgr -password d3moL0tus
   

   execfile("connectionsConfig.py")
   

   LCConfigService.checkOutConfig("f:/temp", AdminControl.getCell() )

   
   Remember to leave the wsadmin session open to check in the file in a later step.
   
2. Open LotusConnections-config.xml in a text editor from the temp directory and modify it to add the following attribute:
• person_card_service_url_pattern:
  This parameter takes string value and is usually URL pattern which is used when users click service link added to business card.
  If ampersand character (&) used in this parameter then it should be escaped.
  The following placeholders can be used in this parameter which will be replaced by actual value at run time.
• {email}: The profile user's email address
• {userid}: The profile user's user ID
• {uid}: The profile user's UID
• {displayName}: The profile user's full name
• {workPhoneNumber}: The profile user's work telephone number
• person_card_service_name_js_eval:
  This parameter takes string value and is used to generate text displayed in the business card for given service. You can add resource string as the value of this attribute. The resource string must include "generalrs." before the resource bundle key.
  Refer to Adding custom strings for widgets and other specified scenarios for more information about how to add resource strings to the business card.
  
  
  
3. Open the service-location.xsd file from the tmp directory and locate element <xsd:simpleType name="serviceNames">. Add the service name specified in LotusConnections-config.xml as shown below.
   
   
   
4. Check in the IBM Connections configuration file.
   In the same wsadmin session check in the Profiles configuration file using the following command:
   

   LCConfigService.checkOutConfig()

   
   
5. Restart the Profiles application.
   This is necessary for Profiles to pick up the new configuration.
   The Profiles application can be stopped and started from the WebSphere Application Server Integrated Solution Console.
   
6. Test your changes by opening the Profiles business card.
   This figure shows the Google Me and Quickr link have been added to the business card.
   

To remove the third-party links from the Profiles business card, follow the steps of adding the third-party links to check the configuration file out and then delete the lines that reference to the third-party link. The check the configuration file in and restart the Profiles application.

Adding third-party links using JavaScript

Third party link can also be added to the Profiles business card using JavaScript at application level. For example, if you are integrating the Profiles business card in your web application, you can add additional JavaScript to your web application to add the third party links. This does not require any configuration changes at the IBM Connections server level, such as changing the configuration file.

Procedure

1. Follow the steps given in section Integrating the Profiles business card to include the Profiles business card in your web application.
2. Include the SemTagPerson.services.push method in your JavaScript code with following parameters:
• Name : This parameter takes a string and should be unique. This is the identifier for third party link in business card, hence it should be unique.
• url_pattern: This parameter takes string value and is usually URL pattern which is used when users click service link added to business card.
  The following placeholders can be used in this parameter that will be replaced by the actual value at run time.
• {email}: The profile user's email address
• {userid}: The profile user's user ID
• {uid}: The profile user's UID
• {displayName}: The profile user's full name
• {workPhoneNumber}: The profile user's work telephone number
• js_eval: This parameter takes string value and is used to generate text displayed in the business card for a given service. You can add resource string as the value of this attribute, the resource string must include "generalrs." before the resource bundle key.
  For more information about how to add resouce strings to the business card, see Adding custom strings for widgets and other specified scenarios 
• location: This parameter takes a string value. The location parameter and the url_pattern parameter are combined when the link is displayed and when the user clicks the third party link.
• label: You can use the label parameter instead of js_eval to give a name to the third party service which will be displayed in the business card.

The following sample code adds Business card to a HTML web page and adds Google and Quickr entry links into the business card.

This picture shows the result.

Integrating Profiles with Lotus Quickr

The integration of Profiles with Lotus Quickr using business card happens by providing Quickr link in business card so that users can quickly navigates public and shared files of user in Quickr. This is accomplished by modifying the LotusConnections-config.xml configuration file to include Quickr link.

Before you begin

• The Quickr version should be supported by IBM Connections. See the detail system requirement for IBM Connections at System Requirement for IBM Connections
• The link for Lotus Quickr for Lotus Domino works with entry places only. This link does not work for regular places.
• If you have enabled SSL in IBM Connections by setting forceconfidentialcommunication to ture in the LotusConnections-config.xml file, you should also enable SSL in Lotus Quickr.

Procedure
Complete following steps to enable Lotus Quickr link in the Profiles business card.

1. Check out the IBM Connections configuration file.
   The general process of checking out and checking in the configuration files is described in Publishing customizations with the wsadmin tool . Adapt the following example commands for your system:
   

   cd e:\IBM\WebSphere\AppServer\profiles\Dmgr01\bin
   

   wsadmin -lang jython -user wasmgr -password d3moL0tus
   

   execfile("connectionsConfig.py")
   

   LCConfigService.checkOutConfig("f:/temp", AdminControl.getCell() )

   
   Remember to leave the wsadmin session open to check in the file in a later step.
2. Open LotusConnections-config.xml using a text editor from the temp directory and add Quickr service in file as given follow. Replace the server value as per your environment.
• For Quickr Service for Domino:
  

  sloc:serviceReference serviceName="quickr"
  

  href="http://<www.myquickrserver.mycompany.com>/servlet"
  

  enabled="true"
  

  ssl_href="https://<www.myquickrserver.mycompany.com>/servlet"
  

  ssl_enabled="true"
  

  person_card_service_url_pattern="/QuickrEntry?email={email}"
  

  person_card_service_name_js_eval="generalrs.label_personcard_quickrlink"/>
  

• For Quickr service for WebSphere Portal
  

  <sloc:serviceReference serviceName="quickr"
  

  href="http://<www.myquickrserver.mycompany.com>/places"
  

  enabled="true"
  

  ssl_href="https://<www.myquickrserver.mycompany.com>/places"
  

  ssl_enabled="true"
  

  person_card_service_url_pattern="/search?#owner={userid}|{displayName}"
  

  person_card_service_name_js_eval="generalrs.label_personcard_quickrlink"/>
  

3. Check in the Lotus Connections configuration file.
   In the same wsadmin session, check in the Profiles configuration file using the following command:
   

   LCConfigService.checkOutConfig()

   
   
4. Restart the Profiles application.
   This is necessary for Profiles to pick up the new configuration.
   The Profiles application can be stopped and started from the WebSphere Application Server Integrated Solution Console.

Customizing business card information

You can alter the main section of the Profiles business card that contains information about a user to add new information such as the extended attribute or to remove the existing information. It is also possible to change the order of the information shown on the out-of-box business card.

Procedure
Complete the following steps to customize business card information.

1. Check out the Lotus Connections configuration file.
   The general process of checking out and checking in the configuration files is described in Publishing customizations with the wsadmin tool . Adapt the following example commands for your system
   

   cd e:\IBM\WebSphere\AppServer\profiles\Dmgr01\bin
   

   wsadmin -lang jython -user wasmgr -password d3moL0tus
   

   execfile("profilesAdmin.py")
   

   ProfilesConfigService.checkOutConfig("f:/temp", AdminControl.getCell() ) 

   
   Remember to leave the wsadmin session open to check in the file in a later step.
2. Open the profiles-config.xml file in a text editor from the tmp directory.
3. Locate the element in the profiles-config.xml file. Add the information which you want to add to business card with one of the following element value under the element. The following elements can be used together to add more then one value for information:
   • attribute: This is a predefined attribute in IBM Connections profile which will be displayed in Business card.
   • extensionAttribute: This is a custom defined attribute in IBM connections profile that you want to display in Business card.
   • html : If you want to display an HTML block, you can choose this attribute.
   
   The above elements can have following attributes:
   • labelKey: This attribute specifies which label should be displayed with information.
   • showlabel : This attribute specifies if the label for information will be displayed or not.
   • hideIfEmpty: If information attribute that you intend to display on business card does not have any value then it will not be displayed if this attribute is set to true.
   • bundleIdRef : This attribute enables the external bundle to pick label.
   For more about resource bundle, see Adding custom strings for widgets and other specified scenarios
   • prependHtml :This attributes takes html code as value and shows this html code before information to be displayed on business card.
   
   For example, see the following snippet:
   

   <businessCardLayout profileType="default">
   

      <attributes>
   

    ...
   

    <html prependHtml="<div class='adr'&gt;"/>
   

    <attribute showLabel="false" hideIfEmpty="true" ...>workLocation.city</attribute>
   

    <extensionAttribute extensionIdRef="region" showLabel="true" labelKey="label.region" bundleIdRef="mylabels" hideIfEmpty="true" prependHtml="..."/> 		 		 ...
   

    </attributes>
   

    ...
   

   </businessCardLayout>
   

   
   
4. Check in the Profiles configuration file.
   In the same wsadmin session check in the profiles configuration file using the following command:
   

   ProfilesConfigService.checkOutConfig()

   
   
5. Restart the Profiles application.
   This is necessary for Profiles to pick up the new configuration.
   The Profiles application can be stopped and started from the WebSphere Application Server Integrated Solution Console.

Customizing action links on the business card

The Profiles business card allows you to modify action links that are given at the bottom of the Profiles business card. You can add other actions such as "callMe" that calls a person's work phone number using Skype, or you can add "add me" link which allows users to send invite for adding the profile owner to their network.

Procedure
Complete the following steps to add action link to business card.

1. Check out the IBM Connections configuration file.
   The general process of checking out and checking in the configuration files is described in Publishing customizations with the wsadmin tool . Adapt the following example commands for your system
   

   cd e:\IBM\WebSphere\AppServer\profiles\Dmgr01\bin
   

   wsadmin -lang jython -user wasmgr -password d3moL0tus
   

   execfile("profilesAdmin.py")
   

   ProfilesConfigService.checkOutConfig("f:/temp", AdminControl.getCell() ) 

   
   Remember to leave the wsadmin session open to check in the file in a later step.
2. Open the profiles-config.xml file in a text editor from the temp directory and locate the <businessCardLayout> element.
3. You can add your actions under the <action> element. For example, we add the "callMe" option which enables users to call person from his business card.
   
   
   The following figure shows the business card with the "callMe" option.
   
   
   Note: In the example above, the <action> element takes the following parameters:
• urlPattern : This parameter takes string inform of a JavaScript function that can be invoked when a person clicks on action link. The following place holders can be used in this parameter that will be replaced by actual value at run time:
• {email}. The profile user's email address
• {userid}. The profile user's user ID
• {uid}. The profile user's UID
• {displayName}. The profile user's full name
• {workPhoneNumber}. The profile user's work telephone number
  
• liClass : This is predefined CSS class name that is added in final source code to separate other actions with <li/> tag.
  
  
• emailEnabledRequired: This attribute takes boolean true and false values. This specifies if an e-mail address is required for action or not.
  The <action> element can have the following sub-elements:
• Icon : The icon element is used to specify any icon image with action.
• label: The label element is used to specify display text for action. You should add a resource string as the value of this attribute. You can find how to add resource string in following link:
  Adding custom strings for widgets and other specified scenarios
• alt: This element acts same as the HTML <alt> tag, which display value when icon is not present.
4. Check in the Profiles configuration file.
   In the same wsadmin session, check in the Profiles configuration file using the following command:
   

   ProfilesConfigService.checkOutConfig()

5. Restart the Profiles application.
   This is necessary for Profiles to pick up the new configuration.
   The Profiles application can be stopped and started from the WebSphere Application Server Integrated Solution Console.

Parent topic: 6.0 Customizing the Profiles and Communities Business card