3.2.1 Managing Users

After you install GoldenGate Stream Analytics, it is important to authenticate and manage users who use the application.

User details are stored in a database. When you create a GGSA schema at the time of installation, the following database tables are populated with one record in each table:

  • osa_users — table containing the users

  • osa_user_roles — table containing the user names and their associated roles

When you execute a query to pull in all the data from the osa_users table, you can see the following: 

select * from osa_users;
+----+----------+--------------------------------------+ 
| id | username | pwd                                  | 
+----+----------+--------------------------------------+ 
|  1 | osaadmin | 7wKx1wn3sC41KWo7nIAkCbF8CibQLv3Kj1RcKQgp0vUyNQ@A | 
+----+----------+--------------------------------------+

where osaadmin is the pre-configured user along with the encrypted password.

When you execute a query to pull in all the data from the osa_user_roles table, you can see the following: 

select * from osa_user_roles;
+---------+---------+
| user_id | role_id |
+---------+---------+
|       1 |       1 |
+---------+---------+

where role_id of value 1 indicates that the user is an administrator.

3.2.1.1 Adding Users

Though you can continue using Oracle GoldenGate Stream Analytics through the pre-configured user, it is a best practice to create your own users and delete the default pre-configured user.

When you add a user, it is highly recommended, though not mandatory, to obfuscate or encrypt the password. You can use the utility provided with the application server (Jetty) to encrypt the password.

Add Users Through User Interface

You can add/create users through the Oracle GoldenGate Stream Analytics application user interface.

To add a new user:

  1. Go to System Settings.

  2. Under the User Management tab, click Add user.

  3. Enter details in the Username, Password, and Confirm Password fields.

  4. click Create.

    You can see the new user along with the predefined user in the list of available users.

Repeat these steps for as many users as you need, based on your requirement. If you try a user with the same name as that of an existing user, an error A user profile with the user name <username> already exists. Please specify another user name. pops up.

Add Users Through Code

To add a new user:

  1. Generate a secure password following the steps provided in Generating Secure Password.
  2. Connect to the database using the database user credentials that you have configured in /osa-base/etc/osa-datasource.xml.
  3. Insert a record into the osa_users table using the encrypted password:
    insert into osa_users (id,username,pwd) values (2,'NewUser','7wKx1wn3sC41KWo7nIAkCbF8CibQLv3Kj1RcKQgp0vUyNQ@A');
  4. Insert a record into the osa_user_roles table using the following command:
    insert into osa_user_roles (user_id, role_id) values (2,1);

    Important:

    Currently, Oracle GoldenGate Stream Analytics supports only one user role, i.e, the administrator role. So the role_id value must always be 1.
You can now login to Oracle GoldenGate Stream Analytics as NewUser using <password>. Repeat these steps to create as many users as you require.

3.2.1.2 Changing Password

Change Password Through User Interface

To change a user password:

  1. Go to System Settings.

  2. Click the User Management tab.

  3. Click Change Password next to the required user within the list of available users and then provide a value for the new password and click Save.

Change Password Using Code

To change a user password:

  1. Generate a secure password by following the steps in Generating Secure Password.
  2. Update the relevant record in the osa_users table. For example:
    update osa_users set pwd='7wKx1wn3sC41KWo7nIAkCbF8CibQLv3Kj1RcKQgp0vUyNQ@A' where username='NewUser';
    This command updates the password for the NewUser.
Remember to use your updated password the next time you login with NewUser.

3.2.1.3 Removing Users

You may want to remove users when you no longer need them.

Before you proceed to delete any user, make a note of the following:

  • If a user who owns draft pipelines is deleted, then the pipelines are either migrated to the current user or deleted, based on the selection you make at the time of deletion.

  • If you attempt to delete yourself, all your draft pipelines are deleted after you confirm. The current user session is invalidated and you will be signed out of the application immediately.

Delete Users Through User Interface

To delete a user:

  1. Go to System Settings.

  2. Click the User Management tab.

  3. Click Delete next to the required user within the list of available users and then click OK within the confirmation dialog.

Delete Users Through Code

To delete a user:

  1. Execute the following command from SQLPLUS or SQLDeveloper tools to remove a user:
    delete from osa_users where id=2;
    This command deletes the user with the id value as 2, i.e, the second user in the database.
  2. Execute the following command to delete the user role corresponding to the user in the above step:
    delete from osa_user_roles where user_id=2;