Home

 

Synchronize user identification data between Wikis and the LDAP directory

Use WikisMemberService commands to synchronize member IDs between Wikis and the user

Each IBM Lotus Connections feature has a local database that stores users to avoid costly lookups on the server user The Wikis feature automatically synchronizes the local with the server using ID values. If all users have IDs that never change, then Wikis synchronizes the local and server directories automatically. Perform the steps in this topic to synchronize the database and using a value other than ID.

If you have configured all Lotus 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 ofuser.synchTask.enabled andgroup.synchTask.enabled in the topic Wikis configuration properties.

If you are using the Profiles service, first synchronize the ExtId values in the Profiles database with the user 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.

The commands used to synchronize member IDs between Wikis and the user 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 script with the following command:

  3. Network deployment:

      execfile("profile_root/config/bin_lc_admin/ wikisAdmin.py")
      

  4. Use the commands below to change the internal IDs of users.


    WikisMemberService administrative commands

    Command Description

    WikisMemberService.syncAllMemberExtIds()

    Synchronizes all user and group information in the Wikis database with the user For each user or group, this service queries the user server by login name (or names) to retrieve updated information, such as ID, display name, and e-mail address.

    Wikis automatically synchronizes the database with the periodically by ID, so running this command is not necessary unless you want to synchronize at a particular time.

    Synchronization time varies depending on the number of people in the Wikis database. On average, it takes eight minutes to update 500 users. For large databases, run this process overnight.

    This command does not take any parameters.

    WikisMemberService.syncMemberExtIdByEmail(string emailAddr)

    Synchronizes one member's information in the Wikis database with the user The command is essentially the same as syncAllMemberExtIds(), but applied to a single member, and the user server is queried by the specified e-mail address. Any out-of-sync information is updated.

    Wikis automatically synchronizes the database with the periodically by ID, so running this command is not necessary unless you want to synchronize using an e-mail address, or you want to synchronize at a particular time rather than waiting for the periodic automatic synchronization. Parameters:

      emailAddr

      The member's e-mail address as a string.

    Example:

      WikisMemberService.syncMemberExtIdByEmail(
       "jdoe@company.com")
      

    WikisMemberService.syncMemberExtIdByLogin(string loginName)

    Synchronizes one member's information in the Wikis database with the user The command is essentially the same as syncAllMemberExtIds(), but applied to a single member. Any out-of-sync information is updated.

    Wikis automatically synchronizes the database with the periodically by ID, so running this command is not necessary unless you want to synchronize using a login name, or you want to synchronize at a particular time rather than waiting for the periodic automatic synchronization. Parameters:

      loginName

      The member's login name as a string.

    Example:

      WikisMemberService.syncMemberExtIdByLogin("John Smith")
      

    WikisMemberService.syncBatchMemberExtIdsByEmail(string emailFile)

    Synchronizes user information in the Wikis database with the user The users are specified by e-mail address in a text file. The file is specified in the parameter.

    The file must contain a list with one valid e-mail address per line. Create the file and save it in a that is local to the server where you are running the wsadmin processor.

    This command is essentially the same as syncAllMemberExtIds() but applied to a list of members, and the user server is queried by e-mail addresses. Any out-of-sync information is updated.

    Wikis automatically synchronizes the database with the periodically by ID, so running this command is not necessary unless you want to synchronize using a login name, or you want to synchronize at a particular time rather than waiting for the periodic automatic synchronization. Parameters:

      emailFile

      The full path to the text file, as a string.

    Example:

      WikisMemberService.syncBatchMemberExtIdsByEmail(".../dirA/dirB/emailFile.txt")
      

    WikisMemberService.syncBatchMemberExtIdsByLogin(string loginFile)

    Synchronizes user information in the Wikis database with the user The users are specified by login ID, in a text file. The file is specified in the parameter.

    The file must contain a list with one valid login ID per line. You must create the file and save it in a that is local to the server where you are running the wsadmin processor.

    This command is essentially the same as syncAllMemberExtIds() but applied to a list of members, and the user server is queried by login IDs. Any out-of-sync information is updated.

    Wikis automatically synchronizes the database with the periodically by ID, so running this command is not necessary unless you want to synchronize using a login name, or you want to synchronize at a particular time rather than waiting for the periodic automatic synchronization. Parameters:

      loginFile

      The full path to the text file, as a string.

    Example:

      WikisMemberService.syncBatchMemberExtIdsByLogin("/opt/Wikis/update.txt")
      

    WikisMemberService.getById(string id)

    Returns information about a user specified by an 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 e-mail address.

      • isOrphan: Returns true if the user is in the database, but not the

      • 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

      • directoryGroupLastUpdate: The last time this user's group membership was synchronized from the

      • communityLastUpdate: The last time this user's Community membership was synchronized.

    WikisMemberService.getByExtId(string externalId)

    Returns information about a user specified by an external 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 ID. This can be any parameter in the user that you have configured as the 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 e-mail address.

      • isOrphan: Returns true if the user is in the database, but not the

      • 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

      • directoryGroupLastUpdate: The last time this user's group membership was synchronized from the

      • communityLastUpdate: The last time this user's Community membership was synchronized.

    WikisMemberService.getByEmail(string email)

    Returns information about a user specified by an e-mail address. The command only searches the Wikis database, so it only returns users who have logged in at least once. Parameters:

      email

      The e-mail 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 e-mail address.

      • isOrphan: Returns true if the user is in the database, but not the

      • 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

      • directoryGroupLastUpdate: The last time this user's group membership was synchronized from the

      • communityLastUpdate: The last time this user's Community membership was synchronized.


Administer Wikis

 

Related tasks

Synchronize IDs between LDAP and the feature databases

Start the wsadmin client

Synchronize user data between Profiles and the LDAP directory

 

Related reference


Wikis configuration properties


+

Search Tips   |   Advanced Search