> Installation Guide > Configuring CollabraSuite, BEA Edition

Installation Guide

     Previous  Next    Open TOC in new window  Open Index in new window  View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Configuring CollabraSuite, BEA Edition

 

Create the Domain

While CollabraSuite, BEA Edition may be successfully deployed into any type of WebLogic domain, a portal domain is required if CollabraSuite, BEA Edition is to be deployed inside a WebLogic Portal. If a WebLogic domain has not yet been created at your site, use the WebLogic Configuration Wizard to create one.

In this document, the directory where WebLogic is installed will be referred to as WL_HOME. For example, WL_HOME=C:\bea\weblogic81

The WebLogic domain directory will be referred to as DOMAIN_HOME. For example, DOMAIN_HOME=C:\bea\user_projects\domains\portalDomain

WebLogic 8.1

For WebLogic 8.1, domains must first be created and later extended with CollabraSuite, BEA Edition. Consult BEA's website for directions on Creating a New WebLogic 8.1 Domain. (http://download.oracle.com/docs/cd/E13196_01/platform/docs81/confgwiz/newdom.html).

WebLogic 9.2

In WebLogic 9.2, CollabraSuite, BEA Edition can be installed into a domain at creation time, or added later by extending the domain. Refer to the section Extend WebLogic 9 Domain below for instructions on configuring CollabraSuite, BEA Edition when creating or extending the domain.

Consult BEA's website for directions on Creating a New WebLogic 9 Domain. (http://download.oracle.com/docs/cd/E13179_01/common/docs92/confgwiz/newdom.html)

 

Extend the Domain

CollabraSuite, BEA Edition is installed into a WebLogic server instance by adding the appropriate configuration to the server's domain. This domain configuration is automated using an extension template containing the CollabraSuite, BEA Edition software. The template can also be used to create the necessary database tables for CollabraSuite, BEA Edition. If you're upgrading an existing installation of CollabraSuite, BEA Edition, refer to the Upgrading CollabraSuite appendix.

Be sure to shut down WebLogic and backup your entire domain directory before applying the extension template to an existing domain. The Configuration Wizard will overwrite all scripts in the domain, removing any local modifications. One strategy for updating an existing domain with local customizations is to first make a copy of the domain. You can then apply the extension template to the copy. When finished with the template, copy the config.xml and the CollabraSuite.ear file back into the original domain. This will allow you to update a domain with CollabraSuite, BEA Edition while preserving any local modifications.

WebLogic 8.1 Domain

The following section describes extending a WebLogic 8.1 domain. If you are using WebLogic 9, skip this section and refer to the next section titled Extend WebLogic 9 Domain.

  1. Run the BEA WebLogic Configuration Wizard.
    1. In Windows, you can use the Start menu to run the Configuration Wizard. For other platforms, you can execute the Configuration Wizard script located in the WebLogic installation directory:
      2. % cd $WL_HOME/common/bin
      % ./config.sh &
  2. Extend an existing WebLogic configuration.
    1. Choose Extend an existing WebLogic configuration.
    2. Click Next.
      3. Figure 3-1 Create or Extend Domain


      Create or Extend Domain

  3. Select the configuration.
    1. Use the tree to select the top level directory of domain you wish to extend with CollabraSuite, BEA Edition functionality.
    2. Click Next.
      3. Figure 3-2 Choose Configuration Directory


      Choose Configuration Directory

  4. Select the CollabraSuite, BEA Edition extension template.
    1. Check CollabraSuite Extension under Configuration Extensions. Click Next.
      2. Figure 3-3 Select Template


      Select Template

  5. Define JDBC Components.
    1. Click Yes when asked to define JDBC components.
    2. Click Next.
      3. Note: If using Pointbase, see the Special PointBase Instructions for WebLogic 8.1. If using MySQL, see the Special MySQL Instructions.
      Figure 3-4 Database Options


      Database Options

    3. The template provides example CollabraSuite, BEA Edition JDBC connection pools for Pointbase, Oracle, Sybase, MS SQL Server and MySQL. Choose the CollabraSuite, BEA Edition connection pool for the database you will be using and delete the remaining CollabraSuite, BEA Edition pools (those beginning with csuite).
      4. Note: If they exist, cgPool, cgJMSPool-nonXA and the portalPool should not be deleted.
    4. Fill in the correct values for DBMS name, DBMS host, User name and User password. Supports Local Transactions should not be checked.
    5. Click Next.
      6. Figure 3-5 Connection Pools


      Connection Pools

    6. Click Next to skip the Configure JDBC MultiPools page.
    7. For the csuitePool Data Source, select the csuite Connection Pool from the drop down menu.
    8. Click Next.
      9. Figure 3-6 Data Sources


      Data Sources

  6. Test JDBC Connection Pools and Settings.
    1. To test the pool, select the csuite Connection Pool and click Test Connection. You should see a successful connection test in the right hand panel.
      2. Figure 3-7 Setup Database


      Setup Database

  7. Create the CollabraSuite, BEA Edition Database Schema
    1. If the database schema does not already exist, click on Load Database.
      2. Note: In WebLogic 8.1, all database scripts are run contrary to the BEA documentation. This will result in any existing CollabraSuite, BEA Edition tables being dropped and recreated, removing any previous CollabraSuite, BEA Edition environment. If upgrading an existing CollabraSuite, BEA Edition environment, please refer to the Upgrading CollabraSuite appendix.
    2. Click Next.
      3. Figure 3-8 Setup Database


      Setup Database

  8. Define JMS Components.
    1. Click No when asked to define JMS components. The JMS configuration should not have to be modified.
    2. Click Next.
      3. Figure 3-9 Messaging Options


      Messaging Options

  9. Target Components to Servers.
    1. Click No when asked to target components to servers. The components will be targeted to the server.
    2. Click Next.
      3. Figure 3-10 Target Options


      Target Options

  10. Configure Application Security.
    1. Click No when asked to configure the application's security. The correct groups and roles have already been defined.
    2. Click Next.
      3. Figure 3-11 Security Options


      Security Options

  11. Extend the configuration.
    1. If desired, use Browse to select the directory to place the CollabraSuite.ear.
      2. Note: If you want to place the EAR under the applications directory located in the domain you may have to create the directory first.
    2. Click Import.
      3. Figure 3-12 WebLogic Configuration


      WebLogic Configuration

  12. A successful import is indicated in the screen below.
    1. Click Done to exit the Configuration Wizard.
      2. Figure 3-13 Creating Configuration


      Creating Configuration

WebLogic 9.x Domain

This section describes extending a WebLogic 9.x domain. If you are using WebLogic 8.1, skip this section and proceed to the next section titled Finish Extending the Domain.

  1. Run the BEA WebLogic Configuration Wizard.
    1. In Windows, you can use the Start menu to run the Configuration Wizard. For other platforms, you can execute the Configuration Wizard script located in the WebLogic installation directory:
      2. % cd $WL_HOME/common/bin
      % ./config.sh &
  2. Extend an existing WebLogic domain.
    1. Choose Extend an existing WebLogic domain.
    2. Click Next.
      3. Figure 3-14 Create or Extend Domain


      Create or Extend Domain

  3. Select the existing configuration.
    1. Use the tree to select the top level directory of the domain you wish to extend with CollabraSuite, BEA Edition functionality.
    2. Click Next.
      3. Figure 3-15 Choose Domain


      Choose Domain

  4. Select the extension source.
    1. Select the appropriate CollabraSuite, BEA Edition template. Choose the CollabraSuite, BEA Edition for ALUI if CollabraSuite, BEA Edition is to be used with AquaLogic User Interaction (ALUI)
    2. Click Next.
      3. Figure 3-16 Select Extensions


      Select Extensions

  5. Customize JDBC Settings
    1. Click Yes when asked to modify JDBC data sources.
    2. Click Next.
      3. Note: If using MySQL, see the Special MySQL Instructions.
      Figure 3-17 Customize JDBC


      Customize JDBC

  6. Configure JDBC Data Sources.
    1. Leave the Name and JNDI name fields unchanged.
    2. Fill in the appropriate Database type and Driver.
      3. Note: Refer to the Supported Configurations Guide for supported databases and drivers.
    3. Fill in the appropriate values for DBMS name, DBMS host, DBMS port, User name and User password.
    4. Check Supports global transactions, then select Emulate two phase commit.
      5. Figure 3-18 Data Source


      Data Source

    5. Test the data source by clicking Test Connections.
    6. In the Test Data Source Connections dialog, click the Test button next to the csuiteDataSource. You should see a successful connection test in the lower panel.
    7. Click OK to dismiss the dialog.
    8. Click Next.
      9. Figure 3-19 Test Data Source


      Test Data Source

  7. Run Database Scripts
    1. If the CollabraSuite, BEA Edition database schema does not already exist, click Run Scripts.
      2. Note: Any existing CollabraSuite, BEA Edition tables will be dropped and recreated, removing any previous CollabraSuite, BEA Edition environment. If upgrading CollabraSuite, BEA Edition, please refer to the Upgrading CollabraSuite appendix.
    2. Click Next.
      3. Figure 3-20 Setup Database


      Setup Database

  8. Review WebLogic Domain.
    1. Click Next.
      2. Figure 3-21 Review Domain


      Review Domain

  9. Extend WebLogic Domain.
    1. Select the desired Application location. This is where the CollabraSuite.ear file will be installed.
      2. Note: If you want to place the EAR file under the applications directory in the domain you may have to create the directory first.
    2. Click Extend.
      3. Figure 3-22 Extend the Domain


      Extend the Domain

  10. A successful domain extension is displayed in the screen below.
    1. Click Done to exit the Configuration Wizard.
      2. Figure 3-23 Create Domain


      Create Domain

Finish Extending the Domain

After extending a WebLogic 8.1 or 9 domain, complete the installation via the WebLogic console.

  1. Start the WebLogic server

    2. For Windows:

    > cd %DOMAIN_HOME%

    > startWebLogic.cmd

    For Unix:

    % cd $DOMAIN_HOME

    % ./startWebLogic.sh

    Note: Startup will take some time because the CollabraSuite, BEA Edition JSPs are precompiled the first time the server is started after CollabraSuite, BEA Edition has been deployed.
  2. Verify the following groups exist; creating the groups if they are not present:
    • CollabraSuiteAdministrators
    • CollabraSuiteUsers
    • CollabraSuiteRemote
      • Note: If using an LDAP, create the groups in the LDAP and add users to the appropriate groups within the LDAP manually.
  3. Add any existing WebLogic users to the appropriate CollabraSuite groups:
    • Users must belong to the CollabraSuiteUsers group in order to login to the CollabraSuite environment.
      • Note: Users belonging to the `wlcs_customer' and `users' groups also have access to CollabraSuite.
    • Users belonging to the CollabraSuiteAdministrators group can create a new CollabraSuite campus and administer any existing campus.
      • Note: Users belonging to the `Administrators' and `PortalSystemAdministrators' groups also belong to the CollabraSuiteAdministrators group.
    • Users must belong to the CollabraSuiteRemote group in order to initialize and interact using the connection between two remote campuses. This is the user listed on the Remote Campus Admin Details page.
      • Note: Prior to the 4.2 release, the group names were CollabraSuiteGroup, CollabraSuiteAdmin, and CollabraSuiteRemoteAPI. These group names are still supported in later releases, though new installations will use the updated group names.
  4. Increase the size of the Default Execute Queue if necessary. CollabraSuite, BEA Edition requires an available thread for every user logged in concurrently. Threads are also consumed by remote campus connections, depending on the settings in the Remote Campus Details page. The Default Execute Queue can be modified in the WebLogic Administration Console under Servers->ServerName->Configuration->General->Advanced Options-> Configure Execute Queues. Select the default execute queue and modify the Thread Count setting as appropriate.
  5. Modify the mail settings.
    1. Some CollabraSuite, BEA Edition components generate email and therefore require a Mail Session. The mail session is created by the template and can be edited from the WebLogic Administration Console under Services->Mail->csuiteMailSession. Important properties of the mail session include:
      • mail.host: SMTP mail server hostname; default=localhost
      • mail.user: The user name used to connect to the mail server; default=empty
      • mail.from: The return email address used when the sending user has not filled in their email address; default=collabraSuite@localhost
        • Note: For further details on the JavaMail API, refer to http://java.sun.com/products/javamail.
    2. Advanced Mail options: CollabraSuite, BEA Edition contains advanced mail formatting options that can configure email headers and footers; a bcc recipient list to be used; and a standard from address to be used. In order to configure these advanced mail settings, the ejb-jar.xml file within the csuite-ebj.jar in CollabraSuite.ear must be updated and the jars repackaged. The individual options are documented within the ejb-jar.xml file.
  6. Configure Virtual Content Repository (VCR) support if necessary:
    1. Enable Library Services in the VCR to enable support for versioning documents. This can be modified via the Portal Administration console.
    2. Modify the VCR data source (named portalDataSource by default) to Support Global Transactions using Logging Last Resource. This can be modified via the WebLogic Administration console under Services-> JDBC-> Data Sources-> portalDataSource-> Configuration-> Transaction.
    3. Users need to have permission to write into the VCR. Adding the users to the Administrators group addresses this.
  7. Verify the HTTP timeouts. CollabraSuite, BEA Edition requires an HTTP timeout of at least 30 seconds.
    1. The WebLogic default of 10 minutes is well within the requirements for CollabraSuite, BEA Edition. If necessary, this setting can be modified from the WebLogic Administration Console under Servers->ServerName->Tuning->Stuck Thread Max Time.
    2. This timeout also applies to any HTTP proxies between the client and WebLogic. The HTTP proxy timeout must be greater than or equal to WebLogic's timeout. Again, most defaults are much larger than 30 seconds, so these settings should not have to be modified to accomodate CollabraSuite, BEA Edition.
  8. CollabraSuite, BEA Edition is licensed via the BEA license. License files must be obtained from BEA. An evaluation license is available on the CollabraSuite, BEA Edition download page. The existing BEA license should be updated via the BEA UpdateLicense tool (UpdateLicense "NEWLICENSEFILE")

 

Create the Collaborative Environment

Once the CollabraSuite, BEA Edition software has been successfully installed, all other documentation and administration capabilities are available via the deployed CollabraSuite, BEA Edition application. An list of all available documentation and links to the documents can be found deployed in the WebLogic server at http://host:port/csuite/docs

  1. Create the initial collaborative environment by using the CollabraSuite, BEA Edition administration web application.
    1. If necessary, create a CollabraSuite, BEA Edition administration user in WebLogic that belongs to the CollabraSuiteAdministrators group.
    2. Bring up the CollabraSuite, BEA Edition administration web application at http://host:port/csuite/ria/admin and log in as an administrative user.
    3. Create the desired campus, buildings, floors, and rooms.
    4. Create the desired users
    5. In a portal environment, create corresponding WebLogic users in the Portal Administration. Otherwise, create the WebLogic users in the WebLogic Administration Console. The WebLogic user name must match the CollabraSuite, BEA Edition user login ID. Alternatively, you can use the <setUserInfo> JSP tag inside a portlet to automatically create a CollabraSuite user that corresponds to the WebLogic user. See CollabraSuite.jspf in the sample portlets for an example of using the <setUserInfo> JSP tag.
      6. Note: Refer to the CollabraSuite, BEA Edition Administration Guide for more information on creating a collaborative environment.

 

Create the Portal

CollabraSuite can run inside either a WebLogic Portal or ALUI environment. If a portal already exists or is not needed, creating the portal may be skipped.

For details on creating a WebLogic Portal application, consult BEA's website on Getting Started with Portal Development. (http://download.oracle.com/docs/cd/E13218_01/wlp/docs81/startdev/index.html)

For details on creating an ALUI portal, consult BEA's ALUI Documentation (http://download.oracle.com/docs/cd/E13174_01/alui/index.html)

 

Extend the Portal

The following sections describe integrating CollabraSuite, BEA Edition into a portal environment. They can be skipped when portal integration is not required.

WebLogic 8.1 Portal

This section describes CollabraSuite, BEA Edition integration with WebLogic Portal 8.1.

  1. Start BEA WebLogic Workshop.
  2. Open an existing portal application or create a new one via File->New->Application...
  3. Select an existing web project or create a new one via File->New->Project...
  4. Right-click on the web project in the left-hand tree and select Install->CollabraSuite
  5. Sample CollabraSuite, BEA Edition portlets are available in the Data Palette. Simply select a portal page and drag the portlets onto the page in the desired location.
  6. CollabraSuite, BEA Edition provides a JSP tag library for creating custom CollabraSuite, BEA Edition portlets. The CollabraSuite, BEA Edition tags are available under the JSP Palette in WebLogic Workshop.
  7. Edit the portlets/CollabraSuite/collabrasuite.jspf file as necessary:
    1. Set the campusName variable to the correct campus name.
    2. Uncomment the <setuserinfo> JSP tag to automatically create CollabraSuite, BEA Edition user accounts if desired.
Note: This requires Auto Account Creation to be enabled on the campus. See the CollabraSuite, BEA Edition Administration Guide for details.

WebLogic 9.2 Portal

This section describes CollabraSuite, BEA Edition integration with WebLogic Portal 9.2.

  1. Start BEA WebLogic Workshop.
  2. Open an existing portal EAR project or create a new one via File->New->Portal EAR Project...
  3. Select an existing portal WAR project or create a new one via File->New->Portal Web Project...
    1. Select the following project facets:
    • CollabraSuite->CollabraSuite Taglibs
    • WebLogic Portal Collaboration->CollabraSuite Portlets
    1. Choose to "Use Shared J2EE Libraries."
  4. Create a new Portal by right clicking on the portal webproject and selecting New->Portal
    5. Note: There is a known issue in WebLogic 9.2 concerning the proper ordering of library modules. As a workaround, open the WebContent/WEB-INF/weblogic.xml file in the web project and re-order the library module references so that the first two library modules are: collabrasuite-portlets-web-lib and collabrasuite-web-lib in that order.
  5. Sample CollabraSuite, BEA Edition portlets are available in the Data Palette. Simply select a portal page and drag them onto the page in the desired location.
  6. CollabraSuite, BEA Edition provides a JSP tag library for creating custom CollabraSuite, BEA Edition portlets. The CollabraSuite, BEA Edition tags are available under the JSP Design Palette in WebLogic Workshop.
  7. Edit the portlets/CollabraSuite/collabrasuite.jspf file as necessary:
    1. Set the campusName variable to the correct campus name.
    2. Uncomment the <setuserinfo> JSP tag to automatically create CollabraSuite, BEA Edition user accounts if desired.
Note: This requires Auto Account Creation to be enabled on the campus. See the CollabraSuite, BEA Edition Administration Guide for details.

WebLogic 9.2 GroupSpace Portal

This section describes CollabraSuite, BEA Edition integration with WebLogic 9.2 GroupSpace portals. Please refer to the GroupSpace Guide (http://download.oracle.com/docs/cd/E13218_01/wlp/docs92/groupspace/index.html) for details on creating a GroupSpace portal.

When creating a domain, select the following products:

  1. Start BEA WebLogic Workshop.
  2. Open an existing portal EAR project or create a new one via File->New->Portal EAR Project...
    1. In addition to the WebLogic Portal and WebLogic Portal Collaboration facets, select the CollabraSuite GroupSpace Library Support facet.
  3. Select an existing portal WAR project or create a new one via File->New->Portal Web Project...
    1. In addition to the WebLogic Portal and WebLogic Portal Collaboration facets, select the following:
    • CollabraSuite/CollabraSuite Taglibs
    • WebLogic Portal Collaboration/CollabraSuite GroupSpace Support
    • WebLogic Portal Collaboration/CollabraSuite Portlets
    1. Choose to "Use Shared J2EE Libraries"
      2. Note: There is a known issue in WebLogic 9.2 concerning the proper ordering of library modules. As a workaround, open the WebContent/WEB-INF/weblogic.xml file in the web project and re-order the library module references so that the first three library modules are: collabrasuite-groupspace-web-lib, collabrasuite-portlets-web-lib and collabrasuite-web-lib in that order.
      Note: Once the CollabraSuite GroupSpace Support facet has been applied to a Web Project, that Web Project can only be used for GroupSpace portals. However, there can be multiple Web Projects deployed into a single domain, some of which support GroupSpace and some that do not.
  4. Publish the EAR to the WebLogic server.
  5. Open the portal administration console.
  6. Create a community template based on the groupspace.ctmeta file.
    7. Note: There are other ways to create a community such as directly from a .community file. However, the only way currently supported is via a template based on the groupspace.ctmeta file.
  7. Create an initial community based on the template created in the previous step.

AquaLogic User Interaction (ALUI) Portal

This section describes CollabraSuite, BEA Edition integration with BEA's ALUI product.

When using WebLogic 8.1, the domain must first be extended using the CollabraSuite, BEA Edition template as described above in the Extend the Domain section. The WebLogic Configuration Wizard must be run again to extend the domain with the CollabraSuite, BEA Edition for ALUI template.

When using WebLogic 9.2, both templates can be applied at the same time, either during domain creation, or later by extending the domain.

  1. Update the CollabraSuite_ALUI_Portlets deployment descriptors.
    1. In order to automatically create WebLogic users corresponding to ALUI users, the name of a WebLogic administrative user is contained in the weblogic.xml file of the csALUI web application. The default username is weblogic. If the weblogic user doesn't exist in the domain or it is not in the Administrators group, the weblogic.xml must be modified. Change the following XML in BEA_HOME\collabrasuite-XXX\ALUI\CollabraSuite_ALUI_Portlets.ear\csALUIWeb.war\WEB-INF\weblogic.xml to reflect the name of an administrative user in your domain:
      2. <security-role-assignment>
      	<role-name>SSO_ROLE</role-name>
      	<principal-name>weblogic</principal-name>
      </security-role-assignment>
      	
      <run-as-role-assignment>
      	<role-name>SSO_ROLE</role-name>
      	<run-as-principal-name>weblogic</run-as-principal-name>
      </run-as-role-assignment>
    2. By default, CollabraSuite, BEA Edition will create new users with the same user name that is used to log into ALUI, with a default homeroom of SampleCampus/SampleBuilding/SampleFloor/SampleRoom. If you would like to change any of these defaults, you need to modify the Servlet parameters in the CollabraSuite_ALUI_Portlets EAR. These are found in the web.xml file of the csALUI web application.
      3. Note: Remember to redeploy this EAR if you make any modifications to the deployment descriptors.
  2. Import the sample CollabraSuite, BEA Edition portlets
    1. If necessary, start up the server that is running the ALUI application.
    2. Navigate to http://host:port/portal/server.pt
    3. Log in as the Administrator. The default is 'Administrator' with no password.
    4. Click on the Administration tab.
    5. Under the Select Utility... tab, choose Migration - Import.
    6. Click Browse... under File Path, and select the following file: <BEA_HOME>/collabrasuite-version/ALUI/QuickStart/csALUISample.pte
    7. Click Load Package.
    8. Click Finish in the upper-right-hand corner of the window, and then click OK to confirm the migration.
    9. You now have a sample ALUI Experience Definition that contains all of the CollabraSuite, BEA Edition portlets, as well as a sample default page to log into that contains two CollabraSuite, BEA Edition portlets.
  3. Modify Remote Server Properties. The migration in the previous step created a remote server object, which should point to the CollabraSuite_ALUI_Portlets application that was deployed by the extension template. To change the default of localhost as the server host and 7001 as the server port:
    1. Make sure that the server running the ALUI application is running.
    2. Log into the ALUI application as the Administrator.
    3. Click on the Administration tab.
    4. Click on the CollabraSuite Experience Definition link.
    5. Click on the Remote Server link, then click on the CS Remote Server link.
    6. Change the host and port in the Base URL text field.
    7. Click Finish in the upper-right-hand corner of the window.
    8. Log out of the ALUI application.
  4. Modify CollabraSuite, BEA Edition Campus settings in the CollabraSuite, BEA Edition Administration tool.
    1. Make sure that the server running CollabraSuite, BEA Edition is running.
    2. Log into the CollabraSuite, BEA Edition admin tool using the CollabraSuite, BEA Edition admin account. The URL is http://host:port/csuite/ria/admin.
    3. Make sure that the Auto-Account Creation checkbox is checked. If not, check this box and click Save.
    4. Log out of the CollabraSuite, BEA Edition admin tool.
  5. Configure ALUI timeout and authentication.
    1. Verify the following values are set in the <PLUMTREE_INSTALL_DIR>/settings/portal/portalconfig.xml file
      • ImageServerConnectionURLTimeout: -1
      • CaptureBasicAuthenticationForPortlets: 1

  Back to Top       Previous  Next