Configuring the remote service on WebSphere Application Server

Configure the users and Java™ options for the remote services on IBM® WebSphere® Application Server 7.0 or 8.0 by using these steps.

Before you begin

You must install WebSphere Application Server 7.0 or 8.0, Rational® Publishing Engine, and the Web Services application, and then deploy the Web Services application before you can configure the users and Java options.

About this task

To configure the remote services, you can:

Configuring users and user roles

About this task

Table 1. Remote services user roles
Role Capabilities
Document generation user (rpe_docgen_user)
  • Can generate documents remotely or locally from the client applications
  • Can view output files and logs about their document generation jobs
Document generation administrator (rpe_docgen_admin)
  • Can generate documents remotely or locally from the client applications
  • When used with the rpe_monitor_admin role, can view output files and logs from the document generation jobs initiated by any user
Central Management component user (rpe_library_user)
  • Can view public assets from the Document Studio application
  • Can use public assets to design templates
Central Management component contributor (rpe_library_contributor)
  • Can view assets from the Document Studio application
  • Can use assets to design templates
  • Can submit assets from the Document Studio application
  • Can modify their existing assets from the Document Studio application
Central Management component administrator (rpe_library_admin)
  • Can view the assets that are created by any user from the Document Studio application
  • Can use assets that are created by any user to design templates
  • Can submit assets from the Document Studio application
  • Can modify the existing assets that are created by any user from the Document Studio application
  • Can create assets in the Central Management component administrative user interface
  • Can modify existing assets that are created by any user from the Central Management component administrative user interface
  • Can remove assets created by any user from the Central Management component administrative user interface
Monitor & Control component user (rpe_monitor_user)
  • Can change the state of their document generation jobs
  • Allows their document generation jobs to be monitored by users with the rpe_monitor_admin role
Monitor & Control component administrator (rpe_monitor_admin)
  • When used with the rpe_docgen_admin role, can view output files and logs from the document generation jobs initiated by any user
  • Can change the status of the document generation jobs initiated by any user

Procedure

  1. Open the administrative console in a browser. Example: http://server:port/ibm/console/logon.jsp
  2. Stop the deployed Web Services application:
    1. Click Applications > Enterprise Applications. The rpews.war application you added is listed as the application name you entered.
    2. Select the Web Services application.
    3. Click Stop.
  3. Configure the security roles:
    1. Click Users and Groups > Manage Users.
    2. Click Create and create three users: rpe_admin, rpe_contributor, and rpe_client, if you have not done so already.
    3. To associate roles with the users, navigate to Applications > Enterprise Applications > rpews.war application > Security role to user/group mapping. These are the roles you can associate with the users for each of the services, depending on which services you plant to use:
      • rpe_docgen_user
      • rpe_docgen_admin
      • rpe_library_user
      • rpe_library_contributor
      • rpe_library_admin
      • rpe_monitor_user
      • rpe_monitor_admin
      Tip:
      • See the table in the About this task section above for descriptions of each role.
      • For added security, create more than one client user and give only one the rpe_docgen_user role. The document generations that users create might contain confidential data. By creating two types of users, you can ensure that only users who have permission to view the result outputs can view them.
    4. Associate the user roles with the rpe_client users.
      1. Select rpe_docgen_user.
      2. Click Look up users.
      3. In the Available column, press the CTRL key, and then select rpe_client. Click >> to add the users to the Selected column.
      4. Click OK.
      1. Select rpe_library_user.
      2. Click Look up users.
      3. In the Search String field, enter rpe* and click Search.
      4. In the Available column, press the CTRL key, and then select rpe_client. Click >> to add the users to the Selected column.
      5. Click OK.
      1. Select rpe_monitor_user.
      2. Click Look up users.
      3. In the Search String field, enter rpe* and click Search.
      4. In the Available column, press the CTRL key, and then select rpe_client. Click >> to add the users to the Selected column.
      5. Click OK.
    5. Associate the contributor and user roles with the rpe_contributor users.
      1. Select rpe_docgen_user.
      2. Click Look up users.
      3. In the Search String field, enter rpe* and click Search.
      4. In the Available column, select rpe_contributor and click >> to add the user to the Selected column.
      5. Click OK.
      1. Select rpe_library_contributor.
      2. Click Look up users.
      3. In the Search String field, enter rpe* and click Search.
      4. In the Available column, select rpe_contributor and click >> to add the user to the Selected column.
      5. Click OK.
      1. Select rpe_monitor_user.
      2. Click Look up users.
      3. In the Search String field, enter rpe* and click Search.
      4. In the Available column, press the CTRL key, and then select rpe_client. Click >> to add the users to the Selected column.
      5. Click OK.
    6. Associate the administrator role with the rpe_admin user.
      1. Select rpe_docgen_admin.
      2. Click Look up users.
      3. In the Search String field, enter rpe* and click Search.
      4. In the Available column, select rpe_admin and click >> to add the user to the Selected column.
      5. Click OK.
      1. Select rpe_library_admin.
      2. Click Look up users.
      3. In the Search String field, enter rpe* and click Search.
      4. In the Available column, select rpe_admin and click >> to add the user to the Selected column.
      5. Click OK.
      1. Select rpe_monitor_admin.
      2. Click Look up users.
      3. In the Search String field, enter rpe* and click Search.
      4. In the Available column, select rpe_admin and click >> to add the user to the Selected column.
      5. Click OK.
    7. Click OK and Save directly to the master configuration.
  4. Start the Web Services application:
    1. Click Applications > Enterprise Applications. The rpews.war application you added is listed as the application name you entered.
    2. Select the Web Services application.
    3. Click Start. The following confirmation message displays: Application rpews.war on server server_name and node node_name started successfully.

Optional: Configuring the Monitor & Control component on a different server from the remote document generation

The document generation service uses the Monitor & Control component deployed with it automatically. To use the default Monitor & Control component, no additional configuration is required and you can continue to the next step. To use a different Monitor & Control component on another server or port than the document generation, configure these Java option flags to configure the login credentials.

Procedure

  1. Optional: Set the Java options:
    1. Expand Servers > Server Types.
    2. Click WebSphere application servers.
    3. Open the server properties by clicking the server_name.
    4. In the Server infrastructure section, expand Java and Process Management.
    5. Click Process definition.
    6. In the Additional Properties section, click Java Virtual Machine.
    7. In the Additional Properties section, click Custom properties.
    8. Click New to add the URL flag:
      • Name: com.ibm.rational.rpe.mc.url
      • Value: http://server:port/rpews/monitor
      Click OK.
    9. Click New to add the user flag:
      • Name: com.ibm.rational.rpe.mc.user
      • Value: rpe_client
      Click OK.
    10. Click New to add the password flag:
      • Name: com.ibm.rational.rpe.mc.password
      • Value: password
      Click OK.
    11. Click OK to save the changes.
  2. Test the Monitor & Control component:
    1. Log out of the WebSphere Application Server administrative console.
      Note: You must log out of the administrative console. Because basic authentication is used, only a single session per browser can exist. If you do not log out of the WebSphere Application Server administrative user, you cannot access the Rational Publishing Engine resources to which only the rpe_admin has access and you receive the following message: Error 401: Unauthorized.
    2. Open http://server:port/rpews/ui/monitor.html in a browser.
    3. Log in with the rpe_admin credentials. If it is configured correctly, you can view the user interface of the Rational Publishing Engine Monitor & Control component.
    4. Click Refresh Jobs. The current jobs display.

Results

After you complete the deployment, the Monitor & Control component administration console is available at: http://server:port/rpews/ui/monitor.html. See Managing document generation jobs in the Monitor & Control component for information on using the administration console.

What to do next

On the end user computers, specify the URL of the Monitor & Control component for a remote server. See Setting the remote services preferences.


Feedback