Adding realm support on Windows
A realm is a group of users from
one or more user registries that form a coherent group within IBM® WebSphere® Portal Express.
Realms allow flexible user management with various configuration options.
A realm must be mapped to a Virtual Portal to allow the defined users to log
in to the Virtual Portal.
Before creating your realm(s), add
all LDAP user registries and/or database user registries, that you will use
to create your realms, to the federated repository. If you are going to create
multiple realms, create all required base entries within your LDAP
user registries and/or database user registries. All base entry names must
be unique within the federated repository.
Perform the following steps to add realm support to your
user registry model:
- Use a text editor
to open the wkplc.properties file, located
in the wp_profile\ConfigEngine\properties directory.
- Required: For realmName,
type the realm name or leave blank to update the default realm.
- Optional: Enter only the
following optional parameters in the wkplc.properties file
under the realm configuration heading:
- For securityUse, type active to
use the virtual realm in now, type inactive to use
the virtual realm later, or type nonSelectable to never
use the virtual realm.
- For delimiter, type the
delimiter to use for this realm; the default value is /.
- For addBaseEntry, type the name of the
base entry to add to this realm.
- Save your changes to the wkplc.properties file.
- Run the ConfigEngine.bat wp-create-realm task, located
in the wp_profile\ConfigEngine directory to add a new realm to the
Virtual Member Manager configuration. To create multiple realms, ensure that
your federated repository contains the required unique base entries. Then
update the wkplc.properties file with the base entry
information and rerun the wp-create-realm task. Repeat
these steps until all realms are created.
- Optional: Perform the following steps to add
additional base entries to the realm configuration; for example, if you had
two additional base entries (base entry 1 and base entry 2) to add to the
realm you just created, you would update the wkplc.properties file with the
information from base entry 1 and then run this task. Then you would update
the properties file with the information for base entry 2 and then run this
task:
- Use a text editor
to open the wkplc.properties file, located
in the wp_profile\ConfigEngine\properties directory.
- Enter the following
parameters in the wkplc.properties file under the realm
configuration heading:
- For realmName, type
the name of the realm configuration where you want to add the base entry.
- For addBaseEntry,
type the name of the base entry you want to add to the realm configuration.
- Save your changes to the wkplc.properties file.
- Run the ConfigEngine.bat
wp-add-realm-baseentry task, located
in the wp_profile\ConfigEngine directory to
add an additional LDAP base entries to the realm configuration.
- Perform the following steps to stop and restart
the server1 and WebSphere_Portal servers:
- Open a command prompt and change to the wp_profile_root\bin directory.
- Enter the stopServer.bat server1
-user admin_userid -password admin_password command
to stop the WebSphere
Application Server.
- Enter the stopServer.bat WebSphere_Portal
-user admin_userid -password admin_password command
to stop the WebSphere Portal Express server.
- Enter the startServer.bat server1 command.
- Enter the startServer.bat WebSphere_Portal command.
- Optional: Perform the following steps to set the
realm you created as the default realm:
- Use a text editor
to open the wkplc.properties file, located
in the wp_profile\ConfigEngine\properties directory.
- For defaultRealmName,
type the realmName property value you want to use as
the default realm.
- Save your changes to the wkplc.properties file.
- Run the ConfigEngine.bat
wp-default-realm task, located
in the wp_profile\ConfigEngine directory to
set this realm as the default realm.
- Optional: Perform the following steps to stop and restart
the server1 and WebSphere_Portal servers:
- Open a command prompt and change to the wp_profile_root\bin directory.
- Enter the stopServer.bat server1
-user admin_userid -password admin_password command
to stop the WebSphere
Application Server.
- Enter the stopServer.bat WebSphere_Portal
-user admin_userid -password admin_password command
to stop the WebSphere Portal Express server.
- Enter the startServer.bat server1 command.
- Enter the startServer.bat WebSphere_Portal command.
- Optional: Perform the following steps to query a realm
for a list of its base entries:
- Use a text editor
to open the wkplc.properties file, located in the profiles/wp_profile/ConfigEngine/properties directory.
- For realmName,
type the realm name or leave blank to update the default realm.
- Save your changes to the wkplc.properties file.
- Run the ConfigEngine.sh
-profileName profile_root wp-query-realm-baseentry task, located
in the profiles/wp_profile/ConfigEngine directory to list the base entries
for a specific realm.
- Enter the following parameters in
the wkplc.properties file under the support entity types
configuration heading to configure a default parent per entity type and realm:
- For realmName, type the realm name or leave
blank to update the default realm.
- For realm.personAccountParent, realm.groupParent,
and realm.orgContainerParent, type the name of the base
entry that will be used as the default parent for the respective entity type.
- Save your changes to the wkplc.properties file.
- Run the ConfigEngine.bat wp-modify-realm-defaultparents task, located
in the wp_profile\ConfigEngine directory to update the default parents
per entity type and realm.
- Perform the following steps to stop and restart
the server1 and WebSphere_Portal servers:
- Open a command prompt and change to the wp_profile_root\bin directory.
- Enter the stopServer.bat server1
-user admin_userid -password admin_password command
to stop the WebSphere
Application Server.
- Enter the stopServer.bat WebSphere_Portal
-user admin_userid -password admin_password command
to stop the WebSphere Portal Express server.
- Enter the startServer.bat server1 command.
- Enter the startServer.bat WebSphere_Portal command.
Parent topic: Configuring the default federated repository on Windows
|
|
|