IBM Connections 4: Develop and Use

IBM Connections 4 Part 5: Developing and Using

IBM® Connections 4 Part 5: Developing and Using

Developing

Find out how to use the Atom APIs provided with IBM Connections and how to add select IBM Connections applications to third-party products.

What's new in developing?

Lists the programmatic applications that are new, changed, or deprecated in version 4.


IBM Connections 4: New APIs

Common API

The applications are more consistently using a common set of parameters.

Activities

There are no new APIs being introduced for this application in this release.

Blogs

There are no new APIs being introduced for this application in this release.

Bookmarks

There are no new APIs being introduced for this application in this release.

Communities

There are no new APIs being introduced for this application in this release.

Files

There are no new APIs being introduced for this application in this release.

Forums

News repository

  • There are no new APIs being introduced for this application in this release.

Profiles

There are new APIs being introduced for this application in this release.

Search

There are no new APIs being introduced for this application in this release.

Wikis

The documentation has been updated to cover how to retrieve the following feeds:


IBM Connections 4: New SPIs


IBM Connections 4: Deprecated APIs

Profiles

The message board APIs have been deprecated and are being replaced by the News repository feeds, see Get News repository feeds for details.

The following APIs were specific to the message board and have been deprecated:

Search

The following APIs are being deprecated in this release.

Integrate web applications into IBM Connections

IBM Connections provides the ability for third-party application developers to integrate iWidgets into the IBM Connections user interface for use in the Communities, Home page, and Profiles applications.

In IBM Connections, many areas of the user interface are constructed using iWidgets. Developers and administrators can extend the IBM Connections user interface with new capabilities and also replace existing capabilities that are shipped with the product by developing their own iWidgets using the iWidget specification and integrating them with IBM Connections.

For more information about developing iWidgets for use in IBM Connections, go to: http://www-10.lotus.com/ldd/lcwiki.nsf/dx/development-guide

Integrate IBM Connections into web applications

A subset of the IBM Connections applications can be surfaced in other products programmatically.

The procedures described in this section require you to have some programming knowledge. In addition to surfacing applications in other products programmatically, you can also install prebuilt plug-ins that do not require programming abilities. These plug-ins surface IBM Connections applications in a predefined list of products. For more information about these plug-ins, see the Extending section of the product documentation.


Extend bookmarks

Use the API provided with IBM Connections to extend the Bookmarks application of IBM Connections.

Add dynamic IBM Connections bookmarks to your application. Or, add a hypertext link to a web page in your application that enables your users to bookmark your application and add the bookmark to their Bookmarks collection in IBM Connections.


Add a set of bookmarks to a web page

Embed a set of bookmarks into your web pages. Your web application can use this resource to enable users to see and navigate to a selected set of bookmarks relevant to your web page.

Table 1. Atom API request details

Resource Description
/snippet Retrieves bookmarks matching search criteria. Returns JavaScript code that emits XHTML containing the search results, with each result specified in a <div> element.
Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Table 2. Input parameters

Parameter Description
access Filters the bookmarks based on whether they are private or public. Options are:

any

Returns all bookmarks only if the request is made over secure http (https). If the request is made over https, it is redirected to the /mybookmarks URI. If the request is made over http, only public bookmarks are returned. This value is the default value.

private

Only returns private bookmarks. Private bookmarks can only be accessed by their owner, and only if the owner is authenticated. The user is prompted to log in and is redirected to the /mybookmarks URI from which only private bookmarks are returned.

public

Only returns public bookmarks.
base Returns only bookmarks to pages hosted by a given web site. For example, to retrieve only bookmarks to pages on the web site www.w3c.org/TR, specify "base=www.w3.org/TR"
email Internet email address. Returns bookmarks created by the user specified by the email address. Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in: 

adam_eventide%40garden.com

Do not use this parameter if IBM Connections is configured to prevent email addresses from being displayed. Use the userid parameter instead.

font_family Specify a font family for the embedded bookmarks. For example, arial.
font_color Specify a font color for the embedded bookmarks. For example, red|EEE|34EEFF.
font_size Specify a font size for the embedded bookmarks. For example, 10| 10px|10em|10pt
lang Language code. Language for strings in the output. If not specified, the language specified by the first matching client, typically the web browser, is used, if available. The server then redirects the request to add this parameter to the URL. Specify this parameter to avoid the redirect.
network Filters the bookmarks based on the network that it is available from. Options are:

  • all . Default. Returns all bookmarks.

  • internet . Only returns the bookmarks that link to Internet resources, which are visible outside the intranet firewall.

  • intranet . Only returns the bookmarks that link to resources available on the corporate intranet, that is, resources that are not externally visible.
page Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 50.
search Well-formed full text search query. Performs a text search on the title, description, and tags of all bookmarks. Orders results by relevance. Respects other constraints. See Advanced search options in the Using section of the wiki for details on the search operators you can use in the search query to perform advanced searches for bookmarks.

When you use this parameter, the search can only find bookmarks that the indexer has processed. The indexing interval is stored in a configuration property that your administrator can configure. See Managing search and index operations in the Administering section of the wiki for more details.

searchOperator Default operator between search terms. Options are:

  • and

  • or
The default value is set by your system administrator. Use in conjunction with "search" parameter to override the system default operator for search queries.
show_icon Includes links to bookmark icons (also known as "favorite icons") in the response. Bookmarks uses link relation "http://www.ibm.com/xmlns/prod/sn/icon" to identify this link in a bookmark Atom entry. Boolean. Options are:

  • false . Default. Links to bookmark icons are not included.

  • true . Includes links to bookmark icons.
show_person True or false. True displays the person link.
show_tag True or false. True displays the tag link.
since Includes in the resulting feed all bookmarks updated after a specified date. Set the date using a date-time value that conforms to RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
sortBy Specifies how the results should be sorted. Options are:

created

Sorts the entries by the date the item was created.

popularity

Sorts the entries by how popular the item is.

This parameter replaces the sort parameter. The sort parameter and its associated options (date and popularity) are supported for backwards compatibility only; they will be deprecated in a future release.

sortOrder

Specifies the order in which to sort the results. The options are:

asc

Sorts the results in ascending order.

desc

Sorts the results in descending order.
The default value is asc.
tag Returns bookmarks with the specified tag. You can search for multiple tags; separate the tags with a space or comma. If you use a space, URL-encode the space using %20.
url A well-formed web address. Returns bookmarks for the given web address. When you use this parameter, all other search parameters are ignored.
userid Unique ID that represents a specific person.


Output

Content-Type: text/html. Indicates payload contains data in html format.


Example

To add a current list of bookmarks matching the search criteria to a web page, add the following HTML code to the source code of your web page. This example uses the email parameter to qualify the search; you can use any of the search parameters listed in Table 2. 

<iframe 
    src="http://yourcompany.com/dogear/snippet?userid=someuserid&lang=en">
</iframe>

...where yourcompany.com is the fully qualified domain name of the server hosting the Bookmarks application and someuserid is a valid user ID as defined in their <snx:userid> element.


Add a list of bookmarks to a web page

Embed a list of bookmarks into your web pages. Your web application can use this resource to enable users to see and navigate to a selected list of bookmarks relevant to your web page.

Table 3. Atom API request details

Resource Description
/lisnippet Retrieves bookmarks matching search criteria. Returns JavaScript code that emits XHTML containing the search results, with each result specified in a <li> element.

Search can only find bookmarks that the indexer has processed. The indexing interval is stored in a configuration property that your administrator can configure. See the Administer Bookmarks section of the IBM Connections product documentation for more details.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Table 4. Input parameters

Parameter Description
access Filters the bookmarks based on whether they are private or public. Options are:

any

Returns all bookmarks only if the request is made over secure http (https). If the request is made over https, it is redirected to the /mybookmarks URI. If the request is made over http, only public bookmarks are returned. This value is the default value.

private

Only returns private bookmarks. Private bookmarks can only be accessed by their owner, and only if the owner is authenticated. The user is prompted to log in and is redirected to the /mybookmarks URI from which only private bookmarks are returned.

public

Only returns public bookmarks.
base Returns only bookmarks to pages hosted by a given web site. For example, to retrieve only bookmarks to pages on the web site www.w3c.org/TR, specify "base=www.w3.org/TR"
email Internet email address. Returns bookmarks created by the user specified by the email address. Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in: 

adam_eventide%40garden.com

Do not use this parameter if IBM Connections is configured to prevent email addresses from being displayed. Use the userid parameter instead.

font_family Specify a font family for the embedded bookmarks. For example, arial.
font_color Specify a font color for the embedded bookmarks. For example, red|EEE|34EEFF.
font_size Specify a font size for the embedded bookmarks. For example, 10| 10px|10em|10pt
lang Language code. Language for strings in the output. If not specified, the language specified by the first matching client, typically the web browser, is used, if available. The server then redirects the request to add this parameter to the URL. Specify this parameter to avoid the redirect.
network Filters the bookmarks based on the network that it is available from. Options are:

  • all . Default. Returns all bookmarks.

  • internet . Only returns the bookmarks that link to Internet resources, which are visible outside the intranet firewall.

  • intranet . Only returns the bookmarks that link to resources available on the corporate intranet, that is, resources that are not externally visible.
page Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 50.
search Well-formed full text search query. Performs a text search on the title, description, and tags of all bookmarks. Orders results by relevance. Respects other constraints. See Advanced search options in the Using section of the wiki for details on the search operators you can use in the search query to perform advanced searches for bookmarks.

When you use this parameter, the search can only find bookmarks that the indexer has processed. The indexing interval is stored in a configuration property that your administrator can configure. See Managing search and index operations in the Administering section of the wiki for more details.

searchOperator Default operator between search terms. Options are:

  • and

  • or
The default value is set by your system administrator. Use in conjunction with "search" parameter to override the system default operator for search queries.
show_icon Includes links to bookmark icons (also known as "favorite icons") in the response. Bookmarks uses link relation "http://www.ibm.com/xmlns/prod/sn/icon" to identify this link in a bookmark Atom entry. Boolean. Options are:

  • false . Default. Links to bookmark icons are not included.

  • true . Includes links to bookmark icons.
show_person True or false. True displays the person link.
show_tag True or false. True displays the tag link.
since Includes in the resulting feed all bookmarks updated after a specified date. Set the date using a date-time value that conforms to RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
sortBy Specifies how the results should be sorted. Options are:

created

Sorts the entries by the date the item was created.

popularity

Sorts the entries by how popular the item is.

This parameter replaces the sort parameter. The sort parameter and its associated options (date and popularity) are supported for backwards compatibility only; they will be deprecated in a future release.

sortOrder

Specifies the order in which to sort the results. The options are:

asc

Sorts the results in ascending order.

desc

Sorts the results in descending order.
The default value is asc.
tag Returns bookmarks with the specified tag. You can search for multiple tags; separate the tags with a space or comma. If you use a space, URL-encode the space using %20.
url A well-formed web address. Returns bookmarks for the given web address. When you use this parameter, all other search parameters are ignored.
userid Unique ID that represents a specific person.


Example

To add a current list of bookmarks matching the search criteria to a web page, add the following HTML code to the source code of your web page. This example uses the email parameter to qualify the search; you can use any of the preceding search parameters. 

<iframe
language="javascript" type="text/javascript"
src="http://yourcompany.com/dogear/lisnippet?userid=someuserid&lang=en">
</iframe>

...where yourcompany.com is the fully qualified domain name of the server hosting the Bookmarks application and someuserid is a valid user ID as defined in their <snx:userid> element. The resulting page displays a bulleted list of documentation links.


Add popular bookmarks to a web page

Embed the most popular bookmarks into your web pages. Your web application can use this resource to enable users to see and navigate to the most popular bookmarks embedded on your web page.

This lists the bookmarks that multiple users have bookmarked recently. It captures the bookmarks that are displayed in the Most Bookmarked in the last 30 days section of the Popular tab of the Bookmarks application. The administrator can change the number of days from 30 to something different. To find out how to add all bookmarks to a page, retrieve the resources described in Add bookmarks to a web page and Add a list of bookmarks to a web page.

Search can only find bookmarks that the indexer has processed. The indexing interval is stored in a configuration property that your administrator can configure. See Administer Search for more details.


Resource information

/lisnippet/popular

Retrieves popular bookmarks. Returns JavaScript code that emits XHTML containing the search results, with each result specified in a <li> element.

/snippet/popular

Retrieves popular bookmarks. Returns JavaScript code that emits XHTML containing the search results, with each result specified in a <div> element.
Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Table 5. Input parameters

Parameter Description
lang Language code. Language of the strings in the output. If not specified, the first matching browser language is used, if available. The server then redirects the request to add this parameter to the URL. Specify this parameter to avoid a redirect.
page Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 50.
font_family Specify a font family for the embedded bookmarks. For example, arial.
font_color Specify a font color for the embedded bookmarks. For example, red|EEE|34EEFF.
font_size Specify a font size for the embedded bookmarks. For example, 10| 10px|10em|10pt
show_icon Includes links to bookmark icons (also known as "favorite icons") in the response. Bookmarks uses link relation "http://www.ibm.com/xmlns/prod/sn/icon" to identify this link in a bookmark Atom entry. Boolean. Options are:

  • false . Default. Links to bookmark icons are not included.

  • true . Includes links to bookmark icons.
show_person True or false. True displays the person link.
show_tag True or false. True displays the tag link.
type Filters the bookmarks returned in the feed. You can filter by the following values:

popular

Returns a list of the most bookmarked web sites. This value is the default value.

visited

Returns a list of the bookmarks that are accessed most often.


Example

You can add code similar to the HTML used in this example to display the popular bookmarks returned by either the /snippet/popular or /lisnippet/popular resource in a web page. 

<iframe src="http://yourcompany.com/dogear/lisnippet/popular?lang=en">
  <p>Your browser does not support iframes.</p>
</iframe>


Add the Add Bookmark link to a web page

To simplify the process of adding a bookmark to one's bookmark collection in IBM Connections, the product provides an Add Bookmark button that users can add to their toolbar and can click to add the current web page to their collection. You can add similar functionality to your web application by adding an Add Bookmark link to a page. When a person clicks the link, the web page is added to the user's IBM Connections bookmark collection. The Bookmarks application provides the following resources to help you create the Add Bookmark link:

  • JavaScript library: A single file named doglink.js that defines a JavaScript object named "DogLink" and contains a post_to_dogear() method. The file is available from the following web address: http://{your_bookmarks_server}/dogear/tools/doglink.js

  • Icon resource: A file named favicon.gif that is located at the following web address: http://{your_bookmarks_server}/dogear/misc/favicon.gif
The post_to_dogear() method is invoked when a user clicks the Add Bookmark link. It opens a separate web browser window in which the user can modify the description or other fields, and then save the bookmark to her collection in the Bookmarks application.

To add the Add Bookmark link to your web page, complete the following steps:

  1. Include the JavaScript library in the <head> HTML block of your web page. For example, use the following HTML element, replacing "www.example.com/dogear" with the address of your Bookmarks server: 

    <script 
 type="text/javascript" 
 src="http://www.example.com/dogear/tools/doglink.js"/>

  2. In the web page, at the location in which you want the Add Bookmark link to be displayed, add an onClick event that calls the following method: 

    post_to_dogear(url, title, tags, description)

    Table 6. post_to_dogear() method parameters

    Parameter Description
    description Description of the page. You can leave the field blank. If your pages have a <meta> tag for descriptions, you can use JavaScript code to get it and fill the field.
    tags Tags are labels that people can associate with a page to categorize it. You can leave this parameter blank or include default tags that you want people to use. Enter tags as a single word, separated by commas or spaces.
    title Title of the page. Specify document.title to refer to the title of the current page.
    url web address of the page. Specify location.href to refer to the current page.
    For example: 

    <a 
  href="#" 
  style="text-decoration:none;" 
  onclick="DogLink.post_to_dogear(location.href,document.title,'','');
  return false;">
    Add Bookmark
</a>

  3. Recommended: Include a bookmark icon that is displayed on the page in front of the Add Bookmark link text. 

    <a 
  href="#" 
  style="text-decoration:none;" 
  onclick="DogLink.post_to_dogear(location.href, document.title, '', '');
  return false;">
  <img 
     height=16 
     src="http://www.example.com/dogear/misc/favicon.gif" 
     width=16 
     border=0> 
   Add Bookmark
</a>

    Replace www.example.com with the address of your Bookmarks server.


Example

Example: 

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
 "http://www.w3.org/TR/html4/loose.dtd"> 
 <html> 
  <head> 
    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 
    <title>Sample Bookmark-able web Page</title> 
    <script 
     type="text/javascript" 
     src="http://www.example.com/dogear/tools/doglink.js">
    </script> 
  </head> 
  <body> 
    <h2>A sample web page with a bookmark link</h2> 
    <p>Your content here. </p> 
    <a 
     href="#" 
     style="text-decoration:none;" 
     onclick="javascript:DogLink.post_to_dogear(location.href, document.title, 
      'tag1,tag2 tag3', '');
     return false;"> 
      <img 
       height=16 
       src="http://www.example.com/dogear/misc/favicon.gif" 
       width=16 border=0/> 
         Add Bookmark
    </a> 
  </body> 
</html>


Integrate business cards in to your web application

Add the Profiles business card to your web application to provide a useful summary of a person's professional role, business location, and contact details. Integrating the community card enables users to easily navigate to a community from your web application.


Add a file picker to your web application

Use a Javascript API to select from a list of files stored in the IBM Connections Files application, and use those files and their metadata in a callback function.

To see documentation on the file picker arguments and callback values, and working sample code, paste the following URL into your browser: 

http://<ibm_connections_server>/connections/resources/web/lconn.core/test/filepicker/sample.html
For example: 

http://connections.enterprise.example.com/connections/resources/web/lconn.core/test/filepicker/sample.html

IBM Connections APIs

The IBM Connections applications (Activities, Blogs, Bookmarks, Communities, Files, Forums, Profiles, and Wikis) and the IBM Connections Home page all provide application programming interfaces (APIs) that enable you to integrate them with other applications. Using the interfaces, you can programmatically access and update much of the same information that you can access and update through the IBM Connections user interface.

Starting in release 4, the IBM Connections API documentation is located in the IBM Social Business Development Wiki.

  • Files administrative commands
  • Wikis administrative commands

    IBM Connections SPIs

    IBM Connections provides Service Provider Interfaces (SPIs) that enable third parties to integrate services and function into the IBM Connections product. Unlike the Atom-based APIs, SPIs are typically Java-based and require some deployment and configuration before they can be used.

    SPIs are lower-level programming interfaces which may be subject to modification from release to release. Changes to your application may be required to maintain equivalent functionality when integrating with a future release.

    Starting in release 4, the IBM Connections SPI documentation is located in the IBM Social Business Development Wiki.

    Use

    Learn how to perform everyday tasks using IBM Connections.

    This section of the information center republishes the documentation provided within the product. It is displayed when you click Help from the product menu. It is included here to serve as a resource for administrators, so that you can refer to the documentation that is being provided to your users. Including it in the information center also enables you to quickly search the content.

    To watch a video demonstration of each application, go to the following pages of the IBM Connections wiki:

    Activities

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Demo_Using_Activities

    Blogs

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Demo_Using_Blogs

    Bookmarks

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Demo_Using_Bookmarks_video

    Communities

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Demo_Using_Communities

    Files

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Demo_Using_Files

    Forums

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Using_Forums

    Home page

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Demo_Using_the_Home_page

    Profiles

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Demo_Using_Profiles

    Wikis

    http://www-10.lotus.com/ldd/lcwiki.nsf/dx/Demo_Using_Wikis

    IBM Connections

    For additional information, review the About page or click ? to get help on a particular feature.


    New to IBM Connections?

    Watch a video to learn more about IBM Connections.


    New to this release?

    Find out what features have been added since the last release.


    Use IBM Connections

    Click topics in the table of contents to get help with other tasks.

    What's new in IBM Connections?

    These features are new or enhanced for this version of IBM Connections.

    • Share a status update or file from anywhere in IBM Connections. Log in and then click the Share link in the header.

    • The activity stream displays an aggregated view of the latest updates from people or events that you are following and people in your network. To view more information about an update, repost it, or like it, click the entry to launch the embedded experience.

    • IBM Connections now introduces an enhanced Metrics application. Metrics employs the analytic capabilities of the IBM Cognos® Business Intelligence server, which is provided as part of the IBM Connections installation to support the collection of metrics data. Administrators and designated users can work with interactive displays of global metrics by clicking Server Metrics in the footer. Community owners can view non-interactive reports for their communities by clicking Metrics in the navigation pane.

    • The rich text editor, which is used across the IBM Connections applications, has been upgraded to CKEditor 3.6.3 in this release. There are a number of new features in the Wikis editor.

    • Profiles has been updated to include the activity stream, which shows the profile owner's latest updates from across IBM Connections.

    • When viewing search results, you can filter the results from Profiles to exclude inactive profiles by selecting Exclude Inactive People from the Show menu on the Profiles Search Results page.

    • The social analytic widgets now recommend private as well as public content, based on your existing relationships with public and private content in IBM Connections.

    • The Trending widget displays a list of the hot topics that are trending in your organization. The widget displays when you filter search results using the Status Updates option.

    • Status updates and microblogging content are now included in the analysis of the relationships that are used to recommend content and people in the social analytics widgets.

    Which application do I use?

    Choose the IBM Connections application that best suits what you want to accomplish.

    IBM Connections is a suite of applications designed to help an organization communicate and work collaboratively. Depending on what is deployed for your organization, you can choose from the following IBM Connections applications:

    Activities

    Allows you to plan and track work items and documents related to a project or task. Activities are best suited for a targeted task, such as planning an event or tracking deliverables for a product release. When the project is over you can complete the activity and place it in an inactive state. If you have a larger project that involves collaborating on documents, a wiki might be a better choice.

    Blogs

    Broadcast information on a particular subject and accept feedback. Blogs generally have a singe or a small number of authors. For a more open exchange of ideas, choose a forum.

    Bookmarks

    Create shortcuts to web pages of interest to you and others. Bookmarks to keep private for your own use or share with everyone can reside in the Bookmarks application. To share bookmarks with a specific group of people, add bookmarks to a community with a defined membership.

    Communities

    Communities allow you to share a collection of information with a group. Although communities can be public, they are often used to share information with a specified group of members. For example, you might create a community for the sales team. Within the community you can provide collaborative applications, such as an activity, wiki, or forum, to enable the community members to work together and share content. Note that a community can only have one of each type of repository. For example, you can only create a single activity within a community. If you plan to create many activities, create them from within the Activities application rather than from a community.

    Files

    Files provides a repository for storing and sharing files. The benefit is that you can link to a file from many places without storing multiple copies of a file. In addition, users with access to the file can view or revise the file and changes are immediately available to other users. Upload a file to Files instead of attaching a file to an email. If you want a defined group of people to have access to a file, use the Files component from within a community.

    Forums

    Use a forum to have an open discussion, where members can create topics or responses. This is a great format for a question and answer application, such as a support forum. If you want to limit access to the forum to a defined group of users, create a forum within a community.

    Home page

    Use the Home page when you want to view the latest updates from all the applications in IBM Connections. If your administrator has enabled it, you can also catch up on the latest updates from third-party applications. You can filter the display to drill down to the information that interests you most, and perform in-context actions, such as liking updates, reposting updates, or commenting on updates.

    Wikis

    Wikis are ideal for storing large numbers of documents. Depending on access, users can view or revise topics stored in a wiki. If you are only dealing with a small number of documents, or you want to track to-do items in addition to sharing documents, an activity might be a better choice. A wiki you create within a community is available only to members of that community.

    Use the business card

    Use the business card to view peoples' contact details and get in touch with them. The business card provides a useful snapshot of a user's profile information. In addition to displaying a job title and contact details, if your administrator has enabled IBM Sametime® awareness, the card displays the user's current status information.

    The business card provides links to the IBM Connections applications that are used by the person and allows you to perform a number of actions. For example, if your administrator has configured email addresses to display, you can send an email, or you can start a chat session with them if you have installed the IBM Connections plug-in for Sametime.

    1. Access a person's business card by hovering over their name in any of the applications and clicking the link that is displayed.

    2. Use the business card to perform the following tasks:

      • Access the applications associated with a person by clicking the links on the business card. For example, you can access the person's public file library and files that they have shared with you by clicking Files.

      • Add the person as a colleague by selecting More Actions > Invite to My Network, typing an invitation message, and clicking Send invitation.

      • Download and save the person's vCard by selecting More Actions > Download vCard, selecting a character encoding option, and clicking Download.

      • Send the person an email by clicking Send E-mail.

        This option is not available if your administrator has configured IBM Connections to prevent email addresses from being displayed.

      • Start a chat session with the person by clicking Chat.

        You must install the IBM Connections plug-in for Sametime for this option to display.

      • Start a telephone conference call with the person by clicking Call.

        You must install IBM Sametime Advanced Telephony for this option to display.

    Use the Sametime task bar

    Use the IBM Sametime task bar to change your Sametime status and interact with the Sametime application directly from IBM Connections.

    The Sametime task bar is only available when your administrator has enabled Sametime integration through the Sametime client. When Sametime presence awareness is enabled and you are logged in to IBM Connections, the Sametime task bar displays in the footer of every page in IBM Connections. Sametime presence awareness enables you to see a person's online status and find out whether the person is available to chat, busy in a meeting, or away from their computer. When this feature is enabled, you can see a person's Sametime status on their profile page and in their profile business card.

    The Sametime task bar allows you to update your own status directly from any page in IBM Connections and access options for interacting with the Sametime application.

    Use the Sametime task bar in the following ways:

    • To update your status message, click the status message and select the status to display to other users. The text in the task bar is updated to display the status message that you choose.

    • To disconnect from Sametime, click the status message and select Disconnect from Sametime from the task bar menu.

    • To connect to Sametime, click the status message and select Connect to Sametime from the task bar menu.

    • To open your Sametime contact list, click the chat bubble icon that displays on the task bar. You can add contacts, send instant messages, search for people, and much more from the dialog that displays. For more information about working with Sametime, click Help.

    Set email notification preferences

    Set email preferences to specify how you want to receive notifications in IBM Connections. You can control how and when you receive email notifications by setting preferences on the Email Preferences tab. You can enable or disable notification emails from other users, set the language to receive notifications in, and specify what email address you want them sent to.

    When you enable email notifications, you can select whether to be notified about different types of content, and also specify how often you want to receive notifications.

    1. Hover over your name in the banner of a page in IBM Connections and select Sets from the menu that displays.

      Alternatively, you can enter the following URL into your browser to access the Email Preferences tab: http://<servername.com:port>/news/.

    2. To specify the email address where you want notifications to be sent, enter an address in the Send emails to this address field.

      You cannot edit this field if your administrator has configured your deployment to prevent email notifications from being sent to an address that is different from your regular work email address.

    3. To enable notifications from other users, select Receive notifications from other people by email.

    4. Select the language in which you want email notifications to be sent from the Email language list.

      The options available depend on what your administrator has configured for your deployment.

    5. Specify how often you want to be notified about responses to content that you create yourself. To disable notifications about content that you create yourself, select No Email.

    6. Specify how often you want to be notified about the people and content that you are following. To disable notifications about people and content that you are following, select No Email.

    7. Click Save to save your preferences.


    What to do next

    If you want to return to the default email notification preferences, access the Email Preferences tab using the information in step 1, and then click Restore Defaults.


    Related tasks

  • Enable users to specify email notification preferences

    Change the display language

    If your administrator has enabled it, you can change the language used in the user interface so that all the IBM Connections applications display in your preferred language.

    The application that allows you to change the language setting in IBM Connections is disabled by default. Your administrator must enable it. To find out if the application is enabled, look for your name in the navigation bar. If a language name is displayed, then the application is enabled.

    Change the display language of an application does not affect the language of the content that users have added to the application. For example, if an activity's entries are authored in English and you change the display language to French, the activity entries continue to be displayed in English. Only the user interface is displayed in French. To change the display language, complete the following steps:

    1. Click the arrow for the language displayed in the navigation bar.

    2. Select a language from the list.

      If the list does not include your preferred language and your preferred language is defined in the locale setting of the web browser that you are using, select Browser Set.


    Results

    The page is refreshed and the user interface is displayed in the selected language. If you do not see a change, refresh the page.

    IBM Connections Search

    When you perform a search in IBM Connections, your query is analyzed to return the optimum results.

    As part of the operation, the Search application performs a linguistic analysis to ensure that different word forms, such as plurals, verb endings, and grammatical tenses, are matched correctly in the search results. For example, when you search for the term goose, you might expect to get results that contain the term geese. Similarly, when you search for the term run, you might expect to get results that include the terms ran or running.

    The more times your search term appears in a piece of content, the higher that content will be ranked in search results. The number of times a piece of content has been bookmarked in Bookmarks also influences its ranking in search results, as does the number of times a piece of content has been liked or recommended. If your search term appears in the content title or as a tag of the content, this does affect its search results ranking, but no more so than if it appeared in the content. It is the frequency with which a term appears that matters primarily.

    The type of content that is searched varies from application to application. For example, content from file attachments is only searched in the Files and Wikis applications. For more information about what content is searched for each application, see Searchable content.


    Search IBM Connections

    Use the search control in the title bar to search all the IBM Connections applications.

    1. From any view, type the word or term to search for into the Search field on the title bar.

    2. Define the scope of the search by clicking the Down arrow next to the Search field, and then selecting one of the following options:

      Option Description
      All Connections Searches for the text string in all the IBM Connections applications.

      application_name Searches for the text string in an individual application.

      The option to select which application to search is only available when you are in the Home page application or on the Advanced Search page.

      Advanced Opens the Advanced Search page from which you can search for the text string in one, all, or a subset of applications. For more information, see Performing an advanced search.

      If your administrator has enabled a custom search option, it is displayed in the list as well.

    3. Click the search icon.

      The search results are displayed in the Search Results page. Click the title of a result to open it.


    Advanced searching

    When you perform an advanced search, you can search for a text string in one, all, or a subset of applications. You can also apply different filters to your search query.

    An advanced search allows you to search across all the applications. For example, searching for the keyword "project" across all the applications returns a list of results with the word "project" in the title, description, tags, or content. The search results can include content from any of the applications included in your installation of IBM Connections, for example, bookmarks, activities, blogs, communities, files, forums, people, and wikis. It can also include status updates.

    You can limit your search to one or more applications if you want to narrow your results to content from specific areas. For example, a search for the keyword "project" that is limited to the Activities application only returns entries from Activities with the word "project" in the title, description, tags, or content. You can further narrow search results by searching your own content only. For example, searching the Communities application when Search MY content is selected searches only the communities that you own and the communities to which you belong.

    When you search for a phrase, you must enclose the phrase in double quotation marks ("); single word search terms do not need to be enclosed in quotation marks. You can further refine the scope of your search by combining search terms with Boolean operators to create a more complex query. For more information about the search operators that you can use when performing an advanced search, see Advanced search options. You can also perform wildcard searches, and group search terms using parentheses to form sub-queries. Note that search terms are not case-sensitive.


    Performing an advanced search

    You can perform an advanced search from any of the applications in IBM Connections.

    For information about the search operators that you can use when performing an advanced search, see Advanced search options.

    Click here to view a demo video showing how to perform an advanced search.

    To perform an advanced search, complete the following steps.

    1. Click the arrow for the Search field and select Advanced.

    2. Select the applications to search. All the applications are selected by default. You can also search status updates.

    3. Define the scope of your search by selecting one of the following:

      • Search ALL content. Select this option to search all public content and content to which you have access.

      • Search MY content. Select this option to search only the content relating to you.

    4. Enter one or more keywords in the Keywords field.

    5. Enter a tag in the Tags field.

      The tag that you enter in this field must be an exact match for the tag that you are searching for; wildcard characters, such as an asterisk (*), question mark (?), or exclamation point (!) are not supported.

    6. Type a name in the Person field to find content associated with a specified person. Wait for type-ahead to display the name that you want and then select the name.

      By default, users who are marked as inactive in your company directory are excluded from the search results. To include inactive users in search results, you can select Profiles from the navigation pane on the Search Results page, and then select All People from the Show options.

      Your administrator can override this default setting by updating the Search configuration file.

    7. Enter a title or file name in the Title or File Name field to retrieve entries with the specified title or files with the specified name.

    8. Click Search.


    What to do next

    Filter the results that display on the Search Results page to find the information you need. For more information, see Working with search results.


    Advanced search options

    You can use advanced search options to control the scope of your search from any of the applications in IBM Connections.

    When performing an advanced search, you can search for single terms, such as test or hello, or phrases, such as "test search" or "hello world". Note that to search for a phrase, you must enclose the phrase in double quotation marks ("). Search is not case-sensitive. You can further refine the scope of your search by combining search terms with Boolean operators to create a more complex query. You can also perform wildcard searches, and group search terms using parentheses to form sub-queries.


    Wildcard searches

    A wildcard is a character that can be used to represent one or more other characters in a search term. Search supports single and multiple character wildcard searches within single terms, but not in phrases. You cannot use the question mark (?) or asterisk (*) wildcards as the first character of a search string.

    • Single character wildcard searches

      To perform a single character wildcard search, use the question mark (?). The Search application looks for terms that match when the single character is replaced by another character.

      For example, if you enter te?t as a search string, the results might include information containing the terms text and test.

    • Multiple character wildcard searches

      To perform a multiple character wildcard search, use the asterisk (*). This type of search looks for zero or more characters.

      For example, if you enter test* as a search string, the results might include information containing the terms test, tests, and tester.


    Search operators

    Use the following operators to control the scope of your search.

    Table 7. Advanced search operators

    Operator Description
    OR Use the OR operator between two words to search for content that contains either word.

    For example, if you enter car or motorcycle, Search returns information that contains either car or motorcycle.

    AND Use the AND operator to search for content where both terms exist anywhere in the text of a single document. By default, a space between keywords is treated as an AND operation.

    The double ampersand (&&) operator can be used as a synonym for the AND operator.

    For example, to search for information containing the text car and motorcycle enter the following query:

    "car" AND "motorcycle"

    + Use the plus sign (+) to combine search words. The plus sign operator is similar to the AND operator, but it applies only to the word immediately following it.

    For example, to search for information that must contain car and can contain motorcycle, enter the following query:

    +car motorcycle

    NOT Use the NOT operator to exclude a word from your search. Results containing the word immediately following the operator are excluded by the search.

    The exclamation point (!) and minus sign (-) can be used as synonyms for the NOT operator.

    For example, to search for information that contains car but not motorcycle, enter one of the following queries:

    • car NOT motorcycle

    • car -motorcycle

    Use the NOT operator, exclamation point (!), or minus sign (-) with a single term returns no results.


    Grouping

    Use parentheses to group search terms in clauses and further refine the scope of your search.

    For example, if you want to search for information that contains plane and car or plane and motorcycle, enter the following query:

    (car OR motorcycle) AND plane


    Special characters

    When your search term contains one of the nonalphanumeric characters listed here, you need to escape the character by using a backslash ( \ ) before the character or by enclosing the search term in double quotation marks ("). Use a backslash before using any of these characters:

    + - && || ! ( ) { } [ ] ^ " ~ * ? : \ If you do not perform this escape operation, Search interprets the characters as being part of the query instructions.

    For example, if you want to search for information that contains the text string cat + dog and you enter cat + dog as your search term, Search looks for any data that contains both the word cat and the word dog. This result is because the plus sign (+) is a reserved operator with a predefined meaning. To search for information containing the actual text string cat + dog, use one of the following queries:

    • cat \+ dog

    • "cat + dog"


    Work with search results

    Filter the results that display on the Search Results page to find the information that is most useful to you. Your search term is highlighted in the returned results to make it easy for you to see whether it is being used in a relevant context. The Search Results page lists the results returned by your search query, and includes the title of each search result, the name of the person who created it, and the date when it was created. You can read a brief description of the search result and view a comment extract, where available, and see how many people liked the search result item. The latest status update displays before the list of search results when it is relevant to the search term. An icon next to each search result identifies which application the content is associated with.

    Table 8. Application icons

    Icon Application
    Activities
    Blogs
    Bookmarks
    Community events
    Communities
    Files

    The icon shown here represents just one file type. The icon next to a search result from the Files application changes depending on the type of file returned. For more information, see File type icons.

    Forums
    Profiles
    Status updates
    Wikis
    The Search Results page displays when you perform any type of search in IBM Connections, except for the context-specific searches that are available in the different applications. When you select a context-specific search option, for example, the option to search My Communities in the Communities application, the search results page for that application displays. When you perform any other type of search in IBM Connections, the Search Results page displays.

    Review search results on the Search Results page by performing the following actions:

    • Click the title of one of the results to open it and review it in more detail.

    • Use the options available from the side navigation bar to display the results returned by a specific application. The All Results option is selected by default.

    • Use the drop-down filters to further refine your search. The filters available vary depending on the option that you select from the navigation bar.

    • Use the Tags widget to search the results for specific tags or keywords. This widget displays up to 50 of the tags associated with search results. Click a tag to display any results that contain that tag. Select a related tag from the Related Tags area if you want to further refine your search.

    • View the people associated with the search results in the People widget. This widget displays up to 250 of the people associated with search results. Click a name to display the results associated with a specific person.

    • Use the Dates widget to display only those results that are associated with a specified year or month. This widget displays up to 250 of the dates associated with your search results.

    • Use the Trending widget to view the latest hot topics in your organization. This widget only displays when you select the Status Updates filter from the navigation bar. It displays up to 50 of the hottest trends associated with search results. Click a topic trend to display the search results that are associated with that trend.


    Searchable content

    When you perform a search in IBM Connections, different types of information are searched for each application.

    The following table lists the content that is searched for each application during a keyword or default search.

    Table 9. Searchable content

    Application Content that is searched
    Activities Tags, titles, content, and the titles of custom fields. Content from file attachments is not searched.
    Blogs Tags, titles, content, author names, and comments. Content from file attachments is not searched.
    Bookmarks Tags, titles, descriptions, and URL strings if the bookmark points to a URL that is not internal to IBM Connections.
    Communities Tags, titles, descriptions, and community events.
    Files File names, tags, and descriptions, and uploaded file content.
    Forums Tags, titles, content, and comments. Content from file attachments is not searched.
    Profiles All main profile fields and custom fields.
    Status updates Status updates posted to Profiles, Communities, and the Home page, or shared using the Share link.

    Status updates that are added from the Home page or shared using the Share link are automatically posted to the user's profile. Use the Show options on the search results page for status updates to filter the display to show all status updates, status updates from Profiles, or status updates from Communities.

    Wikis Tags, titles, summaries, content, comments, and content from file attachments.

    Only current content is indexed; previous versions of wiki pages are not searched.


    My Content searches

    When users choose to search only the content related to them, the behavior of the My Content search feature varies across each of the different applications.

    The following content is returned when users select the Search MY content option on the Advanced Search page:

    Table 10. Results of My Content searches

    Application Content that is returned
    Activities All activities that the user is a member of, including activities that are contained by communities to which the user belongs. Public activities are not returned unless the user explicitly joins them but authored entries in a public activity are returned. Files added to an activity that were uploaded by the user or shared with the user are also returned.
    Blogs Content from any singly-authored blogs, co-authored blogs, community-owned blogs, and Ideation Blogs of which the user is a member.
    Bookmarks All the user's bookmarks, including private links.
    Communities All communities to which the user belongs and all associated content across applications. Also, content that was created by users in a community that they are no longer members of.
    Forums All forum content in forums created by the user, and all forum content associated with communities to which the user belongs.
    Files Files that belong to communities of which the user is a member, files that the user uploaded, and files that were shared with the user.
    Profiles The user.s own profile and the profiles of people who belong to the user.s network.
    Status updates Status updates posted by the user to Profiles, Communities, and the Home page, or shared using the Share link.

    The status updates that you post to Home page or share using the Share link are automatically posted to your profile. Use the Show options on the search results page for status updates to filter the display to show all status updates, status updates from Profiles, or status updates from Communities.

    Wikis Wiki pages where the user is a contributing author or member of an owning community. Files that were uploaded by the user or shared with the user are also returned.


    Add IBM Connections search to your browser

    Add IBM Connections to the list of search engines used by your web browser so that you can search IBM Connections content directly from the browser.

    The IBM Connections search engine can be added to all supported browsers except Microsoft Internet Explorer 6. Add IBM Connections search functionality allows you to search all the content in your deployment directly from the browser, with the results returned in the IBM Connections interface.

    1. To add IBM Connections search to Mozilla Firefox or Microsoft Internet Explorer:

      1. Open either the IBM Connections Search URL provided by your administrator or the Search Results page.

      2. Do one of the following:

        • In Mozilla Firefox:

          1. From the search control in your browser, click the Down arrow to display a list of search engine options.

          2. Select Add "Connections".

        • In Microsoft Internet Explorer:

          1. Click the Search Options arrow next to the search control and select Connections.

    2. To set IBM Connections as the default search engine in Google Chrome:

      1. Click the Customize and control Google Chrome icon on the browser toolbar and select Sets.

      2. Under Search, click Manage search engines.

      3. Enter IBM Connections in the Add a new search engine field.

      4. In the Keyword field, enter the text shortcut to use for IBM Connections. You can use this keyword to quickly access the IBM Connections search engine from the address bar. For example, connections.

      5. Enter the following URL in the URL field, and then click OK. 

        https://server_name/search/web/search?scope=allconnections&query=%s

      6. Hover over the entry that you just added and click the Make default button that displays.


    Results

    IBM Connections search now becomes the active search engine in your browser. You can switch to another search engine at any time by selecting a different option from the list of search engines provided.


    What to do next

    To search IBM Connections from your browser search control, enter a search term in the field provided and click Search. The results display in the IBM Connections user interface, where you can filter them in the usual way. For information about working with search results, see Working with search results.

    What are tags?

    A tag is a descriptive term that you assign to an item, such as a blog or wiki, to categorize it by subject or that you assign to people to categorize them by skill. Categorizing things and people makes them easier to find later, and makes it easier for others to discover information when searching by tag.

    When creating a tag:

    • Set the tag as a single word only; tags cannot contain spaces. They can contain characters such as an underscore (_) or at sign (@).

      For example, you can use follow_up, follow-up, and followup as tags, but not follow up.

    • The letters comprising a tag are saved as all lowercase letters. If you add a tag that contains uppercase letters, then the letters are converted to lowercase when the tag is added.

    • To add multiple tags, type a comma or leave a space between each tag.

    • The tags that you add to items, entries, and people are automatically added to the tag collection, and become visible to others.

      People can only see tags that are associated with items to which they have access. If you add a tag to a private entry, for example, the tag is added to your tag collection, but is not visible in anyone else's tag collection.

    What is a tag collection?

    As you and others add tags to items, entries, and profiles, the tags are automatically added to an organization-wide collection of tags. You can click a tag from the tag collection to find information related to it.

    The tag collection displays the tags assigned to items available to you in the current context. When you are looking at a list of your activities, for example, the tag collection displays the tags assigned to each activity. When you open one of the activities, the collection changes to display the tags assigned to the entries within that activity. The tag collection only displays the tags associated with items or entries to which you have access.

    The tag collection is refreshed periodically; it can take up to 20 minutes for tag changes to be displayed. Therefore, when you add a tag to an item, you might not see it listed in the tag collection immediately.


    Change the display

    You can select to display the tags in the collection in either of the following ways:

    Cloud

    A tag cloud visualizes the popularity of the tags in the collection by grouping the tags together and displaying the most frequently used tags in larger, darker text and less often used tags in smaller, lighter text. The tag cloud displays up to 50 tags.

    List

    A tag list displays the tags in a list starting with the most popular tags. This style collection displays only the 10 most popular tags.


    Use the tag collection

    To find an item, such as an activity or blog entry by tag:

    1. Open the view that contains the type of items to find.

    2. Click a tag from the tag collection.

      This action limits the number of items that are displayed to include only those that have the selected tag associated with them.

    3. To narrow the list further, click another tag from the Related Tags section.

      This action filters the list of items that are displayed to include only those that have both tags associated with them.

    To return to the full collection, click the current view or tab link.


    Search for a specific tag

    If you are looking for a tag that is not displayed in the collection, search for it by clicking Find a tag, entering the tag name in the search field, and then clicking the search icon.

    This feature is not available in all tag collections. For example, you cannot search for a specific tag from the tag cloud on the Search results page.

    Subscribe to feeds

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Social analytics widgets

    The social analytics widgets use the existing relationships between users and content in IBM Connections to help you discover how you are connected to other users and content, and suggest network contacts and content that might interest you.

    The social analytics widgets display different types of information. Some of the widgets recommend content or people, while others display information about how you are connected to other people or content in the organization, based on your existing membership, network connections, and tags. These relationships are based on public and private content, and the widgets can recommend public and private content. The recommendations are randomized to ensure that you see different options every day.

    For example, the Recommendations widget in Communities suggests communities for you to join, based on the communities that you already belong to, the tags that you have used, and people that you are connected to. When this information is being analyzed, only the tags on the communities themselves are used; tags on content within the community, such as community activities or community forums, are not used.

    The following social analytics widgets are available in the Communities, Home page, and Profiles applications.

    Table 11. Social analytics widgets

    Name Description
    Do You Know (Profiles) Recommends people for you to add to your network.

    This widget displays on the My Network page in Profiles.

    Recommendations (Communities) Recommends communities for you to join.

    This widget displays in all the views in Communities: I'm an Owner, I'm a Member, I'm Following, I'm Invited, and Public Communities.

    Recommendations (Home page) Recommends content that might interest you.

    This widget displays in the Updates views in the Home page application.

    Things in Common (Profiles) Displays a list of the things that you have in common with a person.

    This widget displays when you are viewing another user's profile in the Profiles application.

    Who Connects Us? (Profiles) Displays the social path that links you and another user. The social path is displayed as a list of the users that connect you and the other person.

    This widget displays when you are viewing another user's profile in the Profiles application.

    The IBM Connections administrator can enable or disable the social analytics service for your deployment. When the service is disabled, the widgets listed in the table do not display in the user interface.

    The administrator can also exclude specific users from analysis in the social analytics service, if required, with the following results:

    • The user is not returned as a related person in search results.

    • The user is not recommended in the Do You Know widget.

    • The user is not displayed as a link between two people in the Do You Know widget.
    Users who are excluded from the social analytics service still receive recommendations from the Recommendations widgets in Communities and the Home page because these recommendations are based on the users' collaboration history with other users rather than on their social network.


    Related

  • Administer the social analytics service

  • Disable the social analytics service

    Use the rich text editor

    Use the rich text editor to create visually interesting blog posts, wiki articles, forum topics, and activity entries. The rich text editor is also used in profiles.

    The rich text editor allows you to enter and format text and insert images and links to create entries in various IBM Connections applications. Many of the features are common text editing features, however some may not be available depending on the application that you are using and how it is configured. For example, if you are creating a blog entry, you can insert an Adobe Flash demo, but this feature is not available in a forum topic. Hover over an icon for a label describing the feature represented by the item. The following table describes some of the more advanced features available in the editor.

    You can run browser spell check (when available) on words in the editor by selecting the words, and then simultaneously pressing Ctrl and right-clicking.

    Icon Feature description

    Paste content. The Paste menu item provides a way of pasting content if your browser security prevents you from pasting content from the clipboard. The Paste as plain text menu item provides a way of removing formatting from the pasted content and then inserting it into the document. In both cases, use the keyboard to paste the content into the dialog and then click OK to insert it into the page.

    Insert a new table. Specify columns, rows, and other table properties.

    Tip:

    • You can resize columns by dragging the column borders, by using the Column > Column Width context menu item or by resizing a cell in the column using the Cell -> Cell Properties context menu option.

    • Use table headers to help keep the table organized.

    • Set table width to 99 percent to fill the page.

    • To delete a table, right-click it, and select Delete Table.

    Insert an image. You can browse for an image on your computer, select an image that you have already uploaded, or enter a URL for an image on the web.

    This functionality differs across Connections applications. It is not possible to upload an image from your computer or use an image that has already been uploaded in Activities, Profiles, or Forums. These extra abilities are only supported in Wikis and Blogs.

    Insert or edit a link. You can link to a URL, a wiki page, or an attachment.

    This functionality differs across components. It is only possible to link to a wiki page or attachment in Wikis but is not supported in Activities, Blogs, Profiles, or Forums.

    Insert a Document Bookmark. This acts as a marker in your document that you can link to from another location in the document using the Document Bookmark Link toolbar icon.

    Insert a link to a Document Bookmark that is already available in the document. This is useful for page navigation.

    Insert an iFrame, or edit an existing iFrame.

    Insert an Adobe Flash demo. Users can view the flash demo in the blog entry or wiki page. Set the following properties for the demo:

    URL

    A URL to a Flash movie file, usually with file type of .swf

    Width

    The width of the embedded Flash movie, measured in pixels

    Height

    The height of the embedded Flash movie, measured in pixels

    Horizontal space

    The space to the left and right of the embedded Flash movie, measured in pixels

    Vertical space

    The space above and below the embedded Flash movie, measured in pixels

    Preview

    If the URL is valid, the Flash movie is displayed here.

    Insert a page break to control the layout of your posting.

    Insert a line break to control how your text is formatted.

    Insert special characters and symbols, such as currency symbols.

    Insert a block quote to indent a whole section of text in a posting.

    Insert an emoticon to liven up your posts with small graphics that convey feelings.

    Display the formatting in the post, entry, or topic that you are editing.

    Remove formatting that has been applied to text, such as fonts, colors, bold, or italics.

    Retrieve the welcome text for an application

    Welcome text is the text that is displayed in the product user interface the first time that you use it. It describes the currently displayed view and gives you suggestions for how to start using the application. You can close the welcome text panel by clicking the X (close) icon for the panel. When you close the welcome text panel, it does not get displayed again, not even the next time you log in. If you want to retrieve the welcome text again because, for example, you see a tip that you want to read about again, you can retrieve the welcome text panel.

    1. Delete your browser cache. See the documentation provided by your web browser for more details.

      For example, from Mozilla Firefox, you can perform the following steps:

      1. From the browser menu, select Tools > Clear Recent History.

      2. In the Time range to clear drop-down menu, select Everything.

      3. Click the arrow next to Details to display the list of items to clear, select the Cache check box, and then click Clear Now.

    2. Alternatively, see the About page for the application by clicking the About link in the application's footer. Much of the same information available from the welcome text panel is also available from the About page for each application; and unlike the welcome text panel, the About pages are always available.

      For help using an user interface control or for help determining what information to add to a field, click the help icon to display a window that provides a description.

    Moderate content for the site

    Moderate content for your Connections site from a central interface.

    If your Connections administrator assigns you the role of global moderator, you can access a Moderation page

    ...where you can manage the following content:

    • Blog entries and comments

    • Forum posts and comments

    • Community files

    You can review content before it is published and approve it to be published, reject it, or delete it. You can also review and manage published content that users have flagged as inappropriate or otherwise problematic.

    For details on global moderation, see Moderation overview in the Connections wiki.


    Moderate content before publishing it

    Review content before it is published to make sure it meets your standards.

    When content is submitted by a user, it is marked for review and it displays on the Content Approval section of the Moderation tab. The Moderation tab is only visible if you are assigned the global moderator role by the Connections administrator. An authorized moderator can view the state of submitted content and take action on it. Content can be:

    • Blog entries or comments

    • Community files content or comments

    • Forum posts or comments

    The workflow described in this topic requires that valid email addresses are configured for the reviewers and that email notifications are enabled for your Connections deployment.

    When a user submits content, it sets in motion a workflow for reviewing the content. The workflow goes as follows:

    1. Notification is sent to the moderator that content has been submitted. The notification includes information about the person submitting the content and a link to the content. The content is posted to the Content Approval section in the Moderation interface for viewing and managing content before it is published.

    2. The moderator reviews the content and acts on it.

    3. If the content is acceptable, the reviewer approves it and it is published. The author receives notification email that the content is approved.

    4. If the content is considered inappropriate, the reviewer rejects the content. In this case, the author is notified by email. The posting appears on the Rejected panel.

    5. If the content is considered inappropriate, the reviewer can delete it from either the Require Approval or the Rejected tabs.
    Follow these steps to review content and take action.

    1. Click the Moderation tab.

    2. Click Content Approval in the navigation pane and then select the type of content to work with - Blogs, Files, or Forums. Content awaiting decisions are displayed along with information on who submitted the content.

    3. Review an item and choose one of these actions:

      Option Description
      Approve Publish the content.

      Reject The content is moved to the Rejected tab where you can later approve it or delete it. Blog content that is rejected can be revised by the author and resubmitted for approval.

      Delete Permanently remove the content.


    Moderate published content that is flagged as inappropriate

    Review published content that has been flagged as inappropriate and take action on flagged entries and comments.

    When content is flagged by a user, it is marked for review and it displays on the Flagged Content section of the Moderation tab. The Moderation tab is only visible if you are assigned as a global moderator by the Connections administrator. An authorized moderator can view the history and state of flagged content and take action on it. Flagged content can be:

    • Blog entries or comments

    • Community files content or comments

    • Forum posts

    The workflow described in this topic requires that valid email addresses are configured for the reviewers and that email notifications are enabled for your Connections deployment.

    When a user flags content as inappropriate, it sets in motion a workflow for reviewing and resolving the issue. The workflow goes as follows:

    1. Notification is sent to the moderator that content has been flagged. The notification includes information about the person flagging the content, and a link to the content in the Moderation interface. The entry or comment is posted to the Flagged Content section in the Moderation interface for viewing and managing flagged content.

      There is a setting in the contentreview-config.xml file which determines whether notification is sent to a moderator or content reviewer as follows:

      • If issueCategorization is disabled, then notification is sent to all the moderators.

      • If issueCategorization is enabled, then the notification will only be sent to the reviewers defined under each issue category, but if reviewer information is not provided, the notification will still be sent to all the moderators.

    2. The moderator reviews the content and acts on it.

    3. If the reviewer does not think the content is inappropriate, the flag is dismissed and the content remains in the blog or community.

    4. If the content is considered inappropriate, the reviewer quarantines the posting, which means it is removed and placed in a quarantined state. In this case, the author is notified. The posting appears on the Quarantined panel.

      If a quarantined entry has comments or replies, the comments and replies are removed from the Flagged Content section. They will display again if you restore the parent entry from the quarantined state.

    5. If the content is considered inappropriate, the reviewer can delete it from either the Flagged for Review or the Quarantined tabs.
    Follow these steps to review flagged content and take action.

    1. Click the Moderation tab.

    2. Click Flagged Content in the navigation pane and then select the type of content to work with - Blogs, Files, or Forums. Content awaiting decisions are displayed along with information on who flagged the content and why.

    3. Review a flagged entry and choose one of these actions:

      Option Description
      Dismiss Dismiss the flag. The content remains available.

      Quarantine This option turns the post in question to a draft and removes it to a quarantine area so it is not available to readers. This option prompts you to send notification to the posting author explaining your reason for removing the post and providing a link so the author can revise the content. Quarantined content can be restored or deleted.

      Delete Permanently remove the content.

    4. View content that you have quarantined, select one or more items, and take one of the following actions:

      • Click Restore to dismiss the flag and restore the content to a published state.

      • Click Delete to permanently remove the content.

    Viewing metrics

    Metrics summarize how people are using IBM Connections. Metrics can be presented as tables or charts that you refine by selecting options such as the time period to report on, a particular application to focus on, and how to group users in the results.

    Connections collects metrics on two levels. Global metrics report on overall usage; for example, the total number of people who logged into Connections last week. Community metrics report on a particular community; for example, the number of people who logged into the Sales community last week. To protect privacy, community metrics are restricted to the community owner and the Connections administrator.

    The Connections administrator assigns access to metrics information based on people.s roles within the organization. If you believe your access level is incorrect, contact your administrator.

    Table 12. Access to metrics by user role

    Who are you? What metrics can you see? What can you do with reports?

    Community owner

    • Community metrics for each community that you own

    Community owners can always view metrics for their own communities but reports are not interactive. Clicking the Update Metrics button submits a request for the most recent set of metrics; the display is updated when the new data becomes available.

    Business owner

    • Community metrics for each community that you own

    • Community metrics for all communities, if the administrator grants you access

    • Global metrics, if the administrator grants you access

    Business owners (stakeholders or others who have been granted access to global metrics) can view global metrics with interactive reports that allow you to modify the display by customizing the reporting period, sorting people into categories, and drilling down for more detail.

    If you own any communities, you already have access to their metrics. In addition, the administrator can grant you access to all community metrics.

    Connections administrator

    • Global metrics

    • Community metrics for all communities

    Connections administrators have full access to all metrics data with interactive reports that allow you to modify the display by customizing the reporting period, sorting people into categories, and displaying more detail.

    Follow these steps to view a metrics report.

    1. Choose the level of metrics you want to view:

      Your access to metrics determines whether you see these options.

      • Global metrics: click Metrics in the header or click Server metrics in the footer.

      • Community metrics: log in to a community and click Metrics in the navigation pane.

    2. Choose a theme for the report by clicking one of the following options in the navigation pane:

      • People: Tracks the users who visit Connections.

      • Participation: Tracks actions in Connections, such as downloading files or updating profiles.

      • Content: Tracks information shared in Connections, such as files and comments.

    3. Limit the report to a single application by clicking a name under Show by App.

    4. Refresh a community report with the most recent set of data by clicking the Update Metrics button to submit a request.

      Administrators and business owners can additionally explore reports using the following options:

      • Change the reporting period by clicking the View list and selecting a time period (select Custom to define your own start and end dates).

      • Sort the display by types of user by clicking Group by and selecting a category.

      • Explore the report by trying out different formats and levels of detail; for example:

        • Switch between a table and a chart by clicking View table or View chart.

        • Control how much detail is shown in the report by clicking View more detail or View less detail.

        • Home in on a data point by clicking it to display more data (for example, to see the last few days in a report covering the past 4 weeks); right-click the data point and select Drill Up to return to the previous view.

        • View related reports by clicking a report name listed with the current display.

      • Save the report as a PNG image file by right-clicking anywhere on the chart or table and selecting Download.

    Giving applications access to your data

    You can give applications permission to access your IBM Connections data and post data to IBM Connections.

    Your administrator must register the applications that are allowed to ask for permission to use your data.

    When you open a registered application, you are prompted whether you want to give the application access to your data. You can give permission or not. If you give permission, the application can use your data or push data to IBM Connections. The application will have access to all content you have created in IBM Connections. For example, the application can use your profile photograph and personal information, as well as your files, comments, bookmarks, and blog entries. It could also post information to your IBM Connections homepage status.

    You can also remove permission from applications in IBM Connections. Hover over your name on any page in IBM Connections and select Sets from the menu that displays. Then, click the Application Access tab and in the list of authorized applications, click Remove to remove permission.

    Product accessibility

    Accessibility features help users who have a physical disability, such as restricted mobility or limited vision, to use information technology products successfully.


    Keyboard navigation

    Table 13. Keyboard shortcuts

    Action Keyboard shortcut
    Display the business card Tab to highlight a person's name. After the Click here to view business card message is displayed, click Ctrl+Enter to display the card.
    Move from one selectable item to the next* Tab

    In this release of IBM Connections, sections have been added to the page in which arrow key navigation is enabled, so you can navigate a page without having to press the Tab key as many times. Here's how it works: Pressing the Tab key gives focus to the first item in the section. You can then use the arrow keys to navigate between items, and press Enter to select an item. Pressing the Tab key again brings you out of that section and gives focus to the next selectable item on the page. The following sections of the product implement this new behavior:

    Top menu

    Press the Tab key until focus is given to the Home menu option. Use the arrow keys to move to another application menu option. Press Enter to display a submenu, and then use the arrow keys to move directly to the submenu option to select. Press Enter to select a menu option.

    Tabs menu

    When focus is given to the Tabs menu within an application, only the first application tab is given focus. You must use the arrow keys to move between the different tabs. Pressing the Tab key again moves focus to the next area of the page.

    Buttons menu

    Press the Tab key until focus is given to the first button in a set of buttons. Use the arrow keys to move to the button you want to select, and then press Enter. Pressing the Tab key again moves focus to the next areas of the page.

    Side menu

    Press the Tab key until focus is given to the first item in the menu, and then use the arrow keys to move between the menu options. Press Enter to select a menu option.

    Tag collection

    When displayed as a cloud, pressing the Tab key gives focus to the first tag in the cloud. Use the arrow keys to move directly to the tag you want to select, and then press Enter. When displayed as a list, pressing the Tab key gives focus to the first tag in the list. Use the arrow keys to move down the list to the tag you want to select, and then press Enter.


    Accessible Help

    Accessible versions of product documentation are available in the IBM Connections wiki.


    IBM and accessibility

    For more information about the commitment that IBM has to accessibility, go to the IBM Accessibility Center at http://www.ibm.com/able.


    Rich text editor keyboard shortcuts

    The rich text editor used by the IBM Connections applications contains keyboard shortcuts that you can use to navigate the editor without using a mouse.


    Keyboard navigation

    To get help with keyboard navigation, press ALT+0 where 0 is a zero, to open the Accessibility Help window.

    Table 14. Basic navigation

    Edit action Keyboard shortcut
    Move focus into and out of the editor. Tab or Shift+Tab
    Move focus from editing area to editor toolbar. Alt+F10
    Open the context menu in the editing area. Shift+F10 or Ctrl+Shift+F10
    Move focus to the element path bar. Alt+F11
    With the path bar in focus, select HTML elements that are parents of the currently selected element. Tab or Shift+Tab
    With the path bar in focus, move focus back to the editing area without changing selection. Esc
    With the path bar in focus, select the element in the editing area. Enter

    Table 15. Toolbar navigation

    Edit action Keyboard shortcut
    Move focus to the next sub-toolbar. Shift+Tab
    Move focus forward among toolbar items. Right Arrow
    Move focus backward among toolbar items. Left Arrow
    Start selected toolbar item. Enter
    Move focus back to editing area without using commands. Esc

    Table 16. Dialog navigation

    Edit action Keyboard shortcut
    When focus is not on a dialog tab, move forward through input elements in a dialog. Tab
    When focus is not on a dialog tab, move backward through input elements in a dialog. Shift+Tab
    When focus is on a dialog tab, move forward through tab pages in the dialog. Tab or Right Arrow
    When focus is on a dialog tab, move backward through tab pages in the dialog. Shift+Tab or Left Arrow
    Move focus to the currently active tab. Alt+F10
    Close the dialog without completing an action. Esc
    When a single-line text input is in focus, save and close. (The equivalent of pressing OK.) When a tab is in focus, move focus to the first input element inside the tab page. Enter

    Table 17. Context menu navigation

    Edit action Keyboard shortcut
    Move down in a context menu. Tab or Down Arrow
    Move up in a context menu. Shift+Tab or Up Arrow
    Complete a menu action or open a submenu. Enter
    Close a context menu without completing an action. Esc

    Table 18. Style combo box navigation

    Edit action Keyboard shortcut
    Move down in a combo box. Tab or Down Arrow
    Move up in a combo box. Shift+Tab or Up Arrow
    Complete the selected action, and then put the focus back on the editing area. Enter
    Close the combo box without completing an action, and put the focus back on the toolbar. Esc

    Table 19. Color selection box navigation

    Edit action Keyboard shortcut
    Move forward through colors in a color selection box. Tab or Down Arrow
    Move backward through colors in a color selection box. Shift+Tab or Up Arrow
    Apply the selected color to the current selection in the editing area, and move focus back on the editing area. Enter
    Close the color selection box without completing an action, and move focus back on the toolbar. Esc

    Table 20. Editor navigation

    Edit action Keyboard shortcut
    Bold Ctrl+B
    Underline Ctrl+U
    Italic Ctrl+I
    Select all Ctrl+A
    Insert unordered list (Mozilla Firefox only) Ctrl+\
    Undo Ctrl+Z
    Redo Ctrl+Y
    Copy Ctrl+C
    Cut Ctrl+X
    Paste Ctrl+V
    Move to the previous or next word. Ctrl+Left or Ctrl+Right
    Remove the previous word. Ctrl+Backspace
    Remove the current word. Ctrl+Delete
    Create a line in the same paragraph or list item. Shift+Enter
    Open link window Ctrl+L
    Access the toolbar Alt+F10
    Escape the toolbar and return focus on the editor ESC


    Home page accessibility features

    Use the keyboard shortcuts available for the Home page to navigate the activity stream views and the My Page view.

    The keyboard navigation can be enhanced with additional software, such as the JAWS 13 screen reader, which must be used with Mozilla Firefox 10 ESR.

    If you are using JAWS and Mozilla Firefox, you can skip to different locations in the activity stream views or My Page view by using Ctrl+Insert+Semicolon to access the ARIA landmarks provided. The JAWS Landmarks view, which is accessed by pressing Ins+ ;+Ctrl, offers greater assistance than before in navigating to sections of pages. This dialog can be used to jump to sections in the page without tabbing through numerous fields.


    Keyboard navigation for the activity stream and My Page views

    Table 21. Keyboard shortcuts for navigating the activity stream and My Page views

    Action Keyboard shortcut
    Close pop-up window (the focus must be on the window). Esc
    Open menu (the focus must be on the menu). Enter
    Close menu (the focus must be on the menu). Esc
    Move up through menu options. Up Arrow
    Move down through menu options. Down Arrow
    Select a menu option (the focus must be on the menu option). Enter

    In this release of IBM Connections, the navigation sidebar is split into three toolbars. You can navigate the items in each group using the arrow keys. Press Tab to navigate between the groups.

    For the calendar items in the Activities widget, the mechanism and keys are the same as for the drop-down menus. However, when a date has multiple entries associated with it, after pressing Enter to open the pop-up window for the date, you use the Tab key rather than the arrow keys to navigate through the items in the window.

    To display the Profiles business card anywhere in the Home page application, move the focus to the user name, and then press Ctrl+Enter to display the card.


    Profiles accessibility features

    Accessibility features help users who have a physical disability, such as restricted mobility or limited vision, to use information technology products successfully.


    Keyboard navigation

    Table 22. Keyboard shortcuts for the Things in Common widget

    Action Keyboard shortcut
    Move from one twistie to the next Tab
    Expand a twistie Enter or mouse click


    IBM and accessibility

    See the IBM Accessibility Center for more information about the commitment that IBM has to accessibility.


    Search accessibility features

    Use the keyboard shortcuts available for search to navigate the Advanced Search and the Search Results pages.


    Keyboard navigation for Search

    In Microsoft Internet Explorer and Mozilla Firefox, press Alt+Shift to activate the access key. For example, pressing Alt+Shift+A skips the focus to the Activities tab when you are on the Search Results page.

    To access the Advanced Search page, use the following keyboard shortcuts:

    1. Focus on the Search menu by navigating to it using the Tab key, or by using virtual PC cursor mode.

    2. Press Enter to open the Search menu.

      JAWS users must turn off virtual PC cursor mode to activate the Search menu.

    3. Use the Down Arrow to navigate to the Advanced option.

    4. Press Enter to select the Advanced option.

    To submit a search on the Advanced Search page, ensure that the focus is on the Search button and press Enter.

    Use the keyboard shortcuts listed in the following table to navigate and work with search results.

    Table 23. Keyboard shortcuts for navigating the Search Results page

    Action Keyboard shortcut
    Display search results from Activities. A
    Display search results from Blogs. B
    Display search results from Communities. C
    Display search results from Bookmarks. D
    Display search results from Files. F
    Display search results from Forums. G
    Display all search results. N
    Display search results from Profiles. P
    Display search results from Status Updates. S
    Display search results from Wikis. W
    Select a search result (the focus must be on the search result). Enter

    To navigate the tag collection:

    • When it is displayed as a cloud, pressing the Tab key gives focus to the first tag in the cloud. Use the arrow keys to move directly to the tag to select, and then press Enter.

    • When it is displayed as a list, pressing the Tab key gives focus to the first tag in the list. Use the arrow keys to move down the list to the tag to select, and then press Enter.

    To use the People slider, skip the focus to the slider and press the Left Arrow and Right Arrow keys to adjust the size of the display.

    Uploading a file

    There is more than one way to upload a file. Which method to use depends on what you are trying to achieve. Refer to the table to review your options when uploading a file.

    Table 24. Different ways to upload a file to IBM Connections

    Application Description
    Files

    Files provides a common repository for storing files you want to share with others. Depending on the access you assign, users can view or update files you share with them. Send email notifications to others about files you have uploaded, or include links to the files in blogs, activities or forums.

    Activities

    Files you upload to Activities are available only within the context of the activity. Activity users can view or download the file. When the activity is complete, the file is no longer available. If you want activity users to be able to revise a file or have access to it after the activity is complete, upload the file to Files and link to it from the activity instead.

    Wikis

    Files you upload to Wikis are available for users of the activity. Users with sufficient access can view or download files from the wiki. If you want to use version control and the ability to comment on a file, upload the file to Files and link to it from the wiki.

    Blogs

    Files you upload to Blogs are available for use in the blog. You generally upload something like an image file to insert into an entry. If you want to post a file in a blog entry, upload the file to Files and link to it from the blog entry.

    Administrator help

    Administration and configuration help documentation is on the IBM Connections wiki.

    Almost all the administration, configuration, and development tasks for IBM Connections are performed using commands, configuration properties, and the IBM WebSphere® Application Server Integrated Solutions Console. These tasks are documented in the IBM Connections wiki. The exceptions is moderation, which administrators can manage from the IBM Connections user interface. The documentation for moderation features is included in the administration topic Moderation overview. To see the administration documentation, follow the link in the page footer to the IBM Connections wiki.

    The help topic is not available

    The web address you entered or the link you clicked is not returning the help topic that you want. The format of the web address may be incorrect, the topic may be part of the help for an application that you do not have installed, or the topic may have been removed.

    What to do next:

    • Click here to return to the main help overview page.

    • Click a link in the table of contents to retrieve another topic. You can expand the sections to see all of the help topics available.

    • Search for what you are trying to find using the Search bar. You can narrow the scope to search the help of a single application by clicking Search scope, then New to choose which sections you want to search, and then click OK twice to create and save the search scope.
      Tip: If you apply a search scope, remember to switch back to searching all topics if you want to find something outside that scope.

    Activities

    Organize content and prioritize tasks related to a project goal.


    What.s new?

    Find out what features have been added since the last release.


    Get Started

    Get around in Activities

    Log in to Activities to open and create activities, and post entries to your activities.

    The Activities home page might be sparse when you first begin using activities. As you create activities or are added to other people's activities, this page becomes busier. To help you navigate the page, the following table lists the views that are available:

    Table 25. Activities views

    View Description
    My Activities Lists the activities that you created or were added to as a member, including private community activities. This view displays public activities if you are the creator or are a member of the public activity. This view is the default view.
    Completed Lists the activities that have been marked complete. Each activity is created with a goal in mind. After that goal is reached, the activity is marked complete. Completed activities are removed from the My Activities view.
    Tuned Out Activities Lists the activities that you have tuned out of. If you belong to an activity that you are not interested in, you can tune out of the activity to remove it from your My Activities view.
    Trash Lists deleted activities to which you belong before they are permanently removed.
    Prioritized Activities Provides links to activities that you have marked as having a high or medium priority. As your list of activities begins to grow, it is helpful to prioritize them by importance to you. Prioritization settings are unique to each user; no other members can see these collections. Marking your most valued activities as High Priority enables you to quickly access them from the High Priority view.
    Public Activities Lists activities to which you have access even though you are not listed as a member. Public activities can be viewed by anyone who has access to the Activities server. Active, completed, or deleted public activities are only available from the Public Activities section. This view also lists public or moderated community activities.
    Tags Lists all the tags assigned to your activities. You can choose how the tags in the tag collection are displayed: in a list or a cloud. A tag list displays the tags in a list starting with the most popular tags first. A tag cloud visualizes the popularity of the tags in the collection by grouping the tags together and displaying the most frequently used tags in larger, darker text and less often used tags in smaller, lighter text. Within an activity, the Tags view displays all of the tags assigned to the activity entries.

    You can sort the views by recency, due date, name.

    The following tabs are available from the views:

    Table 26. Activities tabs

    Tab Description
    Activities Lists the activities that you created or were added to as a member. This tab is the default tab. From within an activity, you can click this tab to exit the current activity and return to the My Activities view.
    To Do List Lists the open to-do items assigned to you from all of your activities. This tab is a good place to go to see what actions you need to take to complete your projects.
    Activity Templates Lists activity templates that you created or that are being shared with you by other members.
    Recent Updates Displays a list of recent changes that have been made to activities in the My Activities view.

    The view displays updates made to public activities if you are the creator or are a member of the public activity. Within an activity, you can click Recent Updates from the navigation bar to open a view that lists the recent changes made to the current activity.

    Are you finding that you do not see much when you open the Activities application? Add some content by starting an activity! To begin, identify a goal, such as creating a presentation, resolving a bug, or researching a topic. Create an activity to track that goal. You can then add entries to the activity to capture required tasks, store associated documents, and assemble the people required to reach the goal.

    What's new in Activities?

    Find out what is new and what changed in Activities.

    • Activity members are now displayed in a Members view within the activity instead of in a Members section in the navigation pane.

    • Standard activity owners can go to the Members view to make an activity public.

    • Titles and descriptions in activity entries are automatically saved so that if you are unexpectedly disconnected from the application, you do not lose your latest changes.

    • In an activity entry, you can link to files and folders in the Files application.

    • Activity owners can convert an entry into a to do item.

    Frequently asked questions in Activities

    This topic lists the questions that Activities users ask most often and provides brief answers.

    What is an activity?

    An activity is a place where the people involved in a project can share information, assign tasks, and share resources, such as files, tools, and websites.

    What is a community activity?

    If Communities is deployed in your enterprise, you can create an activity from within the Communities application. A community activity can help a community work together to reach a specific goal. If the community from which the activity is created is a public or moderated community, then the activity is also public. If the community is private, then the activity will also be private. Community activities are displayed in the Activities views. When you open a community activity, information about the community to which it belongs is displayed in a community card in the navigation pane. The community card includes links that you can click to switch to the Communities application and work with the associated community.

    Can I turn a standard activity into a community activity?

    There is no automatic way to transform an activity. However, you can perform the following steps to start a community activity that contains most of the content in a standard activity.

    1. From Activities, save the standard activity as an activity template.

    2. From the community, start a new activity. Expand Template options, and then click Pick an Activity Template to choose the template you created in the previous step.

    3. To prevent confusing the standard and community versions of the activity, either delete the original activity if it is no longer needed or specify a different name for the community version of the activity.

    The members from the original activity cannot be added to the community version of the activity. The membership list of the community activity is determined by the membership list of the community.

    How do I know which type of activity I am viewing?

    Both standard and community activities are displayed from the My Activities view in the Activities application. The text Community Activity is displayed next to the title of a community activity. From within an activity, you know that you are viewing a community activity if a community card is displayed first in the navigation pane. Otherwise, you are viewing a standard activity.

    What is a tag?

    A tag is a single-word term that you assign to an activity or entry. All added tags are displayed in a tag collection that can be displayed as a list or a cloud. You can click a tag in the tag collection to retrieve a list of entries or activities that use the same tag.

    What are the benefits of using tags?

    • Find content that you added. When you categorize entries or activities with a single word that you define, it makes it easier to find the entry or activity later because the tag gets added to the tag collection. From an individual activity or an activities view, you can click the tag in the tag collection to retrieve the associated entry or activity.

    • Find related content. Not only is the entry or activity that you tagged returned when you click a tag in the tag collection, but related activities or entries are also returned. Anything tagged with the same term, either by you or someone else and to which you have access, is returned. In this way, tagging helps you to discover new and potentially useful information.

    • Identifying trends. Tagging also makes it easier for you to determine what your colleagues are working on because the tag collection visualizes the most popular tags. The tag cloud displays the tags that are used most often in a larger, bolder font. The tag list displays the tags that are used most often first in the list. As a result, one glimpse at the tag collection can tell you what the members of your activities are most interested in.

    What is a custom field?

    Custom fields are fields that you can add to an entry to collect specific types of information. The following field types are supported:

    • Date. Stores a date value. You can type a date into the field or select a date from the calendar control that is displayed when the field is given focus.

    • Person. Stores a name. When you begin to type a person's name into the field, a list of names from the directory is displayed. You can choose a name from the list or continue to type the name or email address of the person.

    • Text. Stores unformatted text.
    You can add any number of these field types, and then customize them by changing the field labels. By default, each entry is named after its field type. For example, the date field is named Date. You can then change the field label to reflect the information that you want to collect in the Date field; you could rename the field to Deadline, for example. By adding several new custom fields, and renaming them, you can create a custom entry.

    What is an entry template?

    An entry template is a prototype of an entry. Because you can add custom fields to an entry, you can also save a customized entry as an entry template, so that you can use it again later.

    What is an activity template?

    An activity template is a prototype of an activity. You can use a template to capture the required steps, contacts, resources, and tools used to complete a common process. After you create the template, you can create multiple activities from it for each project you begin that uses the process. You can create a template from a community activity and a community activity from a template. However, you cannot associate member information with a community activity template.

    Why am I unable to drag and drop an entry?

    You may not have permission to edit the entry. You can only move entries that you can edit. Owners can drag and drop any entry and authors can drag and drop only entries that they created. A quick way to determine whether you have permission to move an entry is to mouse on the entry. If you can move it, a drag handle is displayed. If you cannot move it, nothing is displayed. To help you determine

    ...where you can drop an entry, a drop box is displayed when you drag the entry to an area where it can be dropped.

    How can I add structure to my activity?

    Use the Activity Outline view. By default, the view has a flat structure. You can add structure to it by grouping entries together into sections.

    What is a section?

    A section functions as a container for a set of activity entries. When you add sections to an activity, you add structure to the activity. Rather than letting the structure be defined by an entry thread or the date on which entries were added, you can use sections to group entries together in a way that make sense to you and other activity members. You cannot create a multi-layered hierarchy in an activity; you cannot add sections to a section.

    Why is the My Activities view empty?

    The My Activities view displays all of the active activities to which you have access. This view is empty in the following cases:

    • You are a new user. This view is empty until you create an activity or are added to an activity by someone else.

    • Your activities were automatically marked complete due to inactivity. If you are not a new user and have participated in activities before, but they are not being displayed in your My Activities view, look for them in the Completed view. By default, the server marks an activity complete if it has not been updated in 90 days.

      If an activity has been marked complete, but should not have been, it can be restored to the My Activities view by the activity owner. If you are not the activity owner, ask the owner to restore it. (You can find out who owns it by opening the activity from the Completed view and expanding the Members section.) If you are the owner, to restore the activity, find it in the Completed view, click More to expand the activity description, and then click Restore.

      Your system administrator can change the time interval after which activities are automatically marked complete.

    • If there is an activity that you know you have accessed before, but you cannot find it in the My Activities view, try looking in the Active view in Public Activities. Public activities have no membership list, but instead are accessible to anyone who has access to the Activities server. Public activities only display in the My Activities view if you are the creator or are a member of the activity.

    How can I prevent unwanted activities from cluttering up my views?

    One approach is to pare down the activities that are displayed in your My Activities view. Always mark activities for which you have accomplished the goal as completed. This action removes them from the My Activities view. You can also tune out of an activity; when you do so, it is removed from your My Activities view.

    Another approach is to assign priority levels to your activities. For example, you can mark important activities as having a high priority. When you do so, they are added to the High Priority view. You can then go straight to that view to find out what is new in the activities that you most care about. The best part is that the priority settings that you specify are private; the priority views that result from them are unique to your environment. In other words, your manager will not find out if you tune out of an activity.

    How do I determine whether to delete, complete, or tune out of an activity?

    • Delete. Only delete an activity that you and all of the activity members no longer need. Deleting the activity moves it to the Trash view. You can restore a deleted activity from the Trash view, but only until the trash is emptied. Trash removal is done on a schedule that is specified by your administrator. You can only delete an activity that you own.

    • Complete. After you finish using an activity to track the progress of a work project, mark it complete. Completing an activity moves it to the Completed view. You can always reference completed activities from the Completed view; this view is not emptied. You can only complete an activity that you own.

    • Tuning out. If you are not interested in an activity, you can tune out of it to prevent it from showing up in your main views. The importance that you designate for your activities is private, so no other members will know if you tune out of an activity. Members can still send you notifications about specific entries. Any member role can tune out of an activity.

    Why am I unable to delete a member from an activity?

    You must be an author or owner of an activity to remove a member. Owners can remove any member. An author can remove readers and other authors only. You can remove yourself from an activity, but only if you are not the sole remaining owner of the activity. If that is the case, change the role of an existing member to Owner, and then delete yourself. You can only edit the member list of a community activity if the members were added individually and not as part of a full community's membership, and you can only remove authors and readers. If the full community membership list was given access to the activity, you must remove the member from the associated community. To remove a member, click Members in the navigation pane, click Remove for the person's name, and then click OK. After you remove a member, entries created by that member can still be viewed by the remaining members, and can be edited or deleted by the owners of the activity.

    What is an activity?

    Activities is a web-based collaboration tool for collecting, organizing, sharing, and reusing work related to a project goal. Use Activities to organize your team's work around project tasks, rather than around the many tools that you use to perform them.

    Members of an activity interact in an online location in which they create, collect, and share a set of ideas and resources to support a project goal. Examples of projects that you could use an activity to track include:

    • Driving a sales process to a close

    • Prepare for an important meeting

    • Writing a report for a client

    • Hiring a new employee

    An activity is a way for you to organize your work and collaborate with others in a shared web space. You can start an activity from a single idea or fragment of an idea in an email. Because it is easy to invite new members, you can quickly pull together the people and resources you need to get the job done. You can post messages, share files and links to websites, and create and assign to-do items.


    Community activities

    You can also create community activities. A community activity is an activity created in the Communities application. Community activities are included in the standard Activities views and can be opened and edited from the Activities application. The only thing different about a community activity is its membership. You can create a community activity with a membership list that reflects the membership list of the community or you can choose to create a community activity whose members are a subset of the community. But, the member list of the activity cannot contain anyone who is not also a member of the owning community. In addition, the public status of a community activity is determined by the community to which it belongs. If the community is public or moderated, all of its associated activities are public. If the community is private, all of its associated activities are private.

    You can create content directly in an activity, or download extensions from the IBM Connections Catalog page that let you add content from the tools you already use: email messages, IBM Sametime chats, and word processing documents, to name a few. To access the catalog, go to the following external website:

    https://greenhouse.lotus.com/catalog (Opens in new window)

    Activities are a good way to improve awareness and coordination in teams. When a member shares a design document, meeting agenda, or spreadsheet to an activity, not only is that item immediately available to everyone else on the team, it is also placed alongside all of the project's other resources. Team members always know that they can go to the activity to find out about the latest project happenings and see who the recent contributors are.


    Opening an activity

    Open an activity to work with its entries and members.

    Your active activities are displayed in the My Activities view.

    To open an activity and display its entries, complete the following steps:

    1. If the My Activities view is not open, click My Activities from the navigation pane.

      From within an activity, you do not see My Activities listed in the navigation pane; click the Activities tab first.

    2. Click the title of the activity.

      If the activity that you are looking for is not listed on the current page, use the Next to page through the activities. Alternatively, you can increase the number of activities displayed in the current page to up to 100 by clicking a number at the after the activities list. You can filter the list by expanding Tags, and then clicking a tag assigned to the activity.

      Tip: Consider designating activities that you use often as high priority, which makes them easier to find; you can open the Prioritized Activities > High Priority view to see a list of only the activities that you deem to be important.


    Starting an activity

    Create an activity to provide a place for the people involved in a project to share information, to assign tasks, and to share resources, such as tools, websites, and files.


    About this task

    Create an activity is easy: just click a button and fill out a form. There are no required fields. You can edit the activity later to add or change information.

    No special access is needed to create an activity. If you have access to the Activities server, you can create an activity.

    You cannot use this procedure to create a community activity. You can only create a community activity from the Communities feature. See Creating a community activity in the Communities Help for more information.

    1. From the My Activities view, click Start an Activity.

      If you have an activity open, then you do not see the Start an Activity button in the navigation pane. Click the Activities tab to exit the opened activity first.

    2. In the Name field, type a short name that describes the purpose of the activity, for example, a project name.

      The activity name is displayed in the subject of the notification sent to the people you add to the activity as members. If you do not provide a name, the activity is given the name Untitled. You can give it a name later by editing the activity.

    3. In the Tags field, type a tag term. As you type, a list of matching tags from the tag collection is displayed. Click a tag to add it, or keep typing to add a tag that is not in the list. Separate multiple tags with commas.

      A tag is a single-word label or keyword that you assign to an activity to categorize it. After the activity is saved, the tag is added to the tag collection. Later, you can use the tag to find this activity by clicking the tag from the tag collection. Not only is this activity returned in the resulting list, but any similarly tagged activities are included also, thus helping you to discover related content. Keep in mind that the tag collection is composed of tags that are created by you and your colleagues; if no one has created any tags yet, you do not see a list of matching tags as you type into this field.

    4. Add members to the activity.

      • Select Person, Group, or Community from the Members drop-down list.

      • If you want to add a member to a role other than the default role of Author, click the down-arrow next to the Author field, and then select Owner or Reader. The access level options are defined as follows:

        Author

        Can view content and add entries.

        Owner

        Can add content, view and edit all entries, and manage the membership of the activity.

        As the creator of the activity, you are automatically added as an owner.

        Reader

        Cannot contribute to an activity; access is restricted to only viewing content.

      • Begin typing the name of the community or the name or email address of the person you want to add into the text field. Alternatively, you can search for a particular group by clicking Browse Groups, and then entering a keyword for the group and clicking Find Groups. Click the group you want and then click Add. If the group contains nested groups within it, you can either add the parent group or select a nested group. Use the breadcrumb trail to switch between levels of nested groups

        If the product is configured to hide email addresses, then no matches are returned when you type an email address into the field; type person's name instead.

      The group feature is available upon request. Contact your administrator for information.

    5. In the Activity goal field, add a description of the activity. Provide a sentence or two that summarizes the goal of the activity, its audience, or the type of content that you want members to add to it.

      Provide enough information about the goal to help members distinguish among activities with similar names. The information in this field is searchable and is displayed in the notification message that members receive when they are invited to join the activity.

    6. In the Due date field, add a date by which this activity must be completed. Either type the date or click the field to select a date from the calendar control.

    7. To create the activity from a template, perform the following steps.

      A template captures the tasks required to complete a specific job. For example, a patent template might link to the files, DBs, tools, or Web sites that an inventor seeking a patent would need. It might also capture a list of to-do items that an inventor would need to complete as part of the patent application process.

      1. Click Pick an Activity Template, and then select a template from the list. You can type a template name into the field to narrow the list. When you select a template, a description of the template is displayed. If you select not to use an available template, select None from the list.

      2. If you want to seed the member list with the members defined in the template, select Use members from template.

    8. Click Save to finish creating the activity. After the activity is created, the server sends an email message or a notification to the Updates tab of the Home page feature to notify the people that you added as members about the activity.


    What to do next

    You can now add entries to the activity.

    What is an entry?

    An activity entry is a unit of content that you add to an activity. The types of content that you can add include text, files, and bookmarks.

    You can also add to-do entries and custom entry types that you define.

    Each entry includes a title and some type of content. You can also add an optional text description and tags to an entry. The description text and tags can be searched to help you find the entry later.

    By default, entries in an activity are shared with all members of the activity. You can hide an entry from other members by marking it private.

    You can add the following types of entries to an activity:

    Entry type Description

    Standard You can add a formatted text message, one or more file attachments, and one or more bookmarks which reference web pages. You can also add one or more custom fields to the entry to create name, text, and date fields. After adding attachments, bookmarks, and new fields, you can change the field labels to reflect the information that is being provided in the fields, file attachments, and bookmarks.

    To Do Item A to-do entry that you author within an activity. You can include a due date and assign the entry to a specific member of the activity. When the task is completed, you can select the to-do item check box to mark it completed. Like a standard entry, you can add one or more file attachments and one or more bookmarks which reference web pages to a to-do item. You can also add one or more custom fields to the to-do item to create name, text, and date fields. After adding attachments, bookmarks, and new fields, you can change the field labels.

    Custom An entry created from an entry template. An entry template is a prototype of an entry. If you create an entry that you want to reuse, you can save it as an entry template, and use the template the next time you create an entry. For example, if you are using an activity to collect team member status reports, you can create a standard entry, and add new fields to it to collect team member names, status report dates, and other information. You can then save that standard entry as a new entry template named Status Report. After it is saved, when you and other activity members create an entry to capture status information, you can choose the entry template named Status Report from the list of entry types to create. Custom entries can be created and reused within one activity only.

    Comment To add a quick comment to an activity, create a standard entry and add the comment to the Title field. You can also add a comment as a response to another entry. When creating a comment as a response to an entry, you can add one or more file attachments and one or more bookmarks, but you cannot add custom fields.

    Related Activity A reference link to an existing activity. The membership list and due date of the related activity can differ from those of the main activity. You must be a member of the related activity to be able to access it through a related activity link.

    Notes® document A reference to an existing Lotus Notes® document. In Notes 8 and later, you can add a Notes document to an activity by dragging it to the Activities sidebar. In Notes 7.x, you can add a Notes document to an activity by using the IBM Lotus® Connections Plug-in for Lotus Notes 7/8. To open the document, members of an activity must have access to the original document.

    Mail message A rich text rendering of an email message that was added from the Lotus Notes client. After being added to the activity, you can not edit the content of the mail message. In Notes 8 and later, you can add a Notes mail message to an activity by dragging it to the Activities sidebar.In Notes 7.x, you can add a Notes mail message to an activity by using the IBM Lotus Connections 2.0.1 Plug-in for Notes 7/8.

    Sametime chat transcript A transcript from an IBM Sametime chat. Add a chat to an activity from the Sametime client using the IBM Connections Plug-in for IBM Sametime.

    You cannot add more than 2000 entries to a single activity. As you approach this maximum number, you receive warnings that inform you that you are reaching the limit.

    You can download the plug-ins for Sametime, Notes, and other extensions from the IBM Connections Catalog. To access the catalog, go to the following external website:

    https://greenhouse.lotus.com/catalog (Opens in new window)


    How do I add an entry?

    You can add an entry to an activity to comment on a topic, make an announcement, ask a question, share a file, or share a web address with the team.

    You must be an author or an owner of the activity to add entries to it.

    As you create or edit an entry, your work is automatically saved every 5 minutes, unless the administrator changes the interval. If you unintentionally leave an entry in an unsaved state when you close your browser, the next time you log in, a notification appears in the My Activities view reminding you that you have an unsaved entry. From that notification message you can click View to open the entry and resume work on it, or Discard to delete the entry. If no action is taken on the unsaved entry, the message appears again the next time the you log in.

    To add an entry, open an activity, and then complete the following steps:

    1. Click Add Entry.

    2. In the Title field, type the title of the entry.

    3. In the Tags field, type a tag term. As you type, a list of matching tags from the tag collection is displayed. Click a tag to add it, or keep typing to add a tag that is not in the list. Separate multiple tags with commas.

      A tag is a single-word label or keyword that you assign to an entry to categorize it. After the entry is saved, the tag is added to the tag collection for the activity. Later, you can use the tag to find this entry by clicking the tag from the tag collection. Not only is this entry returned in the resulting list, but any similarly tagged entries are included also, thus helping you to discover related content. Keep in mind that the tag collection is composed of tags created by you and your colleagues; if no one has created any tags yet, you do not see a list of matching tags as you type into this field.

    4. You can add content to the entry by clicking the following links:

      Add File > Attach File

      Adds a file to the entry. Click Browse to locate the file.

      The maximum size limit for file attachments is 10 MB by default, but this value can be changed by your administrator.

      Add File > Link to File

      Adds a link to a file stored in the Files application. Files must be installed at your deployment.

      1. Select the type of file to share from the options.

        Table 27. File-sharing options

        Option Description
        Recent Files Files recently uploaded to the Files application.
        Pinned Files Files that you marked as prioritized in the Files application.
        My Files Files that you uploaded to the Files application.
        Shared With Me Files shared with you from the Files application.
        Other People's Files

        Files that are shared with you or the files of another person that are public from the Files application.

        Pinned Folders Files from folders that you marked as prioritized in the Files application.
        My Folders Files from your personal folders in the Files application.
        Shared Folders Files from shared folders in the Files application.

      2. Select a file or files from the list that displays, and click OK.

      Add File > Link to Folder

      Adds a link to a folder stored in the Files application. Files must be installed at your deployment.

      1. Select the type of folder to share from the options.

        Table 28. Folder-sharing options

        Option Description
        Recent Folders Folders recently uploaded to the Files application.
        Pinned Folders Folders that you marked as prioritized in the Files application.
        My Folders Folders that you own in the Files application.
        Folders Shared with Me Folders shared with you from the Files application.
        Public Folders Folders in the Files application that are visible to everyone.

      2. Select a folder or folders from the list that displays, and click OK.

      Add Bookmark

      Adds a web address to the entry. Set the title of the web page into the required Bookmark title field, and then copy the web address into the field that begins with http://.

      Add Custom Fields > Date Field

      Adds a Date field to the entry. When you click the empty field, a calendar control is displayed. You can either type the date into the field or pick a date from the calendar control.

      Add Custom Fields > Person Field

      Adds a Person field to the entry. As you type a name into the field, a list of names from the directory is displayed. You can choose a name from the list or continue typing the person's full name or email address.

      If you type the name of a person from within Activities, you must pick from the typeahead to add the person properly instead of clicking the Add Members. This displays the proper business card.

      Add Custom Fields > Text Field

      Adds a Text field to the entry.

      You can add as many types of fields as you want and you can add fields of the same type multiple times. If you want to remove a field that you added, click the X for a field to delete it.

    5. Optional: Rename a field that you added by clicking the field label to edit it.

      After you add a file, bookmark or custom field to the entry, you can change the name that is associated with the field by default to a name that better describes the purpose of the field. For example, if you are using the entry to provide review comments, you might want to add two name fields, and change the name of one field to Author and the other to Reviewer. You could also add a date field labeled Review By Date, and then add a file attachment with a field label of Document To Review.

    6. In the Description field, describe the entry or add entry content. You can use the toolbar buttons to format the added text.

    7. To add this entry to a specific section of the activity, click the arrow for the Section field, and then select the section from the list.

    8. To hide the entry from other members, select Mark this entry private.

    9. If you want to notify activity members about this entry:

      1. Select Notify people of this entry.

      2. Do one of the following:

        • Standard activity:

          • To notify everyone, select the All individual members of this activity check box.

          • To notify specific people, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

          • If the activity has been shared with a community, then you can notify a subset of the community members by selecting Community: community_name where community_name is the name of the community, and then selecting the boxes next to the names of the members to notify.

        • Community activity to which all community members were added:

          • Select the boxes next to the names of individual members that you want to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

            If the activity has more than 500 members, you can click Next to see additional names.

            The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

        • Community activity to which only a subset of community members were added:

          • To notify a subset of community members, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

            If the activity has more than 500 members, you can click Next to see additional names.

            The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

          • To notify the community owners only, select community_name (community owners) where community_name is the name of the community.

      3. If you want to add a comment that is displayed in the notification that is sent to the members, add it to the Notify Message field.

        By default, the notification indicates to inform the member about this entry.

    10. Click Save to finish adding the entry.


    Add a comment

    You can add a quick comment directly to an activity or as a response to an existing entry.

    To add a comment:

    1. Do one of the following:

      • To add a stand-alone comment, open the activity, and then click Add Entry. If your comment is short, type it into the Title field. Otherwise, type it into the Description field.

      • To comment on someone else's entry, open the entry, click Add Comment, and then type your comment into the Comment field.

    2. Click Save.


    Add a bookmark to an activity

    Use the bookmark control provided by IBM Connections to add an Add Bookmark button to your web browser. After the button is added to your browser, when you find a web page to add to an activity, you can click the button to add it as a bookmark to an existing activity.

    Before adding a bookmark to an activity using the button, add the bookmark control to your browser. To do so, complete the following steps:

    1. Under Tools in the IBM Connections footer, click How to Bookmark.

    2. Follow the instructions on the page to add the Add Bookmark button to the toolbar of your web browser.
    To add a bookmark from a web page, complete the following steps:

    1. From the web page to add as a bookmark to an activity, click the Add Bookmark button.

    2. Edit the Title and Description fields to reflect the content of the bookmark.

    3. In the Tags field, type a tag term. Separate multiple tags with commas. A tag is a single-word label or keyword that you associate with the bookmark to help you identify it and find it later.

    4. To specify the activity to which to add the bookmark, click the Add to Activities tab, and then select the activity from the list displayed in the Activity field.

    5. Optional: If you want to hide the bookmark from the other activity members, select Private.

    6. Optional: If you want to add an additional description for the bookmark, add it in the Additional description field.

    7. Click Save to add the bookmark to the activity.


    Add a response to an entry

    You can add a response to an entry in an activity to comment on a topic, make an announcement, ask a question, provide feedback on an existing entry, share a file, or share a web address with the team.

    To add an entry, open an activity, and then complete the following actions:

    1. From the entry to which you want to create a reply, click Add Comment.

      If you cannot see the Add Comment link, then your view may be collapsed. Click the entry title or More to expand the entry.

    2. In the Comment field, add your response. You can use the toolbar buttons to format the added text.

    3. You can add content to the entry by clicking the following links:

      Add File > Attach File

      Adds a file to the entry. Click Browse to locate the file.

      The maximum size limit for file attachments is 10 MB by default, but this value can be changed by your administrator.

      Add File > Link to File

      Adds a link to a file stored in the Files application. Files must be installed at your deployment.

      1. Select the type of file to share from the options.

        Table 29. File-sharing options

        Option Description
        Recent Files Files recently uploaded to the Files application.
        Pinned Files Files that you marked as prioritized in the Files application.
        My Files Files that you uploaded to the Files application.
        Shared With Me Files shared with you from the Files application.
        Other People's Files

        Files that are shared with you or the files of another person that are public from the Files application.

        Pinned Folders Files from folders that you marked as prioritized in the Files application.
        My Folders Files from your personal folders in the Files application.
        Shared Folders Files from shared folders in the Files application.

      2. Select a file or files from the list that displays, and click OK.

      Add File > Link to Folder

      Adds a link to a folder stored in the Files application. Files must be installed at your deployment.

      1. Select the type of folder to share from the options.

        Table 30. Folder-sharing options

        Option Description
        Recent Folders Folders recently uploaded to the Files application.
        Pinned Folders Folders that you marked as prioritized in the Files application.
        My Folders Folders that you own in the Files application.
        Folders Shared with Me Folders shared with you from the Files application.
        Public Folders Folders in the Files application that are visible to everyone.

      2. Select a folder or folders from the list that displays, and click OK.

      Add Bookmark

      Adds a web address to the entry. Set the title of the web page into the required Bookmark title field, and then copy the web address into the field that begins with http://.

      Add Custom Fields > Date Field

      Adds a Date field to the entry. When you click the empty field, a calendar control is displayed. You can either type the date into the field or pick a date from the calendar control.

      Add Custom Fields > Person Field

      Adds a Person field to the entry. As you type a name into the field, a list of names from the directory is displayed. You can choose a name from the list or continue typing the person's full name or email address.

      If you type the name of a person from within Activities, you must pick from the typeahead to add the person properly instead of clicking the Add Members. This displays the proper business card.

      Add Custom Fields > Text Field

      Adds a Text field to the entry.

      You can add as many types of fields as you want and you can add fields of the same type multiple times. If you want to remove a field that you added, click the X for a field to delete it.

    4. To hide the response from other members, select Mark this entry private.

    5. If you want to notify activity members about the response, complete the following steps:

      1. Select Notify people of this entry.

      2. Do one of the following:

        • Standard activity:

          • To notify everyone, select the All individual members of this activity check box.

          • To notify specific people, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

          • If the activity has been shared with a community, then you can notify a subset of the community members by selecting Community: community_name where community_name is the name of the community, and then selecting the boxes next to the names of the members to notify.

        • Community activity to which all community members were added:

          • Select the boxes next to the names of individual members that you want to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

            If the activity has more than 500 members, you can click Next to see additional names.

            The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

        • Community activity to which only a subset of community members were added:

          • To notify a subset of community members, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

            If the activity has more than 500 members, you can click Next to see additional names.

            The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

          • To notify the community owners only, select community_name (community owners) where community_name is the name of the community.

      3. If you want to add a comment that is displayed in the notification that is sent to the members, add it to the Notify Message field.

        By default, the notification indicates to inform the member about this entry.

    6. Click Save to finish adding the response.


    Use to-do entries to track tasks

    Use to-do entries to track the tasks that must be completed for your team to meet a specific project goal.

    You can assign a to-do item to a person on your team or leave it unassigned. You can also give it a due date. See Add a to-do entry for more details.

    Each activity has a To Do Items view that breaks down the to-do entries that have been created in that activity. It lists their assignments, due dates, and whether or not they have been completed.

    The To Do List tab of the Activities application retrieves information about the to-do entries from all of the activities that you are a member of. You can view the to-do items in the following ways:

    My To Do Items

    Lists all to-do items assigned to or created by you.

    Incomplete To Do Items

    Lists all incomplete to-do items. This list includes to-do items that you created or that were assigned to you as well as to-do items that were created by or assigned to others.

    Completed To Do Items

    Lists all completed to-do items. This list includes to-do items that you created or that were assigned to you as well as to-do items that were created by or assigned to others.


    Add a to-do entry

    You can add one or more to-do entries to an activity and assign them to members of the activity. A to-do entry is a special type of entry that represents a task to be completed. You can assign a to-do item to any individual member of an activity and select a due date for it. You can add one or more to-do entries to an activity in order to manage the activity work. You can view all of the to-do entries for an activity from the To Do Items view.

    As you create or edit a to-do entry, your work is automatically saved every five minutes, unless the administrator changes the interval. If you unintentionally leave a to-do entry in an unsaved state when you close your browser, the next time you log in, a notification appears on each page reminding you that you have an unsaved entry. From that notification message you can click View to open the to-do entry and resume work on it, or Discard to delete the to-do entry.

    To add a to-do entry:

    1. Open an activity.

    2. Do one of the following actions

      • To add the to-do entry directly to the activity, click Add To Do Item.

      • To add the to-do entry as a reply to another entry, open the entry, and then click Add To Do Item.

    3. Type a short task description into the To Do field. This task description becomes the text label that identifies the entry and is displayed in all views that include the entry.

      If you want to add attachments, bookmarks, or custom fields, to assign the to-do item, or to specify a due date, click More Options.

    4. In the Tags field, type a tag term. As you type, a list of matching tags from the tag collection is displayed. Click a tag to add it, or keep typing to add a tag that is not in the list. Separate multiple tags with commas.

      A tag is a single-word label or keyword that you assign to an entry to categorize it. After the entry is saved, the tag is added to the tag collection for the activity. Later, you can use the tag to find this entry by clicking the tag from the tag collection. Not only is this entry returned in the resulting list, but any similarly tagged entries are included also, thus helping you to discover related content. Keep in mind that the tag collection is composed of tags created by you and your colleagues; if no one has created any tags yet, you do not see a list of matching tags as you type into this field.

    5. By default, the task is assigned to Anyone (shared), meaning any member of the activity can perform the task, and then check it off after it has been completed. To assign the to-do item to a specific member, click Choose a person, and then perform one of the following actions:

      • Standard activity:

        • To assign the to-do entry to a specific person, select Individual activity members, and then select the persons name from the list. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

        • If the activity has been shared with a community, then you can assign the to-do item to a community member by selecting Community: community_name where community_name is the name of the community, and then selecting the persons name from the list.

        • If a person is a member of a group that belongs to the activity, then add the person as an individual activity member before you can add them.

      • Community activity to which all community members were added:

        • Select the persons name from the list. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

          If the activity has more than 500 members, you can click Next to see additional names.

          The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

      • Community activity to which only a subset of community members were added:

        • Select Individual activity members, and then select the persons name from the list. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

          If the activity has more than 500 members, you can click Next to see additional names.

          The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

        • To assign the to-do entry to a community owner, select community_name (community owners) where community_name is the name of the community, and then select the owners name from the list.

    6. In the Due date field, assign a date by which the to-do entry must be completed. Type a date or choose a date from the calendar control.

    7. You can add content to the entry by clicking the following links:

      Add File > Attach File

      Adds a file to the entry. Click Browse to locate the file.

      The maximum size limit for file attachments is 10 MB by default, but this value can be changed by your administrator.

      Add File > Link to File

      Adds a link to a file stored in the Files application. Files must be installed at your deployment.

      1. Select the type of file to share from the options.

        Table 31. File-sharing options

        Option Description
        Recent Files Files recently uploaded to the Files application.
        Pinned Files Files that you marked as prioritized in the Files application.
        My Files Files that you uploaded to the Files application.
        Shared With Me Files shared with you from the Files application.
        Other People's Files

        Files that are shared with you or the files of another person that are public from the Files application.

        Pinned Folders Files from folders that you marked as prioritized in the Files application.
        My Folders Files from your personal folders in the Files application.
        Shared Folders Files from shared folders in the Files application.

      2. Select a file or files from the list that displays, and click OK.

      Add File > Link to Folder

      Adds a link to a folder stored in the Files application. Files must be installed at your deployment.

      1. Select the type of folder to share from the options.

        Table 32. Folder-sharing options

        Option Description
        Recent Folders Folders recently uploaded to the Files application.
        Pinned Folders Folders that you marked as prioritized in the Files application.
        My Folders Folders that you own in the Files application.
        Folders Shared with Me Folders shared with you from the Files application.
        Public Folders Folders in the Files application that are visible to everyone.

      2. Select a folder or folders from the list that displays, and click OK.

      Add Bookmark

      Adds a web address to the entry. Set the title of the web page into the required Bookmark title field, and then copy the web address into the field that begins with http://.

      Add Custom Fields > Date Field

      Adds a Date field to the entry. When you click the empty field, a calendar control is displayed. You can either type the date into the field or pick a date from the calendar control.

      Add Custom Fields > Person Field

      Adds a Person field to the entry. As you type a name into the field, a list of names from the directory is displayed. You can choose a name from the list or continue typing the person's full name or email address.

      If you type the name of a person from within Activities, you must pick from the typeahead to add the person properly instead of clicking the Add Members. This displays the proper business card.

      Add Custom Fields > Text Field

      Adds a Text field to the entry.

      You can add as many types of fields as you want and you can add fields of the same type multiple times. If you want to remove a field that you added, click the X for a field to delete it.

    8. Optional: Rename a field that you added by clicking the field label to edit it.

      After you add a file, bookmark, or custom field to the entry, you can change the name that is associated with the field by default to a name that better describes the purpose of the field. For example, if you are using the to-do item to identify a file required to review, you might want to attach a file to the to-do entry, and change the name of the file attachment field to Document to review. You could also add a text field named Changes to track any updates you make to the file.

    9. In the Description field, describe the entry or add entry content. You can use the toolbar buttons to format the added text.

    10. To add this entry to a specific section of the activity, click the arrow for the Section field, and then select the section from the list.

    11. To hide the entry from other members, select Mark this entry private.

    12. If you want to notify activity members about this entry:

      1. Select Notify people of this entry.

      2. Do one of the following:

        • Standard activity:

          • To notify everyone, select the All individual members of this activity check box.

          • To notify specific people, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

          • If the activity has been shared with a community, then you can notify a subset of the community members by selecting Community: community_name where community_name is the name of the community, and then selecting the boxes next to the names of the members to notify.

        • Community activity to which all community members were added:

          • Select the boxes next to the names of individual members that you want to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

            If the activity has more than 500 members, you can click Next to see additional names.

            The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

        • Community activity to which only a subset of community members were added:

          • To notify a subset of community members, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

            If the activity has more than 500 members, you can click Next to see additional names.

            The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

          • To notify the community owners only, select community_name (community owners) where community_name is the name of the community.

      3. If you want to add a comment that is displayed in the notification that is sent to the members, add it to the Notify Message field.

        By default, the notification indicates to inform the member about this entry.

    13. Click Save.

    14. Do one of the following:

      • If you want to create another to-do item, type it into the To Do field.

      • If you do not want to create another to-do item, click Cancel.

    Work with entries

    You can view, reply to, edit, tag, and manage the entries in an activity.

    The actions that you can perform on an entry depend on your role in the activity and whether you created the entry. Any member of an activity can view a public entry (that is, one that is not explicitly marked private) and can send notifications about the entry to other members. Only authors and owners can tag and reply to entries. Authors can edit, move, and delete their own entries. Owners can edit, move, and delete any entry.


    Move an entry

    You can move an entry to a new location in the same activity or to a different activity. Move an entry when you want to add it to a section, group it with related entries, or sort entries in a specific sequence.

    Owners can move any entry. Authors can move their own entries only. To move an entry to a different activity, you also must be an author or owner of the destination activity. If you move an entry to another activity and the members of the original activity are not members of the other activity, they will lose access to the entry.

    When you move an entry within the current activity, you can move it using either the menu or by dragging and dropping the entry. If you move an entry that has one or more responses, using either method, its responses move with it. You cannot drag and drop entry responses. When you drag and drop an entry, you can only drop the entry before or after another entry; you cannot drop it after an entry's responses to turn it into a response. To move an entry:

    1. From the My Activities view, open an activity and then scroll to the entry to move.

    2. Do one of the following:

      • To move the entry to a different activity, click More Actions > Move.

        If you cannot see the More Actions link, your view may be collapsed. Click the entry title to expand the entry. From the Move to Activity tab, select an activity from the list, and then click Move.

        When moving an entry to another activity, you cannot specify where you want the entry to be positioned in the other activity. Later, you can open the other activity and move the entry within it as a separate step.

      • To move the entry to a section in the current activity, click the Move to Section tab, and then select a section from the list.

        You can also move the entry to a section in the current activity by hovering over the entry until the drag handle is displayed . Hover over the drag handle until the cursor changes from a pointer into a cross hair , and then drag the entry onto the section.

      • To position the entry after another entry in the current activity, click the Reorder in this Activity tab and then select an entry from the list to move the entry after.

        You can also hover over the entry to move until the drag handle is displayed. Hover over the drag handle until the cursor changes from a pointer into a cross hair, and then drag the entry after the other entry.

      • To move a to-do entry to a different entry in the current activity, click the Move to Entry/To Do tab, and then select an entry name from the list.

      • What does it mean if no drag handle is displayed when you hover over an entry? If a drag handle is not displayed, then you do not have the appropriate level of access to drag the entry.

      • Are you unsure about where you can drop an entry? A bold horizontal line is displayed when you drag the entry to an area where it can be dropped.


    Copy an entry

    You can add a copy of an entry to a new location in the same activity or to a different activity. Copy an entry when you want to move it to a section, group it with related entries, or sort entries in a specific sequence, but also want to keep a copy of the entry in its current position.

    Authors can copy their own entries only. Owners can copy any entry. To copy an entry to a different activity, you also must be an author or owner of the destination activity. If you copy an entry that has one or more replies, its replies are copied with it.

    1. From the My Activities view, open an activity and scroll to the entry to copy.

    2. Click More Actions > Copy.

      If you cannot see the More Actions link, your view may be collapsed. Click the entry title to expand the entry.

    3. Do one of the following:

      • To add a copy of the entry to a different activity, from the Copy to Activity tab, select an activity from the list.

        When copying an entry to another activity, you cannot specify where to position the entry in the other activity. Later, you can open the other activity and move the entry within it as a separate step.

      • To add a copy of the entry to a section, click the Copy to Section tab, and then select a section from the list.

      • To add a copy of a to-do entry to the same entry or a different entry in the current activity, click the Copy to Entry tab, and then select an entry name from the list.

    4. Click Copy.


    Notifying members about an entry

    To bring an entry to the attention of members in the activity, you can notify them about the entry. Members whom you notify receive an email message or a notification in the Updates tab in the Home page application that contains the description of the entry and a link to it.

    Any member of an activity can notify other members about any entry in the activity. The server can send notifications to current members of the activity and to anyone who has added a current entry to the activity even if the person is no longer a member.

    Send a notification does not create an entry in the activity.

    To notify members about an entry:

    1. Open an activity and locate an entry to notify someone about.

    2. Click More Actions > Notify Other People.

      If you cannot see the More Actions link, your view might be collapsed. Click the entry title to expand the entry.

    3. Do one of the following:

      • Standard activity:

        • To notify everyone, select the All individual members of this activity check box.

        • To notify specific people, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

        • If the activity has been shared with a community, then you can notify a subset of the community members by selecting Community: community_name where community_name is the name of the community, and then selecting the boxes next to the names of the members to notify.

      • Community activity to which all community members were added:

        • Select the boxes next to the names of individual members that you want to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

          If the activity has more than 500 members, you can click Next to see additional names.

          The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

      • Community activity to which only a subset of community members were added:

        • To notify a subset of community members, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

          If the activity has more than 500 members, you can click Next to see additional names.

          The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

        • To notify the community owners only, select community_name (community owners) where community_name is the name of the community.

    4. Optional: If you want to add a comment to be displayed in the notification that is sent to the members in addition to the entry description, add it to the Notify Message field.

    5. Click Send to send the notification, and then click OK.


    Marking an entry private so that other members cannot see it

    You can mark an entry private if you want to save it to an activity, but do not want to share it with other members. You can mark an entry private when you first post it, or by editing it later.

    Only the creator of the entry can mark the entry private. By default, when you post an entry to an activity, every member of the activity can read it. Marking an entry private lets you maintain a private work space within an activity. For example, you can mark a draft of an entry private until you are ready to share it. You can also mark an entry private if the information is not relevant to other members.

    To mark an entry private, complete the following steps:

    1. Open the activity, find the entry to mark private, and then click Edit.

      If you cannot see the Edit link, your view may be collapsed. Click the entry title to expand the entry. Only an owner of the activity or the person who created the entry can see the Edit link.

    2. Select Mark this entry private, and then click Save.

      Only the person who created the entry can see the Mark this entry private check box.

      After you save the entry, other members are unable to see it when they open the activity. You can determine which entries are private because they are prefixed with the term [Private].


    What to do next

    You can later share the entry with other members by editing the entry again, and clearing Mark this entry private.


    Add a file to an activity entry

    You can add a file to an activity entry, whether it is a standard entry, a to-do entry, a custom entry, or an entry comment.

    You must be the author of the entry or an owner of the activity to add a file to the entry.

    Files that you attach to a standard or community activity are stored within the activity, and cannot be shared outside the membership of the activity. If you want to upload a file that you can share with a wider audience later, add the file to the Files application. You can add a link to a file or folder in the Files application from the activity entry to share it with the activity members. Files that you attach to an activity entry are stored within the activity only and cannot be accessed after the activity is marked complete, and removed from the system, for example.

    To learn about alternative methods you can use to upload a file to IBM Connections, see Uploading a file.

    To add a file to an entry, open the entry, and then complete the following steps:

    1. Click Edit.

    2. Click one of the following links:

      Add File > Attach File

      Adds a file to the entry. Click Browse to locate the file.

      The maximum size limit for file attachments is 10 MB by default, but this value can be changed by your administrator.

      Add File > Link to File

      Adds a link to a file stored in the Files application. Files must be installed at your deployment.

      1. Select the type of file to share from the options.

        Table 33. File-sharing options

        Option Description
        Recent Files Files recently uploaded to the Files application.
        Pinned Files Files that you marked as prioritized in the Files application.
        My Files Files that you uploaded to the Files application.
        Shared With Me Files shared with you from the Files application.
        Other People's Files

        Files that are shared with you or the files of another person that are public from the Files application.

        Pinned Folders Files from folders that you marked as prioritized in the Files application.
        My Folders Files from your personal folders in the Files application.
        Shared Folders Files from shared folders in the Files application.

      2. Select a file or files from the list that displays, and click OK.

      Add File > Link to Folder

      Adds a link to a folder stored in the Files application. Files must be installed at your deployment.

      1. Select the type of folder to share from the options.

        Table 34. Folder-sharing options

        Option Description
        Recent Folders Folders recently uploaded to the Files application.
        Pinned Folders Folders that you marked as prioritized in the Files application.
        My Folders Folders that you own in the Files application.
        Folders Shared with Me Folders shared with you from the Files application.
        Public Folders Folders in the Files application that are visible to everyone.

      2. Select a folder or folders from the list that displays, and click OK.

      If you want to remove a file that you added, click the X next to the file attachment field to delete it.

    3. Optional: Rename a field that you added by clicking the field label to edit it.

      After you add a file to the entry, you can change the name that is associated with the field by default to a name that better describes the purpose of the field. For example, if you are using the entry to get review comments on a document you created, you might want to change the file attachment field label to Document To Review.

    4. Optional: You can add more than one file to the entry by repeating the previous steps.

    5. Click Save to finish adding the file to the entry.


    Delete an entry

    You can delete an entry to remove it from an activity. A deleted entry is moved to the trash view for the activity. You can restore the entry, but you must restore it before the administrator permanently deletes it by emptying the trash.

    Authors can delete their own entries only. Owners can delete any entry.

    To delete an entry:

    1. Open an activity, and then scroll to the entry that you want to delete.

    2. Click More Actions > Delete.

      If you cannot see the More Actions link, your view may be collapsed. Click the entry title to expand the entry.

    3. Click OK to confirm the deletion.


    Results

    To restore an entry, open the activity from which you removed it. From the navigation pane, click Trash to open the Trash view. Find the entry, click its title to expand it, and then click Restore.

    Only an activity owner or the entry author can restore a deleted entry. If you are not an activity owner nor the entry author, you will not see the Restore link.


    Converting entries into to do items

    If you have an entry in your activity to assign to a specific member or if the entry has a due date that is before the due date for the whole activity, then consider converting the entry to a to do item.

    You must be an activity owner to convert an entry to a to do item. Converting an entry to a to do item adds a check box to the item so you can check off the item when it is completed.

    To convert an entry to a to do item, open an entry, and then complete the following steps:

    1. Click More Actions > Convert to To Do Item.

    2. The To Do field is pre-filled with the title of the existing entry. If you want to change the contents to a better description of the to do item, then edit the field.

    3. If you want to assign the to-do item, specify a due date, or edit any existing fields, click More Options. At a minimum, verify the assignment and assign a due date.

    4. By default, the task is assigned to Anyone (shared). Any member of the activity can perform the task, and then check it off after it is completed. To assign the to-do item to a specific member, click Choose a person, and then perform one of the following actions:

      • Standard activity:

        • To assign the to-do entry to a specific person, select Individual activity members, and then select the persons name from the list. To find people, scroll through the alphabetic list of names or type a name into the Type to filter this list field.

        • If the activity is shared with a community, then you can assign the to-do item to a community member by selecting Community: community_name where community_name is the name of the community, and then selecting the persons name from the list.

      • Community activity to which all community members were added:

        • Select the persons name from the list. To find people, scroll through the alphabetic list of names or type a name into the Type to filter this list field.

          If the activity has more than 500 members, you can click Next to see additional names.

          The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

      • Community activity to which only a subset of community members were added:

        • Select Individual activity members, and then select the persons name from the list. To find people, scroll through the alphabetic list of names or type a name into the Type to filter this list field.

          If the activity has more than 500 members, you can click Next to see additional names.

          The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

        • To assign the to-do entry to a community owner, select community_name (community owners) where community_name is the name of the community, and then select the owners name from the list.

    5. In the Due date field, assign a date by which the to-do entry must be completed. Type a date or choose a date from the calendar control.

    6. Edit any of the other fields in the to do item that are pre-filled with entry content.

    7. Click Save.


    Get the web address of an individual entry

    You can open an entry in its own web page, and then save the page as a bookmark, send it to another member in a chat message, or post it as a bookmark entry in an activity. Anyone who subsequently opens the link is taken directly to the entry's web page.

    To open an entry from a permanent web address, you must be a member of the activity that contains the entry. You cannot use a link to an entry to share it with someone who is not a member of the activity.

    To get the web address of an entry, complete the following steps:

    1. Find the entry to bookmark or share, and then click More Actions > Link to this Entry.

      If you cannot see the More Actions link, your view may be collapsed. Click the entry title to expand the entry.

    2. You can now bookmark the entry or share it with other members by copying the web address from the web browser's location box and pasting it into a chat, or the bookmark field of an activity entry.


    Publishing attachments to Lotus Quickr

    You can store documents associated with an activity using the IBM Lotus Quickr® product by publishing the document to a Lotus Quickr library. After you publish a file, a link to the document in Lotus Quickr replaces the file attachment in the entry.

    Lotus Quickr must be installed in your enterprise and you must have access to one or more Lotus Quickr libraries. Your administrator configures IBM Connections to interact with your Lotus Quickr deployment, and must enable Quickr integration before you can publish files to a Lotus Quickr library. To publish a file to Lotus Quickr, complete the following steps:

    1. Open the entry that contains the file attachment that you want to publish.

    2. Click Publish to Lotus Quickr for the file attachment.

    3. Do one of the following:

      • If the server specified in the Server field is not the one that hosts the library to which you want to publish the file, select a different server. If your administrator configured it, you can alternately type a server name into the field. Include the protocol, such as http:// or https://.

      • If no servers are displayed in the Server field, type the name of the server to publish the file to into the field. Include the protocol, such as http:// or https://.

      If you are asked to provide credentials, provide the user ID and password that you use to access Lotus Quickr, and then click Log In.

      If you provided the correct credentials and the server you chose or specified is set up to integrate with IBM Connections, the Select an Item field is populated with a list of available Lotus Quickr libraries. If it is not populated, contact your administrator. As part of the configuration of Lotus Quickr integration, the administrator defines the list of servers to which Activities files can be published.

    4. Optional: To choose the library to which to publish the document, filter the libraries displayed in the Select an Item field by selecting one of the following options from the Display field:

      All Places

      Displays a list of all the libraries to which you have access, including public libraries.

      Favorites

      Displays a list of all the libraries that you have identified as favorites.

      This option is displayed when using IBM Lotus Quickr services for IBM WebSphere Portal only.

      My Places

      Displays a list of all the libraries of which you are a member, including libraries that you created. This list does not include public libraries.

      This option is displayed when using IBM Lotus Quickr services for IBM Lotus Domino® only.

    5. Select a folder from the list displayed in the Select an Item field.

    6. Click Publish to complete the publication, close the dialog box, and return to the entry.

      The file attachment in the entry is replaced with a Lotus Quickr link. You can click the link to open the target file's document summary page in Lotus Quickr.


    Related

  • IBM Connections Connector for Lotus Quickr

    Work with entry templates

    Reuse a custom entry within an activity by creating an entry template.


    What is an entry template?

    An entry template is a prototype of an entry.

    You can use an entry template to capture a set of fields that comprise a custom entry. After you create the entry template, you can create multiple entries from it.

    For example, suppose your manager wants you and your teammates to add weekly status report entries to the activity you are using to share information and resources for a project. This means that each of you is going to be creating a separate entry that includes the same introductory information, such as your name and the week for which you are providing status. To simplify things, you could create an entry template that contains fields designed to collect status information, such as a name field titled Status for, and a date field titled Week of. After creating the custom entry, you can save it as an entry template and name it Status report. The next time you need to provide a status report, you can click Add from Entry Template > Add Status report to open an entry form based on the template you created, which contains fields designed specifically to store status report information.


    Create entry templates

    If you designed an entry that you would like to reuse, save the entry as an entry template.

    An entry template is a prototype of an entry. You can create a template, and then use it to create multiple custom entries. Entry templates are available within the activity in which they were created only; they are not shared across activities.

    To create an entry template:

    1. Create an entry to serve as the model for the template. Add all the fields to add and rename them as appropriate.

      See How do I add an entry? for more information about how to create an entry.

    2. Save the entry.

    3. Find the created entry, and then click More Actions > Save as Entry Template.

      If you do not see the More Actions link, the entry may be collapsed. Click the entry title to expand it.

    4. Type a name into the Name field. For example, Status report.

    5. If you want to associate an icon with the template and any entries created from it, click an icon.

    6. Click Save to create the template, and then click Close to close the confirmation message box that is displayed.

    7. To use the new entry template, click Add from Entry Template > Add entry template name.

      where entry template name is the name of the entry template that you created. For example, Add Status report.


    Add a custom entry

    You can add a custom entry that is based on an entry template created and stored in the current activity.

    At least one entry template must have been created in the current activity before you can create a custom entry from a template.

    You must be an author or an owner of the activity to add entries to it.

    To add a custom entry, open an activity, and then complete the following steps:

    1. Click Add from Entry Template > Add entry template name

      where entry template name is the name of the template to use as the basis for the custom entry.

    2. Provide values for any fields to complete.

    3. You can add additional content to the entry by clicking More Options and then the following links:

      Add File > Attach File

      Adds a file to the entry. Click Browse to locate the file.

      The maximum size limit for file attachments is 10 MB by default, but this value can be changed by your administrator.

      Add File > Link to File

      Adds a link to a file stored in the Files application. Files must be installed at your deployment.

      1. Select the type of file to share from the options.

        Table 35. File-sharing options

        Option Description
        Recent Files Files recently uploaded to the Files application.
        Pinned Files Files that you marked as prioritized in the Files application.
        My Files Files that you uploaded to the Files application.
        Shared With Me Files shared with you from the Files application.
        Other People's Files

        Files that are shared with you or the files of another person that are public from the Files application.

        Pinned Folders Files from folders that you marked as prioritized in the Files application.
        My Folders Files from your personal folders in the Files application.
        Shared Folders Files from shared folders in the Files application.

      2. Select a file or files from the list that displays, and click OK.

      Add File > Link to Folder

      Adds a link to a folder stored in the Files application. Files must be installed at your deployment.

      1. Select the type of folder to share from the options.

        Table 36. Folder-sharing options

        Option Description
        Recent Folders Folders recently uploaded to the Files application.
        Pinned Folders Folders that you marked as prioritized in the Files application.
        My Folders Folders that you own in the Files application.
        Folders Shared with Me Folders shared with you from the Files application.
        Public Folders Folders in the Files application that are visible to everyone.

      2. Select a folder or folders from the list that displays, and click OK.

      You can add as many types of fields as you want and you can add fields of the same type multiple times. If you want to remove a field that you added, click the X next to the field to delete it.

    4. Optional: Rename a field that you added by clicking the field label to edit it.

      After you add a file, bookmark or custom field to the entry, you can change the name that is associated with the field by default to a name that better describes the purpose of the field. For example, if you are using the entry to provide review comments, you might want to add two name fields, and change the name of one field to Author and the other to Reviewer. You could also add a date field labeled Review By Date, and then add a file attachment with a field label of Document To Review.

    5. In the Description field, describe the entry or add entry content. You can use the toolbar buttons to format the added text.

    6. In the Tags field, type a tag term. As you type, a list of matching tags from the tag collection is displayed. Click a tag to add it, or keep typing to add a tag that is not in the list. Separate multiple tags with commas.

      A tag is a single-word label or keyword that you assign to an entry to categorize it. After the entry is saved, the tag is added to the tag collection for the activity. Later, you can use the tag to find this entry by clicking the tag from the tag collection. Not only is this entry returned in the resulting list, but any similarly tagged entries are included also, thus helping you to discover related content. Keep in mind that the tag collection is composed of tags created by you and your colleagues; if no one has created any tags yet, you do not see a list of matching tags as you type into this field.

    7. To add this entry to a specific section of the activity, click the arrow for the Section field, and then select the section from the list.

    8. To hide the entry from other members, select Mark this entry private.

    9. If you want to notify activity members about this entry:

      1. Select Notify people of this entry.

      2. Do one of the following:

        • Standard activity:

          • To notify everyone, select the All individual members of this activity check box.

          • To notify specific people, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

          • If the activity has been shared with a community, then you can notify a subset of the community members by selecting Community: community_name where community_name is the name of the community, and then selecting the boxes next to the names of the members to notify.

        • Community activity to which all community members were added:

          • Select the boxes next to the names of individual members that you want to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

            If the activity has more than 500 members, you can click Next to see additional names.

            The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

        • Community activity to which only a subset of community members were added:

          • To notify a subset of community members, select Individual activity members, and then select the boxes next to the names of individual members to notify. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field.

            If the activity has more than 500 members, you can click Next to see additional names.

            The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

          • To notify the community owners only, select community_name (community owners) where community_name is the name of the community.

      3. If you want to add a comment that is displayed in the notification that is sent to the members, add it to the Notify Message field.

        By default, the notification indicates to inform the member about this entry.

    10. Click Save to finish adding the entry.


    Edit entry templates

    The owner of an activity can edit the entry templates created from custom entries used in the activity. For example, the activity owner might want to change the icon used by the template as an identifier.

    Do not perform this procedure if there are no entry templates in the activity.

    An entry template is a prototype of an entry. If you create a custom entry to reuse, you can save it as a template. The next time you add an entry, you have the option of adding an entry with the custom fields specified in the template. See Creating entry templates for more information. To edit an entry template:

    1. Open the activity that contains the entry templates that you want to edit.

    2. From the title bar, click More Actions, and then select Edit Entry Templates.

    3. Click Edit next to the template to edit.

    4. Make the edits that you want. To associate an icon with the template, select an icon.

      When you associate an icon with a template, the icon is displayed in the titles of any entries created using the template.

    5. Click Save.

    6. Edit another entry template or click Close.

    Work with searches and Activities

    Some fields that contain the text string are not found when you perform a full text search on your activities and entries.

    When you perform a full text search, it finds the string if it is present in a title, uniform resource identifier (URI) of a file, bookmark URI, bookmark title, text field, or a field label. The search can also find the text if it is present in the first 2 KB of the comment or description field.

    The following limitations apply when performing a full text search:

    • Search will not find text that comes after the first 2 KB of text in a comment or description field. To determine where the 2 KB threshold falls, look for the text that does not display until after you click [more] in the Description field.

    • Search does not find tags or dates.
      Tip: To find activities or entries that use a certain tag, click the tag from the Tags list or cloud.

    • Search does not find names in name fields.

    • Search does not support the use of wildcard characters.

    • Search text is not case-sensitive.


    Search activities for a word or phrase

    Use the search control in the title bar to search across all of your activities and entries for items which contain a word or phrase.

    You can only search activities of which you are a member. The search includes public and completed activities. Search results do not include entries that have been marked private nor those entries or activities in the trash. To search for activities or entries which contain a specific text string:

    1. Set the word or term to search for into the Search field in the title bar.

    2. Set the items to search by clicking the down arrow next to the Search field, and then selecting one of the following options:

      My Activities

      Searches for the text string in the titles and descriptions of all your activities as well as the fields and entries in all your activities.

      All Activities

      Searches for the text string in the titles and descriptions of all the activities to which you have access, which includes all public activities, and searches for the text string in the fields and entries in all those activities.

      To Do List

      Searches for the text string in the to-do entries of all the activities in which you are listed as a member.

      Templates

      Searches for the text string in the titles and descriptions of all the templates to which you have access.

      This Activity

      Searches for the text string in the title, description, fields, and entries of the current activity, as well as any entries within sections in the current activity.

      If you have a template open, This Template is displayed instead. You can choose This Template to search for the text string in the title and description of the current template.

    3. Click the search icon.

      The search results are displayed in the current page. If you are searching this activity or template, the results are not sorted by section, and you can edit the search results directly. Otherwise, click the title of a result to open and edit it.


    Subscribe to an Activities feed

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.


    Following activities

    Follow an activity when you want to be notified about the latest updates to the activity, including updates to activity content. You are not automatically sent these notifications if you are a member of the activity; you must follow the activity to receive them.

    Anyone can follow an activity if the activity is publicly accessible; you do not have to be an activity member to follow a public activity. If you want to follow a restricted activity, you must be a member of the activity.

    1. Optional: To follow a standard activity, complete these steps:

      1. From My Activities or Public Activities, navigate to the activity to follow.

      2. Click Follow this Activity.

    2. Optional: To follow a community activity complete these steps:

      1. Navigate to the community activity.

      2. Click Following Actions.

      3. Click Follow this Activity.


    What to do next

    You can also track events in the activities that you are following from the Home page by clicking I.m Following in the navigation.

    If you no longer want to receive notifications about the latest updates to an activity, you can stop following it at any time. To stop following a standard activity, open the activity and click Stop Following this Activity. To stop following a community activity, open the community activity and click Following Actions, and then click Stop Following this Activity.

    Work with activities

    This section describes the actions that you can perform in an activity.


    Edit an activity

    To edit an activity, you must be an owner of the activity.

    Edit the title, description, due date, or tags associated with an activity does not affect the content of the entries posted to the activity.

    To edit an activity:

    1. Do one of the following actions:

      • From the My Activities view, find the activity that you want to edit in the list of activities, click More to expand the activity description, and then click Edit.

      • From within the activity to edit, click Activity Actions in the title bar, and then select Edit Activity.

      Only an owner of an activity can edit it. If you are not an owner, you do not see the Edit link nor the Edit Activity menu option.

    2. Edit any fields to change, and then click Save.


    Add sections to organize activity content

    Sections are containers for sets of activity entries. Add sections to an activity to give its outline a hierarchical structure.

    To add a section to an activity:

    1. Open the activity to which you want to add the section.

    2. Click Add Section.

    3. Add a section title to the Section field, and then click Save. You have created a new section, and can now add entries to it.

    4. To add an entry, do one of the following:

      • To add a standard entry to the section, click Entry.

      • To add a to-do item to the section, click To Do Item.

      • To add an entry that is based on an entry template, click Add from Entry Template, and then select the entry type that you want to add.

        The Add from Entry Template option is not displayed if there have been no custom entry templates created in this activity.

      • To move an existing entry to the section, drag the entry into the section.


    Move and renaming sections

    After creating a section, you can move it up or down in the view to better organize the activity. You can also rename the section. To move or rename a section:

    1. From the navigation bar within the activity, expand Sections if it is collapsed, and then click the section to rename or move.

    2. Perform one of the following actions:

      • To rename the section, click Actions > Edit Section, change the section title in the Section field, and then click Save.

      • To move the section, click Actions > Move Up or Actions > Move Down.


    Add a link to a related activity

    Create an entry that links to another activity if the other activity contains information that may be of interest to the current activity's members.

    Only members who have access to the other activity will be able to access the other activity from the entry. To add a related activity:

    1. Open the activity to which you want to add a link to a related activity.

    2. Click Activity Actions in the title bar, and then select Add Related Activity.

    3. Select the activity you want to link to from the list of options that is displayed, and then click Save.


    What to do next

    A related activity entry is created. When a member who has access to the other activity expands the related activity entry, and then clicks the related activity link, the related activity opens.


    Exiting an activity

    If you are looking for a view in the navigation pane and don't see it, it might be that you are within an activity and are looking for an item that is only available from the navigation pane in the My Activities view. You have to exit the currently open activity to see the My Activities view.

    The navigation pane changes to provide links that are relevant to the current page content. From within an activity, the navigation pane provides quick access to things that apply only to that activity, such as a list of your to-do items, or a list of the activity's sections. From the My Activities view, the navigation pane provides quick access to other views, such as Public Activities or Prioritized Activities.

    To exit an activity, click the Activities tab. This action returns you to the My Activities view.


    Copy an activity

    Do you see an activity that someone created that you would like to reuse? If the owners of the activity did not create a template for it to enable others to reuse it, you can make a copy of it. You can also copy one of your own activities if you want to reuse it, but do not plan to reuse it enough times to warrant the creation of a template.

    Any member of an activity can copy it. When you copy the activity, you are added to the new activity as the owner. No other members are added to it initially.

    To copy an activity:

    1. Open the activity to copy.

    2. From the title bar, click More Actions, and then select Copy Activity.

    3. In the new activity form, add new values or change the values of any of the fields to update.

    4. Click Save


    Print from an activity

    You can print the content of an activity as you would any web page. Print from an activity prints the current page only.

    To print an activity:

    1. Optional: If you are printing an activity, expand any collapsed sections, click the Expand All icon next to Display to expand any collapsed entries, and if an entry has a long description that is not displayed, click more to display it in full.

    2. Print the view or activity by selecting File > Print from the web browser menu.

    Organizing your activities

    Organize your activities so that you can quickly access the activities that you want and find information easily.


    Prioritizing activities

    Prioritizing activities makes it easier for you to find the activities that are most important to you.

    All activities are given a Normal priority level by default. You can change the priority level of an activity after you have determined how useful it is to you.

    The priority level that you assign to an activity is visible only to you; it does not affect the priority that another member of the activity might assign to it.

    Activities that you have prioritized as High or Medium are displayed in a compact list that you can access by expanding Prioritized Activities in the navigation pane of the My Activities view.

    Prioritized Activities is not displayed in the navigation pane from within an activity; you must exit the activity first. Click the Activities tab to exit the current activity and return to the My Activities view.

    To prioritize an activity, complete one of the following steps:

    • From the My Activities view, find the activity that you want to prioritize. Click More to expand the activity description, click Prioritize, and then choose a priority level.

    • From within an activity, click Activity Actions from the activity title bar, and then choose a priority level.

    These are the priority level options:

    High Priority

    Indicates that this activity is important.

    Medium Priority

    Indicates that this activity has a higher priority than a normal activity.

    Normal Priority (Default)

    Indicates that this activity has a normal priority.

    Mark as Tuned Out

    Moves the activity to the Tuned Out Activities view.


    Tuning out an activity that does not interest you

    You can tune out of an activity that you are not interested in to remove it from the My Activities view. If the activity subsequently becomes more useful, you can tune back into it. Tune out of activities to restrict the activities displayed in your My Activities view to only those activities that you are most interested in. After you tune out of an activity, you remain a member of the activity and can still access its content by switching to the Tuned Out Activities view. Other members of the activity can still send you notifications about entries in the activity.

    To tune out of an activity, complete one of the following steps:

    • From the My Activities view, find the activity that you want to tune out of, click More > Prioritize > Mark as Tuned Out.

    • From within an activity, click Activity Actions in the title bar, and then select Mark as Tuned Out.


    What to do next

    To tune back into an activity, open the Tuned Out Activities view from the navigation pane of the My Activities view. Click More > Prioritize for the activity that you want to tune back into, and then select the appropriate priority level.


    Marking an activity complete

    Mark an activity complete after its goal has been achieved. This action does not delete the activity; the completed activity continues to be available from the Completed view. After you mark an activity complete, members no longer see it listed among their activities.

    You must be an owner of an activity to mark the activity complete. To mark an activity complete, perform the following steps:

    Do one of the following:

    • From the My Activities view, find the activity that you want to mark complete in the list of activities, click More to expand the activity description, and then click Mark Complete.

    • From within the activity to mark complete, click Mark Activity Complete in the title bar.


    Results

    Completed activities are listed in the Completed view.


    What to do next

    To restore a completed activity, perform the following steps:

    1. Open the Completed view.

      There are two Completed views: one contains only completed private activities of which you were a member and the other contains only completed public views.

    2. Find the activity, click More to expand the activity description, and then click Restore.

      Only an owner of a completed activity can restore it. If you are not an owner, you will not see the Restore link.

    By default, activities that are not active after 90 days are marked complete automatically. A notification is sent to the activity owners before this event occurs to let them know that the activity will be marked complete if they do not use it. The inactivity period of 90 days is a value that the administrator can change.


    Delete an activity

    You can delete an activity to move it to the Trash view.

    Only delete an activity if you do not want to retain any of the information in the activity. You must be an owner of an activity to delete it.

    To delete an activity:

    1. Do one of the following:

      • From the My Activities view, find the activity that you want to delete in the list of activities, click More to expand the activity description, and then click Delete.

        Only an owner of an activity can delete it. If you are not an owner, you will not see the Delete link.

      • From within the activity to delete, click Activity Actions in the title bar, and then select Delete Activity.

        Only an owner of an activity can delete it. If you are not an owner, the Delete Activity menu option is not enabled.

    2. Click OK to confirm that you want to move the activity to the Trash view.


    What to do next

    You can restore activities from the Trash view, but only until the trash is emptied. Your administrator determines the frequency with which the trash is emptied.

    You can restore activities from the view until the trash is emptied, which is 90 days by default. To restore a deleted activity, complete the following steps:

    1. From the navigation pane of the My Activities view, click Trash to open the Trash view.

      From within an activity, click the Activities tab to exit the current activity and return to the My Activities view.

      There are two Trash views that temporarily store deleted activities: one contains only private activities of which you were a member and the other contains only public activities.

    2. Find the activity, click More to expand the activity description, and then click Restore.

      Only an owner of a deleted activity can restore it. If you are not an owner, you will not see the Restore link.

    Work with activity templates

    Reuse the style or content of an activity by creating an activity template.


    What is an activity template?

    An activity template is a prototype of an activity.

    You can use an activity template to capture the required steps, contacts, resources, and tools used to complete a common process. After you create the template, you can create multiple activities from it for each project that you begin that uses the process.

    For example, if you are working on a patent, you can create a template for the patent application process. Add a to-do list to the template that captures the steps required to complete the process. Add files and web links to link to the tools and resources that you use to perform the steps. Assign tags to the template that define its purpose. If you are creating a standard activity template, you can add the key people who understand the process as members so that you can later include them in the project workflow. If you are creating a community activity, make sure the key people are members of the community. After you create the template, you can create an activity from that template for each idea or product to patent.

    Use a template limits the amount of work you have to do each time you begin a new project, because the activity you start with already includes most of the correct members, has links to the necessary information, outlines the required steps complete in the To Do Items view, and has appropriate tags associated with it. If you are a project manager, you can create a template and share it with your team to help organize the project.

    You can create a template in one of the following ways:

    • From scratch. An experienced team member can collect the approved resources and itemize the to-do items required to complete a process and make it available to the team or to a set of customers.

      You cannot create a community activity template from scratch.

    • From an existing activity. A team can capture in an activity the resources that they had to use and the to-do items that they had to complete during the process of completing a task. After the information is organically collected in an activity, you can formalize the process by creating a template from that activity.


    Create an activity template from scratch

    Create an activity template to help yourself and other members of your team to organize the steps and resources involved in completing a common task.

    When you create a template from scratch, you are identifying key parts of a process. To create a useful template, you should be familiar with the process or consult with someone who has experience with the process and knows what bookmarks, IBM Lotus Notes DBs, document files, spreadsheets, and presentations are needed by someone who is attempting to complete the process. The template creator should also know the tasks required and the best order in which those tasks should be performed.

    You cannot use this procedure to create a community activity template. To create a template from scratch, complete the following steps:

    1. Click the Activity Templates tab.

    2. Click Create a Template.

    3. Complete the following fields. None of the fields are required.

      Name

      Type a title for the template. If you do not provide a title, it is named Untitled by default.

      Tags

      Type one or more keywords that should be associated with activities that are created from this template. When someone creates an activity based on this template, the tags you define here are assigned to the resulting activity. Separate multiple tags with commas.

      About this template

      Type a description of the template. Describe why someone would want to use it.

    4. Add members to the template.

      • Select Person, Group, or Community from the Members drop-down list.

      • If you want to add a member to a role other than the default role of Author, click the down-arrow next to the Author field, and then select Owner or Reader. The access level options are defined as follows:

        Author

        Can view content and add entries.

        Owner

        Can add content, view and edit all entries, and manage the membership of the activity.

        As the creator of the activity, you are automatically added as an owner.

        Reader

        Cannot contribute to an activity; access is restricted to only viewing content.

      • Begin typing the name of the community or the name or email address of the person you want to add into the text field. Alternatively, you can search for a particular group by clicking Browse Groups, and then entering a keyword for the group and clicking Find Groups. Click the group you want and then click Add. If the group contains nested groups within it, you can either add the parent group or select a nested group. Use the breadcrumb trail to switch between levels of nested groups

        If the product is configured to hide email addresses, then no matches are returned when you type an email address into the field; type person's name instead.

      The group feature is available upon request. Contact your administrator for information.

    5. To add a person, group or community to a role other than the default role of author, click the Author field arrow, and then select Owner or Reader. The access level options are defined as follows:

      Author

      Can view content, add entries, and edit own entries.

      Owner

      Can add content and can view and edit all entries. As the activity creator, you are automatically added to it as an owner.

      Reader

      Cannot contribute to an activity; access is restricted to viewing content only.

    6. Repeat the previous two steps to add additional members.

    7. Click Save to create the template.

    8. Seed the template with entries. Add entries to guide users of the template through the process that you designed it for.


    What to do next

    The template is now ready for use. Be the first to put it to the test by creating an activity from the template.


    Create a template from an activity to reuse resources

    If you and your team used an activity to complete a process and that activity proved useful, because it captured the steps that you needed to complete and gathered together all the resources that you needed, you can use that activity as the starting point for a template. To create a template from an activity, complete the following steps:

    1. Open the activity to use as the starting point for the template.

    2. Click Activity Actions, and then select Copy As New Template.

    3. Edit the following fields. By default, they contain information that pertains to the activity that you are using to create the template.

      Name

      Edit the name of the template. The default value is the activity name. Choose a name that is generic enough that it can be used in different situations. For example, if the name of the activity is Acme sales engagement, change the template name to Sales engagement.

      Tags

      Edit the keywords associated with the activity; delete tags that are too specific to the current activity to be included in the template, or add new keywords. Separate multiple tags with commas.

      About this template

      Edit the description to include information about how the template is meant to be used.

      Starting page

      Specify which view to display by default when the activity is created. Choose one of the following views:

      • Activity Outline

      • Recent Updates

      • To Do Items

    4. Add members to the template.

      • Select Person, Group, or Community from the Members drop-down list.

      • If you want to add a member to a role other than the default role of Author, click the down-arrow next to the Author field, and then select Owner or Reader. The access level options are defined as follows:

        Author

        Can view content and add entries.

        Owner

        Can add content, view and edit all entries, and manage the membership of the activity.

        As the creator of the activity, you are automatically added as an owner.

        Reader

        Cannot contribute to an activity; access is restricted to only viewing content.

      • Begin typing the name of the community or the name or email address of the person you want to add into the text field. Alternatively, you can search for a particular group by clicking Browse Groups, and then entering a keyword for the group and clicking Find Groups. Click the group you want and then click Add. If the group contains nested groups within it, you can either add the parent group or select a nested group. Use the breadcrumb trail to switch between levels of nested groups

        If the product is configured to hide email addresses, then no matches are returned when you type an email address into the field; type person's name instead.

      The group feature is available upon request. Contact your administrator for information.

    5. To add a person, group or community to a role other than the default role of author, click the Author field arrow, and then select Owner or Reader. The access level options are defined as follows:

      Author

      Can view content, add entries, and edit own entries.

      Owner

      Can add content and can view and edit all entries. As the activity creator, you are automatically added to it as an owner.

      Reader

      Cannot contribute to an activity; access is restricted to viewing content only.

    6. Click Save.

    7. Review each of the entries in the template and remove any entries that are not applicable to the process in general. For example, you might have created a message entry with your home number on it so your teammates could reach you in the case of an emergency. This entry is one that you would want to remove from the template to avoid publishing your home number to the entire organization.

    8. Enhance the template by adding entries. Add standard entries and to-do items to cover pertinent information that might have been missing from the existing activity.


    What to do next

    The template is now ready for use. Be the first to put it to the test by creating an activity from the template.


    Edit activity templates

    Edit an activity template to make changes to it after you create it.

    Edit a template has no effect on any of the activities that you created using the template. To edit a template:

    1. Click the Activity Templates tab to open the list of templates.

    2. Find the template to edit, click More to expand it, and then click Edit.

      If the template is already open, from the title bar, select Template Actions > Edit Template.

      Only the owners of a template can edit it. If you are not an owner, you cannot see the Edit link, and the Edit Template menu option is not enabled.

    3. Make the changes that you want, and then click Save.


    Marking activity templates as favorites for easy access

    You can rank the available activity templates by marking those you like best as favorites. Doing so adds the templates to the Favorite Templates view available from the navigation pane of the Activity Templates tab and enables you to quickly access the templates that you find to be most useful.

    Anyone with access to an activity template can mark it as a favorite. To mark an activity template as a favorite, complete the following steps:

    1. Click the Activity Templates tab to open the list of templates.

    2. Find the template, click More to expand it, and then click Mark as Favorite Template.


    What to do next

    To remove a template from the Favorite Templates view, open the Favorite Templates view, find the template in the list, click More to expand it, and then select Mark as Normal Template.


    Delete activity templates

    Delete activity templates that you do not want people to use or that are outdated.

    Only an owner of an activity template can delete it. Deleting a template has no effect on any of the activities that you created from the template. To delete an activity template:

    1. Click the Activity Templates tab to open the list of templates.

    2. Find the template you want to delete, click More to expand it, and then click Delete.

      If the template is already open, from the title bar, select Template Actions > Delete Template.

      Only the owners of a template can delete it. If you are not an owner, you will not see the Delete link nor the Delete Template menu option.

    3. Click OK to confirm the deletion.


    What to do next

    To restore a deleted template, click Template Trash from the navigation pane of the Activity Templates tab, find the template, click More to expand its description, and then click Restore.

    Only the owners of a deleted template can restore it. If you are not an owner, you will not see the Restore link.


    Create an activity from a template

    Create an activity from a template when there is a template available that was designed for the goal to accomplish. A template can get you and your team started on a project more quickly and effectively.

    You cannot use this procedure to create a community activity. For information about creating a community activity from a template, see Creating a community activity in the Communities Help. To create an activity from a template, complete the following steps:

    1. Click the Activity Templates tab to see a list of the available templates. Click More after a template title to read its description.

    2. After you find a template to use, open it if it is not already open, and then click Start an Activity from this Template.

    3. Add values or change the values of any activity fields to change.

    4. From the Starting page field, choose which view to display by default when the activity is opened.

    5. Add members to the activity.

      • Select Person, Group, or Community from the Members drop-down list.

      • If you want to add a member to a role other than the default role of Author, click the down-arrow next to the Author field, and then select Owner or Reader. The access level options are defined as follows:

        Author

        Can view content and add entries.

        Owner

        Can add content, view and edit all entries, and manage the membership of the activity.

        As the creator of the activity, you are automatically added as an owner.

        Reader

        Cannot contribute to an activity; access is restricted to only viewing content.

      • Begin typing the name of the community or the name or email address of the person you want to add into the text field. Alternatively, you can search for a particular group by clicking Browse Groups, and then entering a keyword for the group and clicking Find Groups. Click the group you want and then click Add. If the group contains nested groups within it, you can either add the parent group or select a nested group. Use the breadcrumb trail to switch between levels of nested groups

        If the product is configured to hide email addresses, then no matches are returned when you type an email address into the field; type person's name instead.

      The group feature is available upon request. Contact your administrator for information.

    6. To add a person, group, or community to a role other than the default role of author, click the Author field arrow, and then select Owner or Reader. The access level options are defined as follows:

      Author

      Can view content, add entries, and edit own entries.

      Owner

      Can add content and can view and edit all entries. As the activity creator, you are automatically added to it as an owner.

      Reader

      Cannot contribute to an activity; access is restricted to viewing content only.

    7. Click Save to create the activity.

    Membership roles

    The membership list of an activity determines who can access the activity and what changes they can make.

    You manage the membership differently depending on whether it is a standard or community activity and whether it is public or private.


    Standard activity

    A standard activity is an activity that you create from the Activities application.

    • Private

      You must be a member of a private activity to see the activity, its entries, and its membership list. By default, new activities are private. Only those members that you add to the activity can access it.

      Typically, you add members to a standard activity when you create it. However, you and the other members of the activity can continue to add new members after the activity is started. You can add both individual members, groups and communities.

      When you add a member to a standard activity, you assign the member to a specific role. Members can belong to one of these roles:

      Reader

      Can view content and members and notify other members about entries, but cannot add or modify content or members.

      Author

      Can view and post entries; add, change, and remove tags for the activity and its entries; view and add and remove members with author or reader roles.

      Owner

      Can add, modify, and delete any of the content or members of an activity and the activity itself.

      You cannot modify the role of a member that is a community. To change the member role of a community, you must remove the community from the membership, and then readd the community as a member in the new role.

      The person who creates the activity is automatically assigned to the owner role. A person who is added to the membership list both as an individual and as part of a group always receives the access rights associated with the individual membership entry. For example, if Mary was added by name to the reader role of an activity, and also added as part of a group to the author role, Mary is granted reader-level access to the activity.

      However, if a person is a member of two groups that are added as members and each of the groups has a different member role, the person receives the membership rights of the group with the higher level of access. For example, if Group A is added to the author role of an activity and Group B is added to the reader role, and John is a member of both groups, then John is given author access to the activity.

    • Public

      Public activities can be accessed by anyone who has access to the Activities server.

      To make an activity public, create the activity, expand the Members list, and then under Access click (Change) next to the currently selected access level to select a different level. The default access level is private.

      This option is not available from a community activity.


    Community activity

    A community activity is an activity that you create from the Communities application. The public status and membership list of a community activity is the same as the community to which it belongs.

    • Private

      If the community is private, all its associated activities are private. In addition, the membership list of a private community activity is defined by the membership list of the community to which it belongs; you cannot change the members list of a community activity from the Activities application.

    • Public

      If the community is public or moderated, all its associated activities are public. Initially, users have read-only access to the activity. If they join or are added to the associated community, their access is changed to allow them to author content in the activity as well.


    Add members to a standard activity

    To give a person access to a standard activity, you can add the person as a member. You must be an author or an owner of an activity to add members. An author can add readers and other authors. An owner can add members in any role.

    You can add multiple people at once if the people are members of a group that exists in the company directory or if they are members of a community. If no existing group or community is applicable and there are too many people to add them each one-by-one, then contact your administrator. Administrators can grant a set of people access to an activity using wsadmin commands. Be sure to tell the administrator the web address of the activity and the email addresses of the people to have added to it. If the product is configured to hide email addresses, provide the login names of each person instead.

    If you add a person who is already a member of the activity, the new membership entry overwrites the original entry. To add a member to an activity, complete the following steps:

    1. From the My Activities view, open an activity.

    2. Click Members from the navigation pane to open the Members view.

    3. Click Add Members.

    4. Select Person, Group, or Community from the Members drop-down list.

    5. If you want to add a member to a role other than the default role of Author, click the down-arrow next to the Author field, and then select Owner or Reader. The access level options are defined as follows:

      Author

      Can view content and add entries.

      Owner

      Can add content, view and edit all entries, and manage the membership of the activity.

      As the creator of the activity, you are automatically added as an owner.

      Reader

      Cannot contribute to an activity; access is restricted to only viewing content.

    6. Begin typing the name of the community or the name or email address of the person you want to add into the text field. Alternatively, you can search for a particular group by clicking Browse Groups, and then entering a keyword for the group and clicking Find Groups. Click the group you want and then click Add. If the group contains nested groups within it, you can either add the parent group or select a nested group. Use the breadcrumb trail to switch between levels of nested groups

      If the product is configured to hide email addresses, then no matches are returned when you type an email address into the field; type person's name instead. As you type, a list of matching names is displayed. Click a name in the list to add that person or community. If the person you want to add is not listed, search the directory for her.

    7. Repeat this step to add additional members.

    8. When you are finished adding members to the activity, click Save.


    Results

    The server sends an email message or sends a notification to the Updates tab of the Home page application to each new member, notifying them about the activity.


    Change member roles in a community activity

    Owners can change the level of access that community members have to a community activity by changing their associated roles.

    There are two types of community activities - implicit and explicit. In an implicit community activity all the members of the community are added as Authors to the community activity by default. In an explicit community activity you can select which members of the community have access to the community activity. The selected members can have Owner, Author or Reader access. If you select three members, they can all have the same access or they can each have a different access level.

    To change an explicit activity into an implicit community activity, follow these steps:

    1. From the My Activities view, open a community activity.

    2. Click Members. Be sure that you click the Members link for theActivity Outline and not the link in the community card section.

    3. Click Add Members.

    4. Select Allow all members of this community access in the activity as Author., and then change the role to one of the following options:

      Owner

      Expands the access of the selected people. Owners can add content, view and edit all entries, and manage the membership of the activity.

      Reader

      Limits the access of the selected people. Readers cannot contribute to an activity; access is restricted to only viewing content.

    5. Select the check box for each person for whom you want to apply the role.

    6. Click Save.

    Work with tags in Activities

    A tag is a descriptive term that you assign to an activity or activity entry. You can assign tags to your activities and activity entries to organize them by subject, to make them easier to find, and to share content with other members. You and other members of an activity can search by tag to find related activities or to identify people with similar interests or a particular expertise.

    You can assign tags to an activity or entry when you first create it or you can edit the tags later by editing the activity or entry. Owners can assign tags to an activity and any of its entries; owners can also edit and delete all tags. Authors can assign tags to their own entries only, and can later edit them; they cannot edit or delete activity-level tags.

    A tag can be a single word only and cannot contain any spaces. It can contain characters such as an underscore (_) or at sign (@). For example, you can use follow_up, follow-up, and followup as tags, but not follow up. The letters comprising a tag are saved as all lowercase letters. If you add a tag that contains uppercase letters, they are converted to lowercase when the tag is added to the entry or activity. For example, if you specify followUp, the tag is saved as followup. A single tag can contain up to 128 single-byte characters. One byte is the equivalent of one Extended ASCII character. The number of bytes per character varies between languages.

    A tag assigned to a public activity is available to everyone from the tag collection displayed for the Public Activities view. A tag assigned to a private activity is available to the members of that activity only and is displayed in the tag collection displayed for each member's My Activities view. Tags assigned to activity entries are displayed in the tag collection displayed within the activity. Tags assigned to private entries are not displayed in the collection.

    You can choose how the tags in a tag collection are displayed . either in a list or in a cloud. A tag list displays the tags in a list starting with the most popular tags first. A tag cloud visualizes the popularity of the tags in the collection by grouping the tags together and displaying the most frequently used tags in larger, darker text and less often used tags in smaller, lighter text.

    The tag list displays the 10 most popular tags only. The tag cloud displays a larger set of the most popular tags, but is limited in the number of tags it can display. If you are looking for a tag that is not displayed in the collection, search for it by clicking Find a tag, entering the tag name in the search field, and then clicking the search icon.

    To find an activity or entry by tag, click a tag from the tag collection. This limits the number of activities or entries that are displayed to include only those that have the selected tag associated with them. To narrow down the list even further, click another tag. This action filters the list of activities or entries that are displayed to include only those that have both tags associated with them.


    Edit activity tags

    You can edit the tags of an activity or an activity entry to modify them. You can also add and remove tags.

    You can assign tags to an activity or entry when you first create it or you can edit the tags later by editing the activity or entry. Owners can assign tags to an activity and any of its entries; owners can also edit and delete all tags. Authors can assign tags to their own entries only, and can later edit them; they cannot edit or delete activity-level tags. Readers cannot edit tags. You might want to edit a tag to make it more consistent with other tags. For example, if you use the tag report for some entries in an activity, but you use the plural form, reports for other entries in the activity, you might want to remove the s from the second variation so that all of your tags are consistent.

    1. Do one of the following:

      • To edit tags associated with an activity, from the Activities tab, click More, and then click Edit.

      • To edit the tags associated with an entry, open the activity that contains the entry, click the entry title to expand it, and then click Edit.

      Only an owner of the activity can edit the activity. Only an owner of the activity or the person who created the entry can edit an entry.

    2. Edit the tags listed in the Tags field. Type a comma between multiple tags. To delete a tag, remove it from the field.

    3. Click Save to save your changes.


    Filter activities and entries by tag

    To find a group of activities related to the same idea, project, industry, or other categorization, filter your activities by tag. You can filter the entries in a single activity by tag as well. Tagging entries and activities allows you to create virtual folders that you can later navigate. All of the tags in your activities, those created by you and by others, are displayed in a tag collection. You can choose to display the tags in the collection as a cloud or a list. The tag cloud displays the more frequently used tag terms in bold face, large font. The tag list displays the most frequently used tag terms first in the list.

    Tag browsing not only helps you find the information that you tagged; it also lets you discover similarly tagged information contributed by other activity members. After you learn which members have contributed information in your area of interest, you can browse by person to discover what other information these people have posted.

    Both the tag cloud and tag list display a set of the most popular tags only. The tag list displays the 10 most popular tags. The tag cloud displays up to 50 tags.

    Do one of the following:

    • To find the activities that are categorized with a tag, from the My Activities view, expand Tags in the navigation pane, and then click the tag.

    • To find the entries in a single activity that use a tag, open the activity, expand Tags, and then click a tag.

    Both from an activity view and from within a single activity, you can search for a specific tag. Click Find a tag, enter the tag name in the search field, and then click the search icon. You might want to do this if, for example, you are using a tag list or the tag cloud is so large that only a subset of the tags are displayed in it, and the tag you are interested in is not one of them.

    Blogs


    New to Blogs?

    Watch a video to learn more about Blogs.


    New to this release?

    Find out what features have been added since the last release.

    Click topics in the table of contents to get help with other tasks.

    What are blogs?

    Blogs are online journals that you can use to share information within an organization in an efficient, dynamic style. In a business setting, blogs are a great tool for delivering timely information with a personal touch.

    Blogs are a flexible medium for communicating within an organization. Use a blog to let employees know about a new product. Or use a blog to inform colleagues about topics that range from experiences at a trade show to tips on using new technology. Blogs are a fast, effective way to share your news and views.

    A blog can have a single author or allow for multiple contributors. Invite others to provide feedback comments on what you post. Blogs give you the tools to collect and share information.

    You can quickly access your blog from the My Blogs page. From the Public Blogs page you can browse for blogs, read recent entries, see what others are viewing or liking, and even start your own blog. You can customize the way information is presented by sorting the display on the page. For example, you can sort either the list of blogs or the list of blog entries by date, title, likes/votes, comments, or visits. Click a blog title to view a blog or click an entry title to view an entry. Sort, browse, view, and post . get involved with blogs!

    What's new in blogs?

    This release contains some features designed to make blogs easier for you to use to share your news and views.

    User interface improvements make it easier for you to go directly to your blogs.

    Create a blog

    Create your own blog to share your ideas with your colleagues. As the blog owner, you control how the blog is displayed and how users interact with it.

    1. From the Public Blogs or My Blogs page, click Start a Blog.

    2. If you have not already logged in, enter your user name and password. Consult your administrator for help with login credentials.

    3. Fill in the fields that describe your blog. There is a description of each field on the form.

    4. Click Save to create your blog. Your blog is now available on your My Blogs page. To make it available for others to see, add an initial entry. Click the title of your new blog to open it and add an entry.

    5. Click New Entry to create an entry and do the following:

      1. Enter a title for the entry.

      2. Optional: Enter tags that categorize the entry. Tags must be entered as single words, separated by commas or spaces.

      3. Enter the main text for the entry.

      4. Click Post to post this entry to your blog.


    Results

    Your blog entry is now available on the Public Blogs page.


    What to do next

    If this blog is the one you will post to most frequently, you can designate it as your primary blog by clicking Set as Primary Blog under the blog title on the My Blogs page. If you have more than one blog, your primary blog is the one users will be directed to if they view your business card and click the Blogs link. If you do not designate a blog as your primary blog, users will be directed to the most recent blog you created.


    Create a community blog

    Use a blog to enhance your community with a way to ask a question, brainstorm, or simply share your ideas.

    If you have IBM Connections Communities installed and you are a community owner, you can create a blog for the use of the community members. Each community can have only one blog. The way you can view and access a community blog depends on the type of community, as follows:

    • If your community is restricted, the blog will also be restricted and for the exclusive use of community members. It will not display on the Public Blogs page, but it will appear on your My Blogs page.

    • If your community is public, the blog will also be public. In this case, the blog will display on the Public Blogs page as well as your My Blogs page.

    • If your community is a moderated community, which is a public community that users must ask to join, the blog will be public, and will display on the Public Blogs page as well as your My Blogs page.

    In all of these cases, comment moderation for the blog is disabled by default unless it is configured by the blog owner or an administrator. To turn on comment moderation, so that you or an approved reviewer reads and approves comments before they are posted to the blog, click the Sets link for your blog and enable the Moderate comments option.

    To create a community blog:

    1. From your community's overview page, click Community Actions > Customize and select Blog. The community blog is created and displays on the community's overview page.

    2. Choose Create Your First Entry to create the first blog entry.

    3. Return to your community. The new entry displays in the blog section.


    What to do next

    From the community, you can:

    • Click New Entry to create a blog entry.

    • Click Sets to change blog settings such as the title, description, tags, timezone, member access, and whether the comments should be moderated.

    The community blog you create also displays on your My Blogs page. You can edit all settings for the blog except for membership from that page as well as from the community.

    Who can see my blog? Creating public and restricted blogs

    Where your blog displays and how users interact with it depends on whether it is public or restricted. Restricted blogs are created from the Communities application. In order to create a community blog, you must have the Communities application deployed for IBM Connections.

    The following are the various ways users and owners can access blogs:

    • A blog you create from the My Blogs or Public Blogs page is a public blog. It is displayed on the Public Blogs page and is available for all to read.

    • A blog you create for a public community is a public blog. In addition to being available to people who join or visit the community page, the blog displays on the Public Blogs page and is available for all to read.

    • A blog you create for a restricted community is available only to the community members. Neither the community blog nor any of its entries will be available from the Public Blogs page, but you can view and manage the blog and its entries from the My Blogs page.

    • If you create a blog for a restricted community, but then change the community to a public community, the blog will then display on the Public Blogs page and will be available for all to read.

    • A blog created for a moderated community is a public blog. It is displayed on the Public Blogs page and is available for all to read. A moderated community is a public community, but users must ask to join.

    In all of these cases, comment moderation for the blog is disabled by default unless it is configured by the blog owner or an administrator. To turn on comment moderation, so that you or an approved reviewer reads and approves comments before they are posted to the blog, access the settings for your blog and enable the Moderate comments option.

    What is an Ideation Blog?

    Use an Ideation Blog to generate ideas and gather feedback on ideas within a community.

    An Ideation Blog is a type of blog specifically designed to generate ideas on a particular topic and then collect feedback to get consensus on the best ideas. An Ideation Blog can only exist within a community and membership is limited to the community, but you can manage the settings for an Ideation Blog from your My Blogs page. As the owner of an Ideation Blog you can:

    • Allow your members to contribute ideas

    • Encourage participants to vote for their favorite ideas

    • Graduate ideas that your community wants to promote

    • Freeze the Ideation Blog so that no more ideas, votes, or comments are accepted

    • Unfreeze an Ideation Blog so it can accept ideas, comments and votes

    • Manage the settings for the Ideation Blog


    Use an Ideation Blog

    Create an Ideation Blog so your community can contribute and vote on ideas.

    1. From your community's overview page, choose Community Actions > Customize.

    2. Select Ideation Blog.

    3. Click Create Your First Idea to add an idea to the blog.

    4. Click Vote to vote for an idea you support. If you change your mind about an idea you voted for, click Voted to cancel your vote.

      The number of votes each participant can cast is configurable from the Sets page for the blog. Participants can cast unlimited votes or be limited to a specified number. Status messages track the number of votes used and the number of votes available.

    5. Click Add a Comment to comment on an idea.

    6. When you decide that an idea has enough support from the community, click Graduate. You have the option to create an activity to further develop the idea. If you change your mind about a graduated idea, open the idea and select Cancel Graduation.

    7. To review activity in the Ideation Blog, choose one of the following views from the navigation pane:

      • All Ideas shows all ideas that have been contributed to the Ideation Blog, including graduated ideas.

      • Graduated Ideas to view ideas you have graduated.

      • My Votes shows the ideas you have voted for.


    What to do next

    To search for an idea or a comment in an Ideation Blog, choose one of the following search scopes in the search bar:

    • This Ideation Blog to search for a string in the Ideation Blog that is currently open.

    • Public Ideation blogs to search for a string in an Ideation Blog in public communities.

    • Public Ideas to search for a string in an idea in public communities.

    • My Ideas to search for a string in ideas you have contributed.

    • This Ideation Blog's Comments to search for a string in the comments in the Ideation Blog that is currently open.


    Manage an Ideation Blog

    Manage your Ideation Blog to effectively control idea creation and voting.

    An Ideation Blog must be created within a community. Membership is restricted to the community membership. You must be an owner of an Ideation Blog to manage it.

    1. To freeze the creation of new ideas for the Ideation Blog, click Ideation Blog Actions > Stop Idea Creation. Users will no longer be allowed to contribute ideas but they can still vote for and comment on existing ideas in the blog.

    2. To completely freeze the Ideation Blog, click Ideation Blog Actions > Freeze Ideation Blog. Users will not be able to contribute new ideas or vote for or comment on existing ideas.

    3. To manage settings for the Ideation Blog, click Ideation Blog Actions > Manage Ideation Blog. In addition to managing the settings that are common for all blogs, you can also control voting:

      • Choose Unlimited voting to allow members to vote as many times as they like.

      • Choose Set a voting limit to restrict the number of votes each member can cast to the number you specify.

    What are tags and how do I use them?

    Tags let you assign keywords to your blog entries that are meaningful to you. Tags provide a useful way to categorize your blog or blog entries and search for blogs or blog entries that are of interest to you. Use the tag cloud to view all tags assigned to blog entries in the list, to determine the popularity of a tag, and to access blog entries associated with a tag.

    Tags provide a means of classifying and retrieving content in a way that is meaningful to you. Tags are single words, or multiple words connected with hyphens or underscores. For example, social-bookmarking, status_reports, and payroll are all valid tags.

    You can choose how the tags in a tag collection are displayed . either in a list or in a cloud. A tag list displays the tags in a list starting with the most popular tags at the beginning. A tag cloud visualizes the popularity of the tags in the collection by grouping the tags together and displaying the most frequently used tags in larger, darker text and less often used tags in smaller, lighter text. The tag list displays the ten most popular tags only. The tag cloud displays a larger set of the most popular tags, but is limited in the number of tags it can display.

    If you are looking for a tag that is not displayed in the collection, search for it by clicking Find a Tag, entering the tag name in the search field, and then clicking the search icon. To find a blog or entry by tag, click a tag from the tag collection. This limits the number of blogs or entries that are displayed to include only those that have the selected tag associated with them. To narrow down the list even further, click another tag. This action filters the list of activities or entries that are displayed to include only those that have both tags associated with them. You can view tags in a list or in a cloud. Click List or Cloud at the end of the tag area to switch the display. When you view a tag cloud, note that tags are presented in various sizes and colors. The most popular tags are darker and larger than other tags. The slider controls whether all tags display in the cloud or just the more frequently used tags.

    Create a blog entry

    You can contribute to any blog for which you have owner, author, or draft permission. The autosave feature lets you resume work on entries in progress. The permission you are granted by the blog owner controls whether you can post an entry directly to the blog or whether you can create a draft entry that must be approved by the owner before it gets posted. The permissions are as follows:

    • Owner permission allows user to post entries, manage the blog and its users

    • Author permission allows user to post entries, but not to manage the blog

    • Draft permission allows user to save draft entries only

    As you create or edit an entry, your work is automatically saved every 15 minutes, unless the site administrator changes the interval. If you leave an entry in an unsaved state when you log out of Blogs, the next time you log in, a notification reminds you that you have an unsaved entry. From that notification message you can click Edit to open the entry and resume work on it, or Discard to delete the entry.

    1. Open the blog to contribute to, and click New Entry or click the New Entry button on the Public Blogs page.

    2. Enter a title for your entry.

    3. Enter the text for your entry.

    4. Optional: Enter tags for your entry. Tags are keywords that you can assign to describe the content in your entry. Tags make searching for content easier for blog readers. Note that tags must be entered as single words, or multiple words connected with hyphens or underscores. For example, social-bookmarking, status_reports, and payroll would all be valid tags.

    5. Click Advanced Sets to control these settings:

      • Allow characters to be converted into emoticons.

      • Delay posting an entry to a blog until a time and date that you specify.

      • Limit the number of days for posting comments for the entry.

      • Specify a custom URL. that is, you can enter some text that replaces the entry title in the URL that points to this entry.

    6. To include an external media link, such as a video, in a feed that includes this entry, enter the URL in the External media URL field. For example, http://www.youtube.com/watch?v=Kw2j0YOqKoo. When this entry is posted and viewed from a feed reader, the media will be available in the entry.

    7. Click Post to publish your entry to the blog or Preview to review your entry before posting. If you have Draft permission, your options will be Submit for Review and Save as Draft instead of Post. If the blog is moderated, which means that content must be reviewed and approved before it is published in the blog, your post will not appear in the blog until a moderator approves it.


    Add an image to a blog posting

    Enhance your blog postings with image files. You can add images from your local file system, from files you have already uploaded, or from web pages to enhance your blog entries.

    1. Create or edit a blog entry.

    2. Insert your cursor in the Entry field

      ...where you want the image to appear.

    3. Click the Insert Image icon in the editor toolbar.

    4. Do one of the following:

      • Browse for a file name to add an image file from your local file system.

      • Select from a recent photo you uploaded.

      • Enter a URL for an image file on a web page.

    5. Choose layout options to size and position the image.

    6. Click Insert to add the image to the blog posting.

    7. Preview your posting or post it to the blog to see the image.


    Add a video to your blog posting

    You can include a video in a blog posting to make it available to readers. To add a link to a video or demo to a blog posting you can link directly to a Flash demo if you have the URL for the video file. A Flash demo usually has a *.swf file extension. If you are linking to an embedded video, such as a video in a YouTube page, you must copy the information for embedding the video and paste it into the HTML page of the rich text editor.

    1. Create a blog entry.

    2. To insert a Flash video, do the following:

      1. Click the Insert Flash Movie icon on the toolbar of the rich text editor.

      2. Enter the URL for the Flash demo.

      3. Optional: (Optional) Override the default display settings by entering values in pixels for the width and height, as well as how much vertical space to display above and below the video.

      4. Optional: (Optional) Use the Preview area to see how the video will appear in the blog entry.

    3. To embed a video, such as video from a YouTube page, do the following:

      1. Copy the <embed> object information for the video you want to use and paste it into the editor.

        Many video sharing websites now provide iframe code for videos by default. It is usually still possible to get the old embed code although, for example on YouTube, you can do this by checking the Use old embed code option. Both iframes and old embed code can be pasted directly into the rich text editor. To embed a video from YouTube, click Share > Embed Copy the contents of the textfield and paste it directly into the editor without switching to source view. The rich text editor automatically detects that this is an iframe and will insert an iframe object in the editor. If the old embed code is used instead, the editor will automatically detect that this is a flash video and a flash object will be inserted in the editor. Once the page is saved, the video contents can be viewed within the page.

        If you are inserting an example of the video markup, it is important that you paste it directly as it appears in the video sharing website. Do not add any newlines, spacing, and so on; otherwise the automatic detection feature in the editor might not get triggered. Examples of video markup that will be automatically detected are: 

        <iframe height="315" src="http://www.youtube.com/embed/-mcbsrAXlAg" frameborder="0" allowfullscreen></iframe>
        Or: 

        <object height="315"><param name="movie" value="http://www.youtube.com/v/-mcbsrAXlAg?version=3&amp;hl=en_US"></param><param name="allowFullScreen" value="true"></param><param name="allowscriptaccess" value="always"></param><embed src="http://www.youtube.com/v/-mcbsrAXlAg?version=3&amp;hl=en_US" type="application/x-shockwave-flash" height="315" allowscriptaccess="always" allowfullscreen="true"></embed></object>
        If you try to paste video content into the rich text editor and it is not automatically converted into a flash video or iframe, try pasting the video sample into Notepad or some other plain text editor, and then copy it from there into the rich text editor. All samples pasted directly from the Share feature in YouTube, Vimeo, and such will work as is.

      2. Optional: Add any other text you want to display in the entry.

    4. Save the entry.


    What to do next

    When users view this post they can view the Flash demo or the embedded video.


    Edit or deleting an entry

    If you have the appropriate permissions, you can edit an entry to change the content or status, or to delete it from the blog.

    If you have Author permission, you can edit entries you have created. If you have Owner permission, you can edit any entry in the blog.

    To edit or remove an entry, click Entries from the Sets page to view the entries for your blog and do one of the following:

    • Click Edit to edit an entry.

    • Select one or more entries and click Delete to permanently remove the entries from the blog.

    As you create or edit an entry, your work is automatically saved every 15 minutes, unless the site administrator changes the interval. If you leave an entry in an unsaved state when you log out of Blogs, the next time you log in, a notification reminds you that you have an unsaved entry. From that notification message you can click Edit to open the entry and resume work on it, or Discard to delete the entry.


    Use third-party blog editors to create entries for your blog

    You can set up your blog so that you can use a third-party editing tool to create blog entries.

    To use this application, you must already have a blog with at least one entry. You must also have access to a third-party blog editing tool, such as w.bloggar or ScribeFire. The steps describe how to set up your blog to use ScribeFire, a plug-in for Mozilla Firefox. The steps for enabling other editors as third-party editors are detailed in an article titled Use third-party editors to author blog entries on the IBM Connections wiki. Follow these steps to specify an alternate editor for creating blog entries. These steps assume you have already installed the ScribeFire plug-in and that you are using Mozilla Firefox as your browser.

    1. Click My Blogs to work with your blog.

    2. Click Sets to edit the settings for your blog.

    3. Enable the Enable Blogger and Metaweblog API for your blog setting.

    4. Click Update Blog Sets.

    5. Click on the Scribefire icon in the Firefox status bar or choose Scribefire from the Tools menu to launch ScribeFire.

    6. Launch the account wizard.

    7. Enter the URL for your blog.

    8. Select Metaweblog API in the system type field and enter the URL for your Blogs server in the Server API URL field. The URL should look like this: http://<hostname>/blogs/services/xmlrpc.

    9. Enter your IBM Connections user name and password.

      Both user name and password are case-sensitive. If the login is successful, you see a list of your blogs.

    10. Select the blog or blogs you want to update with ScribeFire.

    11. Use ScribeFire to create a blog entry and post it to your blog.

    Posting a comment

    If a blog is set up to accept comments, you can respond to a blog entry with your own comments. Use a comment, rather than a new entry, when you want to respond to content in a particular blog entry. For example, you might add more information to a discussion or ask a question.

    1. Click the entry you want to respond to.

    2. If the blog is set up to accept comments click Add a Comment.

    3. Enter your comment in the text box.

    4. Optional: Click Preview to see how the comment will display in the blog.

    5. Optional: Select Add this as a new entry in my blog if you want to add this as an entry to your blog. If you have more than one blog, choose one from the list.

    6. Click Submit to publish the comment to the blog. Multiple comments for an entry are displayed in the reverse order in which they were created.


    Results

    If the blog's comments are moderated, the comment will not display immediately. Someone must approve the comment before it displays. Otherwise, the comment displays after the entry.

    Add a bookmark from a web page

    Add links to web pages to your blog with the click of a button. Use the IBM Connections bookmarking application to create a blog entry with the click of a button that includes a link to a web page. Include descriptive text to add some context for sharing the URL link with your readers. Follow these steps to use the bookmark application.

    1. If you haven't already installed the Add Bookmark browser button, click the Bookmark Tools link in the page footer and follow the instructions to install the button for your web browser.

    2. Visit the web page you want to bookmark for your blog and press the Add Bookmark button.

    3. Optional: Add a description and tags for the bookmark. Tags are keywords that make it easier for you to find a bookmark. Enter tags as single words, separated by commas.

    4. Click the Add to Blogs tab and select your blog.

    5. Optional: If you want to add any additional information that will appear in the entry with this bookmark, add it in the Additional description field.

    6. Click Save to add the bookmark to your blog. An entry is created in your blog with the URL link, plus the information from the description fields.

    Notifying a user about a blog entry

    Notify other blog users about an entry that you think might be of interest. If you want to let one or more blog readers know about an entry, send a notification.

    1. Click the More Actions > Notify Other People link at the end of an entry.

    2. Enter one or more names or email addresses.

    3. Add an optional message about why you are sending the notification.

    4. Click Send.


    Results

    An email with a link to the blog entry is sent to the user or users specified. If the user you specified has no email address, the user does not receive an email. Notifications that you send are listed on the recipient's Notifications Received list and on your Notifications Sent list on the My Updates tab. The blog entry is also listed on the notifications list.

    Liking an entry

    When you find an entry of particular interest, you can click an icon to show others that you like the entry. Liking an entry means that the entry will have more relative importance when the entries are sorted using the Likes/Votes option. You can keep track of entries that you like from your My Updates page. You can also like comments.

    1. Click the name of an entry that you like.

    2. Click the Like icon for an entry.


    What to do next

    A recommended entry is indicated with the Like icon along with a number that indicates the number of likes for the entry. You can click the icon to see who liked the entry. Entries that have received the most likes in the last 30 days display in a Most Liked area on the Public Blogs page. The entries that received most likes display first in the list when blog entries are sorted using the Likes/Votes option. You can also click My Likes/Votes to view entries that are of particular interest to you.

    Flagging an entry as inappropriate

    If you encounter a blog entry that you consider inappropriate, you can flag the entry so that a reviewer can determine whether the entry should be removed from the blog. This feature must be enabled by your administrator.

    Occasionally you might come across a blog entry with inappropriate or even illegal content. Any user can flag an entry as inappropriate. The blog owner or a designated reviewer is notified, reviews the entry, and then determines whether the entry should be removed or whether the flag should be dismissed.

    This feature is disabled by default. The option to flag inappropriate content is only available if your administrator enables it for your organization.

    What is considered inappropriate is determined by the community standards for your blog. It will differ according to the intention of the blog as well as according to corporate guidelines. For example, a blog with a wide audience might have very strict guidelines about disclosing information related to product development, while another might support sharing information about product direction. Most blogs discourage profanity or personal attacks. If the guidelines are not clear, you might consider posting what is appropriate and what is not, so users understand the guidelines. If you are not clear on guidelines, ask your Blogs administrator.

    1. Click the name of a blog entry to open it.

    2. Click More Actions > Flag as Inappropriate.

    3. There might be a list that lets you categorize the issue you are reporting. The list is set up by your administrator to reflect concerns in your organization, so it might include categories such as "Inappropriate business content" or "Security risk."


    What to do next

    The blog administrator or designated reviewer is notified that the entry has been flagged so that they can take appropriate action.


    Related tasks

  • Manage flagged content for a blog

    Find a blog or blog entry

    You can use various methods such as browsing or searching for finding a blog or blog entry to view.

    The My Blogs page lists all of your blogs. Icons indicate whether a blog is a public blog, a public community blog, or a restricted community blog.

    The Public Blogs page lists all of the blogs for your organization. Use one of these methods to find a blog or blog entry. In addition to searching or browsing for blogs or blog entries, you can also sort the views by sort criteria such as date, visits, or likes/votes.

    Browse for a blog as follows:

    • Click Public Blogs in the navigation pane and select Blogs Listing to see all of the blogs for your organization.

    • Featured Blogs displays a sampling of blogs over the last two weeks.

    • The Most Liked list displays blogs that contain entries with the most likes.

    • The Most Voted list displays the ideation blogs that have had the most voting activity over the past two weeks.

    • The Most Commented list displays the blogs with the most comments.

    • The Most Visited list displays the blogs that have had the greatest number of hits over the past two weeks.

    • Click a tag in the tag cloud to see blog entries associated with that tag, then click the blog name from the entry to open the blog.

    • Search for a blog. You can change the search scope to search for blogs by name, description, or tags.

    • Hover over the name of a person to open their business card, and then click Blogs to see a blog they own. If they have a default blog, clicking their name opens the default blog. If they don.t have a blog, clicking their name opens the most recently created blog that person belongs to.

    Browse for a blog entry as follows:

    • Click Latest Blog Entries on the Public Blogs page to see the most recent entries.

    • Click a tag in the tag cloud to see all blog entries associated with a particular tag.

    • Search for a blog entry. You can change the search scope to search for blog entries by author or tags.

    • Click an entry from the Featured Blog Entries section of the Public Blogs page. Featured entries are a sampling of entries posted in the past two weeks.

    • Click a blog entry someone has notified you about from your Notifications Received list on your My Updates page.

    • The Most Liked list displays the blog entries that have received the most likes.

    • The Most Voted list displays the ideation blog entries that have had the most voting activity over the past two weeks.

    • The Most Commented list displays the blog entries with the most comments.

    • The Most Visited list displays the blog entries that have had the greatest number of hits.

    • Click the My Updates tab to see only entries you have authored.

    • If you click a blog to view it, the Similar Blogs section shows blog entries that share common tags.

    • If you are an owner or administrator, open a blog and view content by month in the Archive section.

    Search for a blog or blog entry by entering a search term in the Search box and choosing the scope that best matches what you want to search.

    Subscribe to feeds

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Following a blog

    Follow a blog to stay informed about activity in the blog.

    When you follow a blog, you receive notifications about the latest updates to the blog. This is similar to getting a feed from this blog but the notifications are delivered to the Notifications section of your Home page, rather than to an external feed reader. Anyone can follow a public blog. You can also follow community blogs without being a community member, as long as the community is publicly accessible.

    When you are already following a community, you do not need to follow its blog separately; updates about the community blog are automatically included when you follow the parent community.

    Perform any of these action to follow or stop following a blog:

    • To follow a public blog, open the blog and click Follow this Blog.

    • To follow a community blog, open the community and click Follow this Community.

      If you open the community blog from the Blogs application, you can follow the blog by selecting Following Actions > Follow this Community.

    • Keep track of blog activity from the Home page by selecting the I'm Following view on the Updates page.

    • To stop following a public blog, open the blog and click Stop Following this Blog.

    • To stop following a community blog, open the blog and click Stop Following this Community.

      If you open the community blog from the Blogs application, you can stop following the blog by selecting Following Actions > Stop Following this Community.

    Manage your blog

    If you are the blog owner, click Sets to edit, manage, or configure your blog. Sets is a central location where you can edit the properties for one or more of your blogs.

    1. From the My Blogs page, click Sets for a blog and choose any of these options to edit, manage, or configure a blog:

      • General opens the general settings page for the blog so that you can view or edit settings that control how users interact with your blog.

      • Authors lets you add authors or manage user permissions for your blog.

        If your blog is a community blog you are directed back to the community to manage blog membership from there.

      • Theme controls the look and layout of your blog.

      If your site administrator has enabled theme customization, you will also see a Templates tab for editing theme templates.

    2. When you are done with management tasks, open a blog or return to the Public Blogs page.


    Edit general blog settings

    The settings for a blog are a combination of preferences for how you would like users to interact with the blog, and basic settings such as the blog name and description. You can edit all of the settings for a blog that you own.

    You must be a blog owner to edit blog settings.

    1. From the My Blogs page, click the Sets link for your blog.

    2. Edit settings for the blog.

      Option Description
      General Sets Set the basic properties, such as the name, description and how many entries to display (the default value is 25). By default, a blog is active and available to the blog community. The option Allow authors and drafters to edit each other's entries in this blog allows you to have a collaborative blog, where authors and draft members can edit each other's entries and see each other's entries in the entry management interface as well.

      Internationalization Sets Set time zones.

      Comments Select if you want users to comment on a blog. If you choose to moderate comments, you must review and approve comments before they display in a blog.

      Default Comment Sets Set preferences to allow comments for new entries, or to set a time limit so that after a specified number of days the comment field is no longer displayed for an entry. You can also apply these settings to existing entries in the log. Comments for entries are displayed with the entry in reverse chronological order.

      Blog Client API Use this setting if you want to use a third-party editor to create blog entries. For more information, see the topic Using third-party blog editors to create entries for your blog.

    3. When your changes are complete, click Update Blog Sets to publish your changes.


    Manage blog entries

    As the blog owner, you can view and manage all of the entries in your blog from the Entries page. The Entries page provides a central spot where you can view and manage all of the entries for a blog you own. For example, if you have designated a member as a draft author, you can review submitted draft entries and decide whether to approve entries for posting to the blog or reject them and return them to the author.

    1. From the My Blogs page, select Entries for the blog you want to work with. All of the blog entries are listed, with information including entry name, status, and the date the entry was updated.

    2. To filter the set of entries, enter a tag and press the search icon to view all entries associated with that tag.

    3. The All tab displays all blog entries with their status. Click the Require Approval tab to view and manage entries awaiting approval.

    4. Select one or more entries and click one of the following:

      • Approve to publish the entry to the blog.

      • Reject if you do not want to publish the entry. You are prompted to enter an optional reason for rejecting the entry, which is sent in a notification email to the entry author. The author has the option to edit the entry and resubmit it for your review.

      • Delete to permanently remove the entry.

    5. Click the Draft tab to view draft entries. The entries you see depend on your role. If you are a draft user, you see entries you created that are in a draft state. If you are a blog owner or author, you see all draft entries for this blog. From this view you can edit an entry, or select it and click Submit to publish it to the blog, or Delete to permanently remove it.

    6. Click the Published tab to view published entries. From this tab you can edit entries, reject them and remove them from the blog, or delete them.

    7. Click the Rejected tab to view rejected entries. From this tab you can edit entries, approve them for publishing to the blog, or delete them.


    Manage blog comments

    View and manage comments that are posted to your blog. You can view all of the comments for your blog from a central location. If you are a blog owner and you checked the Moderate Comments setting for your blog, you can review and manage comments from the Comments page.

    In some organizations, the site administrator disables this application. In that case, the administrator must specifically assign you a moderator role for you to review and manage blog entries and comments.

    1. Select the blog you want to work with from the My Blogs page.

    2. Select Entries or Sets.

    3. Select Comments. All of the comments posted to the blog are listed, with information including author, status, and entry name. You can manage comments from this view.

    4. To filter the set of comments, use the Date options to see comments for a particular date or date range.

    5. Click the Require Approval tab to view and manage comments awaiting approval.

    6. Select one or more comments and click one of the following:

      • Approve to publish the comment to the blog.

      • Reject if you do not want to publish the comment. You are prompted to enter an optional reason for rejecting the comment, which is sent in a notification email to the comment author. The author has the option to edit the comment and resubmit it for your review.

      • Delete to permanently remove the comment.

    7. Click the Published tab to view published comments. From this tab you can edit comments, reject them and remove them from the blog, or delete them.

    8. Click the Rejected tab to view rejected comments. From this tab you can edit comments, approve them for publishing to the blog, or delete them.


    Viewing the hit count for your blog

    You can view the hit count for your blog from the Referrers page. You can view how many times your blog is visited from the Referrers page. This page tells you where your blog's hits are coming from. Hits with indeterminate referrers, such as those from newsfeed readers and links are counted as direct hits.

    Another way to track visits is to look at the visit count for a blog entry.

    1. Click My Blogs.

    2. Click Sets.

    3. Click Referrers.

    4. To delete hits, select them and click Delete.

    5. Click Reset Hit Count to set the counter back to zero.


    Change the look of your blog

    The blog theme controls the layout and color-scheme of your blog. When you create a new blog, you select from one of the built-in themes.

    You must be a blog owner or site administrator to edit the blog theme. Change the theme to update the look of your blog.

    1. Click My Blogs.

    2. Click Sets for the blog you want to modify.

    3. Click Theme.

    4. Select a different theme for the blog. A preview window shows you what your blog looks like with the new theme.

    5. Click Save to apply the new theme.


    What to do next

    You can also customize a theme from this page if your site administrator makes that feature available to users. Customize a theme requires that you edit HTML template files. Do not customize a theme unless you are comfortable working with HTML. When you click Customize, the templates that define your current theme are copied into your blog where you can edit them from the Templates page. Also note that you can only customize one theme at a time. Clicking Customize overwrites any previous customization.


    How do I create an announcement?

    If you are a Blogs site administrator you can post announcements to the Public Blogs page that all users can see.

    You must be a Blogs site administrator to create an announcement. Site administrators have access to an Administration tab as part of the Blogs interface. An announcement is a great way to get the word out to your whole community of bloggers. For example, if you want to notify users about server maintenance or about an upcoming company event, post an announcement. Announcements display on the Blogs Home page.

    1. Create a new blog entry and enter your announcement text.

    2. Expand the Advanced Sets section.

    3. Select the box next to Post as announcement.

    4. Post the entry. It displays in the Announcements section on the Public Blogs page.


    Delete a blog

    If you are a blog owner, you can permanently remove a blog. Delete a blog removes the blog and all its entries. This operation is not reversible.

    1. From My Blogs, select the blog that you want to delete and click Sets.

    2. On the General Sets page, click Remove Blog.

    3. Click Yes to confirm the deletion.


    What to do next

    If you are trying to delete a community blog, you must delete it from the community. To delete the community blog and all of its content, visit the community and choose Remove from the blog action menu and confirm to permanently remove the blog.

    Uploading a file to a blog

    Use the file upload utility to make graphics available for use in blog entries. You can upload files for use in this blog.

    1. Click the My Blogs page.

    2. Click Entries for the blog you want to edit.

    3. Click File Uploads.

    4. Browse for one or more files to upload. The default file size allowable for uploading is 1 MB per file, up to a total of 4 MB for all files. The allowable file size as well as the allowable file type can be adjusted by the site administrator.

    5. To organize files in a folder, enter a New Directory name and click Create.

    6. To delete a file from the blog, select a file and click the Delete button.


    Results

    After uploading files, you can add the files to a blog entry. You can add images to a blog entry by clicking the Insert Image icon in the rich text editor and browsing for the images you uploaded.

    Add links to your blog

    Make links to web sites available to all of your blog readers. You can enhance your blog by adding links to related web sites, feeds, or images.

    1. Click My Blogs.

    2. Click Sets for the blog that you want to edit.

    3. Click Links.

    4. To add a link, click Add Link and enter a title for the link and the URL.

    5. If the link is to a feed, enter the feed URL.

    6. If you want to use an image instead of link text, specify the image file to use.

    7. To impose a sort order, enter a number for the link. Links display in order from the smallest number to the largest one.

    8. Click Save to save the link. Links will display in a Links section on the blog page.


    What to do next

    After creating links, you can delete or edit them.

    • To delete one or more links, navigate to the Links page, select the box next to one or more links and click Delete.

    • To edit a link, click the Edit icon next to the link.

    Manage member permissions for a blog

    Manage member permissions allows you to add members and assign permissions to your blog.

    You must be a blog owner to manage members.

    If your blog is a community blog, you must manage permissions for the blog from the community. Do the following to manage member permissions for your blog.

    1. From the My Blogs page, click Sets for the blog you want to edit.

    2. Click Authors.

    3. Change the permission or remove any member listed for the blog.

    4. Click Add members to add a member to your blog.

      If your blog is a community blog, you must manage permissions for the blog from the community. You are redirected back to the community to manage membership. When you first create a community blog, all members of the community are granted author access by default. Depending on your community, you might want to change the access level for your members. Note that access is always community-wide. To change access for all community members, select Edit from the Blogs widget action menu.

      1. Select a permission for the member.

        • Owner permission allows user to post entries, manage the blog and its users.

        • Author permission allows user to post entries, but not to manage the blog.

        • Draft permission allows user to save draft entries only.

      2. Type a member's name select the matching name from the name list to add a member. Or, enter a user's email address and click the green plus sign to add the user.

    5. Save any changes that you made to your blog permissions.


    Blogs roles and permissions

    What you can do with blog settings or content depends on what role you are assigned.

    Blog owners can:

    • Create a blog or delete a blog they own.

    • View, create, edit, or delete all content (entries and comments in both the draft and published state) for a blog they own.

    • View, create, and delete all links in the blog.

    • Upload files and create directories as well as view or delete any uploaded file or directory.

    • View and delete information on the Referrers page as well as reset the hit count for the blog.

    • View and edit settings for the blog, such as General, Author, and Theme settings.

    Blog authors can:

    • View, create, edit, or delete blog entries they created, regardless of whether the entries are in the draft state or posted to the blog.

    • View, create, edit, or delete links.

    • Upload files and create directories as well as view or delete any uploaded file or directory they added to the blog.

    • View and delete information on the Referrers page as well as reset the hit count for the blog.

    Draft authors can:

    • View, create, edit or delete a blog draft entry they own.

    • Edit other's entries when the setting Allow authors and drafters to edit other's entries in this blog is selected for the blog.

    • Upload files and create directories. Note that draft authors cannot delete files or directories.

    Viewer in a community blog can:

    • View blog entries for communities they belong to.


    Resigning from a blog

    If you no longer want to participate in a blog, you can resign from it. You cannot resign if you are the one and only blog owner. Resigning from a blog means you can no longer participate unless you are added as a member by the blog owner.

    You can only resign from a public blog. You cannot resign as the owner of a community blog.

    1. From My Blogs, select the Resign link for the blog you want to leave.

    2. The blog is removed from the list of blogs on your My Blogs page.

    Bookmarks


    New to Bookmarks?

    Watch a video to learn more about Bookmarks.


    New to this release?

    Find out what features have been added since the last release.

    Click topics in the table of contents to get help with other tasks.

    What can you do with Bookmarks?

    Bookmarks is a set of social bookmarking tools that you can use to save, organize, and share Internet and intranet bookmarks.

    Bookmarks that you collect are stored in a central repository for your convenience so that you can share some or all of your bookmarks with others, and see other collections of bookmarks. In a work environment, this tool is a great way to share expertise. Bookmarks provides tools for scanning for information about a bookmark or about the bookmark owner, giving you the means to share information in your enterprise or connect with people who have similar interests or the expertise you need. Some highlights of Bookmarks include:

    • A central spot for storing and organizing bookmarks

    • A way to publish some or all of your bookmarks so that others can see your collection

    • Tags that let you identify bookmarks with a keyword that you choose. Tags make searching for and sharing bookmarks easier.

    • Authentication with an enterprise directory to provide boundaries to the social network

    • Contact information provided about bookmark owners so that you can locate and connect with other users

    Collaboration scenario

    Suppose you work in the Finance group and are looking for a person knowledgeable about microcredit. You can search Bookmarks for tags such as "economics," "microcredit," "lending," and "small_business." If you find a match, you can scan the list of bookmarks and the people who have posted the bookmarks. After you identify a person who has created several bookmarks related to microcredit, you can review that person's bookmarks and also get contact information and links to other IBM Connections services associated with that user. This form of expertise location encourages collaboration and sharing of resources within your company.

    Get started and installing the bookmark button

    Follow these steps to install the browser toolbar button and get started using Bookmarks. There are two ways to create a bookmark. If you know the URL you want to bookmark, you can click the Public Bookmarks or My Bookmarks tab and click the Add Bookmark button. Fill in the form to create a bookmark to the URL you specify. If you want to bookmark from a web page you visit, follow the steps to install the browser button so you can easily add a bookmark to a site you want to share or revisit.

    1. If you have not done so already, install the Add Bookmark browser toolbar button from the Bookmarking Tools link in the footer of the Bookmarks window.

    2. Visit a web page to bookmark and click the Add Bookmark toolbar button to create a bookmark. Provide a title, description and tags that describe the bookmark. Indicate whether you want the bookmark to be Public, so that other users can see it, or Private, available only to you. You can also choose to add the bookmark to other IBM Connections applications deployed for your organization. For example, you can add a bookmark to a Community so it is available to the user group.

      You can also add a Discuss This browser button, which will allow you to re-post web pages as topics for discussion in your forums. For more information on the Discuss This button, see the Forums help.


    Results

    Return to the Bookmarks application to view your bookmarks. You have a variety of options for viewing and using bookmarks:

    • View just the bookmarks you have added from the My Bookmarks page.

    • View Public Bookmarks to see the bookmarks available, the people who created them, and the tags used to identify them.

    • View Popular bookmarks to see the most frequently bookmarked pages.

    • Refine the Public Bookmark list using the Search application or filtering by person or tag to locate bookmarks of interest.

    • Add a tag or person to your watchlist. A watchlist maintains a dynamic list of recent bookmarks associated with tags or people that are of particular interest to you. After adding a tag or person to your watchlist, click the My Updates tab to view your list.

    What's new in Bookmarks?

    These features are new or enhanced for this version of Bookmarks.

    The following features are new for Bookmarks:

    • A new user interface makes it easier for you to access and manage bookmarks.

    • When you install the Add Bookmark browser button, you also have the option to install a Discuss This and Related Community browser buttons for posting web pages to an IBM Connections forum or linking together related communities.

    Create a bookmark

    You can save a web page URL as a bookmark that you and others can use to access the page. There are two ways to create a bookmark. If you know the URL you want to bookmark, you can click the Public Bookmarks or My Bookmarks tab and click the Add a Bookmark button. Fill in the form to create a bookmark to the URL you specify. If you want to bookmark from a web page you visit, follow the steps to install the browser button so you can easily add a bookmark to a site you want to share or revisit.

    1. If you have not done so already, install the Add Bookmark browser toolbar button from the Bookmarking Tools link in the footer of the Connections window.

    2. Open a web page to bookmark.

    3. Click the Add Bookmark button in the browser toolbar.

    4. Optional: Enter information for the bookmark such as a description and tags.

    5. Optional: Select where you want to add the bookmark. Depending on what is deployed in your organization. you can save a bookmark to:

      • Bookmarks

      • Communities

      • Activities

      • Blogs
      When you add a bookmark to a community, you can specify a message for the community and you can choose to add the bookmark to the community list of important bookmarks.

      If your organization does not deploy an application, it does not display as an option.

    6. Specify whether you want the bookmark to be Public, so that other users can see it, or Private, available only to you.

    7. Click Save to add the bookmark to My Bookmarks.

    Use tags

    Tags let you assign keywords to your bookmarks that are meaningful to you. Tags provide a useful way to categorize your bookmarks and search for bookmarks that are of interest to you. Use the tag cloud to view all tags assigned to bookmarks in the list, to determine the popularity of a tag, and to access bookmarks associated with a tag.

    You can choose how the tags in a tag collection are displayed . either in a list or in a cloud. A tag list displays the tags in a list starting with the most popular tags first. A tag cloud visualizes the popularity of the tags in the collection by grouping the tags together and displaying the most frequently used tags in larger, darker text and less often used tags in smaller, lighter text. Tags are single words, or multiple words connected with hyphens or underscores . for example, social-bookmarking, status_reports, and payroll would all be valid tags. To work with a tag cloud, view Public Bookmarks, My Bookmarks, or another person's bookmarks.

    1. Click a tag in the cloud to view bookmarks associated with the tag. Bookmarks associated with that tag display.

    2. To further filter the bookmark list, enter or click another tag name to view bookmarks that are tagged with the selected tag (or tags) and the filter tag that you specify.

    3. Continue to refine search results until you have the set that you want.


    Tagging tips

    Use these tips to help you get the most out of tagging.

    When you are ready to start assigning tags, review these tagging strategies:

    • Make your tags work for you. Create or choose tags that are meaningful to you. Also consider creating tags that other users might find meaningful. When you add a tag, look at any matching tags that are displayed to see how other users are tagging information. Type a tag into the search field to see other information that shares the same tags.

    • Assign multiple tags. You can assign as many tags as you want to provide multiple ways to find the information. Look at the tag cloud to see which tags are popular and consider whether they also apply to your information.

    • Keep your tags simple. Although you can use any term as a tag, try to avoid using compound tags. For example, instead of using the tag summer_project, use summer and project instead. That way the item displays in the search results for either tag.

    • Create meaningful categories. When you create or select a tag, consider the context and choose words that will help you remember that context. You can use tags to organize information into one or more categories, so that you have multiple ways to find the information again.

    • Use tags consistently. Avoid assigning variations of the same tag to other bookmarks. For example, if you assign the tag laptops to a bookmark about portable computers, do not create similar tags, such as laptop or lap-top. When you type a new tag, existing tags that match are displayed in the field. Select an existing tag if it is applicable. You can add, edit, or remove tags later, if you want.


    Manage tags

    Manage tags to combine similar tags or remove tags you no longer need. You must be logged in to manage your tags.

    1. Click More Actions > Manage My Tags to find and rename tags or delete tags.

    2. Select one or more bookmarks, click More Actions and do any of the following:

      • Click Add Tag(s) and enter a tag name to add it to all of the selected bookmarks.

      • Click Replace Tag and enter the tag you want to replace and what you want to replace it with for all of the selected bookmarks.

      • Click Delete Tag(s) and enter the name of the tag to delete from all selected bookmarks.

    Add a bookmark to another IBM Connections application

    Add a bookmark to a community, activity, or blog. You can add a bookmark to a community, activity, or blog to make it more widely available.

    1. Choose More for the bookmark that you want to share.

    2. Click More Actions.

    3. Select Add to Community, Add to Activity, or Add to Blog to display the form for creating a bookmark.

    4. Set the community, activity, or blog where you want the bookmark displayed.

    5. Click Save.

    Viewing bookmarks

    Use the tabs in the Bookmarks toolbar to access the various bookmarks views. Each Bookmarks view provides a unique perspective on the bookmarks collected.

    Click one of the following tabs in the Bookmarks toolbar:

    My Bookmarks

    To list bookmarks that you have created. Your private bookmarks display a lock icon . You must be logged in to see the My Bookmarks list.

    Public Bookmarks

    To list all public bookmarks. The most recently created bookmarks are placed first on the bookmarks list.

    Popular

    To list bookmarks that are bookmarked most frequently over a given time frame. The time frame is configurable by the system administrator.

    My Updates

    To view bookmarks associated with a tag or a person that you have added to your watchlist. The watchlist is a convenient way to keep track of the latest bookmarks for a person or tag that you are interested in. You must be logged in to see or add items to your watchlist. You can also track notifications you have received and sent from this page.


    Results

    There are other ways that you can browse for bookmarks, including:

    • View the Most Visited Bookmarks list on the Public Bookmarks page. Click View All to see the full list.

    • Click a tag in the tag cloud or list to view bookmarks associated with that tag.

    • Click a person's name in the People list to view bookmarks associated with that person. If you are viewing an unfiltered list of bookmarks, the People tab lists the most active bookmarkers. If you have filtered the bookmark list, the People tab lists people who have applied the filter tag to at least one bookmark. A number associated with the person's name indicates how many bookmarks they have created with the filter tag or tags. When you are viewing your own bookmarks, the People tab displays related people who have at least one bookmark in common with you.

    • Click a person's name associated with a bookmark to view all bookmarks associated with that person.


    Refining the bookmarks list

    Filter the list of bookmarks to view all the public bookmarks created by another person, or to view all bookmarks associated with a specific tag. Choose a sort criteria.

    Use these techniques to filter and sort bookmarks:

    • Display Public Bookmarks or Popular bookmarks. Popular bookmarks show bookmarks that are created most often and the most visited bookmarks.

    • Change the sort order by clicking Date or Popularity. Clicking either button again toggles the sort order between ascending and descending order.

    • Filter the bookmark list in Public Bookmarks or Popular by clicking a tag or a person's name or searching for a tag or person's name to see bookmarks associated with that tag or person.

      You can filter by both tag and person name to create a very specific search. For example, you can search on the tag rebates and then find bookmarks with that tag created by Samantha Daryn.


    Search for bookmarks

    Use search to quickly locate a bookmark according to various criteria.

    The search scope determines what bookmarks are searched. You can change the search scope using the menu control for the Search field. For example, you can search all bookmarks, or narrow the scope to search only your bookmarks.

    1. From any Bookmarks view, enter a search string in the Search field.

    2. Use the drop-down menu control next to the search field to choose the search scope. The scope can be:

      • Public bookmarks. Searches all bookmarks for your organization.

      • My Bookmarks. Searches only bookmarks that you created. You must be logged in to use this application.

      • These Bookmarks. Searches a subset of bookmarks. For example, if you have filtered the bookmark list to see all bookmarks with a particular tag, you can search only that group of bookmarks.

    3. Click the Search icon to begin the search. Bookmarks are returned in the order of relevancy.


    Create a single bookmark view

    Find a bookmark by specifying the URL and the email address of the bookmark owner. If you want to find a specific bookmark, you can enter the URL for the bookmark and the email address of the owner in the address bar for Bookmarks to find the bookmark. For example, if a colleague tells you about a web page you might find useful, you can enter the url and the email address of your colleague to find the bookmark. You can then add the bookmark to your collection.

    1. Log in to Bookmarks.

    2. Click in the address bar and specify the email address of the bookmark owner and the URL for the bookmark, using this format: 

      email=[email-address]&url=[bookmark-url]
      For example: 

      https://w3.ibm.com/connections/dogear/html?email=sdaryn@us.ibm.com&url=http://www.ibm.com

      The example displays the bookmark to www.ibm.com created by Samantha Daryn. You can then add it to your bookmarks or take any other action on it.

    Viewing business cards

    Bookmarks can display a business card containing information about bookmark owners, their roles within the organization, their management structure and more.

    Your administrator must install the Profiles application before you can view business cards.

    The personal information available is determined by your system administrator in accordance with your company's guidelines and policy. The profile card displays contact information and links to other IBM Connections applications associated with that user.

    To view personal information:

    • Point to a person's name in a bookmark displayed in the bookmarks list and click Ctrl-Enter to view the associated business card.

    • Point to a person's name in the People list and click to view the associated business card.

    Notifying other users about a bookmark

    Send an email message notifying a colleague about a bookmark of interest. You can notify one or more colleagues about a single bookmark, or you can notify others about multiple bookmarks from your bookmark collection. To send an email to a colleague with a link to a bookmark of interest, log in to IBM Connections Bookmarks and follow these steps.

    1. View a bookmark, clicking More, if necessary, and choose Notify Other People.

    2. Enter the names of one or more users to notify. Type-ahead assists you with finding the names of users in your organization. You can also enter an email address.

    3. Enter an optional message.

    4. Click Notify to send an email message with a link to this bookmark.


    Results

    Your colleague will get an email with a link to the bookmark. The email also includes a link to the on-line help page for Connections Bookmarks in case the recipient is not familiar with the service.

    Flagging a bookmark as broken

    Notify a bookmark owner that a bookmark link is broken. If you encounter a bookmark that leads to a broken link, you can notify the bookmark owner so that they can repair or remove the bookmark.

    1. Select More for the bookmark that you want to report.

    2. Select More Actions > Flag as Broken URL.

    3. Edit the default text if you want.

    4. Click Send notification to bookmark owner to send an email message with a link to this bookmark to the owner.

    5. Optional: If your site administrator has configured this option, you can click Send notification to all active users who bookmarked this so that everyone who has bookmarked this URL can take action on the broken link. After checking this option, you will get a message telling you how many people will receive a mail message about this link so you can decide whether or not to send the notification mail. If your site administrator has disabled this option, it will not display on the notification form.

    6. Click Send Notice to send the notification.

    Add bookmarks to your watchlist

    You can add bookmarks associated with a person, with a tag, or with both a person and tag to your watchlist. The watchlist maintains a list of the most recent bookmarks associated with the person or tag that you specify. Click My Updates to view the tags and people you have added to your watchlist. You must be logged in to use this feature.

    1. To add a person to your watchlist, display the person's bookmarks and click Add to Watchlist in the bookmark status bar. The name of the person is added to My Watchlist so that recent bookmarks created by that person are automatically added to the list.

      The My Updates view shows bookmarks from a certain period of time, such as the last two weeks. The time period is configurable by the administrator. If a subscription that you view does not include any recent bookmarks, it is possible that there are not any bookmarks listed in the My Watchlist list.

    2. To add bookmarks associated with a tag to your watchlist, filter the bookmarks list according to a tag by viewing Public Bookmarks and clicking a tag. Click Add to Watchlist in the bookmark status bar. Recent bookmarks associated with that tag are added to My Watchlist.

    3. To create a list that includes bookmarks created by a specific person and marked with a particular tag, display the person's bookmarks and click a tag in the tag cloud or a tag displayed in the bookmarks list. When you click a tag, the bookmarks list is sorted by person and tag. Click Add to Watchlist in the bookmark status bar to add this person's bookmarks associated with the selected tag to your watchlist.

    Subscribe to feeds

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Create a feed from a Bookmarks view

    You can subscribe to a feed to make a collection of bookmarks available to you in a feed client of your choosing so that you can access bookmarks without having to use the Bookmarks site. You can also use the feeds to integrate Bookmarks content into other web sites or applications.

    You must have a feed reader available to set up a feed. Follow these procedures to set up a feed:

    1. Navigate to a view of bookmarks to convert to a feed. For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Click Feed for These Bookmarks and follow the on-screen instructions to choose a feed reader and set up a feed.


    What to do next

    You can also embed a collection of bookmarks in a web page. To do so, click How to Embed These Bookmarks and follow the on-screen instructions to display bookmarks in a web page.

    Copy a bookmark

    You can copy another person's bookmark into your bookmark list to capture a bookmark without navigating to the actual web page represented by the bookmark. To copy a bookmark:

    1. View Public Bookmarks, Popular bookmarks, or another person's bookmarks.

    2. Click More to display all options for the bookmark.

    3. Click Add to My Bookmarks. The bookmark is copied from the displayed bookmarks list and added to the My Bookmarks list.

    Import bookmarks from a web browser

    Use the import and export tools, available from the My Bookmarks page, to move bookmarks into and out of Bookmarks. For example, you might import bookmarks that you created and saved in your browser to initially populate your bookmarks list.

    You must export bookmarks from your browser before you can import them into Bookmarks. When you export bookmarks, your browser creates an export file that you can import into Bookmarks. After you determine which browser bookmarks to share, refer to your browser's help for the procedures required to create a bookmark export file. If the browser bookmark was stored in a folder, the folder name is applied to the bookmark as a tag. Tags that you added during the import operation are displayed by all imported bookmarks.

    When you export bookmarks from Microsoft Internet Explorer, the exported file might be saved in a format, such as ANSI, that Bookmarks does not support. In that case, you will get an error when you try to import the file. After you create the bookmark file, follow these steps to change the format of the bookmarks file to UTF-8 before you import the file.

    1. Open the Bookmark.htm file in a text editor such as Notepad.

    2. Click Save As.

    3. Change the Encoding on the file from ANSI to UTF-8.

    4. Save and close the text file.
    To import a bookmark export file:

    1. Use your browser to create a bookmark export file.

      To export a subset of bookmarks, create a folder and copy the bookmarks into it to export. Create a bookmark export file from that folder.

    2. From the My Bookmarks page, click More Actions > Import Bookmarks.

      If you have not yet created any bookmarks from within IBM Connections, there will be an option to Import Bookmarks on the My Bookmarks page.

    3. Use the browse control to locate the bookmark export file.

    4. Choose whether to import all bookmarks or a subset that you specify.

    5. In the Add Tags field, enter any tags you want to apply to imported bookmarks.

    6. By default your bookmarks are imported as private. Clear the Import as private option if you want your bookmarks to be made available to other Bookmarks users.

    7. Click Import to add bookmarks in the selected export file to your bookmarks list.

    8. If you are selecting a subset of bookmarks, check the ones you want to import and click Import.

    Export bookmarks to a file

    You can export bookmarks to a file that can then be imported into a browser or shared with someone who does not use Bookmarks. You must have created at least one bookmark to use this application. To export your bookmarks:

    1. From the My Bookmarks page, click More Actions > Export My Bookmarks.

    2. Provide the following information for the export file:

      Option Description
      Access

      Select the type of bookmarks to export: Public, Private, Both public and private.

      Network

      Select the type of bookmarks to export: Internet, intranet, both Internet and intranet.

      Tag Filter

      Enter one or more tags to use as export filters. Only bookmarks associated with these tags are included in the export file.

    3. Click Export.

    4. In the Export File window, select one of the following options:

      • Open With on Mozilla Firefox, or Open on Microsoft Internet Explorer, to choose a program, such as a browser, with which to open the exported HTML file and view exported bookmarks.

      • Save File on Mozilla Firefox, or Save on Microsoft Internet Explorer, to save bookmarks in an HTML file that will be placed on your desktop.

    Add a bookmark list to a web site

    You can embed a Bookmarks page in a web site to make it available to site users.

    You should be comfortable editing HTML to do this task because you must insert the bookmark list in the HTML source for a web page and then apply a cascading style sheet (CSS) to format it. Follow these steps to embed a view of the current Bookmarks page into a web site.

    1. From the Bookmarks view to embed, click How to Embed These Bookmarks in the footer of the page.

    2. Follow the instructions for how to add a bookmark list to the page of a web site.

    Work with your bookmarks

    You can work with your bookmarks to delete bookmarks, manage tags, or mark bookmarks public or private. You can edit or delete any bookmark that you create.

    1. Select the My Bookmarks tab. You must be logged in to work with your My Bookmarks list.

    2. Click the selection box next to one or more bookmarks and click one of the following:

      • Notify to send a notification email to one or more users with links to the selected bookmarks.

      • Delete Selected to delete the selected bookmarks.

      • More Actions > Add Tag(s) to enter and add tags to the selected bookmarks.

      • More Actions > Replace Tag to enter an existing tag and then specify a replacement tag to apply to the selected bookmarks.

      • More Actions > Delete Tag(s). Enter a tag to delete from the selected bookmarks.

      • More Actions > Mark Public to make the selected bookmarks available to all of the Bookmarks users in your organization.

      • More Actions > Mark Private to only make the bookmarks available to you.

    3. Import bookmarks, export bookmarks, or manage tags, as follows:

      • More Actions > Import Bookmarks. Follow the instructions for importing bookmarks from your browser into Bookmarks.

      • More Actions > Export My Bookmarks. Follow the instructions for exporting your bookmarks to a file. You must have created at least one bookmark to use this feature.

      • More Actions > Manage My Tags to consolidate tags.

    Communities

    Get together with people who share your interests.


    What.s new?

    Find out what features have been added since the last release.


    Get Started

    What is a community?

    A community lets people who share a common interest interact with one another.


    What makes a community?

    Communities are groups of people with a common interest. A public community with open access is available for all to join, while membership of a restricted community is limited to a particular group. You can also start a public community with invitation-only access, allowing you to control membership and manage access to the community's resources.

    A community provides the means for users to stay in touch, share information, and exchange ideas. Communities provide an excellent way to connect members of a project team, organize a task force researching an emerging technology, or bring together a group of people who share any interest.

    Starting a community can help you to build a valuable repository of information and expertise about a specific subject. In addition to sharing files, bookmarks, and other resources, when members need the solution to a specific problem, posting a question to the community forums is a great way to leverage knowledge within the community. Experts within the community can answer the questions and share their insights with other members.

    Use the tools provided with the Communities application to reach out, make connections, get organized, and start sharing information. As a community owner, you can invite others to join, and manage the content and membership for the community. If owner moderation is enabled, you can also review and manage the content of community blogs, files, and forums.


    Communities highlights

    Whether you are joining a community or starting one of your own, you can use these features to get the most out of your experience.

    • Click I.m a Member to see a list of the communities that you belong to.

    • Participate in a community's discussion forum to explore topics of common interest and debate solutions to shared problems.

    • Owners can access the Members page to add or remove members from your community. All members of the community can view the list of people who belong to the community.

    • Use tags to assign descriptive keywords to your community. Tags are useful for searching for a particular type of community or filtering search results.

    • Bring information into your community by sharing files and bookmarks with fellow members.

    • Add widgets to your community to make extra functionality available to members. For example, you might want to add a wiki to get your community collaborating or a blog for posting the latest community news. You must be a community owner to add widgets to a community.

    • Organize your community membership using subcommunities to create smaller subsets of members within the parent community. You must be a community owner to add subcommunities to a community.

    What's new in Communities?

    This release contains features designed to make communities easier for you to use to share information and to collaborate with fellow community members.

    • The Events widget allows community owners to share information about upcoming events with the rest of the community.

    • For deployments that make use of owner moderation of communities, owners can disable content approval and content flagging on individual communities.

    • Use the Related Communities widget to suggest communities for colleagues to join.
    • Share status with members of your community.

    • The Recent Updates view provides a centralized place to see what is new in a community.

    • You can add more information to the community description and it is collapsible.

    • LDAP groups can now be added as members of a community.

    Frequently asked questions in Communities

    Find answers to the questions that Communities users ask most often.

    Can I join any community?

    You can join any public community that has public access. Some public communities have moderated access, which means that you must request membership and your request must be approved by a community owner. Restricted communities limit membership to a specified group, and you must be added by a community owner to become a member. You can join any community where you have a pending invitation.

    I just joined a community and am finding lots of useful information. How do I extend membership to my colleagues who might also benefit from membership?

    You must be a community owner to add members to a community. Why not send a link to the community to the people who you think might be interested in joining, or ask a community owner to add them as members. Community owners of public communities can also invite people to join a community. The invitee receives an email notification inviting them to join, which they can accept or reject.

    What is the difference between a bookmark and a feed?

    A bookmark is a pointer to a web site that makes it easy for you to retrieve the URL or web page at a later date. You can add bookmarks to a community from web sites or directly from your community. A feed is a regularly updated summary of content from a web site, along with links to full versions of that content. Community members can subscribe to feeds containing content of interest to the community, allowing them to access updated content from the feed without having to leave Communities.

    How many important bookmarks can I add to my community?

    You can add a maximum of 100 important bookmarks to your community.

    Can I create a community forum and make it private?

    You can only add a forum to a community when you are a community owner. If the community is public, anyone who has access to Communities can see the content of the forum. If your community is private, only community members can see the content of the forum.

    Is it possible to edit forum posts that another person has added?

    Yes, but only if you are a community owner.

    How do I archive topics in a community forum?

    There is currently no way to archive topics from a community forum.

    How can I collaborate with other members of my community?

    You can share ideas and information with other members of your community by posting topics to the discussion forum, writing a blog entry, sending email notifications, and adding bookmarks and feeds to the community. You can also collaborate on shared projects using community activities or a wiki, if your community has one.

    How do I create different distribution lists within a community?

    If you are a community owner, you can create subcommunities within a community to bring together a subset of community members. This functionality is useful when you want to set up distribution lists that don't include every community member, or when you want to create specific focus groups within a community.

    What is a widget?

    A widget is a self-contained, HTML-based representation of a software application. Community owners can add widgets to communities from the selection available in the content palette. Widgets appear in the Overview and in the community navigation.

    Why add widgets to my community?

    Add widgets to your community allows you to make extra functionality available to community members. For example, adding the Wiki widget makes a wiki available for members to collaborate and create community content together. You must be a community owner to add widgets to a community.

    How do I restrict members from adding content to a community?

    If you are a community owner, you can remove any of the widgets in a community. For example, if you want to stop members from adding bookmarks to a community, you can remove the Bookmarks widget from the community by going to the widget action menu and selecting Hide or Remove. Hide the widget removes it temporarily, but removing the widget deletes all of the content associated with the widget. You can add the widgets back to the community at any time by clicking theCommunity Actions > Customize button on the community page and selecting the widget.

    As a community owner, you can also restrict community members from adding content to the community blog or wiki, or from uploading files to the community by editing their membership role. To change the access level of community members, select Community Actions > Edit Community, select the Blog, Ideation Blog, Files, Events, Status Updates, or Wiki tab, and specify what the role to assign to community members. All members are assigned the same role.

    You must be logged in to access the Community Actions menu.

    How do I unsubscribe from community emails?

    There is currently no option available for unsubscribing from community emails within Communities. As a workaround, consider setting up a filter in your email client. Note that you can disable email notifications for all of IBM Connections from the E-mail Preferences tab. For more information, see Set email notification preferences.

    How do I keep up-to-date with the latest activity in my community?

    You can stay current with what is going on your community by clicking Recent Updates in the community navigation.

    How do I find out what communities a person is a member of?

    The easiest way to find out what communities a person belongs to is to open Communities, look for that person's name, and then try one of the following actions:

    • If your site uses the Profiles application, then hover your cursor over the person's name and click the link to view their business card. If you click Communities in the business card, it displays the list of all the public communities to which that person belongs.

    • If your site does not use Profiles, then clicking the name displays a list of all the public communities to which that person belongs.

    I accidentally clicked the Leave Community button for a community that I own. How do I get reinstated as a community owner?

    If you are the only owner of a community, you cannot leave that community. If you were able to leave the community, that means that there must be at least one other owner who can reinstate you as an owner.

    How do I replace the image used as the logo for my community?

    You must be a community owner to edit the community logo. To replace the community logo, select Community Actions > Edit Community and click Upload a Community Image.

    You must be logged in to access the Community Actions menu.

    Browsing or searching for communities

    You can browse or search for communities that are of interest to you.

    You can use a number of ways to find communities that interest you and connect with them. For example, you can browse to see what communities are available, or you can search on particular keywords.

    Tags are a handy way to search or browse for a community. For example, if you are interested in photography, search for a photography tag to find all communities that use that tag. When you're creating a community, remember to include relevant tags to indicate the purpose of the community and make it easier for others to find.

    You can browse or search for a community in the following ways.

    • To browse for a community:

      1. Click Communities > Public Communities to display all the public communities in your organization, or use the options available from the navigation bar to display the communities to which you belong, the communities that you own, the communities that you are following, or the communities where you have a pending invitation. You can view a description of each community, the number of members it has, the date it was last updated, the name of the person who last updated it, and the tags associated with the community.

        If your administrator has enabled Lotus Quickr places, use the Display field to select whether or not you want to show only communities, only places, or all communities and places.

      2. Use the Sort by options to order the list alphabetically, by the most popular communities, or by the most recently updated.

    • To search for a keyword that displays in a community's name, description, or tags:

      1. Enter a word to search for in the Search field.

      2. Specify whether you want to search all communities or your own communities by clicking the Down arrow and making a selection.

      3. Click the search icon.

    • To search for a community by tags:

      • Click a tag in the tag cloud to find communities that use that tag.

      • Find a community in the view that interests you. Then, to find other communities that use that tag, click one of the tags associated with the community.

    • For any community, you can:

      • Click the name of the last person who updated the community to view.

        • If your site uses the Profiles application, then clicking the name displays the profile for that person. Hover your cursor over the person's name and click the link to view their business card. If you click Communities in the business card, it displays the list of all the public communities to which that person belongs.

        • If you site does not use Profiles, then clicking the name displays a list of all the public communities to which that person belongs.

      • Click the community name to open its Overview page.

    Use the Communities business card

    Use the Communities business card to navigate to key pages in the community from other applications in IBM Connections or other applications that are integrated with Communities.

    When you add an external application or application to your community, the community business card displays in that application when it is opened in its native user interface. For example, when you open a community blog in Blogs, the community business card displays in the Blogs user interface in the navigation sidebar, allowing members to return to the community at any time. You can recognize the community business card by the community navigation links that display, for example: Overview, Recent Updates, Status Updates, Members, Forums, and other widgets.

    By displaying the community image, the card creates a visual link between the associated application and the community, and clearly identifies the application as belonging to the community.

    You can use the community business card in the following ways:

    • Click the community title or image to open the community's Overview page.

    • Click any of the links in the business card to open that page in the community.

    Joining communities that interest you

    You can join a community in a number of different ways.

    When a community has public access, anyone can join by opening the community and clicking Join this Community. If the community has moderated access, you need to request membership. You can also be invited to join a community, if someone you know already belongs to the community and invites you to become a member.

    The Recommended Communities widget is a useful way to find communities that you might be interested in joining.


    Joining communities

    Join a community that is devoted to a subject that you are interested in and start participating.

    To find a community to join, you can browse all the public communities in the organization in the Public Communities view, or search for a community that is devoted to a particular subject. You can also use suggestions from the Recommendations widget to find communities that might interest you.

    You must be logged in to join a community or to request to join a community.

    You can join public communities with open access by clicking a button, but you must request to join public communities that are moderated. Restricted communities are private and they do not display in the Public Communities view. The only way to join this type of community is when a community owner adds you as a member or invites you to join.

    To join a community.

    1. Click Communities > Public Communities and select the community to join.

    2. Depending on the level of access that the community has, do one of the following:

      • If the community has open access, select Join this Community.

        If you receive a message that the community has already reached the maximum number of members, contact a community owner to see if any inactive members can be removed. Click Members in the navigation and then select Owners in the Filter by field.

      • If the community has moderated access, select Request to Join this Community. Type your reason for wanting to join the community and click Send. Your request is sent to the community owner, who can then decide whether or not to add you to the community. If they add you as a member, you receive an email notification confirming that you have been added to the community.


    Results

    When you join a public community, the community is immediately added to the list of your communities in the I.m a Member view. When you request to join a moderated community, the community does not display in the I.m a Member view until your membership is approved by the community owner.


    Accepting community invitations

    When you receive an invitation to join a community, you can accept or reject the invitation.

    When a community owner or member invites you to join a community, you receive an email notification containing the invitation and some basic details about the community, such as its name and its description. You can accept or reject the invitation using the links provided in the email. These notifications also display in the Home page.

    You can process a community invitation in one of the following ways:

    • To accept the invitation and join the community, click Join this community.

    • To reject the invitation, click Decline this invitation. The community owner does not receive any notification that you rejected the invitation.

    • You can ignore the invitation by not taking any action. When you ignore an invitation to join a community, the invitation can be kept open indefinitely, unless a community owner chooses to revoke it. The community owners also have the option of resending the invitation as a reminder.


    Use the Recommendations widget in Communities

    Find communities that interest you using the Recommendations widget.

    You must be logged in to see the recommendations provided by the Recommendations widget. The Recommendations widget recommends public and moderated communities for you to join based on your existing community membership, network connections, status updates, and tags.

    The widget displays a list of communities and information about the ways in which you are already linked to those communities. For example, one of your network contacts might have recently added content to a recommended community. Or you might have used a tag that has been added to a recommended community.

    You can use the information provided by the widget to help you decide whether to join a recommended community. If you are not interested in the community, you can remove the recommendation.

    Use the Recommendations widget in the following ways.

    • Click the links under the community titles to find out more about what you have in common with the community.

    • If a community interests you, click the community title to open the community and join it, or to browse its content.

    • To remove a recommendation, click next to the community name.

    Create communities of colleagues with similar interests

    Start a community to encourage people in your organization who have similar interests or goals to collaborate with one another.

    Communities can be public or restricted. Public communities are visible to everyone in the organization and, depending on the level of access that you specify, can be available to everyone, or have moderated access that requires ownership approval before you can join. Restricted communities are available only to those people who have been added to the community as members. Restricted communities are not visible to people who do not have community membership.

    To start a community:

    1. From any view in Communities, click Start a Community.

    2. If you are not already logged in, you are prompted for a user name and password. Provide the requested information, and then click Log In.

    3. Required: In the Name field, type a name for the community. Choose a name that identifies the purpose of the community.

      You cannot have multiple public or moderated communities with the same name, however you can have multiple restricted communities with the same name. This naming system allows you to have a public and a restricted community with the same name, or a moderated and a restricted community with the same name.

    4. Enter one or more tags in the Tags field. Tags are keywords that you define to provide users with more ways to identify what a community is all about. Tags must be a single word or multiple words connected with underscores or hyphens. For example, a community that deals with accessibility issues might have the tags accessibility and low-vision. Tags give users more than one way to find a community of interest. The tags that you define here display with the community in the Public Communities view.

    5. To generate a web address for your community, enter a one-word, unique term that identifies the community in the Web Address field. This web address allows you and other community members to access the community using an easy to use URL. These terms are case sensitive, so community members must use the correct case when they access the community with the URL. If you do not want to create a community web address, leave this field blank.

      Since web addresses must be kept unique, other users might learn that a particular web address is in use even if it is for a restricted community. Avoid using web addresses that are sensitive or confidential in nature.

      Tip: Be sure to bookmark the full web address that displays when you complete the Web Address field to save the direct URL to the community.

      Notes:

      • Certain keywords with a technical meaning, such as html or atom, are reserved and cannot be used in community web addresses. If you enter a reserved keyword, an error message is displayed, and you are prompted to enter a different keyword.

      • If your web address contains a non-alphanumeric character, such as an ampersand (&), you must escape the character by using a forward slash ( / ) before the character.

      • If you do not see the option to create a web address for your community in the user interface, this means that your administrator has disabled this option for your organization.

    6. Required: Set the level of access that you want for your community:

      Table 37. Community access levels

      Option Description
      Public - anyone can join Select this option if you want the community to be public with anyone able to join.
      Moderated - people must request to join Select this option if you want the community to be public but for users to request membership.
      Restricted - people must be invited Select this option if you want the community to be restricted, with membership by invitation only.

    7. If your administrator has enabled the use of software acquired from another vendor . for example, IBM Lotus Quickr Team Place, or Lotus Quickr Wiki . specify whether you want to include these applications as part of your community by selecting the required application or applications in the Associated Applications area.

      If you do not see any options to include associated applications, then your administrator has not enabled this feature for your deployment.

    8. Enter the names of the people to add as community members. You can search for names from your organization's directory. Type-ahead predicts the name you are typing by comparing it to names in the directory that your administrator specified. If it proposes the name that you want, click to add it. If you do not want to add community members now, you can edit the community at a later stage and add the members then.

      To add community owners, click the Down arrow next to Members and select Owners, then repeat the process described in this step for adding community members.

    9. Type a description of the purpose of the community in the Description field. Be as specific as possible. Identify the community's goals.

    10. Click Upload a Community Image to browse for an image to associate with the community on the overview page. The image must be 155 x 155 pixels in size, and it can be in .jpeg, .gif, or .png format.

      There are no file size restrictions. However, because the image is automatically resized to 15 KB on the Communities server to fit the allocated space in the user interface, you should keep in mind that the larger the file you upload, the longer the server takes to process the image.

      Image resizing does not support all image formats. If you encounter problems with uploading an image, converting the image to a different format often works.

    11. To apply a different theme to the community, click Change Community Theme and select a theme.

    12. If moderation is available and editable at your site, you can select from the following options:

      • Owners must approve all content (widgets) where widgets might be one or more of the following widgets: blogs, files, or forums. When this option is enabled, community owners can review unpublished content that has been submitted for approval and decide whether to publish it to the community or reject it.

      • Viewers can flag inapproriate content (widgets) where widgets might be one or more of the following widgets: blogs, files, or forums. When this option is enabled, community owners can review content that has been flagged as inappropriate by other users, and decide whether to keep the content or remove it from the community.
      For more information about moderation in communities, see Moderating community content.

    13. Click Save.


    Associated applications

    When you create or edit a community, you can associate different applications with the community, if your administrator has made them available for your deployment.

    When your administrator has enabled associated applications for communities, the Start a Community and the Edit a Community forms display an Associated Applications area that lists the options available for your deployment.

    For example, the administrator can enable you to associate an IBM Lotus Quickr team place with a community, giving you a central location to store and manage files, and share information with fellow community members. Wikis might be another option available for associating with a community. Wikis provide a place for community owners and members to collaborate easily and quickly with each other.

    When you associate an application with a community:

    • A link to the application appears in the navigation sidebar on the community's Overview page.

    • A feed from the application is displayed in the main pane of the Overview page, allowing community members to stay current with the latest information updates.

    • Community members automatically become members of the teamplace or wiki, and any changes to community membership are propagated to the associated application.

    • Community members have access to any feeds associated with the application.

    • Attachments and comments within the application are accessible from the community.

    You can associate a Lotus Quickr application with a community. Depending on your needs, your administrator can enable different types of Lotus Quickr places for association with a community. Options might include the following types:

    • Wiki . creates a place where community members can collaborate and create shared content.

    • Blog . allows community members to post comments in a blog and share information with their team.

    • Team space . creates a place where team members can manage different types of content.

    • Library . creates a place for team members to store and manage project documents and files.
    The administrator can also make custom place types available for association with a community.

    Deleting a community does not automatically delete the Lotus Quickr place associated with it. To delete the associated Lotus Quickr place, you must open the Lotus Quickr application and delete the place from within the application.

    After you have associated an application with your community, do the following actions:

    • To work directly with a wiki or Lotus Quickr place, click the associated link in the navigation pane. For example, if you have associated a Lotus Quickr wiki with your community, click Quickr Wiki to open the Lotus Quickr wiki associated with your community and work directly with it in the Lotus Quickr application.

    • To open a feed associated with a wiki or Lotus Quickr place, click the feed link in the main pane of the community's Overview page to open it in a new page. When you associate a wiki or Lotus Quickr place with a community, a number of default feeds are automatically created. For example, if you have associated a Lotus Quickr teamplace with your community, the following default feeds display: Team Goals, Team News, and Welcome. You can choose to subscribe to other feeds from the associated application.

    • To access help when working with an associated application outside of IBM Connections, click the Help link directly in the application for more guidance. For example, if you need more information when working with a Lotus Quickr wiki, click Help in the Lotus Quickr application.


    Related

  • IBM Connections Connector for Lotus Quickr

    Work with communities

    You can view the members of any public community or follow any public community when you want to receive the latest updates from that community. If you are a community member, you can send emails to your fellow members.

    You can leave a community at any time if you no longer want to be a member.


    Viewing members of a community

    Find out who else is in your community or a community that you are thinking of joining. Anyone who can access a community can view the members for that community.

    To view the members of a community, do one of the following actions:

    • Use the Members area on the community Overview page to view a random selection of members from the community. Click View All to display the complete list of members on the Members page.

      Where ever a member.s name displays in the community, you can access their business card by hovering over their name and clicking the link that is displayed. The business card provides a useful snapshot of a user's profile information. The business card provides links to the IBM Connections applications that are used by the person and allows you to perform a number of actions.

    • Click Members in the navigation pane to open the Members page and display a full list of the community membership. Use the Filter by menu to display the complete list of members or to sort the membership list according to role. Use the Sort by options to sort the display in order of Name, which lists members in alphabetical order, or Date Added, which lists the newest members first.

      The Members page also displays any groups that have been added to the community, but you cannot view the group membership list from the Members page.

    • To find a specific community member, click Find a Member on the Members page and enter a name in the field provided. As you start typing, names from the community membership list are suggested to you. When you see the name that you want, you can click it. If your site uses the Profiles application, the person.s profile displays. If your site does not use the Profiles application, a list of the public communities to which the person belongs displays.


    Following communities

    Follow a community when you want to be notified about the latest updates to the community, including updates to community content, for example, community activities, blogs, files, forums, wikis, and events. You are not automatically sent these notifications if you are a member of the community; you must follow the community to receive them.

    Anyone can follow a community as long as the community is publicly accessible; you do not have to be a community member to follow a public or moderated community. If you are a community owner or creator, then you are already following the community. You cannot follow a restricted community unless you are a member of the community.

    If you do not want to follow an entire community, you can follow specific community content to get updates about that content. For example, if you are interested only in receiving notifications about updates to a community's wiki, you can follow the entire wiki or a specific wiki page. To follow community content, open that content from the community and look for the Follow button. Click the button to view the options available for following that content.

    To follow a community, complete these steps.

    1. From the Public Communities, I.m a Member or I.m an Owner views, navigate to the community to follow.

    2. Click Follow this Community.


    What to do next

    You can view the communities that you are following by selecting the I'm Following view. You can also keep track of updates in the communities that you are following from the Home page by selecting Filter By > Communities in the I.m Following view.

    If you no longer want to receive notifications about the latest updates to a community, you can stop following it at any time. To stop following a community, open the community and click Stop Following this Community.


    Keeping your community updated through notifications

    Contact fellow community members and give them the latest community news using email. You must be a member of a community to mail members of that community.

    To send email to your community, email must be configured to display in your deployment. If the administrator has disabled email for your deployment, the Mail Community option does not display. You can send email to other community members directly from your community. There is no limit on the number of people that you can email, however, you cannot specify individual members of the community as recipients. You must send the notification to all community members or community owners only. Choosing the option to send the notification to all community members means that the email is also sent to community owners.

    You cannot send emails to groups.

    1. From the community's Overview page, select Community Actions > Mail Community.

      You must be logged in to Communities to access the Community Actions menu.

    2. Do one of the following.

      • To send the notification using your default email client, click Click to compose using your default email client.

      • To use the email form provided:

        1. Set the recipients of the email.

          • To send the message to everyone in the community, select Owners and Members.

          • To send the message to community owners only, select Owners Only.

        2. Enter a title for your message in the Subject field. The title is prefixed by the name of the community by default.

        3. Set the content of your message in the Message field and click Send.


    Get updates on a community

    You can keep up-to-date on what is new in a community through the Recent Updates page. The Recent Updates page displays the latest news stories and updates on your community. The updates are displayed in a list format that you can easily filter so you can quickly identify the updates that most interest you.

    Click Recent Updates in the community navigation and work with community updates in the following ways. The options that display depend on the type of update you are looking at.

    • Status Updates only display if the micro-blogging service has been enabled at your site.

    • To comment on an update, click Comment, enter your comment in the field, and click Post.

    • To access more options for working with an update, hover over the update and click it.

      • To notify the people who are following you about a status update, click Repost.

      • To show that you approve of an update, click Like.
      Click anywhere outside the window to close it.


    Manage who can post status updates to your community

    As community owner, you can manage who can post status updates to the community.

    1. From the Overview view, click Community Actions > Edit Community.

    2. Click the Status Updates tab.

    3. Select the whether owners, members, or non-members can post, and then click Save.


    Viewing status updates in your community

    You can keep up-to-date on what your team is doing by viewing the status updates that community members have posted to your community.

    The Status Updates widget makes it easier to find status updates, but status updates are also available in the Recent Updates widget. If you are a community owner, you can add the Status Updates widget to your community. See Add widgets to your community to make more functionality available.

    Click Status Updates in the community navigation and work with Status updates in the following ways.

    1. To comment on a status update, click Comment, enter your comment in the field, and click Post.

    2. To access more options for working with an update, hover over the update and click it.

      • To notify the people who are following you about an update, click Repost.

      • To show that you approve of an update, click Like.
      Click anywhere outside the window to close it.


    Sharing your status with the community

    Update your personal status message on the Status Updates page to let your community know what you are doing.

    You can share your status if the micro-blogging service is available at your site and if a community owner allows it.

    Keep people in your community up-to-date by frequently posting your personal status to the Status Updates page for the community. This message displays in the Status Updates page for the community, but it does not display in your profile or the Home page.

    To update your status message for your community, complete the following steps.

    1. From any view in your community, click Status Updates in the community navigation.

    2. Enter your status message in the text box. If you change your mind, and want to start over, click Reset.

    3. Optional: If you want to include a file in your status, click Add a File.

    4. Optional: To tag your message with a specific keyword, include the keyword prefixed with a hash (#) symbol as part of your message. When you save the message, the keyword is automatically converted to a link. Other people in your community can click the link to search for content tagged with the same keyword.

    5. Click Post.


    Sharing related communities with other members

    If you learn about a community that is doing work related to a community that you own, share that information with other community members.

    You must be a community owner to share related communities. If you do not see a related communities widget in your community, add the widget to your community so your team can share information about similar communities. A community can contain only one related communities widget. See Add widgets to your community to make more functionality available.

    Related communities let you link to other communities that might be doing work that interests your community. This product already recommends communities to you based on your community membership, network connections, and tags. Other members of this community might have a different set of community memberships, connections, and tags, so they receive different recommendations. You might also learn about an interesting community by another method. Related communities let you make others aware of these communities that might not be recommended to them or that they might have overlooked.

    It is a good practice not to share a restricted community as a related community. Only people that are already members can access it.

    1. On the community Overview page, click Add a Community in the Related Communities area of the page.

    2. Enter the URL for the community to share.

    3. Enter the name of the community.

    4. Enter a meaningful description of the community. Think about why the community relates to the current community, and why other members would be interested.

    5. Click Save.


    Results

    To edit or delete a related community, click Related Communities in the community navigation, and then click More next to the related community to delete or edit. Select Edit or Delete. Clicking More also displays recent updates for the community.

    Another way to share related communities with your team is to add the Related Community button to your browser. Click Bookmarking Tools in the footer of any page in IBM Connections to learn how to install and use the Related Community button. As you discover other communities of interest, click the Related Community button, and the Add a community dialog appears with the URL for the community already entered in the Community URLfield.


    Categorizing communities with tags

    A tag is a keyword that you assign to a community to categorize it and make it easy to find. Tag collections in Communities display the tags according to the view that you have currently selected.

    You can choose how the tags in a tag collection are displayed: in a list or a cloud. A tag list displays the tags in a list starting with the most popular tags first. A tag cloud visualizes the popularity of the tags in the collection by grouping the tags together and displaying the most frequently used tags in larger, darker text and less often used tags in smaller, lighter text.

    A tag can be a single word only and cannot contain any spaces. It can contain characters such as an underscore (_) or at sign (@). For example, you can use follow_up, follow-up, and followup as tags, but not follow up.

    The following table describes the tags that are associated with each view in Communities:

    Table 38. Tag views

    Page Displays the tags for
    Public Communities All the public communities up to a defined limit, at which point the tag cloud displays the most popular tags up to the defined limit. The cloud does not include tags on the content within these communities.

    There is a cache associated with tags in this view so tags might not appear immediately when added to a community. The cache defaults to 60 seconds.

    I.m a Member The communities that you belong to or own. The cloud does not include tags on the content within these communities.
    I.m an Owner The communities that you own. The cloud does not include tags on the content within these communities.
    I.m Invited The communities where you have a pending invitation. The cloud does not include tags on the content within these communities.
    I.m Following The communities that you are following. The cloud does not include tags on the content within these communities.
    Overview The activities, blogs, bookmarks, feeds, files, and wikis associated with the current community. The cloud does not include the tags assigned to the current community.

    Tag changes display only after the Search indexing task has run.

    Bookmarks All the bookmarks associated with the current community.
    Feeds All the feeds associated with the current community.


    Leaving communities

    You can cancel your membership in a community if you no longer want to participate in that community.

    You must be logged in to a community to be able to leave the community. If you are not logged in, the Community Actions menu does not display in the user interface.

    To leave a community.

    1. From the community's Overview page, select Community Actions > Leave Community.

      The last remaining owner of a community cannot leave the community.

    2. Click OK to confirm that you want to be removed from the community's membership.


    Results

    The community no longer displays in the I.m a Member view

    How do I add community members?

    As a community owner, you can add members to your community at any time. You can invite people to join the community, and, if the community is moderated, you can decide whether to accept or reject incoming membership requests. To add multiple members at the same time, use the import tool on the Members page.


    Add members with similar interests to your community

    As a community owner, you can extend your community by adding new members. Add people to a community automatically makes them members of the community. If you want to give people the option of choosing to become a member, consider inviting them to join your community instead.

    You must be a community owner to add members to a community. Your administrator configures the total number of members and groups that can be added to a community.

    To add new members to a community, complete the following steps.

    1. From the I.m an Owner view, select the community to which you want to add members.

    2. Click Members in the navigation pane.

    3. Click Add Members.

      • To add regular community members, enter the names of the people to add in the Members field. Type-ahead predicts the name that you are typing by comparing it to names in the directory that your administrator specified. If it proposes the name that you want, click to add it. If you do not see the name that you are looking for, click Person not listed? Use full search to search the company directory for the person.

      • To add community owners, click the Down arrow next to Members and select Owners. Then, enter the names of the people to add in the Owners field.

        Community owners have the ability to edit the community.

      • To add groups to a community, select Groups in the Members drop-down list, and then enter the names of the groups to add in the Members field. Type-ahead predicts the name that you are typing by comparing it to names in your organization's directory or contact list. If it proposes the name that you want, click to add it. Alternatively, you can search for a particular group by clicking Browse Groups, and then entering a keyword for the group and clicking the Find Groups icon . Click the group you want and then click Add. If the group contains nested groups within it, you can either add the parent group or select a nested group. Use the breadcrumb trail to switch between levels of nested groups.

        You cannot add groups as owners to communities.

        The group feature is available upon request. Contact your administrator for information.

      If the community has reached the maximum number of members and groups that can be added, consider asking your administrator to increase the limit.

    4. Click Save.


    Results

    The new members receive an email notification informing them that they have been added to the community. Email notifications are not sent to groups.


    Inviting people to join a community

    Extend your community by inviting people to become members.

    As a community owner, you can reach out to people who you think might be interested in your community by inviting them to become members. Members of a public community can also invite people to join the community. The invitees receive an email notification inviting them to join the community, and they can then choose whether to accept or reject the invitation.

    You can invite people to join only as regular members of a community; you cannot invite them to join as owners of the community.

    To invite people to join a community, complete the following steps.

    1. From the I.m an Owner view, select the community to which you want to invite new members.

    2. Click Members in the navigation pane.

    3. Click Invite Members.

    4. Set the names of the people that you want to invite in the Members field. Type-ahead predicts the name that you are typing by comparing it to names in the directory that your administrator specified. If it proposes the name that you want, click to add it.

    5. Click Send Invitations.


    What to do next

    You can view all the pending invitations for a community from the Invitations tab on the community's Members page. The tab displays information about when each invitation was sent and who it was sent to.


    Send batch invitations to offer membership to many people

    Send a batch email inviting multiple people to join your community using the import tool on the Members page. You can invite people to join only as regular members of a community; you cannot invite them to join as owners of the community.

    To send a batch email inviting people to join a community, you must be a community owner or the member of a public community. Verify with your administrator that your community did not reach the maximum number of members and groups that can be added.

    You can use the import tool to invite a group of people to join your community only when email is configured to be displayed for your deployment. If your administrator configured email to be hidden, then the Import Members button does not display in the user interface.

    You cannot resend or revoke batch community invitations.

    To invite multiple people to join a community, complete the following steps.

    1. Open the Members page of the community to invite people to join.

    2. Click Import Members.

    3. Select Invite people to the community.

    4. Do one of the following actions:

      • To invite people using their email addresses:

        1. Select Enter comma-separated email addresses.

        2. Enter the email addresses of the people to invite, and click Import.

        The email address format must match the format of the profile records in the LDAP directory or Profiles database. If you use an invalid email address, that is, one that does not match the format used in the profile records, an error is displayed in the user interface.

      • To invite people using email details in a comma-separated value (CSV) file:

        1. Click Select a CSV file of email addresses.

        2. Click Browse to locate the CSV file containing the email addresses of the people who you want to invite, and then click Import.


    Resending community invitations as reminders to join

    You can remind people about pending invitations to join your community by resending the invitation notification.

    You must be a community owner to resend community invitations.

    You can view all the pending invitations for a community from the Invitations tab on the community's Members page. The tab displays information about when each invitation was sent and who it was sent to.

    If you notice any invitations that have been pending for some time, you can remind the invitees about the invitations by resending the original notification.

    To resend a community invitation, complete the following steps.

    1. From the Overview page, click Members.

    2. Click the Invitations tab.

    3. Select the person to whom you want to send another invitation, and then click Resend.


    Revoking community invitations that are pending

    If you invite someone to join a community and later change your mind, you can cancel the invitation while it is still pending.

    You must be a community owner to revoke community invitations. If you are inviting people to join a community and you send an invitation to the wrong person by mistake, you can revoke the invitation as long as the person has not yet accepted it.

    You can view all the pending invitations for a community from the Invitations tab on the community's Members page. The tab displays information about when each invitation was sent and who it was sent to.

    To revoke a community invitation, complete the following steps.

    1. From the Overview page, click Members.

    2. Click the Invitations tab.

    3. Select the invitation to cancel and click Revoke.

    4. Click OK to confirm that you want to revoke the invitation.


    Results

    The revoked invitation is removed from the Invitations tab. If the invitee opens the original invitation notification and clicks Join this community, a message displays advising them that the invitation has been revoked.


    Accepting membership requests

    When you are the owner of a moderated community, you receive an email notification and a Home page notification whenever someone requests to join the community. If you do not want to accept a membership request, you can ignore or delete the request notification.

    To accept a membership request, add the email sender to the community for which they requested membership by completing the following steps.

    1. Open the email request, and click Add this Person as a Member. The Add Members form displays, with the name of the person requesting membership automatically added to the Members field.

    2. Click Save to add the person to the community.


    Results

    The new member receives an email notification informing them that they have been added to the community.


    Import multiple members into a community to save time

    You can add multiple members to your community at the same time using the import tool on the Members page. You must be a community owner to import members into a community.

    You can only import community members when email is configured to be displayed for your deployment. If your administrator has configured email to be hidden, then the Import Members button does not display in the user interface.

    Verify with your administrator that your community has not reached the maximum number of members that can be added.

    To import members into a community, complete the following steps.

    1. Open the Members page of the community

      ...where you want to import the members.

    2. Click Import Members.

    3. Ensure that Add people to the community as is selected.

    4. Select a membership role for the new members from the Add people to the community as list. All the members are given the same role.

    5. Do one of the following:

      • To import people using their email addresses:

        1. Select Enter comma-separated email addresses.

        2. Enter the email addresses of the people to import and click Import.

        The email address format must match the format of the profile records in the LDAP directory or Profiles database. If you use an invalid email address, that is, one that does not match the format used in the profile records, an error is displayed in the user interface.

      • To import members from a comma-separated value (CSV) file:

        1. Click Select a CSV file of email addresses.

        2. Click Browse to locate the CSV file containing the information to import, and then click Import.

    Community membership roles

    The actions that you can perform in Communities depend on the role that you are assigned. Find out what you can do as a community owner or member.

    Tip: Communities provides an easy way for you to sort your communities by membership role.

    • I'm a member. Displays the communities of which you are a member or an owner.

    • I'm an owner. Displays the communities that you own.

    • I.m invited. Displays the communities where you have pending invitations.


    What can I do as a community owner?

    Find out what actions you can perform in a community when you are a community owner.

    Tip: If you are unsure of what your role is within a community, open the Members page and look for your name or for the name of the group to which you belong. Your role displays under your name or group name.

    In addition to the tasks that a regular community member can perform, community owners can perform the following management tasks.

    Table 39. Management tasks

    Task type Community owners can
    Community management

    • Delete the community

    • Update the community name

    • Update the community description

    • Change the community access level

    • Upload an image to associate with the community

    • Change the theme of the community

    • Add and remove community tags

    • Edit and delete community content

    • Create, edit, and delete subcommunities

    • Moderate community content
    For more information, see Managing your communities.
    Membership management

    • Add and remove members

    • Invite new members

    • Revoke member invitations

    • Accept membership requests (in a moderated community)

    • Change the role of members

    • Import community members
    For more information, see How do I add community members?
    Widget management

    • Add widgets

    • Edit widget settings

    • Move widgets

    • Hide widgets

    • Delete widgets
    For more information, see Add widgets to your community.
    Community owners can also perform the following tasks when working with community resources.

    Table 40. IBM Connections widget tasks

    Resource Community owners can
    Activities

    • Edit and delete any community activities

    • Mark activities as complete

    • Add and remove activity members (by updating the community membership)
    For more information, see Working with community activities.
    Blog

    • Add, edit, and delete community blog entries and comments

    • Update the community blog title, description, and tags

    • Change the time zone associated with the community blog

    • Change the access level of community blog members

    • Moderate the content of your community blog (when owner moderation is enabled)
    For more information, see Using a community blog.
    Bookmarks

    • Edit and delete any community bookmarks
    For more information, see Add bookmarks to a community.
    Linked Library

    • Configure the display of folders and files
    For more information, see Using Linked Libraries.
    Events

    • Edit and delete any community events.
    For more information, see Scheduling community events.
    Feeds

    • Edit and delete any community feeds
    For more information, see Working with feeds.
    Files

    • Update and remove any community files from the community

    • Change the file access level of community members

    • Moderate the content of community files (when owner moderation is enabled)

    • Restore deleted files to the community (when trash is enabled)

    • Delete individual files from the trash (when trash is enabled)

    • Delete all files from the trash (when trash is enabled)
    For more information, see Add files to a community.
    Forums

    • Create, edit, and delete community forums

    • Edit, move, lock, pin, and delete forum topics

    • Moderate the content of community forums (when owner moderation is enabled)
    For more information, see Using community forums.
    Ideation Blog

    • Change Ideation Blog settings

    • Change the access level of members

    • Contribute, edit, graduate, and delete ideas

    • Set the number of ideas that can be posted

    • Freeze idea creation

    • Freeze an Ideation Blog
    For more information, see Using an Ideation Blog in your community.
    Media Gallery

    • Edit media gallery settings

    • Edit and delete any media gallery files
    For more information, see Using a media gallery.
    Related Communities

    • Edit and delete any related communities
    For more information, see Sharing related communities with other members.
    Status Updates

    • Determine access level of who can post status updates
    For more information, see Managing who can post status updates to your community.
    Wiki

    • Create a community wiki

    • Edit or delete the community wiki

    • Add and remove wiki members (by updating the community membership)

    • Change the wiki access level of community members
    For more information, see Using a community wiki.


    What can I do as a community member?

    Find out what actions you can perform in a community when you are a community member.

    Tip: If you are unsure of what your role is within a community, open the Members page and look for your name or the name of the group to which you belong. Your role displays under your name or the name of the group.

    As a community member, you can perform the following general tasks:

    • View community content.

    • View community membership details.

    • Mail members of the community.

    • Invite members to join the community (if the community has public access).

    • Export the community membership.

      If the display of email addresses is enabled for your deployment of IBM Connections, anyone can export the membership of public and moderated communities. Any member of a restricted community can export the community membership. If the administrator configured email addresses to be hidden, the Export Members option is not available.

    • Leave the community.

      You can leave a community if you are explicitly a member. You cannot leave the community if you became a member because a group that you belong to was added to the group.

    Community members can also perform the following actions when using the resources that belong to the community.

    Table 41. Community member actions

    Resource Community members can
    Activities

    • Start community activities

    • Contribute to community activities of which you are a member
    For more information, see Working with community activities.
    Blog The actions that you can perform in your community blog depend on your access level.

    When you have viewer access, you can:

    • Read blog posts

    When you have draft access, you can:

    • Save draft blog entries

    • Perform all the actions associated with the viewer role

    When you have author access, you can:

    • Post blog entries

    • Edit and delete other users' entries

    • Perform all the actions associated with the viewer and draft roles
    For more information, see Using a community blog.
    Bookmarks

    • Add bookmarks

    • Edit and delete bookmarks that you added
    For more information, see Add bookmarks to a community.
    Library The actions that you can perform using a Linked Library depend on your access level to the Enterprise Content Management server.

    If you have the appropriate access level to the Enterprise Content Manager server and are logged in with your Enterprise Content Manager credentials, you can:

    • Work with folders to which you have access

    • Add documents to folders to which you have access

    • Edit, download, replace, and delete documents to which you have access
    For more information, see Using Linked Libraries.
    Events The actions that you can perform using the Events widget depend on your access level.

    When you have reader access you can:

    • Access information about events

    When you have author access, you can:

    • Add events

    • Edit or delete events that you added
    For more information, see Scheduling community events.
    Feeds

    • Add feeds

    • Edit and delete feeds that you added

    • Subscribe to community feeds
    For more information, see Working with feeds.
    Files The actions that you can perform using the Files widget depend on your access level.

    When you have reader access, you can:

    • Indicate that you like files

    • Follow files

    • Download files

    • View files in the trash

    • Flag a file as inappropriate

    When you have editor access, you can:

    • Upload files

    • Share files

    • Upload new versions of files

    • Update, edit, or delete files uploaded by you

    • Perform all the actions associated with the reader role
    For more information, see Add files to a community..
    Forums

    • Create forum topics

    • Edit and delete forum topics that you added

    • Reply to forum topics

    • Edit and delete your own replies to forum topics

    • Move your forum topics to another forum

    • Flag forum content as inappropriate
    For more information, see Using community forums.
    Ideation Blog The actions that you can perform in your community Ideation Blog depend on your access level.

    When you have viewer access, you can:

    • View ideas

    When you have draft access, you can:

    • Save draft ideas

    • Perform the actions associated with the viewer role

    When you have author access, you can:

    • Post ideas

    • Edit and delete your own and other users' ideas

    • Perform the actions associated with the viewer and draft roles
    For more information, see Using an Ideation Blog in your community.
    Media Gallery

    • Upload files

    • Share, download, comment on, and indicate that you like files

    • Flag file content as inappropriate (if postmoderation is enabled)

    • Replace, edit, delete files that you added
    For more information, see Using a media gallery.
    Related Communities

    • Recommend related communities to other members

    • Edit and delete related communities that you added
    For more information, see Sharing communities with other members.
    Status Updates The actions that you can perform depend on your access level

    • Enter status messages

    • Upload files to status messages

    • Comment on other member.s status message.
    For more information, see Sharing your status with the community.
    Wiki The actions that you can perform in your community wiki depend on your access level.

    When you have reader access, you can:

    • Read wiki content

    When you have editor access, you can:

    • Create wiki pages

    • Edit wiki pages

    • Move pages

    • Perform all the actions associated with the reader role
    For more information, see Using a community wiki.


    What can I do as a non-member?

    Find out what actions you can perform in a community when you are not a community member.

    If you are logged in to IBM Connections but are not a member of a public or moderated community, you can perform the following actions:

    • Open and view Members, and see data in the widgets. You cannot add, edit, or delete any data.

    • Can click Join this Community in a public community or Request to Join this Community in a moderated community.

    Add widgets to your community to make more functionality available

    Add widgets to your community to make extra functionality available to community members. You must be a community owner to add or remove widgets from a community.

    The choice of widgets that you can add to a community depends on what your administrator has made available. You can add the following types of widgets to communities:

    • IBM Connections widgets. These are widgets that correspond to the IBM Connections applications. To add an IBM Connections widget to your community, the corresponding IBM Connections application must be installed in your deployment. For a full list of the IBM Connections widgets available for use in Communities, see Communities widgets.

    • Custom widgets. When your administrator has enabled the use of custom widgets from another source, these are displayed in the content palette along with the IBM Connections widgets that are available for use.

    Widgets are self-contained, HTML-based representations of software applications. When you add an IBM Connections widget to a community, you create an association between that community and the widget application. Membership between the community and the widget application is synchronized, and links to the full widget application are created in the community's user interface so that you can easily find and work with the full application. A summary of the latest activity is posted on the community's Overview page, and you can access the full application at any time by clicking the corresponding link in the community navigation bar.

    When you first create a community, it displays the following widgets by default: Recent Updates, Status Updates, Forums, Bookmarks, Files, and Members. You can customize your community by adding extra widgets. For example, adding the Wiki widget gives members access to a wiki where they can share files and collaborate on project documents. Add the Blog widget lets you create a blog for the community

    ...where members can communicate dynamically and stay up-to-date with the latest community news. The content palette displays the full selection of widgets that your administrator has made available for use in communities.

    To add a widget to your community, complete the following steps.

    1. From the community's Overview page, select Community Actions > Customize to open the content palette.

      You must be logged in to a community to access the Community Actions menu.

    2. Click a widget to add it to the community.

    3. Optional: Click Close palette to close the palette.


    Results

    A section containing the widget is added to the main pane of the Overview page, and a link to the full widget application displays in the community navigation bar.


    Related tasks

  • Enable Linked Libraries
  • Set allowed ECM servers


    Communities widgets

    As a community owner, you can add widgets to your community to make different types of functionality available to members.

    The following IBM Connections widgets are available to add to communities.

    Notes:

    • To add an IBM Connections application widget to your community, the corresponding application must be installed in your deployment.

    • For the widgets in all the IBM Connections applications to load properly in Microsoft Internet Explorer, ActiveX Controls must be enabled on the Security tab. To access the Security tab, select Tools > Internet Options > Security.

    Table 42. Communities widgets

    Widget Description
    Activities Allows community owners to create activities for sharing resources, assigning tasks, and organizing meetings with community members. A community can have multiple activities. For more information, see Working with community activities.

    This is an optional widget.

    Blog Creates a blog for the use of community members. A community can have only one blog. For more information, see Using a community blog.

    This is an optional widget.

    Bookmarks Enables community members to post relevant bookmarks to the community. For more information, see Add bookmarks to a community.

    This widget is added to every community by default, but it can be removed if it is not needed.

    Events Lets community members schedule community events and share information about them. For more information, see Scheduling community events.

    This is an optional widget.

    Feeds Enables community members to subscribe to feeds that are of interest to the community, directly from the community. For more information, see Working with feeds.

    This is an optional widget.

    Files Allows community members to upload and share files and folders. For more information, see Add files to a community.

    This widget is added to every community by default, but it can be removed if it is not needed.

    Forums Enables community owners to create forums where members can ask questions and discuss topics that are relevant to the community. For more information, see Using community forums.

    This widget is added to every community by default, but it can be removed if it is not needed.

    Ideation Blog Creates a central blog space where members can post ideas and vote on other people's ideas. For more information, see Using a community Ideation Blog.

    This is an optional widget.

    Library Creates a Linked Library for a community, allowing members to work with documents and folders on Enterprise Content Management (ECM) servers. For more information, see Using Linked Libraries.

    This is an optional widget.

    Media Gallery Creates a media gallery where members can upload and share photos and videos. For more information, see Using a media gallery.

    This is an optional widget.

    Members Displays the existing membership of the community. For more information, see Viewing members of a community.

    This widget is added to every community by default and it cannot be removed.

    Recent Updates Lets community members keep up-to-date on the latest news stories and status updates on your community, see Get updates on a community.

    This widget is added to every community by default, and it cannot be removed.

    Related Communities Lets you link to other communities that might be doing work that interests your community, see Sharing related communities with other members.

    This is an optional widget.

    Status Updates Lets you post messages to your community and view posts by community members, see Viewing status updates in your community.

    This widget is added to every new community by default, and it can be removed if it is not needed.

    Subcommunities Allows members to see the subcommunities contained in the parent community and navigate easily to them. Fore more information, see Accessing your subcommunities.

    This is an optional widget.

    Wiki Creates a community wiki where community members can share information and resources with fellow members, and collaborate on projects. For more information, see Using a community wiki.

    This is an optional widget.


    Move community widgets

    After adding widgets to a community, you can move them around to find a layout that suits the needs of the community.

    You must be a community owner to move a community widget. You can move any type of widget in a community, except for the Members, Recent Updates, and Status Updates widgets.

    You can customize the layout of the Overview page to suit the needs of your community. For example, if you want to highlight and encourage the use of the community wiki, you might want to move the Wiki widget to a prominent place on the page.

    You cannot move the content inside a widget, only the widget itself.

    To move a widget, perform the following steps.

    1. Click the widget title bar and drag the widget to a new location on the page.

    2. Release the mouse to dock the widget in the location that you want.

    3. If you want to move the widget only one row, click the Actions icon in the title bar of the widget to move, and then click Move Up or Move Down.


    Work with community widgets

    Use the options available from the widget action menu to interact with the widgets in your community. The actions that you can perform depend on your role within the community.

    You must be a community owner to edit, hide, move, or remove the widgets in a community. Also, you must be logged in to Communities to perform these tasks.

    From the community Overview page, click the Actions icon in the title bar of the widget to work with, and then do one of the following actions:

    • To expand or collapse the widget content, select Maximize or Minimize.

    • To update the widget display, select Refresh.

    • To work with widget settings, select Edit. These settings differ depending on the type of widget that you are working with.

      Some widgets cannot be edited, in which case the Edit option does not display on the action menu.

    • To temporarily remove the widget from the community, select Hide. You can reactivate the widget at any time by selecting Community Actions > Customize and choosing the widget from the Hidden section of the content palette. Hide a widget does not delete the information that you already added. If you add the widget to the community again, any information previously added is restored to the community.
      Notes:

      • You cannot hide the Members and Recent Updates widgets. These widgets are automatically added to every community when it is created and cannot be hidden.

      • When you hide the Bookmarks widget, the Important Bookmarks widget is also hidden.

    • To permanently remove the widget from the community, select Remove. When you choose this option, any information previously added is permanently deleted.

      Notes:

      • You cannot remove the Members and Recent Updates widgets. These widgets are automatically added to every community when it is created, and cannot be removed.

      • When you remove the Bookmarks widget, the Important Bookmarks widget is also removed.

    Manage your communities

    As a community owner, you can edit your community to update basic information about the community or the applications associated with the community. If the community is no longer needed or was created in error, you can delete it.

    You can also review and manage the content of your community blog, files, and forums, if owner-moderation is enabled by your administrator.


    Moderate community content

    As a community owner, you can review and manage the blog, file, and forum content in your community directly from the community. By monitoring updates on a regular basis, you can control what content is added by members and remove anything that might be considered inappropriate in your organization.

    The IBM Connections administrator must enable owner moderation for community owners to be able to review and manage community content.

    Tip: If you are a community owner, you can check if owner moderation is enabled for your community by logging in to IBM Connections and opening your community. When owner moderation is enabled, you can select Moderation in the navigation to access moderation options.

    Note that you can enable or disable moderation for individual communities by editing community settings. For more information, see Editing communities. You can also enable or disable moderation for a specific community when you create it. For more information, see Creating communities.

    The Communities moderation interface provides a central place where community owners can review and manage the content of their community blog, files, and forums. If you are a community owner and owner moderation is enabled for your deployment, you can review content that has been submitted for approval, and then decide whether to publish it or reject it. You can also review content that has been flagged as inappropriate by other users.

    When owner moderation is enabled, you can review the following content in the communities that you own:

    • Blog entries and comments

    • File content and comments

    • Forum posts
    Your administrator can configure which of these content types are moderated. For example, your site might only have forum posts under moderation. Another site might have blogs and files under moderation, but forums are not moderated

    You can also edit the content of any blog entry or forum post directly from the Moderation view by selecting the entry and clicking Edit.

    To moderate the content of your community complete the following steps.

    1. From the navigation, select Moderation.

      You must be logged in to see Moderation.

    2. To review content that has not yet been published:

      1. Select Content Approval and then select the type of content to work with - Blogs, Files, or Forums. Ensure that the Require Approval tab is selected.

      2. Click a title to review the content, and then do one of the following:

        • To publish the content to the community, click Approve. An email notification is sent to the content author to let them know that the content has been approved.

        • If you do not want to publish the content, click Reject, enter an optional reason for rejecting the entry, and click OK.

          The content is moved to the Rejected tab where you can later approve it or delete it. An email notification is sent to the content author, explaining your reason for rejecting the content.

        • To permanently delete the content, click Delete and click OK.

    3. To review unpublished content that was previously rejected:

      1. Select Content Approval, select the application to work with - Blogs, Files, or Forums - and then click the Rejected tab.

      2. Click a title to review the content, and then do one of the following:

        • To publish the content to the community, click Approve.

        • To permanently delete the content, click Delete and click OK.

    4. To review published content that has been flagged as inappropriate:

      1. Select Flagged Content and then select the type of content to work with - Blogs, Files, or Forums.

      2. Click a title to review the content and the reason given for flagging it, and then do one of the following:

        • To dismiss the flag and keep the content available in the community, click Dismiss.

        • To remove the content from the community, click Quarantine, enter a reason for removing the content, and click OK.

          The content is moved to a quarantine area and is no longer available to community members. An email notification is sent to the content author, explaining your reason for removing the content.

        • To permanently delete the content from the community, click Delete and click OK.

    5. To review published content that is quarantined:

      1. Select Flagged Content, select the type of content to work with - Blogs, Files, or Forums - and then click the Quarantined tab.

      2. Click a title to review the content and the reason given for quarantining it, and then do one of the following:

        • To restore the content to the community, click Restore. An email notification is sent to the content author to let them know that the content has been restored to the community.

        • To permanently remove the content from the community, click Delete and click OK.


    Edit communities

    If you are a community owner, you can edit information about the community and the applications associated with the community.

    Edit a community to change its name, description, and associated tags, and update information for any applications that are associated with the community. For example, if your community has a blog, you can edit the blog membership or update basic information about the blog. You can also edit community settings to add an application to the community (if your administrator has enabled it), reset the community's privacy level, or change the image associated with the community.

    To edit a community.

    1. From the I.m an Owner view, select the community to edit. If you are not already logged in, you are prompted to do so.

    2. Select Community Actions > Edit Community and do the following as required:

      If your community has extra applications associated with it, such as a blog or wiki, additional tabs display for these applications to enable you to edit them.

      1. To change the name of the community, type a new name in to the Name field.

      2. To add or remove community tags, edit the contents of the Tags field.

      3. To change the community's web address, update the contents of the Web Address field. You cannot change the web address of a community that has subcommunities.

      4. To change the access level of the community, select one of the following options:

        If you change a community's access level from private to public, any private content, such as shared private files, is removed from the community.

        Table 43. Community access levels

        Option Description
        Public - anyone can join Select this option if you want the community to be public with anyone able to join.
        Moderated - people must request to join Select this option if you want the community to be public but for users to request membership.
        Restricted - people must be invited Select this option if you want the community to be restricted, with membership by invitation only.

      5. To add an associated application, select the required application or applications in the Associated Applications area.

        If you do not see any options to include associated applications, then your administrator has not enabled this application for your deployment.

      6. To change the community description, edit the contents of the Description field.

      7. To change the image associated with the community, click Upload a Community Image and browse for the image that you want to upload. Image resizing does not support all image formats. If you encounter problems with uploading an image, converting the image to a different format often works.

      8. To apply a different theme to the community, click Change Community Theme and select one of the options available.

      9. If moderation is available and editable at you site, you can select from the following options:

        • Owners must approve all content (widgets) where widgets might be one or more of the following widgets: blogs, files, or forums. When this option is enabled, community owners can review unpublished content that has been submitted for approval and decide whether to publish it to the community or reject it.

        • Viewers can flag inapproriate content (widgets) where widgets might be one or more of the following widgets: blogs, files, or forums. When this option is enabled, community owners can review content that has been flagged as inappropriate by other users, and decide whether to keep the content or remove it from the community.

    3. When you've finished making changes, click Save.


    Delete communities that you own

    If a community no longer has a purpose or is inactive, you might want to consider deleting it.

    You must be a community owner to be able to delete a community. When you delete a community, all data associated with the community is permanently deleted. Ensure that the community is not being actively used by any of the members before you delete it.

    In addition, check if any applications are associated with the community. Community blogs, files, activities, and wikis are automatically deleted when you delete the associated community. When you delete a community, any subcommunities that are part of the community are also deleted.

    If you delete a community that is associated with an IBM Lotus Quickr place, open the Lotus Quickr application and delete the place directly from the application.

    To delete a community. Be sure that you enter the correct case of any characters that you enter.

    1. From the I.m an Owner view, open the community to delete. If you are not already logged in, you are prompted to do so.

    2. Select Community Actions > Delete Community.

    3. Enter the name of the community in the Confirm community name field.

    4. Enter your name in the Sign with your name field.

    5. Click the I understand that the community and all associated data with it will be permanently deleted check box.

    6. Click Delete.


    Create subcommunities

    Create a subcommunity when you want to bring together a subset of members within an existing community.

    You must be a community owner to create a subcommunity. When you create a subcommunity, you and any other community owners automatically become owners of that subcommunity. The subcommunity has exactly the same functionality as the parent community; you can edit it, add widgets, and perform the same actions in it as you can in the parent community. Create subcommunities is a useful way of organizing your community members into smaller groups with different areas of focus. By creating subcommunities, you can share information and collaborate with a more targeted selection of people while maintaining the goals and objectives of the parent community. You can add as many subcommunities as you like to a community.

    You cannot create nested subcommunities within a community, and you cannot add an existing community as a subcommunity of another community.

    To create a subcommunity.

    1. Log in to IBM Connections and open the community to which you want to add a subcommunity.

    2. From the Overview page, select Community Actions > Create Subcommunity.

    3. Required: Enter a name for the subcommunity in the Name field.

    4. Enter one or more tags in the Tags field.

    5. To generate a web address for your subcommunity, enter a one-word, unique term that identifies the subcommunity in the Web Address field. This field displays only if you have a Web Address entry in the parent community. If you do not want to create a web address, ensure that you leave this field blank.

      Notes:

      • Certain keywords with a technical meaning, such as html or atom, are reserved and cannot be used in subcommunity web addresses. If you enter a reserved keyword, an error message is displayed, and you are prompted to enter a different keyword.

      • If your web address contains a non-alphanumeric character, such as an ampersand (&), you must escape the character by using a forward slash ( / ) before the character.

      • If you do not see the option to create a web address for your subcommunity in the user interface, this means that your administrator has disabled this option for your organization.

    6. Required: Set the level of access that you want for the community. The access options available depend on the access level of the parent community.

      • When the parent community is public, the subcommunity can have public, moderated, or restricted access.

      • When the parent community is moderated, the subcommunity can have moderated or restricted access.

      • When the parent community is restricted, the subcommunity must also have restricted access.

    7. Add members to the subcommunity by doing one of the following:

      • To add a subset of the parent community membership to the subcommunity, enter the names of the people that you want to add in the field provided.

      • To add all the members of the parent community to the subcommunity, click Add all members of this community to your new subcommunity.

      To be a member of a subcommunity, a person must be a member of the parent community.

    8. Enter a description for the subcommunity in the Description field.

    9. To upload an image for the subcommunity, click Upload a Community Image and browse for an image.

    10. To apply a different theme to the subcommunity, click Change Community Theme, and select a theme.

    11. If moderation is available and editable at your site, you can select from the following options:

      • Owners must approve all content (widgets) where widgets might be one or more of the following widgets: blogs, files, or forums. When this option is enabled, community owners can review unpublished content that has been submitted for approval and decide whether to publish it to the community or reject it.

      • Viewers can flag inapproriate content (widgets) where widgets might be one or more of the following widgets: blogs, files, or forums. When this option is enabled, community owners can review content that has been flagged as inappropriate by other users, and decide whether to keep the content or remove it from the community.
      For more information about moderation in communities, see Moderating community content.

    12. Click Save to save the subcommunity.


    Results

    Your subcommunity is created as a child of the parent community.

    A Subcommunities link is added to the navigation sidebar in the parent community to enable you to open the subcommunity from the parent community. You can also access your subcommunities from the I.m a Member or I.m an Owner views.


    What to do next

    You can add content, edit, customize, delete, and follow subcommunities, and work with them in exactly the same way that you would a regular community.

    If you are creating multiple subcommunities within a community, consider adding the Subcommunities widget to the parent community. This widget allows you to see all your subcommunities at a glance and navigate easily to them from the parent community.


    Access your subcommunities

    Add the Subcommunities widget to your community to give you easy access to your subcommunities.

    When you add subcommunities to your community, a Subcommunities link is added to the navigation sidebar of the parent community, and you can also access the subcommunities from the I.m an Owner view. In addition, you can add the Subcommunities widget to the parent community. The widget lists all the subcommunities in the community, with the most recently-updated subcommunity displaying first, and allows you to open the subcommunities directly from the parent community.

    For information about how to add the Subcommunities widget to your community, see Add widgets to your community.

    Use the Subcommunities widget in the following ways.

    1. Click View List or View Images to set your preference for displaying the subcommunities.

    2. Click a subcommunity image or link to open the subcommunity and work with it. You can return to the parent community at any time by clicking the link to the parent community that displays before the subcommunity's business card.


    Manage community membership

    As a community owner, it is your responsibility to manage community membership. For example, you might occasionally need to change the role of a community member if you want to increase or restrict the changes that they can make to community content. Or, if a community member is not an active contributor and no longer needs to be a member of the community, you might want to consider removing them from the membership list.

    You must be a community owner to edit membership roles. To remove someone from the membership of a community, you must be the community owner or the member who is being removed.

    Community members can remove themselves from a community's membership by selecting Community Actions > Leave Community when they are logged in to the community.

    To manage community membership, complete the following steps.

    1. From the I.m an Owner view, click a community to open its Overview page. If you are not already logged in, you are prompted to do so.

    2. Click Members in the navigation pane and do one of the following.

      • To change a membership role:

        • Click Edit next to the member whose role you want to change.

        • Select a role and click Save.

      • To delete a member:

        • Click Remove next to the member that you want to remove.

        • Click OK to confirm your change.


    Results

    Members receive an email notification to let them know about any change in their membership status. Email notifications are not sent to groups.


    Export community membership

    You can export the membership of a community to a comma-separated value (CSV) file that lists members by their email address.

    Anyone can export the membership of a community with public or moderated access. You must be a community member to export the membership of a restricted community.

    The ability to export community members is only available when email is configured to be displayed for your deployment. If your administrator has configured email to be hidden, the Export Members button does not display in the user interface. Export community membership to a CSV file is useful when you want to create a community with the same owners or members as an existing community. Instead of adding the members manually to the new community, you can add them in a single transaction by first exporting the membership details to a CSV file, and then importing details from the CSV file into the new community.

    To export the members of a community, complete the following steps.

    1. Open the Members page of the community whose membership you want to export.

    2. Click Export Members.

    3. Select the role of the members to export. You can export the community owners, members, or both.

    4. Click Export.

    5. Choose whether you want to save or open the CSV file.


    What to do next

    After exporting the membership of a community, you can add the members to another community by importing the details from the CSV file into the new community. For more information, see Importing members into a community.


    Customize your community so you can distinguish it from other ones

    Customize your community to distinguish it from other communities and attract new membership. You must be a community owner to customize a community.

    There are various ways in which you can customize your community. Possible options include changing the community theme, associating a distinctive graphic with the community, and adding applications that bring extra functionality to the community.

    Add an image. An eye-catching graphic can be a powerful way to draw attention to your community and attract potential members. The graphic that you add to your community is displayed in the community business card, which reflects the community's identity and interests when displayed outside the Communities application. By associating a meaningful image with your community, you can give the community a branding that is unique to its members. You can add an image when you first create the community, or you can edit the community to add a new image.

    Add enhanced functionality. You can customize the functionality of your community by adding content that reflect the various aspects of the community and its areas of focus. For example, if organizing project workload is a priority, adding the Activities widget allows you to create a space where members can work on project documents with a fixed duration, assign and complete tasks, and share resources. If collaboration is an important goal for your community, you might want to add the Wikis widget to encourage members to work together on community-related projects.

    Apply a new theme. You can enhance the appearance of your community by changing the default theme. Applying a new theme changes the colors and fonts that are used in the community's user interface. Choose from the options provided with your deployment. There are a number of default themes for you to choose from, but your administrator can also make custom themes available.

    Change the layout. You can arrange your community's Overview page to prioritize specific functionality. For example, if the discussion forum is the most active part of your community, you might want to place it first on the page to give it priority and ensure that members see the latest posts.


    Change the theme of your community

    You can customize the appearance of your community by changing its default theme.

    You must be a community owner to change the theme of a community. You must also be logged in to IBM Connections.

    Community themes are not available if your administrator has made customizations that apply to all of the IBM Connections applications. When you create a community, a default theme is automatically applied. You can change the colors and fonts used in the community's user interface by selecting a new theme. You can choose from a number of default themes, and your administrator can also make custom themes available. When you apply a different theme to your community, that theme is also applied to any community applications, such as a community blog or wiki, and community forums and activities.

    Apply a different theme to a community does not affect any associated applications.

    To select a new theme for your community, complete the following steps.

    1. From your community's Overview page, select Community Actions > Edit Community.

    2. Click Change Community Theme.

    3. Select a theme from the options provided, and then click Save.


    Results

    The theme is applied to all the pages in the community.

    Add bookmarks to a community

    Add bookmarks to make useful web resources available directly from your community.


    Add a bookmark from a web page to a community

    Use the bookmark button control provided by IBM Connections to add the Add Bookmark button to your web browser. Then, when you visit a web page that you want to bookmark, you can click the button to add that page as a bookmark to your community.

    Before adding a bookmark to a community using the Add Bookmark button, add the button control to your web browser. To do so:

    1. Click Bookmarking Tools in the IBM Connections footer.

    2. Follow the instructions in the page to add the Add Bookmark button to your web browser.

    To add a bookmark to a community from the web site that you want to bookmark.

    1. From a web page to bookmark for a community, click Add Bookmark.

    2. Edit the name of the web site that displays in the Title field if necessary.

    3. To edit the URL of the bookmark, make the necessary changes to the contents of the URL field. This field is automatically populated when you open the Add Bookmark form.

    4. Add one or more tags that describe the content of the bookmark link in the Tags field.

    5. Type a description that reflects the content of the bookmark in the Description field.

    6. To specify the community to which you want to add the bookmark, from the Add to Communities tab, select a community from the list displayed in the Community field.

    7. Select Add to important bookmarks to add the link to the list of important bookmarks on the community's Overview page.

      You can add a maximum of 100 important bookmarks to a community.

    8. If you want to prompt a discussion of the bookmark with your fellow community members, enter a message in the Message for discussion field.

    9. Click Save to add the bookmark to the community


    Add bookmarks of relevant websites to your community

    Add bookmarks to relevant websites to your community from the bookmark area.

    Follow these steps to add a bookmark from your community.

    1. Click Bookmarks in the navigation sidebar, and then click Add Bookmark.

    2. Required: Enter the web address of the resource to bookmark into the URL field.

    3. Required: Enter a name for the bookmark link in the Name field.

    4. Add a description for the bookmark link in the Description field.

    5. Add one or more tags that describe the content of the bookmark link.

    6. Select Add to Important Bookmarks to add the link to the list of important bookmarks on the community's Overview page.

      You can add a maximum of 100 important bookmarks to a community.

    7. Click Save.


    Edit community bookmarks

    Keep your community's bookmarks up-to-date to ensure their usefulness and accuracy.

    To edit a community bookmark, you must be a community owner or the person who added the bookmark. If a web page that you have bookmarked has moved or changed, use the Edit Bookmark form to update the bookmark details.

    1. From the community that contains the bookmark that you want to work with, click Bookmarks in the navigation sidebar.

    2. Click More next to the bookmark to edit.

    3. Click Edit to open the Edit Bookmark form.

    4. Make the required changes, and then click Save.


    Delete community bookmarks

    If a bookmark is inappropriate or no longer functional, you can remove it from your community's bookmark area.

    To remove a community bookmark, you must be a community owner or the person who added the bookmark.

    Follow these steps to remove a bookmark from your community.

    1. From the community's Overview page, click Bookmarks to retrieve the list of bookmarks for the community.

    2. Click More next to the bookmark to remove.

    3. Click Delete.

    4. Click OK to confirm that you want to delete the bookmark.


    Search a community for bookmarks

    Search a community to find bookmarks to resources that might be of interest to you.

    You can search for bookmarks within a community in the following ways.

    • From the Public Communities, I.m a Member, I.m an Owner, or I.m Following view, select a community to display its Overview page.

    • Review the bookmarks that others identified as being useful in the Important Bookmarks area.

    • Review the most recent bookmarks in the Bookmarks summary widget in the center column on the community Overview page. Find resources that you might not know about.

    • To search for a bookmark devoted to a specific topic, click the tag that best represents the topic in the community tag cloud.

      This search returns all the bookmarks in the current community that use that tag to identify their topics of interest.

    • Click Bookmarks in the navigation pane to see a list of all the bookmarks associated with the community.

    Work with community forums

    Use your community's forum to post topics for discussion and share ideas.


    Add forums to a community

    When you create a community, it contains a forum by default. You can add additional forums if you want to organize community discussions around different focus areas. You cannot add existing, stand-alone forums to a community.

    You must be a community owner to add a forum to a community, and you must also be logged in to Communities.

    Your community must contain the Forums widget for you to be able to add forums. Every community contains the widget by default when the community is first created. The widget lists the five forum topics that have been updated most recently. If the widget has been removed and you want to add it back, you can do so at any time. For information about how to add widgets, see Add widgets to your community.

    Community forums have the same access level as the community that contains them. When you add a forum to a restricted community, the forum automatically becomes a restricted forum and it is not available from the Forums application. Forums added to public communities are available from the Public Forums page in the Forums application. Add multiple forums to a community provides your members with dedicated discussion areas where they can ask questions and discuss topics that are relevant to the community. For example, if your team encounters a issue that is blocking progress on a project, you might create a troubleshooting forum to find out if anyone in the community has experienced a similar problem and if they have a solution to suggest.

    To add a forum to your community, complete the following steps.

    1. Select Forums on the community's Overview page, and then click the Forums tab.

    2. Click Start a Forum.

    3. Required: Enter a name for the forum in the Name field.

    4. Enter one or more tags in the Tags field.

    5. Enter a description for the forum in the Description field, and then click Save.


    Results

    After you save the forum, it opens in the Forums user interface

    ...where you and your fellow community members can start to post topics and questions. To access the forum from the community, select Forums on the community's Overview page, click the Forums tab, and then click the forum title to open the forum. You can also use the Forums widget on the community's Overview page to keep up with the latest updates to forum topics. The widget lists the five most recently updated forum topics. To access a full list of community forum topics, click View All in the widget.

    For more information about how to work with community forums, click the Help link in the site navigation bar. You can return to the community at any time using the navigation links that display at the side of the page. You can also perform actions relating to the parent community by clicking Community Actions and selecting an option from the list that displays.


    What to do next

    You can perform the following actions directly from the community:

    • Start a forum topic by clicking Start a Topic and completing the form that displays.

    • Click a topic title in the Forums widget to open it. This widget lists the five most recent topic updates.

    • Access a full list of forum topics for the community by clicking View All.


    Remove community forums

    As a community owner, you can delete individual community forums, temporarily hide community forums, or remove the entire forums feature from your community.

    You must be a community owner to remove, hide, or delete community forums.

    Every community has a forum by default. If you decide that your community does not need a place for discussion, you can remove the forums feature from the community. When you remove the feature permanently, all forum content is deleted. You can also remove the forums feature temporarily, which hides the forum content but does not delete it. If you restore the feature to the community at a later stage, any content previously added to the forums is recovered and displayed.

    You can also remove individual forums that are no longer used by your community. Removing a community forum deletes all the content in that forum permanently.

    To remove community forums, do one of the following.

    1. To hide your community forums temporarily:

      1. From the community's Overview page, click the Actions icon in the Forums widget title bar, and then select Hide.

        When you want to display the widget again, select Community Actions > Customize on the Overview page, select Hidden, and then select Forums. The Forums widget is restored to the community with all its existing content.

    2. To remove your community forums permanently:

      1. From the community's Overview page, click the Actions icon in the widget title bar, and then select Remove. Selecting this option deletes all forum content permanently.

    3. To remove a single community forum:

      1. Select Forums from the navigation sidebar and click the Forums tab.

      2. Open the forum to delete.

      3. Select More Actions > Delete Forum.

      4. Click Delete to confirm that you want to delete the forum.


    Manage display settings in community forums

    As a community owner, you can determine if the community forum shows a forum list or topic list by default. Every community has a forum by default. You can determine if the community overview page shows a forum list or topic list by default. You can also determine if the Forums application shows a forum list or a topic list after you open the application.

    1. From the community's Overview page, click Community Actions > Edit Community.

    2. Click the Forums tab.

    3. In the Community overview page field, select whether or not you want the community overview page to shows forum list or topic list by default.

    4. In the Forum application default view field, select whether or not you want the community forums application to show a forum list or a topic list after you open the application.

    5. Click Submit.


    Browsing community forums

    Community forums are a useful place to brainstorm and collect feedback on topics that are relevant to the community. Use your community's forums to share ideas with members and discuss topics of common interest. Every community has a Forums area by default.

    Anyone who can access a community can access the forums associated with that community. To post a topic or reply to a topic, you must be a community member.

    When the community owner has created forums for the use of the community, members can post discussion topics and respond to existing topics in those forums. The five most recent updates from the forums are displayed in the Forums area on the community's Overview page, where you can view usage statistics for each topic. These statistics are a good indicator of the topics that interest your community, and they can also give you an idea of who the most active participants are.

    When you open Forums, the Topics tab shows pinned topics first in the list. However, the pin icons do not display in communities with more than one forum.

    To browse the forums in your community, complete the following steps.

    1. From any page in your community, click Forums in the navigation sidebar.

    2. Do one of the following.

      1. To browse by forum, click the Forums tab to display all of the forums in the community. When you see a forum that interests you, click the forum title to open it and start browsing its topics.

      2. To browse by topic, click the Topics tab. This tab lists all of the forum topics for the community. The topics are listed by date, with the most recently-updated topics at the first in the page. If the community owner has pinned any forum topics, these topics are displayed at the first in the page, regardless of the date in which they were added or updated.

    3. To open any topic, click the topic title. A threaded view of the topic displays, showing the original topic and any responses to it. When navigating long discussion threads, click the name after the response title to display the parent of that topic first in the page. This view makes it easy for you to see which response corresponds to which forum entry.


    What to do next

    If you want to get notified about updates to a community forum that interests you, open the forum and select Follow > Follow this Forum. You do not have to be a member of a community to follow a community forum.


    Add topics to a community forum to start discussions

    Start a discussion with members of your community by adding a topic to one of the community forums. Anyone who can access the forums can view the new topic.

    The Forums application must be available in your community for you to be able to add a discussion topic. When you see a Forums area on the community's Overview page, this means that the application is enabled for your community. You must be a community member to post topics to a community's forums.

    To add a topic to a community forum, complete the following steps.

    1. On the community's Overview page, click Start a Topic in the Forums area of the page. If you are the first member to add a forum topic, the link displays as Start the First Topic.

    2. Required: Enter the title of the discussion topic in the Title field.

    3. To mark the topic as a question, select Mark this topic as a question.

    4. Enter one or more tags in the Tags field.

    5. Enter the content of your topic in the rich-text field provided. Be as descriptive as possible. Remember to start a discussion, so include relevant information to interest other community members and get them involved.

    6. Required: Select the community forum where you want to add the topic from the Forum list.

    7. To attach a file to the topic, click Attach a File and browse for a file.

    8. Click Save.


    Results

    If forum topics are moderated in your deployment, the topic does not display immediately. The forum moderator must approve the topic content first. If content moderation is not enabled, the topic is published immediately.

    Add files to a community

    Upload, share, and work with community files using the Files widget.


    Sharing files with your community

    Share files from the Files application with members of your community. You can also upload files to a community from your local file system.

    Any community member can share files with a community from the Files application. Members with Editor access can also upload files to the community. Your community must contain the Files widget for you to be able to share files with the community. The widget is automatically added to a community when it is first created, but if it has been removed, you can add it to the community again if you are a community owner. For information about adding widgets to a community, see Add widgets to your community.

    File owners can also share files with a community or give a copy of a file to a community directly from the Files application. Anyone can share files with a community to which they have access, but only the community owner and the file owner can remove the file reference from the community. For more information about sharing files with a community from Files, see How do I share files?

    The Files widget allows community members to share local files and files from the Files application with the rest of the community. Sharing files is a great way to foster collaboration within a community. By encouraging members to upload files to the community, you can work together on shared documents and build up a valuable repository of information that is accessible from within the community.

    Notes:

    • The type of files that you can share depends on the type of community to share the files with. A public community can contain only public files, and a restricted community can contain either public or private files.

    • If your community has a media gallery, upload photo and video files from the media gallery instead of the Files widget to access extra functionality for working with multimedia files. For more information, see Uploading content to the media gallery.

    To share files with your community, complete the following steps.

    1. From the Files widget on the Overview page, click Share Files.

      If you are the first person to share files with the community, click Share Your First File.

    2. Do one of the following:

      1. To upload a file from your local file system:

        1. Click Browse files on my computer.

        2. Click Browse to find the file that you want to share.

        3. Edit the file name if necessary, enter some tags in the Tags field, and then click Upload.

        The file is now owned by the community. You do not see it in your My Files list of the Files application.

      2. To share a file from the Files application:

        1. Select the type of file to share from the options.

          Table 44. File-sharing options

          Option Description
          Recent Files Files recently uploaded to the Files application.
          Pinned Files Files that you marked as prioritized in the Files application.
          My Files Files that you uploaded to the Files application.
          Shared With Me Files shared with you from the Files application.
          Other People's Files Other people's files shared with public or files that they shared with you from the Files application.
          Pinned Folders Folders that you prioritized in the Files application.
          My Folders Files from your personal folders in the Files application.
          Shared Folders Files from shared folders in the Files application.

        2. Select one or more files from the list that displays.

        3. Specify whether you want to allow community members to edit the file or files, and then click Share Files.

      3. If you do not see the file that you are looking for, enter the file name in the search field and click the search icon.


    Sharing folders with your community

    Share folders from the Files application with members of your community.

    Your community must contain the Files widget for you to be able to share folders with the community. The widget is automatically added to a community when it is first created, but if it has been removed, you can add it to the community again if you are a community owner. For information about adding widgets to a community, see Add widgets to your community to make more functionality available.

    Anyone can share folders with a community to which they have access, but only the community owner and the folder owner can remove a folder from the community.

    Any community member can share folders from the Files application with their community using the Files widget. The type of folder that you can share depends on the type of community to share the folder with. A public community can contain only public folders, and a restricted community can contain public or private folders.

    To share folders with your community, complete the following steps.

    1. From the Files widget on the Overview page, click the Folders tab.

    2. Click Share Folders.

      If you are the first person to share a folder with the community, click Share Your First Folder.

    3. Select a folder category from the following options:

      Table 45. Folder categories

      Option Description
      Recent Folders Folders recently created in the Files application.
      My Folders Folders that you own in the Files application.
      Folders Shared With Me Folders shared with you from the Files application.
      Public Folders Public folders in the Files application.

    4. Select the folder or folders to share.

    5. Set the level of access that you want community members to have to your folder or folders from the Community members can access the selected folders list:

      Table 46. Folder access levels

      Access level Description
      Reader Readers can view the content of any files in the folder.
      Contributor Contributors can add files to the folder, delete files they added themselves, and view information about files in the folder.
      Owner Owners have ownership of the folder along with the original owner. They can share the folder with other people and delete any file. The owner of a file can delete it or remove it from a folder.

    6. Click Share Folders.


    Download files shared with a community so you can view them locally

    Download files that you have uploaded to a community so that you can continue working on them.

    Anyone can download files from a public community. To download files from a restricted community, you must be a community member.

    To download a file from a community, complete the following steps.

    1. From the Files area, click a file name to select the file. If you do not see the file that you want, click View All to display the full list of community files available for download.

    2. Click Download, choose whether to open or save the file, and click OK.


    Manage community files

    Depending on your access level, you can work in different ways with the files that members have uploaded and shared with your community.

    To select the file to work with, click the file name in the Files widget to access options for working with the file.

    The Files widget on the communitys Overview page displays only the most recent file updates for the community. If you do not see the file to work with displayed in the widget, click Files in the navigation pane to access a full list of the files associated with the community.

    When working with community files, members can indicate to other members that they like a file, upload new versions of files, and edit a files name and description, depending on their level of access to the file. Members can follow files so that they receive an email whenever that file is modified. Community owners, member editors, and users who have uploaded files can delete versions of the uploaded file and restore any version of the file.

    You can perform the following tasks when working with community files.

    • To indicate to other members that you like a file :

      1. Select the file that you like.

      2. Click Like. If you change your mind click Undo. The number of people that like a file displays next to the like icon .
        Tip: If a file is liked by other members, you can hover over the like icon to see who else likes the file.

    • To upload a new version of a file:

      To perform this action, you must be a community owner, a member editor, or the user who uploaded the original file.

      1. Select the file, and click Upload New Version.

      2. Click Browse to locate the file to upload.

      3. Enter a concise description of your changes in the Change summary field, and click Upload.

    • To update a files name or description:

      To perform this action, you must be a community owner, a member editor, or the user who uploaded the original file.

      1. Select the file for which you want to update the properties, and click Edit Properties.

      2. Make the required changes, and click Save.

    • To receive email notifications when changes are made to a file:

      1. Click the file to receive notifications about, and click Follow.

    • To stop receiving updates about a file:

      1. Select the file to stop following, and click Stop Following.

    • To comment on a file:

      1. Select the file to comment on, and then click Add Comment.

      2. Enter your comment in the rich-text field provided, and click Save.

    • To flag a file as containing inappropriate content:

      1. Select the file to flag, and click Flag as Inappropriate.

      2. Enter your reason for flagging the file, and click Flag.

    • To delete a file:

      1. Select the file to delete, and then select More Actions > Delete.

        If trash functionality is enabled, select More Actions > Move to Trash.

        When trash functionality is enabled and a community member removes a file from a community, the file is moved to the trash rather than being permanently deleted. The file remains in the trash view until a community owner either restores it to the community or permanently deletes it from the system. For more information, see Managing deleted files.

      2. Click OK to confirm that you want to remove the file.

      Notes:

      • To delete a community file, you must be a community owner or the person who uploaded the file.

      • You can only delete files that are community-owned, that is, files that have been uploaded to a community. You cannot delete files that have been shared with a community.

    • To lock a file to prevent others from editing it:

      All community members can lock community files that are community-owned. To lock files that were shared with a community, you must be an owner or an editor of those files.

      1. Click the file and then click More Actions > Lock File.

      2. To unlock the file, click More Actions > Unlock File.


    Manage deleted files

    When trash functionality is enabled for Communities, community owners can manage deleted community files by restoring them to the community or by permanently deleting them from the system.

    You can tell if trash is enabled for your deployment by checking if the Move to Trash option is available from the More Actions menu for individual files. If you see the Delete option instead of Move to Trash, this means that trash is not enabled. If trash is enabled, when community members remove files from a community, those files are moved to the trash rather than being completely deleted from the community. The files are held in the trash until a community owner either deletes them permanently or restores them to the community.

    Any community member can view the content of the trash, but you must be a community owner to restore files from the trash. Community owners can manage the trash content by checking it periodically and emptying it when files are no longer needed.

    1. To open the trash view, select Files from the navigation and click View Trash. Any community member can access this view.

    2. Do one of the following:

      You must be a community owner to perform any of the following tasks.

      • To restore a file to the community, click the arrow next to the file and select Restore.

      • To delete a file from the trash, click the arrow next to the file and select Delete.

        When you select this option, the file is permanently removed and the option to restore it to the community is no longer available.

      • To delete all the files in the trash, click Empty Trash.

        When you select this option, the files are permanently removed and the option to restore them to the community is no longer available.


    Manage access to community files

    Manage access to the files that you and other members add to your community.

    You must be a community owner to change access levels to community files. You must also be logged in to IBM Connections. When you first create a community, all members of the community are granted the Editor role by default so that they can share and upload files. Depending on the privacy requirements of your community, you might want to change the file access level for your members. Access to community files is always community-wide. Community owners are always file owners and have full access to upload, edit, and delete files, and to manage file permissions.

    Community members can have one of the following access levels for uploading files:

    Table 47. Access levels for uploading and sharing files

    Role Members with this role can
    Editor Upload community-owned files and download files.
    Reader Share files using the Files application and download files.
    The Editor and Reader roles allow community owners to control whether members can upload a new community-owned file to the community. Members can always share files from the Files application with the community.

    The ability to view community files depends on the type of community. Everyone can see and download files from communities with public access, however only community members can view and download files from a restricted community. If a restricted community is changed to a public community, private files and private folders shared from the Files application are removed from the community.

    To edit file access levels for community members, complete the following steps.

    1. Select Community Actions > Edit Community on the community's Overview page, and then select the Files tab. You can also access edit options by selecting Edit from the Files widget action menu.

    2. Make the required changes, and click Save. All community members are granted the same level of access.


    Manage the Files widget

    After adding the Files widget to a community, you can refresh the widget to display the latest file updates, hide the widget, or remove it from the community if it is no longer needed.

    You must be a community owner to hide, move, or remove the Files widget from your community.

    To manage the Files widget, perform the following steps.

    From the community's Overview page, click the Actions icon in the Files widget title bar, and select from the menu that displays.

    • To expand or collapse the widget content, select Maximize or Minimize as appropriate.

    • To refresh the widget and see all the latest files uploaded to the community or updated in the community, choose Refresh.

    • To move the Files widget up or down the Overview page, choose Move Up or Move Down as appropriate.

    • To hide the Files widget, choose Hide and confirm to temporarily hide files from the community.

      When you are ready to resume file sharing, select Community Actions > Customize to open the content palette, and select Files from the Hidden section of the palette. All content is restored.

    • To permanently remove the Files widget, choose Remove and confirm to permanently remove the widget.

      Notes:

      • Choose this option permanently deletes all the files previously added to the community.

      • If your community has a media gallery, you cannot remove the Files widget from your community because the widget is used to store the media gallery files. However, you can hide the Files widget if you do not want your members to be able to use it. See the previous bullet point for details.

    • To access help documentation for the widget, select Help.

    Work with community activities

    Use activities to organize information and tasks relating to the community.


    Create a community activity

    Add activities to your community to provide community members with a place to assign tasks and to share information and resources. When you start an activity from a community, you can grant access to the activity to all community members, or you can restrict access to a subset of members.

    For community members to create activities, a community owner must first add the Activities widget to the community. For more information, see Add widgets to your community. Create an activity is a useful way to share to-do items, post event information, and organize meetings within a community. Creating an activity is easy: Just click a button and fill out a form. There are no required fields. You can edit the activity later to add or change information.

    If you want, you can create an activity from a template. A template captures the tasks required to complete a specific job. For example, a patent template might link to the files, DBs, tools, or websites that an inventor seeking a patent would need. It might also capture a list of to-do items that an inventor would need to complete as part of the patent application process.

    Activity owners can also share activities with a community from the Activities application. When an activity owner shares an activity with a community, a link to the activity displays in the community. A linked icon displays next to the activity title to indicate that it is a shared activity. For information about sharing an activity with a community, see Starting an activity.

    To create a community activity, complete the following steps.

    1. On the community's Overview page, click Start an Activity in the Activities area. When you are creating the first community activity, the link displays as Create Your First Activity.

    2. If you are not already logged in, you are prompted for a user name and password. Provide the requested information, and then click Log In.

    3. In the Name field, type a short name that describes the purpose of the activity.

    4. In the Tags field, type a tag term. As you type, a list of matching tags from the tag collection is displayed. Click a tag to add it, or keep typing to add a tag that is not in the list. Separate multiple tags with commas.

    5. Add members to the activity by doing one of the following:

      • To add all members of the community to the activity as authors, accept the default option, Allow all members of this community access in the activity as Author.

      • To add a subset of community members to the activity as authors:

        1. Select Allow only the following community members access in the activity as, and ensure that Author is selected from the drop-down list.

      • To add all community members or a subset of members to the activity in a role other than author:

        1. Select Allow only the following community members access in the activity as.

        2. Click the Down arrow next to the Author field, and then select Owner or Reader.

        3. Select the check box next to each member who you want to add to the activity.

          Community owners are not listed because they are automatically added to community activities by default.

    6. In the Activity goal field, enter a description of the activity. Provide a sentence or two that summarizes the goal of the activity, its audience, or the type of content that you want members to add to it.

    7. In the Due date field, add the date by which this activity must be completed. Set the date, or select it from the calendar control provided.

    8. Click Pick an activity template to see a list of available templates. If you choose not to use a template, select None from the list.

    9. Click Save to finish creating the activity.


    Results

    After you save the activity, it opens in the Activities user interface where you can start to add entries and to-do items. Community members receive an email message to notify them that they have been added to the new activity. For information on how to work with your activities, click the Help link in the navigation bar. You can return to the community at any time using the navigation links that display at the side of the page.


    What to do next

    From the community, you can do the following:

    • Click Start an Activity to create another activity.

    • Click Activities to display the full list of activities associated with the community.


    Manage community activities

    After adding the Activities widget to your community, you can edit activity details, move or hide the widget, or remove it from the community if it is no longer needed.

    You must be a community owner to edit community activities, or to hide, move, or remove the Activities widget. You must also be logged in to IBM Connections to perform these tasks.

    To edit information about a community activity, such as the activity title, goal, tags, and so on, you must edit the activity in the Activities application. For more information, see Editing an activity.

    Community owners cannot perform management tasks for any activities that have been shared with a community. Only the activity owner who shared the activity with the community can manage that activity. If your community no longer uses activities, you can remove the Activities widget from the community, or you can hide it temporarily until it is needed again using the options available from the widget action menu.

    To manage community activities, open the community and complete the following tasks as needed.

    • To edit basic information about an activity, such as its title, goal, and tags, click the activity title to open it in Activities application. From there, select Activity Actions > Edit Activity to edit the activity. For more information on how to work with your activity, click the Help link in the Activities user interface.

    • You can also perform the following widget management tasks by clicking the Actions icon in the widget title bar and selecting from the menu that displays:

      • To move the widget up or down the Overview page, choose Move Up or Move Down as appropriate.

      • To hide the widget, choose Hide and confirm to temporarily remove the widget from the community.

        Hide the Activities widget does not delete any activity content. When you are ready to continue using activities, select Community Actions > Customize to open the content palette, click Hidden, and select Activities to restore the widget to the community. Any content previously added to the widget is restored.

      • To permanently remove the widget, choose Remove and confirm to remove the widget.

        Choosing this option permanently deletes any community activities. This content cannot be recovered once it is deleted. For activities that have been shared with the community, removing the Activities widget only removes community access. The activities still exist in the Activities application, but they are no longer shared with the community.

    Use a community blog

    Use a blog to enhance your community with a way to ask a question, brainstorm, or simply share your ideas. A community blog is for the exclusive use of community members.


    Create a blog for your community

    Use a blog to enhance your community with a way to ask a question, brainstorm, or simply share your ideas. When you are a community owner, you can create a blog for the exclusive use of community members. A community can have only one blog.

    Where your blog displays and how other users interact with it depends on whether it is public, private, or moderated. Users and owners can access community blogs in the following ways:

    • Blogs created for public communities are public blogs. In addition to being available to people who join or visit the community page, they are displayed on the Blogs Home page and are available for all to read.

    • Blogs created for restricted communities are available only to the community members. This type of blog is not available from the All Blogs list on the Blogs Home page, but you can view and manage it from the My Blog page.

    If you create a blog for a restricted community, but then change the community to a public community, the blog is displayed on the Blogs Home page and is available for all to read.

    To create a blog for your community, complete the following steps.

    1. From your community's Overview page, select Community Actions > Customize and select Blog. The community blog is created and displayed on the community's Overview page.

      You must be logged in to a community to access the Community Actions menu.

    2. Choose Create Your First Entry to create the first blog entry.

    3. Return to your community. The new entry displays in the Blog area.

      Certain rich-text items that you add to a blog entry appear as plain text if you view them from the community overview page. For example, if you show the details so you can view an entry from the community overview page, links appear as plain text and emoticons do not display. When you open the entry you will see the link in its proper format and be able to view the emoticon.


    What to do next

    From the community, you can do the following:

    • Create a blog entry by clicking Create Blog Entry.

    • See all entries for the blog by clicking View All to open the Blog page.

    • Change blog settings, such as the title, description, tags, time zone, member access, and whether the comments should be moderated, by clicking Community Actions > Edit Community, and then clicking the Blog tab.

    The community blog that you create also displays on the My Blog page. You can edit the settings for the blog from that page as well as from the community.


    Manage your community blog

    After you add a blog to a community, you can manage access to the blog, hide the blog, or remove it from the community.

    You must be a community owner to edit, hide, or remove a community blog, or to change the blog membership. When you first create a community blog, all members of the community are granted author access by default. Depending on your community, you might want to change the access level for your members. Note that access is always community-wide. Community owners are always blog owners and have full access to post entries as well as to manage the blog and its users. All other community members can have one of the following roles:

    Table 48. Community blog roles

    Role Description
    Author Allows user to post entries, but not to manage the blog. Users with this role can also edit and delete other users' entries.
    Draft Allows user to save draft entries only.
    Viewer Allows users to read blog posts but not to contribute to the blog.
    In addition to managing access to the community blog, you can also hide blog activity or delete the blog from the community.

    You can perform the following management tasks for a community blog:

    You must be logged in to IBM Connections to perform management tasks for your community blog.

    • To edit basic information about the blog, select Community Actions > Edit Community on the Overview page and click the Blog tab. Alternatively, select Edit from the widget action menu.

      You must be logged in to the community to access the Community Actions menu.

      1. Edit any of the basic information about the blog, such as its title, description, or tags.

      2. Change whether all community members have author, draft, or viewer membership.

      3. Choose whether comments added to the blog are moderated. Moderated comments are saved into a draft state until you approve them for posting to the blog.

      4. Click Submit when you are ready to save your changes.

    • To add or remove a blog member, you need to add or remove that person from the community membership. You can do this on the community's Members page. For more information about changing community membership, see Managing community membership.

    • You can also perform the following management tasks from the community Overview page by clicking the Actions icon in the Blog widget title bar and selecting from the menu that displays:

      • To move the Blog widget up or down the Overview page, choose Move Up or Move Down as appropriate.

      • To hide the blog, choose Hide and confirm to temporarily remove the blog from the community.

        When you are ready to resume blog activity, select Community Actions > Customize and add the blog back from the Hidden section of the content palette. All the content is restored.

      • To remove the blog and all its content, choose Remove and confirm to permanently remove the blog.

    Work with feeds

    Keep your community informed with up-to-the-minute information by adding feeds to web sites of interest to the community.


    Use feeds

    Use feeds to stay up-to-date with information relevant to your community.

    To add feeds to a community, your community must contain the Feeds widget. For information about adding widgets to a community, see Add widgets to your community. Feeds pull data from one website into another. A feed is a regularly updated summary of web content, along with links to full versions of that content. When you subscribe to a feed for a website by using a feed reader, you receive a summary of new content from that website. For example, if you create a community for a group of doctors, you might include a feed from a medical journal so that all members of the community have direct access to the journal articles from within the community page.

    Communities can subscribe to feeds that are devoted to subjects of interest to the community. This subscription enables the community to get useful information delivered to it in one place from multiple sites of its choosing without having to actively search the web for the latest information.

    The Feeds area on a community Overview page displays the five most recent feeds added to the community.

    To access updated information from a feed associated with your community.

    1. From the community Overview page, click Feeds.

    2. Click More next to a feed that interests you.

      If you try to access a feed without logging in to IBM Connections first, you might be denied access. Either log in to Connections or click the Feed name and enter your login credentials.

    3. Click a link that interests you to read more.

    4. Optional: Use the Next and Previous links to browse more feed entries.


    Add a feed to a community

    Subscribe to a feed to keep your community informed with up-to-the minute information from a web site without leaving the community page. Any member of a community can add a feed. You can only add publicly available feeds to a community. An administrator may make certain feed sources trusted . for example, feeds from other IBM Connections applications . in which case the authenticated feeds from these sources display. However, by default, authenticated feeds are not allowed.

    Follow these steps to add a feed to your community.

    1. Find a feed to subscribe to. For example, go to the IBM Syndicated Feeds web page and choose one of the IBM feeds.

    2. Right-click the feed icon and copy the link URL. This image is one type of feed icon , but there are many variations.

      • In Microsoft Internet Explorer, right-click and choose Copy Shortcut.

      • In Mozilla Firefox, right-click and choose Copy Link Location.

    3. From any community for which you are a member, click Feeds in the navigation pane.

    4. Click Add Feed to open the Add Feed form.

    5. Paste the web address of the feed into the Feed field.

    6. Complete the Add Feed form and click Save.


    What to do next

    If you get a 403 error when you try to access the feed, this might be because your administrator has configured your deployment to prevent access to URLs outside this product. Contact the administrator for more information.


    Edit community feeds

    Make sure that your feeds continue to be useful by keeping their details up-to-date and accurate.

    To edit a community feed, you must be a community owner or the member who added the feed.

    To edit the feeds associated with a community, complete the following steps.

    1. From the community that contains the feed that you want to edit, select Feeds in the navigation sidebar.

    2. Click More next to the feed name.

    3. Click Edit to open the Edit Feed form.

    4. Make the changes to the following fields:

      Table 49. Edit Feed form fields

      Field name Value
      Feed Edit the web address of the feed.
      Name Rename the feed. Choose a name that clearly identifies the resource.
      Description Describe the information available from the feed. Include your own comments about why a community member might want to use the feed.
      Tags Type one or more tags. A tag is a keyword that represents the content of the feed. The tags that you define here display in the tag cloud on the overview page of the current community.

    5. Click Save to save your changes.


    Delete community feeds

    Keep your community up-to-date by removing feeds that are no longer current.

    To delete a community feed, you must be a community owner or the member who added the feed.

    To delete a feed from a community, complete the following steps.

    1. From the community's Overview page, click Feeds.

    2. Click More next to the feed that you want to delete.

    3. Click Delete.

    4. Click OK to confirm that you want to delete the feed.


    Subscribe to a Communities feed to get automatic updates

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Use a community wiki

    Use a wiki to share resources with your community and collaborate with fellow members.


    Add a wiki to a community

    Add a wiki to your community so that you can share information and resources with fellow community members, and work collaboratively on projects.

    You must be a community owner to add a wiki to a community, and you must also be logged in to Communities. You cannot add an existing wiki to a community. Add a wiki to a community provides a shared environment

    ...where members can work together to create and update information in an ongoing, collaborative process. Wiki membership is managed by the community and there is a direct mapping between membership roles. Community members with the Editor role can create and edit pages in the wiki. Members are given the Editor role by default. Users with the Reader role or who are not members of the community can read the wiki content but cannot make any contributions or changes. To change the membership role setting for Wikis, see Managing a community wiki.

    When you add a wiki to a community, the wiki is automatically given the same name as the community. A Wiki area is added to the community's Overview page and, when community members start to populate the wiki, this area displays links to the five latest wiki updates. A Wiki link also appears in the navigation sidebar. Click this link to open the wiki in the Wikis user interface. The community's business card displays at the topic of the wiki, allowing community members to navigate to the community directly from the wiki user interface.

    To add a wiki to your community, complete the following steps.

    1. From the community's Overview page, select Community Actions > Customize.

      You must be logged in to a community to access the Community Actions menu.

    2. Click Wiki to add a wiki to the community.

    3. Optional: Click Close to close the content palette.


    What to do next

    From the community, you can do the following:

    • To create a new wiki page, click Create a Wiki Page.

    • To open the wiki and see the latest activity, click View All.

    • To edit wiki settings, click Community Actions > Edit Community, and then click the Wiki tab.


    Add pages to a community wiki

    Add a new wiki page to share information and collaborate with fellow community members.

    Community members must have the Editor role to add pages to a community wiki. If your community has a wiki associated with it and you have the appropriate access level, you can add pages to the wiki directly from the community.

    To create a wiki page.

    1. Open the community's Overview page.

    2. In the Wiki area, click Create a Wiki Page. The New Page form opens in the Wikis user interface.

    3. Enter a name for the page in the New Page field. Choose a name that describes the page content.

    4. Enter your content in the text field provided, then click Save and Close.


    What to do next

    For information on how to work with your new page, click Help. You can return to the community at any time by clicking any of the community page links at the side of the page.


    Manage a community wiki

    After adding a wiki to your community, you can edit the wiki description, hide the wiki, or remove it from the community. As a community owner, you can edit basic information about the community wiki, change the membership role of members, and suspend wiki activity or remove the wiki from the community.

    You must be logged in to IBM Connections to perform wiki management tasks.

    • To edit the wiki description:

      1. Select Community Actions > Edit Community on the Overview page and click the Wiki tab.

        You can also select Edit from the widget action menu.

      2. Edit the information in the Description field and then click Save.

    • To edit membership roles:

      1. Select Community Actions > Edit Community on the Overview page, and then click the Wiki tab.

      2. Select Editor or Reader in the Members area, and then click Save.

        The role that you select is given to all members of the community.

    • You can also perform the following management tasks from the community's Overview page by clicking the Actions icon in the Wiki widget title bar and selecting from the menu that displays:

      • To move the widget up or down the Overview page, choose Move Up or Move Down as appropriate.

      • To hide the wiki, select Hide and confirm to temporarily remove the wiki from the community.

        When you are ready to resume wiki activity, click Community Actions > Customize to open the content palette, click Hidden, and select Wiki to restore the wiki to the community. Any content previously added to the wiki is also restored.

      • To delete the wiki and all its content, select Remove and confirm to permanently remove the wiki.

    Use an Ideation Blog in your community

    An Ideation Blog is a central blog space where community members can go to contribute and vote on ideas related to the community's area of focus.

    Add an Ideation Blog to your community

    Posting ideas to an Ideation Blog

    Manage your community's Ideation Blog

    		 


    Add an Ideation Blog to your community

    If you are a community owner, you can add an Ideation Blog to your community to enable members to share and vote on ideas that are relevant to the community. A community can have only one Ideation Blog. An Ideation Blog is a central place where community members can share and promote ideas in a dynamic way. By capturing ideas in a central location, you can leverage the creativity of your members and encourage them to brainstorm, develop, and refine innovative concepts that support the community's goals.

    Ideation Blogs are also accessible from the Blogs user interface, where Ideation Blogs belonging to public communities are visible to everybody. Ideation Blogs created for restricted communities are visible to community members only.

    To create an Ideation Blog for your community, complete the following steps.

    1. From your community's Overview page, select Community Actions > Customize.

      You must be logged in to access the Community Actions menu.

    2. Select Ideation Blog.

    3. Optional: Click Close to close the content palette.


    Results

    An Ideation Blog area is added to the community's Overview page. As community members start to add content to the Ideation Blog, this area displays a summary of the latest idea updates and tells you how many comments, visits, and votes each idea has received. Click Create Your First Idea to add your first idea.

    An Ideation Blog link also displays in the navigation sidebar. Click this link to open the Ideation Blog in the Blogs user interface. Note that the Ideation Blog is automatically given the same name as the community.

    For more information about how to work with your Ideation Blog, click the Help link in the navigation bar. You can return to the community at any time using the navigation links that display at the side of the page.


    What to do next

    From the community, you can do the following:

    • Add an idea to the Ideation Blog by clicking Contribute an idea under Ideation Blog.

    • Select an idea from the Ideation Blog area to open it and review it in more detail.

    • View all the ideas added by community members by clicking View All to open the Ideation Blog.

    • Select Ideation Blog from the navigation to access more options for working with the Ideation Blog.

    For information about how to manage your Ideation Blog to effectively control idea creation and voting, see Managing an Ideation Blog.


    Posting ideas to an Ideation Blog

    Update your community's Ideation Blog to share your latest ideas with fellow community members.

    You must be a community member to contribute an idea to an Ideation Blog. If your community has an Ideation Blog and you have the appropriate access level, you can add your own ideas to the Ideation Blog directly from the community.

    1. Open the community's Overview page.

    2. In the Ideation Blog area, click Contribute an idea. The New Idea form opens in the Blogs user interface.

    3. Enter a title in the Title field.

    4. Click Add Tags to add keywords that categorize your idea and make it easier to find later.

    5. Enter your idea in the Idea text field.

    6. Click Advanced Sets to control the following settings:

      • Allow characters to be converted into emoticons.

      • Delay posting an idea until a time and date that you specify.

      • Limit the number of days for posting comments for the idea.

      • Specify a custom URL that points to the idea.

      • Include an external media link, such as a video.

    7. Do one of the following:

      • To publish your idea, click Post.

      • To save your idea as a draft without publishing it, click Save as Draft.

      • To review your idea before posting it, click Preview.


    What to do next

    You can vote and comment on other people's ideas in the Ideation Blog, or graduate your own ideas when you think they have enough support from the community. For more information about what you can do with ideas, see Using an Ideation Blog. You can also click the Help link.

    When you are finished working with the Ideation Blog, you can return to the community by clicking any of the community page links in the navigation.


    Manage your community's Ideation Blog

    After you add an Ideation Blog to a community, you can control membership of the Ideation Blog, hide the Ideation Blog, or remove it from the community.

    You must be a community owner to perform management tasks for an Ideation Blog. You must also be logged in to IBM Connections.

    If your community has an Ideation Blog, you can manage it from the community in a number of ways. For example, you can hide or remove the Ideation Blog, or update the membership of the Ideation Blog. You can also perform Ideation Blog management tasks from the Blogs application. For more information, see Managing an Ideation Blog.

    • To add or remove an Ideation Blog member, you need to add or remove that person from the community membership. You can do this on the community's Members page. For more information about changing community membership, see Managing community membership.

    • You can perform the following Ideation Blog management tasks from the community Overview page by clicking the Actions icon in the Ideation Blog widget title bar and selecting from the menu that displays:

      • To move the Ideation Blog widget up or down the Overview page, choose Move Up or Move Down as appropriate.

      • To hide the Ideation Blog, choose Hide and confirm to temporarily remove the Ideation Blog from the community.

        When you are ready to resume Ideation Blog activity, select Community Actions > Customize and select Ideation Blog from the Hidden section of the content palette. All the Ideation Blog content is restored to the community.

      • To remove the Ideation Blog and all its content, choose Remove and confirm to permanently remove the Ideation Blog.

    Use a media gallery

    Add a media gallery to your community so that you and other members can share photos and videos with the rest of the community.

    Add a media gallery to your community

    Viewing your community's media gallery

    Uploading content to the media gallery

    Work with media gallery content

    Manage the Media Gallery widget

    		 


    Add a media gallery to your community

    Add the Media Gallery widget to your community to enable members to share multimedia content with the rest of the community.

    You must be a community owner to add a media gallery to a community. A community can only contain one media gallery. Add a media gallery to a community provides a dedicated multimedia space where members can upload and view photos and videos that are relevant to the community.

    When you add a media gallery to your community, the Media Gallery widget is added to the community's Overview page. As community members start to add content to the media gallery, the widget displays a selection of thumbnail images of that content. A Media Gallery link is also added to the navigation sidebar, allowing members to access the full set of multimedia content in the community.

    To add a media gallery to your community, complete the following steps.

    If the default content type does not exist when the widget is added to a community, an error message displays indicating that the files cannot by displayed. Contact your administrator.

    1. From the community's Overview page, select Community Actions > Customize.

      You must be logged in to access the Community Actions menu.

    2. Click Media Gallery and then close the content palette by clicking the Close palette icon.


    What to do next

    Your administrator can make custom photo and video templates available for use in the Media Gallery widget, allowing you to associate different types of custom data with your photos or videos. For more information, see Importing custom object types for media galleries in the Administering section of the documentation. If you want to use templates other than the ones provided by default, you can configure widget preferences to specify which templates you want to use in your media gallery. You can also specify what type of content you want to show in the media gallery: photos only, videos only, or both. Select Edit from the widget action menu to select the type of content you want to display and the templates to use. For more information, see Managing the Media Gallery widget.


    Viewing your community's media gallery

    View the photos and videos that you and other members have added to your community's media gallery.

    To open a community's media gallery, from the community's Overview page, click View All in the Media Gallery widget or select Media Gallery from the navigation. The Media Gallery page displays thumbnails of all the multimedia content in your community's media gallery. You can see who uploaded each file and when the file was last updated, as well as if the file has been locked. You can also see how many people have downloaded or commented on a file, and preview photos or videos using the gallery previewer.

    Choose from the following options when viewing media gallery content:

    • Use the Sort by options to sort content by date or by most commented.

    • Use the Display options to display the multimedia content in gallery format or list format.
      Tip: Choose list format if you want to see how many times a file has been downloaded or find out how many people like a file. More sorting options are also available from the list view. For example, you can sort by popularity and most liked as well as by date and most commented.

    • Use the Show options to filter the display to show photos only, videos only, or photos and videos together.

      Community owners can configure the Media Gallery widget to display content of one type only, videos or photos. In this case, the option to filter the media gallery content by file type is not available.

    • Click a thumbnail to open the file in the previewer. From the previewer, you can:

      • Use the arrows on either side of the dialog to view the rest of the thumbnails in the current view. You can also use the arrow keys.

      • Click Go to summary under an image to access more advanced options for working with the file.

      • If you are viewing a video file, click the Play arrow to play the video.

    • If the like icon or displays a number next to it, you can click it to see a list of the people who have liked the file.

    • Click a file name to view detailed information about the file and access more advanced options for working with it. For more information about what you can do with media gallery files, see Working with media gallery content.


    Uploading content to the media gallery

    Use your community's media gallery to share photos and videos with the rest of your community.

    Community owners can configure the media gallery to show videos only or photos only. In this case, the options available in the user interface will only allow you to upload files of the specified type.

    When uploading content, you might need to accept custom terms and conditions or specify additional metadata, such as the photo or video location, or video duration. The following steps describe the default procedure for uploading a photo or video file, but additional custom options might be included in your configuration. If your community has a media gallery, you and other members can upload multimedia content to the community from the Media Gallery widget on the community's Overview page or from the main Media Gallery page.

    To upload a file to your community's media gallery, complete the following steps.

    From the Media Gallery widget, click Upload, and then do one of the following:

    • To upload a photo:

      1. Select New Photo.

      2. Click Browse to locate the image that you want to upload.

      3. Enter one or more tags in the Tags field. This is an optional step.

      4. Enter an optional description of the image in the Description field, and then click Upload.

    • To upload a video:

      1. Select New Video.

      2. Click Browse to locate the video that you want to upload.

        The video file must be encoded using the H.264 format, and the audio must be encoded with AAC. For more information about the supported codecs, go to the following web page:
        http://kb2.adobe.com/cps/402/kb402866.html

      3. Enter one or more tags in the Tags field. This is an optional step.

      4. Enter an optional description of the video in the Description field.

      5. To upload a preview image to display in the media gallery, select Upload a thumbnail image for this video. This is an optional step.

        This option is not available when premoderation is enabled.

      6. Click Upload.

      7. If you selected the option to upload a thumbnail image for the video, click Browse to locate the image. and then click Upload. You can only do this after the video has been successfully uploaded.

        You can change the preview image for a video file later by uploading a replacement file. For more information, see Working with media gallery content.


    Results

    If premoderation is enabled for your community, the file is submitted for upload pending approval by the community moderator. If premoderation is not enabled, the file is uploaded immediately. Note that when you first upload a photo or video, you might not see the image immediately. Instead, you might see a gray icon as a placeholder for the file. Refresh the page after a few minutes to see the file rendered on the current page.


    What to do next

    The files that you add to your community's media gallery are stored in the community's file library. Although you can access media gallery files using the Files widget, it is preferable to use the media gallery as your access point as it provides more options for working with your photo and video files. For more information, see Working with media gallery content.


    Work with media gallery content

    You can work in different ways with the content in your community media gallery, depending on your access level.

    To work with media gallery content, first open the media gallery by clicking View All in the Media Gallery widget or by selecting Media Gallery from the navigation. On the Media Gallery page, select the file that you want to work with by clicking the file name to open the details page.

    You can perform the following tasks when working with media gallery files.

    • To indicate to other members that you like a file :

      1. Select the file that you like.

      2. Click Like. If you change your mind, click Undo. The number of people that like a file displays next to the like icon .
        Tip: If a file is liked by other members, you can click the like icon to see who else likes the file.

    • To replace a file with a newer version:

      To perform this action, you must be a community owner, a member editor, or the user who uploaded the original file.

      1. Click Replace.

      2. Click Browse to locate the replacement file, and then click OK. If you want to replace the file with a file that has a different extension, click Change Extension to confirm that you want change the file extension and replace the original file.

    • To edit a files properties:

      To edit a files properties, you must be a community owner or the user who uploaded the original file. You can edit the files default properties and any custom properties that are available.

      1. Click Edit properties, update the properties as needed, and then click OK to save your changes.

        You can also edit a files custom properties (if they are available) by clicking Custom Properties and clicking Edit properties.

    • To remove a file, you have one of the following choices depending on your deployment:

      • Click Delete, and then click Delete again to confirm to delete the file.

      • Click Move to Trash and then confirm to move the file to trash.

      To perform this action, you must be a community owner or the user who uploaded the original file.

    • To flag a file as containing inappropriate content:

      Post moderation must be enabled for you to be able to flag media gallery content; otherwise the Flag as Inappropriate option does not display in the user interface.

      1. Select More actions > Flag as Inappropriate. If the content is not a video, you can click Flag as Inappropriate without clicking More actions first.

      2. Enter your reason for flagging the file and click Submit.

        When you flag media gallery content as inappropriate, the community owner or a designated moderator can review the flagged content and the reason given for flagging it, and then determine whether the content should be removed or the flag should be dismissed.

    • To change the preview image associated with a video file:

      This option is not available if pre-moderation is enabled (owners must approve all content). It is still available if only post moderation (viewers can flag inappropriate content) is enabled.

      1. Select More actions > Change Thumbnail Preview. If post moderation (viewers can flag inappropriate content) has not been enabled, then you can click Change Thumbnail Preview without clicking More actions first.

      2. Click Browse to locate the replacement image, and then click Upload.

    • To download a file, click Download this file and choose whether to open or save the file.

    • To comment on a file, click Add a comment, enter your comment in the field provided, and then click Save.

      After adding a comment, you can later make changes to it by clicking Edit next to the comment, or you can delete the comment by clicking Delete. Community owners can delete any comments, but they can only edit comments that they own; they cannot edit comments added by other users. The Files administrator can edit any comments about media gallery files.

      When postmoderation is enabled, members can also flag comments to the media gallery as inappropriate by clicking Flag as inappropriate next to a comment.

    • To view detailed information about the file, such as when it was uploaded or last updated, click About this file. You can also view the file size and find out how many times the file has been downloaded.

    • If the community owner has selected custom templates for use in the media gallery, click Custom Properties to view details of the custom properties associated with the file.

    • If media gallery content has been locked in the Files application, then it also appears as locked in the media gallery. If you have the ability to unlock the file, then a View in Files to unlock link displays that takes you to the file in the Files component, where you can unlock the file. If you did not lock the file, then the name of the person who locked the file displays. To lock or unlock a file, see Managing community files.


    Manage the Media Gallery widget

    As community owner, you can specify the type of content that you want the Media Gallery widget to display by editing settings for the widget. You can also hide the widget or remove it from the community.

    You must be a community owner to hide or remove the Media Gallery widget, or to set display preferences for the widget. You must also be logged in to IBM Connections. You can set widget preferences to specify whether the Media Gallery widget in your community shows only photos or videos, or both. If the widget is configured to show both photos and videos, community members can then filter the media gallery by file type. You can also specify the property templates to use for photo and video content within the community. Depending on which template you specify, different attributes might display in the user interface in addition to the standard attributes when users are uploading and working with media gallery content.

    If you want to remove the Media Gallery widget from your community temporarily, you can hide it from the community. You can also delete the widget if you want to remove it from the community permanently.

    From the community's Overview page, click the Actions icon in the Media Gallery widget title bar, and select from the menu that displays.

    • To set preferences for the widget display:

      1. Click Edit.

      2. Select an option from the Use the media gallery to show list. You can display photos and videos, photos only, or videos only.

      3. Select a photo property template.

      4. Select a video property template.

      5. Click Save.

    • To move the Media Gallery widget up or down the Overview page, choose Move Up or Move Down as appropriate.

    • To hide the Media Gallery widget, choose Hide and confirm to temporarily hide media gallery content from the community.

      When you want to make the media gallery available again, select Community Actions > Customize to open the content palette, and select Media Gallery from the Hidden section of the palette. All content is restored.

    • To permanently remove the Media Gallery widget, choose Remove and confirm to permanently remove the widget.

      Removing the Media Gallery widget does not delete any of the photo or video files uploaded to the community. The media gallery content is still present in the community-owned Files library.

    Use Linked Libraries

    Add Linked Libraries to IBM Connections communities to work with documents and folders on Enterprise Content Management (ECM) servers. For example, when you add a new document to a Linked Library you are adding the document to the ECM server. There are two types of supported ECM server: IBM FileNet® P8 and IBM Content Manager. There are some small differences in how Linked Libraries behave when using one or the other. Those differences are addressed in this help.

    To use Linked Libraries you must log in to both IBM Connections and the ECM server. If your environment uses single sign-on, logging in to IBM Connections also logs you in to the ECM server. If your environment does not use single sign-on, you must log in to the ECM server separately. IBM Connections prompts you to log in to the ECM server when you open a community with a Linked Library. If you are prompted to log into the ECM server and do not know an appropriate user name and password, ask your administrator to provide you with one.


    How do I add a Linked Library to my community?

    Community owners can add a Linked Library to their community.

    You can only add one Linked Library to a community.

    To add a Linked Library to a community:

    1. From the Overview page, click Community Actions > Customize.

    2. Click Linked Library. The Linked Library displays in the Overview view in communities. Open the full application by clicking the Linked Library name, or clicking Linked Library in the navigation bar.

    3. Optional: Click Close palette.


    What to do next

    To delete a Linked Library, click Overview in the community. Then click the Actions icon and select Remove. You must be logged in as a community owner to delete a Linked Library from a community.


    How do I show files and folders in a Linked Library?

    Edit the Linked Library to create a connection to an ECM server, and then specify a sort order and column to specify how documents display.

    You must be logged in as a community owner.

    Perform these steps to show files and folders:

    1. In the widget, click the Actions icon and select Edit.

    2. In the Server field, type the URL address of the ECM server, including a protocol and port number as necessary, for example http://my.ecm.server:80.

    3. Perform one of the following steps:

      • Check Log in with my current credentials. If the environment uses single-sign on, you will be logged in with your IBM Connections user name and password. If the environment does not use single-sign on, you are prompted for the name and password of a user with access to the ECM server.

      • Uncheck Log in with my current credentials. Set the user name and password of a user with access to the ECM server.

    4. Click Log In.

    5. Select a Linked Library or folder from the list to show in the library. You can change this selection later.

    6. Optional: Click the Customize tab.

    7. Optional: Select a column and sort order. Columns and sort order options are specified on the ECM server. Your selection determines how the folders and files are sorted in the Linked Library.


    How do I work with folders?

    You can add, rename, and delete folders in Linked Libraries.

    Permissions for working with folders are set on the ECM server.

    1. To add a folder, open the Linked Library or folder where you want the new folder and click New Folder. Then type a name and description.

    2. To rename a folder in the compact layout, click the down arrow next to the folder name, and then select Rename. In the descriptive layout click More.

    3. To delete a folder in the compact layout, click the down arrow next to the folder name, and then select Delete. In the descriptive layout click More.


    How do I add new documents?

    Use Linked Libraries to copy documents from your computer onto the ECM server. To add documents, the Linked Library must be part of a public community or you must be a community member.

    Perform these steps to add new documents:

    1. Open the Linked Library and folder you want to upload the document to.

    2. Click Upload a File.

    3. In the File field click Browse and select your file.

    4. Optional: Edit the file name, and type a title and description.

    5. Optional: In the Document type section click Change to change the document type. The default document type is the document type of the current folder. The selection of document types is specified on the ECM server. See Document types for more information on document types.

    6. Optional: Select Show only required fields to display only required fields in the document type section.

    7. Optional: Select Show inline help text to display inline help text for fields in the document type section. Inline help provides information on how to complete the fields.

    8. Complete at least the required fields for the document type. Required fields are marked with an asterisk, for example: *Sales Date.

    9. Perform one of the following steps:

      • Click Check In to upload the file and make it available to Linked Library users.

      • Click Save as Draft to upload the file as a draft. Only you can see and work with your drafts. To check in a draft, open the file page and click Check In.


    How do I delete documents?

    Delete a document permanently removes the document and all of its attachments and versions from the ECM server.

    You cannot retrieve a deleted document. Be absolutely sure that the document is no longer necessary, or download a copy to your computer as a backup copy.

    Most users cannot delete a document that has a working draft or a pending draft, or a document that is checked out by another user. Only administrators can delete documents in these states.

    You must have permission to delete other people's documents in a Linked Library. Permissions are set on the ECM server.

    Click the down arrow next to the name of the document you want to delete, and then select Delete.


    How do I edit documents?

    Download Linked Library documents to your computer to edit them. Then replace the current version of the document with your edited version.

    You can also edit documents with IBM Lotus Quickr Connectors. See How do I edit documents with connectors?.

    This topic includes the optional step of checking out a document before you edit it. Checking out a document locks it so no one else can replace the document while you are working on it. This gives you some control over edits, and avoids conflict errors if you and another person try to replace the document at the same time.

    Perform these steps to edit documents:

    1. Optional: Check out the document to lock it. No one else can edit the document while it is checked out.

      1. Click the document title in any view to open its summary page.

      2. Click Check Out.

        A small red lock icon

        indicates that documents that are locked when someone else has checked out the file. A gray lock icon with a green key
        appears if you have checked out the file.

        To unlock the document, click the down arrow and click Check In or Cancel check out. Check In makes the your edited version the current version and unlocks the document. Canceling a check out deletes any drafts and unlocks the document.

    2. Download the document.

      1. In the summary page, click Download this file.

      2. Save the document on your local computer according to your browser, for example in Microsoft Internet Explorer click Save.

    3. Edit the document on your computer.

    4. Replace the document.

      1. In the summary page, click Replace.

        If a draft was created, open the private draft summary page by clicking View private draft, and then click Replace.

      2. Click Browse and navigate to the file on your computer.

      3. Perform one of the following steps:

        • Click Check In. This replaces the current public document with the version on your computer, and then unlocks it.

        • Click Save as Draft to replace the current draft document with the version on your computer, and keep it locked. When you are ready to make the draft the public version, click Check In.


    How do I edit documents with connectors?

    Edit Linked Library documents in their native applications using IBM Lotus Quickr Connectors.

    You must install IBM Lotus Quickr Connectors.

    With Lotus Quickr Connectors installed you can open documents in their native application directly from a Linked Library, for example edit Microsoft Word documents in Microsoft Word. When a file can be opened with more than one application, the computer default settings determine the application, for example html files open in the default web browser.

    1. In a Linked Library document list, click the menu arrow next to a document, and then select Edit document. The document opens in its native application. If Edit document isn't available, click the Check connector installation link at the end of the list to check your connector installation.

      If the Lotus Quickr Connectors were not installed, not running, or failed to be detected the first time you used a Linked Library, then the link is Enable editing (check connector installation). Click that link, the Linked Library widget finds Lotus Quickr Connectors, and then the link changes to Check connector installation. Then go to Step 2.

    2. Edit the document and save it. The document is saved as a draft in the Linked Library.

    3. Refresh the page to see the updated state of the document. When you are ready to make the draft the public version, click Check In.


    How do I edit document properties?

    Edit document properties, including custom document type properties. You can also replace the current version of the document.

    Edit document properties and replacing the current version of the document are optional.

    Perform these steps to edit document properties:

    1. Click the document title in any view to open its summary page.

    2. Click Edit properties.

    3. Edit the file name, title, and description.

    4. To replace the current document with a local version on your computer, in the Replace file field click Browse and locate the local version. Any property edits are then set for your version.

    5. In the Document type section click Change to change the document type. The default document type is the document type of the current folder. The selection of document types is specified on the ECM server. See Document types for more information on document types.

      This is only available with FileNet ECM servers.

    6. Select Show only required fields to display only required fields in the document type section.

    7. Select Show inline help text to display inline help text for fields in the document type section. Inline help provides information on how to fill in fields.

    8. Edit the properties. Required fields must have values. Required fields are marked with an asterisk, for example: *Sales Date

    9. Perform one of the following steps:

      • Click Check In to upload the file and make it available to Linked Library users.

      • Click Save as Draft to upload the file as a draft. Only you can see and work with drafts until you check them in. To check in a draft, open the file summary page for the draft and click Check In.


    How do I see information about documents?

    Information about documents is in tabs on the document summary page.

    You can see attachment information, general information about the document, and the document's custom document type properties. If versioning is enabled in your environment, you can also see and work with versions of the document.

    Perform the following steps to see information about a document:

    1. In any list of documents, click the detailed display icon to show more data about each document in the view.

    2. Click the document title in any view to open its summary page, and then perform any of the following steps:

      • Click Attachments to see attached documents. You can download, replace, and delete attachments if you have proper permission. Permissions are set on the ECM server. This tab is only displayed with documents considered "pages" by the ECM repository.

      • Click About this file to see the date and time it was last updated, the date and time it was uploaded, and its size.

      • Click Custom Properties to see the values of the document type properties. See Document types for more information.

      • Click Versions to see versions of a document. You can download, restore, and delete versions if you have proper permission. Permissions are set on the ECM server. This tab is only displayed if versioning is enabled in the repository and for the document type.

    3. Optional: Click More > Open in repository to work with documents in the ECM server.


    How do I work with attachments?

    Add, replace, delete and download attachments from the document summary.

    Attachments appear in the document summary only for pages published to the ECM server from IBM Lotus Quickr, services for IBM Lotus Domino.

    Perform these steps to work with document attachments:

    1. Click a document to open the document summary.

    2. Click Attachments to display a list of available attachments and perform any of the following tasks:

      • To add an attachment, click Add attachment. Select the file you want to add. The File name field will default to the name of the file selected but can be modified.

      • To replace an attachment, click Replace next to the attachment you want to replace. Select the file you want to replace the attachment with. The File name field can also be modified.

      • To delete an attachment, click Delete next to the attachment you want to delete.

      • To download an attachment, click Download next to the attachment you want to download.


    How do I work with versions?

    From the document summary you can restore and download versions of a document, view the change summary of a version (with some ECM repositories), and create a new version of a document.

    Versioning can work differently depending on your ECM server. Some ECM servers only support automatic versioning, so that might be the only option. Other ECM servers support three levels of versioning: automatic, manual, and none. Automatic versioning will create a version every time you edit a document. Manual versioning allows you to choose when you want to create a version. If versioning is set to none, then you are unable to create versions. The version level is associated with the Document Type, so different documents can have different version requirements. The ECM administrator controls the version level.

    Perform these steps to work with document versions:

    1. Click a document to open the document summary.

    2. Click Versions to display a list of available versions and view the change summary.

    3. To restore a previous version, click Restore next to the version you want to restore. Enter a reason for restoring the version in the Change summary field, if it is available.

    4. To download a previous version, click Download next to the version you want to download.

    5. To create a new version of the document click Create a new version. If prompted, enter a reason for creating the new version in the Change summary field. This option is only available with document types that use manual versioning.


    Document types

    A document type is a defined set of information and settings for a document. For example, a license application form is a document that might have required and optional information, and be set for manual versioning. That information and setting can be defined in a document type.

    When users upload or edit documents, they must associate them with a document type, and then they must provide at least required information for that document. The document type information and settings are then associated with the document.

    Document types are a useful tool to help you organize and retrieve documents. On the ECM server, document type information can be used to create custom views containing sets of documents that share common characteristics. Those views can then display in Linked Libraries, if your administrator has enabled views. They also help you control versioning and therefore the amount of storage space used.

    Document types are defined on the ECM server.

    Schedule community events

    Use the Events widget to share information about important events and dates relating to your community.

    Viewing community events

    Create community events

    Manage community events

    Manage access to community events

    Add community events to your personal calendar

    		 


    Viewing community events

    Find out what events are coming up in your community.

    Your community must contain the Events widget for you to be able to see information about community events. To check whether your community has this functionality, look for Upcoming Events on the Overview page. When your community contains the widget, a Events link is also available in the community navigation. Upcoming Events on the Overview page for your community lists the next five events that are scheduled. Community members can access details about the events directly from the widget. Members can also open the Events page to view the full list of events scheduled for the community.

    You can view information about community events in the following ways:

    • Click an event title in Upcoming Events to open an event and view more details about it.

    • Click View All Events in Upcoming Events to view a list of all the events associated with the community. Alternatively, you can select Events from the community navigation to open the Events page.

    • From the Events page, you can do the following:

      • Click the Events tab to view a list of events in order of date. Use the Display options to toggle the display between the summary view and the detailed view. Click Show Past Events to see events that have already finished.

      • Click the Calendar View tab to view the events in calendar format. Use the View option to change how much of the calendar to display: one, two or five days, a week, or a month.


    Create community events

    You can create events in the community Events widget to flag upcoming meetings, all-day events, or events that run for a number of days. To add an event for the community, you must be a community owner or a community member with Author access.

    You can create community events only if your community contains the Events widget. The widget must be added to the community by a community owner. For more information about adding widgets, see Add widgets to your community to make more functionality available. Upcoming Events on your community Overview page lists upcoming events or important dates for the community. You can remind community members about upcoming events and provide details about the event, such as the time and location.

    To create a community event:

    1. Select Events from the community navigation and click Create an Event.

    2. Enter an event name in the Event Title field.

    3. Add one or more words that make the event easier to find in the Tags field.

    4. Use the drop-down controls, select the starting date and time of the event, and then select the finishing date and time.

    5. To specify that the event runs for a full day, select All-day event.

      If you select All-day event, the options to specify a starting and finishing time for the event are not available.

    6. To create a repeating event, click Repeats. Specify whether you want the event to repeat daily or weekly by selecting the appropriate option from the Repeats list.

      • If you select Daily, the event repeats every day until the specified end date. You can clear any day of the week that you do not want the event to occur.

      • If you select Weekly, the event repeats every week at the specified time on the specified day. You can change the frequency to every two, three, four, or five weeks in the Every field.
      By default, you cannot have more than 700 community event instances in a repeating event. Your administrator can reconfigure this setting.

    7. Enter the location of the event into the Location field.

    8. Enter a description of the event in to the Description field.

    9. If you want to notify community members about this event, complete the following steps:

      1. Select Notify community members.

      2. In Select community members, select the boxes next to the names of individual members that you want to invite. To find people, scroll through the alphabetic list of names or type a person's name into the Type to filter this list field. If the activity has more than 500 members, you can click Next to see additional names.

        The filter searches the names on the current page only. If there are multiple pages, click Next until you get to a page with names in the same alphabetic range as the name you are looking for, and then type the name into the filter box.

      3. If you want to add a comment that is displayed in the invitation that is sent to the members, add it to the Message field.

    10. Click Save.


    Manage community events

    Depending on your access level, you can work in different ways with the events that members have added to the community.

    To edit or delete the events that are flagged in the community calendar, you must be a community owner or a community member with Author access to the Events widget. Community members can only edit or delete events that they created themselves. Community owners can edit or delete any event in the Events widget.

    By default, all logged in users that can access the community can add comments to an event entry. Only a community owner or the comment writer can delete a comment.

    A community owner or member can send invitations to interested community members about events.

    To manage a community event, select Calendar from the community navigation, expand an event entry in the Events view, and do one of the following:

    • To attend the event, click Attend.

    • To see a list of others that are attending, scroll to the People Attending section.

    • To update the details of an event, click Edit, update the title, date, duration, location, or description of the event, and then click Save.

    • To follow a community event, click Follow.

    • To delete an event that occurs only once, click More Actions > Delete and then click Delete again.

    • To delete an event that repeats, click More Actions > Delete, specify whether you want to delete the selected instance or the entire series, and then click Delete again.

    • To add a comment click Add a comment and enter you comment. Click Save when you have finished.

    • To delete a comment, click Delete, and then click Delete again.

    • To invite community members to an event, click More Actions > Notify Other People, select the community members, enter a message to accompany the invitation, and then click Notify.


    Manage access to community events

    As community owner, you can manage the level of access that community members have to the Events widget. Community owners always have Author access.

    Community members have Author access to the Events widget by default, which means that they can add events, and edit or delete events that they create themselves. If you want to restrict member access to the widget so that members can only read information about community events, but cannot add or change event information, you must set the membership role to Reader. All community members are given the same role.

    To change the access level community members have to Events.

    1. Select Community Actions > Edit Community.

    2. Click the Events tab.

    3. Select the role that you want members to have and click Save.


    Add community events to your personal calendar

    Stay up-to-date with upcoming community events by adding a feed from the Events widget to your personal calendar.

    Your email application must support iCal or iCalendar feeds. By default, you can import events up to six months old and upcoming events up to 12 months into the future. Your administrator can reconfigure this setting.

    To add a feed from the Events widget to your personal calendar.

    1. Select Events from the community navigation bar.

    2. Click Add to Personal Calendar.

    3. Click the URL that displays in the box to subscribe to all the events for the community. Depending on your calendar application, you might need to copy the URL into that application. Click OK.

    4. Subscribe to the URL that you copied in the previous step as an iCalendar feed from your personal calendar application.

    Search within a community

    Search a community for a given keyword to return all of the community content that contains that keyword. This includes content from any applications that have been added to the community, for example, activities, blogs, events, and wikis.

    You must open a community before you can search the content within that community.

    To search the content of a community, complete the following steps.

    1. Click the Down arrow next to the search control and ensure that This Community is selected. This option is selected by default.

    2. Enter one or more keywords to search for in the text field.

    3. Click the search icon.


    Review search results

    Use the options available for filtering search results to find the information that interests you most.

    When you search the content within a community, the results are returned to you in a tabbed view, with each tab corresponding to an application in the community. The order of the tabs corresponds to the order in which the applications are displayed in the community. This means that if you have prioritized a certain application by placing it first on the community page, the search results for that application are also prioritized in the search results tabbed view.

    Review search results by doing the following.

    • Click the title of one of the results to open it and review it in more detail.

    • Click a tab to display the results from a specific application. For example, if your community has a blog and you're particularly interested in finding relevant blog entries, click Blog to display the results from the community blog.

    • Use the Sort by options to sort the results by relevance or date.

    Files

    Share and collaborate on files.

    Watch a video to learn more about Files.


    New to this release?

    Find out what features have been added since the last release.


    Get started

    What's new in Files?

    Find out what is new and what changed in Files.

    • Files now enables you to do the following actions:

      • Upload multiple files at the same time.

      • Download all of the files in a view.

      • Add files to a folder during upload.

      • Select and perform actions on multiple files at one time.

      • Delete a file version.

      • Share folders with communities.

      • Give community members access to edit files you own.

      • Move files uploaded to a community to trash; from trash you and others can restore or delete the files.

      • Stop sharing a file in one action, including removing the file from any shared folders and communities.

      • Stop sharing files that were shared with you. For example, if someone shared a file with you, and then you shared the file with a community, you can stop sharing with the community.

    • A file.s owners and editors can lock and unlock the file.

    • The file lock icon displays a red key in the owner.s view when the file is locked by another user. The file owner can unlock the file at any time.

    • A graphic Like option is now available on the file page; the Recommend file option has been changed to a Like file option.

    • For files that you are adding or have added to a folder, you can give access to those files to anyone who has access to the folder.

    • The files summary page and tabs have been redesigned to provide more information, such as in which folders the file resides and whether the file is referenced by status updates.

    • The Communities application contains an option for displaying files that are shared through the community.

    • Files that are referenced in one or more status updates are noted as such.

    What is Files?

    Files is a collaboration tool that enables you and others to easily upload, organize, and share files.

    Files provides a simple way to share files and ideas with people and communities, as well as a central storage place for your work. Files can be shared, tagged, organized in folders, and accessed from other applications, such as Activities.

    Uploading files

    Upload files from your computer by clicking Upload Files from the Files screen. See Uploading a file.

    Opening and editing a file

    Open a file for view or edit by opening its file page and clicking Download.

    Download a file to a device

    Download a file to disk by opening its file page and clicking Download. Click Save File > OK and specify the folder in which to save the file.

    Some file types can be viewed directly from within Files. See Viewing a file using the viewer.

    Sharing files

    Keep files private so that only you can read and work with them. Share files with specific people or communities, and optionally allow them to share the files with others. Or make files public so that anyone who can access IBM Connections can read them. See Sharing files.

    Find files

    Find files by looking through lists of files in different views. Sort views with columns. Filter views to narrow the lists by date, by how they are shared, or by access level. Search for files or find them using tags. Pin files you work with to quickly find them when you need them. Finally, organize files in folders to find them more easily. See Finding files.

    Following files

    Open a file and click Follow to receive notification when the file is edited or commented on. See Tracking file and folder changes.

    Access levels

    When you share your files with people, groups, or communities you can give them Reader or Editor access to the file. When you share your folders with people, groups, or communities you can give them Reader, Contributor, or Owner access to the folder.

    When you share your files with the public anyone can read them. See Using file sharing to collaborate with others.

    Recommending and commenting

    Recommend and comment on files. See Working with other people's files.

    Organizing files with tags

    Add descriptive tags to files to make them easier to find later. See Using file tags.

    Organizing files in folders

    Organize your files in folders. Like files, you can follow folders to receive notification when they are updated.

    Folders can be private, shared, or public. Keep folders private so that only you can work with them. Share folders with people, groups, or communities and choose their access. Or make folders public so that anyone can see them. See Creating folders.

    Versions

    When you add a file it becomes the first version of the file. A new version is generated if you restore a file from an older version, or upload a new version of the file. If you have access to read or edit a file, you can see its versions. If you are the owner of a file you can delete versions. See Using a file version.

    Trash

    Move files to the trash to remove them from Files. Files in trash are not yet permanently deleted. To find a files that you have moved to the trash click Trash in the navigation box. Other people cannot see or link files that are in your trash. See Removing files.

    Use file sharing to collaborate with others

    File sharing enables you to collaborate with others on specific files and groups of files.

    The Files application enables you and others to upload files for central storage and share files with those whom you designate. Sharing files enables you to collaborate with others. Controlling access to files enables you to be specific about who can see and act on files that you share and on files that are shared with you.

    File sharing is particularly useful during the project or design planning stage when it is critical that multiple team members be able to see and act on ideas in a way that all team members can see and respond to.

    Control elements include person and community-level access settings such as read and edit or read only. Files can optionally be grouped by folder, and folders can also be designated with specific access settings, including a contributor access level.

    If you have owner or editor access to a file you can download and make changes to the file and upload new versions of the file. If you have reader access to a file, you can download the file but not upload new versions of it to that file page.

    The following file tracking capabilities are available:

    • Versioning . Each time a new version of a file is uploaded, the version number increments.

    • Commenting . Commenting is available to all people who have access to the file.

    • Feed reader subscription and update notification . People receive notification when updates are made to a file that they own or that has been shared with them. People can optionally create a feed to receive update notification in their feed reader of choice.


    Related tasks

  • Sharing folders

    Understand file access rights

    File owners can keep their files private or share them with others.

    The person who uploads a file for the first time is its owner.

    If the owner does not share or make the file public, the file is private, and only the owner can read and edit it.

    Owners can share their files with people or communities. People can have Reader or Editor access to the file. Communities can also be granted Reader or Editor access.

    • Reader access: Readers can read, comment on, download, and recommend a file, be notified of changes to the file, and share the file. They can add a file to one of their folders, or to a folder to which they have Contributor access.

    • Editor access: Editors can read, edit, comment on, download, recommend, upload a new version of, and set properties on the file. They can be notified of changes to the file, and share it. Editors can also add a file to a folder of theirs, or to a folder to which they have Contributor access.

    Editors can lock a file. However, editors can only unlock a file they were the person who locked it. A file owner can unlock a file regardless of who locked it.

    Owners can also make a file public, meaning everyone who can access IBM Connections can read the file.

    In some file lists, private files are marked with a private icon, shared files are marked with a shared icon, and public files are marked with a public icon.

    If a file is both public and shared, it is marked with a public icon.

    Uploading and sharing files

    Upload one or more files from your device to Files.

    You can upload existing files to associate them with an activity or community or to simply store them centrally for your later reference or use. You can optionally tag and share files with others during or after upload.

    Your administrator limits the amount of space that you have for storing files. Stored files include all versions of uploaded files. If needed, you can delete old file versions to create additional storage space.

    The file size limit for uploading a single file is set by your administrator, the default is 500 MB.

    1. Click Upload Files.

    2. Click Browse, select one or more files, and click Open.

    3. Optional: Type tags, separated by a space.

    4. Select any of the following sharing choices:

      Option Description

      No one

      Make the files private. Only the owner can see and edit them.

      People or Communities

      Share the files with specific people or communities.

      1. Select a Person or a Community.

        Only communities in which you are an owner or a member are available.

      2. Select the as Reader or as Editor access level:

        • Readers can read, comment on, download, and recommend a file. They can add files to folders to which they have Contributor access, be notified of changes to the file, and share the file with other people.

        • Editors can read, edit, comment on, download, recommend, upload a new version, and set properties on the file. They can add files to folders to which they have Contributor access, be notified of changes to the file, and share it with other people.

      3. Perform one of the following tasks:

        • To share with a Person, start typing the name of the person, and then select the person name when it displays.

        • To share with people, click in the field to display the names of people you have recently shared files with. If the person you are looking for is displayed, select them. If they are not displayed, type a name or email address, and then select the person. If the name you want does not display, click Person not list? Use full search... to search for them.

        • To share with a Community, start typing the name of the community, and then select the community name when it displays.

          When you share a file with a public community the file becomes public.

      4. Add an optional message for people with whom you have shared the file. The message is included in the notification sent to people with whom you share the file.

      Public

      Make the files visible to everyone, even people who have not logged in. This setting provides Reader access.

      An administrator can require that everyone log in, or only a certain group of people can log in. In this case public files are only available to users who are able to log in.

      Allow others to share these files

      Allow those you have shared the file with to share it with others.

         

         

    5. Click Upload.

    Download a copy of a file

    You can download a local copy of a file from Files to a specified location on disk.

    You can download a local copy of an uploaded file from a Files view in which the file is visible to you. For example, you can download a file that you own or a file that has been shared with you and for which Reader or Editor access has been assigned.

    1. Locate the file you want to download from Files and click its name to open it.s file page.

      For example, find the file in Files using tags or display a view in which you know the file is visible, such as My Files or Shared with Me.

    2. Click Download.

    3. Click Save File > OK.

    4. Set the folder in which to save the file and click Save.

    Opening and viewing or editing a file

    Open an uploaded file to view or edit from Files.

    You can open an uploaded file to view or edit from a Files view in which the file is visible to you. For example, you can open and edit a file that you own or a file that has been shared with you and for which Editor access has been assigned.

    1. Locate the file you want to open in Files and click its name to open it.s file page.

      For example, find the file in Files using tags or display a view in which you know the file is visible, such as My Files or Shared with Me.

    2. Click Download.

    3. Click Open with and specify the application with which to open the file and click OK.

    Use a file version

    When you upload a file an initial version of that file is created. Your original work is saved in that first version until you delete it. When you or someone with Editor access uploads it again, a new version is created.

    To access versions of a file, open the file page and click the Versions tab. You can see information including the version number, when it was updated, the person who made the updates, and the version size.

    You can download versions of the file, and if you own the file or have Editor access, you can restore a previous version to make it the latest version. Only an owner or administrator can delete a version of the file. A new version is generated if you restore a file from an older version, or click Upload New Version to upload a new version of the file.

    When you restore an older version of the file, only the content of the file is restored. The title, tags, and other properties on a file page do not change.

    Versioning can be disabled the administrator. If versioning is disabled, the new edited and uploaded version overwrites the current version.

    Find files

    There are many ways to find files. You can sort, filter, switch between different presentations, and search using keywords or wildcards.

    Before you log in, you can search for public files, and read and download them. After you log in, you can search for, and potentially work on, files you have pinned, your own files, files shared with you, files shared by you, and community files to which you have access.

    You can control how files appear in your Files views, by clicking either of the two Display style icons or by clicking Customize and selecting the columns to display in your file lists.

    In some file lists, private files are marked with a private icon, shared files are marked with a shared icon, and public files are marked with a public icon. If a file is both public and shared with specific people, it is marked with a public icon.

    1. Do any one of the following to find files:

      Option Description

      To find files you pinned

      Click Pinned Files in the navigation box.

      To pin a file, click the thumbtack icon next to the file in a list, or open the file and click the pin icon.

      To find files you uploaded

      Click My Files in the navigation box.

      To find files people shared with you

      Click Shared With Me in the navigation box.

      These are files shared by other people specifically with you.

      Files shared with you might also be public.

      To find files you shared with people

      Click Shared By Me in the navigation box.

      These are files you shared with specific people.

      Files shared by you might also be public.

      To find community files you have access to see

      Click Community Files in the navigation box.

      To find public files

      Click Public Files in the navigation box.

      To search by string or using a wildcard character

      Select a files search category, such as My Files or Shared With Me. Type characters into the search field such as a file name, or a string containing the wildcard character *, and then click the search icon.

      See Advanced search options for more information.

    2. Do any of the following to further filter or access files:

      Option Description

      To show files by tag

      Expand the Tags or Public Tags section and click a tag in the tag cloud. Or type a tag into the field and click the search icon to return files with that tag.

      You can also open a file to which you have access and see the assigned tags.

      To show files by how they are shared

      You can limit the display of files in a view by how the files are shared.

      1. Click Pinned Files or My Files.

      2. Expand the Sharing section.

      3. Click any of the following links to filter file display:

        • with everyone (public)

        • with one or more people

        • with no one (private)

      1. Click Shared With Me or Shared By Me.

      2. Expand the Sharing section.

      3. Click and public or and not public. Or find a specific person by typing their name in the search field.

      To show files by date

      Expand the Date Updated section and click any of the following links:

      • Today

      • Last 7 days

      • Last 30 days

      • Last 365 days

      Expand the date section. It could be any of the following, depending on the file list you are viewing:

      • The Date Updated section is in the Pinned Files and My Files lists.

      • The Date Shared section is in the Shared With Me and Shared By Me lists.

      • The Date Created section is in the Public Files list.

      File dates also appear in the various file list views.

      To show other people's files you can edit

      In the Shared With Me view, expand the Role section, and then click editor.

      To show your files other people can edit

      In the Shared By Me view, expand the Role section, and then click editor.

      To add columns to a view

      In any folder view, click Customize. Select data to display in columns in the view, and then click Show.

      To download all the files in a view

      Click Download All Files to download a compressed file containing all of the files in the view, including files not on the current page. The compressed file can be a maximum of 4GB.

      If any of the file names you are downloading to the compressed file contain non-English characters, you can use the Global (default) setting. This setting informs the compression program to use UTF-8 characters so that all file name characters can be properly processed during compression. If the file names inside the compressed file are not displayed correctly after choosing the Global (default) setting, click Global (default), specify a language value when prompted, and reprocess the download.

      If you perform multiple compressed file downloads, the first is named files.zip. Subsequent downloads are named the same but with numbers appended, such as files(1).zip, files(2).zip. You can rename the compressed files later.

      To receive feed notifications when changes are made to a view

      Click Feed for These Files and create a feed reader subscription as prompted.

    Work with other people's files

    What you can do with your or other people's files depends on the access that has been given to those files.

    When a file is public anyone can read and download it, even people who have not logged in. After they log in, people can also share the file, add it to a folder, comment on it, and get an email when someone edits it or comments on it.

    An administrator can configure your account so that everyone must log in, or only a certain group of people can log in. In this case public files are only available to users who are able to log in.

    When someone shares a file with you, they can give you Reader or Editor access:

    • Reader access: Readers can read, comment on, download, and recommend a file, be notified of changes to the file, and share the file. They can add a file to one of their folders, or to a folder to which they have Contributor access.

    • Editor access: Editors can read, edit, comment on, download, recommend, upload a new version of, and set properties on the file. They can be notified of changes to the file, and share it. Editors can also add a file to a folder of theirs, or to a folder to which they have Contributor access.

    File owners can choose to allow other people to share files.

    To see what access you and others have to a file, open its file page and click Sharing.

    Open the file page and perform one or more of the following file actions.

    Option Description

    To recommend files

    In any list of files, find a file and click the Like option or icon for that file to recommend the file. You can also click the Like option or icon on an individual file page.

    To comment on files

    Open the file page, click the Comments tab, and then click Add a comment. Type your comment, and then click Save.

    To download files

    • To download a file open the file page and click Download.

    • To download one or more files, open a files or folder view, check the box next to the files you want to download, and click Download.

    • To download all of the files in the view, click Download All Files to download a compressed file containing all the files, including files not on the current page, in the folder. The compressed file can be a maximum of 4GB

    If any of the file names you are downloading to the compressed file contain non-English characters, you can use the Global (default) setting. This setting informs the compression program to use UTF-8 characters so that all file name characters can be properly processed during compression. If the file names inside the compressed file are not displayed correctly after choosing the Global (default) setting, click Global (default), specify a language value when prompted, and reprocess the download.

    If you perform multiple compressed file downloads of selected files, the first is named files.zip. Subsequent downloads are named the same but with numbers appended, such as files(1).zip, files(2).zip. You can rename the compressed files later.

    To edit file properties

    Open the file page, and then click More Actions > Edit Properties. Change the file name, description or file extension and then click Save. You must be an owner or have Editor access to edit the properties of someone's file.

    To add files to a folder

    Open the file page, and then click Add to Folders. Select a folder, and then click Add to Folders. Alternatively you can open the folder page, click Add Files and select previously uploaded files.

    To lock or unlock a file

    Open the file page, and then click More Actions > Lock File or More Actions > Unlock File.

    An editor can lock a file, but can only unlock a file that they have locked. An editor cannot unlock a file that another user has locked unless they are also the file owner.

    Sharing files

    Share your files with people and communities or make them visible to everyone in your organization.

    You can give people Reader or Editor access. You can also make the file available to the public.

    • Reader access: Readers can read, comment on, download, and recommend a file. Readers can also add files to folders to which they have Contributor access, be notified of changes to files, and share files with other people.

    • Editor access: Editors can read, edit, comment on, download, recommend, upload a new version, and set properties on the file. Editors can also add files to folders to which they have Contributor access, be notified of changes to the file, and share it with other people.

    People and communities with whom you share files can be notified by email, or in their Updates tab, depending on how they have specified their notification settings. See Set email notification preferences.

    You can also share files that have been shared with you if the owner allows it. Only owners can make a file available to all users in the company.

    You can click the Sharing tab on a file page to display how the file is shared.

    Share a file as follows.

    Option Description

    To share a file when you upload it

    1. Click Upload Files.

    2. Set the file path or browse for the file.

    3. Type a file name.

    4. Optional: Type tags, separated by a space or comma.

    5. Select People or Communities.

    6. Select a Person or a Community.

    7. Select as Reader or as Editor to assign access.

    8. Perform one of the following tasks:

      • To share with people, click in the field to display the names of people you have recently shared files with. If the person you are looking for is displayed, select them. If they are not displayed, type a name or email address, and then select the person. If the name you want does not display, click Person not listed? Use full search... to search for them.

      • To share with a community, start typing the name of the community, and then select the community name when it displays.

      When you share a file with a public community the file becomes public.

    9. Optional: Uncheck Allow others to share files to prevent people you share the file with from sharing with new people.

    10. Add an optional message for people with whom you have shared the file.

    11. Click Upload.

    To make a file public when you upload it

    1. Click Upload Files.

    2. Set the file path or browse for the file.

    3. Type a file name.

    4. Optional: Type tags, separated by a space or comma.

    5. Select Public.

    6. Optional: Uncheck Allow others to share this file to prevent people you share the file with from sharing with new people.

    7. Click Upload.

    To share a file that is already uploaded

    1. Open the file page.

    2. Click Share.

    3. Select a Person or a Community.

    4. Select as Reader or as Editor to assign access.

    5. Perform one of the following tasks:

      • To share with people, click in the field to display the names of people you have recently shared files with. If the person you are looking for is displayed, select them. If they are not displayed, type a name or email address, and then select the person. If the name you want does not display, click Person not listed? Use full search... to search for them.

      • To share with a communities, start typing the name of the community, and then select the community when it displays.

        When you share a file with a public community the file becomes public.

    6. Optional: Add an optional message for people with whom you have shared the file.

    7. Click Share.

    You can also click the Sharing tab to access additional file sharing options.

    To make a file public after you upload it

    1. Open the file page.

    2. Click Share.

    3. Select Public.

    4. Click Share.

    To copy a file to a community

    Instead of sharing, you can copy the latest version of a file to a community. Only an owner can copy a file to a community.

    1. Open the file page.

    2. Click More Actions > Give Copy to Community.

    3. Start typing the name of the community, and then select the community when it displays.

    4. Optionally change the file name.

    5. Optionally tag the file.

    6. Click Copy.

    To make a public file non-public

    1. Open the file page.

    2. Click the Sharing tab.

    3. Click the x next to Everyone and click OK.

    This only makes the file non-public. People you have shared the file with can still see and work with it.

    To make a shared file private

    1. Open the file page.

    2. Click the Sharing tab.

    3. Click the Stop sharing this file link.

    4. Click OK.

    This makes you the only person who can see or work with the file.

    To demote someone's access to a shared file

    1. Open the file page.

    2. Click the Sharing tab.

    3. Click the x next to a person or community.

    4. Select a new access level and then click OK.

    To stop sharing files

    1. Open the file page.

    2. Click the Sharing tab.

    3. Click Stop sharing this file, and then click OK.

    To see how a file has been shared

    1. Open the file page.

    2. Click the Sharing tab to view sharing information.

    3. If available, click See who has shared for further details.

    If a file hs been made available as an attachment to a status update, the .This file is associated with one or more status updates. message displays.

    Create folders

    Folders enable you to group files together in a meaningful way. Folders can be designated as private, shared, or available to everyone.

    You can create a folder to enable files to be grouped together. You can also enable one of three types of sharing capabilities to allow others to collaborate on files within the folder.

    • Files in private folders can only be read and worked with by their owner. If you make a private folder public, files that are not assigned to be public are removed from the folder.

    • Files in folders that you have shared with people or communities can be read and worked with by people and communities with whom the folder has been shared. People and communities can have Reader, Contributor or Owner access to a folder. Readers can read files in the folder. Contributors can add files to the folder, delete files they have added, and see information about files in the folder. Owners have ownership of the folder along with the original owner. They can share the folder with other people, and delete any file. When you share a folder with people and communities, they can see the files in that folder. But they cannot see those same files anywhere else unless you explicitly share the files with them. For example, if you add a file to a folder and share the folder with Cathy but have not shared the file with Cathy, she can see and open the file in the folder, but cannot see it in any other list. When you share a folder with people or change their role, those people are notified.

    • Files in public folders can be read by anyone, but only the owner and those who have been made Contributor or Owner can add files to them.

    1. Click New Folder.

    2. Type a name for the folder.

    3. Optional: Type a description.

    4. Select any of the following options:

      • Select No one to make the folder private. Only the owner can see and edit it.

      • Select People, Groups, or Communities to share the file with specific people. Perform these steps:

        1. Select a Person, a Group, or a Community.

        2. Assign an access level of Owner, Contributor, or Reader.

        3. Start typing a name or email address, then select that name or address when it displays.

      • Select Public to make the file visible to everyone, even people who have not logged in.

        An administrator can configure the system so that everyone must log in, or only a certain group of people can log in. In this case public files are only available to users who are able to log in.

    5. Click Everyone can contribute to this folder to make the folder public and allow all logged-in users to contribute to the folder.

    6. Click Save to create the folder.

    Add files to folders

    Folders contain and organize files. Add files to folders that you have Contributor or Owner access to.

    You can open a folder and add files, open a file and add it to a folder, or drag and drop files into folders.

    You cannot add other peoples' private or shared files to public folders.

    To remove files from folders, open the file, click the Folders tab, click the X next to the folder you want to remove the file from, and then click OK.

    1. Follow these steps to open a folder and add files:

      1. Open the folder.

      2. Click Add Files.

      3. Find files in any of the following ways:

        Choice Description

        Browse files on my computer

        Upload files from your computer to the folder.

        Uploading a file to a public folder makes the file public.

        Uploading a file to a shared folder means the file is shared with whoever the folder is shared with.

        Recent Files

        Select files that were recently uploaded or recently shared with you.

        To search across all files, type characters in the search field and click the search icon. All files include your files, files available to everyone, and files shared with you.

        Pinned Files

        Select from a list of your pinned files.

        My Files

        Select files you uploaded.

        To search across your files, type characters in the search field and click the search icon.

        Shared With Me

        Select files people have shared with you.

        To search across files shared with you, type characters in the search field and click the search icon.

        Other People's Files

        Select files that have been shared with you, a community to which you belong, or publicly.

        Start typing a name or email address in the search field and then select it. If the name or address does not display, click the search icon.

        My Folders

        Select files from your folders. Expand My Folders, click a folder, and then select files from that folder.

        To search across all files, type characters in the search field and click the search icon. All files include your files, public files, and files shared with you.

        Shared Folders

        Select files from folders shared with you. Expand Shared Folders, click a folder, and then select files from that folder.

        To search across all files, type characters in the search field and click the search icon. All files include your files, public files, and files shared with you.

      4. Click Add Files.

      5. Optionally check the box to allow members of the folder to edit any files you own.

    2. Follow these steps to open a file and add it to a folder:

      1. Open the file.

      2. Click Add to Folders.

      3. Find folders in any of the following ways:

        Choice Description

        Recent Folders

        Below Folders I Recently Added To, select folders that you recently added files to.

        Below Recently Updated Folders, select folders you recently created, folders other people recently shared with you, and folders other people recently added files to.

        To search across all of these folders, type characters in the search field and click the search icon.

        My Folders

        Select folders you created.

        To search across all of these folders, type characters in the search field and click the search icon.

        Folders Shared With Me

        Select folders people have shared with you.

        To search across all of these folders, type characters in the search field and click the search icon.

        Public Folders

        Select public folders.

        To search across all of these folders, type characters in the search field and click the search icon.

      4. Click Add to Folders.

    3. Follow these steps to add previously uploaded files to folders:

      • Open a folder, click Add Files, select the files to add to the folder, and lick Add Files.

      • Open a file, click Add to Folders, select the folders to add the file to, and click Add to Folders.

    Find folders

    There are many different ways to see lists of folders. You can sort, filter, switch between different presentations, and search for specific keywords.

    Before you log in, you can see public folders. After you log in, you can find pinned folders, your own folders, folders shared with you, and public folders. To log in, click Log in and start sharing!.

    In some folder lists, private folders are marked with a private icon, shared folders are marked with a shared icon, and public folders are marked with a public icon. If a folder is both public and shared with specific people, it is marked with a public icon. If you hover over the icon, help text explains that the folder is public and shared.

    1. Do any one of the following to find folders:

      Option Description

      To find folders you pinned

      Click Pinned Folders in the navigation box.

      To pin a folder, click the thumbtack icon next to the folder.

      To find folders you created

      Click My Folders in the navigation box.

      To find folders people shared with you

      Click Folders Shared With Me in the navigation box.

      These are folders shared by other people specifically with you.

      To find public folders

      Click Public Folders in the navigation box.

      To search by string or using a wildcard character

      Select a folder search category, such as My Folders or Folders Shared With Me. Type characters into the search field such as a folder name, or a string containing the wildcard character *, and then click the search icon.

      Folders matching those characters are returned.

      See Advanced search options for more information

      When searching for a folder by name,  if using 3 or more characters as search string criteria, all folder names that contain the criteria are returned. However, if using 2 or less characters as search string criteria, only folder names that exactly match the search string are returned. To return folder names that contain the search string criteria, regardless of number of characters in the string, append the asterisk (*) wildcard character after the search string criteria.

    2. Do any of the following to further filter or access folders:

      Option Description

      To show folders created by a specific person

      Expand the Created by filter and start typing a name. Click the name when it displays, or click the search icon. This is not available in My Folders.

      To show folders by how they are shared

      Expand the Sharing filter in either the My Folders or Folders Shared With Me lists.

         

      To show folders you have contributor or owner access to

      Expand the Role filter, and then click contributor or owner.

      To download all the files in a folder

      Click Download This folder to download a compressed file containing all of the files in the folder, including files not on the current page. The compressed file can be a maximum of 4GB.

      If any of the file names you are downloading to the compressed file contain non-English characters, you can use the Global (default) setting. This setting informs the compression program to use UTF-8 characters so that all file name characters can be properly processed during compression. If the file names inside the compressed file are not displayed correctly after choosing the Global (default) setting, click Global (default), specify a language value when prompted, and reprocess the download.

      To receive notifications when changes are made to a folder

      Click Feed for This folder and create a feed reader subscription as prompted.

    Sharing folders

    Share your folders with people and communities or make them available to others.

    You can give people and communities Reader, Contributor, or Owner access.

    • Reader access: Readers can read files in the folder.

    • Contributor access: Contributors can add files to the folder, remove files from folder they have added to folder, and see information about files in the folder.

    • Owner access: Owners have ownership of the folder along with the original owner. They can share the folder with other people, and remove any files from folder. The owner of a file can move it to trash, or remove it from a folder.

    People and communities with whom you share folders can be notified in the Updates tab in their home page, and by email if they specified that in their notification preferences. See Set email notification preferences.

    To see who has access to your folders, open the folder page and click the Sharing tab.


    Option Description

    To share a folder when you create it

    1. Click New Folder.

    2. Type a name.

    3. Type a description.

    4. Do one of the following:

      • Select People or Communities to share with specific people and groups. Select a Person or a Community, and select an access level. Then start typing a name or email address and select that name or address when it displays. You only see the people and groups available in your enterprise directory.

      • Select Public to give everyone Reader access. Select Everyone can contribute to this folder to give everyone Contributor access. When you make a folder public, non-public files are removed from the folder.

    5. Click Save.

    You cannot share a private folder with a public community.

    To share a folder after you create it

    1. Open the folder.

    2. Click Share.

    3. Do one of the following:

      • Select People or Communities to share with specific people and groups. Select a Person or a Community, and then select an access level (described in this topic). Then start typing a name or email address and select that name or address when it displays. You only see the people and groups available in your enterprise directory.

      • Select Public to give everyone Reader access. Select Everyone can contribute to this folder to give everyone Contributor access. When you make a folder public, non-public files are removed from the folder.

    4. Click Share.

    You cannot share a private folder with a public community.

    To make a public folder non-public

    1. Open the folder page.

    2. Click the Sharing tab.

    3. Click the X next to Everyone.

    This only makes the folder non-public. People, groups, and communities you have specifically shared the folder with can still see and work with it.

    To make a shared folder private

    1. Open the folder page.

    2. Click the Sharing tab.

    3. Click the Stop sharing link.

    4. Click OK.

    This makes you the only person who can see or work with the folder.

    To demote someone's access to a shared folder

    1. Open the folder page.

    2. Click the Sharing tab.

    3. Click the X next to a person, group, or community.

    4. Select a new access level and then click OK.


    Related

  • Use file sharing to collaborate with others

    Tracking file and folder changes

    You can request notification when changes are made to a file, folder, or view.

    When you follow a file or folder, notifications are sent to your home page when the file or folder is updated.

    You can also choose to receive updates by email in your email settings. If you choose to receive email from Files, you are emailed with a Subscribe to this file link when someone shares a file with you. Also, you are emailed about any comments on, or changes to, a file after you download it, but this can be disabled by your administrator. See Set email notification preferences.

    Folders, files, and file lists provide feed links. You can subscribe to these feeds to receive update notifications in your feed reader. See Subscribing to a feed.

    When you subscribe to a feed you receive an Atom feed, so you must have a feed reader on your computer that supports Atom feeds. When the list changes, your feed is updated.

    Perform any of these tasks to track file and folder changes:


    Option Description

    To be notified when a file is added to a folder

    Open a folder and click Follow.

    By default this is selected for folders that you own and deselected for public folders and folders you are a member of.

    To be notified when a file is edited or commented on

    Open the file page and click More Actions > Follow.

    By default this is selected for files that you own and deselected for public files and files shared with you.

    To subscribe to a list feed

    You can subscribe to a file list or a folder.

    Open the view list and click the feed link, for example Feed for These Folders.

    When you pin a folder, you get email notifications when there are changes to the folder.

    To subscribe to a single file feed (comments or versions)

    Open the file page.

    To subscribe to comment updates, click the Comments tag and then click Feed for These Comments.

    To subscribe to version updates, click the Versions tag and then click Feed for These Versions.

    To view information about a file

    Open the file page and click the About this File tab. You can see when the files was added and last updated; how large it is; and how many times a file has been recommended and downloaded, and how many of those downloads were anonymous users. You can also see which users downloaded the file.

    To learn about versions that have been uploaded, click the Versions tab.

    To learn about comments that have been posted, click the Comments tab.

    To learn about how the file is shared, click the Sharing tab.

    To learn which folders contain links to the file, click the Folders tab.

    Use file tags

    Use file tags to assign keywords that you and others can use to find or group files.

    You can tag files you own or to which you have been given Editor access.

    You can search for files by tag by selecting one or more tag names from a list of by typing a tag name.

    • Tag a single file

      Follow these steps to add a tag to a file:

      1. Open the file page.

      2. Click Add Tags.

      3. Type tags, separated by a single space or a comma.

        The comma is converted to a space.

      4. Click Save.

    • Tag multiple files

      Follow these steps to tag multiple files at once:

      1. Open the My Files or Shared By Me view.

      2. Check the boxes next to files.

      3. Click Add Tags.

      4. Type tags, separated by a single space or a comma.

        The comma is converted to a space.

      5. Click OK.

    • Search for files by tag name

      Follow these steps to find files using tags:

      1. Open any folder or list of files.

      2. In the Tags or Public tags filter, click a tag in the tag cloud or click Find a Tag, type the tag name and click the search icon.

    Locking files

    Lock files to prevent people from editing them.

    The Owners and Editors of files can lock and unlock those files. For example, if you upload a file you are the owner and can lock and unlock that file. If you give a person Editor access to the file, they can also lock and unlock it. When you lock a file, people can still download and read it, but only you can upload new versions of it.

    When a file is locked it cannot be edited, but it can still be moved to the trash and deleted, and commented on and recommended.

    1. Open the file page.

    2. Click More Actions > Lock File.

    3. To unlock the file, click More Actions > Unlock File

    Remove files

    Move your files to trash to remove them from Files. You can then either restore or permanently delete your files from trash.

    Move a file to the trash hides it from all folders and it no longer appears in searches. When you move a file to trash, all of the file's versions, recommendations, and comments move to trash, and the file is hidden from people with whom you have shared it.

    If a file is restored from the trash, it is added back to the folders it was previously in, and all data is restored. When you restore a file from trash, all versions, recommendations, and comments are restored, and people with whom you have shared the file can see it again.

    Administrators can see and work with files in your trash.

    Files in trash count toward your file size quota. When you reach your quota limit you can delete files in trash to create space to upload more files.

    You can move one or more files to Trash and then either restore or delete them.

    1. Open a file page.

    2. Click More Actions > Move to Trash, and then click OK.

      To move multiple files to trash, open a view (such as My Files), check the boxes next to files to move and then click Move to Trash and then click OK. You can only move files you own to the trash.

    3. Optional: To restore or delete files in trash, click Trash in the navigation box and then do one of the following actions:

      • To restore a file, click the arrow icon next to the file name and select Restore.

      • To permanently delete the file, click the arrow icon next to he file name and select Delete.

    4. Optional: To permanently delete all files in the trash, click Empty Trash.

    Subscribe to a Files feed

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Forums

    Share information, brainstorm ideas, and discuss topics of common interest.


    New to Forums?

    Watch a video to learn more about Forums.


    New to this release?

    Find out what features have been added since the last release.


    Use Forums

    Click topics in the table of contents to get help with other tasks.

    What are Forums?

    A forum is an online discussion board where people can ask questions, share their experiences, and discuss topics of common interest.

    Use the Forums application to start discussions about a specific topic or debate solutions to shared problems. By participating in a forum, you can exchange ideas, ask questions, and leverage the expertise of other people in your organization.

    To join in a Forums discussion by starting or responding to Forums topics, you must first be enabled to use mail-in capabilities.

    Forums can be stand-alone or they can be associated with a community. Anyone can post a topic or respond to a topic in a stand-alone forum, but you must be a community member to participate in a community forum.

    When you are logged in and you open the Forums application, you are automatically brought to the My Forums page. This page is empty at first but, as you start to participate in forums, you can use the page to stay up-to-date with the forums that you own, the community forums that you belong to, and the forums that you are following.

    If you are new to Forums, use the Public Forums page as your entry point to participating in forums. If you cannot find an ongoing discussion that targets your focus area, why not start your own forum? Forums are an excellent way to create social connections and a sense of community, and can help you to cultivate an interest group about a particular subject.

    What's new in Forums?

    This release contains features designed to make forums easier for you to use to share information and collaborate with others.

    The following feature is new for Forums in IBM Connections 4.

    • When a user is notified by email that someone has added a topic to a forum, the user can click a Reply to this topic link in the email. This creates a response email the user can add content to and send. This create a new forum topic as a response to the topic they were notified about in the email. Attachments in the email are added to the response topic.

    • You can add content from any web page or IBM Connections source to a forum topic by clicking a button in your browser tool bar. Click Bookmark or Discuss This, and then follow the steps for installing the Discuss This button. Then navigate to any web or IBM Connections page, click Discuss This, and select a forum to post the content to.

    Browsing forums

    Browse the forums in your organization when you want to look for answers to common problems or share your opinions with others. Forums are a useful place to brainstorm and collect feedback about different subjects. The Public Forums page displays all the public forums in your organization, including any public community forums. Browse the list of forums to find one that interests you. The Topics/Messages column allows you to see how many topics and messages a forum contains, and gives you an idea of how popular or active the forum is. You can also see who last updated the forum.

    View forums and forum topics by doing the following.

    1. Open the Public Forums page to see a list of the public forums in your organization.

    2. When you see a forum that interests you, click the forum title to open the forum. A list of the topics in the forum displays. You can see how many replies each topic has, and who last updated the topic. You can also see who owns the forum in the Owner area of the page.

    3. Click a topic title to open the topic. A threaded view of the topic displays, showing the original topic and any responses to it.


    What to do next

    When navigating long discussion threads, click the user name under a response title to display the post to which the user is responding. This can be the original topic or a topic reply. Clicking the user name automatically scrolls you up to the post to which the user is responding, making it easy for you to see which response corresponds to which forum entry.

    When you start to create and follow forums, you can use the My Forums page to keep track of the forums that you are involved in. Use the options available in the navigation bar to display the forums that you are following, the community forums that you are a member of, or the forums that you own.

    Create forums

    Start a new forum when you want to get the answer to a specific question or get a discussion going about a particular topic. Anyone can create a forum, but you must be logged in to do so.

    Forums created in the Forums application are public by default. Any user in your organization with access to the Forums application can view and contribute to public forums. To create a forum with restricted access, create the forum inside a community with restricted access. For more information, see Add forums to a community.

    When you create a forum, you automatically become the owner of that forum. You also become the forum moderator, if content moderation is enabled in your deployment. Forums are an effective way to get a discussion going among a group of people who share a particular area of interest or expertise. Forums can be stand-alone or they can be associated with a community. To create a stand-alone forum, add it from the Forums application. Community forums must be added by community owners from the Communities application. For information about how to create a community forum, see Add forums to a community. After they are created, stand-alone forums cannot be converted into community forums, and community forums cannot be converted into stand-alone forums.

    Before you create a forum, it's a good idea to browse the existing forums in your organization first. You might find that someone has already asked the question to post, or there might already be a discussion underway about the topic that interests you. Use the Public Forums page that lists the forums in your organization.

    To create a stand-alone forum, complete the following steps.

    1. From the Public Forums page, click Start a Forum. You can also create a forum from the Forums tab on the My Forums page.

    2. Required: Enter a name for the forum in the Name field.

    3. To categorize the forum and make it easier to find, enter one or more tags in the Tags field.

    4. Enter a description for the forum in the Description field, and then click Save.


    What to do next

    Click Start a Topic to start adding topics to your new forum. If you do not want to create topics now, you can access the forum later from the My Forums page.

    Add forum topics

    Start a discussion with the people in your organization by creating a forum topic. Anyone who can access Forums can view the new topic.

    To add a topic to a forum.

    1. From the My Forums or Public Forums page, open the forum to which you want to add the topic.

    2. Click Start a Topic.

    3. Enter the title of the discussion topic in the Title field.

    4. To flag your topic as a question, select Mark this topic as a question.

    5. To tag the topic, enter one or more tags in the Tags field. Tags are keywords that you define to help users identify what a topic is all about. Tags must be a single word or multiple words connected with underscores or hyphens.

    6. Enter your topic content in the rich text field provided. Be as descriptive as possible. Remember to start a discussion, so include relevant information to interest other people and get them involved.

    7. To attach a file to your message, click Attach a File, click Browse to select the location of the file, and then click OK.

    8. Click Save to save your topic.


    Results

    If forum topics are moderated in your deployment, the topic does not display immediately. The forum moderator must approve the topic content first. If content moderation is not enabled, the topic displays immediately.

    Making web pages into forum topics

    You can install a browser toolbar button that creates a forum topic from whatever web page you are currently viewing.

    1. Open the Forums application and click the Bookmark or Discuss This link at the bottom of the page.

      You can also add an Add Bookmark browser button, which will allow you to add a bookmark to the web page. For more information on the Add Bookmark button, see the Bookmarks help.

    2. Follow the instructions for installing the Discuss This button.

    3. Visit a web page to post as a forum topic, and click the Discuss This toolbar button.

    4. Find a forum to add the web page to, and make any edits you want:

      1. In the Forums field, narrow the scope to public forums, or forums you own, are a member of, or are following.

      2. In the Forum name field, start typing a name to find the forum you want.

      3. Edit the title of the new topic, add any comments, and edit the content if you want.

      4. Select Pin this to pin the topic so it displays at the top of the list of topics in the forum.

    5. Click Save.


    Results

    The new topic is posted to the forum you selected.


    What to do next

    If you see a Discuss This link in forum topics (as opposed to the Bookmark or Discuss This link at the bottom of the page), that allows you to post the current topic as a new topic in a different forum.

    Responding to forum topics

    Join in a discussion by responding to forum topics that interest you.

    Anyone can respond to a topic in a stand-alone forum, you just need to have access to the Forums application. You must be a community member, and be enabled for mail-in capabilities, to respond to a topic in a community forum. If forum topics are moderated, your response does not display immediately. The forum moderator must approve its content first. If content moderation is not enabled, then the topic response displays immediately.

    In addition to responding to forum topics from the Forums user interface, when you receive an email notification about a new or updated forum topic, you can also reply to the topic directly from the mail. Additional considerations when responding to a forum topic include the following:

    • You can add attachments to response. Attachments must all comply with existing file upload constraints, such as file size and file extension. Embedded images in your reply are processed as attachments.

    • When you reply to an email notification, all previous content is included as part of the reply. To truncate the previous content , manually add #end where you want to end the reply history to end. Content that appears after the #end entry is ignored.

    • You can reply more than once to an email notification.

    • To reply to emails, certain settings must be selected. Click Sets, and then click the Email Preferences tab. Make sure Receive notifications from other people by email and Allow me to reply to notifications by email are selected. In the Content that I am following section, make sure Forums is set to Individual Emails.

    To respond to a forum topic.

    1. Open the topic to which you want to respond. The original topic displays, with a list of the responses to it.

    2. Click Reply under the section of the thread to which you want to respond.

    3. Optional: To change the title of your response, click Edit Title and enter a title in the field provided.

    4. Enter your response in the rich text field provided.

    5. To attach a file to your response, click Attach a File and browse for a file.

    6. Click Save to save your reply.

    Work with forum topics

    You can edit, move, and delete forum topics, and mark topic content as inappropriate.

    The actions that you can perform on a stand-alone forum topic depend on your role in the forum and whether you created the topic. The Forums administrator has access to work with all content in the Forums application. Only forum owners and topic authors can edit, move, and delete forum topics. Anyone with access to a forum can mark content in that forum as inappropriate.

    In a community forum, any member of the community can reply to a forum topic or flag a forum topic as inappropriate. Only topic authors and community owners can edit, move, and delete community forum topics and topic responses.


    Edit forum topics

    Edit a topic to make changes to it after you have added it to a forum. For example, you might want to update the title of the topic or attach a file to the topic.

    To edit a topic in a stand-alone forum, you must be the Forums administrator, the owner of the forum containing the topic, or the person who created the topic. To edit a community forum topic, you must be the Forums administrator, the topic author, or a community owner. Edit a forum topic does not affect the content of the responses posted in reply to the topic.

    To edit a forum topic.

    1. Open the forum containing the topic to edit, and then open the relevant topic.

    2. Click Edit under the topic entry.

    3. Edit the topic as required and click Save to save your changes.


    Results

    If content moderation is not enabled, your topic is updated immediately.

    If forum topics are moderated in your deployment, any edits that you make to your topic must be approved by a moderator before the updated topic can be displayed. While your changes are awaiting approval, the topic is temporarily hidden. The topic displays again after the forum moderator has approved your changes.


    Move forum topics

    After adding a discussion topic, you can move it to a different forum if you think it would fit more appropriately into that forum. When you move a discussion topic from one forum to another forum, any responses to the topic are also moved to the new forum.

    • To move a topic in a stand-alone forum, you must be the forum owner. You must also own the forum to which you are planning to move the topic.

    • To move a topic in a community forum, you must be a community owner. You can only move the topic to a forum that is in the same community.

    To move a forum topic.

    1. Open the forum topic to move and click Move.

    2. Select the forum to move the topic to, and then click Move again.


    Results

    The breadcrumb trail updates to display the forum that you selected in step 2.


    Delete forum topics

    Ensure that the content of your forum is meaningful and useful by deleting topics that are irrelevant or that contain inappropriate content.

    The owner of a stand-alone forum can delete any topic in that forum. Other users can only delete topics that they have created themselves and only when these topics do not have responses. The Forums administrator can delete any topic in any forum.

    Community owners can delete any topic in a community forum. Community members can only delete topics that they created themselves, and only when those topics do not have responses from other members. Delete a topic removes the topic from the forum completely, including any replies to that topic.

    To delete a forum topic.

    1. Open the topic to delete.

    2. Click Delete under the topic.

    3. Click Delete again to confirm that you want to delete the topic.


    Delete responses to forum topics

    If you change your mind about a response that you've posted to a forum topic, you can delete it from the discussion thread.

    Anyone who has posted a response to a topic in a stand-alone forum can delete that response. Forum owners can delete any topic response in the forums that they own, and the Forums administrator can delete any topic response in any forum.

    To delete a response to a community forum topic, you must be the community owner or the person who added the response. Delete the response to a discussion topic deletes the content of the response only. A placeholder for the entry is still visible in the forum, but the entry is marked as deleted.

    When deleting a topic response, you have the option of entering a reason for deleting the topic. This reason is displayed in the entry placeholder when the response is deleted.

    To delete a response to a discussion topic, complete the following steps.

    1. Open the topic thread containing the response that you want to delete.

    2. Click Delete under your response.

    3. Optional: Enter a reason for deleting the response. This reason is displayed in the entry placeholder when the response is deleted.

    4. Click Delete.


    Flagging forum content as inappropriate

    If you notice that a forum contains content that might be considered inappropriate, you can flag the content to alert the forum moderator. Any Forums user can flag forum content as inappropriate.

    You must be logged in to the Forums application to flag forum content as inappropriate. When you flag forum content as inappropriate, the forum owner or a designated moderator can review the flagged content and the reason given for flagging it, and then determine whether the content should be removed or the flag should be dismissed.

    The standards that determine whether forum content is inappropriate depend on your organization's corporate guidelines. Corporate guidelines typically discourage profanities and personal attacks, and additional rules might also apply. For example, information related to product development might not be suitable for discussion in a public forum. If you are not clear about the guidelines that apply to forums in your organization, ask your Forums administrator.

    To flag a forum entry as inappropriate, complete the following steps.

    1. Open the forum containing the content to flag.

    2. Navigate to the content to flag and click Flag as Inappropriate. You can flag a forum topic or a response to a forum topic.

    3. Select a category for the issue that you are reporting.

      This option only displays if the IBM Connections administrator has set up a list to categorize issues that are of concern to your organization. For example, possible categories might include Inappropriate business content or Security risk.

    4. Enter your reason for flagging the content in the field provided, and then click Flag.


    Results

    The Forums administrator or a designated moderator is notified that the forum post has been flagged so that they can review its content and take appropriate action.

    Posting questions and answers to a forum

    When you need a solution for a specific problem, posting a question to a forum can be a useful way to find help. Forum members can suggest answers, which you can accept or reject.

    Posting questions and answers to a forum is also a great way to share the answers to common questions that you know forum users might have. Formatting information in a question-and-answer format provides a way to share basic information in an easy-to-read layout.

    Question topics that have not been answered are displayed on the Open Questions tab on the My Forums page, making it easy for you to see which questions require attention. You can view resolved questions using the Answered Questions tab.


    Posting questions to a forum

    Posting a question to a forum is a great way to get an answer from the experts.

    Anyone can post a question to a stand-alone forum. To post a question to a community forum, you must be a community member. If you want to know the answer to a specific question, why not post the question to a relevant forum? As the topic creator, you can moderate the answers that people provide, and choose whether to accept or reject them.

    Use a question-and-answer format is also a useful way to make information available to forum members in an easy-to-read layout. By creating question-and-answer threads, forum members can build up a useful repository of information for users who are new to a subject and share the same questions.

    When posting a question to a forum, all you need to do is create a regular topic, but you need to be sure to mark the topic as a question. When you mark a topic as a question, the topic is marked with a question mark icon in the user interface, making it easy for forum users to identify which topics in the forum are questions.

    To post a question to a forum, complete the following steps.

    1. Open the forum where you want to post your question.

    2. Click Start a Topic.

    3. Enter a topic title in the Title field.

    4. Required: Select Mark this topic as a question.

    5. To tag the topic, enter one or more tags in the Tags field.

    6. Enter your question in the rich text field provided.

    7. To attach a file to your question, click Attach a File and browse for a file.

    8. Click Save.


    Results

    If forum topics are moderated in your deployment, the topic does not display immediately. The forum moderator must approve the topic content first. If content moderation is not enabled, the topic displays immediately.


    What to do next

    You can post an answer to your own question by clicking Add Your Answer and following the steps described in Answering questions in a forum. When you post an answer to a question that you created yourself, the answer is automatically marked as an accepted answer.

    To accept an answer posted by another user, click Accept this Answer under the answer. The response is marked as an accepted answer and the icon next to the original question changes to a green tick . Accepted answers are also highlighted with a green background, making it easy for you to identify them when the question has a lot of responses. You can mark multiple replies as accepted answers. When one reply is marked as an answer, the entire topic is marked as answered.

    To reject an answer that has already been marked as accepted, click Decline this Answer under the response.

    If your question is marked as answered, but you later find required more information, you can click Reopen Question under the original post to reopen the question. The question is marked as open again and users can post answers to it.


    Answering questions in a forum

    Share your expertise by answering questions posted to the forums that you are interested in. You can also post answers to questions that you add yourself when you want to share information with other users in a question-and-answer format.

    Anyone can answer a question posted to a stand-alone forum. To answer a question posted to a community forum, you must be a community member. Unanswered questions in a forum are flagged with a question mark icon , making it easy for forum members to identify them.

    When you answer a question in a forum, the person who posted the question receives a notification containing your answer. They can then choose whether to accept or reject your answer. If they accept your answer, the question is marked as answered in the user interface, and the question is flagged with a green tick to indicate that it has been answered correctly. A question can have multiple correct answers.

    To answer a question in a forum, complete the following steps.

    1. Open the forum containing the question to answer, and select the relevant question.

    2. Click Reply.

    3. Enter your answer in the rich text field provided.

    4. Optional: To attach a file to your answer, click Attach a File, click Browse to select the location of the file, and then click OK.

    5. Click Save to post your answer.

    Work with attachments

    You can replace or delete the file attachments that you add to forum threads.

    To edit attachments in a stand-alone forum, you must be the person who uploaded the attachment, the forum owner, or the Forums administrator. In a community forum, only the community owner or the person who uploaded an attachment can edit that attachment. When you create or respond to a discussion topic, you can share attachments with other people in the discussion. Add attachments can be a useful way to include supplemental information that is too long to cover in the body of your message. To delete or replace the attachment at a later stage, you can do so by editing your message. You can also upload additional attachments as needed.

    To work with file attachments, follow these steps.

    1. Open the topic containing the attachment that you want to work with.

    2. Click Edit under the post that you want to edit and do one of the following:

      • To replace a file with an updated version, click Replace next to the file, click Browse to locate the file you want to add instead, and then click OK.

      • To remove a file from the post, click Remove next to the file.

      • To add another attachment, click Attach a File, click Browse to select the location of the file, and then click OK.

    3. Click Save to save your changes.


    Download attachments so you can view them locally

    You can download the attachments that you and other people add to forum posts to your local computer.

    Anyone can download the files that are posted to a stand-alone forum or a public community forum. Add an attachment can be a good way to share information with other people in a discussion or to include supplemental data that is too long to cover in the body of a post. When you have access to a forum, you can download any of the attachments uploaded to the forum by you or other users.

    To download a file attachment, complete the following steps.

    1. Open the forum topic containing the attachment that you want to download.

    2. Click the file name and then select whether you want to save or open the file.

    Manage forums

    When you are a forum owner, you can edit, delete, and lock or unlock a forum. In addition, you can pin forum topics so they appear first in a forum. The Forums administrator can also perform these tasks.


    Forum moderation

    When moderation is enabled for Forums, the content that users add to forums does not display until it is approved by a designated moderator.

    The moderator for Forums can review and manage forum topics before they are published and review forum topics that are already available. In addition, when forum content is flagged as inappropriate by forum users, a notification is sent to the moderator, who can then review the content and decide what action to take.

    Your IBM Connections administrator can specify whether moderation is managed by global moderators or by content owners. Users assigned the global moderator role can view and manage stand-alone forum content and community forum content from a centralized moderation interface that is available only to them. When owner moderation is enabled, community owners can moderate community forum content from the community moderation interface. For more information about moderating community forum content, see Moderating community content.

    Owners of stand-alone forums must use the Forums moderation API to moderate forum content. For more information, see Moderating forum content programmatically.


    Add additional owners to a forum

    If you are the Forums administrator or a forum owner, you can add additional owners to a forum to share the responsibilities of forum ownership. When you create a forum, you automatically become the forum owner. You can add additional owners to a forum after creating it.

    To add additional owners to a forum, complete the following steps.

    1. From the Forums tab on the My Forums page, open the forum to which you want to add new owners.

    2. Click Add Owners.

    3. Enter the names of the people who you want to add as owners in the field provided.

      As you enter names, the type-ahead tool predicts the name you are typing by comparing it to names in your company directory. If it proposes the name that you want, click to add it. If you do not see the name you want listed, click Person not listed? Use full search to search the company directory.

    4. Click OK to add the new owners.


    Results

    The new owners are now listed in the Owner area.


    What to do next

    If you need to remove owners from the forum at a later time, for example, if a forum owner leaves the organization, you can remove them from the forum ownership by clicking the icon next to their name in the Owner area.


    Pinning forum topics

    Highlight or prioritize important topics by pinning them. When you pin a topic, it stays at the top of that forum's topic listing to ensure that it receives attention from other forum participants.

    You must be the forum owner or the Forums administrator to pin a topic in a stand-alone forum. You must be a community owner or the Forums administrator to pin a topic in a community forum. Pinning a topic ensures that the topic does not become difficult to find in a large forum that contains many posts. For example, if you are posting a topic that contains details about an important event, then you might want to pin the topic so that people can find it easily. Pinned topics are marked with a thumbtack icon.

    When you are pinning a topic in a community forum and that community contains multiple forums, the pinned topic does not display at the top of the Topics tab on the Forums page. You must open the forum from the Forums tab to see pinned topics listed at the top of the forum.

    To pin a forum topic.

    1. Open the topic to pin.

    2. Click Pin this Topic under the topic.


    Results

    If at some point the topic no longer needs to be given priority, you can restore it to its regular place in the sequence by selecting Unpin this Topic.


    Edit forums

    Edit a forum to make changes to the forum's name or description, or to add or remove forum tags.

    You must be the Forums administrator or the forum owner to edit a stand-alone forum. To edit a community forum, you must be a community owner.

    To edit a forum.

    1. Open the forum to edit.

    2. Select More Actions > Edit Forum.

    3. Edit the forum as required, and then click Save.


    Locking forums and forum topics

    You can lock a forum when you want to prevent users from contributing to the forum or making updates to existing posts. If you do not want to lock an entire forum, you can control access at topic level by locking forum topics.

    You must be the Forums administrator or the forum owner to lock a stand-alone forum or a topic in a stand-alone forum. To lock a community forum or community forum topic, you must be a community owner or the Forums administrator.


    Locking forums to prevent users from adding topics or responses

    You can lock forums to prevent users from adding new topics or posting responses to existing topics.

    You must be a forum owner to lock or unlock a stand-alone forum. Administrators can lock or unlock any forum. If the forum is in a community, then community owners can also lock and unlock a forum and its topics.

    Anyone who has permission to lock a forum can create topics and replies in the forum even when it is locked. This functionality allows forum owners to make changes to the forum without unlocking it and thus opening it to the entire community. The forum and its topics remain locked for all other users. You might want to lock a forum when you consider the content in the forum to be resolved or complete. For example, if someone started the forum to troubleshoot a specific issue and that issue has now been resolved, then you might consider locking the forum so that no further changes can be made. When you lock a forum, users can still view the forum content, but they cannot add any new topics or make changes to existing content.

    To lock a forum.

    1. Open the forum to lock.

    2. Select More Actions > Lock Forum.


    Results

    The forum is marked as locked in the user interface to let users know that they cannot contribute to the forum.


    What to do next

    You can unlock the forum when you want to allow users to resume adding topics and posting responses to existing topics. To unlock a forum, open the forum and select More Actions > Unlock Forum.


    Locking forum topics to prevent users from editing topics or adding responses

    Lock a forum topic when you want to prevent people from editing the topic or posting responses to it.

    You must be the Forums administrator or the forum owner to lock or unlock a topic in a stand-alone forum. You must be a community owner or the Forums administrator to lock or unlock a topic in a community forum. If you do not want to lock an entire forum, you can lock forum content at topic level to prevent people from editing a topic or posting responses to it. For example, you might want to lock a forum topic when you consider the topic to be resolved or complete. When you lock a forum topic, people can still view the topic, but they cannot post responses to it or make changes to existing content.

    As the forum owner, you can still edit a locked topic and post replies to it even though the topic remains locked for everyone else. This functionality gives you greater control over the content of the forum. For example, if the topic contains inappropriate content, you can lock the topic, and then update it by deleting or editing certain replies without having to reopen the topic.

    To lock a forum topic.

    1. Open the topic to lock.

    2. Click Lock Topic.


    Results

    The topic is marked as locked in the user interface to let users know that they can no longer contribute to the discussion thread.


    What to do next

    If you need to unlock the topic at a later stage, you can do so by opening the topic and clicking Unlock Topic.


    Delete forums

    You can delete forums when they are no longer being actively used and you want to remove them permanently.

    You must be the forum owner or an administrator to delete a stand-alone forum. To delete a community forum, you must be a community owner or an administrator. If you find that a forum is no longer in use, you might want to delete it. Deleting a forum removes it permanently from the Forums application.

    When you want to prevent users from contributing to a forum, but you still want them to be able to view the existing content in that forum, consider locking the forum instead of deleting it. For more information about how to lock a forum, see Locking and unlocking forums.

    To delete a forum.

    1. Open the forum to delete.

    2. Select More Actions > Delete Forum.

    3. Click Delete to confirm that you want to delete the forum.

    Search forums

    Use the search control in the title bar to search for forums or forum topics that contain a specific word or phrase.

    You can only search the forums that you are a member of and forums that have public access.

    To search Forums for a specific text string, complete the following steps.

    1. Set the scope of your search by clicking the Down arrow next to the Search field in the title bar, and then selecting one of the following options:

      All Forums

      Searches for the text string in the titles and descriptions of all the forums to which you have access, all the topics and topic responses contained in those forums, category names and descriptions (if forum categories are enabled), and forum and topic tags.

      This Forum

      Searches for the text string in the title and description of the selected forum, the topics and topic replies in the selected forum, and the tags in the selected forum.

      You must have a forum already open to access this option.

    2. Enter the word or phrase to search for into the Search field, and then click the search icon.

    Following forums and forum topics

    Follow a forum when you want to receive notifications about the latest updates to the forum. If you are interested in a particular forum thread, you can also follow forum content at topic level. When you follow a forum, you receive notifications about the latest updates to the forum. Following a forum topic is also useful when you are interested in a specific discussion thread and you want to keep up-to-date with the progress of that thread.

    Anyone can follow a stand-alone forum or forum topic.

    Notes:

    • When you create a forum, you automatically follow that forum; you do not need to perform any additional steps to follow the forum.

    • When you are already following a community, you do not need to follow its forums or forum topics separately; updates about the community forums are automatically included when you follow the parent community.

    To follow forum content, do one of the following.

    • To follow a forum:

      1. Open the forum to follow.

      2. Select Following Actions > Follow this Forum.

        The forum is added to the list of forums that you are following. To view the complete list, select I'm Following on the My Forums tab, and then select Forums.

    • To follow a forum topic:

      1. Open the topic to follow.

      2. Select Following Actions > Follow this Topic.

        The topic is added to the list of topics that you are following. To view the complete list, select I'm Following on the My Forums tab and ensure that the Topics tab is selected.


    What to do next

    You can keep track of the forums and forum topics that you are following from the Home page by selecting News Feed > Forums on the Updates tab. You can also set email preferences to control how you want to be notified about the forum content that you are following. For more information, see Set email notification preferences.

    If you no longer want to receive notifications about updates to a forum or forum topic, you can stop following it. To stop following a forum, open the forum and select Follow > Stop Following this Forum. To stop following a forum topic, open the topic and click Follow > Stop Following this Topic.

    Subscribe to a Forums feed

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Home page

    Get the latest news and updates from your network and the wider organization.


    New to the Home page?

    Watch a video to learn more about the Home page.


    New to this release?

    Find out what features have been added since the last release.


    Use the Home page

    Click topics in the table of contents to get help with other tasks.

    What is the Home page?

    The Home page delivers an aggregated view of your latest updates across all the IBM Connections applications. Depending on your preference, you can view the updates in list format using the activity stream views, or in widget format using the My Page view.

    The Home page makes it easy for you to share information and collaborate with others by providing an always-current snapshot view of your IBM Connections applications in a single, centralized location.

    By consolidating the latest information from your IBM Connections applications in a one-stop workspace, the Home page helps you stay up-to-date with the people and activities in your organization and fully leverage the benefits of a collaborative working environment.


    Manage centrally

    Want to save time by accessing critical status information in one place? Use the Home page to organize your workload from a centralized workspace and maximize your work efficiency. Get reminders for whichever of your activities are due and prioritize what's most important to you.


    Access information at a glance

    Use the activity stream views to stay informed and quickly filter through the latest updates for the projects and activities that you're working on. Find out who has added content to a blog or created a wiki. Check the status of people in your network and view responses to posts. Click an update to view additional information about it and access more options for working with it. With the update details open, you can comment on your colleagues' status updates or click Like to recommend an update to others. Or you might want to preview an image or download a file to work on it locally.


    Personalize your IBM Connections experience

    Use the My Page view to create a customized workspace that displays your view of the information you want in the way you want. Drag and drop widgets to arrange them as best suits you.

    Get started with IBM Connections

    Use the Get Started view when you are a new or inexperienced user and you want to familiarize yourself with the different applications in IBM Connections.

    When you select Home from the product navigation, you are brought to the Get Started view by default. Use the numbered steps as a guide to help you get started with using each application. Discover how to add new content, find resources that are relevant to you, collaborate with colleagues, and build up a network of connections. Your administrator can customize the getting started experience to meet the needs of your organization by editing the content of the steps, and by adding or removing steps.

    As you become more familiar with IBM Connections, you can close the Get Started view by selecting the Do not show this screen at start check box. When you select this option, you are automatically brought to the Updates view the next time that you open the Home page. You can bookmark the page views that you visit most so that you can navigate directly to them later.

    What's new in the Home page?

    Find out about the new and updated features designed to make the Home page easier for you to use.

    The following features are new or updated for the Home page in IBM Connections 4.

    • The Home page user interface has been updated so that it is easier to find information that is important to you. The Updates tab and the Widgets tab have been replaced by a single page with different views available from the navigation sidebar. Use these views to filter the display and check for your latest updates and notifications. For example, you can check the Action Required view for items that require a response from you. The My Notifications view now includes responses to topics in addition to notifications that you have sent and received. For more information about the different views, see Home page views.

    • The improved microblogging experience allows you to gather information in a meaningful way and act on it in context. You can now attach files to your status updates, and use hashtags to tag your updates and make them easier for other users to find. You can repost status updates to share information with the people who are following you, or click Like to recommend an update. You can also preview images and download files to work on them locally.

    • The steps for following tags from the Home page have changed.

    • The Events widget helps you to keep track of upcoming community events that you are attending and that you are following. The widget is available from the activity stream views.

    Frequently asked questions about the Home page

    Lists the questions that Home page users ask most often and provides brief answers.

    What is the Home page?

    The Home page application delivers an aggregated view of the latest updates from all the IBM Connections applications. If your administrator has enabled it, the Home page also delivers updates from third-party applications. You can filter the list of updates using the different views available.

    Can I set one of the views as my default view?

    No, but the views have different URLs, so you can bookmark your favorite view at any time.

    What are widgets?

    A widget is a self-contained, HTML-based representation of a software component. The My Page view uses widgets to display a snapshot view of updates from each of the IBM Connections applications. You can also add a selection of widgets to the side column in the activity stream views.

    What can I do with IBM Connections widgets?

    You can stay current with updates from all of your IBM Connections applications directly from the Home page. Some widgets allow you to toggle between different views to display different types of information.

    What widgets can I add to my Home page?

    You can add widgets for each of the IBM Connections applications you have installed. Third-party widgets might also be available if your administrator has enabled them. You can view the widgets available for use by clicking Customize from the My Page or activity stream views.

    If I rearrange the widgets, what happens the next time I open the page?

    Whenever you add or move a widget, the next time you open the page, the widget displays in the same location. The widget also displays the same view as when you last viewed it.

    If I close a widget, does that mean that I can't use it again?

    Closing a widget returns it to the content palette. You can add the widget to the Home page again whenever you want.

    What is the limit of the number of entries displayed in the activity stream views?

    There is no limit to the number of entries that you can display. The activity stream displays the full number of entries in all views, except for entries that are 30 days or older. The length of time after which entries are purged is set to 30 days by default.

    What happens to updates on the Home page when someone deletes the original content?

    When a user deletes content from IBM Connections, any updates related to the deleted content are removed, including comments or recommendations for that content. If you saved an update related to the deleted content, that update is also removed from your Saved view.

    Use the activity stream views

    Find out what's new in your network and the wider organization using the activity stream views available from the Home page. You can use the different activity stream views available from the Home page to filter the latest news stories and updates from across IBM Connections. The updates are displayed in list format, making it easy for you to scan through the entries and quickly identify the updates that are most important to you. An icon next to each update identifies which application the update is associated with.

    You can check for the latest news stories and work with updates in the following ways:

    • Use the options available from the navigation sidebar to filter your updates and display different types of information in the activity stream. Select one of the following options:

      • I'm Following

      • Status Updates

      • Action Required

      • Saved

      • My Notifications

      • Discover
      For more information about these views, see Home page views.

    • Use the Filter By options to filter the display to show specific updates.

    • To comment on an update, hover over the update and click Comment. Enter your comment in the field, and then click Post.

    • To save an update for following up later, hover over the update and click Save this. You can retrieve your saved updates later by selecting Saved from the navigation sidebar.

    • To stop receiving updates about an item or person, click Stop following.

    • To access more options for working with an update, hover over the update and click it. The options that display depend on the type of update you are looking at. For example, to share a status update with the people who are following you, click Repost. To close the window, click the X icon or click anywhere outside the window.


    What to do next

    What else can I do using the activity stream views?

    • Click Customize to add widgets and bring extra functionality to your Home page.

    • Let people know what you're doing by updating your personal status message. Click What are you working on right now and enter your status message in the field. If you want to attach a file to your status, click Add a File to select the file, and then click Post.

    • Check what community events are taking place soon using the Events widget. For more information, see Using the Events widget.

    • Keep track of your upcoming to-do items using the To Do List widget. For more information, see Using the To Do List widget.

    • Check for recommended content in the Recommendations widget. The widget suggests content that might interest you, based on your existing community membership, network connections, and tags. For more information, see Using the Recommendations widget on the Home page.

    • Bookmark the page views that you visit most often so that you can navigate directly to them later.


    Update your status message from the Home page

    Update your personal status message from the Home page to let the people in your network know what you're doing. Updating your status message from the Home page automatically updates the status message that displays in your profile. You can keep the people in your network informed about what you're doing by regularly updating your personal status message. For example, you might post a message to let people know that you're busy preparing for a meeting or that you're about to leave the office for the day. Or you might want to share a link to an interesting website with the people in your network. When you paste a URL into the status message field, the URL is automatically converted to a hyperlink.

    To update your status message, complete the following steps.

    1. Click What are you working on right now from any of the activity stream views.

    2. Enter your status message in the field that displays. The administrator can configure the character limit available for status updates so the length of the message that you can enter might vary depending on your deployment.
      Tip: To tag your message with a specific keyword, type the keyword prefixed with a hash (#) symbol as part of your message. When you save the message, the keyword is automatically converted to a link. Other users can click the link to search for status updates tagged with the same keyword.

    3. Optional: Attach a file to your message by clicking Add a File and choosing one of the following options:

      • To attach a file from the Files application, select My Files, select a file, and then click OK.

      • To attach a file from your local system, select My Computer, click Browse to select a file, and then click OK.

    4. Click Post.

      If you decide that you do not want to post the message, click Reset to cancel the message.


    What to do next

    You can delete your status messages at any time by hovering over the message to remove, clicking the X icon, and then clicking Delete.


    Following tags

    Follow tags that you are interested in so that you can receive the latest updates for the people or content with those tags. Following tags is an easy way to get updates about the content and people that interest you. When you follow a tag, updates are sent directly to your Home page whenever any public content with the tags that you are following is added or changed. This includes news updates from all the applications.

    1. Select I'm Following, and then select Tags from the Filter By options.

    2. To check the latest updates for a tag that you are already following, select a tag from the Show list. The latest updates related to the tag are displayed.

    3. To follow a new tag, click Manage Tags, enter the tag in the field that displays, and click Add. Then click Done.

    4. To remove a tag, click Manage Tags, and click the X icon next to the tag that you want to remove. Then click Done.

      Alternatively, when you are in the I'm Following view, you can click Stop Following for an entry, and then click Save.


    Application icons

    The Home page uses different icons to identify the application that each update is associated with.

    Table 50. Application icons

    Icon Application
    Activities
    Blogs
    Bookmarks
    Communities
    Files
    Forums
    Profiles
    Wikis

    Use the My Page view

    Stay current with the latest news stories from your organization by using widgets to list the most recent updates. The My Page view lets you access the latest updates from the different applications using widgets, with each widget listing the updates for a specific application. In addition to the widgets available from IBM Connections, you can add third-party widgets if your administrator has made them available.

    To open the My Page view, select My Page from the navigation sidebar.

    Use the My Page view to access and work with updates in the following ways.

    • To open the content that was updated, click the update title.

    • To add more widgets to the page, click Customize and select a widget. You can move widgets to arrange them as best suits you. For example, if you are interested in updates from some applications more than others, you can arrange the corresponding widgets to give them more prominence on the page. For more information about adding widgets, see Add widgets to your Home page.

    • If you find that you are not using a particular widget, you can free up space by removing it from the page. For more information about removing widgets, see Managing Home page widgets.

    • You can change the layout of the My Page view to specify the number of columns that is displayed. For more information, see Selecting a page layout.


    Selecting a page layout

    You can change the setup of the My Page view by selecting a two-column or three-column layout. The widgets automatically resize to fit the chosen layout.

    To change the layout of the My Page view, complete the following steps.

    1. From the My Page view, click Customize.

    2. Select Change Layout and then select a layout option.

    3. Click the Close icon to close the Change Layout panel.

    What are widgets?

    Widgets are self-contained, HTML-based representations of software components. The content palette displays the widgets that are available for you to use in the Home page.

    You can access the following types of widget from the content palette:

    • IBM Connections widgets. The widgets available from the content palette include widgets for the IBM Connections applications that you have installed. Use these widgets to display a snapshot view of the latest updates for each application. The content palette also contains social analytics widgets if your administrator has made them available. These widgets use information from the different IBM Connections applications to recommend content that might be relevant to you.

    • Third-party widgets. When your administrator has enabled the use of widgets from another vendor, these are displayed in the content palette along with the IBM Connections widgets that are available for use.

    You can access the content palette from any of the Home page views by clicking Customize.

    For the widgets in all the IBM Connections applications to load properly in Microsoft Internet Explorer, ActiveX Controls must be enabled on the Security tab. To access the Security tab, select Tools > Internet Options > Security.


    Add widgets to your Home page

    Add widgets to the activity stream and My Page views so that you can see updates from IBM Connections and other sources, and bring extra functionality to your Home page.

    To add an IBM Connections widget to the Home page, your organization must have a subscription to the corresponding IBM Connections application. You can also add third-party widgets if your administrator has enabled use of them. The content palette lists all the widgets that the administrator has made available for your deployment.

    The first time you use the Home page, a number of default widgets display in the activity stream and My Page views. You can extend the information displayed in each view by adding extra widgets from the content palette. For example, if you are an active blogger and are interested in seeing what other bloggers in your organization are talking about, you might want to add the Blogs widget. Or, if you want to keep track of what the people in your network are doing, you might want to add the My Network widget.

    You can add widgets to any of the columns in the My Page view, but you can only add widgets to the side column in the activity stream views. Your widget preferences are automatically saved by the system so that when you next open the Home page, the widget display is the same as when you last used the page.

    Your preferences are not saved if you remove all the widgets from a page. When you remove all the widgets, the page is automatically reset to display the default set of widgets the next time that you return.

    To add a widget.

    1. Click Customize.

      If you are in the My Page view, you might need to click the Add Content tab if it is not already displayed.

    2. Select a widget type from the menu sidebar, and then click a widget to add it.

    3. Click the Close palette icon to close the content palette.


    Home page widgets

    The widgets in the Home page widget catalog can help you stay up-to-date with events in the different applications.

    The following IBM Connections widgets are available to add to the Home page.

    Notes:

    • To add an IBM Connections application widget to your Home page, the corresponding application must be installed in your deployment.

    • For the widgets in the IBM Connections applications to load properly in Microsoft Internet Explorer, ActiveX Controls must be enabled on the Security tab. To access the Security tab, select Tools > Internet Options > Security.

    Table 51. Home page widgets

    Widget Description
    Activities Displays a snapshot view of the latest updates from the Activities application, including updates to your personal activities and public activities.

    This widget is available in the My Page view.

    Blogs Displays information about the most recent blog entries in your organization.

    This widget is available in the My Page view.

    Bookmarks Lists the latest updates from the Bookmarks application.

    This widget is available in the My Page view.

    Communities Displays information about the most recent entries to communities in the Communities application.

    This widget is available in the My Page view.

    Events Lists upcoming community events that you are planning to attend and events that you are following.

    This widget is available in the activity stream views.

    Files Shared with Me Lists the files that other people have shared with you recently in Files.

    This widget is available in the My Page view.

    Latest Wikis Lists wikis that have been updated recently, including public wikis and wikis to which you belong.

    This widget is available in the My Page view.

    My Activities Lists the latest updates from your activities.

    This widget is available in the My Page view.

    My Bookmarks Displays your most recent updates in the Bookmarks application.

    This widget is available in the My Page view.

    My Communities Displays information about your communities that have been recently updated.

    This widget is available in the My Page view.

    My Files Lists the files that you have added or updated most recently in Files.

    This widget is available in the My Page view.

    My Network Displays a summary of the latest updates that people in your network have made in the Activities, Blogs, and Bookmarks applications.

    This widget is available in the My Page view.

    My Profile Displays a snapshot view of your personal details from Profiles.

    This widget is available in the My Page view.

    My Watchlist Lists the recent bookmarks that are created by that people on your watchlist or that match the tags on your watchlist.

    This widget is available in the My Page view.

    My Wikis Lists the wikis to which you belong in order of the most recently-updated wiki.

    This widget is available in the My Page view.

    Popular Bookmarks Lists the public bookmarks shared in the Bookmarks application, in order of most popular.

    This widget is available in the My Page view.

    Popular Wikis Lists the wikis that receive the greatest number of visits, in order of the most recently-updated wiki.

    This widget is available in the My Page view.

    Profiles Provides a snapshot view of your personal details from Profiles, and also lists recent activity and updates for the people in your network.

    This widget is available in the My Page view.

    Public Activities Displays the latest updates from public activities.

    This widget is available in the My Page view.

    Public Communities Displays information about the public communities that have been updated most recently.

    This widget is available in the My Page view.

    Recent Bookmarks Displays a list of the most recent public bookmarks added in the Bookmarks application.

    This widget is available in the My Page view.

    Recommendations Suggests content that might interest you, based on your existing community membership, network connections, and tags.

    This widget is available in the activity stream views.

    To Do List Lists your upcoming to-do items from Activities.

    This widget is available in the activity stream views.


    Use the Recommendations widget on the Home page

    Use the Recommendations widget to find content from the different applications that might interest you. The widget displays in the side column of the activity stream views. The Recommendations widget suggests content that might interest you based on your existing community membership, network connections, tags, and so on. The widget displays a randomized list of public and private content that has been recently added or updated in the different applications. The recommendations made are based on your relationship with existing public and private content in IBM Connections. An icon next to each recommended item identifies which application the content is associated with. The widget displays 15 recommendations by default.

    Table 52. Application icons

    Icon Application
    Activities
    Blogs
    Bookmarks
    Communities
    Files

    The icon shown here represents just one file type. The icon next to a recommended file from the Files application changes depending on the type of file. For more information, see File type icons.

    Forums
    Wikis

    The Recommendations widget also provides information about the ways in which you are already connected to the content listed. For example, you can click the related tags link to see what tags you have in common with the suggested content. The tags that are displayed are tags that are associated with the recommended content and also associated with you in some way. You might have assigned the tags to content or to your profile for instance.

    The Recommendations widget only recommends content, it does not recommend people. Use the Do You Know widget on the My Network page in Profiles when you want to get suggestions for people to add to your network.

    Use the Recommendations widget in the following ways.

    • If an item interests you, click the title to open the item and take a closer look.

    • Click the links under the items listed to find out more about how you are connected to that item. You can view related tags or related people to find out what you have in common with the recommended content.

    • Use the Previous and Next links to page through the recommendations and display more options.

    • To remove an item from the list of recommendations, click the icon next to the item.


    Use the To Do List widget

    Use the To Do List widget to find out which of your task deadlines are approaching. The widget displays in the activity stream views by default. The To Do List widget lists the to-do items that are assigned to you. The items are listed in chronological order, allowing you to quickly scan through them and identify which are most urgent. The to-do items that do not have a due date are displayed under items with a due date.

    Use the To Do List widget in the following ways.

    • To view individual to-do items:

      1. Click a to-do title to open it in Activities. For information about how to work with your to-do items, click ? to access the help for Activities.

      2. When you are finished working with the to-do item, close the window to return to the Home page.

    • If you do not have any to-do items, click Go to my to do list to open the Activities application and start creating items. For information about how to create a to-do item, see Add a to-do entry.


    Use the Events widget

    Use the Events widget to keep track of upcoming community events from your Home page. The widget displays in the activity stream views by default. The Events widget lists the community events that you are following and the events that you are planning to attend. You can access details about the events directly from the widget.

    You can work with the Events widget in the following ways:

    • Click an event title to view more details about the event in the Communities application. From the Calendar page, you can see which community the event is associated with and access more options for working with the event.

    • Click Add to Personal Calendar to add a feed from the widget to your personal calendar.

      Your email application must support iCal or iCalendar feeds for this functionality to be available.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of events to display in the widget.

      3. Select the type of information to display, and then click Save.

        There are three options:

        • All followed or attending events. Select this option to display the events that you are attending and following. This is the default option.

        • Attending events. Select this option to display only the event instances that you are attending.

        • Followed events. Select this option to display only the event instances that you are following.


    Use the Activities widget

    Use the Activities widget to access a snapshot view of the latest updates from the Activities application. You can toggle between widget views to access different information.

    You can work with the Activities widget in the following ways:

    • To select a widget view, click the Down arrow under the widget title and select one of the following options:

      Table 53. Activities widget views

      View Description
      My Activities In this view, the Activities widget displays the most recent updates for your personal activities.

      Click the links next to the calendar to view the latest updates to your posts or high priority activities, or to open the Activities application.

      For information about how to use the calendar, see Using the calendar in the Activities widget.

      Public Activities The Public Activities view displays a list of the most recently updated public activities.

      Click the title of an activity that interests you to open the update in Activities.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the period of time for which you want to display recent entries for your activities.

      3. Select the number of public activities to display in the widget.

      4. Click Save.


    Use the calendar in the Activities widget

    Use the calendar in the Activities widget to find out which of your task deadlines are approaching.


    About this task

    The calendar highlights the deadlines for your to-do items for the current month, using the following background colors and symbols to highlight significant dates. The current date is highlighted in bold text.

    Table 54. Calendar color codes and symbols

    Background color Symbol Description
    Red > To-do items that are overdue.
    Gray # To-do items to be completed today.
    Blue * Personal to-do items to be completed on a future date.
    Green + Team (unassigned) to-do items to be completed on a future date.
    For example, for a to-do item assigned to you personally that must be completed on a future date, that date is highlighted with a blue background, with an asterisk (*) symbol preceding the date.

    The calendar also flags the dates associated with unassigned tasks to be completed in the future. Deadlines for completed tasks are not included. If a personal to-do item and a team to-do item fall on the same day, then the calendar flags the personal to-do item rather than the team to-do item.

    Use the arrows on either side of the month name to display task deadlines for the previous and following months.

    To view the tasks associated with a specific deadline, complete the following steps.

    1. Click the highlighted date in the calendar. A pop-up window displays, listing the tasks with deadlines on the selected day.

    2. Click a task title to retrieve information about the task directly from the Activities application.

    3. When you are finished working with the task, close the window to return to the Home page.


    Use the My Activities widget

    Use the My Activities widget to view the latest updates from your activities. You can use the My Activities widget to get information about the latest updates to your activities. This includes responses to your activity entries and new entries in your high priority activities.

    You can work with the My Activities widget in the following ways:

    • To view responses to your activity entries, click number of new responses to your posts.

    • To view recent entries in your high priority activities, click View new entries in your high priority activities.

    • To view a list of your recent activity updates, click My Activities.

    • To use the calendar to view the tasks associated with a specific deadline, click a highlighted date in the calendar. For more information about how to use the calendar, see Using the calendar in the My Activities widget.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the period of time for which you want to display recent entries for your activities, and then click Save.


    Use the calendar in the My Activities widget

    Use the calendar in the My Activities widget to find out which of your task deadlines are approaching.

    The calendar highlights the deadlines for your to-do items for the current month, using the following background colors and symbols to highlight significant dates. The current date is highlighted in bold text.

    Table 55. Calendar color codes and symbols

    Background color Symbol Description
    Red > To-do items that are overdue.
    Gray # To-do items to be completed today.
    Blue * Personal to-do items to be completed on a future date.
    Green + Team (unassigned) to-do items to be completed on a future date.
    For example, for a to-do item assigned to you personally that must be completed on a future date, that date is highlighted with a blue background, with an asterisk (*) symbol preceding the date.

    The calendar also flags the dates associated with unassigned tasks to be completed in the future. Deadlines for completed tasks are not included. If a personal to-do item and a team to-do item fall on the same day, then the calendar flags the personal to-do item rather than the team to-do item.

    Use the arrows on either side of the month name to display task deadlines for the previous and following months.

    To view the tasks associated with a specific deadline, complete the following steps.

    1. Click the highlighted date in the calendar. A pop-up window displays, listing the tasks with deadlines on the selected day.

    2. Click a task title to retrieve information about the task directly from the Activities application.

    3. When you are finished working with the task, close the window to return to the Home page.


    Use the Public Activities widget

    Use the Public Activities widget to view the latest updates from public activities.

    You can work with the Public Activities widget in the following ways:

    • To view an update to a public activity, click the title of an activity that interests you to open the update in Activities. Close the window to return to the Home page.

    • If no activities have been created yet, click Go to your Activities page to open the Activities application. From there, you can click My Activities to start creating activities and assigning to-do items.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of public activities to display in the widget and click Save.


    Use the Blogs widget

    Use the Blogs widget to view the latest updates from the Blogs application. The Blogs widget displays information about the most recent blog entries in your organization, in order of the most recently published entry. You can see how many people liked a blog entry or commented on it.

    You can work with the Blogs widget in the following ways:

    • To view a blog update, click the blog title to open the update in the Blogs application. Alternatively, click Details to open the blog entry in a pop-up window.

    • If no blog entries have been created yet, click Go to your Blogs page to open the Blogs application and create a new blog or start adding blog entries.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Use the Bookmarks widget

    Use the Bookmarks widget to stay current with the latest bookmarks added to Bookmarks. The Bookmarks widget lets you access the latest updates from the Bookmarks application. Toggle between widget views to access different information. You can edit your own bookmarks from any of the Bookmarks widget views. You can also use the widget to copy other people's bookmarks into your personal bookmark list.

    You can work with the Bookmarks widget in the following ways:

    • To change to a different view, click the Down arrow under the widget title and select one of the following options:

      Table 56. Bookmarks widget views

      View Description
      My Bookmarks In this view, the Bookmarks widget displays the most recent updates you've entered in Bookmarks. You can also edit your bookmarks from this view.
      Popular Bookmarks The Popular Bookmarks view displays a list of all the public bookmarks shared in Bookmarks, in order of most popular. You can edit your own links from this view and copy bookmarks to your personal bookmarks list.
      My Watchlist The Bookmarks application allows you to add people and tags to a watchlist. Any public bookmarks that are created by people on the list or that match watched tags are displayed in the My Watchlist view in the Bookmarks widget. You can edit your own links from this view and copy bookmarks to your personal bookmarks list.
      Recent Bookmarks The Recent Bookmarks view displays a list of the most recent public bookmarks added in the Bookmarks application. This view also provides links for you to edit your own bookmarks and copy other people's bookmarks to your personal bookmark list.

    • To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively, click Details to open the bookmark in a pop-up window.

    • To edit one of your bookmarks:

      1. Click Details under the bookmark you want to edit.

      2. Click Edit this bookmark.

      3. Make your changes, and then click Save.

      4. Click Close to return to the Home page.

    • To copy a bookmark:

      1. Click Details under the bookmark you want to copy.

      2. Click Add to my bookmarks.

      3. Complete the Add Bookmark form, and then click Save.

      4. Click Close to return to the Home page.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget, and then click Save.


    Use the My Bookmarks widget

    Use the My Bookmarks widget to display the most recent updates you entered in the Bookmarks application. You can also edit your bookmarks from this view.

    You can work with the My Bookmarks widget in the following ways:

    • To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively, click Details to open the bookmark in a pop-up window.

    • To edit one of your bookmarks:

      1. Click Details under the bookmark you want to edit.

      2. Click Edit this bookmark.

      3. Make your changes, and then click Save.

      4. Click Close to return to the Home page.

    • If you have not yet added any bookmarks, click Go to your bookmarks page to open Bookmarks and start adding your own bookmarks.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget, and then click Save.


    Use the My Watchlist widget

    Use the My Watchlist widget to monitor the most recent bookmarks added to your watchlist. You can edit your own links from this view and copy bookmarks to your personal bookmarks list. The Bookmarks application allows you to add people and tags to a watchlist. Any public bookmarks that are created by people on the list or that match watched tags are displayed in the My Watchlist widget in the My Page view. You can edit your own links from this view and copy bookmarks to your personal bookmarks list.

    You can work with the My Watchlist widget in the following ways:

    • To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively, click Details to open the bookmark in a pop-up window.

    • To edit one of your bookmarks:

      1. Click Details under the bookmark you want to edit.

      2. Click Edit this bookmark.

      3. Make your changes, and then click Save.

      4. Click Close to return to the Home page.

    • To copy a bookmark:

      1. Click Details under the bookmark you want to copy.

      2. Click Add to my bookmarks.

      3. Complete the Add Bookmark form, and then click Save.

      4. Click Close to return to the Home page.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget, and then click Save.


    Use the Popular Bookmarks widget

    Use the Popular Bookmarks widget to display a list of all the public bookmarks shared in the Bookmarks application, in order of most popular. You can edit your own links from this view and copy bookmarks to your personal bookmarks list.

    You can work with the Popular Bookmarks widget in the following ways:

    • To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively, click Details to open the bookmark in a pop-up window.

    • To edit one of your bookmarks:

      1. Click Details under the bookmark you want to edit.

      2. Click Edit this bookmark.

      3. Make your changes, and then click Save.

      4. Click Close to return to the Home page.

    • To copy a bookmark:

      1. Click Details under the bookmark you want to copy.

      2. Click Add to my bookmarks.

      3. Complete the Add Bookmark form, and then click Save.

      4. Click Close to return to the Home page.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget, and then click Save.


    Use the Recent Bookmarks widget

    Use the Recent Bookmarks widget to display a list of the most recent public bookmarks added in the Bookmarks application. The widget also provides links for you to edit your own bookmarks and copy other people's bookmarks to your personal bookmark list.

    You can work with the Recent Bookmarks widget in the following ways:

    • To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively, click Details to open the bookmark in a pop-up window.

    • To edit one of your bookmarks:

      1. Click Details under the bookmark you want to edit.

      2. Click Edit this bookmark.

      3. Make your changes, and then click Save.

      4. Click Close to return to the Home page.

    • To copy a bookmark:

      1. Click Details under the bookmark you want to copy.

      2. Click Add to my bookmarks.

      3. Complete the Add Bookmark form, and then click Save.

      4. Click Close to return to the Home page.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget, and then click Save.


    Use the Communities widget

    Use the Communities widget to access the latest updates to communities. The Communities widget displays information about the most recent entries to communities in the Communities application. The widget contains links to the feeds, bookmarks, and forum topics associated with a community. Depending on the view you select, you can see updates for public communities or communities of which you are a member. The list is ordered by the most recently published entry.

    You can work with the Communities widget in the following ways:

    • To change views, click the Down arrow under the widget title and select one of the following options:

      Table 57. Communities views

      View Description
      My Communities In this view, the Communities widget displays the most recently updated communities to which you belong.
      Public Communities The Public Communities view displays the public communities that have been updated most recently.

    • To view a community update, click a community title. The update opens in the Communities application.

    • If no communities display, click the link provided to open the Communities application and create a new community or join existing communities.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Use the My Communities widget

    Use the My Communities widget to retrieve the latest updates for the communities of which you are a member. The My Communities widget displays information about your communities that have been recently updated. You can view who last updated the community and when. The widget also contains links to the feeds, bookmarks, and forum topics associated with each community. The list is ordered by the most recently updated community.

    You can work with the My Communities widget in the following ways:

    • To view a recently updated community, click the community title. The community opens in the Communities application, where you can view a summary of the latest updates on the Overview page.

    • If no communities display, click Go to your Communities page to open the Communities application and create a new community or join existing communities.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Use the Public Communities widget

    Use the Public Communities widget to view a list of the most recently updated communities. The Public Communities widget displays information about the public communities that have been most recently updated. You can see who last updated the community and when. The widget also contains links to the feeds, bookmarks, and forum topics associated with the community. The list is ordered by the most recently updated community.

    You can work with the Public Communities widget in the following ways:

    • To view a recently updated community, click the community title. The community opens in the Communities application, where you can view a summary of the most recent updates on the Overview page.

    • If no communities display, click the link provided to open the Communities application and create a new community.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Use the My Files widget

    Use the My Files widget to see a list of the files that you have added or updated most recently in Files. You can also use the widget to upload new files to the Files application.

    You can work with the My Files widget in the following ways:

    • To view the most recent updates to your files, click a file name to open the update in the Files application.

    • To upload a file to Files, click Upload, click Upload Files, and then complete the form that displays.

    • If there are no entries to display, click Go to Files to open the Files application and start uploading files.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Use the Files Shared with Me widget

    Use the Files Shared with Me widget to display a list of the latest files that people have shared with you. You can also use the widget to upload new files to the Files application. The Files Shared with Me widget lets you keep track of the files that other people have shared with you.

    You can work with the Files Shared with Me widget in the following ways:

    • To view the latest files shared with you, click a file name to open the update in the Files application.

    • To upload a file to Files, click Upload, click Upload Files, and then complete the form that displays.

    • If no files have been shared with you yet, click Go to Files to open the Files application and access other options for working with files.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Use the Profiles widget

    Use the Profiles widget to view the latest updates for the people in your network. You can also access and edit your profile directly from the widget.

    You can work with the Profiles widget in the following ways:

    • To change to a different view, click the Down arrow under the widget title and select one of the following options:

      Table 58. Profiles widget views

      View Description
      My Profile In this view, the Profiles widget displays a snapshot view of your personal details from Profiles. You can open your profile directly in Profiles or edit your profile from this view.
      My Network The My Network view displays recent activity and updates for the people in your network. This might include new activity entries and blog entries that they have created, and new bookmarks that they have added in the Bookmarks application. You can also check if you have any pending colleague requests from this view.

    • To access your full profile, click Profile from the My Profile view.

    • To edit your profile, click Edit from the My Profiles view, make your changes, and click Save.

    • To view the latest updates for people in your network, select the My Network view. This view also lets you see how many updates your colleagues have made lately in Activities, Blogs, and Bookmarks.

    • To process new network requests, click the network requests link. If you do not see a network requests link, this means that you have no pending network requests.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the period of time for which you want to display the latest entries from your network.

      3. Select the number of people to display in the widget.

      4. Click Save.


    Use the My Profile widget

    Use the My Profile widget to display a snapshot view of your personal details from Profiles. You can open your profile directly in Profiles or edit your profile using this widget.

    You can work with the My Profile widget in the following ways:

    • To access your full profile, click Profile.

    • To edit your profile, click Edit, make your changes, and click Save.


    Use the My Network widget

    Use the My Network widget to stay current with your colleagues and add new connections to your network. The My Network widget displays a summary of the latest updates that people in your network have made in the Activities, Blogs, and Bookmarks applications.

    You can work with the My Network widget in the following ways:

    • To display a list of the updates that a person has made in Activities, Blogs, or Bookmarks, click one of the application links under the person's name. Click an update title to open the full update.

    • If you do not have any network connections yet, click Go to your profile to open the Profiles application and search for useful network contacts.

    • To process new network requests, click the network requests link. If you do not see a network requests link, this means that you do not have any pending network requests.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the period of time for which you want to display the latest entries from your network.

      3. Select the number of people to display in the widget.

      4. Click Save.


    Use the My Wikis widget

    Use the My Wikis widget to help you track the latest updates to the wikis of which you are a member. The My Wikis widget displays a list of the wikis that you are a member of, in order of the most recently-updated wiki. The widget lists the wikis by title, and provides information about who last updated the wiki and when they made the update.

    You can work with the My Wikis widget in the following ways:

    • To navigate to a wiki to get more information about an update, click the wiki title to open the wiki in the Wikis application. Close the window to return to the Home page.

    • If there are no wiki entries to display, click Go to your Wiki page to open the Wikis application and start a wiki or access other options for working with existing wikis.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Use the Latest Wikis widget

    Use the Latest Wikis widget to display a list of wikis that have been updated recently. The Latest Wikis widget allows you to keep current with the latest updates to public wikis. Browsing the widget entries is a useful way of finding wikis with recent activity. You can see who last updated a wiki and when they made the update.

    You can work with the Latest Wikis widget in the following ways:

    • To navigate to a wiki to get more information about an update, click the wiki title to open the wiki in the Wikis application. Close the window to return to the Home page.

    • If there are no wiki entries to display, click Go to your Wiki page to open the Wikis application and start a wiki or access other options for working with existing wikis.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Use the Popular Wikis widget

    Use the Popular Wikis widget to see a list of popular wikis that have been updated recently. The Popular Wikis widget displays a list of the wikis that receive the greatest number of visits, in order of the most recently-updated wiki. The widget lists the wikis by title, and provides information about who last updated the wiki and when they made the update.

    You can work with the Popular Wikis widget in the following ways:

    • To navigate to a wiki to get more information about an update, click the wiki title to open the wiki in the Wikis application. Close the window to return to the Home page.

    • To configure display settings for the widget:

      1. Click the Actions icon in the widget title bar and select Edit.

      2. Select the number of entries to display in the widget and click Save.


    Manage Home page widgets

    Use the options available from the widget action menu to manage widgets in the Updates and My Page views.

    To access the action menu for a widget, click the Actions icon in the widget title bar. You can perform various management tasks for the widgets in the Updates and My Page views. For example, if you find that you are no longer using a specific widget, you might want to remove it to free up some space on the page. Or, if you're using one widget more than the other widgets, you might want to move it to a more prominent position on the page.

    The options available from the widget action menu vary from widget to widget.

    To manage widgets as needed.

    • To move a widget to a new location, do one of the following:

      • Click the widget title bar and drag the widget to a new location.

      • Choose one of the Move options available from the widget action menu. The options available depend on the current position of the widget on the page.

    • To set the number of entries that the widget displays:

      1. Select Edit from the widget action menu.

      2. Select the number of entries to display. The options available depend on the widget that you are editing.

      3. Click Save.

    • To view help for the tasks that you can perform using the widget, select Help from the widget action menu.

    • To reload the widget and display the latest updates, select Refresh from the widget action menu.

    • To remove the widget, select Remove from the widget action menu. Removing the widget returns it to the content palette. You can add the widget again at any time.

    Home page views

    You can use the views available in the Home page to learn more about IBM Connections, and to get the latest updates from your network and the wider organization.

    Tip: If you use some Home page views more than others, you can bookmark them to make them quicker to get to later.

    Table 59. Home page views

    Option Description
    Get Started Use this option when you are a new or inexperienced user and want to learn more about IBM Connections. Select the Do not show this screen at start check box if you do not want this view to display by default every time you open the Home page.
    I'm Following Select this option when you want to see updates related to the people and content that you are following.

    Click Stop following under an update if you no longer want to get the latest updates for a specific person or piece of content.

    Status Updates Select this option to view the latest status update messages from across your organization.
    Action Required Use this option to view your latest to-do items from Activities, network and community invitations, requests to join moderated communities, and any third-party events requiring an action on your part.

    The number of items requiring action displays next to the view name so that you can see at a glance how many items you need to complete. This number is automatically updated when you perform an action related to an item, such as accepting a network invitation or completing a to-do item.

    Saved Select this option to view the updates you saved for later.

    Save updates can be useful when you are checking the latest news but you do not have time to look at the full details of individual updates.

    When you are finished with a saved update, you can remove it from this view by clicking the X icon next to it.

    My Notifications Use this option to see the latest notifications that you received and sent in IBM Connections. You can use the Show options to filter the display to check for the latest responses to content that you created, or view notifications that you sent to other users.
    Discover Select this option to view the latest public updates from all the applications.

    Browsing the latest public entries from IBM Connections can be a useful way to find new content and people that interest you.

    My Page Select this option when you want to view the latest updates using application widgets rather than in list format.
    Administration Select this option when you want to perform administrative tasks for the Home page. This option only displays for users who have been assigned the administrator role.

    Subscribe to a Home page feed

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Profiles

    Find expertise and connect with people.


    New to Profiles?

    Watch a video to learn more about Profiles.


    New to this release?

    Find out what features have been added since the last release.


    Use Profiles

    Click topics in the table of contents to get help with other tasks.

    What is Profiles?

    Profiles is an application that provides a directory of the people in an organization: how to contact them, and how to find out about their projects, skills, and interests. Use Profiles to facilitate collaboration by helping you to find and get in touch with the appropriate people fast.

    New employees must be added to the Profiles application by the IBM Connections administrator. Only people who are listed in the corporate directory are available in Profiles.


    Increase your visibility

    Profiles can help you to tap into the collective knowledge of the people in your organization and work collaboratively with others.

    Let people in the organization know who you are, what you do, what projects you are working on, the tools and technologies you are using, the problems you are currently trying to solve, and what you are reading or writing. Start by filling out your profile. Help people get to know you better by adding rich social information, such as your interests, hobbies, and tags that indicate your area of expertise.


    Become involved

    Discover who in the organization is working on projects like yours or finding solutions to similar problems, and what resources they are using to simplify their jobs. Find out who your co-workers are, what their interests are, what skills they have, what they are publishing or reading, and get in touch with them. See who they connect to so that you can extend your network further.


    Build your own network

    Use profiles to make useful connections. Find people with the skills and expertise you need and add them to your network. Follow people when you want to keep up with their updates but don't want to add them to your network. You can view the latest status updates from the people that you are following and the people in your network by logging in to the Home page and selecting Status Updates on the Updates tab.

    What's new in Profiles?

    Find out what is new and what changed in Profiles.

    • The The Board tab has been replaced with the Recent Updates tab on the user.s profiles page. The Recent Updates list of posts is similar to the board in that it displays status messages and responses. It also includes information about other actions performed by the profile owner, such as sharing a file or adding a post to a blog. The message posting area itself is essentially identical to the earlier version, enabling you and others to view and post messages to a user.s wall.

    • The Recent Posts tab on the Profiles page has been removed. Recent posts appear under the profile owner.s Recent Updates tab.

    • Use the Recent Updates area on your profile page to post a status message.

    • The business card has been redesigned for improved layout and access.

    • On the Invite to My Network page, the Also Follow option is enabled by default.

    • You can now accept a network invitation from the inviter's profile page.

    • The Network Contact or Pending Invitation indicator label now displays next to the person.s name on their profile page.

    • You can now accept an invitation to join a person.s network from that person.s profile page.

    Frequently asked questions in Profiles

    Find answers to the questions that Profiles users ask most often.

    What is Profiles?

    The Profiles application provides a directory of the people in your organization, giving you the information you need to contact them and find out about their projects, skills, and interests.

    How do I update my profile?

    Use the Edit My Profile page to update your profile. You can change your contact details, background information, and upload a new profile photo or pronunciation file using the options available on this page.

    Some profile information is automatically filled in by your administrator based on the information in your organization's personnel directory. For example, your name and the details of your report-to chain might be pulled in directly from your company directory. The administrator might also set some fields to read-only so that you cannot update them yourself. To update read-only fields, the information must be updated in the corporate personnel directory first, then the changes will be updated to your profile the next time the administrator synchronizes Profiles with the personnel directory. If you need to update information in your profile but cannot do so from the Edit My Profile page, contact your administrator or Human Resources department for assistance.

    What are tags?

    A tag is a descriptive keyword that you assign to your profile or someone else's profile to identify work activities, skills, or interests.

    How do I find people?

    You can search profiles using a simple search to find people by their contact information, such as name and job title, or use more advanced information to find people by searching on their interests, experience, and work projects. The search control is available on every page in Profiles. You can also open the Directory tab to search for people in your organization. For a more targeted directory search, use Display full search options on the Directory tab to search for data in specific fields.

    How do I build up my own network?

    After you've found the people to connect with, add them to your network to build up a set of useful contacts. When you add someone to your network, they receive an email invitation asking them to join your network, which they can accept or decline.

    I accidentally clicked Invite to My Network when viewing a colleague's profile. Can I cancel the invitation?

    There is no way to revoke a network invitation once it has been sent.

    If I ignore an invitation to join someone's network, will the person who invited me find out?

    No, if you do not accept the invitation, the person is not notified.

    Can I block someone from following me?

    No, there is currently no way to prevent a person from following your profile.

    What is the difference between following someone and inviting someone to join my network?

    When you invite people to join your network, and they accept, they are added to your list of networks on the My Network page of Profiles. When you choose to follow someone, whenever the person you are following performs an action, such as posting a profile status message, adding a blog post, or commenting on or recommending something, the action is listed in the All Updates view of your Home page. When people in your network perform the same types of actions, they are not listed to your All Updates view. You must explicitly choose to follow someone if you want the person.s latest updates to be displayed in your All Updates view.

    I recently got married and want to change my name in my profile. How do I do this?

    Your administrator can set certain fields, such as your name, to be read-only. If you cannot update your name directly from Profiles, contact your administrator or Human Resources department to advise them about your name change.

    My department has been reorganized and I report to a different manager now. How do I update the information in my report-to chain?

    The information in your report-to chain is automatically added to your profile from your organization's personnel directory; it is not possible to update this information directly from Profiles. Contact your administrator or Human Resources department for assistance.

    The display of people's business cards as the cursor moves over names in views such as Directory and My Network is really distracting; is there a way to prevent that?

    Use the keyboard arrows to scroll minimizes that behavior.

    Viewing profiles

    View profiles to find contact and work-related information for people, and connect with them in different ways.

    In addition to contact details and work background, a profile provides rich, social information about a person that can help you decide if you want to connect with them. You can find out how you are related to the person, what you have in common, view their latest status updates, and keep up with what they've been doing lately in the other applications.

    You can also connect with people directly from their profile. For example, you can email them, invite them to join your network, or follow them. When Sametime awareness is enabled, the person's online status is displayed, and you can start an instant chat with them directly from their profile.

    The IBM Connections Plug-in for Sametime must be installed for this information to display.

    View a person's profile to find the following information:

    Send Email

    Click to send the profile owner an email, or simply learn their email address if it is not specified in their contact information.

    Invite to My Network

    Click to send a message to the profile owner, inviting them to join your network and begin to share information. Optionally select to also follow their status updates and message posts.

    Download vCard

    Click to download and store the profile owner's virtual business card (vCard) data. A vCard is a file that stores basic contact information following the Internet Mail Consortium specification. You can add new contacts by using your email system to import vCard files.

    Follow

    Select to have the profile owner.s status updates and message posts appear as messages on your own profile page under the Recent Updates tab.

    Recent Updates

    Click to display the latest posts to the profile owner's status and message board. This information includes the profile owner's recent status messages and comments that other users have posted to the profile owner's message area. You can control the types of posts that are displayed by clicking Filter By and making a selection.

    Contact Information

    Click to display basic information business card information, such as name and email addresses, as specified in the user.s profile page.

    Your administrator can configure IBM Connections to prevent email addresses from being displayed, in which case email addresses do not display in a person's profile or business card.

    Background

    Click to display the content that the user has specified in the About me, and optionally the Background, sections of their profile page. Typically this includes work experience, technical skills, languages spoken, and education. It may also contain personal information such as hobbies or any other information that the profile owner has created and wants to share.

    Tags

    Tags are short keywords used to identify the profile owner's skills, areas of interest, or work activities. These tags can be added by the profile owner or by another person.

    Things in Common

    This section displays items such as files and activities that you have in common with the person whose profile you are viewing. This information can help you decide if you want to connect with the person and invite them to join your network. For more information, see Using the Things in Common widget.

    You must be logged in to see content in the Things in Common widget.

    Pronunciation

    The pronunciation link is displayed if the profile owner has created an audio file and uploaded it to the profile. Click the link to play a recording of the person's name with the correct pronunciation.

    Who Connects Us?

    This section displays contacts that link you and the profile owner. Viewing information is a useful way to see how you are connected to a particular person. For more information, see Using the Who Connects Us widget

    You must be logged in to see information about the social path that exists between you and the profile owner.

    Report-to-Chain

    This area shows the profile owner's position in the organizational hierarchy, from the profile owner up to the top of the organizational chart.

    Choose one of the following options to open additional information about the people in the reporting structure:

    Table 60. Reporting structure views

    View Description
    Full Report-to Chain Opens a page that shows basic information about the people in the organizational hierarchy, from the profile owner up to the top of the organizational chart.
    Same Manager Opens a page that shows basic information about the people who also report to the profile owner's manager.
    People Managed Opens a page that shows basic information about the people that the profile owner manages.

    Network

    This area shows a selection of the people in the profile owner's network. You can click View All to display a full list of the people in the profile owner's network. You an also click a network member name or image to open their profile page.

    My Links

    This area contains external links that profile owners include as part of their profile. You can click Add Link to add links to your profile.

    Update your status message

    Update your personal status message to let the people in your network know what you are doing. Your status message is visible to anyone who can view your profile page in their, and your, profile page.

    You must be logged in to Profiles to update your status message. You can keep people informed about what you are doing by regularly updating the personal status message that displays under your profile picture. For example, you might post a message to let people know that you are busy preparing for a meeting or that you are about to leave the office for the day. Or you might want to share a link to an interesting website with the people in your network. When you paste a URL into the status message field, it is automatically converted to a hyperlink.

    To update your status message, complete the following steps on your profile page.

    1. Click Recent Updates and click in the What are you working on now? message area.

    2. Enter a brief status message in the field provided, and then click Post. Optionally add a file that has already been uploaded or that is on your computer.

    Update your profile

    Edit your profile to add or update information about yourself, change your profile picture, or upload a pronunciation file. An administrator initially creates your profile with information from the user directory for your organization. You can edit your profile as needed to add extra details and ensure that the information is kept up-to-date. Note that if you cannot update a field in your profile, for example, your name, this is because the administrator has set the field to be read only. To update the information in read-only fields, contact your administrator.

    Notes:

    • The information in your profile comes from the organization's personnel directory and, because different directories store different information, the fields that are displayed in your profile might differ from the default fields. In addition, your administrator can automatically fill in a field to prevent you from having to fill it out. The administrator can also set a field to be read-only if it collects information that is not relevant to your organization.

    • You cannot update your report-to chain information directly from Profiles. This information is automatically pulled in to the Profiles application from your organization's corporate directory. If the information in your report-to chain is no longer current, the information must be updated in the corporate directory first. Your administrator can then synchronize the changes back to Profiles.

    To edit your profile, perform the following steps.

    1. Click Edit My Profile on the My Profile page. Alternatively, select Profiles > Edit My Profile from the product navigation.

    2. Depending on the type of changes you want to make, click one of the following tabs:

      Table 61. Edit profile tabs

      Tab Select this tab if you want to:
      Contact Information Edit your office location, contact details, or job title, or choose a different time zone. Add or change your personal blog link.
      About Me Update the details of your work history and background information.
      Photo Update or remove your current profile picture.
      Pronunciation Update or remove an audio file of your name being spoken with the correct pronunciation.

    3. When you've made the necessary changes, click Save or Save and Close.


    Update contact information

    Keep your contact information up-to-date to ensure that people can get in touch with you.

    The information in your profile comes from the organization's personnel directory and, because different directories store different information, the fields that are displayed in your profile might differ from the default fields listed below. In addition, your administrator can automatically fill in a field to prevent you from having to fill it out. The administrator can also set a field to be read-only if it collects information that is not relevant to your organization.

    To edit your contact information, complete the following steps.

    1. Click Edit My Profile on your My Profile page. Alternatively, select Profiles > Edit My Profile from the product navigation.

    2. Click the Contact Information tab.

    3. Edit the content of any of the following fields.

      Your administrator can set specific fields to be read-only so that, depending on your deployment, you might not be able to edit all the fields listed below. For example, you might not be able to update your name or your email address if those fields are set to be read-only. If your contact information has changed and you cannot edit the information yourself directly from Profiles, contact the IBM Connections administrator to advise them about the updated information.

      Table 62. Contact information fields

      Field name Description
      Building Building name.
      Floor Floor number.
      Office Office name.
      Office number Office telephone number.
      IP telephony number Tie line number.
      Mobile number Mobile telephone number.
      Pager number Pager number.
      Fax number Fax number.
      Alternate e-mail An alternate email address. This option is not available if your administrator has disabled the display of email addresses for your deployment.
      Blog link Link to your personal blog.
      Job title Your official job title.
      Assistant Name of your assistant.
      Time zone Click the Down arrow to select the time zone of your primary work location.

    4. Click Save when you are ready to save your changes.


    Update your background information

    Edit the About Me area of your profile to let people know information about yourself such as specific skills and previous work experience. This content appears in the Background page of your profile.

    Use the About Me area of your profile to describe what you do. Provide details about the projects that you are working on, the technologies that you are using, and the problems that you are encountering or resolving. Include information about any relevant technical skills, language skills, or interests that you might have. You might also add information about your previous work experience, education, and training in the Background section of this page.

    An administrator initially creates your profile with information from the user directory for your organization. Because the information comes from the organization's personnel directory and different directories store different information, the fields that are displayed in your profile might differ from the default fields. In addition, your administrator can automatically fill in a field to prevent you from having to fill it out. The administrator can also set a field to be read-only if it collects information that is not relevant to your organization.

    To update your background information, complete the following steps.

    1. From the My Profile page, click Edit My Profile. Alternatively, select Profile > Edit My Profile from the product navigation.

    2. Click the About Me tab.

    3. Click in the About Me field , and nter information about yourself in the area provided, for example your current work projects and areas of responsibility. This area is a rich text field, so you can format the text, paste text copied from elsewhere, add embedded links to web sites, and so on.

    4. Scroll to the Background field to optionally enter additional information, for example your past work experience, education, and accomplishments.

    5. Click Save or Save and Close.


    User profile Background samples

    See these samples to get ideas for the type of information to include for the Background tab of your profile.

    The Background section of your profile should describe your work background, experience, areas of expertise, and include some information about your interests or hobbies to keep it interesting. Use the samples below as a reference. You update this content using the About Me tab, which is available when you click Edit My Profile on your profile page.


    Product manager

    I have held a variety of roles within software development, including development, design, user research, and now product management. I am currently the product manager team lead for Renovations SocioTech, a social software tool for the retail industry. In the role of senior product manager, I work to define the overall social software strategy, develop and drive product requirements with engineering and design, work with customers and partners to shape the product, and publicize the product through demonstrations and presentations at numerous industry events.

    I came into Renovations through the Research Collaborative User Experience group as a user researcher. In my 10 years with the company, I have developed expertise in the entire Socio suite of products. I hold an MBA with a concentration in Human Factors in Information Design, and I have a strong interest in collaboration technologies and personal and business productivity tools.

    My new favorite hobby is sharing the experience of training our family puppy in my pawprints blog.


    Program manager

    I am currently responsible for the Socio brand education offerings driving revenue, development and quality worldwide.

    I have been part of Renovations Education since 2001 specializing in internet sales technology, TCP/IP, and secure transactions. I have over 20 years experience working with UNIX® systems and have been actively responsible for managing, teaching, and developing the Renovations suite education curriculum. I am the Learning profession Champion for the technology group in Europe. I am a Certified Learning Professional, and a member of the Global Learning Profession Board. I am a Chartered Member of the British Computer Society; a Fellow of the Institute of IT Training and a member Institute of Engineering and Technology. I have many Certifications including Renovations Certified Advanced Technical Expert - Socio and Renovations Certified Systems Expert (Exam developer).

    I am an amateur violinist, and am currently preparing for my first public performance with a local string quartet.


    Update your profile photo

    You can add, update, or remove your profile photo on your profile page.

    Your profile photo must be one of the following file types: .jpeg, .gif, or ..png. There are no file size restrictions. However, the image is automatically resized to fit the allocated space in the user interface.

    You can enhance your profile by updating your image from time to time. Be sure to upload a business-appropriate image.

    To update your profile image, perform the following steps.

    1. From the My Profile page, mouse over your profile photo and click the Edit profile photo icon.

      Alternatively, click Edit My Profile and click the Photo tab.

    2. Do one of the following:

      • To upload a new image:

        1. Click Browse to locate a file containing a picture of you to display in your profile.

        2. Select the image file to upload and display and then click Open.

        3. Optionally resize the portion of the image that will display using the Image Preview area.

          Image resizing is not available for all image formats; if you encounter problems with uploading and sizing an image, try converting the image to a different format and then upload.

        4. Click Save.

      • To remove the existing photo, select Remove Image.


    Add a pronunciation file

    Edit your profile to add a recording of your name being pronounced correctly.

    The pronunciation file that you upload to your profile must be in .wav or .wma format, and it cannot be larger than 100 KB in size.

    You can enhance your profile by adding a recording of yourself saying your name so that others can hear it pronounced correctly.

    To upload an audio file to your profile, perform the following steps.

    1. Click Edit My Profile on the My Profile page. Alternatively, select Profiles > Edit My Profile from the product navigation.

    2. Click the Pronunciation tab.

    3. Click Browse and locate an audio file recording of your name being clearly spoken with the correct pronunciation.

    4. Click Save to upload the selected file.

      To remove your pronunciation file, click Remove audio file and then click Save.


    Add links to your profile

    Add external web site links to your profile page to share them with others.

    You can add your favorite web sites, such as social networking sites or industry web sites, to the My Links area of your profile. For example, you might want to include a link to your twitter feed, public blog, or your profile on Facebook or LinkedIn so that you and your colleagues can easily access your social data from your profile page.

    To add a link to the My Links area in your profile.

    1. From your My Profile page, click Add Link in the My Links area.

    2. Enter a name for the link in the Name field. The text you enter here is displayed in the My Links area as the hypertext link. For example, if the link goes to your LinkedIn profile, you might enter "My LinkedIn profile."

    3. Type or paste in the web address of the page you want to link to into the Link field, and then click Save.

      For example, you can copy one of the following types of web addresses and paste it into the Link field:

      • Twitter feed. From your Twitter settings, find the public profile web address, such as http://twitter.com/myusername.

      • LinkedIn profile. From your profile in LinkedIn, find the public profile web address, such as http://www.linkedin.com/pub/my-name/8/234/a05.

      • Facebook profile. Open your profile in Facebook, and then copy the web address in the browser location bar, such as http://www.facebook.com/profile.php?id=000000000000000.

        To improve the readability of the web address for your profile, you can go to your account settings and create a Facebook user name, which gets used in the profile web address: http://www.facebook.com/username.

    Add people to your network

    Use profiles to create a network of work colleagues and useful contacts. You can invite people to join your network by sending them an invitation.

    You do not need to be in Profiles to add someone to your network. You can connect to people directly from the profile business card in any of the IBM Connections applications. For example, if a person's profile is returned as part of search results, or if you are members of the same community as someone and you want to add them to your network, you can do so using the business card.

    You do not get updated on actions performed by people in your network; you have to follow someone if you want to be informed of their latest updates.

    To add someone to your network, do the following:

    1. Search for the person.s profile, and then open it.

    2. Click Invite to My Network. If you are not already logged in to the Profiles application, you are directed to log in.

    3. Accept the default message or enter a message of your own inviting the person to join your network.

    4. Enter keywords that define how you are connected to the person in the Add tags for name field.

    5. If you want actions performed by the person, such as posting a profile status message, adding a blog post, commenting on or recommending something, to be displayed in the All Updates view in your Home page, click Also Follow.

    6. Click Send invitation.


    Results

    The person you have invited to join your network receives notification that you have invited them to join your network. If they accept your invitation, they are added to your My Network page, and the Invite to My Network link is changed to Remove From Network when you next view their profile pages. There is no notification to let you know when people accept or reject an invitation to join your network.


    Accepting network invitations

    Accept invitations to join other people.s networks. When you accept an invitation, the inviter is added to your network as well.

    If your administrator has enabled email notifications for the Profiles application, when people add you to their network, they generate an email message inviting you to join their network. The email contains a link to the My Network page,

    ...where you can accept or decline the invitation.

    If email notifications are not enabled for your deployment, you can access invitations directly from the My Network page.

    To accept a network invitation, complete the following steps:

    1. Open the invitation by doing one of the following:

      • If email notifications are enabled, you can click the link provided in the email invitation to open the My Network page.

      • Select Invitations from the My Network page.

    2. Accept or ignore the invitation.

      • To accept the invitation and join the inviter's network, click Accept.

        You can also click the inviter.s name and accept the invitation from their profile page.

      • To ignore the invitation and delete it from the Invitations tab, click Ignore.

        When you ignore an invitation, the inviter does not receive notification of your action.


    Viewing network contacts

    Want to see who's connected to who? Use Profiles to view a person's network contacts or check if someone is already part of your network. You can view the people in your network and in other people's networks from the Network Contacts page.

    To view network contacts for your profile or someone else's profile.

    Open the Network Contacts page by doing one of the following.

    • To view your own network contacts, open the My Network page, and click My Network Contacts.

    • To view another person's network contacts, open their profile page and click View All in the Network area of the page.
    Click to open a contact.s profile page to learn more about them. Optionally initiate an action such as following the contact, inviting them to your network, or posting a message to their Recent Updates area.

    The Network Contact label appears on a person.s profile page if you are networked with them.


    Delete people from your network

    When people move or leave your organization, you can remove them from your network.

    To delete a person from your network, perform the following steps.

    1. Open the My Network page, and click My Network Contacts.

    2. Select the check box next to each person that you want to remove, and click Remove from My Network.

      The person does not receive notification that you have removed them from your network.

    Get to know other people

    You can follow people in your organization to receive their latest updates and find out what they are working on. You can also use the social analytics widgets available in Profiles to help you get to know people better.

    The social analytics widgets, such as Who Connects Us? and Report-to-Chain areas, help you to find out what you have in common with other people, find people to add to your network, and see the social path that connects you to another person.


    Following people

    Follow a person when you want to keep up-to-date with their latest updates. You do not have to add a person to your network in order to follow them. When you are interested in another user's activities and status content you can stay up-to-date with what they're doing by following them. You do not have to add a person to your network in order to follow them. For example, if you want to hear about what someone in your organization is blogging about, you might want to follow them to get their latest updates.

    Unlike inviting someone to join your network, where the person must accept your invitation to become connected to you, following does not require the approval of the person to follow.

    You can see who you are following by selecting My Network > Following. You can see who is following you by selecting My Network > Followers in Profiles, but you cannot remove people from the Followers list, and cannot block prospective followers.

    To follow a person.

    1. Open the profile page of the person you want to follow. For example, click the Directory tab in Profiles and enter the person.s name.

    2. Click Follow on the person.s profile page.


    What to do next

    You can set your email preferences so that you receive regular notifications about the people that you are following. For more information, see Set email notification preferences. You can also check the latest updates for the people that you are following from the Home page by the All Updates tab. For more information, see Using the Updates tab.

    If you are following a lot of people and you can no longer keep up with the updates that you are getting, you might decide to confine your following list to a smaller number of people. Or you might want to stop following a person if you find that their updates are not relevant to you. To stop following a person, open their profile page and click Stop following.


    Use the Things in Common widget

    Use the Things in Common widget to find out what you have in common with a person. The widget displays when you are viewing other people's profiles.

    You must be logged in to see content in the Things in Common widget. The widget only displays the public content that a user has in common with another user. When you are viewing another person's profile, the Things in Common widget lists the things that you have in common with that person. The widget displays a list of public content organized according to application. For example, the widget might display a list of the public communities that you and the profile owner both belong to or a list of the tags that you have both used. You can use this information to help you decide if you want to follow that person or add them to your network.

    Use the Things in Common widget in the following ways.

    • Expand the application twisties to display content from a particular application. For example, this content might include communities, discussions (forum threads), blogs, activities, files, bookmarks, tags, or wikis that you and the profile owner have in common.

    • When a content listing interests you, click the title to open it and take a closer look.


    Use the Do You Know widget

    Make new connections and expand your network using the Do You Know widget on the My Network page.

    You must be logged in to receive colleague suggestions from the Do You Know widget. The Do You Know widget recommends people for you to add to your network based on your existing connections, tags, organizational relationships, and actions that you have taken in the different applications.

    The widget recommends people for you to connect to and provides information about how you are already related to those people. For example, you might share the same manager, you might be a member of the same communities, or you might have used the same tag.

    You can use the information provided by the widget to help you decide whether to add a person to your network. If the person interests you and you want to connect with them, you can add them to your network directly from the widget. You can remove the recommendation if you decide that you do not want to connect with them.

    Because the widget is refreshed on an interval basis, you may not be prompted immediately for people recently made available.

    Use the Do You Know widget in the following ways:

    • Select a person's profile picture to display a list of the ways in which that person is related to you.

    • Scroll through the suggested profiles by clicking the photo on either side of the middle photo.

    • To invite a person to join your network, select the person's profile picture and click Invite to connect.

    • To remove a recommendation, select the person's profile picture and click Remove.

    • Access a person's business card by hovering over their name and clicking the link that displays.


    Use the Who Connects Us widget

    Use the Who Connects Us widget to find out how you are connected socially to other people in your organization. The widget displays when you are viewing other people's profiles.

    You must be logged in to see content in the Who Connects Us widget. You can use the Who Connects Us widget to view the social path that links you to a person when you are viewing that person's profile. The social path displays as a list of people who link you and the profile owner.

    The Who Connects Us widget provides information about how you are connected to the profile owner, and how the profile owner is connected to other people in the social path. This information can be useful if you are looking to expand your social network and want to find people who are connected to you in some way, or if you just want to get a clearer picture of the social structure in your organization.

    Use the Who Connects Us widget in the following ways.

    • Select a person's profile picture to display a list of the ways in which that person is linked to you.

    • When you want to find out more about a person in the social path, click the person's name under their profile photo to open their profile.

    • Expand the twisties to view more detailed information about how you are connected to the profile owner, or how the profile owner is connected to other people in the social path.

    • Select the photo on either side of the center photo to display more profiles.

    Search profiles

    You can search profiles to find people by their contact information, such as name and job title, or by more advanced information, such as their interests, experience, and work projects.

    There are a number of different types of search that you can perform in Profiles:

    • Use the search control to perform a basic search based on a single search field. This control is available at the top of every page in Profiles.

    • Search for a person by name or keyword using the Profiles by Name and Profiles by Keyword options available from the search control at the top of the Profiles page. .

    • Use your company directory to perform a more targeted search based on multiple search fields. You can search the company directory from the Directory page or by selecting Directory Search from the search control at the top of the page.

    • The tag clouds on the My Profile and Directory pages allow you to search the profile tags for your profile or the entire organization. Click a tag to display a list of people with that tag and show related tags to help you refine your search.

    For all types of search, the wildcard character (*) is supported. For example, if you enterEthan * as a search string for names, the results display all profiles for people with the first name Ethan. If you enter 555* as the search string for telephone numbers, the results display all numbers beginning with 555.


    Search by name

    You can search for a person based on their name.

    1. From the My Profile, My Network, or Directory page, select Profiles by Name in the search area.

    2. Type a name into the Search field and click the search icon.

      • Use an asterisk (*) as a wildcard character. For example, enter Ethan * to find people with whose first or last name begins with Ethan.

      • Type just the first letters of a name, for example Ab to find people whose first or last name begins with the letters Ab.


    Performing a more advanced search

    Perform a more advanced search when you want to use information in addition to or instead of a person.s name as the search criteria.

    1. Open the Directory page in Profiles. Alternatively, click Directory in the search bar the top of the page from your My Profile or My Network page.

      Additional advanced search options are available by clicking Advanced in the search bar the top of the page.

    2. Do one of the following.

      • To find the profile of someone you know, enter the person.s name in the field provided, and then click Search.

      • To find the profile of a person whose name you forget or to find the profiles of people you do not know, but who share a common job role or tag, you can search particular fields as follows:

        1. Click Display full search options.

        2. Enter a value into one or more of the following fields to return profiles that contain the same value in the corresponding field.

          Table 63. Directory search fields

          Field name What to enter
          Keyword A term to search for in every field of every profile.
          Display Name First and last name of the person that you want to find. If the person goes by a nickname, use this field to search for the person by nickname.
          First Name Given name.
          Last Name Family name.
          Tags The tag to search for. This searches the tags that were added to peoples. profiles.
          Job Title Job title to find the profiles of people who perform that job function.
          About Me A keyword that captures the type of skills and experience that you are looking for.
          Background A keyword that describes the kind of background that you are interested in.
          Organization or Company Name of an organization or company to find the profiles of employees.
          City City to find the profiles of people who work at that location.
          State State to find the profiles of people who work at that location.
          Country Country to find the profiles of people who work at that location.
          E-mail Address Business email address. This option is not available when the configuration prevents email addresses from being displayed.
          Phone Number Telephone number. This field searches all five phone number fields in a person's profile.

          Your administrator can add or remove fields from the Search the Directory form to suit the needs of your organization. Because of this capability, the fields that display in the form might be different from those listed here.

        3. To include users who have left the organization in your search, select Include inactive users in search results. You can identify inactive users because their profiles are grayed out.

        4. Click Search to submit your search query.

      • To search every field in every profile for a given term, select Search > Profiles by Keyword from the top of the page, type the term into the search field, and then click the Search icon.


    Use tags to find people

    Use the tags assigned to profiles to find people based on the tag names they have used to define their skills, job role, or interests.

    • From your own or someone else.s profile, click a tag in the Tags collection to see other people who assigned the same tag to their profiles.

    • On the Directory page,, click a tag in the Organization Tags collection to display only people who have assigned the same tag to their profiles.

    • On the Directory page, click Display full search options, type one or more tag names into the Tags field and then click Search. Separate multiple tag names using a space or comma.


    Viewing the search results

    Your search returned multiple results. Now what should you do?

    You can perform a search in Profiles, for example using the Search bar option Profiles by Name, to find people.s profiles. The search results are limited to 250 results by default. This figure can be changed by the administrator.

    Profile contact information is displayed in the search results. Sort options are available in the search results list. You can also click a tag in the Organization Tags collection to filter the results by tag.

    Review search results by doing the following.

    • View the business card of people returned by a search by hovering over their name and clicking the link provided. If after viewing the business card, you want to learn more, click the person's name to open their profile.

    • Use the Sort by options at the top of the page to sort the results in order of relevance, display name, and last name.

    • Page through the search results by clicking the Next, Previous, or page number buttons at the top and bottom of the view. If there are too many results, you can search again. In the subsequent search, provide more qualifiers by filling in more of the search fields.

    Download vCard contact details

    You can download a person's vCard in preparation for adding them as a new contact in your address book. A virtual card (vCard) is a file that stores basic contact information for a user, following the Internet Mail Consortium specification. You can add new contacts by using your email system to import vCard files. You can also download the vCard from the Profiles business card.

    When you download a person.s vCard, you need to select the character encoding option that is appropriate for your address book reader. The default option is Internationalized (UTF-8), which is suitable for users of IBM Lotus Notes and Microsoft Outlook. However, you might need to select a different encoding if your email client is Microsoft Outlook Express® or some other email tool.

    To save a person.s vCard to your personal records, perform the following steps.

    1. Open the profile page for the person who you want to add as a contact.

    2. Click Download vCard.

    3. Select the character encoding to use.

    4. Click Download to save the person's vCard to a specified location.

    What is the Recent Updates area?

    Every user has a Recent Updates area on their profile page,

    ...where their status updates are displayed. Other users can post messages to another user.s status updates area, making it easy to communicate directly with that person within Profiles. Status updates for contacts that the profile owner follows also appear in this area enabling the profile owner and others to increase their awareness of what network contacts and community members are doing and saying.

    The recent updates area of a person's profile displays their latest status messages, helping you to keep up with what the person is doing, what they are working on, and how busy they are. You can go to people's profile pages and quickly scan listed posts to see a summary of their latest updates and updates of contacts whom they follow. The profile owner and other users can post comments in response to any update entries or messages.

    This area also displays an update message when the profile owner, or someone the profile owner follows, performs various tasks such as creating a new blog, posting a blog entry, or commenting on a blog entry.

    Your administrator can choose whether to enable or disable this feature for users in your organization. By default, it is enabled. The administrator can also configure settings to control who can post messages. For example, the administrator might choose to limit access so that only the people in a user's network can post comments to that user's message board.


    Posting messages or comments to another user's profile page

    Connect with the people in your organization by commenting on a colleague's status message or posting a message to their recent updates area.

    You must be logged in to Profiles to post a message or comment to someone's profile.

    Your administrator controls who can write on a person's recent updates area. When you view another person's profile, if you do not see the option to post a message or comment, then you do not have access to write in that person's recent updates area. Every Profiles user has a recent updates area on their profile page that displays their status messages, as well as other information such as certain actions and updates of contacts whom they follow. You can communicate with your colleagues by posting a message or comment on their profile page. The profile owner receives an email notification whenever a message or comment is posted to their profile.

    • To post a message to another user's profile page:

      1. On the person's profile page, click inside the message field in the Recent Updates area, where What are you working on right now? is displayed.

      2. Enter your message, and then click Post.

    • To post a comment to another user's profile:

      1. Locate the message or comment to which you want to respond and do one of the following:

        1. If you are responding to a message, click Comment under the message.

        2. If you are responding to a comment, click Add a comment under the comment.

      2. Enter your reply in the field provided, and then click Post.


    Remove messages or comments from your profile page

    As profile owner, you can control what displays in your recent updates area by removing posts that you think are inappropriate.

    You must be logged in to Profiles to remove content from the recent updates area of your profile or content that you have added to another user's area. Profile owners can delete any of the content added to their recent updates area. People who have added comments or messages to another user's recent updates can only remove content that they created themselves.

    To remove a message or comment from the recent updates area, click the remove icon next to the entry to delete. If you do not see the icon, then you do not have permission to delete the entry.

    Tagging profiles

    Add a tag to your own profile or to another person.s profile to identify a specific skill set or area of expertise. Profile tags should identify a person.s job role, skills, or interests. For example: loan-officer, human_resources, encryption, fly-fishing. When used correctly, they can help people learn about one another.

    If your system administrator has enabled people tagging, you can tag yourself and others. You must be logged in to create or modify tags.

    • Tags that you add to your own profile or to the profiles of others cannot be hidden or private. All tags are displayed in the profile tag collection and organizational tag collection.

    • If multiple people assign the same tag to a profile, a number is displayed beside the tag to identify the number of times the tag has been assigned. You can click the number to display a list of the people who assigned that tag to the profile.

    • Tags that you assign to a profile are listed separately from those that were assigned by others.

    To tag a profile.

    1. Open your own profile or the profile page of the person to tag.

    2. Type a keyword into the tag field. The tag must be a single word only; it cannot contain spaces. You can use an underscore (_) or a hyphen (-) to specify multiple word phrases. Separate multiple tags with commas or spaces.

      Tags are automatically converted to lowercase.

    3. Click the Add tags to this profile icon to add the tags to the profile.


    What to do next

    You can remove the tags that you added to another person's profile. Profile owners can remove any of the tags added to their profile, whether the tag was added by the profile owner or by someone else.


    Use the Organization Tags collection

    The organizational tags collection is displayed on the Directory page and contains the tags that have been assigned to peoples. profiles the most often. From the search results view, it displays the tags that have been assigned to the profiles returned by the search.

    When you add a tag to a profile, it does not get displayed in the organizational tag collection until the profile content is next indexed. The frequency of the indexing task is defined by your site administrator, but usually occurs every 15 to 20 minutes. So, it might take that long before you see a tag that you add get displayed in the organizational tag collection.

    • You can choose to display the collection as a list or cloud. The List view displays the 10 most popular tags. The Cloud view displays the 50 most popular tags. If you do not see a tag that you know exists in the collection, click in the Type to find a tag search field, type the tag name in the field, and click the search icon to find it.

    • Click a tag to see a list of the people who have assigned that tag to their profiles or had it assigned to their profiles by someone else.


    Understand profile tags

    A tag is a descriptive keyword that you can assign to your profile to identify work activities, skills, or interests. For example: payroll, event-planning, human_resources. If your system administrator has enabled it, you can also assign tags to other people's profiles as well.

    Tags that you assign to your profile are displayed in the tag collection in your profile and in the organizational tag collection in the Directory page. The tag collection in your profile is called Tags. It includes only the tags that have been added to your profile by you or others, and is displayed below your profile picture. The tag collection in the Directory page is called Organization Tags. It includes the most popular tags that have been added to the profiles of everyone in your organization.


    Use the tag collection

    You can view the tags in the tag collection as a list or a cloud. Click Cloud or List at the bottom of the tag collection to switch the display. The list view shows the top 10 tags. The cloud view shows the top 50 tags and displays the most frequently used tags in a larger, bolder font. You can quickly find experts in a specific area by browsing the tag collection and clicking tags that interest you.


    Publicize your skills

    By assigning tags to your profile, you describe your skills, job role, interests, and education to others in your organization. Tags describe what you do and what you care about. When you create tags, use keywords that represent your interests or areas of expertise. Tags must be entered as a single word, or as multiple words connected with a hyphen or underscore.


    Find people

    Click one of your own profile tags to quickly find other people who share your interest or are doing similar work. People with whom you share common tags are likely to be good resources for you. You can get their contact information from their profiles and begin collaborating with them.

    Find out who has tagged you. Click the frequency number for a particular tag to display a list of the people who tagged you with that term. Click the frequency again to hide the information.


    Define your connection

    Tagging a colleague's profile can help remind you what your connection to a person is. For example, if you worked with them on a particular project, you might choose to tag them with the name of that project. When you tag someone else's profile, that tag is visible to anyone who views the profile. By tagging your own profile and other people's profiles, you make it easier for you and your colleagues to locate expertise in your organization.

    Subscribe to a Profiles feed

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Create an audio file

    Create a recording of yourself saying your name so that others hear it pronounced correctly. To create an audio file on a Microsoft Windows system, perform the following steps:

    To create an audio file on a Linux system, use the record command or use a sound recording utility.

    1. Select Start > All Programs > Accessories > Entertainment > Sound Recorder.

    2. Click the Record button, say your full name, speaking as clearly as possible, and then click the Stop button. Click the Play button to listen to the recording.

    3. Check the size of the recording by clicking File > Properties. The data size must be smaller than 100 KB.

    4. To rerecord the audio file, click File > New, and select No when prompted to save the recording. Repeat step 2 to rerecord. Follow these tips to improve the quality of the recording:

      • If the recording is inaudible, make sure that the microphone is enabled. Select Start > All Programs > Accessories > Entertainment > Volume Control, then select Options > Properties. Choose Recording, select Microphone, and then click OK. Drag the volume slider for the microphone up to the maximum level.

      • If the recording is unclear or the file produced is too large (over 100 KB), configure the sound recorder. Select Start > All Programs > Accessories > Entertainment > Sound Recorder. Select File > Properties, and then click Convert Now. In the Format field, select PCM and in the Attributes field, select 8.000 kHz, 8 bit, Mono. Click OK, and then click OK to close the Properties window.

    5. After you have produced a recording that is clear, audible, and smaller than 100 KB, select File > Save As to save it. Type a name for the file and choose a directory to save it to. Make a note of the name and location, so that you can retrieve it when you upload the file to your profile. Set the file type (.wav and .wma), then click Save.

    Wikis

    Create and collaborate on content in wikis.


    New to Wikis?

    Watch a video to learn more about Files.


    New to this release?

    Find out what features have been added since the last release.


    Use Wikis

    Click topics in the table of contents to get help with other tasks.

    What are wikis?

    Wikis are collections of pages about a particular subject. Wiki members can edit or comment on the pages, or add their own pages. Teams can use wikis to create a central place to collaborate on a project.

    Typically someone creates a wiki, gives it a title, adds initial members, and adds a description and some tags. On the first page in the wiki, they provide information about the subject, and then they tell the members that it is available. Depending on their access, members can read the wiki, edit pages, comment on pages, and add their own pages.

    An example might be a wiki about birds. The wiki creator titles the wiki "Birds of the United States," provides a description, and makes like-minded people members, giving them access to create new pages and edit existing pages.

    The creator then edits the first page and provides some introductory information, including a welcome, an explanation of the subject, and instructions on getting started and where to find help.

    Now let's assume that the creator has a particular interest in birds of the southwest United States. She could then create a child page below the welcome page titled "Southwest." Then she could create child pages for each type of southwestern U.S. bird.

    As she is building the "Southwest" section of the wiki, other members have started looking at it. One member creates a peer page next to the "Southwest" page called "Northeast" and begins adding pages about Northeast birds. The hierarchy of pages now looks like this: 

    Birds of the United States
 Southwest
  California Condor (Gymnogyps californianus)
 Northeast
  Orchard Oriole (Icterus spurius)

    Other members begin editing existing pages, adding comments, and adding their own pages. Within a few months the wiki is robust and full of information, and finding information about a particular bird is no longer as simple as glancing at the hierarchy. Users interested in a particular bird can search on the bird's name, or look for that bird's name as a tag, or find the name in the page index.

    What's new in Wikis?

    Find out about the new and updated features in Wikis.

    • There are no longer My Wikis and Public Wikis tabs. All views are together in the same list.

    • See wikis you are following by clicking I'm Following.

    • Pages can be removed from a wiki by moving them to the trash. From the trash, pages can be deleted or restored to the wiki.

    • You can now download a version of a page from the page comparison view, as an HTML file.

    • The wiki editor has been updated. Administrators can divide toolbars into multiple toolbars. You can navigate between toolbars with the Tab key. Also, toolbars now include a button for adding and editing iFrames.

    • The wiki editor has two new features: the editor area expands downward as you add content. As your editing space expands, a toolbar displays even if scrolling is required.

    How do I find wikis?

    You can find wikis by navigating wiki lists or using tags.


    Option Description

    To find wikis by title

    In the search menu, select Go to Wiki, and then start typing the name of the wiki. A list of wiki titles matching the name display. Select the wiki from the list.

    To navigate the list of public wikis

    Click Public Wikis then sort the list.

    To navigate wikis you own or are a member of

    Click any of the following views:

    • I'm an Owner

    • I'm an Editor

    • I'm a Reader

    To navigate wikis you are following

    Click I'm Following.

    To find wikis using a tag

    Click Public Wikis and then expand the Public tags section. Click Find a tag, and then type the tag into the field and click the wiki title when it displays. If the tag does not display, click the search icon. You can also click a tag in the list or in the tag cloud.

    Click any view except Public Wikis and then expand the Tags section. Click Find a tag, and then type the tag into the field and click the wiki title when it displays. If the tag does not display, click the search icon. You can also click a tag in the list or in the tag cloud.

    How do I create wikis?

    You can create a wiki from any Wikis view after you log in to IBM Connections. See the Communities wiki help for information on creating a wiki within a community.

    1. Click Start a Wiki.

    2. Type a wiki name.

    3. Optional: Type tags, separated by spaces, to associate with the wiki. You can also add tags after creating the wiki.

    4. In the Read access section select one of the following:

      • All users: Everyone can read the wiki, including people who have not logged in.

      • Wiki members only: Only people you make members can read the wiki.

    5. In the Edit access section select one of the following:

      • All logged in users: Everyone who logs in can edit the wiki.

      • Wiki editors and owners only: Only people you have granted editor or owner access.

    6. Optional: In the Members section do the following:

      1. Select one of these roles:

        • Editor: Editors can read, edit, comment, create, tag, and recommend pages.

        • Reader: Readers can read, comment, and recommend pages.

        • Owner: Owners can read, edit, comment, create, tag, recommend, and delete pages, tag the wiki, and change the wiki description.

      2. Set the name of a person, and then select the name.

        Click the x next to names to remove access.

      If you choose not to add members here, you can add them after you create the wiki. See the topic How do I manage wiki members and access?

    7. Optional: Click Add groups and then do the following:

      1. Select one of these roles:

        • Editor: Editors can read, edit, comment, create, and recommend pages.

        • Reader: Readers can read, comment, and recommend pages.

        • Owner: Owners can read, edit, comment, create, recommend, and delete pages, tag the wiki, and change the wiki description.

      2. Set the name of a group, and then select the name.

        Click the x next to names to remove access.

      If you choose not to add groups here, you can add them after you create the wiki. See How do I manage wiki members and access?

    8. Optional: Type a description of the wiki. The description displays in wiki lists.

    9. Click Save.


    What to do next

    An administrator sets a limit on the size of wikis. Wiki owners and editors can see a wiki's size limit and how much is currently used by clicking Index, where size limit and use are displayed at the bottom of the list of pages. Size and use are visible by clicking Wiki Actions > Edit Wiki.

    To delete a wiki, open it and click Wiki Actions > Delete Wiki.

    How do I find wiki pages?

    There are several ways to find pages in a wiki.

    1. Open the wiki.

    2. Do any of the following to find pages:

      Option Description

      To find a page in the page hierarchy

      Expand and click pages in the navigation box.

      To find a page using a tag

      Open a wiki, and then click a tag in the cloud or list in the Tags filter. Or click Find a tag, and then type the tag into the field and select it when it displays.

      To search for pages

      Do any of the following to search for pages:

      • To search for pages in a wiki, open the wiki and select This Wiki in the search menu, then type text in the field and click the search icon.

      • To search for pages in all public wikis, select Public Wikis in the search menu, then type text in the field and click the search icon.

      • To search for pages in all of your wikis, select My Wikis in the search menu, then type text in the field and click the search icon.

      • To search for all public wikis and your wikis, select All Wikis in the search menu, then type text in the field and click the search icon.

      To find pages by title

      Click Index. Expand the Pages section and click Go to Page. Type text and click the search icon to search for pages containing that text.

      • Click I Edited to find pages you edited.

      • Click Edited by..., start typing a name or email address, and then select that name or email address to find pages edited by that person.

      To find pages you edited

      Click Index. Expand the Pages section and click I Edited.

      To find pages a particular member edited

      Click Index. Expand the Pages section and click Edited by.... Start typing a name or email address, and then select that name or email address.

      To find pages by date created

      Click Index. Expand the Date section and click a time period to show pages created or updated during that period.

    How do I edit other people's pages?

    You must have at least Editor access to the wiki to edit other people's pages. If you only have Reader access you can ask the owner or a member with Owner access to give you Editor access.

    To edit pages, open the page and click Edit. Edit the content in the Rich Text tab, HTML Source tab, or Wiki Text tab. The rich-text editor is straightforward, what you see is what you get. You must know HTML to use the HTML editor. The wiki text editor uses standard wiki syntax called WikiCreole. See the Wiki markup guide in the Wiki Text tab for supported syntax.


    Results

    After you edit a page and save it, your changes are saved as a version of the page. To see versions of a page, open the page and click Versions at the bottom.

    Membership and access to community wikis is managed in the community. There is a direct mapping between membership roles in the community and the wiki. Community owners can edit wiki settings and delete the wiki. Community members can create and edit pages in the wiki. Users who are not members of the community can only read the wiki content. See the Communities wiki help for more information.

    How do I create pages?

    You must have at least Editor access to create a page. If you only have Reader access you can ask a member with Owner access to give you Editor access.

    An administrator sets a limit on the size of wikis. Wiki Owners and Editors can see a wiki's size limit and how much is currently used by clicking Index, expanding the Pages section, and then clicking either I Edited or Edited by. Size limit and use are displayed at the bottom of the list of pages.

    To create pages in a community wiki you must be a member of the community. Membership and access is managed in the community. Community owners can edit and delete Community wikis from Communities. Community members can create and edit pages in the wiki. Users who are not members of the community can only read the wiki content. See the Communities wiki help for more information.

    1. Open a page on the level at which you want to create your new page.

    2. Do any of the following:

      • Right-click on a page in the navigation box and click Create Child or Create Peer.

      • Click Page Actions > Create Peer to create a page at the same level as the current page.

      • Click Page Actions > Create Child to create a page one level below the current page.

      • In the navigation tree, click New Page to create a page at the top level in the wiki.


    What to do next

    Edit page content in the Rich Text tab, HTML Source tab, or Wiki Text tab. The rich-text editor is straightforward, what you see is what you get. You must know HTML to use the HTML editor. The wiki text editor uses standard wiki syntax called WikiCreole. See the Wiki markup guide in the Wiki Text tab for supported syntax.

    To add attachments, click the Attachments tab and click Add an attachment.

    To delete the page, click Page Actions > Delete Page.

    Use the rich text editor in Wikis

    Use the rich text editor to create visually interesting blog posts, wiki articles, forum topics, and activity entries. The rich text editor is also used in profiles.

    The rich text editor allows you to enter and format text and insert images and links to create entries in various IBM Connections applications. Many of the features are common text editing features, however some may not be available depending on the application that you are using and how it is configured. For example, if you are creating a blog entry, you can insert an Adobe Flash demo, but this feature is not available in a forum topic. Hover over an icon for a label describing the feature represented by the item. The following table describes some of the more advanced features available in the editor.

    You can run browser spell check (when available) on words in the editor by selecting the words, and then simultaneously pressing Ctrl and right-clicking.

    Icon Feature description

    Paste content. The Paste menu item provides a way of pasting content if your browser security prevents you from pasting content from the clipboard. The Paste as plain text menu item provides a way of removing formatting from the pasted content and then inserting it into the document. In both cases, use the keyboard to paste the content into the dialog and then click OK to insert it into the page.

    Insert a new table. Specify columns, rows, and other table properties.

    Tip:

    • You can resize columns by dragging the column borders, by using the Column > Column Width context menu item or by resizing a cell in the column using the Cell -> Cell Properties context menu option.

    • Use table headers to help keep the table organized.

    • Set table width to 99 percent to fill the page.

    • To delete a table, right-click it, and select Delete Table.

    Insert an image. You can browse for an image on your computer, select an image that you have already uploaded, or enter a URL for an image on the web.

    This functionality differs across Connections applications. It is not possible to upload an image from your computer or use an image that has already been uploaded in Activities, Profiles, or Forums. These extra abilities are only supported in Wikis and Blogs.

    Insert or edit a link. You can link to a URL, a wiki page, or an attachment.

    This functionality differs across components. It is only possible to link to a wiki page or attachment in Wikis but is not supported in Activities, Blogs, Profiles, or Forums.

    Insert a Document Bookmark. This acts as a marker in your document that you can link to from another location in the document using the Document Bookmark Link toolbar icon.

    Insert a link to a Document Bookmark that is already available in the document. This is useful for page navigation.

    Insert an iFrame, or edit an existing iFrame.

    Insert an Adobe Flash demo. Users can view the flash demo in the blog entry or wiki page. Set the following properties for the demo:

    URL

    A URL to a Flash movie file, usually with file type of .swf

    Width

    The width of the embedded Flash movie, measured in pixels

    Height

    The height of the embedded Flash movie, measured in pixels

    Horizontal space

    The space to the left and right of the embedded Flash movie, measured in pixels

    Vertical space

    The space above and below the embedded Flash movie, measured in pixels

    Preview

    If the URL is valid, the Flash movie is displayed here.

    Insert a page break to control the layout of your posting.

    Insert a line break to control how your text is formatted.

    Insert special characters and symbols, such as currency symbols.

    Insert a block quote to indent a whole section of text in a posting.

    Insert an emoticon to liven up your posts with small graphics that convey feelings.

    Display the formatting in the post, entry, or topic that you are editing.

    Remove formatting that has been applied to text, such as fonts, colors, bold, or italics.


    Add a video to your wiki page

    You can embed a video in a wiki page. To add a link to a video or demo to a wiki page you can link directly to a Flash demo if you have the URL for the video file. A Flash demo usually has a *.swf file extension. If you are linking to an embedded video, such as a video in a YouTube page, you must copy the information for embedding the video and paste it into the HTML page of the rich text editor.

    1. Create a wiki page.

    2. To insert a Flash video, do the following:

      1. Click the Flash icon on the toolbar of the rich text editor.

      2. Enter the URL for the Flash demo.

      3. Optional: Override the default display settings by entering values in pixels for the width and height, as well as how much vertical space to display above and below the video.

      4. Optional: Click Preview to see how the video will appear in the blog entry.

    3. To embed a video, such as video from a YouTube page, do the following:

      1. Copy the <embed> object information for the video you want to use and paste it into the editor.

        Many video sharing websites now provide iframe code for videos by default. It is usually still possible to get the old embed code although, for example on YouTube, you can do this by checking the Use old embed code option. Both iframes and old embed code can be pasted directly into the rich text editor. To embed a video from YouTube, click Share > Embed Copy the contents of the textfield and paste it directly into the editor without switching to source view. The rich text editor automatically detects that this is an iframe and will insert an iframe object in the editor. If the old embed code is used instead, the editor will automatically detect that this is a flash video and a flash object will be inserted in the editor. Once the page is saved, the video contents can be viewed within the page.

        If you are inserting an example of the video markup, it is important that you paste it directly as it appears in the video sharing website. Do not add any newlines, spacing, and so on; otherwise the automatic detection feature in the editor might not get triggered. Examples of video markup that will be automatically detected are: 

        <iframe height="315" src="http://www.youtube.com/embed/-mcbsrAXlAg" frameborder="0" allowfullscreen></iframe>
        Or: 

        <object height="315"><param name="movie" value="http://www.youtube.com/v/-mcbsrAXlAg?version=3&amp;hl=en_US"></param><param name="allowFullScreen" value="true"></param><param name="allowscriptaccess" value="always"></param><embed src="http://www.youtube.com/v/-mcbsrAXlAg?version=3&amp;hl=en_US" type="application/x-shockwave-flash" height="315" allowscriptaccess="always" allowfullscreen="true"></embed></object>
        If you try to paste video content into the rich text editor and it is not automatically converted into a flash video or iframe, try pasting the video sample into Notepad or some other plain text editor, and then copy it from there into the rich text editor. All samples pasted directly from the Share feature in YouTube, Vimeo, and such will work as is.

      2. Optional: Add any other text you want to display in the entry.

    4. Save the entry.


    What to do next

    When users view this page they can view the embedded video.

    How do I manage wiki members and access?

    When you create a wiki, you are its owner. You can control who can read, edit, and manage the wiki as an Owner.

    Make sure you are an owner of the wiki.

    Membership and access to community wikis is managed in the community. There is a direct mapping between membership roles in the community and the wiki. Community owners can edit wiki settings and delete the wiki. Community members can create and edit pages in the wiki. Users who are not members of the community can only read the wiki content. See the Communities wiki help for more information.

    1. Open the wiki.

    2. In the navigation box click Members and then do any of the following:

      Option Description
      To see members listed by role

      Expand the Roles section and click Reader, Editor, or Owner.

      To see members listed by kind

      Expand the Kind section and click Person or Group.

      To add new members

      1. Click Add Members.

      2. Select a role.

      3. Start typing a name, and then select the person.

      4. Click Add group to add a group.

      5. Start typing a name, and then select the group.

      6. Click OK.

      To remove members

      1. Check boxes beside members.

      2. Click Remove Members.

      To manage access

      1. Click Manage access.

      2. Below Read access select one of the following:

        • All users: Everyone can read the wiki, including people who have not logged in.

        • Wiki member only: Only people you make members can read the wiki.

      3. Below Edit access select one of the following:

        • All logged in users: Everyone who logs in can edit the wiki.

        • Wiki editors and managers only: Only people you have granted editor or manager access.

    How do I recommend pages?

    You can recommend wiki pages by liking them. You can also see how many times a page has been liked, and who liked it.

    You must be logged in to IBM Connections and at least have Reader access to like another member's page.

    To like a page, open the page, hover over the star icon below the title, and then click either No likes (if no one has liked it) or Like this page. To remove your recommendation, hover over the star icon again, and then click Undo. See the number of times a page was liked by clicking Index. The number of times a page was liked is displayed in each row.

    How do I comment on pages?

    You must be logged in, and have at least Reader access to comment on another member's page.

    1. To comment on a page, open the page and click Comments at the bottom.

    2. Click Add a comment.

    3. Type your comment.

    4. Click Save.

    5. To edit a comment click Edit.

    6. To delete comment click the x.

    What happens to the original content when a page is edited?

    When you create a page, an initial version is created. Your original work is saved in that first version of the page until you delete the page.

    Each time a member edits the page, a new version of the page is created. You can see version information, from newest to oldest, including version number, when it was edited, the person who made the edits, and a link to view the version. If you own a page, or have Editor or Owner access to it, you can restore a previous version as the current version. Owners can delete versions older than a specified version.

    To see versions of a page, open the page and click Versions.

    What can I do with tags in Wikis?

    Tags are keywords that you assign to wikis and pages that make them easier to find later. You can find wikis and pages by clicking tags that have been assigned to them.

    You must be an owner or have Owner access to add or remove tags in a wiki. You must have at least Editor access to add or remove tags in a page.


    Option Description

    To add tags to a wiki

    1. Open the wiki.

    2. Click Wiki Actions > Edit Wiki.

    3. In the Tags field, type tags separated by a space.

    4. Click Save.

    Add tags or Add or remove tags are also available in lists of wikis when you click More.

    To remove tags from a wiki

    1. Open the wiki.

    2. Click Wiki Actions > Edit Wiki.

    3. In the Tags field, delete tags.

    4. Click Save.

    Add tags or Add or remove tags are also available in lists of wikis when you click More.

    To add tags to a page

    1. Open the page.

    2. Click Add tags (if none have been added yet) or Add or remove tags (if some have been added).

    3. Type tags separated by a space.

    To remove tags from a page

    1. Open the page.

    2. Click Add or remove tags.

    3. Click the x next to tags to remove them.

    To find public wikis using a tag

    1. Click Public Wikis.

    2. Expand the Public Tags section.

    3. Click the tag in the list. Or click Find a tag, and then type the tag into the field and click the tag when it displays.

    To find your wikis using a tag

    1. Click I'm an Owner, I'm an Editor, or I'm a Reader.

    2. Expand the Tags section.

    3. Click the tag in the list. Or click Find a tag, and then type the tag into the field and click the tag when it displays.

    To find pages using a tag

    1. Open a wiki.

    2. Expand the Tags section.

    3. Click the tag in the list. Or click Find a tag, and then type the tag into the field and click the tag when it displays.

    To search for wikis or pages using tags

    Perform a search on a tag.

    To narrow search results using a tag

    Perform a search. Then expand the Tags section and click a tag to return search results with that tag.

    How do I track wiki and wiki page changes?

    Follow wikis and wiki pages to get updates in your home page and by email. Subscribe to Atom feeds of pages, comments, versions, attachments, members, and most lists to get updates in your browser or feed reader.

    You are always notified when your wiki access changes. When you follow a wiki you are notified when a page in the wiki is created, updated, or deleted, or when a tag, recommendation, or comment is added to a page. When you follow a wiki page you are notified when the page is updated or deleted, or when a tag, recommendation, or comment is added. When you follow a wiki or wiki page, notifications are sent to your home page. You can also choose to receive updates by email in your email settings. See Set email notification preferences.

    In addition to being able to follow content, pages, comments, versions, attachments, members, and most lists in Wikis (such as the list of wikis you own, or public wikis) provide feed links. With a standalone feed reader or newer web browsers you can subscribe to those feed links. Your feed reader shows changes when they occur.

    Feeds reflect lists as they display when you click the feed link, filters and sort options included. For example, if you filter a list with a "birds" tag and sort by name in ascending order, clicking the feed link creates a feed of wikis tagged with "birds" and sorted by name in ascending order. See Subscribing to a feed.

    Perform any of the following tasks to track changes:

    Task Description

    To follow a page

    Open the page and click Following Actions > Follow this Page. Click Stop Following this Page to stop receiving notifications.

    To follow a wiki

    Open the wiki and click Following Actions > Follow this Wiki. Click Stop Following this Wiki to stop receiving notifications.

    To navigate wikis you are following, click I'm Following.

    To subscribe to a wiki page feed

    Open the page and at the bottom click Subscribe to this page.

    Your feed reader is sent updates on edits or new comments, versions, or attachments.

    To subscribe to a wiki list feed

    Open the list and at the bottom click Subscribe to [list]. For example, clickPublic Wikis and then click Subscribe to public wikis.

    Your feed reader is sent updates on list additions and removals.

    To subscribe to a wiki page data feed

    Open a wiki page and at the bottom click the Comments and then click Subscribe to these comments, click the Versions tab and then click Subscribe to these page versions, or click the Attachments tab and then click Subscribe to these attachments.

    Your feed reader is sent updates on changes or new content.

    To subscribe to a wiki members feed

    Open a wiki and click Members. At the bottom of the page click Subscribe to these members.

    Your feed reader is sent updates on changes to the access of any member.

    How does trash work in wikis?

    Pages can be removed from a wiki by moving them to the trash. From the trash, pages can be deleted or restored to the wiki. Your wiki access determines what you can do with trash.

    Owners of a wiki can move any wiki page to the trash. They can permanently delete pages from trash, or restore them to the wiki.

    Editors of a wiki can move their pages (pages they created) to the trash. They can permanently delete their pages from trash, or restore their pages to the wiki.

    Readers of a wiki can see the trash. But they cannot move pages to the trash, or delete or restore pages once they're in the trash. If there is a page in trash that they think should be restored, they can see the page owner in the list, contact them, and ask them to restore it. In public wikis, everyone has the same access as Readers do.

    1. Log in to Wikis.

    2. Open a wiki page.

    3. Click Page Actions > Move to Trash.

    4. Click Trash in the navigation panel.

    5. Choose either of the following options:

      • To restore pages select them, and then click Restore. Restoring pages restores them under the parent if it exists, and does not preserve the order. If the parent does not exist, they are restored to the top level.

      • To permanently delete pages select them, and then click Delete.

      You can select wiki pages on different pages in the trash. For example select wikis pages, then navigate to the next page in the trash, then select more wiki pages. The wiki pages on the first page remain selected.

    6. To permanently delete all pages in the trash, click Empty Trash.

    Subscribe to a Wikis feed

    Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest and automatically delivers any updates to you.

    You must have a feed reader installed on your computer that supports Atom feeds. Atom is an XML-based file format that is used to syndicate web content, such as news headlines, blogs, or websites. Atom feeds perform the same function as rich site summary (RSS) feeds, but do so using an alternative method.

    Subscribe to a feed simplifies the task of monitoring the activity taking place in IBM Connections because your feed reader automatically checks for and retrieves content updates for each feed.

    Do not confuse this application with the Feeds application in the Communities application. The Feeds application in Communities functions as a mini feed reader; it enables community members to have updates from external websites published to the community page. See Working with feeds for more information.

    1. Go to the page with the content to subscribe to.

      For example, filter the bookmarks list to display a set of bookmarks associated with a person, a tag, or with some other selection criteria.

    2. Find the Feed icon . Click the feed link to subscribe to the currently displayed content.

      Blogs only: You can hover on the feed link to select whether to create the feed in a community or in the web browser.

    3. Add the feed to your preferred feed reader. The steps that complete to do so vary depending on the web browser and feed reader that you are using. See the web browser or feed reader documentation for details.

      Communities only: When specifying the web address of the feed, you can enter a parameter to specify a different page size for the feed. By default, feeds in Communities display 10 entries per page. Specify a different page size using the ps parameter. The first page of 10 entries is fetched by default. However, you can use the page parameter to fetch subsequent pages. For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20. By subscribing to the Activities feed of a specific community, you can get a good list of the things going on in your community.

    Add profile types

    Profile types can be used to configure the layout of the main Profiles page and the layout of the widgets used in Profiles.

    IBM Connections supports multiple attribute layouts based on different profile types. In addition to different attribute layouts, custom extension attributes are also supported for every profile type.

    Because all profiles share one schema, an extension attribute, such as customers, has the same semantic meaning for all profile types. However, you can choose to associate a particular attribute with a profile based on profile type. The user interface configuration, including display characteristics and whether an attribute can be edited, is also configurable for custom extension attributes based on profile type.

    The following applications can be associated with a profile type:

    • Attributes and attribute layout

    • Custom extension attributes and custom extension attribute layout

    • Search results layout

    • Business card layout

    • ATOM API attributes

    • Widgets and widget layout

      For more information on adding widgets to Profiles, see Add custom widgets to Profiles.

    To enable multiple profile types, add the following line to the IBM Tivoli® Directory Integrator map_dbrepos_from_source.properties file before population or synchronization: 

    profileType=LDAP field or function
    If you do not add this line to the file, the default profile type is used.

    For more information about mapping LDAP properties, see Mapping fields manually.

    When configuring profile types for the layout of Profiles, you make the configuration changes in the profiles-config.xml file. To add profile types for widget layout, you make the configuration changes in the widgets-config.xml file.


    Related

  • Configure features by profile type

    Customize Profiles

    Customize the Profiles application to define the core data model for people within your deployment and tailor the presentation of profile content to meet your organization.s requirements.

    Use this section of the product documentation to deploy a unique Profiles model for your organizations IBM Connections users.


    Related

  • Administer Profiles

    Get News repository feeds

    Use the Atom subscription API to retrieve resources from the latest updates made to all of the installed applications and displayed in the Home page.

    Profiles Administration API

    Use the Profiles Administration API to make updates to user data.

    Administrators can use the Profiles Administration API to make updates to user data in the Profiles membership tables. This functionality mirrors the tasks you can perform using Tivoli Directory Integrator (TDI) and is provided as an alternative for those who do not want to use TDI.

    Only people listed in the administrator role for the Profiles application can access and use the Profiles Administration API. See Roles to find out how to get added to the administrative user role.

    The only supported methods for writing data to or modifying data in the Profiles database are by using this Profiles Atom administrative API, using the supplied Profiles TDI assembly lines, or by developing custom assembly lines using the connectors. Writing directly to the database, including using TDI database connectors to do so, is not supported and can lead to unforeseen consequences including data loss and application malfunction.


    Related

  • Manage user data using the Profiles Administration APIs

  • Administer community content

  • Administer application content

    Use advanced search options

    Use advanced search options to control the scope of your search from any of the applications in IBM Connections.

    When performing an advanced search, you can search for single terms, such as test or hello, or phrases, such as "test search" or "hello world".

    To search for a phrase, you must enclose the phrase in double quotation marks (").

    You can further refine the scope of your search by combining search terms with Boolean operators to create a more complex query. You can also perform wildcard searches and fuzzy searches, and group search terms using parentheses to form sub-queries. Search is not case-sensitive: uppercase and lowercase characters are equivalent.

    When you perform an advanced search, your query is analyzed to return the optimum results. As part of the operation, the Search application performs a linguistic analysis to ensure that different word forms, such as plurals, verb endings, and grammatical tenses, are matched correctly in the search results. For example, when you search for the term goose, you might expect to get results that contain the term geese. Similarly, when you search for the term run, you might expect to get results that include the terms ran or running. Search engines refer to this functionality as stemming. However, IBM Connections uses a different approach, which is based on dictionaries rather than stemming.


    Wildcard searches

    A wildcard is a character that can be used to represent one or more other characters in a search term. Search supports single and multiple character wildcard searches within single terms, but not in phrases. You cannot use the question mark (?) or asterisk (*) wildcards as the first character of a search string.

    • Single character wildcard searches

      To perform a single character wildcard search, use the question mark (?). The Search application looks for terms that match when the single character is replaced by another character.

      For example, if you enter te?t as a search string, the results might include information containing the terms text and test.

    • Multiple character wildcard searches

      To perform a multiple character wildcard search, use the asterisk (*). This type of search looks for zero or more characters.

      For example, if you enter test* as a search string, the results might include information containing the terms test, tests, and tester.


    Search operators

    Use the following operators to control the scope of your search.

    Table 64. Advanced search operators

    Operator Description
    OR Use the OR operator between two words to search for content that contains either word.

    For example, if you enter car or motorcycle, Search returns information that contains either car or motorcycle.

    AND Use the AND operator to search for content where both terms exist anywhere in the text of a single document. By default, a space between keywords is treated as an AND operation.

    The double ampersand (&&) operator can be used as a synonym for the AND operator.

    For example, to search for information containing the text car and motorcycle enter the following query:

    "car" AND "motorcycle"

    + Use the plus sign (+) to combine search words. The plus sign operator is similar to the AND operator, but it applies only to the word immediately following it.

    For example, to search for information that must contain car and can contain motorcycle, enter the following query:

    +car motorcycle

    NOT Use the NOT operator to exclude a word from your search. Results containing the word immediately following the operator are excluded by the search.

    The exclamation point (!) and minus sign (-) can be used as synonyms for the NOT operator.

    For example, to search for information that contains car but not motorcycle, enter one of the following queries:

    • car NOT motorcycle

    • car -motorcycle

    Use the NOT operator, exclamation point (!), or minus sign (-) with a single term returns no results.


    Grouping

    Use parentheses to group search terms in clauses and further refine the scope of your search.

    For example, if you want to search for information that contains plane and car or plane and motorcycle, enter the following query:

    (car OR motorcycle) AND plane


    Special characters

    When your search term contains one of the nonalphanumeric characters listed below, you need to escape the character by using a backslash ( \ ) before the character or by enclosing the search term in double quotation marks ("). Use a backslash before using any of these characters:

    + - && || ! ( ) { } [ ] ^ " ~ * ? : \ If you do not perform this escape operation, Search interprets the characters as being part of the query instructions.

    For example, if you want to search for information that contains the text string cat + dog and you enter cat + dog as your search term, Search looks for any data that contains both the word cat and the word dog. This result is because the plus sign (+) is a reserved operator with a predefined meaning. To search for information containing the actual text string cat + dog, use one of the following queries:

    • cat \+ dog

    • "cat + dog"

    Locking forums and forum topics

    You can lock a forum when you want to prevent users from contributing to the forum or making updates to existing posts. If you do not want to lock an entire forum, you can control access at topic level by locking forum topics.

    You must be the Forums administrator or the forum owner to lock a stand-alone forum or a topic in a stand-alone forum. To lock a community forum or community forum topic, you must be a community owner or the Forums administrator.

    Manage forums

    When you are a forum owner, you can edit, delete, and lock or unlock a forum. In addition, you can pin forum topics so they appear first in a forum. The Forums administrator can also perform these tasks.

    Forum moderation

    When moderation is enabled for Forums, the content that users add to forums does not display until it is approved by a designated moderator.

    The moderator for Forums can review and manage forum topics before they are published and review forum topics that are already available. In addition, when forum content is flagged as inappropriate by forum users, a notification is sent to the moderator, who can then review the content and decide what action to take.

    Your IBM Connections administrator can specify whether moderation is managed by global moderators or by content owners. Users assigned the global moderator role can view and manage stand-alone forum content and community forum content from a centralized moderation interface that is available only to them. When owner moderation is enabled, community owners can moderate community forum content from the community moderation interface. For more information about moderating community forum content, see Moderating community content.

    Owners of stand-alone forums must use the Forums moderation API to moderate forum content. For more information, see Moderating forum content programmatically.

    Posting questions and answers to a forum

    When you need a solution for a specific problem, posting a question to a forum can be a useful way to find help. Forum members can suggest answers, which you can accept or reject.

    Posting questions and answers to a forum is also a great way to share the answers to common questions that you know forum users might have. Formatting information in a question-and-answer format provides a way to share basic information in an easy-to-read layout.

    Question topics that have not been answered are displayed on the Open Questions tab on the My Forums page, making it easy for you to see which questions require attention. You can view resolved questions using the Answered Questions tab.

    What are Forums?

    A forum is an online discussion board where people can ask questions, share their experiences, and discuss topics of common interest.

    Use the Forums application to start discussions about a specific topic or debate solutions to shared problems. By participating in a forum, you can exchange ideas, ask questions, and leverage the expertise of other people in your organization.

    To join in a Forums discussion by starting or responding to Forums topics, you must first be enabled to use mail-in capabilities.

    Forums can be stand-alone or they can be associated with a community. Anyone can post a topic or respond to a topic in a stand-alone forum, but you must be a community member to participate in a community forum.

    When you are logged in and you open the Forums application, you are automatically brought to the My Forums page. This page is empty at first but, as you start to participate in forums, you can use the page to stay up-to-date with the forums that you own, the community forums that you belong to, and the forums that you are following.

    If you are new to Forums, use the Public Forums page as your entry point to participating in forums. If you cannot find an ongoing discussion that targets your focus area, why not start your own forum? Forums are an excellent way to create social connections and a sense of community, and can help you to cultivate an interest group about a particular subject.

    What's new in Forums?

    This release contains features designed to make forums easier for you to use to share information and collaborate with others.

    The following feature is new for Forums in IBM Connections 4.

    • When a user is notified by email that someone has added a topic to a forum, the user can click a Reply to this topic link in the email. This creates a response email the user can add content to and send. This create a new forum topic as a response to the topic they were notified about in the email. Attachments in the email are added to the response topic.

    • You can add content from any web page or IBM Connections source to a forum topic by clicking a button in your browser tool bar. Click Bookmark or Discuss This, and then follow the steps for installing the Discuss This button. Then navigate to any web or IBM Connections page, click Discuss This, and select a forum to post the content to.

    Get started with IBM Connections

    Use the Get Started view when you are a new or inexperienced user and you want to familiarize yourself with the different applications in IBM Connections.

    When you select Home from the product navigation, you are brought to the Get Started view by default. Use the numbered steps as a guide to help you get started with using each application. Discover how to add new content, find resources that are relevant to you, collaborate with colleagues, and build up a network of connections. Your administrator can customize the getting started experience to meet the needs of your organization by editing the content of the steps, and by adding or removing steps.

    As you become more familiar with IBM Connections, you can close the Get Started view by selecting the Do not show this screen at start check box. When you select this option, you are automatically brought to the Updates view the next time that you open the Home page. You can bookmark the page views that you visit most so that you can navigate directly to them later.

    What is the Home page?

    The Home page delivers an aggregated view of your latest updates across all the IBM Connections applications. Depending on your preference, you can view the updates in list format using the activity stream views, or in widget format using the My Page view.

    The Home page makes it easy for you to share information and collaborate with others by providing an always-current snapshot view of your IBM Connections applications in a single, centralized location.

    By consolidating the latest information from your IBM Connections applications in a one-stop workspace, the Home page helps you stay up-to-date with the people and activities in your organization and fully leverage the benefits of a collaborative working environment.


    Manage centrally

    Want to save time by accessing critical status information in one place? Use the Home page to organize your workload from a centralized workspace and maximize your work efficiency. Get reminders for whichever of your activities are due and prioritize what's most important to you.


    Access information at a glance

    Use the activity stream views to stay informed and quickly filter through the latest updates for the projects and activities that you're working on. Find out who has added content to a blog or created a wiki. Check the status of people in your network and view responses to posts. Click an update to view additional information about it and access more options for working with it. With the update details open, you can comment on your colleagues' status updates or click Like to recommend an update to others. Or you might want to preview an image or download a file to work on it locally.


    Personalize your IBM Connections experience

    Use the My Page view to create a customized workspace that displays your view of the information you want in the way you want. Drag and drop widgets to arrange them as best suits you.

    Frequently asked questions about the Home page

    Lists the questions that Home page users ask most often and provides brief answers.

    What is the Home page?

    The Home page application delivers an aggregated view of the latest updates from all the IBM Connections applications. If your administrator has enabled it, the Home page also delivers updates from third-party applications. You can filter the list of updates using the different views available.

    Can I set one of the views as my default view?

    No, but the views have different URLs, so you can bookmark your favorite view at any time.

    What are widgets?

    A widget is a self-contained, HTML-based representation of a software component. The My Page view uses widgets to display a snapshot view of updates from each of the IBM Connections applications. You can also add a selection of widgets to the side column in the activity stream views.

    What can I do with IBM Connections widgets?

    You can stay current with updates from all of your IBM Connections applications directly from the Home page. Some widgets allow you to toggle between different views to display different types of information.

    What widgets can I add to my Home page?

    You can add widgets for each of the IBM Connections applications you have installed. Third-party widgets might also be available if your administrator has enabled them. You can view the widgets available for use by clicking Customize from the My Page or activity stream views.

    If I rearrange the widgets, what happens the next time I open the page?

    Whenever you add or move a widget, the next time you open the page, the widget displays in the same location. The widget also displays the same view as when you last viewed it.

    If I close a widget, does that mean that I can't use it again?

    Closing a widget returns it to the content palette. You can add the widget to the Home page again whenever you want.

    What is the limit of the number of entries displayed in the activity stream views?

    There is no limit to the number of entries that you can display. The activity stream displays the full number of entries in all views, except for entries that are 30 days or older. The length of time after which entries are purged is set to 30 days by default.

    What happens to updates on the Home page when someone deletes the original content?

    When a user deletes content from IBM Connections, any updates related to the deleted content are removed, including comments or recommendations for that content. If you saved an update related to the deleted content, that update is also removed from your Saved view.

    Post-migration steps for profile types and profile policies

    After migrating to this release, manually update profiles-types.xml to ensure that all profile types referenced in either profiles-policy.xml or widgets-config.xml file are present in the migrated deployment. You may also need to manually copy your customized com.profextattr.resources.properties file after migration. If you have modified profiles-policy.xml file, manually update it again with the same changes, or copy and replace profiles-policy.xml file in this release.

    In migrating to this release, there are significant changes to profiles configuration that should be validated. In prior releases, the layout of the profile and the underlying data model was defined in profiles-config.xml. In this release, the data model for profile-type definitions has been moved into a dedicated profiles-types.xml file and the rules for presentation of a profile have been moved into a set of FreeMarker template files.

    It is important to understand how the default migration for each file works in order to best validate the results for your environment:

    • profiles-types.xml

      This file now identifies the set of properties that are associated with each profile-record based on its associated profile-type.

      A profile-type is generated based on the previous data in profiles-config.xml using the following procedure. For each apiModel previously defined, a corresponding profile-type is generated with the associated properties. Each property is marked as readwrite if it was identified as an editable attribute and each property is marked as hidden if it was identified as a hidden attribute.

      For each profileLayout previously defined, a corresponding profile-type is generated or merged with the previously processed apiModel. A property is marked as readwrite if it was an editable attribute, and it is marked as richText if it was declared as a richText attribute for rendering.

      After migration, you must update profiles-types.xml to ensure that all profile types referenced in either profiles-policy.xml or widgets-config.xml file are present in the migrated deployment.

      For more information, see Profile-types.

    • User Interface Template files

      A set of template files now control the rendering of a profile record in the user interface.

      Each template file is generated based on previous layout definitions present in the prior release profiles-config.xml file. The profileDetails.ftl file and the profileEdit.ftl file are generated using the profileLayout definitions. The searchResults.ftl file is generated using the searchResultsLayout definitions. The businessCardInfo.ftl file is generated using the businessCardLayout definitions.

      If there were multiple profile-type layouts defined, the migrated file will preserve the profile presentation, and the generated files will have a set of if-elseif-else logic to handle each migrated profile-type. If there were common renderings across profile-type layout definitions, and you had many profile-type layout definitions for a particular layout, the migrated file may appear to contain redundant content. Where possible, leverage the features of the FreeMarker template language to simplify the result of each migrated file.

      For more information, see Customize display using templates.

    • LotusConnections-config.xml

      If your Profiles customization included custom strings, ensure that your custom resource bundle is properly registered in LotusConnections-config.xml.

      For more information, see Add custom strings for widgets and other scenarios.

    To summarize, profile types in the profiles-config.xml file are migrated. However, profile types in profiles-policy.xml and widgets-config.xml files are not migrated and require manual post-migration work. For example, the widgets-config.xml file may contain profile types temp and employee. These two types would not be present in the migrated profiles-config.xml file. You must manually make the same updates again or copy profiles-policy.xml from 3.0.1 environment to replace the copy in the 4.0 environment.

    To ensure that all defined profile types are present in the migrated deployment, manually add all profile types in your profiles-policy.xml and widgets-config.xml files to the end of profiles-types.xml after migration using the following format: 

        <type>
        <parentId>default</parentId>
        <id>temp</id>
    </type>

    If you defined custom profile fields using extended attributes, the labels that display on the profile are typically defined in a file such as com.profextattr.resources.properties, which is referenced by the LCC.xml file. While the LCC.xml file is migrated, the referenced com.profextattr.resources.properties file is not. If your LCC.xml file contains references to com.profextattr.resources.properties, you must manually copy the file to the following folder structure in the new deployment: 

    .../IBM/Connections/data/shared/customization/strings/com.profextattr.resources.properties

    User profile Background samples

    See these samples to get ideas for the type of information to include for the Background tab of your profile.

    The Background section of your profile should describe your work background, experience, areas of expertise, and include some information about your interests or hobbies to keep it interesting. Use the samples below as a reference. You update this content using the About Me tab, which is available when you click Edit My Profile on your profile page.


    Product manager

    I have held a variety of roles within software development, including development, design, user research, and now product management. I am currently the product manager team lead for Renovations SocioTech, a social software tool for the retail industry. In the role of senior product manager, I work to define the overall social software strategy, develop and drive product requirements with engineering and design, work with customers and partners to shape the product, and publicize the product through demonstrations and presentations at numerous industry events.

    I came into Renovations through the Research Collaborative User Experience group as a user researcher. In my 10 years with the company, I have developed expertise in the entire Socio suite of products. I hold an MBA with a concentration in Human Factors in Information Design, and I have a strong interest in collaboration technologies and personal and business productivity tools.

    My new favorite hobby is sharing the experience of training our family puppy in my pawprints blog.


    Program manager

    I am currently responsible for the Socio brand education offerings driving revenue, development and quality worldwide.

    I have been part of Renovations Education since 2001 specializing in internet sales technology, TCP/IP, and secure transactions. I have over 20 years experience working with UNIX® systems and have been actively responsible for managing, teaching, and developing the Renovations suite education curriculum. I am the Learning profession Champion for the technology group in Europe. I am a Certified Learning Professional, and a member of the Global Learning Profession Board. I am a Chartered Member of the British Computer Society; a Fellow of the Institute of IT Training and a member Institute of Engineering and Technology. I have many Certifications including Renovations Certified Advanced Technical Expert - Socio and Renovations Certified Systems Expert (Exam developer).

    I am an amateur violinist, and am currently preparing for my first public performance with a local string quartet.

    Frequently asked questions in Profiles

    Find answers to the questions that Profiles users ask most often.

    What is Profiles?

    The Profiles application provides a directory of the people in your organization, giving you the information you need to contact them and find out about their projects, skills, and interests.

    How do I update my profile?

    Use the Edit My Profile page to update your profile. You can change your contact details, background information, and upload a new profile photo or pronunciation file using the options available on this page.

    Some profile information is automatically filled in by your administrator based on the information in your organization's personnel directory. For example, your name and the details of your report-to chain might be pulled in directly from your company directory. The administrator might also set some fields to read-only so that you cannot update them yourself. To update read-only fields, the information must be updated in the corporate personnel directory first, then the changes will be updated to your profile the next time the administrator synchronizes Profiles with the personnel directory. If you need to update information in your profile but cannot do so from the Edit My Profile page, contact your administrator or Human Resources department for assistance.

    What are tags?

    A tag is a descriptive keyword that you assign to your profile or someone else's profile to identify work activities, skills, or interests.

    How do I find people?

    You can search profiles using a simple search to find people by their contact information, such as name and job title, or use more advanced information to find people by searching on their interests, experience, and work projects. The search control is available on every page in Profiles. You can also open the Directory tab to search for people in your organization. For a more targeted directory search, use Display full search options on the Directory tab to search for data in specific fields.

    How do I build up my own network?

    After you've found the people to connect with, add them to your network to build up a set of useful contacts. When you add someone to your network, they receive an email invitation asking them to join your network, which they can accept or decline.

    I accidentally clicked Invite to My Network when viewing a colleague's profile. Can I cancel the invitation?

    There is no way to revoke a network invitation once it has been sent.

    If I ignore an invitation to join someone's network, will the person who invited me find out?

    No, if you do not accept the invitation, the person is not notified.

    Can I block someone from following me?

    No, there is currently no way to prevent a person from following your profile.

    What is the difference between following someone and inviting someone to join my network?

    When you invite people to join your network, and they accept, they are added to your list of networks on the My Network page of Profiles. When you choose to follow someone, whenever the person you are following performs an action, such as posting a profile status message, adding a blog post, or commenting on or recommending something, the action is listed in the All Updates view of your Home page. When people in your network perform the same types of actions, they are not listed to your All Updates view. You must explicitly choose to follow someone if you want the person.s latest updates to be displayed in your All Updates view.

    I recently got married and want to change my name in my profile. How do I do this?

    Your administrator can set certain fields, such as your name, to be read-only. If you cannot update your name directly from Profiles, contact your administrator or Human Resources department to advise them about your name change.

    My department has been reorganized and I report to a different manager now. How do I update the information in my report-to chain?

    The information in your report-to chain is automatically added to your profile from your organization's personnel directory; it is not possible to update this information directly from Profiles. Contact your administrator or Human Resources department for assistance.

    The display of people's business cards as the cursor moves over names in views such as Directory and My Network is really distracting; is there a way to prevent that?

    Use the keyboard arrows to scroll minimizes that behavior.

    Viewing profiles

    View profiles to find contact and work-related information for people, and connect with them in different ways.

    In addition to contact details and work background, a profile provides rich, social information about a person that can help you decide if you want to connect with them. You can find out how you are related to the person, what you have in common, view their latest status updates, and keep up with what they've been doing lately in the other applications.

    You can also connect with people directly from their profile. For example, you can email them, invite them to join your network, or follow them. When Sametime awareness is enabled, the person's online status is displayed, and you can start an instant chat with them directly from their profile.

    The IBM Connections Plug-in for Sametime must be installed for this information to display.

    View a person's profile to find the following information:

    Send Email

    Click to send the profile owner an email, or simply learn their email address if it is not specified in their contact information.

    Invite to My Network

    Click to send a message to the profile owner, inviting them to join your network and begin to share information. Optionally select to also follow their status updates and message posts.

    Download vCard

    Click to download and store the profile owner's virtual business card (vCard) data. A vCard is a file that stores basic contact information following the Internet Mail Consortium specification. You can add new contacts by using your email system to import vCard files.

    Follow

    Select to have the profile owner.s status updates and message posts appear as messages on your own profile page under the Recent Updates tab.

    Recent Updates

    Click to display the latest posts to the profile owner's status and message board. This information includes the profile owner's recent status messages and comments that other users have posted to the profile owner's message area. You can control the types of posts that are displayed by clicking Filter By and making a selection.

    Contact Information

    Click to display basic information business card information, such as name and email addresses, as specified in the user.s profile page.

    Your administrator can configure IBM Connections to prevent email addresses from being displayed, in which case email addresses do not display in a person's profile or business card.

    Background

    Click to display the content that the user has specified in the About me, and optionally the Background, sections of their profile page. Typically this includes work experience, technical skills, languages spoken, and education. It may also contain personal information such as hobbies or any other information that the profile owner has created and wants to share.

    Tags

    Tags are short keywords used to identify the profile owner's skills, areas of interest, or work activities. These tags can be added by the profile owner or by another person.

    Things in Common

    This section displays items such as files and activities that you have in common with the person whose profile you are viewing. This information can help you decide if you want to connect with the person and invite them to join your network. For more information, see Using the Things in Common widget.

    You must be logged in to see content in the Things in Common widget.

    Pronunciation

    The pronunciation link is displayed if the profile owner has created an audio file and uploaded it to the profile. Click the link to play a recording of the person's name with the correct pronunciation.

    Who Connects Us?

    This section displays contacts that link you and the profile owner. Viewing information is a useful way to see how you are connected to a particular person. For more information, see Using the Who Connects Us widget

    You must be logged in to see information about the social path that exists between you and the profile owner.

    Report-to-Chain

    This area shows the profile owner's position in the organizational hierarchy, from the profile owner up to the top of the organizational chart.

    Choose one of the following options to open additional information about the people in the reporting structure:

    Table 65. Reporting structure views

    View Description
    Full Report-to Chain Opens a page that shows basic information about the people in the organizational hierarchy, from the profile owner up to the top of the organizational chart.
    Same Manager Opens a page that shows basic information about the people who also report to the profile owner's manager.
    People Managed Opens a page that shows basic information about the people that the profile owner manages.

    Network

    This area shows a selection of the people in the profile owner's network. You can click View All to display a full list of the people in the profile owner's network. You an also click a network member name or image to open their profile page.

    My Links

    This area contains external links that profile owners include as part of their profile. You can click Add Link to add links to your profile.

    Search profiles

    You can search profiles to find people by their contact information, such as name and job title, or by more advanced information, such as their interests, experience, and work projects.

    There are a number of different types of search that you can perform in Profiles:

    • Use the search control to perform a basic search based on a single search field. This control is available at the top of every page in Profiles.

    • Search for a person by name or keyword using the Profiles by Name and Profiles by Keyword options available from the search control at the top of the Profiles page. .

    • Use your company directory to perform a more targeted search based on multiple search fields. You can search the company directory from the Directory page or by selecting Directory Search from the search control at the top of the page.

    • The tag clouds on the My Profile and Directory pages allow you to search the profile tags for your profile or the entire organization. Click a tag to display a list of people with that tag and show related tags to help you refine your search.

    For all types of search, the wildcard character (*) is supported. For example, if you enterEthan * as a search string for names, the results display all profiles for people with the first name Ethan. If you enter 555* as the search string for telephone numbers, the results display all numbers beginning with 555.

    Get to know other people

    You can follow people in your organization to receive their latest updates and find out what they are working on. You can also use the social analytics widgets available in Profiles to help you get to know people better.

    The social analytics widgets, such as Who Connects Us? and Report-to-Chain areas, help you to find out what you have in common with other people, find people to add to your network, and see the social path that connects you to another person.

    Understand profile tags

    A tag is a descriptive keyword that you can assign to your profile to identify work activities, skills, or interests. For example: payroll, event-planning, human_resources. If your system administrator has enabled it, you can also assign tags to other people's profiles as well.

    Tags that you assign to your profile are displayed in the tag collection in your profile and in the organizational tag collection in the Directory page. The tag collection in your profile is called Tags. It includes only the tags that have been added to your profile by you or others, and is displayed below your profile picture. The tag collection in the Directory page is called Organization Tags. It includes the most popular tags that have been added to the profiles of everyone in your organization.


    Use the tag collection

    You can view the tags in the tag collection as a list or a cloud. Click Cloud or List at the bottom of the tag collection to switch the display. The list view shows the top 10 tags. The cloud view shows the top 50 tags and displays the most frequently used tags in a larger, bolder font. You can quickly find experts in a specific area by browsing the tag collection and clicking tags that interest you.


    Publicize your skills

    By assigning tags to your profile, you describe your skills, job role, interests, and education to others in your organization. Tags describe what you do and what you care about. When you create tags, use keywords that represent your interests or areas of expertise. Tags must be entered as a single word, or as multiple words connected with a hyphen or underscore.


    Find people

    Click one of your own profile tags to quickly find other people who share your interest or are doing similar work. People with whom you share common tags are likely to be good resources for you. You can get their contact information from their profiles and begin collaborating with them.

    Find out who has tagged you. Click the frequency number for a particular tag to display a list of the people who tagged you with that term. Click the frequency again to hide the information.


    Define your connection

    Tagging a colleague's profile can help remind you what your connection to a person is. For example, if you worked with them on a particular project, you might choose to tag them with the name of that project. When you tag someone else's profile, that tag is visible to anyone who views the profile. By tagging your own profile and other people's profiles, you make it easier for you and your colleagues to locate expertise in your organization.

    What is the Recent Updates area?

    Every user has a Recent Updates area on their profile page,

    ...where their status updates are displayed. Other users can post messages to another user.s status updates area, making it easy to communicate directly with that person within Profiles. Status updates for contacts that the profile owner follows also appear in this area enabling the profile owner and others to increase their awareness of what network contacts and community members are doing and saying.

    The recent updates area of a person's profile displays their latest status messages, helping you to keep up with what the person is doing, what they are working on, and how busy they are. You can go to people's profile pages and quickly scan listed posts to see a summary of their latest updates and updates of contacts whom they follow. The profile owner and other users can post comments in response to any update entries or messages.

    This area also displays an update message when the profile owner, or someone the profile owner follows, performs various tasks such as creating a new blog, posting a blog entry, or commenting on a blog entry.

    Your administrator can choose whether to enable or disable this feature for users in your organization. By default, it is enabled. The administrator can also configure settings to control who can post messages. For example, the administrator might choose to limit access so that only the people in a user's network can post comments to that user's message board.

    What's new in Profiles?

    Find out what is new and what changed in Profiles.

    • The The Board tab has been replaced with the Recent Updates tab on the user.s profiles page. The Recent Updates list of posts is similar to the board in that it displays status messages and responses. It also includes information about other actions performed by the profile owner, such as sharing a file or adding a post to a blog. The message posting area itself is essentially identical to the earlier version, enabling you and others to view and post messages to a user.s wall.

    • The Recent Posts tab on the Profiles page has been removed. Recent posts appear under the profile owner.s Recent Updates tab.

    • Use the Recent Updates area on your profile page to post a status message.

    • The business card has been redesigned for improved layout and access.

    • On the Invite to My Network page, the Also Follow option is enabled by default.

    • You can now accept a network invitation from the inviter's profile page.

    • The Network Contact or Pending Invitation indicator label now displays next to the person.s name on their profile page.

    • You can now accept an invitation to join a person.s network from that person.s profile page.

    What is Profiles?

    Profiles is an application that provides a directory of the people in an organization: how to contact them, and how to find out about their projects, skills, and interests. Use Profiles to facilitate collaboration by helping you to find and get in touch with the appropriate people fast.

    New employees must be added to the Profiles application by the IBM Connections administrator. Only people who are listed in the corporate directory are available in Profiles.


    Increase your visibility

    Profiles can help you to tap into the collective knowledge of the people in your organization and work collaboratively with others.

    Let people in the organization know who you are, what you do, what projects you are working on, the tools and technologies you are using, the problems you are currently trying to solve, and what you are reading or writing. Start by filling out your profile. Help people get to know you better by adding rich social information, such as your interests, hobbies, and tags that indicate your area of expertise.


    Become involved

    Discover who in the organization is working on projects like yours or finding solutions to similar problems, and what resources they are using to simplify their jobs. Find out who your co-workers are, what their interests are, what skills they have, what they are publishing or reading, and get in touch with them. See who they connect to so that you can extend your network further.


    Build your own network

    Use profiles to make useful connections. Find people with the skills and expertise you need and add them to your network. Follow people when you want to keep up with their updates but don't want to add them to your network. You can view the latest status updates from the people that you are following and the people in your network by logging in to the Home page and selecting Status Updates on the Updates tab.

    Deployment options

    Install IBM Connections in one of three deployment topologies to achieve optimum scaling, load balancing, and failover.

    A network deployment can consist of a single server that hosts all IBM Connections applications or two or more sets of clustered servers that share the workload. You must configure an additional system with WebSphere Application Server Network Deployment Manager.

    IBM Cognos Business Intelligence is an optional component in the deployment. If used, Cognos must be federated to the same Deployment Manager as the IBM Connections servers. However, Cognos servers cannot be configured within an IBM Connections cluster.

    A network deployment provides the administrator with a central management facility and it ensures that users have constant access to data. It balances the workload between servers, improves server performance, and facilitates the maintenance of performance when the number of users increases. The added reliability also requires a larger number of systems and the experienced administrative personnel who can manage them.

    When you are installing IBM Connections, you have three deployment options:

    Small deployment

    Install all IBM Connections applications on a single node in a single cluster. This option is the simplest deployment but has limited flexibility and does not allow individual applications to be scaled up. All the applications run within a single Java. Virtual Machine (JVM).

    The diagram depicts a topology with up to 8 servers. If you install the servers on shared systems, you do not need to deploy 8 separate systems.

    Figure 1. Small deployment topology 

    


    




     
    Medium deployment
    




     
    Install a subset of applications in separate clusters. IBM Connections provides three predefined
cluster names shared among all of its applications. Use this option
to distribute applications according to your usage expectations. For instance, you might anticipate higher loads for the Profiles application
and install it in its own cluster, while other applications could
be installed in a different cluster. This option allows you to maximize
the use of available hardware and system resources to suit your needs.
    Figure 2. Medium deployment topology 


    


    




     
    Large deployment
    




     
    Install each application in its own cluster. IBM Connections provides a predefined cluster
name for each application. This option provides the best performance
in terms of scalability and availability options but also requires
more system resources. In most cases, you should install the News
and Home page applications in the same cluster.
    Figure 3. Large deployment
topology 


    


    

    






     


     Notes: 


     
      


       
    •  In a multi-node cluster, configure network share directories
as shared content stores. When using NFS, use NFS v4 because NFS v3
lacks advanced locking capability. When using Microsoft SMB Protocol for file-sharing,
use the UNC file-naming convention; for example: \\machine-name\share-name.





       
    •  You can assign various combinations of applications to clusters
in many different ways, depending on your usage and expectations.
For more information, visit the IBM Connections wiki to read articles about deployment.





       
    •  The number of JVMs required for each cluster depends on the user population and workload. For failover, you must have two JVMs
per application, or two nodes for each cluster, scaled horizontally.
Horizontal scaling refers to having multiple JVMs per application
with each JVM running on a WebSphere Application Server instance. Vertical scaling refers to running multiple JVMs
for the same application on a single WebSphere Application Server instance.
Vertical scaling is not officially supported in IBM Connections. However, it is typically not
needed unless your server has several CPUs.





       
    •  For performance and security reasons, consider using a proxy server
in your deployment. 





       
    •  IBM Cognos Business Intelligence does not have
to be deployed before you install the Metrics application. Even if
you do not plan to deploy Cognos now,
you should install the Metrics application so that events are recorded
in the Metrics database for use when Cognos is
available to provide reports.





       
    •  For added security when you are planning to run 3rd party OpenSocial
gadgets, such as those from iGoogle, configure locked domains.
 Locked domains are required to isolate these gadgets from access
to your intranet and SSO information.  The basic configuration of
locked domains is as follows:


       
        


         
      •  A second top-level domain that is not in your SSO domain. For example, if you organization's SSO domain is example.com, you will
require a distinct top level domain, such as example-modules.com. 





         
      •  A wild card SSL certificate for this domain name.


      





       No additional server instances are required for the basic
configuration. See the Configuring locked domains topic
under the Installing > Post-installation
tasks > Optional post-installation tasks section for more details.



    






     Configure
single sign-on
    





     Set up single sign-on integration
between IBM Connections and
other IBM products and third-party
security products.






     
    How single
sign-on works
    


     IBM Connections uses single sign-on (SSO) to
secure the transfer of user ID and password information that is used
to authenticate with the system. With SSO, users can switch to different
applications without needing to authenticate again. 





     SSO is
automatically enabled when IBM Connections is installed on a single WebSphere Application Server profile or
when different profiles are federated into the same cell. 







     
    Server-to-server authentication
    


     SSO solutions
can inadvertently block back-end server-to-server communication. IBM Connections uses a server-to-server
authenticator to prevent internal communication being blocked by your SSO solution. The configuration settings for the authenticator are
stored in the customAuthenticator element in LotusConnections-config.xml.



     
    Related tasks
    

  •   Configure IBM Connections for SSO




     Update 3.0.1 DBs
    





     Update IBM Connections 3.0.1 DBs to version 4.0 in an existing database environment. 





     There are two methods for updating a database:
using the IBM Connections database
wizard or the SQL scripts provided with the product. 


     
    Database wizard 
    




     
    The wizard is a faster procedure and also validates the update.
For more information, see the Updating 3.0.1 DBs with
the wizard topic.
    




     
    SQL scripts
    




     
     Use the SQL scripts provided with the product, you can examine
all the commands applied to your database. For more information, see
the Updating 3.0.1 DBs manually topic.
    

    






     Perform the tasks that apply to your deployment:




    What's new in the Home page?
    

    


     Find out about the new and updated features designed to
make the Home page easier for you to use.

    The following features are new or updated for the Home page
in IBM Connections 4.
    


     
      


       
    •  The Home page user interface has been updated so that it is easier
to find information that is important to you. The Updates tab
and the Widgets tab have been replaced by a
single page with different views available from the navigation sidebar.
Use these views to filter the display and check for your latest updates
and notifications. For example, you can check the Action
Required view for items that require a response from you.
The My Notifications view now includes responses
to topics in addition to notifications that you have sent and received.
For more information about the different views, see Home page views.





       
    •  The improved microblogging
experience allows you to gather information in a meaningful
way and act on it in context. You can now attach files to your status updates,
and use hashtags to tag your updates and make them easier for other users to find. You can
repost status updates to share information with the people who are
following you, or click Like to recommend an
update. You can also preview images and download files to work on
them locally.





       
    •  The steps for following tags from
the Home page have changed.





       
    •  The Events widget helps you to keep track of upcoming community
events that you are attending and that you are following. The widget is available from the activity stream views.


    






    What are widgets?
    

    


     Widgets are self-contained, HTML-based representations
of software components. The content palette displays the widgets that
are available for you to use in the Home page.





     You can access the following types of widget from the content palette:


     
      


       
    •  IBM Connections widgets.
The widgets available from the content palette include widgets for
the IBM Connections applications
that you have installed. Use these widgets to display a snapshot view
of the latest updates for each application. The content palette also
contains social analytics widgets if your administrator has made them
available. These widgets use information from the different IBM Connections applications to
recommend content that might be relevant to you.





       
    •  Third-party widgets. When your administrator has enabled
the use of widgets from another vendor, these are displayed in the content palette along with the IBM Connections widgets that are available for use.


    






     You can access the content palette from any of the Home page views
by clicking Customize.


      For the widgets
in all the IBM Connections applications
to load properly in Microsoft Internet
Explorer, ActiveX Controls must be enabled on the Security tab.
To access the Security tab, select Tools > Internet Options > Security.





    Forums
    

    


     Share information, brainstorm ideas, and discuss topics
of common interest.






     
    New to Forums?
    Watch a video to learn more about Forums.






     
    New to this release?
    Find out what features have been added since
the last release.






     
    Use Forums
    


     
    





     Click topics in the table of contents to get help with other
tasks.





     Home page
    

    


     Get the latest news and updates from your network and the wider organization.






     
    New to the Home page?
    Watch a video to learn more about the Home page.






     
    New to this release?
    Find out what features have been added since
the last release.






     
    Use the Home page
    


     
    





     Click topics in the table of contents to get help with other
tasks.





    Directory path conventions
    





     Directory variables are abbreviations for the default installation paths for IBM AIX®, Linux, and Microsoft Windows. This topic defines the directory variable and its matching default installation directory
for each supported operating system.





     Notes: 


     
      


       
    •  The term Linux in this
documentation includes the Linux for System z® platform,
unless otherwise specified.





       
    •  Many examples of directory and file paths in this documentation
use the UNIX '/' separator
to denote AIX, Linux, and Windows path separators, even though the Windows convention is to use the '\'
separator. Where applicable, substitute the '\' separator
for the '/' separator.


    





    Table 66. Directory variable values

    Directory variable
    Default installation root




    app_server_root


     IBM WebSphere Application Server installation directory

    
    		AIX:


     /usr/IBM/WebSphere/AppServer
Linux:


     /opt/IBM/WebSphere/AppServer
Windows: 


     drive:\Program Files\IBM\WebSphere\AppServer

    ...where drive is the system drive on which the file directory is
stored. For example: C or D.



    profile_root


     WebSphere Application Server installation directory

    
    		AIX:


     /usr/IBM/WebSphere/AppServer/profiles/profile_name
Linux:


     /opt/IBM/WebSphere/AppServer/profiles/profile_name
Windows: 


     drive:\Program Files\IBM\WebSphere\AppServer\profiles\profile_name

    ...where profile_name is the name of the profile on which the application is installed
or the profile name of the deployment manager. drive is the system drive on which the file directory is stored. For example:
C or D.



    ibm_http_server_root


     IBM HTTP Server installation directory

    
    		AIX:


     /usr/IBM/HTTPServer
Linux:


     /opt/IBM/HTTPServer
Windows: 


     drive:\Program Files\IBM\HTTPServer

    ...where drive is the system drive on which the file directory is stored. For example: C or D.



    connections_root


     IBM Connections installation directory

    
    		AIX or Linux:


     /opt/IBM/Connections
Windows: 


     drive:\Program Files\IBM\Connections

    ...where drive is the system drive on which the file directory is stored. For example: C or D.



    local_data_directory_root


     Local content stores

    
    		AIX or Linux:


     /opt/IBM/Connections/data/local
Windows: 


     drive:\Program Files\IBM\Connections\data\local





     where drive is the system drive on which
the directory is stored. For example: C or D.




    shared_data_directory_root


     Shared content stores

    
    		AIX or Linux:


     /opt/IBM/Connections/data/shared
Windows: 


     drive:\Program Files\IBM\Connections\data\shared\

    ...where drive is the system drive on which the directory is stored. For example: C or D.



    IM_root


     IBM Installation Manager installation directory

    
    		AIX:


     /opt/IBM/InstallationManager
 Linux:


     /var/IBM/InstallationManager
Windows:


     drive:\Program Files
\IBM\Installation Manager

    ...where drive is the system drive on which the file directory is stored. For example:
C or D.



    shared_resources_root


     Shared
resources directory

    
    		AIX or Linux:


     /opt/IBM/SSPShared
Windows:


     drive:\Program Files\IBM\SSPShared

    ...where drive is the system drive on which the file directory is stored. For example: C or D.



    db2_root


     DB2® database installation directory

    
    		AIX or Linux:


     /usr/IBM/db2/version
Linux:


     /opt/ibm/db2/version
Windows: 


     drive:\Program Files\IBM\SQLLIB\version

    ...where drive is
the system drive on which the file directory is stored, for example:
C or D, and version is the version of DB2 installed, for example: V9.5 or V9.7.



    oracle_root


     Oracle database installation directory

    
    		AIX or Linux:


     /home/oracle/oracle/product/version/db_1
Windows: 


     drive:\oracle\product\version\db_1

    ...where version is the supported Oracle number and drive is the system drive on which the file directory is stored. For example: C
or D.



    sql_server_root


     Microsoft SQL Server database
installation directory

    
    		Windows: 


     drive:\Program Files\Microsoft
SQL Server

    ...where drive is the system
drive on which the file directory is stored, for example: C or D.



    Cognos_BI_install_path


     IBM Cognos BI Server installation directory

    
    		AIX or Linux:


     /opt/IBM/Cognos64
Windows: 


     drive:\Program Files\IBM\Cognos64

    ...where drive is the system drive on which the file
directory is stored. For example: C or D.


      You specify the installation directory in the cognos-setup.properties file
during installation.




    Cognos_Transformer_install_path


     Cognos Transformer installation directory

    
    		AIX or Linux:


     /opt/IBM/Cognos
Windows: 


     drive:\Program Files\IBM\Cognos 

    ...where drive is the system drive on which the file
directory is stored. For example: C or D.


      You can specify the installation directory in the cognos-setup.properties file during installation.




    





     Subscribe to a Files feed
    

    


     Subscribe to a feed of IBM Connections data to get updates sent to your feed reader. Using feeds prevents you from having to go to each application
or the home page to see a list of the latest updates. Instead, the feed reader monitors product areas that you indicate are of interest
and automatically delivers any updates to you.


     You must have a feed reader installed on your computer that
supports Atom feeds. Atom is an XML-based file format that is used
to syndicate web content, such as news headlines, blogs, or websites.
Atom feeds perform the same function as rich site summary (RSS) feeds,
but do so using an alternative method. 







      Subscribe to a feed simplifies
the task of monitoring the activity taking place in IBM Connections because your feed reader automatically
checks for and retrieves content updates for each feed.





     Do not confuse this application with the Feeds
application in the Communities application. The Feeds application
in Communities functions as a mini feed reader; it enables community
members to have updates from external websites published to the community
page. See Working with feeds for more information.


    


     
      


       
    1.  Go to the page with the content to subscribe
to. 


       For example, filter the bookmarks list to display
a set of bookmarks associated with a person, a tag, or with some other
selection criteria.






       
    2.  Find the Feed icon . Click the feed link to subscribe to the currently displayed content. 


       


         Blogs only:  You can hover on the feed link
to select whether to create the feed in a community or in the web
browser.







       
    3.  Add the feed to your preferred feed reader. The steps that
complete to do so vary depending on the web browser and feed
reader that you are using. See the web browser or feed reader documentation
for details. 


       


        Communities only: When specifying
the web address of the feed, you can enter a parameter to specify
a different page size for the feed. By default, feeds in Communities
display 10 entries per page. Specify a different page size using the ps parameter.
The first page of 10 entries is fetched by default. However, you can
use the page parameter to fetch subsequent pages.
For example, you might use the following web address to fetch the second page of the My Communities feed where the page size is set
to 20 entries: http://connections.example.com/communities/service/atom/communities/my?page=2&ps=20.
By subscribing to the Activities feed of a specific community, you
can get a good list of the things going on in your community.




    




    IBM Connections 4 Supporting
Documentation
    





     The following section contains information referenced by IBM Connections documentation.


     Change the media galleries J2C alias
    



     Edit the events-config.xml configuration file to change
the J2C alias that media galleries use to generate preview images.

    


     You can edit the j2calias value if you
want to change the alias that media galleries use, but the new alias
must be a valid user in your organization, and have an administrator role on the Files application.





     For information on checking out
and in the events-config.xml file, see the topic Editing events-config.xml.



    <postHandler enabled="true" invoke="ASYNC" name="PhotoRenditionEventHandler" class="com.ibm.lconn.media.renditions.PhotoRenditionEventHandler"> 
<subscriptions> 
<subscription source="FILES" type="CREATE" eventName="*"/> 
<subscription source="FILES" type="UPDATE" eventName="*"/> 
</subscriptions> 
<properties> 
<property name="j2calias">connectionsAdmin</property> 
</properties> 
</postHandler>
    



     
    Related tasks
    

  •   Edit events-config.xml




    Common parameters
    



     Lists the parameters that can be used on most subscription
API requests.

    The following parameters can be included with the input parameters
for most requests to retrieve subscription feeds. They may differ
slightly by application and by the feed being returned. See the Get
feeds sections for each application API for more information about
the parameters supported for a specific feed request.



    Table 67. Input
parameters

    Parameter
    Description




    email
    Internet email address of a user.


     Format the HTTP request using the proper URL encoding. For example, the encoded
form of the @ symbol is %40 as in:


    adam_eventide%40garden.com
    






      Do
not use this parameter if IBM Connections is configured to prevent email addresses from being displayed. Use
the userid parameter instead.




    page
    Page number. Specifies
the page to be returned. The default value is 1, which returns the first page.



    ps
    Page size. Specifies the number of entries to return per page. The default value is 10. The maximum size accepted differs by application.



    search
    Well-formed full text search query. 



    since
    Includes items updated after a specified date.
For most features, you specify the date using a date-time value that
conforms to RFC3339.  Use an upper case "T" to separate
the date and time, and an uppercase "Z" in the absence of a numeric
time zone offset. For example: 2009-01-04T20:32:31.171Z.
For Activities, Files, and Forums, you specify the date in the number
of milliseconds since January 1, 1970, 00:00:00 GMT time.



    sortBy
    Specifies what value to use as the basis for
organizing the entries returned in the feed. The options for this
parameter differ by application. They include the options described
in the list below. Not every option is supported on every request;
see the application-specific API documentation for more information.


     
    author
    




     
    Sorts the entries alphabetically by
the name of the author of the item.
    




     
    commented
    




     
    Sorts the entries by the number of
comments or replies an item has received.
    




     
    count
    




     
    Sorts the entries by the number of members
that belong to the item.
    




     
    created
    




     
    Sorts the entries by the date the item
was created.
    




     
    createdBy
    




     
    Sorts the entries alphabetically
by the name of the user who created the item.
    




     
    date
    




     
    Sorts the entries by the date on which
it was changed to its current moderation status.
    




     
    desc
    




     
    Sorts the entries alphabetically by description.
    




     
    displayName
    




     
    Sorts the entries alphabetically
by display name.
    




     
    displayOrder
    




     
    Sorts the entries in the order
chosen by the user in the pinned views in the product user interface.
    




     
    downloaded
    




     
    Sorts the entries by the number
of times the item was downloaded.
    




     
    itemCount
    




     
    Sorts the entries by the number of
items associated with the item.
    




     
    label
    




     
    Sorts alphabetically by the label.
    




     
    length
    




     
    Sorts the entries by the size of the file.
    




     
    modified
    




     
    Sorts the entries by the last modified
date.
    




     
    popularity
    




     
    Sorts the entries by how popular
the item is.
    




     
    published
    




     
    Sorts the entries by the date the item was published (usually related to atom:published element).
    




     
    recommended
    




     
    Sorts the entries by the number
of times the item was recommended.
    




     
    sharedBy
    




     
    Sorts the entries alphabetically by
the name of the person who shared the item.
    




     
    sharedWith
    




     
    Sorts the entries alphabetically
by the name of the person with whom the item was shared.
    




     
    title
    




     
    Sorts the entries alphabetically by title.
The title used is the text that is displayed in the <title> element
of each entry in the feed.
    




     
    totalMediaSize
    




     
    Sorts the entries by the size
of the media associated with the item.
    




     
    updated
    




     
    Sorts the entries by the last time
the item was updated.
    

    




    sortOrder
    
    Specifies the order
in which to sort the results. The options are: 


     
    asc
    




     
    Sorts the results in ascending order.
    




     
    desc
    




     
    Sorts the results in descending order.
    

    





    tag
    Returns items that have been assigned the specified
tag. 



    userid
    Unique ID that represents a specific person. 



    






     Download a file
    



     Download a file from your library programmatically.

    


     See Authenticating requests for information
about how to authenticate the request.


    



    Table 68. Atom API request details

    Method
    Resource address
    Output representation
    Description




    GET
    Construct the URI using the following syntax: /basic/anonymous/api/document/{document-id}/media
    binary media
    Returns a public file from your library
without authenticating the request.



    GET
    Determine the resource address in either of
the following ways:


     
      


       
    •  Value of the href attribute of the <link rel="edit-media">
element  in the file's Document Atom entries.





       
    •  Construct the address using the following URL:/basic/api/myuserlibrary/document/{document-id}/ where {document-id} is
the <td:uuid> or <td:label> element of the document entry.


    

        		binary media
    Returns a file from your library. This request
requires authentication.


      Use this URI to retrieve the binary
data if you plan to update and return it using a PUT request.




    



    


     You can use one or more of these headers.




    Table 69. Input
headers

    Parameter
    Description




    If-Modified-Since
    Used to validate the local cache of the feed
and entry documents retrieved previously. If the feed or entry has
not been modified since the specified date, HTTP response code 304
(Not Modified) is returned. 



    If-None-Match
    Contains an ETag response header sent by the server in a previous request to the same URL. If the ETag is still
valid for the specified resource, HTTP response code 304 (Not Modified)
is returned. 



    



    


     You can use one or more of these input parameters. Separate
multiple parameters with an ampersand (&).




    Table 70. Input
parameters

    Parameter
    Description




    identifier
    String. Indicates the identifier used in the document segment of the web address. Options are uuid or label.
Uses the UUID as the identifier by default.



    inline
    Specifies whether the documents contents should
be included inline in the content element. Options are true or false.



    logDownload
    Specifies whether to log this file download.
 Options are true or false. By default,
it does log the download.



    








     
    Input
    


     None.







     
    Output
    


     Binary content of the file. If active
content filtering is enabled, and the file is an HTML file, it is
filtered.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the file entry was successfully downloaded. If an error occurs, this header contains one of the error codes.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 401 Unauthorized





       
    •  HTTP/1.1 403 Forbidden





       
    •  HTTP/1.1 404 Not Found


    




     
    Related tasks
    

  •   Display files inline




     Move a stand-alone forum topic programmatically
    



     To move a forum topic from one discussion thread to another,
use the edit link found in the forum topic entry in the forum topics
feed.

    


     Before you can move a topic, complete the following tasks:


     
      


       
    1.  Retrieve a feed of forums that includes the forum you want to
move the topic to. See Get the My Forums feed. 





       
    2.  Find the entry representing the forum to which you want to move
the topic, and then make a note of the <id> element value.





       
    3.  Retrieve the Atom entry document for the forum topic that you
want to move. See Retrieve a stand-alone forum topic programmatically.





       
    4.  Edit the topic Atom entry document to reference the new forum
instead of the old forum by updating the value of the ref attribute
in the <thr:in-reply-to> element with the values you noted in a
previous step. 


      <thr:in-reply-to 
 href=<web address of the link rel="replies" element> 
 ref=<id element of new forum>
 type="application/atom+xml">    
</thr:in-reply-to>
      
For example:


      <thr:in-reply-to 
 href="https://example.com/forums/atom/topics?
  forumUuid=7cf6c58d-0f24-44bc-a18b-9ded332f40d8" 
 ref="urn:lsid:ibm.com:forum:6b4f9f8d-e979-41e3-b011-d56f4cefbf89" 
 type="application/atom+xml">    
</thr:in-reply-to>
      





        The value of the href attribute,
which continues to reference the web address of the replies link for
the old forum is automatically updated by the server to reference
the new forum after you submit the edited Atom entry document using
the PUT request.






       
    5.  Save the edited topic Atom entry document.





       
    6.  Send a PUT request to the web address specified in the href attribute
of the <link rel="edit"> element of the forum topic that you want
to move. Include the edited Atom entry document with the request.
See the Input section below for details about how to handle attachments
and so on.


    






     See Authenticating requests for information
about how to authenticate the request.





    Table 71. Atom API request details

    Method
    Resource
    URI
    Input representation




    PUT
    forum topic
    Value of the href attribute of the <link>
element that has a rel="edit" attribute value for each entry in the forum topics feed.
    forum topic



    







     
    Input
    


     Provide a forum Atom entry document.


      The content type of the Atom entry document must be application/atom+xml.



     
      


       
    •  To pin a topic, add a <category term="pinned" scheme="http://www.ibm.com/xmlns/prod/sn/flags"/>
element to the forum topic entry document that you pass in on the request. To remove a pin from a topic, remove the element from the topic entry document.





       
    •  To lock a topic, add a <category term="locked" scheme="http://www.ibm.com/xmlns/prod/sn/flags"/>
element to the forum topic entry document that you pass in on the request. To unlock a locked topic, remove the element from the topic
entry document.





       
    •  To mark a normal topic as a question, add a <category term="question"
scheme="http://www.ibm.com/xmlns/prod/sn/flags"/> element to the forum
topic entry document that you pass in on the request. To change a
question to a normal topic, remove the element from the topic entry
document.


    
 





     To add an attachment to a topic entry without any, send
the modified entry document with an attachment using a multipart PUT
request. On a successful PUT, metadata for the attachment will be
added to the entry. For example:


    <snx:field name="resume" fid="id of the attached file node" ...>
  <link href="link to the attachment" />
</snx:field>
    






     To update a topic entry that already
has file attachments, send the modified entry document with an attachment
using a multipart PUT request. On a successful PUT, metadata for the attachment will be added to the entry. For example:


    <snx:field name="resume" fid="id of the attached file node" ...>
  <link href="link to the attachment" />
</snx:field>
    
Any file snx:fields to keep
must be present in the entry document. Otherwise, they will be removed
from the entry.





     To remove an attachment, remove the snx:field
for the file from the entry document's metadata, and then send
a PUT request.







     
    Output
    


     None.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the forum topic was successfully updated. If an
error occurs, this header contains one of the error codes.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 401 Unauthorized





       
    •  HTTP/1.1 404 Not Found


    



    


     Request:


    PUT /forums/atom/topic?topicUuid=84139b22-17f0-4290-939b-73370c6ef17c HTTP/1.1
Host: www.dulcinea.com
Content-Type: application/atom+xml
Authorization: xxx
Content-Length: nnn

<entry xmlns="http://www.w3.org/2005/Atom">
    <id>urn:lsid:ibm.com:forum:84139b22-17f0-4290-939b-73370c6ef17c</id>
    <title type="text">Test topic 1</title>
    <published>2010-08-04T21:45:09.324Z</published>
    <updated>2010-08-04T21:45:09.324Z</updated>
    <author>
        <email>jdoe@literature.com</email>
        <name>Jane Doe</name>
        <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
         772A006E-0A01-8703-8525-7346003DAFD6
        </snx:userid>
        <snx:userState xmlns:snx="http://www.ibm.com/xmlns/prod/sn">active</snx:userState>
    </author>
    <link 
     href="https://www.dulcinea.com/forums/atom/topic?topicUuid=84139b22-17f0-4290-939b-73370c6ef17c" 
     rel="self" 
     type="application/atom+xml"></link>
    <link 
     href="https://www.dulcinea.com/forums/atom/topic?topicUuid=84139b22-17f0-4290-939b-73370c6ef17c" 
     rel="edit" 
     type="application/atom+xml">
    </link>
    <category term="forum-topic" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category>
    <category term="bb"></category>
    <category term="aa"></category>
    <link 
     href="https://www.dulcinea.com/forums/html/topic?id=84139b22-17f0-4290-939b-73370c6ef17c" 
     rel="alternate" 
     type="text/html">
    </link>
    <link 
     xmlns:thr="http://purl.org/syndication/thread/1.0" 
     href="https://www.dulcinea.com/forums/atom/replies?topicUuid=84139b22-17f0-4290-939b-73370c6ef17c" 
     rel="replies" 
     type="application/atom+xml" 
     thr:count="0">
    </link>
    <thr:in-reply-to 
     xmlns:thr="http://purl.org/syndication/thread/1.0" 
     href="https://www.dulcinea.com/forums/atom/topics?forumUuid=e1b8faff-afc7-4ba8-9269-05bfd592efc7" 
     ref="urn:lsid:ibm.com:forum:e1b8faff-afc7-4ba8-9269-05bfd592efc7" 
     type="application/atom+xml">
    </thr:in-reply-to>
    <content type="html">updated topic test</content>
    <snx:permissions xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
     none, create_forum, view_forum, edit_forum, del_forum, create_post, edit_personal_post, edit_all_post, 
     del_personal_post, del_all_post, pin_topic, subscribe, lock_node, add_member, delete_member, 
     create_topictag, del_all_topictag, del_personal_topictag, create_forumtag, del_all_forumtag, 
     del_personal_forumtag, view_category, edit_personal_question, edit_all_question
    </snx:permissions>
</entry>
    






     Response:


    HTTP/1.1 200 OK
    






    Retrieve the dates related to a set of search results
    



     Search IBM Connections to find all of the content that contains a specific text string in
its title, description or content, or contains information tagged
with a specific tag term, and then return the dates associated with
the results.

    



    Table 72. Atom API request details

    Resource
    Description




     /atom/search/facets/date
    Search IBM Connections for public information, and then return the dates associated with
the results.



    /atom/mysearch/facets/date
    Search IBM Connections for both public information and private information that you have
access to, and then return the dates associated with the results.
You must provide authentication information in the request to retrieve
this resource.



    



    You must specify at least one of the following parameters;
you can specify more than one. Separate multiple parameters with an
ampersand (&).



    Table 73. Input parameters

    Parameter
    Description




    component
    Limits the search results to include items from
a specific application. If you specify multiple applications, this
parameter acts as an AND operator. To specify multiple applications,
type a comma between each application name. For example, if you specify
component=dogear,activities, the results would be limited to all of
the activities that have been dogeared or all activity bookmarks that
are also dogeared. Options are: 


     
      


       
    •  activities





       
    •  blogs





       
    •  calendar





       
    •  communities





       
    •  dogear





       
    •  files





       
    •  forums





       
    •  profiles





       
    •  status_updates





       
    •  wikis


    




    components
    Limits the search results to include items from
a specific application. If you specify multiple applications, this
parameter acts as an OR operator. To specify multiple applications,
type a comma between each application name. For example, if you specify
components=dogear,activities, the results would include all items
from Activities or Bookmarks that match the search criteria. Options
are: 


     
      


       
    •  activities





       
    •  blogs





       
    •  calendar





       
    •  communities





       
    •  dogear





       
    •  files





       
    •  forums





       
    •  profiles





       
    •  status_updates





       
    •  wikis


    




    email
    Limits the results to only those items associated
with the person who has the specified email address. For example,
the person could be the author of an activity entry that is returned
or a member of the community returned.



    lang
    


     Specifies a language
in which to search for a string. This parameter is optional. When
specified, the appropriate dictionary for the specified language is
loaded. You can specify any of the following language codes:


     
    ar
    




     
    Arabic
    




     
    cs
    




     
    Czech
    




     
    da
    




     
    Danish
    




     
    de
    




     
    German
    




     
    el
    




     
    Greek
    




     
    en
    




     
    English
    




     
    es
    




     
    Spanish
    




     
    fi
    




     
    Finnish
    




     
    fr
    




     
    French
    




     
    it
    




     
    Italian
    




     
    ja
    




     
    Japanese
    




     
    ko
    




     
    Korean
    




     
    nb
    




     
    Norwegian
    




     
    nl
    




     
    Dutch
    




     
    pl
    




     
    Polish
    




     
    pt-BR
    




     
    Brazilian Portuguese
    




     
    pt-PT
    




     
    Iberian Portuguese
    




     
    ru
    




     
    Russian
    




     
    sv
    




     
    Swedish
    




     
    zh
    




     
    Chinese
    

    





      The dictionary for the language specified must
be enabled for this parameter to work. See Configuring dictionaries
for search for more details.





    query
    Text to search for. Returns a list of results
with the specified text in the title, description, or content. Encode
the strings. By default, spaces are treated as an AND operator. The following operators are supported:


     
      


       
    •  AND or &&: Searches for items that contain both words.
For example: query=red%20AND%20test returns items that contain both
the word red and the word test. AND is the default operator. 





       
    •  NOT or !: Excludes the word that follows the operator from the search. For example: query=test%20NOT%20red returns items that contain
the word test, but not the word red.





       
    •  OR: Searches for items that contain either of the words. For example:
query=test%20OR%20red





       
    •  To search for a phrase, enclose the phrase in quotation marks
(" ").





       
    •  +: The plus sign indicates that the word must be present in the result. For example: query=+test%20red returns only items that contain
the word test and many that also contain red, but none that contain
only the word red.





       
    •  ?: Use a question mark to match individual characters. For example:
query=te%3Ft returns items that contain the words test, text, tent,
and others that begin with te.





       
    •  -: The dash prohibits the return of a given word. This operator
is similar to NOT. For example: query=test%20-red returns items that
contains the word test, but not the word red.


    




    tag
    Tag to search for. Returns a list of results
with the specified tag. You can use this parameter multiple times
to search for content that is tagged with all of the tag terms.



    userid
    Limits the results to only those items associated
with the person who has the specified user ID. This parameter overwrites
the email parameter if both are specified.



    






    Retrieve the applications related to a set of search results
    



     Search IBM Connections to find all of the content that contains a specific text string in
its title, description or content, or that contains information tagged
with a specific tag term, and then return the applications related
to those search results and identify how many results were found per
application.

    



    Table 74. Atom API request details

    Resource
    Description




     /atom/search/facets/source
    Search IBM Connections for public information, and then return the applications associated
with the results and identify how many results were found per application.



    /atom/mysearch/facets/source
    Search IBM Connections for both public information and private information that you have
access to, and then return the applications associated with the results
and identify how many results were found per application. You must
provide authentication information in the request to retrieve this
resource.



    



    


     You must specify at least one of the following parameters;
you can specify more than one. Separate multiple parameters with an
ampersand (&).




    Table 75. Input parameters

    Parameter
    Description




    component
    Limits the search results to include items from
a specific application. If you specify multiple applications, this
parameter acts as an AND operator. To specify multiple applications,
type a comma between each application name. For example, if you specify
component=dogear,activities, the results would be limited to all of
the activities that have been dogeared or all activity bookmarks that
are also dogeared. Options are: 


     
      


       
    •  activities





       
    •  blogs





       
    •  calendar





       
    •  communities





       
    •  dogear





       
    •  files





       
    •  forums





       
    •  profiles





       
    •  status_updates





       
    •  wikis


    




    components
    Limits the search results to include items from
a specific application. If you specify multiple applications, this
parameter acts as an OR operator. To specify multiple applications,
type a comma between each application name. For example, if you specify
components=dogear,activities, the results would include all items
from Activities or Bookmarks that match the search criteria. Options
are: 


     
      


       
    •  activities





       
    •  blogs





       
    •  calendar





       
    •  communities





       
    •  dogear





       
    •  files





       
    •  forums





       
    •  profiles





       
    •  status_updates





       
    •  wikis


    




    email
    Limits the results to only those items associated
with the person who has the specified email address. For example,
the person could be the author of an activity entry that is returned
or a member of the community returned.



    lang
    


     Specifies a language
in which to search for a string. This parameter is optional. When
specified, the appropriate dictionary for the specified language is
loaded. You can specify any of the following language codes:


     
    ar
    




     
    Arabic
    




     
    cs
    




     
    Czech
    




     
    da
    




     
    Danish
    




     
    de
    




     
    German
    




     
    el
    




     
    Greek
    




     
    en
    




     
    English
    




     
    es
    




     
    Spanish
    




     
    fi
    




     
    Finnish
    




     
    fr
    




     
    French
    




     
    it
    




     
    Italian
    




     
    ja
    




     
    Japanese
    




     
    ko
    




     
    Korean
    




     
    nb
    




     
    Norwegian
    




     
    nl
    




     
    Dutch
    




     
    pl
    




     
    Polish
    




     
    pt-BR
    




     
    Brazilian Portuguese
    




     
    pt-PT
    




     
    Iberian Portuguese
    




     
    ru
    




     
    Russian
    




     
    sv
    




     
    Swedish
    




     
    zh
    




     
    Chinese
    

    





      The dictionary for the language specified must
be enabled for this parameter to work. See Configuring dictionaries
for search for more details.





    query
    Text to search for. Returns a list of results
with the specified text in the title, description, or content. Encode
the strings. By default, spaces are treated as an AND operator. The following operators are supported:


     
      


       
    •  AND or &&: Searches for items that contain both words.
For example: query=red%20AND%20test returns items that contain both
the word red and the word test. AND is the default operator. 





       
    •  NOT or !: Excludes the word that follows the operator from the search. For example: query=test%20NOT%20red returns items that contain
the word test, but not the word red.





       
    •  OR: Searches for items that contain either of the words. For example:
query=test%20OR%20red





       
    •  To search for a phrase, enclose the phrase in quotation marks
(" ").





       
    •  +: The plus sign indicates that the word must be present in the result. For example: query=+test%20red returns only items that contain
the word test and many that also contain red, but none that contain
only the word red.





       
    •  ?: Use a question mark to match individual characters. For example:
query=te%3Ft returns items that contain the words test, text, tent,
and others that begin with te.





       
    •  -: The dash prohibits the return of a given word. This operator
is similar to NOT. For example: query=test%20-red returns items that
contains the word test, but not the word red.


    




    tag
    Tag to search for. Returns a list of results
with the specified tag. You can use this parameter multiple times
to search for content that is tagged with all of the tag terms.



    userid
    Limits the results to only those items associated
with the person who has the specified user ID. This parameter overwrites
the email parameter if both are specified.



    




    Example
    To find out how many results of a search
across the content to which you have access for the term Red
Sox are returned in each application, send the following HTTP
request:


    > GET /search/atom/mysearch/facets/source?query=%22Red%20Sox%22 HTTP/1.1
> Authorization: Basic ...
> Host: enterprise.example.com:9443
> Accept: */*
    
The following content is returned by the server:


    <?xml version="1.0" encoding="UTF-8" ?> 
<feed 
 xmlns="http://www.w3.org/2005/Atom" 
 xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/" 
 xmlns:relevance="http://a9.com/-/opensearch/extensions/relevance/1.0/" 
 xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
  <title>"Red Sox"</title> 
  <link href="https://enterprise.example.com:9443/search/atom/mysearch/
   facets/source?query=%22Red%20Sox%22" rel="self" /> 
  <updated>2008-10-07T23:45:09Z</updated> 
  <id>https://enterprise.example.com:9443/search/atom/mysearch/facets/
   source?query=%22Red%20Sox%22</id> 
  <author>
    <name>enterprise.example.com</name> 
  </author>
  <entry>
    <title>profiles</title> 
    <updated>2008-10-07T23:45:09Z</updated> 
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/resultcount">3</snx:rank> 
    <id>https://enterprise.example.com:9443/search/atom/mysearch/facets/
     source?query=%22Red%20Sox%22&component=profiles</id> 
    <content /> 
  </entry>
  <entry>
    <title>blogs</title> 
    <updated>2008-10-07T23:45:09Z</updated> 
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/resultcount">59</snx:rank> 
    <id>https://enterprise.example.com:9443/search/atom/mysearch/facets/
     source?query=%22Red%20Sox%22&component=blogs</id> 
    <content /> 
  </entry>
  <entry>
    <title>communities</title> 
    <updated>2008-10-07T23:45:09Z</updated> 
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/resultcount">5</snx:rank> 
    <id>https://enterprise.example.com:9443/search/atom/mysearch/facets/
     source?query=%22Red%20Sox%22&component=communities</id> 
    <content /> 
  </entry>
  <entry>
    <title>dogear</title> 
    <updated>2008-10-07T23:45:09Z</updated> 
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/resultcount">11</snx:rank> 
    <id>https://enterprise.example.com:9443/search/atom/mysearch/facets/
     source?query=%22Red%20Sox%22&component=dogear</id> 
    <content /> 
  </entry>
</feed>
    





    Retrieve the people related to a set of search results
    



     Search IBM Connections to find all of the content that contains a specific text string in
its title, description or content, or contains information tagged
with a specific tag term, and then return the people associated with
the results.

    



    Table 76. Atom API request details

    Resource
    Description




     /atom/search/facets/people
    Search IBM Connections for public information, and then return the people associated with
the results.



    /atom/mysearch/facets/people
    Search IBM Connections for both public information and private information that you have
access to, and then return the people associated with the results.
You must provide authentication information in the request to retrieve
this resource.



    



    


     You must specify at least one of the following parameters;
you can specify more than one. Separate multiple parameters with an
ampersand (&).




    Table 77. Input parameters

    Parameter
    Description




    component
    Limits the search results to include items from
a specific application. If you specify multiple applications, this
parameter acts as an AND operator. To specify multiple applications,
type a comma between each application name. For example, if you specify
component=dogear,activities, the results would be limited to all of
the activities that have been dogeared or all activity bookmarks that
are also dogeared. Options are: 


     
      


       
    •  activities





       
    •  blogs





       
    •  calendar





       
    •  communities





       
    •  dogear





       
    •  files





       
    •  forums





       
    •  profiles





       
    •  status_updates





       
    •  wikis


    




    components
    Limits the search results to include items from
a specific application. If you specify multiple applications, this
parameter acts as an OR operator. To specify multiple applications,
type a comma between each application name. For example, if you specify
components=dogear,activities, the results would include all items
from Activities or Bookmarks that match the search criteria. Options
are: 


     
      


       
    •  activities





       
    •  blogs





       
    •  calendar





       
    •  communities





       
    •  dogear





       
    •  files





       
    •  forums





       
    •  profiles





       
    •  status_updates





       
    •  wikis


    




    email
    Limits the results to only those items associated
with the person who has the specified email address. For example,
the person could be the author of an activity entry that is returned
or a member of the community returned.



    lang
    


     Specifies a language
in which to search for a string. This parameter is optional. When
specified, the appropriate dictionary for the specified language is
loaded. You can specify any of the following language codes:


     
    ar
    




     
    Arabic
    




     
    cs
    




     
    Czech
    




     
    da
    




     
    Danish
    




     
    de
    




     
    German
    




     
    el
    




     
    Greek
    




     
    en
    




     
    English
    




     
    es
    




     
    Spanish
    




     
    fi
    




     
    Finnish
    




     
    fr
    




     
    French
    




     
    it
    




     
    Italian
    




     
    ja
    




     
    Japanese
    




     
    ko
    




     
    Korean
    




     
    nb
    




     
    Norwegian
    




     
    nl
    




     
    Dutch
    




     
    pl
    




     
    Polish
    




     
    pt-BR
    




     
    Brazilian Portuguese
    




     
    pt-PT
    




     
    Iberian Portuguese
    




     
    ru
    




     
    Russian
    




     
    sv
    




     
    Swedish
    




     
    zh
    




     
    Chinese
    

    





      The dictionary for the language specified must
be enabled for this parameter to work. See Configuring dictionaries
for search for more details.





    query
    Text to search for. Returns a list of results
with the specified text in the title, description, or content. Encode
the strings. By default, spaces are treated as an AND operator. The following operators are supported:


     
      


       
    •  AND or &&: Searches for items that contain both words.
For example: query=red%20AND%20test returns items that contain both
the word red and the word test. AND is the default operator. 





       
    •  NOT or !: Excludes the word that follows the operator from the search. For example: query=test%20NOT%20red returns items that contain
the word test, but not the word red.





       
    •  OR: Searches for items that contain either of the words. For example:
query=test%20OR%20red





       
    •  To search for a phrase, enclose the phrase in quotation marks
(" ").





       
    •  +: The plus sign indicates that the word must be present in the result. For example: query=+test%20red returns only items that contain
the word test and many that also contain red, but none that contain
only the word red.





       
    •  ?: Use a question mark to match individual characters. For example:
query=te%3Ft returns items that contain the words test, text, tent,
and others that begin with te.





       
    •  -: The dash prohibits the return of a given word. This operator
is similar to NOT. For example: query=test%20-red returns items that
contains the word test, but not the word red.


    




    tag
    Tag to search for. Returns a list of results
with the specified tag. You can use this parameter multiple times
to search for content that is tagged with all of the tag terms.



    userid
    Limits the results to only those items associated
with the person who has the specified user ID. This parameter overwrites
the email parameter if both are specified.



    




    Example
    To retrieve the people associated with
the search results returned when you search content to which you have
access for the term Red Sox, send the following HTTP
request:


    > GET /search/atom/mysearch/facets/people?query=%22Red%20Sox%22 HTTP/1.1
> Authorization: Basic ...
> Host: enterprise.example.com:9443
> Accept: */*
    
The following content is returned by the server:


    <?xml version="1.0" encoding="UTF-8" ?> 
<feed 
 xmlns="http://www.w3.org/2005/Atom" 
 xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/" 
 xmlns:relevance="http://a9.com/-/opensearch/extensions/relevance/1.0/" 
 xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
  <title>"Red Sox"</title> 
  <link href="https://enterprise.example.com:9443/search/atom/mysearch/
   facets/people?query=%22Red%20Sox%22" rel="self" /> 
  <updated>2008-10-07T23:33:13Z</updated> 
  <id>https://enterprise.example.com:9443/search/atom/mysearch/facets/
   people?query=%22Red%20Sox%22</id> 
  <entry>
    <author>
      <name>Paul C. Laserman</name> 
      <snx:userid>89804r9cfea0cc6500jg0764a36250a8</snx:userid> 
    </author>
    <title>Paul C. Laserman</title> 
    <updated>2008-10-07T23:33:13Z</updated> 
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/resultcount">14</snx:rank> 
    <id>https://enterprise.example.com:9443/search/atom/mysearch/facets/
     people?query=%22Red%20Sox%22&person=
     89804r9cfea0cc6500jg0764a36250a8%02Paul C. Laserman</id> 
    <content /> 
  </entry>
  <entry>
    <author>
      <name>Peter Kearns</name> 
      <snx:userid>98adje9c03t6db8b0103e5c224fa4dwe</snx:userid> 
    </author>
    <title>Peter Kearns</title> 
    <updated>2008-10-07T23:33:13Z</updated> 
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/resultcount">13</snx:rank> 
    <id>https://enterprise.example.com:9443/search/atom/mysearch/facets/
     people?query=%22Red%20Sox%22&
     person=98adje9c03t6db8b0103e5c224fa4dwe%02Peter Kearns</id> 
    <content /> 
  </entry>
  ...
</feed>
    





    Retrieve the tags related to a set of search results
    



     Search IBM Connections to find all of the content that contains a specific text string in
its title, description or content, or that contains information tagged
with a specific tag term, and then return the tags related to the results. Search returns are limited to 100 tags.

    



    Table 78. Atom API request details

    Resource
    Description




     /atom/search/facets/tags
    Search IBM Connections for public information, and then return the tags associated with the results.



    /atom/mysearch/facets/tags
    Search IBM Connections for both public information and private information that you have
access to, and then return the tags associated with the results. You must provide authentication information in the request to retrieve
this resource.



    



    


     You must specify at least one of the following parameters;
you can specify more than one. Separate multiple parameters with an
ampersand (&).




    Table 79. Input parameters

    Parameter
    Description




    component
    Limits the search results to include items from
a specific application. If you specify multiple applications, this
parameter acts as an AND operator. To specify multiple applications,
type a comma between each application name. For example, if you specify
component=dogear,activities, the results would be limited to all of
the activities that have been dogeared or all activity bookmarks that
are also dogeared. Options are: 


     
      


       
    •  activities





       
    •  blogs





       
    •  calendar





       
    •  communities





       
    •  dogear





       
    •  files





       
    •  forums





       
    •  profiles





       
    •  status_updates





       
    •  wikis


    




    components
    Limits the search results to include items from
a specific application. If you specify multiple applications, this
parameter acts as an OR operator. To specify multiple applications,
type a comma between each application name. For example, if you specify
components=dogear,activities, the results would include all items
from Activities or Bookmarks that match the search criteria. Options
are: 


     
      


       
    •  activities





       
    •  blogs





       
    •  calendar





       
    •  communities





       
    •  dogear





       
    •  files





       
    •  forums





       
    •  profiles





       
    •  status_updates





       
    •  wikis


    




    email
    Limits the results to only those items associated
with the person who has the specified email address. For example,
the person could be the author of an activity entry that is returned
or a member of the community returned.



    lang
    


     Specifies a language
in which to search for a string. This parameter is optional. When
specified, the appropriate dictionary for the specified language is
loaded. You can specify any of the following language codes:


     
    ar
    




     
    Arabic
    




     
    cs
    




     
    Czech
    




     
    da
    




     
    Danish
    




     
    de
    




     
    German
    




     
    el
    




     
    Greek
    




     
    en
    




     
    English
    




     
    es
    




     
    Spanish
    




     
    fi
    




     
    Finnish
    




     
    fr
    




     
    French
    




     
    it
    




     
    Italian
    




     
    ja
    




     
    Japanese
    




     
    ko
    




     
    Korean
    




     
    nb
    




     
    Norwegian
    




     
    nl
    




     
    Dutch
    




     
    pl
    




     
    Polish
    




     
    pt-BR
    




     
    Brazilian Portuguese
    




     
    pt-PT
    




     
    Iberian Portuguese
    




     
    ru
    




     
    Russian
    




     
    sv
    




     
    Swedish
    




     
    zh
    




     
    Chinese
    

    





      The dictionary for the language specified must
be enabled for this parameter to work. See Configuring dictionaries
for search for more details.





    query
    Text to search for. Returns a list of results
with the specified text in the title, description, or content. Encode
the strings. By default, spaces are treated as an AND operator. The following operators are supported:


     
      


       
    •  AND or &&: Searches for items that contain both words.
For example: query=red%20AND%20test returns items that contain both
the word red and the word test. AND is the default operator. 





       
    •  NOT or !: Excludes the word that follows the operator from the search. For example: query=test%20NOT%20red returns items that contain
the word test, but not the word red.





       
    •  OR: Searches for items that contain either of the words. For example:
query=test%20OR%20red





       
    •  To search for a phrase, enclose the phrase in quotation marks
(" ").





       
    •  +: The plus sign indicates that the word must be present in the result. For example: query=+test%20red returns only items that contain
the word test and many that also contain red, but none that contain
only the word red.





       
    •  ?: Use a question mark to match individual characters. For example:
query=te%3Ft returns items that contain the words test, text, tent,
and others that begin with te.





       
    •  -: The dash prohibits the return of a given word. This operator
is similar to NOT. For example: query=test%20-red returns items that
contains the word test, but not the word red.


    




    tag
    Tag to search for. Returns a list of results
with the specified tag. You can use this parameter multiple times
to search for content that is tagged with all of the tag terms.



    userid
    Limits the results to only those items associated
with the person who has the specified user ID. This parameter overwrites
the email parameter if both are specified.



    




    Example
    To retrieve the tags associated with
the search results returned when you search for the term "Red Sox",
send the following HTTP request:


    > GET /search/atom/search/facets/tags?query=%22Red%20Sox%22 HTTP/1.1
> Host: enterprise.example.com:9443
> Accept: */*
    
The following content is returned by the server:


    <?xml version="1.0" encoding="UTF-8" ?> 
<app:categories 
 fixed="no" 
 xmlns="http://www.w3.org/2005/Atom" 
 xmlns:app="http://www.w3.org/2007/app" 
 xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
  <category snx:frequency="14" term="baseball" /> 
  <category snx:frequency="3" term="baseball-news" /> 
  <category snx:frequency="1" term="beckett" /> 
  <category snx:frequency="4" term="boston" /> 
  ...
  <category snx:frequency="1" term="varitek" /> 
  <category snx:frequency="1" term="wakefield" /> 
</app:categories>
    





     Clear the current status message
    



     To clear the current status message, and replace it with
an empty string, use the HTTP DELETE method. 

    


     This API has been deprecated in Connections 4.





     You can only clear your own status message. See Authenticating requests for
information about how to authenticate the request.





    Table 80. Atom API request details

    Method
    Resource
    URI
    Input and output representations




    DELETE
    status
    web address specified in the href attribute
of the <link> element that contains a rel="http://www.ibm.com/xmlns/prod/sn/status"
attribute value from the person's service document.
    none



    







     
    Input
    


     None.







     
    Output
    


     None.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the current status message was successfully cleared.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 404 Not Found


    






    Add a comment to a message board
    



     Add a comment to someone's status or add a comment as a
response to a message that someone else added to your message board.

    


     This API has been deprecated in Connections 4.





     See Authenticating
requests for information about how to authenticate the request.





    Table 81. Atom API request details

    Method
    Resource
    URI
    Input representation




    POST
    message board entry replies
    Value of the href attribute of the <link>
element with the rel="replies" attribute value found in the message
entry.
    comment



    POST
    status feed
    Value of the href attribute of the <link>
element with the rel="replies" attribute value found in the message
entry.
    comment



    







     
    Input
    


     Provide a comment Atom entry document.
The content type of the Atom entry document must be application/atom+xml.







     
    Output
    


     An Atom entry document containing
the new comment.





     Returned HTTP headers


     
    HTTP/1.1 201 Created
    




     
    Indicates that the comment was successfully created. If an error
occurs, this header contains one of the error codes.
    




     
    Location: url
    




     
    Link to edit_url of the message board entry. You can use the web
address specified here to subsequently retrieve and update the comment.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 401 Unauthorized


    






    Add a message to a message board
    



     Send an Atom document containing a message entry to your own or another person's board feed. 

    


     This API has been deprecated in Connections 4.





     See Authenticating
requests for information about how to authenticate the request.





    Table 82. Atom API request details

    Method
    Resource
    URI
    Input representation




    POST
    user's board feed
    Value of the href attribute of the <link>
element with the rel="http://www.ibm.com/xmlns/prod/sn/mv/theboard"
attribute value found in one of the following locations:


     
      


       
    •  Your service document to add the message to your own board.





       
    •  The user's profile entry to add the message to someone else's
board.


    

        		message



    







     
    Input
    


     Provide a message Atom document. The content type of the Atom entry document must be application/atom+xml.







     
    Output
    


     An Atom entry document containing
the new message.





     Returned HTTP headers


     
    HTTP/1.1 201 Created
    




     
    Indicates that the message was successfully created. If an error
occurs, this header contains one of the error codes.
    




     
    Location: url
    




     
    Link to edit_url of the message entry. You can use the web address
specified here to subsequently retrieve the message.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 401 Unauthorized


    






     Delete a comment from a message board
    



     To remove a comment from your message board, use the HTTP
DELETE method. 

    


     This API has been deprecated in Connections 4.





     See Authenticating
requests for information about how to authenticate the request.





    Table 83. Atom API request details

    Method
    Resource
    URI
    Input and output representations




    DELETE
    comment
    Value of the href attribute of the <link>
element with the rel="self" attribute found in the comments feed.
    none



    







     
    Input
    


     None.







     
    Output
    


     None.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the comment was successfully deleted.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 404 Not Found


    






     Delete a message from a message board
    



     To remove a message from your message board, use the HTTP
DELETE method. 

    


     This API has been deprecated in Connections 4.





     See Authenticating
requests for information about how to authenticate the request.





    Table 84. Atom API request details

    Method
    Resource
    URI
    Input and output representations




    DELETE
    message
    Value of the href attribute of the <link>
element with the rel="self" attribute for each message entry found
in the board feed.
    none



    







     
    Input
    


     None.







     
    Output
    


     None.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the message was successfully deleted.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 404 Not Found


    






     Delete a status message
    



     To delete a status message, use the HTTP DELETE method. 

    


     This API has been deprecated in Connections 4.





     See Authenticating
requests for information about how to authenticate the request.





    Table 85. Atom API request details

    Method
    URI
    Input and output representations




    DELETE
    Value of the href attribute of the <link>
element with the rel="self" attribute for each message entry found
in the board feed.
    none



    







     
    Input
    


     None.







     
    Output
    


     None.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the status message was successfully deleted.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 404 Not Found


    






    Retrieve comments from a message board
    



     To retrieve the Atom document for a comment associated
with a person's status message or the other messages posted to a message
board, get a feed that lists the comments to find out the comment's
ID, and then request that comment.

    


     This API has been deprecated in Connections 4.





    Table 86. Atom API request details

    Method
    URI
    Output representation




    GET
    Value of the href attribute of the <link>
element with the rel="self" attribute for each entry in the replies
feed for the board entry.
    comment 



    







     
    Input
    


     None.







     
    Output
    


     An Atom entry document containing
the comment.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the comment was successfully found and returned.
If an error occurs, this header will contain one of the error codes
below.
    




     
    Content-Type: application/atom+xml
    




     
     Indicates that the document returned contains data in Atom format.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 401 Unauthorized: Returned if you failed
to authenticate the request.





       
    •  HTTP/1.1 404 Not Found


    






    Retrieve messages from a message board
    



     To retrieve messages posted to a message board, look at
the board feed to find the entry ID of the message, and then request
that entry.

    


     This API has been deprecated in Connections 4.





     See Authenticating
requests for information about how to authenticate the request.





    Table 87. Atom API request details

    Method
    URI
    Output representation




    GET
    Value of the href attribute of the <link>
element that has the rel="self" attribute for each entry in the board
feed.
    message



    







     
    Input
    


     None.







     
    Output
    


     An Atom entry document containing
the message.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the message was successfully found and returned.
If an error occurs, this header will contain one of the error codes
below.
    




     
    Content-Type: application/atom+xml
    




     
     Indicates that the document returned contains data in Atom format.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 401 Unauthorized: Returned if you failed
to authenticate the request.





       
    •  HTTP/1.1 404 Not Found


    






    Retrieve status messages
    



     Programmatically retrieve a status message posted to a
message board.

    


     This API has been deprecated in Connections 4.





     See Authenticating
requests for information about how to authenticate the request.





    Table 88. Atom API request details

    Method
    URI
    Output representation




    GET
    Value of the href attribute of the <link>
element with the rel="http://www.ibm.com/xmlns/prod/sn/status" attribute
in the person's profile feed or service document.
    status



    







     
    Input
    


     None.







     
    Output
    


     An Atom entry document containing
the status message.





     Returned HTTP headers


     
    HTTP/1.1 204
    




     
    Indicates that there was no content to return, which means that
no status message was available.
    




     
    HTTP/1.1 200 OK
    




     
    Indicates that the status message was successfully found and returned.
If an error occurs, this header will contain one of the error codes
below.
    




     
    Content-Type: application/atom+xml
    




     
     Indicates that the document returned contains data in Atom format.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 401 Unauthorized: Returned if you failed
to authenticate the request.





       
    •  HTTP/1.1 404 Not Found


    






    Retrieve
profile extension data
    



     To retrieve the data defined
for custom fields added to
a profile, use the Profiles extension resource link returned by the Profiles user feed.

    


     Profiles extension
data can be represented as follows: 


     
      


       
    •  A single plain text value.
Identified as type="text/plain."





       
    •  Multiple values defined by
an XML schema. Identified as type="text/xml."


    
The links for
working with custom extensions are found in the <feed>
element of the Profiles user feed. The <link rel="http://www.ibm.com/xmlns/prod/sn/ext-attr"
> element appears once in the feed for each custom extension defined
for a profile. 


      No custom extensions links are available from
the links in the <entry> element of the feed that contains the user's profile.





      When you update an extension, all existing
information will be replaced with the new data. To avoid deleting
existing data, follow the instructions in this topic to retrieve any
data you want to retain first, and send it back with this request.
 See the topic Updating profile extension data for more
information. 






     To retrieve a profile extension, complete
the following steps:


     
      


       
    1.  Get the person's user feed. See Searching
for a user's profile.





       
    2.  Get the URI of the extension
resource which is specified in the href attribute of the <link> element in the user's user feed that
has a rel="http://www.ibm.com/xmlns/prod/sn/ext-attr" attribute and
a snx:extensionId attribute that matches the extension you want to
retrieve.





       
    3.  Send a GET request to the web address specified
in the href attribute.


    






    Table 89. Atom API
request details

    Method
    Resource
    URI
    Output
representation




    GET
    profile extension
    Value of the href attribute of the <link>
element in the user's user feed that has a   rel="http://www.ibm.com/xmlns/prod/sn/ext-attr"
attribute and a snx:extensionId attribute that matches the extension
you want to update. 
    XML schema defined
by each extension or plain
text



    







     
    Input
    


     None.







     
    Output
    


     Extension data is returned in the response content.





     Returned HTTP headers


     
    HTTP/1.1
200 OK
    




     
    Indicates that the extension was found and returned
successfully.
If an error is encountered, the header contains one of the error codes
listed below.
    




     
    Content-Type: text/plain
    




     
    Indicates format of the response to a GET request.
    




     
    Content-Type: text/xml
    




     
    Indicates format of the response to a GET request.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 400 Bad Request





       
    •  HTTP/1.1 401 Unauthorized





       
    •  HTTP/1.1
404 Not Found


    



    Input:


    GET /profiles/atom/profileExtension.do?key=c007e7e2-9322-4021-9426-136b0411796f&
 extensionId=employeeType HTTP/1.1
Host: profiles.enterprise.example.com
    
Response:


    HTTP/1.1 200 OK
Content-Type: text/plain; charset=UTF-8
Content-Length: 7
    
Response content:


    regular
    



     
    Related tasks
    

  •   Enable custom extension attributes for Profiles




     Update a status message
    



     To update a status message, send an updated status document
in Atom format using an HTTP PUT request.

    


     This API has been deprecated in Connections 4.





     See Authenticating
requests for information about how to authenticate the request.





    Table 90. Atom API request details

    Method
    URI
    Input representation




    PUT
    Value of the href attribute of the <link>
element with the rel="http://www.ibm.com/xmlns/prod/sn/status" attribute
in the person's profile feed or service document.
    status



    







     
    Input
    


     Provide a status Atom document. The content type of the Atom entry document must be application/atom+xml.







     
    Output
    


     None.





     Returned HTTP headers


     
    HTTP/1.1 200 OK
    




     
    Indicates that the status message was successfully updated. If an error occurs, this header contains one of the error codes.
    

    






     Error codes


     
      


       
    •  HTTP/1.1 401 Unauthorized





       
    •  HTTP/1.1 404 Not Found


    






    Get a feed of the wikis with the most comments
    



     Get a feed that returns all wikis sorted by wikis with
the most comments first. 

    This returns a feed of wikis to which everyone who can log
into the Wikis application has access. 

    



    Table 91. Atom API request details

    Resource address
    Method
    Input or output representation
    Description




    /basic/anonymous/api/wikis/mostcommented
    GET
    Feed of wiki definition Atom entries
    A feed of the wikis with the most comments.



    



    Use one or more of the input parameters to narrow the search
for the GET request. Separate multiple parameters with an ampersand
(&).



    Table 92. Input parameters

    Parameter
    Description




    acls
    Specifies whether or not the permissions for
each user should be displayed for each entry in the returned Atom
document. This parameter takes a Boolean value of either true or false.
By default, the permission information is not returned.



    includeTags
    Specifies whether or not the tags that are displayed
on the wiki welcome page are included in the returned Atom document.
This parameter takes a Boolean value of either true or false.
By default, the tags are not returned.



    page
    Page number. Specifies
the page to be returned. The default value is 1, which returns the first page.



    ps
    Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 500.


      This parameter replaces
the pageSize parameter. The pageSize parameter is supported for backwards
compatibility only; it will be deprecated in a future release.




    sI
    Start index. Specifies the start index (number)
in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided. The default
value is 1.



    sortBy
    String. Specifies what to sort the returned
entries by. Options are:


     
    commented
    




     
    Sorts the entries by the number of
comments or replies an item has received.
    




     
    created
    




     
    Sorts the entries by the date the item
was created.
    




     
    desc
    




     
    Sorts the entries alphabetically by description.
    




     
    modified
    




     
    Sorts the entries by the last modified
date.
    




     
    published
    




     
    Sorts the entries by the date the item was published (usually related to atom:published element).
    




     
    title
    




     
    Sorts the entries alphabetically by title.
The title used is the text that is displayed in the <title> element
of each entry in the feed.
    




     
    updated
    




     
    Sorts the entries by the last time
the item was updated.
    

    
The default value is commented.



    sortOrder
    


     Specifies the order
in which to sort the results. The options are: 


     
    asc
    




     
    Sorts the results in ascending order.
    




     
    desc
    




     
    Sorts the results in descending order.
    

    

Descending
is the default value.



    




    Example
    To get a feed of all wikis ordered
by most commented, send the following HTTP request:


    > GET wikis/basic/anonymous/api/wikis/mostcommented HTTP/1.1
> Authorization: Basic ...
> Host: wikis.enterprise.example.com:9088
> Accept: */*
    





    Get a feed of the wikis with the most recommendations
    



     Get a feed that returns all wikis sorted by most recommended. 

    This returns a feed of wikis to which everyone who can log
into the Wikis application has access. 

    



    Table 93. Atom API request details

    Resource address
    Method
    Input or output representation
    Description




    /basic/anonymous/api/wikis/mostrecommended
    GET
    Feed of wiki definition Atom entries
    A feed of the wikis with the most recommendations.



    



    Use one or more of the input parameters to narrow the search
for the GET request. Separate multiple parameters with an ampersand
(&).



    Table 94. Input parameters

    Parameter
    Description




    acls
    Specifies whether or not the permissions for
each user should be displayed for each entry in the returned Atom
document. This parameter takes a Boolean value of either true or false.
By default, the permission information is not returned.



    includeTags
    Specifies whether or not the tags that are displayed
on the wiki welcome page are included in the returned Atom document.
This parameter takes a Boolean value of either true or false.
By default, the tags are not returned.



    page
    Page number. Specifies
the page to be returned. The default value is 1, which returns the first page.



    ps
    Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 500.


      This parameter replaces
the pageSize parameter. The pageSize parameter is supported for backwards
compatibility only; it will be deprecated in a future release.




    sI
    Start index. Specifies the start index (number)
in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided. The default
value is 1.



    sortBy
    String. Specifies what to sort the returned
entries by. Options are:


     
    created
    




     
    Sorts the entries by the date the item
was created.
    




     
    desc
    




     
    Sorts the entries alphabetically by description.
    




     
    modified
    




     
    Sorts the entries by the last modified
date.
    




     
    published
    




     
    Sorts the entries by the date the item was published (usually related to atom:published element).
    




     
    recommended
    




     
    Sorts the entries by the number
of times the item was recommended.
    




     
    title
    




     
    Sorts the entries alphabetically by title.
The title used is the text that is displayed in the <title> element
of each entry in the feed.
    




     
    updated
    




     
    Sorts the entries by the last time
the item was updated.
    

    
The default value is recommended.



    sortOrder
    


     Specifies the order
in which to sort the results. The options are: 


     
    asc
    




     
    Sorts the results in ascending order.
    




     
    desc
    




     
    Sorts the results in descending order.
    

    

Descending
is the default value.



    




    Example
    To get a feed of all wikis ordered
by most recommended, send the following HTTP request:


    > GET wikis/basic/anonymous/api/wikis/mostrecommended HTTP/1.1
> Authorization: Basic ...
> Host: wikis.enterprise.example.com:9088
> Accept: */*
    





    Get a feed of the most visited wikis
    



     Get a feed that returns all wikis sorted by most visited. 

    This returns a feed of wikis to which everyone who can log
into the Wikis application has access. 

    



    Table 95. Atom API request details

    Resource address
    Method
    Input or output representation
    Description




    /basic/anonymous/api/wikis/mostvisited
    GET
    Feed of wiki definition Atom entries
    A feed of the most visited wikis.



    



    Use one or more of the input parameters to narrow the search
for the GET request. Separate multiple parameters with an ampersand
(&).



    Table 96. Input parameters

    Parameter
    Description




    acls
    Specifies whether or not the permissions for
each user should be displayed for each entry in the returned Atom
document. This parameter takes a Boolean value of either true or false.
By default, the permission information is not returned.



    includeTags
    Specifies whether or not the tags that are displayed
on the wiki welcome page are included in the returned Atom document.
This parameter takes a Boolean value of either true or false.
By default, the tags are not returned.



    page
    Page number. Specifies
the page to be returned. The default value is 1, which returns the first page.



    ps
    Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 500.


      This parameter replaces
the pageSize parameter. The pageSize parameter is supported for backwards
compatibility only; it will be deprecated in a future release.




    sI
    Start index. Specifies the start index (number)
in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided. The default
value is 1.



    sortBy
    String. Specifies what to sort the returned
entries by. Options are:


     
    created
    




     
    Sorts the entries by the date the item
was created.
    




     
    desc
    




     
    Sorts the entries alphabetically by description.
    




     
    downloaded
    




     
    Sorts the entries by the number
of times the item was downloaded. In
the context of a wiki, this means the number of times a wiki page
was viewed.
    




     
    modified
    




     
    Sorts the entries by the last modified
date.
    




     
    published
    




     
    Sorts the entries by the date the item was published (usually related to atom:published element).
    




     
    title
    




     
    Sorts the entries alphabetically by title.
The title used is the text that is displayed in the <title> element
of each entry in the feed.
    




     
    updated
    




     
    Sorts the entries by the last time
the item was updated.
    

    
The default value is downloaded.



    sortOrder
    


     Specifies the order
in which to sort the results. The options are: 


     
    asc
    




     
    Sorts the results in ascending order.
    




     
    desc
    




     
    Sorts the results in descending order.
    

    

Descending
is the default value.



    




    Example
    To get a feed of all wikis ordered
by most visited, send the following HTTP request:


    > GET wikis/basic/anonymous/api/wikis/mostvisited HTTP/1.1
> Authorization: Basic ...
> Host: wikis.enterprise.example.com:9088
> Accept: */*
    





    Get a feed of wiki pages edited by someone
    



     Get a feed that lists all of the pages in a specific wiki
that have been added or edited by the authenticated user. 

    



    Table 97. Atom API request details

    Resource address
    Method
    Input or output representation
    Description




    /basic/api/wiki/{wiki-label}/mypages
    GET
    Feed of wiki page entries
    A feed of the pages in a wiki that were edited
by the authenticated user.



    






     {wiki-label} is the value of the <td:label> element
of the wiki.


    Use one or more of the input parameters to narrow the search
for the GET request. Separate multiple parameters with an ampersand
(&).



    Table 98. Input parameters

    Parameter
    Description




    acls
    Specifies whether or not the permissions for
each user should be displayed for each entry in the returned Atom
document. This parameter takes a Boolean value of either true or false.
By default, the permission information is not returned. 



    includeTags
    Specifies whether or not the tags that are displayed
on the wiki welcome page are included in the returned Atom document.
This parameter takes a Boolean value of either true or false.
By default, the tags are not returned.



    page
    Page number. Specifies
the page to be returned. The default value is 1, which returns the first page.



    ps
    Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 500.



    sortBy
    String. Specifies what to sort the returned
entries by. Options are:


     
    commented
    




     
    Sorts the entries by the number of
comments or replies an item has received.
    




     
    created
    




     
    Sorts the entries by the date the item
was created.
    




     
    downloaded
    




     
    Sorts the entries by the number
of times the item was downloaded. In
the context of a wiki, this means the number of times a wiki page
was viewed.
    




     
    label
    




     
    Sorts alphabetically by the label. 
    




     
    length
    




     
    Sorts the entries by the size of the file. 
    




     
    published
    




     
    Sorts the entries by the date the item was published (usually related to atom:published element). 
    




     
    recommended
    




     
    Sorts the entries by the number
of times the item was recommended.
    




     
    title
    




     
    Sorts the entries alphabetically by title.
The title used is the text that is displayed in the <title> element
of each entry in the feed.
    




     
    totalMediaSize
    




     
    Sorts the entries by the size
of the media associated with the item.
    




     
    updated
    




     
    Sorts the entries by the last time
the item was updated.
    

    
The default value is published.



    sortOrder
    


     Specifies the order
in which to sort the results. The options are: 


     
    asc
    




     
    Sorts the results in ascending order.
    




     
    desc
    




     
    Sorts the results in descending order.
    

    

Descending
is the default value.



    




    Example
    To get a feed of pages in the myNewWiki
wiki, send the following HTTP request:


    > GET wikis/basic/api/wiki/myNewWiki/mypages HTTP/1.1
> Authorization: Basic ...
> Host: wikis.enterprise.example.com:9088
> Accept: */*
    





    Get a feed of wiki pages in the trash
    



     Get a feed that lists the pages that have been deleted
from wikis and are currently stored in the trash.

    This returns a feed of wikis to which everyone who can log
into the Wikis application has access. 

    



    Table 99. Atom API request details

    Resource address
    Method
    Input or output representation
    Description




    /basic/anonymous/api/wiki/{wiki-label-or-ID}/recyclebin/feed
    GET
    Feed of wiki definition Atom entries
    A feed of pages in the trash



    

{wiki-label-or-ID} is the value of the <td:label> element
or the <id> element of the wiki.

    Use one or more of the input parameters to narrow the search
for the GET request. Separate multiple parameters with an ampersand
(&).



    Table 100. Input parameters

    Parameter
    Description




    acls
    Specifies whether or not the permissions for
each user should be displayed for each entry in the returned Atom
document. This parameter takes a Boolean value of either true or false.
By default, the permission information is not returned.



    includeQuota
    Specifies whether or not to include the library
size and library quota information in the returned Atom document.
This parameter takes a Boolean value of either true or false.
Defaults to false. If set to true, this parameter adds quota information
into the feed. This parameter only applies if the requesting user
has the 'AddChild' permission.



    page
    Page number. Specifies
the page to be returned. The default value is 1, which returns the first page.



    ps
    Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 500.


      This parameter replaces
the pageSize parameter. The pageSize parameter is supported for backwards
compatibility only; it will be deprecated in a future release.




    sI
    Start index. Specifies the start index (number)
in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided. The default
value is 1.



    sortBy
    String. Specifies what to sort the returned
entries by. Options are:


     
    label
    




     
    Sorts alphabetically by the label.
    




     
    title
    




     
    Sorts the entries alphabetically by title.
The title used is the text that is displayed in the <title> element
of each entry in the feed.
    




     
    updated
    




     
    Sorts the entries by the last time
the item was updated.
    

    




    sortOrder
    


     Specifies the order
in which to sort the results. The options are: 


     
    asc
    




     
    Sorts the results in ascending order.
    




     
    desc
    




     
    Sorts the results in descending order.
    

    

Descending
is the default value.



    






    Error messages
    



     Use the codes included in the error messages generated
by IBM Connections to identify
problems and find their solutions.

    The following error
messages are generated by IBM Connections:



    Table 101. IBM Connections error
messages with codes

    Message
    Cause
    Solution




    CLFRP####E: The installation of application
{0} failed while creating WebSphere Application Server Variables.
    The installation failed
while creating WebSphere Application Server
Variables.
    


     
      


       
    1.  Check the detailed
error message in the log file. 





       
    2.  Find the root cause of error
then try to fix it. 





       
    3.  Run the uninstaller to uninstall the application and then install
the application again.


    




    CLFRP####E:
The installation of application
{0} failed while creating datasource.
    The
installation failed while creating while
creating datasource.
    


     
      


       
    1.  Check
the detailed error message in the log file. 





       
    2.  Find the root
cause of error then try to fix it. 





       
    3.  Run the uninstaller to
uninstall the application and then install
the application again.


    




    CLFRP####E:
The installation of application
{0} failed while deploying application.
    The
installation failed while deploying application.
    


     
      


       
    1.  Check the detailed error message in the log file. 





       
    2.  Find the root cause of error then try to fix it. 





       
    3.  Run the uninstaller to uninstall the application and then install
the application again.


    




    CLFRP####E:
The installation of application
{0} failed while doing server configuration.
    The
installation failed while doing server configuration.
    


     
      


       
    1.  Check the detailed error message in the log file. 





       
    2.  Find the root cause of error then try to fix it. 





       
    3.  Run the uninstaller to uninstall the application and then install
the application again.


    




    CLFRP####E:
The uninstallation of application
{0} failed while removing WebSphere Application Server Variables.
    The uninstallation
failed while removing WebSphere Application Server
Variables.
    


     
      


       
    1.  Check the detailed
error message in the log file to find the root
cause. 





       
    2.  Try to fix it and then uninstall the application.


    




    CLFRP####E: The uninstallation
of application
{0} failed while removing datasource.
    The
uninstallation failed while removing datasource.
    


     
      


       
    1.  Check the detailed error message in the log file to find the root
cause. 





       
    2.  Try to fix it and then uninstall the application.


    




    CLFRP####E: The uninstallation
of application
{0} failed while uninstalling application.
    The
uninstallation failed while uninstalling
application.
    


     
      


       
    1.  Check the detailed
error message in the log file to find the root
cause. 





       
    2.  Try to fix it and then uninstall the application.


    




    CLFRP####E: The uninstallation
of application
{0} failed while doing server configuration.
    The
uninstallation failed while doing server
configuration.
    


     
      


       
    1.  Check the detailed error message in the log file to find the root
cause. 





       
    2.  Try to fix it and then uninstall the application.


    




    CLFNF6001E: Could not
store portlet preferences.
    The portlet
failed to save preferences to portal
preferences store.  It may be caused by incorrect permission settings
granted by the administrator.
    Check
if the user has permission to store
preferences.



    CLFNF6002E: Error
storing slot id.
    The portlet failed to
store user credentials
in the portal credential vault.
    Check
your portal credential vault configuration.



    CLFNF6003E: There was an error with a name.
    


     Caused by: javax.naming.





     NamingException
when the portlet is trying to lookup Portal services (i.e. Puma service
or Identification service).

    
    		Check
your portal configuration to make
sure Puma services and Portal Identification service are available.



    CLFNF6004E: JSONTranslator could
not modify
portlet preferences.
    The portlet failed
to save preferences to portal
preferences store. It may be caused by incorrect permission settings
granted by the administrator.
    Check
if the user has permission to store
preferences.



    CLFNF6005E: There
was an error with the portlet
service.
    The server encountered an error
when using Portal
Puma services.
    Check your portal
configuration to make
sure puma services function correctly.



    CLFNF6006E: Error creating credential.
    The portlet failed to create a private credential
slot.
    Check your portal credential
vault configuration.



    CLFNF6007E:
Name not found.
    The portlet failed to
locate portal services.
(i.e. Puma or Identification)
    Check
your portal configuration to make
sure puma services and Portal Identification are available.



    CLFNF6008E: There was an error serializing
an
id.
    The portlet failed to serialize portlet
window
ID.
    Reinstall the portlet instance
on the page,
if the problem is consistent, check your portal configuration.



    CLFNF6009E: Could not get custom
views.
    The portlet failed to change the value for a
read-only preference attribute.
    Check
if the user has permission to store
preferences.



    CLFNF6010E: Query
was stored in a bad format:
{0}.
    The user used the character .|.
in a custom
search query or in a custom tag filter.
    Do
not use .|. in a custom search query
or in a custom tag filter.



    CLFNF6011E:
Error getting user credentials.
    The portlet
encountered an error when attempting
to retrieve user credentials from the Portal credential vault.
    Check the portal credential vault configuration.



    CLFRA0001E: Viral content replaced.
    The virus scanner removed a virus from added
content.
    No action necessary.



    CLFRA0003E: Virus detected - <error>.
    The virus scanner received the error <error>
scanning content.
    No action necessary.
The content was not
added to Activities.



    CLFRA0006E:
Unable to find CMAPI provider "<providerName>".
    Unable to find a suitable CMAPI provider.
    Check the <objectStore> settings in oa-config.xml
and provide a correct <providerName> for the class property of
the store element.



    CLFRA0013E:
unable to delete file <fileName>.
    An
error occurred while deleting a file from
the Activities content store.  Additional information relating to
the failure may be found in the SystemOut.log file.
    Verify the directory and file information
is correct.



    CLFRA0014E: unable
to create file upload directory <directoryName>.
    The directory given in oa-config.xml for the element property name "root.directory" either could not be found or
created.  This directory is used for file uploads to the Activities
content store.
    Check that the directory
exists; create
it if it does not exist.



    CLFRA0015E:
error encountered deleting content: <directoryName> <fileName>.
    An error occurred while deleting the contents
of a file from the Activities content store.  Additional information
relating to the failure may be found in the SystemOut.log file.
    Verify the directory and file information
is correct.



    CLFRA0016E: unable
to upload file: <directoryName> <fileName>.
    An error occurred while retrieving or uploading
a file to the Activities content store.  Additional information relating
to the failure may be found in the SystemOut.log file.
    Verify the directory and file information
is correct.



    CLFRA0017E: Error
closing statistics file.
    A file system
error occurred closing one of
the files used for Activities statistics persistence.
    Verify the file system directory containing
the statistics files is writable and has available space.



    CLFRA0019E: Error creating statistics file.
    A file system error occurred creating one of
the files used for Activities statistics persistence.
    Verify the file system directory containing
the statistics files is writable and has available space.



    CLFRA0020E: Error parsing statistics file.
    The format of one of the files used for Activities
statistics persistence is inconsistent with the expected format.
    Remove the existing files in the file system
directory containing the statistics files.



    CLFRA0021E: Activities statistics persistence
cannot create directory <directory>.
    A
file system error occurred creating the file
system directory <directory> for containing the Activities statistics
files.
    Verify the server level WebSphere Application Server
variable ACTIVITIES_STATS_DIR
is set to a valid directory location on the server's file system;
create the directory <directory> on the file system.



    CLFRA0022E: Error saving to statistics
file.
    A file system error occurred saving
data one
of the files used for Activities statistics persistence.
    Verify the file system directory containing
the statistics files is writable and has available space.



    CLFRA0023E: Error saving summary information.
    A file system error occurred saving data one
of the files used for Activities statistics persistence.
    Verify the file system directory containing
the statistics files is writable and has available space.



    CLFRA0026E: Error fetching profiles.
    The MemberService wsadmin object received an
exception executing a fetchMembers command.
    Verify the parameter to the fetchMembers
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRA0028E: Error updating access control list.
    The AccessControlService wsadmin object received
an exception executing an access modification command.
    Verify the parameter to the command
is valid.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRA0029E:
Error fetching activities.
    The ActivityService
wsadmin object received
an exception executing a command to fetch Activities.
    Verify the parameter to the command
is valid.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRA0030E:
Error fetching access control list.
    The
AccessControlService wsadmin object received
an exception executing a fetchAccess command.
    Verify the parameter to the command
is valid.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRA0032E:
Error updating profile.
    The MemberService
wsadmin object received an
exception executing a updateMember command.
    Verify the parameter to the updateMember
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRA0033E: Error purging trash.
    The TrashCollectionService wsadmin object received
an exception executing a purgeTrash command.
    Verify the parameter to the purgeTrash
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRA0034E: Error fetching trash.
    The TrashCollectionService wsadmin object received
an exception executing a fetchTrash command.
    Verify the parameter to the fetchTrash
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRA0035E: Error undeleting trash.
    The TrashCollectionService wsadmin object received
an exception executing a undeleteTrash command.
    Verify the parameter to the undeleteTrash
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRA0036E: Error locating MBeanServer, no Activity
Administration MBeans registered.
    An
exception was generated when Activities tried
to locate MBean server needed to register the Activities Administration
MBeans.
    Report this problem to Customer
Support.
 Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRA0038E:
Error registering mbean.
    An exception
was generated when Activities tried
to register the Activities Administration MBeans.
    Report this problem to Customer Support.
 Additional information relating to the failure may be found in the SystemOut.log file. 



    CLFRA0042E: <className>
error parsing generic
properties into a Properties object.
    An
exception was generated when the Event Broker
tried to parse its configuration from oa-config.xml.
    Ensure the properties and elements for the <eventBroker>
element in oa-config.xml are valid. Additional information relating
to the failure may be found in the SystemOut.log file.



    CLFRA0043E: subscriber did not start: <className>.
    The Event Broker service is attempting to initialize
a subscriber to server-generated events, but the subscriber initialization
process failed.
    Check that the <eventBroker>
configuration
specified in oa-config.xml for the subscriber reporting this error
is valid.  Additionally, you may want to pursue the exception thrown
by the subscriber in the SystemOut.log file.



    CLFRA0044E: {0} the class "<className>" was
not found.  Check the configuration file, under the class attribute
of the service for the correct Java classname.
 Or, check the classpath to make sure the class is visible.
    The Event Broker service tried to load a Java class that did not exist in
the current classpath.
    Check to see
whether the class specified
in the <eventBroker> configuration has been spelled correctly.
 Also check to see that the class file is visible in the current classpath
scope.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRA0045E:
{0} the class "<className>" could
not be instantiated.
    The classloader
could not instantiate the class
requested by the Event Broker service.
    Investigate
whether something is wrong with
the classloader or the class specified in the <eventBroker> configuration
itself.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRA0046E:
{0} illegal access exception for
the class "<className>".
    The Event
Broker service is trying to access
fields or methods in the class discovered via reflection that it can't
normally see.  Additional information relating to the failure may
be found in the SystemOut.log file.
    Examine
the class for methods that should
be exposed have been hidden.



    CLFRA0047E:
{0} error initializing adapter:
classname= "{1}"  Double-check the config settings for this specific
adapter for correct/valid values.
    The
Event Broker service is attempting to initializer
a subscriber to server-generated events, but the subscriber initialization
process failed.
    Check that the <eventBroker>
configuration
specified in oa-config.xml for the subscriber reporting this error
is valid.  Additionally, you may want to pursue the exception thrown
by the subscriber in the SystemOut.log file.



    CLFRA0048E: could not inform a subscriber of
event: <eventName>.
    The Event Broker
service passed an event to
a subscriber of that event, and the subscriber issued an exception.
    To fix this class of exception, you need
to determine what is failing in this particular subscriber.  Additional
information relating to the failure may be found in the SystemOut.log
file.



    CLFRA0050E: Invalid
oa-config.xml file.  Check
the XML format and ensure that all required settings are complete.
    The format of oa-config.xml does not have correct
XML syntax.
    Load the oa-config.xml
into a browser or
editor that will display syntax errors; fix the error and save the file.



    CLFRA0051E: Error decoding
passwords.  If passwords
are encoded, some functionality may fail.
    Should
not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0068E:
{0} OpenActivitiesException while
updating node content ref uuid.
    An error
occurred while updating the content
of the specified activity.
    Check
that the content stores are available
and accessible and that the referenced item exists in the content
store.  The item may have been deleted by an external process.



    CLFRA0070E: Illegal access exception
for the class "<className>".
    An error occurred
while processing the Activities
content store configuration.  Additional information relating to the failure may be found in the SystemOut.log file.
    Verify the <objectStore> configuration
information in oa-config.xml is correct.  If the problem persists
after restarting the Activities application, contact Customer Support
to report the incident.



    CLFRA0071E:
{0} DaoException while updating
node content ref uuid=<uuid>.
    An error
occurred while updating the content
of the specified activity.
    Check
that the content stores are available
and accessible and that the referenced item exists in the content
store.  The item may have been deleted by an external process.



    CLFRA0072E: activities object store
did not
start: <className>.
    The Activities
Object Store service implemented
by <className> did not start.  Additional information relating
to the failure may be found in the SystemOut.log file.
    Verify the <objectStore> configuration
information in oa-config.xml is correct.  If the problem persists
after restarting the Activities application, contact Customer Support
to report the incident.



    CLFRA0073E:
{0} Destination ObjectStore ID="<id>"
not found in ObjectStore registry. Double-check the oa-config.xml
file.
    An error occurred while transferring
Activities
content from one content store to another.  The requested destination
object store identifier was not found.
    Check
the spelling of the ID used and compare
it with the available object stores listed in the oa-config.xml file.



    CLFRA0074E: ObjectStoreFilter error
during activities
object store content filtering "<error>".
    An
error occurred while processing Activities
content.  Additional information relating to the failure may be found
in the SystemOut.log file.
    Depending
on the additional error information
given, it may be possible to correct the data and re-process it.



    CLFRA0075E: Premature invocation
before transfer
is complete.  Check busy() method or listen for completion event.
    An error occurred while transferring Activities
content from one content store to another.  The transfer utility may
already be carrying out a transfer.
    Attempt
this operation after the other transfer
is complete.



    CLFRA0076E: <error>
Exception while retrieving
activities collection.
    An error occurred
while transferring Activities
content from one content store to another.
    Check that the content stores are available
and accessible.



    CLFRA0077E:
ObjectStoreConfigLoader: the class
"<className>" could not be instantiated.
    An
error occurred while processing the Activities
content store configuration.  Additional information relating to the failure may be found in the SystemOut.log file.
    Verify the <objectStore> configuration
information in oa-config.xml is correct.  If the problem persists
after restarting the Activities application, contact Customer Support
to report the incident.



    CLFRA0078E:
Source ObjectStore ID="<id>"
not found in ObjectStore registry.  Double-check the oa-config.xml
file.
    An error occurred while transferring
Activities
content from one content store to another.  The requested source object
store identifier was not found.
    Check
the spelling of the ID used and compare
it with the available object stores listed in the oa-config.xml file.



    CLFRA0079E: {0} error initializing
adapter:
classname= "{1}"  Double-check the config settings for this specific
adapter for correct/valid values.
    An
error occurred while processing the Activities
content store configuration.  Additional information relating to the failure may be found in the SystemOut.log file.
    Verify the configuration information
for the object store is correct.  If the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0080E: ObjectStoreConfigLoader:
missing
id for activities object store class "<className>".
    An error occurred while loading the Activities
content store configuration.
    Verify
that the configuration information
for the object store is correct.  If the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0081E: EventBrokerConfigLoader:
the class
"<className>" was not found. Check the configuration file, under
the class attribute of the service for the correct Java classname. Or, check the classpath to make
sure the class is visible.
    An error occurred
while processing the Activities
content store configuration.  Additional information relating to the failure may be found in the SystemOut.log file.
    Verify the configuration information
for the object store is correct.  If the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0082E: Unable
to access content reference
for ACTIVITYUUID=<uuid>, NODEUUID=<uuid>, CONTENTREFUUID=<uuid>.
    An error occurred while transferring the content
of the specified activity from one content store to another.
    Check that the content stores are available
and accessible and that the referenced item exists in the content
store.  The item may have been deleted by an external process.



    CLFRA0084E: error terminating activities
object
store.
    An error occurred while terminating
the Activities
content store.  Additional information relating to the failure may
be found in the SystemOut.log file.
    If
the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0085E: Activities
Schema Version Mismatch. Current® database
schema version
is <version>. Activities requires version <version>.
    The system is expecting a certain schema version
on the database.  However, the database is reporting it has a different
version.
    Upgrade the Activities'
codebase, or upgrade
the database schema to match.



    CLFRA0087E:
The content of mime type: "<type>"
or filename: "<fileName>" you tried to upload exceeded the size
limit of <integer> bytes. Talk to your administrator about increasing
the permitted upload size.
    The administrator set a size limit for the type
of content a user tried to upload, either by mime type or by filename.
    Change the upload limits in the <sizeLimits>
element in oa-config.xml or upload something smaller.



    CLFRA0088E: A profile provider error has occurred. <error>
    Activities received an error querying the directory
(i.e. LDAP) for a user or group.
    Ensure
that the LDAP server configured for
the WebSphere Application Server is accessible and that the bind credentials used to authenticate
to the LDAP server (if necessary) are valid.



    CLFRA0090E: profile provider error.
    Activities received an error querying the directory
(i.e. LDAP) for a user or group.
    Ensure
that the LDAP server configured for
the WebSphere Application Server is accessible and that the bind credentials used to authenticate
to the LDAP server (if necessary) are valid.



    CLFRA0091E: internal error.
    Activities
generated an exception.
    If the problem
persists after restarting
the Activities application, contact Customer Support to report the incident.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRA0092E:
A short description could not be
generated because the entry contains invalid HTML.  Clicking on [more]
will display the full description.
    The
service tried to clean up user-submitted
HTML rich text input using the JTidy library.  The HTML was so malformed
that JTidy could not clean it, and produced a null result.  This error
is a message printed to the user that indicates the service could
not truncate the input HTML to produce a summary for display in the entry. 
    The user should attempt to
change the HTML
input, possibly by copying a different section of rich text to paste
into the entry body.



    CLFRA0093E:
exception while executing JTidy
on node: <uuid>.
    The service tried
to clean up user-submitted
HTML rich text input using the JTidy library.  JTidy failed to finish
executing on this HTML code before throwing an exception.
    The user should attempt to change the HTML
input, possibly by copying a different section of rich text to paste
into the entry body.



    CLFRA0094E:
output from JTidy execution: <html>.
    This
is a trace message that explains why JTidy
failed to process some HTML input.
    This
exception trace will inform you on
how JTidy failed and whether it could be fixed.



    CLFRA0095E: internal error while executing JTidy
on node: <uuid>.
    The service tried
to clean up user-submitted
HTML rich text input using the JTidy library.  The HTML was so malformed
that JTidy could not clean it, and produced a null result.
    The user should attempt to change the HTML
input, possibly by copying a different section of rich text to paste
into the entry body.



    CLFRA0096E:
Error fetching deleted items to
purge.
    The scheduled TrashAutoPurge job
received an
exception fetching the items to purge.
    Restart
the Activities application.  Additional
information relating to the failure may be found in the SystemOut.log
file.  If the problem persists after restarting the Activities application,
contact Customer Support to report the incident.



    CLFRA0102E: Error closing email connections.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0105E:
Error purging deleted items.
    The scheduled
TrashAutoPurge job received an
exception purging items.
    Restart
the Activities application.  Additional
information relating to the failure may be found in the SystemOut.log
file.  If the problem persists after restarting the Activities application,
contact Customer Support to report the incident.



    CLFRA0106E: Error sending notify message.
    Error when trying to send an email notification.
    Ensure that SMTP server configuration in
the <email> element of notification-config.xml is valid and that
the server is accessible.  Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRA0107E: Error composing HTML email message.
    Error received when trying to create an outbound
email message from the server.
    Restart
the Activities application.  Additional
information relating to the failure may be found in the SystemOut.log
file.  If the problem persists after restarting the Activities application,
contact Customer Support to report the incident.



    CLFRA0108E: EmailNotifier: problems sending
email.  The most probable cause is due to using an invalid recipient
email address. Or, the connection to the host is down.  Or, there
could also be authentication problems. Check the username and password
settings.
    Error received when trying
to send outbound
emails.
    Ensure that SMTP server configuration
in
the <email> element of notification-config.xml is valid and that
the server is accessible.  Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRA0109E: Malformed email template, url=<url>.
    The web address specified is in an invalid URL
syntax/format.
    Check oa-config.xml,
email/outbound/templates/url
and make sure the URLs are valid.  You can validate them by typing
the URLs directly into a browser.



    CLFRA0110E:
Error sending error message.
    Error received
when trying to send an email
error notification.
    Ensure that SMTP
server configuration in
the <email> element of notification-config.xml is valid and that
the server is accessible.  Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRA0111E: Unable to connect to any of the <number>
SMTP servers found on the MX records of the DNS server.
    The SMTP server is down, unreachable, or not
responding.
    Ensure that the SMTP
and DNS servers configured
in the <email> element of notification-config.xml are reachable.



    CLFRA0112E: Unable to get email template
from
url= <url>.
    Error trying to retrieve
an email template from
the given URL.
    Check oa-config.xml,
email/outbound/templates/url
and make sure the URLs are valid.  You can validate them by typing
the URLs directly into a browser.



    CLFRA0114E:
The email from "<sender>" with
subject "<subject>" did not match either the create or add-to matching
address expressions. The email will be deleted and not processed.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0115E:
The email address="<emailAddress>"
was not found in the directory.  Unable to process the message.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0116E:
Unable to find a member profile
for the email "<emailAddress>".  This user will not be added to
the activity membership.
    Should not see
this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0117E:
The activity you tried to email
into (id=<uuid>) is deleted or no longer exists.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0118E:
You need to update your configuration
file version.  Make sure you are not trying to use an old config file
on a newer server or vice-versa.
    The
version of oa-config.xml on the server differs
from the version expected by the Activities Application.
    Ensure the version property of the <config>
element in oa-config.xml matches the version expected by the Activities
Application.



    CLFRA0119E: ExecutionContext
leak detected.
    The Activities application
has detected a resource
leak.
    Restart the Activities application.
 Additional
information relating to the failure may be found in the SystemOut.log
file.  If the problem persists after restarting the Activities application,
contact Customer Support to report the incident.



    CLFRA0120E: Internal Error, EC Count is null.
    The Activities application has detected a resource
leak.
    Restart the Activities application.
 Additional
information relating to the failure may be found in the SystemOut.log
file.  If the problem persists after restarting the Activities application,
contact Customer Support to report the incident.



    CLFRA0121E: Error publishing event <event>.
    The Activities application received an error
from the Event Broker service.
    Check
that the <eventBroker> configuration
specified in oa-config.xml is valid.  Correct an invalid configuration.
 Additional information relating to the failure may be found in the SystemOut.log file.  If the problem persists after restarting the Activities application, contact Customer Support to report the incident. 



    CLFRA0122E: Cannot find credentials
for <name>.
    The system is configured
to use J2C Authentication
Aliases to store authentication data.  The entry for <name> is
missing.
    Go to Secure
administration,
applications, and infrastructure > JAAS > J2C authentication data in the WebSphere Application Server
Integrated Solutions Console, and check whether there is an entry
for <name>. If there is no entry, create an Authentication Alias
for <name> by completing these steps:


     
      


       
    1.  Shut down the WebSphere Application Server.





       
    2.  Edit the security.xml file in <APPServer_HOME>/profiles/AppSrv01/config/cells/<cell>





       
    3.  Find the authDataEntries entry with an alias that includes <name>.
For example: 						<authDataEntries alias="text/name"> 					2.5 





       
    4.  Replace "text/name" with "name"





       
    5.  Save the security.xml
file.





       
    6.  Restart the WebSphere Application Server.


    
If there is an entry for <name>, verify that the user credentials
are correct.  If these steps do not fix the problem, then contact
Customer Support.



    CLFRA0123E:
Profile provider error.
    Activities received
an error querying the directory
(i.e. LDAP) for a user or group.
    Ensure
that the LDAP server configured for
the WebSphere Application Server is accessible and that the bind credentials used to authenticate
to the LDAP server (if necessary) are valid.



    CLFRA0127W: Activities cannot determine host
name.
    An error occurred while initializing
the Statistics
collection service.  There was a problem with the server host name.
 Additional information relating to the failure may be found in the SystemOut.log file.
    If the problem
persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0131E: Activities
Task Scheduler initialization
error: <error>.
    Reason: An error occurred
while initializing
the Quartz scheduler.  Additional information relating to the failure
may be found in the SystemOut.log file.
    If
the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0135E: Error
executing event notification.
    Error received
in the event broker.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the problem persists after
restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0136E: Exiting
the Async Notification Thread:
event processing has been halted.
    Error
received when the event broker thread
is halted.  Additional information relating to the failure may be
found in the SystemOut.log file.
    If
the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0137E: Error
encountered processing events.
    Error
received in the event broker when dispatching
events.  Additional information relating to the failure may be found
in the SystemOut.log file.
    If the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0138E: The invoker should not be interrupted.
    Another
thread interrupted the internal event
broker.  Additional information relating to the failure may be found
in the SystemOut.log file.
    If the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0142E: Incorrect
number of arguments. 
Please specify the configuration file to process.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0143E:
Cannot locate configuration file
{0}.
    Should not see this error message.
 Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0144E:
ConfigurationParser: Bad configuration.
 Config section defines more properties than values, or vice versa.
 Possible errant <property> element(s) without a "name" attribute(s).
    A configuration element in oa-config.xml or
oa-jobs.xml is invalid.
    Enable debug
tracing for com.ibm.openactivities.util,
restart the application, and determine the invalid element from the trace.log output.  Correct the element and restart the Activities
application.



    CLFRA0146E: Unable
to refresh cached list of
groups.
    Activities received an exception
refreshing
its group cache.  Additional information relating to the failure may
be found in the SystemOut.log file. 
    If
the problem persists after restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0147E: Error
initializing Activities.
    The Activities
application received an error
trying to start.
    The cause of the error will be found in
the SystemOut.log file.  Correct the error cause and restart the Activities
application.



    CLFRA0270E: Error
getting server URL for <name>.
    There
was an error reading the server URL for
the <name> service.
    


     
      


       
    1.  Find
LotusConnections-config.xml (in <App server home>/profiles/<name>/config/cells/<cell
name>/LotusConnections-config) 		





       
    2.  Make sure the files exists
and is readable by the WebSphere Application Server process. 	





       
    3.  Make sure the files contains the correct
entry for the <name>
service.


    




    CLFRA0271E:
Cannot find config variable directory <directory>.
    There was a problem reading variables that can
be used in the oa-config.xml file.
    Make
sure the directory exists and is readable
by the WebSphere Application Server.



    CLFRA0272E: Cannot
find <file> for config
variables.
    There was a problem opening
a file getting configuration
variables.
    Make sure the file exists
and is readable
by the WebSphere Application Server.



    CLFRA0273W: Missing
system setting for <name>.
    The IBM Connections configuration cannot find a definition for a variable named "name".
    Either, check the installation documentation
for the variable to find the correct value for the variable, or add
the variable with its correct value in the WebSphere Application Server Integrated
Solutions Console, Environment/websphere Variables page. 



    CLFRA0275E: Error loading config variables
from <file>.
    There was a failure parsing
variables in file.
    


     
      


       
    1.   Make
sure the file exists and is readable by the WebSphere Application Server. 





       
    2.  Replace
the current copy with a back-up copy of the file.


    




    CLFRA0276E: Too many errors occurred
while sending
Activity auto-completion notices. The auto-complete operation was
aborted.
    The server has given up trying
to keep sending
any more auto complete email notices.
    Ensure
that SMTP server configuration in
the <email> element of notification-config.xml is valid and that
the server is accessible.  Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRA0277W: Warning, invalid parameter specified
for the Activity Auto Completion notification max errors ({0}).
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRA0278E:
An error occurred while generating
the list of activities eligible for auto completion.
    Error received querying the database to obtain
a list of activities that qualify to be autocompleted.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the problem persists after
restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0279E: Error
sending auto-complete notification
for activity UUID <uuid>.
    Error received
when sending email about an auto
complete notification.  Additional information relating to the failure
may be found in the SystemOut.log file.
    Ensure
that SMTP server configuration in
the <email> element of notification-config.xml is valid and that
the server is accessible.  Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRA0280E: Error initializing the Activities
Administrator email address.  Some email functionality will not be
available.
    No administrator email address
was configured
in oa-config.xml.
    Edit notification-config.xml
and provide
an administrator email address for the globalSenderEmailAddress property
and optionally provide additional email addresses for different types
of Activities notifications.



    CLFRA0281E:
The content of mime type: "<mimeType>"
or filename: "<fileName>" you tried to upload is not allowed by
your administrator.
    The administrator set a size limit of zero bytes
for the type of content a user tried to upload, either by mime type
or by filename.
    Change the upload
limits in the <sizeLimits>
element in oa-config.xml.



    CLFRA0282E:
The profile provider could not find
information for member <uuid>.
    The
Activities profile application did not find
a member by the given member ID.
    Contact
Customer Support to report the incident.



    CLFRA0285W: Purge expiration period (days) either
not specified or invalid (<integer>).  Defaulting to {1} days.
    The trashRetentionInDays configured for the TrashAutoPurgeJob in oa-jobs.xml is invalid.
    Add a value greater than 0 for the trashRetentionInDays
configuration.  Otherwise, trash older than 1 day will be purged when
the job runs.



    CLFRA0286E:
Error sending activity auto completion
notification.
    Error received when trying
to send an email
auto-completion notification.
    Ensure
that SMTP server configuration in
the <email> element of notification-config.xml is valid and that
the server is accessible.  Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRA0287E: Error parsing administrator email
address.
    The administrator email address
configured in
oa-config.xml is badly formatted.
    Edit
notification-config.xml and provide
an administrator email address in the correct format in the <globalSenderEmailAddress>
element.



    CLFRA0288E: No Activities
Administrator email
address has been configured.  You must specify a value for "globalSenderEmailAddress"
or "sender" in the notification configuration file.
    The administrator email address configured in
oa-config.xml is empty.
    Edit notification-config.xml
and provide
an administrator email address in the correct format in the <globalSenderEmailAddress>
element.



    CLFRA0289W: Content
removed by active content
filter.
    The active content filter removed
active content
from user input.
    No action necessary.



    CLFRA0290E: Error starting the active
content
filter.
    The active content filter received
an error
on start up.
    Contact Customer Support
to report the incident.



    CLFRA0291E:
Error encountered with the active
content filter.
    The active content filter
received an error
trying to filter text.
    Contact Customer
Support to report the incident.



    CLFRA0292W:
Warning, it appears the ACF inserted
an invalid character mid stream (<filteredText>).
    The active content filter inserted an invalid
character in the filteredText as part of a filtering operation.
    No action necessary.  The Activities application
fixes up the invalid character.



    CLFRA0293E:
A MemberProfile cannot be null.
    The data
in a request to update a member profile
in the database is null; possibly via a bad API request.
    Contact Customer Support to report the incident.



    CLFRA0295E: Cannot update non-matching
MemberProfiles. <uuid>
is not <uuid>.
    In a request to one
member profile with a new
one, the member IDs do not match.
    Contact
Customer Support to report the incident.



    CLFRA0300E: The ArchiveService cannot export
activities to the directory=<directory>; it is not writable.
    The exportActivities command of ArchiveService
wsadmin object tried to archive Activities to a directory that is
not writable.
    Ensure that <directory>
exists and that
it is writable by the WebSphere Application Server.



    CLFRA0301E: The required
zip file "Activity-<uuid>.zip"
was not found.  This activity will not be imported, or a related activity
link will be broken.
    The ArchiveService
was requested to import activity
with uuid <uuid>.  However, the directory path that was also given
to the ArchiveService does not contain the file Activity-<uuid>.zip.
    Ensure that the directory specified in an
ArchiveService importActivities or createActivities command contains
the archives for the desired Activities.



    CLFRA0304E: The version of the archive you tried
to import does not match the current DB schema.
    One cannot import activities into servers that
are using different DB schemas
    Migrate
the archive to the matching schema
version and then import the migrated archive.



    CLFRA0306W: The user by email (or display name
if it's a group) <member> was not found in the LDAP or the database!
 This means the activity being imported has a reference to a user
that has changed emails, or has been removed from the LDAP. In other
words, this email address is stale, and the activity is carrying around
incongruent data.
    A member that was included
in the imported activity
cannot be found anymore.  This might happen when switching LDAP servers,
and the membership list is different.
    No
action necessary.  The imported activity
will be imported, the missing member email address (or display name
if a group) will be rewritten to "NOT_FOUND_<original emal>". 
If this behavior is unexpected, you might want to investigate why
members are missing in the new LDAP. 



    CLFRA0309E: The ArchiveService cannot export
activities to the directory=<directory>; it is not a directory.
    The exportActivities command of ArchiveService
wsadmin object tried to archive Activities to a directory that is
not writable.
    Ensure that <directory>
exists and that
it is writable by the WebSphere Application Server.



    CLFRA0310E: Error
writing activity entry #<uuid>
to the database.
    An ArchiveService import
error received at the point where the Node of the Activity is written.  Additional information
relating to the failure may be found in the SystemOut.log file.
    If the error reported in the SystemOut.log
file cannot be resolved, contact Customer Support to report the incident.



    CLFRA0312E: Error writing activity
node to the database.
    An ArchiveService import error
received at the point where one of the nodes (entries) of the Activity is written.
 Additional information relating to the failure may be found in the SystemOut.log file.
    If the error
reported in the SystemOut.log
file cannot be resolved, contact Customer Support to report the incident.



    CLFRA0315E: The ArchiveService cannot
create
the directory=<directory> for exporting activities.
    In an ArchiveService exportActivities command
one specifies a directory where all the archive files will be written.
 In this case, the system cannot write out the specified directory
to the file system.
    Manually create
the <directory> on the file system and ensure it is writable by the WebSphere Application Server.



    CLFRA0318E: The related activity with UUID=<uuid>
already exists in the system.  It is unclear whether the intention
is to overwrite that activity with old data or not.  Thus, it will
be not imported.
    When an activity has
a related activity link
in it, the ArchiveService will automatically try to import the related
activity.  However, if the ArchiveService is being run with "importActivities"
which overwrites activities rather than creating copies, then, it
is unclear to the system whether the administrator also intentionally
meant to overwrite related activities since that related activity
it was not explicitly passed in to be imported.
    If the administrator wishes to overwrite
the related activity, he can use the ArchiveService importActivites
command to overwrite the related Activity.



    CLFRA0319E: Error writing activity content entry
"<name>".
    An ArchiveService import
error received at the point where the content (files, attachments, etc) of one of the nodes
(entries) of the activity is written.  Additional information relating
to the failure may be found in the SystemOut.log file.
    If the error reported in the SystemOut.log
file cannot be resolved, contact Customer Support to report the incident.



    CLFRA0320E: Error importing activity
with UUID=<uuid>.
    An ArchiveService
import error.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the error reported in the SystemOut.log
file cannot be resolved, contact Customer Support to report the incident.



    CLFRA0321E: Error unpacking the archive.
    An ArchiveService import error received when
unmarshalling the Zip archive.
    The
Zip archive has been corrupted.  If the cause of the corruption cannot be determined, contact Customer
Support to report the incident.



    CLFRA0327I:
Status.
     
    Informational
message; no solution is needed.



    CLFRA0328W:
The <name> scheduler is not enabled
in config. Check spelling.
    An attempt
was made to start or stop a scheduler
that is not enabled in the oa-config.xml file or is named differently
than the name given in oa-config.xml.
    Enable
the scheduler by changing the 'enabled'
true/false setting.  Ensure the scheduler name is spelled correctly.



    CLFRA0329E: The attempt to start
the <name>
scheduler failed.
    The Quartz scheduler
did not start.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the problem persists after
restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0330W: The <name>
scheduler has already
been stopped.
    An attempt was made to
stop a scheduler that
is already stopped.
    Ensure that the scheduler is started before
attempting to stop it.



    CLFRA0331I:
The request to resume job {0} has
been submitted.
    The request to resume
the specified job has
been submitted.
    Informational message;
no solution is needed.



    CLFRA0332W:
The job <name> is not valid for
the {1} scheduler.
    An attempt was made
to carry out an action on
a job that is not running.
    Ensure
that the job name is spelled correctly
and that the job name is known to the system.



    CLFRA0333I: The job {0} was removed.
    The specified job was removed from the scheduler.
    Informational message; no solution is needed.



    CLFRA0334I: The {0} scheduler is
running.
    The specified job is running.
    Informational message; no solution is needed.



    CLFRA0335W: The job <name> is
already running
on the {1} scheduler.
    An attempt was
made to resume a job that is
already running on a scheduler.
    Ensure
that the job is paused before attempting
to resume it.



    CLFRA0336I:
The request to pause job {0} has
been submitted.
    The request to pause
the specified job has been
submitted.
    Informational message;
no solution is needed.



    CLFRA0337W:
The <name> scheduler has already
been started.
    An attempt was made to
start a scheduler that
is already started.
    Ensure that the scheduler is stopped before
attempting to start it.



    CLFRA0338I:
The {0} scheduler was stopped successfully.
    The
specified scheduler was stopped successfully.
    Informational message; no solution is needed.



    CLFRA0339W: The <name> scheduler
is disabled
in config.
    An attempt was made to start
or stop a scheduler
that is disabled in the oa-config.xml file.
    Enable the scheduler by changing the 'enabled'
true/false setting.



    CLFRA0340W:
The request to pause job <name>
failed.
    An error occurred while attempting
to pause
a job.  Additional information relating to the failure may be found
in the SystemOut.log file.
    No action
is required.



    CLFRA0341W: The job <name> has already been
paused on the {1} scheduler.
    An attempt
was made to pause a job that is already
paused on a scheduler.
    Ensure that
the job is running before attempting
to pause it.



    CLFRA0342I: The {0} scheduler is in standby
mode.
    The specified scheduler is in standby
mode.
    Informational message; no solution
is needed.



    CLFRA0343W: The request to resume job <name>
failed.
    An error occurred while attempting
to resume
a previously paused job.  Additional information relating to the failure
may be found in the SystemOut.log file.
    No
action is required.



    CLFRA0344I:
The {0} scheduler was started successfully.
    The
specified scheduler started successfully.
    Informational message; no solution is needed.



    CLFRA0345E: The attempt to stop the <name>
scheduler failed.
    The Quartz scheduler
did not stop.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the problem persists after
restarting
the Activities application, contact Customer Support to report the incident.



    CLFRA0346I: The job {0} on the {1} scheduler
has been paused.
    The specified job on
the specified scheduler
has been paused.
    Informational message;
no solution is needed.



    CLFRA0347E:
Error exporting activity UUID={0}.
    An
error occurred while trying to import the activity with the given UUID.
    Check
previous log messages for the actual
cause of the import failure.  Resolve the error and re-run the import.



    CLFRA0348W: The group "{0}" could
not be loaded
from LDAP or the database. Or, there might have been multiple matches
for the same name in LDAP.
    This error
is encountered when a group name
is not found or multiple matches to the name are found in the configured
directory.
    No action necessary. The activity will continue
to be imported; an entry for "NOT_FOUND_" + the group name will be
added to the member table and the membership list.



    CLFRA0349E: Error locating profile: EXID mismatch,
but email matches.  email={0}, directory EXID={1}, db EXID={2}.
    This error is encountered when a member entry
is found in the Activities database by the given email address, but
the external identifier does not match the LDAP record.
    


     Determine if the person's record has
changed in LDAP and if the two entries are really for the same person.
 If they are, use the Activities MemberService.





     synchMemberExtId
(email address) command to update the Activities database with the correct id.




    CLFRA0350E:
Error: the group profile "{0}" could
not be located in the Activities database.
    This
error is encountered during LDAP synchronization.
 The group could not be located in the Activities database.
    Check the spelling of the group name.



    CLFRA0351E: Error: the group profile
"{0}" could
not be located in the directory service.
    This
error is encountered during LDAP synchronization.
 The group found in the Activities database could not be located in
LDAP.
    Check the spelling of the group
name.



    CLFRA0352I: The group
profile "{0}" has been
synchronized with the directory services changing the external id
from {0} to {1}.
    This message is encountered
during LDAP synchronization.
 This record in the Activities database has been updated to match
LDAP.
    Informational message; no solution
is needed.



    CLFRA0353E: Error:
the member profile "{0}"
could not be located in the Activities database.
    This error is encountered during LDAP synchronization.
 The person could not be located in the Activities database.
    Check the spelling of the email address



    CLFRA0354I: The member profile "{0}"
has been
synchronized with the directory services changing the external id
from {0} to {1}.
    This message is encountered
during LDAP synchronization.
 This record in the Activities database has been updated to match
LDAP.
    Informational message; no solution
is needed.



    CLFRA0355I: The member profile "{0}" matches
the directory service with external id {1}.
    This
message is encountered during LDAP synchronization.
 This record is already synchronized.
    Informational
message; no solution is needed.



    CLFRA0356E:
Error: the member profile "{0}"
could not be located in the directory service.
    This error is encountered during LDAP synchronization.
 The person could not be located in LDAP.
    There is no match for the person by the given value.  Check to see if the person exists in LDAP.



    CLFRA0357E: Error: more than one profile
was
found with the key "{0}".
    Multiple entries
identified by the <user
identifier> have been found in the member profile table.
    One of the entries must be deleted.  Contact
Customer Support before proceeding.



    CLFRA0358I: The group profile "{0}" matches
the directory service with external id {1}.
    This
message is encountered during LDAP synchronization.
 This record is already synchronized.
    Informational
message; no solution is needed.



    CLFRA0359E:
Error locating member profile for <user
identifier>, search type <internal search type>.
    The user's member profile could not be located
in the directory.
    Verify the LDAP
configuration is correct.
 If this error is limited to a specific user, verify the user can
be located in LDAP given the identifier in the error message.  The search type indicates what LDAP attribute is searched:  1=login, 2=email,
3=internal Activities member id (not used when searching LDAP). 



    CLFRA0360I: The {0} scheduler is
not running.
    The specified scheduler
is not running.
    Informational message;
no solution is needed.



    CLFRA0361E:
The file "{0}" cannot be uploaded
as it is a 0-byte file.
    An attempt was
made to upload the specified
file which has no content (zero bytes in size). Only files which have
content may be uploaded.
    Ensure that
the file contains data before
uploading.



    CLFRA0362E: FileSystem
property name="use.historic"
was not found in ObjectStore registry. Double-check the oa-config.xml
file.
    The use.historic property
is missing
from the ObjectStore section of the oa-config.xml file. It must be
present and must have a value of either true or false.
    Check the <objectStore> settings in oa-config.xml
file and provide a correct value for the use.historic property
of the <store> element. 



    CLFRA0363I:
The Notification service for {0}
is disabled in the configuration.  No notification messages will be
sent.
    The notification service for Activities
is disabled
in the configuration. This is an administrator controlled setting
that is stored in the notification-config.xml configuration file.
    No action is required. The message is informational
only. 



     CLFRA0364E: Error
initializing the Notification
service for {0}.  No notification messages will be sent.  Error details
: {1}.
    An unexpected error occurred while
initializing
the notification service for Activities. This is most likely due to
a configuration problem with the server or mail service.
    Verify the mail service is configured
properly. Additional information relating to the failure can be found
in the SystemOut.log file.



    CLFRA0365I:
Activities Notification service
started
    The notification service for
Activities started
successfully.  This is normal.
    No
action is required.  The message is informational
only. 



    CLFRA0366E: Activities
Notification service
initialization error: {0}
    An unexpected
error occurred while initializing
the notification service for Activities.  This is most likely due
to a configuration problem with the server or mail service.
    Verify the mail service is configured
properly. Additional information relating to the failure can be found
in the SystemOut.log file.



    CLFRA0367E:
The date {0} is invalid; see documentation
for acceptable date formats
    The date
supplied as a parameter is invalid.
 This date was supplied to the request to fix up the content store
after a restore from backup.  This is a WSAdmin command task.
    Enter a date that is valid according to
one of the documented acceptable formats.



    CLFRA0368E: The folder {0} does not exist
    The folder path which was supplied as a parameter
is invalid.
    Enter the path of a folder
that exists.



    CLFRA0369E: The attempt to fix up the content
store failed : {0}
    An error occurred
while attempting to fix up
the contents of the file store after a restore from backup.
    Verify the command was used properly
and that the file system is accessible.  Additional information relating
to the failure can be found in the SystemOut.log file.



    CLFRA0371E: Creation of the orphan folder
{1}
failed
    An error occurred while attempting
to create
the specified folder for orphaned files.
    Verify
that the path for the folder exists
and that the file system is accessible.  Also verify that the user
has write access to the file system.  Additional information relating
to the failure can be found in the SystemOut.log file.



    CLFRA0372I: {0} content store files were
moved
to the orphan folder.  Details are in the report file {1} in the folder
{2}.
     Informational message.  This message
is a status
report that is provided when the fix up utility task is used.
    No action is required.  The message is for
information only. 



    CLFRA0373E:
The value {0} for the content store
configuration is invalid.  Check oa-config.xml
    The directory given in oa-config.xml for the <store>
element property name root.directory either could not
be found or accessed.  This directory is used for file uploads to
the Activities content store.
    Check
that the directory exists. Create
it if it does not exist.



    CLFRA0374E:
file: {0} already exists.
    While attempting
to mark a file as "purged"
for subsequent deletion, the file could not be marked since a file
with that name already existed on the file system.  This should not
ordinarily happen.
    This is not a
critical situation but could
lead to extraneous files being left on the file system.  The administrator can safely manually remove any files that the purge task fails to
mark for deletion. Additional information relating to the failure
can be found in the SystemOut.log file.



    CLFRA0375E: error encountered while purging
content: {0} {1}.
    An error occurred while
attempting to remove
content from the file store or mark the file for deletion.
    Additional information relating to the failure
can be found in the SystemOut.log file. If the problem persists after
restarting Activities, contact Customer Support to report the incident.



    CLFRA0376E: unable to mark file:
{0} for deletion.
    An error occurred while
attempting to mark the specified file as "purged" for subsequent deletion.  The file could
not be marked for deletion from the file system.  This should not
ordinarily happen.
    This is not a
critical situation but could
lead to extraneous files being left on the file system.  The administrator can safely manually remove any files that the purge task fails to
mark for deletion. Additional information relating to the failure
can be found in the SystemOut.log file.



    CLFRA0377E: unable to purge file {0} {1}.
    An error occurred while attempting to mark the specified file as "purged" for subsequent deletion.  The file could
not be marked for deletion from the file system.  This should not
ordinarily happen.
    This is not a
critical situation but could
lead to extraneous files being left on the file system.  The administrator can safely manually remove any files that the purge task fails to
mark for deletion. Additional information relating to the failure
can be found in the SystemOut.log file.



    CLFRA0378E: The attempt to remove redundant
files from the content store failed : {0} 
    An
error occurred while attempting to remove
redundant files from the content store.  The files could not be removed
from the file system.  This should not ordinarily happen.
    This is not a critical situation but could
lead to extraneous files being left on the file system.  The administrator can safely manually remove any files that the purge task fails to
mark for deletion. Additional information relating to the failure
can be found in the SystemOut.log file. Ensure that the referenced
file exists and can be accessed.  If the problem persists after restarting
Activities, contact Customer Support to report the incident.



    CLFRA0379I: {0} items were removed
from  {1}
    Informational message.  This message is a status
report that is provided when the historic file purge task is used.
 It reports how many files were successfully removed from the specified
content store.
    No action is required.
 The message is informational
only. 



    CLFRA0380E: The content
store location is not
a valid directory or is missing: {0}
    The
file path specified in the oa-config.xml
file for the root.directory property either could not
be found or could not be accessed.  This directory is used for file
uploads to the Activities content store and must exist and be writeable.
    Check that the directory exists; create
it if it does not exist.



    CLFRA0381I:
Removal of redundant files from
content store started.
    The task that
removes previously purged files
from the file system has entered the running state.
    No action is required.  The message is informational
only. 



    CLFRA0382E: Unable
to delete file {0} from the content store.  The system security manager denied file delete access.
    An error occurred while attempting to delete
a file from the content store.  The file could not be removed from
the file system since delete access to the file was denied by the system security manager.  This should not ordinarily happen.  Only
processes with the appropriate access credentials should be attempting
to delete files from the system.  Any failure should be investigated
by the system administrator to determine which process was attempting
the unauthorized access.
    This is
not a critical situation but could
lead to extraneous files being left on the file system. Additional
information relating to the failure can be found in the SystemOut.log
file. Ensure that the referenced file exists and can be accessed.
If the problem persists after restarting Activities, contact Customer
Support to report the incident.



    CLFRA0383E:
The content store cleanup job only
supports a file system object store.  Store is {0}.  Check oa-config.xml.
    The Activities content store must be a file
system content store.  No other type of content store is supported.
 
    Check in the oa-config.xml file
for the store type and ensure that it refers to a FileSystemObjectStore.



    CLFRA0384W: Unable to delete file
{0} from the content store.  Skipping this file.
    An
error occurred while attempting to delete
a file from the content store.  The file could not be removed from
the file system since the file delete operation failed.  This should
not ordinarily happen.
    This is not
a critical situation but could
lead to extraneous files being left on the file system.  Ensure that
the referenced file exists and can be accessed.  The administrator can safely manually remove any files that the historic purge task
fails to delete. Additional information relating to the failure can
be found in the SystemOut.log file. If the problem persists after
restarting Activities, contact Customer Support to report the incident.



    CLFRA0385I: Removal of redundant
files from
content store stopped.
    The task that
removes previously purged files
from the file system has stopped.  All files that are not referenced
by the Activities system should now have been completely removed.
    No action is required.  The message is informational
only. 



    CLFRA0386E: The file
does not exist.
    An error occurred while
attempting to delete
a file from the content store.  The file could not be removed from
the file system since it does not exist.  This should not ordinarily
happen.
    This is not a critical situation.
Additional
information relating to the failure can be found in the SystemOut.log
file.  Ensure that the referenced file exists and can be accessed.
 If the problem persists after restarting Activities, contact Customer
Support to report the incident.



    CLFRA0387E:
The directory is not empty.
    An error
occurred while attempting to remove
a directory from the content store.  The directory could not be removed
from the file system since it contained at least one file. This should
not ordinarily happen.
    This is not
a critical situation. Additional
information relating to the failure can be found in the SystemOut.log
file.  Ensure that the referenced directory exists and can be accessed
and verify that the files contained in it are no longer needed by
the Activities server.  If they are no longer used, then files in
that directory can be manually removed and the directory can be manually
removed.  If the problem persists after restarting Activities, contact
Customer Support to report the incident.



    CLFRA0388E: The file is read only.
    An error occurred while attempting to delete
a file from the content store.  The file could not be removed from
the file system since it is read only.  This should not ordinarily
happen.  Files in the Activities content store should be read-write
so that they can be updated, moved or deleted by the Activities system.
    This is not a critical situation. Additional
information relating to the failure can be found in the SystemOut.log
file.  Ensure that the referenced file exists and can be accessed.
 If necessary, change the file access permissions to read-write. If the problem persists after restarting Activities, contact Customer
Support to report the incident.



    CLFRK0002E:
Unable to determine memberUUID for
{0}.
    The federated realm is not configured
correctly
or the wimconfig.xml file contains errors.
    Follow the instructions provided in the Installation Guide for Set up federated repositories.
 If you edited the wimconfig.xml file, revert to the original copy
of the file.



    CLFRK0003E: Unable
to locate VMM Profile Service
{0}.
    The VMM component is not functioning
properly.
    Ensure that the system
is configured as
a 'federated realm' by following the instructions provided in the Installation Guide for Set up federated repositories.



    CLFRK0004E: Unable to locate LDAP
Profile Service
{0}.
    The LDAP component is not functioning
properly. 
    You may be trying to implement
a configuration
that is not currently supported by IBM Connections.
 To prevent this error, you would have to configure the system as
a 'standalone LDAP user registry,' which is currently not supported.



    CLFRK0005E: Unable to locate Persona
Profile
Service {0}.
    The Profiles Service Atom
feed component is
not functioning properly.
    You may
be trying to implement a configuration
that is not currently supported by IBM Connections.
 To prevent this error, you would have to configure the system to
rely on the Profiles service Atom feed, which is not currently supported.



    CLFRK0006E: Unable to locate Memory
Profile
Service {0}.
    The memory model service
of the Waltz component
is not functioning properly.
    You
may be trying to implement a configuration
that is not currently supported by IBM Connections.
To prevent this error, you would have to configure Tomcat as the memory
model, which is an unsupported configuration.



    CLFRK0007E: Unable to access directory settings
for IBM Connections {0}.
    IBM Connections cannot find the LotusConnection-config.xml file.
    Make sure the LotusConnection-config.xml
file is installed on the system.



    CLFRL0001E: Error getting person for
email <email>.
    The email
tag is used as a key when
query person in database.  This error is encountered if a SQL exception
occurs when querying database.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0003E: Dogear servlet error.
    This error is encountered when Bookmarks
servlet failed to handle the user requests.
    Check the detailed exception message
below this error massages in the log file to find the root cause.
 If this error occurs for all requests then it is likely a downstream
error condition from a previous configuration error.   Check the logs
from server startup for the first error condition. 



    CLFRL0006W: Lock slow refresh rate:
dt = {0}.
    This is a utility
log message that
should not affect the end user for lock file {1}.
    No action necessary.



    CLFRL0011E: Unable to parse atom post
entry sent by user <user>.
    Bookmarks
received an Atom Publishing
request that we could not parse because of invalid syntax.
    No action is required if this error
does not persist.  The requesting client will receive an error 400® code notifying that it sent
a bad request.  If this error continues, it is likely that a client
continues to send bad requests.  Examine the HTTP server logs to determine
the source of the requests and report the problem to the application
developer creating these requests.



    CLFRL0014E: Internal error updating
memberids from file with email <link_line><message>Check the detailed exception message below this error message in the log file
to find the root cause.  See the dogear admin guide for more details.
    This error is encountered if an unexpected
exception occurs when updating a batch of memberids by email from
a file in administrative service.
    Check the detailed exception message
below this error massages in the log file to find the root cause.
 See the Administering IBM Connections section of the information center for more details.



    CLFRL0015E: Internal error retrieving
task by node id <message>.
    This
error is encountered if an unexpected
exception occurs when Bookmarks is trying to retrieve a task in the administrative service.
    Check
the detailed exception message
below this error massages in the log file to find the root cause.
 See the Administering IBM Connections section of the information center for more details.



    CLFRL0016W: Failed to submit for person: <user>.
    This warning is encountered if an unexpected
IO exception occurs when trying to submit browser bookmarks for the specified user.
    If this
warning only occurs on
some browser import actions, then no action is required.  Check the detailed exception message below this error message in the log file
to find the root cause.



    CLFRL0019E:
Error getting person for
member id <member_id>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get the person with the specified
member ID from the database.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0020W: An error occurred while
parsing the search query for search spec: {0}.
    This warning is encountered if the Lucene service is unable to retrieve a search term.
    No action required.



    CLFRL0022E: Error updating url for
id <id>.
    This error is encountered
if an unexpected
SQL exception occurs when trying to retrieve a web address with the specified ID.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready. Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0023E: An error occurred while
closing the index modifier during a commit.
    Bookmarks runs the indexing service
as a background task.  This error is encountered if an unexpected
exception occurs when trying to close the index modifier during a
commit. 
    No action is required
if this error
does not persist.  If this error continues, you may check the detailed
exception message below this error massages in the log file to find
the root cause.  If restarting the application does not resolve and
the index appears corrupt or is unusable you may use the Bookmarks
administrative service to reset the indexing task.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0024E:
Error deleting link <link_id>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to delete the specified link from
the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0026E: Error finding file <file>.
    This error is encountered if Bookmarks
cannot find the specified file when trying to perform batch operations
in the administrative service.
    See
the Administering IBM Connections section of the information center
for more details on how to specify a file with the administrative
service.  Ensure the administrative process has proper file permissions.



    CLFRL0029E: An error occurred
release
lock file <file>.
    This error
is encountered if an unexpected
IO exception occurs when trying to release the lock file.
    No action is required if this error
does not persist.  If this error continues, you may need to stop the affected node, delete the file by hand, and restart the node.  This file is located in the same directory as your full text index.  See
the Administering IBM Connections section of the information center for help determining that location.
 If the problem still continues, check disk permissions for the WebSphere Application Server
process, also check the detailed exception message below this error
message in the log file to find the root cause.



    CLFRL0030E: Attempt by <user> to
create subscription for <subscriber>.
    This error is encountered when a user
is trying to create a watchlist entry as another user.
    This action is not allowed and
the watchlist entry will not get created.  If it is a malicious user,
you can contact or restrict the user.



    CLFRL0032E: Attempt by <user> to
update or delete <link>.
    This
error is encountered if a user
attempts to delete another user's link.  The link will not get deleted.
    If the delete action was performed
for administrative purpose, please see the Administering IBM Connections section of the information center.
 If it was performed by a malicious user, you can contact or restrict
the user.



    CLFRL0034E:
Failed to rollback <task>
will continue to rollback other tasks.
    Bookmarks runs some background tasks
periodically.  This error is encountered if an unexpected exception
occurs when one is doing a rollback of the specified task.
    No action is required if this error
does not persist.  If this error persists, check the detailed exception
message below this error massages in the log file to find the root
cause.



    CLFRL0036E:
Error updating subscription <subscription_id>.
    This error is encountered if an unexpected
SQL exception occurs when trying to delete the specified watchlist
entry.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0039W: An error occurred loading
task <task> , skipping.
    Bookmarks
runs a background link processing
task periodically. This error is encountered if an unexpected exception
occurs when initializing the link processing task.
    Check the detailed exception message
below this error massages in the log file to find the root cause.



    CLFRL0043E: Error getting
tag counts
for url <url>.
    This error
is encountered if an unexpected
SQL exception occurs when trying to get tag counts for the specified
URL.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0048E: Error updating Url.
    This error is encountered if an unexpected
SQL exception occurs when trying to update a URL.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0049I: Retrieve batch of url
ids.
    The Bookmarks admin task
has retrieved
a batch from the database and is about to process them to assign intranet
or internet status to them.
    Informational
message; no solution
is needed.



    CLFRL0050W:
Failed to transform URL
encoder from <string>.
    This
warning is encountered if UTF-8
encoding is not supported on the server.  Bookmarks will use default
encoding to encode the strings.
    Check
the encoding settings of
the system and make sure UTF-8 is supported by the system.



    CLFRL0051E: Internal error deleting
link with UID <link_uid>_<message>.
    This error is encountered if an unexpected
exception occurs when Bookmarks is trying to delete a link with the specified UID in the administrative service.
    Check if the UID provided is correct.
Check the detailed exception message below this error massages in
the log file to find the root cause.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0052E:
Error getting subscription
on person <person>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get a list of people who have
a specified person in their watchlist
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready. Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0055E: Error getting url ids.
    This error is encountered if an unexpected
SQL exception occurs when trying to get a batch of URL ids.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0056E: Dogear JSP tag error. 
Error message: <message>.
    This
error is encountered if an unexpected
exception is propagated to the UI tier of the application.
    Check the detailed exception message
below this error message in the log file to find the root cause.



    CLFRL0057E: Error getting
tag set counts
person <person>.
    This error
is encountered if an unexpected
SQL exception occurs when trying to get tag set counts for the specified
person.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0058E: Error getting link count
for person <person>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get link count for the specified
person in the database.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready. Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0061E: Error getting link count.
    This error is encountered if an unexpected
SQL exception occurs when trying to get link count in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready. Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0062E: Error registering MBean.
    This error is encountered if an unexpected
JMX exception occurs when trying to register MBean during Bookmarks
application initialization.
    Check
the detailed exception message
in the log file to find the root cause.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0063W:
Unable to retrieve a favicon
from <icon_location>.
    This
warning is encountered if Bookmarks
fails to retrieve a favicon from the specified location. 
    Check the location and make sure
the favicon exists.  If it does not exists, check your favicon settings
in the dogear-config-node.xml or try restart the node.  If the warning
persists, reset the favicons storage.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0066E:
Error getting inbox links
for subscriptions <subscriptions>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get link for a user's watchlist
in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0067E: An error occurred marking
lock file <file> to keep alive -<error_message>.
    This error is encountered if an unexpected
IO exception occurs when trying to mark the lock file as alive.
    No action is required if this error
does not persist.  If the problem still continues, check disk permissions
for the WebSphere Application Server process, also check the detailed exception message below this
error message in the log file to find the root cause.



    CLFRL0068E: Error getting intersection
link count for tags <tags> and person <person>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get intersection link count for
the specified tags for the specified person in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere:  The custom
dependency checker rules directory you specified cannot be found,
or does not contain all the required files.  If you wish to continue,
the installer will use the default dependency checker rules directory.
 Otherwise, cancel the install and supply a different location for
the custom dependency checker rules directory. Application Server
to verify the database connection.



    CLFRL0069E: Error creating url <url>.
    This error is encountered if an unexpected
SQL exception occurs when trying to insert a URL to the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0070E: Error retrieving full links
for <link_ids>.
    This error
is encountered if an unexpected
SQL exception occurs when trying to get links with the specified ids
in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0071E: An error occurred while
loading the index searcher for <index_directory>.
    Bookmarks runs the indexing service
as a background task.  This error is encountered if an unexpected
exception occurs when loading the index searcher from the specified
directory.
    No action is
required if this error
does not persist.  If this error continues, you may check the detailed
exception message below this error message in the log file to find
the root cause.  If restarting the application does not resolve and
the index appears corrupt or is unusable you may use the Bookmarks
administrative service to reset the indexing task.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0074E:
Error getting links for
ft index queue, startpos=<start_pos> and count of <count>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get links in the link processing
queue from the specified start position with the specified count.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0077E: Error getting tag counts
for prefix <prefix> and limit <limit>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get tag counts for the specified
prefix with the specified limit.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0080E: Error getting union links
for tags <tags> and person <person>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get union links for the specified
tags for the specified person in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0081W: Failed to get favicon for
host {0}.  Use blank image.
    This
warning is encountered if the server had trouble caching a favicon for the specified URL.
    If this warning only occurs on
some URLs, then no action is required - this is normal.  If this warning
occurs on all URLs, check that the server can make outbound HTTP requests.
 You may need to setup an outbound proxy if the server is in a protected
zone.  Also check that the server process can write to the favicon
cache storage on disk.



    CLFRL0083E:
An error occurred detecting
or removing an obsolete lock file <file> - <error_message>.
    This error is encountered if an unexpected
IO exception occurs when checking if a lock file is active and/or
removing it if obsolete.
    No
action is required if this error
does not persist.  If this error continues, you may need to stop the effected node, delete the file by hand, and restart the node.  This file is located in the same directory as your full text index.  See
the Administering IBM Connections section of the information center for help determining that location.
 If the problem still continues, check disk permissions for the WebSphere Application Server
process, also check the detailed exception message below this error
message in the log file to find the root cause.



    CLFRL0084E: Error getting person counts
for url.
    This error is encountered
if an unexpected
SQL exception occurs when trying to get person counts for a URL.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0085E: Error getting popular tag
for url <url>.
    This error
is encountered if an unexpected
SQL exception occurs when trying to get popular tags for the specified
URL.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0086E: Attempt by <user> to
create link for <person>.
    This
error is encountered when a user
is trying to create a link for another person. 
    This action is not allowed and
the link will not get created.  If it is a malicious user, you can
contact or restrict the user.



    CLFRL0087E: Error updating link <link_id>.
    This error is encountered if an unexpected
SQL exception occurs when trying to update the specified link in the database.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0090E: Error getting intersection
links for tags <tags> and person <person>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get intersection links for the specified tags for the specified person in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0091E: An error occurred while
releasing the write lock during a commit.
    Bookmarks runs the indexing service
as a background task.  The task requires a write lock to ensure exclusive
write access to the index file.  This error is encountered if an unexpected
exception occurs when trying to release the write lock during a commit.
    No action is required if this error
does not persist.  If this error persists, you may need to stop the effected node, delete the file by hand, and restart the node.  This file is located in the same directory as your full text index.  See
the Administering IBM Connections section of the information center for help determining that location.
 If the problem still continues, check disk permissions for the WebSphere Application Server
process, also check the detailed exception message below this error
message in the log file to find the root cause.



    CLFRL0092E: An error occurred while
releasing the write lock during a rollback.
    Bookmarks runs the indexing service
as a background task.  The task requires a write lock to ensure exclusive
write access to the index file.  This error is encountered if an unexpected
exception occurs when trying to release the write lock during a rollback. 
    No action is required if this error
does not persist.  If this error persists, you may need to stop the effected node, delete the file by hand, and restart the node.  This file is located in the same directory as your full text index.  See
the Administering IBM Connections section of the information center for help determining that location.
 If the problem still persists, check disk permissions for the WebSphere Application Server
process, also check the detailed exception message below this error
message in the log file to find the root cause.



    CLFRL0093E: Error getting subscription
for person: <person>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get the watchlist for a specified
person.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0095E: Internal error recalculating
intranet ranges for url <url> <message>.
    This error is encountered if an unexpected
exception occurs when trying to update the ip address for a URL in
the administrative service.
    Check
the detailed exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for  more details.



    CLFRL0096E: Error updating memberid <member_id>.
    This error is encountered if an unexpected
SQL exception occurs when trying to update a user's member ID in the database.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0097E: Error getting links for
urls <url>.
    This error is
encountered if an unexpected
SQL exception occurs when trying to get links for the specified URL
in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0098W: Failed to check authentication
status of <url>.
    This warning
is encountered when trying
to check the authentication status of the specified URL.
    If this warning only occurs on
some URLs, then no action is required - this is normal.  If all URLs
when bookmarked are producing this warning, check that the server
can make outbound HTTP requests.  You may need to set up an outbound
proxy if the server is in a protected zone.



    CLFRL0101E: Error getting link for
person <person>.
    This error
is encountered if an unexpected
SQL exception occurs when trying to get links for the specified person
in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0102E: Error reading file <file>.
    This error is encountered if an unexpected
IO exception occurs when Bookmarks is trying to read the specified
file when trying to perform batch operations in the administrative
service.
    Check the detailed
exception message
below this error message in the log file to find the root cause. 
Ensure the administrative process has proper file permissions.  See
the Administering IBM Connections section of the information center for more details.



    CLFRL0104E: Error getting active tag
counts since <since_when>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get active tag counts since the specified time.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0105E: Using default icon cache <favicon_locations>.
    Bookmarks stores favicons in the location
which is determined at installation.  This error is encountered when
the favicon store location is not defined in dogear-config-node.xml.
 When this error occurs, Bookmarks creates temp favicons store location
in the temp folder.
    Open <WAS_Home>\profiles\<profile>\config\cells\<cell>\nodes\<node>\LotusConnections-config\dogear-config-node.xml
and correct the <property name="favicon.directory"> values in <favIconService> 



    CLFRL0106E: An error occurred
while
optimizing the ft index during a commit.
    Bookmarks runs the indexing service
as a background task.  This error is encountered if an unexpected
exception occurs when the index modifier is optimizing the full text
indexing during a commit.
    No
action is required if this error
does not persist.  If this error continues, you may check the detailed
exception message below this error message in the log file to find
the root cause.  If restarting the application does not resolve and
the index appears corrupt or is unusable you may use the Bookmarks
administrative service to reset the indexing task.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0107E:
ip address <ip_addr>
is an unknown or invalid host.
    Bookmarks
has different behavior on
intranet bookmarks and on internet bookmarks.  The ip range for intranet
is defined in dogear-config-cell.xml.  This error is encountered if
any ip address in the ip range definition is not a valid host. 
    


     Open <WAS_Home>\profiles\





     <profile>\config\cells\<cell>\





     LotusConnections-config\





     dogear-config-cell.xml
and correct





     the values in 





     <privateIntranetAllocation





     Table>.




    CLFRL0109W: Failed to run
import job.
    This warning is
encountered if an unexpected
exception occurs when running job to import browser bookmarks.
    If this warning only occurs on
some browser import actions, then no action is required.  It is likely
the user imported an invalid bookmark file.  Check the detailed exception
message below this error message in the log file to find the root
cause.



    CLFRL0110E:
Error getting active links.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get active links in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0111E: Error creating subscription
(<subscribee>,<tag>) for person <subscriber>.
    This error is encountered if an unexpected
SQL exception occurs when trying to create a watch list entry to the subscribee on the specified tag for the subscriber.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0114E: Error creating person <person>.
    This error is encountered if an unexpected
SQL exception occurs when trying to insert the person to the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0116E: Error getting subscribers
to tag <tag>.
    This error
is encountered if an unexpected
SQL exception occurs when trying to get watchlist entries on the specified
tag.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0119E: Error updating person <person_id>.
    This error is encountered if an unexpected
SQL exception occurs when trying to update the specified person in
the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0120E: Error getting recent tag
counts for person <person>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get recent tag counts for the specified person.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0123E: Failed to initialize DaoConfig.
    Bookmarks uses the IBatis Dao framework.
This error is encountered if an unexpected exception occurs when trying
to initialize DaoConfig.  The cause may be one of the following issues: 


     
      


       
    •  Bookmarks configuration file is missing or corrupted





       
    •  Database
connections is not available





       
    •  A downstream error from a previous
initialization problem


    

        		Check that directory.profile.xml
and directory.profile.xsd are in <WAS_Home>\profiles\<profile>\config\cells\<cell>\\LotusConnections-config\
folder and the files are not corrupted.  Check the database connections.
 Make sure the connection works fine by using "Test Connections" function
in WebSphere Application Server.  If this is likely a downstream error, scroll to the top of
the log file after server startup and identify the first error in
the logs.



    CLFRL0124E:
Error getting tag counts
for tags <tags> and person <person>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get associated  tag counts for
the specified tags and person.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0125E: An exception occurred while
processing background tasks.  Will continue on next cycle.
    Bookmarks runs some background tasks
periodically.  This error is encountered if an unexpected exception
occurs when processing a background task, but the task will continue
on next cycle.
    No action
is required if this error
does not persist.  If this error continues, you may check the detailed
exception message below this error message in the log file to find
the root cause.



    CLFRL0126E:
Internal error deleting
link <link>.
    This error is
encountered if an unexpected
exception occurs when Bookmarks is trying to delete the specified
link in the administrative service.
    Check the detailed exception message
below this error massages in the log file to find the root cause.
 See the Administering IBM Connections section of the information center for more details.



    CLFRL0127E: Internal error retrieving
user by email <email>.
    This
error is encountered if an unexpected
exception occurs when trying to find a person by email address in
the administrative service.
    Check
the detailed exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0128E: Internal error updating
memberid.
    This error is encountered
if an unexpected
exception occurs when updating memberids by email in administrative
service.
    Check the detailed
exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0130E: Error getting active count.
    This error is encountered if an unexpected
SQL exception occurs when trying to get active count in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0133E: Internal error deleting
link from file <file>.
    This
error is encountered if an unexpected
exception occurs when Bookmarks is trying to delete link from the specified file in the administrative service.
    Check the detailed exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0135I: Retrieve batch of person
ids.
    The admin task has retrieved
a batch
of users from the database and is about to update their member ids
with values from the LDAP.
    Informational
message; no solution
is needed.



    CLFRL0137E:
Error getting link for
id <link_id>.
    This error
is encountered if an unexpected
SQL exception occurs when trying to get a link with the specified
ID in the database.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0138E: Internal error updating
url <url> from file <message>.
    This error is encountered if an unexpected
exception occurs when trying to update the ip address for a URL or
update its intranet/internet status in the administrative service.
    Check the detailed exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0139E: Error getting tag counts
for person <person>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get tag counts for the specified
person.
    Check the detailed
exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0141E: Error deleting link by
person and url <message>.
    This
error is encountered if an unexpected
exception occurs when Bookmarks is trying to delete link by person
and URL in the administrative service.
    Check the detailed exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0142E: Error loading jndi context
for database resource.
    Bookmarks
loads JNDI context for database
resource at startup.  This error is encountered if the Bookmarks fails
to load JNDI.
    Log in to WebSphere Application Server
Integrated
Solutions Console and verify the JNDI configure for Bookmarks.  If settings previously worked, check for an expired password or locked
db administrative account.  Use the "Test Connections" in WebSphere Application Server
to verify the database connection.



    CLFRL0144E: An error occurred while
closing the index modifier during a rollback.
    Bookmarks runs the indexing service
as a background task.  This error is encountered if an unexpected
exception occurs when trying to close the index modifier during a
rollback.
    No action is required
if this error
does not persist.  If this error continues, you may check the detailed
exception message below this error message in the log file to find
the root cause.  If restarting the application does not resolve and
the index appears corrupt or is unusable you may use the Bookmarks
administrative service to reset the indexing task.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0145E:
Error retrieving search
result links <link_ids>.
    This
error is encountered if an unexpected
SQL exception occurs when trying to get search result links with the specified link ids.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0147E: Error getting url for: <url>.
    This error is encountered if an unexpected
SQL exception occurs when trying to retrieve a URL object by URL string.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0148E: An error occurred while
processing background tasks. Aborting.
    Bookmarks runs some background tasks
periodically.  This error is encountered if an unexpected exception
when processing a background task.  The task is aborted.
    Check the detailed exception message
below this error message in the log file to find the root cause.



    CLFRL0151W: An error occurred
loading
a task, skipping.
    Bookmarks
runs a background link processing
task periodically.  This error is encountered if the implement class
for this task cannot be loaded.
    This
value should never change
from the default value shipped with the product.  Open <WAS_Home>\profiles\<profile>\config\cells\<cell>\nodes\<node>\LotusConnections-config\dogear-config-node.xml
and check the value of class attribute of <task> in <linkProcessingTasks>
to see if it was modified from the default value.



    CLFRL0153E: Error creating link for
person <person> and url <url>.
    This error is encountered if an unexpected
SQL exception occurs when trying to create a link for the specified
person with the specified URL in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0154E: Verbiage size of <length>
or html verbiage size of <length> was too large when creating a
link for user <person> for <url>.
    This error is encountered if the verbiage
length exceeds the maximum length threshold when trying to create
a link for the specified user.
    Not
available



    CLFRL0155E:
Error getting url intersection
counts for people who have same url as <person>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get URL intersection counts for
people who have same URL as the person.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0157E: Unable to get ATOM payload
from servlet request.
    Bookmarks
was unable to retrieve the payload from a PUT or POST request from the Atom Publishing API.
    No action is required if this error
does not persist.  The requesting client will receive an error 400 code notifying that it sent
a bad request.  If this error continues, it is likely that a client
continues to send bad requests.  Examine the HTTP server logs to determine
the source of the requests and report the problem to the application
developer creating these requests.



    CLFRL0158E: Error getting person from
directory profile for email {0}.
    Bookmarks
uses Waltz to retrieve person
information from LDAP server.  This error is encountered if an unexpected
exception occurs when trying to get person from directory profile
with the specified email address.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the connection to LDAP server is available and the signer
certificate is valid.  See the Administering IBM Connections section of the information center
for more details.



    CLFRL0159E:
Error getting person from
directory profile for email <email>
    Bookmarks uses Waltz to retrieve person
information from LDAP server.  This error is encountered if an unexpected
exception occurs when trying to get person from directory profile
with the specified email address.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the connection to LDAP server is available and the signer
certificate is valid.  See the Administering IBM Connections section of the information center
for more details.



    CLFRL0160E:
Internal error with task
reset <message>.
    This error
is encountered if an unexpected
exception occurs when Bookmarks is trying to reset a task in the administrative
service.
    Check the detailed
exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0163E: Error getting link count
for url <url>.
    This error
is encountered if an unexpected
SQL exception occurs when trying to get link count for the specified
URL in the database.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0165E: An error occurred while
obtaining a write lock.
    Bookmarks
runs the indexing service
as a background task.  The task requires a write lock to ensure exclusive
write access to the index file.  This error is encountered if an unexpected
exception occurs when trying to write this file.
    No action is required if this error
does not persist.  If the error continues, check disk permissions
for the WebSphere Application Server process, also check the detailed exception message below this
error message in the log file to find the root cause.



    CLFRL0168W: The value for property <property_name>
 in the link processing service config was not an integer, skipping
config param.
    Bookmarks runs
a background link processing
task periodically.  Bookmarks defines the task running parameters
in configure files.  This error is encountered if the value of an
integer property is not an integer. 
    Open <WAS_Home>\profiles\<profile>\config\cells\<cell>\nodes\<node>\LotusConnections-config\dogear-config-node.xml
and correct the values in <linkProcessingTasks>.



    CLFRL0170E: Error deleting links prior
to <date>.
    This error is
encountered if an unexpected
SQL exception occurs when trying to delete links prior to the specified
date from the database.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0173E: Error getting all people.
    This error is encountered if an unexpected
SQL exception occurs when trying to get all person in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0174W: Failed to get URL string: <url_string>.
    This warning is encountered if the server is having trouble resolving URL redirects.
    If this warning only occurs on
some URLs, then no action is required - this is normal.  If all URLs
when bookmarked are producing this warning, check that the server
can make outbound HTTP requests.  You may need to setup an outbound
proxy if the server is in a protected zone.



    CLFRL0177E: Error getting most active
person counts since <since_when>.
    This error is encountered if an unexpected
SQL exception occurs when trying to list the most active Bookmarks
users in the database.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0178E: Internal error retrieving
url.
    This error is encountered
if an unexpected
exception occurs when trying to get a URL in the administrative service.
    Check the detailed exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0179E: Error getting inbox link
count for subscriptions <subscriptions>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get a link count for a user's
watchlist in the database.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0180W: Encountered more links
with identical timestamp than batch size, increasing batchsize to
{0} for this iteration.
    This
warning is encountered if the batch size provided by the user is less than the number of links for
the timestamp the processing service is working on.
    No action is required.



    CLFRL0181E: Error init Dogear config.
    This error is encountered if Bookmarks
is unable to properly load all required configuration files.
    Check the detailed exception message
of the exception.  It will show which configuration file is corrupted
or missing.  Edit the configure file to fix the error.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0182E:
Error getting person counts
for tag intersection <tags> and person <person>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get person counts for tag intersection
for the specified person with the specified tags.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0183E: Error getting person profile
from ldap for id: <login_id>.
    Bookmarks
uses Waltz to retrieve person
information from LDAP server.  This error is encountered if an unexpected
exception occurs when trying to get person profile from directory
profile with the specified login ID.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the connection to LDAP server is available and the signer
certificate is valid.  See the Administering IBM Connections section of the information center
for more details.



    CLFRL0185E:
Attempt by <user> to
update or delete <person>.
    This
error is encountered when a user
is trying to update or delete an entry form another user's watchlist.
    This action is not allowed and
the entry will not change.  If it is a malicious user, you can contact
or restrict the user.



    CLFRL0186E:
Error getting link for
person <person> and url <url>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get a link for a specified user
with a specified URL in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0187E: An error occurred reloading
the search index during a commit.
    Bookmarks
runs the indexing service
as a background task.  This error is encountered if an unexpected
exception occurs when reloading the index searcher during a commit.
    No action is required if this error
does not persist.  If this error continues, you may check the detailed
exception message below this error message in the log file to find
the root cause.  If restarting the application does not resolve and
the index appears corrupt or is unusable you may use the Bookmarks
administrative service to reset the indexing task.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0190E:
An error occurred creating
a lock file <file> - <error_message>.
    This error is encountered if an unexpected
IO exception occurs when trying to create the lock file.
    No action is required if this error
does not persist.  If the problem still continues, check disk permissions
for the WebSphere Application Server process, also check the detailed exception message below this
error message in the log file to find the root cause.



    CLFRL0191E: Internal error retrieving
batch from database <message>.
    This
error is encountered if an unexpected
exception occurs when retrieving a batch of URLs when trying to updated
their ip addresses or update their intranet/internet settings in administrative
service.
    Check the detailed
exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0193E: Error getting tag counts
for subscriptions <subscriptions>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get tag counts for the specified
watchlist entries.
    Check
the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0196E: Error getting union link
count for tags <tags> and person <person>.
    This error is encountered if an unexpected
SQL exception occurs when trying to get union link count for the specified
tags for the specified person in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0197W: Unable to generate UTF-8
bytes.
    This error is encountered
if Bookmarks
cannot convert the input strings to UTF-8 encoded bytes.  Bookmarks
will use default encoding to convert the strings.
    Check the encoding settings of
the system and make sure UTF-8 is supported by the system.



    CLFRL0198E: Error getting links.
    This error is encountered if an unexpected
SQL exception occurs when trying to get links in the database.
    Check the detailed exception message
below this error message in the log file to find the root cause and
make sure the database connection is ready.  Use the .Test Connections.
in WebSphere Application Server to verify the database connection.



    CLFRL0201E: An error occurred while
shutting down index searcher for <index_directory>.
    Bookmarks runs the indexing service
as a background task.  This error is encountered if an unexpected
exception occurs when shutting down the index searcher from the specified
directory.
    No action is
required if this error
does not persist.  If this error continues, you may check the detailed
exception message below this error messages in the log file to find
the root cause.  If restarting the application does not resolve and
the index appears corrupt or is unusable you may use the Bookmarks
administrative service to reset the indexing task.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0216E:
Internal error reprocessing
intranet address for url  <url> <message>.
    This error is encountered if an unexpected
exception occurs when reprocessing intranet address for URL in administrative
service.
    Check the detailed
exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0219W: Authorization failed for <user>
while invoking <method> on <servlet_path>, not granted any of
the required roles: <role>.
    This
warning is encountered if basic
authentication succeeds but the user is not authorized to use the Bookmarks application.
    Not
available.



    CLFRL0220W:
Basic Authentication failed
for <user> while invoking <method> on <servlet_path>.
    This warning is encountered if basic
authentication fails for the user.  This is usually a wrong username
or password.
    Not available.



    CLFRL0221E: ERROR unable
to find url
matching url string <url_string> provided.
    This error is encountered if no URL
in database matches the specified URL string when trying to update
ip address or update intranet/internet status in the administrative
service.
    Provide a valid
URL.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0222E:
Failed to delete task from
database table with task id <task_id>.
    This error is encountered if an attempt
is made to delete a non existent task in the administrative service.
    Get a list of valid task ids and
delete the desired task by the correct ID.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0223E:
ERROR Unable to find link
matching UID provided.
    This
error is encountered if no link
in database matches the specified uid when running administrative
service to delete a link.
    Provide
a valid UID.  See the Administering IBM Connections section of the information
center for more details.



    CLFRL0224E:
Error deleting line when
deleting link by person url from file <message>.
    This error is encountered if an unexpected
exception occurs when Bookmarks is trying to delete link by person
and URL in the administrative service.
    Check the detailed exception message
below this error massages in the log file to find the root cause.
 See the Administering IBM Connections section of the information center for more details.



    CLFRL0225E: ERROR Unable to find link
matching email and url provided.
    This
error is encountered if no link
in database matches the specified email and URL when running administrative
service to delete a link.
    Provide
a URL and email that match
an existing link.  See the Administering IBM Connections section of the information center for more details.



    CLFRL0226E: Internal error updating
url from file <message>.
    This
error is encountered if an unexpected
exception occurs when trying to update URL from file in the administrative
service.
    Check the detailed
exception message
below this error message in the log file to find the root cause. 
See the Administering IBM Connections section of the information center for more details.



    CLFRL0227E: ERROR unable to find person
matching email provided <email@>.
    This error is encountered if no person
in database matches the specified email when running administrative
service.
    Provide a valid
email. See the Administering IBM Connections section of the information center for more details.



    CLFRL0243E: One or both files are not
directories: [" {0} "] [" {1} "]" 
     
     



    CLFRL0244E: Directories have different
number of files: [" {0} "] has " {1} " files [" {2} "] has " {3} "
files
     
     



     CLFRL0245E:
Files do not both exist:
[" {0} "] [" {1} "] 
     
     



    CLFRL0246E: Could not get canonical
path for {0} 
     
     



    CLFRL0247E: One is a directory, the other isn''t: [" {0} "] [" {1} "] 
     
     



    CLFRL0248E: Files have different names:
[" {0} "] [" {1} "] 
     
     



    CLFRL0249E: File contents are different:
[" {0} "] [" {1} "]" 
     
     



    CLFRL0250E: Directories do not both
exist: [" {0} "] ["{1} "] 
     
     



    CLFRL0251E: Error deleting received
notifications of person {0} 
     
     



    CLFRL0252E: Error deleting notifications
sent by person {0} 
     
     



    CLFRL0254E: Error saving notifications. 
     
     



    CLFRL0255E: Error retrieving
full links
by URL and date for {0} 
     
     



    CLFRL0256E: Error getting the notification
with id {0} 
     
     



    CLFRL0257E: Error deleting notifications
on link {0} 
     
     



    CLFRL0258E: Error sending notifications
from {0} to {1} on bookmarks {2}  
     
     



    CLFRL0259E: Could not delete bookmarks
to {0} 
     
     



    CLFRL0260E:
Invalid link id from user:
{0}, link id: {1} 
     
     



    CLFRL0262E: Error deleting the notification
with id {0}
     
     



    CLFRL0263E:
Error parsing email addresses
when sending notifications. Emails: {0} 
     
     



    CLFRL0264E: Error sending notifications
as user {0} 
     
     



    CLFRL0265E: Error recording the notification
from person {0} to person {1} on link {2}  
     
     



    CLFRL0266E: Error getting most
visited
links. 
     
     



    CLFRL0267E:
Error getting notifications
on link {0} 
     
     



    CLFRL0271E: Service {0} is not correctly
configured. Bookmarklet can not point to the correct server if attributes
"enabled" and "href" are not set in the configure file. Please check IBM Connections configure file.
 
     
     



    CLFRL0272E:
Unable to load configure
file for bookmarklet installer.  
     
     



    CLFRL0273E: Failed to check bookmarklet
installer.  
     
     



    CLFRL0275E: Failed to update the bookmarklet
installer. 
     
     



    CLFRL0276E:
Failed to parse IBM Connections configure file. 
     
     



    CLFRL0278E: Unable to find configure
file for bookmarklet installer.  
     
     



    CLFRL0279E: Failed to get and parse
the profile for user {0}. 
     
     



    CLFRL0280E: Error getting recently
received notifications of user {0}. 
     
     



    CLFRL0282E: Error getting the number
of received notifications of user {0}. 
     
     



    CLFRL0283E: Error getting received
notifications of user {0}. 
     
     



    CLFRL0285E: Error sending notification
from {0} to {1} on bookmarks {2} 
     
     



    CLFRL0286E: Error parsing email addresses
when sending notifications. Emails: {0} 
     
     



    CLFRL0287E: Invalid link id from
user:
{0}, linkid: {1} 
     
     



    CLFRL0289E: Error getting schema version
from database. 
     
     



    CLFRL0291E: Error updating person {0}
with new locale {1}
     
     



    CLFRL0302E: Error: failed to update
ContentTypes with the ones from the configuration file. 
     
     



    CLFRL0303E: Error getting
the number
of ContentTypes in the most notified links. 
     
     



    CLFRL0306E: Error deleting all
ContentTypes
from database. 
     
     



    CLFRL0308E: Error getting received
notifications of user {0}, filtered by tag union. Tags: {1}. 
     
     



    CLFRL0309E: Error creating
ContentType
URL mappings for URL: {0} 
     
     



    CLFRL0310E: Error getting the number
of ContentTypes in received notifications of user {0}, filtered by
tag union. Tags: {1}. 
     
     



    CLFRL0311E: Error getting the number
of received notifications of user {0}. 
     
     



    CLFRL0312E: Error getting count
of
content types. 
     
     



    CLFRL0313E: Error getting received
notifications of user {0}, filtered by tag intersection. Tags: {1}. 
     
     



    CLFRL0314E: Error getting
tag counts
of received notifications for {0} 
     
     



    CLFRL0316E: Error getting person counts
of received notifications for {0} 
     
     



    CLFRL0317E: Error querying all ContentTypes
from database. 
     
     



    CLFRL0318E: Error: failed to get count
of ContentTypes from database. 
     
     



    CLFRL0319E: Error getting the number
of ContentTypes in received notifications of user {0}, filtered by
tag intersection. Tags: {1}. 
     
     



    CLFRL0320E: Error deleting all ContentType
URL mappings from database when updating the mappings. 
     
     



    CLFRL0320E: Error deleting
all URL-ContentType
mappings from database when updating URL-ContentType mappings. 
     
     



    CLFRL0321E: Error getting
count of
content types for person {0} 
     
     



    CLFRL0322E: Error getting the number
of ContentTypes in received notifications of user {0}. 
     
     



    CLFRL0323E: Error deleting
all ContentType
URL mappings from database. 
     
     



    CLFRL0327E: Error: failed to get specified
ContentType from database. 
     
     



    CLFRL0328E: Error getting count of
content types for subscriptions {0} 
     
     



    CLFRL0329E: Error getting the number
of received notifications of user {0}, filtered by tag union. Tags:
{1}. 
     
     



    CLFRL0331E:
Error getting the number
of ContentTypes in received notifications of user {0}. 
     
     



    CLFRL0332E: Error: failed
to delete
URL mappings of a ContentType from database. 
     
     



    CLFRL0334E: Error: failed to create
ContentType URL mapping. 
     
     



    CLFRL0335E: Error getting the number
of the most notified links. 
     
     



    CLFRL0336E: Error getting links for
full-text index queue, startpos 
     
     



    CLFRL0337E: Error: failed to insert
a ContentType record. 
     
     



    CLFRL0338E: Failed to verify request. 
     
     



    CLFRL0339E: Error: failed
to get links
count by ContentType. 
     
     



    CLFRL0342E: Error getting intersection
count of content types for tags {0} and person {1} 
     
     



    CLFRL0343E: Error getting
count of
content types for URL {0} 
     
     



    CLFRL0344E: Error getting notifications
by URL and date. 
     
     



    CLFRL0345E: Error getting the number
of received notifications of user {0}, filtered by tag intersection.
Tags: {1}. 
     
     



    CLFRL0346E:
Error: failed to record
the click on Link {0} 
     
     



    CLFRL0347E: Error writing ServiceConfigs
to feed. 
     
     



    CLFRL0349E:
Error getting structured
tag counts for person {0} 
     
     



    CLFRL0350E: Error getting number of
unique URLs last modified since {0} 
     
     



    CLFRL0352E: Error getting tag
counts
of sent notifications for {0} 
     
     



    CLFRL0354E: Error getting structured
tag counts of received notifications for {0} 
     
     



    CLFRL0355E: Error sending the notification
on broken URL from {0} to {1} on bookmark {2} 
     
     



    CLFRL0356E: Error getting notifications
sent by user {0}.  
     
     



    CLFRL0357E: Error getting person counts
of notifications sent by {0}. 
     
     



    CLFRL0358E: Error getting URLs last
modified since {0} 
     
     



    CLFRL0359E: Error getting the number
of notifications sent to user {0}. 
     
     



    CLFRL0360E: Error getting the number
of the notifications sent to user {0}, filtered by tag intersection.
Tag: {1}.
     
     



    CLFRL0361E:
Error getting the number
of the notifications sent to user {0}, filtered by tag union. Tag:
{1}. 
     
     



    CLFRL0362E:
Error getting tag counts
for hover text, tag is {0} 
     
     



    CLFRL0363E: Error getting structured
tag counts of sent notifications for {0} 
     
     



    CLFRL0364E: Error getting the notifications
sent to user {0}, filtered by tag intersection. Tag: {1}. 
     
     



    CLFRL0365E: Error: failed
to record
the click on Link {0} by Person {1} 
     
     



    CLFRL0366E: Error getting the notifications
sent to user {0}, filtered by tag union. Tag: {1}. 
     
     



    CLFRL0367E: Error getting
tag counts
for hover text for person {0}, tag is {1} 
     
     



    CLFRL0368E: Error parsing email
address
when sending broken URL notifications. Email: {0} 
     
     



    CLFRL0369E: Error getting login
names
for person id {0}. 
     
     



    CLFRL0371E: Error getting person for
login name {0} 
     
     



    CLFRL0373E: Internal error updating
login name by the provided id {0} 
     
     



    CLFRL0374E: Attempt by {0} to subscribe
to Anonymous User. 
     
     



    CLFRL0379E: Internal error updating
login names from file with member id {0} {1} 
     
     



    CLFRL0387E: Error getting person
profile
from LDAP for id: {0} 
     
     



    CLFRL0388E: Error deleting login names
for person id {0}. 
     
     



    CLFRL0390E: Unable to find person matching
the provided id {0} 
     
     



    CLFRL0392E: Error getting person profile
from LDAP for email: {0} 
     
     



    CLFRL0393E: Error getting login names
in batch 
     
     



    CLFRL0394E:
Error updating login names
for person id {0}. 
     
     



    CLFRL0397E: Internal error retrieving
user by member id {0} 
     
     



    CLFRL0398E: Error getting tags for
constraints {0}
     
     



    CLFRL0400E: Error getting deleted links. 
     
     



    CLFRL0403E: The term of
category is
not correct. 
     
     



    CLFRL0404E: No category specified in
the post entry. 
     
     



    CLFRL0405E: Notification body only
supports text format. 
     
     



    CLFRL0406E: Unable to parse Notification
Atom post entry sent by user {0} 
     
     



    CLFRL0407E: Dogear Notification API
only supports http post method. 
     
     



    CLFRL0408E: Links in the atom are private
or deleted. 
     
     



    CLFRL0409E: Recipients in the atom
cannot be found. 
     
     



    CLFRL0410E: Content type is not correct. Current ContentType is: {0} 
     
     



    CLFRL0411E: Error updating
last login
time {0} for person {1}   
     
     



    CLFRL0412E: An error occurred while
firing search request to Global Search service 
     
     



    CLFRL0413E: Error getting the number
of new and unique URLs posted in the last {0} days 
     
     



    CLFRL0414E: Error getting
the number
of users who have more than {0} bookmarks 
     
     



    CLFRL0415E: Error getting number
of
users logged on in the last {0} days. 
     
     



    CLFRL0416E: Error getting the number
of bookmarks that have at least 1 tag 
     
     



    CLFRL0417E: Error getting the number
of users who received notifications in the past {0} days. 
     
     



    CLFRL0418E: Error getting
the number
of new bookmarks posted in the last {0} days  
     
     



    CLFRL0419E: Error getting the number
of users who submit bookmarks in the last {0} days 
     
     



    CLFRL0420E: Error getting
the number
of users who sent notifications in the past {0} days. 
     
     



    CLFRL0421E: Error getting
the number
of tags posted in the last {0} days 
     
     



    CLFRL0422E: Error getting the number
of users who have not logged in for more than {0} days. 
     
     



    CLFRL0423E: Error getting
the number
of new tags posted in the last {0} days 
     
     



    CLFRL0424E: Error getting person
counts
for bookmarks with request parameters {0}.
     
     



    CLFRO0142E: No argument to method may be
null.
Cannot draw header or footer
     
     



    CLFRO0143E:
NavigationHelper class has not been
initialized
     
     



    0144E:
No argument to method may be null. Cannot
draw header or footer
     
     



    CLFRO0145E:
NavigationHelper class has not been
initialized
     
     



    CLFRO2001E:
Error processing config file: <path>, <filename>.
    The server encountered an error while parsing
the specified configuration file.
    Ensure
that XML configuration files in the LotusConnections-config folders are valid.



    CLFRO2002E: Unable to find configuration with
id: <config_id>.
    The server could
not retrieve an XML configuration
file with the requested ID in the LotusConnections-config folder hierarchy.
    Report this problem to Customer Support.



    CLFRO2003E: Error processing global
configuration
file
    The server could not retrieve or
successfully
parse a LotusConnections-config.xml configuration file from the LotusConnections-config
folder hierarchy.
    Report this problem
to Customer Support.



    CLFRO2004E:
Error: <filename> does not have
an id attribute in its config element.
    The
specified XML configuration file does not
have a value defined for the required id attribute
of the <config> element.
    Report
this problem to Customer Support.



    CLFRO2006E:
href attribute in <filename>
service element
    The specified XML configuration
file does not
have a valid value defined for the href attribute;
it should be a value that can be converted into a URL.
    Update the value of the href attribute
to be a properly formed URL string.



    CLFRO2009E: Entry for service <service_name>
does not exist in global config file <file_name>.
    The global configuration file does not have
a service reference for the requested service name.
    Report this problem to Customer Support.



    CLFRO2010E: Cannot locate schema
file <filename>.
    The server cannot
find an xsd file required
to validate the schema validation in the folder <app_server_profile>/config/cells/ <cell_name>/LotusConnections-config.
    Report this problem to Customer Support.



    CLFRP0001E: IBM Connections cannot use the WebSphere Application Server in: <FileLocation>.  Please refer to the following message
log for additional information: <LogFileLocation>
    The WebSphere Application Server is insufficient for IBM Connections.
    IBM Connections requires specific WebSphere Application Server applications and component levels.  Refer to the message log
file to determine why the WebSphere Application Server is insufficient for IBM Connections.
 Apply WebSphere Application Server changes as required to satisfy IBM Connections requirements.



    CLFRP0006E:
The specified directory is not valid.
 IBM Connections is already
installed in this location. 
    The selected
directory already has IBM Connections installed.
    Choose a different directory
or remove IBM Connections from
the selected
directory.



    CLFRP0007E: Operating
System prerequisite check
failed.  Refer to the message log file <LogFileLocation> for additional
information.
    The operating system is
not supported.
    Install IBM Connections on a supported operating system.  If your operating system is a newer
version of a supported platform, refer to the IBM Connections support site or contact Customer
Support to determine if the operating system level is supported.



    CLFRP0060E: There were no profiles
detected
for the installed WAS and managed node selected. 
    There were no profiles detected under the installed WebSphere Application Server.
    Make sure there are profiles under WebSphere Application Server.



    CLFRP0061E: The profile selected
cannot be validated.
 Please refer to the following logs for additional information: <LogFileLocation> <FileLocation>
    Cannot pass the validation of the selected profile.
    


     
      


       
    1.  Check the detailed exception message
below this error message
in the log file to find the root cause.





       
    2.  Make sure the profile
selected is valid and then try again.


    




    CLFRP0061W: WebSphere Application Server security must be enabled.
    WebSphere Application Server security is not enabled.
    Make
sure WebSphere Application Server security is
enabled, then try again.



    CLFRP0062E:
There were no servers detected for
the installed WebSphere Application Server.
    There were no servers detected
under the installed WebSphere Application Server.
    Make sure there is a server
instance under
the WebSphere Application Server profile selected.



    CLFRP0063E:
The server selected cannot be validated.
 Please refer to the following logs for additional information: <LogFileLocation> <FileLocation>
    The WebSphere AppServer
server is not valid.
    Make sure the WebSphere AppServer server
is valid.



    CLFRP0214E: The custom dependency checker rules
directory you specified cannot be found, or does not contain all the required files.  You must supply a different location for the custom
dependency checker rules directory.  The installer will now exit.
    The custom dependency checker rules directory
you specified cannot be found, or does not contain all the required
files.
    Check the value you supplied
for the custom
dependency checker rules directory.  Look at the logs for the files
that are required by the installer.  Also make sure all the required
dependency checker files exist in that directory.



    CLFRP0251E: Installation of Change Password
Application has failed.
    Failure to install
Change Password Application.
    


     
      


       
    1.  Check
the detailed exception message below this error message
in the log file to find the root cause.





       
    2.  Continue IBM Connections Pilot installation. 





       
    3.  After installation is completed, install
the file, changePassword.ear
from the following directory:


      <LotusConnectionsInstall
Location>\installable
Apps\
      



    




    CLFRP0252E:
The selected file does not have
a correct format, please select a correct one.
    The selected file does not have a correct format.
    Check the format of the user file according
to IBM Connections information
center, making sure it is correct.



    CLFRP0299E: An error occurred installing 6.1.0.0-WS-WAS-IFPK38815.pak,
please check log file <LogFileLocation>.
    Failure
to install 6.1.0.0-WS-WAS-IFPK38815.pak.
    


     
      


       
    1.  Check the detailed exception message below this error message
in the log file to find the root cause.





       
    2.  Continue IBM Connections installation, referring to WebSphere Application Server information center to install the interim fix 6.1.0.0-WS-WAS-IFPK38815.pak
manually once the IBM Connections installation is complete.


    




    CLFRP0300E: An error occurred installing WebSphere Application Server
V6.1.0.3.  For additional information, refer to the log file <LogFileLocation>
or <FileLocation>.
    Failure to install WebSphere Application Server.
    


     
      


       
    1.  Check the detailed exception message
below this error message
in the log file to find the root cause.





       
    2.  Cancel the IBM Connections installation.





       
    3.  Uninstall WebSphere Application Server and DB2 manually. (Refer
to WebSphere and DB2 information centers.)





       
    4.  Try
to install IBM Connections
Pilot again.


    




    CLFRP0301E:
An error occurred installing 6.1.0.3-WS-WAS-IFPK34390.pak.
 For additional information, refer to the log file <LogFileLocation>.
    Failure to install 6.1.0.3-WS-WAS-IFPK34390.pak.
    


     
      


       
    1.  Check the detailed exception message
below this error message
in the log file to find the root cause.





       
    2.  Continue the IBM Connections installation.





       
    3.  Refer to the WebSphere Application Server information center to install the interim fix 6.1.0.3-WS-WAS-IFPK34390.pak
manually once the IBM Connections installation is complete.


    




    CLFRP0303E: An error occurred installing WebSphere Update Installer
V6.1.0.1.  For additional information, refer to the log file <LogFileLocation>.
    This error is encountered if there is a failure
to install WebSphere Update
installer.
    


     
      


       
    1.  Check the detailed
exception message below this error message
in the log file to find the root cause.





       
    2.  Continue the pilot
installation.





       
    3.  After installation is completed, try to install WebSphere Update Installer
manually. (Refer
to the WebSphere Application Server information center.)





       
    4.  Install the 5 interim fixes mentioned
in the IBM Connections information
center.


    




    CLFRP0305W: WebSphere Application Server administrator passwords must match.
    WebSphere Application Server administrator passwords don't match.
    Make sure WebSphere Application Server administrator passwords match.



    CLFRP0306W: DB2 Administrator
password must match.
    The DB2 Administrator
password doesn't match.
    Make sure
the DB2 Administrator
password matches.



    CLFRP0307E:
A previous version of IBM Connections was found <FileLocation>.
 This version only requires a Fix Pack to be applied.  Refer to IBM Connections information center
for instructions on installing Fix Pack <FixPackVersion>.
    A previous version of IBM Connections was installed on the server.
    Either run upgrade installer for 1.0.2 or
uninstall previous IBM Connections,
then run 1.0.2 installer to install again.



    CLFRP0308W: DB2 Administrator
password field cannot be empty.
    The Administrator
password field is empty.
    Make sure
the DB2 Administrator
password field is not empty.



    CLFRP0309E:
An error occurred while installing IBM DB2 Express Edition fixpack1.  For additional information, refer to the log file <LogFileLocation>.
    Failure to install IBM DB2 Express Edition fixpack 1.
    


     
      


       
    1.  Check the detailed exception message below
this error message
in the log file to find the root cause.





       
    2.  Stop the Lotus Connection
Pilot installation and then remove DB2 manually.
(Refer to the DB2 information
center.)





       
    3.  Try to install Lotus Connection
Pilot again.


    




    CLFRP0310E:
An error occurred uninstalling WebSphere Update
Installer
V6.1.0.1.  For additional information, refer to the log file <LogFileLocation>.
    Failure to uninstall IBM WebSphere Update
Installer V6.1.0.1.
    


     
      


       
    1.  Check
the detailed exception message below this error message
in the log file to find the root cause.





       
    2.  Continue uninstalling IBM Connections.
 Refer to the WebSphere Application Server information center to uninstall WebSphere Update Installer V6.1.0.1 manually
after the IBM Connections installation is completed.


    




    CLFRP0311E: <ApplicationName>
application
already installed.
    The application has
already been installed.
    


     
      


       
    1.  Run
the uninstaller guide to uninstall the application.





       
    2.  Try to
install the application again.


    




    CLFRP0315E: An error occurred while uninstalling IBM WebSphere Application Server 6.1.  For additional information, refer to the log file <LogFileLocation>.
    Failure to uninstall IBM WebSphere Application Server 6.1.
    


     
      


       
    1.  Check the detailed
exception message below this error message
in the log file to find the root cause.





       
    2.  Continue uninstalling IBM Connections.





       
    3.  After uninstallation
is completed, try to uninstall WebSphere Application Server manually.
(Refer to the WebSphere information
center.)


    




    CLFRP0316E:
An error occurred installing 6.1.0.3-WS-WAS-IFPK37124.pak.
 For additional information, refer to the log file <LogFileLocation>.
    Failure to install 6.1.0.3-WS-WAS-IFPK37124.pak.
    


     
      


       
    1.  Check the detailed exception message
below this error message
in the log file to find the root cause.





       
    2.  Continue installing IBM Connections.





       
    3.  Refer to
the WebSphere Application Server information center to install the interim fix 6.1.0.3-WS-WAS-IFPK37124.pak
manually after the IBM Connections installation is completed.


    




    CLFRP0317E: An error occurred uninstalling WebSphere Application Server
V6.1.0.3.  For additional information, refer to the log file <LogFileLocation>.
    An error occurred while uninstalling WebSphere Application Server
V6.1.0.3.
    


     
      


       
    1.  Check the detailed
exception message below this error message
in the log file to find the root cause.





       
    2.  Continue uninstalling IBM Connections.





       
    3.  Refer to
the WebSphere Application Server information center to uninstall WebSphere Application Server V6.1.0.3 manually
after the IBM Connections installation is completed.


    




    CLFRP0318W:
The WebSphere Application Server administrator User name field cannot be empty.
    The WebSphere Application Server administrator User name field is empty.
    Make sure the WebSphere Application Server administrator User name field is not empty.



    CLFRP0319W: WebSphere Application Server administrator user name must be 30 characters or less.
    WebSphere Application Server administrator user name has exceeded 30 characters.
    Make sure the WebSphere Application Server administrator user name has 30 characters or less.



    CLFRP0321E: An error occurred while uninstalling IBM Update Installer for WebSphere Software Installation.
 For additional information, refer to the log file <LogFileLocation>.
    An error occurred while uninstalling IBM Update Installer.
    


     
      


       
    1.  Check the detailed exception message below
this error message
in the log file to find the root cause.





       
    2.  Continue the uninstallation.





       
    3.  After uninstallation is completed, try to uninstall WebSphere Update Installer manually. (Refer
to the WebSphere information
center.)


    




    CLFRP0322E:
An error occurred while creating
a user.  For additional information, refer to the log file <LogFileLocation>.
    This error is encountered if there is a failure
to start WebSphere Application Server or generate a user.
    Check
the detailed exception message below
this error message in the log file to find the root cause.  Try to
fix it and then do the user creation again.



    CLFRP0324E: Uninstallation of offerings has
failed.
    An error occurred while uninstalling
offerings.
    


     
      


       
    1.  Check the detailed
exception message below this error message
in the log file to find the root cause.





       
    2.  Try to fix it and
then uninstall again.


    




    CLFRP1001E:
db2jcc_license_cu.jar and db2jcc.jar
do not exist in <FileLocation>.
    The
directory you specified does not contain
all the required files.
    Make sure
db2jcc_license_cu.jar and db2jcc.jar
exist in the specified directory.



    CLFRP1002E:
ojdbc14.jar does not exist in <FileLocation>.
    Installer cannot locate ojdbc14.jar.
    Make sure ojdbc14.jar is in the specified
directory.



    CLFRP1003E: Cannot
connect to database using
provided settings, please check again!
    This
error is encountered if the user provided
settings are not correct.
    Input the correct database properties and
try again.



    CLFRP1004E: At
least one application must be
selected for uninstall.
    This error is
encountered if no application
is selected for uninstall.
    Make sure
at least one application is selected
for uninstall.



    CLFRP1005E:
At least one application must be
selected for install.
    This error is encountered
if no application
is selected for install.
    Make sure
at least one application is selected
for install.



    CLFRP1006E: uninstallInfo.txt
missing, unable
to uninstall this product.
    Cannot find
uninstallInfo.txt under the directory: 


    <LotusConnectionsInstall
Location>/<component>/
uninstall/profiles/
<profile>
    
.
        		Try to
recover uninstallInfo.txt, and perform
the uninstallation again.



    CLFRP1007E:
Uninstall of the component: <ComponentName>
has failed or this component has already been uninstalled.
    Failure to uninstall the component.
    


     
      


       
    1.  Check the detailed exception message below
this error message
in the log file to find the root cause.





       
    2.  Try to fix it and
then uninstall again.


    




    CLFRV0001E:
Viral content replaced.
    The virus scanner
removed a virus from added
content.
    No action necessary.



    CLFRV0003E: Virus detected - <error>.
    The virus scanner received the error <error>
scanning content.
    No action necessary.
 The content was not
added to the discussion forum. 



    CLFRV0006E:
Unable to find CMAPI provider "<providerName>".
    Unable to find a suitable CMAPI provider.
    Check the <objectStore> settings in forum-config.xml
and provide a correct <providerName> for the class property of
the store element. 



    CLFRV0007E:
Unable to store object. URL = <url>
HTTP status = <error>.
    An error occurred
while attempting to store
the discussion forum's content in the Domino content
store.
    Verify the Domino server is responding and that the URL
is accessible.  The HTTP response code may give additional information
as to the reason for the failure.



    CLFRV0008E:
Unrecognized URI: <url> for this
ObjectStore: <storeId>.
    An invalid
URL or URL syntax was used to access
the Domino content store.
    Verify the Domino server is responding and that the URI
is accessible.  Contact Customer Support for additional information.



    CLFRV0009E: Unable to access: <url>,
the
HTTP response code = <error>.
    An error
occurred while attempting to retrieve
a discussion forum's content from the Domino content
store.
    Verify the Domino server is responding.  The HTTP response
code may give additional information as to the reason for the failure.



    CLFRV0010E: Notes UNID
could not be retrieved. Make certain the database has the correct
design.
    An error occurred while attempting
to store
or update a discussion forum in the Domino content
store.
    Verify the Domino server is responding.  Verify that
the Domino object store is
using the correct NSF design.



    CLFRV0011W:
Content does not have a name, the generated name <url> will be used.
    A
warning that the content being saved did not
have a name while attempting to store or update a discussion forum
in the Domino content store.
    No action is required.  The system has generated
a name automatically.



    CLFRV0012E:
Unable to delete object. URL = <url>
HTTP status = <error>.
    An error occurred
while attempting to delete
a discussion forum from the Domino content
store.
    Verify the Domino server is responding and that the URL
is accessible.  The HTTP response code may give additional information
as to the reason for the failure.



    CLFRV0013E:
Unable to delete file <fileName>.
    An
error occurred while deleting a file from
the discussion forum content store.  Additional information relating
to the failure may be found in the SystemOut.log file.
    Verify the directory and file information
is correct.



    CLFRV0014E: Unable
to create file upload directory <directoryName>.
    The directory given in forum-config.xml for
the element property name "root.directory" either could not be found
or created.  This directory is used for file uploads to the discussion
forum content store.
    Check that the directory exists; create
it if it does not exist.



    CLFRV0015E:
Error encountered deleting content: <directoryName> <fileName>.
    An error occurred while deleting the contents
of a file from the discussion forum content store.  Additional information
relating to the failure may be found in the SystemOut.log file.
    Verify the directory and file information
is correct.



    CLFRV0016E: Unable
to upload file: <directoryName> <fileName>.
    An error occurred while retrieving or uploading
a file to the discussion forum content store.  Additional information
relating to the failure may be found in the SystemOut.log file.
    Verify the directory and file information
is correct.



    CLFRV0017E: Error
closing statistics file.
    A file system
error occurred closing one of
the files used for discussion forum statistics persistence.
    Verify the file system directory containing
the statistics files is writable and has available space.



    CLFRV0019E: Error creating statistics file.
    A file system error occurred creating one of
the files used for discussion forum statistics persistence.
    Verify the file system directory containing
the statistics files is writable and has available space.



    CLFRV0020E: Error parsing statistics file.
    The format of one of the files used for discussion
forum statistics persistence is inconsistent with the expected format.
    Remove the existing files in the file system
directory containing the statistics files.



    CLFRV0021E: Activities statistics persistence
cannot create directory <directory>.
    A
file system error occurred creating the file
system directory <directory> for containing the discussion forum
statistics files.
    Verify the server level WebSphere Application Server variable ACTIVITIES_STATS_DIR
is set to a valid directory location on the server's file system;
create the directory <directory> on the file system.



    CLFRV0022E: Error saving to statistics
file.
    A file system error occurred saving
data one
of the files used for discussion forum statistics persistence.
    Verify the file system directory containing
the statistics files is writable and has available space.



    CLFRV0023E: Error saving summary information.
    A file system error occurred saving data one
of the files used for discussion forum statistics persistence.
    Verify the file system directory containing
the statistics files is writable and has available space.



    CLFRV0026E: Error fetching profiles.
    The MemberService wsadmin object received an
exception executing a fetchMembers command.
    Verify the parameter to the fetchMembers
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRV0028E: Error updating acl.
    The AccessControlService wsadmin object received
an exception executing an access modification command.
    Verify the parameter to the command
is valid.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRV0029E:
Error fetching activities.
    The ActivityService
wsadmin object received
an exception executing a command to fetch the discussion forum.
    Verify the parameter to the command
is valid.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRV0030E:
Error fetching acl.
    The AccessControlService
wsadmin object received
an exception executing a fetchAccess command.
    Verify the parameter to the command
is valid.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRV0032E:
Error updating profile.
    The MemberService
wsadmin object received an
exception executing a updateMember command.
    Verify the parameter to the updateMember
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRV0033E: Error purging trash.
    The TrashCollectionService wsadmin object received
an exception executing a purgeTrash command.
    Verify the parameter to the purgeTrash
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRV0034E: Error fetching trash.
    The TrashCollectionService wsadmin object received
an exception executing a fetchTrash command.
    Verify the parameter to the fetchTrash
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRV0035E: Error undeleting trash.
    The TrashCollectionService wsadmin object received
an exception executing a undeleteTrash command.
    Verify the parameter to the undeleteTrash
command is valid.  Additional information relating to the failure
may be found in the SystemOut.log file.



    CLFRV0036E: Error locating MBeanServer, no Activity
Administration MBeans registered.
    An
exception was generated when the Discussion
Forum tried to locate the MBean server needed to register the Discussion
Forum Administration MBeans.
    Report
this problem to Customer Support.
 Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRV0038E:
Error registering mbean.
    An exception
was generated when the Discussion
Forum tried to register the Activities Administration MBeans.
    Report this problem to Customer Support.
 Additional information relating to the failure may be found in the SystemOut.log file.



    CLFRV0042E: <className>
error parsing generic
properties into a Properties object.
    An
exception was generated when the Event Broker
tried to parse its configuration from forum-config.xml.
    Ensure the properties and elements for the <eventBroker>
element in forum-config.xml  are valid. Additional information relating
to the failure may be found in the SystemOut.log file.



    CLFRV0043E: subscriber did not start: <className>.
    The Event Broker service is attempting to initialize
a subscriber to server-generated events, but the subscriber initialization
process failed.
    Check that the <eventBroker>
configuration
specified in forum-config.xml for the subscriber reporting this error
is valid.  Additionally, you may want to pursue the exception thrown
by the subscriber in the SystemOut.log file.



    CLFRV0044E: The class "<className>" was not
found.  Check the configuration file, under the class attribute of
the service for the correct Java classname.
 Or, check the classpath to make sure the class is visible. 
    The Event Broker service tried to load a Java class that did not exist in
the current classpath. 
    Check to
see whether the class specified
in the <eventBroker> configuration has been spelled correctly.
 Also check to see that the class file is visible in the current classpath
scope.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRV0045E:
The class "<className>" could
not be instantiated.
    The classloader
could not instantiate the class
requested by the Event Broker service.
    Investigate
whether something is wrong with
the classloader or the class specified in the <eventBroker> configuration
itself.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRV0046E:
Illegal access exception for the class "<className>".
    The Event Broker
service is trying to access
fields or methods in the class discovered via reflection that it can't
normally see.  Additional information relating to the failure may
be found in the SystemOut.log file.
    Examine
the class for methods that should
be exposed have been hidden.



    CLFRV0047E:
{0} error initializing adapter:
classname= "{1}"  Double-check the config settings for this specific
adapter for correct/valid values.
    The
Event Broker service is attempting to initializer
a subscriber to server-generated events, but the subscriber initialization
process failed.
    Check that the <eventBroker>
configuration
specified in forum-config.xml for the subscriber reporting this error
is valid.  Additionally, you may want to pursue the exception thrown
by the subscriber in the SystemOut.log file.



    CLFRV0048E: Could not inform a subscriber of
event: <eventName>.
    The Event Broker
service passed an event to
a subscriber of that event, and the subscriber issued an exception.
    To fix this class of exception, you need
to determine what is failing in this particular subscriber.  Additional
information relating to the failure may be found in the SystemOut.log
file.



    CLFRV0050E: Invalid
forum-config.xml file. 
Check the XML format and ensure that all required settings are complete.
    The format of forum-config.xml does not have
correct XML syntax.
    Load the forum-config.xml
file into a browser
or editor that will display syntax errors; fix the error and save
the file.



    CLFRV0051E: Error
decoding passwords.  If passwords
are encoded, some functionality may fail.
    Should
not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0068E:
OpenActivitiesException while updating
node content ref uuid=<uuid>.
    An error
occurred while updating the content
of the specified discussion forum.
    Check
that the content stores are available
and accessible and that the referenced item exists in the content
store.  The item may have been deleted by an external process.



    CLFRV0070E: Illegal access exception
for the class "<className>".
    An error occurred
while processing the discussion
forum content store configuration. Additional information relating
to the failure may be found in the SystemOut.log file.
    Verify the <objectStore> configuration
information in forum-config.xml is correct.  If the problem persists
after restarting the Discussion Forum application, contact Customer
Support to report the incident.



    CLFRV0071E:
DaoException while updating node
content ref uuid=<uuid>.
    An error
occurred while updating the content
of the specified discussion forum.
    Check
that the content stores are available
and accessible and that the referenced item exists in the content
store.  The item may have been deleted by an external process.



    CLFRV0072E: activities object store
did not
start: <className>.
    The Discussion
Forum Object Store service implemented
by <className> did not start.  Additional information relating
to the failure may be found in the SystemOut.log file.
    Verify the <objectStore> configuration
information in forum-config.xml is correct.  If the problem persists
after restarting the Discussion Forum application, contact Customer
Support to report the incident.



    CLFRV0073E:
Destination ObjectStore ID="<id>"
not found in ObjectStore  registry.  Double-check the forum-config.xml
file.
    An error occurred while transferring
discussion
forum content from one content store to another.  The requested destination
object store identifier was not found.
    Check
the spelling of the ID used and compare
it with the available object stores listed in the forum-config.xml
file.



    CLFRV0074E: ObjectStoreFilter:
error during
activities object store content filtering "<error>".
    An error occurred while processing discussion
forum content.  Additional information relating to the failure may
be found in the SystemOut.log file.
    Depending
on the additional error information
given, it may be possible to correct the data and re-process it.



    CLFRV0075E: Premature invocation
before transfer
is complete.  Check busy() method or listen for completion event.
    An error occurred while transferring discussion
forum content from one content store to another.  The transfer utility
may already be carrying out a transfer.
    Attempt
this operation after the other transfer
is complete.



    CLFRV0076E: <error>
Exception while retrieving
activities collection.
    An error occurred
while transferring discussion
forum content from one content store to another.
    Check that the content stores are available
and accessible.



    CLFRV0077E:
ObjectStoreConfigLoader: the class
"<className>" could not be instantiated.
    An
error occurred while processing the discussion
forum content store configuration. Additional information relating
to the failure may be found in the SystemOut.log file.
    Verify the <objectStore> configuration
information in forum-config.xml is correct.  If the problem persists
after restarting the Discussion Forum application, contact Customer
Support to report the incident.



    CLFRV0078E:
Source ObjectStore ID="<id>"
not found in ObjectStore registry. Double-check the forum-config.xml
file.
    An error occurred while transferring
discussion
forum content from one content store to another.  The requested source
object store identifier was not found.
    Check
the spelling of the ID used and compare
it with the available object stores listed in the forum-config.xml
file.



    CLFRV0079E: {0} error
initializing adapter:
classname= "{1}"  Double-check the config settings for this specific
adapter for correct/valid values.
    An
error occurred while processing the discussion
forum content store configuration. Additional information relating
to the failure may be found in the SystemOut.log file.
    Verify the configuration information
for the object store is correct. If the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0080E:
ObjectStoreConfigLoader: missing
id for activities object store class "<className>".
    An error occurred while loading the discussion
forum content store configuration.
    Verify
that the configuration information
for the object store is correct. If the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0081E:
EventBrokerConfigLoader: the class
"<className>" was not found. Check the configuration file, under
the class attribute of the service for the correct Java classname. Or, check the classpath to make
sure the class is visible.
    An error occurred
while processing the discussion
forum content store configuration. Additional information relating
to the failure may be found in the SystemOut.log file.
    Verify the configuration information
for the object store is correct. If the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0082E:
Unable to access content reference
for ACTIVITYUUID=<uuid>,  NODEUUID=<uuid>, CONTENTREFUUID=<uuid>.
    An error occurred while transferring the content
of the specified discussion forum from one content store to another.
    Check that the content stores are available
and accessible and that the referenced item exists in the content
store.  The item may have been deleted by an external process.



    CLFRV0084E: Error terminating activities
object
store.
    An error occurred while terminating
the discussion
forum content store.  Additional information relating to the failure
may be found in the SystemOut.log file.
    If
the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0085E:
Activities Schema Version Mismatch. Current database
schema version
is <version>. Activities requires version <version>.
    The system is expecting a certain schema version
on the database.  However, the database is reporting it has a different
version.
    Upgrade the discussion forum
codebase, or
upgrade the database schema to match.



    CLFRV0087E: The content of mime type: "<type>"
or filename: "<fileName>" you tried to upload exceeded the size
limit of <integer> bytes. Talk to your administrator about increasing
the permitted upload size.
    The administrator set a size limit for the type
of content a user tried to upload, either by mime type or by file
name.
    Change the upload limits in
the <sizeLimits>
element in forum-config.xml or upload something smaller.



    CLFRV0088E: Profile provider error.
    The Discussion Forum received an error querying
the directory (i.e. LDAP) for a user or group.
    Ensure that the LDAP server configured for
the WebSphere Application Server is accessible and that the bind credentials used to authenticate
to the LDAP server (if necessary) are valid.



    CLFRV0090E: Profile provider error.
    The Discussion Forum received an error querying
the directory (i.e. LDAP) for a user or group.
    Ensure that the LDAP server configured for
the WebSphere Application Server is accessible  and that the bind credentials used to authenticate
to the LDAP server (if necessary) are valid.



    CLFRV0091E: Internal error.
    The
Discussion Forum generated an exception.
    If
the problem persists after restarting
the Communities application, contact Customer Support to report the incident.  Additional information relating to the failure may be found
in the SystemOut.log file.



    CLFRV0092E:
A short description could not be
generated because the entry contains invalid HTML.
    The service tried to clean up user-submitted
HTML rich text input using the JTidy library.  The HTML was so malformed
that JTidy could not clean it, and produced a null result.  This error
is a message printed to the user that indicates the service could
not truncate the input HTML to produce a summary for display in the entry.
    The user should attempt to
change the HTML
input, possibly by copying a different section of rich text to paste
into the entry body.



    CLFRV0093E:
Exception while executing JTidy
on node: <uuid>.
    The service tried
to clean up user-submitted
HTML rich text input using the JTidy library.  JTidy failed to finish
executing on this HTML code before throwing an exception.
    The user should attempt to change the HTML
input, possibly by copying a different section of rich text to paste
into the entry body.



    CLFRV0094E:
Output from JTidy execution: <html>. 
    This
is a trace message that explains why JTidy
failed to process some HTML input.
    This
exception trace will inform you on
how JTidy failed and whether it could be fixed.



    CLFRV0095E: Internal error while executing JTidy
on node: <uuid>.
    The service tried
to clean up user-submitted
HTML rich text input using the JTidy library.  The HTML was so malformed
that JTidy could not clean it, and produced a null result.
    The user should attempt to change the HTML
input, possibly by copying a different section of rich text to paste
into the entry body.



    CLFRV0096E:
Error fetching deleted items to
purge.
    The scheduled TrashAutoPurge job
received an
exception fetching the items to purge.
    Restart
the Discussion Forum application.
 Additional information relating to the failure may be found in the SystemOut.log file.  If the problem persists after restarting the Discussion Forum application, contact Customer Support to report the incident.



    CLFRV0102E: Error
closing email connections.
    Should not
see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0105E:
Error purging deleted items.
    The scheduled
TrashAutoPurge job received an
exception purging items.
    Restart
the Discussion Forum application.
 Additional information relating to the failure may be found in the SystemOut.log file.  If the problem persists after restarting the Discussion Forum application, contact Customer Support to report the incident.



    CLFRV0106E: Error
sending notify message.
    Error when trying
to send an email notification.
    Ensure
that SMTP server configuration in
the <email> element of forum-config.xml is valid and that the server
is accessible.  Additional information relating to the failure may
be found in the SystemOut.log file.



    CLFRV0107E: Error composing HTML email message.
    Error received when trying to create an outbound
email message from the server.
    Restart
the Discussion Forum application.
 Additional information relating to the failure may be found in the SystemOut.log file.  If the problem persists after restarting the Discussion Forum application, contact Customer Support to report the incident.



    CLFRV0108E: EmailNotifier:
problems sending
email.  Most probable cause is due to using an invalid recipient email
address. Or, the connection to the host is down.  Or, there could
also be authentication problems - check the  user/password settings.
    Error received when trying to send outbound
emails.
    Ensure that SMTP server configuration
in
the <email> element of forum-config.xml is valid and that the server
is accessible.  Additional information relating to the failure may
be found in the SystemOut.log file.



    CLFRV0109E: Malformed email template, url=<url>.CLFRV0109E:
Malformed email template, url=<url>.
    The
web address specified is in an invalid URL
syntax/format.
    Check forum-config.xml,
email/outbound/templates/url
and make sure the URLs are valid.  You can validate them by typing
the URLs directly into a browser.



    CLFRV0110E:
Error sending error message.
    Error received
when trying to send an email
error notification.
    Ensure that SMTP
server configuration in
the <email> element of forum-config.xml is valid and that the server
is accessible.  Additional information relating to the failure may
be found in the SystemOut.log file.



    CLFRV0111E: Unable to connect to any of the <number>
SMTP servers found on the MX records of the DNS server.
    The SMTP server is down, unreachable, or not
responding.
    Ensure that the SMTP
and DNS servers configured
in the <email> element of forum-config.xml are reachable.



    CLFRV0112E: Unable to get email template
from
url= <url>.
    Error trying to retrieve
an email template from
the given URL.
    Check forum-config.xml,
email/outbound/templates/url
and make sure the URLs are valid.  You can validate them by typing
the URLs directly into a browser.



    CLFRV0114E:
The email from "<sender>" with
subject "<subject>" did not match either the create or add-to matching
address expressions. The email will be deleted and not processed.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0115E:
The email address="<emailAddress>"
was not found in the directory.  Unable to process the message.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0116E:
Unable to find a member profile
for the email "<emailAddress>". This user will not be added to
the activity membership.
    Should not see
this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0117E:
The activity you tried to email
into (id=<uuid>) is deleted or no longer exists.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0118E:
You need to update your configuration
file version.  Make sure you are not trying to use an old config file
on a newer server or vice-versa.
    The
version of forum-config.xml on the server
differs from the version expected by the Discussion Forum.
    Ensure the version property of the <config>
element in forum-config.xml matches the version expected by the Discussion
Forum.



    CLFRV0119E: ExecutionContext
leak detected.
    The Discussion Forum application
has detected
a resource leak.
    Restart the Discussion
Forum application.
 Additional information relating to the failure may be found in the SystemOut.log file.  If the problem persists after restarting the Discussion Forum application, contact Customer Support to report the incident.



    CLFRV0120E: Internal
Error, EC Count is null.
    The Discussion
Forum application has detected
a resource leak.
    Restart the Discussion
Forum application.
 Additional information relating to the failure may be found in the SystemOut.log file.  If the problem persists after restarting the Discussion Forum application, contact Customer Support to report the incident.



    CLFRV0121E: Error
publishing event <event>.
    The Discussion
Forum application received an
error from the Event Broker service.
    Check
that the <eventBroker> configuration
specified in forum-config.xml is valid.  Correct an invalid configuration.
 Additional information relating to the failure may be found in the SystemOut.log file.  If the problem persists  after restarting the Discussion Forum application, contact Customer Support to report the incident.



    CLFRV0122E: Cannot
find credentials for <name>.
    The system
is configured to use J2C Authentication
Aliases to store authentication data.  The entry for <name> is
missing.
    Go to Secure
administration,
applications, and infrastructure > JAAS > J2C authentication data in the WebSphere Application Server
Integrated Solutions Console, and check whether there is an entry
for <name>. If there is no entry, create an Authentication Alias
for <name> by completing these steps:


     
      


       
    1.  Shut down the WebSphere Application Server.





       
    2.  Edit the security.xml file in <APPServer_HOME>/profiles/AppSrv01/config/cells/<cell>





       
    3.  Find the authDataEntries entry with an alias that includes <name>.
For example: 						<authDataEntries alias="text/name"> 					2.5 





       
    4.  Replace "text/name" with "name"





       
    5.  Save the security.xml
file.





       
    6.  Restart the WebSphere Application Server.


    
If there is an entry for <name>, verify that the user credentials
are correct.  If these steps do not fix the problem, then contact
Customer Support.



    CLFRV0123E:
Profile provider error.
    The Discussion
Forum received an error querying
the directory (i.e. LDAP) for a user or group.
    Ensure that the LDAP server configured for
the WebSphere Application Server is accessible  and that the bind credentials used to authenticate
to the LDAP server (if necessary) are valid.



    CLFRV0127W: Activities cannot determine host
name.
    An error occurred while initializing
the Statistics
collection service.  There was a problem with the server host name.
 Additional information relating to the failure may be found in the SystemOut.log file.
    If the problem
persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0131E:
Activities Task Scheduler initialization
error: <error>.
    Reason: An error occurred
while initializing
the Quartz scheduler.  Additional information relating to the failure
may be found in the SystemOut.log file.
    If
the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0135E:
Error executing event notification.
    Error
received in the event broker.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the problem persists after
restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0136E:
Exiting the Aynch Notification Thread:
event processing has been halted.
    Error
received when the event broker thread
is halted.  Additional information relating to the failure may be
found in the SystemOut.log file.
    If
the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0137E:
Error encountered processing events.
    Error
received in the event broker when dispatching
events.  Additional information relating to the failure may be found
in the SystemOut.log file.
    If the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0138E:
The invoker should not be interrupted.
    Another
thread interrupted the internal event
broker.  Additional information relating to the failure may be found
in the SystemOut.log file.
    If the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0142E:
Incorrect number of arguments. 
Please specify the configuration file to process.
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0143E:
Cannot locate configuration file
{0}.
    Should not see this error message.
 Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0144E:
ConfigurationParser: Bad configuration.
 Config section defines more properties than values, or vice versa.
 Possible errant <property> element(s) without a "name" attribute(s).
    A configuration element in forum-config.xml
or forum-jobs.xml is invalid.
    Enable
debug tracing for com.ibm.openactivities.util,
restart the application,  and determine the invalid element from the trace.log output.  Correct the element and restart the Discussion
Forum application.



    CLFRV0146E:
Unable to refresh cached list of
groups.
    The Discussion Forum received
an exception refreshing
its group cache.  Additional information relating to the failure may
be found in the SystemOut.log file.
    If
the problem persists after restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0147E:
Error initializing Activities.
    The Discussion
Forum application received an
error trying to start.
    The cause
of the error will be found in
the SystemOut.log file.  Correct the error cause and restart the Discussion
Forum application.



    CLFRV0269E:
Unable to connect to Domino database
at url= <url>
    An error occurred while
attempting to connect
to the Discussion Forum's Domino content
store.
    Verify the Domino server is responding and that the URL
is accessible.



    CLFRV0270E:
Error getting server URL for <name>.
    There
was an error reading the server URL for
the <name> service.
    


     
      


       
    1.  Find
LotusConnections-config.xml (in <App server home>/profiles/<name>/config/cells/<cell
name>/LotusConnections-config)





       
    2.  Make sure that the files exists
and is readable by the WebSphere Application Server
process.





       
    3.  Make sure that the files contain the correct entry
for the <name>
service.


    




    CLFRV0271E:
Cannot find config variable directory <directory>.
    There was a problem reading variables that can
be used in the forum-config.xml file.
    Make
sure that the directory exists and
is readable by the WebSphere Application Server.



    CLFRV0272E: Cannot
find <file> for config
variables.
    There was a problem opening
a file getting configuration
variables.
    Make sure that  the file
exists and is readable
by the WebSphere Application Server.



    CLFRV0273W: Missing
system setting for <name>.
    The IBM Connections configuration cannot find a definition for a variable named "name".
    Either, check the installation documentation
for the variable to find the correct value for the variable, or add
the variable with its correct value in the WebSphere Application Server Integrated
Solutions Console, Environment/websphere Variables page.



    CLFRV0275E: Error loading config variables
from <file>.
    There was a failure parsing
variables in file.
    


     
      


       
    1.  Make sure
the file exists and is readable by the WebSphere Application Server.





       
    2.  Replace
the current copy with a back-up copy of the file.


    




    CLFRV0276E: Too many errors encountered
sending
Activity Auto Completion notices, auto complete aborted.
    The server has given up trying to keep sending
any more auto complete email notices. 
    Ensure
that SMTP server configuration in
the <email> element of forum-config.xml is valid and that the server
is accessible.  Additional information relating to the failure may
be found in the SystemOut.log file.



    CLFRV0277W: Warning, invalid parameter specified
for the Activity Auto Completion notification max errors ({0}).
    Should not see this error message.  Application is not enabled.
    Should not see this
error message.  Application is not enabled.



    CLFRV0278E:
Error generating list of activities
eligible for auto completion.
    Error received
querying the database to obtain
a list of discussion forums that qualify to be autocompleted.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the problem persists after
restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0279E:
Error sending auto complete notification
for activity UUID <uuid>.
    Error received
when sending email about an auto
complete notification.  Additional information relating to the failure
may be found in the SystemOut.log file.
    Ensure
that SMTP server configuration in
the <email> element of forum-config.xml is valid and that the server
is accessible.  Additional information relating to the failure may
be found in the SystemOut.log file.



    CLFRV0280E: Error initializing the Activities
Administrator email address.  Some email functionality will be unavailable.
    No administrator email address was configured
in forum-config.xml.
    Edit forum-config.xml
and provide an administrator email address in the <activities-administrative-email-address>
 element.



    CLFRV0281E: The content of mime type: "<mimeType>"
or filename: "<fileName>" you tried to upload is not allowed by
your administrator.
    The administrator set a size limit of zero bytes
for the type of content a user tried to upload, either by mime type
or by file name.
    Change the upload
limits in the <sizeLimits>
element in forum-config.xml.



    CLFRV0282E:
profile provider could not find
member for <uuid>.
    The Discussion
Forum profile application did
not find a member by the given member ID.
    Contact Customer Support to report the incident.



    CLFRV0285W: Purge expiration period
(days) either
not specified or invalid (<integer>).  Defaulting to {1} days.
    The trashRetentionInDays configured for the TrashAutoPurgeJob in forum-jobs.xml is invalid.
    Add a value greater than 0 for the trashRetentionInDays
configuration.  Otherwise, trash older than 1 day will be purged when
the job runs.



    CLFRV0286E:
Error sending activity auto completion
notification.
    Error received when trying
to send an email
auto-completion notification.
    Ensure
that SMTP server configuration in
the <email> element of forum-config.xml is valid and that the server
is accessible.  Additional information relating to the failure may
be found in the SystemOut.log file.



    CLFRV0287E: Error parsing administrator email
address.
    The administrator email address
configured in
forum-config.xml is badly formatted.
    Edit
forum-config.xml and provide an administrator email address in the correct format in the  <activities-admin-email-address>
element.



    CLFRV0288E: No Activities
Administrator email
address has been configured.  You must specify a value for "activities-admin-email-address".
    The administrator email address configured in
forum-config.xml is empty.
    Edit forum-config.xml
and provide an administrator email address in the correct format in the <activities-admin-email-address>
element.



    CLFRV0289W: Content
removed by active content
filter.
    The active content filter removed
active content
from user input.
    No action necessary.



    CLFRV0290E: Error starting the active
content
filter.
    The active content filter received
an error
on start up.
    Contact Customer Support
to report the incident.



    CLFRV0291E:
Error encountered with the active
content filter.
    The active content filter
received an error
trying to filter text.
    Contact Customer
Support to report the incident.



    CLFRV0292W:
Warning, it appears the ACF inserted
an invalid character mid stream (<filteredText>).
    The active content filter inserted an invalid
character in the filteredText as part of a filtering operation.
    No action necessary.  The Discussion Forum
application fixes up the invalid character.



    CLFRV0293E: MemberProfile cannot be null.
    The data in a request to update a member profile
in the database is null; possibly via a bad API request.
    Contact Customer Support to report the incident.



    CLFRV0295E: Cannot update non-matching
MemberProfiles. <uuid>
is not <uuid>.
    In a request to one
member profile with a new
one, the member IDs do not match.
    Contact
Customer Support to report the incident.



    CLFRV0300E: The ArchiveService cannot export
activities to the directory=<directory>; it is not writable.
    The exportActivities command of ArchiveService
wsadmin object tried to archive the Discussion Forum to a directory
that is not writable.
    Ensure that <directory>
exists and that
it is writable by the WebSphere Application  Server.



    CLFRV0301E: The required
zip file "Activity-<uuid>.zip"
was not found. This activity will not be imported, or a related activity
link will be broken.
    The ArchiveService
was requested to import activity
with uuid <uuid>. However, the directory path that was also given
to the ArchiveService does not contain the file Activity-<uuid>.zip.
    Ensure that the directory specified in an
ArchiveService importActivities or createActivities command contains
the archives for the desired discussion forums.



    CLFRV0304E: The version of the archive you tried
to import does not match the current DB schema.
    One cannot import activities into servers that
are using different DB schemas.
    Migrate
the archive to the matching schema
version and then import the migrated archive.



    CLFRV0306W: The user by email (or display name
if it's a group) <member> was not found in the LDAP or the database!
 This means the activity being imported has a reference to a user
that has changed emails, or has been removed from the LDAP. In other
words, this email address is stale, and the activity is carrying around
incongruent data.
    A member that was included
in the imported activity
cannot be found anymore. This might happen when switching LDAP servers,
and the membership list is different.
    No
action necessary.  The imported activity
will be imported, the missing member email address (or display name
if a group) will be rewritten to "NOT_FOUND_<originalemail>". 
If this behavior is unexpected, you might want to investigate why
members are missing in the new LDAP.



    CLFRV0309E: The ArchiveService cannot export
activities to the directory=<directory>; it is not a directory.
    The exportActivities command of ArchiveService
wsadmin object tried to archive the Discussion Forum to a directory
that is not writable.
    Ensure that <directory>
exists and that
it is writable by the WebSphere> Application  Server.



    CLFRV0310E: Error writing activity entry #<uuid>
to the database.
    An ArchiveService import
error received at the point where the Node of the Discussion Forum is written.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the error reported in the SystemOut.log
file cannot be resolved, contact Customer Support to report the incident.



    CLFRV0312E: Error writing activity
node to the database.
    An ArchiveService import error
received at the point where one of the nodes (entries) of the Discussion Forum is
written.  Additional information relating to the failure may be found
in the SystemOut.log file.
    If the error reported in the SystemOut.log
file cannot be resolved, contact Customer Support to report the incident.



    CLFRV0315E: The ArchiveService cannot
create
the directory=<directory>  for exporting activities.
    In an ArchiveService exportActivities command
one specifies a directory where all the archive files will be written.
 In this case, the system cannot write out the specified directory
to the file system.
    Manually create
the <directory> on the file system and ensure it is writable by the WebSphere Application Server.



    CLFRV0318E: The related activity with UUID=<uuid>
already exists in the system.  It is unclear whether the intention
is to overwrite that activity with old data or not.  Thus, it will
be not imported.
    When a discussion forum
has a related discussion
forum link in it, the ArchiveService will automatically try to import
the related discussion forum.  However, if the ArchiveService is being
run with "importActivities" which overwrites discussion forums rather
than creating copies, then, it is unclear to the system whether the administrator also intentionally meant to overwrite related discussion
forums since that related discussion forum was not explicitly passed
in to be imported.
    If the administrator wishes to overwrite
the related discussion forum, he can use the ArchiveService importActivites
command to overwrite the related discussion forum.



    CLFRV0319E: Error writing activity content entry
"<name>".
    An ArchiveService import
error received at the point where the content (files, attachments, etc) of one of the nodes
(entries) of the discussion forum is written. Additional information
relating to the failure may be found in the SystemOut.log file.
    If the error reported in the SystemOut.log
file cannot be resolved, contact Customer Support to report the incident.



    CLFRV0320E: Error importing activity
with UUID=<uuid>.
    An ArchiveService
import error.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the error reported in the SystemOut.log
file cannot be resolved, contact Customer Support to report the incident.



    CLFRV0321E: Error unpacking the archive.
    An ArchiveService import error received when
unmarshalling the Zip archive.
    The
Zip archive has been corrupted.  If the cause of the corruption cannot be determined, contact Customer
Support to report the incident.



    CLFRV0327I:
Status.
     
    Informational
message; no solution is needed.



    CLFRV0328W:
The {0} scheduler is not enabled
in config. Check spelling.
    The specified
scheduler is not enabled in the forum-config.xml file.
    Check the forum-config.xml file to make
sure that the scheduler is enabled (change the 'enabled' attribute
to true) and that the scheduler name is spelled correctly.



    CLFRV0329E: The attempt to start the <name>
scheduler failed.
    The Quartz scheduler
did not start.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the problem persists after
restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0330W:
The {0} scheduler has already been
stopped.
    The specified scheduler has
already been stopped.
    No action required.



    CLFRV0331I: The request to resume
job {0} has
been submitted.
    The request to resume
the specified job has
been submitted.
    Informational message;
no solution is needed.



    CLFRV0332W:
The job {0} is not valid for the {1} scheduler.
    The job you are trying
to run cannot be run
on the specified scheduler.
    Run the job on the appropriate scheduler.



    CLFRV0333I:
The job {0} was removed.
    The specified
job was removed from the scheduler.
    Informational
message; no solution is needed.



    CLFRV0334I:
The {0} scheduler is running.
    The specified
job is running.
    Informational message;
no solution is needed.



    CLFRV0335W:
The job {0} is already running on
the {1} scheduler.
    The specified job
is already running on the specified scheduler.
    No action required.



    CLFRV0336I: The request to pause
job {0} has
been submitted.
    The request to pause
the specified job has been
submitted.
    Informational message;
no solution is needed.



    CLFRV0337W:
The {0} scheduler has already been
started.
    The specified scheduler has
already been started.
    No action required.



    CLFRV0338I: The {0} scheduler was
stopped successfully.
    The specified scheduler
was stopped successfully.
    Informational
message; no solution is needed.



    CLFRV0339W:
The {0} scheduler is disabled in
config.
    The specified scheduler is not
enabled in the forum-config.xml file.
    Enable the scheduler by changing the 'enabled'
attribute for the scheduler  to true in the forum-config.xml file.



    CLFRV0340W: The request to pause
job <name>
failed.
    An error occurred while attempting
to pause
a job.  Additional information relating to the failure may be found
in the SystemOut.log file.
    No action
is required.



    CLFRV0341W: The job <name> has already been
paused on the {1} scheduler.
    An attempt
was made to pause a job that is already
paused on a scheduler.
    Ensure that
the job is running before attempting
to pause it.



    CLFRV0342I: The {0} scheduler is in standby
mode.
    The specified scheduler is in standby
mode.
    Informational message; no solution
is needed.



    CLFRV0343W: The request to resume job <name>
failed.
    An error occurred while attempting
to resume
a previously paused job.  Additional information relating to the failure
may be found in the SystemOut.log file.
    No
action is required.



    CLFRV0344I:
The {0} scheduler was started successfully.
    The
specified scheduler started successfully.
    Informational message; no solution is needed.



    CLFRV0345E: The attempt to stop the <name>
scheduler failed.
    The Quartz scheduler
did not stop.  Additional
information relating to the failure may be found in the SystemOut.log
file.
    If the problem persists after
restarting
the Discussion Forum application, contact Customer Support to report
the incident.



    CLFRV0346I:
The job {0} on the {1} scheduler
has been paused.
    The specified job on
the specified scheduler
has been paused.
    Informational message;
no solution is needed.



    CLFRV0347E:
Error exporting activity UUID={0}.
    An
error occurred while trying to import the activity with the given UUID.
    Check
previous log messages for the actual
cause of the import failure.  Resolve the error and re-run the import.



    CLFRV0348W: The group "{0}" could
not be loaded
from LDAP or the database. Or, there might have been multiple matches
for the same name in LDAP.
    This error
is encountered when a group name
is not found or multiple matches to the name are found in the configured
directory.
    No action necessary. The activity will continue
to be imported; an entry for "NOT_FOUND_" + the group name will be
added to the member table and the membership list.



    CLFRV0349E: Error locating profile: EXID mismatch,
but email matches.  email={0}, directory EXID={1}, db EXID={2}.
    This error is encountered when a member entry
is found in the Discussion Forum database by the given email address,
but the external identifier does not match the LDAP record.
    Determine if the person's record has changed
in LDAP and if the two entries are really for the same person.  If they are, use the Discussion Forum MemberService.synchMemberExtId
 (email address) command to update the Discussion Forum database with
the correct id.



    CLFRV0350E:
Error: the group profile "{0}" could
not be located in the Activities database.
    This
error is encountered during LDAP synchronization.
 The group could not be located in the Discussion Forum database.
    Check the spelling of the group name.



    CLFRV0351E: Error: the group profile
"{0}" could
not be located in the directory service.
    This
error is encountered during LDAP synchronization.
 The group found in the Discussion Forum database could not be located
in LDAP.
    Check the spelling of the group name.



    CLFRV0352I: The group profile "{0}" has been
synchronized with the directory  services changing the external id
from {0} to {1}.
    This message is encountered
during LDAP synchronization.
 This record in the Discussion Forum database has been updated to
match LDAP.
    Informational message;
no solution is needed.



    CLFRV0353E:
Error: the member profile "{0}"
could not be located in the Activities database.
    This error is encountered during LDAP synchronization.
 The person could not be located in the Discussion Forum database.
    Check the spelling of the email address.



    CLFRV0354I: The member profile "{0}"
has been
synchronized with the directory services changing the external id
from {0} to {1}.
    This message is encountered
during LDAP synchronization.
 This record in the Discussion Forum database has been updated to
match LDAP.
    Informational message;
no solution is needed.



    CLFRV0355I:
The member profile "{0}" matches
the directory service with external id {1}.
    This
message is encountered during LDAP synchronization.
 This record is already synchronized.
    Informational
message; no solution is needed.



    CLFRV0356E:
Error: the member profile "{0}"
could not be located in the directory service.
    This error is encountered during LDAP synchronization.
 The person could not be located in LDAP.
    There is no match for the person by the given value.  Check to see if the person exists in LDAP.



    CLFRV0357E: Error: more than one profile
was
found for the key "{0}".
    Multiple entries
identified by the <user
identifier> have been found in the member profile table.
    One of the entries must be deleted.  Contact
Customer Support before proceeding.



    CLFRV0358I: The group profile "{0}" matches
the directory service with external id {1}.
    This
message is encountered during LDAP synchronization.
 This record is already synchronized.
    Informational
message; no solution is needed.



    CLFRV0359E:
Error locating member profile for <user
identifier>, search type <internal search type>.
    The user's member profile could not be located
in the directory.
    Verify the LDAP configuration is correct.
 If this error is limited to a specific user, verify that the user
can be located in LDAP given the identifier in the error message.
 The search type indicates what LDAP attribute is searched:  1=login,
2=email, 3=internal Discussion Forum member id (not used when searching
LDAP).




    CLFRV0360I: The {0} scheduler is not running.
    The specified scheduler is not running.
    Informational message; no solution is needed.



    CLFRV0361E: The file "{0}" cannot
be uploaded
as it is a 0-byte file.
    An attempt was
made to upload the specified
file which has no content (zero bytes in size). Only files which have
content may be uploaded.
    Ensure that
the file contains data before uploading.



    EJPIC0060E: There were no profiles detected
for the installed WAS and managed node selected.
    There must be at least one profile on the existing
managed node to continue.
    Retrieve the install logs for errors and make
sure at least one profile exists on the existing managed node. Then
try the installer again.



    



    



    Table 102. Bookmarks error messages

    Header
    Header
    Header




    CLFRO####E: Error init connections config.	
    IBM Connections configuration file has something wrong, or an unexpected exception
occurs when parsing the IBM Connections configuration file.	
    Check the detailed
exception message below this
error message in the log file to find the root cause. Check the configure
file is correct.



    CLFRO####E:
Error when handling the multiple
bookmarklet user request.	
    This error
is encountered if an unexpected exception
occurs when handing the request of the common bookmarklet.	
    Check the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Error when parsing atom entry
to
object instance.	
    The common bookmarklet
received an Atom document
that we could not parse because of invalid syntax. Usually this error
is caused because Bookmarks/Communities/Activities/Blogs is not working.	
    Check the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to get content document
from
url {0}.	
    Check the detailed exception
message below this
error message in the log file to find the root cause. 
    Make sure the given url is valid and the remote
server is available.



    CLFRO####E:
Failed to update the bookmark.	
    This
error is encountered if an unexpected exception
occurs when updating the bookmark.	
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to delete the bookmark.	
    This error is encountered if an unexpected exception
occurs when deleting a bookmark from Bookmarks.
    Check the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to post the bookmark
to Dogear.	
    This error is encountered
if an unexpected exception
occurs when adding a bookmark to Bookmarks.
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to post the bookmark
to one
or more Communities.
    This error is encountered
if an unexpected exception
occurs when adding a bookmark to Communities.
    Check the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to post the bookmark
to one
or more Activities.	
    This error is encountered
if an unexpected exception
occurs when adding a bookmark to Activities.
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to post the bookmark
to one
or more Blogs.	
    This error is encountered
if an unexpected exception
occurs when adding a blog entry to  Blogs. 
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to get count of the bookmark,
url is: {0}	
    This error is encountered
if an unexpected exception
occurs when querying the bookmark count from Bookmarks. 
    Check the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to validate the url.
    When user updates a bookmark, Common Bookmarklet
must first validate the url to see if user already has another bookmark
with the same url. 
    Check the detailed
exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Service {0} is not correctly
configured. 
    Bookmarklet can not point
to the correct server
if attributes ""enabled"" and ""href"" are not set in the configure
file. Please check IBM Connections configure file.	IBM Connections configuration file has something wrong.	
    Check the detailed exception message below this
error message in the log file to find the root cause. Check the configure
file is correct.



    CLFRO####E:
Failed to parse IBM Connections configure file
    IBM Connections configuration file has something wrong	
    Check
the detailed exception message below this
error message in the log file to find the root cause. Check the configure
file is correct.



    CLFRO####E:
Unable to find configure file for
bookmarklet installer. 	
    The error is
encountered if the configure file
is not created.	
    Check the detailed exception
message below this
error message in the log file to find the root cause. 



    CLFRO####E: Unable to load configure file
for
bookmarklet installer.	 
    The error is
encountered if the configure file
is not created or locked by other application.	
    Check the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to update the bookmarklet
installer.
    This error is encountered
if an IOException
occurs when updating the installer.	
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to check bookmarklet
installer.
	
    This error is encountered if an unexpected
exception
occurs when checking the installer. 
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: The parameter constraint shouldn't
be null.	
    This error is encountered if
the given constraint
is null.
    Check the detailed exception
message below this
error message in the log file to find the root cause. Check the user
inputs.



    CLFRO####E: Failed
to add Credentials for invoking
remote service, remote url is {0}	
    This
error is encountered if an URISyntaxException
occurs when adding Credentials.	
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to apply constraints.	
    This error is encountered if an unexpected exception
occurs when applying the constraints.
    Check
the detailed exception message below this
error message in the log file to find the root cause. Check the user
inputs.



    CLFRO####E: Add search
text operator or 'ps'
or 'page' parameters failed.	
    This error
is encountered if an URIException
occurs when adding 'ps' or 'page' parameter.	
    Check the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Parse redirect url failed.	
    This error is encountered if an IRISyntaxException
occurs when parsing the redirect url	
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to build data entry
for invoking
remote service.	The common bookmarklet creates xml document with the user inputs. 
    The common bookmarklet
creates xml document
with the user inputs. This error is usually caused by the bad user
inputs.	
    Check the detailed exception
message below this
error message in the log file to find the root cause. Check the user
inputs.



    CLFRO####E: Failed
to invoke remote service
{0}, remote server return HTTP code: {1} 	
    This
error is encountered if the remote service
doesn't return the expected http code.	
    Check
the detailed exception message below this
error message in the log file to find the root cause. Check the remote
server is available.



    CLFRO####E:
Failed to edit bookmark, url is:
{0}	
    This error is encountered if an
unexpected exception
occurs when updating the bookmark.	
    Check
the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to delete bookmark,
url is:
{0}	
    This error is encountered if an
unexpected exception
occurs when deleting a bookmark from Bookmarks	.
    Check the detailed exception message below this
error message in the log file to find the root cause. 



    CLFRO####E: Failed to publish bookmark
via remote
service.	
    This error is encountered if
an unexpected exception
occurs when adding a bookmark to Bookmarks	
    Check
the detailed exception message below this
error message in the log file to find the root cause.



    



    



    Table 103. Blogs error
messages

    Message
    Cause
    Solution




    Error instantiating <roller_classname>.
    Cannot find specified class.
    Make sure all libraries are available or reinstall IBM Connections Blogs.



    It appears that your factory does not implement <"CacheFactory
interface>.
    Cannot find specified class.
    Make sure all libraries are available or reinstall IBM Connections Blogs.



    It appears that your mapper does not implement <RequestMapper
interface>.
    Cannot find specified class.
    Make sure all libraries are available or reinstall IBM Connections Blogs.



    rollerversion.properties not found.
    The Blogs configuration file, .rollerversion.properties,.
does not exist.
    Recover this file or
reinstall IBM Connections Blogs.



    Unable to instantiate cache factory <classname>
falling back on default.
    Cannot find
specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    Unable to instantiate
cache handler <Handler>. 
    Cannot find
specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    Unable to instantiate
request mapper <mapper>.
    Cannot find
specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    Unable to load smileys.properties.
    Specified file does not exist.
    Recover this file or reinstall IBM Connections Blogs. 



    Unable to lookup mail session.  Check configuration.
    Cannot find JavaMail JNDI resource.
    Check WebSphere Application Server Blogs configuration to make sure the JNDI resource has been
configured.



     
     
     



    CLFRS0012E: Error processing referrer
    Not identifiable without more information.
    Report this problem to Customer Support.



     CLFRS0019E: Error deleting the resource 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0025E: Error getting weblogs
default page 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0030E:
Content-Type error 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0031E:
Error processing subscription entry 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0040E:
Error loading model objects for
page 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0049E: Error updating the resource 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0050E: Error retrieving the resource 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0055E: WaltzUserAutoProvision.getUserDetailsByLoggedInUser
{0} failed. 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0057E:
Error adding a media-link entry
to the collection feed 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0059E:
Error retrieving accepted content
type ranges  
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0060E:
Error getting key ''{0}''
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0062E:
Parent association is null 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0070E:
Error while updating master search
index 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0071E: Error
posting the new entry 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0074E:
Planet cache directory is not writable 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0080E:
Error writing resource file 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0082E:
Error processing linkback 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0087E:
Error ending transaction 
    SQL Transaction
commit failed.
    This could be database
SQL execution error.
 Please wait and try again later.



    CLFRS0089E:
Parsing exception  
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0090E:
Error during rendering for page
{0}
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0091E: Error posting the new
media-link
entry 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0101E: Error
adding an entry to the collection
feed 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0102E: Error deleting the blog 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0106E: Error checking user authorization
level for blog 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0107E:
Error adding a blog entry to the collection feed 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0108E:
Error message: {0} 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0112E:
Error initializing iBatis 
    SQL Transaction
commit failed.
    This could be database
SQL execution error.
 Please wait and try again later.



    CLFRS0113E:
Error adding a report entry to the collection feed 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0116E:
Error deleting the comment 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0125E:
Unable to create planet cache directory 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0131E:
Error retrieving the entry 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0133E:
Error deleting the entry 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0136E:
Error looking up website object 
    The
blog specified does not exist.
    Informational
message.  No solution is needed.



    CLFRS0139E:
Error updating the entry 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0140E:
Error adding a flagged entry to
the collection feed 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0143E:
Error with the active content filter 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0152E:
Unexpected exception 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0154E:
Error retrieving the resource to
delete 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0160E: NamingException
during websphere
InitialContext retrieval 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0174E:
Error retrieving list of collections
for user 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0176E: Error
committing transaction the process will be rolled back 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0178E:
Error retrieving list of categories
for weblog 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0191E:
Error parsing referrer.robotCheck.userAgentPattern
value ''{0}''. Robots will not be filtered. 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0192E:
Could not find renderer for page
{0} 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0195E: Error getting weblog
entry data
for entry [{0}] 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0196E:
Error fetching most commented weblog
entry list 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0197E:
Error retrieving MonthMap 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0199E:
Error fetching most recommended
weblog list 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0200E:
Error while processing ping queue 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0201E:
Error looking up weblog [{0}] 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0203E:
Error in action 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0204E:
Error initializing calendar tag 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0205E:
Error scheduling task 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0206E:
Error getting today's referrers 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0207E:
Error occurred while attempting
to read theme template file [{0}] 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0209E:
Could not read theme template file
[{0}]  
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0210E: Error
determining site URL
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0213E:
Error rendering for weblog [{0}] 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0214E:
SQL error occurred when upgrading
database to version 3.0.0 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0215E:
It appears that the handler does
not implement the CacheHandler interface 
    Cannot
find specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    CLFRS0216E: Error occurred
when optimizing index
 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0218E: Error getting page from
request
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0220E: Error
getting weblog category by
id from request 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0221E:
Error removing invalid MediaCast
attributes 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0222E:
Error getting bookmark from request 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0223E:
Error downloading blacklist 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0224E:
Error getting child folders 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0225E:
Unable to instantiate cache factory
[{0}], falling back on default 
    Cannot
find specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    CLFRS0226E: Error writing
resource file  
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0227E:
Error importing bookmarks
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0229E:
Error updating comments 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0230E:
Error in MetaweblogAPIHandler.getCategories 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0231E:
Error forming Struts URL 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0232E:
Error getting aggregation 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0233E:
Error occurred during rendering
for page [{0}] 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0234E:
Error occurred when adding document
to index 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0235E: Error
occurred while checking MediaCast
URL [{0}]: {1} 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0237E:
Error during rendering for RSD template 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0238E:
Unable to parse configured ping
variant [{0}]. Skipping this variant. Check your setting of the property
[{1}] 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0239E: Error
setting default editor page
for weblog 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0240E:
Error getting folder from request 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0241E:
HTTP response message [{0}] returns
from MediaCast URL 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0243E:
Error from plugin: {0} 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0244E:
Error calling function shutdown() 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0245E:
Error saving comment rating 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0246E:
Error occurred when updating last
modified date to index 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0247E:
Error getting entry month map 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0248E:
It appears that the  mapper does
not implement the RequestMapper interface 
    Cannot
find specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    CLFRS0249E: Error toggling
linkback display 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0250E:
Error calling function release() 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0252E:
Could not find renderer for planet
RSS 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0253E: Error loading model objects
for
page 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0254E: Error fetching weblog
tags list 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0255E: Error
in BloggerAPIHander.getInfo 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0256E:
RollerSession.synchUserProfile {0}
failed. 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0257E: Aborting
collection of Technorati
rankings.\ntechnorati.license not found at root of classpath.\nGet
license at http://technorati.com/developers/apikey.html\nPut the license
string in a file called technorati.license.\nAnd place that file at
the root of Roller's classpath.\nFor example, in the /WEB-INF/classes
directory. 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0258E:
Could not lookup current database
version 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0259E: Error
getting previous entry 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0260E:
Error in BloggerAPIHander.getRecentPosts 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0261E:
Unable to instantiate editor [{0}] 
    Cannot
find specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    CLFRS0262E: Error setting
default editor page
for weblog 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0263E:
Unable to load smileys.properties 
    Specified
file does not exist.
    Recover this file
or reinstall IBM Connections Blogs. 



    CLFRS0264E: Error
fetching annoucement weblog
entries 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0265E: Error
occurred when reading theme
{0} 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0266E: PingConfig property [{0}]
is not
an integer value. Using default value: {1} 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0267E:
Error batch delete documents from
index for re-indexing 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0268E:
Unable to instantiate request mapper
[{0}] 
    Cannot find specified class.
    Make sure all libraries are available or reinstall IBM Connections Blogs.



    CLFRS0269E: Forward specified in XML menu
file
not found: {0} 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0270E:
SQL error occurred when upgrading
database to version 2.1.0 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0271E:
Error fetching users by letter 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0272E:
Error in BloggerAPIHander.editPost 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0273E:
Unable to parse configured initial
ping target [{0}]. Skipping this target. Check your setting of the property [{1}] 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0275E:
Error during rendering for page
[{0}] 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0277E: Error
in action 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0279E: SQL error
occurred when upgrading
database to version 2.0.0 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0280E:
Error getting recent entries 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0281E:
Error saving comment 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0282E:
Unable to instantiate renderer factory
[{0}] 
    Cannot find specified class.
    Make sure all libraries are available or reinstall IBM Connections Blogs.



    CLFRS0284E: Error fetching weblog handle
character
map  
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0285E: Internal error validating
user
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0286E: Exception in tag 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0287E: Error occurred during
rendering
for planet RSS 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0288E:
Error in MetaweblogAPIHandler.getPost 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0290E:
Error in blogger.deletePost: {0} 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0292E:
Error creating authenticator, using
default 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0293E: Error
ranking subscriptions 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0294E:
Cannot synchronize websites. Absolute
URL not specified in Blogs configuration 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0295E:
Error occurred when getting ThreadManager 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0300E:
Error getting ranked blogs 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0301E:
Error executing job. Thread  
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0302E:
Error fetching username character
map 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0303E: Error saving entry rating 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0304E: Plugin is not found:
Emoticons 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0305E: Error
occurred when initiating messageModel 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0306E:
Unexpected exception processing
ping queue 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0307E:
Error creating toggle-linkback URL 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0308E:
Error getting default page 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0309E:
Error getting next entry 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0310E:
Error fetching user list 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0311E:
Could not find renderer for page
[{0}] 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0312E: Error
creating URL 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0313E:
SQL error occurred when upgrading
database to version 1.3.0 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0314E:
Error getting default page for preview 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0315E:
Error instantiating {0} 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0316E:
Error loading model for page 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0317E:
Database problem occurred when trying
to load resource [{0}] 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0318E:
Error getting user in menu model 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0319E:
Error fetching weblog entries list 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0320E:
Error in BloggerAPIHander.newPost 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0321E:
Operation is interrupted. 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0322E:
Error getting weblog category by
name from request 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0323E:
Error in BloggerAPIHander.getUsersBlogs 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0324E:
It appears that the factory does
not implement the RendererFactory interface 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0325E:
Error in BloggerAPIHander.setTemplate 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0326E:
Error fetching notification count 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0328E:
Error occurred when closing writer
    Not
identifiable without more information.
    Report
this problem to Customer Support.



     CLFRS0329E:
Error persisting updated hit counts 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0330E:
Error in BloggerAPIHander.getTemplate 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0332E:
Error occurred when searching index 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0333E:
Error with operation [{0}] 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0334E:
Error fetching featured weblog entry
list 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0335E: Error in action: {0}
 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0336E: Error getting total hit
count 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0336E: Error
getting total hit count 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0337E:
Error getting weblog entry: anchor
 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0338E: Error fetching most commented
weblog
list 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0339E: Error fetching weblog
count 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0340E: Error
getting recent comments 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0342E:
Initialization of XML-RPC servlet
failed 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0343E: Error
in MetaweblogAPIHandler.newPost 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0344E:
Error in MetaweblogAPIHandler.editPost 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0346E:
Error fetching favorites list  
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0347E:
Error occurred when closing reader
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0348E:
Unable to instantiate cache handler
[{0}] 
    Cannot find specified class.
    Make sure all libraries are available or reinstall IBM Connections Blogs.



    CLFRS0349E: Error occurred when fetching
last
update time stamp from index 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0350E:
Error fetching comment list 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0351E:
Error initializing plugins 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0354E:
rollerversion.properties is not
found 
    The Blogs configuration file,
.rollerversion.properties,.
does not exist.
    Recover this file or
reinstall IBM Connections Blogs.



    CLFRS0355E: Error occurred while
checking for
referrer 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0356E: Unable
to find user with email  
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0357E:
It appears that the factory does
not implement the CacheFactory interface 
    Cannot
find specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    CLFRS0358E: Could not
find renderer for RSD
template 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0359E: Error
in MetaweblogAPIHandler.getRecentPosts 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0360E:
Error instantiating task 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0364E:
Error getting managers 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0365E:
Error parsing runtime configuration
definitions 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0368E:
Error fetching recent notification
list 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0369E: Unknown exception creating
renderer
for template [{0}] 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0370E:
Calendar tag exception 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0371E:
Could not load a blacklist file
from anywhere. This means blacklist checking is disabled. 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0374E: Error committing referrer 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0375E: Error fetching featured
weblog list 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0376E:
Error fetching site tags list 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0378E:
Error loading weblog custom models 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0379E:
Error fetching categories 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0380E:
ThemeResourceLoader Error: {0} 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0381E:
PingConfig property [{0}] is outside
the required range ({1}, {2}). Use default value: {3} 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0382E: Error saving website 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0383E: Error fetching weblog
list 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0385E: Error fetching folder
for weblog 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0386E:
Error creating preview request 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0387E:
Error fetching most recommended
weblog entry list 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0388E:
Error occurred when deleting document
from index 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0389E:
Notification email not sent due
to Blogs configuration or mail server problem. 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0391E: Error refreshing entries 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0392E: Error sorting folders 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0393E: It appears that the editor
does
not implement the weblogEntryEditor interface 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0394E: Error getting weblog entry
[{0}] 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0395E: Notification
email not sent. Blogs
site URL is malformed. 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0395E:
Notification email not sent. Blogs
site URL is malformed. 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0396E:
Notification email not sent. Blogs
mail session is not configured properly. 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0397E:
Error fetching categories for path:
{0} 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0398E: Error loading runtime
configuration
definitions file 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0399E:
Error getting weblog page [{0}] 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0400E:
Error getting comment with id [{0}] 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0401E:
Error updating flagged inappropriate
entry 
    Not identifiable without more
information.
    Report this problem to Customer
Support.



    CLFRS0403E: Error
getting weblog category [{0}] 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0404E:
Error getting user object 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0405E:
Error fetching weblog data 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0406E:
Error getting decorator[{0}] for
template {1} 
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    CLFRS0408E:
Error adding banned IP to file 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0409E:
Error closing stream 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0410E:
Error occurred when creating writer 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0411E:
Unable to get planet manager 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0412E:
Error getting weblogs default page
    Not
identifiable without more information.
    Report
this problem to Customer Support.



     CLFRS0414E:
Error looking up theme [{0}] 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS0415E:
Error fetching weblog entry tags
list 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0416E: Failed to instantiate
a cache factory 
    Cannot find specified
class.
    Make sure all libraries are available
or reinstall IBM Connections Blogs.



    CLFRS0417E: Failed
to instantiate the implementation 
    Cannot
find specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    CLFRS0418E: Initialization
of ServletContextListener
implementation class failed 
    Cannot find
specified class.
    Make sure all libraries
are available or reinstall IBM Connections Blogs.



    CLFRS0419E: Failed
to initialize runtime configuration
properties. Please check that the database has been upgraded. 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0420E: Fatal message: {0} 
    Not identifiable without more information.
    Report this problem to Customer Support.



    CLFRS0421E: The Blogs database version
does
not match current version of Blogs. Please check the database and
make sure to use the correct version. 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS0422E:
Cannot access footer url 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS1755E:
Error connecting remote search EJB 
    Not
identifiable without more information.
    Report
this problem to Customer Support.



    CLFRS1756E:
Error removing community blog. Resource
ID {0}
    Not identifiable without more
information.
    Report this problem to Customer
Support.



     CLFRS1759E: Error
retrieving categories document 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS1760E:
Profile provider is null 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS1762E:
Error performing member update 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS1765E:
Error locating search EJB 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS1766E:
Error creating search EJB 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS1767E:
Error updating community blog visibility.
Resource ID {0}, title {1} 
    Not identifiable
without more information.
    Report this
problem to Customer Support.



    CLFRS1769E:
Error getting weblog entry comment
with id [{0}]
    Not identifiable without
more information.
    Report this problem
to Customer Support.



    





    Table 104. Installation error messages without codes

    Message
    Cause
    Solution




    At least one application
must be selected for
install.
    The installer requires the selection
of at least
one application for both production and pilot installations.
    Please choose at least one application.



    At least one application must be
selected for
uninstall.
    The installer requires the selection of at least
one application for both production and pilot uninstallations.
    Please choose at least one application.



    Cannot connect to database using
provided settings,
please check again!
    The installer validates
a JDBC connection to
ensure that the Connections application installed will be able to
communicate with the database.  This connection has the following requirements: 


     
      


       
    1.  JDBC Driver Library: A valid path to the jars
that provide JDBC
connectivity.





       
    2.  Application User Account: A valid user account
for the database
that hosts the Connections application data.  This is the user that
the Connections application will use.





       
    3.  Application User Account
password: The password for the application
user account.





       
    4.  Host: Host name of the machine that has the database server. 





       
    5.  Port: Port number used to connect to the database.





       
    6.  Database name:  The name of the database.


    

        		Make sure the correct values have been provided.



    db2jcc_license_cu.jar and db2jcc.jar
does not
exists in <directory path>
    The installer
validates a JDBC connection to
ensure that the Connections application installed will be able to
communicate with the database.  This error message is stating that
a valid JDBC connection is not possible as the required DB2 jars are not located at the location specified.
    In the install panel requesting JDBC connection
information, ensure that the path leading to the db2jcc_license_cu
and db2jcc jars is valid.



    ojdbc14.jar
does not exists in <directory
path>
    The installer validates a JDBC
connection to
ensure that the Connections application installed will be able to
communicate with the database.  This error message is stating that
a valid JDBC connection is not possible as a required Oracle jar is
not located at the location specified.
    In
the install panel requesting JDBC connection
information, ensure that the path leading to the ojdbc14.jar is correct.



    Uninstall of the component: <Connections
offering name> has failed or this component has already been uninstalled.
    The process of removing a Connections application
has failed.
    Please retrieve the uninstall
log, lcuninstalllog.txt,
from the temp directory.  Locate errors and contact support.



    The user did not provide the mandatory
input
parameter WAS userid in the command line.
    The
update installer will not continue and will
print out the command usage help on screen. 
    User
has to add userid to the command line.



    





    Table 105. IBM HTTP
Server error messages

    Message
    Cause
    Solution




    ERROR: lib_stream: openStream:
Failed in r_gsk_secure_soc_init:
  GSK_ERROR_BAD_CERT(gsk rc = 414)
    If
you see a 500 error when using HTTPS over
the IBM HTTP Server to get to
an application, HTTPS might not be configured correctly with the WebSphere Application Server
plug-in. The WebSphere Application Server SSL certificate might not be trusted by the WebSphere Application Server plug-in configured
for the IBM HTTP Server.
    If this error occurs, check both your IBM HTTP Server and WebSphere Application Server logs to see
if there is a GSK_ERROR. If the logs do not contain errors, examine
the plug-in logs located in the following directory:


    C:\ibm\HTTPServer\Plugins\logs\webserver1\http_plugin.log
    
To
fix this error, follow the instructions in the topic, Configuring
the IBM HTTP Server for SSL.



    





    Table 106. IBM Lotus Connections Portlets for IBM WebSphere Portal
error messages

    Message
    Cause
    Solution




    CLFNF6001E: Could not store
portlet preferences 
     
     



    CLFNF6002E:
Error storing slot id 
     
     



    CLFNF6003E:
There was an error with a name 
     
     



    CLFNF6004E:
JSONTranslator could not modify
portlet preferences 
     
     



    CLFNF6005E:
There was an error with the portlet
service 
     
     



    CLFNF6006E: Error creating credential 
     
     



    CLFNF6007E: Name not found 
     
     



    CLFNF6008E: There was an error serializing an
id 
     
     



    CLFNF6009E: Could not get custom
views 
     
     



    CLFNF6010E: Query was stored in a
bad format:
{0} 
     
     



    CLFNF6011E: Error getting user credentials
     
     



    




     

  •  Communities administrative commands




    Application icons
    



     The Home page uses different icons to identify the application
that each update is associated with.

    



    Table 107. Application icons

    Icon
    Application




    
    Activities



    
    Blogs



    
    Bookmarks



    
    Communities



    
    Files



    
    Forums



    
    Profiles



    
    Wikis



    






    Home page views
    



     You can use the views available in the Home page to learn
more about IBM Connections,
and to get the latest updates from your network and the wider organization.

    Tip: If you use some Home page views more than
others, you can bookmark them to make them quicker to get to later.




    Table 108. Home page views

    Option
    Description




    Get Started
    Use this option when you are a new or inexperienced
user and want to learn more about IBM Connections.
Select the Do not show this screen at start check
box if you do not want this view to display by default every time
you open the Home page.



    I'm Following
    Select this option when you want to see updates
related to the people and content that you are following.


     Click Stop
following under an update if you no longer want to get
the latest updates for a specific person or piece of content.




    Status Updates
    Select this option to view the latest status
update messages from across your organization.



    Action Required
    Use this option to view your latest to-do items
from Activities, network and community invitations, requests to join
moderated communities, and any third-party events requiring an action
on your part.


     The number of items requiring action displays next
to the view name so that you can see at a glance how many items you
need to complete. This number is automatically updated when you perform
an action related to an item, such as accepting a network invitation
or completing a to-do item.




    Saved
    Select this option to view the updates you saved
for later.


      Save updates can be useful when you are checking the latest news but you do not have time to look at the full details of
individual updates.





     When you are finished with a saved update,
you can remove it from this view by clicking the X icon
next to it.




    My Notifications
    Use this option to see the latest notifications
that you received and sent in IBM Connections.
You can use the Show options to filter the display to check for the latest responses to content that you created,
or view notifications that you sent to other users.



    Discover
    Select this option to view the latest public
updates from all the applications.


     Browsing the latest public entries
from IBM Connections can be
a useful way to find new content and people that interest you.




    My Page
    Select this option when you want to view the latest updates using application widgets rather than in list format.



    Administration
    Select this option when you want to perform
administrative tasks for the Home page. This option only displays
for users who have been assigned the administrator role.



    






    Home page widgets
    



     The widgets in the Home page widget catalog can help you
stay up-to-date with events in the different applications.

    The following IBM Connections widgets are available to add to the Home page.


     Notes: 


     
      


       
    •  To add an IBM Connections application widget to your Home page, the corresponding application
must be installed in your deployment.





       
    •  For the widgets in the IBM Connections applications to load properly in Microsoft Internet
Explorer, ActiveX Controls must be enabled on the Security tab.
To access the Security tab, select Tools > Internet Options > Security.


    





    Table 109. Home page widgets

    Widget
    Description




    Activities
    Displays a snapshot view of the latest updates
from the Activities application, including updates to your personal
activities and public activities.


     This widget is available in the My
Page view.




    Blogs
    Displays information about the most recent blog
entries in your organization.


     This widget is available in the My
Page view.




    Bookmarks
    Lists the latest updates from the Bookmarks
application.


     This widget is available in the My Page view.




    Communities
    Displays information about the most recent entries
to communities in the Communities application.


     This widget is available
in the My Page view.




    Events
    Lists upcoming community events that you are
planning to attend and events that you are following.


     This widget
is available in the activity stream views.




    Files Shared with Me
    Lists the files that other people have shared
with you recently in Files.


     This widget is available in the My
Page view.




    Latest Wikis
    Lists wikis that have been updated recently,
including public wikis and wikis to which you belong.


     This widget
is available in the My Page view.




    My Activities
    Lists the latest updates from your activities.


     This
widget is available in the My Page view.




    My Bookmarks
    Displays your most recent updates in the Bookmarks
application.


     This widget is available in the My Page view.




    My Communities
    Displays information about your communities
that have been recently updated.


     This widget is available in the My
Page view.




    My Files
    Lists the files that you have added or updated
most recently in Files.


     This widget is available in the My
Page view.




    My Network
    Displays a summary of the latest updates that
people in your network have made in the Activities, Blogs, and Bookmarks
applications.


     This widget is available in the My Page view.




    My Profile
    Displays a snapshot view of your personal details
from Profiles.


     This widget is available in the My Page view.




    My Watchlist
    Lists the recent bookmarks that are created
by that people on your watchlist or that match the tags on your watchlist.


     This
widget is available in the My Page view.




    My Wikis
    Lists the wikis to which you belong in order
of the most recently-updated wiki.


     This widget is available in the My
Page view.




    Popular Bookmarks
    Lists the public bookmarks shared in the Bookmarks
application, in order of most popular.


     This widget is available
in the My Page view.




    Popular Wikis
    Lists the wikis that receive the greatest number
of visits, in order of the most recently-updated wiki.


     This widget
is available in the My Page view.




    Profiles
    Provides a snapshot view of your personal details
from Profiles, and also lists recent activity and updates for the people in your network.


     This widget is available in the My
Page view.




    Public Activities
    Displays the latest updates from public activities.


     This
widget is available in the My Page view.




    Public Communities
    Displays information about the public communities
that have been updated most recently.


     This widget is available in
the My Page view.




    Recent Bookmarks
    Displays a list of the most recent public bookmarks
added in the Bookmarks application.


     This widget is available in
the My Page view.




    Recommendations
    Suggests content that might interest you, based
on your existing community membership, network connections, and tags.


     This
widget is available in the activity stream views.




    To Do List
    Lists your upcoming to-do items from Activities.


     This
widget is available in the activity stream views.




    






    IBM Connections system
requirements
    



     A variety of hardware and software
is required to run IBM Connections.

    


     To view the hardware and software
requirements, go to the Detailed system requirements for IBM Connections web page.





    Tivoli Directory Integrator solution properties for Profiles
    



     IBM Connections maps
LDAP, database, and other properties with Tivoli Directory Integrator configuration
parameters. 

    


     The properties described in this topic are found in the supplied profiles_tdi.properties file.





     The TDI
parameter column in the tables contains the name of the parameter in the LDAP connector.  See the Tivoli Directory Integrator product documentation for
more information. 





     You can find additional information about
LDAP properties at ibm.com® and
other sites. 





      All
file paths specified are relative to the TDI solution directory.


    


     The following properties are associated in an LDAP directory
that will be used as the source for the data. If you wish to use a
source other than LDAP, see Manually populating the Profiles
database.




    Table 110. LDAP Properties
    Property 
    TDI parameter
    Definition




    source_ldap_url
    LDAP URL hostname and LDAP URL Port
    


     Required.





     The LDAP web address used
to access the source LDAP system. The port is required and is typically
389 for non-SSL connections. 





     Express this value in the form
of ldap://host:port. For example: ldap://myservername.com:389.





     If
using the population wizard, this property is configured using the LDAP
server name and LDAP server port on
the LDAP server connection page.





      The LDAP query constructed
from the source URL, search base, and search filter are stored in
a source url property, which can be used to segment the Profiles database
user set during synchronization. Using different values for this property,
which may be equivalent (for example referencing the LDAP server by
IP address or DNS name) is not advised.





     The default value
is ldap://localhost:389.




    source_ldap_use_ssl
    LDAP URL Use SSL connection
    


     Required if you are using SSL to authenticate. 





     Set
to either true or false. 





     Set to true if you are using SSL (for
example if you are using port 636 in the LDAP URL). 





     The default
value is false.





     If using the population wizard, this property
is configured with the Use SSL communication checkbox
on the LDAP server connection page.




    source_ldap_user_login
    Login user name
    


     Login user name used for authentication.
You can leave this blank if no authentication is required.





     If
using the population wizard, this property is configured in the Bind
distinguished name (DN) field on the LDAP authentication
properties page.




    source_ldap_user_password
    Login password
    


     Login password used for authentication. Leave
this blank if no authentication is required. The value will be encrypted
in the file the next time it is loaded.





     If using the population
wizard, this property is configured in the Bind password field
on the LDAP authentication properties page.




    source_ldap_search_base or source_ldap_user_search_base
    Search Base
    


     The search base (the location from where
the search begins) of the iterating directory. The search begins at
this point in the ldap directory structure and searches all records
underneath. This should be a distinguished name. 


      Most directories
require a search base, and as such it must be a valid distinguished
name. Some directory services allow you to specify a blank string
which defaults to whatever the server is configured to do.






     A
default value is not specified.





     If using the population wizard,
this property is configured in the LDAP user search base field
on the LDAP page. 




    source_ldap_search_filter or source_ldap_user_search_filter
    Search Filter
    


     Search filter used when iterating the directory.





      This determines which objects are included or excluded in the search. If using the search base and the specified search filter properties do
not allow you to adequately construct your search set, use the source_ldap_required_dn_regex property.





      Search
filters are used by those directories to select entries from which
data is retrieved from a search operation. Care should be taken when
specifying search filters as they can affect performance of the directory
being searched. The directory server schema being queried can impact
performance. 





     A default value is not specified.





     If
using the population wizard, this is the LDAP user search
filter field on the LDAP authentication properties page.




    source_ldap_sort_page_size
    Page size
    


     If specified, the LDAP Connector tries to
use paged mode search. Paged mode causes the directory server to return
a specific number of entries (called pages) instead of all entries
in one chunk. Not all directory servers support this option. The default
value is 0, which indicates that paged mode is disabled. 





     The default value is 0.





     This parameter is not configurable when
using the population wizard. 




     
     
     



    source_ldap_authentication_method
    Authentication Method
    


     Options include the following:



     
    Anonymous
    




     
    This method provides minimal security.
    




     
    Simple
    




     
    This method uses a login user name and password to authenticate.
It is treated as anonymous if no user name and password are provided.
    




     
    CRAM-MD5
    




     
    Challenge/Response Authentication Mechanism using Message Digest
5. This method provides reasonable security against various attacks,
including replay.
    




     
    SASL
    




     
    Simple Authentication and Security Layer. This method adds authentication
support to connection-based protocols. Specify parameters for this
type of authentication using the Extra Provider Parameters option.
    

    





     This parameter is not configurable when using the population wizard.




    source_ldap_collect_dns_file
     
    


     Name of the file used to collect distinguished
names (DNs) by the collect_dns.bat/sh process
from the source, and then used during population by the populate_from_dn_file.bat/sh processes
to look up entries to add to the database repository. 





     This
file can also be constructed by hand to populate an explicit set of
users.





     The default value is collect.dns.





     This
parameter is not configurable when using the population wizard.




    source_ldap_escape_dns
     
    


     Indicates that special characters have not
been escaped properly and identifies them so the processor can find
those characters and escape them. Special characters are:



     
      


       
    •  , (comma)





       
    •  = (equals)





       
    •  + (plus)





       
    •  < (less than)





       
    •  > (greater than)





       
    •  # (number sign)





       
    •  ; (semicolon)





       
    •  \ (backslash)





       
    •  " (quotation mark)


    





     The backslash is used to escape special characters. A plus
sign is represented by \+ and a backslash is represented
by \\. 





     if your distinguished names contains
these special characters and you receive errors when running the collect_dns/populate_from_dn_file
process, set this property to true so that the characters
are escaped.





     The default value is false.





     This parameter
is not configurable when using the population wizard.




    source_ldap_required_dn_regex
     
    


     Allows a regular expression to be used to
limit the distinguished names (DNs) which are processed by providing
a regular expression which must be matched. If the regular expression
is not matched, that particular record is skipped. Although the search
filter property gives some flexibility, in case this is not sufficient,
you can use a more powerful regular expression.





     A default value
is not specified.





     This parameter is not configurable when using
the population wizard.




    source_ldap_sort_attribute
    Sort Attribute
    


     Specifies server-side sorting. This parameter
instructs the LDAP server to sort entries matching the search base
on the specified field name. Server-side sorting is an LDAP extension.
The iterating directory must be able to support this sorting extension. 





     A
default value is not specified.





     This parameter is not configurable
when using the population wizard.




    source_ldap_iterate_with_filter
     
    


     This property should be used if the size
of the data to be retrieved from LDAP exceeds the search limit from
the LDAP.  For example, if your search parameters would return 250K
records but your LDAP only allows 100K to be returned at a time, this
parameter must be used.  





     If the data is too large, an LDAP
size limit exceeded error message is generated.   To configure this
mechanism, see the Populating a large user set topic.





     When
set to true, this specifies that the default iteration assembly line
use the collect_ldap_dns_generator.js file to
iterate over a set of LDAP search bases and filters. The cconfig setting
replaces the sync_all_dns_forLarge and collect_dns_iterate scripts
used in earlier releases.





     This parameter is not configurable
when using the population wizard.





     The default value is false.




    source_ldap_binary_attributes
    Binary Attributes
    


     By default, this property is set internally
to GUID, objectGUID, objectSid, sourceObjectGUID. Any additional values
specified in the property are appended to the list. 





     This parameter
is not configurable when using the population wizard.





     The default
value is GUID.




    source_ldap_time_limit_seconds
    Time Limit
    


     Specifies the maximum number of seconds that
can be used when searching for entries; 0 = no limit.





     This parameter
is not configurable when using the population wizard.





     The default
value is 0.




    source_ldap_map_functions_file
     
    


     Specifies the location of any referenced
function mappings.





     When using the population wizard, the functions
shown in the mapping dialog are read from and written to this file.





     The default value is profiles_functions.js.




    source_ldap_logfile
     
    


     In addition to the standard logs/ibmdi.log file,
output from the populate_from_dn_file.bat or populate_from_dn_file.sh task
is written to this file.





     This parameter is not configurable
when using the population wizard.





     The default value is logs/PopulateDBFromSource.log.




    source_ldap_compute_function_for_givenName
     
    


     Connections allows Javascript functions for
setting values of common LDAP fields such as cn, sn, givenName to
execute before Connections performs its mapping. For example, sn and/or givenName can
be parsed from cn (common name).





     This parameter
is not configurable when using the population wizard.





     A default
value is not specified.




    source_ldap_compute_function_for_sn
     
    


     Connections allows Javascript functions for
setting values of common LDAP fields such as cn, sn, givenName to
execute before Connections performs its mapping. For example, sn and/or givenName can
be parsed from cn (common name).





     This parameter
is not configurable when using the population wizard.





     A default
value is not specified.




    source_ldap_collect_updates_file
     
    


     This property is no longer used.




    source_ldap_manager_lookup_field
     
    


     This property is no longer used.




    source_ldap_secretary_lookup_field
     
    


     This property is no longer used.




    






     Many
properties in the TDI LDAP connector are not mapped to Profiles TDI
properties. To configure properties other than those listed here,
consider using an alternate source repository and creating your own
specialized configuration. Use the LDAP iterator and connectors provided
with the TDI solution directory as a starting point, see Using
a custom source repository connector for more information.





     The following properties are associated with the Profiles database repository.


      The following properties must be set in the profiles_tdi.properties file,
even if developing your own assembly lines using the connectors provided
in the Profiles TDI solution directory. These properties are not configured
in the Connector panels, but rather in the profiles_tdi.properties file.
See Developing custom Tivoli Directory Integrator assembly lines for
Profiles for more information.




    Table 111. Profiles
Database Properties

    Property 
    TDI parameter
    Definition




    dbrepos_jdbc_driver
    JDBC Driver
    


     Required.





     The JDBC driver implementation
class name used to access the Profiles database repository. 





     For DB2, the default is com.ibm.db2.jcc.DB2Driver. For example:


    dbrepos_jdbc_driver=com.ibm.db2.jcc.DB2Driver
    






     For Oracle, the default is oracle.jdbc.driver.OracleDriver.
For example:


    dbrepos_jdbc_driver=oracle.jdbc.driver.OracleDriver
    






     If
you are using a Microsoft SQL Server database, change the value to
reference a SQL Server driver, for example:


    dbrepos_jdbc_driver=com.microsoft.sqlserver.jdbc.SQLServerDriver
    






     This
corresponds to the JDBC driver path in the population wizard. If not
using the wizard, this library must be present in the CLASSPATH of
Tivoli Directory Integrator, or Tivoli Directory Integrator cannot
load the library when initializing the Connector and cannot communicate
with the Relational Database (RDBMS). 





     To install a JDBC driver
library so that Tivoli Directory Integrator can use it, copy it into
the TDI_install_dir/jars directory, or a subdirectory
such as TDI_install_dir/jars/local.




    dbrepos_jdbc_url
    JDBC URL
    


     Required.





     JDBC web address used to
access the Profiles database repository. 





     You must modify the hostname portion and port number to reference your server information. 


      You can find this information by accessing the WebSphere Application Server Administration
Console (http://yourhost:9060),
and then selecting Resources > JDBC > Data sources > profiles.
 





     The default
syntax is for DB2, unless using the wizard, but the default uses a
local host. If the DB2 is not on the same system as the TDI solution
directory, update the URL with the host name.





     If you are using
an Oracle database, use the following syntax: 


    dbrepos_jdbc_url=jdbc:oracle:thin:@<host_name>:1521:orcl
    






      If you are using a SQL Server database, use the following syntax: 


    dbrepos_jdbc_url=jdbc:sqlserver://<host_name>:1433;databaseName=PEOPLEDB
    





    dbrepos_username
    User name
    


     Required.





     User name under which the database tables, which are part of the Profiles database repository,
are accessed.




    dbrepos_password
    Password
    


     Required.





     Password associated with
the username under which the database tables, which are part of the Profiles database repository, are accessed.




    dbrepos_mark_manger_if_referenced
     
    


     This property is no longer used.




    







     The following properties are associated with the task
that monitors the Profiles employee draft table for changes and transmits
them through a DSML v2 connector.



    Table 112. Change Monitoring
Properties

    Property 
    TDI parameter
    Definition




    monitor_changes_dsml_server_authentication
     
    


     Type of authentication used by the DSML server
update requests. Options include the following: 



     
    HTTP basic authentication
    




     
    A method designed to allow a web browser, or other client program,
to provide credentials, in the form of a user name and password, when
making a request.
    




     
    Anonymous
    




     
    This method provides minimal security.
    

    




    monitor_changes_dsml_server_url
     
    Required if you are transmitting
user changes back to the source repository. 


     Web address
of the DSML server to which the DSML update requests should be sent.




    monitor_changes_dsml_server_username
     
    Required if you are transmitting
user changes back to the source repository. 


     User name
used for authentication to the DSML server.




    monitor_changes_dsml_server_password
     
    Required if you are transmitting
user changes back to the source repository. 


     Password
used for authentication to DSML server that the DSML update requests
should be sent to.




    monitor_changes_map_functions_file
     
    


     Path to the file containing mapping functions
for mapping from a changed database field to a source. for example
LDAP field. This is only needed if changes made to the source based
on database repository field changes are not mapped one-to-one. You can use the same file you use to map from source to database repository
fields, assuming the functions are named appropriately.




    monitor_changes_sleep_interval
     
    


     Polling interval, in seconds, between checks
for additional changes when no changes exist.




    







     The following properties are associated
with the Tivoli Directory
Integrator processing that reads a Tivoli Directory
Server change log and subsequently updates the database repository
with those changes.



    Table 113. Tivoli Directory Server Change Log Properties

    Property 
    TDI parameter
    Definition




    ad_changelog_ldap_url
     
    


     LDAP web address used to access the LDAP
system that was updated. For example:


    ldap://host:port
    





    ad_changelog_ldap_user_login
     
    


     Login user name to use to authenticate with
an LDAP system that has been updated. You can leave this blank if
no authentication is needed.




    ad_changelog_ldap_user_password
     
    


     Login user name to use to authenticate with
an LDAP that has been updated. You can leave this blank if no authentication
is needed. The value will be encrypted in the file the next time it
is loaded.




    ad_changelog_ldap_search_base
     
     



    ad_changelog_ldap_use_ssl
     
    


     Defines whether or not to use SSL in authenticating
with an LDAP system that was updated. The options are true and false.




    ad_changelog_timeout
     
     



    ad_changelog_sleep_interval
     
    


     Polling interval, in seconds, between checks
for additional changes when no changes exist.




    ad_changelog_use_notifications
     
    


     Indicates whether to use changelog notifications
rather than polling. If true, the tds_changelog_sleep_interval is
not applicable since polling is not used. The options are true and
false. 




    ad_changelog_ldap_page_size
     
     



    ad_changelog_start_at 
     
    


     Change number in the Active Directory changelog
to start at. Typically this is an integer, while the special value
EOD means start at the end of the changelog.




    ad_changelog_ldap_required_dn_regex. 
     
     



    tds_changelog_ldap_authentication_method
    Authentication Method
    


     Authentication method used to connect to
LDAP to read records. Options include the following:



     
    Anonymous
    




     
    This method provides minimal security.
    




     
    Simple
    




     
    This method uses a login user name and password to authenticate.
It is treated as anonymous if no user name and password are provided.
    




     
    CRAM-MD5
    




     
    Challenge/Response Authentication Mechanism using Message Digest
5. This method provides reasonable security against various attacks,
including replay.
    




     
    SASL
    




     
    Simple Authentication and Security Layer. This method adds authentication
support to connection-based protocols. Specify parameters for this
type of authentication using the Extra Provider Parameters option.
    

    




    tds_changelog_ldap_changelog_base
    ChangelogBase
    


     Changelog base to use when iterating through
the changes. This is typically cn=changelog.




    tds_changelog_ldap_time_limit_seconds
    Time Limit
    


      Search for entries must take no more than
this number of seconds; 0 = no limit.




    tds_changelog_ldap_url
    LDAP URL
    


     LDAP web address used to access the LDAP
system that was updated. For example:


    ldap://host:port
    





    tds_changelog_ldap_use_ssl
    Use SSL
    


     Defines whether or not to use SSL in authenticating
with an LDAP system that was updated. The options are true and false. 




    tds_changelog_ldap_user_login
     Login user name
    


     Login user name to use to authenticate with
an LDAP system that has been updated. You can leave this blank if
no authentication is needed.




    tds_changelog_ldap_user_password
    Login password
    


     Login user name to use to authenticate with
an LDAP that has been updated. You can leave this blank if no authentication
is needed. The value will be encrypted in the file the next time it
is loaded.




    tds_changelog_sleep_interval
     
    


     Polling interval, in seconds, between checks
for additional changes when no changes exist.




    tds_changelog_start_at_changenumber
     
    


     Change number in the Tivoli Directory Server changelog to start
at. Typically this is an integer, while the special EOD value means
start at the end of the changelog.




    tds_changelog_use_notifications
     
    


     Indicates whether to use changelog notifications
rather than polling. If true, the tds_changelog_sleep_interval is
not applicable since polling is not used. The options are true and
false. 




    







     The following properties are
available in the profiles_tdi.properties file
and are associated with Tivoli Directory
Integrator debug activities. 


      The debug properties enable TDI
debugging for an entire assembly. In addition, enabling debug_update_profile which
enables debugging for the commands that use the Profiles Connector,
also enables Java debugging for the following packages. 


     
      


       
    •  log4j.logger.com.ibm.lconn.profiles.api.tdi=ALL





       
    •  log4j.logger.com.ibm.lconn.profiles.internal.service=ALL





       
    •  log4j.logger.java.sql=ALL


    






      The following properties are not configurable when
using the population wizard.




    Table 114. Tivoli Directory Integrator Debug
and Trace Properties

    Property 
    TDI parameter
    Definition




    sync_all_dns
     
    For information about sync_all_dns,
see Understanding how the sync_all_dns process works.



    debug_managers
     
    


     Flag that instructs TDI to log additional
debug information for the following command(s).





     The options
are true and false. 





     To enable, set as debug_managers=true.





     This
property maps as follows:


    debug_managers
    mark_managers
    






     The default setting is false.




    debug_photos
     
    


     Flag that instructs TDI to log additional
debug information for the following command(s).





     The options
are true and false. 





     This property maps as follows:


    debug_photos
    load_photos_from_files
    dump_photos_to_files
    






     The default setting is
false.




    debug_pronounce
     
    


     Flag that instructs TDI to log additional
debug information for the following command(s).





     The options
are true and false. 





     This property applies to the following command(s):


    debug_pronounce
    load_pronounce_from_files, 
    dump_pronounce_to_files
    






     The default setting
is false.




    debug_fill_codes
     
    


     Flag that instructs TDI to log additional
debug information for the following command(s).





     The options
are true and false. 





     This property applies to the following command(s):


    debug_fill_codes
    fill_country
    fill_department
    fill_emp_type
    fill_organization
    fill_worklok
    






     The default setting is false.




    debug_draft
     
    


     Flag that instructs TDI to log additional
debug information for the following command(s).





     The options
are true and false. 





     This property applies to the following command(s):


    debug_draft
    process_draft_updates
    reset_draft_iiterator_state
    set_draft_iterator_count
    






     The default setting
is false.




    debug_update_profile
     
    


     Flag that instructs TDI to log additional
debug information for the following command(s).





     The options
are true and false. 





     This property applies to the following command(s):


    debug_update_profile
    populate_from_dn_file
    delete_or_inactivate_employees
    populate_from_xml_file
    process_ad_changes
    process_tds_changes
    






     The default setting is false.




    debug_collect
     
    


     Flag that instructs TDI to log additional
debug information for the following command(s).





     The options
are true and false. 





     This property applies to the following command(s):


    debug_collect
    collect_dns
    






     The default setting is false.




    debug_special
     
    


     Flag that instructs TDI to log additional
debug information for the following command(s).





     The options
are true and false. 





     This property applies to the following command(s):


    debug_special
    unused at present
    






     The default setting is false.




    trace_profile_tdi_javascript
     
    


     Enables generation of an internal Javascript
trace file. 





     Options are OFF, FATAL, ERROR, WARN, INFO, DEBUG,
TRACE, ALL ( values are not case-sensitive).





     The default setting is OFF.
 



    





     
    Related tasks
    

  •   Update Profiles when changing LDAP directory




     Configure the Manager designation in user profiles
    



     When you map manager data in the Profiles database, you
can mark manager profiles and also create report-to chains.

    


     Each profile contains a manager_uid field
which stores the uid value of that person's manager.
This information is used to build the Reports To display
widget in the Profiles user interface. For information about the manager_uid field,
see Mapping fields manually. 





     Additionally, the isManager field
(which equates to the Mark manager mapping
task in the Profiles population wizard) is used to mark the user profile
as being a manager. This information is used to build the People
Managed display widget in the Profiles user interface. A Y or N attribute
is assigned to an employee to indicate whether the employee is listed
as a manager of other employees. 





     You can set the isManager field
as described in the Mapping fields manually topic (using
either 1:1 mapping or function mapping) or by running the Mark manager
task (using the population wizard or by running the mark_manager.bat or mark_manager.sh script).
For more information about these options see Using the Profiles
population wizard and Manually populating the Profiles
database.





     If you are setting the ismanager field
using a 1:1 mapping, ensure specified how to set the field
in the map_dbrepos_from_source.properties file.
For example, if your LDAP has an  ismanager field
that is set to a value of Y or N, your map_dbrepos_from_source.properties file
could specify the following property:


    PROF_IS_MANAGER=ismanager
    






     If
the manager information is supplied directly from the source, the Mark manager task is not necessary. 





     The Mark manager task will
iterate through the profiles, and see if that particular profile is
referenced as the manager for any other profiles. If yes, it will
mark that profile as a manager. If that profile is not referenced
as anyone else's manager, it will be marked as not a manager.





     For information about configuring the display of the Reports
To and People Managed widgets for your organization, see Enabling the display of organizational structure
information.





    Batch files for processing Profiles data
    



     IBM Connections provides
several batch files that automate the collection and processing of
LDAP data for the Profiles database.






     
    Batch file
functions
    


      The name of each
batch file ends with the .sh suffix for the IBM AIX and Linux operating
systems and with the .bat suffix for the Microsoft Windows operating system.





     The following list describes each batch file and its functions. You can search for
more information about these files in the help topics.



     
    clearLock
    




     
    Delete the lock file that is generated by the sync_all_dns batch
file.
    




     
    collect_dns
    




     
    Create a file
called collect.dns that contains
the distinguished names from the LDAP directory. This batch file is
used in the first step of the process to populate the Profiles database.
    




     
    delete_or_inactivate_employees
    




     
    Deactivate
employee records in the Profiles database. The records
are not removed from the Profiles database but are set to an inactive
state and the employee login and mail address values are removed.
 These changes are propagated to the member and login tables in the DBs of installed applications. The records to be deactivated
are defined in the delete_or_inactivate_employees.in file.
To remove users from only the Profiles database, change the value of the sync_delete_or_inactivate property in the profiles_tdi.properties file
to delete.


      You must manually create the delete_or_inactivate_employees.in file.
Use the following format for adding entries:


     $dn:cn=Any
User3,cn=Users,l=WestfordFVT,st=Massachusetts,c=US,ou=Lotus,o=Software
Group,dc=ibm,dc=com uid:Any User3 


    




     
    dump_photos_to_files
    




     
    Copy all the photos from
the PHOTO table in the Profiles database
to a folder on the local system called dump_photos.
This batch file also creates a local file called collect_photos.in that
contains the UID and URL of each photo.
    




     
    dump_pronounce_to_files
    




     
    Copy all the pronunciation files from the PRONUNCIATION table
in the Profiles database to a folder on the local system called dump_pronounce.
the local files. This batch file also
creates a local file called collect_pronounce.in that
contains the UID and URL of each pronunciation file.
    




     
    fill_country
    




     
    Populate the COUNTRY table in the Profiles database from the isocc.csv file.
    




     
    fill_department 
    




     
    Populate the DEPARTMENT
table in the Profiles database from the deptinfo.csv file.
    




     
    fill_emp_type 
    




     
    Populate the EMP_TYPE
table in the Profiles database from the emptype.csv file.
    




     
    fill_organization 
    




     
    Populate the ORGANIZATION
table in the Profiles database from
the orginfo.csv file.
    




     
    fill_workloc 
    




     
    Populate the WORKLOC table in the Profiles database from the workloc.csv file.
    




     
    load_photos_from_files
    




     
    Load all the photos from the dump_photos folder
on the local system to the PHOTO table in the Profiles database. This batch file reads the collect_photos.in file and
the dump_photos folder that you created with
the dump_photos_to_files batch file. This batch
file loads photos only for people who are already recorded in the database.
    




     
    load_pronounce_from_files
    




     
    Load
all the pronunciation files from the dump_pronounce folder
on the local system to the PRONUNCIATION table in the Profiles
database. This batch file reads the collect_pronounce.in file
and the dump_pronounce folder that you
created with the dump_pronounce_to_files batch
file. This batch file loads pronunciation files only for people who
are already recorded in the database.
    




     
    mark_managers
    




     
    Set the PROF_IS_MANAGER field in the Profiles database, based
on the value of the PROF_MANAGER_UID field in the employee records.
    




     
    populate_from_dn_file
    




     
    Populate the Profiles database from the source LDAP directory.
This batch file reads the collect.dns data file
that you created with the collect_dns batch file.
The batch file also updates existing employee records in the Profiles
database.
    




     
    process_ad_changes
    




     
    Synchronize
LDAP directory changes with the Profiles database
when your LDAP directory type is Microsoft Active
Directory. This batch file is stored in the solution-dir/Samples directory.
For
more information, go to the Active Directory Change Detection Connector topic
in the Tivoli Directory
Integrator information center. For information about permissions,
go to the How
to poll for object attribute changes topic on the Microsoft Support website.
     The sync_all_dns script
is recommended when you want to synchronize changes in the LDAP directory with the Profiles database.

    




     
    process_draft_updates
    




     
    Synchronize changes from
the Profiles database back to the LDAP
directory.
    




     
    process_tds_changes
    




     
    Synchronize
LDAP directory changes with the Profiles database
when your LDAP directory type is IBM Tivoli Directory
Server. This batch file is stored in the solution-dir/Samples directory.


      The sync_all_dns script
is recommended when you want to synchronize changes in the LDAP directory with the Profiles database.

    




     
    sync_all_dns
    




     
    Update the Profiles database
to capture changes to the LDAP directory.
This synchronization process includes updates to employee records
and additions and deletions of records.
    




     
    tdienv
    




     
    Set the correct environment for IBM Tivoli Directory
Integrator. This batch file sets the path to the Tivoli Directory Integrator program, the Tivoli Directory Integrator host,
and the Tivoli Directory
Integrator port. If you installed Tivoli Directory
Integrator to a custom location, modify the path to that location before using this batch file.
    

    



     
    Related tasks
    

  •   Update Profiles when changing LDAP directory

  •   Synchronize IBM Tivoli Directory Server and Microsoft Active Directory LDAP changes

  •  Delete or inactivate users in the Profiles database




     Use the calendar in the Activities widget
    

    


     Use the calendar in the Activities widget to find out which
of your task deadlines are approaching.


    About this task
    


     The calendar highlights the deadlines
for your to-do items for the current month, using the following background
colors and symbols to highlight significant dates. The current date
is highlighted in bold text.

    



    Table 115. Calendar
color codes and symbols

    Background color
    Symbol
    Description




    Red
    >
    To-do items that are overdue.



    Gray
    #
    To-do items to be completed today.



    Blue
    *
    Personal to-do items to be completed on a future
date.



    Green
    +
    Team (unassigned) to-do items to be completed
on a future date.



    

For example, for a to-do item assigned to you personally that
must be completed on a future date, that date is highlighted with
a blue background, with an asterisk (*) symbol preceding the date.





     The calendar also flags the dates associated with
unassigned tasks to be completed in the future. Deadlines for completed
tasks are not included. If a personal to-do item and a team to-do
item fall on the same day, then the calendar flags the personal to-do
item rather than the team to-do item.





     Use the arrows on either
side of the month name to display task deadlines for the previous
and following months.


    


     To view the tasks associated with a specific deadline,
complete the following steps.


     
      


       
    1.  Click the highlighted date in the calendar. A
pop-up window displays, listing the tasks with deadlines on the selected
day.





       
    2.  Click a task title to retrieve information about the task
directly from the Activities application.





       
    3.  When you are finished working with the task, close the window to return to the Home page.


    




    Add links to your profile
    

    


     Add external web site links to your profile page to share
them with others.


     




You can add your favorite web sites, such as social networking
sites or industry web sites, to the My Links area
of your profile. For example, you might want to include a link to
your twitter feed, public blog, or your profile on Facebook or LinkedIn
so that you and your colleagues can easily access your social data
from your profile page.

    


     To add a link to the My Links area
in your profile.


     
      


       
    1.  From your My Profile page, click Add
Link in the My Links area.





       
    2.  Enter a name for the link in the Name field. The text you enter here is displayed in the My Links area as
the hypertext link. For example, if the link goes to your LinkedIn
profile, you might enter "My LinkedIn profile."





       
    3.  Type or paste in the web address of the page you want to
link to into the Link field, and then click Save. 


       For example, you can copy one of the following types of web
addresses and paste it into the Link field:


       
        


         
      •  Twitter feed. From your Twitter settings, find the public profile
web address, such as http://twitter.com/myusername.





         
      •  LinkedIn profile. From your profile in LinkedIn, find the public
profile web address, such as http://www.linkedin.com/pub/my-name/8/234/a05.





         
      •  Facebook profile. Open your profile in Facebook, and then copy
the web address in the browser location bar, such as http://www.facebook.com/profile.php?id=000000000000000.


         To improve the readability of the web address for your profile, you can
go to your account settings and create a Facebook user name, which
gets used in the profile web address: http://www.facebook.com/username.



      




    




    Add widgets to your Home page
    

    


     Add widgets to the activity stream and My Page views
so that you can see updates from IBM Connections and other sources, and bring extra functionality to your Home page.


     To add an IBM Connections widget to the Home page, your organization must have a subscription
to the corresponding IBM Connections application. You can also add third-party widgets if your administrator has enabled use of them. The content palette lists all the widgets
that the administrator has made available for your deployment.







     The first time you use the Home page, a number of default
widgets display in the activity stream and My Page views.
You can extend the information displayed in each view by adding extra
widgets from the content palette. For example, if you are an active
blogger and are interested in seeing what other bloggers in your organization
are talking about, you might want to add the Blogs widget. Or, if
you want to keep track of what the people in your network are doing,
you might want to add the My Network widget.





     You can add widgets
to any of the columns in the My Page view, but
you can only add widgets to the side column in the activity stream
views. Your widget preferences are automatically saved by the system
so that when you next open the Home page, the widget display is the same as when you last used the page.


      Your preferences are not
saved if you remove all the widgets from a page. When you remove all
the widgets, the page is automatically reset to display the default
set of widgets the next time that you return.



    


     To add a widget.


     
      


       
    1.  Click Customize. 


        If you are in the My Page view, you might need to
click the Add Content tab if it is not already
displayed.






       
    2.  Select a widget type from the menu sidebar, and then click
a widget to add it.





       
    3.  Click the Close palette icon to
close the content palette.


    




    Add a node to a cluster
    





     Add a node to an existing cluster.


     You must already have a cluster with at least one member. 


     Ensure installed IBM WebSphere Application Server Network Deployment (Application Server option) on the new node.





     If you are adding a node to a Search cluster, do not use these
instructions. Instead, use the instructions in the Add an
additional Search node to a cluster topic.





     Although the IBM Cognos Business Intelligence server is managed by the same Deployment
Manager as IBM Connections,
you cannot add that node to the Connections cluster.








     To add a node to a cluster:


    


     
      


       
    1.  Add a node to the DM cell:


       
        


         
      1.  Log on to the new node.





         
      2.  Open a command prompt and change to the bin directory
of the local WebSphere Application Server profile:  


         app_server_root/profiles/profile_name/bin





         where profile_name is the name of the applicable WebSphere Application Server
profile on this node.






         
      3.  Run the addNode command to add this node to the DM cell:
. 


         addnode [dmgr_host]
[dmgr_port] [-username uid]
[-password pwd] [-localusername localuid] [-localpassword localpwd]





         where 


         
          


           
        •  dmgr_host is the host name of the Deployment
Manager





           
        •  dmgr_port is the SOAP port of the deployment
manager (the default is 8879)





           
        •  uid and pwd are the DM administrator user
name and password





           
        •  localuid and localpwd are
the user name and password for the WebSphere Application Server administrator of the node


        







         
      4.  Open the addNode.log file and confirm
that the node was successfully added to the DM cell. The file is stored
in the following location:  


         app_server_root/profiles/profile_name/log/addNode.log



      






       
    2.  Copy the relevant JDBC files from the DM node to this node,
placing them in the same location as the JDBC files on the DM. If,
for example, you copied the db2jcc.jar file from
the C:\IBM\SQLLIB directory on the DM, you must
copy the same file to the C:\IBM\SQLLIB directory
on this node. See the following table to determine which files to
copy. See the following table to determine which files to copy: 



      Table 116. JDBC files

      Database type
    JDBC files




      DB2
    


       db2jcc.jar





       db2jcc_license_cu.jar sql




      Oracle
    


       ojdbc6.jar




      SQL Server
    


       sqljdbc4.jar




      







       
    3.  Ensure that the shared folders that are used for the application
content stores in the cluster are accessible from the new node: from
the new node, try to access the shared directories.





       
    4.  Add additional members
to an existing IBM Connections cluster:


       
        


         
      1.  Log on to the Deployment Manager Integration Solutions Console.





         
      2.  Click Servers > Clusters > cluster_name > Cluster members > New. Set the following information about the new cluster
member: 


         
        Member name
        




         
        The name of the server instance that is created for the cluster.
The DM creates a server instance with this name.


          Each member
name in the same cluster must be unique. The Integration Solutions Console prevents you from reusing the same member name in a cluster.

        

        



         
        Select node
        




         
        The node where the server instance is located.
        

        





         Click Add Member to add this
member to the cluster member list.






         
      3.  Click Next to go to the summary
page where you can examine detailed information about this cluster
member. Click Finish to complete this step
or click Previous to modify the settings.





         
      4.  Click Save to save the configuration.





         
      5.  Click Server > Servers > Clusters > cluster_name > Cluster members. In the member list, click the new member that you
added in the previous step.





         
      6.  On the detailed configuration page, click Ports to expand the port information of the member. Make
a note of the WC_defaulthost and WC_defaulthost_secure port numbers.
For example, the WC_defaulthost port number is typically 9084, while
the WC_defaulthost_secure port number is typically 9447.





         
      7.  Click Environment > Virtual Hosts > default_host > Host Aliases > New. Enter the following information for the host alias
for the WC_defaulthost port: 


         
        Host name
        




         
        The IP address or DNS host name of the node where the new member
is located.
        

        



         
        Port: 
        




         
        The port number for WC_defaulthost. For example, 9084.
        

        





         Click OK to complete the virtual host configuration.






         
      8.  Click Save to save the configuration.





         
      9.  Repeat the previous two substeps to add the host alias
for the WC_defaulthost_secure port.





         
      10.  Click System administration > Nodes.





         
      11.  In the node list page, select all the nodes where the target cluster members are located and then click Synchronize. 


      



    

     
    What to do next
    


     Configure IBM HTTP
Server to connect to this node. For more information, see the Configuring IBM HTTP Server and Defining IBM HTTP
Server for a node topics.





     Repeat this
task for each new node to add to a cluster.





     (AIX or Linux only) If you installed the Search application
on the new node, configure the path variables to point to that application.
For more information, see the Copying Search conversion tools
to local nodes topic. 





     If you experience interoperability
failure, you might be running two servers on the same host with the same name. This problem can cause the Search and News applications
to fail. For more information, go to the NameNotFoundException from JNDI lookup operation web page.



     
    Related tasks
    

  •  Add an additional Search node to a cluster




     Restore
a Community Blogs widget
    





     If the Communities server
crashes, use this command to
restore the Blogs widget.


     


     To edit configuration files, you must
use the wsadmin client. See  Administer Blogs using the wsadmin Client for
details.





Use this command to restore a Blogs
widget and its content
after a Communities server crash. 

    


     
      


       
    1.  Open a command window and start the wsadmin command line
tool. See Starting the wsadmin client for more details. 


        In clusters, when you run the command from the deployment
manager the path and file are created on the server running Blogs.
In clusters where multiple nodes are running Blogs, you are asked
choose a server to connect to and run the command on, and then the path and file are created on that server.






       
    2.  Start the Blogs Jython script interpreter by entering the following command: 


       
        


         
      •  Single server:


        execfile("blogsAdmin.py")
        






         
      •  Cluster:


        execfile("<WAS_HOME>/blogs/DMGR/bin/blogsAdmin.py")
        



      






       
    3.  Use the following command to identify
the Blogs widget
file:  


       
      BlogsAdminService.exportSyncedResourceInfo(FullFilePath,
ContainerType)
      




       
      


       The FullFilePath is
the absolute path
to the file name. For example, "c:/output.xml". Notice the forward
slash. 





       ContainerType only supports type
"community"

      

      
 For example,
output may look like
this:


      <snx:feed xmlns:snx="http://www.mycompany.com/xmlns/prod/sn" snx:remoteAppDefId="Blog" 
            snx:objectIdentifyingIdName="BlogUuid" snx:objectIdentifyingTermName="Blog Name">
  <snx:resource type="community" id="72a57bd0-ae9b-4d23-a511-b21b1b06359f">
    <snx:property name="communityType">publicInviteOnly</snx:property>
    <snx:objectIdentifyingTerm>jones4_comm_2</snx:objectIdentifyingTerm>
    <snx:objectIdentifyingId>351638e8-2888-4d72-995c-91078cbe0d76</snx:objectIdentifyingId>
  </snx:resource>
  <snx:resource type="community" id="67810d57-6c00-403d-9385-81d0f0d1cfa7">
    <snx:property name="communityType">public</snx:property>
    <snx:objectIdentifyingTerm>jones3_comm</snx:objectIdentifyingTerm>
    <snx:objectIdentifyingId>3a3806e7-235a-4833-8b82-fc4753568d27</snx:objectIdentifyingId>
  </snx:resource>
  <snx:resource type="community" id="7409e731-6c48-4a84-b162-8f65ff3e6dfb">
    <snx:property name="communityType">private</snx:property>
    <snx:objectIdentifyingTerm>jones4_comm</snx:objectIdentifyingTerm>
    <snx:objectIdentifyingId>99eafe90-f8c5-4ae2-af61-410132c72ead</snx:objectIdentifyingId>
  </snx:resource>
</snx:feed>
      






       
    4.  Use the following command to remove any orphaned data following the restore process: 


       
      BlogswAdminService.deleteweblog(weblogId)
weblogId = blog uuid
      




       
      The blog UUID is the snx:objectIdentifyingId
in the exported synced
resource information xml file. 
      

      



    


     
    Related tasks
    

  •   Restore communities with remote applications

  •   Delete orphaned data




     Synchronize
user identification data between Blogs and LDAP
    





     You can run commands that will synchronize the unique identifier
(user ID) and user email addresses used in Blogs with the user information
stored in LDAP. You can also remove inactive users.


     


     To edit configuration files, you must
use the wsadmin client. See  Start the wsadmin client for
details.





The synchronization commands synchronizes
the unique identifiers
(user IDs) or email addresses used in Blogs with the corresponding
user IDs or email addresses used in the LDAP directory. Run these
commands if LDAP information for any Blogs users changed. For example,
if a user in an LDAP directory was deleted and then added back, the user would get a new user ID in the LDAP directory - even if the user
was recreated with the same Login Name or email address. You would
then need to run one of the synchronization commands so that the Blogs
database tables can be updated with the new user ID from LDAP. If you are moving from a pilot installation to a full production environment,
you would be moving to a different LDAP and would need to run this
command.  


       If the IBM Connections server has Profiles directory service extension enabled in LotusConnections-config.xml,
you must also ensure that the Profiles component has also done a sync
command with the LDAP server, so that the information stored in the Profiles database reflects the new email addresses or new user IDs.
 With Profiles directory service extension enabled, the other components,
like Blogs, will look to the Profiles database (instead of LDAP) when
making some of the membership calls. 





     You can also use the MemberService command to remove inactive users who no longer exist
in the directory.


    


     
      


       
    1.  Open a command window
and start the wsadmin command line
tool. See Starting the wsadmin client for more details. 


        In a clustered environment, make sure you run wsadmin
from the WAS Network Deployment server. 






       
    2.  Start
the Blogs Jython script interpreter by entering the following command: 


      execfile("<WAS_PROFILE_ROOT>/<DmgrName>/bin/blogsAdmin.py")
      
 For example, WebSphere\AppServer\profiles\Dmgr01\config\bin_lc_admin\blogsAdmin.py 





       
    3.  Enter one of the following commands to synchronize
user
data: 


       
      BlogsMemberService.syncAllMembersByExtId(boolean)
      




       
      


       Iterates through all users in the Blogs ROLLERUSER database
table to compare them against the entries in the directory based on
each user's external ID. This command allows you to inactivate
users who no longer exist in the directory. It first checks to see
if the external ID is present in the directory. If it is, then no
action is performed. If the external ID does not exist in the directory,
an attempt is made to match the person by email address and login
name. If neither is found, then the person is marked as inactive in
the Blogs ROLLERUSER database table. If the match by login and email
is successful, then one of the following actions is taken: 


       
        


         
      •  If
you specified true as the parameter, then the member external
ID is updated.





         
      •  If you specified false as the parameter, then
the member information
is appended to a log file named <file name TBD>.


      






       Parameters:


       
      true
      




       
      Specifies that you want the external ID
in the Blogs ROLLERUSER
database table to be updated with the name in the directory if the current external ID is incorrect, but the correct ID was found by
matching the person's login name and email address.
      




       
      false
      




       
      Specifies to create a log
entry when the current
external ID is incorrect, but the correct ID was found by matching
the person's login name and email address.
      

      


      




       
      BlogsMemberService.syncMemberByExtId(newExternalID,
oldExternalID)
      




       
      


       Determines whether a user is active or inactive
by checking
the directory for the external ID used in the Blogs ROLLERUSER database
table to represent that user.





       Parameters:


       
      newExternalID
      




       
      Unique ID that represents a user. If you provide this parameter
alone, the command compares the active status of the member between
the Blogs ROLLERUSER database table and the directory. If the member
is marked as inactive in the Blogs ROLLERUSER database table, but
is found in the directory, then the record is reactivated. If the member is marked as active in the Blogs ROLLERUSER database table,
but is not found in the directory, then the record is marked as inactive.
      




       
      oldExternalID
      




       
      Optional. If you provide
this parameter, you are stating that
you know that the same person is being represented by two different
external IDs . the oldExternalID in the Blogs ROLLERUSER database
table where the member is marked as inactive and the newExternalID
in the your LDAP directory . and you want to use the value of the newExternalID to represent the person you want to activate. When you
specify this parameter, all the data associated with both IDs is merged
into a single record that is associated with the new ID only.
      

      

      CAUTION:
      Use this command with care. It should only be used when you are sure that the two IDs represent the same person.


      




       
      BlogsMigrationService.syncAllUserEmails()
      




       
      


       This command updates all email addresses in the Blogs ROLLERUSER
database table. This service queries the LDAP server for each user
by user ID to retrieve the updated email address, and then updates
all member email addresses by user ID.   Update time will vary, depending
on the number of people the Blogs ROLLERUSER database table. On average,
8 minutes per 500 users is the norm. For large DBs, run this
process overnight. 

      




       
      BlogsMemberService.syncAllMemberExtIds()
      




       
      


       This command will update the user's external user ID in the Blogs ROLLERUSER database table. This service queries the LDAP server
for each user by login name to retrieve the updated user ID.





        Update
time will vary, depending on the number of people in the Blogs database
table, ROLLERUSER. On average, 8 minutes per 500 users is the norm.
For large DBs, run this process overnight.

      




       
      BlogsMemberService.syncMemberExtIdByEmail(emailAddr)
      




       
      


       This command updates the user's external user ID in the Blogs
ROLLERUSER database table by the specified email address. For example,
  
BlogsMemberService.syncMemberExtIdByEmail("mary_brown@renovations.com")
      




       
      BlogsMemberService.syncMemberExtIdByLogin(loginName)
      




       
      


       This command updates the user's external user ID in the Blogs
ROLLERUSER database table by the specified login name. For example,
  
BlogsMemberService.syncMemberExtIdByLogin("mary_brown")
      




       
      BlogsMemberService.syncBatchMemberExtIdsByEmail(emailFile)
      




       
      


       This command updates the user's external user ID in the Blogs
ROLLERUSER database table by the email addresses in the specified
email file. Set the path and name of a text file that contains
one or more email addresses of users to sync. Specify one email address
per line in the text file. For example,
 BlogsMemberService.syncBatchMemberExtIdsByEmail("d:/temp/userEmails.txt")


       In
a stand-alone deployment, create this text file and save
it in a directory local to the server where you are running the wsadmin
processor. In a network deployment, the file needs to be local to
the server that you connect to.
           


        Sample of the userEmails.txt
file: 
 

        


         
      •   ajones@ibm.com





         
      •  joseph_smith@ibm.com





         
      •  eric.warner@ibm.com


      

      




       
      BlogsMemberService.syncBatchMemberExtIdsByLogin(loginFile) 
      




       
      


       This command updates the user's external user ID in the Blogs
ROLLERUSER database table by the login names in the specified login
file. Set the path and name of a text file that contains one or
more login names of users to sync. Specify one login name per line
in the text file. For example,
BlogsMemberService.syncBatchMemberExtIdsByLogin("d:/temp/userLoginNames.txt")


       In
a stand-alone deployment, create this text file and save
it in a directory local to the server where you are running the wsadmin
processor. In a network deployment, the file needs to be local to
the server that you connect to.





       Sample of the userLoginNames.txt
file:  


        


         
      •   ajones





         
      •  joseph
smith





         
      •  ericwarner


      

      




       
      BlogsMigrationService.syncAllUserIds()
      




       
      


         This command is being deprecated in Connections 2.5.  For release 2.5, this command is being maintained for backward compatibility.
We recommend you use BlogsMemberService.syncAllMemberExtIds() instead,
which is the replacement for this deprecated command.





       This
command updates all user IDs in the Blogs database. This service queries
the LDAP server for each user by login name to retrieve the updated
user ID.  





        Update time will vary, depending on the number of
people in your Blogs database table, ROLLERUSER. On average, 8 minutes
per 500 users is the norm. For large DBs, run this process overnight.

      

      
 


        Depending on the size of data
being synchronized, if the execution of one of these commands takes
longer to complete than the value of the com.ibm.SOAP.requestTimeout
property in the soap.client.props file
in WAS_HOME\profiles\PROFILE_NAME\properties\soap.client.props,
an error will display on the wsadmin console, and any return value
from the method invoked will be lost. The command continues to be
processed to completion, but the connection between the application
and the wsadmin client that invoked it is gone. To change this behavior
so that the client does not terminate the connection, increase the value of the com.ibm.SOAP.requestTimeout property or
set the property to 0 for no timeout. If you reset the property you
must restart the application server for the change to take effect. 



    

     
    Results
    When the command completes, the result displays
in the wsadmin
console, including error messages and summary message.  You also can
see the messages that are logged by "BlogsAdmin" in the SystemOut.log
file. The commands update the Blogs ROLLERUSER database table.


     
    Related tasks
    

  •   Start the wsadmin client




    Customize the user interface
    





     The steps that you must perform to customize IBM Connections are the same no matter what part
of the product you are customizing. You need to find the relevant
source file, save a copy of the file in the appropriate customization
directory, edit the file, and then validate your changes.


     Start IBM Connections and review the product user interface to determine which areas of
the product you want to customize.




Use the steps outlined here as a general guide to the process
for customizing the product user interface. For additional detail
on how to customize specific areas of the user interface, refer to
the task-specific topics that are referenced at the end of this topic.
For information about best practices to follow when customizing your deployment, see Customization best practices.


     The IBM Connections user interface style
is based on the IBM Lotus User Interface Toolkit 3.0.


    


     
      


       
    1.  Find the file that serves as the source of the area of
the product to edit. For a list of the web
application source directories and OSGi bundles that are packaged
with IBM Connections, see Application WAR files and OSGi bundles.





       
    2.  Turn on the customization debugging capability. For more information, see Enabling and disabling customization debugging.





       
    3.  Copy the file to customize and past it into
the appropriate customization directory. For more information,
see Determining where to save your customizations.


       The following table identifies the files that serve as the source for
user interface areas that are popular targets for customization. The files are located in the nav folder of the following directory: 
      WAS_HOME/profiles/profile_name/installedApps/cell_name/application_name.ear/application_name.war

      where: 


       
        


         
      •  WAS_HOME is the directory to which you installed IBM WebSphere Application Server.





         
      •  profile_name is the profile to which you installed
one of the IBM Connections applications.





         
      •  cell_name is the cell to which you installed
the application.





         
      •  application_name.ear is the EAR file name for
the application.





         
      •  application_name.war is the WAR file name for
the application.


      
For a list of the web application source directories that are
packaged with IBM Connections,
see Application WAR files and OSGi bundles.





       



      Table 117. Popular customization areas

      Feature
    File location




      Cascading stylesheets
    


       
        


         
      •  To add custom styles to the product, edit the following files: 


          If your users view the product in Arabic, Hebrew, or another right-to-left
language, copy the defaultTheme_rtl.css file
too.



         
          


           
        •  /nav/common/styles/defaultTheme/custom.css





           
        •  /nav/common/styles/defaultTheme/custom_rtl.css


        
For more information, see Add styles to the IBM Connections stylesheet.





         
      •  To make extensive changes to the colors used in the product, edit
the following file: 
        /nav/common/styles/defaultTheme/defaultTheme.css


         For more information, see Making extensive color and style changes.



      




      Error page
    /nav/templates/error.jsp


       For more information, see Customize the error page.




      Footer
    /nav/templates/footer.jsp


       For more information, see Customize the footer.




      Login page
    /nav/templates/login.jsp


       For more information, see Customize the login page.




      Navigation bar
    /nav/templates/header.jsp


       For the menus available from the navigation bar:


      /nav/templates/menu/people.jsp
/nav/templates/menu/communities.jsp
/nav/templates/menu/apps.jsp
      
For more information, see Customize
the navigation bar.




      







       For example: 


       
        


         
      •  To edit the footer and have the same footer be displayed in all
of the applications, store the updated footer file in the following directory: 


         customizationDir/common/nav/templates/footer.jsp






         
      •  To change the login page of a single application, store the updated
login page file in the directory where customizations that are specific
to that application are stored. For example, to change the login page
of the Files application only, store the login.jsp file
in the files subdirectory instead of the common subdirectory: 


         customizationDir/files/nav/templates/login.jsp



      







       
    4.  Edit the file stored in the customizationDir directory
to make your changes.





       
    5.  Test your changes by refreshing the web browser. You might
also need to clear your browser cache to see the changes.





       
    6.  When you are ready to publish your changes, turn off the customization debugging capability.





       
    7.   Use the WebSphere Application Server Integrated Solutions Console, stop and restart each application
EAR file.





       
    8.  Force all user web browsers to refresh all cached content
and display your changes by running the command that updates the product
version stamp. For more information, see Required post-customization
step.


    

     
    What to do next
    See the following topics for more information about customizing
specific areas of the product.




    Required
post-customization step
    





     Edit a configuration property
to make sure that your users
will see the changes you have made to the product the next time they
log in without having to clear the cache of their web browser.


     Only perform this
procedure if you made customization changes
to the product user interface. 


     To edit configuration
files, you must use the wsadmin client. See  Start the wsadmin client for details.








     Each product web page downloads static script and stylesheets
that do not change often.  To optimize performance, it is recommended
that these pages are cached for extended periods of time so that end
users only need to download them once per product upgrade.  After
you make customizations, you can instruct the server to ensure that
all web browsers download new copies of these files.  To force web
browsers to refresh all cached content on the next visit, run the following command to update the product version stamp. The version
stamp is automatically updated when you install any ifixes or major
product version upgrades. 


    


     
      


       
    1.  Use the wsadmin client to access and check out the IBM Connections configuration files.


       
        


         
      1.  Enter the following command
to access the IBM Connections configuration file: execfile("connectionsConfig.py") 


         If prompted to specify a service to connect
to, type 1 to pick the first node in the list. Most commands can run
on any node. If the command writes or reads information to or from
a file using a local file path, you must pick the node where the file
is stored. This information is not used by the wsadmin client when
you are making configuration changes.






         
      2.  Enter the following command
to check out the IBM Connections configuration files: 


         LCConfigService.checkOutConfig("working_directory","cell_name")





         where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
to separate directories in the file path, even if you are using the Microsoft Windows operating system. 


           AIX and Linux only:
The directory must grant write permissions or the command does not
run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, type the following command while in the wsadmin
command processor:print AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")





           
        •  Microsoft

          Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")


        




      






       
    2.  Enter the following command to increment
the value of the versionStamp property: LCConfigService.updateConfig("versionStamp","gmt_timestamp") where gmt_timestamp is
the GMT time. You can specify an empty string for the time stamp or
provide a GMT value string. When you specify an empty string, the client calculates the current GMT time and updates the version stamp
with that value. If you choose to provide the time, specify it using
the following format:  yyyyMMdd.HHmmss and specify
the time in GMT.  It is best to provide an empty string and let the client format the time stamp. For example: LCConfigService.updateConfig("versionStamp","").





       
    3.  After making changes,
you must
check the configuration files back in and you must do so during the same wsadmin session in which you checked them out for the changes
to take effect. See Applying common configuration property changes for
information about how to save and apply your changes.


    


     
    Related tasks
    

  •  Set a maximum size on files

  •  Set maximum sizes on media, pages, and attachments

  •  Restrict forum topic editing to creators

  •   Enable users to specify email notification preferences

  •   Edit configuration files

  •   Apply property changes in Activities

  •   Apply property changes in Communities

  •   Apply property changes in Forums

  •   Apply property changes in the News repository

  •   Apply property changes in Profiles

  •   Apply Files property changes

  •   Apply Wikis property changes

  •   Apply common configuration property changes


     

  •  Files configuration properties

  •  Wikis configuration properties




     Configure J2C Aliases for the moderation proxy service
    





     Configure J2C Aliases so that community owners can moderate
their community Blogs, Forums, and Files applications.







     Moderation actions are performed by a moderation API.
Community owners cannot access that API, so IBM Connections handles their moderation requests
through a proxy service. The proxy service uses J2C Aliases to pass
the requests. Proxy service alias users must be in the global-moderator
roles of the appropriate applications, and they must be able to log
in to IBM Connections.





     By default the proxy service uses the connectionsAdmin J2C Alias provided during installation. That user
is mapped to the global-moderator roles for Blogs, Forums, Files,
Moderation, and Communities by the installation program, and can log
in to IBM Connections. However, you can create different moderation
aliases for each of the different supported applications. You can
create the following aliases:


     
      


       
    •  For Blogs create an alias called moderationBlogsAlias.





       
    •  For Files create an alias called moderationFilesAlias.





       
    •  For Forums create an alias called moderationForumAlias.


    






     The different applications recognize these specific aliases.
You can map any users to these aliases, but all users must be in the global-moderator roles of the appropriate application, and they must
be able to log into IBM Connections. For example, the moderationBlogsAlias
user must be in the global-moderator role for Blogs. See Roles.





     The proxy service logs its actions, so if the users (other than the connectionAdmin
user) are only used for this purpose, it will make reading the log
more clear.


    


     To create moderation aliases and then map them to a global
moderator role:


     
      


       
    1.  Create a moderation alias:


       
        


         
      1.  From the IBM WebSphere Application Server
Integrated Solutions Console, expand Security,
and then click Global security.





         
      2.  In the Authentication area, expand Java
Authentication and Authorization Service, and click J2C
authentication data.





         
      3.  Click New.





         
      4.  Name the alias, for example moderationFilesAlias.





         
      5.  Set the name and password of a user for the alias.





         
      6.  Click OK.


      






       
    2.  Map an alias user to a global-moderator role:


       
        


         
      1.  Expand Applications > Application Types, and then select WebSphere
enterprise applications. Find and click the link to the application to configure.





         
      2.  Click Security role to user/group mapping.





         
      3.  Select the check box for the global-moderator role,
and then click Map users.





         
      4.  In the Search String box, type
the name of the user to assign to the role, and then click Search.
If the user exists in the directory, it is displayed in the Available list.





         
      5.  Select the user or group name from the Available box,
and then move it into the Selected column by
clicking the right arrow button.





         
      6.  Click OK.





         
      7.  Click OK, and then click Save to
save the changes.


      






       
    3.  Synchronize and restart all your WebSphere Application Server instances.


    


     

  •  Roles




    Mitigating
a cross site scripting attack
    





     If you deem that your network is secure enough to turn
off the active content filter, consider using one of the configuration
options described in this topic to mitigate an attack should one occur.




If you decide to
disable active content filtering in favor
of providing maximum flexibility, you must take steps to contain a
cross site scripting (XSS) attack. For example, your organization
might believe that as long as the XSS exposure is limited only to
your blog site, the risk is acceptable. If that is the case, consider
adopting the following best practices to contain an attack:


     
    Use isolated domains
    




     
    Ensure that the component
at risk of attack is installed in a
completely separate domain. For example, if the Blogs application
will allow posting of active content, install it in a separate domain
such as: blogs.acme.org. If the Activities application will allow
active content, install it in a separate domain such as: activities.acme.org.
Also consider using multiple domains for a single application, using
a separate domain for the file downloads of the application.
    




     
    Do not use single sign-on
    




     
    To contain
any attack, ensure that single-sign-on (SSO) authentication
is not used to authenticate a user in an application that allows active
content. When single sign-on is enabled, a user's cookie can be stored
and used to access data in another domain. While it is not recommended
that single sign-on be used when a component has turned off active
content filtering, it is possible to use single sign-on with HTTP
Only Cookies.  WebSphere Application Server version 6.1.0.11 introduced the ability to produce "HTTP Only"
cookies for the single sign-on cookies. If this application is used
in conjunction with an HTTP-only browser, then the XSS vulnerability
can be contained.
    




     
    Configure files to be
downloaded from a separate domain
    




     
    Add rewrite rules to the IBM HTTP
Server configuration file to force any downloaded files to be recognized
by the web browser as content that is independent from the application
it was downloaded from, and treat it accordingly. Without downloading
in a subdomain with non-shared authentication, there is a vulnerability
because other content types can allow execution of content with the hosting domain's credentials. An example of another content type that
can get executed in the hosted domain is Adobe Flash. If Flash Player 9 is used, all
hosted Flash will be allowed to call the hosting domain's services
and execute XSS attacks. With Flash Player 10, if Content-Disposition:
inline is used this vulnerability still exists. Blogs uses this Content-Disposition
mode, so for maximum security on Blogs, a separate download domain
must be used or Flash must be disabled.


     If you choose to set up
a subdomain for file downloads, determine whether or not to enable
single sign-on between the subdomain and the domain of the core application: 


     
      


       
    •  If you choose to enable single sign-on, configure HTTP-only cookies.
To do so:


       
        


         
      1.  Open the WebSphere Application Server Integrated Solution Console.





         
      2.  Expand Security,
and then select Global
security.





         
      3.  Click Custom properties.





         
      4.  Click New to add a property, and then add
the following values to the fields:


         
        Name
        




         
        com.ibm.ws.security.addHttpOnlyAttributeToCookies
        




         
        Value
        




         
        true
        

        






         
      5.  Click Apply, and then OK.


      






       
    •  If you choose not to enable single sign-on, users will
be asked
to re-authenticate when they download a file.


    

See Specifying
a separate file download domain for
information about how to create the subdomain.
    

    



     
    Related tasks
    

  •   Display files inline


     

  •  Files configuration properties




    Add a theme to the Communities configuration file
    





     After defining a custom theme, you need to add it to the Communities configuration file, communities-config.xml.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.





The list of themes displayed in the theme palette in Communities
comes from list of themes defined in the Communities configuration
file, communities-config.xml. When you define
a new theme, add a corresponding theme entry to the configuration
file for it to display in the user interface. The placement of the theme in the configuration file list matches its placement in the Communities theme palette. Typically, you might add new themes to
the end of the list, but if you want to make your new theme the default
community theme, you need to add it to the beginning of the list.
This placement means that the theme is used whenever another theme
has not been explicitly set.

    


     To add a theme to the Communities configuration file,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Communities Jython script interpreter.


       
        


         
      1.  Use the following command
to access the Communities configuration files: 


        execfile("communitiesAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Check out the Communities
configuration files : 


         CommunitiesConfigService.checkOutConfig("working_directory",
"cell_name")





         where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied.
The files are kept in this working directory while you make changes
to them.


            AIX and Linux only: The directory must
grant write permissions or the command will not run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is required. If you do not know the cell name, you can
determine it by typing the following command in the wsadmin command
processor:


           print AdminControl.getCell()



        
For example:


        CommunitiesConfigService.checkOutConfig("/opt/my_temp_dir", "CommServerNode01Cell")
        




      






       
    3.  Open communities-config.xml in a text
editor.





       
    4.  Add a new <comm:theme> element to
include the properties for the new theme in the list of themes that
are already defined in the file: 


       For example:


      <comm:theme>
		 <comm:themeUuid>corporate</comm:themeUuid>
		 <comm:displayNameKey>label.theme.name.corporate</comm:displayNameKey>
		 <comm:isScriptKey>false</comm:isScriptKey>
		 <comm:cssUrl>/themes/corporateTheme/corporateTheme.css</comm:cssUrl>
		 <comm:cssRtlUrl>/themes/corporateTheme/corporateThemeRTL.css</comm:cssRtlUrl>
		 <comm:thumbnailUrl>/images/corporate.png</comm:thumbnailUrl>
</comm:theme>
      

      ...where:


       
        


         
      •  <comm:themeUuid> is the unique identifier
of the theme that is stored in the database when the theme is selected.
It should not contain spaces or special characters. It must be 36
characters or less.





         
      •  <comm:displayNameKey> is the resource key
for the display name. For information about how to create property
strings for the displayNameKey, see Specifying the name of a
custom theme.





         
      •  <comm:isScriptKey> is set to true when the display name is found in a JavaScript resource
file.





         
      •  <comm:cssUrl> is the location of the theme
stylesheet.





         
      •  <comm:cssRtlUrl> is the location of the theme stylesheet for right-to-left languages, such as Arabic and Hebrew.





         
      •  <comm:thumbnailUrl> is the location of the thumbnail image that is displayed in the Theme Palette. The image
must be included in the following location: 


         /customization/communities/images/



      







       
    5.  Save the communities-config.xml file.





       
    6.  After making changes, check the configuration
files back in, and you must do so during the same wsadmin session
in which you checked them out for your configuration changes to take
effect. You must also stop and restart the Communities server. See Applying
property changes in Communities for information about how to
save and apply your changes.


    

     
    What to do next
    


     
      


       
    1.  Test your changes by refreshing the web browser.





       
    2.  When you are ready to make the custom theme available to others,
refer to steps 6-8 of Customize the user interface for
information about how to publish your changes and make them permanent.


    



     
    Related tasks
    

  •   Apply property changes in Communities




     Integrate the Communities business card
    





     Include the Communities business card in your web application
so that users can quickly navigate to a community from the application.


     The CSS files loaded with the Communities business card do
not include font style information. To ensure that the business card
appears fully integrated with your web application from a visual perspective,
define your own font styles globally so that the styles used in your application are also applied to the business card 


      The use of JavaScript Object Notation
with padding (JSONP) technology in the business card will be deprecated
in future releases. Although JSONP will continue to be supported,
if you are integrating the business card in to your web application
and you want to prevent JSONP data from being transmitted by IBM Connections, you must use an
Ajax proxy.





     For information about how to configure the Communities
business card on a Lotus Domino 8.5 server, see Configuring
the Communities business card on a Domino server.





The Communities business card displays basic community information,
such as the name of the community, the image associated with the community,
and the links for the widgets associated with the community. By including
the card in your web application, you enable users to access a community
directly from your application using the links in the card. 


      The CSS files loaded with the Communities business card do not include
font style information. To ensure that the business card appears fully
integrated with your web application from a visual perspective, define
your own font styles globally so that the styles used in your application
are also applied to the business card.
To add the Communities
business card to your web application:

    


     
      


       
    1.  Include the following reference to the semanticTagService.js file
in your code: 


      <script type="text/javascript" src="protocol://connections_server/profiles_app/ibm_semanticTagServlet/javascript/semanticTagService.js"></script>
      





       Notes





       


       
        


         
      •  The body element must exist and be instantiated before the script's
JavaScript executes, thus if the script resource is included within
the head element of your html code, it must use the defer attribute (defer="defer") so
that it executes after the page is loaded.  Otherwise, the script
resource request must be included within the body element.





         
      •  The business card uses Dojo 1.4. If Dojo 1.4 is already included
in your application, add the ?inclDojo=false URL
parameter to the JavaScript include as follows, otherwise the business
card will not work.


        <script type="text/javascript" src="protocol://connections_server/profiles_app/ibm_semanticTagServlet/javascript/semanticTagService.js?inclDojo=false"></script>
        






         
      •  The business card can be loaded with or without CSS. If you already
have the IBM Connections CSS files loaded in your application and
do not want to include the CSS again, add the loadCssFiles=false parameter
to the JavaScript include like this:


        <script type="text/javascript" src="protocol://connections_server/profiles_app/ibm_semanticTagServlet/javascript/semanticTagService.js?loadCssFiles=false"></script>
        



      







       
    2.  Use and modify the following code to render the card with
community details: 


      <span class="vcomm X-community-display-inline">
<span class="name" style="display:none;"><community_name></span>
<span class="uuid" style="display:none"><community_uuid></span>
<span class="selectedWidgetId" style="display:none;"><widget_id></span>
</span>
      

      ...where: 


       
        


         
      •  <community_name> is the name of the community.
This parameter is a text string.





         
      •  <community_uuid> is the UUID of the community.





         
      •  <widget_id> is a text string that corresponds
to the widgetDefId of the widget that has been added to the community.
This text string is used to highlight the menu item in the navigation
bar. The <widget_id> element is optional, and
must only be provided for iWidgets that are integrated into Communities.
The widget ID is defined by the iWidget developer, and you need to
request it from your administrator or the iWidget developer.


      
For example:


      <span class="vcomm X-community-display-inline">
<span class="name" style="display:none;">Snowboarders</span>
<span class="uuid" style="display:none">b307369e-7e60-403b-b850-206a28d6c19e</span>
<span class="selectedWidgetId" style="display:none;">HelloWorldExtFullpage</span>
</span>
      






       
    3.  Optional: If you are building a web application
that constructs its user interface using Ajax, you can make the business
card user interface available by adding LiveName programmatically
using JavaScript. Use
the following API example: 


        This step only applies
when you are building an application that constructs its user interface
using Ajax. The business card code only scans the HTML when the page
is first loaded so, if you dynamically alter the page, you need to
manually specify the DOM elements that the code rescans for business
card vcard class attributes. If you are developing a completely static
page, you can ignore this step.



      var htmlContent = "<span class="vcomm X-community-display-inline">"+
"<span class="name" style="display:none;"/><community_name></span>"+
"<span class="uuid" style="display:none"><community_uuid></span>"+
"<span class="selectedWidgetId" style="display:none;"><widget_id></span>"+
"</span>";
 
document.getElementById("containerId").innerHTML += htmlContent;
 
setTimeout("SemTagSvc.parseDom(null, 'containerId')", 500 ); 
      



    



    Related
    

  •   Administer Communities




     Configure the library widget proxy
    





     Add a proxy policy to the proxy-ecm-config.tpl file
to enable communication between IBM Connections and ECM servers.


     


     To edit configuration files, you must use the IBM WebSphere Application Server wsadmin client. See Starting
the wsadmin client for details.


      When
configuring the proxy to allow your users access to trusted third-party
web sites, ensure that those sites implement appropriate security
controls. Configuring the proxy to mirror content from third-party
servers may cause the proxy to mirror malicious content from those
servers, so be sure to allow access to trusted sites only.


    


     To configure the proxy-ecm-config.tpl file
for library widgets.


     
      


       
    1.  Start the wsadmin client.





       
    2.  Access and check out the proxy-ecm-config.tpl file:


       
        


         
      1.  Enter the following command
to access theproxy-ecm-config.tpl file: execfile("connectionsConfig.py") 


         If you are prompted to specify which server to connect to,
type 1.






         
      2.  Enter the following command
to check out the proxy-ecm-config.tpl file: 


         LCConfigService.checkOutProxyEcmConfig("working_directory","cell_name")





         where:


         
          


           
        •  working_directory is the temporary working
directory to which the file is copied and are stored while you make
changes. Use forward slashes to separate directories in the file path,
even if you are using the Microsoft Windows operating system. 


           AIX and Linux only: The directory must grant write
permissions or the command does not run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, type the following command while in the wsadmin
command processor:print AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:LCConfigService.checkOutProxyEcmConfig("/opt/temp","foo01Cell01")





           
        •  Microsoft

          Windows:LCConfigService.checkOutProxyEcmConfig("c:/temp","foo01Cell01")


        




      






       
    3.  Navigate to the working directory and open the proxy-ecm-config.tpl file
in a text editor. In the policy element, replace the URL attribute
with the server address of the ECM server: 


      <proxy:policy url="http://www.myECMServer.com:8080/*" acf="none" basic-auth-support="true">
        <proxy:actions>
            <proxy:method>GET</proxy:method>
            <proxy:method>HEAD</proxy:method>
            <proxy:method>POST</proxy:method>
            <proxy:method>PUT</proxy:method>
            <proxy:method>DELETE</proxy:method>
        </proxy:actions>
        <proxy:headers>
            <proxy:header>User-Agent</proxy:header>
            <proxy:header>Accept*</proxy:header>
            <proxy:header>Content*</proxy:header>
            <proxy:header>Authorization*</proxy:header>
            <proxy:header>X-Method-Override</proxy:header>
            <proxy:header>Set-Cookie</proxy:header>
            <proxy:header>If-*</proxy:header>
            <proxy:header>Pragma</proxy:header>
            <proxy:header>Cache-Control</proxy:header>
            <proxy:header>X-Server</proxy:header>
            <proxy:header>X-Update-Nonce</proxy:header>
            <proxy:header>X-Passthrough-Basic</proxy:header>
            <proxy:header>X-Requested-With</proxy:header>
            <proxy:header>If-Modified-Since</proxy:header>
            <proxy:header>If-None-Match</proxy:header>
            <proxy:header>com.ibm.lotus.openajax.virtualhost</proxy:header>
            <proxy:header>com.ibm.lotus.openajax.virtualport</proxy:header>
        </proxy:headers>
        <proxy:cookies>
            <proxy:cookie>LtpaToken</proxy:cookie>
            <proxy:cookie>LtpaToken2</proxy:cookie>
            <proxy:cookie>JSESSIONID</proxy:cookie>
        </proxy:cookies>
    </proxy:policy>
      






       
    4.  You can optionally specify values for
the following proxy:meta-data properties. Add any custom configurations
before these proxy:meta-data elements. 


       
      circular_redirects
      




       
      Specifies that circular redirects are allowed. This property accepts
a Boolean value of true or false specified
in lower-case letters. If set to true, it supports
using a proxy for a site that redirects to the same URL but with different
parameters. Such a change is not recognized as a new URL. The default
value of this property is true.
      




       
      connection-timeout
      




       
      Amount of time before an attempt to connect to a host times out.
Specified in milliseconds, the default value of this property is 60,000,
which is 1 minute.
      




       
      max_circular_redirects
      




       
      Maximum number of times a circular redirect is allowed before
the proxy rejects it. Specified as an integer, the default value of
this property is 100.
      




       
      maxconnectionsperhost
      




       
      Maximum number of simultaneous connections between the proxy and
a given host. Specified as an integer, the default value of this property
is 20.
      




       
      maxtotalconnections
      




       
      Maximum number of simultaneous connections between the proxy and
all of the hosts together. Specified as an integer, the default value
of this property is 50.
      




       
      socket-timeout
      




       
      Amount of time before an attempt to use a socket times out. Specified
in milliseconds, the default value of this property is 60,000, which
is 1 minute.
      




       
      unsigned_ssl_certificate_support
      




       
      Specifies that self-signed SSL certificates are supported. This property accepts a Boolean value of true or false specified
in lower-case letters. The default value of this property is true.
Change it to false when the system is ready for production.
      

      
For example:


      <proxy:meta-data>
  <proxy:name>maxconnectionsperhost</proxy:name>
  <proxy:value>20</proxy:value>
</proxy:meta-data>  
      






       
    5.  If your environment uses a pass-through proxy, add a <proxy:meta-data> element
containing each of the following parameters: 


       
      passthru_host
      




       
      The address at which the proxy is listening. In most cases, accessing
the host and port from a browser causes an authentication request
popup to be displayed. Required.
      




       
      passthru_password
      




       
      Password that corresponds with the passthru_username value. Required.
If you do not provide a user name and password, all other parameters
are ignored.
      




       
      passthru_port
      




       
      The port at which the proxy is listening. If not specified, then
a default value of port 80 is used. Required.
      




       
      passthru_realm
      




       
      User credential pairs are associated with realms, not URLs. This allows the same authorization information to be used for multiple
URLs or whole URL trees. When a server sends back an unauthorized
error, it includes the name of the realm that the requested URL belongs
to. The client can then look and see whether it has stored a username
and password for the realm, and if so, it supplies that information
without having to prompt the user again. If a user name and password
are needed for the proxy, you can specify the realm for the proxy
so that the credentials do not get sent to any proxy. If you do not
specify this parameter, then the credentials are sent for all authentication
attempts. In the example that follows, Subversion User Authentication
is specified as the passthru_realm. As a result, all authentication
requests from this realm on the SVN server will be provided the given
username and password. Optional. Set the passthru_realm parameter
in a production environment to prevent the user name and password
information from being presented for all authentication requests.
      




       
      passthru_username
      




       
      User name for authenticating with the pass-through proxy. In the example that follows, any username which has read access to the subversion
server will be sufficient when a GET request is sent to get authorization.
Required. If you do not provide a user name and password, all other
parameters are ignored.
      

      





       The following example shows the configuration for
a fictitious proxy firewall. 



      <proxy:meta-data>      
	<proxy:name>passthru_host</proxy:name>
	<proxy:value>9.17.237.132</proxy:value>
</proxy:meta-data>
<proxy:meta-data>
	<proxy:name>passthru_port</proxy:name>
	<proxy:value>3128</proxy:value>
</proxy:meta-data>
<proxy:meta-data>
	<proxy:name>passthru_realm</proxy:name>
	<proxy:value>Subversion User Authentication</proxy:value>
</proxy:meta-data>   
<proxy:meta-data>
	<proxy:name>passthru_username</proxy:name>
	<proxy:value>adamsmith</proxy:value>
</proxy:meta-data>   
<proxy:meta-data>
	<proxy:name>passthru_password</proxy:name>
	<proxy:value>password123</proxy:value>
</proxy:meta-data>
      






       
    6.  Enter the following command to check in your changes: LCConfigService.checkInProxyEcmConfig("working_directory","cell_name")





       
    7.  Restart the IBM Connections server.


    

     
    What to do next
    


     To enable communication with more ECM servers, add a new
copy of the current policy for each ECM server. In each new policy
change the server name in the URL attribute.



     
    Related tasks
    

  •   Enable Linked Libraries




     Synchronize
user identification data between Communities
and the LDAP directory
    





     Use administrative commands
to synchronize member records
in the Communities database with the LDAP directory.


     To use administrative
commands, you must use the wsadmin client.
See  Start the wsadmin
client for details.


     If you are using the Profiles directory
service, you must first synchronize the ExtId values in the Profiles
database with the LDAP directory before you can run the commands that
synchronize member IDs described in this topic. See Synchronizing
user data between Profiles and the LDAP directory for more
details.





When you run the synchronization commands
for Communities,
internally the commands update two database tables: MEMBERPROFILE,
which holds member names and information for users who have been added
to Communities as members or owners, and DF_MEMBERPROFILE, which holds
member information for the discussion forums that are contained in
the various communities. The synchronization commands write output
to the SystemOut.log file. After running the commands, be sure to check this file because the login names of community
users that were not successfully updated are logged in the file. 


     You can see information being logged about the MEMBERPROFILE and DF_MEMBERPROFILE
database tables as they are being updated by the synchronization commands.
The information being logged by Communities begins with the prefix
CLFRM, and the information being logged by discussion forums is prefixed
with CLFRV. Here is an example of each: 


    CLFRM0148I: Updated member identified by login name: ajones => [Display Name Alan Jones -> Alan Jones], [Directory UUID 8E9FEEB4-6843-C96C-8525-7346003D2222 -> 8E9FEEB4-6843-C96C-8525-7346003DC434], [Email address ajones@test.company.com -> ajones@test.company.com]
    



    CLFRV0234I: The member profile "Jason_Nesbit" matches the directory service with external id 6A10B973-025F-35F7-8525-74020078147B.
    






      Communities
use an internal identifier to manage access control. This identifier
is different from the person identifier used in the LDAP directory.
When the LDAP identifier changes, the mapping of it to the internal
identifier for each member needs to be changed. Commands are provided
for manipulating the internal ID of community members.


    


     To synchronize member IDs between Communities
and the LDAP directory.


     
      


       
    1.  Start
the wsadmin client so that you can access Communities
configuration files.


       
        


         
      1.  Use the following command
to access the Communities configuration files: 


        execfile("communitiesAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    2.  Use the following commands to change the internal IDs of
community members: 


       


       
      CommunitiesMemberService.syncAllMemberExtIds()
      




       
      


       Synchronizes
all member directory IDs in the Communities member
database table with the LDAP directory ID. For each member, this service
queries the LDAP server by login name (or names) stored as part of
the Communities member profile to retrieve the updated directory ID
(unique interapplication identifier). The member's login names,
display name, and email address are updated if necessary.





       Use
this command when a change occurs in the deployment LDAP system. For example, if people have been deleted from the LDAP directory or personal
information has changed.





       The update time varies depending on
the number of people in the Communities database. On average, it takes
approximately eight minutes to update 500 users. For large DBs,
run this process overnight.





       This command does not take any parameters.

      




       
      CommunitiesMemberService.syncMemberExtIdByLogin(String
loginName)
      




       
      


       Synchronizes a single member's directory
ID in the Communities
member database table. This command is essentially the same as syncAllMemberExtIds()
but applied to a single member. The member's login names, display
name, and email address are updated if necessary.





       This command
takes loginName as a parameter. This parameter
is a single, valid user login name.





       For example: 


      CommunitiesMemberService.syncMemberExtIdByLogin("John Smith")
      


      




       
      CommunitiesMemberService.syncBatchMemberExtIdsByLogin(String
loginFile)
      




       
      


       Synchronizes a list of member's directory
IDs in the Communities
member database table. The list is specified in a text file specified
by the parameter. This command is essentially the same as syncAllMemberExtIds()
but applied to a list of members, and the LDAP server is queried by
the specified login names. The members' login names, display names,
and email address are updated if necessary.





       This command takes loginFile as
a parameter. This is a text file name with a single, valid login name
per line. You must create this text file and save it in a directory
that is local to the server that you connect to.
Example: 


      CommunitiesMemberService.syncBatchMemberExtIdsByLogin("/opt/Communities/update.txt")
      

      




       
      CommunitiesMemberService.syncMemberExtIdByEmail(String
emailAddr)
      




       
      


       Synchronizes a single member's directory
ID in the Communities
member database table. The command is essentially the same as syncAllMemberExtIds(),
but applied to a single member, who is identified by the specified
email address. The member's login names and display name are
updated if necessary.





       This command is used when a change occurs
in the deployment LDAP system or when a person identifier in the LDAP
directory changes in some respect. This change might occur when an
LDAP record is updated.





       This command takes a string as a parameter, emailAddr.
This string is a valid email address.





       For example:


      CommunitiesMemberService.syncMemberExtIdByEmail( "jdoe@example.com")
      


      




       
      CommunitiesMemberService.syncBatchMemberExtIdsByEmail(String
emailFile)
      




       
      


       Synchronizes a list of member's directory
IDs in the Communities
member database table. The list is specified in a text file specified
by the parameter. This command is essentially the same as syncAllMemberExtIds()
but applied to a list of members, and the LDAP server is queried by
the specified email addresses. The members' login names and display
names are updated if necessary.





       This command takes emailFile as
a parameter. This parameter is a text file name with a single, valid
email address per line. You must create this text file and save it
in a directory that is local to the server that you connect to.





       For example: 


      CommunitiesMemberService.syncBatchMemberExtIdsByEmail("c:/Communities/email_file.txt")
      


      

      






        Depending on the size of data being synchronized,
if the execution of one of the synchronization commands takes longer
to complete than the value of the com.ibm.SOAP.requestTimeout property
in the soap.client.props file in WAS_HOME\profiles\PROFILE_NAME\properties\soap.client.props,
a "SOAP timeout" error displays on the wsadmin console, and any return
value from the method invoked is lost. This means that the connection
between the wsadmin command processor and the server is lost. However,
the server continues to process the command and you can view additional
messages being logged by the command in the SystemOut.log file.
To change this behavior so that the client does not terminate the connection, increase the value of the com.ibm.SOAP.requestTimeout
property or set the property to 0 for no timeout. If you reset the property, you must restart the application server for the change to
take effect.



    


     
    Related tasks
    

  •   Synchronize user data between Profiles and the LDAP directory




     Configure the AJAX proxy
    





     By default, the IBM Connections AJAX proxy is configured to allow cookies, headers or mime types,
and all HTTP actions to be exchanged among the IBM Connections applications. If you want to
change the traffic that is allowed from non-IBM Connections services,
you must explicitly configure it. 


     This task is not required. Only perform it if you want to
display information from an external service within IBM Connections.

      When configuring the AJAX proxy to allow your users
access to trusted third-party web sites, ensure that those sites implement
appropriate security controls. Configuring the proxy to mirror content
from third-party servers may cause the proxy to mirror malicious content
from those servers, so be sure to allow access to trusted sites only.








     The proxy-config.tpl template file
defines rules about which HTTP requests, headers, and cookies are
allowed to be redirected to the IBM Connections applications. When an IBM Connections server is started, it reads information about the applications from
LotusConnections-config.xml, and, based
on the rules defined in the proxy-config.tpl template
file, configures the proxy to be used by any web browsers or other
servers that send requests to IBM Connections. 





     For example, if you want to allow one application, such as Home page,
to proxy a widget, but not allow any of the other applications to
proxy it, create an application-specific version of the proxy-config.tpl file
and edit that. See Configuring the AJAX proxy for a specific
application for more details. 
To configure the AJAX proxy,
complete the following steps:

    


     
      


       
    1.  Access the common AJAX proxy
configuration template file: 


       
        


         
      1.  Open a command prompt, and then
change to the following directory of the system on which you installed
the deployment manager: 


          

        app_server_root\profiles\dm_profile_root\bin
        

        ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01. For example,
on

        Windows:


        C:\Program Files\IBM\WebSphere\AppServer\profiles\Dmgr01\bin
        

         You must run the following command to start the wsadmin
client from this specific directory because the Jython files for the product are stored here. If you try to start the client from a different
directory, then the execfile() command that you subsequently call
to initialize the administration environment for an IBM Connections component does not work correctly. 







         
      2.  Enter the following command to
start the wsadmin client: 


         
          


           
        •  AIX or Linux:


          ./wsadmin.sh -lang jython -user admin_user_id -password admin_password -port SOAP_CONNECTOR_ADDRESS Port
          






           
        •  Microsoft

          Windows:


          wsadmin -lang jython -user admin_user_id -password admin_password -port SOAP_CONNECTOR_ADDRESS Port
          



        





         where: 


         
          


           
        •  admin_user_id is the user name of a person
in the Administrator role on the IBM WebSphere Application Server.





           
        •  admin_password is the password of the WebSphere Application Server
administrator. 





           
        •  SOAP_CONNECTOR_ADDRESS Port is the SOAP
port for the WebSphere Application Server deployment manager server. The default value of the SOAP port
is 8879. If you are using the default port value, you do not need
to specify this parameter. If you are not using the default and you
do not know the port number, you can look up its value in the WebSphere Application Server
Integrated Solution Console. To look up the SOAP port number, perform
the following steps:


           
            


             
          1.  Open the WebSphere Application Server Integrated Solution Console for the deployment manager, and
then select System Administration > Deployment Manager.





             
          2.   In the Additional properties section expand Ports,
and then look for the SOAP_CONNECTOR_ADDRESS port entry to find the port number.


          



        






         For example:


         
          


           
        •  AIX or Linux: 


          ./wsadmin.sh -lang jython -username primaryAdmin -password p@assword -port 8879
          






           
        •  Microsoft

          Windows: 


          wsadmin -lang jython -username primaryAdmin -password p@assword -port 8879
          



        







         
      3.  Access the configuration
file: 


        execfile("connectionsConfig.py")
        






         
      4.  Use the following command to check out the configuration
file: 


        LCConfigService.checkOutProxyConfig("temp_directory",
 "cell_name")
        

        ...where temp_directory is
a temporary directory of your choice, and cell_name is
the name of the cell where the IBM Connections application that uses the global proxy template file is located.


      






       
    2.  From the temporary directory to
which you checked out the configuration files, open the proxy-config.tpl file
in a text editor.





       
    3.  Make your edits. For example, you
can do the following things:

        


         
      •  To explicitly refuse all traffic from a specific site, add
a policy as follows:


        <proxy:policy url="malicious.site.com" acf="none">
    <proxy:actions/>
    <proxy:headers/>
    <proxy:cookies/>
    </proxy:policy>
        






         
      •  To allow a particular service on your network to display a
custom widget, you can add the following policy entry to the file:


        <proxy:policy url="http://my.network.com/widget/*" acf="none">
    <proxy:actions>
        <proxy:method>GET</proxy:method>
    </proxy:actions>
    <proxy:headers>
      <proxy:header>User-Agent</proxy:header>
      <proxy:header>Accept.*</proxy:header>
      <proxy:header>Content.*</proxy:header>
      <proxy:header>Authorization.*</proxy:header>
      <proxy:header>If-.*</proxy:header>
      <proxy:header>Pragma</proxy:header>
      <proxy:header>Cache-Control</proxy:header>
    </proxy:headers>
    <proxy:cookies>
        <proxy:cookie>JSESSIONID</proxy:cookie>
    </proxy:cookies>
</proxy:policy>
        






         
      •  If a service requires authentication, you can configure it
to also allow basic authentication requests by adding a basic-auth-support="true" attribute
to the <proxy:policy> element. For example:


        <proxy:policy 
 url="http://my.network.com/service/*" 
 acf="none" 
 basic-auth-support="true">
   ...
</proxy:policy>
        
If this attribute is not added, when
an unauthenticated request is sent to a service that requires authentication,
the service does not display the basic authentication dialog, but
returns an HTTP 403 status code instead.





         
      •  To allow a particular service to run on your network and to
pass cookies for LTPA tokens to the applications:


        <proxy:policy url="http://my.network.com/service/*" acf="none">
    <proxy:actions>
        <proxy:method>GET</proxy:method>
    </proxy:actions>
    <proxy:headers>
      <proxy:header>User-Agent</proxy:header>
      <proxy:header>Accept.*</proxy:header>
      <proxy:header>Content.*</proxy:header>
      <proxy:header>Authorization.*</proxy:header>
      <proxy:header>If-.*</proxy:header>
      <proxy:header>Pragma</proxy:header>
      <proxy:header>Cache-Control</proxy:header>
    </proxy:headers>
    <proxy:cookies>
      <proxy:cookie>JSESSIONID</proxy:cookie>
      <proxy:cookie>LtpaToken</proxy:cookie>
      <proxy:cookie>LtpaToken2</proxy:cookie>
    </proxy:cookies>
</proxy:policy>
        



      
 


        Set the headers using regular expressions. If no cookies
are specified, the proxy will pass all of them. To prevent it from
passing any cookies, specify <proxy:cookies/>.






       
    4.  The following policy allows GET
requests to be passed to any web address. If you want to allow your users to have access to all web sites, remove the comments from around
this policy. For example, users who add a feed to a community will
see a 403 error where the feed results should be displayed unless
you perform this step. Be sure that the policy is listed as the last
policy in the configuration file.  


      <!--proxy:policy url="*" acf="none"> 
    <proxy:actions>
      <proxy:method>GET</proxy:method>
    </proxy:actions>
    <proxy:headers/>
    <proxy:cookies/>
</proxy:policy-->
      





        Do not enable this policy
on internet-facing deployments because it can allow unauthorized access
to internal servers.






       
    5.  You can optionally specify values for
the following proxy:meta-data properties. Add any custom configurations
before these proxy:meta-data elements. 


       
      circular_redirects
      




       
      Specifies that circular redirects are allowed. This property accepts
a Boolean value of true or false specified
in lower-case letters. If set to true, it supports
using a proxy for a site that redirects to the same URL but with different
parameters. Such a change is not recognized as a new URL. The default
value of this property is true.
      




       
      connection-timeout
      




       
      Amount of time before an attempt to connect to a host times out.
Specified in milliseconds, the default value of this property is 60,000,
which is 1 minute.
      




       
      max_circular_redirects
      




       
      Maximum number of times a circular redirect is allowed before
the proxy rejects it. Specified as an integer, the default value of
this property is 100.
      




       
      maxconnectionsperhost
      




       
      Maximum number of simultaneous connections between the proxy and
a given host. Specified as an integer, the default value of this property
is 20.
      




       
      maxtotalconnections
      




       
      Maximum number of simultaneous connections between the proxy and
all of the hosts together. Specified as an integer, the default value
of this property is 50.
      




       
      socket-timeout
      




       
      Amount of time before an attempt to use a socket times out. Specified
in milliseconds, the default value of this property is 60,000, which
is 1 minute.
      




       
      unsigned_ssl_certificate_support
      




       
      Specifies that self-signed SSL certificates are supported. This property accepts a Boolean value of true or false specified
in lower-case letters. The default value of this property is true.
Change it to false when the system is ready for production.
      

      
For example:


      <proxy:meta-data>
  <proxy:name>maxconnectionsperhost</proxy:name>
  <proxy:value>20</proxy:value>
</proxy:meta-data>  
      






       
    6.  Save and close the file.





       
    7.  Check the proxy-config.tpl file in
during the same session in which you checked it out. Use the following command to check the file in: 


        

      LCConfigService.checkInProxyConfig("temp_directory",
 "cell_name")
      

      ...where temp_directory is
the temporary directory to which you checked out the configuration
files, and cell_name is the name of the cell

      ...where the application that uses the common proxy-config.tpl file is
located.






       
    8.  Restart the application server hosting IBM Connections.


    



    Related
    

  •   Enable community feeds




     Change configuration
settings for Bookmarks
    





     You can make changes to configuration
settings to customize
Bookmarks for your deployment.


     


     To change configuration settings, you
must use the wsadmin client. See  Start the wsadmin client for details.





You can change configuration settings to configure a Bookmarks
server. The configuration scripts described here use the implicit
AdminConfig object available in wsadmin to interact with the Bookmarks
configuration repository.  Any configuration change requires a restart
of the related Bookmarks cluster. To change settings:

    


     
      


       
    1.  Open a command window and start the wsadmin command window.
  See the topic, Starting the wsadmin client, for details
on starting the wsadmin client.





       
    2.  After the wsadmin
command environment has initialized,
run the following command to initialize the Bookmarks environment
and start the Bookmarks script interpreter: 


      wsadmin>execfile('<$WAS_HOME>\profiles\<DMGR>\config\bin_lcadmin\dogearAdmin.py')

 This command should print something similar to the following messages 
 in the wsadmin console window.

Connecting to WebSphere:name=DogearTaskService,cell=TestServerNode01Cell,
 node=TestServerNode01,process=server1

Connecting to WebSphere:name=DogearLinkService,cell=TestServerNode01Cell,
 node=TestServerNode01,process=server1

Connecting to WebSphere:name=DogearPersonService,cell=TestServerNode01Cell,
 node=TestServerNode01,process=server1

Connecting to WebSphere:name=DogearUrlService,cell=TestServerNode01Cell,
 node=TestServerNode01,process=server1

Bookmarks MBeans initialized
Bookmarks Configuration Environment initialized
      






       
    3.  Check out the configuration file
with the following command: 


      DogearCellConfig.checkOutConfig([working_dir], [cellName])
      

      ...where:	


       
        


         
      •  [working_dir] is a temporary directory
to checkout the cell level
configuration file. This directory must already exist on the server

        ...where you are running wsadmin.





         
      •   [cellName] =  The name of
the cell that the dogear node belongs
to. (Name is case-sensitive.) 


      
  Example Usage: 


      DogearCellConfig.checkOutConfig('d:/dogear_temp', 'DogearServerNode01Cell')
      
    This command should print out this message: Bookmarks
Cell Level configuration file successfully checked out.





       
    4.  To list the current values for all configuration settings,
enter the following command: 


      wsadmin>DogearCellConfig.showConfig()

dogear_cell configuration properties:

activeContentFilter.enabled = true
fullTextIndex.defaultSearchOperator = OR
iconService.favIcon.max.age = 90
iconService.favIcon.max.size = 6
privateIntranetAllocationTable from 0.0.00.00 to 0.00.00.1
privateIntranetAllocationTable from 1.1.11.11 to 1.101.0.1
privateIntranetAllocationTable from 2.2.22.20 to 2.202.0.2
privateIntranetAllocationTable from 3.3.33.30 to 3.303.0.3
privateIntranetAllocationTable from 4.4.44.40 to 4.404.0.4
linkThresholds.maxInclude.popularLinks = 2000
linkThresholds.sinceWhen.inboxLinks = 20
linkThresholds.sinceWhen.popularLinks = 30
personThresholds.maxInclude.activePerson = 1500
personThresholds.minCount.activePerson = 5
personThresholds.sinceWhen.activePerson = 30
tagThresholds.maxInclude.activeTags = 4000
tagThresholds.minCount.activeTags = 5
tagThresholds.sinceWhen.activeTags = 30
      






       
    5.  To update configuration properties
enter the appropriate
key into the following command: 


      DogearCellConfig.updateConfig(.[key]', .[value]')

      ...where:
[key] is a valid cell-level configuration setting
[value] is the new value for the setting.

Example:
wsadmin>DogearCellConfig.updateConfig('tagThresholds.sinceWhen.activeTags', 
 '50')
      
The following lists the Bookmarks Cell "key" settings
that can be changed, along with an explanation of what those keys
are.




      
    

      Option
    Description

      activeContentFilter.enabled
    


       Boolean. true/false.





       Enables/disables the active
content filter for the Rich Text descriptions on bookmarks.  The default
value is "true" and can be set to "false" if you wish not to filter
active content.





         Disabling the active content filter is
not recommended as it will allow end users to create Rich Text Descriptions
with malicious scripts that might be executed when other users visit
Bookmarks.




      fullTextIndex.defaultSearchOperator
    


       String. AND/OR.





        Determines the default operator
used when a user performs a full text search with spaces in the input
string. 





       Default value is OR.  OR will result in queries returning
results that have any of the search terms.





       AND will result in
queries returning results that have all of the search terms.





        Both
approaches are relevance ranked where the best matches are listed
at the top of results. 




      iconService.favIcon.max.age
    


       Integer.





       Small (fav) icons are displayed to end users
next to each bookmark.  Bookmarks downloads and caches these icons
from the hosts servers for each URL.  This setting determines length
of time (in days) an icon remains cached locally before an updated
copy is retrieved.





       Default is 90 days.




      iconService.favIcon.max.size
    


       Integer.





       Small (fav) icons are displayed to end users
next to each bookmark. Bookmarks downloads and caches these icons
from the hosts servers for each URL.  This setting provides a cap
(in KB) on the size of the cached icon to control image file size.
The default is 6 KB.




      linkThresholds.sinceWhen.popularLinks
    


       Integer.





       Determines the age (in days) a link may
be to get included in the popular link algorithm. This value is used
in conjunction with the other popular link settings to determine what
bookmarks are included on the "Popular" bookmarks tab.  Smaller values
result in better performance. The default is 30 days.




      linkThresholds.maxInclude.popularLinks
    


       Integer.





       Provides a maximum number of links that
will get included in the popular link algorithm. If there are more
links that are eligible to be included based on the other settings,
the algorithm will take the most recent links that fall within this
cap.  This is to ensure consistent performance over peak times.  The default value is 2000 links.




      linkThresholds.sinceWhen.inboxLinks 
    


       Integer.





       Determines age (in days) a link may be to
get included in a user's watchlist.  Smaller values will result in
better performance.  The default is 20 days.




      tagThresholds.sinceWhen.activeTags
    


       Integer.





       Determines age (in days) a link may be to
have its tags included in the Active Tag cloud shown on the All and
Popular bookmark views.  This value is used in conjunction with the other active tag threshold settings to determine what is included
in the tag cloud.  Smaller values will result in better performance.
 The default is 30 days.




      tagThresholds.minCount.activeTags
    


       Integer.





       Provides a minimum number of occurrences
for a tag within the active time window for it to show in the Active
Tag cloud.  Tags that occur less than this threshold within the active
time window will not show in the Active Tag cloud on the All and Popular
bookmark views.  This value is used in conjunction with the other
active  tag threshold settings to determine what is included in the tag cloud.  The default is 5 tags.




      tagThresholds.maxInclude.activeTags
    


       Integer.





       Provides a maximum number of tags that will
get included in the active tag algorithm.  If there are more tags
that are eligible to be included  in this calculation based on the other settings, the algorithm will take the most recent tags that
fall within this cap.  This is to ensure consistent performance over
peak times.  The default value is 4000 tags.




      	personThresholds.sinceWhen.activePerson
    


       Integer.





       Determines age (in days) a bookmark may
be to have the associated person included in the active person list
on the All and Popular bookmark views.  This value is used in conjunction
with the other active person threshold settings to determine who is
included in the active person list.  Smaller values will result in
better performance.  The default is 30 days.




      personThresholds.minCount.activePerson
    


       Integer.





       Provides a minimum number of bookmarks a
user must have within the active time window to be considered for
the active person list. People that have less bookmarks than this
threshold will not be included in the list on the All and Popular
bookmark views. This value is used in conjunction with the other active
person threshold settings to determine who is included in the active
person list.  The default is 5 bookmarks.




      personThresholds.maxInclude.activePerson
    


       Integer.





       Provides a maximum number of bookmarks (and
the associated people) that are included in the active person list
algorithm. If more entries are eligible to be included in this calculation
based on the other settings, the algorithm will take the people associated
with the most recent links that fall within this cap.  This is to
ensure consistent performance over peak times.  The default value
is 1500 bookmarks.



      






       
    6.  IP
ranges are used to identify bookmarks located on your corporate intranet. As you expand or change your intranet topology,
use these settings to incorporate changes into Bookmarks: 


       If
the Administrator has previously configured an "IntranetAllocation.ipRange",
when the Administrator does the "DogearCellConfig.showConfig()" command,
one or more "IntranetAllocation.ipRange" will appear.  For example:


      privateIntranetAllocationTable from 0.0.00.00 to 0.00.00.1
privateIntranetAllocationTable from 1.1.11.11 to 1.101.0.1
privateIntranetAllocationTable from 2.2.22.20 to 2.202.0.2
privateIntranetAllocationTable from 3.3.33.30 to 3.303.0.3
privateIntranetAllocationTable from 4.4.44.40 to 4.404.0.4
      






       This
represents the various IP ranges of web sites in the corporate intranet.
This setting is used to determine if a site is internal or external.
Internal sites are represented by an intranet favicon. 





       You might need to update this value after initially installing Bookmarks
with no IP ranges or if you want to add a range post-install. This might be the case due to a corporate merger or acquisitions that result
in added or deleted IP ranges.  Any change to IP ranges will
require an update to the intranet settings of bookmarks in the database.
See help about recalculating or reprocessing intranet ranges in the Administrative help topic "Using administrative commands."





       The following commands allow the administrator to either Add or Remove
ipRanges. 





      
    

      Option
    Description

      DogearCellConfig.addIpRange'(intranetAllocation.ipRange',
['from_range'], ['to_range'])
    


       Strings.
This command will add an additional IP Range.





       [from_range]
 = the starting IP address of this range





       [to_range] =  the ending
IP address of this range





       Example: 


      DogearCellConfig.addIpRange(
 'intranetAllocation.ipRange', 
 '2.2.22.20' , '2.202.0.2')
      





      DogearCellConfig.removeIpRange('intranetAllocation.ipRange',
'[from_range]', '[to_range]')
    


       Strings. This command will delete an existing IP Range.





       [from_range]
 = the starting IP address of this range





       [to_range] =  the ending
IP address of this range





       Example: 


      DogearCellConfig.removeIpRange(
 'intranetAllocation.ipRange', 
 '2.2.22.20' , '2.202.0.2')
      





      DogearCellConfig.clearIpRanges('intranetAllocation.ipRange')
    


       String.





       Clears all IP ranges recorded in the configuration
settings





       Example:


      DogearCellConfig.clearIpRanges(
 'intranetAllocation.ipRange')
      




      






       
    7.  To check in the configuration file
enter this command: 


      DogearCellConfig.checkInConfig()

# This command should print out the following: 

Using configuration arguments :
        workingDirectory: d:/dogear_temp
        cellName: cellName
        nodeName: None
       serverName: None
Loading schema file for validation: d:/dogear-temp/dogear-config-cell.xsd
d:/dogear-temp/dogear-config-cell.xml is valid
Bookmarks cell level configuration file successfully checked in
      



    


     
    Related tasks
    

  •   Start the wsadmin client

  •   Apply common configuration property changes




     Change
node-level configuration settings
    





      

     


     To edit configuration files, you must
use the wsadmin client. See  Start the wsadmin client for
details.





These commands are run specific to the node. In a clustered
environment with multiple nodes the commands described below will
need to be run for each node. Node-level configuration change requires
a restart of the related Bookmarks node.  To change node-level settings:

    


     
      


       
    1.  Open a command window and start the wsadmin command
window.
  See the topic Editing application settings with the wsadmin
client for details on starting the wsadmin client.





       
    2.  After the wsadmin command environment has initialized,
run the following command to initialize the Bookmarks environment
and start the Bookmarks script interpreter:  


      wsadmin>execfile('<$WAS_HOME>\profiles\<DMGR>\config\bin_lcadmin \dogearAdmin.py')

 This command should print out something similar to the following messages in the wsadmin console.

Connecting to WebSphere:name=DogearTaskService,cell=TestServerNode01Cell,node=TestServerNode01,process=server1

Connecting to WebSphere:name=DogearLinkService,cell=TestServerNode01Cell,node=TestServerNode01,process=server1

Connecting to WebSphere:name=DogearPersonService,cell=TestServerNode01Cell,node=TestServerNode01,process=server1

Connecting to WebSphere:name=DogearUrlService,cell=TestServerNode01Cell,node=TestServerNode01,process=server1

Bookmarks MBeans initialized
Bookmarks Configuration Environment initialized
      






       
    3.  Check out the node-level configuration file with
the following command: 


      DogearNodeConfig.checkOutConfig('[working_dir]', '[cellName]', '[nodeName]')
Where:
[working_dir]  =  A temporary directory to checkout the node-level configuration
file. This directory must already exist on the server where you are running wsadmin.
[cellName] =  The name of the cell that the dogear node belongs to
[nodeName] = The name of the dogear node 
	

Example Usage:
DogearCellConfig.checkOutConfig('c:/Admin/test', 'DogearServerNode01Cell', 'DogearServerNode01')

The command should print out the message:
Bookmarks node level configuration file successfully checked out
      






       
    4.  To list current values for all
node-level configuration
settings: 


      DogearNodeConfig.showConfig()

dogear_node configuration properties:
fullTextService.directory = C:/ProgramFiles/IBM/LotusConnections  /Data/Bookmarks/AppSrv01_server1/index
iconService.favIcon.directory = C:/Program Files/IBM/LotusConnections /Data/Bookmarks/favicons
iconService.favIcon.failoverGif = C:/Program Files/IBM/LotusConnections /Data/Bookmarks/favicons/internal.gif
linkProcessingTask.batchsize = 300
linkProcessingTask.interval = 15
linkProcessingTask.nodeId = DogearServerNode01
linkProcessingTask.start = 15
      






       
    5.  To update node-level configuration, use a command similar
to the following: 


      DogearNodeConfig.updateConfig('[key]', '[value]')


      ...where:
[key]  = a valid node level configuration setting
[value] =  the new value for this configuration setting

Example:
wsadmin>DogearNodeConfig.updateConfig('fullTextService.directory', 'c:/fullTextDirectoryLocation')

Changing fullTextServiceProvider.stringProperty from
C:/Program Files/IBM/LotusConnections/Data/Bookmarks/AppSrv01_server1/index
to c:/fullTextDirectoryLocation
      






       
    6.  Use the commands in the table
below to update node-level
settings. The first column displays the "key" entries that can be
modified with the update command.  The second column provides more
information about the key and lists its default value.




      
    

      Option
    Description

      linkProcessingTask.start
    


       Integer. Determines the time interval (in minutes) the link processing task will wait from the time the Bookmarks Application is started  before it begins processing links.





       Bookmarks has
full text search which necessitates indexing of links.  Therefore
every link in the Bookmarks database must be indexed. The default
value is 15 minutes.




      linkProcessingTask.interval
    


       Integer. Determines the time interval (in minutes) between
each link processing job. This setting can be increased or decreased
based on frequency of usage as well as for performance reasons. The default value is 15 minutes.





        



      linkProcessingTask.batchsize
    


       Integer. Determines how many links will be processed during
each indexing job. The link processing task retrieves these links
from the database based on the timestamp they were created.





        IBM recommends that this setting not exceed 600 links. The default
is 300 links.




      linkProcessingTask.nodeId
    


       String. Determines the node ID the link processing task
will associate its processing with.





        Changing the node
ID for link processing task will restart indexing and link processing
from the beginning using this new node ID. If you change the node
ID you should also delete the old node ID from the Task list using
the TaskServiceMBean.




      fullTextService.directory
    


       String. Determines where the full text index directory
will be created on the file system. This will be located on the local
file system of each node machine.





        Be sure to specify a location
with room for growth as if there are a large number of links this
will grow.





        If you need to change the directory location
for fullTextService, copy over the current index structure so indexing
can continue. If you do not copy it over, you must use the TaskServiceMBean
to reset the indexing task for this node ID or it will create a new
index and start indexing from the beginning.




      iconService.favIcon.directory
    


        String. Determines where the favicon image caches will
be stored on the file system. This will be located on the local file
system of each node machine.




      iconService.favIcon.failoverGif 
    


       String. Determines the default intranet favicon image that
may be used in cases where intranet sites do not offer favicons. If an icon is not provided or the image file is missing, Bookmarks will
use a default icon.





       For proper rendering it is advised that
16 x 16 images files be used.





        If you wish to clear your Favicon cache after changing the default favicon for intranet sites,
delete the files under the directory specified for iconService.favIcon.directory
and the cache will regenerate itself.



      






       
    7.  Use a command similar to the following to check
in the node-level configuration file: 


      DogearNodeConfig.checkInConfig()

# This command will print out something like the following: 

Using configuration arguments :
        workingDirectory: c:/Admin/test
        cellName: cellName
        nodeName: nodeName
       serverName: None
Loading schema file for validation: /c:/Admin/test/dogear-config-node.xsd
c:/Admin/test/dogear-config-node.xml is valid
Bookmarks node level configuration file successfully checked in
      



    


     
    Related tasks
    

  •   Start the wsadmin client

  •   Apply common configuration property changes




    Customize file type icons
    





     You can add new file extensions to an existing file type
icon, or add a new file extension with a new icon. Custom file type
icons display in the Activities, Files, and Communities applications.
They also display in the activity stream.

    


     
      


       
    1.  Optional: Turn on the customization debugging
capability. For more information, see Enabling and disabling
customization debugging.





       
    2.  Add the new icon files to the following directory: 
      customizationDir/themes/images


       where customizationDir is
the base directory where your customizations should go. For more information,
see Determining where to save your customizations.






       
    3.  Make a copy of the sprite-lconn.css file.
You can access the file from the following directory: 
      WAS_HOME/profiles/profile_name/installedApps/cell_name/application_name.ear/application_name.war/nav/common/styles/base


       where: 


       
        


         
      •  WAS_HOME is the directory to which you installed IBM WebSphere Application Server.





         
      •  profile_name is the profile to which you installed
one of the IBM Connections applications.





         
      •  cell_name is the cell to which you installed
the application.





         
      •  application_name.ear is the EAR file name for
the application.





         
      •  application_name.war is the WAR file name for
the application.


      
For a list of the web application source directories that are
packaged with IBM Connections,
see Application WAR files and OSGi bundles.






       
    4.  Paste the sprite-lconn.css file into
the appropriate subdirectory of the customizationDir directory: 


       
        


         
      •  When you want the edited file to be used by all the applications,
post it to the customizationDir/themes/images/common directory.





         
      •  For the file to be used by a specific application only, post it
to the customizationDir/themes/images/application_name directory.


      






       
    5.  Open the new copy of the sprite-lconn.css file
in a text editor and do one of the following:

        


         
      •  Add a new extension and associate it with an existing icon:


         
          


           
        1.  Find the line with extensions that currently use the icon. For example, this is the line for extensions that use the "document" icon:


          .lconn-ftype16-doc,.lconn-ftype16-docm,.lconn-ftype16-docx, .... {background-position: 0 -408px;}
          






           
        2.  Add the new extension in the appropriate format. Make it lowercase,
and replace non-alpha numeric characters (a through z and 0 through
9) with a  dash ("-"). For example, add the extension .DocFormat_2010
to the list like this:


          .lconn-ftype16-docformat-2010, .lconn-ftype16-doc,.lconn-ftype16-docm,.lconn-ftype16-docx, .... {background-position: 0 -408px;}
          






           
        3.  Repeat steps a and b in the 32 and 64 pixel list. For example:


          .lconn-ftype32-docformat-2010, .lconn-ftype32-doc,.lconn-ftype32-docm,.lconn-ftype32-docx, .... {background-position: 0 -1112px;}
          



          .lconn-ftype64-docformat-2010, .lconn-ftype64-doc,.lconn-ftype64-docm,.lconn-ftype64-docx, .... {background-image: url(../images/ftWordProcessing64.png);}
          



        






         
      •  Add a new extension and a new icon by creating new rules for
16, 32, and 64 pixel icons, for example:


        .lconn-ftype16-docformat-2010 { background-image:url(myCustomExtensionIcon16.png) !important; background-position: 0 0; }
        



        .lconn-ftype32-docformat-2010 { background-image:url(myCustomExtensionIcon32.png) !important; background-position: 0 0; }
        



        .lconn-ftype64-docformat-2010 { background-image:url(myCustomExtensionIcon64.png) !important; background-position: 0 0; }
        



      






       
    6.  When you are ready to publish your changes, turn off the customization debugging capability. Test whether your changes were
added successfully by restarting the applications, and then refreshing
the web browser. A browser refresh only shows you your changes if
you turned on debugging. See Enabling and disabling customization
debugging for more details.





       
    7.  See Required post-customization step for information
about how to update the product version stamp and ensure that your users see the changes the next time that they log in to IBM Connections.


    


     
    Related tasks
    

  •   Configure MIME types for Files




    Customize
Files notification templates
    





     You can customize Files
notifications.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.








     Notification templates are programmed
in FreeMarker template
language and make use of variables, such as {notification.media.url},
that are populated by the server, as well as property files for inserting
internationalized strings. A core style template allows the generation
of both text/plain and text/html notification and can be customized
(along with individual templates) to change the style of the notification.


    


     
      


       
    1.  Start the wsadmin client.





       
    2.  Start the Files Jython script
interpreter : 


      execfile("filesAdmin.py")
      





       If
you are asked to select a server, you can select any server.






       
    3.  Check out the Files configuration files using the following
command: 


       FilesConfigService.checkOutConfig("working_directory",
"cell_name", includeEmailTemplates = "true") where:


       
        


         
      •  working_directory is the temporary working
directory to which the configuration files are copied. The files are
kept in this working directory while you make changes to them.





         
      •  cell_name is
the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is required even in stand-alone deployments. If you
do not know the cell name, type the following command while in the wsadmin command processor:


        print AdminControl.getCell()
        






         
      •  includeEmailTemplates must be set to "true" to
check out the notification templates along with the configuration
files. This is set to "false" by default.


      
For
example:


      FilesConfigService.checkOutConfig("/opt/my_temp_dir", "CommServerNode01Cell", includeEmailTemplates = "true")
      







       
    4.  Edit any of the following templates:




      
    

      Template
    Description

      


       commentAdded.ftl

    
      		


       Notification
sent to users when a comment is created on
a file they are following. Users can follow files by opening the file
page and clicking Follow.




      


       mediaUpdated.ftl

    
      		


       Notification
sent to users when a file they are following is edited. Users can follow files by opening the file page and clicking Follow.




      


       mediaShared.ftl

    
      		


       Notification
sent to users when files are shared with them.




      


       collectionMediaAdded.ftl

    
      		


       Notification
sent to users when a file is added to a folder
or community they are following.




      


       collectionMemberUpdated.ftl

    
      		


       Notification sent to users when a folder is shared with
them, or when their folder access level changes. This applies to individual
users, not groups.




      


       communityVisibilityUpdated.ftl

    
      		


       Notification sent to owners of a community when the community
was made public and non-public files shared with the community were
removed from it.




      


       style.ftl

    
      		


       Style template that controls the output of all notification
templates. Edit to customize the style of all notification templates.




      


       util.ftl

    
      		


       Helper
script methods to be used in templates.



      






       
    5.  Edit a notification_<locale>.properties file
to edit notification strings in a particular language.





       
    6.  You must check the configuration files back in after making
changes, and they must be checked in during the same wsadmin session
in which they were checked out for the changes to take effect. See
the topic Applying Files property changes for details. 


        Check in the templates using includeEmailTemplates="true"
with the checkin command, for example:FilesConfigService.checkInConfig(includeEmailTemplates
= "true").



    


     
    Related tasks
    

  •   Start the wsadmin client

  •   Apply Files property changes

  •   Apply Wikis property changes




     Synchronize user identification data between Files and the LDAP directory
    





     Use FilesMemberService commands to
synchronize member information
between the Files database directory and the IBM Connections user directory.


     


     Each IBM Connections application has a local database that stores users to avoid costly
lookups on the server user directory. The Files application automatically
synchronizes the local database directory with the server directory
using directory ID values. If all users have directory IDs that never
change, then Files synchronizes the local and server directories automatically.
Perform the steps in this topic to synchronize the Files directory
and user directory using a value other than the directory ID.





     If
you have configured all IBM Connections applications, including Files, to synchronize users automatically,
you should disable the Files user synch task. For information on disabling
the synch tasks, see the descriptions of scheduledTasks.DirectoryUserSynch.enabled
in the topic Files configuration properties.





     If
you are using the Profiles directory service, you must first synchronize
the ExtId values in the Profiles database with the user directory
before you can run the commands that synchronize member information
described in this topic. See Synchronizing user data between
Profiles and LDAP for more details.





     To use administrative
commands, you must use the wsadmin client. See  Start the wsadmin client for
details.








     The commands used to synchronize
member information between
the Files and user directory do not return any output. After running
the commands, be sure to check the SystemOut.log file
because the login names of users that were not successfully updated
are logged in this file.


    


     
      


       
    1.  Start the wsadmin client.





       
    2.  Start the Files Jython script interpreter
: 


      execfile("filesAdmin.py")
      






       
    3.  Use the commands below to change the internal IDs
of users. 


       
      FilesMemberService.getById(string userId)
      




       
      


       Returns information about a user specified by a user ID. The command only searches the Files database, so it only returns users who have logged in at least once.





       Parameters:


       
      id
      




       
      The user ID in the following standard Universally Unique Identifier (UUID) format: 00000000-0000-0000-0000-000000000000. The following information is returned:


       
        


         
      •  id: The user ID in the following standard Universally Unique Identifier (UUID) format: 00000000-0000-0000-0000-000000000000.





         
      •  name: The user's name in the database as of the date in directoryLastUpdate.





         
      •  email: The user's email address.





         
      •  isOrphan: Returns true if the user is in the database, but not the directory.





         
      •  createDate: The date the user was added to the database.





         
      •  lastVisit: The date of the user's last log in.





         
      •  directoryLastUpdate: The last time the user's data was synchronized from the directory.





         
      •  directoryGroupLastUpdate: The last time this user's group membership was synchronized from the directory.





         
      •  communityLastUpdate: The last time this user's Community membership was synchronized.


      

      

      






       For example:


      FilesMemberService.getById("2d93497d-065a-4022ae25-a4b52598d11a")
      


      




       
      FilesMemberService.getByExtId(string externalId)
      




       
      


       Returns information about a user specified by an external directory ID. The command only searches the Files database, so it only returns users who have logged in at least once.





       Parameters:


       
      externalId
      




       
      A string value matching the user's external directory ID. This can be any parameter in the user directory that you have configured as the directory ID. The following user information is returned:


       
        


         
      •  id: The user ID in the following standard Universally Unique Identifier (UUID) format: 00000000-0000-0000-0000-000000000000.





         
      •  name: The user's name in the database as of the date in directoryLastUpdate.





         
      •  email: The user's email address.





         
      •  isOrphan: Returns true if the user is in the database, but not the directory.





         
      •  createDate: The date the user was added to the database.





         
      •  lastVisit: The date of the user's last log in.





         
      •  directoryLastUpdate: The last time the user's data was synchronized from the directory.





         
      •  directoryGroupLastUpdate: The last time this user's group membership was synchronized from the directory.





         
      •  communityLastUpdate: The last time this user's Community membership was synchronized.


      

      

      






       For example:


      FilesMemberService.getByExtId("2d93497d-065a-4022ae25-a4b52598d11a")
      


      




       
      FilesMemberService.getByEmail(string email)
      




       
      


       Returns information about a user specified by an email address. The command only searches the Files database, so it only returns users who have logged in at least once.





       Parameters:


       
      email
      




       
      The email address for the user. The following user information is returned:


       
        


         
      •  id: The user ID in the following standard Universally Unique Identifier (UUID) format: 00000000-0000-0000-0000-000000000000.





         
      •  name: The user's name in the database as of the date in directoryLastUpdate.





         
      •  email: The user's email address.





         
      •  isOrphan: Returns true if the user is in the database, but not the directory.





         
      •  createDate: The date the user was added to the database.





         
      •  lastVisit: The date of the user's last log in.





         
      •  directoryLastUpdate: The last time the user's data was synchronized from the directory.





         
      •  directoryGroupLastUpdate: The last time this user's group membership was synchronized from the directory.





         
      •  communityLastUpdate: The last time this user's Community membership was synchronized.


      

      

      






       For example:


      FilesMemberService.getByEmail("john_doe@company.com")
      






        See Synchronizing user data using administrative commands for details.

      




       
      FilesMemberService.syncAllMembersByExtId( {"updateOnEmailLoginMatch": ["true" | "false"] } )
      




       
      




       
      FilesMemberService.syncMemberByExtId("currentExternalId"[, {"newExtId" : "id-string" [, "allowExtIdSwap" : ["true" | "false"] ] } ] )
      




       
      




       
      FilesMemberService.inactivateMemberByEmail("email")
      




       
      




       
      FilesMemberService.inactivateMemberByExtId("externalID")
      




       
      




       
      FilesMemberService.getMemberExtIdByEmail("email")
      




       
      




       
      FilesMemberService.getMemberExtIdByLogin("login")
      




       
      




       
      FilesMemberService.syncBatchMemberExtIdsByEmail("emailFile" [, {"allowInactivate" : ["true" | "false"] } ] )
      




       
      




       
      FilesMemberService.syncBatchMemberExtIdsByLogin("loginFile" [, {"allowInactivate" : ["true" | "false"] } ] )
      




       
      




       
      FilesMemberService.syncMemberExtIdByEmail("email" [, { "allowInactivate" : ["true" | "false"] } ])
      




       
      




       
      FilesMemberService.syncMemberExtIdByLogin("name" [, {"allowInactivate": ["true" | "false"] } ])
      




       
      

      



    


     
    Related tasks
    

  •   Start the wsadmin client

  •   Synchronize user data between Profiles and the LDAP directory


     

  •  Files configuration properties

  •  Wikis configuration properties




     Synchronize
user identification data between the Home page
and the LDAP directory
    





     Use administrative commands
to synchronize member records
in the Home page database with the LDAP directory.


     


     To use administrative commands, you must
use the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.





     If you are using the Profiles directory service,
you must first synchronize the ExtId values in the Profiles database
with the LDAP directory before you can run the commands that synchronize
member IDs described in this topic. See Synchronizing user data
between Profiles and the LDAP directory for more details.





When users are migrated to a new LDAP directory or a user
is removed and reentered in the LDAP directory and their unique identifier
changes, these users are not able to log in to the Home page until
the user record is updated with the HomepageMemberService command.

    


     To synchronize member IDs between the Home page
and LDAP
DBs:


     
      


       
    1.  Start
the wsadmin client so that you can access the Home
page configuration file:


       
        


         
      1.  Use the following command to
access the Home page configuration files. 


        execfile("homepageAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    2.  Use one of the following commands to update member IDs
in the Home page database: 



      Table 118. HomepageMemberService
commands

      Command
    Description




      HomepageMemberService.syncAllMemberExtIds()
    Synchronizes all member directory IDs in the Home page member database table with the LDAP directory ID. For each
member, this service queries the LDAP server by login name (or names)
stored as part of the Home page member profile to retrieve the updated
directory ID (unique interapplication identifier). In addition, the member's login names, display name, and email address are updated
if necessary.


       Use this command when a change occurs in the deployment
LDAP system. For example, if people have been deleted from the LDAP
directory or personal information has changed.





       Update time varies
depending on the number of people in the Home page database. On average,
it takes approximately eight minutes to update 500 users. For large
DBs, run this process overnight. If an update was not completed
successfully, check your server logs for any additional information.





       This
command does not take any parameters.





       For example:


      HomepageMemberService.syncAllMemberExtIds()
      





      HomepageMemberService.syncMemberExtIdByLogin(String
loginName)
    Synchronizes a single member's
directory ID
in the Home page member database table. This command is essentially
the same as syncAllMemberExtIds() but applied to a single member.
The member's login names, display name, and email address are updated.


       This
command takes loginFile as a parameter. This is a text file name with
a single, valid login name per line. You must create this text file
and save it in a directory that is local to the server that you connect
to.





       For example: 


      HomepageMemberService.syncMemberExtIdByLogin("/opt/Homepage/update.txt")
      





      HomepageMemberService.syncBatchMemberExtIdsByLogin(String
loginFile)
    Synchronizes a list of member's
directory IDs
in the Communities member database table. The list is specified in
a text file specified by the parameter. This command is essentially
the same as syncAllMemberExtIds() but applied to a list of members,
and the LDAP server is queried by the specified login names. Thus,
the members' login names, display names, and email address are updated.


       You must create this text file and save it in a directory that is local
to the server that you connect to.





       For example: 


      HomepageMemberService.syncBatchMemberExtIdsByLogin("/opt/Homepage/update.txt")
      





      HomepageMemberService.syncMemberExtIdByEmail(String
emailAddr)
    Synchronizes a single member's
directory ID
in the Home page member database table. The command is essentially
the same as syncAllMemberExtIds(), but applied to a single member,
who is identified by the specified email address. In addition, the member's login names and display name are updated if necessary.


       This
command is used when a change occurs in the deployment LDAP system
or when a person identifier in the LDAP directory changes in some
respect. This change might occur when an LDAP record is updated.





       This
command takes a string as a parameter, emailAddr. This string is a
valid email address.


        Email addresses are case sensitive.






       For example: 


      HomepageMemberService.syncMemberExtIdByEmail("john_smith@example.com")
      





      HomepageMemberService.syncBatchMemberExtIdsByEmail(String
emailFile)
    Synchronizes a list of member's
directory IDs
in the Home page member database table. The list is specified in a
text file specified by the parameter. This command is essentially
the same as syncAllMemberExtIds() but applied to a list of members,
and the LDAP server is queried by the specified email addresses. Thus,
the members' login names and display names are updated.


       This command
takes emailFile as a parameter. This parameter is a text file name
with a single, valid email address per line. You must create this
text file and save it in a directory that is local to the server that
you connect to.


        Email addresses are case sensitive.






       For example: 


      HomepageMemberService.syncBatchMemberExtIdsByEmail("/opt/Homepage/update.txt")
      





      






        Depending on the size of data
being synchronized, if
the execution of one of these commands takes longer to complete than
the value of the com.ibm.SOAP.requestTimeout property
in the soap.client.props file in WAS_HOME\profiles\PROFILE_NAME\properties\soap.client.props,
an error displays on the wsadmin console, and any return value from
the method invoked is lost. The command continues to be processed
to completion, but the connection between the application and the wsadmin client that invoked it is gone. To change this behavior so
that the client does not terminate the connection, increase the value
of the com.ibm.SOAP.requestTimeout property or
set the property to 0 for no timeout. If you reset the property, you
must restart the application server for the change to take effect.



    


     
    Related tasks
    

  •   Synchronize user data between Profiles and the LDAP directory




     Synchronize user identification data between the news application
and the LDAP directory
    





     Use administrative commands
to synchronize member records
between the Home page and the LDAP DBs.


     


     To use administrative commands, you must
use the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.





     If you are using the Profiles directory service,
you must first synchronize the ExtId values in the Profiles database
with the LDAP directory before you can run the commands that synchronize
member IDs described in this topic. See Synchronizing user data
between Profiles and the LDAP directory for more details.





When users are migrated to a new LDAP directory or a user
is removed and reentered in the LDAP directory and their unique identifier
changes, these users are not able to log in to the Home page until
the user record is updated with the NewsPersonService command.

    


     To synchronize member IDs between the news application
and LDAP DBs:


     
      


       
    1.  Start the wsadmin client so that you can access the news
configuration file:


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    2.  Use one of the following commands to update member IDs
in the Home page database. 


       


       
      NewsMemberService.syncAllMemberExtIds()
      




       
      


       Synchronizes all member directory IDs in the Home page member
database table with the LDAP directory ID. For each member, this service
queries the LDAP server by login name (or names) stored as part of
the Home page member profile to retrieve the updated directory ID
(unique interapplication identifier). In addition, the member's login
names, display name, and email address are updated if necessary.





       Use
this command when a change occurs in the deployment LDAP system. For example, if people have been deleted from the LDAP directory or personal
information has changed.





       Update time varies depending on the number of people in the Home page database. On average, it takes approximately
eight minutes to update 500 users. For large DBs, run this process
overnight.





       This command does not take any parameters.





       For example:


      NewsMemberService.syncAllMemberExtIds()
      


      




       
      NewsMemberService.syncMemberExtIdByLogin(String
loginName)
      




       
      


       Synchronizes a single member's directory ID
in the Home page
member database table. This command is essentially the same as syncAllMemberExtIds()
but applied to a single member. Thus, the member's login names, display
name, and email address are updated.





       This command takes loginName
as a parameter. This parameter is a single, valid user login name.





       For example: 


      NewsMemberService.syncMemberExtIdByLogin("John Smith")
      


      




       
      NewsMemberService.syncBatchMemberExtIdsByLogin(String
loginFile)
      




       
      


       Synchronizes a list of member's directory IDs
in the Home page
member database table. The list is specified in a text file specified
by the parameter. This command is essentially the same as syncAllMemberExtIds()
but applied to a list of members, and the LDAP server is queried by
the specified login names. Thus, the members' login names, display
names, and email address are updated.





       This command takes loginFile
as a parameter. This is a text file name with a single, valid login
name per line. You must create this text file and save it in a directory
that is local to the server that you connect to.





       For example: 


      NewsMemberService.syncBatchMemberExtIdsByLogin("/opt/Homepage/update.txt")
      


      




       
      NewsMemberService.syncMemberExtIdByEmail(String
emailAddr)
      




       
      


       Synchronizes a single member's directory ID
in the Home page
member database table. The command is essentially the same as syncAllMemberExtIds(),
but applied to a single member, who is identified by the specified
email address. In addition, the member's login names and display name
are updated if necessary.





       This command is used when a change
occurs in the deployment LDAP system or when a person identifier in
the LDAP directory changes in some respect. This change might occur
when an LDAP record is updated.





       This command takes a string
as a parameter, emailAddr. This string is a valid email address.


        Email
addresses are case sensitive.






       For example: 


      NewsMemberService.syncMemberExtIdByEmail("john_smith@example.com")
      


      




       
      NewsMemberService.syncBatchMemberExtIdsByEmail(String
emailFile)
      




       
      


       Synchronizes a list of member's directory IDs
in the Home page
member database table. The list is specified in a text file specified
by the parameter. This command is essentially the same as syncAllMemberExtIds()
but applied to a list of members, and the LDAP server is queried by
the specified email addresses. Thus, the members' login names and
display names are updated.





       This command takes emailFile as a
parameter. This parameter is a text file name with a single, valid
email address per line. You must create this text file and save it
in a directory that is local to the server that you connect to.


        Email
addresses are case sensitive.






       For example: 


      NewsMemberService.syncBatchMemberExtIdsByEmail("/opt/Homepage/update.txt")
      


      

      






        Depending on the size of data being synchronized,
if the execution of one of these commands takes longer to complete
than the value of the com.ibm.SOAP.requestTimeout property
in the soap.client.props file in WAS_HOME\profiles\PROFILE_NAME\properties\soap.client.props,
an error displays on the wsadmin console, and any return value from
the method invoked is lost. The command continues to be processed
to completion, but the connection between the application and the wsadmin client that invoked it is gone. To change this behavior so
that the client does not terminate the connection, increase the value
of the com.ibm.SOAP.requestTimeout property or
set the property to 0 for no timeout. If you reset the property, you
must restart the application server for the change to take effect.



    


     
    Related tasks
    

  •   Synchronize user data between Profiles and the LDAP directory




    Add custom strings for widgets and other specified scenarios
    





     You can add custom strings or modify existing strings when
performing certain IBM Connections tasks.


     When adding custom strings, you must use the wsadmin client.
See  Start the wsadmin
client for details.


     IBM Connections provides a external resource bundle loader for adding and updating
strings to Profiles, Communities, and the Home page. You can only
use this process when performing the following tasks:


     
      


       
    •  Add custom extension attributes to profiles





       
    •  Customize the Profiles business card





       
    •  Add custom widgets to Communities, Profiles, and the Home page





       
    •   Configure the vCard export application





       
    •  Renaming the tabs in the Home page





       
    •  Add custom themes to Communities


    
You can add custom strings for other tasks using the procedure
outlined in Customize product strings.





To add custom strings for the listed tasks, create a bundle
containing the custom strings and save it in the customization_dir/strings directory
that is created at installation time. You then register the file in
LotusConnections-config.xml. For performance
reasons, include all the resource strings in a single bundle.


     For a complete example, see Creating a simple profile data model
and template customization.


    


     
      


       
    1.  Create a properties file containing the strings that you
want to add in the customization_dir/strings directory. 


       
        


         
      •  To specify the name of the default properties file, use the following syntax:
         resource_bundle_name.properties_file_name





         
      •  To specify custom strings in multiple languages, append an underscore
followed by the appropriate language code to the resource bundle name
using the following syntax:
         
        resource_bundle_name_language_code.properties_file_name


      





       For example, if your string bundle is named com.example.resources,
you might create a file in the strings directory
that looks like the following:
      customization_dir/strings/com.example.resources.properties
       This file contains the strings used for the default locale. When there
is no specific bundle for the user's locale, the labels in this
default properties file are used.





       To include an English version
of the strings, you might create the following file: 
      <customization_dir>/strings/com.example.resources_en.properties





       And
to include a Slovakian version of the strings, you might include the following file:
      customization_dir/strings/com.example.resources_sk.properties





       The following sample string is contained in the properties file.


      label.vcard.encoding.cp943c=Japanese Encoding
      







       
    2.  Register the resource bundle in LotusConnections-config.xml:


       
        


         
      1.  Open a command window and start the wsadmin command-line
tool as described in the topic, Starting the wsadmin client.





         
      2.  Enter the following command to access the IBM Connections configuration file: 
        execfile("<$WAS_HOME>/profiles/<DMGR>/config/bin_lc_admin/connectionsConfig.py")





         
      3.  Enter the following command to check out the IBM Connections configuration file: 
        LCConfigService.checkOutConfig(working_directory, cell_name) 
        where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied.
The files are kept in this working directory while you make changes
to them.





           
        •  cell_name is the name of the IBM WebSphere Application Server cell hosting the IBM Connections application. This argument is required. It is also case-sensitive,
so type it with care.


        
For example:


        LCConfigService.checkOutConfig("/temp", "foo01Cell01")
        






         
      4.  From the temporary directory to which you just checked
out the IBM Connections configuration
files, open LotusConnections-config.xml
in a text editor.





         
      5.  Add the following line of code into the <resources>
element block to register the resource bundle: 


        <widgetBundle prefix=bundle_prefix name=bundle_name />
        

        ...where 


         
          


           
        •  bundle_prefix is a globally unique name that
identifies the bundle. This is a string value. The bundle prefix is
used to uniquely scope the keys in each bundle. The prefix must be
unique across all registered widget bundles.


           This bundle prefix
maps to the bundle ID reference that you specify when you define a
custom resource attribute or widget. For more information about defining
custom resource attributes, see Enabling custom extension attributes
for Profiles. For information about defining custom widgets,
see Enabling custom widgets for Communities or Enabling
custom widgets for Profiles.






           
        •  bundle_name is the Java package name. This parameter takes a string
value. When you name the resource bundle, the elements in the bundle
name must correspond to the file name of the properties file that
you created in step 1.


           For example, if the strings customization
directory contains the files com.example.resources.properties, com.example.resources_en.properties,
and com.example.resources_sk.properties, the name of the bundle is com.example.resources.



        
The following sample code is used to register the com.example.resources bundle:


        <resources>

  <!--  Example:  The attribute 'prefix' must be globally unique as it identifies the bundle when used in IBM Connections.  -->

  <widgetBundle prefix="example" name="com.example.resources"/>

</resources>
        






         
      6.  Save your changes to LotusConnections-config.xml.





         
      7.  To check in the updated file, use the following command: 
        LCConfigService.checkInConfig()





         
      8.  To exit the wsadmin client, type exit at
the prompt.


      



    

     
    What to do next
    After completing this procedure, you can use the labels in
other configuration settings or in your JavaScript code. For example, you can
use the strings when customizing the business card in Profiles (to
add labels for custom extension attributes) and adding widgets to
Profiles, Communities, and the Home page (to provide widget titles
and descriptions). You can also use the strings to rename the Updates, Widgets,
and Administration tabs in the Home page.


     Note
that when you specify external labels for attributes, editable attributes,
or custom extension attributes, the labels are only applied to the user interface element that the configuration object represents. For example, if you apply a custom label to a business card <attribute>
element, the label does not automatically apply to the same element
in the advanced search page layout. 





     For information about how
to apply the label configuration to each user interface element individually,
see Specifying external labels for attributes.



     
    Related tasks
    

  •   Start the wsadmin client

  •   Enable custom extension attributes for Profiles

  •   Configure the vCard export application for Profiles

  •   Configure Profiles directory search options




     Configure
profile types for widget layout
    





     To configure widget
layout, you can add a profile type
containing the widget layout configuration to Profiles in the widgets-config.xml file.


     


     To edit configuration files,
you must use the wsadmin client. See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.


    


     To add a new profile
type for widget layout, perform
the following steps.


     
      


       
    1.  Start
the wsadmin client from the following directory of the system on which you installed the Deployment Manager:  


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Use the wsadmin client to access and
check out the Profiles
configuration files.


       
        


         
      1.  Enter the following command
to access the Profiles configuration files: 
        execfile("profilesAdmin.py") 
        If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    3.  Use the following command to check out the widget configuration file: 


       ProfilesConfigService.checkOutWidgetConfig("<working_directory>",
"<cell_name>")

      ...where:


       
        


         
      •  working_directory is
the temporary working
directory to which the configuration XML and XSD files will be copied.
The files are kept in this working directory while you make changes
to them.





         
      •  cell_name is the name of
the WebSphere Application Server cell hosting
the Profiles application. This argument is required.


      
For
example:


      ProfilesConfigService.checkOutWidgetConfig("/wsadminoutput", "jdoe30Node02Cell")
      






       
    4.  Save a copy of the widgets-config.xml file.





       
    5.  Open the file in a text editor.





       
    6.  Add a widget layout under the <widgets> element, as
in the following example: 


      <layoutConfiguration>
  <widgets xmlns:tns="http://www.ibm.com/profiles-config">
    <layout resourceSubType="debug">
      <page pageId="profilesView">
        <widgetInstance uiLocation="col2" defIdRef="multiWidget" instanceId="tabsWidget1"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="board"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="contactInfo"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="backgroundInfo"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="multiFeedReader"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="socialTags"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="sand_thingsInCommon"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="sand_socialPath"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="reportStructure"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="friends"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="linkRoll"/>
      </page>
    </layout>
      
    <layout resourceSubType="restricted">
      <page pageId="profilesView">
        <!-- <widgetInstance uiLocation="col2" defIdRef="multiWidget" instanceId="mw1"/> -->
        <widgetInstance uiLocation="col2" defIdRef="contactInfo" instanceId="ci1"/>
        <widgetInstance uiLocation="col1" defIdRef="reportStructure"/>
      </page>
    </layout>

    <layout resourceSubType="mobile">
      <page pageId="profilesView">
        <widgetInstance uiLocation="col2" defIdRef="multiWidget" instanceId="tabsWidget1"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="board"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="contactInfo"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="backgroundInfo"/>
        <widgetInstance uiLocation="col2" defIdRef="multiWidget" instanceId="tabsWidget2"/>
        <widgetInstance uiLocation="tabsWidget2" defIdRef="multiFeedReader"/>
        <widgetInstance uiLocation="col1" defIdRef="socialTags"/>
        <widgetInstance uiLocation="col1" defIdRef="sand_thingsInCommon"/>
        <widgetInstance uiLocation="col1" defIdRef="sand_socialPath"/>
        <widgetInstance uiLocation="col3" defIdRef="reportStructure"/>
        <widgetInstance uiLocation="col3" defIdRef="friends"/>
        <widgetInstance uiLocation="col3" defIdRef="linkRoll"/>
      </page>
    </layout>

    <layout resourceSubType="default">
      <page pageId="profilesView">
        <widgetInstance uiLocation="col2" defIdRef="multiWidget" instanceId="tabsWidget1"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="board"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="contactInfo"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="backgroundInfo"/>
        <widgetInstance uiLocation="tabsWidget1" defIdRef="multiFeedReader"/>
        <widgetInstance uiLocation="col1" defIdRef="socialTags"/>
        <widgetInstance uiLocation="col1" defIdRef="sand_thingsInCommon"/>
        <widgetInstance uiLocation="col3" defIdRef="sand_socialPath"/>
        <widgetInstance uiLocation="col3" defIdRef="reportStructure"/>
        <widgetInstance uiLocation="col3" defIdRef="friends"/>
        <widgetInstance uiLocation="col3" defIdRef="linkRoll"/>
      </page>
      <page pageId="searchResultView">
        <widgetInstance uiLocation="col1" defIdRef="commonTags"/>
      </page>
      <page pageId="searchView">
        <widgetInstance uiLocation="col1" defIdRef="sand_DYK"/>
        <widgetInstance uiLocation="col1" defIdRef="commonTags"/>
        <!-- 
          <widgetInstance uiLocation="col3" defIdRef="sand_recomItems"/>
        -->
      </page>
      <page pageId="networkView">
        <widgetInstance uiLocation="col1" defIdRef="sand_DYK"/>
      </page>
      <page pageId="editProfileView">
       ...
    </layout>
  </widgets>
</layoutConfiguration>
      






       
    7.  Save your changes
and check the widgets-config.xml file back in
: 


       ProfilesConfigService.checkInWidgetConfig()






       
    8.  To exit the wsadmin client, type exit at
the prompt.





       
    9.  Stop and restart the Profiles server.


    


     
    Related tasks
    

  •   Apply property changes in Profiles




    Add
widgets to Profiles
    





     IBM Connections provides
enhanced application customization of the user interface in the form
of widgets. As administrator, you can add default widgets to Profiles
by defining and configuring the widgets in the widgets-config.xml file.


     


     To edit configuration files, you must
use the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command line tool.





Based on profile type, you
can add widgets to Profiles and
modify their layout to adapt to different usage patterns. You can
also add and remove widgets so that different roles have different
widgets and widget layouts. As well as adding default widgets, you
can define and display widgets from external sources. The widgets
are rendered by the web browser rather than a server.


     To add widgets
to Profiles, perform the following steps:


    


     
      


       
    1.  Use the wsadmin client to access the Profiles configuration
files.


       
        


         
      1.  Enter the following command
to access the Profiles configuration files: 
        execfile("profilesAdmin.py") 
        If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    2.  Use the following command to check out the widget configuration
file: 


      ProfilesConfigService.checkOutWidgetConfig("<working_directory>", "<cell_name>")
      

      ...where:


       
        


         
      •  working_directory is the temporary working
directory to which the configuration XML and XSD files will be copied.
The files are kept in this working directory while you make changes
to them.





         
      •  cell_name is the name of
the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is required even in stand-alone deployments.


      
For
example:


      ProfilesConfigService.checkOutWidgetConfig("/wsadminoutput", "jdoe30Node02Cell")
      






       
    3.  Save a copy of widgets-config.xml.





       
    4.  Open the file in a text editor, and specify attributes
and values for the <widgetDef> element under the <widgets> element: 



      Table 119. The widgetDef element

      Attribute
    Description




      defId
    Used by the internal
framework to identify the widget. Must be unique. It is also used as a resource bundle
key. For information on adding a resource string to Profiles, see Add
custom strings to IBM Connections.


       This
attribute takes a string value.




      url
    Specifies the location
of the widget definition
document. This URL can be relative to the host system where Profiles
is installed. The URL can also be absolute; the widget can be located
on a different server from Profiles.


       This attribute takes a string
value.




      showFullPageViewLinkInNavBar
    Specifies whether a link to the widget is displayed
in the navigation bar. This link forwards the user to a full page
view of the widget. The iWidget must be able to handle a normal view
and a full page view.


       This attribute takes a Boolean value.




      navBarResourceBundleId
    Contains the resource bundle key that Profiles
uses when displaying a link name in the navigation bar. For information
on adding a resource string to Profiles, see Add custom strings
to IBM Connections.


       This
attribute takes a string value.




      loginRequired
    Specifies
whether a user must be logged in to
Profiles for the iWidget to display.


       This attribute takes a Boolean
value.




      helpBodyResourceBundleId
    Contains the resource bundle key that Profiles
uses when displaying a help text for an iWidget. For information on
adding a resource string to Profiles, see Add custom strings
to IBM Connections.


       This
attribute takes a string value.




      






       The configData element can contain a list of child elements
named attr. The attr elements are a list of name-value pairs that
are passed into the iWidget as an AttributeItemSet. The attributes
specified in this section can also be specified as an <iw:itemSet/>
in the widget definition file.




      Table 120. The layout element

      Attribute
    Description




      profileType
    Contains
the name of the profile type that is
used to  render the widget layout. Multiple profile type layout configuration
is allowed in Profiles. For more information, see Add profile
types.


       This attribute takes a string value.




      





      Table 121. The page element

      Attribute
    Description




      pageId
    Contains the pageId
for the page that Profiles
uses to render the widget layout. Possible values include profilesView
and reportingStructureView.


       This attribute takes a string value.




      





      Table 122. The widgetInstance element

      Attribute
    Description




      defIdRef
    Contains
a reference to the <widgetDef> defId
attribute.


       This attribute takes a string value.




      ui-location
    Specifies
the location of the widget in the Profiles page.


       Possible values include col1, col2, and col3.





       This
attribute takes a string value.




      

For example:


      <widgets xmlns:tns="http://www.ibm.com/profiles-config">
  <definitions>
    ...
    <widgetDef defId="photoApp" url="http://mycompany.com/photoApp/widgetDefition.xml" fullPageView="true" 
    showFullPageViewLinkInNavBar="true" navBarResourceBundleId="photoAppTitleId" helpBodyResourceBundleId="photoAppHelpTextId">
      <configData>
        <attr key="numberOfPhotoToDisplay" value="4" />
      </configData>
    </widgetDef>
    ...
  </definitions>
  <layout profileType="default">
    <page pageId="profilesView">
      ...
      <widgetInstance uiLocation="col3" defIdRef="photoApp"/>
      ...
    </page>
    <page pageId="reportingStructureView"/>
  </layout>
<layout profileType="management">
    <page pageId="profilesView">
      ...
      <widgetInstance uiLocation="col2" defIdRef="photoApp"/>
      ...
    </page>
    <page pageId="reportingStructureView">
      ...
      <widgetInstance uiLocation="col2" defIdRef="photoApp"/>
      ...
    </page>
  </layout>
</widgets>
      






       
    5.  Save your changes and check the widgets-config.xml file
back in : 


      ProfilesConfigService.checkInWidgetConfig()
      






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop and restart the Profiles server.


    


     
    Related tasks
    

  •   Apply property changes in Profiles




    Customize login attributes
    





     By default, Profiles looks at the login table and various
login attributes in the Profiles database. To improve performance,
comment out login attributes that are not used in your environment.


     


     To edit configuration files,
you must use the wsadmin client. See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.








     Default mappings for uid and mail are provided. To use
a mapping for loginId, replace ADMIN_REPLACE in
the loginField element with the appropriate login
attribute specified in WebSphere Application Server. This section should only contain those login attributes that
will be used in a deployment. For example, if users only log in with
email, then the mappings for uid and loginId should
be commented out or removed.





     For more information on enabling
and disabling access, see Forcing users to log in before they
can access an application.





      The login attributes described
here refer to the Profiles database table, not the LDAP; the values
you enter in the Admin Console refer to the LDAP. Thus if an LDAP
field has been added using the Admin Console, you would not need to
add it to the Profiles database using the procedure described here. 





      When
editing the login table in the Profiles database, you can comment
out login attributes that you do not need, but you should not use
the login table to add new login attributes. 


    


     
      


       
    1.  Start
the wsadmin client from the following directory of the system on which you installed the Deployment Manager:  


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Profiles Jython script interpreter.


       
        


         
      1.  Enter the following command
to access the Profiles configuration files: 
        execfile("profilesAdmin.py") 
        If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Enter the following command
to check out the Profiles configuration files: 
        ProfilesConfigService.checkOutConfig("working_directory",
"cell_name")where:


         
          


           
        •  working_directory is
the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
(/) to separate directories in the file path, even if you are using
the Microsoft Windows operating system.


            AIX and Linux only: The directory must grant write
permissions or the command does not complete successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the Profiles application. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor: 
          print
AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:


          ProfilesConfigService.checkOutConfig("/opt/prof/temp","foo01Cell01")
          






           
        •  Microsoft

          Windows:


          ProfilesConfigService.checkOutConfig("c:/prof/temp","foo01Cell01")
          



        



      






       
    3.  Locate the Profiles configuration file, profiles-config.xml,
in the local working directory specified in the checkOutConfig command.
The Profiles configuration file contains the various configuration
settings for the Profiles application. The following section of the file can be used for customizing login attributes: 


      <loginAttributes>
<loginAttribute>uid</loginAttribute>
<loginAttribute>email</loginAttribute>
<loginAttribute>loginId</loginAttribute>
</loginAttributes>
      





       


        The uid, mail, and loginId
options are on the first side of the + in the map_dbrepos_from_source.properties file
and refer to data in the Profiles database table. The value on the other side of the = is the LDAP (or function) name. 



       
        


         
      •  The uid value pertains to the EMPLOYEE
PROF_UID column.





         
      •  The email value pertains to the PROF_MAIL column. 





         
      •  The loginId value pertains to the EMPLOYEE
PROF_LOGIN column and the PROF_LOGIN table
and refers to the mappings loginId= and logins=.
For example, you could set logins= to employee number. 


      







       
    4.  Comment out any attributes that are not used in your environment,
as in the following example: 


        

      <loginAttributes>
<loginAttribute>uid</loginAttribute>

<! -- The following login attribute is not used

<loginAttribute>email</loginAttribute>

-->

<loginAttribute>loginId</loginAttribute>
</loginAttributes>
      




    


     
    Related tasks
    

  •   Apply property changes in Profiles




     Enable custom extension attributes for Profiles
    





     Extend the Profiles application by adding custom extension
attributes.


     


     To edit configuration files,
you must use the wsadmin client. See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.





In addition to different attribute layouts, Profiles supports
extension attributes for every profile type. Because all profiles
share one schema, an extension attribute, such as customers,
has the same semantic meaning for all profile types. However, you
can choose to associate a particular attribute with a profile based
on profile type. The user interface configuration, including display
characteristics and whether an attribute can be edited, is also configurable
for extension attributes based on profile type. 


     You can enable
custom extension attributes by adding them to the My Profile page.
The attributes that display on the My Profile page
are specified using the profiles-config.xml file
located in the was_profile_rootconfig/cellscell_name/nodes/node-name/LotusConnections-config directory.
Although changes to profiles-config.xml should
generally be made using wsadmin client scripting, there are no wsadmin
commands to modify the profilesDataModel, so you
can make changes to the profilesDataModel using
a text editor.





     There are three child elements under the profileDataModel element
that correspond to the three sections in the My Profile page
in Profiles: jobInformation, contactInformation,
and associatedInformation. The order in which the attributes display in the file reflects the order in which they display
in the form. This correspondence means that you can easily reorder
the attributes without needing to modify any JSP files.





     The extension attributes that you define are included as links in the output of the Profiles API unless you specify otherwise in the profiles-config.xml file,
as described in step 7 in the following procedure. For more information
about retrieving Profiles extensions through the API, see Retrieve
profile extension data.


    


     To add a custom extension attribute to the My
Profile page, perform the following steps.


     
      


       
    1.  Start
the wsadmin client from the following directory of the system on which you installed the Deployment Manager:  


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Profiles Jython script interpreter.


       
        


         
      1.  Enter the following command
to access the Profiles configuration files: 
        execfile("profilesAdmin.py") 
        If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Enter the following command
to check out the Profiles configuration files: 
        ProfilesConfigService.checkOutConfig("working_directory",
"cell_name")where:


         
          


           
        •  working_directory is
the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
(/) to separate directories in the file path, even if you are using
the Microsoft Windows operating system.


            AIX and Linux only: The directory must grant write
permissions or the command does not complete successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the Profiles application. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor: 
          print
AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:


          ProfilesConfigService.checkOutConfig("/opt/prof/temp","foo01Cell01")
          






           
        •  Microsoft

          Windows:


          ProfilesConfigService.checkOutConfig("c:/prof/temp","foo01Cell01")
          



        



      






       
    3.  Save a copy of the profiles-config.xml file.





       
    4.  Open the file in a text editor.





       
    5.  To define the extension attribute, add it to the <profileExtensionAttributes> element
under <profileDataModels> as shown in the following sample: 


      <profileDataModels>	
  <profileExtensionAttributes>
    <simpleAttribute extensionId="property1" length="64"/>
    <simpleAttribute extensionId="property2" length="64"/>
    <simpleAttribute extensionId="property3" length="64"/>
  </profileExtensionAttributes>

  <profileDataModel>
...
  </profileDataModel>
...
</profileDataModels>
      
For example:


      <profileDataModels>
  <profileExtensionAttributes>
   ...
    <simpleAttribute extensionId="spokenLang" length="64" />
    <simpleAttribute extensionId="TechExperience" length="64" />
    <simpleAttribute extensionId="officeAddress" length="64" />
    <simpleAttribute extensionId="homeAddress" length="64" />

  </profileExtensionAttributes>
</profileDataModels>
      






       
    6.  To display the extension attribute, you need to associate
it with a profile type. To do this, add the following line of code
as a child element under the relevant profileType element,
and under the appropriate page section, jobInformation, contactInformation,
or associatedInformation: 


      <extensionAttribute showLabel="true" editable="true" extensionIdRef="extension_attribute_name"/>
      





       The following table displays the XML attributes associated with the extensionAttribute element.



      Table 123. XML attributes associated with extensionAttribute

      Attribute
    Description




      editable
    Specifies if the extension attribute can be
edited by users. This attribute takes a Boolean value.



      showLabel
    Specifies whether to display a label for the extension attribute in the user interface. The attribute takes a Boolean
value.



      hideIfEmpty
    Specifies whether to hide the attribute if it
does not have a value. This attribute takes a Boolean value.



      link
    This attribute takes a Boolean value.



      extensionIdRef
    The ID of the extension. This ID is associated
with the property key in the resource file. This attribute takes a
string value.



      labelKey
    Specifies the referenced key name of the label.
This attribute takes a string value.



      bundleIdRef
    Specifies the referenced bundle ID of the label.
This attribute takes a string value.



      prependHtml
    Specifies the HTML code prefixed to the value.
This attribute takes a string value.



      appendHtml
    Specifies the HTML code appended to the value.
This attribute takes a string value.



      


For example, to display the officeAddress and homeAddress extension
attributes in the Contact Information section of the page:


      <layoutConfiguration>
    <profileLayout profileType="student">
        <contactInformation>
           <extensionAttribute 
            showLabel="true" 
            editable="true" 
            extensionIdRef="officeAddress"/>
           <extensionAttribute 
            showLabel="true" 
            editable="true" 
            extensionIdRef="homeAddress" />
           <extensionAttribute 
            showLabel="true" 
            editable="true" 
            extensionIdRef="property1" 
            labelKey="label.contactInformation.property1" 
            bundleIdRef="customRes" />
          ...
        </contactInformation>
    </profileLayout>
</layoutConfiguration>
      






       
    7.  To label the extension attribute, add a resource string
to the Profiles application. For more information, see Add
custom strings for widgets and other specified scenarios.





       
    8.  Extension attributes are included in the output of the Profiles API by default. To prevent extension attributes from being
included in the API, define which attributes should not be output
for each profile type. To do this, add the following line in the <apiConfiguration> section
as a child element of the <apiModel> element
for the relevant profileType. 


      <hiddenApiExtensionAttribute extensionIdRef="extension-id"/>
      
For
example, to prevent the homeAddress extension attribute
from appearing in API output for the default profile type, use the following configuration:


      <apiConfiguration>
  <apiModel profileType="default">
    <hiddenApiExtensionAttribute extensionIdRef="homeAddress"/>
          ... 
  </apiModel>
</apiConfiguration>
      



    


     
    Related tasks
    

  •   Apply property changes in Profiles

  •  Add custom strings for widgets and other specified scenarios


     

  •  Retrieve profile extension data




     Integrate the Profiles business card
    





     Include the Profiles business card in your web application
so that users can access your profile information and contact details.


     The CSS files loaded with the Profiles business card do not
include font style information. To ensure that the business card appears
fully integrated with your web application from a visual perspective,
define your own font styles globally so that the styles used in your application are also applied to the business card.


      The use of JavaScript Object Notation
with padding (JSONP) technology in the business card will be deprecated
in future releases. Although JSONP will continue to be supported,
if you are integrating the business card in to your web application
and you want to prevent JSONP data from being transmitted by IBM Connections, you must use an
Ajax proxy.





You can integrate the Profiles business card with your web
application based on one of the following:


     
      


       
    •  User ID, using the x-lconn-userid parameter





       
    •  email address, using the email parameter


    





     The x-lconn-userid parameter is any unique
identifier for the user defined by the administrator and originating
from the corporate LDAP directory. Many LDAP directories contain users
who do not have email addresses and using the x-lconn-userid parameter
is a way of preemptively avoiding a dependency on the email address.
In addition, administrators can edit configuration property settings
to prevent email addresses from being displayed in IBM Connections. Hide email is a way to prevent
the scraping of email addresses and protect the privacy of users.
You can architect your web application so that it does not rely on
email addresses for retrieving user data, such as the contextual business
card.





     Two types of business card are available to add to your web application:


     
      


       
    •  Inline. This type of business card is embedded in the user interface.
Only one inline card can be displayed at a time on the page.





       
    •  Pop-up. This type of business card displays when users click a
link in the user interface. Only one popup card can be displayed at
a time.


    

To integrate the Profiles business card with your web application,
complete the following steps:

    


     
      


       
    1.  Include the following reference to the semanticTagService.js file
in your code: 


      <script type="text/javascript" src="src="protocol://connections_server/profiles_app/ibm_semanticTagServlet/javascript/semanticTagService.js"></script>
      





       Notes: 


       
        


         
      1.  The body element must exist and it must be instantiated before
the script's JavaScript executes.
So, if the script resource is included within the head element of
your HTML code, it must use the defer attribute (defer="defer") so
that the JavaScript executes
after the page is loaded. Otherwise, the script resource request must
be included within the body element.





         
      2.  The business card uses Dojo. If Dojo is already included in your application, add the ?inclDojo=false URL
parameter to the JavaScript include
as follows, otherwise the business card will not work.


        <script type="text/javascript" src="src="protocol://connections_server/profiles_app/ibm_semanticTagServlet/javascript/semanticTagService.js?inclDojo=false"></script>
        
If
you use the ?inclDojo=false setting, ensure that
you include the Javelin JavaScript after
you include Dojo on your web page.





         
      3.  The business card can be loaded with or without CSS. If you already
have the IBM Connections CSS
files loaded in your application and do not want to include the CSS
again, add the loadCssFiles=false parameter to the JavaScript include like this:


        <script type="text/javascript" src="src="protocol://connections_server/profiles_app/ibm_semanticTagServlet/javascript/semanticTagService.js?loadCssFiles=false"></script>
        






         
      4.  The business card cannot be run from the file system; your HTML
file must reside on a web server. This server does not need to be
in the same domain as Profiles. Use the following sample syntax to
call your HTML file.


        <script type="text/javascript" src="src="protocol://connections_server/profiles_app/ibm_semanticTagServlet/javascript/semanticTagService.js"></script>
        



      







       
    2.  Use and modify one of the following code examples to render
the card with your personal details. 


       To add the inline
card:





      
    

      Option
    Description

      Based on user ID
    


      <div class="vcard X-person-display-inline">
  <span class="fn" style="display:none;">user_name</span>
  <span class="x-lconn-userid" style="display: none;">user_id</span>
</div>
      





       For example:


      <div class="vcard X-person-display-inline">
  <span class="fn" style="display:none;">Joe Todd</span>
  <span class="x-lconn-userid" style="display: none;">91ae7240-8f0a-1028-737f-db07163b51b2</span>
</div>
      





      Based on email address
    


      <div class="vcard X-person-display-inline">
  <span class="fn" style="display:none;">user_name</span>
  <span class="email" style="display:none;">user_email_address</span>
</div>
      
For example:


      <div class="vcard X-person-display-inline">
  <span class="fn" style="display:none;">Joe Todd</span>
  <span class="email" style="display:none;">todd@mycomp.com</span>
</div>
      



      
 To add the pop-up card:




      
    

      Option
    Description

      Based on user ID
    


      <span class="vcard">
  <a href="javascript:void(0);"class="fn url">user_name</a>
  <span class="x-lconn-userid" style="display: none;">user_id</span>
</span>
      





       For example:


      <span class="vcard">
  <a href="javascript:void(0);"class="fn url">Joe Todd</a>
  <span class="x-lconn-userid" style="display: none;">91ae7240-8f0a-1028-737f-db07163b51b2</span>
</span>
      





      Based on email address
    


      <span class="vcard">
   <a href="javascript:void(0);"class="fn url"><user_name></a>
   <span class="email" style="display: none;"><user_email_address></span>
</span>
      
For example:


      <span class="vcard">
   <a href="javascript:void(0);"class="fn url">Joe Todd</a>
   <span class="email" style="display: none;">todd@mycomp.com</span>
</span>
      



      






       
    3.  Optional: If you are using the standalone business
card, include the following code to provide support for bidirectional
languages: 


      <script type="text/javascript">
var SemTagSvcConfig = { isBidiRTL: true};
</script>
      






       
    4.  Optional: If you are building a web application
that constructs its user interface using Ajax, do one of the following to make the business card user interface and a person's profile data
available: 


        This step only applies when you are building
an application that constructs its user interface using Ajax. The business card code only scans the HTML when the page is first loaded
so, if you dynamically alter the page, you need to manually specify
the DOM elements that the code should rescan for business card vcard
class attributes. If you are developing a completely static page,
you can ignore this step.





       Do one of the following:


        


         
      •  For applications that construct HTML dynamically, you can
add LiveName programmatically using JavaScript. Use the following API example:


        var htmlContent = 
"<span class='vcard'>"+
   "<a href='javascript:void(0);' class='fn url'>user_name</a>"+
   "<span class='email' style='display: none;'>"+
      "user_name@company.com"+
   "</span>'+
"</span>";

document.getElementById("containerId").innerHTML += htmlContent;

setTimeout("SemTagSvc.parseDom(null, 'containerId')", 500 );
        
For example:


        var htmlContent =
"<span class='vcard'>"+
   "<a href='javascript:void(0);' class='fn url'>Joe Todd</a>"+
   "<span class='email' style='display: none;'>"+
      "todd@mycomp.com"+
   "</span>'+
"</span>";

document.getElementById("containerId").innerHTML += htmlContent;

setTimeout("SemTagSvc.parseDom(null, 'containerId')", 500 );
        






         
      •  To make the business card user interface and a person's profile
data available on your server:


         
          


           
        1.  Verify the following files are in the WAS_HOME\profiles\WAS_Profile\config\cells\Host_name\LotusConnections-config directory:


           
            


             
          •  service-location.xsd





             
          •  LotusConnections-config.xsd





             
          •  LotusConnections-config.xml


          






           
        2.  Ensure that the profile service reference in LotusConnections-config.xml
points to a running profile server. For example:


          <sloc:serviceReference serviceName="profiles"
	href="http://localhost:9080/profiles"
	enabled="true"
      	ssl_href="https://localhost:9443/profiles"
	ssl_enabled="true"
    person_card_service_url_pattern="/html/simpleSearch.do?searchFor={email}&amp;searchBy=email"
        person_card_service_name_js_eval="generalrs.label_personcard_profilelink"/>
          



        



      



    



    Related
    

  •   Administer Profiles




     Delete outdated file content
    





     You can use an administrative command to purge old file
content from the system before you create a new Search index and reindex
the content of file attachments.


     


     See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.





You can purge the system of outdated content extracted from
file attachments using the SearchService.purgeFilesContent() command.
For example, you might want to run this command when the existing
files content is no longer current and you are replacing an old Search
index with a newly-created Search index.

    


     To delete outdated file attachment data from the system,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Run the following command: 


       


       
      SearchService.purgeFilesContent()
      




       
      


       Removes all entries from the HOMEPAGE database table that tracks
the status of individual files as part of the content extraction process.
This table is used by the Search application when indexing the content
of file attachments.





       The command does not take any arguments.

      

      




    


     
    Related tasks
    

  •  Retrieve file content

  •   Configure file attachment indexing settings

  •  Recreating the Search index




    Customize
Wikis notification templates
    





     You can customize Wikis
notifications.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.








     Notification templates are programmed
in FreeMarker template
language and make use of variables, such as {notification.media.url},
that are populated by the server, as well as property files for inserting
internationalized strings. A core style template allows the generation
of both text/plain and text/html notifications and can be customized
(along with individual templates) to change the style of the notification.


    


     
      


       
    1.  Start the wsadmin client.





       
    2.  Access the Wikis configuration
files : 


      execfile("wikisAdmin.py")
      





       If
you are asked to select a server, you can select any server.






       
    3.  Check out the Wikis configuration files using the following
command: 


       WikisConfigService.checkOutConfig("working_directory",
"cell_name", includeEmailTemplates = "true") where:


       
        


         
      •  working_directory is the temporary working
directory to which the configuration files are copied. The files are
kept in this working directory while you make changes to them.





         
      •  cell_name is
the name of the WebSphere Application Server cell hosting
the IBM Connections application.
If you do not know the cell name, type the following command while
in the wsadmin command processor: 


        print AdminControl.getCell()
        






         
      •  includeEmailTemplates must be set to "true" to
check out the notification templates along with the configuration
files. This is set to "false" by default.


      
For
example:


      WikisConfigService.checkOutConfig("/opt/my_temp_dir", "CommServerNode01Cell", includeEmailTemplates = "true")
      







       
    4.  Edit any of the following templates:




      
    

      Template
    Description

      


       commentAdded.ftl

    
      		


       Notification
sent to users when a comment is created on
a wiki page they are following, or on any page in a wiki they are
following.





       Users can follow wiki pages or wikis by opening a
page and clicking Follow, and then Follow
this Page or Follow this Wiki.




      


       mediaUpdated.ftl

    
      		


       Notification
sent to users when an event occurs in a wiki
page or wiki they are following. Events include title or description
edits, new tags, and new or deleted pages, edits or comments.





       Users
can follow wiki pages or wikis by opening a page and clicking Follow,
and then Follow this Page or Follow
this Wiki.




      


       libraryMemberUpdated.ftl

    
      		


       Notification sent to users when they are made a member
of a wiki, or when their wiki access level is changed. This applies
to individual users, not groups.




      


       style.ftl

    
      		


       Style template that controls the output of all notification
templates. Edit to customize the style of all notification templates.




      


       util.ftl

    
      		


       Helper
script methods to be used in templates.



      






       
    5.  Edit a notification_<locale>.properties file
to edit notification strings in a particular language.





       
    6.  You must check the configuration files back in after making
changes, and they must be checked in during the same wsadmin session
in which they were checked out for the changes to take effect. See
the topic Applying Wikis property changes for details.


    




     Synchronize user identification data between Wikis and the LDAP directory
    





     Use WikisMemberService commands to
synchronize member IDs
between Wikis and the user directory.


     


     Each IBM Connections application has a local database that stores users to avoid costly
lookups on the server user directory. The Wikis application automatically
synchronizes the local directory with the server directory using directory
ID values. If all users have directory IDs that never change, then
Wikis synchronizes the local and server directories automatically.
Perform the steps in this topic to synchronize the database and directory
using a directory value other than directory ID.





     If you have
configured all IBM Connections components to synchronize automatically, including Wikis, you should
disable the Wikis user and group synch tasks. For information on disabling
the synch tasks, see the descriptions of scheduledTasks.DirectoryUserSynch.enabled
and scheduledTasks.DirectoryGroupSynch.enabled in the topic Wikis
configuration properties.





     If you are using the Profiles
directory service, you must first synchronize the ExtId values in
the Profiles database with the user directory before you can run the commands that synchronize member IDs described in this topic. See Synchronizing
user data between Profiles and LDAP for more details.





     To use administrative commands, you must use the wsadmin client. See  Start the wsadmin client for
details.








     The commands used to synchronize
member IDs between Wikis
and the user directory do not return any output. After running the commands, be sure to check the SystemOut.log file
because the login names of users that were not successfully updated
are logged in this file.


    


     
      


       
    1.  Start the wsadmin client.





       
    2.  Start the Wikis Jython script interpreter
: 


      execfile("wikisAdmin.py")
      






       
    3.  Use the commands below to change the internal IDs
of users. 


       
      WikisMemberService.getById(string id)
      




       
      


       Returns information about a user specified by a user ID. The command only searches the Wikis database, so it only returns users
who have logged in at least once.





       Parameters:


       
      id
      




       
      The user ID in the following standard Universally Unique Identifier
(UUID) format: 00000000-0000-0000-0000-000000000000. The following information is returned:


       
        


         
      •  id: The user ID in the following standard Universally Unique Identifier
(UUID) format: 00000000-0000-0000-0000-000000000000.





         
      •  name: The user's name in the database as of the date in directoryLastUpdate.





         
      •  email: The user's email address.





         
      •  isOrphan: Returns true if the user is in the database, but not
the directory.





         
      •  createDate: The date the user was added to the database.





         
      •  lastVisit: The date of the user's last log in.





         
      •  directoryLastUpdate: The last time the user's data was synchronized
from the directory.





         
      •  directoryGroupLastUpdate: The last time this user's group membership
was synchronized from the directory.





         
      •  communityLastUpdate: The last time this user's Community membership
was synchronized.


      

      

      






       For example:


      WikisMemberService.getById("2d93497d-065a-4022ae25-a4b52598d11a")
      


      




       
      WikisMemberService.getByExtId(string externalId)
      




       
      


       Returns information about a user specified by an external directory
ID. The command only searches the Wikis database, so it only returns
users who have logged in at least once.





       Parameters:


       
      externalId
      




       
      A string value matching the user's external directory ID. This can be any parameter in the user directory that you have configured
as the directory ID. The following user information is returned:


       
        


         
      •  id: The user ID in the following standard Universally Unique Identifier
(UUID) format: 00000000-0000-0000-0000-000000000000.





         
      •  name: The user's name in the database as of the date in directoryLastUpdate.





         
      •  email: The user's email address.





         
      •  isOrphan: Returns true if the user is in the database, but not
the directory.





         
      •  createDate: The date the user was added to the database.





         
      •  lastVisit: The date of the user's last log in.





         
      •  directoryLastUpdate: The last time the user's data was synchronized
from the directory.





         
      •  directoryGroupLastUpdate: The last time this user's group membership
was synchronized from the directory.





         
      •  communityLastUpdate: The last time this user's Community membership
was synchronized.


      

      

      






       For example:


      WikisMemberService.getByExtId("2d93497d-065a-4022ae25-a4b52598d11a")
      


      




       
      WikisMemberService.getByEmail(string email)
      




       
      


       Returns information about a user specified by an email address.
The command only searches the Wikis database, so it only returns users
who have logged in at least once.





       Parameters:


       
      email
      




       
      The email address for the user. The following user information
is returned:


       
        


         
      •  id: The user ID in the following standard Universally Unique Identifier
(UUID) format: 00000000-0000-0000-0000-000000000000.





         
      •  name: The user's name in the database as of the date in directoryLastUpdate.





         
      •  email: The user's email address.





         
      •  isOrphan: Returns true if the user is in the database, but not
the directory.





         
      •  createDate: The date the user was added to the database.





         
      •  lastVisit: The date of the user's last log in.





         
      •  directoryLastUpdate: The last time the user's data was synchronized
from the directory.





         
      •  directoryGroupLastUpdate: The last time this user's group membership
was synchronized from the directory.





         
      •  communityLastUpdate: The last time this user's Community membership
was synchronized.


      

      

      






       For example:


      WikisMemberService.getByEmail("john_doe@company.com")
      


      




       
      WikisMemberService.syncAllMembersByExtId( {"updateOnEmailLoginMatch":
["true" | "false"] } )
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.syncMemberByExtId("currentExternalId"[,
{"newExtId" : "id-string" [, "allowExtIdSwap" :
["true" | "false"] ] } ] )
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.inactivateMemberByEmail("email")
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.inactivateMemberByExtId("externalID")
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.getMemberExtIdByEmail("email")
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.getMemberExtIdByLogin("login")
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.syncBatchMemberExtIdsByEmail("emailFile" [,
{"allowInactivate" : ["true" | "false"] } ] )
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.syncBatchMemberExtIdsByLogin("loginFile" [,
{"allowInactivate" : ["true" | "false"] } ] )
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.syncMemberExtIdByEmail("email" [,
{ "allowInactivate" : ["true" | "false"] } ])
      




       
      See Synchronizing user data using administrative commands for
details.
      




       
      WikisMemberService.syncMemberExtIdByLogin("name" [,
{"allowInactivate": ["true" | "false"] } ])
      




       
      See Synchronizing user data using administrative commands for
details.
      

      



    




     Start the wsadmin client
    





     Use the wsadmin client to make configuration changes to
common IBM Connections settings
and individual application settings. 


     The wsadmin client is a scripting environment that gets installed
with IBM WebSphere Application Server. You can use
Jython language scripts, that are installed with IBM Connections, to access and change properties
that govern the IBM Connections configuration. You can configure common properties that apply across
all applications, and you can configure properties that apply only
to an individual application.

    Start the wsadmin client :


     
      


       
    1.  Open a command prompt, and then
change to the following directory of the system on which you installed
the deployment manager: 


        

      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01. For example,
on

      Windows:


      C:\Program Files\IBM\WebSphere\AppServer\profiles\Dmgr01\bin
      

       You must run the following command to start the wsadmin
client from this specific directory because the Jython files for the product are stored here. If you try to start the client from a different
directory, then the execfile() command that you subsequently call
to initialize the administration environment for an IBM Connections component does not work correctly. 







       
    2.  Enter the following command to
start the wsadmin client: 


       
        


         
      •  AIX or Linux:


        ./wsadmin.sh -lang jython -user admin_user_id -password admin_password -port SOAP_CONNECTOR_ADDRESS Port
        






         
      •  Microsoft

        Windows:


        wsadmin -lang jython -user admin_user_id -password admin_password -port SOAP_CONNECTOR_ADDRESS Port
        



      





       where: 


       
        


         
      •  admin_user_id is the user name of a person
in the Administrator role on the IBM WebSphere Application Server.





         
      •  admin_password is the password of the WebSphere Application Server
administrator. 





         
      •  SOAP_CONNECTOR_ADDRESS Port is the SOAP
port for the WebSphere Application Server deployment manager server. The default value of the SOAP port
is 8879. If you are using the default port value, you do not need
to specify this parameter. If you are not using the default and you
do not know the port number, you can look up its value in the WebSphere Application Server
Integrated Solution Console. To look up the SOAP port number, perform
the following steps:


         
          


           
        1.  Open the WebSphere Application Server Integrated Solution Console for the deployment manager, and
then select System Administration > Deployment Manager.





           
        2.   In the Additional properties section expand Ports,
and then look for the SOAP_CONNECTOR_ADDRESS port entry to find the port number.


        



      






       For example:


       
        


         
      •  AIX or Linux: 


        ./wsadmin.sh -lang jython -username primaryAdmin -password p@assword -port 8879
        






         
      •  Microsoft

        Windows: 


        wsadmin -lang jython -username primaryAdmin -password p@assword -port 8879
        



      




    


     
    What to do next
    See the common IBM Connections section and individual application sections for information about
the properties that you can change.



    Related
    

  •   Administer the Home page using the wsadmin client


    

  •   Use the Profiles database as the user directory

  •  Add custom strings for widgets and other specified scenarios


     

  •   Administer Blogs using the wsadmin Client

  •  Common configuration properties

  •  Activities configuration properties




    Back up IBM Connections
    





     Before migrating or updating IBM Connections, back up your DBs and applications.




Follow these steps to back up your IBM Connections deployment. You can use this
back-up to restore your existing deployment if the update or migration
fails. This procedure backs up your entire deployment; you cannot
use it to back up individual applications within IBM Connections. 

    


     
      


       
    1.  Stop the IBM WebSphere Application Server
instances that are hosting IBM Connections.





       
    2.   Use native database tools, back up the DBs. If the update or migration fails, use this backup to restore the DBs.
For more information about backing up IBM Connections data, see the Back up and restoring
data topic.





       
    3.  Back up the WebSphere Application Server Deployment Manager profile directory: profile_root/Dmgr01. For example: D:\WebSphere\AppServer\profiles\dmgr. 





       
    4.  Back up your IBM Connections deployment.


       
        


         
      1.  Create a back-up of the IBM Connections installation directory: connections_root. 





         
      2.  Create a back-up of the WebSphere Application Server profile directory: profile_root 


          If IBM Connections applications are deployed on separate profiles, archive
each profile. 






         
      3.  Create a back-up of the profileRegistry.xml file, located under app_server_root/properties.





         
      4.  Back up the local and shared data directories: 


         
        



      






       
    5.  Back up the Shared Resources directory: 


       
      






       
    6.  Optional: Back up the IBM Installation Manager data directory: 


        This step is necessary only if you are planning an in-place
migration of IBM Connections;
that is, where you use the same systems to host the new deployment.



       
        


         
      •  AIX or Linux: /var/ibm/InstallationManager





         
      •  AIX or Linux (non-root user): /home/user/var/ibm/Installation Manager


         where user is the account name of the non-root user. 






         
      •  Windows: C:\ProgramData\IBM\Installation
Manager


      






       
    7.  Back up any customized configuration files. For more information,
see the Saving your customizations topic.


    


     
    Related tasks
    

  •   Maintain application DBs




    Add the Files widget so you can share files and folders
with your community
    

    


     Add the Files widget to your community so that you and
other members can share files and folders with the rest of the community.


     The Files widget is automatically added to a community when
it is first created. You can remove the widget and add it to the community
again at a later stage. You must be a community owner to add the Files
widget to a community.







     When you add the Files widget to a community,
members can share local files and files from the Files application
with the rest of the community. Sharing files is a good way to foster
collaboration within a community. By encouraging members to upload
files to the community, you can work together on shared documents
and build up a valuable repository of information that is accessible
from within the community.


    


     To add the Files widget to a community, complete the following steps.


     
      


       
    1.  From the community's Overview page, select Community Actions > Customize to open the content palette.





       
    2.  Click Files to add file-sharing
functionality to your community.





       
    3.  Optional: Click Close Palette to
close the palette.


    

     
    Results
    A new Files area displays on the Overview page.
This area is empty at first but, when community members become active
and start sharing files, it displays the five files that have been
most recently updated or uploaded to the community file share area.
A Files link to the community's file share
area is also provided in the navigation sidebar.


     By
default, every member can now start sharing files with the rest of
the community. As a community owner, you can restrict the access level
of regular members by selecting Community
Actions > Edit Community from
the community's Overview page, clicking the Files tab,
and changing the permissions as required. For more information about
editing permissions for community files, see Managing the Files
widget.





     Configure PowerCube refresh schedules
    





     By default, IBM Cognos Transformer refreshes
each PowerCube with incremental updates once each day, and replaces
the cube.s data for the current month once a week. These jobs are
scheduled by default but you might need to modify the schedules to
avoid conflicts with other activities.







     When scheduling the refresh jobs, keep the following issues
in mind:


     
      


       
    •  These jobs should run at times when the Cognos system usage is relatively low, to
minimize the impact on normal usage. You should adjust these times
based on your system's usage pattern.





       
    •  The weekly refresh should run only once every week; since it will
take longer to complete, you should schedule it for the time when
system usage is lowest (for example, on the weekend).





       
    •  The daily refresh should run early in the morning (for example,
just after midnight), so users can see the latest metrics for the previous day.


    



    On the computer hosting Cognos Transformer,
schedule the PowerCube updates, making sure the schedules for the daily and weekly jobs do not collide:

      


       
    •  AIX or Linux:


       Edit the cron jobs
in the system crontab.






       
    •  Windows:


       Edit the MetricsCubeDailyRefresh job to ensure it does not collide with the weekly refresh. You can modify the job.s properties in the Task Scheduler
Library; for more information see the next topic.



    





     Configure the job scheduler for Cognos Transformer on Windows
    





     Rather than store administrative credentials in a script,
you can add them to the job properties of the IBM Cognos Transformer
to enable scheduled tasks on Microsoft Windows.







     Finish configuring the job scheduler to run the Transformer
periodically by adding the Windows Administrator
credentials to the MetricsCubeDailyRefresh scheduler job. 


    


     
      


       
    1.  Click Start > Control
Panel > Administrative Tools and click Task Scheduler.





       
    2.  In the navigation tree, click Task Scheduler
Library.





       
    3.  In the list of scheduled tasks, click MetricsCubeDailyRefresh to
view its properties.





       
    4.  In the MetricsCubeDailyRefresh Properties window,
open the General tab and click the Change
User or Group button.





       
    5.  In the Select user or group dialog
box, type administrator in the Enter the object name to select field, and then click the Check
Names button. 


       The Task Scheduler compiles a list accounts with administrative
access on this Windows server.






       
    6.  When the Task Scheduler dialog box
prompts to Enter the user account information to run
this task, select the Windows Administrator
user name that will be associated with the MetricsCubeDailyRefresh
task, and type the password associated with that account; then click OK. 


       The selected administrator account now has the authority
to run the MetricsCubeDailyRefresh task.






       
    7.  Click OK to save the change and
close the MetricsCubeDailyRefresh Properties window.





       
    8.  Close the Task Scheduler.


    




     Grant access to global metrics
    





     Configure the metrics-report-run security role to grant
users the authority to view and interact with global metrics.







     Other than administrators, only the users assigned to
the metrics-report-run role can access global metrics. Whenever a
user with this authorization level views the global metrics, the report
information is updated automatically. 


    


     


     Configure the metrics-report-run security role in IBM WebSphere Application Server.



     
      


       
    1.  On the Deployment Manager, log in to the Integrated Solutions Console as the WebSphere administrator.





       
    2.  In the navigation tree, click Enterprise
Applications > Metrics > Security
role to user/group mapping.





       
    3.  In the roles table, click the check box next to the metrics-report-run role.





       
    4.  Click the Map Groups button in the table.





       
    5.  Add one or more user groups to the metrics-report-run role,
giving those users the ability to view and interact with global metrics
reports. 


       For best results, limit access to a small set
of users whose jobs require them to view the most recent metrics.
Granting this level of access to a large number of users  slow performance,
as update requests are processed in sequence.






       
    6.  Click OK.





       
    7.  Save the change to the master configuration by clicking
the Save link in the "Messages" box.





       
    8.  Synchronize all nodes in the cell to the Deployment Manager,
and then restart the node agents:


       
        


         
      1.  On the navigation tree, click System
Administration > Nodes.





         
      2.  Click the Full Resynchronize button
in the table.





         
      3.  Return to the navigation tree and click System Administration > Node agents.





         
      4.  In the nodes table, click the box in front of each node.





         
      5.  Click the Restart button in the table.


      



    




     Define IBM HTTP Server
    





     Define IBM HTTP Server to manage web connections.


     


     Install web server plug-ins for IBM HTTP Server, if they are not already installed. For more information, go to the  Install web server plug-ins web site. 








     IBM Connections uses a web server as the entry point for all the applications.





     This procedure describes how to create a web server using the Integrated Solutions Console. There are other ways to create the web server. See the IBM WebSphere Application Server information center for more information.





     To define IBM HTTP Server:


    


     
      


       
    1.  Start the IBM HTTP Administration Server: 


       
        


         
      •  AIX or Linux:


         
          


           
        1.  cd following directory: 


           
            


             
          •  AIX: /usr/IBM/HTTPServer/bin





             
          •  Linux: /opt/IBM/HTTPServer/bin


          






           
        2.  Enter the following command: ./adminctl start


        






         
      •  Windows:


         
          


           
        1.  Open the Services window in the Windows Control Panel.





           
        2.  Verify the IBM HTTP Administration Server service is started. If this service is not running, start it


        



      






       
    2.  Log in to the WebSphere Application Server Integrated Solutions Console on the Deployment Manager and select System administration > Nodes > Add Node.





       
    3.  Select Unmanaged node and click Next.





       
    4.  Set the properties of the node by providing values in the following fields: 


       
      Name
      




       
      Enter the name of the node.
      




       
      Host Name
      




       
      Enter the fully qualified DNS host name for IBM HTTP Server. For example: webserver.example.com.
      




       
      Platform
      




       
      Select the operating system type that hosts your IBM HTTP Server.
      

      
Click OK and then click Save.





       
    5.  Select Servers > Server Types > Web servers and click New.





       
    6.  Provide values for the following fields: 


       
      Select node
      




       
      Select the node specified in Step 4.
      




       
      Server name
      




       
      Enter the name of the your web server. The default value is webserver1.
      




       
      Type
      




       
      Select IBM HTTP Server. 
      

      






       
    7.  Click Next.





       
    8.  Select the default web server template and click Next.





       
    9.  On the Enter the properties for the new web server page, check the paths and make adjustments if necessary, and then enter the user name and password specified when you installed IBM HTTP Server. Confirm the password and click Next.





       
    10.  Confirm to create the new web server.





       
    11.  Click Finish and then click Save.





       
    12.  Synchronize all the nodes.





       
    13.  Select Servers > Server Types > Web servers and click the link to your webserver.





       
    14.  Click Generate Plug-in.





       
    15.  Select the check box for your webserver.





       
    16.  Click Propagate Plug-in. 





       
    17.  Select Servers > Server Types > Web servers and click the link to your webserver.





       
    18.  Click Plug-in properties and then click Copy to Web Server key store directory. 


        If the plugin-key.kdb file is on a different system from the IBM HTTP Server system, copy it manually from the WebSphere Application Server system to the IBM HTTP Server system. 






       
    19.  Restart IBM HTTP Server.


    

     
    What to do next
    


     Complete the steps in the Configuring IBM HTTP Server for SSL topic.





     Configure IBM HTTP Server to handle file downloads from the Files and Wikis applications. For information on this configuration, see the Configuring Files and Wikis downloads topic. 





    Customize the Get Started view
    





     Help your users get started with your implementation of IBM Connections by customizing the Get
Started view that is displayed in the Home page.


     The Get Started view is only available
from the Home page. If you do not install the Home Page application,
then the Get Started view is not available
in the product.


     To edit configuration files, you must use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.





The gettingstarted-config.xml file defines
the content of the Get Started view in the Home page. By default, the view identifies the following steps in
vertical tabs:


     
      


       
    1.  Welcome





       
    2.  Share





       
    3.  Explore


    
You can edit the content that is displayed in each tab and you
can add or remove tabs.

    


     
      


       
    1.  Open a command window, and then start the wsadmin command
line tool.





       
    2.  Access the configuration files
for the Home page application: 


      execfile("homepageAdmin.py")
      






       
    3.  Check out the Get Started view
configuration files : 


      HomepageCellConfig.checkOutGetstartedConfig("working_directory","cell_name")
      

      ...where:


       
        


         
      •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
to separate directories in the file path, even if you are using the Microsoft Windows operating system.


          AIX and Linux only:
The directory must grant write permissions or the command will not
run successfully.






         
      •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, you can determine it by typing the following command
in the wsadmin command processor:


        print AdminControl.getCell()
        



      
For example:


       
        


         
      •  AIX/Linux:


        HomepageCellConfig.checkOutGetstartedConfig("/opt/act/temp","foo01Cell01")
        






         
      •  Microsoft

        Windows:


        HomepageCellConfig.checkOutGetstartedConfig("c:/act/temp","foo01Cell01")
        



      






       
    4.  From the temporary directory to
which you checked out the gettingstarted-config.xml file,
open it in a text editor.





       
    5.  Make any of the following updates that you want:

        


         
      •  To remove one of the vertical tabs, find the <step> element
that represents the tab and change the value of its enabled attribute
from true to false.





         
      •  To add another tab to the list:


         
          


           
        1.  Copy one of the existing <step> elements and paste it into
the <steps> block. The order of the vertical tabs reflects the order of the steps in the <steps> element block, so copy it before
and after the steps you want it to be displayed between on the page.





           
        2.  Change the content of the copied <step> element:


           
            


             
          •  Change the tab title by adding your title text directly to the element in place of the jsp.start.step1.tab.title key or by specifying
a key that you define in a corresponding resource bundle that you
also define. For example, the title of the first tab is Welcome. It is defined by the jsp.start.step1.tab.title key that is stored in
the com.ibm.lconn.homepage.resources.nls.jsp.jsp_resources resource
bundle. It is specified in the title element for that step in the configuration file. The bundle attribute identifies where the resource
bundle is stored and the title element itself contains the key value
for the title string. 


            <title bundle="com.ibm.lconn.homepage.resources.nls.jsp.jsp_resources">
  jsp.start.step1.tab.title
</title>
            






             
          •  Define what should be displayed in the tab body using the <body-links>
element. The <body-links> element must reference a web page that
can be accessed over http and https. The page must be in the same
domain as the Home page, for example an HTML page on the HTTP server
of the IBM Connections deployment.


             
              


               
            •  To specify the page, provide its web address as the value of the secure and unsecure attributes. For example:


              <step enabled="true">
  ...
  <body-links
   secure="https://w3.example.com/peoplepages/myProfile.wss"
   unsecure="http://w3.example.com/peoplepages/myProfile.wss" />
</step>
              



            



          






           
        3.  To change what is displayed in a tab, edit the title and content
of the page. See the previous bullet for details.


        



      






       
    6.  Save and close the gettingstarted-config.xml file.





       
    7.  Run the following command to check the configuration files
back in. You must check the files back in during the same wsadmin
session in which you checked them out for the changes to take effect. 


      HomepageCellConfig.checkInGetstartedConfig("working_directory",
 "cell_name")
      

      ...where the working_directory and cell_name parameters
contain the same values you specified for the checkout location.





       
    8.  Update the version stamp property to force a refresh of
your users' web browsers, so that they will see the changes you made
to the Get Started view the next time they
access the product. See Required post-customization step.


    



    Related
    

  •   Administer the Home page using the wsadmin client


    

  •  Forcing the Get Started view to be the default Home page view


     

  •  Home page administrative commands




    Customize product strings
    





     You can replace a word or phrase in the product user interface
with terminology that better suits your environment.


     


     Notes: 


     
      


       
    •  You cannot use this method to customize the default notification
messages in emails that are sent from IBM Connections applications.
See Customize notifications for information about how
to customize notifications.





       
    •  You cannot use the customization debugging capability to test
edited strings.


    






Many of the product strings in the IBM Connections user interface are represented
by key-value pairs defined in the properties files stored in the application
JAR files. Before you can redefine the value of a string, you must
find out which key is used to represent it. After you have identified
the key-value pair to customize, you can create a properties
file that contains the key-value pairs corresponding to your custom
strings, and copy it into the customizationDir/strings directory.

    


     
      


       
    1.  Find the key that is used to represent the value of the string to customize. For a list of the application properties
files that contain strings you can customize, see Property file
strings.





       
    2.  Create a properties file in which to store the key-value
pair for the custom string. Give the properties file the same name
as the properties file that is used to store that key by the application.
For example, if you copy the templates.properties file,
and paste it into the customizationDir/strings directory,
name it as follows: 


      com.ibm.lconn.core.strings.templates.properties
      





        You must create the file with the full file name; that is, it must not
be a series of directories containing the templates.properties file,
such as, com/ibm/lconn/core/strings/templates.properties.





       Also, specify a language code for the properties file
in the file name. If you do not provide a _language_code value
at the end of the properties file name, the value you specify for
the key in the properties file is used despite the locale of the web
browser accessing the application.





       For example, if you change
the key with the current value of "Help" to "Ayuda" and define it
in a file named com.ibm.lconn.files.strings.ui.properties (without
the _es suffix), then anyone who accesses the product will see Aydua
in place of the Help string even if their browser locale is not set
to es. In some cases, you might want the same value applied to all
languages. If you want to change the term "IBM Connections" to a company name, for example,
then you might store the customized key in a properties file without
the _language_code suffix and the company name
shows as-is to all browsers.





       For a full list of the language
codes supported by IBM Connections,
see Language codes.






       
    3.  Save the properties file that you created in the following directory: 


      customizationDir/strings
      

      ...where customizationDir is
the root directory for customization files. See Determining

      ...where to save your customizations for more details. Unlike
some of the other areas of the product, the strings directory
in the customization root does not have a subdirectory for each application.
Each application uses unique properties file names so all of the strings
that you replace can be stored in this common strings directory.





       
    4.   Use the IBM WebSphere Application Server
Integrated Solutions Console, stop and restart each application EAR
file.





       
    5.  Test your changes by clearing your browser cache, and then
refreshing the browser.





       
    6.  To force all user web browsers to refresh all cached content
and display your changes, run the command that updates the product
version stamp.


       
        


         
      1.  Enter the following command
to access the IBM Connections configuration file: execfile("connectionsConfig.py") 


         If prompted to specify a service to connect
to, type 1 to pick the first node in the list. Most commands can run
on any node. If the command writes or reads information to or from
a file using a local file path, you must pick the node where the file
is stored. This information is not used by the wsadmin client when
you are making configuration changes.






         
      2.  Enter the following command
to check out the IBM Connections configuration files: 


         LCConfigService.checkOutConfig("working_directory","cell_name")





         where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
to separate directories in the file path, even if you are using the Microsoft Windows operating system. 


           AIX and Linux only:
The directory must grant write permissions or the command does not
run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, type the following command while in the wsadmin
command processor:print AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")





           
        •  Microsoft

          Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")


        







         
      3.  Enter the following command to increment
the value of the versionStamp property: LCConfigService.updateConfig("versionStamp","gmt_timestamp") where gmt_timestamp is
the GMT time. You can specify an empty string for the time stamp or
provide a GMT value string. When you specify an empty string, the client calculates the current GMT time and updates the version stamp
with that value. If you choose to provide the time, specify it using
the following format:  yyyyMMdd.HHmmss and specify
the time in GMT.  It is best to provide an empty string and let the client format the time stamp. For example: LCConfigService.updateConfig("versionStamp","").





         
      4.  After making changes,
you must
check the configuration files back in and you must do so during the same wsadmin session in which you checked them out for the changes
to take effect. See Applying common configuration property changes for
information about how to save and apply your changes.


      



    


     
    Related tasks
    

  •  Add labels to media gallery fields


     

  •   Work with CMIS API object types




     Create forums
    

    


     Start a new forum when you want to get the answer to a
specific question or get a discussion going about a particular topic.
Anyone can create a forum, but you must be logged in to do so.


     Forums created in the Forums application are public by default.
Any user in your organization with access to the Forums application
can view and contribute to public forums. To create a forum with restricted
access, create the forum inside a community with restricted
access. For more information, see Add forums to a community.


     When
you create a forum, you automatically become the owner of that forum.
You also become the forum moderator, if content moderation is enabled
in your deployment.





Forums are an effective way to get a discussion going among
a group of people who share a particular area of interest or expertise.
Forums can be stand-alone or they can be associated with a community.
To create a stand-alone forum, add it from the Forums application.
Community forums must be added by community owners from the Communities
application. For information about how to create a community forum,
see Add forums to a community. After they are created,
stand-alone forums cannot be converted into community forums, and
community forums cannot be converted into stand-alone forums.


     Before
you create a forum, it's a good idea to browse the existing forums
in your organization first. You might find that someone has already
asked the question to post, or there might already be
a discussion underway about the topic that interests you. Use the Public
Forums page that lists the forums in your organization.


    


     To create a stand-alone forum, complete the following steps.


     
      


       
    1.  From the Public Forums page, click Start
a Forum. You can also create a forum from the Forums tab
on the My Forums page.





       
    2.  Required: Enter a name for the forum in the Name field.





       
    3.  To categorize the forum and make it easier to find, enter
one or more tags in the Tags field.





       
    4.  Enter a description for the forum in the Description field,
and then click Save.


    

     
    What to do next
    Click Start a Topic to start adding
topics to your new forum. If you do not want to create topics now,
you can access the forum later from the My Forums page.




    Add additional owners to a forum
    

    


     If you are the Forums administrator or a forum owner, you
can add additional owners to a forum to share the responsibilities
of forum ownership.




When you create a forum, you automatically become the forum
owner. You can add additional owners to a forum after creating it.

    


     To add additional owners to a forum, complete the following steps.


     
      


       
    1.  From the Forums tab on the My
Forums page, open the forum to which you want to add new
owners.





       
    2.  Click Add Owners.





       
    3.  Enter the names of the people who you want to add as owners
in the field provided. 


       As you enter names, the type-ahead
tool predicts the name you are typing by comparing it to names in
your company directory. If it proposes the name that you want, click
to add it. If you do not see the name you want listed, click Person
not listed? Use full search to search the company directory.






       
    4.  Click OK to add the new owners.


    

     
    Results
    The new owners are now listed in the Owner area.

     
    What to do next
    If you need to remove owners from the forum at a later time,
for example, if a forum owner leaves the organization, you can remove
them from the forum ownership by clicking the  icon
next to their name in the Owner area.




    Add forum topics
    

    


     Start a discussion with the people in your organization
by creating a forum topic. Anyone who can access Forums can view the new topic.

    


     To add a topic to a forum.


     
      


       
    1.  From the My Forums or Public
Forums page, open the forum to which you want to add the topic.





       
    2.  Click Start a Topic.





       
    3.  Enter the title of the discussion topic in the Title field.





       
    4.  To flag your topic as a question, select Mark
this topic as a question.





       
    5.  To tag the topic, enter one or more tags in the Tags field. Tags are keywords that you define to help users identify what
a topic is all about. Tags must be a single word or multiple words
connected with underscores or hyphens.





       
    6.  Enter your topic content in the rich text field provided.
Be as descriptive as possible. Remember to start a discussion,
so include relevant information to interest other people and get them
involved.





       
    7.  To attach a file to your message, click Attach
a File, click Browse to select
the location of the file, and then click OK.





       
    8.  Click Save to save your topic.


    

     
    Results
    If forum topics are moderated in your deployment, the topic
does not display immediately. The forum moderator must approve the topic content first. If content moderation is not enabled, the topic
displays immediately.




    Answering questions in a forum
    

    


     Share your expertise by answering questions posted to the forums that you are interested in. You can also post answers to questions
that you add yourself when you want to share information with other
users in a question-and-answer format.


     


     Anyone can answer a question posted to
a stand-alone forum. To answer a question posted to a community forum,
you must be a community member.





Unanswered questions in a forum are flagged with a question
mark icon , making it easy for forum members to identify them.


     When
you answer a question in a forum, the person who posted the question
receives a notification containing your answer. They can then choose
whether to accept or reject your answer. If they accept your answer,
the question is marked as answered in the user interface, and the question is flagged with a green tick  to indicate that it has been answered correctly.
A question can have multiple correct answers.


    


     To answer a question in a forum, complete the following steps.


     
      


       
    1.  Open the forum containing the question to
answer, and select the relevant question.





       
    2.  Click Reply.





       
    3.  Enter your answer in the rich text field provided.





       
    4.  Optional: To attach a file to your answer,
click Attach a File, click Browse to
select the location of the file, and then click OK.





       
    5.  Click Save to post your answer.


    




     Delete forums
    

    


     You can delete forums when they are no longer being actively
used and you want to remove them permanently.


     You must be the forum owner or an administrator to delete
a stand-alone forum. To delete a community forum, you must be a community
owner or an administrator.




If you find that a forum is no longer in use, you might want
to delete it. Deleting a forum removes it permanently from the Forums
application.


     When you want to prevent users from contributing to
a forum, but you still want them to be able to view the existing content
in that forum, consider locking the forum instead of deleting it.
For more information about how to lock a forum, see Locking
and unlocking forums.


    


     To delete a forum.


     
      


       
    1.  Open the forum to delete.





       
    2.  Select More Actions > Delete Forum.





       
    3.  Click Delete to confirm that you
want to delete the forum.


    




     Delete forum topics
    

    


     Ensure that the content of your forum is meaningful and
useful by deleting topics that are irrelevant or that contain inappropriate
content.


     The owner of a stand-alone forum can delete any topic in that
forum. Other users can only delete topics that they have created themselves
and only when these topics do not have responses. The Forums administrator can delete any topic in any forum.


     Community owners can delete any
topic in a community forum. Community members can only delete topics
that they created themselves, and only when those topics do not have
responses from other members.





 Delete a topic removes the topic from the forum completely,
including any replies to that topic.

    


     To delete a forum topic.


     
      


       
    1.  Open the topic to delete.





       
    2.  Click Delete under the topic.





       
    3.  Click Delete again to confirm that
you want to delete the topic.


    




     Delete responses to forum topics
    

    


     If you change your mind about a response that you've posted
to a forum topic, you can delete it from the discussion thread.


     Anyone who has posted a response to a topic in a stand-alone
forum can delete that response. Forum owners can delete any topic
response in the forums that they own, and the Forums administrator can delete any topic response in any forum.


     To delete a response
to a community forum topic, you must be the community owner or the person who added the response.





 Delete the response to a discussion topic deletes the content
of the response only. A placeholder for the entry is still visible
in the forum, but the entry is marked as deleted.


     When deleting
a topic response, you have the option of entering a reason for deleting
the topic. This reason is displayed in the entry placeholder
when the response is deleted.


    


     To delete a response to a discussion topic, complete
the following steps.


     
      


       
    1.  Open the topic thread containing the response that you
want to delete.





       
    2.  Click Delete under your response.





       
    3.  Optional: Enter a reason for deleting the response. This reason is displayed in the entry placeholder
when the response is deleted.





       
    4.  Click Delete.


    




    Making web pages into forum topics
    

    


     You can install a browser toolbar button that creates a
forum topic from whatever web page you are currently viewing.

    


     
      


       
    1.  Open the Forums application and click the Bookmark
or Discuss This link at the bottom of the page. 


        You can also add an Add Bookmark browser button,
which will allow you to add a bookmark to the web page. For more information
on the Add Bookmark button, see the Bookmarks
help.






       
    2.  Follow the instructions for installing the Discuss
This button.





       
    3.  Visit a web page to post as a forum topic,
and click the Discuss This toolbar button.





       
    4.  Find a forum to add the web page to, and make any edits
you want:


       
        


         
      1.  In the Forums field, narrow the scope to public forums, or forums you own, are a member of, or are
following.





         
      2.  In the Forum name field, start
typing a name to find the forum you want.





         
      3.  Edit the title of the new topic, add any comments, and
edit the content if you want.





         
      4.  Select Pin this to pin the topic
so it displays at the top of the list of topics in the forum.


      






       
    5.  Click Save.


    

     
    Results
    


     The new topic is posted to the forum you selected.


     
    What to do next
    


     If you see a Discuss This link
in forum topics (as opposed to the Bookmark or Discuss
This link at the bottom of the page), that allows you
to post the current topic as a new topic in a different forum.





     Download attachments so you can view them locally
    

    


     You can download the attachments that you and other people
add to forum posts to your local computer.


     


     Anyone can download the files that are
posted to a stand-alone forum or a public community forum.





Add an attachment can be a good way to share information
with other people in a discussion or to include supplemental data
that is too long to cover in the body of a post. When you have access
to a forum, you can download any of the attachments uploaded to the forum by you or other users.

    


     To download a file attachment, complete the following steps.


     
      


       
    1.  Open the forum topic containing the attachment that you
want to download.





       
    2.  Click the file name and then select whether you want to
save or open the file.


    




     Edit forums
    

    


     Edit a forum to make changes to the forum's name or
description, or to add or remove forum tags.


     


     You must be the Forums administrator or the forum owner to edit a stand-alone forum. To edit a community
forum, you must be a community owner.


    


     To edit a forum.


     
      


       
    1.  Open the forum to edit.





       
    2.  Select More Actions > Edit Forum.





       
    3.  Edit the forum as required, and then click Save.


    




     Edit forum topics
    

    


     Edit a topic to make changes to it after you have added
it to a forum. For example, you might want to update the title of
the topic or attach a file to the topic.


     To edit a topic in a stand-alone forum, you must be the Forums
administrator, the owner of the forum containing the topic, or the person who created the topic. To edit a community forum topic, you
must be the Forums administrator, the topic author, or a community
owner.




 Edit a forum topic does not affect the content of the responses posted in reply to the topic.

    


     To edit a forum topic.


     
      


       
    1.  Open the forum containing the topic to edit,
and then open the relevant topic.





       
    2.  Click Edit under the topic entry.





       
    3.  Edit the topic as required and click Save to
save your changes.


    

     
    Results
    If content moderation is not enabled, your topic is updated
immediately.


     If forum topics are moderated in your deployment, any
edits that you make to your topic must be approved by a moderator
before the updated topic can be displayed. While your changes are
awaiting approval, the topic is temporarily hidden. The topic displays
again after the forum moderator has approved your changes.





    Following forums and forum topics
    

    


     Follow a forum when you want to receive notifications about
the latest updates to the forum. If you are interested in a particular
forum thread, you can also follow forum content at topic level.




When you follow a forum, you receive notifications about
the latest updates to the forum. Following a forum topic is also useful
when you are interested in a specific discussion thread and you want
to keep up-to-date with the progress of that thread.


     Anyone can follow a stand-alone
forum or forum topic.


     Notes: 


     
      


       
    •  When you create a forum, you automatically follow that forum;
you do not need to perform any additional steps to follow the forum.





       
    •  When you are already following a community, you do not need to
follow its forums or forum topics separately; updates about the community
forums are automatically included when you follow the parent community.


    




    To follow forum content, do one of the following.

      


       
    •  To follow a forum:


       
        


         
      1.  Open the forum to follow.





         
      2.  Select Following Actions > Follow this Forum.


         The forum is added to the list of forums that you
are following. To view the complete list, select I'm
Following on the My Forums tab,
and then select Forums.



      






       
    •  To follow a forum topic:


       
        


         
      1.  Open the topic to follow.





         
      2.  Select Following Actions > Follow this Topic.


         The topic is added to the list of topics that you
are following. To view the complete list, select I'm Following on
the My Forums tab and ensure that the Topics tab
is selected.



      



    


     
    What to do next
    


     You can keep track of the forums and
forum topics that you are following from the Home page by selecting News Feed > Forums on the Updates tab. You can
also set email preferences to control how you want to be notified
about the forum content that you are following. For more information,
see Set email notification preferences.





     If
you no longer want to receive notifications about updates to a forum
or forum topic, you can stop following it. To stop following a forum,
open the forum and select Follow > Stop Following this Forum. To stop following a forum topic, open the topic and click Follow > Stop Following this Topic.





    Locking forums to prevent users from adding topics or responses
    

    


     You can lock forums to prevent users from adding new topics
or posting responses to existing topics.


     


     You must be a forum owner to lock or
unlock a stand-alone forum. Administrators can lock or unlock any
forum. If the forum is in a community, then community owners can also
lock and unlock a forum and its topics.





     Anyone who
has permission to lock a forum can create topics and replies in the forum even when it is locked. This functionality allows forum owners
to make changes to the forum without unlocking it and thus opening
it to the entire community. The forum and its topics remain locked
for all other users.





You might want to lock a forum when you consider the content
in the forum to be resolved or complete. For example, if someone started
the forum to troubleshoot a specific issue and that issue has now
been resolved, then you might consider locking the forum so that no
further changes can be made. When you lock a forum, users can still
view the forum content, but they cannot add any new topics or make
changes to existing content.

    


     To lock a forum.


     
      


       
    1.  Open the forum to lock.





       
    2.  Select More Actions > Lock Forum.


    

     
    Results
    


     The forum is marked as locked in the user interface to
let users know that they cannot contribute to the forum.


     
    What to do next
    You can unlock the forum when you want to allow users to
resume adding topics and posting responses to existing topics. To unlock a forum, open the forum and select More
Actions > Unlock Forum.




    Locking forum topics to prevent users from editing topics or
adding responses
    

    


     Lock a forum topic when you want to prevent people from
editing the topic or posting responses to it.


     


     You must be the Forums administrator or the forum owner to lock or unlock a topic in a stand-alone forum.
You must be a community owner or the Forums administrator to lock
or unlock a topic in a community forum.





If you do not want to lock an entire forum, you can lock
forum content at topic level to prevent people from editing a topic
or posting responses to it. For example, you might want to lock a
forum topic when you consider the topic to be resolved or complete.
When you lock a forum topic, people can still view the topic, but
they cannot post responses to it or make changes to existing content.


     As
the forum owner, you can still edit a locked topic and post replies
to it even though the topic remains locked for everyone else. This functionality gives you greater control over the content of the forum.
For example, if the topic contains inappropriate content, you can
lock the topic, and then update it by deleting or editing certain
replies without having to reopen the topic.


    


     To lock a forum topic.


     
      


       
    1.  Open the topic to lock.





       
    2.  Click Lock Topic.


    

     
    Results
    The topic is marked as locked in the user interface to let
users know that they can no longer contribute to the discussion thread.

     
    What to do next
    If you need to unlock the topic at a later stage, you can
do so by opening the topic and clicking Unlock Topic.




    Flagging forum content as inappropriate
    

    


     If you notice that a forum contains content that might
be considered inappropriate, you can flag the content to alert the forum moderator. Any Forums user can flag forum content as inappropriate.


     You must be logged in to the Forums application to flag forum
content as inappropriate.




When you flag forum content as inappropriate, the forum owner
or a designated moderator can review the flagged content and the reason
given for flagging it, and then determine whether the content should
be removed or the flag should be dismissed.


     The standards that determine
whether forum content is inappropriate depend on your organization's
corporate guidelines. Corporate guidelines typically discourage profanities
and personal attacks, and additional rules might also apply. For example,
information related to product development might not be suitable for
discussion in a public forum. If you are not clear about the guidelines
that apply to forums in your organization, ask your Forums administrator.


    


     To flag a forum entry as inappropriate, complete the following steps.


     
      


       
    1.  Open the forum containing the content to
flag.





       
    2.  Navigate to the content to flag and click Flag
as Inappropriate. You can flag a forum topic
or a response to a forum topic.





       
    3.  Select a category for the issue that you are reporting. 


        This option only displays if the IBM Connections administrator has set up a list
to categorize issues that are of concern to your organization. For example, possible categories might include Inappropriate business
content or Security risk.






       
    4.  Enter your reason for flagging the content in the field
provided, and then click Flag.


    

     
    Results
    The Forums administrator or a designated moderator is notified
that the forum post has been flagged so that they can review its content
and take appropriate action.




     Move forum topics
    

    


     After adding a discussion topic, you can move it to a different
forum if you think it would fit more appropriately into that forum.
When you move a discussion topic from one forum to another forum,
any responses to the topic are also moved to the new forum.


     


     
      


       
    •  To move a topic in a stand-alone forum, you must be the forum
owner. You must also own the forum to which you are planning to move
the topic.





       
    •  To move a topic in a community forum, you must be a community
owner. You can only move the topic to a forum that is in the same
community.


    


    


     To move a forum topic.


     
      


       
    1.  Open the forum topic to move and click Move.





       
    2.  Select the forum to move the topic to, and
then click Move again.


    

     
    Results
    The breadcrumb trail updates to display the forum that you
selected in step 2.




    Pinning forum topics
    

    


     Highlight or prioritize important topics by pinning them.
When you pin a topic, it stays at the top of that forum's topic listing
to ensure that it receives attention from other forum participants.


     You must be the forum owner or the Forums administrator to
pin a topic in a stand-alone forum. You must be a community owner
or the Forums administrator to pin a topic in a community forum.




Pinning a topic ensures that the topic does not become difficult
to find in a large forum that contains many posts. For example, if
you are posting a topic that contains details about an important event,
then you might want to pin the topic so that people can find it easily.
Pinned topics are marked with a thumbtack  icon. 


      When you are pinning
a topic in a community forum and that community contains multiple
forums, the pinned topic does not display at the top of the Topics tab
on the Forums page. You must open the forum from
the Forums tab to see pinned topics listed
at the top of the forum.


    


     To pin a forum topic.


     
      


       
    1.  Open the topic to pin.





       
    2.  Click Pin this Topic under the topic.


    

     
    Results
    If at some point the topic no longer needs to be given priority,
you can restore it to its regular place in the sequence by selecting Unpin
this Topic.




    Posting questions to a forum
    

    


     Posting a question to a forum is a great way to get an
answer from the experts.


     


     Anyone can post a question to a stand-alone
forum. To post a question to a community forum, you must be a community
member.





If you want to know the answer to a specific question, why
not post the question to a relevant forum? As the topic creator, you
can moderate the answers that people provide, and choose whether to
accept or reject them.


      Use a question-and-answer format is also
a useful way to make information available to forum members in an
easy-to-read layout. By creating question-and-answer threads, forum
members can build up a useful repository of information for users
who are new to a subject and share the same questions.





     When
posting a question to a forum, all you need to do is create a regular
topic, but you need to be sure to mark the topic as a question. When
you mark a topic as a question, the topic is marked with a question
mark icon  in the user interface, making it easy for forum
users to identify which topics in the forum are questions.


    


     To post a question to a forum, complete the following steps.


     
      


       
    1.  Open the forum where you want to post your question.





       
    2.  Click Start a Topic.





       
    3.  Enter a topic title in the Title field.





       
    4.  Required: Select Mark this topic
as a question.





       
    5.  To tag the topic, enter one or more tags in the Tags field.





       
    6.  Enter your question in the rich text field provided.





       
    7.  To attach a file to your question, click Attach
a File and browse for a file.





       
    8.  Click Save.


    

     
    Results
    If forum topics are moderated in your deployment,
the topic does not display immediately. The forum moderator must approve
the topic content first. If content moderation is not enabled, the topic displays immediately.

     
    What to do next
    You can post an answer to your own question by clicking Add
Your Answer and following the steps described in Answering
questions in a forum. When you post an answer to a question
that you created yourself, the answer is automatically marked as an
accepted answer.


     To accept an answer posted by another user, click Accept
this Answer under the answer. The response is marked as
an accepted answer and the icon next to the original question changes
to a green tick . Accepted answers are also highlighted with a green
background, making it easy for you to identify them when the question
has a lot of responses. You can mark multiple replies as accepted
answers. When one reply is marked as an answer, the entire topic is
marked as answered.





     To reject an answer that has already been
marked as accepted, click Decline this Answer under
the response.





     If your question is marked as answered, but you
later find required more information, you can click Reopen
Question under the original post to reopen the question.
The question is marked as open again and users can post answers to
it.





     Search forums
    

    


     Use the search control in the title bar to search for forums
or forum topics that contain a specific word or phrase.


     You can only search the forums that you are a member of and
forums that have public access.

    


     To search Forums for a specific text string, complete
the following steps.


     
      


       
    1.  Set the scope of your search by clicking the Down arrow
next to the Search field in the title bar,
and then selecting one of the following options: 


       
      All Forums
      




       
      Searches for the text string in the titles and descriptions of
all the forums to which you have access, all the topics and topic
responses contained in those forums, category names and descriptions
(if forum categories are enabled), and forum and topic tags.
      




       
      This Forum
      




       
      Searches for the text string in the title and description of the selected forum, the topics and topic replies in the selected forum,
and the tags in the selected forum. 


        You must have a forum already
open to access this option.

      

      






       
    2.  Enter the word or phrase to search for into
the Search field, and then click the search  icon.


    




    Responding to forum topics
    

    


     Join in a discussion by responding to forum topics that
interest you.


     Anyone can respond to a topic in a stand-alone forum, you
just need to have access to the Forums application. You must be a
community member, and be enabled for mail-in capabilities, to respond
to a topic in a community forum. If forum topics are moderated, your response does not display immediately. The forum moderator must approve
its content first. If content moderation is not enabled, then the topic response displays immediately. 







     In addition to responding to forum topics from the Forums
user interface, when you receive an email notification about a new
or updated forum topic, you can also reply to the topic directly from
the mail. Additional considerations when responding to a forum topic
include the following:


     
      


       
    •  You can add attachments to response. Attachments must all comply
with existing file upload constraints, such as file size and file
extension. Embedded images in your reply are processed as attachments.





       
    •  When you reply to an email notification, all previous content
is included as part of the reply. To truncate the previous content
, manually add #end where you want to end the reply
history to end. Content that appears after the #end entry
is ignored.





       
    •  You can reply more than once to an email notification.





       
    •  To reply to emails, certain settings must be selected. Click Sets,
and then click the Email Preferences tab. Make
sure Receive notifications from other people by email and Allow
me to reply to notifications by email are selected. In
the Content that I am following section, make
sure Forums is set to Individual
Emails.


    



    


     To respond to a forum topic.


     
      


       
    1.  Open the topic to which you want to respond. The original topic displays, with a list of the responses to it.





       
    2.  Click Reply under the section of
the thread to which you want to respond.





       
    3.  Optional: To change the title of your response,
click Edit Title and enter a title in the field
provided.





       
    4.  Enter your response in the rich text field provided.





       
    5.  To attach a file to your response, click Attach
a File and browse for a file.





       
    6.  Click Save to save your reply.


    




     Work with attachments
    

    


     You can replace or delete the file attachments that you
add to forum threads.


     


     To edit attachments in a stand-alone
forum, you must be the person who uploaded the attachment, the forum
owner, or the Forums administrator. In a community forum, only the community owner or the person who uploaded an attachment can edit
that attachment.





When you create or respond to a discussion topic, you can
share attachments with other people in the discussion. Add attachments
can be a useful way to include supplemental information that is too
long to cover in the body of your message. To delete or
replace the attachment at a later stage, you can do so by editing
your message. You can also upload additional attachments as needed.

    


     To work with file attachments, follow these steps.


     
      


       
    1.  Open the topic containing the attachment that you want
to work with.





       
    2.  Click Edit under the post that you
want to edit and do one of the following:

        


         
      •  To replace a file with an updated version, click Replace next
to the file, click Browse to locate the file
you want to add instead, and then click OK.





         
      •  To remove a file from the post, click Remove next
to the file.





         
      •  To add another attachment, click Attach a File,
click Browse to select the location of the file, and then click OK.


      






       
    3.  Click Save to save your changes.


    




    Browsing forums
    

    


     Browse the forums in your organization when you want to
look for answers to common problems or share your opinions with others.




Forums are a useful place to brainstorm and collect feedback
about different subjects. The Public Forums page
displays all the public forums in your organization, including any
public community forums. Browse the list of forums to find one that
interests you. The Topics/Messages column allows
you to see how many topics and messages a forum contains, and gives
you an idea of how popular or active the forum is. You can also see
who last updated the forum.

    


     View forums and forum topics by doing the following.


     
      


       
    1.  Open the Public Forums page to see
a list of the public forums in your organization.





       
    2.  When you see a forum that interests you, click the forum
title to open the forum. A list of the topics in the forum
displays. You can see how many replies each topic has, and who last
updated the topic. You can also see who owns the forum in the Owner area
of the page.





       
    3.  Click a topic title to open the topic. A threaded
view of the topic displays, showing the original topic and any responses
to it.


    

     
    What to do next
    When navigating long discussion threads, click the user name
under a response title to display the post to which the user is responding.
This can be the original topic or a topic reply. Clicking the user
name automatically scrolls you up to the post to which the user is
responding, making it easy for you to see which response corresponds
to which forum entry.


     When you start to create and follow forums,
you can use the My Forums page to keep track
of the forums that you are involved in. Use the options available
in the navigation bar to display the forums that you are following,
the community forums that you are a member of, or the forums that
you own.





    Following tags
    

    


     Follow tags that you are interested in so that you can
receive the latest updates for the people or content with those tags.




Following tags is an easy way to get updates about the content
and people that interest you. When you follow a tag, updates are sent
directly to your Home page whenever any public content with the tags
that you are following is added or changed. This includes news updates
from all the applications.

    


     
      


       
    1.  Select I'm Following, and then select Tags from
the Filter By options.





       
    2.  To check the latest updates for a tag that you are already
following, select a tag from the Show list.
The latest updates related to the tag are displayed.





       
    3.  To follow a new tag, click Manage Tags,
enter the tag in the field that displays, and click Add.
Then click Done.





       
    4.  To remove a tag, click Manage Tags,
and click the X icon next to the tag that you
want to remove. Then click Done. 


       Alternatively,
when you are in the I'm Following view, you can
click Stop Following for an entry, and then
click Save.



    




     Use the My Profile widget
    





     Use the My Profile widget to display a snapshot view of
your personal details from Profiles. You can open your profile directly
in Profiles or edit your profile using this widget.

    


     You can work with the My Profile widget in the following ways:

      


       
    •  To access your full profile, click Profile.





       
    •  To edit your profile, click Edit,
make your changes, and click Save.


    




    Selecting a page layout
    

    


     You can change the setup of the My Page view by selecting
a two-column or three-column layout. The widgets automatically resize
to fit the chosen layout.

    


     To change the layout of the My Page view, complete the following steps.


     
      


       
    1.  From the My Page view, click Customize.





       
    2.  Select Change Layout and then select
a layout option.





       
    3.  Click the Close icon to close the Change
Layout panel.


    




     Update your status message from the Home page
    

    


     Update your personal status message from the Home page
to let the people in your network know what you're doing. Updating
your status message from the Home page automatically updates the status
message that displays in your profile.




You can keep the people in your network informed about what
you're doing by regularly updating your personal status message. For example, you might post a message to let people know that you're busy
preparing for a meeting or that you're about to leave the office for
the day. Or you might want to share a link to an interesting website
with the people in your network. When you paste a URL into the status
message field, the URL is automatically converted to a hyperlink.

    


     To update your status message, complete the following steps.


     
      


       
    1.  Click What are you working on right now from
any of the activity stream views.





       
    2.  Enter your status message in the field that displays. The administrator can configure the character limit available
for status updates so the length of the message that you can enter
might vary depending on your deployment.
      Tip: To tag your message with a specific keyword, type the keyword prefixed with a
hash (#) symbol as part of your message. When you save the message,
the keyword is automatically converted to a link. Other users can
click the link to search for status updates tagged with the same keyword.






       
    3.  Optional: Attach a file to your message by
clicking Add a File and choosing one of the following options:

        


         
      •  To attach a file from the Files application, select My
Files, select a file, and then click OK.





         
      •  To attach a file from your local system, select My
Computer, click Browse to select
a file, and then click OK.


      






       
    4.  Click Post. 


        If you decide that you do not want to post the message, click Reset to
cancel the message.



    

     
    What to do next
    You can delete your status messages at any time by hovering
over the message to remove, clicking the X icon,
and then clicking Delete.




     Use the activity stream views
    

    


     Find out what's new in your network and the wider
organization using the activity stream views available from the Home
page.




You can use the different activity stream views available
from the Home page to filter the latest news stories and updates from
across IBM Connections. The updates are displayed in list format, making it easy for you to scan
through the entries and quickly identify the updates that are most
important to you. An icon next to each update identifies which application
the update is associated with.

    


     You can check for the latest news stories and work with
updates in the following ways:

      


       
    •  Use the options available from the navigation sidebar to
filter your updates and display different types of information in
the activity stream. Select one of the following options: 


       
        


         
      •  I'm Following





         
      •  Status Updates





         
      •  Action Required





         
      •  Saved





         
      •  My Notifications





         
      •  Discover


      
For more information about these views, see Home page views.





       
    •  Use the Filter By options to filter
the display to show specific updates.





       
    •  To comment on an update, hover over the update and click Comment.
Enter your comment in the field, and then click Post.





       
    •  To save an update for following up later, hover over the update and click Save this. You can retrieve your saved updates later by selecting Saved from
the navigation sidebar.





       
    •  To stop receiving updates about an item or person, click Stop
following.





       
    •  To access more options for working with an update, hover
over the update and click it. The options that display
depend on the type of update you are looking at. For example, to share
a status update with the people who are following you, click Repost.
To close the window, click the X icon or click
anywhere outside the window.


    

     
    What to do next
    


     What else can I do using the activity stream views?


     
      


       
    •  Click Customize to add widgets and bring
extra functionality to your Home page.





       
    •  Let people know what you're doing by updating your personal
status message. Click What are you working on right now and
enter your status message in the field. If you want to attach a file
to your status, click Add a File to select
the file, and then click Post.





       
    •  Check what community events are taking place soon using the Events
widget. For more information, see Using the Events widget.





       
    •  Keep track of your upcoming to-do items using the To Do List widget.
For more information, see Using the To Do List widget.





       
    •  Check for recommended content in the Recommendations widget. The widget suggests content that might interest you, based on your existing
community membership, network connections, and tags. For more information,
see Using the Recommendations widget on the Home page.





       
    •  Bookmark the page views that you visit most often so that you
can navigate directly to them later.


    






     Use the My Page view
    

    


     Stay current with the latest news stories from your organization
by using widgets to list the most recent updates.




The My Page view lets you access the latest updates from the different applications using widgets, with
each widget listing the updates for a specific application. In addition
to the widgets available from IBM Connections,
you can add third-party widgets if your administrator has made them
available.


     To open the My Page view, select My
Page from the navigation sidebar.


    


     Use the My Page view to access and
work with updates in the following ways.

      


       
    •  To open the content that was updated, click the update
title.





       
    •  To add more widgets to the page, click Customize and
select a widget. You can move widgets to arrange them as best suits
you. For example, if you are interested in updates from some applications
more than others, you can arrange the corresponding widgets to give
them more prominence on the page. For more information about adding
widgets, see Add widgets to your Home page.





       
    •  If you find that you are not using a particular widget,
you can free up space by removing it from the page. For more information
about removing widgets, see Managing Home page widgets.





       
    •  You can change the layout of the My Page view
to specify the number of columns that is displayed. For more information,
see Selecting a page layout.


    




     Use the Activities widget
    





     Use the Activities widget to access a snapshot view of
the latest updates from the Activities application. You can toggle
between widget views to access different information.

    


     You can work with the Activities widget in the following ways:

      


       
    •  To select a widget view, click the Down arrow under the widget title and select one of the following options: 



      Table 124. Activities widget views

      View
    Description




      My Activities
    In this view, the Activities widget displays
the most recent updates for your personal activities.


       Click the links next to the calendar to view the latest updates to your posts
or high priority activities, or to open the Activities application.





       For information about how to use the calendar, see Using the calendar
in the Activities widget.




      Public Activities
    The Public Activities view displays a list of
the most recently updated public activities.


       Click the title of
an activity that interests you to open the update in Activities.




      







       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the period of time for which you want to display
recent entries for your activities.





         
      3.  Select the number of public activities to display in
the widget.





         
      4.  Click Save.


      



    




     Use the Blogs widget
    





     Use the Blogs widget to view the latest updates from the Blogs application.




The Blogs widget displays information about the most recent
blog entries in your organization, in order of the most recently published
entry. You can see how many people liked a blog entry or commented
on it.

    


     You can work with the Blogs widget in the following ways:

      


       
    •  To view a blog update, click the blog title to open the update in the Blogs application. Alternatively, click Details to
open the blog entry in a pop-up window.





       
    •  If no blog entries have been created yet, click Go
to your Blogs page to open the Blogs application and create
a new blog or start adding blog entries.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Use the Bookmarks widget
    





     Use the Bookmarks widget to stay current with the latest
bookmarks added to Bookmarks.




The Bookmarks widget lets you access the latest updates from
the Bookmarks application. Toggle between widget views to access different
information. You can edit your own bookmarks from any of the Bookmarks
widget views. You can also use the widget to copy other people's bookmarks
into your personal bookmark list.

    


     You can work with the Bookmarks widget in the following ways:

      


       
    •  To change to a different view, click the Down arrow under
the widget title and select one of the following options: 



      Table 125. Bookmarks widget views

      View
    Description




      My Bookmarks
    In this view, the Bookmarks widget displays
the most recent updates you've entered in Bookmarks. You can also
edit your bookmarks from this view.



      Popular Bookmarks
    The Popular Bookmarks view displays a list of
all the public bookmarks shared in Bookmarks, in order of most popular.
You can edit your own links from this view and copy bookmarks to your personal bookmarks list.



      My Watchlist
    The Bookmarks application allows you to add
people and tags to a watchlist. Any public bookmarks that are created
by people on the list or that match watched tags are displayed in
the My Watchlist view in the Bookmarks widget. You can edit your own
links from this view and copy bookmarks to your personal bookmarks
list.



      Recent Bookmarks
    The Recent Bookmarks view displays a list of
the most recent public bookmarks added in the Bookmarks application.
This view also provides links for you to edit your own bookmarks and
copy other people's bookmarks to your personal bookmark list.



      







       
    •  To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively,
click Details to open the bookmark in a pop-up
window.





       
    •  To edit one of your bookmarks:


       
        


         
      1.  Click Details under the bookmark
you want to edit.





         
      2.  Click Edit this bookmark.





         
      3.  Make your changes, and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  To copy a bookmark:


       
        


         
      1.  Click Details under the bookmark
you want to copy.





         
      2.  Click Add to my bookmarks.





         
      3.  Complete the Add Bookmark form,
and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  To configure display settings for
the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display
in the widget, and then click Save.


      



    




     Use the Communities widget
    





     Use the Communities widget to access the latest updates
to communities.




The Communities widget displays information about the most
recent entries to communities in the Communities application. The widget contains links to the feeds, bookmarks, and forum topics associated
with a community. Depending on the view you select, you can see updates
for public communities or communities of which you are a member. The list is ordered by the most recently published entry.

    


     You can work with the Communities widget in the following ways:

      


       
    •  To change views, click the Down arrow under the widget
title and select one of the following options: 



      Table 126. Communities
views

      View
    Description




      My Communities
    In this view, the Communities widget displays
the most recently updated communities to which you belong.



      Public Communities
    The Public Communities view displays the public
communities that have been updated most recently.



      







       
    •  To view a community update, click a community title. The update opens in the Communities application.





       
    •  If no communities display, click the link provided to open
the Communities application and create a new community or join existing
communities.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Use the Events widget
    





     Use the Events widget to keep track of upcoming community
events from your Home page. The widget displays in the activity stream
views by default.




The Events widget lists the community events that you are
following and the events that you are planning to attend. You can
access details about the events directly from the widget.

    


     You can work with the Events widget in the following ways:

      


       
    •  Click an event title to view more details about the event
in the Communities application. From the Calendar page,
you can see which community the event is associated with and access
more options for working with the event.





       
    •  Click Add to Personal Calendar to
add a feed from the widget to your personal calendar. 


        Your
email application must support iCal or iCalendar feeds for this functionality
to be available.






       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of events to display
in the widget.





         
      3.  Select the type of information to display,
and then click Save. 


         There are
three options:


         
          


           
        •  All followed or attending events. Select this option to display the events that you are attending and following.
This is the default option.





           
        •  Attending events. Select this option to
display only the event instances that you are attending.





           
        •  Followed events. Select this option to
display only the event instances that you are following.


        




      



    




     Use the Latest Wikis widget
    





     Use the Latest Wikis widget to display a list of wikis
that have been updated recently.




The Latest Wikis widget allows you to keep current with the latest updates to public wikis. Browsing the widget entries is a useful
way of finding wikis with recent activity. You can see who last updated
a wiki and when they made the update.

    


     You can work with the Latest Wikis widget in the following ways:

      


       
    •  To navigate to a wiki to get more information about an
update, click the wiki title to open the wiki in the Wikis application.
Close the window to return to the Home page.





       
    •  If there are no wiki entries to display, click Go
to your Wiki page to open the Wikis application and start
a wiki or access other options for working with existing wikis.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Use the My Activities widget
    





     Use the My Activities widget to view the latest updates
from your activities.




You can use the My Activities widget to get information about
the latest updates to your activities. This includes responses to
your activity entries and new entries in your high priority activities.

    


     You can work with the My Activities widget in the following ways:

      


       
    •  To view responses to your activity entries, click number
of new responses to your posts.





       
    •  To view recent entries in your high priority activities,
click View new entries in your high priority activities.





       
    •  To view a list of your recent activity updates, click My
Activities.





       
    •  To use the calendar to view the tasks associated with a
specific deadline, click a highlighted date in the calendar. For more information about how to use the calendar, see Using the calendar in the My Activities widget.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the period of time for which you want to display
recent entries for your activities, and then click Save.


      



    




     Use the My Bookmarks widget
    





     Use the My Bookmarks widget to display the most recent
updates you entered in the Bookmarks application. You can also edit
your bookmarks from this view.

    


     You can work with the My Bookmarks widget in the following ways:

      


       
    •  To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively,
click Details to open the bookmark in a pop-up
window.





       
    •  To edit one of your bookmarks:


       
        


         
      1.  Click Details under the bookmark
you want to edit.





         
      2.  Click Edit this bookmark.





         
      3.  Make your changes, and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  If you have not yet added any bookmarks, click Go
to your bookmarks page to open Bookmarks and start adding
your own bookmarks.





       
    •  To configure display settings for
the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display
in the widget, and then click Save.


      



    




     Use the My Communities widget
    





     Use the My Communities widget to retrieve the latest updates
for the communities of which you are a member.




The My Communities widget displays information about your communities that have been recently updated. You can view who last
updated the community and when. The widget also contains links to
the feeds, bookmarks, and forum topics associated with each community.
The list is ordered by the most recently updated community.

    


     You can work with the My Communities widget in the following ways:

      


       
    •  To view a recently updated community, click the community
title. The community opens in the Communities application, where you
can view a summary of the latest updates on the Overview page.





       
    •  If no communities display, click Go to your Communities page to open the Communities application and
create a new community or join existing communities.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Use the My Files widget
    





     Use the My Files widget to see a list of the files that
you have added or updated most recently in Files. You can also use
the widget to upload new files to the Files application.

    


     You can work with the My Files widget in the following ways:

      


       
    •  To view the most recent updates to your files, click a
file name to open the update in the Files application.





       
    •  To upload a file to Files, click Upload,
click Upload Files, and then complete the form
that displays.





       
    •  If there are no entries to display, click Go
to Files to open the Files application and start uploading
files.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Use the My Network widget
    





     Use the My Network widget to stay current with your colleagues
and add new connections to your network.




The My Network widget displays a summary of the latest updates
that people in your network have made in the Activities, Blogs, and
Bookmarks applications.

    


     You can work with the My Network widget in the following ways:

      


       
    •  To display a list of the updates that a person has made
in Activities, Blogs, or Bookmarks, click one of the application links
under the person's name. Click an update title to open the full update.





       
    •  If you do not have any network connections yet, click Go
to your profile to open the Profiles application and search
for useful network contacts.





       
    •  To process new network requests, click the network requests
link. If you do not see a network requests link, this means that you
do not have any pending network requests.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the period of time for which you want to display
the latest entries from your network.





         
      3.  Select the number of people to display
in the widget.





         
      4.  Click Save.


      



    




     Use the My Watchlist widget
    





     Use the My Watchlist widget to monitor the most recent
bookmarks added to your watchlist. You can edit your own links from
this view and copy bookmarks to your personal bookmarks list.




The Bookmarks application allows you to add people and tags
to a watchlist. Any public bookmarks that are created by people on
the list or that match watched tags are displayed in the My Watchlist
widget in the My Page view. You can edit your own links from this view and copy bookmarks to your personal bookmarks
list.

    


     You can work with the My Watchlist widget in the following ways:

      


       
    •  To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively,
click Details to open the bookmark in a pop-up
window.





       
    •  To edit one of your bookmarks:


       
        


         
      1.  Click Details under the bookmark
you want to edit.





         
      2.  Click Edit this bookmark.





         
      3.  Make your changes, and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  To copy a bookmark:


       
        


         
      1.  Click Details under the bookmark
you want to copy.





         
      2.  Click Add to my bookmarks.





         
      3.  Complete the Add Bookmark form,
and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  To configure display settings for
the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display
in the widget, and then click Save.


      



    




     Use the My Wikis widget
    





     Use the My Wikis widget to help you track the latest updates
to the wikis of which you are a member.




The My Wikis widget displays a list of the wikis that you
are a member of, in order of the most recently-updated wiki. The widget
lists the wikis by title, and provides information about who last
updated the wiki and when they made the update.

    


     You can work with the My Wikis widget in the following ways:

      


       
    •  To navigate to a wiki to get more information about an
update, click the wiki title to open the wiki in the Wikis application.
Close the window to return to the Home page.





       
    •  If there are no wiki entries to display, click Go
to your Wiki page to open the Wikis application and start
a wiki or access other options for working with existing wikis.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Use the Popular Bookmarks widget
    





     Use the Popular Bookmarks widget to display a list of all
the public bookmarks shared in the Bookmarks application, in order
of most popular. You can edit your own links from this view and copy
bookmarks to your personal bookmarks list.

    


     You can work with the Popular Bookmarks widget in the following ways:

      


       
    •  To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively,
click Details to open the bookmark in a pop-up
window.





       
    •  To edit one of your bookmarks:


       
        


         
      1.  Click Details under the bookmark
you want to edit.





         
      2.  Click Edit this bookmark.





         
      3.  Make your changes, and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  To copy a bookmark:


       
        


         
      1.  Click Details under the bookmark
you want to copy.





         
      2.  Click Add to my bookmarks.





         
      3.  Complete the Add Bookmark form,
and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  To configure display settings for
the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display
in the widget, and then click Save.


      



    




     Use the Popular Wikis widget
    





     Use the Popular Wikis widget to see a list of popular wikis
that have been updated recently.




The Popular Wikis widget displays a list of the wikis that
receive the greatest number of visits, in order of the most recently-updated
wiki. The widget lists the wikis by title, and provides information
about who last updated the wiki and when they made the update.

    


     You can work with the Popular Wikis widget in the following ways:

      


       
    •  To navigate to a wiki to get more information about an
update, click the wiki title to open the wiki in the Wikis application.
Close the window to return to the Home page.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Use the Profiles widget
    





     Use the Profiles widget to view the latest updates for
the people in your network. You can also access and edit your profile
directly from the widget.

    


     You can work with the Profiles widget in the following ways:

      


       
    •  To change to a different view, click the Down arrow under
the widget title and select one of the following options: 



      Table 127. Profiles widget views

      View
    Description




      My Profile
    In this view, the Profiles widget displays a
snapshot view of your personal details from Profiles. You can open
your profile directly in Profiles or edit your profile from this view.



      My Network
    The My Network view displays recent activity
and updates for the people in your network. This might include new
activity entries and blog entries that they have created, and new
bookmarks that they have added in the Bookmarks application. You can
also check if you have any pending colleague requests from this view.



      







       
    •  To access your full profile, click Profile from
the My Profile view.





       
    •  To edit your profile, click Edit from
the My Profiles view, make your changes, and click Save.





       
    •  To view the latest updates for people in your network,
select the My Network view.  This view also lets you see
how many updates your colleagues have made lately in Activities, Blogs,
and Bookmarks.





       
    •  To process new network requests, click the network requests
link. If you do not see a network requests link, this means that you
have no pending network requests.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the period of time for which you want to display
the latest entries from your network.





         
      3.  Select the number of people to display
in the widget.





         
      4.  Click Save.


      



    




     Use the Public Activities widget
    





     Use the Public Activities widget to view the latest updates
from public activities.

    


     You can work with the Public Activities widget in the following ways:

      


       
    •  To view an update to a public activity, click the title
of an activity that interests you to open the update in Activities. Close the window to return to the Home page.





       
    •  If no activities have been created yet, click Go
to your Activities page to open the Activities application. From there, you can click My Activities to
start creating activities and assigning to-do items.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of public activities to display in
the widget and click Save.


      



    




     Use the Public Communities widget
    





     Use the Public Communities widget to view a list of the most recently updated communities.




The Public Communities widget displays information about
the public communities that have been most recently updated. You can
see who last updated the community and when. The widget also contains
links to the feeds, bookmarks, and forum topics associated with the community. The list is ordered by the most recently updated community.

    


     You can work with the Public Communities widget in the following ways:

      


       
    •  To view a recently updated community, click the community
title. The community opens in the Communities application, where you
can view a summary of the most recent updates on the Overview page.





       
    •  If no communities display, click the link provided to open
the Communities application and create a new community.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Use the Recent Bookmarks widget
    





     Use the Recent Bookmarks widget to display a list of the most recent public bookmarks added in the Bookmarks application. The widget also provides links for you to edit your own bookmarks and
copy other people's bookmarks to your personal bookmark list.

    


     You can work with the Recent Bookmarks widget in the following ways:

      


       
    •  To view a bookmark update, click the bookmark title to open the bookmark directly in Bookmarks. Alternatively,
click Details to open the bookmark in a pop-up
window.





       
    •  To edit one of your bookmarks:


       
        


         
      1.  Click Details under the bookmark
you want to edit.





         
      2.  Click Edit this bookmark.





         
      3.  Make your changes, and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  To copy a bookmark:


       
        


         
      1.  Click Details under the bookmark
you want to copy.





         
      2.  Click Add to my bookmarks.





         
      3.  Complete the Add Bookmark form,
and then click Save.





         
      4.  Click Close to return to the Home page.


      






       
    •  To configure display settings for
the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display
in the widget, and then click Save.


      



    




     Use the Recommendations widget on the Home page
    

    


     Use the Recommendations widget to find content from the different applications that might interest you. The widget displays
in the side column of the activity stream views.




The Recommendations widget suggests content that might interest
you based on your existing community membership, network connections,
tags, and so on. The widget displays a randomized list of public and
private content that has been recently added or updated in the different
applications. The recommendations made are based on your relationship
with existing public and private content in IBM Connections. An icon next to each recommended
item identifies which application the content is associated with.
The widget displays 15 recommendations by default.



    Table 128. Application icons

    Icon
    Application




    
    Activities



    
    Blogs



    
    Bookmarks



    
    Communities



    
    Files


      The icon shown here represents just
one file type. The icon next to a recommended file from the Files
application changes depending on the type of file. For more information,
see File type icons.




    
    Forums



    
    Wikis



    






     The Recommendations widget also provides information about
the ways in which you are already connected to the content listed.
For example, you can click the related tags link to see what tags
you have in common with the suggested content. The tags that are displayed
are tags that are associated with the recommended content and also
associated with you in some way. You might have assigned the tags
to content or to your profile for instance.





     The Recommendations
widget only recommends content, it does not recommend people. Use
the Do You Know widget on the My Network page
in Profiles when you want to get suggestions for people to add to
your network.


    


     Use the Recommendations widget in the following ways.

      


       
    •  If an item interests you, click the title to open the item
and take a closer look.





       
    •  Click the links under the items listed to
find out more about how you are connected to that item. You can view related tags or related people to find out what you have
in common with the recommended content.





       
    •  Use the Previous and Next links
to page through the recommendations and display more options.





       
    •  To remove an item from the list of recommendations,
click the  icon
next to the item.


    




     Use the Files Shared with Me widget
    





     Use the Files Shared with Me widget to display a list of
the latest files that people have shared with you. You can also use
the widget to upload new files to the Files application.




The Files Shared with Me widget lets you keep track of the files that other people have shared with you.

    


     You can work with the Files Shared with Me widget in
the following ways:

      


       
    •  To view the latest files shared with you, click a file
name to open the update in the Files application.





       
    •  To upload a file to Files, click Upload,
click Upload Files, and then complete the form
that displays.





       
    •  If no files have been shared with you yet, click Go
to Files to open the Files application and access other
options for working with files.





       
    •  To configure display settings for the widget:


       
        


         
      1.  Click the Actions icon  in the widget
title bar and select Edit.





         
      2.  Select the number of entries to display in the widget
and click Save.


      



    




     Install IBM Connections 4.0
    





     Install IBM Connections.


    


     Ensure
that you complete all the prerequisite tasks that are relevant for
your environment. For more information, see the Before installing topic.








     To install IBM Connections,
run the IBM Installation Manager
 wizard on the system where the Deployment Manager is installed.





     If an error occurs during installation, IBM Installation Manager cancels the installation and rolls back the installation files. Installation errors are usually
caused by environment problems such as insufficient disk space, privilege
issues, or corruption of a WebSphere profile. If your installation is canceled, complete
the following steps:


     
      


       
    1.  Identify and resolve the error that caused the cancellation. After
canceling the installation, IBM Installation Manager displays an error message with an error code.
You can look up the error code in the Installation error messages topic or check the log files.





       
    2.  Restore the Deployment Manager profile from your backup.





       
    3.  Delete the connections_root directory.





       
    4.  Start this task again.


    






     To install IBM Connections,
complete the following steps:


    


     
      


       
    1.  On each
node, stop any running instances of WebSphere Application Server and WebSphere node agents. 





       
    2.  Start WebSphere Application Server
Network Deployment Manager.





       
    3.  Copy
the installation files to the system hosting the Deployment Manager. 


        Ensure that the directory path that you enter contains
no spaces.






       
    4.  From the Connections setup directory, run the file to start
the IBM Connections launchpad:

        


         
      •  AIX or Linux: Connections set-up/launchpad.sh





         
      •  Windows: Connections set-up\launchpad.exe 


      
 


        The launchpad needs a web browser to run. If your system
does not have a web browser, take one of the following actions:


       
        


         
      •  Install a web browser.





         
      •  Install IBM Connections in silent mode. For more information, see the Installing silently topic.





         
      •  Start IBM Installation Manager
manually:


         
          


           
        1.  Open a command prompt.





           
        2.  Change to the Connections_install/IM/OS directory, where OS is your operating
system.





           
        3.  Enter ./install.sh -input response.xml.


        



      







       
    5.  Click Install IBM Connections 4.0 and then click Launch the IBM Connections 4.0 install
wizard. 


        Click the links to Documentation,
Pre-installation tasks, or Post-installation tasks to view the product
documentation. 






       
    6.  In the Select packages to install window, select the packages
to install and click Next to
continue. 


       Notes: 


       
        


         
      •  Accept the default setting for Show all versions.





         
      •  If you are using an earlier version of IBM Installation Manager than 1.4.4, the 1.4.4
package is selected in this window.





         
      •  Click Check for Other Versions and Extensions to search for updates to IBM Installation Manager.


      







       
    7.  Review and accept the license agreement by clicking I accept the terms in the license agreements. Click Next. 





       
    8.  Set the location of shared directories for IBM Installation Manager. 


       
        


         
      1.  Set the location of the Shared Resources
Directory.





         
      2.  Set the location of the Installation
Manager Directory. This option appears only if you have
not previously installed IBM Installation Manager. 





         
      3.  Click Next.


      
 


       Notes: 


       
        


         
      •  The Shared Resources directory stores resources that can be shared
by multiple packages. If you used IBM Installation Manager before, the wizard automatically enters
this value.





         
      •  The Installation Manager directory stores resources that are unique
to the packages that you are installing.


      







       
    9.  Choose to Use the existing package group or Create a new package group.  


        If you are using the wizard for the first time, the Use the existing package group option is not available.






       
    10.  Set the location of the installation directory for IBM Connections. You can accept
the default directory location, enter a new directory name, or click Browse to select an existing directory. Click Next.





       
    11.  Confirm the applications to install and click Next. You can select from the following options:  

        


       
        


         
      •  The wizard always installs the Home page, News, and Search applications.





         
      •  To use media gallery widgets in the Communities application, you must
install the Files application. Media gallery widgets store photo and
video files in the Files database.





         
      •  Even
if you are not configuring Cognos yet, install Metrics now so that
your application data is captured from the moment that IBM Connections is deployed. Metrics captures your deployment data whereas Cognos
is used for viewing data reports. If you install Metrics at a later
stage, you will not have any data reports for the period before you
installed Metrics.


      






      
    

      Option
    Description

      IBM Connections 4.0
    Install all IBM Connections applications.



      Activities
    Collaborate with colleagues.



      Blogs
    Write personal perspectives about projects.



      Communities
    Interact with people on shared projects.



      Bookmarks
    Bookmark important websites.



      Files
    Share files among users.



      Forums
    Discuss projects and exchange information.



      Metrics
    Identify and analyze usage and trends.



      Mobile
    Access IBM Connections from mobile devices.



      Moderation
    Forum and community owners can moderate the content of forums.



      Profiles
    Find people in the organization.



      Wikis
    Create content for your website.


      






       
    12.  Enter the details of your WebSphere Application Server environment: 


       
        


         
      1.  Select the WebSphere Application Server installation location that contains the Deployment Manager.  


         Note the default
path to the WebSphere Application Server installation:


         
          


           
        •  AIX: /usr/IBM/WebSphere/AppServer





           
        •  Linux: /opt/IBM/WebSphere/AppServer





           
        •  Windows: C:\Program
Files\IBM\WebSphere\AppServer


        







         
      2.  Enter the properties of the WebSphere Application Server Deployment Manager (DM):  


         
        Deployment Manager profile
        




         
        Name of the DM to use for IBM Connections. The wizard automatically detects any available DMs.
        

        



         
        Host name
        




         
        Name of the host DM server.
        

        



         
        Administrator ID
        




         
        The administrative ID of the DM.
         This ID is set to
the connectionsAdmin J2C authentication alias, which is mapped to
the following J2EE roles: dsx-admin, widget-admin, and search-admin.
It is also used by the service integration bus. To use
security management software such as Tivoli Access Manager or SiteMinder, the ID that you specify
here must exist in the LDAP directory. For more information, see the Switching to unique administrator IDs for system level communication topic. 

        

        



         
        Administrator Password
        




         
        The password for the administrative ID of the DM.
        

        



         
        SOAP port number
        




         
        The SOAP port number of the DM. The wizard automatically detects
this value.
        

        






         
      3.  Click Validate to verify the DM information that you entered and that application security is enabled
on WebSphere Application Server. If the verification fails, IBM Installation Manager displays an error message. 


          (AIX and Linux) The validation process checks the number
of open files that are supported by your system. If the value for
this parameter, known as the Open File Descriptor limit, is too low,
a file open error, memory allocation failure, or connection establishment
error could occur. If one of these errors occurs, exit the installation wizard and increase the open file limit before restarting the wizard.
To set the file limit, go to the Installation error messages topic and search for error code CLFRP0042E. The recommended value
for IBM Connections is 8192.
For more information about the Open File Descriptor limit, see the documentation for your operating system.






         
      4.  When the verification test is successful, click Next.


      
 The wizard creates a dmInfo.properties file under WebSphere Application Server
to record details of the cell, node, and server.





       
    13.  Configure your topology. For more information about each
option, see the Deployment options topic. 


        


       If
you return to this page from a later page in the installation wizard,
your settings are still present but not visible.  If you want to change
any settings, you must enter all of the information again. If you
do not want to change your initial settings, click Next.



        


         
      •  Small deployment:


         
          


           
        1.  Select the Small deployment topology. 





           
        2.  Enter a Cluster name for the topology. 





           
        3.  Select a Node.





           
        4.  Click Next.


        






         
      •  Medium deployment:


         
          


           
        1.  Select the Medium deployment topology. 





           
        2.  Select the default
value or enter a Cluster name for each application
or for groups of applications. For example, use Cluster1 for Activities,
Communities, and Forums. 
           IBM Installation Manager creates servers and
clusters when required.






           
        3.  Select a Node for each cluster. Accept the predefined node or
select a different node.
           These nodes host
application server instances that serve IBM Connections applications. You can assign multiple nodes
to a cluster, where each node is a server member of that cluster.






           
        4.  Enter a Server member name for the selected node. Choose the default or enter a custom name.


            If you enter a custom server
member name, the name must be unique across all nodes in your deployment.






           
        5.  Click Next.


        






         
      •  Large deployment:


         
          


           
        1.  Select the Large deployment topology. 





           
        2.  Enter a Cluster name for each application. 


            IBM Installation Manager creates servers and
clusters when required.






           
        3.  Select a Node for each cluster. Accept the predefined node or
select a different node.
           These nodes host
application server instances that serve IBM Connections applications. You can assign multiple nodes
to a cluster, where each node is a server member of that cluster.






           
        4.  Enter a Server member name for the selected node. Choose the default or enter a custom name.


            If you enter a custom server
member name, the name must be unique across all nodes in your deployment.






           
        5.  Click Next.


        



      






       
    14.  Enter the database information:  


        


       If
you return to this page from a later page in the installation wizard,
your settings are still present but not visible.  If you want to change
any settings, you must enter all of the information again. If you
do not want to change your initial settings, click Next.




       
        


         
      1.  Specify whether the installed applications use the same
database server or instance: Select Yes or No. 


          If allowed by your database configuration,
you can select multiple database instances as well as different database
servers.






         
      2.  Select a Database type from one of the following options: 


         
          


           
        •  IBM DB2 Universal Database.





           
        •  Oracle Enterprise Edition





           
        •  Microsoft SQL Server Enterprise
Edition


        






         
      3.  Enter the Database server host name. For example: appserver.enterprise.example.com 


         If your installed applications use different database servers, enter the database
host name for each application.






         
      4.  Enter the Port number of the database server. The default values are: 50000 for DB2, 1521 for Oracle, and 1433 for SQL Server. 


         If your installed applications use different database servers or instances,
enter the port number for each database server or instance.






         
      5.  Enter the JDBC driver location. For example: 


         
          


           
        •  AIX:


           /usr/IBM/WebSphere/AppServer/lib






           
        •  Linux:


           /opt/IBM/WebSphere/AppServer/lib






           
        •  Windows:


           C:\IBM\WebSphere\Appserver\lib



        






         
      6.  Ensure
that the following JDBC driver libraries are present in the JDBC directory: 


         
        DB2
        




         
        db2jcc.jar and db2jcc_license_cu.jar


          Ensure that your user account has the necessary permissions
to access the DB2 JDBC files.

        




         
        Oracle
        




         
        ojdbc6.jar
        




         
        SQL Server
        




         
        Download the SQL Server JDBC 2 driver from the Microsoft website to a local directory
and enter that directory name in the JDBC driver library field.


         The directory must not contain the sqljdbc.jar file, only the sqljdbc4.jar file. Even though
the data source is configured to use the sqljdbc4.jar file, an exception occurs if both files are present in the same
directory.





         IBM recommends that you obtain this Microsoft hotfix for the JDBC 2 driver for production deployments.

        

        






         
      7.  Enter the User ID and Password for each database. If each database
uses the same user credentials, select the Use the same
password for all applications check box and then enter
the user ID and password for the first database in the list.
         


         If your database
type is Oracle, connect to the database with the user ID
that you used when you created the application database. 







         
      8.  Click Validate to verify your database settings. If the validation fails, check your database settings.
When the validation succeeds, click Next. 


         IBM Installation Manager tests your database connection with the database values that you supplied. You can change the database configuration later in the WebSphere Application Server Integrated
Solutions Console.



      






       
    15.  Specify your Cognos configuration details as explained in the table, and then click Validate to verify your connection. 
       


       
        


         
      •  The IBM Cognos configuration panel appears only if you chose to install
the Metrics application earlier in this task.





         
      •  Ensure that Cognos Business Intelligence Server is running because
the wizard pings the server during the validation process.





         
      •  If you do not want to deploy Cognos now, enter dummy values for
user ID and password, click Load node info,
and then click Validate. Ignore the error message
that appears. To continue installing IBM Connections, click Next. For information about deploying Cognos, see the Installing Cognos Business Intelligence topic. For information
about resolving Cognos validation problems, see the Troubleshooting
Cognos validation problems topic.


      






      
    

      Option
    Description

      Administrator user ID
    Set the user name of the administrator account that you selected
for Cognos Business Intelligence.
This user must be included in the LDAP directory used with Connections.



      Administrator password
    Set the password for the Cognos administrator.



      Name
    Click the Load node info button to
retrieve the list of available nodes and profiles, then click the arrow and select the WebSphere profile that hosts the Cognos BI server. The profile you select here must match the profile you
specified as the was.profile.name in the cognos-setup.properties file.



      


       Host name

    
      		


       This is a non-editable field that is populated when you
select a profile in the Name field. Seeing
the associated host name for each profile/node can help you choose
the correct node where the Cognos BI Server is running.




      Server name
    There might be multiple servers installed on the same computer
as the Cognos BI server;
click the arrow and select the instance that represents the Cognos server. Must
match what you specified as the cognos.was.server.name in the cognos-setup.properties file.
      Tip: A default value of cognos_server was assigned
in the properties file, so unless you changed that value, use it now.




      Port
    Set the number of the port that the Cognos BI Server is listening on; this defaults
to port 9080 but might have been changed. You can determine the port
by checking the WC_defaulthost value in the following file: WAS_install_root/config/cells/Cell_Name/nodes/Node_Name/serverindex.xml; for example on

      Windows: 


      C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSvr01\config\cells\lc40Cell01\nodes\lc40CellManager01\serverindex.xml
      




      Web context root
    The context root determines which requests will be delegated
to the Cognos application
for processing (any request beginning with this string will be handled
by Cognos). Must
match the cognos.contextroot specified in
the cognos-setup.properties file.
      Tip: A default value of cognos was assigned in the properties
file, so unless you changed that value, use it now.



      
 


       If you deployed Cognos Business Intelligence and the validation fails at this
point, you can click Next and continue installing IBM Connections. After the installation is complete, you can correct the validation issue as explained in
the topic, Troubleshooting Cognos validation problems.






       
    16.  Set the locations of the content stores. All nodes
in a cluster must have read-write access to shared content. Both shared
and local content stores must be accessible using the same path from
all nodes and from the DM. Each content store is represented by a
corresponding WebSphere variable that is further defined as shared or local. Local content
is node-specific. 


        If you are migrating from IBM Connections 3.0.1, you can reuse
your existing content stores in 4.0. For more information, see the Content store migration topic.



       
        


         
      1.  Enter the location of the Shared content store. The shared content store usually resides in a shared repository
that grants read-write access to the DM and all the nodes. Use one
of the following methods to create a shared data directory:


         
          


           
        •  Network-based file shares (for example: NFS, SMB/Samba, and so
on)





           
        •  Storage area network drives (SAN)





           
        •   If you are using a shared-file system on Microsoft Windows, specify the file location using the Universal Naming
Convention (UNC) format. For example: \\server_name\share_name.
           (Windows only) If you use Remote
Desktop Connection to map shared folder drives, ensure that you use
the same session to start the node agents. Otherwise, the shared drives
might be invisible to the nodes.



        






         
      2.  Enter the location of the Local content store.





         
      3.  Click Validate to verify that
the account that you are using to install IBM Connections has write access to the content
store.





         
      4.  Click Next.


      






       
    17.  Select a Notification solution. Notifications are email messages to users
about new information and events in your IBM Connections deployment. 

        


         
      •  Enable Notification only.


         Use notifications but without
the ReplyTo capability.






         
      •  Enable Notification and ReplyTo.


         Use notifications and the ReplyTo capability. To use ReplyTo, your mail server must be able
to receive all the replies and funnel these replies into a single
inbox. IBM Connection connects
to the mail server using the IMAP protocol.






         
      •  None. 


         Do not use a notification solution in your IBM Connections deployment. You can configure notifications after installation.



      






       
    18.  Select and specify a mail server solution and then click Next.

        


         
      •  


         WebSphere Java Mail Session: Use a single mail server
for all notifications. Select this option if you can access an SMTP
server directly using the host name.





         Complete the following fields to identify the mail server to use for sending email:


         
        Host name of SMTP messaging server
        




         
        Enter the host name or IP address of the preferred SMTP mail server.
        




         
        This SMTP server requires authentication
        




         
        Select the check box to force authentication when mail is sent
from this server.
        




         
        User ID
        




         
        If the SMTP server requires authentication, enter the user ID.
        




         
        Password
        




         
        If the SMTP server requires authentication, enter the user password.
        




         
        Encrypt outgoing mail traffic to the SMTP messaging server using
SSL
        




         
        Select this check box if you want to encrypt outgoing mail to
the SMTP server.
        




         
        Port
        




         
        Accept the default port of 25, or enter port 465 if you are using
SSL.
        

        







         
      •  


         DNS MX
Records: Use information from DNS to determine which mail servers
to use. Select this option if you use a Domain Name System (DNS) server
to access the SMTP messaging server.



         
        Messaging domain name
        




         
        Enter the name or IP address of the messaging domain.
        




         
        Choose a specific DNS server
        




         
        Select this check box if you want to specify a unique SMTP server.
        




         
        DNS server for the messaging servers query
        




         
        Enter the host name or IP address of the DNS server.
        




         
        DNS port used for the messaging servers query 
        




         
        Enter the port number that is used for sending queries using the messaging server.
        




         
        This SMTP server requires authentication
        




         
        Select the check box to force authentication when notification
mail is sent from this server.
        




         
        User ID
        




         
        If SMTP authentication is required, enter the administrator user
ID for the SMTP server.
        




         
        Password
        




         
        If SMTP authentication is required, enter the password for the administrator user of the SMTP server.
        




         
        Encrypt outgoing mail traffic to the SMTP messaging server using
SSL
        




         
        Select the check box if you want to use the Secure Sockets Layer
(SSL) when connecting to the SMTP server.
        




         
        Port
        




         
        Set the port number to use for the SMTP server connection.
The default port number for the SMTP protocol is 25. The default port
number for SMTP over SSL is 465.
        

        






         
      •  If you click Do not enable Notification, IBM Installation Manager
skips the rest of this step. You can configure notification later.


      






       
    19.  If you selected the Notification and ReplyTo option, configure
the ReplyTo email settings. IBM Connections uses a unique ReplyTo address to identify both the person
who replied to a notification and the event or item that triggered
the notification. 


       
        


         
      1.  Enter a domain name. For example: mail.example.com. 


          This domain name is used to build the ReplyTo address.
The address consists of the suffix or prefix, a unique key, and the domain name. 






         
      2.  The reply email address is given a unique ID by the system. You can customize
the address by adding a prefix or suffix, using a maximum of 28 characters.
This extra information is useful if the domain name is already in
use for other purposes. Select one of the following options:  


         
        None
        




         
        Use the ID generated by the system.
        




         
        Prefix
        




         
        Enter a prefix in the Example field.
        




         
        Suffix
        




         
        Enter a suffix in the Example field.
        

        





         As you select an option, the wizard creates an example
of the address, combining your selection with the ID generated by
the system.





         For example: 


         
          


           
        •  unique_id@domain





           
        •  prefix_unique_id@domain 





           
        •  unique_id_suffix@domain - 


        







         
      3.  Specify
the details of the mail file to which ReplyTo emails are sent: 


         
        Server
        




         
        The domain where your mail server is located. For example: replyTo.mail.example.com.
        




         
        User ID
        




         
        The user account for the mail server. The user ID and password
are credentials that IBM Connections will use to poll the inbox on the mail server to retrieve the replies
and process the content. IBM Connections connects to the mail server
using IMAP.
        




         
        Password
        




         
        Password for the user account. The user ID and password are credentials
that IBM Connections will use
to poll the inbox on the mail server to retrieve the replies and process
the content. IBM Connections connects to the mail server using IMAP.
        

        






         
      4.  Click Next.


      
 
       You can modify the ReplyTo settings after installation. To edit the domain
name and prefix or suffix, edit the news-config.xml file. For more information, see the Post-migration step for
status updates topic. To edit the server and authentication
details, log in to the WebSphere Application Server Integrated Solutions Console and navigate to
the Mail Sessions page, where you can edit the configuration. 






       
    20.  Review the information that you have entered. To revise
your selections, click Back. To finalize the installation, click Next.





       
    21.  Review the result of the installation. Click Finish to exit the installation wizard.





       
    22.  Restart
the Deployment Manager: 


       
        


         
      •  AIX or Linux: Open a command prompt and change to
the profile_root/Dmgr01/bin directory. Enter the ./stopManager.sh
command and then enter the ./startManager.sh command.





         
      •  Windows: Stop and restart
the Deployment Manager service.


      






       
    23.  Start
all the federated nodes and enter the startNode command. Repeat these steps for each node:


       
        


         
      1.  Log in to a node.





         
      2.  From a command line, change to the profile_root/bin directory.





         
      3.  Enter the startNode command for
your operating system: 


         
          


           
        •  AIX or Linux: ./startNode.sh





           
        •  Windows: startNode.bat


        



      






       
    24.  Log in
to the Integrated Solutions Console on the DM to perform a full synchronization
of all nodes.


       
        


         
      1.  Go to System administration > Nodes.





         
      2.   Select the nodes and click Full Resynchronize.


      
 


        Wait until the DM copies all the application EAR files to the installedApps directory on each of  the nodes. This process can take up to 30
minutes. 


       To verify that the DM has distributed the application
EAR files to the nodes, check the SystemOut.log file of each node agent. The default path to the SystemOut.log file on a node is profile_root/logs/nodeagent.





       Look for a message such as the following example: ADMA7021I: Distribution of application application_name completed successfully. where application_name is the name of an IBM Connections application.







       
    25.  Restart
the Deployment Manager.





       
    26.  Start
all your IBM Connections clusters:


       
        


         
      1.  Log in to the Integrated Solutions Console
on the DM





         
      2.  Go to Servers > Clusters > WebSphere Application server
clusters.





         
      3.  Select the IBM Connections clusters and click Start.


      
 


       Notes: 


       
        


         
      •  If you installed a cluster with multiple Search nodes, you must
create the initial index. For more information about creating the Search index, see the Creating the initial Search index topic.


         
          


           
        1.  If you are installing a non-English language deployment, enable
Search dictionaries. For more information, see the Enabling
Search dictionaries topic.





           
        2.  The index is ready when the INDEX.READY and CRAWLING_VERSION files are present in the index directory.


        






         
      •  If some applications do not start, the file-copying process might
not have completed. Wait a few minutes and start the applications.


      




    


    Results
    


     The installation wizard has installed IBM Connections in a network deployment.





     To confirm that the installation was successful, open the log files in
connections_root/logs. Each IBM Connections application installed
has a log file, using the following naming format: application_nameInstall.log, where application_name is the name of an IBM Connections application. Search for the words error or exception to check whether any errors
or exceptions occurred during installation. 





     To view the log
file for system events that occurred during the installation, open
the date_time.xml file, where date_time represents the date and time of the installation.
The file is located by default in the following directory: 


     
      


       
    •  AIX or Linux (root user): /var/ibm/InstallationManager/logs





       
    •  AIX or Linux (non-root user): /home/user/var/ibm/Installation Manager/logs where user is the non-root user name





       
    •  Windows Server 2008 64-bit: C:\ProgramData\IBM\Installation Manager\logs


    




    What to do next
    


     Complete
the post-installation tasks that are relevant to your installation.
For more information, see the Post-installation tasks topic.





      Access network shares:





     If you installed WebSphere Application Server
on Microsoft Windows and configured it to run as a service,
ensure that you can access network shares. For more information, see
the Accessing Windows network shares topic.





     Manage Home page widgets
    

    


     Use the options available from the widget action menu to
manage widgets in the Updates and My Page views.


     To access the action menu for a widget, click the Actions icon  in the widget
title bar.




You can perform various management tasks for the widgets
in the Updates and My Page views. For example, if you find that you
are no longer using a specific widget, you might want to remove it
to free up some space on the page. Or, if you're using one widget
more than the other widgets, you might want to move it to a more prominent
position on the page.


      The options available from the widget action
menu vary from widget to widget.


    


     To manage widgets as needed.

      


       
    •  To move a widget to a new location, do one of the following:

        


         
      •  Click the widget title bar and drag the widget to a new location.





         
      •  Choose one of the Move options available
from the widget action menu. The options available depend on the current
position of the widget on the page.


      






       
    •  To set the number of entries that the widget displays:


       
        


         
      1.  Select Edit from the widget action
menu.





         
      2.  Select the number of entries to display. The options available depend on the widget that you are editing.





         
      3.  Click Save.


      






       
    •  To view help for the tasks that you can perform using the widget, select Help from the widget action
menu.





       
    •  To reload the widget and display the latest updates, select Refresh from
the widget action menu.





       
    •  To remove the widget, select Remove from
the widget action menu.  Removing the widget returns it
to the content palette. You can add the widget again at any time.


    




     Modify the installation in interactive mode
    





     Modify your deployment of IBM Connections by adding or removing applications.




Use the Modify function of the IBM Installation Manager to add or remove IBM Connections applications.


     To modify your installation:


    


     
      


       
    1.  Open a command prompt and change to the  IM_root directory.





       
    2.  Run the following command: 


       
        


         
      •  AIX or Linux: ./launcher





         
      •  Windows: launcher.exe


      






       
    3.  From the IBM Installation
Manager menu, click File > Preferences.





       
    4.  Click Repositories.





       
    5.  In the Repositories area, select the repositories that
you want to modify.





       
    6.  Click OK to save your selections.





       
    7.  Click Modify.





       
    8.  Select IBM Connections and click Next.





       
    9.  In the Application Selection page, choose the applications
you want to add or remove and then click Next.  

        


         
      •  Add applications: Select the check boxes of any applications
that are not already installed and to add to your deployment.





         
      •  Remove applications: Clear the check boxes of any installed
applications to remove from your deployment. 


      
 


       Notes: 


       
        


         
      •  All installed applications are selected by default.





         
      •  The Home page, News, and Search applications are required and
cannot be removed.


      







       
    10.  Enter the administrative ID and password of the Deployment Manager. 


        This ID is set to
the connectionsAdmin J2C authentication alias, which is mapped to
the following J2EE roles: dsx-admin, widget-admin, and search-admin.
It is also used by the service integration bus. To use
security management software such as Tivoli Access Manager or SiteMinder, the ID that you specify
here must exist in the LDAP directory. For more information, see the Switching to unique administrator IDs for system level communication topic. 






       
    11.  Configure
your topology: 


       Notes: 


       
        


         
      •  The panel described in this step appears only if you selected
new applications to install.





         
      •  If you select an existing cluster on which to deploy applications,
the nodes in that cluster are fixed and cannot be modified.


      



        


         
      •  Small deployment:


         
          


           
        1.  Select the Small deployment topology. 





           
        2.  Enter a Cluster name for the topology. 





           
        3.  Select a Node.





           
        4.  Click Next.


        






         
      •  Medium deployment:


         
          


           
        1.  Select the Medium deployment topology. 





           
        2.  Select the default
value or enter a Cluster name for each application
or for groups of applications. For example, use Cluster1 for Activities,
Communities, and Forums. 
           IBM Installation Manager creates servers and
clusters when required.






           
        3.  Select a Node for each cluster. Accept the predefined node or
select a different node.
           These nodes host
application server instances that serve IBM Connections applications. You can assign multiple nodes
to a cluster, where each node is a server member of that cluster.






           
        4.  Enter a Server member name for the selected node. Choose the default or enter a custom name.


            If you enter a custom server
member name, the name must be unique across all nodes in your deployment.






           
        5.  Click Next.


        






         
      •  Large deployment:


         
          


           
        1.  Select the Large deployment topology. 





           
        2.  Enter a Cluster name for each application. 


            IBM Installation Manager creates servers and
clusters when required.






           
        3.  Select a Node for each cluster. Accept the predefined node or
select a different node.
           These nodes host
application server instances that serve IBM Connections applications. You can assign multiple nodes
to a cluster, where each node is a server member of that cluster.






           
        4.  Enter a Server member name for the selected node. Choose the default or enter a custom name.


            If you enter a custom server
member name, the name must be unique across all nodes in your deployment.






           
        5.  Click Next.


        



      






       
    12.  Enter the database information.  


        The panel described
in this step appears only if you selected new applications to install
and if the new applications require database configuration.



       
        


         
      1.  Specify whether the installed applications use the same
database server or instance: Select Yes or No. 


          If allowed by your database configuration,
you can select multiple database instances as well as different database
servers.






         
      2.  Select a Database type from one of the following options: 


         
          


           
        •  IBM DB2 Universal Database





           
        •  Oracle Enterprise Edition





           
        •  Microsoft SQL Server Enterprise
Edition


        






         
      3.  Enter the Database server host name. For example: appserver.enterprise.example.com 


         If your installed applications use different database servers, enter the database
host name for each application.






         
      4.  Enter the Port number of the database server. The default values are: 50000 for DB2, 1521 for Oracle, and 1433 for SQL Server. 


         If your installed applications use different database servers or instances,
enter the port number for each database server or instance.






         
      5.  Enter the JDBC driver location. For example: 


         
          


           
        •  AIX:


           /usr/IBM/WebSphere/AppServer/lib






           
        •  Linux:


           /opt/IBM/WebSphere/AppServer/lib






           
        •  Windows:


           C:\IBM\WebSphere\Appserver\lib



        






         
      6.  Ensure
that the following JDBC driver libraries are present in the JDBC directory: 


         
        DB2
        




         
        db2jcc.jar and db2jcc_license_cu.jar


          Ensure that your user account has the necessary permissions
to access the DB2 JDBC files.

        




         
        Oracle
        




         
        ojdbc6.jar
        




         
        SQL Server
        




         
        Download the SQL Server JDBC 2 driver from the Microsoft website to a local directory
and enter that directory name in the JDBC driver library field.


         The directory must not contain the sqljdbc.jar file, only the sqljdbc4.jar file. Even though
the data source is configured to use the sqljdbc4.jar file, an exception occurs if both files are present in the same
directory.





         IBM recommends that you obtain this Microsoft hotfix for the JDBC 2 driver for production deployments.

        

        






         
      7.  Enter the User ID and Password for each database. If each database
uses the same user credentials, select the Use the same
password for all applications check box and then enter
the user ID and password for the first database in the list.
         


         If your database
type is Oracle, connect to the database with the user ID
that you used when you created the application database. 







         
      8.  Click Validate to verify your database settings. If the validation fails, check your database settings.
When the validation succeeds, click Next. 


         IBM Installation Manager tests your database connection with the database values that you supplied. You can change the database configuration later in the WebSphere Application Server Integrated
Solutions Console.



      






       
    13.  In the summary panel, confirm your selection and click Modify.





       
    14.  When the modification process is complete, restart the Deployment Manager and all the nodes. 


        Wait until the DM copies all the application EAR files to the installedApps directory on each of  the nodes. This process can take up to 30
minutes. 


       To verify that the DM has distributed the application
EAR files to the nodes, check the SystemOut.log file of each node agent. The default path to the SystemOut.log file on a node is profile_root/logs/nodeagent.





       Look for a message such as the following example: ADMA7021I: Distribution of application application_name completed successfully. where application_name is the name of an IBM Connections application.

 


       To confirm that the installation was successful, open the log files in
connections_root/logs. Each IBM Connections application installed
has a log file, using the following naming format: application_nameInstall.log, where application_name is the name of an IBM Connections application. Search for the words error or exception to check whether any errors
or exceptions occurred during installation. 



    



    Related
    

  •   Configure media galleries


     

  •  Roles




     Use the calendar in the My Activities widget
    

    


     Use the calendar in the My Activities widget to find out
which of your task deadlines are approaching.







     The calendar highlights the deadlines
for your to-do items for the current month, using the following background
colors and symbols to highlight significant dates. The current date
is highlighted in bold text.

    



    Table 129. Calendar
color codes and symbols

    Background color
    Symbol
    Description




    Red
    >
    To-do items that are overdue.



    Gray
    #
    To-do items to be completed today.



    Blue
    *
    Personal to-do items to be completed on a future
date.



    Green
    +
    Team (unassigned) to-do items to be completed
on a future date.



    

For example, for a to-do item assigned to you personally that
must be completed on a future date, that date is highlighted with
a blue background, with an asterisk (*) symbol preceding the date.





     The calendar also flags the dates associated with
unassigned tasks to be completed in the future. Deadlines for completed
tasks are not included. If a personal to-do item and a team to-do
item fall on the same day, then the calendar flags the personal to-do
item rather than the team to-do item.





     Use the arrows on either
side of the month name to display task deadlines for the previous
and following months.


    


     To view the tasks associated with a specific deadline,
complete the following steps.


     
      


       
    1.  Click the highlighted date in the calendar. A
pop-up window displays, listing the tasks with deadlines on the selected
day.





       
    2.  Click a task title to retrieve information about the task
directly from the Activities application.





       
    3.  When you are finished working with the task, close the window to return to the Home page.


    




    Accepting network invitations
    

    


     Accept invitations to join other people.s networks. When
you accept an invitation, the inviter is added to your network as
well.







     If your administrator has enabled email notifications
for the Profiles application, when people add you to their network,
they generate an email message inviting you to join their network.
The email contains a link to the My Network page,

    ...where you can accept or decline the invitation.





     If email notifications
are not enabled for your deployment, you can access invitations directly
from the My Network page.


    


     To accept a network invitation, complete the following steps:


     
      


       
    1.  Open the invitation by doing one of the following:

        


         
      •  If email notifications are enabled, you can click the link
provided in the email invitation to open the My Network page.





         
      •  Select Invitations from the My
Network page.


      






       
    2.  Accept or ignore the invitation.

        


         
      •  To accept the invitation and join the inviter's network, click Accept.


          You can also click the inviter.s name and accept the invitation from their
profile page.






         
      •  To ignore the invitation and delete it from the Invitations tab,
click Ignore.


          When you ignore an invitation,
the inviter does not receive notification of your action.



      



    




    Add people to your network
    

    


     Use profiles to create a network of work colleagues and
useful contacts.




You can invite people to join your network by sending them
an invitation. 


      You do not need to be in Profiles to add someone
to your network. You can connect to people directly from the profile
business card in any of the IBM Connections applications. For example, if a person's profile is returned as part
of search results, or if you are members of the same community as
someone and you want to add them to your network, you can do so using
the business card.





     You do not get updated on actions performed
by people in your network; you have to follow someone if you want
to be informed of their latest updates.


    


     To add someone to your network, do the following:


     
      


       
    1.  Search for the person.s profile, and then open it.





       
    2.  Click Invite to My Network. If you are not already logged in to the Profiles application,
you are directed to log in.





       
    3.  Accept the default message or enter a message of your own
inviting the person to join your network.





       
    4.  Enter keywords that define how you are connected to the person in the Add tags for name field.





       
    5.  If you want actions performed by the person, such as posting
a profile status message, adding a blog post, commenting on or recommending
something, to be displayed in the All Updates view
in your Home page, click Also Follow.





       
    6.  Click Send invitation.


    

     
    Results
    The person you have invited to join your network receives
notification that you have invited them to join your network. If they
accept your invitation, they are added to your My Network page,
and the Invite to My Network link is changed
to Remove From Network when you next view their
profile pages. There is no notification to let you know when people
accept or reject an invitation to join your network.




     Create an audio file
    

    


     Create a recording of yourself saying your name so that
others hear it pronounced correctly.




To create an audio file on a Microsoft Windows system,
perform the following steps:


      To create an audio file on a Linux system, use the record command
or use a sound recording utility.


    


     
      


       
    1.  Select Start > All
Programs > Accessories > Entertainment > Sound Recorder.





       
    2.  Click the Record button, say your full name, speaking as clearly as possible, and then click the Stop button.
Click the Play button to listen to the recording.





       
    3.  Check the size of the recording by clicking File > Properties. The data size must be smaller than 100 KB.





       
    4.  To rerecord the audio file, click File > New, and select No when
prompted to save the recording. Repeat step 2 to rerecord. Follow
these tips to improve the quality of the recording: 


       
        


         
      •  If the recording is inaudible, make sure that the microphone is
enabled. Select Start > All
Programs > Accessories > Entertainment > Volume Control, then select Options > Properties. Choose Recording, select Microphone,
and then click OK. Drag the volume slider for
the microphone up to the maximum level.





         
      •  If the recording is unclear or the file produced is too large
(over 100 KB), configure the sound recorder. Select Start > All Programs > Accessories > Entertainment > Sound Recorder. Select File > Properties, and then click Convert Now.
In the Format field, select PCM and
in the Attributes field, select 8.000
kHz, 8 bit, Mono. Click OK, and
then click OK to close the Properties window.


      






       
    5.  After you have produced a recording that is clear, audible,
and smaller than 100 KB, select File > Save As to save it. Type a name
for the file and choose a directory to save it to. Make a note of
the name and location, so that you can retrieve it when you upload
the file to your profile. Set the file type (.wav and .wma), then
click Save. 


    




    Add a pronunciation file
    

    


     Edit your profile to add a recording of your name being
pronounced correctly.


     The pronunciation file that you upload to your profile must
be in .wav or .wma format,
and it cannot be larger than 100 KB in size.







     You can enhance your profile by adding a recording of
yourself saying your name so that others can hear it pronounced correctly.


    


     To upload an audio file to your profile, perform the following steps.


     
      


       
    1.  Click Edit My Profile on the My
Profile page. Alternatively, select Profiles > Edit My Profile from the product navigation.





       
    2.  Click the Pronunciation tab.





       
    3.  Click Browse and locate an audio
file recording of your name being clearly spoken with the correct
pronunciation.





       
    4.  Click Save to upload the selected
file. 


       To remove your pronunciation file, click Remove
audio file and then click Save.



    




     Update your background information
    

    


     Edit the About Me area of your profile
to let people know information about yourself such as specific skills
and previous work experience. This content appears in the Background page
of your profile. 







     Use the About Me area of your profile
to describe what you do. Provide details about the projects that you
are working on, the technologies that you are using, and the problems
that you are encountering or resolving. Include information about
any relevant technical skills, language skills, or interests that
you might have. You might also add information about your previous
work experience, education, and training in the Background section
of this page.





      An administrator initially creates your profile
with information from the user directory for your organization. Because
the information comes from the organization's personnel directory
and different directories store different information, the fields
that are displayed in your profile might differ from the default fields.
In addition, your administrator can automatically fill in a field
to prevent you from having to fill it out. The administrator can also
set a field to be read-only if it collects information that is not
relevant to your organization.


    


     To update your background information, complete the following steps.


     
      


       
    1.  From the My Profile page, click Edit
My Profile. Alternatively, select Profile > Edit My Profile from the product navigation.





       
    2.  Click the About Me tab.





       
    3.  Click in the About Me field , and
nter information about yourself in the area provided, for example
your current work projects and areas of responsibility. This area is a rich text field, so you can format the text, paste text
copied from elsewhere, add embedded links to web sites, and so on. 





       
    4.  Scroll to the Background field to
optionally enter additional information, for example your past work
experience, education, and accomplishments. 





       
    5.  Click Save or Save and
Close.


    




     Delete people from your network
    

    


     When people move or leave your organization, you can remove
them from your network.

    


     To delete a person from your network, perform the following steps.


     
      


       
    1.  Open the My Network page, and click My
Network Contacts.





       
    2.  Select the check box next to each person that you want
to remove, and click Remove from My Network.  


       The person does not receive notification that you have removed
them from your network.



    




     Update your profile photo
    

    


     You can add, update, or remove your profile photo on your profile page.


     


     Your profile photo must be one of the following file types: .jpeg, .gif,
or ..png. There are no file size restrictions.
However, the image is automatically resized to fit the allocated space
in the user interface.








     You can enhance your profile by updating your image from
time to time. Be sure to upload a business-appropriate image. 


    


     To update your profile image, perform the following steps.


     
      


       
    1.  From the My Profile page, mouse over
your profile photo and click the Edit profile photo icon. 


       Alternatively, click Edit My Profile and
click the Photo tab.






       
    2.  Do one of the following:

        


         
      •  To upload a new image:


         
          


           
        1.  Click Browse to locate a file containing
a picture of you to display in your profile.





           
        2.  Select the image file to upload and display and
then click Open.





           
        3.  Optionally resize the portion of the image that will display using
the Image Preview area.


            Image resizing is
not available for all image formats; if you encounter problems with
uploading and sizing an image, try converting the image to a different
format and then upload.






           
        4.  Click Save.


        






         
      •  To remove the existing photo, select Remove Image.


      



    




     Update your profile
    

    


     Edit your profile to add or update information about yourself,
change your profile picture, or upload a pronunciation file.




An administrator initially creates your profile with information
from the user directory for your organization. You can edit your profile
as needed to add extra details and ensure that the information is
kept up-to-date. Note that if you cannot update a field in your profile,
for example, your name, this is because the administrator has set
the field to be read only. To update the information in read-only
fields, contact your administrator.


     Notes: 


     
      


       
    •  The information in your profile comes from the organization's
personnel directory and, because different directories store different
information, the fields that are displayed in your profile might differ
from the default fields. In addition, your administrator can automatically
fill in a field to prevent you from having to fill it out. The administrator can also set a field to be read-only if it collects information that
is not relevant to your organization.





       
    •  You cannot update your report-to chain information directly from
Profiles. This information is automatically pulled in to the Profiles
application from your organization's corporate directory. If the information in your report-to chain is no longer current, the information must be updated in the corporate directory first. Your
administrator can then synchronize the changes back to Profiles.


    



    


     To edit your profile, perform the following steps.


     
      


       
    1.  Click Edit My Profile on the My
Profile page. Alternatively, select Profiles > Edit My Profile from the product navigation.





       
    2.  Depending on the type of changes you want to make, click
one of the following tabs: 



      Table 130. Edit profile tabs

      Tab
    Select this tab if you want to:




      Contact Information
    Edit your office location, contact details,
or job title, or choose a different time zone. Add or change your personal blog link.



      About Me
    Update the details of your work history and
background information.



      Photo
    Update or remove your current profile picture.



      Pronunciation
    Update or remove an audio file of your name
being spoken with the correct pronunciation.



      







       
    3.  When you've made the necessary changes, click Save or Save
and Close.


    




     Download vCard contact details
    

    


     You can download a person's vCard in preparation for adding
them as a new contact in your address book.




A virtual card (vCard) is a file that stores basic contact
information for a user, following the Internet Mail Consortium specification.
You can add new contacts by using your email system to import vCard
files. You can also download the vCard from the Profiles business
card.


     When you download a person.s vCard, you need to select the character encoding option that is appropriate for your address book
reader. The default option is Internationalized (UTF-8),
which is suitable for users of IBM Lotus Notes and Microsoft Outlook. However,
you might need to select a different encoding if your email client
is Microsoft Outlook Express or some other email
tool. 


    


     To save a person.s vCard to your personal records, perform
the following steps.


     
      


       
    1.  Open the profile page for the person who you want to add
as a contact. 





       
    2.  Click Download vCard.





       
    3.  Select the character encoding to use.





       
    4.  Click Download to save the person's
vCard to a specified location.


    




     Search by name
    

    


     You can search for a person based on their name.

    


     
      


       
    1.  From the My Profile, My
Network, or Directory page, select Profiles
by Name in the search area.





       
    2.  Type a name into the Search field
and click the search icon.

        


         
      •  Use an asterisk (*) as a wildcard character. For example,
enter Ethan * to find people with whose first
or last name begins with Ethan. 





         
      •  Type just the first letters of a name, for example Ab to
find people whose first or last name begins with the letters Ab.


      



    




     Use tags to find people
    

    


     Use the tags assigned to profiles to find people based
on the tag names they have used to define their skills, job role,
or interests.

    

      


       
    •  From your own or someone else.s profile, click a tag in
the Tags collection to see other people who
assigned the same tag to their profiles. 





       
    •  On the Directory page,, click a tag
in the Organization Tags collection to display
only people who have assigned the same tag to their profiles.





       
    •  On the Directory page, click Display
full search options, type one or more tag names into the Tags field
and then click Search. Separate multiple tag
names using a space or comma. 


    




    Following people
    

    


     Follow a person when you want to keep up-to-date with their
latest updates. You do not have to add a person to your network in
order to follow them.




When you are interested in another user's activities
and status content you can stay up-to-date with what they're
doing by following them. You do not have to add a person to your network
in order to follow them. For example, if you want to hear about what
someone in your organization is blogging about, you might want to
follow them to get their latest updates.


     Unlike inviting someone
to join your network, where the person must accept your invitation
to become connected to you, following does not require the approval
of the person to follow. 





     You can see who you
are following by selecting My Network > Following. You can see who is
following you by selecting My Network > Followers in Profiles, but you
cannot remove people from the Followers list,
and cannot block prospective followers. 


    


     To follow a person.


     
      


       
    1.  Open the profile page of the person you want to follow.
For example, click the Directory tab in Profiles
and enter the person.s name. 





       
    2.  Click Follow on the person.s profile
page.


    

     
    What to do next
    You can set your email preferences so that you receive regular
notifications about the people that you are following. For more information,
see Set email notification preferences. You can also
check the latest updates for the people that you are following from
the Home page by the All Updates tab. For more
information, see Using the Updates tab.


     If you are
following a lot of people and you can no longer keep up with the updates
that you are getting, you might decide to confine your following list
to a smaller number of people. Or you might want to stop following a person if you find that their updates are not relevant to you. To stop following a person, open their profile page and click Stop
following. 





    Posting messages or comments to another user's profile
page
    

    


     Connect with the people in your organization by commenting
on a colleague's status message or posting a message to their
recent updates area.


     


     You must be logged in to Profiles to post a message or
comment to someone's profile.





     Your administrator controls
who can write on a person's recent updates area. When you view
another person's profile, if you do not see the option to post
a message or comment, then you do not have access to write in that
person's recent updates area.





Every Profiles user has a recent updates area on their profile
page that displays their status messages, as well as other information
such as certain actions and updates of contacts whom they follow.
You can communicate with your colleagues by posting a message or comment
on their profile page. The profile owner receives an email notification
whenever a message or comment is posted to their profile.

    

      


       
    •  To post a message to another user's profile page:


       
        


         
      1.  On the person's profile page, click inside the message field in the Recent Updates area, where What
are you working on right now? is displayed.





         
      2.  Enter your message, and then click Post.


      






       
    •  To post a comment to another user's profile:


       
        


         
      1.  Locate the message or comment to which you want to respond
and do one of the following: 


         
          


           
        1.  If you are responding to a message, click Comment under
the message.





           
        2.  If you are responding to a comment, click Add a comment under
the comment.


        






         
      2.  Enter your reply in the field provided, and then click Post.


      



    




     Remove messages or comments from your profile page
    

    


     As profile owner, you can control what displays in your recent updates area by removing posts that you think are inappropriate.


     You must be logged in to Profiles to remove content from the recent updates area of your profile or content that you have added
to another user's area.




Profile owners can delete any of the content added to their
recent updates area. People who have added comments or messages to
another user's recent updates can only remove content that they
created themselves.

    To remove a message or comment from the recent updates
area, click the remove icon next to the entry to delete.
If you do not see the icon, then you do not have permission to delete
the entry.




    Performing a more advanced search
    

    


     Perform a more advanced search when you want to use information
in addition to or instead of a person.s name as the search criteria.

    


     
      


       
    1.  Open the Directory page in Profiles.
Alternatively, click Directory in the search
bar the top of the page from your My Profile or My
Network page. 


        Additional advanced search
options are available by clicking Advanced in
the search bar the top of the page.






       
    2.  Do one of the following.

        


         
      •  To find the profile of someone you know, enter the person.s
name in the field provided, and then click Search.





         
      •  To find the profile of a person whose name you forget or to
find the profiles of people you do not know, but who share a common
job role or tag, you can search particular fields as follows:


         
          


           
        1.  Click Display full search options.





           
        2.  Enter a value into one or more of the following fields to return
profiles that contain the same value in the corresponding field.



          Table 131. Directory search fields

          Field name
    What to enter




          Keyword
    A term to search for in every field of every
profile. 



          Display Name
    First and last name of the person that you want
to find. If the person goes by a nickname, use this field to search
for the person by nickname.



          First Name
    Given name.



          Last Name
    Family name.



          Tags
    The tag to search for. This searches the tags
that were added to peoples. profiles.



          Job Title
    Job title to find the profiles of people who
perform that job function.



          About Me
    A keyword that captures the type of skills and
experience that you are looking for.



          Background
    A keyword that describes the kind of background
that you are interested in.



          Organization or Company
    Name of an organization or company to find the profiles of employees.



          City
    City to find the profiles of people who work
at that location.



          State
    State to find the profiles of people who work
at that location.



          Country
    Country to find the profiles of people who work
at that location.



          E-mail Address
    Business email address. This option is not available
when the configuration prevents email addresses from being displayed.



          Phone Number
    Telephone number. This field searches all five
phone number fields in a person's profile.



          






            Your administrator can add or remove fields from the Search
the Directory form to suit the needs of your organization.
Because of this capability, the fields that display in the form might
be different from those listed here.






           
        3.  To include users who have left the organization in your search,
select Include inactive users in search results.
You can identify inactive users because their profiles are grayed
out.





           
        4.  Click Search to submit your search query.


        






         
      •  To search every field in every profile for a given term, select Search > Profiles by Keyword from the top of the page, type the term into the search
field, and then click the Search icon. 


      



    




    Viewing the search results
    

    


     Your search returned multiple results. Now what should
you do?


     You can perform a search in Profiles, for example using the Search bar
option Profiles by Name, to find people.s profiles.
The search results are limited to 250 results by default. This figure
can be changed by the administrator. 


      Profile contact information
is displayed in the search results. Sort options are available in
the search results list. You can also click a tag in the Organization
Tags collection to filter the results by tag.


    


     Review search results by doing the following.

      


       
    •  View the business card of people returned by a search by
hovering over their name and clicking the link provided. If after
viewing the business card, you want to learn more, click the person's
name to open their profile.





       
    •  Use the Sort by options at the top
of the page to sort the results in order of relevance, display name,
and last name.





       
    •  Page through the search results by clicking the Next, Previous,
or page number buttons at the top and bottom of the view. If there
are too many results, you can search again. In the subsequent search,
provide more qualifiers by filling in more of the search fields.


    




    Tagging profiles
    

    


     Add a tag to your own profile or to another person.s profile
to identify a specific skill set or area of expertise. Profile tags
should identify a person.s job role, skills, or interests. For example: loan-officer, human_resources, encryption, fly-fishing.
When used correctly, they can help people learn about one another.


     If your system administrator has enabled people tagging, you
can tag yourself and others. You must be logged in to create or modify
tags.







      


     
      


       
    •  Tags that you add to your own profile or to the profiles of others
cannot be hidden or private. All tags are displayed in the profile
tag collection and organizational tag collection.





       
    •  If multiple people assign the same tag to a profile, a number
is displayed beside the tag to identify the number of times the tag
has been assigned. You can click the number to display a list of the people who assigned that tag to the profile.





       
    •  Tags that you assign to a profile are listed separately from those
that were assigned by others. 


    



    


     To tag a profile.


     
      


       
    1.  Open your own profile or the profile page of the person
to tag.





       
    2.  Type a keyword into the tag field. The tag must be a single
word only; it cannot contain spaces. You can use an underscore (_)
or a hyphen (-) to specify multiple word phrases. Separate multiple
tags with commas or spaces. 


       Tags are automatically converted
to lowercase.






       
    3.  Click the Add tags to this profile icon
to add the tags to the profile.


    

     
    What to do next
    You can remove the tags that you added to another person's
profile. Profile owners can remove any of the tags added to their
profile, whether the tag was added by the profile owner or by someone
else.




     Update contact information
    

    


     Keep your contact information up-to-date to ensure that
people can get in touch with you.


     The information in your profile comes from the organization's
personnel directory and, because different directories store different
information, the fields that are displayed in your profile might differ
from the default fields listed below. In addition, your administrator can automatically fill in a field to prevent you from having to fill
it out. The administrator can also set a field to be read-only if
it collects information that is not relevant to your organization.

    


     To edit your contact information, complete the following steps.


     
      


       
    1.  Click Edit My Profile on your My
Profile page. Alternatively, select Profiles > Edit My Profile from the product navigation.





       
    2.  Click the Contact Information tab.





       
    3.  Edit the content of any of the following fields. 


        Your
administrator can set specific fields to be read-only so that, depending
on your deployment, you might not be able to edit all the fields listed
below. For example, you might not be able to update your name or your email address if those fields are set to be read-only. If your contact
information has changed and you cannot edit the information yourself
directly from Profiles, contact the IBM Connections administrator to advise them about the updated information.




      Table 132. Contact information fields

      Field name
    Description




      Building
    Building name.



      Floor
    Floor number.



      Office
    Office name.



      Office number
    Office telephone number.



      IP telephony number
    Tie line number.



      Mobile number
    Mobile telephone number.



      Pager number
    Pager number.



      Fax number
    Fax number.



      Alternate e-mail
    An alternate email address. This option is not
available if your administrator has disabled the display of email
addresses for your deployment.



      Blog link
    Link to your personal blog.



      Job title
    Your official job title.



      Assistant
    Name of your assistant.



      Time zone
    Click the Down arrow to select the time zone
of your primary work location.



      







       
    4.  Click Save when you are ready to
save your changes.


    




     Update your status message
    

    


     Update your personal status message to let the people in
your network know what you are doing. Your status message is visible
to anyone who can view your profile page in their, and your, profile
page.


     You must be logged in to Profiles to update your status message.




You can keep people informed about what you are doing by
regularly updating the personal status message that displays under
your profile picture. For example, you might post a message to let
people know that you are busy preparing for a meeting or that you
are about to leave the office for the day. Or you might want to share
a link to an interesting website with the people in your network.
When you paste a URL into the status message field, it is automatically
converted to a hyperlink.

    


     To update your status message, complete the following steps on your profile page.


     
      


       
    1.  Click Recent Updates and click in
the What are you working on now? message area.





       
    2.  Enter a brief status message in the field provided, and
then click Post. Optionally add a file that
has already been uploaded or that is on your computer.


    




     Use the Do You Know widget
    

    


     Make new connections and expand your network using the Do You Know widget on the My Network page.


     You must be logged in to receive colleague suggestions from
the Do You Know widget.




The Do You Know widget recommends people for you to add to
your network based on your existing connections, tags, organizational
relationships, and actions that you have taken in the different applications.


     The widget recommends people for you to connect to and provides information
about how you are already related to those people. For example, you
might share the same manager, you might be a member of the same communities,
or you might have used the same tag.





     You can use the information
provided by the widget to help you decide whether to add a person
to your network. If the person interests you and you want to connect
with them, you can add them to your network directly from the widget.
You can remove the recommendation if you decide that you do not want
to connect with them.


      Because the widget is refreshed on an interval
basis, you may not be prompted immediately for people recently made
available. 



    


     Use the Do You Know widget in the following ways:

      


       
    •  Select a person's profile picture to display a list of
the ways in which that person is related to you.





       
    •  Scroll through the suggested profiles by clicking the photo
on either side of the middle photo.





       
    •  To invite a person to join your network, select the person's
profile picture and click Invite to connect.





       
    •  To remove a recommendation, select
the person's profile picture and click Remove.





       
    •  Access a person's business card by hovering over their
name and clicking the link that displays.


    




     Use the Organization Tags collection
    

    


     The organizational tags collection is displayed on the Directory page
and contains the tags that have been assigned to peoples. profiles
the most often. From the search results view, it displays the tags
that have been assigned to the profiles returned by the search.


     When you add a tag to a profile, it does not get displayed
in the organizational tag collection until the profile content is
next indexed. The frequency of the indexing task is defined by your site administrator, but usually occurs every 15 to 20 minutes. So,
it might take that long before you see a tag that you add get displayed
in the organizational tag collection.

    

      


       
    •  You can choose to display the collection as a list or cloud.
The List view displays the 10 most popular
tags. The Cloud view displays the 50 most popular
tags. If you do not see a tag that you know exists in the collection,
click in the Type to find a tag search field,
type the tag name in the field, and click the search icon to find
it.





       
    •  Click a tag to see a list of the people who have assigned
that tag to their profiles or had it assigned to their profiles by
someone else.


    




     Use the Who Connects Us widget
    

    


     Use the Who Connects Us widget to find out how you are
connected socially to other people in your organization. The widget
displays when you are viewing other people's profiles.


     You must be logged in to see content in the Who Connects Us
widget.




You can use the Who Connects Us widget to view the social
path that links you to a person when you are viewing that person's
profile. The social path displays as a list of people who link you
and the profile owner.


     The Who Connects Us widget provides information
about how you are connected to the profile owner, and how the profile
owner is connected to other people in the social path. This information
can be useful if you are looking to expand your social network and
want to find people who are connected to you in some way, or if you
just want to get a clearer picture of the social structure in your organization.


    


     Use the Who Connects Us widget in the following ways.

      


       
    •  Select a person's profile picture to display a list
of the ways in which that person is linked to you.





       
    •  When you want to find out more about a person in the social
path, click the person's name under their profile photo to open
their profile.





       
    •  Expand the twisties to view more detailed information about
how you are connected to the profile owner, or how the profile owner
is connected to other people in the social path.





       
    •  Select the photo on either side of the center photo
to display more profiles.


    




     Use the Things in Common widget
    

    


     Use the Things in Common widget to find out what you have
in common with a person. The widget displays when you are viewing
other people's profiles.


     You must be logged in to see content in the Things in Common
widget. The widget only displays the public content that a user has
in common with another user.




When you are viewing another person's profile, the Things
in Common widget lists the things that you have in common with that
person. The widget displays a list of public content organized according
to application. For example, the widget might display a list of the public communities that you and the profile owner both belong to or
a list of the tags that you have both used. You can use this information
to help you decide if you want to follow that person or add them to
your network.

    


     Use the Things in Common widget in the following ways.

      


       
    •  Expand the application twisties to display content from
a particular application. For example, this content might
include communities, discussions (forum threads), blogs, activities,
files, bookmarks, tags, or wikis that you and the profile owner have
in common.





       
    •  When a content listing interests you, click the title to
open it and take a closer look.


    




    Viewing network contacts
    

    


     Want to see who's connected to who? Use Profiles to view
a person's network contacts or check if someone is already part
of your network.




You can view the people in your network and in other people's
networks from the Network Contacts page.

    


     To view network contacts for your profile or someone
else's profile. 
    Open the Network Contacts page by
doing one of the following.

      


       
    •  To view your own network contacts, open the My Network page,
and click My Network Contacts.





       
    •  To view another person's network contacts, open their
profile page and click View All in the Network area
of the page.


    
 Click to open a contact.s profile page to learn more about them.
Optionally initiate an action such as following the contact, inviting
them to your network, or posting a message to their Recent
Updates area. 


      The Network Contact label
appears on a person.s profile page if you are networked with them. 





     Map fields manually
    

    


     To populate the Profiles database with data from the enterprise
LDAP directory, map the content of the fields in the database to the fields in the LDAP directory.







     Edit the map_dbrepos_from_source.properties file
to map fields between the Profiles database and the LDAP directory.
Open the profiles_functions.js file to see the options for the different mapping functions. You can add your own
functions if necessary.





      When you run the Profiles population
wizard in interactive mode, it generates two property files in the Wizards\TDIPopulation directory:
a tdisetting.properties file and a mappings.properties file.
The properties in mappings.properties are very
similar to those in map_dbrepos_from_source.properties.





      


     The internal name of the Profiles
database is PEOPLEDB.





     To map fields:


    


     
      


       
    1.  On the system hosting your Tivoli Directory
Integrator installation, create a subdirectory in which to store the Tivoli Directory Integrator solution
directory. Make sure that the file path does not contain spaces. Do
not, for example, create the subdirectory in the Program
Files directory in Microsoft Windows.





       
    2.  Copy the tdisol compressed file from
the TDISOL directory of the IBM Connections installation media to the system

      ...where you installed Tivoli Directory
Integrator.





       
    3.   Use appropriate
tools, extract the tdisol file to the directory
that you created in Step 1. This process creates a Tivoli Directory Integrator Solution directory
called TDI.





       
    4.  From the TDI solution directory, open
the tdienv.bat or tdienv.sh file in a text editor.
Ensure that the path to the Tivoli Directory
Integrator installation directory is specified correctly in the TDIPATH variable.
If the path is not correct, edit the TDIPATH environment
variable.

        


         
      •  AIX or Linux: 


         The default value for TDIPATH is: 


        export TDIPATH=/opt/IBM/TDI/V7.1 
        







         
      •  Windows: 


         The default value for TDIPATH is: 


        SET TDIPATH=C:\Program Files\IBM\TDI\V7.1
        




      
 Other scripts in the solution directory use this Tivoli Directory Integrator path
or tdienv.bat or tdienv.sh file to find Tivoli Directory Integrator files. 





       
    5.  Edit the properties files to define the mapping between
the LDAP directory and the Profiles database. Consider using LDAP
viewer software to help you map the fields. To define the mappings
that are used when populating the Profiles database from the enterprise
directory: 


       
        


         
      1.  From the TDI directory, open the map_dbrepos_from_source.properties file
in a text editor. 





         
      2.  Add or modify the field values. Any values that you omit or set
to null are not populated in the database. You can modify the values
in one of the following ways:


         
        1:1 mapping
        




         
        If one field in the Profiles database matches one field in the enterprise directory, type the name of the field in the Profiles database
and set it equal to the associated source database LDAP property.
For example:


         bldgId=buildingname

        




         
        Complex mapping
        




         
        If there is a more complex relationship between the fields in
the Profiles database and enterprise directory, such as the content
of the property in the enterprise LDAP directory must be split into
multiple fields in the Profiles database, use a JavaScript function to define the relationship.
Define the function in the profiles_functions.js file
and wrap the name of the JavaScript function
in braces {}. Begin function names with func_ so
that you can more easily identify them. For example:


         bldgId={func_map_to_db_bldgId}

        

        





          See Example complex mapping of Profiles
data for an example of complex mapping.





         Notes: 


         
          


           
        •  The uid, guid, dn, surname,
and displayName attributes are always required.





           
        •  See Table 2 for a list of the default values for the fields.


        




      






       
    6.  Open the tdi-profile-config.xml file. After the IBM Tivoli Directory Integrator Solution
files are extracted, the file is located in the following directory:


       TDI/conf/LotusConnections-config






       
    7.  Modify the file to configure the extension attribute, specifying
the property's name and mapping from the source. Use the following parameters: 



      Table 133. Custom extension attribute parameters

      Parameter
    Description




      extensionId
    The ID of the extension attribute.


       This parameter
is required.




      sourceKey
    The name of the attribute from the source.


       This
parameter is required.




      






       For example, to add a simple attribute called spokenLangs,
the configuration would look like the following extract from the tdi-profiles-config.xml file:



      <simpleAttribute extensionId="spokenLangs"
    sourceKey="spokenLang"/>
      





        The formatting between
the tdi-profile-config.xml and the profiles-config.xml files
is compatible, so you can copy and paste configuration information
between the files. For the extension to be displayed in the user interface,
the modifications must be made in profiles-config.xml.
For more information, see Extension properties in the data model in
the Customize Profiles section. 





        To leverage the custom attribute in the Profiles user interface or REST API, you must
configure the application per the instructions in the Customize
Profiles section. For a detailed example that uses custom attributes,
see Creating a simple profile data model and template customization.






       
    8.  Save your changes to the tdi-profile-config.xml file.





       
    9.  Optional: Write a JavaScript function that combines different
attributes from your LDAP directory to map a customized extension
attribute for the Profiles database:


       
        


         
      1.  Add the extension attribute function definition in the map_dbrepos_from_source.properties file,
using the following format:  


         extattr.spokenLangs={func_map_to_langs}





          The extensionAttribute name
must match the specified extensionId in the tdi-profiles-config.xml extension
attribute definition.






         
      2.  Add a new func_map_to_db_extensionAttribute JavaScript function in the TDISolution\TDI\profiles_functions.js file.
Write logic for the function that specifies the new extension attribute
mapping.





         
      3.  Repeat these steps for each JavaScript function.


      



    

     
    What to do next
    


     The properties in the map_dbrepos_from_source.properties file
have the default values defined in the following table. Many of them
are null. You must determine which LDAP properties to map to your database fields and edit this file to specify values that apply to
your configuration. Any values that you omit or set to null are not
populated in the database.





     


      See Attribute mapping
for Profiles for a table of additional attribute mapping field
values.




    Table 134. Default
values for properties in the map_dbrepos_from_source.properties file

    TDI property
    Default LDAP attribute mapping




    alternateLastname
    null



    bldgId
    null



    blogUrl
    null



    calendarUrl
    null



    countryCode
    c



    courtesyTitle
    null



    deptNumber
    null



    description
    null



    displayName
    cn


     Required.




    distinguishedName
    $dn 


     Required.




    email
    mail



    employeeNumber
    employeenumber



    employeeTypeCode
    employeetype



    experience
    null



    faxNumber
    facsimiletelephonenumber 



    floor
    null



    freeBusyUrl
    null



    givenName
    givenName 



    givenNames
    gn



    groupwareEmail
    null



    guid
    See the note at the foot of this table about
mapping the guid, uid, and loginId.


     Required




    ipTelephoneNumber
    null



    isManager
    null 



    jobResp
    null



    loginId
    See the note at the foot of this table about
mapping the guid, uid, and loginId.



    logins
    null



    managerUid
    $manager_uid 


     This property represents a lookup
of the UID of the manager using the Distinguished Name in the manager
field.




    mobileNumber
    mobile 



    nativeFirstName
    null 



    nativeLastName
    null 



    officeName
    physicaldeliveryofficename 



    orgId
    ou



    pagerId
    null



    pagerNumber
    null 



    pagerServiceProvider
    null 



    pagerType
    null 



    preferredFirstName
    null 



    preferredLanguage
    preferredlanguage 



    preferredLastName
    null 



    secretaryUid
    null 



    shift
    null



    surname
    sn 


     You must provide this field because the Search application expects to find it in the Profiles database.





     Required.




    surnames
    sn



    telephoneNumber
    telephonenumber 



    timezone
    null



    title
    null



    uid
    See the note at the foot of this table about
mapping the guid, uid, and loginId.


     Required.




    workLocationCode
    postallocation



    






      Map the guid, uid, and loginId: The guid property
identifies the global unique ID of a user. This property's value
is created by the LDAP directory and is unique, complex, and never
changes. It is essential in that it maps each user's IBM Connections data to their User ID when using
the Profiles database as the user repository. The mapping of the guid property
must be handled differently depending on the type of LDAP directory
that you are using:


     
      


       
    •  Microsoft Active Directory


       guid={function_map_from_objectGUID}
You
must use a JavaScript function
to define the value for Active Directory because objectGUID is stored
in Active Directory as a binary value, but is mapped to guid,
which is stored as a string in the Profiles database. Also, the samAccountName property
used by Active Directory has a 20 character limit, as opposed to the 256 character limit of the other IDs used by IBM Connections.





       
    •  IBM Lotus Domino 
  


       guid={function_map_from_dominoUNID}






       
    •  IBM Directory Server


       guid=ibm-entryUuid






       
    •  Sun Java System Directory
Server


       guid=nsUniqueID






       
    •  Novell eDirectory


       guid={function_map_from_GUID}



    
If you edited the wimconfig.xml file to
use a custom global unique ID, be sure to specify that custom ID here.
The uid property,
not to be confused with the guid property, defines
the unique ID of a user. This property differs from a guid in
that it is the organization-specific permanent identifier for a user
. often a login ID or some value based on the user's employee
code. The uid is a critical field in the Profiles
database. By default, this property links a given person's user record
back to LDAP data. The value you map to uid must
meet the following requirements:


     
      


       
    •  It must be present in every entry that is to be added to the database.





       
    •  It must be unique.





       
    •  In a multi-LDAP environment, it must be unique across LDAP directories.





       
    •  It must be 256 characters or fewer in length.


    
In Active Directory, although there often is a UID field available,
this field is not always the best choice for mapping to uid because
it is not guaranteed to be present for all entries. A better choice
is sAMAccountName because it usually does exist for all entries. Other
values are acceptable also, as long as they meet the requirements. 


     Notes: 


     
      


       
    •  If you are mapping the uid from an LDAP field,
specify the name of the field. However, if you need to parse it from
the distinguished name and it is in the DN in the form of uid=value,
use the following mapping function: 


       {func_map_to_db_UID}






       
    •  Use the isManager and managerUid properties
to set up the organizational structure of the organization. The isManager field
determines whether the current person is a manager or not. You must
assign a Y (Yes) or N (No) value to this property for each entry.
Y identifies the person as a manager. The managerUid identifies
the UID of the current person's manager. By default, managerUid is
mapped to $manager_uid, which represents a lookup
of the UID of the manager (using the Distinguished Name contained
in the LDAP manager field). If a user's manager information is not
contained in the $manager_uid field, you should
adjust the mapping accordingly. These two properties work together
to identify manager/employee relationships and create a report-to
chain out of individual user entries.





       
    •  If users intend to log into Profiles using a single-valued user
name other than the value specified in the uid or email properties,
you must map that user name value to the loginId property.
To do so, complete the following step:


       
        


         
      •  Set the loginId property in the map_dbrepos_from_source.propeties file
equal to the LDAP property to use as the login ID. For example, if you want to use employeeNumber as the login property, edit the property value as follows:


         loginId=employeeNumber



      





       If you have more than one additional login ID (such as with
a long and short form user ID) and you want to allow users to login
with either of their login IDs, you can populate multiple additional
login IDs by using one of the following settings: 	





       logins=multiValuedLdapAttribute





       or





       logins={function_to_get_multiple_ldap_values}
 
	


    







     For more information, see the Tivoli Directory
Integrator product documentation.





     Add profile types: 


     IBM Connections supports
the ability to classify a profile using a profile type. The profile
type allows the application to provide the set of properties that
are intended for a given profile object. For more information, see Profile-types.




     
    Related tasks
    

  •   Update Profiles when changing LDAP directory


     

  •  Customize the Profiles data model




    Customize the Profiles user interface
    





     Specify which attributes should display in Profiles based
on the needs of your organization.







     In prior releases, customizing attributes for Profiles
user interface display was done using the profiles-config.xml file.
That customization is now done using a set of supplied template files
and the FreeMarker Templating Language (FTL). This method provides
greater customization flexibility. 



     
    Related tasks
    

  •   Apply property changes in Profiles




     Install and configuring the Lotus Quickr library widgets
    





     Download the Lotus Quickr library widgets and then
install and configure them.


     


     Before you can use the widgets: 


     
      


       
    •  You must configure single sign-on between the IBM Connections and Lotus Quickr servers.
See the topic Configuring single sign-on between the Connections and Lotus Quickr servers.





       
    •  You must add IBM Connections server URLs to the Lotus Quickr Resource Environment provider.
See the topic Add Connections URLs to the Lotus Quickr Resource
Environment provider.





       
    •  To use the Linked Lotus Quickr library widget there must
be an existing Lotus Quickr place with a library in
the Lotus Quickr deployment.





       
    •  You must install all prerequisites. See the Lotus Quickr Library
widget page on the IBM Lotus and WebSphere Portal Business Solutions Catalog web
site.


    



    


     
      


       
    1.  In SiteMinder environments only, perform the follow tasks
on the IBM connections server:


       
        


         
      1.  Copy the US_export_policy.jar and local_policy.jar files
from wherever you unpackaged the unrestricted.zip file when configuring
SiteMinder. Paste it in the following directory, overwriting the existing
versions of those files: 


        <websphere_application_server>/java/jre/Lib/Security
        






         
      2.  Copy the sm_jsafe.jar and sm_jsafeJCE.jar files
from the Siteminder ASA crypto-libraries installation directory. Paste
it in the following directory, overwriting the existing versions of
those files: 


        <websphere_application_server>/java/jre/lib/ext
        



      






       
    2.  Download the Lotus Quickr Library widget war file
from the IBM Lotus and WebSphere Portal Business Solutions Catalog web
site.





       
    3.  Install the widget war file.


       
        


         
      1.  Log in to the WebSphere Administrative
Console on the IBM Connections server.





         
      2.  Navigate to Applications > Application Types > WebSphere enterprise
applications.





         
      3.  Click Install.





         
      4.  Browse and select the comm.communitylibrary.war file,
click Next, and then click Next again.





         
      5.  In Step 1 of the installation wizard, click Next without
changing anything.





         
      6.  In Step 2, select the cluster and web server (if there
is one), and then click Next.





         
      7.  In Step 3 of the installation wizard, in the Target
Resource JNDI Name column, click Browse and
select communities. Then click Apply.
The field is populated with the value jdbc/sncomm.
Then check the box and click Next.





         
      8.  In Step 4, check the box and then click Next without
changing anything.





         
      9.  In Step 5, type /quickr/connector in
the Context Root field, and then click Next.





         
      10.  In Step 6, click Finish.





         
      11.  Click Save to save all changes. In clusters you must wait for synchronization to complete before
continuing. Check the systemout.log in the /opt/IBM/WebSphere/AppServer/profiles/AppSrv01/logs/nodeagent
directory (on Linux servers)
to check for the synchronization completed successfully message.





         
      12.  In the list of applications, select the Lotus Quickr Library
widgets application and then click Start to
start it.


      






       
    4.  Create a J2C authentication alias for the Lotus Quickr administrator.


       
        


         
      1.  On the IBM Connections server, log into the WebSphere Application Server Integrated Solutions Console, expand Security,
and then select Global Security.





         
      2.  Expand Java Authentication and Authorization
Service.





         
      3.  Select J2C authentication data.





         
      4.  Click New.





         
      5.  Type an alias name (for example quickradmin), and specify
the user ID and password credentials of a Lotus Quickr administrator. 


          If the Lotus Quickr administrative user is
not available to IBM Connections (meaning not in the LDAP or defaultFileBasedRepository), then you
must add them to the defaultFileBasedRepository. Navigate to Users and Groups > Manage Users, and then create a user with the Lotus Quickr administrator ID and password.



      
 The server generates a J2C alias with a cell name and
the alias name you provided, for example: cell01\quickradmin. You must use this generated alias, including the cell name.





       
    5.  Copy the widget configuration files to the IBM Connections configuration directory.


       
        


         
      1.  Navigate to the widget \resources_config directory: 


         \IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\cell_name\comm_communitylibrary_war.ear\comm.communitylibrary.war\resources_config
        






         
      2.  Copy the communities-quickr-library-config.xml and communities-quickr-library-config.xsd
files to the \LotusConnections-Config directory: 


        \IBM\WebSphere\AppServer\profiles\<profile_name>\config\cells\<cell_name>\LotusConnections-config
        





         In
clustered deployments, copy the files to the \LotusConnections-Config
directory on the deployment manager node.



      






       
    6.  Add the widget resource bundle to the LotusConnections-config.xml
file.


       
        


         
      1.  Navigate to the widget \resources directory: 


        \IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\<cell_name>\comm_communitylibrary_war.ear\comm.communitylibrary.war\resources
        
In
clusters, navigate to the directory on any node.





         
      2.  Copy the contents of the \resources directory to the IBM\LotusConnections\data\shared\customization\strings directory (in
clusters, copy to the deployment manager computer).





         
      3.  Check out and open LotusConnections-config.xml.
See Editing configuration files.





         
      4.  Add the following line of code into the <resources>
element block to register the resource bundle for the Quickr Library widget: 


        <widgetBundle name="com.ibm.quickr.communitylibrary.resources" prefix="quickrCommunityLibrary_res" />
        



      






       
    7.  Add the following widget xml definitions to the widgets-config.xml
file, editing values to reflect your environment. In clustered deployments,
edit the widgets-config.xml file on the deployment manager node. See
steps and most attribute descriptions in the topic Enabling
custom widgets for Communities: 


      <widgetDef bundleRefId="quickrCommunityLibrary_res" defId="LinkedQuickrCommunityLib" 
description="LinkedQuickrCommunityLibDesc" primaryWidget="false" 
url="/quickr/connector/com.ibm.quickr.communitylibrary.xml" modes="view edit fullpage"
iconUrl="{contextRoot}/nav/common/images/iconFiles16.png" uniqueInstance="true" 
displayLoginRequired="true"
helpLink="http://www.lotus.com/ldd/lcwiki.nsf/dx/Using_the_Linked_Lotus_Quickr_library_widget_ic301">
<itemSet>
<item name="iframeLoadTimeout" value="30000" />
</itemSet>
</widgetDef>

<widgetDef bundleRefId="quickrCommunityLibrary_res" defId="QuickrCommunityLib" description="QuickrCommunityLibDesc" primaryWidget="false" url="/quickr/connector/com.ibm.quickr.communitylibrary.xml" modes="view fullpage"
iconUrl="{contextRoot}/nav/common/images/iconFiles16.png" uniqueInstance="true" displayLoginRequired="true"
helpLink="http://www.lotus.com/ldd/lcwiki.nsf/dx/Using_the_Lotus_Quickr_library_widget_ic301">
<itemSet>
<item name="iframeLoadTimeout" value="30000" />
</itemSet>
<lifecycle remoteHandlerURL="remoteHandlerURL/quickr/connector/lifecycle" 
remoteHandlerAuthenticationAlias="remoteHandlerAuthenticationAlias">
<event>widget.added</event>
<event>widget.removed</event>
<event>community.members.added</event>
<event>community.members.removed</event>
<event>community.updated</event>
<event>community.visibility.changed</event>
<event>community.prepare.delete</event>
<event>community.members.modified</event>
</lifecycle>
</widgetDef>
      
Where:


       
        


         
      •  In IBM Tivoli Access Manager environments the widgetDef
url value must explicitly specify the Quickr server Tivoli Access Manager junction URL. For example,
this sample assumes a URL such as https://yourserver.com:port/lotus
and only the /quickr/connector/com.ibm.quickr.communitylibrary.xml
part is specified. In Tivoli Access
Manager environments you must specify the entire URL, for example
https://tam.hostname.com:port/lotus/quickr/connector/com.ibm.quickr.communitylibrary.xml.





         
      •  The itemSet.item.value attribute is the number of milliseconds
Internet Explorer browsers wait to determine if the Lotus Quickr library
loaded successfully before showing an error. If Internet Explorer
users are seeing only the error page, you can try increasing this
value to resolve the issue, particularly if they can see the library
in the Firefox browser.





         
      •  {contextRoot} is a variable automatically populated
with the Connections directory.





         
      •  remoteHandlerURL is the URL of the Connections server on which the widget is installed, for example: https://yourserver.com:9443.
If you have IBM Tivoli Access Manager enabled on IBM Connections server, replace yourserver.com with
the IBM Tivoli Access Manager sever hostname.





         
      •  remoteHandlerAuthenticationAlias is the Connections J2C authentication alias used to talk to the servlet. The alias connectionsAdmin is
the default for all widgets.


      






       
    8.  On the IBM Connections server, open communities-quickr-library-config.xml and update the Lotus Quickr information for your environment, for
example: 


      <host>quickr.example.com</host>
<port>10040</port>
<sslPort>10035</sslPort>
<useSSL>false</useSSL>
<authentry>cell01/quickradmin</authentry>
<ownersRole>Managers</ownersRole>
<membersRole>Editors</membersRole>
<publicRole>Readers</publicRole>
      
Where:


       
        


         
      •  <host> is the Lotus Quickr server hostname. If you
have IBM Tivoli Access Manager enabled on Lotus Quickr server,
replace yourserver.com with the IBM Tivoli Access
Manager sever hostname.





         
      •  <port> is the http port number of the Lotus Quickr server.
Or if a web server is configured, <port> is the http port number
of the web server.





         
      •  <sslPort> is the https port number of the Lotus Quickr server.
Or if a web server is configured, <port> is the http port number
of the web server.





         
      •  <useSSL> is whether or not to use http or https in communicating
with the Lotus Quickr server. If this is set to "true", the Lotus Quickr server must have a certificate that
is trusted by the IBM Connections server. See Secure communications using Secure Sockets Layer in
the WebSphere Application Server 6.1 documentation for more information.





         
      •  <authentry> is the full name of the J2C authentication alias
for the Lotus Quickr administrator that you created in Step
3.





         
      •  For <ownersRole>, <membersRole>, and <publicRole> the role names can be either the role title in English or the id field
returned for the roles feed. If anonymous access is not allowed, the publicRole element should be omitted or empty. The publicRole is applied
in both public and moderated communities, but is not in restricted
communities


      






       
    9.  In clustered environments, perform a full synchronization
of the IBM Connections cluster.





       
    10.  Restart IBM Connections.





       
    11.  If you had IBM HTTP Server installed before you installed
the Lotus Quickr widget, follow instructions in Mapping applications
to IBM HTTP Server to map the Lotus Quickr widget application
to the IBM HTTP Server.


    


     
    Related tasks
    

  •   Enable custom widgets for Communities

  •   Edit configuration files




     Configure the active content filter for Activities, Communities,
and Bookmarks
    





     IBM Connections provides
a set of active content filter (ACF) configuration files that you
can apply to the Activities, Communities, or Bookmarks applications
to limit or widen the types of content that users can add to their
entries.


     This is not a required procedure. Only perform this if you
want to change the level of filtering performed by the active content
filter.


     All of the applications, except Blogs, Wikis, and Forums,
use the default acf-config.xml file, which filters active content
in the following ways:


     
      


       
    •  You can change the formatting of content within rich text fields,
but styles cannot be added to entries using HTML.





       
    •  Javascript is stripped from all entries.





       
    •  Flash animations are not permitted. 


    






     The following configuration files are shipped with IBM Connections and stored in the LotusConnections-config\extern directory.
To change the level of filtering that is performed by the active content
filter, you can replace the default configuration file with one of
these files:





     


     
    acf-config-nf.xml
    




     
    Allows style changes, but strips forms and flash. The types of
forms that are not allowed are form HTML elements. Form HTML elements
are used to add things like buttons or fields to a web page. 
    




     
    acf-config-nf-ns.xml
    




     
    Prevents style changes and strips forms and flash.
    




     
    acf-config-nm.xml
    




     
    Prevents users from changing the margins on images. By default,
these applications permit image margin changes.
    




     
    acf-config-ns.xml
    




     
    Allows forms, but strips style changes and flash. Preventing style
changes affects rich text fields. If you configure the active content
filter to prevent style changes, then users will not be able to perform
the common tasks associated with changing the style of rich text content,
such as changing the font color, margins, and so on.
    

    






     To edit configuration files,
you must use the wsadmin client. See  Start the wsadmin client for details.


    


     
      


       
    1.  Edit LotusConnections-config.xml.


       
        


         
      1.  Enter the following command
to access the IBM Connections configuration file: execfile("connectionsConfig.py") 


         If prompted to specify a service to connect
to, type 1 to pick the first node in the list. Most commands can run
on any node. If the command writes or reads information to or from
a file using a local file path, you must pick the node where the file
is stored. This information is not used by the wsadmin client when
you are making configuration changes.






         
      2.  Enter the following command
to check out the IBM Connections configuration files: 


         LCConfigService.checkOutConfig("working_directory","cell_name")





         where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
to separate directories in the file path, even if you are using the Microsoft Windows operating system. 


           AIX and Linux only:
The directory must grant write permissions or the command does not
run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, type the following command while in the wsadmin
command processor:print AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")





           
        •  Microsoft

          Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")


        







         
      3.  Open LotusConnections-config.xml in a text
editor.





         
      4.  Find the <sloc:serviceReference> element
for the application to which you want to change filtering levels.
The application name is specified in the serviceName attribute.  


         Change the active content filter configuration for the applications
with the following serviceName attributes:


         
          


           
        •  Activities





           
        •  Communities





           
        •  Bookmarks


        







         
      5.  Add the following attribute to the <sloc:serviceReference> element
for the application you want to change: 


         For example:


        acf_config_file="file_name"
        

        ...where file_name is
one of the configuration files (acf-config-nf.xml, acf-config-nf-ns.xml, acf-config-nm.xml,
or acf-config-ns.xml). 





         For example, to
configure the Activities application to prevent image margin changes,
you could add the following acf_config_file element:


        <sloc:serviceReference 
 bootstrapHost="myServer.example.com" 
 bootstrapPort="2817" 
 clusterName="" 
 enabled="true" 
  serviceName="activities"  
 ssl_enabled="true" 
  acf_config_file="acf-config-nm.xml"> 
  <sloc:href>
    <sloc:hrefPathPrefix>/blogs</sloc:hrefPathPrefix>
    <sloc:static 
     href="http://enterprise.example.com:9082" 
     ssl_href="https://enterprise.example.com:9447"/>
    <sloc:interService href="https://enterprise.example.com:9447"/>
  </sloc:href>
</sloc:serviceReference>
        







         
      6.  Repeat Steps d and e to apply different filtering levels
to different applications, and then save and close the configuration
file.





         
      7.  After making changes, check the configuration
file back in and you must do so during the same wsadmin session in
which you checked them out for the changes to take effect. See Applying
common configuration property changes for information about
how to save and apply your changes.


      






       
    2.  Synchronize the nodes using the Integrated Solutions Console
for the network deployment system.





       
    3.  Restart the WebSphere Application Server.


    



    Related
    

  •   Administer Communities

  •   Administer Forums




     Copy Search conversion tools to local nodes
    





     To enable full indexing of data, copy the Search conversion
tools to local nodes.


     


     Perform this task only on nodes in the Search cluster.
If you added a node to an existing cluster, as described in the Add a node to a cluster topic, complete this task only
if the new node is a member of the Search cluster. References to nodes
in the steps of this task apply only to nodes in the Search cluster.





     Steps 1-3 and 6-7 are required for all supported operating systems.
However, if your deployment has only one node, skip steps 1-3. Steps
4-5 are required only if you are using the AIX or Linux operating system.








     The Search conversion tools index Files and Wiki attachments.
The tools work best when they are available locally on each node.
However, when IBM Connections was installed, the conversion tools were deployed on a network share.
Therefore, copy the tools to each node in the Search cluster.





     To copy Search conversion tools to local nodes, complete the following steps:


    


     
      


       
    1.  Identify the nodes in the Search cluster.


       
        


         
      1.  Log in to the Integrated Solutions Console and click Servers > Clusters > WebSphere application server clusters.





         
      2.  Click cluster_name, where cluster_name is the name of the Search
cluster.





         
      3.  In the Additional Properties area, expand Cluster members and then click Details.





         
      4.  In the table of cluster members, make a note of the nodes that host the cluster members.


      






       
    2.  Copy the shared_data_directory_root/search/stellent directory from the shared content folder to a local directory on
each node. Use exactly the same path on each node. The following path is an example only and might be different on your operating
system: 


       


       
        


         
      •  AIX or Linux: /opt/IBM/Connections/data/local/search/stellent





         
      •  Windows: C:\IBM\Connections\data\local\search\stellent


      






       The new directory contains the exporter executable file.






       
    3.  On the Deployment Manager, update the FILE_CONTENT_CONVERSION
Websphere variable to point to the exporter file
in the local directory on each node. 


       For example: /opt/IBM/Connections/data/local/search/stellent/dcs/oiexport/exporter 





       The exporter file must be in the same file path on all nodes. 
 


       For more information about WebSphere variables, see the Changing WebSphere Application Server
environment variables topic.






       
    4.  (AIX and Linux only) Back up the setupCmdLine.sh file on each node. This file is in the app_server_root/AppServer/bin directory. 





       
    5.  (AIX and Linux only) Add the following text to the end
of the setupCmdLine.sh file on each node:


       
        


         
      1.  export PATH=$PATH:SearchBinariesHome/dcs/oiexport
         


         where SearchBinariesHome is the path to the directory specified in Step 2.






         
      2.  Choose the option for your operating system: 


         
          


           
        •  AIX: export LIBPATH=$LIBPATH:SearchBinariesHome/dcs/oiexport





           
        •  Linux: export
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:SearchBinariesHome/dcs/oiexport


        



      






       
    6.  Restart all node agents.





       
    7.  Restart WebSphere Application Server on each node.


    


     
    Related tasks
    

  •  Add an additional Search node to a cluster




     Enable single sign-on for standalone LDAP
    





     IBM Connections requires
a federated repositories configuration, but you can enable IBM Connections applications to
perform Single sign-on for a standalone LDAP directory. 


     


     This procedure is required if you want to enable Single
sign-on (SSO) between IBM Connections and an application hosted by a version of WebSphere Application Server that is earlier
than 6.1, which is the version in which federated repositories were
introduced.
Before you perform this procedure, configure
federated repositories on IBM Connections.







     By default, applications deployed on servers within the same WebSphere Application Server cell are enabled for single-sign-on. To support this, the servers
share the same set of LTPA keys and the same LDAP directory configuration.
Use this configuration if you want to set up SSO between applications
that use different LDAP directory configurations.
To enable SSO
between IBM Connections and
a WebSphere Application Server configured for standalone LDAP:

    


     
      


       
    1.  Log in to the WebSphere Application Server Integrated Solutions Console by going to the following web
address in a browser:  


      http://<web.server.host.name>:9060/ibm/console
      






       
    2.  Log in to the Welcome page. 





       
    3.  Click Security > Global
security.





       
    4.   Select Federated Repositories from
the Available realm definitions field, and then click Configure.





       
    5.  On the Federated repositories page, add the <host_name>:<port> of
the standalone LDAP server to the Realm name field.  


       For example: 


      ldap.example.com:389
      







       
    6.  Click Apply and then click Save to
save this setting.





       
    7.  After changing the realm name, you must update the administrative
user roles because the previous realm name is still appended to the administrative users. Until you remove and re-add the administrative
users, the users are unable to access the Integrated Solutions Console. 


       
        


         
      1.  Navigate to Users and Groups > Administrative User Roles.





         
      2.  Select all user roles and click Remove.





         
      3.  Click Add.





         
      4.  In the Roles field, click Administrator.





         
      5.  In the User field, enter the user name to which you want to grant administrative privileges.





         
      6.  In the Search string field, enter
a user name to set as an administrator and then click Search.
Select the user name in the Available list and click the right arrow
button to move it to the Mapped to role field.





         
      7.  To map other users, repeat the previous step.





         
      8.  Click OK and then click Save. 


      
 


        If there is only one user, you might not be allowed to
remove the user. In that case, add the new user first and then remove
the original user.






       
    8.  Synchronize the nodes and then restart the servers:


       
        


         
      1.  Log into the Integrated Solutions Console for the Deployment
Manager. 





         
      2.  Expand System administration > Nodes. Select the name of the node that you updated and click Full Resynchronize.





         
      3.  Select Servers > Clusters. Select the check box
for the cluster you want to restart and click Stop.





         
      4.  Select System administration > Node agents. Select the check
boxes for the nodes to restart and click Restart.





         
      5.  Stop and restart the Deployment Manager.





         
      6.  Log into the Integrated Solutions Console again.





         
      7.  Select Servers > Clusters. Select the check box
 the cluster you want to restart and click Start.


      



    


     
    Related tasks
    

  •   Configure IBM Connections for SSO




    Deploying an event handler
    





     Deploy your event handler to the IBM Connections server runtime.


     


     
      


       
    •  Understand what events your handler needs to consume and what
type of handler it is. 


       Pre-event handlers and post-event handlers
that you intend to be invoked synchronously must always be run in
the context of the application that generates the events that the handler is subscribed to consume. Therefore, these handlers must be
deployed in a way that allows them to be executed by that application
or applications.





       Asynchronously-invoked post-event handlers
are always run in the context of the News application. Therefore,
these handlers much be deployed in a way that allows them to be executed
by the News application.  






       
    •  If your handler is a pre-event handler, or a post-event handler
you will register synchronously, then document what IBM Connections applications you want to consume
events from.





       
    •  Decide on the file system location in which to store your event
handler code. This location should be available to all nodes in the deployment. A suggested approach is to create a new subdirectory within
the shared content store location that was defined when the product
was installed.


    





Perform the configuration of WebSphere Application Server using the Integrated Solutions Console of the Deployment Manager.


     You will
need the JAR file for the event handler implementation, plus any associated
dependencies.


    


     
      


       
    1.  Place your event handler JAR file, and the files for any
dependencies, in the file system location that you decided on earlier.
For example /mnt/shared/LotusConnections/eventHandlers. So, if your handler JAR file is called myHandler.jar, the location is /mnt/shared/LotusConnections/eventHandlers/myHandler.jar.





       
    2.  Log in to the WebSphere Application Server Integrated Solutions Console, expand Environment,
and then select Shared libraries.





       
    3.  Select the Cell level scope from the Scope drop-down box,
and then click New.





       
    4.  Provide the following details for the shared library: 



      Table 135. 

      Field name
    Description
    Example




      Name
    The name of this shared library. Choose a name
that describes the event handler.
    MyHandler



      Description
    Optional. Provide a fuller description on the event handler  	  
     



      Classpath
    Provide the physical location of the event handler
JAR file, and any JAR files it depends on.
    /mnt/shared/LotusConnections/eventHandlers/myHandler.jar



      Native Library Path
    Optional. Only specify values here if your handler
code relies on native libraries.
     



      







       
    5.  Make sure that the Use an isolated class loader
for this shared library check box is not selected.





       
    6.  Click Apply, then click OK, and save your changes.





       
    7.  Add the shared library you just created to each IBM Connections application you
identified that this handler needs to be deployed to. If your handler
is a pre-event handler, or a post-event handler which will be invoked
synchronously, then perform the following steps for each IBM Connections application that it needs to
run in. If your handler is a post-event handler which needs to be
invoked asychronously, then perform the following steps only for the News application.


       
        


         
      1.  Expand Applications > Application Types, and then click WebSphere
enterprise applications.





         
      2.  Select the checkbox next to the application with which
you want to associated the library.





         
      3.  Under References, click Shared library references. 





         
      4.  Select the checkbox next to the application name, and
then click Reference shared libraries.





         
      5.  From the list of available handlers, select the handler
name that you created and follow the instructions on the page to move
the handler to the Selected list.





         
      6.  Click OK, and then click OK again.





         
      7.  Save your changes.





         
      8.  Repeat these steps for any other applications that need
to run this event handler.


      






       
    8.  Start the wsadmin client from the following directory of
the system on which you installed the deployment manager: 


      



       
        


         
      1.  Open a command prompt, and then
change to the following directory of the system on which you installed
the deployment manager: 


          

        app_server_root\profiles\dm_profile_root\bin
        

        ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01. For example,
on

        Windows:


        C:\Program Files\IBM\WebSphere\AppServer\profiles\Dmgr01\bin
        

         You must run the following command to start the wsadmin
client from this specific directory because the Jython files for the product are stored here. If you try to start the client from a different
directory, then the execfile() command that you subsequently call
to initialize the administration environment for an IBM Connections component does not work correctly. 







         
      2.  Enter the following command to
start the wsadmin client: 


         
          


           
        •  AIX or Linux:


          ./wsadmin.sh -lang jython -user admin_user_id -password admin_password -port SOAP_CONNECTOR_ADDRESS Port
          






           
        •  Microsoft

          Windows:


          wsadmin -lang jython -user admin_user_id -password admin_password -port SOAP_CONNECTOR_ADDRESS Port
          



        





         where: 


         
          


           
        •  admin_user_id is the user name of a person
in the Administrator role on the IBM WebSphere Application Server.





           
        •  admin_password is the password of the WebSphere Application Server
administrator. 





           
        •  SOAP_CONNECTOR_ADDRESS Port is the SOAP
port for the WebSphere Application Server deployment manager server. The default value of the SOAP port
is 8879. If you are using the default port value, you do not need
to specify this parameter. If you are not using the default and you
do not know the port number, you can look up its value in the WebSphere Application Server
Integrated Solution Console. To look up the SOAP port number, perform
the following steps:


           
            


             
          1.  Open the WebSphere Application Server Integrated Solution Console for the deployment manager, and
then select System Administration > Deployment Manager.





             
          2.   In the Additional properties section expand Ports,
and then look for the SOAP_CONNECTOR_ADDRESS port entry to find the port number.


          



        






         For example:


         
          


           
        •  AIX or Linux: 


          ./wsadmin.sh -lang jython -username primaryAdmin -password p@assword -port 8879
          






           
        •  Microsoft

          Windows: 


          wsadmin -lang jython -username primaryAdmin -password p@assword -port 8879
          



        







         
      3.  Access the IBM Connections configuration files: 


        execfile("connectionsConfig.py")
        






         
      4.  Check out the events-config.xml file : 


        LCConfigService.checkOutEventsConfig("<working_directory>","<cell_name>")
        

        ...where:


         
          


           
        •  <working_directory> is the temporary working directory to which
the configuration XML and XSD files are copied and are stored while
you make changes to them. Use forward slashes to separate directories
in the file path, even if you are using the Microsoft Windows operating
system. 


            AIX and Linux only: The directory must
grant write permissions or the command will not run successfully.






           
        •  <cell_name> is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, type the following command while in the wsadmin
command processor:


          print AdminControl.getCell()
          



        






         
      5.  From the working directory to which you checked out
the configuration files, open the events-config.xml file in a text
editor.





         
      6.  Do one of the following: 


         
          


           
        •  If you are deploying a pre-event handler, add a new <preHandler>
element in the <preHandlers> element, following the example shown
in the file.





           
        •  If you are deploying a post-event handler, whether it is synchronous
or asynchronous, add a new <postHandler> in the <postHandlers>
element, following the example shown in the file.


        






         
      7.  For each type of handler, add the following attributes: 


         
        name
        




         
        The name of the event handler. This is an arbitrary name.
        




         
        enabled
        




         
        Set to true to ensure this handler is enabled.
This attributes can be set to false to disable the handler.
        




         
        class
        




         
        The Java class that provides
the handler implementation.
        

        
If you are defining a post-event handler, in the <postHandler>
element also specify the following attribute:


         
        invoke
        




         
        Identify if the handler should be invoked synchronously or asynchronously
using one of the following values:


         
          


           
        •  ASYNC





           
        •  SYNC


        

        

        






         
      8.  Add a <subscriptions> element to your handler definition.
Within this element, create one or more <subscription> elements.
Each subscription element tells the runtime about the events this
handler will consume. For each <subscription> element, define the following attributes: 


         
        source
        




         
        Set the source of the event. Valid values include:


         
          


           
        •  * (Indicates all applications)





           
        •  ACTIVITIES





           
        •  BLOGS





           
        •  BOOKMARKS





           
        •  COMMUNITIES





           
        •  FILES





           
        •  FORUMS





           
        •  HOMEPAGE





           
        •  MOBILE





           
        •  NEWS





           
        •  PROFILES





           
        •  SEARCH





           
        •  WIKIS


        

        




         
        type
        




         
        Set the type of event to consume. Valid values include:


         
          


           
        •  * (Indicates all types)





           
        •  ACKCOM





           
        •  APPROVE





           
        •  AUDIT





           
        •  COMMAND





           
        •  CREATE





           
        •  DELETE





           
        •  DISMISS





           
        •  FLAG





           
        •  INACTIVE_UPDATE





           
        •  MEMBERSHIP





           
        •  MODERATE





           
        •  NOTIFY





           
        •  QUARANTINE





           
        •  PEND





           
        •  PRECREATE





           
        •  READ





           
        •  REJECT





           
        •  RESTORE





           
        •  RETURN





           
        •  UPDATE


        

        




         
        eventName
        




         
        Set the event name to subscribe to. This can be any event
name, or * for all event names. You cannot provide a partial event
name nor use wild cards to prompt the application to search for the event name. For a list of the events available in IBM Connections, see the Events Reference wiki article.
        

        

         A value for each of these attributes
is required. 





         Examples:


         
          


           
        •  To subscribe to all events generated, specify the following:


          <subscription source="*" type="*" eventName="*"/>
          






           
        •  To subscribe to all create events from all components, specify
the following:


          <subscription source="*" type="CREATE" eventName="*"/>
          






           
        •  To subscribe to all create events from the Profiles application,
specify the following:


          <subscription source="PROFILES" type="CREATE" eventName="*"/>
          






           
        •  To subscribe to only one specific event from the Profiles application,
specify the following:


          <subscription source="PROFILES" type="*" eventName="profiles.status.updated"/>
          



        






         A single event handler can define multiple subscriptions,
for example:


        <subscriptions>
  <subscription source="PROFILES" type="*" eventName="profiles.status.updated"/>
  <subscription source="PROFILES" type="*" eventName="profiles.status.deleted"/>
</subscriptions>
        







         
      9.  If your event handler defines properties, add a <properties>
element and define one <property> element for each property. The name attribute value must match the name of the property. For example: 


        <properties>
  <property name="logFile" value="/tmp/event.log"/>
</properties>
        






         
      10.  Save and close the events-config.xml file.





         
      11.  Check in the configuration files : 


        LCConfigService.checkInEventsConfig("<working_directory>","<cell_name>")
        

        ...where
you specify the same values you specified in Step 8d for <working_directory>
and <cell_name>.





         
      12.  Stop and restart IBM Connections.


      



    


     
    Related tasks
    

  •   Edit events-config.xml




     Update web addresses in IBM HTTP Server
    





     Update the web addresses that IBM HTTP Server uses to access IBM Connections applications. 


     


     If
you installed and configured IBM HTTP Server after installing IBM Connections, your IBM Connections applications are automatically mapped to the web server. However,
if you installed and configured IBM HTTP Server before installing IBM Connections, manually map the applications.





     Before
continuing with this task, map the application modules to IBM HTTP Server. For more information,
see the Mapping applications to IBM HTTP Server topic.





     If you are using the Files
or Wikis applications, configure IBM HTTP Server to handle file downloads from those applications.
For more information, see the Configuring Files and Wikis downloading topic. 





     If you choose to let the WebSphere Application Server redirect servlet
manage file downloading, configure the server to transfer
data synchronously instead of asynchronously. This configuration helps
avoid errors caused by using too much memory. See the Excessive native memory use in IBM WebSphere Application Server technote for instructions.








     If you
do not install a web server such as IBM HTTP Server, users must include the correct port number
in the web address that they use to access the application. When you
use a webserver, users can access the applications without using port
numbers. 





     By
default, the web address that you enter to access IBM Connections applications includes the port
number for each application. To avoid using port numbers, update the web addresses by editing LotusConnections-config.xml. IBM HTTP Server can
then redirect requests to the appropriate port for each application.





     For more information about editing
configuration files, see the Editing configuration files topic. 





     To update the web addresses to your IBM Connections applications, complete the following steps:


    


     
      


       
    1.  Stop WebSphere Application Server.





       
    2.  Check out LotusConnections-config.xml. The file is stored by default in the following directory: 


       
        


         
      •  AIX: /usr/IBM/WebSphere/AppServer/profiles/profile_name/config/cells/cell_name/LotusConnections-config 





         
      •  Linux: /opt/IBM/WebSphere/AppServer/profiles/profile_name/config/cells/cell_name/LotusConnections-config 





         
      •  Windows: C:\IBM\WebSphere\AppServer\profiles\profile_name\config\cells\cell_name\LotusConnections-config 


      
	  





       
    3.  For each application, update the web addresses specified
in the href and ssl_href properties: 


      <sloc:href>
<sloc:hrefPathPrefix>/application</sloc:hrefPathPrefix>
<sloc:static
href="http://webserver:port"
ssl_href="https://webserver:port">
<sloc:interService 
href="https://webserver:port">
</sloc:href>
      





       where


       
        


         
      •  webserver is the domain name of IBM HTTP Server, such as webserver.example.com.





         
      •  port is the default port number of the application.
Remove the port number when you specify a webserver. 





         
      •  application is the name of an IBM Connections application.


      


       


       Each href attribute in LotusConnections-config.xml is case-sensitive and
must specify a fully-qualified domain name.






       For example, to update the web address for Communities, add the following specifications to the file:





       <sloc:href> 





       <sloc:hrefPathPrefix>/communities</sloc:hrefPathPrefix> 





       <sloc:static href="http://webserver.example.com"





       ssl_href="https://webserver.example.com">





       <sloc:interService  href="https://webserver.example.com"> 





       </sloc:href>





       
       To use a reverse proxy,
the web addresses defined in this file must be updated to match the appropriate proxy server URLs. Go to the IBM Connections wiki for
more information about deployment scenarios, including how to configure
a reverse proxy.







       
    4.  Save and check in LotusConnections-config.xml.





       
    5.  Synchronize the nodes.





       
    6.  Log on to each application to ensure that the web addresses
in the navigation bar are correct.


    

     
    Results
    You can access each application without needing to specify
a port number.




     Use the To Do List widget
    

    


     Use the To Do List widget to find out which of your task
deadlines are approaching. The widget displays in the activity stream
views by default.




The To Do List widget lists the to-do items that are assigned
to you. The items are listed in chronological order, allowing you
to quickly scan through them and identify which are most urgent. The to-do items that do not have a due date are displayed under items
with a due date.

    


     Use the To Do List widget in the following ways.

      


       
    •  To view individual to-do items:


       
        


         
      1.  Click a to-do title to open it in Activities. For information
about how to work with your to-do items, click ? to
access the help for Activities.





         
      2.  When you are finished working with the to-do item, close
the window to return to the Home page.


      






       
    •  If you do not have any to-do items, click Go
to my to do list to open the Activities application and
start creating items. For information about how to create
a to-do item, see Add a to-do entry.


    




    How do I add and remove wiki members?
    

    


     You can add and remove wiki members if you are an owner
of the wiki. You can also change a member's access.







     Membership and access to community wikis is managed in
the community. There is a direct mapping between membership roles
in the community and the wiki. Community owners can edit wiki settings
and delete the wiki. Community members can create and edit pages in
the wiki. Users who are not members of the community can only read
the wiki content. See the Communities wiki help for more information.


    


     Do the following to add, remove, or edit the access of
wiki members:


     
      


       
    1.  Open the wiki.





       
    2.  In the navigation box click Members.





       
    3.  Optional: Do any of the following to change
the list of members:

        


         
      •  Expand the Role section and select Reader, Editor,
or Owner to only show members with that access.





         
      •  Expand the Kind section and select Person or Group to
only show person or group type members.


      






       
    4.  Do any of the following:




      
    

      Option
    Description

      


       To add a member or group

    
      		


       


       
        


         
      1.  Click Add Members.





         
      2.  Select one of these access levels:


         
          


           
        •  Editor: Editors can read, edit, comment,
create, and recommend pages.





           
        •  Reader: Readers can read and recommend
pages.





           
        •  Owner: Owners can read, edit, comment,
create, recommend, and delete pages, tag the wiki, and change the wiki description.


        






         
      3.  Set the name and select it.





         
      4.  Click Add Groups.





         
      5.  Select Editor, Reader,
or Owner.





         
      6.  Set the name and select it.





         
      7.  Click OK.


      





        When you add a wiki member, they receive an email notification
saying they are a member.





      


       To remove a member

    
      		


       


       
        


         
      1.  Check the boxes next to the names of members.





         
      2.  Click Remove Members.


      





      


       To change member access

    
      		


       


       
        


         
      1.  Click Edit next to their name.





         
      2.  Select one of these access levels:


         
          


           
        •  Editor: Editors can read, edit, comment,
create, and recommend pages.





           
        •  Reader: Readers can read and recommend
pages.





           
        •  Owner: Owners can read, edit, comment,
create, recommend, and delete pages, tag the wiki, and change the wiki description.


        






         
      3.  Click OK.


      




      



    


     
    Related tasks
    

  •   Remove a person's or a group's access




     Configure IBM HTTP
Server
    





     Configure IBM HTTP
Server to manage web requests to IBM Connections.





     When you have successfully
installed IBM Connections to
run on WebSphere Application Server, you can configure IBM HTTP
Server to handle web traffic by completing
the following tasks:


     
    Related tasks
    

  •   Manage user data using Profiles administrative commands




     Manage inappropriate content
    





     You can manage inappropriate content in IBM Connections using moderation, deleting bookmark
links, creating global administrators, and trusting owners to delete
content.





     See Configuring Moderation for related information.



    

    Application
    Ways to manage inappropriate content




    


     Activities

    
    		


     Create a global administrator. See Administering
application content.




    


     Blogs

    
    		


     
      


       
    •  Enable administrator moderation.





       
    •  Enable owner moderation.





       
    •  Enable the moderation service and create a global moderator.


    





     See Moderation overview. 




    


     Bookmarks

    
    		


     Use commands to delete links. See Deleting
unnecessary links.




    


     Communities

    
    		


     
      


       
    •  Create global administrator. See Administering community
content.





       
    •  Enable community owner moderation. When owner moderation is enabled,
community owners can manage the content of their communities.





       
    •  Enable the moderation service and create a global moderator to
manage community files.


    





     See Moderation overview and Moderating
community content. 




    


     Files

    
    		


     File owners can delete versions of the file
that contain inappropriate content. They can also delete comments
with inappropriate content.




    


     Forums

    
    		


     Enable the moderation service and create
a global moderator to manage content. See Moderation overview.




    


     News

    
    		


     A news administrator can delete all status
updates, board messages and community status updates and comments
if they have been enabled. 




    


     Wikis

    
    		


     Wiki owners can move pages to the trash and
then delete them. They can also delete page versions, comments, and
attachments. See Moderation overview.




    





    Related
    

  •  Moderation overview


    

  •   Administer community content

  •   Delete unnecessary links




     Administer Search
    





     The Search service provides a point for performing full
text and tag searches across all the deployed IBM Connections applications. Search is a required
application for all IBM Connections applications, and it must be running to prevent unexpected behaviors
in the other applications.





     IBM Connections Search is
based on multifaceted search technology and uses related people, related
dates, related tags, and source application facets. This information
enables users to drill down into specific facets to find the content
that they want without having to page through large numbers of results.





     During the indexing process, bookmarks created in the Activities,
Communities, and Bookmarks applications are indexed into the same
document, and the details of the link, such as its tags, are used
to supplement the document in the index. For example, a blog posting
that was bookmarked in the Bookmarks application has facets for both
Bookmarks and Blogs.





     Search results in IBM Connections are based on the following facets.



    Table 136. IBM Connections search facets

    Facet
    Description




    Date
    The set of dates associated with the search
results.


     This facet enables users to filter search results first
by year, and then by year and month.




    Tags
    The complete set of tags used for the full text
result set, including tags associated with bookmarks created in the Bookmarks, Activities, and Communities applications.



    Related people
    The complete set of users associated with the full text result set. This facet includes associations mined from
bookmarked content in Activities, Bookmarks, Communities, Files, Forums,
and Wikis. Related people also include shared authors on blogs and
people who have commented on blogs.



    Source component
    The IBM Connections application from which the results were retrieved.


     Users can filter
results by source using the options at the side of the Search
Results page.




    

These facets are calculated at indexing time for optimum performance
at search time.



    Related
    

  •   Troubleshoot Search




     Administer
the News repository
    





     You administer the News repository
using scripts accessed
using the wsadmin client. Changes to News configuration settings require
node synchronization and a restart of the Home page server before
they take effect.





     Events are generated by
the different IBM Connections applications whenever an activity occurs in the system. Information
about these events is stored in the News repository, and the Home
page application pulls data from the repository to display only the events that are relevant to a particular user on that user's
Home page. You can configure News configuration settings to control
how the information that the Home page receives from the News repository
is stored and administered.



    Related
    

  •   Manage users

  •   Synchronize user data using administrative commands




     Manage the Search application
    





     You can perform the following tasks when managing the Search
application.


     

  •  SearchService commands

  •  SearchCellConfig commands




    Activity stream search
    





     The activity stream search service provides an indexing
and search infrastructure that is bundled with the News application.
This service provides search capabilities over the activity stream.





     The activity stream search service is automatically configured
to crawl the activity stream seedlist at regular intervals. By default,
the interval is set to 30 seconds. After an initial crawl of the activity
stream, subsequent crawls are incremental, and only new events that
were generated since the previous crawl are collected. When you install IBM Connections, the crawler is
disabled by default.





     Crawling and indexing is carried out on one of the servers in the cluster where the News application is deployed. This server is chosen
automatically by the WebSphere High Availability (HA) Manager. If News becomes unavailable on this server, a different server that is
running News is chosen by WebSphere HA to replace it. For each crawling
session, the indexing server creates a delta index in a shared file
system and sends a notification to other nodes in the cluster. This delta index is read from shared file system by the other nodes and
merged into the main index on the local disk. All the cluster nodes
serve search requests by reading from the local index. Configuration
and status information for the crawlers is stored in database tables
that are available to all the nodes. Delta indexes are stored for
24 hours. If a node is down for more than 24 hours, you need to copy
the index manually to that node from another node. In the event that
a node is unavailable, the other nodes can still perform search requests
with no interruption.





     Administrative users can manage the activity stream search service
from a user interface that is accessed using a URL. From the Activity
Stream Search Administration page, you can enable or disable
the crawler, and edit the crawl schedule. You can also clear the current
indexed content and perform a full crawl if required. To access the page, you must be assigned the search-admin role. For more information
about this role, see the Roles topic.


     

  •  Roles




     Delete microblog data
    





     The News administrator can delete any status update or
comment from the Home page, Profiles, and Communities applications
by clicking the X icon next to the status update or comment in the user interface.





     To delete microblog data, the administrator must be assigned the admin role for the News application. For information about how to
assign a role, see Assigning people to J2EE roles.


     
    Related tasks
    

  •   Assign people to J2EE roles




     Administer microblogs
    





     You can perform a number of administrative tasks to manage
the microblogging feature in IBM Connections.





     You can control the size and display of microblog entries in your deployment by editing settings in the news-config.xml file.
In the event of a system crash, you can use administrative commands
to synchronize microblog data with the Communities database or remove
orphaned community microblog data.


     
    Related tasks
    

  •   Disable microblogging




     Synchronize microblog data with Communities
    





     Use the NewsMicrobloggingService.exportSyncedResourceInfo
command to return an XML synchronization report of the community resources
held in the News repository. The report contains information about
the current state of microblog data in the community activity stream.





     This information can help you to synchronize the microblog data
with the Communities database after a system crash that involves data
loss. For more information, see Recovering from a database failure.



    Related
    

  •   Recover from a database failure


    

  •   Restore communities with remote applications

  •   Compare remote application data with the Communities database




    Back up the Search index
    





     You can back up the Search index using SearchService commands
or you can manually copy the index files to a backup location.





     Note that the Search index has a dependency on the HOMEPAGE database.
The Search index can be backed up and restored independently of the HOMEPAGE database as long as the HOMEPAGE database remains current.
However, if the database is restored, a corresponding Search index
backup must be restored with it.



    Related
    

  •   Restore the Search index


    

  •   Restore a Search index in a single-node environment

  •   Restore a Search index in an environment with multiple nodes

  •   Restore a Search index without restarting individual nodes


     

  •  SearchService commands




     Configure dictionaries for Search
    





     The Search
application provides globalization support by
using different dictionaries for different languages. Each dictionary
file must be enabled in the Search configuration file before indexing.
By default, only the English language dictionary is enabled during
installation.





     Every language has its
own specified dictionary file. Dictionaries
that are marked as enabled in the Search configuration file are loaded
into memory at server start time when the Search application is started.

      For non-English deployments, enabling multilingual
support for Search is a mandatory post-installation step that needs
to be performed before you start your IBM Connections Search server for the first time. Without multiple dictionary support,
for languages other than English, Search will only return results

    ...where there is an exact match between the search term and content
term. Enabling multiple dictionaries ensures better quality search
results when your user base is multilingual.




    Related
    

  •  Search and globalization


    

  •  Recreating the Search index

  •   Create the initial Search index




     Configure scheduled tasks
    





     The SearchService MBean is used to access a service that
provides an administrative interface for adding scheduled task definitions
to the Home page database.





     To configure scheduled tasks for Search, use the SearchService
administration commands to add and delete scheduled task definitions,
and or to enable or disable indexing task definitions in the Home
page database.





     You can also use SearchService commands get a list of the tasks
that are scheduled for the Search application, and to list the tasks
that are currently running for Search.


     
    Related tasks
    

  •  Add scheduled tasks for the social analytics service


     

  •  SearchService commands

  •  Search default scheduled tasks




     Create Search indexes
    





     Search indexing is automatically configured for IBM Connections during installation.





     To create the initial Search index after installing the product,
wait for one of the default indexing tasks to run and this will automatically
create the index. The next step is for the Search application to copy
the index to all the nodes. The index is first saved to a staging
folder, and then it is copied from the staging folder to all the secondary
nodes in the deployment. You must not stop your deployment until the index has been copied to all the nodes. If the server is stopped during
this process, the index will not be successfully rolled out to all
the nodes.





     To create subsequent indexes, for example, if the index has become
corrupt or unusable, delete any existing indexes, and then either
wait for the next scheduled indexing task to run or run a one-off
indexing task. Alternatively, if the index is still functional, to
avoid disrupting your users. access to Search functionality, you can
recreate the Search index by running a wsadmin command to create a
background index.


     

  •  Search default scheduled tasks




    Search index folder structure
    





     IBM Connections 4
has a new folder structure in which each application has its own index
folder.





     Because of this new folder structure, a new index must be built
for IBM Connections 4. You cannot
migrate an index from a previous version of the product. In addition,
it is important to note that there are dependencies between the application
index folders, so that, for example, deleting an application index
folder can cause index corruption and lead to other issues.





     The new application-specific index folders are named index_application_name.
The Search index folder is defined by the WebSphere Application Server variable SEARCH_INDEX_DIR.



    Table 137. Application index folders

    Application
    Index folder




    Activities
    index_activities



    Blogs
    index_blogs



    Bookmarks
    index_bookmarks



    Calendar
    index_calendar



    Communities
    index_communities



    Files
    index_files



    Forums
    index_forums



    Profiles
    index_profiles



    Social analytics
    index_sand



    Status updates
    index_status_updates



    Wikis
    index_wikis



    

Each index folder contains doctype, facets, filesTemp, and
graph files. After the index is built, each folder also contains an
INDEX.READY file and a CRAWLING_VERSION file.





     The following new folders are also used by the Search application:


     
    index_backup
    




     
    When the SearchService.backupIndexNow() command is run, the index
is backed up to this folder. This folder is contained in the data\local\search directory.
The folder location is specified by the WebSphere Application Server variable SEARCH_INDEX_BACKUP_DIR.
    




     
    staging
    




     
    After the initial index is built, it is copied to this folder
before it is rolled out to all the nodes in the deployment. This folder
is located on the network share. The folder location is specified
by the WebSphere Application Server variable SEARCH_INDEX_SHARED_COPY_LOCATION.
    




     
    persistence
    




     
    This folder contains the XML files that are created after an application
is crawled. These files are used to build an index for the application.
This folder is contained in the data\local\search directory.
The folder location is specified by the WebSphere Application Server variable CRAWLER_PAGE_PERSISTENCE_DIR.
    




     
    extracted
    




     
    This folder holds documents that contain the content extracted
from files. This folder is located on the network share. The folder
location is specified by the WebSphere Application Server variable EXTRACTED_FILE_STORE.
    

    



     

  •  WebSphere Application Server environment variables




    Search and globalization
    





     You can configure globalization settings to enable users
to perform accent-insensitive searches, ignore punctuation in search
terms, and perform a one-to-two mapping in search terms. Search globalization
settings are disabled by default.





      For non-English deployments, first enable the relevant language dictionary for your geography. This procedure is
a mandatory post-installation task. Without multiple dictionary support
for languages other than English, Search will only return results

    ...where there is an exact match between the search term and content
term. Enabling multiple dictionaries ensures better quality search
results when your user base is multilingual. By default, only the English language dictionary is enabled during installation. For more
information about enabling multilingual support, see Configuring
dictionaries for Search.





     When your organization spans multiple geographies and multiple
languages, you might find it useful to enable the globalization options
provided by the Search application. Note that when these options are
enabled, Search requires more terms to be indexed, resulting in a
larger Search index that contains the extra globalized terms. As more
terms need to be indexed, this means that the indexing task will take
longer to complete.





     Search provides the following globalization options: 


     
    Accent-insensitive search
    




     
    Allows users to search for equivalent non-accented search terms
when using a search term that contains an accent.


     For example, the default behavior of the Search application is to index the term á
as a single term. However, when accent sensitivity is enabled, the term á is stored in the index as "á" and "alt".

    




     
    Ignore Punctuation
    




     
    Allows users to search for equivalent search terms without using
punctuation in the search term that contains the punctuation.


     For example, the default behavior of the Search application is to index
I.B.M. as a single term. However, when the ignore punctuation setting
is enabled, the term I.B.M. is stored in the index as I.B.M. and IBM.

    




     
    1 to 2 matching
    




     
    Allows users to search for equivalent search terms using the stem
of characters in the Search term.


     For example, the default behavior
of the Search application is to index Müas a single term. However,
when the 1 to 2 matching setting is enabled, the term Müis stored
in the index as Müand Mueller.

    

    






      Enable the globalization options results in a larger index. When
you choose to enable these options, you must delete the current index
to generate the creation of a new one. For more information, see Deleting
the index.





      Enable these settings for Search also affects the relevance of
the results returned when a search is performed. The default behavior
is to return search results for a term based on an exact match of
the term. However, if these globalization settings are enabled, more
search results are returned to the user. For example, performing an
accent-insensitive search for the term curéight return results for
cure and curéThis type of search can lead to less relevant search
results being returned to the user. The English translation of the French term cure is treatment, while curés a priest.





     For information about how to configure the globalization properties
for Search, see Common configuration properties.



    Related
    

  •   Configure dictionaries for Search


    

  •   Delete the index


     

  •  Common configuration properties




    The indexing process
    





     The Search index is generated by retrieving information
from each of the applications based on a schedule defined by the administrator.
Search uses the IBM WebSphere Application Server
scheduling service for creating and updating the Search index. The index must be deployed on each node running the Search enterprise
application.






     
    Indexing overview
    Search indexing happens in
several stages:


     
    Crawling
    




     
    Crawling is the process of accessing and reading content from
each application in order to create entries for indexing.


     During
the crawling process, the Search application requests a seedlist from
each IBM Connections application.
This seedlist is generated when each application runs queries on the data stored in its database, based on the parameters that the Search
application submits in its HTTP request.





     The contents of the seedlists are persisted to disk. They are deleted when the next incremental
indexing task completes successfully.

    




     
    File content extraction
    




     
    Search provides a document conversion service to extract the content
of the files to be indexed. During the file content extraction stage,
the document conversion service downloads files to a temporary folder
in the index directory and converts them to plain text. The extracted
text is then indexed.


     IBM Connections supports the indexing of file attachment content from the Files and
Wikis applications only.





     File content extraction takes place
on the schedule defined for the file content extraction task, which
runs every 20 minutes by default.

    




     
    Indexing
    




     
    During the indexing phase, the entries in the persisted seedlists
are processed into Lucene documents, which are serialized into a database
table that acts as an index cache.


     When the indexing phase is complete,
the seedlists are removed from disk. A resume token marks where the last seedlist request finished so that the Search application can
start from this point on the next seedlist request. This resume token
enables Search to retrieve only the new data that was added after
the last seedlists were generated and crawled.





     The crawling
and indexing stages for multiple applications take place concurrently
in incremental foreground indexing. For example, if an indexing task
that indexes Files, Activities, and Blogs is created, each of these
applications is crawled and added to the database cache at the same
time. During initial and background indexing, only the crawling stage
for multiple applications takes place concurrently.





     During incremental
foreground indexing, after the crawling and indexing stages are complete,
all the nodes are notified that they can build their index. At this
point, the index builder on each node begins extracting entries from
the database cache and storing them in the index on the local file
system.

    




     
    Index building
    




     
    Index building refers to the deserialization and writing of the Lucene documents into the Search index. This process only occurs during
incremental foreground indexing. During index building, the index
builder takes entries from the database cache and stores them in an
index on the local file system. Each node has its own index builder,
so crawling and preparing entries only takes place once in a network
deployment, and then the index is created on each node from the information
that has already been processed. 


     During initial and background
indexing, the indexing stage and the index building stage are merged,
and no database serialization or deserialization occurs.

    




     
    Post processing
    




     
    After the index has been built from the database cache, post-processing
work takes place on the new index entries to add additional metadata
to the search results, such as bookmark rollup and the addition of
file content to Files search results.


     Bookmark rollup refers to
the process of aggregating the information for public bookmarks that
point to the same URL. For example, if 1000 users create a public
bookmark for the same URL, when someone searches for that URL, a single
bookmark is returned instead of 1000 search results. The bookmark
that is returned includes the information for all 1000 bookmarks rolled
up into a single search result, so that all of the tags and people
associated with each of the individual bookmarks are now associated
with the one document.





     In addition, if two
users bookmark the same internal document, for example, a wiki page,
then the wiki page gets rolled up with the bookmark so if the user
then searches for the wiki page or the bookmark that they created
to the wiki page, only one result is returned in the search results.
The tags and people associated with the bookmark and the wiki page
are combined into a single document.

    

    







     
    Indexing types
    The following table explains
the differences between the various types of indexing:



    Table 138. Types of indexing

     
    Foreground indexing
    Background indexing




    Initial indexing
    The initial index is built using the default
15min-search-indexing-task.


     Alternatively, it can be built by a
custom indexing task created by the SearchService.addIndexingTask
command or a command that is run once, such as SearchService.indexNow(String
applicationNames).





     This index is used for searching and for
further indexing. The database cache is not used.

    
    		An index is built using the SearchService.startBackgroundIndex
command.


     The background indexing command creates a one-off index
in a specified location on disk.





     This index is not used for
searching. The database cache is not used.




    Incremental indexing
    The index is updated using the default 15min-search-indexing-task.


     Alternatively,
the index can be updated by a custom indexing task created by the SearchService.addIndexingTask command or a command that is run once,
such as SearchService.indexNow.





     This index is used for searching
and for further indexing. The database cache is used.

    
    		A background index can be updated using the SearchService.startBackgroundIndex command.


     This index is not used
for searching. The database cache is not used.




    








     
    Indexing steps
    The indexing process involves
the following steps: 


     
    Initial and background indexing
    




     
    


     
      


       
    1.  Crawl all pages of the seedlist and persist them to disk.





       
    2.  Extract the file content and persist it to disk.





       
    3.  Crawl a seedlist page from disk.





       
    4.  Index the seedlist entries into Lucene documents.





       
    5.  Write the documents to the Lucene index.





       
    6.  Repeat until all the persisted seedlist pages have been crawled.


    

    




     
    Incremental foreground indexing
    




     
    


     
      


       
    1.  The node that has the scheduler lease crawls all the pages of
the seedlist and persists them to disk.





       
    2.  Crawl a seedlist page from disk.





       
    3.  Index the seedlist entries into Lucene documents.





       
    4.  Serialize the Lucene documents into the database cache.





       
    5.  Send a JMS message to all Search nodes to alert them of the completion
of the serialization.





       
    6.  Each node deserializes the Lucene documents into the Lucene index.


    

    

    


    After the index has been built from the database
cache, post-processing work takes place on the new index entries to
add additional metadata to the search results, such as adding the content of files to Files search results and linking bookmark information
to URLs.



    Related
    

  •   Schedule tasks

  •   Validate Search seedlists


    

  •   Enable indexing resumption

  •   Configure page persistence settings

  •   Configure the number of indexing threads

  •  Recreating the Search index


     

  •  Seedlist response




    Index settings
    





     Indexing is automatically configured in IBM Connections. However, when setting up indexing
for your environment, you might need to perform additional configuration
tasks.





     Important for non-English deployments: Enabling
multilingual support for Search is a mandatory post-installation step
that needs to be performed before you start your IBM Connections Search server for the first time.
Without multiple dictionary support, for languages other than English,
Search will only return results where there is an exact match between
the search term and content term. Enabling multiple dictionaries ensures
better quality search results when your user base is multilingual.
For more information about enabling multilingual support, see Configuring
dictionaries for Search.





     By default, the IBM Connections user interface is displayed in the language identified in the locale
settings of the web browser being used. You can set it up to allow
users to explicitly choose the language in which the product is displayed.
For more information, see Enabling users to set a language preference.





     You can also perform optional post-installation configuration tasks
relating to indexing, such as configuring J2C authentication for Search
or changing the location of the Search index.


     
    Related tasks
    

  •   Enable users to set a language preference




     Manage the Search index
    





     The Search application uses a Lucene 3.0.3 index, supplemented
by social facet information. The location of the Search index is mapped
to an IBM WebSphere Application Server variable,
SEARCH_INDEX_DIR. The value of this variable is set to CONNECTIONS_DATA_DIRECTORY/search/index by
default.





     The index is generated by retrieving all the necessary information
from each IBM Connections application
on an administrator-defined schedule. Each task defines which applications
to crawl and whether to optimize the index at the end of the task.
The following applications can be indexed: Activities, Blogs, Bookmarks,
Communities, Files, Forums, Profiles, and Wikis. Status updates and
community calendar events can also be indexed.





     Search uses the WebSphere Application Server scheduling service for creating and updating the Search index.
The scheduling service is based on the Cron calendar, which uses predefined
date algorithms to determine when a task should run. While the scheduling
service supports the use of a Simple calendar, this is not currently
supported for IBM Connections.
For more information about the WebSphere Application Server scheduler, see Scheduling tasks.





     IBM Connections applications
maintain delete and access-control update information for a maximum
of 30 days. If indexing is not performed on an index for 30 days,
that index is considered to be out-of-date and reindexing is necessary.
You must delete and recreate the index to ensure data integrity.





     


      When indexing on a Microsoft Windows 2008 deployment, you
might get the following error: java.io.IOException: Access is denied.
This error is caused by an underlying Lucene issue and prevents the index from being updated. To resolve the problem, restart all the machines in the cluster.




    Related
    

  •   Schedule tasks

  •   Troubleshoot Search

  •   Restore the Search index




     Restore the Search index
    





     When you create a backup copy of the Search index, you
can use the copy to restore the index in the event of loss or corruption.





     The process for restoring the Search index differs depending on
the number of nodes in your deployment. In an environment with multiple
nodes, you must restore the backup consistently for all the nodes.



    Related
    

  •  Back up the Search index

  •   Manage the Search index


    

  •  Back up the Search index using wsadmin commands

  •  Back up the Search index manually

  •  Add an additional Search node to a cluster

  •   Create a background index




     Administer the social analytics service
    





     The social analytics widgets that are available from Communities,
Profiles, and the Home page use the Search application as a data provider.





     The social analytics framework used by the widgets analyzes the social elements of the Search application to generate an index and
map complex relationships between users and content. This mapping
information is stored with the Search index, and is leveraged to provide
users with recommendations of content that might interest them.



    Related
    

  •  Social analytics widgets


     

  •  SearchService commands




     Moderate
blogs programmatically
    





     Use the Atom Publishing Protocol,
also known as AtomPub,
to moderate blog content.





      Use the IBM WebSphere Application Server Integrated
Solutions Console, you can define one or more moderators who can control
the content that is published in blogs in the Blogs application in
the following ways:


     
    Premoderation
    




     
    This setting
requires that all posts and comments added to all
blogs be approved by the moderator before they are published. 
    




     
    Post-moderation
    




     
    This setting enables
users to flag published content as inappropriate.
Flagged content is then reviewed by the moderator, who determines
what to do with the posting or comment in question.
    

    
The
moderator cannot be defined programmatically; see Roles for
more information about how to add people to the moderator role. Additionally,
you cannot configure which types of moderation to use programmatically;
see Managing content moderation and flagged content for
information about how to enable moderation. 





     All users can do
the following things programmatically:


     
      


       
    •  Flag content as inappropriate.





       
    •  Get a list of inappropriate content flag types.


    






     Moderators
can do the following things programmatically:


     
      


       
    •  Get a list of
new entries and comments that need to be reviewed
before they can be published.





       
    •  Take action on pending content.





       
    •  Get a list of published content that has been flagged as inappropriate
and needs to be reviewed.





       
    •  Take action on flagged content.





       
    •  Get a history of the moderation actions taken on a particular
blog posting or comment.


    




    Related
    

  •  Moderation overview




     Moderate
community files and comments programmatically
    





     Use
the Atom Publishing Protocol, also known as AtomPub,
to moderate community files and comments.





      Use the WebSphere Application Server Integrated Solutions Console, you can define one or more moderators
who can control the content that is published in the community files
in the following ways:


     
    Premoderation
    




     
    This
setting requires that all community files and comments be
approved by the moderator before they are published. 
    




     
    Post-moderation
    




     
    This setting enables users to
flag published content as inappropriate.
Flagged content is then reviewed by the moderator, who determines
what to do with the community file or comment in question.
    

    
The moderator cannot be defined programmatically; see Roles for
more information about how to add people to the moderator role. Additionally,
you cannot configure which types of moderation to use programmatically;
see Managing content moderation and flagged content for
information about how to enable moderation. 





     All users can do
the following things programmatically:


     
      


       
    •  Flag content as inappropriate.





       
    •  Get a list of inappropriate content flag types.


    






     Moderators
can do the following things programmatically:


     
      


       
    •  Get a list of
new community files and comments that need to be
reviewed before they can be published.





       
    •  Take action on pending
content.





       
    •  Get a list of published content that has been flagged
as inappropriate
and needs to be reviewed.





       
    •  Take action on flagged content.


    




    Related
    

  •  Moderation overview

  •   Moderate the content in a community




    Files API
    





     The Files application of IBM Connections enables teams to create a shared repository of files. The Files API
allows application programs to add files to a collection and to read
and modify existing files. 





     Files implements the following APIs:


     
    Subscription
    




     
    Files implements the Atom
Syndication Format (Atom 1.0) to serve
Atom feeds that you can use in your applications to search for and
retrieve files added to a collection by the people in your organization.
The format documented here is what feed readers use to discover new
or updated files.
    




     
    Publishing
    




     
    Files
implements the Atom Publishing Protocol to enable you to
programmatically manipulate files. Files provides a service document
and some category documents. The service document contains the currently
authenticated user's collections and feeds. You can use the publishing
APIs in your applications to perform actions, such as adding a file
to a collection. When interacting with collections to which you have
owner access, you can add a file or update and delete any file. When
interacting with collections to which you have Author access, you
can add a file or update and delete the files that you authored.
    

    





     Moderate
forum content programmatically
    





     Use the Atom Publishing
Protocol, also known as AtomPub,
to moderate forum content.





      Use the WebSphere Application Server Integrated Solutions Console, you can define one or more moderators
who can control the content that is published in the Forums application
in the following ways:


     
    Premoderation
    




     
    This
setting requires that all forum entries and replies be approved
by the moderator before they are published. 
    




     
    Post-moderation
    




     
    This setting enables users to flag published content as inappropriate.
Flagged content is then reviewed by the moderator, who determines
what to do with the entry or reply in question.
    

    
The
moderator cannot be defined programmatically; see Roles for
more information about how to add people to the moderator role. Additionally,
you cannot configure which types of moderation to use programmatically;
see Managing content moderation and flagged content for
information about how to enable moderation. 





     All users can do
the following things programmatically:


     
      


       
    •  Flag content as inappropriate.





       
    •  Get a list of inappropriate content flag types.


    






     Moderators
can do the following things programmatically:


     
      


       
    •  Get a list of
new entries and replies that need to be reviewed
before they can be published.





       
    •  Take action on pending content.





       
    •  Get a list of published content that has been flagged as inappropriate
and needs to be reviewed.





       
    •  Take action on flagged content.


    




    Related
    

  •  Moderation overview

  •   Moderate forums




    News administrative commands
    



     Use the commands listed to perform administrative tasks
for the News repository.

    The following sections define the commands that you can use
when working with the News repository. Each section describes the commands for a specific service. The commands are listed in alphabetical
order.


     


     
    




    NewsActivityStreamService
commands
    


     
    NewsActivityStreamService.getApplicationRegistration("applicationId")
    




     
    


     Returns a list of details about the specified application.
This command takes a single argument, which is a string that specifies
the application ID. Use the NewsActivityStreamService.listApplicationRegistrations()
command to retrieve this ID.





     Results are returned as key value
pairs that are separated by commas.





     For example: 


    wsadmin>NewsActivityStreamService.listApplicationRegistrations()
{blogs=blogs, a=null, forums=forums, wikis=wikis, communities=communities, files=files, profiles=profiles, dogear=dogear, activities=activities, homepage=homepage}
    



    wsadmin>NewsActivityStreamService.getApplicationRegistration("communities")
{imageUrl=http://example.com:9082/connections/resources/web/com.ibm.lconn.core.styles/images/iconCommunities16.png, summary=null, isEnabled=true, secureUrl=https://example.com:9445/communities, secureImageUrl=https://example.com:9445/connections/resources/web/com.ibm.lconn.core.styles/images/iconCommunities16.png, appId=communities, displayName=communities, url=http://example.com:9082/communities}
    


    




     
    NewsActivityStreamService.listApplicationRegistrations()
    




     
    


     Returns a list of the applications that are registered with
the News service. The applications are separated by commas and formatted
as follows:


    application ID=Display name or description
    


    




     
    NewsActivityStreamService.registerApplication(appId, displayName,
url, secureUrl, imageUrl, secureImageUrl, summary, isEnabled)
    




     
    


     Registers a new application.





     This command takes the following parameters:


     
      


       
    •  appId. The ID of the application to register.





       
    •  displayName. The name of the application to display
in the product user interface.





       
    •  url. The web address for the application.





       
    •  secureUrl. The secure web address for the application.





       
    •  imageUrl. The web address for an image to associate with the application
in the user interface.





       
    •  secureImageUrl. The secure web address for an image to display
for the application.





       
    •  summary. A short description of the application.





       
    •  isEnabled. A Boolean string that specifies whether the registration
is enabled or disabled.


    





      You must include the appId and isEnabled parameters, but
the remaining parameters are optional. After registering an application,
you might also need to restart the Home page application for the application
to display in the filter list.






     For example:


    NewsActivityStreamService.registerApplication("testApp", "Test Application", "http://www.test.com/gadget.xml", "https://www.test.com/gadget.xml", "http://www.test.com/image.jpg", "https://www.test.com/image.jpg", "summary", "true")
    


    




     
    NewsActivityStreamService.removeApplicationRegistration(appId)
    




     
    


     Removes the specified application registration.





     This
command takes a single parameter, which is the ID of the application
to remove.





     For example, the following command
removes the registration of the testApp application.


    NewsActivityStreamService.removeApplicationRegistration("testApp")
    


    




     
    NewsActivityStreamService.updateApplicationRegistration(appId,
field, value)
    




     
    


     Updates a particular field associated with an existing, registered
application.





     This command takes the following parameters: 


     
      


       
    •  appId. The ID of the application to update.





       
    •  field. The registration field whose information you want to update.
Set this parameter to one of the following values:


       
        


         
      •  displayName. The updated name of the application.





         
      •  url. The updated web address for the application.





         
      •  secureUrl. The updated secure web address for the application.





         
      •  imageUrl. The updated web address of the image to associate with
the application in the user interface.





         
      •  secureImageUrl. The updated secure web address of the image to
associate with the application in the user interface.





         
      •  summary. An updated short description of the application.





         
      •  isEnabled. A Boolean string that specifies whether the registration
is enabled or disabled.


      






       
    •  value. The value of the field that you are updating. When you
are updating the displayName field, summary, or one of the URL fields,
specify the value as a string. When you are updating the isEnabled
field, specify a Boolean string.


    






     For example, the following command disables the registration
of the testApp application:


    NewsActivityStreamService.updateApplicationRegistration("testApp", "isEnabled", "false")
    


    

    



    NewsCellConfig commands
    


     
    NewsCellConfig.checkOutConfig("working_directory",
"cell_name")
    




     
    


     Checks out the News repository configuration files.





     This
command takes the following parameters:


     
    <working_directory>
    




     
    Temporary working directory to which the configuration files are
copied. The files are kept in this working directory while you make
changes to them.
    




     
    <cell_name>
    




     
    Name of the IBM WebSphere Application Server
cell hosting the IBM Connections application. If you do not know the cell name, type the following command while in the wsadmin command processor: 


    print AdminControl.getCell()
    

    

    
For example:


     
      


       
    •  AIX/Linux:


      NewsCellConfig.checkOutConfig("/opt/my_temp_dir", "NewsServerNode01Cell")
      






       
    •  Microsoft®

      Windows:


      NewsCellConfig.checkOutConfig("c:/temp","foo01Cell01")
      



    


    




     
    NewsCellConfig.checkInConfig()
    




     
    


     Checks in the News repository configuration files. Run from
the wsadmin command processor.

    

    



    NewsEmailDigestService
commands
    


     
    NewsEmailDigestService.loadBalanceEmailDigest()
    




     
    


     Reallocates and load balances the users in the email address
groups used by the email digest according to mail domain. This command
does not take any parameters.





     The command returns the number
of users who have been reallocated to different email address groups
for load balancing purposes.





     For example:


    wsadmin> NewsEmailDigestService.loadBalanceEmailDigest()
1603
    


    

    



    NewsMailinService commands
    


     
    NewsMailinService.removeReplyToId("replyto address ID")
    




     
    


     Removes a single reply-to ID.





     This command takes a single
parameter, which is a string that specifies the reply-to ID that you
want to delete.





     For example:


    NewsMailinService.removeReplyToId("c0c7e9bf-32d9-48a7-933c-74794479ebf3")
    


    




     
    NewsMailinService.removeReplyToIdsForUserEmail("user email")
    




     
    


     Removes all the reply-to IDs for the user with the specified
email address.





     This command takes a single parameter, which
is a string that specifies the email address for the user whose reply-to
IDs you want to delete.





     For example:


    NewsMailinService.removeReplyToIdsForUserEmail("mary_smith@example.com")
    


    




     
    NewsMailinService.removeReplyToIdsForUserExtId("user extId")
    




     
    


     Removes all the reply-to IDs for the user with the specified
external ID.





     This command takes a single parameter, which is
a string that specifies the external ID for the user whose reply-to
IDs you want to delete.





     For example:


    NewsMailinService.removeReplyToIdsForUserExtId("91b3897d-b4f8-4d05-3621-50bcaa22d300")
    


    

    



    NewsMemberService
commands
    


     
    NewsMemberService.getMemberExtIdByEmail("email")
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.getMemberExtIdByLogin("login")
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.inactivateMemberByEmail("email")
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.inactivateMemberByExtId("externalID")
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.syncAllMembersByExtId( {"updateOnEmailLoginMatch":
["true" | "false"] } )
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.syncBatchMemberExtIdsByEmail("emailFile" [,
{"allowInactivate" : ["true" | "false"] } ] )
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.syncBatchMemberExtIdsByLogin("loginFile" [,
{"allowInactivate" : ["true" | "false"] } ] )
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.syncMemberByExtId("currentExternalId"[, {"newExtId"
: "id-string" [, "allowExtIdSwap" : ["true" | "false"] ] } ] )
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.syncMemberExtIdByEmail("email" [, { "allowInactivate"
: ["true" | "false"] } ])
    




     
    


     See Synchronizing user data using administrative commands for
details.

    




     
    NewsMemberService.syncMemberExtIdByLogin("name" [, {"allowInactivate":
["true" | "false"] } ])
    




     
    


     See Synchronizing user data using administrative commands for
details.

    

    



    NewsMicrobloggingService
commands
    


     
    NewsMicrobloggingService.deleteMicroblogs("communityId")
    




     
    


     Removes all microblog and associated data for a community from
the News repository.





     This command takes a single parameter,
which is a string that specifies the ID of the community whose microblog
data you want to delete.





     For example:


    NewsMicrobloggingService.deleteMicroblogs("e952cf0c-a86c-4e26-b1e0-f8bf40a75804")
    


    




     
    NewsMicrobloggingService.exportSyncedResourceInfo(filePath, eventType)
    




     
    


     Returns an XML synchronization report of the community resources
held in the News repository. The report contains information about
the current state of microblog data in the community activity stream.





     This
command takes the following parameters: 


     
    filePath
    




     
    String that specifies the full directory path in which to store
the file that is returned by the command. Include the file name in
the file path and use forward slashes. For example: "C:/temp/activity_output.xml"
    




     
    eventType
    




     
    Identifies the type of synchronization event to report about.
The only supported value for this parameter is community. Specify
this value as a singular community and in lower case.
    

    






     For example:


    NewsMicrobloggingService.exportSyncedResourceInfo("C:/temp/news_output.xml","community")
    


    

    



    NewsOAuth2ConsumerService
commands
    


     
    NewsOAuth2ConsumerService.bindGadget(string widgetId, string serviceName,
string clientName, string allowModuleOverride)
    




     
    Binds a gadget to a client with the specified service name and
client name.


     
    widgetId
    




     
    The id of the widget.
    




     
    serviceName
    




     
    The name to associate with the gadget. The widgetId and service
name must create a unique composite key for the deployment.
    




     
    clientName
    




     
    The name of the client to associate with this gadget.
    




     
    allowModuleOverride
    




     
    Value is "true" if the gadget overrides the provider default endpoint
urls, else "false".
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.bindGadget("aad20aa1-c0fa-48ef-bd05-8abe630c0012", "connections_service", "client123", "false")
    


    




     
    NewsOAuth2ConsumerService.browseClient(string providerName, int
pageSize, int pageNumber)
    




     
    Returns a list of Map objects that represent each OAuth 2.0 clients
registered with the consumer proxy, in ascending ordered by provider
name. The following information is returned for each map object in
the returned list:


     
      


       
    •  clientId: the identifier issued by the authorization server when
registering your client





       
    •  clientSecret: the secret issued by the authorization server when
registering your client





       
    •  ctype: the client type, "confidential" or "public" are the supported
values per the specification





       
    •  grantType: "code" per specification, or "client_credentials" per specification





       
    •  name: the name of the client





       
    •  providerName: the name of the associated provider that was previously
registered





       
    •  redirectUri: the client redirection uri


    



     
    providerName
    




     
    An optional filter to only browse clients associated with the specified provider.
    




     
    pageSize
    




     
    The maximum number of clients to list per page. The default value
is 20. This parameter is optional.
    




     
    pageNumber
    




     
    The number of the page to display. For example, if you specify
in the pageSize parameter that each page will have 50 items, page
1 will contain items 1-50. The default value is 1. This parameter
is optional.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.browseClient("provider123", 50, 1)
    


    




     
    NewsOAuth2ConsumerService.browseGadgetBinding(string widgetId,
string clientName, int pageSize, int pageNumber)
    




     
    Returns a list of Map objects that represent each OAuth 2.0 gadget
bindings registered with the consumer proxy ordered by service name
ascending. The following information is returned for each map entry
in the returned list:


     
      


       
    •  clientName: the name of the associated client





       
    •  allowModuleOverride: "true" or "false"





       
    •  serviceName: the name of the associated service





       
    •  uri: the gadget uri 


    



     
    widgetId
    




     
    An optional filter to browse bindings only associated with a specific
widget.
    




     
    clientName
    




     
    An optional filter to browse gadgets only associated with the specified client.
    




     
    pageSize
    




     
    The maximum number of bindings to list per page. The default value
is 20. This parameter is optional.
    




     
    pageNumber
    




     
    The number of the page to display. For example, if you specify
in the pageSize parameter that each page will have 50 items, page
1 will contain items 1-50. The default value is 1. This parameter
is optional.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.browseGadgetBinding("aad20aa1-c0fa-48ef-bd05-8abe630c0012", "client123", 50, 2)
    


    




     
    NewsOAuth2ConsumerService.browseProvider(int pageSize, int pageNumber)
    




     
    Returns a list of Map objects that represent each OAuth 2.0 provider
registered with the consumer proxy, in ascending ordered by provider
name. The following information is returned for each map object in
the returned list:


     
      


       
    •  authHeader: "true" or "false"





       
    •  authUrl: the authentication url endpoint for the provider





       
    •  clientAuth: the client authentication method in use





       
    •  name: the name of the provider





       
    •  tokenUrl: the token url endpoint for the provider





       
    •  urlParam: "true" or "false"


    



     
    pageSize
    




     
    The maximum number of providers to list per page. The default
value is 20. This parameter is optional.
    




     
    pageNumber
    




     
    The number of the page to display. For example, if you specify
in the pageSize parameter that each page will have 50 items, page
1 will contain items 1-50. The default value is 1. This parameter
is optional.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.browseProvider(50, 1)
    


    




     
    NewsOAuth2ConsumerService.countClient(string providerName)
    




     
    Returns the total number of OAuth 2.0 clients registered with
the consumer proxy.


     
    providerName
    




     
    An optional filter to only count clients associated with the specified
provider.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.countClient("provider123")
    


    




     
    NewsOAuth2ConsumerService.countGadgetBinding(string widgetId,
string clientName)
    




     
    Returns the total number of OAuth 2.0 bindings registered with
the consumer proxy.


     
    string widgetId, string clientName
    




     
    widgetId is an optional filter to count only bindings associated
with a specific widget.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.countGadgetBinding("aad20aa1-c0fa-48ef-bd05-8abe630c0012", "connections_servicex")
    


    




     
    NewsOAuth2ConsumerService.deleteClient(string clientName)
    




     
    Deletes a client by name if it exists, and has no existing associated
gadget bindings that leverage this client.


     
    clientName
    




     
    The name of the client to remove.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.deleteClient("client123")
    


    




     
    NewsOAuth2ConsumerService.findClient(string clientName)
    




     
    Returns a Map with information about the registered OAuth 2.0
client with the specified name.


     
    providerName
    




     
    The client name.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.findClient("client123")
    


    




     
    NewsOAuth2ConsumerService.findGadgetBindingByUri(string gadgetUri,
string serviceName)
    




     
    Returns a Map with information about the registered OAuth 2.0
gadget bindings with the specified gadgetUri and service name.


     
    gadgetUri
    




     
    The uri for the gadget.
    




     
    serviceName
    




     
    The name associated with the gadget. A gadgetUri and service name
create a unique composite key for a gadget in the deployment.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.findGadgetBinding("http://www.acme.com/mygadget", "connections_service")
    


    




     
    NewsOAuth2ConsumerService.findGadgetBindingByWidgetId(string widgetId,
string serviceName)
    




     
    Returns a Map with information about the registered OAuth 2.0
gadget bindings with the specified widget id and service name.


     
    widgetId
    




     
    The id of the widget.
    




     
    serviceName
    




     
    The name associated with the gadget. A widgetId and service name
create a unique composite key for a gadget in the deployment.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.findGadgetBinding("aad20aa1-c0fa-48ef-bd05-8abe630c0012", "connections_service")
    


    




     
    NewsOAuth2ConsumerService.countProvider()
    




     
    Returns the total number of OAuth 2.0 providers registered with
the consumer proxy. There are no parameters.


     Example:


    wsadmin>NewsOAuth2ConsumerService.countProvider()

20
    


    




     
    NewsOAuth2ConsumerService.deleteProvider(string providerName)
    




     
    Deletes a provider by name if it exists, and has no existing associated
clients or gadget bindings.


     
    providerName
    




     
    The unique provider name.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.deleteProvider("provider123")
    


    




     
    NewsOAuth2ConsumerService.findProvider(string providerName)
    




     
    Returns a Map with information about the registered OAuth 2.0
provider with the specified name.


     
    providerName
    




     
    The unique provider name.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.findProvider("provider123")
    


    




     
    NewsOAuth2ConsumerService.purgeAllTokens()
    




     
    Purges all tokens persisted in the repository.  This operation
should be executed if the underlying encryption method has been modified.
    




     
    NewsOAuth2ConsumerService.registerClient(string clientName, string
providerName, string ctype, string grantType, string clientId, string
clientSecret, string redirectUri)
    




     
    Registers or updates an existing OAuth 2.0 client by name with
the associated parameters.


     
    clientName
    




     
    The name to associate with the client that must be unique in a
deployment.
    




     
    providerName
    




     
    The name of the registered provider to associate with this client.
    




     
    ctype
    




     
    The client type. Supported values are "confidential" or "public"
per LINKspecification/LINK.
    




     
    grantType
    




     
    The authorization grant type. Supported values are "code" or "client_credentials"
per specification??
    




     
    clientID
    




     
    The identifier issued by the authorization server when registering
your client.
    




     
    clientSecret
    




     
    The secret issued by the authorization server when registering
your client.
    




     
    redirectUri
    




     
    The client redirection URI.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.registerClient("client123", "provider123", "confidential", "code", "my-client", "my-secret", "https://{opensocial}/gadgets/oauth2callback")
    


    




     
    NewsOAuth2ConsumerService.registerProvider(string providerName,
string clientAuth, string authHeader, string urlParam, string authUrl,
string tokenUrl)
    




     
    Registers or updates an existing OAuth 2.0 provider by name with
the associated parameters.


     
    providerName
    




     
    The unique provider name.
    




     
    clientAuth
    




     
    The client authentication method for accessing this provider.
Supported values out of the box are "standard" and "basic" per the specification.
    




     
    authHeader
    




     
    Value of "true" if credentials must be encoded in the authorization
header, otherwise "false".
    




     
    urlParam
    




     
    Value of "true" if credentials must be specified as query parameters
on the URI, otherwise "false".
    




     
    authUrl
    




     
    The authentication endpoint for the provider.
    




     
    tokenUrl
    




     
    The token endpoint for the provider.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.registerProvider("provider123", "standard", "true", "false", "???", "???")
    


    




     
    NewsOAuth2ConsumerService.unbindGadget(string widgetId, string
serviceName)
    




     
    Deletes a gadget binding by widgetId and serviceName.


     
    widgetId
    




     
    The id of the widget.
    




     
    serviceName
    




     
    The name to associate with the gadget. The widgetId and service
name must create a unique composite key for the deployment.
    

    





     Example:


    wsadmin>NewsOAuth2ConsumerService.unbindGadget("aad20aa1-c0fa-48ef-bd05-8abe630c0012", "connections_service")
    


    

    



    NewsScheduler commands
    


     
    NewsScheduler.getTaskDetails(java.lang.String taskName)
    




     
    


     Returns information about the scheduled task specified by taskName.





     The values returned are server time, next scheduled run time, status (SCHEDULED,
RUNNING, SUSPENDED), and task name. When the task has been paused,
then the status parameter shows as SUSPENDED instead of SCHEDULED.
SUSPENDED means that the task is not scheduled to run.





     For example:


    NewsScheduler.getTaskDetails("NewsDataCleanup")
    
The
resulting output looks similar to the following:


    {taskName=NewsDataCleanup, currentServerTime=Fri Mar 12 14:42:25 GMT 2010, nextFireTime=Fri Mar 12 23:00:00 GMT 2010, status=SCHEDULED}
    


    




     
    NewsScheduler.pauseSchedulingTask(java.lang.String taskName)
    




     
    


     Temporarily pauses the specified task and stops it from running.





     When
you pause a scheduled task, the task remains in the suspended state
even after you stop and restart News or the WebSphere Application Server. You must
run the NewsScheduler.resumeSchedulingTask(String taskName) command
to get the task running again.





     If the task is currently running,
it continues to run but is not scheduled to run again. If the task
is already suspended, this command has no effect. When the task is
paused successfully, a 1 is returned to the wsadmin client. When the task is not paused successfully, a 0 is returned.





     For example:


    NewsScheduler.pauseSchedulingTask("NewsDataCleanup")
    


    




     
    NewsScheduler.resumeSchedulingTask(java.lang.String taskName)
    




     
    


     If the task is suspended, puts the task in the scheduled state.
If the task is not suspended, this command has no effect.





     When
a task is resumed, it does not run immediately; it runs at the time
when it is next scheduled to run. 





     For example:


    NewsScheduler.resumeSchedulingTask("NewsDataCleanup")
    
When
the task is resumed successfully, a 1 is returned to the wsadmin client.
When the task is not resumed successfully, a 0 is returned.

    

    



    NewsWidgetCatalogService
commands
    


     
    NewsWidgetCatalogService.addWidget(**widget)
    




     
    Add a widget to the widget catalog. 
    




     
    ** widget indicates that this is a free form set of key=value
properties. The keys/values map to the Sets available for widgets
table previously described. 
    




     
    Returns the ID of the newly created widget.
    




     
    The following example creates a sample EE gadget that has 'trusted'
access policies. This gadget depends on the Profiles component.  


    NewsWidgetCatalogService.addWidget(, text="Sample gadget description.", url="http://www.to.my.gadget.com/gadget.xml",
categoryName=[WidgetCategories.NONE], isGadget=TRUE,appContexts=[WidgetContexts.EMBEDXP], "policyFlags=[GadgetPolicyFlags.TRUSTED]}, prereqs=["profiles"])
    

    




     
    NewsWidgetCatalogService.browseWidgets(enablement = Enablement.ALL,
pageSize = PAGE_SIZE_UNBOUNDED, pageNumber = 1)
    




     
    Browse the widgets in the widget catalog.
    




     
    Uses the parameter for enablement (Refer to Enablement).
    




     
    Uses the parameter for pageSize.
    




     
    Uses the parameter for pageNumber.
    




     
    Returns a list of Widget objects.
    




     
    


    wsadmin>NewsWidgetCatalogService.browseWidgets(Enablement.ALL, 1, 1)
    

    




     
    NewsWidgetCatalogService.countWidgets(enablement = Enablement.ALL)
	
    




     
    Count the widgets in the widget catalog.
    




     
    * Uses the parameter for enablement (Refer to Enablement).
    




     
    * Returns a count of the number of widgets in the catalog.
    




     
    NewsWidgetCatalogService.disableWidget(widgetId)
    




     
    Returns the following output:


    CLFRQXXXXI: Widget {0} is now disabled.
    

    




     
    NewsWidgetCatalogService.enableWidget(widgetId)
    




     
    Returns the following output:


    CLFRQXXXXI: Widget {0} is now enabled.
    

    




     
    NewsWidgetCatalogService.findWidgetById(WidgetId)
    




     
    Find a widget by id. 
    




     
     Uses the parameter for widgetId.
    




     
     Returns the matching widget or null if no matching widget is
found.
    




     
    For example:


    wsadmin>NewsWidgetCatalogService.findWidgetById("405a4f26-fa08-4cef-a995-7d90fbe2634f")
    

    




     
    NewsWidgetCatalogService.findWidgetByUrl(widgetUrl)
    




     
    Find a widget by Url. 
    




     
    Uses the parameter for url. 
    




     
    Returns the matching widget or null if no matching widget is found. 
    




     
    NewsWidgetCatalogService.listShareGadgets(enablement = Enablement.ALL)
    




     
    List out the share gadgets. By design, paging is not supported.
    




     
    Uses the parameter for enablement (Refer to Enablement).
    




     
    Returns the share gadgets.
    




     
    For example:


    wsadmin>NewsWidgetCatalogService.listShareGadgets(Enablement.ALL)
    

    




     
    NewsWidgetCatalogService.ProxyPolicy
    




     
    Set the server proxy policy.
    




     
    INTRANET_ACCESS May access intranet sites.
    




     
    EXTERNAL_ONLY  May access external (non-intranet) sites only.
    




     
    CUSTOM Uses rules in the rule manager configuration.
    




     
    NewsWidgetCatalogService.removeWidget(widgetId)
    




     
    Remove a widget matching the widgetId entered.
    




     
    For example:


    wsadmin>NewsWidgetCatalogService.removeWidget("405a4f26-fa08-4cef-a995-7d90fbe2634f") 
    

    




     
    NewsWidgetCatalogService.updateWidget(widgetId, **widget)
    




     
    Update an existing widget in the widget catalog.
    




     
    Uses the parameter for widgetId.
    




     
    ** widget indicates that this is a free form set of key=value
properties. The keys/values map to the Sets available for widgets
table previously described. 
    




     
    


    wsadmin>NewsWidgetCatalogService.updateWidget("1bf9ad75-a634-4301-88c6-ce493eb03cc9", , text="test")
    

    




     
    NewsWidgetCatalogService.updateWidgetShareOrder(widgetId, orderAfterWidgetId)
    




     
    Place the widget marked in a widgetId after a second widget in
widget ordering.
    




     
    widgetId The id of the widget you wish to move. 
    




     
    orderAfterWidgetId The id of the widget you want to place the gadget after.  If this is null, the widget will be placed first in
the ordering.
    

    




    Related
    

  •   Synchronize user data using administrative commands


    

  •   Run administrative commands

  •   Synchronize remote application data with the Communities database




    SearchCellConfig commands
    



     The SearchCellConfig commands are used to configure the location of the Search index and the IBM LanguageWare dictionaries
used by Search, and to configure the file download and conversion
service used when indexing file attachments.






     
    SearchCellConfig
commands
    Use the following MBean commands to perform administrative
tasks for Search. The commands are listed in alphabetical order.


     To run the commands, you first need to initialize the Search configuration
environment. For more information about initializing the Search configuration
environment, see Accessing the Search configuration environment.


      For the SearchCellConfig commands that create, update, or delete configuration
data, you must also check out the search-config.xml file
using the SearchCellConfig.checkOutConfig() command. After making
your edits, you need to check in your changes using the SearchCellConfig.checkInConfig()
command. When the server next restarts, your changes will take effect.
Any of these changes require the indexes to be rebuilt.




     
    SearchCellConfig.checkInConfig()
    




     
    


     Checks in the Search configuration file. This command must
be used after changes are made to the Search configuration file in
order for those changes to take effect. As part of this operation
, the edited copy of the Search configuration file, search-config.xml,
is validated against the XSD schema definition file, search-config.xsd.





     The checkInConfig command copies the updated configuration file from the temporary directory to the location of the active copy of these files
and it overwrites the existing XML file.





     For example:


    SearchCellConfig.checkInConfig()
    


    




     
    SearchCellConfig.checkOutConfig(String working_directory, String
cell_name)
    




     
    


     Checks out a copy of the Search configuration file to a working
directory located on the file system. This command must be used before
changes are made to the Search configuration file.





     This command
takes two arguments:


     
      


       
    •  working_directory. A file path to a temporary working directory
to which the configuration XML and XSD files are copied by the checkOutConfig
command. This argument is a string value.





       
    •  cell_name. The name of the IBM WebSphere Application Server
cell hosting the IBM Connections Search application. This argument is a string value.


    
For example:


    SearchCellConfig.checkOutConfig("/temp","foo01Cell01")
    


    




     
    SearchCellConfig.disableAttachmentHandling()
    




     
    


     Disables the indexing of file attachments in the Files and
Wikis applications.





     This command does not take any input parameters.

    




     
    SearchCellConfig.disableDictionary(String languageCode)
    




     
    


     Disables the specified LanguageWare dictionary.





     This
command accepts one argument:


     
      


       
    •  languageCode. The language code for the dictionary
to delete. This argument is a string value.


       The language
code typically comprises two letters conforming to the ISO standard
639-1:2002 that identifies the primary language of the dictionary.
However, there are some codes that additionally define a country or
variant, in which case these constituent parts are separated by an
underscore. For example, Portuguese has two variants, one for Portugal
(pt_PT) and one for Brazil (pt_BR). 


        When using a code that also
specifies a country, ensure that you use an underscore to separate
the language code and the country code rather than a hyphen; otherwise
an error will be generated.




    
For example:


    SearchCellConfig.disableDictionary("fr")
    


    




     
    SearchCellConfig.disableVerboseLogging()
    




     
    


     Disables verbose logging.





     This command does not take
any parameters.





     Verbose logging fills the SystemOut.log file
with detailed output that can occupy an increasing amount of disk
space, unless you have configured your deployment to retain only a
limited number of the most recent log files. A high turnover of logs
might be a problem when you are trying to track down the cause of
an issue if the log file that you are interested in has been deleted.
For this reason, you might want to disable verbose logging. The performance
impact of having verbose logging enabled is negligible.

    




     
    SearchCellConfig.enableAttachmentHandling()
    




     
    


     Enables the indexing of file attachments in the Files and Wikis
applications.





      If you already disabled the attachment handling
of files during the last indexing, you need to rebuild the index again
after enabling attachment handling. Otherwise, this command won't
take effect.





     This command does not take any input parameters.

    




     
    SearchCellConfig.enableDictionary(String languageCode, String
dictionaryPath)
    




     
    


     Enables support for the specified LanguageWare dictionary.





     This
command accepts two arguments.


     
      


       
    •  languageCode. The language code for the dictionary
to add. This argument is a string value.


       The language
code typically comprises two letters conforming to the ISO standard
639-1:2002 that identifies the primary language of the dictionary.
However, there are some codes that additionally define a country or
variant, in which case these constituent parts are separated by an
underscore. For example, Portuguese has two variants, one for Portugal
(pt_PT) and one for Brazil (pt_BR).


        When using a code that also
specifies a country, ensure that you use an underscore to separate
the language code and the country code rather than a hyphen; otherwise
an error will be generated.







       
    •  dictionaryPath. The path to the directory containing the dictionary
file. This argument is a string value.


    
For example:


    SearchCellConfig.enableDictionary("fr","/opt/IBM/Connections/data/shared/search/dictionary")
    
You
can also specify the path using a WebSphere environment
variable. In the following example, the "${SEARCH_DICTIONARY_DIR}"
value is used to point to the shared Search dictionary directory.


    SearchCellConfig.enableDictionary("fr","${SEARCH_DICTIONARY_DIR}")
    
Or,
if you are using a shared-file system on Microsoft Windows,
you can specify the file path to a network share directory using the Universal Naming Convention (UNC) format: 


    SearchCellConfig.enableDictionary("fr","\\enterprise.server\Connections\data\shared\search\dictionary")
    


    




     
    SearchCellConfig.enableVerboseLogging()
    




     
    


     Enables more detailed status reporting during crawling and
indexing in the form of more verbose logging to the SystemOut.log file.
Verbose logging is automatically enabled when IBM Connections 4 is installed.





     This command
does not take any parameters.





     You can use the following commands
to tune the frequency with which status information is logged to the SystemOut.log file
during different stages of the crawling and indexing process: 


     
      


       
    •  SearchCellConfig.setVerboseInitialLoggingInterval(int
interval)





       
    •  SearchCellConfig.setVerboseSeedlistRequestLoggingInterval(int
interval)





       
    •  SearchCellConfig.setVerboseIncrementalCrawlingLoggingInterval(int
interval)





       
    •  SearchCellConfig.setVerboseIncrementalBuildingLoggingInterval(int
interval)


    
For more information about each of these commands, refer to the command descriptions that follow.

    




     
    SearchCellConfig.excludeInactiveProfilesSearchResults()
    




     
    


     Specifies that the documents corresponding to inactive user
profiles are excluded from search results. In a default installation of IBM Connections, inactive
user profiles are automatically excluded from search results.

    




     
    SearchCellConfig.includeInactiveProfilesSearchResults()
    




     
    


     Specifies that the documents corresponding to inactive user
profiles are included in search results. In a default installation of IBM Connections, inactive
user profiles are automatically excluded from search results.

    




     
    SearchCellConfig.listDictionaries()
    




     
    


     Lists
the LanguageWare dictionaries
that are configured for Search. These dictionaries are used by common
Search to support indexing multilingual content and searching in multiple
languages.





     This command does not take any input parameters.

    




     
    SearchCellConfig.setBackupType(String type)
    




     
    


     Specifies the type of backup to create.





     This
command takes a single argument that specifies the backup type. This can be one of the following:


     
      


       
    •  new. Creates a new index backup every time.





       
    •  dual. Creates dual copies and overwrites the oldest existing backup.





       
    •  overwrite. Overwrites the existing index backup.


    
For example:


    SearchCellConfig.setBackupType("new")
    


    




     
    SearchCellConfig.setCacheExpiryTime(int numberOfDays)
    




     
    


     Sets the number of days for which a downloaded file's
indexable content is cached in the database. This information is cached
for potential reuse at indexing time. If a file is not reused in the number of days specified, its entry in the database cache is deleted.
If the file content has changed, the file is downloaded again and
the cache is updated with the revised content.





     This command
allows you to ensure that the database cache used for indexing files
is kept up-to-date.





     The expiry time is measured in days. Specify
a positive integer greater than zero.





     For example:


    SearchCellConfig.setCacheExpiryTime("30")
    


    




     
    SearchCellConfig.setCacheFileSize(int cacheFileSize)
    




     
    


     Specifies the maximum amount of extracted text that can be
indexed per file. Before a file is indexed, it is converted to plain
text.  This command allows you to specify how much of that plain text
conversion should be indexed.





     The cache file size is set to
200 KB by default, which is a very large amount of plain text.

      The cache file size limit is applied to the amount
of extracted text rather than the size of the original file. If you
have a large presentation file, for example, the default setting should
be sufficient to allow for all of the text in that file to be extracted
for indexing. The limit refers to the size of the plain text, not
the size of the original file.






     This command accepts one
argument:


     
      


       
    •  cacheFileSize. The number of bytes of indexable and searchable
file content stored in the database cache. Use a positive integer
greater than zero.


    






     For example:


    SearchCellConfig.setCacheFileSize("200000")
    


    




     
    SearchCellConfig.setDefaultDictionary(String languageCode)
    




     
    


     Configures the default LanguageWare dictionary
used by the Search application. The default dictionary must be one
of the enabled dictionaries.





     This command takes a single argument:


     
      


       
    •  languageCode is the language code for the dictionary that you
want to set as the default.


       This language code typically comprises
two letters conforming to the ISO standard 639-1:2002 that identifies
the primary language of the dictionary. However, there are some codes
that additionally define a country or variant, in which case these
constituent parts are separated by an underscore. For example, Portuguese
has two variants, one for Portugal (pt_PT) and one for Brazil (pt_BR).
When using a code that also specifies a country, ensure that you use
an underscore to separate the language code and the country code rather
than a hyphen; otherwise an error will be generated.


        A matching
dictionary must exist in the list of configured dictionaries for the language that you specify as a parameter.




    






     For example:


    SearchCellConfig.setDefaultDictionary("fr")
    


    




     
    SearchCellConfig.setDeletePersistedPages(String enabled)
    




     
    


     Specifies whether to delete the persisted pages after a successful
incremental index. By default, the value is set to true.





     This
command takes a single argument:


     
    enabled
    




     
    A string that determines whether persisted pages are to be deleted
after a successful incremental index. This string represents a boolean,
that is, it should be set to true or false.
    

    






     When this functionality is enabled, persisted
pages from the initial index creation are also deleted after a successful
incremental index.





     For example:


    SearchCellConfig.setDeletePersistedPages("false")
    


    




     
    SearchCellConfig.setDownloadThrottle(long downloadThrottle)
    




     
    


     Sets the duration of a rest period between successive files
downloads in a single file-download thread.





     This command takes
a single argument that specifies the download throttle size in milliseconds.
The download throttle is set to 500 by default.
    CAUTION:
    Increasing
this value increases the load on the Files server.






     For example:


    SearchCellConfig.setDownloadThrottle("500")
    


    




     
    SearchCellConfig.setIndexingResumptionAllowed(boolean allowed)
    




     
    


     Enables or disables the resumption of interrupted or failed
indexing tasks that have not reached a resume point.





     This command
takes a single argument:


     
      


       
    •  allowed. A boolean value.


    






     For example, to enable indexing resumption:


    SearchCellConfig.setIndexingResumptionAllowed("true")
    


    




     
    SearchCellConfig.setMaxCacheEntries(int maxCacheEntries)
    




     
    


     Sets the maximum number of cached file entries allowed in the database cache.





     This command takes a single argument:


     
      


       
    •  maxCacheEntries. The number of cached file entries. This argument
must be an integer greater than zero.


    
For example:


    SearchCellConfig.setMaxCacheEntries("1000")
    


    




     
    SearchCellConfig.setMaxCrawlerThreads(String maxThreadNumber)
    




     
    


     Specifies the maximum number of seedlist threads that can be
used when crawling. By default, the value is set to 2.





     This
command takes a single argument that specifies the number of threads
allowed.





     For example:


    SearchCellConfig.setMaxCrawlerThreads("3")
    


    




     
    SearchCellConfig.setMaximumAttachmentSize(int maxAttachmentSize)
    




     
    


     Sets the limit on the size of files that can be downloaded
for indexing. Files that are greater than the configured maximum attachment
size are not downloaded or processed for content indexing. By default,
the limit is set to 50 MB, which means that files over 50 MB are not
indexed.





     Files that are under the specified size are downloaded
to a temporary directory located in the index directory, where they
go through the text extraction process. The extracted text is then
indexed. The temporary directory size available must be greater than
the maximum file size allowed for content indexing. You can control
the amount of extracted text that is indexed using the setCacheFileSize command.





     This
command accepts one argument:


     
      


       
    •  maxAttachmentSize. The maximum file size in bytes of any file
attachment eligible for indexing. This is an integer value.


    
For example:


    SearchCellConfig.setMaximumAttachmentSize("52428800")
    


    




     
    SearchCellConfig.setMaximumConcurrentDownloads(int maxConcurrentDownloads)
    




     
    


     Sets the maximum number of threads that perform file downloading
on a Search server.





     This command takes a single argument that
specifies the maximum number of threads. The argument must be an integer
greater than zero. The default value is 3. The value of the maxConcurrentDownloads
argument must not exceed the maximum number of threads set for the DefaultWorkManager Work Manager resources at the Search server scope.
    CAUTION:
    Increasing this value increases the load on the Files
server.






     For example:


    SearchCellConfig.setMaximumConcurrentDownloads("10")
    


    




     
    SearchCellConfig.setMaxIndexerThreads(String maxThreadNumber)
    




     
    


     Specifies the maximum number of indexer threads that can be
used when indexing. By default, the value is set to 1.





     This
command takes a single argument that specifies the number of threads
allowed.





     For example:


    SearchCellConfig.setMaxIndexerThreads("3")
    


    




     
    SearchCellConfig.setMaximumTempDirSize(int maxTempDirSize)
    




     
    


     Sets the maximum size of a temporary directory used by a Search
server for the files conversion process.





     This command takes
a single argument that specifies the maximum size in bytes. The argument
must be an integer greater than zero. The default value is 100 MB.





     Files
are downloaded to a temporary directory, which is located in the index
directory. The temporary directory size available must be greater
than the maximum file size allowed for content indexing.





     For example:


    SearchCellConfig.setMaximumTempDirSize("51200")
    


    




     
    SearchCellConfig.setMaxPagePersistenceAge(String maxAgeInHours)
    




     
    


     Specifies the maximum age for persisted pages in a seedlist
persistence directory. By default, the value is set to 720 hours (30
days).





     If the pages are older than the maximum age, they are
ignored when building an index or resuming a crawl.





     This command
takes a single argument: 


     
    maxAgeInHours
    




     
    A string representing an integer that specifies the maximum age
in hours of the persisted pages.
    

    






     For example: 


    SearchCellConfig.setMaxPagePersistenceAge("42")
    


    




     
    SearchCellConfig.setPostBackupScript(String script)
    




     
    


     Specifies which shell script or third-party application runs
on completion of the backup task.





     This command takes a single
argument that specifies the name of the shell script or application
file.





     For example:


    SearchCellConfig.setPostBackupScript("backup.sh")
    






     To disable the script, run the command again with an empty string as
the argument. For example: 


    SearchCellConfig.setPostBackupScript("")
    


    




     
    SearchCellConfig.setSandIndexerTuning(String indexer, Int iterations)
    




     
    


     Sets the number of iterations used by a specified social analytics
job.





     This command takes the following arguments: 


     
      


       
    •  indexer. A string that specifies the name of the social analytics
indexing job. The following values are valid: evidence, graph, manageremployees,
and tags.





       
    •  iterations. An integer that specifies the number of iterations
for the specified social analytics indexing job.


    






     For example:


    SearchCellConfig.setSandIndexerTuning("manageremployees",200)
SearchCellConfig.setSandIndexerTuning("graph",400)
    


    




     
    SearchCellConfig.setVerboseIncrementalBuildingLoggingInterval(int
incrementalBuildingInterval)
    




     
    


     Controls the frequency with which update indexing progress
is logged to the SystemOut.log file. Update indexing
of an IBM Connections application
or set of applications, is an indexing job that updates an index that
already has content from all applications that are to be indexed as
part of the current indexing job.





     This command takes a single
parameter: 


     
    incrementalBuildingInterval
    




     
    A positive integer that corresponds to a number of documents.
For example, if an interval of 20 is specified, then for every 20
documents that have been indexed, the number of documents indexed
when indexing a particular application during the current indexing
job is logged. The incrementalBuildingInterval parameter is set to
100 by default.
    

    






     You can find additional logging information
about update indexing progress in the SystemOut.log file
by searching for occurrences of the CLFRW0600I logging message. For example: 


    CLFRW0600I: Search is continuing to build the index for blogs: 40 documents indexed.
    






     For example: 


    SearchCellConfig.setVerboseIncrementalBuildingLoggingInterval(100)
    


    




     
    SearchCellConfig.setVerboseIncrementalCrawlingLoggingInterval(int
incrementalCrawlingInterval)
    




     
    


     Controls the frequency with which seedlist update crawling
progress is logged to the SystemOut.log file.
An update crawl of an application fetches data that was created, updated,
or deleted since the previous crawl of that application began.





     This
command takes a single parameter: 


     
    incrementalCrawlingInterval
    




     
    A positive integer that corresponds to a number of seedlist entries.
For example, if an interval of 100 is specified, then, for every 100
entries that have been crawled, the number of entries that have been
crawled for a particular application during the current indexing job
is logged. The incrementalCrawlingInterval parameter is set to 100
by default.
    

    






     You can find additional logging information
about initial index creation in the SystemOut.log file
by searching for occurrences of the CLFRW0589I logging message. For example: 


    CLFRW0589I: Search is continuing to build the index for profiles: 1,600 seedlist entries indexed.
    






     For example: 


    SearchCellConfig.setVerboseIncrementalCrawlingLoggingInterval(100)
    


    




     
    SearchCellConfig.setVerboseInitialLoggingInterval(int initialInterval)
    




     
    


     Controls the frequency with which initial index creation progress
is logged to the SystemOut.log file.





     This
command takes a single parameter: 


     
    initialInterval
    




     
    A positive integer that corresponds to a number of seedlist entries.
A seedlist entry is an indexing instruction that specifies an action,
such as the creation, deletion, or update of a specified document
in the Search index. For example, if an interval of 500 is specified,
then for every 500 entries processed, the number of seedlist entries
indexed so far for an application by the current indexing job is logged.
The initialInterval parameter is set to 250 by default.
    

    






     You can find additional logging information
about initial index creation in the SystemOut.log file
by searching for occurrences of the CLFRW0581I logging message. For example: 


    CLFRW0581I: Search is continuing to build the index for activities: 3500 seedlist entries indexed.
    






     For example: 


    SearchCellConfig.setVerboseInitialLoggingInterval(500)
    


    




     
    SearchCellConfig.setVerboseLogging(int initialInterval, int seedlistRequestInterval,
int incrementalCrawlingInterval, int incrementalBuildingInterval)
    




     
    


     Enables verbose logging with the specified initial interval,
seedlist request interval, crawling interval, and incremental building
interval.





      Run this command has the same net effect as calling
the following commands in sequence: 


     
      


       
    •  SearchCellConfig.enableVerboseLogging()





       
    •  SearchCellConfig.setVerboseInitialLoggingInterval(initialInterval)





       
    •  SearchCellConfig.setVerboseSeedlistRequestLoggingInterval(seedlistRequestInterval)





       
    •  SearchCellConfig.setVerboseIncrementalCrawlingLoggingInterval(incrementalCrawlingInterval)





       
    •  SearchCellConfig.setVerboseIncrementalBuildingLoggingInterval(incrementalBuildingInterval)


    


    




     
    SearchCellConfig.setVerboseSeedlistRequestLoggingInterval(int
seedlistRequestInterval)
    




     
    


     Controls the frequency with which seedlist crawling progress
is logged to the SystemOut.log file.





     This
command takes a single parameter:


     
    seedlistRequestInterval
    




     
    A positive integer that corresponds to a number of seedlist page
requests. A seedlist crawl is a sequence of seedlist page requests,
which are HTTP GET operations that fetch seedlist pages. A seedlist
page can contain zero or more seedlist entries up to a specified maximum.
For example, if an interval of 1 is specified, then after every seedlist
request, the crawling progress of the application being currently
crawled is logged. The seedlistRequestInterval parameter is set to
1 by default.
    

    






     You can find additional logging information
about seedlist crawling in the SystemOut.log file
by searching for occurrences of the CLFRW0604 logging message. For example: 


    CLFRW0604 : Current seedlist state: Finish Date: Thu May 12 10:14:58 IST 2011; Start Date: Thu Jan 01 01:00:00 GMT 1970; Type: 1; Last Modified: Thu Jan 01 01:00:00 GMT 1970; Finished: false; Started: true; ACL Start: 0; Offset: 0;  
    






     For example:


    SearchCellConfig.setVerboseSeedlistRequestLoggingInterval(1)
    


    

    




    Related
    

  •   Manage the Search application


    

  •   Access the Search configuration environment

  •   Enable dictionaries

  •  Listing enabled dictionaries

  •   Disable dictionaries

  •  Set the default dictionary

  •   Configure file attachment indexing settings

  •   Configure index backup settings

  •   Enable indexing resumption

  •  Tuning social analytics indexing

  •  IBM Connections configuration property values




    SearchService commands
    



     The SearchService commands are used to create, retrieve,
update, and delete scheduled task definitions for the indexing and
optimization Search operations.






     
    SearchService commands
    Use the following MBean commands to perform administrative
tasks for Search. The commands are listed in alphabetical order.


     To use the commands, you must first initialize the Search configuration
environment. For more information, see Accessing the Search
configuration environment.



     
    SearchService.addBackupIndexTask(String taskName, String schedule,
String startbySchedule)
    




     
    


     Defines a new scheduled index backup task.





     This command
takes the following arguments:


     
      


       
    •  taskName. The name of the task to be added.





       
    •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





       
    •  startbySchedule. The time given for the task to run before it
is automatically canceled. This argument is a string value that must
be specified in Cron format.


    
For example:


    SearchService.addBackupIndexTask("WeeklyIndexBackup","0 0 2 ? * SAT","0 10 2 ? * SAT")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.addFileContentTask(String taskName, String schedule,
String startBy, String applicationNames, failuresOnly)
    




     
    


     Creates a scheduled file content retrieval task.





     This
command takes the following arguments:


     
      


       
    •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





       
    •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format. For more
information about the Cron schedule, see Scheduling tasks.





       
    •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format. For more information about the Cron schedule, see Scheduling
tasks.





       
    •  applicationNames. The name (or names) of the IBM Connections application to be indexed when
the task is triggered. This argument is a string value. To index multiple
applications, use a comma-delimited list. The following values are
valid:


       
        


         
      •  files





         
      •  wikis


      






       
    •  failuresOnly. A flag that indicates that only the content of files
for which the download and conversion tasks failed should be retrieved.
This argument is a boolean value.


    






     For example:


    SearchService.addFileContentTask("mine", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI", "wikis,files","true")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.





     You can also use the SearchService.addFileContentTask
command to replace the task definition for the default 20min-file-retrieval-task.
By default, this task runs every 20 minutes, except for a one-hour
period between 01:00 and 02:00. To replace the default task settings,
first remove the existing task using the SearchService.deleteTask(String
taskName) command. Then use the SearchService.addFileContentTask to
create a new task with the values that you specify.





     For example: 


    SearchService.deleteTask("20min-file-retrieval-task")
SearchService.addFileContentTask("20min-file-retrieval-task", "0 1/20 0,2-23 * * ?", "0 10/20 0,2-23 * * ?", "all_configured", "false")
    


    




     
    SearchService.addIndexingTask(String taskName, String schedule,
String startBy, String applicationNames, Boolean optimizeFlag)
    




     
    


     Creates a new scheduled indexing task definition in the Home
page database.





     This command takes the following arguments:


     
      


       
    •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





       
    •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





       
    •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format. 


       This parameter should be used to ensure that indexing
tasks are not queued up and running into server busy times. Under
normal conditions, the only factors that might cause a task to be
delayed are that overlapping or coincident tasks are trying to fire
at the same time, or an earlier task is running for a long time.






       
    •  applicationNames. The name (or names) of the IBM Connections application to be indexed when
the task is triggered. This argument is a string value. To index multiple
applications, use a comma-delimited list. The following values are
valid: activities, blogs, calendar, communities, dogear, files, forums,
profiles, status_updates, and wikis.





       
    •  optimizeFlag. A flag that indicates if an optimization step should
be performed after indexing. This argument is a boolean value.
       The optimization operation is both CPU and I/O
intensive. For this reason, the operation should be performed infrequently
and, if possible, during off-peak hours. For more information, refer
to the following web page: 
      http://lucene.apache.org/core/old_versioned_docs/versions/3_0_3/api/all/org/apache/lucene/index/IndexWriter.html#optimize%28%29


       Note
that when you install IBM Connections,
a search optimization task is set up to run every night by default.
See Search default tasks for more information.




    
All arguments are required.





     For example:


    SearchService.addIndexingTask("customDogearAndBlogs", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI", "dogear,blogs","true")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console. 


      The refreshTasks() command should be used after this
command for the new task definitions to take effect immediately. Otherwise,
the changes take place when the Search application is next restarted.






     You can also use the SearchService.addIndexingTask command to replace
the 15min-search-indexing-task that is automatically configured when
you install IBM Connections.
By default, all installed IBM Connections applications are crawled and indexed every 15 minutes, except for
a one-hour period between 01:00 and 02:00. To replace the default
indexing task settings, first remove the existing indexing task using
the SearchService.deleteTask(String taskName) command. Then, use the SearchService.addIndexingTask command to create a new indexing task
with the values that you specify.





     For example: 


    SearchService.deleteTask("15min-search-indexing-task")
SearchService.addIndexingTask("15min-search-indexing-task", "0 1/15 0,2-23 * * ?", "0 10/15 0,2-23 * * ?", "all_configured", "false")
    


    




     
    SearchService.addOptimizeTask(String taskName, String schedule,
String startBy)
    




     
    


     Creates a new index optimization scheduled task definition.





     This
command takes the following arguments:


     
      


       
    •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





       
    •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





       
    •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format.


       This parameter should be used to ensure that indexing
tasks are not queued up and running into server busy times. Under
normal conditions, the only factors that might cause a task to be
delayed are that overlapping or coincident tasks are trying to fire
at the same time, or an earlier task is running for a long time.



    
All arguments are required.


      The optimization operation is both CPU and I/O
intensive. For this reason, the operation should be performed infrequently
and, if possible, during off-peak hours. For more information, refer
to the following web page: 
    http://lucene.apache.org/core/old_versioned_docs/versions/3_0_3/api/all/org/apache/lucene/index/IndexWriter.html#optimize%28%29


     Note
that when you install IBM Connections,
a search optimization task is set up to run every night by default.
See Search default tasks for more information.







     For example:


    SearchService.addOptimizeTask("customOptimize", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console. 


      The refreshTasks() command should be used after this
command for the new task definitions to take effect immediately. Otherwise,
the changes take place when the Search application is next restarted.






     You can also use the SearchService.addOptimizeTask command to replace
the nightly-optimize-task that is automatically configured when you
install IBM Connections. By
default, this task runs nightly at 01:30. To replace the default optimize
task settings, first remove the existing optimize task using the SearchService.deleteTask
command. Then, use the SearchService.addOptimizeTask command to create
a new optimize task with the values that you specify.





     For example: 


    SearchService.deleteTask("nightly-optimize-task")
SearchService.addOptimizeTask("nightly-optimize-task", "0 30 1 * * ?", "0 35 1 * * ?")
    


    




     
    SearchService.addSandTask(String taskName, String schedule, String
startBy, String jobs)
    




     
    


     Creates a new scheduled task definition for the social analytics
service in the Home page database.





     This command takes the following arguments:


     
      


       
    •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





       
    •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





       
    •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format. 


       This parameter should be used to ensure that scheduled
tasks are not queued up and running into server busy times. Under
normal conditions, the only factors that might cause a task to be
delayed are that overlapping or coincident tasks are trying to fire
at the same time, or an earlier task is running for a long time.






       
    •  jobs. The name, or names, of the jobs to be run when the task
is triggered. This argument is a string value. To index multiple jobs,
use a comma-delimited list. The following values are valid: evidence,
graph, manageremployees, tags, taggedby, and communitymembership.


    
All the arguments are required.





     For example:


    SearchService.addSandTask("customSaNDIndexTask", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI", "evidence,graph,manageremployees,tags,taggedby,communitymembership")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.





     You can also use the SearchService.addSandTask command
to replace the nightly-sand-task that is automatically configured
when you install IBM Connections.
By default, the task runs nightly at 01:00. To replace the default
SAND task settings, first remove the existing task using the SearchService.deleteTask(String
taskName) command. Then use the SearchService.addSandTask command
to create a new SAND task with the values that you specify.





     For example: 


    SearchService.deleteTask("nightly-sand-task")
SearchService.addSandTask("nightly-sand-task", "0 0 1 * * ?", "0 5 1 * * ?", "evidence,graph,manageremployees,tags,taggedby,communitymembership")
    


    




     
    SearchService.backupIndexNow()
    




     
    


     Backs up the index to the location specified by the IBM WebSphere Application Server variable,
SEARCH_INDEX_BACKUP_DIR. There might be a delay before the backup
occurs if there are indexing tasks in progress.





     This command
does not take any arguments.





     After backing up the Search index
using wsadmin commands, consider performing a full backup of the HOMEPAGE
database. Note that the Search index has a dependency on data in the HOMEPAGE database.

    




     
    SearchService.deleteFeatureIndex(String featureName)
    




     
    Removes and purges the content for the specified application from
the Search index. 


      Only use this command if you are uninstalling
an application from IBM Connections.
After running the command, you cannot reindex the content from the application that has been deleted. For more information, see Purging
content from the index.





     This command takes a string
value, which is the name of the application whose content is to be
deleted. The following values are valid: activities, blogs, calendar,
communities, dogear, files, forums, profiles, status_updates, and
wikis.





     For example:


    SearchService.deleteFeatureIndex("activities")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.deleteAllTasks()
    




     
    


     Deletes all task definitions from the Home page database.





     This
command does not take any parameters.





     When the command runs
successfully, 1 is printed to the wsadmin console. If the command
does not run successfully, 0 is printed to the wsadmin console.

    




     
    SearchService.deleteGlobalSandProperty(String propertyName)
    




     
    


     Deletes the specified global social analytics property.





     For example: 


    SearchService.deleteGlobalSandProperty("sand.tag.freq.threshold")
    






     When the property is successfully added or updated, 1
is printed to the wsadmin console. If the property is not successfully
added or updated, then you will see 0 printed to the wsadmin console.
If this happens, contact the Search Cluster Administration and check
the SystemOut.log file for more details.

    




     
    SearchService.deleteTask(String taskName)
    




     
    


     Deletes the task definition with the specified name from the Home page database.





     This command takes a string value, which
is the name of the task to be deleted. For information about how to
retrieve the names of the tasks in the Home page database, see Listing
scheduled tasks.





     For example:


    SearchService.deleteTask("profilesIndexingTask")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.disableAllTasks()
    




     
    


     Disables all scheduled tasks for the Search application.





     This
command does not take any arguments.





     When the command runs successfully,
1 is printed to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

    




     
    SearchService.disableTask(String taskName)
    




     
    


     Disables the scheduled task with the specified name.





     This
command takes a single argument:


     
      


       
    •  taskName. The name of the task to be disabled. This argument is
a string value.


    






     For example:


    SearchService.disableTask("mine")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.





      Use this command affects the indexing process as
follows:


     
      


       
    •  When the command is run before the scheduled task fires, the indexing
operation is prevented from starting.





       
    •  When the command is run during the indexing operation for an application,
the Search application stops indexing.


    
Results for the current application that is being indexed are
discarded but, if, as part of an scheduled task, some applications
have been successfully crawled, those applications are up-to-date
in the index. For example, if a task is fired that is to index Bookmarks,
Blogs, and Activities (in that order) and the disable command is called
while Blogs is being indexed, when the task is enabled again, Blogs
and Activities resume indexing at the same point as the previously-called
task. Disabled tasks remain disabled until they are re-enabled.

    




     
    SearchService.enableAllTasks()
    




     
    


     Re-enables all scheduled tasks for the Search application.





     This
command does not take any arguments.





     When the command runs successfully,
1 is printed to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

    




     
    SearchService.enableTask(String taskName)
    




     
    


     Re-enables the scheduled task with the specified name. This command uses the current schedule.





     This command takes a single
argument:


     
      


       
    •  taskName. The name of the task to be enabled. This argument is
a string value.


    






     For example:


    SearchService.enableTask("mine")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.flushPersistedCrawlContent()
    




     
    


     Deletes current persisted seedlists.


      This command only
clears persisted seedlists in the default persistence location. Seedlists
crawled using the startBackgroundCrawl, startBackgroundFileContentExtraction,
or startBackgroundIndex commands must be deleted manually.






     This command does not take any input parameters.


      Do
not run this command while a crawl is in progress.






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.getFileContentNow(String applicationNames)
    




     
    


     Launches the file content retrieval task. This command iterates
over the file cache, downloading and converting files that don't
have any content.

    This command takes a
string value, which is the name of the application whose content is
to be retrieved. The following values are valid:


     
      


       
    •  files





       
    •  wikis


    






     For example:


    SearchService.getFileContentNow("files")
    


    




     
    SearchService.indexNow(String applicationNames)
    




     
    


     Creates a one-off task that indexes the specified applications
30 seconds after being called.





     This command takes a single argument:


     
      


       
    •  applicationNames. The name (or names) of
the IBM Connections application
to be indexed when the task is triggered. This argument is a string
value. To index multiple applications, use a comma-delimited list.
The following values are valid: activities, blogs, calendar, communities,
dogear, files, forums, profiles, status_updates, and wikis.


    





      An optimize operation is not run at the end of the indexing
operation.
For example:


    SearchService.indexNow("dogear, blogs")
    


    




     
    SearchService.indexNowWithOptimization(String applicationNames)
    




     
    


     Creates a one-off task that indexes the specified applications
30 seconds after being called, and performs an optimization operation
at the end of the indexing operation.





     This command takes a single
argument:


     
      


       
    •  applicationNames. The name (or names) of
the IBM Connections application
to be indexed when the task is triggered. This argument is a string
value. To index multiple applications, use a comma-delimited list.
The following values are valid: activities, blogs, calendar, communities,
dogear, files, forums, profiles, status_updates, and wikis.


    





      The optimization operation is both CPU and I/O
intensive. For this reason, the operation should be performed infrequently
and, if possible, during off-peak hours. For more information, refer
to the following web page: 
    http://lucene.apache.org/core/old_versioned_docs/versions/3_0_3/api/all/org/apache/lucene/index/IndexWriter.html#optimize%28%29


     Note
that when you install IBM Connections,
a search optimization task is set up to run every night by default.
See Search default tasks for more information.

For
example:


    SearchService.indexNowWithOptimization("dogear, blogs")
    


    




     
    SearchService.listFileContentTasks()
    




     
    


     Lists all the scheduled file content retrieval tasks.





     This
command does not take any input parameters.

    




     
    SearchService.listGlobalSandProperties()
    




     
    


     Lists all global properties for the social analytics service.





     The properties are returned as a mapping of keys to values. For example,
the following output indicates that the value of the sand.tag.freq.threshold
property is 32000.


    {sand.tag.freq.threshold=32000}
    


    




     
    SearchService.listIndexingNodes()
    




     
    


     Returns a list of the Search indexing nodes in your deployment.





     This
command does not take any arguments.





     When the command runs successfully,
the names of the Search indexing nodes are printed to the wsadmin
console along with information about each node. The output includes
a version timestamp and information that indicates whether the node
is an indexing node or a non-indexing node, whether the index on the server is more than 30 days old, and whether the index on the server
is synchronized with the latest index in the cluster.





     For example: 


    Indexing Node Id: dubxpcvm084-0Node02:server1, Last Crawl Version: 1,340,285,460,074, Indexer: true, Out of Date: false, Out of Sync: false
    


    




     
    SearchService.listIndexingTasks()
    




     
    


     Lists all scheduled
indexing task definitions defined in the Home page database.





     This command does not take any input parameters.

    




     
    SearchService.listOptimizeTasks()
    




     
    


     Lists all scheduled optimize task definitions defined in the Home page database.





     This command does not take any input parameters.

    




     
    SearchService.listRunningTasks()
    




     
    


     Lists all the tasks that are currently running for the Search
application. This command does not take any input parameters.





     The command returns a list of the tasks that are currently running, and
includes the following information for each task:


     
      


       
    •  Internal task ID





       
    •  Task name





       
    •  Time that the task started


    






     For example: 


    wsadmin>SearchService.listRunningTasks()
>>>51
roi-profiles-WedDec0715:23:09GMT2011
Wed Dec 07 15:23:09 GMT 2011
    


    




     
    SearchService.listSandTasks()
    




     
    


     Lists all the tasks scheduled for the social analytics service
defined in the Home page database.





     This command does
not take any input parameters.

    




     
    SearchService.listTasks()
    




     
    


     Lists all Search scheduled task definitions (indexing and optimize)
defined in the Home page database.





     This command does not take
any input parameters.

    




     
    SearchService.notifyRestore(Boolean isNewIndex)
    




     
    


     Brings the database to a consistent state so that crawlers
start from the point at which the backup was made.





     The notifyRestore
command updates index management tables in the HOMEPAGE database so
that crawling resume points are reloaded from a restored index, thereby
ensuring that all future crawls start from the correct point. The command also purges cached content in the HOMEPAGE database.





     The notifyRestore command optionally removes all entries from the HOMEPAGE
database table that tracks the status of individual files as part
of the content extraction process. This table is used by the Search
application when indexing the content of file attachments.





     This
command takes a single parameter: 


     
      


       
    •  isNewIndex: If set to true, all entries are removed from the database
table that is used by the file content extraction process to track
the status of individual files.


       Set this parameter to true when
you are restoring a newly-built index. Set the parameter to false
when you are restoring an index backup.



    
For example:


    SearchService.notifyRestore("true")
    


    




     
    SearchService.optimizeNow()
    




     
    


     Creates a one-off task that performs an optimize operation
on the search index, 30 seconds after being called.


      The optimization operation is both CPU and I/O
intensive. For this reason, the operation should be performed infrequently
and, if possible, during off-peak hours. For more information, refer
to the following web page: 
    http://lucene.apache.org/core/old_versioned_docs/versions/3_0_3/api/all/org/apache/lucene/index/IndexWriter.html#optimize%28%29


     Note
that when you install IBM Connections,
a search optimization task is set up to run every night by default.
See Search default tasks for more information.







     This
command does not accept any input parameters.





     This operation
should not be called during an indexing operation; if it needs to
be run, do it at an off-peak time when the application is not expected
to be performing intensive I/O operations on the index.

    




     
    SearchService.optIntoSandByEmail(String email)
    




     
    


     Includes the user with the specified email address in the social
analytics service.





     This command takes a single argument:


     
      


       
    •  email. The email address of the user who
is to be included in the social analytics service. This argument is
a string value.


    






     For example: 


    SearchService.optIntoSandByEmail("ajones10@example.com")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.optIntoSandByExId(String externalId)
    




     
    


     Includes the user with the specified external ID in the social
analytics service.





     This command takes a single argument:


     
      


       
    •  externalId. The external ID of the user who
is to be included in the social analytics service. This argument is
a string value.


    






     For example: 


    SearchService.optIntoSandByExId("11111-1111-1111-1111")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.optOutOfSandByEmail(String email)
    




     
    


     Excludes the user with the specified email address from the social analytics service.





     This command takes a single argument:


     
      


       
    •  email. The email address of the user who
is to be excluded from the social analytics service. This argument
is a string value.


    






     For example: 


    SearchService.optOutOfSandByEmail("ajones10@example.com")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.optOutOfSandByExId(String externalId)
    




     
    


     Excludes the user with the specified external ID from the social
analytics service.





     This command takes a single argument:


     
      


       
    •  externalId. The external ID of the user who
is to be excluded from the social analytics service. This argument
is a string value.


    






     For example: 


    SearchService.optOutOfSandByExId("11111-1111-1111-1111")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.refreshTasks()
    




     
    


     Calls the server to read task settings from the Search task
definition tables and synchronizes the configured tasks with those
persisted in the IBM WebSphere Application Server
scheduler tables.





     This command should be used after the following commands for the changes to task definitions to take effect immediately.
Otherwise, the changes take place when the Search application is next
restarted.


     
      


       
    •  SearchService.addIndexingTask(String taskName, String schedule,
String startBy, String applicationNames, Boolean optimizeFlag)





       
    •  SearchService.addOptimizeTask(String taskName, String schedule,
String startBy)





       
    •  SearchService.deleteTask(String taskName)


    






     This command does not accept any input parameters.

    




     
    SearchService.reloadIndex()
    




     
    


     Reloads the Search index on the current node only without a
restart of the Search application.


      If you are making changes to the configuration of the social
analytics service, you still need to restart Search to apply the changes.






     When the command runs successfully, 1 is printed
to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

    




     
    SearchService.reloadIndexAllNodes()
    




     
    


     Reloads the Search index on all the nodes in the cluster without
a restart of the Search application.


      If you are making changes to the configuration of the social
analytics service, you still need to restart Search to apply the changes.






     When the command runs successfully, 1 is printed
to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

    




     
    SearchService.reloadSearchConfiguration()
    




     
    


     Reloads the search-config.xml file for
Search on the current node only without a restart of the Search application.
     If you are making changes to the configuration of the social
analytics service, you still need to restart Search to apply the changes.






     When the command runs successfully, 1 is printed
to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

    




     
    SearchService.reloadSearchConfigurationAllNodes()
    




     
    


     Reloads the search-config.xml file for
Search on all nodes in the cluster without a restart of the Search
application.


      If you are making changes to the configuration of the social
analytics service, you still need to restart Search to apply the changes.






     When the command runs successfully, 1 is printed
to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

    




     
    SearchService.removeIndexingNode(String nodeName)
    




     
    


     Removes the specified node from the index management table.





     This
command takes a single argument:


     
      


       
    •  nodeName. The name of the node to be removed. This argument is
a string value that takes the following format: 


      nodeName:serverName
      
To
retrieve a list of the indexing nodes in your deployment, run the SearchService.listIndexingNodes() command. For more information, see Listing
indexing nodes.


    






     For example:


    SearchService.removeIndexingNode("Node01:cluster1_server1")
    






     When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

    




     
    SearchService.resetAllTasks()
    




     
    


     Deletes all scheduled task definitions from the Home page database
and restores the default set of tasks. For more information about
these tasks, see Search default scheduled tasks.





     This
command does not take any parameters.





     When the command runs
successfully, 1 is printed to the wsadmin console. If the command
does not run successfully, 0 is printed to the wsadmin console.

    




     
    SearchService.retryContentFailuresNow(String applicationNames)
    




     
    


     Retries failed attempts at downloading and converting files
for the specified application.





     This command takes a string value,
which is the name of the application whose content is to be downloaded
and converted. The following values are valid:


     
      


       
    •  files





       
    •  wikis


    






     A file download or conversion task can fail for a number
of reasons, for example, hardware or network issues. Failures are
flagged in the cache and can be retried.





     For example:


    SearchService.retryContentFailuresNow("wikis,files")
    


    




     
    SearchService.retryIndexing(String service, String id)
    




     
    


     Attempts to index an item of content that was not indexed successfully
during initial or incremental indexing.





     This
command takes two parameters: 


     
    service
    




     
    The application from which the content originated.
    




     
    id
    




     
    The Atom ID of the content. For information about how to retrieve
the Atom ID for the content, refer to the IBM Connections APIs section
of the product documentation.
    

    






     For example:


    SearchService.retryIndexing('activities', 'b63cabf8-0533-45cf-9636-d63cd6a6f3ca')
    






     If
the command is successful, 1 is printed to the console. If the command
fails, 0 is printed to the console.

    




     
    SearchService.sandIndexNow(String jobs)
    




     
    


     Creates a one-off social analytics task that indexes the specified
services 30 seconds after being called.





     This
command takes a single argument:


     
      


       
    •  jobs. The name, or names, of the jobs to be run when the task
is triggered. This argument is a string value. To run multiple jobs,
use a comma-delimited list. The following values are valid: evidence,
graph, manageremployees, tags, taggedby, and communitymembership.


    
For example:


    SearchService.sandIndexNow("evidence,graph,manageremployees,tags,taggedby,communitymembership")
    


    




     
    SearchService.saveMetricsToFile(String filePath)
    




     
    Collects internal metrics and writes them to the specified file.


     This
command takes a single argument:


     
    filePath
    




     
    The full path to a text file in which to store the metric information.
This argument is a string value.
    

    






     A file is created in the specified directory.
The file name is prefixed with the string "searchMetrics-" and contains
a timestamp indicating when the metrics were collected. The file output
is printed in the following format:


    ================================================================
ACTIVITIES

Average entry indexing time: 0.03 seconds
Max entry indexing time: 0.17
Min entry indexing time: 0.01
Entry count: 54

Average seedlist request time: 1.83 seconds
Max seedlist request time: 4.16
Min seedlist request time: 0.1
Seedlist request count: 3

================================================================
PROFILES

Average entry indexing time: 0.07 seconds
Max entry indexing time: 1.48
Min entry indexing time: 0.04
Entry count: 1763

Average seedlist request time: 8.6 seconds
Max seedlist request time: 13.06
Min seedlist request time: 0.14
Seedlist request count: 5
    


    




     
    SearchService.setGlobalSandIntegerProperty(String propertyName,
String integerProperyValue)
    




     
    


     Adds or updates a dynamic global social analytics property
that affects the social analytics API or indexing behavior. The changes
take place when the next social analytics indexing job starts.





     When the property is successfully added or updated, 1
is printed to the wsadmin console. If the property is not successfully
added or updated, then you will see 0 printed to the wsadmin console.
If this happens, contact the Search Cluster Administration and check
the SystemOut.log file for more details.





     Currently,
support is provided only for the sand.tag.freq.threshold social
analytics property. This property takes an integer value.





     The property is used by the Recommend API algorithm as follows: 


     
      


       
    1.  Get the people and tags to which the user is related.


       
        


         
      •  If the tag has a frequency in the Search index that is greater
than or equal to the value specified for the sand.tag.freq.threshold
property, discard it. This action prevents users from getting recommendations
based on common tags, that is, tags that have a high frequency.


      






       
    2.  Get the documents with which the people and tags gathered in the first query are associated.





       
    3.  Return the results to the user.


    
For example: 


    SearchService.setGlobalSandIntegerProperty("sand.tag.freq.threshold",100)
    






     


     Notes: 


     
      


       
    •  This setting is global and will affect all IBM Connections users. The setting should only
be changed by an administrator.





       
    •  You can consult the SystemOut.log file when
social analytics indexing begins to check the frequency distribution
of the top 100 tags in the system. 


       For example, in line 1 of the following extract, you can see that the tag brown has ordinal 1718
in the index (an ordinal is a facet identifier) and that it has a
frequency of 1, which means that there is only one instance of a document
being tagged with the keyword brown in the index.


      [5/30/11 15:41:13:544 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1718:brown:1} 
[5/30/11 15:41:13:548 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1730:summaries:1} 
[5/30/11 15:41:13:551 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1737:public_holiday:1} 
[5/30/11 15:41:13:554 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1721:chronicle:1} 
[5/30/11 15:41:13:558 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1716:hollis:1} 
[5/30/11 15:41:13:561 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1700:inquirer:1} 
[5/30/11 15:41:13:565 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1684:gazette:5} 
[5/30/11 15:41:13:568 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1679:ibm:7} 
[5/30/11 15:41:13:572 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum Cache:{1679=7, 1684=5, 1700=1, 1716=1, 1718=1, 1721=1, 1730=1, 1737=1} 
[5/30/11 15:41:13:633 IST] 00000025 IndexBuilderQ I com.ibm.lotus.connections.search.admin.index.impl.IndexBuilderQueue startSaNDIndexingService CLFRW0483I: SAND indexing has started.
      




    



    




     
    SearchService.startBackgroundCrawl(String persistenceLocation,
String components)
    




     
    


     Crawls the seedlists for the specified applications and then
saves the seedlists to the specified location. This command does not
build an index.





     The command takes the following parameters:


     
    persistenceLocation
    




     
    A string that specifies the path to which the seedlists are to
be saved.
    




     
    components
    




     
    A string that specifies the applications whose seedlists are to
be crawled. The following values are valid: activities, all_configured,
blogs, calendar, communities, dogear, files, forums, profiles, status_updates,
and wikis. Use all_configured when you want to crawl all the applications.
    

    






     For example:


    SearchService.startBackgroundCrawl("/opt/IBM/Connections/backgroundCrawl", "activities, forums, communities, wikis")
    


    




     
    SearchService.startBackgroundFileContentExtraction(persistence
dir, components, extracted text
dir, thread limit)
    




     
    


     Extracts file content for all files referenced in the persisted
seedlists in a process that is independent of the indexing task.





     This
command takes the following parameters: 


     
    persistence dir
    




     
    A string that specifies the location of the persisted files seedlists.
    




     
    components
    




     
    A string that specifies the application or applications for which
you want to extract file content. The following values are valid:
files, wikis.
    




     
    extracted text dir
    




     
    A string that specifies the target location for the extracted
text. The same directory structure and naming scheme is used for this
directory as for the extracted text directory on the deployment, connections
shared data/ExtractedText. For example, ExtractedText/121/31/36cdb7a0-92b2-4cf9-91f3-c4e7e527a5e1.
    




     
    thread limit
    




     
    The maximum number of seedlist threads.
    

    






     For example: 


    SearchService.startBackgroundFileContentExtraction("/bg_index/seedlists", "files", "/bg_index/ExtractedText", 10)
    






     You typically run this command after running a startBackgroundCrawl command
to act on up-to-date seedlists. If there are no persisted seedlists
available, the behavior is the same as when you run the startBackgroundIndex
command, that is, the seedlists are crawled and persisted first.

    




     
    SearchService.startBackgroundIndex(String persistenceLocation,
String extractedFileContentLocation, String indexLocation, String
components)
    




     
    


     Creates a stand-alone index in a specified location.





     This
command crawls the seedlists for the specified applications, saves
the seedlists to the specified persistence location, extracts the file content, and then builds a Search index for the applications
at the specified index location.





     This command takes the following arguments:


     
    persistenceLocation
    




     
    A string value that specifies the location where you want to save
the application seedlists.
    




     
    extractedFileContentLocation
    




     
    The file content extraction location. Use the same location that
you specified when you previously extracted the file content using
the SearchService.startBackgroundFileContentExtraction command or
the SearchService.startBackgroundIndex command. Otherwise, specify
an empty directory as the location for storing the extracted file
content.
    




     
    indexLocation
    




     
    A string value that specifies the location where you want to create
the background index.
    




     
    components
    




     
    A string value that specifies the names of the applications that
you want to include in the index crawl. The following values are valid:
activities, all_configured, blogs, calendar, communities, dogear,
files, forums, profiles, status_updates, and wikis. Use all_configured
when you want to index all the applications.


     To queue up multiple
applications for indexing, run a single instance of the SearchService.startBackgroundIndex
command with the names of the applications to index
listed with a comma separator between them. If you run multiple instances
of the command with a single application specified as a parameter,
a lock is established when you run the first command so that only
the first application specified is indexed successfully.

    

    






     For example:


    SearchService.startBackgroundIndex("/opt/IBM/Connections/data/local/search/backgroundCrawl", "/opt/IBM/Connections/data/local/search/backgroundExtracted", "/opt/IBM/LotusConnections1/data/search/background/backgroundIndex", "activities, blogs, calendar, communities, dogear, files, forums, profiles, wikis, status_updates")
    



    SearchService.startBackgroundIndex("/opt/IBM/Connections/data/local/search/backgroundCrawl", "/opt/IBM/Connections/data/local/search/backgroundExtracted", "/opt/IBM/LotusConnections1/data/search/background/backgroundIndex", "all_configured")
    


    

    




    Related
    

  •   Configure scheduled tasks

  •   Administer the social analytics service

  •  Back up the Search index

  •   Manage the Search application


    

  •   Access the Search configuration environment

  •  Add scheduled tasks for Search

  •  Listing scheduled tasks

  •   Delete scheduled tasks for Search

  •   Enable and disable scheduled tasks

  •   Run one-off tasks

  •   Run one-off social analytics scheduled tasks

  •  Back up the Search index using wsadmin commands

  •  Reloading the Search application

  •   Configure global properties for the social analytics service

  •  Listing Search tasks that are currently running

  •  Excluding specific users from the social analytics service

  •   Purging content from the index

  •  Reindexing content

  •  Retrieve file content

  •   Restore a Search index without restarting individual nodes

  •  Back up the Search index manually

  •   Restore a Search index in a single-node environment

  •   Validate seedlists using the wsadmin client

  •   Remove a node from the index management table

  •   Restore a Search index in an environment with multiple nodes

  •  Performing a background crawl

  •  Listing social analytic indexing tasks

  •   Create a background index

  •   Delete persisted seedlist data

  •  Add scheduled tasks for the social analytics service

  •  Extracting file content

  •   Restore the default scheduled tasks for Search

  •  Listing indexing nodes

  •  IBM Connections configuration property values


     

  •  Search default scheduled tasks




    Search default scheduled tasks
    



     When you install IBM Connections,
a number of tasks are automatically configured for the Search application.

    The following tasks are scheduled for Search by default:



    Table 139. Search scheduled tasks

    Task name
    Description




    15min-search-indexing-task
    This task specifies that all installed IBM Connections applications are
to be crawled and indexed every 15 minutes, except for a one-hour
period between 01:00 and 02:00.


     You can update the settings for
this default task using the SearchService.addIndexingTask command.
For more information, see Add scheduled tasks for Search.




    20min-file-retrieval-task
    This task sends a JMS message that triggers
the downloading of files and the indexing of file content on all Search
nodes. The task runs every 20 minutes, except for a one-hour period
between 01:00 and 02:00.


     You can update the settings for this default
task using the SearchService.addFileContentTask command.
For more information, see Add scheduled tasks for Search.




    nightly-sand-task
    This task sends a JMS message that triggers
social analytics indexing on all Search nodes. The social analytic
indexing task is resource-intensive and consequently should be run
at off-peak times. By default, the task runs nightly at 01:00.


     The social analytic indexers query the index and create utility documents
that are used by the social analytics feature to provide recommendations
for the Recommendations widgets and to build the graph of connected
users that is used by the Do You Know widget and the Who Connects
Us widget.





     You can update the settings for this default task
using the SearchService.addSandTask command. For more information, see Add scheduled tasks for Search.




    nightly-optimize-task
    This task sends a JMS message that triggers
a Lucene optimize operation of the local indexes on all Search nodes.
The task runs nightly at 01:30.


     You can update the settings for
this default task using the SearchService.addOptimizeTask command.
For more information, see Add scheduled tasks for Search.




    





    Related
    

  •   Create Search indexes

  •   Configure scheduled tasks


    

  •   Create the initial Search index

  •  Retrieve file content

  •  Add scheduled tasks for the social analytics service

  •  Add scheduled tasks for Search

  •   Run one-off tasks

  •   Restore the default scheduled tasks for Search




    Search language dictionaries
    



     The Search application provides a number of language dictionaries.

    The following table lists the language dictionaries that
are currently provided.



    Table 140. Search language dictionaries

    Language
    Dictionary file
    Language identifier




    Arabic
    ar-XX-Lex-7004.dic
    ar



    Chinese
    zh-XX-Lex-7002.dic
    zh



    Czech
    cs-CZ-LLex-7002.dic
    cs



    Danish
    da-DK-LLex-7001.dic
    da



    Dutch
    nl-NL-Reform-LLex-7003.dic
    nl



    English
    en-XX-LLex-7011.dic
    en



    Finnish
    fi-FI-Lex-5312.dic
    fi



    French
    fr-XX-LLex-7003.dic
    fr



    German
    de-XX-LLex-7003.dic
    de



    Greek
    el-GR-LLex-7000.dic
    el



    Italian
    it-IT-LLex-7003.dic
    it



    Japanese
    ja-JP-Lex-7003.dic
    ja



    Korean
    ko-KR-Lex-7001.dic
    ko



    Norwegian (Bokmal)
    nb-NO-LLex-7000.dic
    nb



    Polish
    pl-PL-LLex-7002.dic
    pl



    Portuguese (Brazilian)
    pt-BR-LLex-7002.dic
    pt_BR



    Portuguese (Portugal)
    pt-PT-LLex-7002.dic
    pt_PT



    Russian
    ru-RU-LLex-7001.dic
    ru



    Spanish (Spanish)
    es-ES-LLex-7001.dic
    es



    Swedish
    sv-SE-LLex-7000.dic
    sv



    

In addition, the mul-XX-LangID-5311.dic dictionary is used
for language guessing. This dictionary is not configurable.


     
    Related tasks
    

  •   Enable dictionaries

  •  Listing enabled dictionaries

  •  Set the default dictionary

  •   Disable dictionaries




    Seedlist
response
    



     Understand what is returned in the seedlist
response.

    


     Seedlists are
a modified Atom XML format and follow the Atom paging model. The seedlist uses standard Atom elements and field
metadata descriptors and fields. It defines the content to be indexed
in multiple field Atom extension elements and in standard Atom elements,
such as the updated element. It specifies how the content in the field
elements should be indexed using field metadata descriptors in fieldInfo
Atom extension elements.





     These elements are in the http://www.ibm.com/wplc/atom/1.0
namespace.







     
    <wplc:action>
    


     Identifies
the reason why
the item is included in the seedlist by specifying the action type
in its do attribute. The options are as follows:


     
    delete
    




     
    Indicates that the associated document was deleted. This entry
provides enough information to enable you to delete the document from
the index. For example:


    <atom:entry xml:lang="en_US">
<atom:id>dad9504f-50c4-47c5-b274-7245b21cd308</atom:id>
<atom:updated>2008-06-18T10:08:38+01:00</atom:updated>
<wplc:action do="delete"/>
</atom:entry>
    


      The Bookmarks application
handles deletions differently from the other applications. Bookmarks
are rolled up into cumulative entries for multiple instances of bookmark
links to the same URL. The Bookmarks seedlist API only includes delete
entries when the last bookmark for a given URL is deleted. Otherwise,
deleted content is removed from the rolled up content of an update
action.

    




     
    insert
    




     
    Indicates
that the associated document was added.
    




     
    update
    




     
    Indicates that the associated document was changed.
    

    



    wplcAction =
element wplc:action {
attribute do {"insert" | "delete" | "update"}
}
    








     
    <wplc:fieldInfo>
    


     Makes
the seedlist Atom
feeds self-describing by listing content fields provided by each IBM Connections seedlist. Field
metadata also gives the indexer hints about how the fields should
be treated. Field metadata can be part of the feed or of the entry
definition. If it shows on both, the entry takes precedence. Fields
metadata can be defined for custom fields and also for the following existing Atom elements: author, summary, title, published, and updated.





     The <wplc:fieldInfo>
element contains the following attributes:


     
    contentSearchable
    




     
    Indicates whether to search the value of the field. When true,
the value of the field is available for search, even if no specific
field is specified in the query. For example, if there is a document
with the title "my title," and this attribute is set to true for
the title, the API matches queries like "my title." Values are true or false.
The default value is false.
    




     
    description
    




     
    Text that describes the content of the field.
    




     
    fieldSearchable
    




     
    Indicates whether the value of
the field will be available for
search in the context of the field. For example, if there is a document
with the title "my title," and this attribute is set to true for
the title, the API matches queries that search for the value of that
specific field, such as "title:\"my title\"" or "title:my". Values
are true or false. The default value
is false.
    




     
    id
    




     
    Text
that identifies the field that this information is associated
with. This ID corresponds to the id attribute in the <wplc:field>
element. 
    




     
    name
    




     
    Text that identifies
the name of the field. This value is not
displayed anywhere.
    




     
    parametric
    




     
    Indicates
whether this field should answer range constraints in
the query. Set the value to true can incur additional
indexing, and space and query processing overhead on the search index,
therefore set it with caution. IBM Connections seedlists do not currently set this parameter to true.
Values are true or false. The default
value is false.
    




     
    returnable
    




     
    Indicates whether the content of the field should be returned
together with search results. This operation often means additional
overhead in indexing and query processing. Values are true or false.
The default value is false.
    




     
    sortable
    




     
    Indicates whether this field should allow sorting the result set
by its value. The default value is false.
    




     
    supportsExactMatch
    




     
    Indicates whether
the field should be stored as is. This attribute
only takes effect if contentSearchable or fieldSearchable are set
to true. Values are true or false.
The default value is false.
    




     
    type
    




     
    Identifies the type of content in the field from among the following options:


     
      


       
    •  Boolean





       
    •  date





       
    •  double





       
    •  fields





       
    •  int





       
    •  long





       
    •  string


    

    

    



    wplcFieldInfo = element wplc:fieldInfo {
attribute id { text },
attribute name { text }?,
attribute description { text }?,
attribute type { "Boolean" | "string"| "date" | "double" | "int" | "long" | "fields" }?,
attribute contentSearchable { "true" | "false" }?,
attribute fieldSearchable { "true" | "false" }?,
attribute parametric { "true" | "false" }?,
attribute returnable { "true" | "false" }?,
attribute sortable { "true" | "false" }?,
attribute supportsExactMatch { "true" | "false" }?,
wplcFieldInfos ?
}
    








     
    <wplc:field>
    


     Provides
the content to
be indexed. The following types of field can be included in seedlist
responses:



     
    Complex
    




     
    Contain other wplc:field
elements.
    




     
    Primitive
    




     
    Contain a simple
text value.
    

    
Each wplc:field element contains the following attribute:


     
    id
    




     
    Text value that identifies
the field and associates it with the appropriate <wplc:fieldInfo> element.
    

    



    wplcFields = { wplcField+ }
wplcField = element wplc:field {
attribute id { text },
extensionAttribute*,
( text | wplcFields | atomContent )
}
extensionAttribute =
attribute * - (wplc:* | local:*) { text } 
    







     
    <wplc:acl>
    


     Specifies a security token
that can be used later to filter search results. This element contains
a text value that represents the token as an opaque string. Add one
or more security tokens to a feed or entry to prefilter search results.
If the <wplc:acl> element is missing, the crawl can assume that
the content is publicly available and is OK to display to unauthenticated
users. A user's security tokens can be retrieved at search time to
enable searching over access-controlled or secure documents. These
APIs return the same opaque security token strings that are used in
the <wplc:acl> element of the seedlist document. See Securing
access to seedlist SPIs for more details.



    wplcACL = element wplc:acl { text }
    







     
     Search file attachments
    


     The seedlist
format enables indexing of content stored in file attachments in the Files and Wikis applications through the use of <atom:link> and <atom:content>
elements. The <atom:entry> element representing the file attachment
has an <atom:content> element in which the src attribute specifies
the location from which the file can be downloaded by the crawler.
Additional information about the file is present in the corresponding <atom:link>
element in the entry. For example:


    <atom:entry xml:lang="en">
  <atom:id>13bcb9ed-bca5-4dc8-b60d-d5b90144c8a8</atom:id>
  <atom:link 
   href="http://www.seedlistsample.com :9080/files/app/file/13bcb9ed-bca5-4dc8-
    b60d-d5b90144c8a8" 
   rel="via" 
   type="application/pdf" 
   hreflang="en" 
   />
  <atom:content 
   xml:lang="en" 
   type="application/pdf" 
   src="https://www.seedlistsample.com:9443/files/seedlist/document/contents/
    13bcb9ed-bca5-4dc8-b60d-d5b90144c8a8"/>
  ...
</atom:entry>
    



    The following XML
snippet is an example of a seedlist response:


    <atom:feed>
  <atom:id>
  http://www.seedlistsample.com:10038/seedlist/myserver?Action=GetChildren&Format=
  com.ibm.lotus.search.plugins.seedlist.ATOMFormatterFactory&Locale=en&Range=3&
  SeedlistId=com.ibm.jcr,localhost:e802bd80468869da9d93dd95f6dc8031&
  Source=com.ibm.lotus.search.plugins.seedlist.retriever.jcr.JcrRetrieverFactory&
  Start=10
  </atom:id>
  <atom:link 
   href="/seedlist/myserver?Range=3&Format=com.ibm.lotus.search.plugins.seedlist.
    ATOMFormatterFactory&Locale=en&SeedlistId=
    com.ibm.jcr%2Clocalhost%3Ae802bd80468869da9d93dd95f6dc8031&Source=
    com.ibm.lotus.search.plugins.seedlist.retriever.jcr.JcrRetrieverFactory&
    Action=GetDocuments&Start=13&State=MTAwfC9jb250ZW50Um9vdC9pY2%3D%3D" 
   rel="next" 
   type="application/atom+xml" 
   />
  <atom:link 
   href="/seedlist/myserver?Range=3&Format=com.ibm.lotus.search.plugins.seedlist.
    ATOMFormatterFactory&Locale=en&SeedlistId=
    com.ibm.jcr%2Clocalhost%3Ae802bd80468869da9d93dd95f6dc8031&Source=
    com.ibm.lotus.search.plugins.seedlist.retriever.jcr.JcrRetrieverFactory&
    Action=GetDocuments&Start=7" 
   rel="previous" 
   type="application/atom+xml" 
   />
  <atom:generator xml:lang="en" version="1.0">
   Seedlist Service Backend System
  </atom:generator>
  <wplc:timestamp>AAABFoVf8zs=</wplc:timestamp>
  <atom:category 
   term="ContentSourceType/PDM" 
   scheme="com.ibm.wplc.taxonomy://application_taxonomy" 
   label="PDM"/>
  <atom:title xml:lang="en">
   PDM Retriever : 5 entries of Seedlist Root
  </atom:title>
  <atom:updated>2007-11-28T10:29:26+02:00</atom:updated>
  <wplc:action do="update"/>
  <wplc:fieldInfo 
   id="title" 
   name="Title" 
   description="Title" 
   type="string" 
   contentSearchable="true" 
   fieldSearchable="true" 
   parametric="false" 
   returnable="true" 
   sortable="false" 
   supportsExactMatch="true"/>
  <wplc:fieldInfo 
   id="summary" 
   name="Description" 
   description="Description" 
   type="string" 
   contentSearchable="true" 
   fieldSearchable="true" 
   parametric="false" 
   returnable="true" 
   sortable="false" 
   supportsExactMatch="true"/>
  <wplc:fieldInfo 
   id="updated" 
   name="Last Update Date" 
   description="Last modified date" 
   type="date" 
   contentSearchable="true" 
   fieldSearchable="true" 
   parametric="false" 
   returnable="true" 
   sortable="false" 
   supportsExactMatch="true"/>
  <wplc:fieldInfo 
   
   name="Creation Date" 
   description="Creation date"    
   type="date" 
   contentSearchable="true" 
   fieldSearchable="true" 
   parametric="false" 
   returnable="true" 
   sortable="false" 
   supportsExactMatch="true"/>
  <wplc:fieldInfo 
   id="author" 
   name="Author" 
   description="Author" 
   type="string" 
   contentSearchable="true" 
   fieldSearchable="true" 
   parametric="false" 
   returnable="true" 
   sortable="false" 
   supportsExactMatch="true"/>
  <wplc:fieldInfo 
   id="FIELD_PDM_COMMENT" 
   name="PDM Comment" 
   description="PDM Comment" 
   type="string" 
   contentSearchable="true" 
   fieldSearchable="true" 
   parametric="false" 
   returnable="true" 
   sortable="false" 
   supportsExactMatch="true"/>
  <!-- Seedlist2 : toplevel0 -->
  <atom:entry xml:lang="en">
    <atom:id>
     com.ibm.jcr,localhost!25803e8046886a0d9decdd95f6dc8031
    </atom:id>
    <atom:link 
     href="/seedlist/myserver?Range=3&Format=
      com.ibm.lotus.search.plugins.seedlist.ATOMFormatterFactory&Locale=en&
      SeedlistId=com.ibm.jcr%2Clocalhost%3A25803e8046886a0d9decdd95f6dc8031&
      Source=com.ibm.lotus.search.plugins.seedlist.retriever.jcr.JcrRetrieverFactory&
      Start=0&Action=GetChildren" 
     rel="alternate" 
     type="application/atom+xml" 
     />
    <atom:link 
     wplc:repeatable="false" 
     href="/seedlist/myserver?Range=3&Format=com.ibm.lotus.search.plugins.
      seedlist.ATOMFormatterFactory&Locale=en&SeedlistId=
      com.ibm.jcr%2Clocalhost%3A25803e8046886a0d9decdd95f6dc8031&
      Source=com.ibm.lotus.search.plugins.seedlist.retriever.jcr.JcrRetrieverFactory&
      Start=0&Action=GetDocuments" 
     rel="via" 
     type="application/atom+xml" 
     />
    <wplc:securityId>
     6QReDeHHCG3QS6H1E03QO6O1ECJGHCK9ECMQGC4JPIJQOCM1P66S06J9C0
    </wplc:securityId>
    <atom:author>
      <atom:name>quikradm</atom:name>
      <atom:uri>uid=quikradm,o=default organization</atom:uri>
      <atom:email>quikradm@us.ibm.com</atom:email>
    </atom:author>
    <atom:category 
     term="com.ibm.jcr,localhost!e802bd80468869da9d93dd95f6dc8031" 
     scheme="com.ibm.wplc.taxonomy://location_taxonomy" 
     label="pdfs"/>
    <atom:category 
     term="com.ibm.jcr,localhost!1611c180468868649d8cdd95f6dc8031" 
     scheme="com.ibm.wplc.taxonomy://location_taxonomy" 
     label="Performance"/>
    <atom:category 
     term="com.ibm.jcr,localhost!92644b804679c0cb9a3dbfb7b3c312f0" 
     scheme="com.ibm.wplc.taxonomy://pdm_categories_taxonomy" 
     label=".public"/>
    <atom:category 
     term="com.ibm.jcr,localhost!56a2010046c2db58ac80af58af525af5" 
     scheme="com.ibm.wplc.taxonomy://pdm_categories_taxonomy" 
     label="movies"/>
    <atom:title xml:lang="en">toplevel0</atom:title>
    <atom:updated>2007-08-21T18:03:45+03:00</atom:updated>
    <wplc:action do="update"/>
    <wplc:acls>
      <wplc:acl>uid=quikradm,o=default organization</wplc:acl>
      <wplc:acl>cn=wpsadmins,o=default organization</wplc:acl>
    </wplc:acls>
    <atom:published>2007-08-20T03:39:23+03:00</atom:published>
    <atom:summary xml:lang="en">toplevel0</atom:summary>
  </atom:entry>
  <!-- Seedlist1.DOC1 : f1040prh.pdf -->
  <atom:entry xml:lang="en">
    <atom:id>
     com.ibm.jcr,localhost:efeb960046886d29a393e795f6dc8031
    </atom:id>
    <atom:link 
     href="/lotus/mypoc?uri=dm:efeb960046886d29a393e795f6dc8031&verb=view" 
     rel="via" 
     type="application/pdf" 
     hreflang="en" 
     />
    <atom:content 
     xml:lang="en" 
     type="application/pdf" 
     src="/lotus/mypoc?uri=dm:efeb960046886d29a393e795f6dc8031&verb=download"/>
    <wplc:securityId>
     6QReDe5JPA6H57M1C03QO6O1EC3I96P9O6JSC65RDIJQOCM1P66S06J9C0
    </wplc:securityId>
    <atom:author>
      <atom:name>quikradm</atom:name>
      <atom:uri>uid=quikradm,o=default organization</atom:uri>
      <atom:email>quikradm@us.ibm.com</atom:email>
    </atom:author>
    <atom:category 
     term="com.ibm.jcr,localhost!25803e8046886a0d9decdd95f6dc8031" 
     scheme="com.ibm.wplc.taxonomy://location_taxonomy" 
     label="toplevel0"/>
    <atom:category 
     term="com.ibm.jcr,localhost!e802bd80468869da9d93dd95f6dc8031" 
     scheme="com.ibm.wplc.taxonomy://location_taxonomy" 
     label="pdfs"/>
    <atom:category 
     term="com.ibm.jcr,localhost!1611c180468868649d8cdd95f6dc8031" 
     scheme="com.ibm.wplc.taxonomy://location_taxonomy" 
     label="Performance"/>
    <atom:title>f1040prh.pdf</atom:title>
    <atom:updated>2007-01-17T11:19:32+02:00</atom:updated>
    <wplc:action do="insert"/>
    <wplc:acls>
      <wplc:acl>uid=quikradm,o=default organization</wplc:acl>
      <wplc:acl>cn=wpsadmins,o=default organization</wplc:acl>
    </wplc:acls>
    <wplc:field xml:lang="en" id="FIELD_PDM_COMMENT">
     This is comment for file f1040prh.pdf
    </wplc:field>
    <atom:published>2007-01-17T11:19:32+02:00</atom:published>
    <atom:summary>f1040prh.pdf</atom:summary>
  </atom:entry>
  <!-- Seedlist1.DOC2 : f1098e03.pdf -->
  <atom:entry xml:lang="en">
    <atom:id>
     com.ibm.jcr,localhost:3bfeb80046886a569e8bdf95f6dc8031
    </atom:id>
    <atom:link 
     href="/lotus/mypoc?uri=dm:3bfeb80046886a569e8bdf95f6dc8031&verb=view" 
     rel="via" 
     type="application/pdf" 
     hreflang="en" 
     />
    <atom:link 
     href="/lotus/mypoc?uri=dm:960b860046886b079fbedf95f6dc8031&verb=download" 
     rel="related" 
     type="application/pdf" 
     hreflang="en" 
     />
    <atom:content 
     xml:lang="en" 
     type="application/pdf" 
     src="/lotus/mypoc?uri=dm:3bfeb80046886a569e8bdf95f6dc8031&verb=download"/>
    <wplc:securityId>
     6QReDePHD03H17M1C03QO6O1EC3H16N9EC6HLC4JPIJQOCM1P66S06J9C0
    </wplc:securityId>
    <atom:author>
      <atom:name>wpsadmin</atom:name>
      <atom:uri>uid=wpsadmin,o=default organization</atom:uri>
      <atom:email>wpsadmin@us.ibm.com</atom:email>
    </atom:author>
    <atom:category 
     term="com.ibm.jcr,localhost!25803e8046886a0d9decdd95f6dc8031" 
     scheme="com.ibm.wplc.taxonomy://location_taxonomy" 
     label="toplevel0"/>
    <atom:category 
     term="com.ibm.jcr,localhost!e802bd80468869da9d93dd95f6dc8031" 
     scheme="com.ibm.wplc.taxonomy://location_taxonomy" 
     label="pdfs"/>
    <atom:category 
     term="com.ibm.jcr,localhost!1611c180468868649d8cdd95f6dc8031" 
     scheme="com.ibm.wplc.taxonomy://location_taxonomy" 
     label="Performance"/>
    <atom:title>f1098e03.pdf</atom:title>
    <atom:updated>2007-01-17T11:19:33+02:00</atom:updated>
    <wplc:action do="update"/>
    <wplc:acls>
      <wplc:acl>uid=wpsadmin,o=default organization</wplc:acl>
      <wplc:acl>cn=wpsadmins,o=default organization</wplc:acl>
    </wplc:acls>
    <atom:published>2006-08-21T18:03:45+03:00</atom:published>
    <atom:summary>f1098e03.pdf</atom:summary>
  </atom:entry>
</atom:feed>
    





    Add
applications to the SSL trust store
    





     If you have
enabled SSL and Common directory services for
Profiles or Communities, add that application to the SSL
trust store.


     If the applications
are not added to the SSL trust store,
you might experience application exceptions.




To add
an application to the SSL trust store, complete the following steps:

    


     
      


       
    1.  Start WebSphere Application Server and log in
to the WebSphere Application Server Integrated
Solutions Console.





       
    2.  Click Security > SSL certificate and key management > Key
stores
and certificates > NodeDefaultTrustStore > Signer certificates.





       
    3.  Click Retrieve from port.





       
    4.  Type your host name in the Host field.
For example: example.com.





       
    5.  Set the port number
in the Port field. The default for HTTPS is
443.





       
    6.  Type an Alias that
is easy to remember.





       
    7.  Click Retrieve
signer information, and then click OK.





       
    8.  Save your changes.





       
    9.  Repeat
this task for each server instance.





       
    10.  Restart WebSphere Application Server.


    


     
    Related tasks
    

  •   Use the Profiles database as the user directory




     Remove
a person's or a group's access
    





     If one or more people
leave the company, you can prevent
them from being able to access the applications by removing that user
or group from the LDAP directory.


     


     Do not attempt
to delete all of the data or content created
by the person. 


    


     
      


       
    1.  Remove the person from
the company LDAP directory.





       
    2.  Use the new synchronization commands
to mark the person inactive in the application DBs. You must
run the synchronization command on each application database separately.  


       For example, to mark the person as inactive in the Communities
database, run the following command where ExternalID is the external
ID of the user who has left the company:



      CommunitiesMemberService.syncMemberByExtID(ExternalID)
      
See
the administrative command topics for each application for more details
on the syncMemberByExtID commands.





       
    3.  Optional: Perform the steps that are appropriate
for your implementation of the product. 


       
        


         
      •  If the person who left was the sole owner of an activity that
other people still use, add one or more additional owners to the activity,
so that it can continue to be managed by someone. To add owners to
an activity, perform the steps in this procedure:  Manage member access to activities. Use the setOwnerAccess
command in the list of options in Step 6 to add one or more people
to the owner role in the member list of the activity. 





         
      •  To edit or delete a blog owned by a specific person, complete
the steps in this procedure:  Administer Blogs users





         
      •  To remove bookmarks created by a specific person from the Bookmarks
application, complete the steps in the this procedure:  Delete unnecessary links. See the deleteLinkByPerson
command options.





         
      •  To remove a person's profile, complete the steps in this procedure:  Synchronize source changes such as LDAP with Profiles.





         
      •  To remove files owned by a specific person, complete the steps
in this procedure:  Delete user files from the system





         
      •  If the person who left was the sole owner of a wiki that other
people still use, add one or more additional owners to the wiki, so
that it can continue to be managed by someone. To add owners to a
wiki, perform the steps in the topic named How do I add and
remove wiki members? in the Wikis help.


      



    


     
    Related tasks
    

  •  How do I add and remove wiki members?




     Disable community invitations
    





     You can update configuration settings in the communities-policy.xml file to disable the ability to
invite people to join a community.


     To update configuration files, you must use the wsadmin client.
See  Start the wsadmin
client for details.




If you do not want community owners or members to be able
to invite people to join a community, you can disable this functionality
by removing any lines of code containing CommunityInvitePermission from the communities-policy.xml file.

    


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Communities Jython script interpreter.


       
        


         
      1.  Use the following command
to access the Communities configuration files: 


        execfile("communitiesAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Check out the Communities configuration
files : 


        CommunitiesConfigService.checkOutPolicyConfig("working_directory", "cell_name")
        

        ...where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied.
The files are kept in this working directory while you make changes
to them.


            AIX and Linux only: The directory must
grant write permissions or the command will not run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is required. If you do not know the cell name, you can
determine it by typing the following command in the wsadmin command
processor: 


          print AdminControl.getCell()
          



        
For example: 


        CommunitiesConfigService.checkOutPolicyConfig("/opt/my_temp_dir", "CommServerNode01Cell")
        



      






       
    3.  Navigate to the working directory specified in
the previous step and open the communities-policy.xml file using a text editor.





       
    4.  Comment out or remove any lines that include the following: 


      CommunityInvitePermission
      






       
    5.  Comment out or remove any <comm:grant> element that
does not contain a valid <comm:permission>. 


       For example:


      <!--
 <!-- Invitee -->
  <comm:grant>
    <comm:principal class="com.ibm.tango.auth.principal.Role" name="invitee" />

  </comm:grant>
-->
      







       
    6.  Save your changes and then close the communities-policy.xml file.





       
    7.  Check in the updated policy file : 


      CommunitiesConfigurationService.checkInPolicyConfig("<working-directory", "cell-name>")
      






       
    8.  Synchronize your changes across all nodes and then restart
the Communities application.


    


     
    Related tasks
    

  •   Disable the ability to add members to a community




     Disable
trash bin in Files
    





     Change an attribute in the configuration
properties to
disable the trash bin in Files. It is enabled by default.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.








     Perform the following steps to disable
trash bin in Files:


    


     
      


       
    1.  Start the wsadmin client.





       
    2.  Start the Files Jython script interpreter.


       
        


         
      1.  Use
the following command
to access the Files configuration files: 


        execfile("filesAdmin.py")
        
If
you are asked to select a server, you can select any server.





         
      2.  Check out the Files
configuration
files : 


         FilesConfigService.checkOutConfig("working_directory",
"cell_name")





         where:


         
          


           
        •  working_directory is
the temporary working
directory to which the configuration XML and XSD files are copied.
The files are kept in this working directory while you make changes
to them.


            AIX and Linux only: The directory must
grant write permissions or the command will not run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is required. If you do not know the cell name, you can
determine it by typing the following command in the wsadmin command
processor:


           print AdminControl.getCell()



        
For example:


        FilesConfigService.checkOutConfig("/opt/my_temp_dir", "CommServerNode01Cell")
        




      






       
    3.  Open files-config.xml.





       
    4.  In the <personalFiles> element
in the <recyclebin> section,
specify the enabled attribute as false.


    


    Example
    For example:


     ....
 <recyclebin>
  <personalFiles enabled="false"/>
 </recyclebin>
....
    



     

  •  Files configuration properties




     Access the News configuration file
    





     To make configuration changes to the News component in IBM Connections, you must first
access the News configuration file.


     To access configuration files, you must use the wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.

    


     To change News configuration settings, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the News Jython script interpreter.


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Check out the News cell-level
configuration file : 


         NewsCellConfig.checkOutConfig("working_dir",
"cellName")

        ...where:


         
          


           
        •  working_dir is the temporary directory to which
you want to check out the cell-level configuration file. This directory
must exist on the server where you are running wsadmin.


            AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






           
        •  cellName is the name of the cell that the home
page node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, type the following command in the wsadmin command processor to determine it:


           print
AdminControl.getCell()



        
For example: 


        NewsCellConfig.checkOutConfig("d:/temp", "NewsServerNode01Cell")
        
The command displays this message: 


        News Cell Level configuration file successfully checked out.
        



      






       
    3.  Navigate to the temporary directory in which you saved
the news-config.xml file, and then open the file
in a text editor and update the following parameters as required. 



      Table 141. News configuration parameters

      Parameter
    Description




      databaseCleanup storyLifetimeInDays
    Specifies the interval at which news stories
are deleted from the News repository. For more information, see Configuring
database clean-up for the News repository.



      dataSynchronization frequencyInHours
    Specifies the interval at which networking data
is synchronized between the News repository and the Profiles application.
For more information, see Synchronizing News data with other
applications.



      NewsDataCleanup task
    Defines the interval at which the databaseCleanup
task runs. There is also a configuration parameter to enable or disable
this task from running. 


       Do not disable this setting. If you disable
it, you run the risk of rapidly reaching your file system storage
limit as the database increases in size. Disabling this setting can
also result in poor data access performance.
For more information
about this task, see Configuring database clean-up for the News
repository.



      






       


        The following parameters are also present in the news-config.xml file,
but their default settings must not be changed.



      Table 142. Additional
parameters

      Parameter
    Description




      EmailDigestDelivery
    A batch job that runs each hour to collect and
post the news as daily and weekly emails. This setting must not be
changed.


       Depending on their email notification settings, a daily
or weekly email digest is posted to IBM Connections users with the most relevant news. The emails are sent instantly when
they are posted as notifications in IBM Connections.




      MetricsCollector
    Used to update the statistics and metrics that
are displayed for the Home page and News applications. The metrics
collector is a batch process that runs every night.



      NewsCheckUpdatedPersons
    Used internally to discover how often a person
status changes in the system, for example, when a user is marked as
active or inactive.



      PersonSpreadTranche
    A scheduled task that load balances the users
in the existing tranches that are used by the email digest so that
users are spread in a uniform way according to their mail domain.


       You can run this task manually using the NewsEmailDigestService.loadBalanceEmailDigest()
command. For more information, see Reallocating and load balancing
users according to mail domain.




      









       
    4.  You must check the configuration file back in after making
changes, and it must be checked in during the same wsadmin session
in which it was checked out for the changes to take effect. See Applying
property changes in the News repository for details.


    


     
    Related tasks
    

  •   Configure database clean-up for the News repository

  •   Synchronize News data with other applications

  •  IBM Connections configuration property values

  •  Reallocating and load balancing users according to mail domain




    Back up the Search index manually
    





     The Search index can be backed up and restored at a later
date in the event of loss or corruption of data.

    


     To back up the Search index manually, complete the following steps.


     
      


       
    1.  Disable any regular indexing tasks that you have configured. 


       To disable all tasks, enter the following command: 


      SearchService.disableAllTasks()
      







       
    2.  Verify that indexing is not ongoing. For more
information, see Verifying that index building is not taking
place.





       
    3.  Copy the entire index directory and its subdirectories
to a secure backup location.





       
    4.  Optional: When backing up the Search index,
consider performing a full backup of the HOMEPAGE database. Note
that the Search index has a dependency on data in the HOMEPAGE database.





       
    5.  Re-enable your indexing task or tasks by performing one
of the following steps:

        


         
      •  If you had no tasks that were disabled before you completed
step 1, then run the SearchService.enableAllTasks() command.





         
      •  If you had specific tasks that were disabled before you completed
step 1, then use the SearchService.enableTask(String taskname) command
to enable those tasks.


         For example: 


        SearchService.enableTask("mine")
        




      
 The next indexing task to run resumes indexing at the point
at which the restored index was last successfully indexed.


    



    Related
    

  •   Restore the Search index


    

  •  Back up the Search index using wsadmin commands

  •   Enable and disable scheduled tasks

  •  Listing scheduled tasks


     

  •  SearchService commands




     Change the location of the Search index
    





     By default, the Search index is stored in the search/index subdirectory
of the IBM Connections data
directory defined at install time, for example, on Linux, /opt/IBM/Connections/data/local/search/index.
This location can be changed by editing the IBM WebSphere Application Server variable, SEARCH_INDEX_DIR.




Each node running the Search application requires its own
dedicated index on the file system. Using a Search index on a network
share is not supported. Highly-available network storage, such as
a storage area network (SAN), can be used but it must be configured
to be locally mounted to each node running the Search application.


      Changing
the value of the SEARCH_INDEX_DIR variable causes the next indexing
task that fires to index all content from the beginning, so that the task creates a clean index. This operation might take some time to
complete.


    


     To change the location of the Search index, complete
the following steps.


     
      


       
    1.  Launch the WebSphere Application Server Integrated Solutions Console.





       
    2.  Select Environment > WebSphere variables.





       
    3.  Select the SEARCH_INDEX_DIR environment
variable from the list of defined variables. Depending
on your deployment choices, there might be more than one SEARCH_INDEX_DIR
variable defined. IBM recommends that you have consistent locations
for the Search index directory across the nodes in your deployment.





       
    4.  Change all the SEARCH_INDEX_DIR variables by selecting
each variable, entering a new location for the variable in the Value field,
and then clicking OK.





       
    5.  Save your changes to the configuration.





       
    6.  Restart the Search server or servers for your changes to
take effect.


    




     Configure database clean-up for the News repository
    





     Edit settings in the news-config.xml file
to define the interval at which the different database clean-up tasks
run and specify when the IBM WebSphere Application Server
scheduler starts the tasks.


     


     To edit configuration files, you must
use the WebSphere Application Server wsadmin client. See Starting
the wsadmin client for details.





The database clean-up tasks defined in the news-config.xml file
ensure that content that is out-of-date is periodically removed from
the News repository. You can update the following properties for these
tasks:


     
    enabled
    




     
    Enables or disables the task. This property takes a Boolean value,
true or false. The value must be formatted in lowercase.
    




     
    interval
    




     
    Specifies the interval at which the task runs. This property is
a string value that must be specified in Cron format. For more information
about the Cron schedule, see Scheduling tasks.
    

    





      If you disable the database clean-up tasks, you
run the risk of rapidly reaching your file system storage limit as
the database increases in size. Disabling these tasks can also result
in poor data access performance.


    


     To configure database clean-up tasks, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the News Jython script interpreter.


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Check out the News cell-level
configuration file : 


         NewsCellConfig.checkOutConfig("working_dir",
"cellName")

        ...where:


         
          


           
        •  working_dir is the temporary directory to which
you want to check out the cell-level configuration file. This directory
must exist on the server where you are running wsadmin.


            AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






           
        •  cellName is the name of the cell that the home
page node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, type the following command in the wsadmin command processor to determine it:


           print
AdminControl.getCell()



        
For example: 


        NewsCellConfig.checkOutConfig("d:/temp", "NewsServerNode01Cell")
        
The command displays this message: 


        News Cell Level configuration file successfully checked out.
        



      






       
    3.  Open news-config.xml in a text editor.





       
    4.  Locate the section of the file containing the database
clean-up tasks and make the necessary changes. 


       
        


         
      •  To update the News data clean-up task:


         
          


           
        1.  Enable or disable the task by locating the following section of
code and updating the value of the enabled parameter. By default,
the task is enabled and runs every day exactly at 23 hours.


          <task name="NewsDataCleanup" description="Job to clean up the news"
interval="0 0 23 ? * *" startby="" enabled="true" scope="cluster" type="internal"
targetName="ScheduledTaskService" mbeanMethodName="" serverName="unsupported" >
</task>
          






           
        2.  Set the interval at which news stories are deleted from the News repository:


           For example, the following code specifies that
news stories are deleted from the database when they are more than
30 days old.


          <databaseCleanup>
...
  <storyLifetimeInDays>30</storyLifetimeInDays>
</databaseCleanup>
          




        






         
      •  To update the ReplyToId clean-up task:


         
          


           
        1.  Enable or disable the task by locating the following section of
code and updating the value of the enabled parameter. By default,
the task is enabled and runs weekly.


          <!-- This task run periodically to purge the system of expired ReplyTo Id records>
  <task  serverName="unsupported"
    startby=""
    mbeanMethodName=""
    targetName="ScheduledTaskService"
    type="internal"
    scope="cluster"
    enabled="true"
    interval="0 0 4 ? * SAT"
    description="Job to cleanup Expired ReplyTo Id records"
    name="ReplyToIdCleanup" >
  </task>
          






           
        2.  Set the expiry date for the ReplyTo IDs that enable users to reply
to notifications about forum posts directly in the forum:


           For example,
the following code specifies that ReplyTo IDs are deleted from the database when they are 365 days old.


          <databaseCleanup>
...
  <replyToIdLifetimeInDays>365</replyToIdLifetimeInDays>
</databaseCleanup>
          




        






         
      •  To update the ReplyToAttachment clean-up task:


         
          


           
        1.  Enable or disable the task by locating the following section of
code and updating the value of the enabled parameter. By default,
the task is enabled and runs weekly.


          <!-- This task runs periodically to remove any replyTo attachments that were not properly removed from the shared data store>
  <task  serverName="unsupported"
    startby=""
    mbeanMethodName=""
    targetName="ScheduledTaskService"
    type="internal"
    scope="cluster"
    enabled="true"
    interval="0 0 4 ? * SUN"</p><p>
    description="Job to cleanup Expired ReplyTo Attachment Files"
    name="ReplyToAttachmentCleanup" >
  </task>
          






           
        2.  Set the number of days to keep mailed-in reply attachments
and folders on the file system before deleting them:


           For example,
the following code specifies that any resource stored by the system
is to be deleted after 7 days.


          <databaseCleanup>
...
  <!-- The number of days before the system will remove any replyTo attachments that were not properly removed from the shared data store. -->
  <replyToAttachmentLifetimeInDays>7</replyToAttachmentLifetimeInDays>
</databaseCleanup>
          




        



      






       
    5.  After making changes, check the configuration
files back in, and you must do so during the same wsadmin session
in which you checked them out for the changes to take effect. See Applying
property changes in the News repository for information about
how to save and apply your changes.


    


     
    Related tasks
    

  •   Apply property changes in the News repository

  •   Access the News configuration file

  •   Manage scheduled tasks for the News repository

  •   Purging compromised reply-to IDs




     Synchronize News data with other applications
    





     Edit settings in the news-config.xml file
to define the interval at which data from the IBM Connections applications is synchronized
with the News repository.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





To ensure that the information received by the News repository
is analyzed correctly, you need to synchronize data between the other IBM Connections applications and
the News repository to ensure that the information in the repository
is kept up-to-date. The interval at which data is synchronized is
specified using the frequencyInHours setting. By default, the synchronization
is set to take place every 24 hours.

    


     To configure the data synchronization task, complete
the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the News Jython script interpreter.


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Check out the News cell-level
configuration file : 


         NewsCellConfig.checkOutConfig("working_dir",
"cellName")

        ...where:


         
          


           
        •  working_dir is the temporary directory to which
you want to check out the cell-level configuration file. This directory
must exist on the server where you are running wsadmin.


            AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






           
        •  cellName is the name of the cell that the home
page node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, type the following command in the wsadmin command processor to determine it:


           print
AdminControl.getCell()



        
For example: 


        NewsCellConfig.checkOutConfig("d:/temp", "NewsServerNode01Cell")
        
The command displays this message: 


        News Cell Level configuration file successfully checked out.
        



      






       
    3.  Open news-config.xml in a text editor.





       
    4.  Locate the section containing the dataSynchronization task
and make the necessary changes. 


       For example, the following code specifies that data is synchronized between the News repository
and the IBM Connections applications
every 24 hours. The information is copied over only if it hasn't
been copied already in the last 24 hours.


      <dataSynchronization>
  <frequencyInHours>24</frequencyInHours>
</dataSynchronization>
      







       
    5.  After making changes, check the configuration
files back in, and you must do so during the same wsadmin session
in which you checked them out for the changes to take effect. See Applying
property changes in the News repository for information about
how to save and apply your changes.


    


     
    Related tasks
    

  •   Apply property changes in the News repository

  •   Access the News configuration file




     Apply
property changes in the News repository
    





     After making
changes to News configuration settings, you
must check in the configuration settings and restart the server to
apply the changes.


     You must perform
the check-in during the same wsadmin session
in which you checked out the files for the changes that you made to
take effect.

    


     
      


       
    1.  Complete your configuration
changes.





       
    2.  Check in the changed configuration
property keys using
the following wsadmin client command: 


       NewsCellConfig.checkInConfig()






       
    3.  Update the value of the version stamp configuration
property
in LotusConnections-config.xml to force
users' browsers to pick up this change. See Required post-customization
step for more details.





       
    4.  To exit the wsadmin
client, type exit at
the prompt.





       
    5.  Use the IBM WebSphere Application Server
Integrated Solutions Console to stop and restart the server hosting
the News application.


    


     
    Related tasks
    

  •   Configure database clean-up for the News repository

  •   Synchronize News data with other applications

  •   Apply common configuration property changes

  •  Required post-customization step




     Set the maximum size for microblogs
    





     Edit settings in the news-config.xml file
to set the maximum size of microblogs in your deployment.


     


     To edit configuration files, you must
use the WebSphere Application Server wsadmin client. See Starting
the wsadmin client for details.





In IBM Connections 4, the board feature has been replaced by the activity stream, which
has capabilities for displaying richer HTML content and events in
addition to status updates. The following microblog settings for the board previously stored in the profiles-config.xml file
are no longer supported:


    <property name="com.ibm.lconn.profiles.config.ui.theboard.entry.ViewTruncateChars" value="250"/>
<property name="com.ibm.lconn.profiles.config.ui.theboard.comment.ViewTruncateChars" value="250"/>
    





     In
this release, you can control the size of microblog data in your deployment
by specifying the maximum number of characters allowed for entries
and comments in the news-config.xml file.


    


     To specify microblog settings, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the News Jython script interpreter.


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Check out the News cell-level
configuration file : 


         NewsCellConfig.checkOutConfig("working_dir",
"cellName")

        ...where:


         
          


           
        •  working_dir is the temporary directory to which
you want to check out the cell-level configuration file. This directory
must exist on the server where you are running wsadmin.


            AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






           
        •  cellName is the name of the cell that the home
page node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, type the following command in the wsadmin command processor to determine it:


           print
AdminControl.getCell()



        
For example: 


        NewsCellConfig.checkOutConfig("d:/temp", "NewsServerNode01Cell")
        
The command displays this message: 


        News Cell Level configuration file successfully checked out.
        



      






       
    3.  Open news-config.xml in a text editor.





       
    4.  Locate the <microblogging settings> section of the file
and update the following lines as needed. 


       
        


         
      •  


        <microblogEntryMaxChars>1000</microblogEntryMaxChars>
        
Specifies
the maximum number of characters allowed for microblog entries. The default value is 1000.





         
      •  


        <microblogCommentMaxChars>1000</microblogCommentMaxChars>
        
Specifies
the maximum number of characters allowed for microblog comments. The default value is 1000.


      






       
    5.  Save your changes to the news-config.xml file.





       
    6.  After making changes, check the configuration
files back in, and you must do so during the same wsadmin session
in which you checked them out for the changes to take effect. See Applying
property changes in the News repository for information about
how to save and apply your changes.


    


     
    Related tasks
    

  •   Apply property changes in the News repository




     Configure activity stream search index settings
    





     You can update the default settings for the index folder
and the shared replication folder for the activity stream search service.




The IBM WebSphere Application Server variables
ACTIVITY_STREAM_SEARCH_INDEX_DIR and ACTIVITY_STREAM_SEARCH_REPLICATION_DIR
define the location of the activity stream search index folder and
the activity stream search replication folder respectively. The search
index folder stores the actual index. You need one of these for each
server. The shared replication folder stores the changes that have
been recently made to the index. You need one shared replication folder
for each server cluster.


     The default directory path for the ACTIVITY_STREAM_SEARCH_INDEX_DIR
and ACTIVITY_STREAM_SEARCH_REPLICATION_DIR variables on the cell scope
is set when you install IBM Connections,
and this definition is automatically used for every additional node.
However, you can update the paths on the cell scope if you want to
customize the default settings.


    


     
      


       
    1.  From the IBM WebSphere Integrated Solutions Console, expand Environment and select Websphere
Variables.





       
    2.  Select ACTIVITY_STREAM_SEARCH_INDEX_DIR,
enter the location of the local activity stream search index folder
in the Value field, click Apply,
and then click OK.





       
    3.  Select ACTIVITY_STREAM_SEARCH_REPLICATION_DIR,
enter the location of the shared replication folder in the Value field,
click Apply, and then click OK. All nodes need access to this shared folder.


    


     
    Related tasks
    

  •   Copy the activity stream search index to new nodes




     Copy the activity stream search index to new nodes
    





     When you add a node to the News cluster to ensure high
availability for activity stream search requests, copy the activity stream search index to the new node. Before copying the index,
ensure that you disable scheduled metadata collections.

    


     To copy the activity stream search index to a new node,
complete the following steps.


     
      


       
    1.  Access the Activity Stream Search Administration page
by entering the following URL in your browser and logging in using
your admin user credentials: 
      http://server_name/news/web/activityStreamSearchAdmin/activityStreamSearchAdmin.action





       
    2.  Disable source metadata collection by selecting More actions > Disable Schedule. This action stops future collections, but it does
not delete existing metadata from the index.





       
    3.  Copy the activity stream search index folder from an existing
node to the new node by following these steps:


       
        


         
      1.  Log in to the Integrated Solutions Console and click Servers > Clusters > WebSphere
application server clusters.





         
      2.  Click cluster_name,

        ...where cluster_name is the name of the News cluster.





         
      3.  In the Additional Properties area, expand Cluster
members and then click Details.





         
      4.  In the table of cluster members, make a note of the nodes that host the cluster members.





         
      5.  Copy the activity stream search index folder from an
existing node to the new node. 


         The activity stream search
index is located in the ActivityStream folder that is defined by the ACTIVITY_STREAM_SEARCH_INDEX_DIR WebSphere Application Server variable.





         The default location of the variable is \opt\IBM\Connections\DataLocal\news\search\index.
The activity stream search index is located in the ActivityStream
subfolder that is created under the path.
See Configuring
activity stream search index settings for information about
how to configure the ACTIVITY_STREAM_SEARCH_INDEX_DIR variable.


      






       
    4.  To reenable source metadata collection, return to the Activity
Stream Search Administration page using the URL in step
1, and select More actions > Enable Schedule.


    


     
    Related tasks
    

  •   Configure activity stream search index settings




     Delete community microblogs from the News repository
    





     You can use an administrative command to remove orphaned
community microblog data as part of the community widget life-cycle
disaster recovery scenario.


     


     To run administrative commands, you must
use the wsadmin client. See Starting
the wsadmin client for details.





A microblog is a status update message that is posted to
a community activity stream. Microblog updates are displayed in the aggregated list of events in the Recent Updates widget in Communities.
If a community owner has added the Status Updates widget to a community,
microblog messages can also be seen in that widget. In addition, microblog
messages are displayed when users filter the Home page activity stream
to show status updates for a community.


     The microblogs that display
in the Recent Updates and Status Updates widgets in Communities are
stored in the News repository. In the event of a database failure
or some other disaster, if the associated community data has been
deleted, you might decide that the orphaned microblog data in the News repository should be removed. The NewsMicrobloggingService.deleteMicroblogs
command allows you to remove all microblog and associated data for
a community from the News repository. Note that there is no support
for deleting other types of events that display in the Recent Updates
widget. For more information about removing orphaned data, see Deleting
orphaned data.


    


     To delete community microblogs from the News repository,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Jython script interpreter for the News repository.


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    3.  Use the following command: 


       


       
      NewsMicrobloggingService.deleteMicroblogs("communityId")
      




       
      


       Removes all microblog and associated data for a community from
the News repository.





       This command takes a single parameter,
which is a string that specifies the ID of the community whose microblog
data you want to delete.





       For example:


      NewsMicrobloggingService.deleteMicroblogs("e952cf0c-a86c-4e26-b1e0-f8bf40a75804")
      


      

      




    


     
    Related tasks
    

  •   Delete orphaned data




    Reallocating
and load balancing users according to mail domain
    





     Use
the NewsEmailDigestService.loadBalanceEmailDigest()
command to manually reallocate and load balance users in the different
email tranches (or groups of email addresses) used by the email digest.


     


     To run administrative commands, you must
use the wsadmin client. See Starting
the wsadmin client for details.





A scheduled
task runs every month to load balance the users
in the email address groups used by the email digest. This task ensures
that users are spread across the groups in a uniform way according
to their mail domain. The task is configured in the news-config.xml file
and looks as follows. Note that the default settings should not be
modified.


    <task serverName="unsupported" 
   startby="" 
   mbeanMethodName="" 
   targetName="ScheduledTaskService" 
   type="internal" 
   scope="cluster" 
   enabled="true" 
   interval="0 0 22 1 * ?" 
   description="Job to spread users in tranche" 
   name="PersonSpreadTranche"  > 
</task>
    
By default, the task runs on the first day of
every month at 10:00 p.m. If you do not want to wait for the next
scheduled task, you can run the task manually using the NewsEmailDigestService.loadBalanceEmailDigest()
MBean command.

    


     To reallocate and load
balance users in the existing
email address groups used by the email digest, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Jython script interpreter for
the News repository.


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    3.  Enter the following command: 


       


       
      NewsEmailDigestService.loadBalanceEmailDigest()
      




       
      


       Reallocates and load balances the users in the email address
groups used by the email digest according to mail domain. This command
does not take any parameters.





       The command returns the number
of users who have been reallocated to different email address groups
for load balancing purposes.





       For example:


      wsadmin> NewsEmailDigestService.loadBalanceEmailDigest()
1603
      


      

      




    




     Administer activity stream search
    





     Update information related to the activity stream search
service and manage the collection of activity stream data.


     To access the activity stream service administrative user
interface, you must be assigned the IBM WebSphere Application Server
search-admin role. For more information about this role, see the Roles topic.




You can access options for managing the activity stream search
service from the Activity Stream Search Administration page.
From this page, you can update the settings for the activity stream
source, check the status of the activity stream search service, see
when it was last updated, and when the next update is due.


     The activity
stream source publishes metadata about activity stream entries and
collects that metadata in an index. The metadata is collected automatically
on a schedule, but you can also collect data manually, delete data
from the index, and disable the schedule using the options available
from the administration page.


    


     Administer activity stream search by performing the following steps.


     
      


       
    1.  To access the Activity Stream Search Administration page,
enter the following URL in your browser and log in using your admin
user credentials: 


      http://server_name/news/web/activityStreamSearchAdmin/activityStreamSearchAdmin.action
      
There
is no link provided from the IBM Connections user interface, you must access the page using the direct URL.





       
    2.  To manage the activity stream search service, perform the following tasks:

        


         
      •  To view the number of documents in the index, see the Number
of items column.





         
      •  To check whether the scheduler is enabled, view the Status column.
When the scheduler is enabled, you can see the result of the last
crawl; otherwise, the status displays as Disabled.
When the scheduler is disabled, periodic crawling does not take place,
but the search operation still works on existing indexed content.





         
      •  To edit the activity stream source, click Edit
Details. Update the following fields as needed, and then
click OK:


         
          


           
        •  Name. The name of the source. The source
is the service that you are crawling.





           
        •  Server URL. The web address of the local IBM Connections server. The source
and its server URL are automatically created when the News application
starts up for the first time after the product is installed.





           
        •  Seedlist URL. The web address of the seedlist
that will be crawled. By default, the URL points to localhost, which
means that crawling is done programmatically instead of using HTTP.





           
        •  Collect every. The interval at which new
data is collected from the activity stream. The default setting is
30 seconds.


        






         
      •  To manage source metadata collection, click More
actions and select one of the following options: 


         
          


           
        •  Collect Data. Crawls the activity stream
content and collects new data. Select this option when you want to
crawl for new data immediately, without waiting for the next scheduled
crawl. When the crawler is disabled, you can still use this option
to manually collect data from existing indexed content.





           
        •  Clear Data. Deletes activity stream metadata
from the index. Select this option when you want to delete the indexed
content and perform a full crawl. This option is useful when you want
to investigate unexpected issues but should not be used frequently
as it is resource intensive.





           
        •  Disable Schedule. Disables the crawler.
Selecting this option disables the collection of metadata but it does
not delete existing metadata from the index. When you install IBM Connections, the schedule is
disabled by default.


        



      



    


     
    Related tasks
    

  •   Assign people to J2EE roles


     

  •  Roles




     Manage scheduled tasks for the News repository
    





     Use administrative commands to manage scheduled tasks for
the News repository.


     


     To run administrative commands, you must
use the wsadmin client. See Starting
the wsadmin client for details.





You can use the NewsScheduler commands to pause and resume
the scheduled tasks for the News repository, and to retrieve information
about tasks. The scheduling information is contained in the news-config.xml file.
The SystemOut.log file also contains information
about whether the scheduler is running and whether any scheduled tasks
have started.


     The News repository uses the IBM WebSphere Application Server scheduling service for performing regular managed tasks. For more information about how the scheduler works, see Scheduling
tasks.


    


     To manage a scheduled task.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Jython script interpreter for the News repository.


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    3.  Use the following commands to administer the scheduler
service for the News repository. 


       


       
      NewsScheduler.getTaskDetails(java.lang.String taskName)
      




       
      


       Returns information about the scheduled task specified by taskName.





       The values returned are server time, next scheduled run time, status (SCHEDULED,
RUNNING, SUSPENDED), and task name. When the task has been paused,
then the status parameter shows as SUSPENDED instead of SCHEDULED.
SUSPENDED means that the task is not scheduled to run.





       For example:


      NewsScheduler.getTaskDetails("NewsDataCleanup")
      
The
resulting output looks similar to the following:


      {taskName=NewsDataCleanup, currentServerTime=Fri Mar 12 14:42:25 GMT 2010, nextFireTime=Fri Mar 12 23:00:00 GMT 2010, status=SCHEDULED}
      


      




       
      NewsScheduler.pauseSchedulingTask(java.lang.String taskName)
      




       
      


       Temporarily pauses the specified task and stops it from running.





       When
you pause a scheduled task, the task remains in the suspended state
even after you stop and restart News or the WebSphere Application Server. You must
run the NewsScheduler.resumeSchedulingTask(String taskName) command
to get the task running again.





       If the task is currently running,
it continues to run but is not scheduled to run again. If the task
is already suspended, this command has no effect. When the task is
paused successfully, a 1 is returned to the wsadmin client. When the task is not paused successfully, a 0 is returned.





       For example:


      NewsScheduler.pauseSchedulingTask("NewsDataCleanup")
      


      




       
      NewsScheduler.resumeSchedulingTask(java.lang.String taskName)
      




       
      


       If the task is suspended, puts the task in the scheduled state.
If the task is not suspended, this command has no effect.





       When
a task is resumed, it does not run immediately; it runs at the time
when it is next scheduled to run. 





       For example:


      NewsScheduler.resumeSchedulingTask("NewsDataCleanup")
      
When
the task is resumed successfully, a 1 is returned to the wsadmin client.
When the task is not resumed successfully, a 0 is returned.

      

      




    


     
    Related tasks
    

  •   Configure database clean-up for the News repository




     Purging compromised reply-to IDs
    





     Use the NewsMailinService commands to delete compromised
reply-to IDs from the system and ensure that replies are received
from secure IDs only. If a particular reply to ID is being misused,
you can delete that ID from the system while keeping the user.s other
valid IDs active.


     


     To run administrative commands, you must
use the wsadmin client. See Starting
the wsadmin client for details.





In IBM Connections 4, users can reply to a forum post directly
from an email notification about the post. For example, when a forum
topic is updated, a notification is sent out to all the people who
are following that topic and those people can reply to the topic by
clicking a link in the notification. The notification has a ReplyToNotification
ID and each recipient is issued a ReplyToID. This reply-to ID is included
in the reply email address and is used to verify the content coming
back in to the system when the user replies to the notification. If you suspect that a reply-to ID has been compromised, you can remove
the ID from the system using the NewsMaillinService commands. For example, when users leave the organization, you might want to remove
all their reply-to IDs so that they cannot update a feature by saving
an ID and responding to a forum post.


     The ReplyToIdCleanup task
also runs weekly to purge the system of any reply-to ID records that
are out of date. This task removes any IDs that are older than the interval specified by the replyToIdLifetimeInDays property. The expiry
period is set to 365 days by default. The ReplyToIdCleanup task removes
any ReplyToNotification IDs that have expired so that it is no longer
possible for users to reply to the forum topic from the email notification.
All related reply-to IDs are also removed as part of the clean-up
task. Note that the task does not perform any security checking for
comprised or corrupted IDs. For information about how to configure
the ReplyToIdCleanup task, see Configuring database clean-up
for the News repository.





     Reply-to IDs can vary in format
but in general they look similar to the following:


    id@connections.example.com
id_mailin@connections.example.com
    
For
example: 


    c0c7e9bf-32d9-48a7-933c-74794479ebf3_replyto@connections.example.com
    
You
can customize reply-to IDs if you want. For instance, instead of using
the ID as a prefix as in the example, you can include it as a suffix.
For example: 


    replyto_c0c7e9bf-32d9-48a7-933c-74794479ebf3@connections.example.com
    



    


     To remove reply-to IDs from the system, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Jython script interpreter for the News repository.


       
        


         
      1.  Use the following command
to access the News configuration file: 


        execfile("newsAdmin.py")
        
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.


      






       
    3.  Use the following commands: 


       


       
      NewsMailinService.removeReplyToId("replyto address ID")
      




       
      


       Removes a single reply-to ID.





       This command takes a single
parameter, which is a string that specifies the reply-to ID that you
want to delete.





       For example:


      NewsMailinService.removeReplyToId("c0c7e9bf-32d9-48a7-933c-74794479ebf3")
      


      




       
      NewsMailinService.removeReplyToIdsForUserExtId("user extId")
      




       
      


       Removes all the reply-to IDs for the user with the specified
external ID.





       This command takes a single parameter, which is
a string that specifies the external ID for the user whose reply-to
IDs you want to delete.





       For example:


      NewsMailinService.removeReplyToIdsForUserExtId("91b3897d-b4f8-4d05-3621-50bcaa22d300")
      


      




       
      NewsMailinService.removeReplyToIdsForUserEmail("user email")
      




       
      


       Removes all the reply-to IDs for the user with the specified
email address.





       This command takes a single parameter, which
is a string that specifies the email address for the user whose reply-to
IDs you want to delete.





       For example:


      NewsMailinService.removeReplyToIdsForUserEmail("mary_smith@example.com")
      


      

      




    


     
    Related tasks
    

  •   Configure database clean-up for the News repository




     Configure event log clean-up for Profiles . obsolete
    





     Edit settings in the profiles-config.xml file
to define the interval at which events are deleted from the Profiles
database and specify how often the event log clean-up task runs.


     


     To edit configuration files,
you must use the wsadmin client. See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.





The event log clean-up process is responsible for cleaning
up the event log table and ensuring that events are periodically removed
from the Profiles database. By default, the clean-up process automatically
removes any entries in the EVENTLOG table that are older than 30 days
and the process is run once a day. You can change these default settings
if necessary.

    


     To configure event log clean-up for Profiles, add properties
to the profiles-config.xml file.


     
      


       
    1.  Start
the wsadmin client from the following directory of the system on which you installed the Deployment Manager:  


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Profiles Jython script interpreter.


       
        


         
      1.  Enter the following command
to access the Profiles configuration files: 
        execfile("profilesAdmin.py") 
        If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Enter the following command
to check out the Profiles configuration files: 
        ProfilesConfigService.checkOutConfig("working_directory",
"cell_name")where:


         
          


           
        •  working_directory is
the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
(/) to separate directories in the file path, even if you are using
the Microsoft Windows operating system.


            AIX and Linux only: The directory must grant write
permissions or the command does not complete successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the Profiles application. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor: 
          print
AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:


          ProfilesConfigService.checkOutConfig("/opt/prof/temp","foo01Cell01")
          






           
        •  Microsoft

          Windows:


          ProfilesConfigService.checkOutConfig("c:/prof/temp","foo01Cell01")
          



        



      






       
    3.  Open the profiles-config.xml file
in a text editor.





       
    4.  Add the following settings to the "Additional config settings
START" section of the file: 


      <properties>
  <property name="com.ibm.lconn.profiles.config.EventLogToKeepInDays" value="30"/>
  <property name="com.ibm.lconn.profiles.config.DBCleanupIntervalInMinutes" value="1440"/>
</properties>
      

      ...where:


       
      com.ibm.lconn.profiles.config.EventLogToKeepInDays
      




       
      Defines how long (in days) events are kept in the EVENTLOG table.
After the specified time, the events are deleted from the database.
The default value is 30.
      




       
      com.ibm.lconn.profiles.config.DBCleanupIntervalInMinutes
      




       
      Specifies the interval (in minutes) at which events are deleted
from the EVENTLOG table. The default value is 720.
      

      






       
    5.  Save your changes and close the configuration file.


    


     
    Related tasks
    

  •   Apply property changes in Profiles

  •   Manage the Profiles event log




     Configure Profiles directory search options
    





     Configure directory search options to specify the fields
that can be used when performing a search.


     


     To edit configuration files,
you must use the wsadmin client. See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.





A directory search in Profiles allows the user to search
using multiple fields. You can customize the Search the Directory form to include custom fields. You can also
specify which predefined fields are available on the search form.
For example, you might want to prevent an email address field from
displaying on the form.

    


     To configure directory search options for Profiles, complete
the following steps.


     
      


       
    1.  Start
the wsadmin client from the following directory of the system on which you installed the Deployment Manager:  


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  Start the Profiles Jython script interpreter.


       
        


         
      1.  Enter the following command
to access the Profiles configuration files: 
        execfile("profilesAdmin.py") 
        If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Enter the following command
to check out the Profiles configuration files: 
        ProfilesConfigService.checkOutConfig("working_directory",
"cell_name")where:


         
          


           
        •  working_directory is
the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
(/) to separate directories in the file path, even if you are using
the Microsoft Windows operating system.


            AIX and Linux only: The directory must grant write
permissions or the command does not complete successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the Profiles application. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor: 
          print
AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:


          ProfilesConfigService.checkOutConfig("/opt/prof/temp","foo01Cell01")
          






           
        •  Microsoft

          Windows:


          ProfilesConfigService.checkOutConfig("c:/prof/temp","foo01Cell01")
          



        



      






       
    3.  Open the profiles-config.xml file
in a text editor.





       
    4.  Locate the <searchLayout> section and
edit it to specify which fields display on the Search the Directory form.  


       
        


         
      •  To enable a predefined attribute for search, include the following line for each attribute to include:


        <attribute showLabel="true">attribute_name</attribute>
        
For
a complete list of the predefined attributes that can be included
in the Search the Directory form, see Profiles
directory search attributes.





         
      •  To enable a custom extension attribute for search, include the following line for each custom attribute to include:


        <extensionAttribute showLabel="true" labelKey="label.custom.attribute_id" bundleIdRef="bundle_name" extensionIdRef="attribute_id"/>
        
Use
the optional hideOnSearchUIForm attribute to control
whether the custom field displays in the Search the Directory form.
When this property is set to true, the custom field does not display
in the user interface. For example:


        <extensionAttribute showLabel="false" hideOnSearchUIForm="true" extensionIdRef="schoolName" />
        
In
the preceding example, the schoolName custom extension
attribute is hidden in the directory search user interface, but because
the attribute is enabled for search, the following URL can be used
to find the result:


        http://yourco.com/profiles/html/advancedSearch.do?keyword=&displayName=&preferredFirstName=Joseph&preferredLastName=&profileTags=&jobResp=&experience=&background=&organizationTitle=&workLocation%24city=&workLocation%24state=&countryDisplayValue=&email=&telephoneNumber=&extattr%24schoolName=yourschool&lang=en_us
        





          For more information about adding custom extension attributes to Profiles,
see Add custom extension attributes for Profiles.
For information about how to add custom strings in Profiles, see Add
custom strings for widgets and other specified scenarios.



      
For example:


      <searchLayout>
   <attribute showLabel="true">displayName</attribute>
   <attribute showLabel="false">preferredFirstName</attribute>
   <attribute showLabel="false">preferredLastName</attribute>
   <attribute showLabel="true">profileTags</attribute>
   <attribute showLabel="true">jobResp</attribute>
   <attribute showLabel="false">departmentTitle</attribute>
   <attribute showLabel="false">experience</attribute>
   <attribute showLabel="false">background</attribute>
   <attribute showLabel="true">organizationTitle</attribute>
   <attribute showLabel="false">workLocation.city</attribute>
   <attribute showLabel="false">workLocation.state</attribute>
   <attribute showLabel="false">countryDisplayValue</attribute>
   <attribute showLabel="false">email</attribute>
   <attribute showLabel="false">telephoneNumber</attribute>
   <extensionAttribute showLabel="true" labelKey="label.custom.schoolName" bundleIdRef="education" extensionIdRef="schoolName"/>
</searchLayout>
      



    


     
    Related tasks
    

  •  Hide email addresses

  •  Expose email addresses

  •  Add custom strings for widgets and other specified scenarios




     Configure status updates and messages character limits for
Profiles - obsolete
    





     You can configure settings in the profiles-config.xml file
to control the character limit available in the Recent Updates area
of the Profiles user interface for status updates, messages, and comments.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.


    


     To set the character limit for status updates and messages,
complete the following steps.


     
      


       
    1.  Start the wsadmin
client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly. For more information, see Starting
the wsadmin client.






       
    2.  Start the Profiles Jython script interpreter.


       
        


         
      1.  Enter the following command
to access the Profiles configuration files: 
        execfile("profilesAdmin.py") 
        If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





         
      2.  Enter the following command
to check out the Profiles configuration files: 
        ProfilesConfigService.checkOutConfig("working_directory",
"cell_name")where:


         
          


           
        •  working_directory is
the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
(/) to separate directories in the file path, even if you are using
the Microsoft Windows operating system.


            AIX and Linux only: The directory must grant write
permissions or the command does not complete successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the Profiles application. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor: 
          print
AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:


          ProfilesConfigService.checkOutConfig("/opt/prof/temp","foo01Cell01")
          






           
        •  Microsoft

          Windows:


          ProfilesConfigService.checkOutConfig("c:/prof/temp","foo01Cell01")
          



        



      






       
    3.  Open the profiles-config.xml file
in a text editor.





       
    4.  Update the following settings in the <properties> section
of the file. 


      <properties>
<property name="com.ibm.lconn.profiles.config.theboard.entry.MaxChars" value="1000"/>
<property name="com.ibm.lconn.profiles.config.ui.theboard.entry.ViewTruncateChars" value="250"/>
<property name="com.ibm.lconn.profiles.config.ui.theboard.comment.ViewTruncateChars" value="250"/>
</properties>
      

      ...where:


       
      com.ibm.lconn.profiles.config.theboard.entry.MaxChars
      




       
      


       Controls how many characters can be entered in status updates,
messages, and comments. The default is 1000 characters.

      




       
      




       
      




       
      com.ibm.lconn.profiles.config.ui.theboard.entry.ViewTruncateChars
      




       
      


       Controls how many characters are viewable in the Recent Updates
area for status updates, messages, and comments. The default is 250
characters.





       Text is truncated after 250 characters even though
the actual text can be stored in the database up to the maximum number
of characters specified by the com.ibm.lconn.profiles.config.theboard.entry.MaxChars
property.

      




       
      com.ibm.lconn.profiles.config.ui.theboard.comment.ViewTruncateChars
      




       
      


       Controls how many characters are viewable in the Recent Updates
area for status updates, messages, and comments. The default is 250
characters.





       Text is truncated after 250 characters even though
the actual text can stored in the database up to the maximum number
of characters specified by the com.ibm.lconn.profiles.config.theboard.entry.MaxChars
property.

      

      






       
    5.  Save your changes and close the configuration file.





       
    6.  After making changes, check the configuration
files back in, and you must do so during the same wsadmin session
in which you checked them out for the changes to take effect. See Applying
property changes in Profiles for information about how to save
and apply your changes.


    


     
    Related tasks
    

  •   Apply property changes in Profiles




     Manage Communities administrators - obsolete
    





     In deployments with Profiles installed and the default
configuration, the Profiles database synchronizes with your enterprise
repository, and then propagates the user data to the other application
DBs. Communities administrators are an exception, because they
are stored in the Member Manager repository in IBM WebSphere Application Server. To synchronize Communities administrators (users in the Communities admin role)
with your enterprise repository, you must use the CommunitiesMemberService.syncMemberExtIdByLogin() command.







     The CommunitiesMemberService.syncMemberExtIdByLogin("name",
{"allowInactivate":"true"}) command synchronizes the member
records in the application member table identified in the user login
name parameter. If a match is found, the command checks the external
ID in the application member table against the value in the configured
directory to see if it is the same or different. If the external ID
matches, then the user's email address and display name and any additional
login names are updated so that they match the ones in the configured
directory. The refresh operation is not logged.





     If the external
ID in the member table in the application database does not match
the one in the configured directory, then a synchronize operation
is performed and the user's external ID in the member table in the application database is updated with that of the external id in the configured directory.  Also, the user's email, display name, and any
additional login names are refreshed. Each user that is synchronized
by this operation is logged in the log file. If the user cannot be
found in the configured directory by any means (external ID, login
names, or email) then the user is inactive because the person exited
the company and is no longer in the configured directory. The command
can do one of two things in this situation, depending on whether the allowInactivate input
parameter is set to true or false (see the following explanation of
the two flags).





     Parameters:


     
    name
    




     
    String. User login name.
    




     
    allowInactivate
    




     
    String. Options are true or false.
Optionally specify one of these values to allow changes to the state
of the user. If you specify true, the user is inactivated in the member
table of the application database if there is no match. The user's
email and login names are deleted from the table and the state flag
is set to inactive. If you specify false or omit the flag, the user
is not made inactive.  Instead, a log message is written to the log
file.
    

    






     For example: 


    CommunitiesMemberService.syncMemberExtIdByLogin("jdoe", {"allowInactivate":"true"})
    
 





      


     This
command has a matching "preview" command that shows you what the synchronization
command would do if you ran it. For example, the CommunitiesMemberService.previewSyncMemberExtIdByLogin() command
generates a log showing what the CommunitiesMemberService.syncMemberExtIdByLogin() command
would do if you ran it. You should run preview versions of commands
before running the actual commands. When you are sure the command
will do what you want, run the actual command.






     For more
information on CommunitiesMemberService.syncMemberExtIdByLogin() and CommunitiesMemberService.previewSyncMemberExtIdByLogin() commands,
see Synchronizing user data using administrative commands.


    


     
      


       
    1.  Start
the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly. For more information, see Starting
the wsadmin client.






       
    2.  Start the Communities Jython script interpreter
: 


      execfile("communitiesAdmin.py")
      
If
prompted to specify a service to connect to, type 1 to pick the first
node in the list. Most commands can run on any node. If the command
writes or reads information to or from a file using a local file path,
you must pick the node where the file is stored.





       
    3.  Run the CommunitiesMemberService.syncMemberExtIdByLogin() command
to synchronize each Communities administrator.


    



    Related
    

  •   Synchronize user data using administrative commands




     Access the Search configuration environment
    





     You need to initialize the Search configuration environment
to be able to run the SearchCellConfig and SearchService MBean commands.


    


     See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.





Two types of command are provided for administering the Search
application:


     
    SearchCellConfig
    




     
    An MBean used to check out, update, and check in copies of the Search configuration file, search-config.xml.
This file is used to control many aspects of Search configuration,
such as:


     
      


       
    •  The location of the Search index





       
    •  The location of the IBM LanguageWare dictionaries
used by Search





       
    •  The configuration of the file download and conversion service
used by Search when indexing file attachments


    
The SearchCellConfig MBean also provides the user with a means
of checking out and checking in the Search Ajax proxy configuration
file, proxy-search-config.xml.


     For more information
about the syntax of the SearchCellConfig commands and a description
of what each command does, see SearchCellConfig commands.

    




     
    SearchService
    




     
    An MBean used to create, retrieve, update, and delete scheduled
task definitions of the following Search operations. This includes
a facility to trigger one of these operations.


     
      


       
    •  Indexing





       
    •  Indexing optimization


    
This is implemented by scheduling a one-off task that is scheduled
to run within 30 seconds of issuing the corresponding SearchService
command.


     For more information about the syntax of the SearchService
commands and a description of what each command does, see SearchService
commands.

    

    


    


     To initialize the Search configuration environment, complete
the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      




    


     

  •  SearchCellConfig commands

  •  SearchService commands




    Add an additional Search node to a cluster
    





     You can add another Search node to a cluster where there
is an existing Search node for load-balancing purposes or if you want
to have a backup node for redundancy.


     IBM WebSphere Application Server Network Deployment
(Application Server option) must installed on the new node.

    


     To add a second Search node to a cluster, complete these
steps.


     
      


       
    1.  Add a new node to the Deployment Manager cell by doing
the following:


       
        


         
      1.  Log in to the new node.





         
      2.  Open a command prompt and change to the bin directory
of the local WebSphere Application Server profile: 


         app_server_root/profiles/profile_name/bin





         where profile_name is
the name of the applicable WebSphere Application Server profile on this node.






         
      3.  Run the addNode command to add the node to the Deployment
Manager cell: 


         addnode [dmgr_host]
[dmgr_port] [-username uid]
[-password pwd] [-localusername localuid]
[-localpassword localpwd]





         where:


         
          


           
        •  dmgr_host is the host name of the Deployment
Manager.





           
        •  dmgr_port is the SOAP port of the Deployment
Manager. The default is 8879.





           
        •  uid and pwd are the DM administrator username and password respectively.





           
        •  localuid and localpwd are
the username and password respectively for the node's WebSphere Application Server administrator.


        







         
      4.  Open the addNode.log file and confirm
that the node was successfully added to the Deployment Manager cell. The file is stored in the following location: 


         app_server_root/profiles/profile_name/log/addNode.log



      






       
    2.  Copy the relevant JDBC files from the Deployment Manager
node to the new node, placing them in the same location as the JDBC
files on the Deployment Manager. 


       For example, if you
copied the db2jcc.jar file from the C:\IBM\SQLLIB directory
on the Deployment Manager, you need to copy the same file to the C:\IBM\SQLLIBdirectory
on the new node. 
      Use the following table to determine
which files to copy.



      Table 143. JDBC files

      Database type
    JDBC files




      DB2
    


       db2jcc.jar





       db2jcc_license_cu.jar
sql




      Oracle
    


       ojdbc6.jar




      Microsoft SQL
Server
    


       sqljdbc4.jar




      








       
    3.  Ensure that the shared folders that are used for the application
content stores in the cluster are accessible from the new node. 





       
    4.  Add the node as an additional member to the cluster.


       
        


         
      1.  Log in to the Deployment Manager Integration Solutions Console.





         
      2.  Select Servers>Clusters>cluster_name>Cluster
members>New. 





         
      3.  Set the following information about the new cluster
member: 


         
        Member name
        




         
        The name of the server instance that is created for the cluster.
The Deployment Manager creates a new server instance with this name.


          Each
member name in the same cluster must be unique.

        




         
        Select node
        




         
        The node where the server instance resides.
        

        






         
      4.  Click Add Member to add this
member to the cluster member list.





         
      5.  Click Next to go to the summary
page where you can examine detailed information about the cluster
member. Click Finish to complete this step
or click Previous to modify the settings.





         
      6.  Click Save to save the configuration.





         
      7.  Select Server>Servers>Clusters>cluster_name>Cluster
members. In the member list, click the new member that
you added in the previous step.





         
      8.  On the detailed configuration page, click Ports to
expand the port information of the member. Make a note of the WC_defaulthost
and WC_defaulthost_secure port numbers. For example, the WC_defaulthost port number is typically 9084, while the WC_defaulthost_secure
port number is typically 9447.





         
      9.  Select Environment>Virtual
Hosts>default_host>Host
Aliases>New. Enter the following information for the host alias for the WC_defaulthost port:


         
        Host name
        




         
        The IP address or DNS host name of the node where the new member
resides.
        

        



         
        Port: 
        




         
        The port number for WC_defaulthost. For example, 9084.
        

        






         
      10.  Click OK to complete the virtual
host configuration, and then click Save to
save the configuration.





         
      11.  Repeat the previous two substeps to add the host alias
for the WC_defaulthost_secure port.





         
      12.  Select System administration>Nodes.





         
      13.  In the node list page, select all the nodes where the target cluster members reside, and then click Synchronize to
perform a synchronization between the nodes.


      






       
    5.   Use the WebSphere Application Server Integrated Solutions Console, stop the Search application on
the new node.





       
    6.  Stop all the previously existing nodes that are running
the Search application.





       
    7.  Copy the index directory from one of the existing nodes
to the new node.





       
    8.  Restart all the nodes that are running Search.


    

     
    What to do next
    


     
      


       
    1.  Configure IBM HTTP Server
to connect to the new node. For more information, see Configuring IBM HTTP Server and Defining IBM HTTP Server.





       
    2.  IBM AIX or Linux only:
Configure the path variables to point to the Search application. For more information, see Copying Search conversion tools to local
nodes.





       
    3.  Create Search work managers for the newly-added node. For more
information, see Creating work managers for Search.


    





     If you experience interoperability failure, you might be running
two servers on the same host with the same name. This problem can
cause the Search and News applications to fail. For more information,
go to the following web page: 
    http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp?topic=/com.ibm.websphere.base.doc/info/aes/ae/rtrb_namingprobs.html




    Related
    

  •  Back up the Search index

  •   Configure IBM HTTP Server

  •   Restore the Search index


    

  •   Copy Search conversion tools to local nodes

  •  Add a node to a cluster

  •   Define IBM HTTP Server

  •   Create work managers for Search




    Add third-party search options to the search control
    





     You can extend the search control in IBM Connections to include options from third-party
search engines by configuring settings in LotusConnections-config.xml.


     To edit configuration files, you must use the wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.




When you configure settings for additional search options
in LotusConnections-config.xml, those
options are made available to users from the Search drop-down menu,
allowing them to search content from the sources described in the configuration file. When a user selects a third-party search engine
from the Search menu and enters a query term, the results of the search
display on a third-party search results page.

    


     To add a third-party option to the IBM Connections search control, complete the following steps.


     
      


       
    1.  Use the wsadmin client to access and check out the IBM Connections configuration files.


       
        


         
      1.  Enter the following command
to access the IBM Connections configuration file: execfile("connectionsConfig.py") 


         If prompted to specify a service to connect
to, type 1 to pick the first node in the list. Most commands can run
on any node. If the command writes or reads information to or from
a file using a local file path, you must pick the node where the file
is stored. This information is not used by the wsadmin client when
you are making configuration changes.






         
      2.  Enter the following command
to check out the IBM Connections configuration files: 


         LCConfigService.checkOutConfig("working_directory","cell_name")





         where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
to separate directories in the file path, even if you are using the Microsoft Windows operating system. 


           AIX and Linux only:
The directory must grant write permissions or the command does not
run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, type the following command while in the wsadmin
command processor:print AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")





           
        •  Microsoft

          Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")


        




      






       
    2.  Navigate to the temporary working directory specified
in the previous step, and then open LotusConnections-config.xml
in a text editor.





       
    3.  Define the additional search option as a child element
of the serviceName="search" element by adding a <sloc:searchScope>
element that contains the details of the third-party service. 


       For example: 


      <sloc:serviceReference bootstrapHost="" bootstrapPort="" clusterName="cluster" enabled="true" serviceName="search" ssl_enabled="true">  
   <sloc:href>
      <sloc:hrefPathPrefix>/search</sloc:hrefPathPrefix>
      <sloc:static href="http://myserver.example.com:9081" ssl_href="https://myserver.example.com:9444"/>
      <sloc:interService href="https://myserver:9444"/>
   </sloc:href>
   <!-- Add third Party Search Options here -->
   <sloc:searchScope scopeName="Yahoo" enabled="true" isGlobal="true">
      <sloc:searchApplicationURL>
         <sloc:static href="http://search.yahoo.com/search?q=" ssl_href="http://search.yahoo.com/search?q="/>
      </sloc:searchApplicationURL>
      <sloc:searchScopeIconClass>lconnSprite lconnSprite-iconThirdParty16</sloc:searchScopeIconClass>
   </sloc:searchScope>
   <!-- Third party Search options added-->
</sloc:serviceReference>
      

      ...where: 


       
        


         
      •  <sloc:searchApplicationURL> defines the URL to the third-party
search application. When a user selects the third-party search engine
from the Search menu and enters a search term, that search query term
is appended to this URL.


         Ensure that the URL that you define will
use the search query terms that are passed to the URL. Pointing to
a base URL, such as www.yahoo.com, does not work. Refer to the external
documentation for the third-party search engine to find the correct
URL to use. For example, the correct URL for searching using the Yahoo
search engine is "http://search.yahoo.com/search?q=".






         
      •  <sloc:searchScopeIconClass> specifies the CSS class for an
icon that identifies the third-party search option in the Search drop-down
menu. The value of <sloc:searchScopeIconClass> must
always be set to lconnSprite lconnSprite-iconThirdParty16.


      
For the new search engine to display in the search control, ensure
that the enabled parameter is set to true for the <sloc:serviceReference>
and <sloc:searchScope> elements. The isGlobal parameter for the <sloc:searchScope>
element must also be set to true.





       


       
        


         
      1.  To point to a Search option that is locally available on the same
URL as the IBM Connections server,
use the <sloc:hrefPathPrefix> tag instead of the <sloc:href>
tag.


         For example:


        <sloc:searchScope scopeName="myPlaces" enabled="true" isGlobal="false">
   <sloc:searchApplicationURL>
      <sloc:hrefPathPrefix>places?scope=myPlaces&query=</sloc:hrefPathPrefix>
   </sloc:searchApplicationURL>
   <sloc:searchScopeIconClass>lconnSprite lconnSprite-iconThirdParty16</sloc:searchScopeIconClass>
</sloc:searchScope>
        





          In this case the isGlobal
parameter is set to false because the example is for a local search.




      







       
    4.  Save your changes and then close LotusConnections-config.xml.





       
    5.  After making changes, check the configuration
files back in, and you must do so during the same wsadmin session
in which you checked them out for the changes to take effect. See Applying
common configuration property changes for information about
how to apply your changes.


    


     
    Related tasks
    

  •   Apply common configuration property changes




    Back up the Search index using wsadmin commands
    





     Use SearchService administrative commands to define scheduled
backup tasks for the Search index.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.


     Backups are written to the location specified
in the IBM WebSphere Application Server environment
variable, SEARCH_INDEX_BACKUP_DIR.


    


     To back up the Search index, complete the following tasks.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands. 


       


       
      SearchService.addBackupIndexTask(String taskName, String schedule,
String startbySchedule)
      




       
      


       Defines a new scheduled index backup task.





       This command
takes the following arguments:


       
        


         
      •  taskName. The name of the task to be added.





         
      •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





         
      •  startbySchedule. The time given for the task to run before it
is automatically canceled. This argument is a string value that must
be specified in Cron format.


      
For example:


      SearchService.addBackupIndexTask("WeeklyIndexBackup","0 0 2 ? * SAT","0 10 2 ? * SAT")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      




       
      SearchService.backupIndexNow()
      




       
      


       Backs up the index to the location specified by the IBM WebSphere Application Server variable,
SEARCH_INDEX_BACKUP_DIR. There might be a delay before the backup
occurs if there are indexing tasks in progress.





       This command
does not take any arguments.





       After backing up the Search index
using wsadmin commands, consider performing a full backup of the HOMEPAGE
database. Note that the Search index has a dependency on data in the HOMEPAGE database.

      




       
      SearchService.deleteTask(String taskName)
      




       
      


       Deletes the specified backup task.





       This command takes
a single argument:


       
        


         
      •  taskName. The name of the task to be deleted.


      
For example:


      SearchService.deleteTask("NightlyBackupTask")
      


      




       
      SearchService.notifyRestore(Boolean isNewIndex)
      




       
      


       Brings the database to a consistent state so that crawlers
start from the point at which the backup was made.





       The notifyRestore
command updates index management tables in the HOMEPAGE database so
that crawling resume points are reloaded from a restored index, thereby
ensuring that all future crawls start from the correct point. The command also purges cached content in the HOMEPAGE database.





       The notifyRestore command optionally removes all entries from the HOMEPAGE
database table that tracks the status of individual files as part
of the content extraction process. This table is used by the Search
application when indexing the content of file attachments.





       This
command takes a single parameter: 


       
        


         
      •  isNewIndex: If set to true, all entries are removed from the database
table that is used by the file content extraction process to track
the status of individual files.


         Set this parameter to true when
you are restoring a newly-built index. Set the parameter to false
when you are restoring an index backup.



      
For example:


      SearchService.notifyRestore("true")
      


      

      




    



    Related
    

  •   Restore the Search index


    

  •  Back up the Search index manually

  •   Restore a Search index in a single-node environment

  •   Restore a Search index without restarting individual nodes

  •   Restore a Search index in an environment with multiple nodes


     

  •  SearchService commands




     Configure index backup settings
    





     Use SearchCellConfig commands to define index backup settings
in the search-config.xml file.


     


     When using administrative commands, you
must use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





When backing up the search index, you can specify the type
of backup to create by configuring the backupType setting
in the search-config.xml file. You can also specify
whether to run a shell script or third-party application on completion
of the backup task by editing the postBackupExecutable setting. These
settings are applied to all backup tasks.

    


     To configure index backup settings, complete the following steps:


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  To configure index backup settings, use the following commands: 


       


       
      SearchCellConfig.setBackupType(String type)
      




       
      


       Specifies the type of backup to create.





       This
command takes a single argument that specifies the backup type. This can be one of the following:


       
        


         
      •  new. Creates a new index backup every time.





         
      •  dual. Creates dual copies and overwrites the oldest existing backup.





         
      •  overwrite. Overwrites the existing index backup.


      
For example:


      SearchCellConfig.setBackupType("new")
      


      




       
      SearchCellConfig.setPostBackupScript(String script)
      




       
      


       Specifies which shell script or third-party application runs
on completion of the backup task.





       This command takes a single
argument that specifies the name of the shell script or application
file.





       For example:


      SearchCellConfig.setPostBackupScript("backup.sh")
      






       To disable the script, run the command again with an empty string as
the argument. For example: 


      SearchCellConfig.setPostBackupScript("")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    


     
    Related tasks
    

  •  Reloading the Search application


     

  •  SearchCellConfig commands




     Enable dictionaries
    





     Use administrative commands to enable the dictionaries
to use with Search.


     


     When using administrative commands, you
must use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.


      Enabling additional dictionaries adds
a performance cost at indexing time and will increase the size of
the index. Additional dictionaries should only be enabled as needed.






The Search application provides globalization support by
using different dictionary files for different languages. Each dictionary
file must be enabled in the Search configuration file before indexing.
The dictionaries that are enabled in the Search configuration file
are loaded into memory at server start time when the Search application
is started.

    


     To enable dictionaries for use with Search, complete
the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  To add a specified dictionary to the list of configured
dictionaries, use the following command: 


       


       
      SearchCellConfig.enableDictionary(String languageCode, String
dictionaryPath)
      




       
      


       Enables support for the specified LanguageWare dictionary.





       This
command accepts two arguments.


       
        


         
      •  languageCode. The language code for the dictionary
to add. This argument is a string value.


         The language
code typically comprises two letters conforming to the ISO standard
639-1:2002 that identifies the primary language of the dictionary.
However, there are some codes that additionally define a country or
variant, in which case these constituent parts are separated by an
underscore. For example, Portuguese has two variants, one for Portugal
(pt_PT) and one for Brazil (pt_BR).


          When using a code that also
specifies a country, ensure that you use an underscore to separate
the language code and the country code rather than a hyphen; otherwise
an error will be generated.







         
      •  dictionaryPath. The path to the directory containing the dictionary
file. This argument is a string value.


      
For example:


      SearchCellConfig.enableDictionary("fr","/opt/IBM/Connections/data/shared/search/dictionary")
      
You
can also specify the path using a WebSphere environment
variable. In the following example, the "${SEARCH_DICTIONARY_DIR}"
value is used to point to the shared Search dictionary directory.


      SearchCellConfig.enableDictionary("fr","${SEARCH_DICTIONARY_DIR}")
      
Or,
if you are using a shared-file system on Microsoft Windows,
you can specify the file path to a network share directory using the Universal Naming Convention (UNC) format: 


      SearchCellConfig.enableDictionary("fr","\\enterprise.server\Connections\data\shared\search\dictionary")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    


     
    Related tasks
    

  •   Enable users to set a language preference

  •  Reloading the Search application

  •  Listing enabled dictionaries

  •  Set the default dictionary

  •   Disable dictionaries


     

  •  SearchCellConfig commands

  •  Search language dictionaries




    Add scheduled tasks for Search
    





     Use SearchService administrative commands to add scheduled
task definitions for the Search application to the Home page database.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.







     The SearchService commands are used to access a service
that provides an administrative interface for adding scheduled indexing
task definitions to the Home page database. The following applications
can be indexed: Activities, Blogs, Bookmarks, Communities, Files,
Forums, Profiles, and Wikis. You can also index status updates and
community calendar events.





     When defining a scheduled task in
the Home page database, you need to specify when the scheduler starts
the task. The schedule is defined using a Cron schedule. For more
information about the scheduler, see Scheduling tasks.





     It is not possible to specify an end time for an indexing task. All tasks
run as long as they need to. The startby interval defines the time
period by which a task can fire before it is automatically canceled.
This mechanism ensures that tasks do not queue up for an overly long
period before being canceled, and allows for tasks that run for longer
than the default indexing schedule, such as initial index creation.


    


     To define a scheduled task for the Search application,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands to add scheduled task definitions
in the Home page database. 


       


       
      SearchService.addBackupIndexTask(String taskName, String schedule,
String startbySchedule)
      




       
      


       Defines a new scheduled index backup task.





       This command
takes the following arguments:


       
        


         
      •  taskName. The name of the task to be added.





         
      •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





         
      •  startbySchedule. The time given for the task to run before it
is automatically canceled. This argument is a string value that must
be specified in Cron format.


      
For example:


      SearchService.addBackupIndexTask("WeeklyIndexBackup","0 0 2 ? * SAT","0 10 2 ? * SAT")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      




       
      SearchService.addFileContentTask(String taskName, String schedule,
String startBy, String applicationNames, failuresOnly)
      




       
      


       Creates a scheduled file content retrieval task.





       This
command takes the following arguments:


       
        


         
      •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





         
      •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format. For more
information about the Cron schedule, see Scheduling tasks.





         
      •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format. For more information about the Cron schedule, see Scheduling
tasks.





         
      •  applicationNames. The name (or names) of the IBM Connections application to be indexed when
the task is triggered. This argument is a string value. To index multiple
applications, use a comma-delimited list. The following values are
valid:


         
          


           
        •  files





           
        •  wikis


        






         
      •  failuresOnly. A flag that indicates that only the content of files
for which the download and conversion tasks failed should be retrieved.
This argument is a boolean value.


      






       For example:


      SearchService.addFileContentTask("mine", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI", "wikis,files","true")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.





       You can also use the SearchService.addFileContentTask
command to replace the task definition for the default 20min-file-retrieval-task.
By default, this task runs every 20 minutes, except for a one-hour
period between 01:00 and 02:00. To replace the default task settings,
first remove the existing task using the SearchService.deleteTask(String
taskName) command. Then use the SearchService.addFileContentTask to
create a new task with the values that you specify.





       For example: 


      SearchService.deleteTask("20min-file-retrieval-task")
SearchService.addFileContentTask("20min-file-retrieval-task", "0 1/20 0,2-23 * * ?", "0 10/20 0,2-23 * * ?", "all_configured", "false")
      


      




       
      SearchService.addIndexingTask(String taskName, String schedule,
String startBy, String applicationNames, Boolean optimizeFlag)
      




       
      


       Creates a new scheduled indexing task definition in the Home
page database.





       This command takes the following arguments:


       
        


         
      •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





         
      •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





         
      •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format. 


         This parameter should be used to ensure that indexing
tasks are not queued up and running into server busy times. Under
normal conditions, the only factors that might cause a task to be
delayed are that overlapping or coincident tasks are trying to fire
at the same time, or an earlier task is running for a long time.






         
      •  applicationNames. The name (or names) of the IBM Connections application to be indexed when
the task is triggered. This argument is a string value. To index multiple
applications, use a comma-delimited list. The following values are
valid: activities, blogs, calendar, communities, dogear, files, forums,
profiles, status_updates, and wikis.





         
      •  optimizeFlag. A flag that indicates if an optimization step should
be performed after indexing. This argument is a boolean value.
         The optimization operation is both CPU and I/O
intensive. For this reason, the operation should be performed infrequently
and, if possible, during off-peak hours. For more information, refer
to the following web page: 
        http://lucene.apache.org/core/old_versioned_docs/versions/3_0_3/api/all/org/apache/lucene/index/IndexWriter.html#optimize%28%29


         Note
that when you install IBM Connections,
a search optimization task is set up to run every night by default.
See Search default tasks for more information.




      
All arguments are required.





       For example:


      SearchService.addIndexingTask("customDogearAndBlogs", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI", "dogear,blogs","true")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console. 


        The refreshTasks() command should be used after this
command for the new task definitions to take effect immediately. Otherwise,
the changes take place when the Search application is next restarted.






       You can also use the SearchService.addIndexingTask command to replace
the 15min-search-indexing-task that is automatically configured when
you install IBM Connections.
By default, all installed IBM Connections applications are crawled and indexed every 15 minutes, except for
a one-hour period between 01:00 and 02:00. To replace the default
indexing task settings, first remove the existing indexing task using
the SearchService.deleteTask(String taskName) command. Then, use the SearchService.addIndexingTask command to create a new indexing task
with the values that you specify.





       For example: 


      SearchService.deleteTask("15min-search-indexing-task")
SearchService.addIndexingTask("15min-search-indexing-task", "0 1/15 0,2-23 * * ?", "0 10/15 0,2-23 * * ?", "all_configured", "false")
      


      




       
      SearchService.addOptimizeTask(String taskName, String schedule,
String startBy)
      




       
      


       Creates a new index optimization scheduled task definition.





       This
command takes the following arguments:


       
        


         
      •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





         
      •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





         
      •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format.


         This parameter should be used to ensure that indexing
tasks are not queued up and running into server busy times. Under
normal conditions, the only factors that might cause a task to be
delayed are that overlapping or coincident tasks are trying to fire
at the same time, or an earlier task is running for a long time.



      
All arguments are required.


        The optimization operation is both CPU and I/O
intensive. For this reason, the operation should be performed infrequently
and, if possible, during off-peak hours. For more information, refer
to the following web page: 
      http://lucene.apache.org/core/old_versioned_docs/versions/3_0_3/api/all/org/apache/lucene/index/IndexWriter.html#optimize%28%29


       Note
that when you install IBM Connections,
a search optimization task is set up to run every night by default.
See Search default tasks for more information.







       For example:


      SearchService.addOptimizeTask("customOptimize", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console. 


        The refreshTasks() command should be used after this
command for the new task definitions to take effect immediately. Otherwise,
the changes take place when the Search application is next restarted.






       You can also use the SearchService.addOptimizeTask command to replace
the nightly-optimize-task that is automatically configured when you
install IBM Connections. By
default, this task runs nightly at 01:30. To replace the default optimize
task settings, first remove the existing optimize task using the SearchService.deleteTask
command. Then, use the SearchService.addOptimizeTask command to create
a new optimize task with the values that you specify.





       For example: 


      SearchService.deleteTask("nightly-optimize-task")
SearchService.addOptimizeTask("nightly-optimize-task", "0 30 1 * * ?", "0 35 1 * * ?")
      


      




       
      SearchService.addSandTask(String taskName, String schedule, String
startBy, String jobs)
      




       
      


       Creates a new scheduled task definition for the social analytics
service in the Home page database.





       This command takes the following arguments:


       
        


         
      •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





         
      •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





         
      •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format. 


         This parameter should be used to ensure that scheduled
tasks are not queued up and running into server busy times. Under
normal conditions, the only factors that might cause a task to be
delayed are that overlapping or coincident tasks are trying to fire
at the same time, or an earlier task is running for a long time.






         
      •  jobs. The name, or names, of the jobs to be run when the task
is triggered. This argument is a string value. To index multiple jobs,
use a comma-delimited list. The following values are valid: evidence,
graph, manageremployees, tags, taggedby, and communitymembership.


      
All the arguments are required.





       For example:


      SearchService.addSandTask("customSaNDIndexTask", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI", "evidence,graph,manageremployees,tags,taggedby,communitymembership")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.





       You can also use the SearchService.addSandTask command
to replace the nightly-sand-task that is automatically configured
when you install IBM Connections.
By default, the task runs nightly at 01:00. To replace the default
SAND task settings, first remove the existing task using the SearchService.deleteTask(String
taskName) command. Then use the SearchService.addSandTask command
to create a new SAND task with the values that you specify.





       For example: 


      SearchService.deleteTask("nightly-sand-task")
SearchService.addSandTask("nightly-sand-task", "0 0 1 * * ?", "0 5 1 * * ?", "evidence,graph,manageremployees,tags,taggedby,communitymembership")
      


      

      







       
    4.  To refresh the Home page database to include the newly-added
tasks, use the following command: 


       SearchService.refreshTasks()



    



    Related
    

  •   Schedule tasks


    

  •  Add scheduled tasks for the social analytics service


     

  •  SearchService commands

  •  Search default scheduled tasks




     Configure page persistence settings
    





     Edit settings to specify whether the persisted pages in
a seedlist persistence directory are deleted after a successful incremental
index. You can also update the maximum age for persisted pages.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





By default, the pages saved in a seedlist persistence directory
are deleted after a successful incremental index. To speed up the indexing process when you have a large data set, you can also configure
seedlist persistence settings so that pages over a specified age are
not included when building an index or resuming a crawl.

    


     To configure page persistence settings, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  Use the following commands: 


       


       
      SearchCellConfig.setDeletePersistedPages(String enabled)
      




       
      


       Specifies whether to delete the persisted pages after a successful
incremental index. By default, the value is set to true.





       This
command takes a single argument:


       
      enabled
      




       
      A string that determines whether persisted pages are to be deleted
after a successful incremental index. This string represents a boolean,
that is, it should be set to true or false.
      

      






       When this functionality is enabled, persisted
pages from the initial index creation are also deleted after a successful
incremental index.





       For example:


      SearchCellConfig.setDeletePersistedPages("false")
      


      




       
      SearchCellConfig.setMaxPagePersistenceAge(String maxAgeInHours)
      




       
      


       Specifies the maximum age for persisted pages in a seedlist
persistence directory. By default, the value is set to 720 hours (30
days).





       If the pages are older than the maximum age, they are
ignored when building an index or resuming a crawl.





       This command
takes a single argument: 


       
      maxAgeInHours
      




       
      A string representing an integer that specifies the maximum age
in hours of the persisted pages.
      

      






       For example: 


      SearchCellConfig.setMaxPagePersistenceAge("42")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    



    Related
    

  •  The indexing process


    

  •   Delete persisted seedlist data

  •   Create a background index




    Add scheduled tasks for the social analytics service
    





     Use SearchService administrative commands to schedule social
analytics tasks in the Home page database. A nightly task is scheduled
to run after the optimize task by default. Every time the social analytics
scheduled task runs, the index for the social analytics service is
recreated.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.





    The social analytics indexing process includes
the following five jobs. You can schedule these jobs individually
or in a batch.


     
    evidence
    




     
    Builds the evidence index, which links people to results and maps
user connections.
    




     
    graph
    




     
    Builds the graph of connections between users.
    




     
    manageremployees
    




     
    Provides details of manager relationships so that people's
relationships through their management can be identified. For example,
when two people share a second line manager.
    




     
    tags
    




     
    Generates index documents for each used tag and stores the list
of users that have used that tag.
    




     
    taggedby
    




     
    Creates relationships between the users who have tagged each other's
profiles.
    




     
    communitymembership
    




     
    Creates relationships between the users who are members of the same community.


      Communities that have more than 100 members are
skipped. These communities will not be recommended to users.

    

    






     When defining a social analytics scheduled task
in the Home page database, you need to specify when the scheduler
starts the task. The schedule is defined using a Cron schedule. For more information about the scheduler, see Scheduling tasks.





     It is not possible to specify an end time for a scheduled task. All tasks
run as long as they need to. The startby interval defines the time
period by which a task can fire before it is automatically canceled.
This mechanism ensures that tasks do not queue up for an overly long
period before being canceled, and allows for tasks than run for longer
than the default indexing schedule, such as initial index creation.


    


     To define a social analytics scheduled task, complete
the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following command: 


       


       
      SearchService.addSandTask(String taskName, String schedule, String
startBy, String jobs)
      




       
      


       Creates a new scheduled task definition for the social analytics
service in the Home page database.





       This command takes the following arguments:


       
        


         
      •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





         
      •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format.





         
      •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format. 


         This parameter should be used to ensure that scheduled
tasks are not queued up and running into server busy times. Under
normal conditions, the only factors that might cause a task to be
delayed are that overlapping or coincident tasks are trying to fire
at the same time, or an earlier task is running for a long time.






         
      •  jobs. The name, or names, of the jobs to be run when the task
is triggered. This argument is a string value. To index multiple jobs,
use a comma-delimited list. The following values are valid: evidence,
graph, manageremployees, tags, taggedby, and communitymembership.


      
All the arguments are required.





       For example:


      SearchService.addSandTask("customSaNDIndexTask", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI", "evidence,graph,manageremployees,tags,taggedby,communitymembership")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.





       You can also use the SearchService.addSandTask command
to replace the nightly-sand-task that is automatically configured
when you install IBM Connections.
By default, the task runs nightly at 01:00. To replace the default
SAND task settings, first remove the existing task using the SearchService.deleteTask(String
taskName) command. Then use the SearchService.addSandTask command
to create a new SAND task with the values that you specify.





       For example: 


      SearchService.deleteTask("nightly-sand-task")
SearchService.addSandTask("nightly-sand-task", "0 0 1 * * ?", "0 5 1 * * ?", "evidence,graph,manageremployees,tags,taggedby,communitymembership")
      


      

      







       
    4.  To refresh the Home page database to include the newly-added
tasks, use the following command: 


       SearchService.refreshTasks()



    



    Related
    

  •   Schedule tasks

  •   Configure scheduled tasks


    

  •  Tuning social analytics indexing

  •  Add scheduled tasks for Search

  •  Listing social analytic indexing tasks


     

  •  SearchService commands

  •  Search default scheduled tasks




     Configure global properties for the social analytics service
    





     Use SearchService commands to list, add, update, or delete
global properties for the social analytics service.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.




You can have greater control over the social analytics service
by configuring dynamic, global properties that affect the social analytics
API or indexing behavior. For example, you might want to configure
the property that defines the frequency threshold of tags so that
you can tune out popular tags from the recommendations provided to
users.

    


     To configure global properties for the social analytics
service.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands to configure social analytics
properties: 


       


       
      SearchService.listGlobalSandProperties()
      




       
      


       Lists all global properties for the social analytics service.





       The properties are returned as a mapping of keys to values. For example,
the following output indicates that the value of the sand.tag.freq.threshold
property is 32000.


      {sand.tag.freq.threshold=32000}
      


      




       
      SearchService.setGlobalSandIntegerProperty(String propertyName,
String integerProperyValue)
      




       
      


       Adds or updates a dynamic global social analytics property
that affects the social analytics API or indexing behavior. The changes
take place when the next social analytics indexing job starts.





       When the property is successfully added or updated, 1
is printed to the wsadmin console. If the property is not successfully
added or updated, then you will see 0 printed to the wsadmin console.
If this happens, contact the Search Cluster Administration and check
the SystemOut.log file for more details.





       Currently,
support is provided only for the sand.tag.freq.threshold social
analytics property. This property takes an integer value.





       The property is used by the Recommend API algorithm as follows: 


       
        


         
      1.  Get the people and tags to which the user is related.


         
          


           
        •  If the tag has a frequency in the Search index that is greater
than or equal to the value specified for the sand.tag.freq.threshold
property, discard it. This action prevents users from getting recommendations
based on common tags, that is, tags that have a high frequency.


        






         
      2.  Get the documents with which the people and tags gathered in the first query are associated.





         
      3.  Return the results to the user.


      
For example: 


      SearchService.setGlobalSandIntegerProperty("sand.tag.freq.threshold",100)
      






       


       Notes: 


       
        


         
      •  This setting is global and will affect all IBM Connections users. The setting should only
be changed by an administrator.





         
      •  You can consult the SystemOut.log file when
social analytics indexing begins to check the frequency distribution
of the top 100 tags in the system. 


         For example, in line 1 of the following extract, you can see that the tag brown has ordinal 1718
in the index (an ordinal is a facet identifier) and that it has a
frequency of 1, which means that there is only one instance of a document
being tagged with the keyword brown in the index.


        [5/30/11 15:41:13:544 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1718:brown:1} 
[5/30/11 15:41:13:548 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1730:summaries:1} 
[5/30/11 15:41:13:551 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1737:public_holiday:1} 
[5/30/11 15:41:13:554 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1721:chronicle:1} 
[5/30/11 15:41:13:558 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1716:hollis:1} 
[5/30/11 15:41:13:561 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1700:inquirer:1} 
[5/30/11 15:41:13:565 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1684:gazette:5} 
[5/30/11 15:41:13:568 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum {1679:ibm:7} 
[5/30/11 15:41:13:572 IST] 00000025 CommonTagsCac I com.ibm.lotus.connections.sand.tags.impl.CommonTagsCache buildCacheUsingTermEnum Cache:{1679=7, 1684=5, 1700=1, 1716=1, 1718=1, 1721=1, 1730=1, 1737=1} 
[5/30/11 15:41:13:633 IST] 00000025 IndexBuilderQ I com.ibm.lotus.connections.search.admin.index.impl.IndexBuilderQueue startSaNDIndexingService CLFRW0483I: SAND indexing has started.
        




      



      




       
      SearchService.deleteGlobalSandProperty(String propertyName)
      




       
      


       Deletes the specified global social analytics property.





       For example: 


      SearchService.deleteGlobalSandProperty("sand.tag.freq.threshold")
      






       When the property is successfully added or updated, 1
is printed to the wsadmin console. If the property is not successfully
added or updated, then you will see 0 printed to the wsadmin console.
If this happens, contact the Search Cluster Administration and check
the SystemOut.log file for more details.

      

      




    


     

  •  SearchService commands




     Configure file attachment indexing settings
    





     Edit settings in the search-config.xml file
to configure Search for file attachments.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





Search provides a dedicated document conversion service.
When a file indexing task is run, the document conversion service
downloads files, converts them to plain text, and then indexes the content. During this process, content from different MIME types is
indexed. For a list of the MIME types supported by Search, see Supported
MIME types.


     The behavior of the document conversion service
can be altered by modifying various settings, allowing administrators
to control the file content indexing process.





     IBM Connections supports the indexing of file
attachment content from the Files and Wikis applications. Content
from file attachments in Activities, Blogs, and Forums is not searched.

     When file indexing is enabled, the content of files
is not indexed the first time that the index is run. The first index
starts the process of retrieving the file content, but the actual
indexing of the content only takes place when the index is run for
the second time.


    


     To configure file attachment indexing settings, complete
the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  Use the following commands to control the file content
indexing process. 


       


       
      SearchCellConfig.enableAttachmentHandling()
      




       
      


       Enables the indexing of file attachments in the Files and Wikis
applications.





        If you already disabled the attachment handling
of files during the last indexing, you need to rebuild the index again
after enabling attachment handling. Otherwise, this command won't
take effect.





       This command does not take any input parameters.

      




       
      SearchCellConfig.disableAttachmentHandling()
      




       
      


       Disables the indexing of file attachments in the Files and
Wikis applications.





       This command does not take any input parameters.

      




       
      SearchCellConfig.setMaximumAttachmentSize(int maxAttachmentSize)
      




       
      


       Sets the limit on the size of files that can be downloaded
for indexing. Files that are greater than the configured maximum attachment
size are not downloaded or processed for content indexing. By default,
the limit is set to 50 MB, which means that files over 50 MB are not
indexed.





       Files that are under the specified size are downloaded
to a temporary directory located in the index directory, where they
go through the text extraction process. The extracted text is then
indexed. The temporary directory size available must be greater than
the maximum file size allowed for content indexing. You can control
the amount of extracted text that is indexed using the setCacheFileSize command.





       This
command accepts one argument:


       
        


         
      •  maxAttachmentSize. The maximum file size in bytes of any file
attachment eligible for indexing. This is an integer value.


      
For example:


      SearchCellConfig.setMaximumAttachmentSize("52428800")
      


      




       
      SearchCellConfig.setCacheExpiryTime(int numberOfDays)
      




       
      


       Sets the number of days for which a downloaded file's
indexable content is cached in the database. This information is cached
for potential reuse at indexing time. If a file is not reused in the number of days specified, its entry in the database cache is deleted.
If the file content has changed, the file is downloaded again and
the cache is updated with the revised content.





       This command
allows you to ensure that the database cache used for indexing files
is kept up-to-date.





       The expiry time is measured in days. Specify
a positive integer greater than zero.





       For example:


      SearchCellConfig.setCacheExpiryTime("30")
      


      




       
      SearchCellConfig.setCacheFileSize(int cacheFileSize)
      




       
      


       Specifies the maximum amount of extracted text that can be
indexed per file. Before a file is indexed, it is converted to plain
text.  This command allows you to specify how much of that plain text
conversion should be indexed.





       The cache file size is set to
200 KB by default, which is a very large amount of plain text.

        The cache file size limit is applied to the amount
of extracted text rather than the size of the original file. If you
have a large presentation file, for example, the default setting should
be sufficient to allow for all of the text in that file to be extracted
for indexing. The limit refers to the size of the plain text, not
the size of the original file.






       This command accepts one
argument:


       
        


         
      •  cacheFileSize. The number of bytes of indexable and searchable
file content stored in the database cache. Use a positive integer
greater than zero.


      






       For example:


      SearchCellConfig.setCacheFileSize("200000")
      


      




       
      SearchCellConfig.setMaxCacheEntries(int maxCacheEntries)
      




       
      


       Sets the maximum number of cached file entries allowed in the database cache.





       This command takes a single argument:


       
        


         
      •  maxCacheEntries. The number of cached file entries. This argument
must be an integer greater than zero.


      
For example:


      SearchCellConfig.setMaxCacheEntries("1000")
      


      




       
      SearchCellConfig.setMaximumConcurrentDownloads(int maxConcurrentDownloads)
      




       
      


       Sets the maximum number of threads that perform file downloading
on a Search server.





       This command takes a single argument that
specifies the maximum number of threads. The argument must be an integer
greater than zero. The default value is 3. The value of the maxConcurrentDownloads
argument must not exceed the maximum number of threads set for the DefaultWorkManager Work Manager resources at the Search server scope.
      CAUTION:
      Increasing this value increases the load on the Files
server.






       For example:


      SearchCellConfig.setMaximumConcurrentDownloads("10")
      


      




       
      SearchCellConfig.setMaximumTempDirSize(int maxTempDirSize)
      




       
      


       Sets the maximum size of a temporary directory used by a Search
server for the files conversion process.





       This command takes
a single argument that specifies the maximum size in bytes. The argument
must be an integer greater than zero. The default value is 100 MB.





       Files
are downloaded to a temporary directory, which is located in the index
directory. The temporary directory size available must be greater
than the maximum file size allowed for content indexing.





       For example:


      SearchCellConfig.setMaximumTempDirSize("51200")
      


      




       
      SearchCellConfig.setDownloadThrottle(long downloadThrottle)
      




       
      


       Sets the duration of a rest period between successive files
downloads in a single file-download thread.





       This command takes
a single argument that specifies the download throttle size in milliseconds.
The download throttle is set to 500 by default.
      CAUTION:
      Increasing
this value increases the load on the Files server.






       For example:


      SearchCellConfig.setDownloadThrottle("500")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    


     
    Related tasks
    

  •  Reloading the Search application

  •   Delete outdated file content


     

  •  SearchCellConfig commands




    Avoiding unnecessary full search crawls
    





     Use an administrative command to avoid performance hits
by avoiding unnecessary full search crawls.







     IBM Connections keeps records of deleted files. The seedlistSets.maximumIncrementalQuerySpanInDays
property in the LotusConnections-config.xml configuration
file specifies the number of days for which these records are saved
before they are deleted. The records can be deleted by the SearchClearDeletionHistory
task after the number of days specified by the property.





     You can avoid performance hits by making sure that deletion
records are kept long enough to be read by the incremental search
crawler. The incremental search crawler needs these deletion records
to update the Search index. If the records are deleted before the incremental crawler reads them, updates will be incomplete. When the updates are incomplete, IBM Connections performs a full crawl instead of an incremental crawl. Full crawls
delete the existing Search index and create a new one, which is more
time consuming than incremental crawls. To avoid frequent full crawls,
make sure that the value of the seedlistSets.maximumIncrementalQuerySpanInDays
property is higher than the span of days between incremental crawls.
For example, if incremental crawls happen every four days, ensure
that the property value is higher than 4. This ensures that incremental
crawls capture all deletion records.


    


     To avoid unnecessary full-search crawls, complete the following steps.


     
      


       
    1.  Use the wsadmin client to access and check out the IBM Connections configuration files:


       
        


         
      1.  Enter the following command
to access the IBM Connections configuration file: execfile("connectionsConfig.py") 


         If prompted to specify a service to connect
to, type 1 to pick the first node in the list. Most commands can run
on any node. If the command writes or reads information to or from
a file using a local file path, you must pick the node where the file
is stored. This information is not used by the wsadmin client when
you are making configuration changes.






         
      2.  Enter the following command
to check out the IBM Connections configuration files: 


         LCConfigService.checkOutConfig("working_directory","cell_name")





         where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
to separate directories in the file path, even if you are using the Microsoft Windows operating system. 


           AIX and Linux only:
The directory must grant write permissions or the command does not
run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, type the following command while in the wsadmin
command processor:print AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")





           
        •  Microsoft

          Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")


        




      






       
    2.  Optional: If you want to find out the current value of a property, you
can list the current configuration settings and values : LCConfigService.showConfig()





       
    3.  Enter the following command: 


      LCConfigService.updateConfig("seedlistSets.maximumIncrementalQuerySpanInDays",number_days)
      
Where number_days is
a number greater than or equal to 1.


    

     
    What to do next
    


     Check
the configuration files back in during the same wsadmin session in
which you checked them out. For more information, see the Applying
common configuration property changes topic.



     
    Related tasks
    

  •   Apply common configuration property changes




    Recreating the Search index
    





     If your Search index is corrupt and cannot be used, you
can recreate it by first deleting any existing indexes, and then either
waiting for the next scheduled indexing task to run or running a one-off
indexing task.


     

      When you follow the steps described
in the following procedure, Search functionality is not available
to your users. If you want to recreate the index without the need
for Search downtime, follow the steps described in the Creating
a background index topic instead.








     During
the indexing update process, documents are first written to a cache
table in the HOMEPAGE database and then written to each index across
the nodes. When a new index needs to be built, the database cache
is skipped, and the crawling and indexing process writes directly
to the index directory on the node that is performing the indexing
task.


    


     
      


       
    1.  Stop all the nodes that are running the Search application. If there are existing search indexes on these nodes, delete them by performing
the steps described in Deleting the index.





       
    2.  Start all the Search nodes in the cluster.





       
    3.  Recreate the index by completing one of the following steps: 

        


         
      •  Create a one-off task that indexes all the installed IBM Connections applications in
your deployment. For more information, see Running one-off tasks.





         
      •  Wait for the next scheduled indexing task to run.


      
 


       You can tell that the index is built on the indexing node
when the INDEX.READY and CRAWLING_VERSION files are present in the index directory. The Search index directory is defined by the IBM WebSphere Application Server variable SEARCH_INDEX_DIR.





       After
the index is built, the next phase is index roll-out. During this
phase, the files in the index directory are automatically copied to
the Search staging folder, which is defined by the WebSphere Application Server variable SEARCH_INDEX_SHARED_COPY_LOCATION.
The files in the Search staging folder are then copied to each index
folder on the remaining nodes. 

        Do not stop
your deployment until the index has been copied to all nodes. If the server is stopped during this process, the index will not be successfully
rolled out to all nodes. In this event, you need to manually copy
the index from the staging location to the other nodes.




    



    Related
    

  •   Configure dictionaries for Search

  •  The indexing process


    

  •   Run one-off tasks

  •   Delete the index

  •   Create the initial Search index

  •   Create a background index

  •   Delete outdated file content




     Create a background index
    





     Use the SearchService.startBackgroundIndex command to create
a background index. Using this command helps you to remove inconsistencies
from your Search index without the need for downtime while the index
is rebuilt.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.




The SearchService.startBackgroundIndex command allows you
to create a background index in a specified location. When you use
this command, the Search application performs a full crawl of the specified applications and then builds the index at the chosen location.
If an index already exists at the location, the crawl resumes from
the resume point stored in the Search index at that location.


     A
file called INDEX.READY is created in the specified location when
the background index is complete.


    


     To create a background index, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following command: 


       


       
      SearchService.startBackgroundIndex(String persistenceLocation,
String extractedFileContentLocation, String indexLocation, String
components)
      




       
      


       Creates a stand-alone index in a specified location.





       This
command crawls the seedlists for the specified applications, saves
the seedlists to the specified persistence location, extracts the file content, and then builds a Search index for the applications
at the specified index location.





       This command takes the following arguments:


       
      persistenceLocation
      




       
      A string value that specifies the location where you want to save
the application seedlists.
      




       
      extractedFileContentLocation
      




       
      The file content extraction location. Use the same location that
you specified when you previously extracted the file content using
the SearchService.startBackgroundFileContentExtraction command or
the SearchService.startBackgroundIndex command. Otherwise, specify
an empty directory as the location for storing the extracted file
content.
      




       
      indexLocation
      




       
      A string value that specifies the location where you want to create
the background index.
      




       
      components
      




       
      A string value that specifies the names of the applications that
you want to include in the index crawl. The following values are valid:
activities, all_configured, blogs, calendar, communities, dogear,
files, forums, profiles, status_updates, and wikis. Use all_configured
when you want to index all the applications.


       To queue up multiple
applications for indexing, run a single instance of the SearchService.startBackgroundIndex
command with the names of the applications to index
listed with a comma separator between them. If you run multiple instances
of the command with a single application specified as a parameter,
a lock is established when you run the first command so that only
the first application specified is indexed successfully.

      

      






       For example:


      SearchService.startBackgroundIndex("/opt/IBM/Connections/data/local/search/backgroundCrawl", "/opt/IBM/Connections/data/local/search/backgroundExtracted", "/opt/IBM/LotusConnections1/data/search/background/backgroundIndex", "activities, blogs, calendar, communities, dogear, files, forums, profiles, wikis, status_updates")
      



      SearchService.startBackgroundIndex("/opt/IBM/Connections/data/local/search/backgroundCrawl", "/opt/IBM/Connections/data/local/search/backgroundExtracted", "/opt/IBM/LotusConnections1/data/search/background/backgroundIndex", "all_configured")
      


      

      




    

     
    What to do next
    


     
      


       
    •  To start using the new index, complete the steps for restoring
an index as described in Restoring the Search index.
The steps required to perform vary depending on your deployment
type.





       
    •  Copy the extracted file content to the directory specified by
the WebSphere Application Server environmental variable EXTRACTED_FILE_STORE so that the files
do not have to be converted again unnecessarily during indexing. For more information about the EXTRACTED_FILE_STORE variable, see WebSphere Application Server
environment variables.


    




    Related
    

  •   Restore the Search index


    

  •   Configure page persistence settings

  •   Delete persisted seedlist data

  •   Delete the index

  •   Create the initial Search index

  •  Recreating the Search index

  •  Performing a background crawl

  •  Extracting file content


     

  •  SearchService commands

  •  WebSphere Application Server environment variables




     Create work managers for Search
    





     When you add a new node to your deployment after installing IBM Connections, you need to manually
create Search work managers for the newly-added node.




When you install IBM Connections,
the following work managers are automatically created for Search on
each node in your deployment:


     
    SearchCrawlingWorkManager
    




     
    Handles the work involved in crawling the seedlists to persist
them to disk.
    




     
    SearchDCSWorkManager
    




     
    Handles the work for the file content retrieval and conversion
task.
    




     
    SearchIndexingWorkManager
    




     
    Handles the work involved in processing the entries in persisted
seedlists into Lucene documents.
    

    





     If you subsequently add a new node, you need to
create these work managers manually. For more information about creating
work managers, see the following web page: 
    http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.express.doc/info/exp/asyncbns/tasks/tasb_workmanager.html


    


     To create work managers for Search, complete the following steps.


     
      


       
    1.  Open the IBM WebSphere Integrated Solutions Console on the node where you want to create the work managers.





       
    2.  Select Resources > Asynchronous beans > Work managers.





       
    3.  Select the node where you want to create the work managers
from the All scopes list and then click New.





       
    4.  Enter one of the following display names in the Name field: 



      Table 144. JNDI Names

      Work manager
    Name




      SearchIndexingWorkManager
    SearchIndexingWorkManager



      SearchCrawlingWorkManager
    SearchCrawlingWorkManager



      SearchDCSWorkManager
    SearchDCSWorkManager



      







       
    5.  Enter one of the following values in the JNDI
Name field: 



      Table 145. JNDI Names

      Work manager
    JNDI Name




      SearchIndexingWorkManager
    wm/search-indexing



      SearchCrawlingWorkManager
    wm/search-crawling



      SearchDCSWorkManager
    wm/search-dcs



      







       
    6.  Select all the options under Service names.





       
    7.  Set the following values under Thread pool
properties: 



      Table 146. Thread pool property
settings

      Thread pool property
    Value




      Number of alarm threads
    5



      Minimum number of threads
    1



      Maximum number of threads
    10



      Thread Priority
    5



      







       
    8.  Deselect the Growable check box
and then click OK to save your configuration.





       
    9.  Repeat steps 3-8 to create each of the three work managers
required on the node.


    


     
    Related tasks
    

  •   Configure the number of crawling threads

  •   Configure the number of indexing threads

  •  Add an additional Search node to a cluster




     Disable dictionaries
    





     If your organization no longer operates in specific geographies,
you can streamline the operation of the Search application by disabling
any dictionaries that are no longer needed.


     


     When using administrative commands, you
must use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.


    


     To remove a dictionary from the list of enabled dictionaries,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  To disable a dictionary, use the following command: 


       


       
      SearchCellConfig.disableDictionary(String languageCode)
      




       
      


       Disables the specified LanguageWare dictionary.





       This
command accepts one argument:


       
        


         
      •  languageCode. The language code for the dictionary
to delete. This argument is a string value.


         The language
code typically comprises two letters conforming to the ISO standard
639-1:2002 that identifies the primary language of the dictionary.
However, there are some codes that additionally define a country or
variant, in which case these constituent parts are separated by an
underscore. For example, Portuguese has two variants, one for Portugal
(pt_PT) and one for Brazil (pt_BR). 


          When using a code that also
specifies a country, ensure that you use an underscore to separate
the language code and the country code rather than a hyphen; otherwise
an error will be generated.




      
For example:


      SearchCellConfig.disableDictionary("fr")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    


     
    Related tasks
    

  •  Reloading the Search application

  •   Enable dictionaries

  •  Listing enabled dictionaries

  •  Set the default dictionary


     

  •  SearchCellConfig commands

  •  Search language dictionaries




     Delete the index
    





     Delete the index by deleting the contents of the directory
specified by the IBM WebSphere Application Server variable, SEARCH_INDEX_DIR.




From time to time, you might need to delete and rebuild the Search index. For example, if you change the context root of one of
the IBM Connections applications,
you then need to rebuild the index by deleting the current index.
The index is automatically rebuilt the next time the indexing task
runs.


     When you delete the index, you might also want to delete the content of the extracted file store used by the Search index. However,
the existing extracted file content can be reused when generating
a new index so, if the files were previously indexed successfully,
it is generally preferable to keep the extracted content to reduce
index recreation time.


    


     To delete the Search index.


     
      


       
    1.  Check the value of the SEARCH_INDEX_DIR WebSphere Application Server variable for
the relevant server:


       
        


         
      1.  Launch the WebSphere Application Server Integrated Solutions Console.





         
      2.  Expand Environment and select WebSphere
variables.





         
      3.  Click the Show filter function icon.





         
      4.  Ensure that Name displays in
the Filter dropdown menu.





         
      5.  Enter SEARCH_INDEX_DIR into the Search
terms field and click Go. A variable called SEARCH_INDEX_DIR displays in the search
results. Take a note of the value of this variable as the index location
for the relevant server.


      






       
    2.  Optional: To delete the contents
of the extracted file store, check the value of the EXTRACTED_FILE_STORE WebSphere Application Server
variable for the server:


       
        


         
      1.  Repeat steps 1a to 1d from the previous step.





         
      2.  Enter EXTRACTED_FILE_STORE into
the Search terms field and click Go. A variable called EXTRACTED_FILE_STORE displays in the search results. Take a note of the value of this variable as the extracted
file content location for the server.


      






       
    3.  Shut down the Search server or cluster.





       
    4.  Delete the contents of the index folder that you noted
in step 1e.





       
    5.  Optional: Delete the contents of the extracted
file content folder that you noted in step 2b.





       
    6.  Rebuild the index by following the steps described in Recreating
the Search index.


    


     
    Related tasks
    

  •   Change application URLs

  •   Restore Activities data

  •  Recreating the Search index

  •   Create a background index


     

  •  Common configuration properties




     Delete persisted seedlist data
    





     You can free up disk space by deleting persisted seedlists
from your system using the SearchService.flushPersistedCrawlContent command.


     


     See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.





Persisted seedlists can take up a large amount of space when
your deployment has a lot of content. If you know that a particular
set of crawled content is no longer needed, you can free up disk space
by using the SearchService.flushPersistedCrawlContent command
to delete the persisted data. This command only clears persisted seedlists
in the default persistence location. To delete seedlists
crawled using the startBackgroundCrawl, startBackgroundFileContentExtraction,
or startBackgroundIndex commands, you must delete them manually.


     You might also want to use the SearchService.flushPersistedCrawlContent command
to remove old data when you are about to recrawl the entire system
with the persistence option enabled. Where previously persisted data
still exists, you can use the command to purge old data from the system
before generating a more up-to-date copy.


    


     To delete persisted seedlists, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Run the following command: 


       


       
      SearchService.flushPersistedCrawlContent()
      




       
      


       Deletes current persisted seedlists.


        This command only
clears persisted seedlists in the default persistence location. Seedlists
crawled using the startBackgroundCrawl, startBackgroundFileContentExtraction,
or startBackgroundIndex commands must be deleted manually.






       This command does not take any input parameters.


        Do
not run this command while a crawl is in progress.






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      

      




    


     
    Related tasks
    

  •   Configure page persistence settings

  •   Create a background index


     

  •  SearchService commands




     Delete scheduled tasks for Search
    





     Use SearchService administrative commands to delete scheduled
task definitions from the Home page database.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.

    


     To delete scheduled tasks for Search, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands: 


       


       
      SearchService.deleteAllTasks()
      




       
      


       Deletes all task definitions from the Home page database.





       This
command does not take any parameters.





       When the command runs
successfully, 1 is printed to the wsadmin console. If the command
does not run successfully, 0 is printed to the wsadmin console.

      




       
      SearchService.deleteTask(String taskName)
      




       
      


       Deletes the task definition with the specified name from the Home page database.





       This command takes a string value, which
is the name of the task to be deleted. For information about how to
retrieve the names of the tasks in the Home page database, see Listing
scheduled tasks.





       For example:


      SearchService.deleteTask("profilesIndexingTask")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      

      







       
    4.  To refresh the Home page database and purge it of information
related to the deleted task or tasks, use the following command: 


       SearchService.refreshTasks()



    


     
    Related tasks
    

  •  Listing scheduled tasks

  •   Restore the default scheduled tasks for Search


     

  •  SearchService commands




    Excluding specific users from the social analytics service
    





     Use SearchService commands to control
whether specific users are included or excluded from the social analytics
service. All users are included in the social analytics service by
default.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





You can use SearchService commands to
exclude a specified user from the social analytics service. When a
user is excluded from the social analytics service, the service does
not build or infer relationships between that user and other users
in the organization. The exempted user:


     
      


       
    •  Is not returned as a related person in search results.





       
    •  Is not recommended in the Do You Know widget.





       
    •  Is not displayed as a link between two people in the Who Connects
Us widget.


    
When the administrator excludes a user from the social analytics
service, the user still receives recommendations from the Recommendations
widgets in Communities and the Home page because these recommendations
are based on the user's collaboration history with other people
in the organization rather than on the user's social network.


     The list of users who are included in the social analytics service is
processed when the Search application starts up, and the list is only
refreshed on completion of social analytics indexing tasks.


    


     To exclude specific users from the social analytic widget
service.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  To exclude a user from the social analytics service, enter
one of the following commands. 


       


       
      SearchService.optOutOfSandByEmail(String email)
      




       
      


       Excludes the user with the specified email address from the social analytics service.





       This command takes a single argument:


       
        


         
      •  email. The email address of the user who
is to be excluded from the social analytics service. This argument
is a string value.


      






       For example: 


      SearchService.optOutOfSandByEmail("ajones10@example.com")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      




       
      SearchService.optOutOfSandByExId(String externalId)
      




       
      


       Excludes the user with the specified external ID from the social
analytics service.





       This command takes a single argument:


       
        


         
      •  externalId. The external ID of the user who
is to be excluded from the social analytics service. This argument
is a string value.


      






       For example: 


      SearchService.optOutOfSandByExId("11111-1111-1111-1111")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      

      







       
    4.  To re-enable a user for the social analytics service, use
one of the following commands. 


       


       
      SearchService.optIntoSandByEmail(String email)
      




       
      


       Includes the user with the specified email address in the social
analytics service.





       This command takes a single argument:


       
        


         
      •  email. The email address of the user who
is to be included in the social analytics service. This argument is
a string value.


      






       For example: 


      SearchService.optIntoSandByEmail("ajones10@example.com")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      




       
      SearchService.optIntoSandByExId(String externalId)
      




       
      


       Includes the user with the specified external ID in the social
analytics service.





       This command takes a single argument:


       
        


         
      •  externalId. The external ID of the user who
is to be included in the social analytics service. This argument is
a string value.


      






       For example: 


      SearchService.optIntoSandByExId("11111-1111-1111-1111")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      

      




    


     
    Related tasks
    

  •   Disable the social analytics service


     

  •  SearchService commands




     Enable and disable scheduled tasks
    





     Use SearchService administrative commands to enable and
disable the scheduled tasks defined in the Home page database.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.

    


     To enable or disable scheduled tasks in the Home page
database.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands to disable and re-enable scheduled
tasks. 


       


       
      SearchService.disableAllTasks()
      




       
      


       Disables all scheduled tasks for the Search application.





       This
command does not take any arguments.





       When the command runs successfully,
1 is printed to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

      




       
      SearchService.disableTask(String taskName)
      




       
      


       Disables the scheduled task with the specified name.





       This
command takes a single argument:


       
        


         
      •  taskName. The name of the task to be disabled. This argument is
a string value.


      






       For example:


      SearchService.disableTask("mine")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.





        Use this command affects the indexing process as
follows:


       
        


         
      •  When the command is run before the scheduled task fires, the indexing
operation is prevented from starting.





         
      •  When the command is run during the indexing operation for an application,
the Search application stops indexing.


      
Results for the current application that is being indexed are
discarded but, if, as part of an scheduled task, some applications
have been successfully crawled, those applications are up-to-date
in the index. For example, if a task is fired that is to index Bookmarks,
Blogs, and Activities (in that order) and the disable command is called
while Blogs is being indexed, when the task is enabled again, Blogs
and Activities resume indexing at the same point as the previously-called
task. Disabled tasks remain disabled until they are re-enabled.

      




       
      SearchService.enableAllTasks()
      




       
      


       Re-enables all scheduled tasks for the Search application.





       This
command does not take any arguments.





       When the command runs successfully,
1 is printed to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

      




       
      SearchService.enableTask(String taskName)
      




       
      


       Re-enables the scheduled task with the specified name. This command uses the current schedule.





       This command takes a single
argument:


       
        


         
      •  taskName. The name of the task to be enabled. This argument is
a string value.


      






       For example:


      SearchService.enableTask("mine")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      

      




    



    Related
    

  •   Schedule tasks


     

  •  SearchService commands




    Excluding inactive users from search results
    





     By default, when users search for people in IBM Connections, inactive user profiles are excluded
from the search results. You can run a command to change your deployment
settings so that search results related to inactive users are automatically
included in search results.


     


     To edit configuration files, you must use the IBM WebSphere Application Server wsadmin client. See Starting
the wsadmin client for details.





When you set the user profiles of employees who have left
your organization to inactive, by default, those profiles are not
listed in search results. Additionally, inactive users do not display
in the person type-ahead on the Advanced Search page.
End users can still filter search results to display inactive profiles
by selecting All People from the Show menu
on the Search Results page when the Profiles filter
is selected.


     If you want inactive profiles to display in search
results by default, you can run a SearchCellConfig command to update
the value of the includeInactiveUsers property in the search-config.xml file
to true. When this property is set to true, the person type ahead
on the Advanced Search page includes inactive
users.





     For more information about the user life cycle in IBM Connections, see Managing
users.


    


     To include or exclude inactive users from search results,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  Use the following commands: 


       
      SearchCellConfig.includeInactiveProfilesSearchResults()
      




       
      


       Specifies that the documents corresponding to inactive user
profiles are included in search results. In a default installation of IBM Connections, inactive
user profiles are automatically excluded from search results.

      




       
      SearchCellConfig.excludeInactiveProfilesSearchResults()
      




       
      


       Specifies that the documents corresponding to inactive user
profiles are excluded from search results. In a default installation of IBM Connections, inactive
user profiles are automatically excluded from search results.

      

      






       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.


    



    Related
    

  •   Manage users




    Extracting file content
    





     To speed up the indexing process, you can use a SearchService
command that extracts file content in a process that is separate from
indexing.


     


     To use SearchService administrative commands,
you must use the IBM WebSphere Application Server
wsadmin client. See Starting
the wsadmin client for details.





The SearchService.startBackgroundFileContentExtraction command
performs file content extraction outside of the indexing process.
This command iterates over the persisted files seedlists and, for
each file, it extracts the file content according to the specified
configuration settings. This process is multithreaded, and is the same file content extraction process that occurs when you run the startBackgroundIndex command.

    


     To extract file content outside of the indexing process,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following command: 


       


       
      SearchService.startBackgroundFileContentExtraction(persistence
dir, components, extracted text
dir, thread limit)
      




       
      


       Extracts file content for all files referenced in the persisted
seedlists in a process that is independent of the indexing task.





       This
command takes the following parameters: 


       
      persistence dir
      




       
      A string that specifies the location of the persisted files seedlists.
      




       
      components
      




       
      A string that specifies the application or applications for which
you want to extract file content. The following values are valid:
files, wikis.
      




       
      extracted text dir
      




       
      A string that specifies the target location for the extracted
text. The same directory structure and naming scheme is used for this
directory as for the extracted text directory on the deployment, connections
shared data/ExtractedText. For example, ExtractedText/121/31/36cdb7a0-92b2-4cf9-91f3-c4e7e527a5e1.
      




       
      thread limit
      




       
      The maximum number of seedlist threads.
      

      






       For example: 


      SearchService.startBackgroundFileContentExtraction("/bg_index/seedlists", "files", "/bg_index/ExtractedText", 10)
      






       You typically run this command after running a startBackgroundCrawl command
to act on up-to-date seedlists. If there are no persisted seedlists
available, the behavior is the same as when you run the startBackgroundIndex
command, that is, the seedlists are crawled and persisted first.

      

      







       
    4.  Verify the target extracted text directory is populated
with the extracted files content. Open some of the extracted
text files in a text editor. You can expect to see the typical format,
for example, some header information followed by the extracted content.


    

     
    What to do next
    


     
      


       
    1.  Copy the extracted file content to the directory specified by
the WebSphere Application Server environmental variable EXTRACTED_FILE_STORE. Storing the extracted
file content in this directory means that when the Search application
next detects a file update during indexing, if the update is a metadata
change only, Search can avoid converting the file again unnecessarily.
For more information about the EXTRACTED_FILE_STORE variable, see WebSphere Application Server
environment variables.





       
    2.  Complete the steps outlined in the topic, Creating a background
index to create a background index using the extracted file
content.


    



     
    Related tasks
    

  •   Create a background index

  •  Performing a background crawl


     

  •  SearchService commands

  •  WebSphere Application Server environment variables




    Listing
enabled dictionaries
    





     Use the listDictionaries command
to check which dictionaries
are currently enabled for use with Search.


     


     When
using administrative commands, you
must use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.


    


     To list
the dictionaries that are currently enabled,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out
the Search cell-level configuration
file : 


      SearchCellConfig.checkOutConfig("working_dir", "cellName")
      

      ...where:


       
        


         
      •  working_dir is the temporary directory
to which you want to check out the cell level configuration file.
This directory must exist on the server where you are running the wsadmin client. Use forward slashes to separate directories in the file path, even if you are using the Microsoft Windows operating
system.


         AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is
the name of the cell that
the Search node belongs to. This argument is required. It is also
case-sensitive, so type it with care. If you do not know the cell
name, you can determine it by typing the following command while in
the wsadmin command processor:


        print AdminControl.getCell()
        



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      






       
    4.  To list the dictionaries currently enabled for use
with
Search, use the following command: 


       


       
      SearchCellConfig.listDictionaries()
      




       
      


       Lists
the LanguageWare dictionaries
that are configured for Search. These dictionaries are used by common
Search to support indexing multilingual content and searching in multiple
languages.





       This command does not take any input parameters.

      

      




    


     
    Related tasks
    

  •  Reloading the Search application

  •   Enable dictionaries

  •  Set the default dictionary

  •   Disable dictionaries


     

  •  SearchCellConfig commands

  •  Search language dictionaries




    Listing indexing nodes
    





     Use the SearchService.listIndexingNodes command when you
need to check the names of the Search indexing nodes in your deployment.
For example, if you want to remove an indexing node from the index
management table, you can use this command to verify the name of the node to remove.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.

    


     To list the indexing nodes for Search, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Run the following command: 


       


       
      SearchService.listIndexingNodes()
      




       
      


       Returns a list of the Search indexing nodes in your deployment.





       This
command does not take any arguments.





       When the command runs successfully,
the names of the Search indexing nodes are printed to the wsadmin
console along with information about each node. The output includes
a version timestamp and information that indicates whether the node
is an indexing node or a non-indexing node, whether the index on the server is more than 30 days old, and whether the index on the server
is synchronized with the latest index in the cluster.





       For example: 


      Indexing Node Id: dubxpcvm084-0Node02:server1, Last Crawl Version: 1,340,285,460,074, Indexer: true, Out of Date: false, Out of Sync: false
      


      

      




    


     
    Related tasks
    

  •   Remove a node from the index management table


     

  •  SearchService commands




    Listing social analytic indexing tasks
    





     You can use a SearchService administrative command to list
the indexing tasks defined for the social analytics service.


     To use SearchService administrative commands, you must use
the wsadmin client. See  Start the wsadmin client for information about
how to start the wsadmin command-line tool.

    


     To list the scheduled tasks defined for the social analytics
service.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following command: 


       


       
      SearchService.listSandTasks()
      




       
      


       Lists all the tasks scheduled for the social analytics service
defined in the Home page database.





       This command does
not take any input parameters.

      

      




    


     
    Related tasks
    

  •  Add scheduled tasks for the social analytics service

  •   Run one-off social analytics scheduled tasks


     

  •  SearchService commands




    Listing Search tasks that are currently running
    





     You can use a SearchService command to get a list of the tasks that are currently running for the Search application.


     


     To run SearchService commands, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.


    


     To get a list of the Search tasks that are currently
running.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Enter the following command: 


       


       
      SearchService.listRunningTasks()
      




       
      


       Lists all the tasks that are currently running for the Search
application. This command does not take any input parameters.





       The command returns a list of the tasks that are currently running, and
includes the following information for each task:


       
        


         
      •  Internal task ID





         
      •  Task name





         
      •  Time that the task started


      






       For example: 


      wsadmin>SearchService.listRunningTasks()
>>>51
roi-profiles-WedDec0715:23:09GMT2011
Wed Dec 07 15:23:09 GMT 2011
      


      

      




    


     

  •  SearchService commands




     Set the maximum number of search results per page
    





     You can update a property in the IBM Connections configuration
file to specify the maximum size of a search results page.




The seedlistSets.maximumPageSize property in the LotusConnections-config.xml configuration
file allows you to specify the maximum number of items to display
on a search results page.

    


     To specify the maximum number of search results per page,
complete the following steps.


     
      


       
    1.  Use the wsadmin client to access and check out the IBM Connections configuration files:


       
        


         
      1.  Enter the following command
to access the IBM Connections configuration file: execfile("connectionsConfig.py") 


         If prompted to specify a service to connect
to, type 1 to pick the first node in the list. Most commands can run
on any node. If the command writes or reads information to or from
a file using a local file path, you must pick the node where the file
is stored. This information is not used by the wsadmin client when
you are making configuration changes.






         
      2.  Enter the following command
to check out the IBM Connections configuration files: 


         LCConfigService.checkOutConfig("working_directory","cell_name")





         where:


         
          


           
        •  working_directory is the temporary working
directory to which the configuration XML and XSD files are copied
and are stored while you make changes to them. Use forward slashes
to separate directories in the file path, even if you are using the Microsoft Windows operating system. 


           AIX and Linux only:
The directory must grant write permissions or the command does not
run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is case-sensitive, so type it with care. If you do not
know the cell name, type the following command while in the wsadmin
command processor:print AdminControl.getCell()


        
For example:


         
          


           
        •  AIX or Linux:LCConfigService.checkOutConfig("/opt/temp","foo01Cell01")





           
        •  Microsoft

          Windows:LCConfigService.checkOutConfig("c:/temp","foo01Cell01")


        




      






       
    2.  Optional: If you want to find out the current value of a property, you
can list the current configuration settings and values : LCConfigService.showConfig()





       
    3.  Enter the following command: 


      LCConfigService.updateConfig("seedlistSets.maximumPageSize",number_items)
      
Where number_items is a number greater
than or equal to 100.


    

     
    What to do next
    


     Check
the configuration files back in during the same wsadmin session in
which you checked them out. For more information, see the Applying
common configuration property changes topic.





     Run one-off social analytics scheduled tasks
    





     Use the SearchService.sandIndexNow command to create a
one-off scheduled task for the social analytics service. The task
is scheduled to run once and only once, 30 seconds after being called.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.







     The social analytics indexing process includes
the following five jobs. You can schedule these jobs individually
or in a batch.


     
    evidence
    




     
    Builds the evidence index, which links people to results and maps
user connections.
    




     
    graph
    




     
    Builds the graph of connections between users.
    




     
    manageremployees
    




     
    Provides details of manager relationships so that people's
relationships through their management can be identified. For example,
when two people share a second line manager.
    




     
    tags
    




     
    Generates index documents for each used tag and stores the list
of users that have used that tag.
    




     
    taggedby
    




     
    Creates relationships between the users who have tagged each other's
profiles.
    




     
    communitymembership
    




     
    Creates relationships between the users who are members of the same community.


      Communities that have more than 100 members are
skipped. These communities will not be recommended to users.

    

    



    


     To run a one-off social analytics scheduled task, complete
the following steps:


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following command: 


       


       
      SearchService.sandIndexNow(String jobs)
      




       
      


       Creates a one-off social analytics task that indexes the specified
services 30 seconds after being called.





       This
command takes a single argument:


       
        


         
      •  jobs. The name, or names, of the jobs to be run when the task
is triggered. This argument is a string value. To run multiple jobs,
use a comma-delimited list. The following values are valid: evidence,
graph, manageremployees, tags, taggedby, and communitymembership.


      
For example:


      SearchService.sandIndexNow("evidence,graph,manageremployees,tags,taggedby,communitymembership")
      


      

      




    


     
    Related tasks
    

  •   Run one-off tasks

  •  Listing social analytic indexing tasks


     

  •  SearchService commands




     Run one-off tasks
    





     The SearchService MBean provides commands that allow you
to create an indexing optimize task that is scheduled to run once
and only once, 30 seconds after being called.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.







     Notes: 


     
      


       
    1.  If the time between issuing these commands is less than the polling
interval for the Search scheduler, then tasks might not execute in
the same order as the order in which the commands were issued.





       
    2.  You should wait at least the duration of the poll interval after
issuing the following commands before issuing another one of the commands:


       
        


         
      •  indexNow()





         
      •  indexNowWithOptimization()





         
      •  optimizeNow()


      



    



    


     To run one-off Search tasks.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands to run one-off indexing tasks. 


       


       
      SearchService.indexNow(String applicationNames)
      




       
      


       Creates a one-off task that indexes the specified applications
30 seconds after being called.





       This command takes a single argument:


       
        


         
      •  applicationNames. The name (or names) of
the IBM Connections application
to be indexed when the task is triggered. This argument is a string
value. To index multiple applications, use a comma-delimited list.
The following values are valid: activities, blogs, calendar, communities,
dogear, files, forums, profiles, status_updates, and wikis.


      





        An optimize operation is not run at the end of the indexing
operation.
For example:


      SearchService.indexNow("dogear, blogs")
      


      




       
      SearchService.indexNowWithOptimization(String applicationNames)
      




       
      


       Creates a one-off task that indexes the specified applications
30 seconds after being called, and performs an optimization operation
at the end of the indexing operation.





       This command takes a single
argument:


       
        


         
      •  applicationNames. The name (or names) of
the IBM Connections application
to be indexed when the task is triggered. This argument is a string
value. To index multiple applications, use a comma-delimited list.
The following values are valid: activities, blogs, calendar, communities,
dogear, files, forums, profiles, status_updates, and wikis.


      





        The optimization operation is both CPU and I/O
intensive. For this reason, the operation should be performed infrequently
and, if possible, during off-peak hours. For more information, refer
to the following web page: 
      http://lucene.apache.org/core/old_versioned_docs/versions/3_0_3/api/all/org/apache/lucene/index/IndexWriter.html#optimize%28%29


       Note
that when you install IBM Connections,
a search optimization task is set up to run every night by default.
See Search default tasks for more information.

For
example:


      SearchService.indexNowWithOptimization("dogear, blogs")
      


      




       
      SearchService.optimizeNow()
      




       
      


       Creates a one-off task that performs an optimize operation
on the search index, 30 seconds after being called.


        The optimization operation is both CPU and I/O
intensive. For this reason, the operation should be performed infrequently
and, if possible, during off-peak hours. For more information, refer
to the following web page: 
      http://lucene.apache.org/core/old_versioned_docs/versions/3_0_3/api/all/org/apache/lucene/index/IndexWriter.html#optimize%28%29


       Note
that when you install IBM Connections,
a search optimization task is set up to run every night by default.
See Search default tasks for more information.







       This
command does not accept any input parameters.





       This operation
should not be called during an indexing operation; if it needs to
be run, do it at an off-peak time when the application is not expected
to be performing intensive I/O operations on the index.

      

      




    



    Related
    

  •   Schedule tasks


    

  •   Run one-off social analytics scheduled tasks


     

  •  SearchService commands

  •  Search default scheduled tasks




    Performing a background crawl
    





     You can use a SearchService command to perform a background
crawl of the Search seedlists without creating a Search index.


     


     See  Start the wsadmin client for
information about how to start the wsadmin command-line tool.





The SearchService.startBackgroundCrawl command allows you
to crawl the application seedlists and save those seedlists to a specified
location. You might want to use this command if you are experiencing
issues with crawling and you want to verify that the crawling process
is completing successfully.

    


     To perform a background crawl of the Search seedlists,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Enter the following command: 


       


       
      SearchService.startBackgroundCrawl(String persistenceLocation,
String components)
      




       
      


       Crawls the seedlists for the specified applications and then
saves the seedlists to the specified location. This command does not
build an index.





       The command takes the following parameters:


       
      persistenceLocation
      




       
      A string that specifies the path to which the seedlists are to
be saved.
      




       
      components
      




       
      A string that specifies the applications whose seedlists are to
be crawled. The following values are valid: activities, all_configured,
blogs, calendar, communities, dogear, files, forums, profiles, status_updates,
and wikis. Use all_configured when you want to crawl all the applications.
      

      






       For example:


      SearchService.startBackgroundCrawl("/opt/IBM/Connections/backgroundCrawl", "activities, forums, communities, wikis")
      


      

      




    

     
    What to do next
    After completing a background crawl, perform one of the following options:


     
      


       
    •  Extract file content. For more information, see Extracting
file content.





       
    •  Create a background index. For more information, see Creating
a background index.





       
    •  Create a foreground index. For more information, see Recreating
the Search index. 


       If you want to create a foreground index,
copy the persisted seedlists from the persistence location that you
specified when you used the startBackgroundIndex command to the CRAWLER_PAGE_PERSISTENCE_DIR
directory on the node that is doing the indexing.





       In a multi-node
system, you might want to copy the seedlists to the CRAWLER_PAGE_PERSISTENCE_DIR
directory on all nodes. Alternatively, you can set the CRAWLER_PAGE_PERSISTENCE_DIR
variable to a network location and copy the persisted seedlists from
the persistence location you specified to that location.



    



     
    Related tasks
    

  •   Configure the number of crawling threads

  •   Verify that Search is crawling regularly

  •   Create a background index

  •  Extracting file content


     

  •  SearchService commands




     Purging content from the index
    





     Use the SearchService.deleteFeatureIndex command to purge
content for a specific application from the Search index in a single-node
environment.


     To run administrative commands, you must use the IBM WebSphere Application Server wsadmin client. See Starting
the wsadmin client for details.


      In an environment with
multiple nodes, use the SearchService.deleteFeatureIndex command only
when you want to delete the index for an application that has been
uninstalled. After running this command, the content from the component
that has been deleted cannot be reindexed. To delete content
for a specific application from the index, use the SearchService.startBackgroundIndex
command to rebuild a new index for all applications instead. For more
information about this command, see Creating a background index.





If there is a problem with indexed content from any of the IBM Connections applications, instead
of deleting and recreating the entire index, you can use the SearchService.deleteFeatureIndex
command to remove and purge all documents for a given application
from the index. The command deletes the content from the database
that is shared by all the servers in the cluster as well as from the indexes.


     When you run the SearchService.deleteFeatureIndex command,
the command removes indexed content for the specified application
from the node in your deployment. Indexing tasks are automatically
disabled at the start of this process and re-enabled when the process
is complete, regardless of whether the tasks were disabled initially.





      When
you remove an application from the Search index, you need to rebuild
the indexes for the social analytics service. The social analytics
indexes are completely rebuilt every night by default, however, to
fully remove an application's index immediately, you must use the SearchService.sandIndexNow command on each of the social analytics
indexes. For more information about this command, see Running
one-off social analytics scheduled tasks.


    


     To purge content for a specific application from the index.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following command to remove and purge content from
a specified application from the Search index. 


       


       
      SearchService.deleteFeatureIndex(String applicationName)
      




       
      


       Removes and purges the content for the specified application
from the Search index.

        Only use this command
if you are uninstalling an application from IBM Connections. After you run the command, the content from the application that has been deleted cannot be reindexed.






       This
command takes a string value, which is the name of the application
whose content is to be deleted. The following values are valid: activities,
blogs, calendar, communities, dogear, files, forums, profiles, status_updates,
and wikis.





       For example:


      SearchService.deleteFeatureIndex("activities")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      

      




    



    Related
    

  •   Administer the social analytics service


    

  •   Run one-off social analytics scheduled tasks

  •   Create a background index


     

  •  SearchService commands




    Reindexing content
    





     Use the retryIndexing command when you want to reindex
content that was not indexed successfully during initial or incremental
indexing.


     To run administrative commands, you must use the IBM WebSphere Application Server wsadmin client. See Starting
the wsadmin client for details.




If a failure occurs when you are trying to index content
from the IBM Connections applications,
you can use the retryIndexing command to try to index that content
again. You can tell if a failure has occurred during content indexing
when you do not see the expected search results being returned, or
when you see incorrect search results being returned. For example,
you might have updated a document but an older version of that document
is returned by a search.

    


     To reindex content that failed to be indexed previously,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following command. 


       


       
      SearchService.retryIndexing(String service, String id)
      




       
      


       Attempts to index an item of content that was not indexed successfully
during initial or incremental indexing.





       This
command takes two parameters: 


       
      service
      




       
      The application from which the content originated.
      




       
      id
      




       
      The Atom ID of the content. For information about how to retrieve
the Atom ID for the content, refer to the IBM Connections APIs section
of the product documentation.
      

      






       For example:


      SearchService.retryIndexing('activities', 'b63cabf8-0533-45cf-9636-d63cd6a6f3ca')
      






       If
the command is successful, 1 is printed to the console. If the command
fails, 0 is printed to the console.

      

      




    



    Related
    

  •  IBM Connections APIs


     

  •  SearchService commands




    Reloading the Search application
    





     After making configuration changes to Search, you can use
SearchService commands to reload the Search index and configuration,
and avoid the need for restarting the Search application.


     


     To use SearchService administrative commands,
you must use the IBM WebSphere Application Server
wsadmin client. See Starting
the wsadmin client for details.





You can use the SearchService commands for reloading Search
after running SearchCellConfig commands if it is not feasible to restart
the Search application. You might want to use the commands for reloading
the index as part of restoring a Search index backup if it is not
feasible to stop the Search application.

    


     To reload the Search application, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands to reload the Search configuration
and index: 


       


       
      SearchService.reloadSearchConfiguration()
      




       
      


       Reloads the search-config.xml file for
Search on the current node only without a restart of the Search application.
       If you are making changes to the configuration of the social
analytics service, you still need to restart Search to apply the changes.






       When the command runs successfully, 1 is printed
to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

      




       
      SearchService.reloadSearchConfigurationAllNodes()
      




       
      


       Reloads the search-config.xml file for
Search on all nodes in the cluster without a restart of the Search
application.


        If you are making changes to the configuration of the social
analytics service, you still need to restart Search to apply the changes.






       When the command runs successfully, 1 is printed
to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

      




       
      SearchService.reloadIndex()
      




       
      


       Reloads the Search index on the current node only without a
restart of the Search application.


        If you are making changes to the configuration of the social
analytics service, you still need to restart Search to apply the changes.






       When the command runs successfully, 1 is printed
to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

      




       
      SearchService.reloadIndexAllNodes()
      




       
      


       Reloads the Search index on all the nodes in the cluster without
a restart of the Search application.


        If you are making changes to the configuration of the social
analytics service, you still need to restart Search to apply the changes.






       When the command runs successfully, 1 is printed
to the wsadmin console. If the command does not run successfully,
0 is printed to the wsadmin console.

      

      




    


     
    Related tasks
    

  •   Configure index backup settings

  •   Configure file attachment indexing settings

  •   Disable dictionaries

  •  Listing enabled dictionaries

  •   Configure the number of crawling threads

  •   Enable dictionaries

  •  Set the default dictionary

  •   Restore a Search index without restarting individual nodes


     

  •  SearchService commands




     Remove a node from the index management table
    





     When you are removing a node from a cluster, use the SearchService.removeIndexingNode
wsadmin command to remove the node from the index management table.


     You must remove the node from the cluster before using the SearchService.removeIndexingNode command to remove it from the index
management table. For information about how to remove nodes, see Removing
nodes from a cluster.


     To use the SearchService.removeIndexingNode
command, you must use the IBM WebSphere Application Server
wsadmin client. See Starting
the wsadmin client for details.





You can use the removeIndexNode command to remove an entry
from the SR_INDEX_MANAGEMENT table that is added or updated by Search
servers at start-up time.

    


     To remove a node from the index management table, complete
the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following command: 


       


       
      SearchService.removeIndexingNode(String nodeName)
      




       
      


       Removes the specified node from the index management table.





       This
command takes a single argument:


       
        


         
      •  nodeName. The name of the node to be removed. This argument is
a string value that takes the following format: 


        nodeName:serverName
        
To
retrieve a list of the indexing nodes in your deployment, run the SearchService.listIndexingNodes() command. For more information, see Listing
indexing nodes.


      






       For example:


      SearchService.removeIndexingNode("Node01:cluster1_server1")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.

      

      




    



    Related
    

  •   Remove nodes from a cluster


    

  •  Listing indexing nodes


     

  •  SearchService commands




     Restore the default scheduled tasks for Search
    





     Use a SearchService administrative command to delete all
scheduled tasks from the Home page database and restore the tasks
that are configured by default when you first install IBM Connections. You can also use SearchService
commands to restore individual default tasks.


     To use SearchService administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.


     


      If the effect of resetting the default
scheduled tasks for Search is to update the indexing task by adding
an application that is not already part of any indexing task and is
not currently indexed in the Search index, you must perform initial
indexing for that application. In a production environment, first
make a backup of your Search index, and then use the startBackgroundIndex
command to add the new application to your Search index backup. Replace
the current index with the resulting new index before you execute
the reset command. If you do not do this, indexing on nodes that do
not have a Search index containing resume points for all the applications
contained in the task will not proceed and, as a result, all Search
indexing will stop.



    


     To restore the default scheduled tasks for Search, complete
the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  To restore the full set of default tasks, use the following command: 


       


       
      SearchService.resetAllTasks()
      




       
      


       Deletes all scheduled task definitions from the Home page database
and restores the default set of tasks. For more information about
these tasks, see Search default scheduled tasks.





       This
command does not take any parameters.





       When the command runs
successfully, 1 is printed to the wsadmin console. If the command
does not run successfully, 0 is printed to the wsadmin console.

      

      







       
    4.  To reset individual default tasks, use the following commands
with the parameters provided here: 


       
      15min-search-indexing-task
      




       
      


      SearchService.addIndexingTask("15min-search-indexing-task", "0 1/15 0,2-23 * * ?", "0 10/15 0,2-23 * * ?", "all_configured", "false")
      

      




       
      20min-file-retrieval-task
      




       
      


      SearchService.addFileContentTask("20min-file-retrieval-task", "0 1/20 0,2-23 * * ?", "0 10/20 0,2-23 * * ?", "all_configured", "false")
      

      




       
      nightly-optimize-task
      




       
      


      SearchService.addOptimizeTask("nightly-optimize-task", "0 30 1 * * ?", "0 35 1 * * ?")
      

      




       
      nightly-sand-task
      




       
      


      SearchService.addSandTask("nightly-sand-task", "0 0 1 * * ?", "0 5 1 * * ?", "evidence,graph,manageremployees,tags,taggedby,communitymembership")
      

      

      
For more information about these default scheduled
tasks, see Search default scheduled tasks.





       
    5.  To refresh the Home page database and purge it of information
related to the deleted task or tasks, use the following command: 


       SearchService.refreshTasks()



    


     
    Related tasks
    

  •   Delete scheduled tasks for Search


     

  •  SearchService commands

  •  Search default scheduled tasks




     Restore a Search index in an environment with multiple nodes
    





     Complete the following procedure when you want to restore
a Search index in a multi-node environment where restarting individual
Search nodes is acceptable. Some Search nodes are unavailable during
the procedure but other nodes in the cluster are still available to
handle incoming requests.


     For information about how to create a backup
copy of the Search index, see Back up the Search index.


      IBM Connections applications maintain
delete and access-control update information for a maximum of 30 days.
Indexes that are more than 30 days old are not considered suitable
for restoration because they might contain obsolete or orphan content.





When you create a backup copy of the Search index, you can
use this copy to restore the index in the event of loss or corruption.
You must restore the backup consistently for all the nodes in your deployment.


     Follow this procedure to restore a Search index if your environment has multiple Search nodes in the cluster. If your environment
has multiple nodes but the Search application is only deployed on
one of those nodes, refer to the topic, Restoring a Search index
in a single-node environment.


    


     
      


       
    1.  Disable any regular indexing tasks that you
have configured.


       
        


         
      1.  To list the indexing tasks, enter the following command: 
        SearchService.listIndexingTasks()





         
      2.  To disable a task, enter the following command: 
        SearchService.disableTask(String taskName)


         For example:


        SearchService.disableTask('15min-search-indexing-task')
        






         There
is only one indexing task by default.



      






       
    2.  To prepare the HOMEPAGE database to successfully load restored
indexes on each node, enter the following command: 
      SearchService.notifyRestore(Boolean
isNewIndex)


       where the isNewIndex parameter specifies
whether all entries are removed from the database table that is used
by the file content extraction process to track the status of individual
files. Set the parameter to false when you are restoring an index
backup.





       For example: 


      SearchService.notifyRestore("false")
      






       For more information about this command, see Back up the Search
index using wsadmin commands.






       
    3.  Stop the first Search node in your deployment.





       
    4.  Delete the contents of the index directory and all its
subdirectories from the IBM Connections Search data directory.





       
    5.  Copy the backup index and all its subdirectories into the Search directory.





       
    6.  Restart the Search node.





       
    7.  Stop each remaining Search node in the cluster in turn
and repeat steps 4-6 for that node.





       
    8.  Re-enable your indexing task or tasks using
the SearchService.enableTask(String taskName) command. 


       For example:


      SearchService.enableTask('15min-search-indexing-task')
      

The
next indexing task to run resumes indexing at the point at which the restored index was last successfully indexed.


    



    Related
    

  •  Back up the Search index


    

  •   Start the wsadmin client

  •   Enable and disable scheduled tasks

  •  Listing scheduled tasks

  •   Restore a Search index in a single-node environment

  •   Restore a Search index without restarting individual nodes

  •   Verify Search index creation

  •  Back up the Search index using wsadmin commands


     

  •  SearchService commands




     Restore a Search index in a single-node environment
    





     In the event of data loss or corruption, you can use a
backup copy of the Search index to restore the index. Use the following procedure to restore the Search index in a single node environment.


    For information about how to create a backup
copy of the Search index, see Back up the Search index.


      IBM Connections applications maintain
delete and access-control update information for a maximum of 30 days.
Indexes that are more than 30 days old are not considered suitable
for restoration because they might contain obsolete or orphan content.





You can also follow the procedure described here when you
want to restore the index in an environment with multiple nodes if
it is not an issue that all the nodes are unavailable while the index
is being restored. For information about restoring the index in a
multi-node environment, see Restoring a Search index in an environment
with multiple nodes.

    


     To restore a Search index in a single-node environment,
complete the following steps:


     
      


       
    1.  Disable any regular indexing tasks that you
have configured.


       
        


         
      1.  To list the indexing tasks, enter the following command: 
        SearchService.listIndexingTasks()





         
      2.  To disable a task, enter the following command: 
        SearchService.disableTask(String taskName)


         For example:


        SearchService.disableTask('15min-search-indexing-task')
        






         There
is only one indexing task by default.



      






       
    2.  To prepare the HOMEPAGE database to successfully load the restored index, enter the following command: 
      SearchService.notifyRestore(Boolean
isNewIndex)


       where the isNewIndex parameter specifies
whether all entries are removed from the database table that is used
by the file content extraction process to track the status of individual
files. Set the parameter to false when you are restoring an index
backup.





       For example: 


      SearchService.notifyRestore("false")
      






       For more information about this command, see Back up the Search
index using wsadmin commands.






       
    3.  Stop the Search server.





       
    4.  Delete the contents of the index directory and all its
subdirectories from the IBM Connections Search data directory. 





       
    5.  Copy the backup index and all its subdirectories into the Search directory. 





       
    6.  Restart the Search server.





       
    7.  Re-enable your indexing task or tasks using
the SearchService.enableTask(String taskName) command. 


       For example:


      SearchService.enableTask('15min-search-indexing-task')
      

The
next indexing task to run resumes indexing at the point at which the restored index was last successfully indexed.


    



    Related
    

  •  Back up the Search index


    

  •   Start the wsadmin client

  •   Enable and disable scheduled tasks

  •  Listing scheduled tasks

  •   Restore a Search index in an environment with multiple nodes

  •   Restore a Search index without restarting individual nodes

  •   Verify Search index creation

  •  Back up the Search index using wsadmin commands


     

  •  SearchService commands




     Restore a Search index without restarting individual nodes
    





     Complete the following procedure when you want to restore
a Search index in a multi-node environment where restarting individual
Search nodes must be avoided.


     For information about how to create a backup
copy of the Search index, see Back up the Search index.


      IBM Connections applications maintain
delete and access-control update information for a maximum of 30 days.
Indexes that are more than 30 days old are not considered suitable
for restoration because they might contain obsolete or orphan content.





You can use a backup copy of the Search index to restore
the index in the event of loss or corruption. You must restore the backup consistently for all the nodes in your deployment.

    


     To restore the Search index in the event of loss or corruption,
complete the following steps:


     
      


       
    1.  Disable any regular indexing tasks that you
have configured.


       
        


         
      1.  To list the indexing tasks, enter the following command: 
        SearchService.listIndexingTasks()





         
      2.  To disable a task, enter the following command: 
        SearchService.disableTask(String taskName)


         For example:


        SearchService.disableTask('15min-search-indexing-task')
        






         There
is only one indexing task by default.



      






       
    2.  To prepare the HOMEPAGE database to successfully load restored
indexes on each node, enter the following command: 
      SearchService.notifyRestore(Boolean
isNewIndex)


       where the isNewIndex parameter specifies
whether all entries are removed from the database table that is used
by the file content extraction process to track the status of individual
files. Set the parameter to false when you are restoring an index
backup.





       For example: 


      SearchService.notifyRestore("false")
      






       For more information about this command, see Backing
up the Search index using wsadmin commands.






       
    3.  On each Search node, delete the contents of the index directory
and all its subdirectories from the IBM Connections Search data directory.





       
    4.  On each Search node, copy the backup index and all its
subdirectories into the Search directory.





       
    5.  On each Search node, reload the index : 


      SearchService.reloadIndex()
      






       
    6.  Re-enable your indexing task or tasks using
the SearchService.enableTask(String taskName) command. 


       For example:


      SearchService.enableTask('15min-search-indexing-task')
      

The
next indexing task to run resumes indexing at the point at which the restored index was last successfully indexed.


    



    Related
    

  •  Back up the Search index


    

  •  Reloading the Search application

  •   Start the wsadmin client

  •   Enable and disable scheduled tasks

  •  Listing scheduled tasks

  •   Restore a Search index in a single-node environment

  •   Restore a Search index in an environment with multiple nodes

  •   Verify Search index creation

  •  Back up the Search index using wsadmin commands


     

  •  SearchService commands




     Enable indexing resumption
    





     You can add a configuration setting to the search-config.xml file
to specify that interrupted or failed indexing tasks are automatically
resumed.


     


     When using administrative commands, you
must use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





The SearchCellConfig.setIndexingResumptionAllowed command
allows you to enable the resumption of failed or interrupted indexing
tasks that have not yet reached a resume point. When you enable this
functionality and an indexing task fails or is interrupted, the task
resumes at the start of the previous seedlist page rather than from
the previous resume point.


     Indexing resumption is disabled by default
when you install IBM Connections. When you run the SearchCellConfig.setIndexingResumptionAllowed command,
the allowResumption setting, which specifies that interrupted or failed
indexing tasks are automatically resumed, is added to the search-config.xml configuration
file. 


    <indexSets allowResumption="true" location="${SEARCH_INDEX_DIR}" maxIndexerThreads="1"/>
    






     You might want to consider enabling indexing resumption
after installation because, if there is an interruption during initial
indexing, this feature allows indexing to resume from where it left
off. Normally, only crawling and file content extraction resume from

    ...where they are left off after an interruption. However, the indexing
resumption feature has an impact on performance, and there is little
benefit to enabling it during incremental indexing as incremental
indexing typically executes very quickly.


    


     To enable indexing resumption, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  Use the following command: 


       


       
      SearchCellConfig.setIndexingResumptionAllowed(boolean allowed)
      




       
      


       Enables or disables the resumption of interrupted or failed
indexing tasks that have not reached a resume point.





       This command
takes a single argument:


       
        


         
      •  allowed. A boolean value.


      






       For example, to enable indexing resumption:


      SearchCellConfig.setIndexingResumptionAllowed("true")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    



    Related
    

  •  The indexing process


    

  •   Verify that Search is crawling regularly

  •   Configure the number of crawling threads


     

  •  SearchCellConfig commands




    Retrieve file content
    





     Use SearchService commands to perform file content retrieval
tasks.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





Depending on the number of files being indexed in your deployment,
it can take a long time to retrieve file content. To ensure that all
content is retrieved and indexed, you can run the indexNow command
to retrieve all content before the document indexing service finishes,
or you can run it after the document indexing service has finished.


     For example, to manually index files and all file content, you might run
the following commands:



    wsadmin>SearchService.indexNow("files")
wsadmin>SearchService.getFileContentNow("files")
wsadmin>SearchService.indexNow("files")
    





     The document
indexing service can run on multiple nodes, making the download and
conversion process faster. When the document indexing task is scheduled,
the Search application sends a message to all the nodes to tell them
to start the document indexing process locally. Each Search server
starts taking files from the cache and downloading and converting
them. When a node retrieves a file, it flags the file in the cache
as claimed so that other nodes do not try to get content for that
file.


    


     To perform file content retrieval tasks, complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands to perform file content retrieval
tasks. 


       


       
      SearchService.getFileContentNow(String applicationNames)
      




       
      


       Launches the file content retrieval task. This command iterates
over the file cache, downloading and converting files that don't
have any content.

      This command takes a
string value, which is the name of the application whose content is
to be retrieved. The following values are valid:


       
        


         
      •  files





         
      •  wikis


      






       For example:


      SearchService.getFileContentNow("files")
      


      




       
      SearchService.retryContentFailuresNow(String applicationNames)
      




       
      


       Retries failed attempts at downloading and converting files
for the specified application.





       This command takes a string value,
which is the name of the application whose content is to be downloaded
and converted. The following values are valid:


       
        


         
      •  files





         
      •  wikis


      






       A file download or conversion task can fail for a number
of reasons, for example, hardware or network issues. Failures are
flagged in the cache and can be retried.





       For example:


      SearchService.retryContentFailuresNow("wikis,files")
      


      




       
      SearchService.addFileContentTask(String taskName, String schedule,
String startBy, String applicationNames, failuresOnly)
      




       
      


       Creates a scheduled file content retrieval task.





       This
command takes the following arguments:


       
        


         
      •  taskName. The name of the scheduled task. This argument is a string
value, which must be unique.





         
      •  schedule. The time at which the scheduled task starts. This argument
is a string value that must be specified in Cron format. For more
information about the Cron schedule, see Scheduling tasks.





         
      •  startBy. The time given to a task to fire before it is automatically
canceled. This argument is a string value that must be specified in
Cron format. For more information about the Cron schedule, see Scheduling
tasks.





         
      •  applicationNames. The name (or names) of the IBM Connections application to be indexed when
the task is triggered. This argument is a string value. To index multiple
applications, use a comma-delimited list. The following values are
valid:


         
          


           
        •  files





           
        •  wikis


        






         
      •  failuresOnly. A flag that indicates that only the content of files
for which the download and conversion tasks failed should be retrieved.
This argument is a boolean value.


      






       For example:


      SearchService.addFileContentTask("mine", "0 0 1 ? * MON-FRI", "0 10 1 ? * MON-FRI", "wikis,files","true")
      






       When
the command runs successfully, 1 is printed to the wsadmin console.
If the command does not run successfully, 0 is printed to the wsadmin
console.





       You can also use the SearchService.addFileContentTask
command to replace the task definition for the default 20min-file-retrieval-task.
By default, this task runs every 20 minutes, except for a one-hour
period between 01:00 and 02:00. To replace the default task settings,
first remove the existing task using the SearchService.deleteTask(String
taskName) command. Then use the SearchService.addFileContentTask to
create a new task with the values that you specify.





       For example: 


      SearchService.deleteTask("20min-file-retrieval-task")
SearchService.addFileContentTask("20min-file-retrieval-task", "0 1/20 0,2-23 * * ?", "0 10/20 0,2-23 * * ?", "all_configured", "false")
      


      




       
      SearchService.listFileContentTasks()
      




       
      


       Lists all the scheduled file content retrieval tasks.





       This
command does not take any input parameters.

      




       
      SearchService.enableTask(String taskName)
      




       
      


       Enables the specified task.





       This command takes a single
argument: 


       
        


         
      •  taskName. The name of the task to be enabled. This argument is
a string value.


      






       For example:


      SearchService.enableTask("mine")
      


      




       
      SearchService.disableTask(String taskName)
      




       
      


       Disables the specified task.





       This command takes a single
argument: 


       
        


         
      •  taskName. The name of the task to be disabled. This argument is
a string value.


      






       For example:


      SearchService.disableTask("mine")
      


      

      




    



    Related
    

  •   Schedule tasks

  •   Configure scheduled tasks


    

  •   Delete outdated file content


     

  •  SearchService commands

  •  Search default scheduled tasks




    Listing scheduled tasks
    





     Use
SearchService administrative commands to list the scheduled
tasks defined in the Home page database.


     To use SearchService
administrative commands, you must use
the wsadmin client. See Starting
the wsadmin client for information about how to start the wsadmin
command-line tool.

    


     To list the scheduled
tasks defined in the Home page
database.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Use the following commands
to list tasks defined in the Home page database. 


       


       
      SearchService.listTasks()
      




       
      


       Lists all Search scheduled task definitions (indexing and optimize)
defined in the Home page database.





       This command does not take
any input parameters.

      




       
      SearchService.listIndexingTasks()
      




       
      


       Lists all scheduled
indexing task definitions defined in the Home page database.





       This command does not take any input parameters.

      




       
      SearchService.listOptimizeTasks()
      




       
      


       Lists all scheduled optimize task definitions defined in the Home page database.





       This command does not take any input parameters.

      

      




    



    Related
    

  •   Schedule tasks


    

  •   Delete scheduled tasks for Search


     

  •  SearchService commands




    Set the default dictionary
    





     Use administrative commands to set the default dictionary
used for Search query strings.


     


     When using administrative commands, you
must use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





You use the setDefaultDictionary command
to set the default dictionary used for Search queries. At indexing
time, when content is analyzed, an attempt is made to guess which
of the enabled IBM LanguageWare dictionaries should be
used when applying the text analysis process. If the attempt is unsuccessful
or if the language guessed does not have a corresponding dictionary
enabled, the default dictionary is used.


     The default dictionary
is also used at search time. Language guessing is not used at search
time to determine which dictionary is used for text analysis, the language is specified as part of the HTTP request. If there is a problem
loading the dictionary corresponding to the language specified or
if there is no corresponding dictionary enabled, then the default
dictionary is used.


    


     To specify a default dictionary for use with Search,
complete the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  To set the default dictionary, use the following command: 


       


       
      SearchCellConfig.setDefaultDictionary(String languageCode)
      




       
      


       Configures the default LanguageWare dictionary
used by the Search application. The default dictionary must be one
of the enabled dictionaries.





       This command takes a single argument:


       
        


         
      •  languageCode is the language code for the dictionary that you
want to set as the default.


         This language code typically comprises
two letters conforming to the ISO standard 639-1:2002 that identifies
the primary language of the dictionary. However, there are some codes
that additionally define a country or variant, in which case these
constituent parts are separated by an underscore. For example, Portuguese
has two variants, one for Portugal (pt_PT) and one for Brazil (pt_BR).
When using a code that also specifies a country, ensure that you use
an underscore to separate the language code and the country code rather
than a hyphen; otherwise an error will be generated.


          A matching
dictionary must exist in the list of configured dictionaries for the language that you specify as a parameter.




      






       For example:


      SearchCellConfig.setDefaultDictionary("fr")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    


     
    Related tasks
    

  •  Reloading the Search application

  •   Enable dictionaries

  •  Listing enabled dictionaries

  •   Disable dictionaries


     

  •  SearchCellConfig commands

  •  Search language dictionaries




     Configure the number of crawling threads
    





     Edit settings in the search-config.xml file
to specify the maximum number of threads used when crawling. The maximum
number of threads that you should specify is the number of applications
that you have installed in your deployment.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





By default, the maximum number of threads allowed when crawling
is 2, however you can change this value by modifying the search-config.xml file.
When you change the maximum number of crawling threads, you might
also need to adjust the thread settings for the SearchCrawlingWorkManager
on each node. The Search application will use whichever setting is
lower. For more information about updating Search work managers, see Updating
Search work manager settings.

    


     To update the maximum number of crawling threads that
can be used when crawling.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  Use the following command: 


       


       
      SearchCellConfig.setMaxCrawlerThreads(String maxThreadNumber)
      




       
      


       Specifies the maximum number of seedlist threads that can be
used when crawling. By default, the value is set to 2.





       This
command takes a single argument that specifies the number of threads
allowed.





       For example:


      SearchCellConfig.setMaxCrawlerThreads("3")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    


     
    Related tasks
    

  •  Reloading the Search application

  •   Configure the number of indexing threads

  •  Performing a background crawl

  •   Enable indexing resumption

  •   Create work managers for Search




     Configure the number of indexing threads
    





     Edit settings in the search-config.xml file
to specify the maximum number of threads used when indexing.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





By default, the maximum number of threads allowed when indexing
is 1, however you can change this value by modifying the search-config.xml file.
When you change the maximum number of indexing threads, you might
also need to adjust the thread settings for the SearchIndexingWorkManager
on each node. The Search application will use whichever setting is
lower. For more information about updating Search work managers, see Updating
Search work manager settings.

    


     To update the maximum number of threads that can be used
when indexing.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  Enter the following command: 


       


       
      SearchCellConfig.setMaxIndexerThreads(String maxThreadNumber)
      




       
      


       Specifies the maximum number of indexer threads that can be
used when indexing. By default, the value is set to 1.





       This
command takes a single argument that specifies the number of threads
allowed.





       For example:


      SearchCellConfig.setMaxIndexerThreads("3")
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    



    Related
    

  •  The indexing process


    

  •   Configure the number of crawling threads

  •   Create work managers for Search




    Set the timeout for seedlist requests
    

    


     You can set the default timeout for seedlist requests by
creating an IBM WebSphere Application Server environment
variable and specifying the required value of the timeout.




By default, seedlist requests time out after 240 seconds.
This default setting overrides the timeout for server-to-server requests
that is defined in LotusConnections-config.xml,
which is 60 seconds. You can override the default seedlist request
timeout by creating a WebSphere Application Server variable named SEARCH_SEEDLIST_TIMEOUT and setting the required
value of the timeout in milliseconds.

    


     
      


       
    1.   Use an administrator ID, log in to the WebSphere Application Server Integrated
Console associated with the profile to which you installed IBM Connections. If you installed
the applications to multiple WebSphere Application Server profiles, log in to the console associated with the appropriate
profile. 





       
    2.  Expand Environment and click WebSphere
variables.





       
    3.  Select the relevant cell from the Scope drop-down
list and click New.





       
    4.  Enter SEARCH_SEEDLIST_TIMEOUT in
the Name field.





       
    5.  Enter a value in milliseconds in the Value field.





       
    6.  Enter a description of the variable in the Description field,
and then click OK.





       
    7.  Stop the affected servers and start those servers again
to put the variable configuration change into effect. If the change you made affects a node, you must stop and restart all
of the servers on that node. Similarly if the change you made affects
a cell, you must stop and restart all of the servers in that cell.


        For a high-availability deployment, stop and start the servers in turn
to ensure that the Search application is still available to your users.



    


     
    Related tasks
    

  •   Change WebSphere Application Server environment variables


     

  •  WebSphere Application Server environment variables




    Tuning social analytics indexing
    





     Use a SearchCellConfig command to configure the number
of iterations used by the different jobs involved in the social analytics
indexing process.


     


     When using administrative commands, you
must use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for details.





The social analytics indexing process includes a number of
jobs. The work for these jobs is divided up based on iterations. To improve performance, you can configure the number of iterations specified
for a particular job based on the needs of your deployment. For example,
reducing the number of iterations results in faster performance but
is more memory-intensive.


     For more information about the social
analytics indexing jobs, see Add scheduled tasks for the social analytics widgets.


    


     To tune the social analytics indexing process, complete
the following steps.


     
      


       
    1.  Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager: 


      app_server_root\profiles\dm_profile_root\bin
      

      ...where app_server_root is
the WebSphere Application Server installation directory and dm_profile_root is
the Deployment Manager profile directory, typically dmgr01.


       You must start the client from this directory or subsequent commands that
you enter do not execute correctly.






       
    2.  After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter: 


      execfile("searchAdmin.py")
      
 If prompted to specify a service to connect to, type 1 to pick
the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a
local file path, you must pick the node where the file is stored.


       When
the command is run successfully, the following message displays: 


      Search Administration initialized
      







       
    3.  Check out the Search cell-level
configuration file, search-config.xml, using
the following command: 


       SearchCellConfig.checkOutConfig("working_dir",
"cellName")





       where:


       
        


         
      •  working_dir is the temporary directory to which
you want to check out the cell level configuration file. This directory
must exist on the server where you are running the wsadmin client.
Use forward slashes to separate directories in the file path, even
if you are using the Microsoft Windows operating system.


          AIX and Linux only: The directory must grant write
permissions or the command will not run successfully.






         
      •  cellName is the name of the cell that the Search
node belongs to. This argument is required. It is also case-sensitive,
so type it with care. If you do not know the cell name, you can determine
it by typing the following command in the wsadmin command processor:


         print
AdminControl.getCell()



      
For example:


      SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
      







       
    4.  Use the following command: 


       


       
      SearchCellConfig.setSandIndexerTuning(String indexer, Int iterations)
      




       
      


       Sets the number of iterations used by a specified social analytics
job.





       This command takes the following arguments: 


       
        


         
      •  indexer. A string that specifies the name of the social analytics
indexing job. The following values are valid: evidence, graph, manageremployees,
and tags.





         
      •  iterations. An integer that specifies the number of iterations
for the specified social analytics indexing job.


      






       For example:


      SearchCellConfig.setSandIndexerTuning("manageremployees",200)
SearchCellConfig.setSandIndexerTuning("graph",400)
      


      

      







       
    5.  Check in the updated search-config.xml configuration
file using the following wsadmin client command: 


       SearchCellConfig.checkInConfig()






       
    6.  To exit the wsadmin client, type exit at
the prompt.





       
    7.  Stop the server or servers hosting the Search
application, delete the index, and then restart the Search servers. The next time the scheduled task runs, it recreates the index.


    


     
    Related tasks
    

  •  Add scheduled tasks for the social analytics service


     

  •  SearchCellConfig commands




     Verify that Search is crawling regularly
    





     Crawling is the process of accessing and reading content
from each application to create entries for indexing. You can verify
that the Search application is crawling on a regular basis by checking
for specific log messages in the SystemOut.log file.

    To verify that Search is crawling on a regular basis, open
the SystemOut.log file that corresponds to the application server instance on which Search is running and look for
the following log messages: 


    CLFRW0297I: Search is starting to crawl the {0} component
    



    CLFRW0294I: Search has finished crawling the {0} component
    

    ...where
{0} is the name of an IBM Connections application. Crawling refers to the persistence of the seedlists to
disk.


     When Search is crawling as expected, these messages are available
for each of the IBM Connections applications installed and configured as part of the scheduled
crawling task. By default, this task is scheduled to run every 15
minutes and it includes all the IBM Connections applications installed.





     You should also see the following log messages in the SystemOut.log file: 


    CLFRW0042I: IBM Connections indexing task {0} fired event TaskNotificationInfo.FIRING
    



    CLFRW0042I: IBM Connections indexing task {0} fired event TaskNotificationInfo.FIRED
    



    CLFRW0042I: IBM Connections indexing task {0} fired event TaskNotificationInfo.SCHEDULED
    

    ...where
{0} is the name of the scheduled task, for example, 15min-search-indexing-task.





     These
informational messages refer to the current status of the scheduled
task. The FIRING message is printed before the messages CLFRW0297I
and CLFRW0294I. The FIRED and SCHEDULED messages are printed after
the messages CLFRW0297I and CLFRW0294I.





     Indexing in the CLFRW0588I
and CLFRW0576I messages refers to the iteration through the persisted
seedlists:


    CLFRW0588I: Search is starting to index the {0} component.
CLFRW0576I: Search has finished indexing the {0} component.
    






     For example: 


    [7/11/12 15:46:00:674 IST] 0000004c IndexingNotif I   CLFRW0042I: IBM Connections scheduled task 15min-search-indexing-task fired event TaskNotificationInfo.FIRING
[7/11/12 15:46:00:755 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the blogs component.
[7/11/12 15:46:00:777 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the forums component.
[7/11/12 15:46:00:795 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the wikis component.
[7/11/12 15:46:01:676 IST] 00000052 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the blogs component.
[7/11/12 15:46:01:686 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the communities component.
[7/11/12 15:46:01:728 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the blogs component.
[7/11/12 15:46:01:764 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the blogs component.
[7/11/12 15:46:02:276 IST] 00000053 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the forums component.
[7/11/12 15:46:02:299 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the files component.
[7/11/12 15:46:02:325 IST] 00000052 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the wikis component.
[7/11/12 15:46:02:327 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the forums component.
[7/11/12 15:46:02:355 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the forums component.
[7/11/12 15:46:02:375 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the dogear component.
[7/11/12 15:46:02:414 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the wikis component.
[7/11/12 15:46:02:435 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the wikis component.
[7/11/12 15:46:02:811 IST] 00000053 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the communities component.
[7/11/12 15:46:02:824 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the profiles component.
[7/11/12 15:46:02:835 IST] 00000052 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the files component.
[7/11/12 15:46:02:852 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the communities component.
[7/11/12 15:46:02:876 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the communities component.
[7/11/12 15:46:02:901 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the activities component.
[7/11/12 15:46:02:914 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the files component.
[7/11/12 15:46:02:936 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the files component.
[7/11/12 15:46:03:334 IST] 00000053 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the dogear component.
[7/11/12 15:46:03:342 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the status_updates component.
[7/11/12 15:46:03:363 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the dogear component.
[7/11/12 15:46:03:375 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the dogear component.
[7/11/12 15:46:03:483 IST] 00000052 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the profiles component.
[7/11/12 15:46:03:493 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleCrawling CLFRW0297I: Search is starting to crawl the calendar component.
[7/11/12 15:46:03:523 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the profiles component.
[7/11/12 15:46:03:555 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the profiles component.
[7/11/12 15:46:04:444 IST] 00000053 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the activities component.
[7/11/12 15:46:04:478 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the activities component.
[7/11/12 15:46:04:490 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the activities component.
[7/11/12 15:46:04:864 IST] 00000053 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the calendar component.
[7/11/12 15:46:04:889 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the calendar component.
[7/11/12 15:46:04:901 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the calendar component.
[7/11/12 15:46:04:909 IST] 00000052 CrawlingWorkL I com.ibm.connections.search.process.work.CrawlingWorkListener workCompleted CLFRW0294I: Search has finished crawling the status_updates component.
[7/11/12 15:46:04:947 IST] 0000004c WorkScheduler I com.ibm.connections.search.process.WorkScheduler scheduleIndexing CLFRW0588I: Search is starting to index the status_updates component.
[7/11/12 15:46:04:958 IST] 00000058 IndexingWorkL I com.ibm.connections.search.process.work.IndexingWorkListener workCompleted CLFRW0576I: Search has finished indexing the status_updates component.
[7/11/12 15:46:05:009 IST] 0000004c IndexingNotif I   CLFRW0042I: IBM Connections scheduled task 15min-search-indexing-task fired event TaskNotificationInfo.FIRED
[7/11/12 15:46:05:014 IST] 0000004c IndexingNotif I   CLFRW0042I: IBM Connections scheduled task 15min-search-indexing-task fired event TaskNotificationInfo.SCHEDULED
    






     In
a deployment where there is a single Search node: No further action
is required.





     In a deployment with multiple Search nodes:
Note that only one node in the cluster does the crawling although
all the nodes do the incremental index building based on the crawling
that Search node does. Because the crawling is performed by a single
Search node, you only see the log messages on that node in the cluster.



     
    Related tasks
    

  •  Performing a background crawl

  •   Enable indexing resumption




     Verify Search index creation
    





     You can confirm that the initial Search index creation
has completed successfully by checking for the presence of specific
files in the index directory.

    


     To verify that the initial index creation is complete:
    Check that the INDEX.READY and CRAWLING_VERSION files
are present in the index directory. 


     By default, the Search index is stored in the search/index subdirectory
of the IBM Connections data directory defined at install time, for
example, on Linux, /opt/IBM/Connections/data/local/search/index. 





     Initial
index creation is complete when both files are present in the index
directory. Note that this means that the Search index is fully built;
the social analytics index is not yet built.





     If your deployment
has a single Search node only: No further action is required.





     If
your deployment has multiple Search nodes: Verify the Search
index was successfully copied to the remaining nodes.



     
    Related tasks
    

  •   Restore a Search index in a single-node environment

  •   Restore a Search index in an environment with multiple nodes

  •   Restore a Search index without restarting individual nodes




     Disable
trash bin in Wikis
    





     Change an attribute in the configuration
properties to
disable the trash bin in Wikis. It is enabled by default.


     


     To edit configuration files, you must
use the IBM WebSphere Application Server wsadmin client.
See  Start the wsadmin
client for information about how to start the wsadmin command-line
tool.








     Perform the following steps to disable
trash bin in Wikis:


    


     
      


       
    1.  Start the wsadmin client.





       
    2.  Start the Wikis Jython script interpreter.


       
        


         
      1.  Use
the following command
to access the Wikis configuration files: 


        execfile("wikisAdmin.py")
        
If
you are asked to select a server, you can select any server.





         
      2.  Check out the Wikis
configuration
files : 


         WikisConfigService.checkOutConfig("working_directory",
"cell_name")





         where:


         
          


           
        •  working_directory is
the temporary working
directory to which the configuration XML and XSD files are copied.
The files are kept in this working directory while you make changes
to them.


            AIX and Linux only: The directory must
grant write permissions or the command will not run successfully.






           
        •  cell_name is the name of the WebSphere Application Server cell hosting
the IBM Connections application.
This argument is required. If you do not know the cell name, you can
determine it by typing the following command in the wsadmin command
processor:


           print AdminControl.getCell()



        
For example:


        WikisConfigService.checkOutConfig("/opt/my_temp_dir", "CommServerNode01Cell")
        




      






       
    3.  Open wikis-config.xml.





       
    4.  In the <recyclebin> element,
specify
the enabled attribute as false.


    


    Example
    For example:


     ....
 <recyclebin enabled="false">
 </recyclebin>
....
    



     

  •  Wikis configuration properties




     Configure authorization for foreign bus connections
    





     Configure authorization for foreign bus connections to
enable buses to forward messages to foreign buses. You must perform
this task using the wsadmin client.


     


     To configure authorization for foreign
bus connections, you must use the WebSphere Application Server wsadmin client. See Starting
the wsadmin client for details.





You can authorize foreign bus connections by running the addUserToForeignBusRole command
in the wsadmin client. The command needs to be run on both servers
involved in the link. 


      You must take care to connect to the correct
server when running the command.





     To configure authorization
for foreign bus connections:


    


     
      


       
    1.  Run the following command on the application server that has
a foreign bus defined for the news repository server: 


      AdminTask.addUserToForeignBusRole('[-bus <busName>
 -foreignBus <foreignBusName> -role <roleName>
 -user <userName>]')
      
The command takes the following parameters:



      Table 147. Parameters for the addUserToForeignBusRole
command

      Parameter
    Description




      - bus
    The name of the bus on the server.



      - foreign bus
    The name of the foreign bus.



      - role
    This is always set to Sender.



      - user
    The user name defined in step 1 of the topic, Preparing
to create bus links.



      

For example:


      AdminTask.addUserToForeignBusRole('[-bus Connections_ActivitiesServer_Bus -foreignBus Connections_NewsServer_Bus -role Sender -user john_smith@example.com]')
AdminConfig.save()
      






       
    2.   Use the wsadmin tool, connect to the server hosting the news repository and run the command from step 1. 


       For example:


      AdminTask.addUserToForeignBusRole('[-bus Connections_NewsServer_Bus -foreignBus Connections_ActivitiesServer_Bus -role Sender -user john_smith@example.com]')
AdminConfig.save()
      




    

     
    What to do next
    Repeat the steps above for every application server in your configuration
to link it to the server hosting the news repository.


     
    Related tasks
    

  •   Update the messaging bus configuration when the connectionsAdmin user ID changes




     Configure
J2C authentication for Search
    

    


     When you install IBM Connections,
the installation wizard automatically configures authentication and
authorization for each application. Crawling content for indexing
occurs over an internal REST API interface, and the credentials used
are retrieved from the connectionsAdmin J2C authentication alias that
is configured during installation. The user ID from the credentials
is also added to the search-admin J2EE role for each application.
If you want to further secure the IBM Connections environment, you can override this authentication alias on an application-by-application
basis.




Search
functionality depends on the ability of IBM Connections to index the data that is stored
by each application. The JAAS/J2C alias that is configured at installation time allows automatic authentication for the user account that you
assigned to the alias. This user account is also mapped to the Search
administrator search-admin role for the application that you are configuring.


     To override the connectionsAdmin J2C authentication alias for a specific IBM Connections application, you
need to define a J2C authentication alias for that application using
the IBM WebSphere Application Server Integrated
Solutions Console. For information about how to define a search J2C
authentication alias for an application, see Switching to unique
administrator IDs for system level communication.



     
    Related tasks
    

  •   Switch to unique administrator IDs for system level communication

  •   Change references to administrative credentials


     

  •  Roles




     Enable single sign-on between applications
    





     Enable single sign-on between all your IBM Connections applications.


     


     Ensure that the realm name for federated repositories is
identical on each node in your deployment. The base entry and the DN of the base entry must also be identical on each server.





     Configure the SSO domain to be the common domain for all nodes.
Verify that you can access each IBM Connections application from a web browser.


      


     
      


       
    •  If you are enabling SSO
between IBM Connections and
a product that is deployed on a pre-6.1 version of WebSphere Application Server, you must
first complete the steps described in the Enabling single sign-on
for stand-alone LDAP topic.


    









     When your IBM Connections applications are installed on different nodes, you can configure IBM Connections to allow single
sign-on (SSO) authentication between the applications. When SSO is
enabled, users can log into one application and then switch to other
applications without having to authenticate again.





     To set up
SSO, ensure that all the nodes in your deployment share the same LTPA
keys by exporting the keys from one node and importing them into the other nodes.





     To set up SSO between applications
on each node where IBM Connections applications are installed:


    


     
      


       
    1.  Enable SSO:


       
        


         
      1.  Log into the WebSphere Application Server Integrated Solutions Console as
an administrator and expand Security > Global security.





         
      2.  Expand web security and click single sign-on (SSO).





         
      3.  Enter the SSO domain name in the Domain name field. Include a dot (.) before the domain name. For example: 


        .enterprise.example.com
        



      






       
    2.  Import the LTPA key file:


       
        


         
      1.  Under Authentication, click LTPA.





         
      2.  Under Cross-cell single sign-on, provide values for
the following fields: 


         
          


           
        •  Password: Enter the password that you used for the key file when
you exported it.





           
        •  Fully qualified key file name: Set the name of the key file.


        






         
      3.  Click Import keys.


      






       
    3.  When you have regenerated the LTPA keys, clear the schedules
in the cluster. For more information, see the Clearing all scheduled
tasks topic.





       
    4.  Restart all the nodes.


    

     
    What to do next
    Periodically, WebSphere Application Server automatically regenerates LTPA keys. To maintain
SSO, disable this default regeneration setting. For security purposes,
however, consider manually regenerating the LTPA keys from time to
time.


     
    Related tasks
    

  •   Use the Profiles database as the user directory

  •  Hide email addresses

  •  Expose email addresses