Configuring and deploying the task manager application for IBM Content Navigator

Product documentation


Abstract

The task manager application is a Java Platform, Enterprise Edition REST application that enables you to schedule and run tasks.

Content

Important: The task manager APIs are provided as a technology preview.

You can use the task manager APIs to create asynchronous, scheduled operations, such as:

  • Exporting a large number of documents from a repository
  • Deleting all of the documents and folders that are associated with a teamspace

After you create the tasks, you can use the task manager interface to schedule and run the tasks.

To use the task manager interface, you must configure and deploy the task manager application on your web application server. Complete the appropriate task for your environment:

Configuring the task manager application on WebSphere Application Server
To configure the task manager application, you must complete the following tasks:

    Modifying the task manager configuration script
    You must modify the task manager configuration script for your environment.
      Procedure
      To modify the configuration script:
      1. Open the task manager configuration script, WAS_taskManager.tcl, in a text editor. The configuration script is located in the taskManager/scripts subdirectory of the IBM Content Navigator installation directory.
      2. Modify the _cell parameter:
        1. Remove the comment tag from the beginning of the _cell parameter.
        2. Set the value of the _cell parameter to the name of the cell where you plan to deploy the application. You can find a list of the cells on the application server in the WebSphere_Install_Directory/WebSphere/AppServer/profiles/profile_name/server_name/installedApps directory.
      3. Modify any other parameters, such as the thread pool size, according to your needs.
      4. Save your changes to the configuration file.

    Running the configuration script
    You must run the task manager configuration script to create WebSphere resources that the task manager application needs to run. When you run the configuration script, the following resources are created:
    • A timer manager
    • A work manager
    • A mail session
      Procedure
      To run the configuration script:
      1. Open a command prompt and change to the WebSphere_Install_Directory/WebSphere/AppServer/profiles/profile_name/bin directory.

        For example, on Windows, change to the C:\Program Files\IBM\WebSphere\AppServer\profiles\AppServ01\bin directory.
      2. Enter the following command:

        wsadmin -user user_name -password password -conntype SOAP -port port_number -lang jacl -f "IBM_Content_Navigator_Install_Directory\taskManager\scripts\WAS_taskManager.tcl"

        For example, on Windows, enter the following command:

        wsadmin -user user -password password -conntype SOAP -port 8880 -lang jacl -f "C:\Program Files\IBM\ECMClient\taskManager\scripts\WAS_taskManager.tcl"

    Configuring task manager notification emails
    If you want the task manager application to send email notifications, you must configure an SMTP server in WebSphere Application Server.
      Procedure
      To configure email notifications:
      1. Log in to the WebSphere Application Server administrative console.
      2. Go to Resources > Mail > Mail sessions.
      3. Click the CNMailSession entry.
      4. In the Outgoing Mail Properties section, enter the information for your SMPT server.
      5. Save your changes to the master configuration.


    Deploying the task manager application
    You must generate the task manager application EAR file and deploy it to your web application server.
      Procedure
      To deploy the task manager application:
      1. Open the taskManager/deploy subdirectory of the IBM Content Navigator installation directory.
      2. Optional: If you have task JAR files from another application, add the JAR files to the taskManager/deploy/WEB-INF/dropins subdirectory of the IBM Content Navigator installation directory.

        Some IBM products provide JAR files that work with the task manager application.
      3. If you are deploying the task manager application in a highly available cluster environment, you must modify the config.properties file for your environment. The config.properties file is located in the taskManager/deploy/WEB-INF subdirectory of the IBM Content Navigator installation directory.

        Important: It is recommended that you do not change the database_schema_name parameter. If you do change this parameter, you must modify the database files before you import them to your database.
        1. You must modify the following parameters:
          • Set the taskManager_admin_user to the user name that you want to use as the task manager administrator.
          • Set the taskManager_admin_password to the password that you want to use for
            the task manager administrator.
          • Set the taskManager_base_URL to the URL of the cluster server where you plan to deploy the task manager application.
        2. You can modify the following parameters if you want to override the default values:
          • Set the logfile_directory to the fully qualified path of the directory where you want to store log files that are generated by the task manager application.
          • Set the taskManager_default_log_level to one of the following values. The default setting is WARNING. It is recommended that you do not set FINE, FINER, or FINEST unless you are instructed to by IBM Software Support.
            • SEVERE
            • WARNING
            • INFO
            • CONFIG
            • FINE
            • FINER
            • FINEST
          • Set the enable_heartbeat_monitoring parameter to true.
        3. Encrypt the password that you entered in the config.properties file by running the following command:

          java -jar updateUserInfo.jar fully_qualified_path_of_config.properties admin_user_name admin_password
      4. Run the create_taskManager_ear.bat or create_taskManager_ear.sh file to create the taskManagerWebWebsphere.ear file.
      5. Log in to the WebSphere Application Server administrative console.
      6. Go to Applications > Application Types > WebSphere enterprise applications.
      7. Click Install and specify the fully qualified path of the taskManagerWebWebSphere.ear file.
      8. Click Next.
      9. When prompted, select the default options to deploy the application.
      10. Save your changes to the master configuration.


    Associating users with task manager roles
    After you configure and deploy the task manager application, you must associate users and groups with the task manager roles.

    The task manager application includes the following roles:
    • TaskUsers - Users who are associated with this role can create tasks. They can also see and modify only the tasks that they create. They cannot see tasks created by other users.
    • TaskAdmins - Users who are associated with this role can see and modify all of the tasks in the system.
    • TaskAuditors - Users who are associated with this role can see and modify all of the audit records in the system.
      Procedure
      To associate users with the task manager roles:
      1. In the WebSphere Application Server administrative console, go to Applications > Application Types > WebSphere enterprise applications.
      2. Click the taskManagerWebSphereEAR entry.
      3. In the Detail Properties section, click Security role to user/group mapping.
      4. Associate users and groups with each of the task manager roles.
      5. Save the changes to the master configuration.


    Configuring a database for the task manager application
    You must create and configure a database to store data for the task manager application.

    You can create the task manager database on one of the following types of database servers:
    • DB2
    • Microsoft SQL Server
    • Oracle
      Prerequisites
      Create a database on your database server.

      Procedure
      1. Open the taskManager/database subdirectory of the IBM Content Navigator installation directory.
      2. Follow the documentation for your database server to import the appropriate script to your database server.

        The script creates the database table and schema in the database that you created for the task manager application.

        Important: If the Nexus schema is not created on your database, you must manually create the Nexus schema.


    Creating a data source for the task manager database
    After you create your task manager database, you must create a data source on your web application server to enable the deployed web application to communicate with the database.
      Procedure
      To create a data source:
      1. Log in to the WebSphere Application Server administrative console.
      2. Follow the WebSphere Application Server documentation to create a data source for the task manager database.

        Important: You must specify jdbc/NexusDS as the JNDI name.

        For example, if you use WebSphere Application Server, Version 8.0, refer to Configuring a data source using the administrative console in IBM Knowledge Center.
      3. Save the changes to the master configuration.
      4. Go to Applications > Application Types > WebSphere enterprise applications.
      5. Select the taskManagerWebSphereEAR entry and click Start.

    Verifying the task manager application deployment
    Before you use the task manager application, ensure that the application was successfully deployed on WebSphere Application Server.
      Procedure
      To verify the task manager application deployment:
      1. Enter the following URL in your web browser:
        https://server_host_name:port_number/taskManagerWeb/api/v1/tasks/ping


      Results
      The server should return a JSON response.

      If you do not see a JSON response, record the error code that is returned by the server and contact IBM Software Support.

    Adding the task manager application to your IBM Content Navigator configuration
    To enable IBM Content Navigator and IBM Content Navigator plug-ins to access the task manager APIs, you must configure IBM Content Navigator.

    Prerequisites
    Before you can complete this task, you must:
    • Configure and deploy IBM Content Navigator.
    • Complete any required post-configuration tasks for your environment to ensure that you can access the web client.

    Procedure
    To add the task manager application to IBM Content Navigator:
    1. Open the administration tool in the web client.
    2. Click Settings.
    3. In the Task Manager Configuration section, enter the URL of the task manager application. The URL should have the format https://server_host_name:port_number/taskManagerWeb/api/v1.
    4. Save your changes.


Configuring the task manager application on Oracle WebLogic Server
To configure the task manager application, you must complete the following tasks:

    Configuring task manager notification emails
    If you want the task manager application to send email notifications, you must configure an SMTP server in Oracle WebLogic Server.
      Procedure
      To configure email notifications:
      1. Log in to the Oracle WebLogic Server administrative console.
      2. Go to Services > Mail session.
      3. Click New and create a mail session with the following properties:
        1. Name the mail session ICNMail.
        2. Enter mail/ICNMail for the JNDI name.
      4. In the JavaMail Properties section, enter the information for your SMPT server. For example, enter:

        mail.debug=true
        mail.host=
        fully_qualified_SMPT_Server_host_name
        mail.transport.protocol=smtp

      5. Click Finish.


    Deploying the task manager application
    You must generate the task manager application EAR file and deploy it to your web application server.
      Procedure
      To deploy the task manager application:
      1. Open the taskManager/deploy subdirectory of the IBM Content Navigator installation directory.
      2. Optional: If you have task JAR files from another application, add the JAR files to the taskManager/deploy/WEB-INF/dropins subdirectory of the IBM Content Navigator installation directory.

        Some IBM products provide JAR files that work with the task manager application.
      3. If you are deploying the task manager application in a highly available cluster environment, you must modify the config.properties file for your environment. The config.properties file is located in the taskManager/deploy/WEB-INF subdirectory of the IBM Content Navigator installation directory.

        Important: It is recommended that you do not change the database_schema_name parameter. If you do change this parameter, you must modify the database files before you import them to your database.
        1. You must modify the following parameters:
          • Set the taskManager_admin_user to the user name that you want to use as the task manager administrator.
          • Set the taskManager_admin_password to the password that you want to use for
            the task manager administrator.
          • Set the taskManager_base_URL to the URL of the cluster server where you plan to deploy the task manager application.
        2. You can modify the following parameters if you want to override the default values:
          • Set the logfile_directory to the fully qualified path of the directory where you want to store log files that are generated by the task manager application.
          • Set the taskManager_default_log_level to one of the following values. The default setting is WARNING. It is recommended that you do not set FINE, FINER, or FINEST unless you are instructed to by IBM Software Support.
            • SEVERE
            • WARNING
            • INFO
            • CONFIG
            • FINE
            • FINER
            • FINEST
          • Set the enable_heartbeat_monitoring parameter to true.
        3. Encrypt the password that you entered in the config.properties file by running the following command:

          java -jar updateUserInfo.jar fully_qualified_path_of_config.properties admin_user_name admin_password
      4. Run the create_taskManager_ear.bat or create_taskManager_ear.sh file to create the taskManagerWebWeblogic.ear file.
      5. Log in to the Oracle WebLogic Server administrative console.
      6. Go to Deployments.
      7. Click Install and specify the fully qualified path of the taskManagerWebWeblogic.ear file.
      8. When prompted, select the default options to deploy the application.
      9. Click Finish.

    Associating users with task manager roles
    After you configure and deploy the task manager application, you must associate users and groups with the task manager roles.

    The task manager application includes the following roles:
    • TaskUsers - Users who are associated with this role can create tasks. They can also see and modify only the tasks that they create. They cannot see tasks created by other users.
    • TaskAdmins - Users who are associated with this role can see and modify all of the tasks in the system.
    • TaskAuditors - Users who are associated with this role can see and modify all of the audit records in the system.
      Procedure
      To associate users with the task manager roles:
      1. In the Oracle WebLogic Server administrative console, go to Deployments.
      2. Click the taskManagerWeblogicEAR entry.
      3. On the Security tab, associate users and groups with each of the task manager roles.
      4. Save the security role mapping.


    Enabling SSL on Oracle WebLogic Server
    By default, SSL is disabled on Oracle WebLogic Server. However, SSL must be enabled for the task manager application to function correctly.
      Procedure
      To enable SSL on Oracle WebLogic Server:
      1. In the Oracle WebLogic Server administrative console, go to Environment > Servers.
      2. Click the AdminServer entry.
      3. On the General tab, select SSL Listen Port Enabled.
      4. Click Save.


    Configuring a database for the task manager application
    You must create and configure a database to store data for the task manager application.

    You can create the task manager database on one of the following types of database servers:
    • DB2
    • Microsoft SQL Server
    • Oracle
      Prerequisites
      Create a database on your database server.

      Procedure
      1. Open the taskManager/database subdirectory of the IBM Content Navigator installation directory.
      2. Follow the documentation for your database server to import the appropriate script to your database server.

        The script creates the database table and schema in the database that you created for the task manager application.

        Important: If the Nexus schema is not created on your database, you must manually create the Nexus schema.


    Creating a data source for the task manager database
    After you create your task manager database, you must create a data source on your web application server to enable the deployed web application to communicate with the database.
      Procedure
      To create a data source:
      1. Log in to the Oracle WebLogic Server administrative console.
      2. Follow the Oracle WebLogic Server documentation to create a data source for the task manager database.

        Important: You must specify jdbc/NexusDS as the JNDI name.
      3. Click Finish.

    Verifying the task manager application deployment
    Before you use the task manager application, ensure that the application was successfully deployed on Oracle WebLogic Server.
      Procedure
      To verify the task manager application deployment:
      1. Enter the following URL in your web browser:
        https://server_host_name:port_number/taskManagerWeb/api/v1/tasks/ping


      Results
      The server should return a JSON response.

      If you do not see a JSON response, record the error code that is returned by the server and contact IBM Software Support.


    Adding the task manager application to your IBM Content Navigator configuration
    To enable IBM Content Navigator and IBM Content Navigator plug-ins to access the task manager APIs, you must configure IBM Content Navigator.

    Prerequisites
    Before you can complete this task, you must:
    • Configure and deploy IBM Content Navigator.
    • Complete any required post-configuration tasks for your environment to ensure that you can access the web client.

    Procedure
    To add the task manager application to IBM Content Navigator:
    1. Open the administration tool in the web client.
    2. Click Settings.
    3. In the Task Manager Configuration section, enter the URL of the task manager application. The URL should have the format https://server_host_name:port_number/taskManagerWeb/api/v1.
    4. Save your changes.

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Content Navigator

Software version:

2.0.2

Operating system(s):

AIX, Linux, Linux on System z, Windows

Reference #:

7039190

Modified date:

2014-06-26

Translate my page

Machine Translation

Content navigation