Disable the social analytic widgets for individual users 

Use SearchService commands to control whether specific users are included or excluded from the social analytics service. The social analytics service is enabled for all users by default.


Before you begin


To edit configuration files, use the IBM WAS wsadmin client. See Starting the wsadmin client for details.


About this task


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:

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.


Procedure


To enable or disable the social analytic widget service on a per-user basis...

  1. From the dmgr host:

      cd $DMGR_PROFILE/bin
      ./wsadmin.sh -jython
      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, pick the node where the file is stored.

  2. 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")

      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")

  3. To 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")

      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")


Parent topic

Administer Search

Related concepts
Scheduling tasks

Related tasks
Disable the social analytics service

Related reference
SearchService commands


December 6, 2011
   

 

Dec 6, 2011 2:35:32 PM Made the two variable names italic. 2 Dec 6, 2011 2:33:53 PM Removed angle brackets surrounding variable names because cannot add a... 1

});