Upgrading user information from a schema repository to a user database

When making changes to user information in a schema repository, in order to propagate the changes from the schema repository to the user databases you must upgrade the user databases with one of the following methods:
  • UpgradeInfo method of the User object

    Upgrades one user (that is, one User object) in all databases the user is subscribed to. It does not update group memberships, and only updates user properties such as is-active, e-mail, full name, and phone.

  • UpgradeMasterUserInfo method of the Database object

    Upgrades all user and group information for one database, including the user and groups records and group memberships.

For existing users, you can propagate changes with either of the following methods:
  • Get a list of user databases in the schema repository, iterate through each one calling the UpgradeMasterUserInfo method of the Database object.
  • Call the UpgradeInfo method of the User object.

For newly created users, if you create new HCL Compass users by using the CreateUser method of the AdminSession object and set privileges, password, and other user information that you want propagated from a schema repository to user databases, you must use the UpgradeMasterUserInfo method of the Database object (by iterating through a list of user databases in the schema repository and calling UpgradeMasterUserInfo for each user database).

The UpgradeInfo method was introduced (in version 2003.06.00) to provide a way to propagate user and group information from the schema repository to all affected user databases. However, the method only works for an existing user and not for a newly-created user.

Note: You cannot update Group membership using the UpgradeInfo method of the User object. Only the properties that can be set by the methods of the User object are updated by calling UpgradeInfo. Group membership is changed with the methods of the Group object, and the UpgradeMasterUserInfo method of the Database object must be used to update Group information settings.