BITeamwork out-of-the-box is an amazing solution that changes the way users leverage their Enterprise Business Intelligence platform. You have to install it first before you can use it. That is what this part of the documentation describes in detail for you.

How does BITeamwork integrate so seamlessly?

At its core, BITeamwork is a Java-based Web Application. It is created using best practices, Web 2.0 capabilities, and a lot of the technology that you'll find in both Enterprise Software as well as top E-commerce websites such as Amazon.com. Leveraging inherent capabilities within the Enterprise Business Intelligence application such as templates, pages, and javascript, BITeamwork is configured in such a way that it transparently integrates.

And, because it is a Java (JEE) based web application it only requires an existing Java Application Server such as WebLogic Server on which to be deployed. The managed collaboration data is stored in a database repository so as part of the installation process a database schema must be created for the BITeamwork metadata and the provided SQL scripts will be executed in order to create the repository tables and other database objects. It's really straightforward to install as you'll see.

It all comes together nicely once the installation process completes successfully.

Who should be responsible for installing BITeamwork?

The installation of BITeamwork should be conducted by an administrator of the Business Intelligence system.

In order to install BITeamwork there are only a few requirements that need to be met. If your Business Intelligence platform is installed per the software vendor's specifications and meet their certification requirements then the requirements for installing BITeamwork have been met. Please take into consideration that any customizations made to your existing Business Intelligence platform may need to be inventoried. Please backup your existing BI implementation as a common sense safe guard before installing any new patches, software, or updates to a production system.

Oracle Business Intelligence 11g

  1. Must have the ability to create a database schema and run SQL (DLL/DML) script
    • Similar to RCU Schemas for BI (MDS, BIPLATFORM) and can reside on same database server instance
  2. WebLogic Server (Application Server) must be running at time of BITeamwork installation
    • Simple or Enterprise Installation certified with BITeamwork
  3. Backup the $FMW_HOME/instances/instance1/bifoundation/OracleBIPresentationServicesComponent/coreapplication_obips1/msgdb/ folder

We've made the install so straightforward you'll think it's simple.
Also, Watch the Videos

  1. Download the Software
  2. S/FTP or move the downloaded compressed file to the Oracle BI 11g or 12c Server
  3. Copy the compressed file to a temporary drive (ex: C:\tmp or /tmp) and extract the file's contents
  4. Navigate to the BITeamwork_<version#> folder
  5. Expand the folders InstallFiles > DB > Scripts and then choose the folder of the database vendor you will use to store the BITeamwork metadata, i.e.: Oracle or SQLServer.

    NOTE: Choose whichever database vendor works for your organization. Running the initial vendor dependent SQL scripts (next step) is the only part that creates a variation in the BITeamwork install process.

  6. Execute the two SQL Scripts using your favorite Oracle or SQL Server Management IDE (ex: SQLDeveloper or Management Studio) to create the BITEAMWORK repository schema and to populate the schema objects. Execute the files using the order below:
    • 1) Execute W_CREATE_BITEAMWORK_USER.sql or 1_CREATE_BITEAMWORK_USER_MSSQLSERVER.sql
    • 2) Execute X_BITEAMWORK_BUILD_SCHEMA.sql or 2_BITEAMWORK_BUILD_SCHEMA_MSSQLSERVER.sql
    • Only if you are upgrading from previous BITeamwork version using an Oracle database schema:
      • Execute any Z_BITEAMWORK_.....sql
      • If you experience any problems because you've executed this script then drop the schema and re-build with only the X_BITEAMWORK_BUILD_SCHEMA.sql script and do not run the Z_BITEAMWORK..sql scripts any more
    • You may potentially need your DBA to create the BITEAMWORK schema so provide her with the W_CREATE_BITEAMWORK_USER.sql script.
    • Connect then to the newly created BITEAMWORK (i.e.: BITEAMWORK_OBI) schema and execute the X_BITEAMWORK_BUILD_SCHEMA.sql script, as well as any Z_BITeamwork...sql scripts available if conducting an UPGRADE of BITEAMWORK.
  7. If updating, upgrading, or patching an existing version of BITeamwork, execute the SQL scripts that reflect your closest SQL version and all of the additional scripts available in the directory. You may receive warning messages stating that some objects already exists.
    • During an upgrade you should always run a diff or compare using the latest X_BITEAMWORK_BUILD_SCHEMA.sql and your current db repository that was patched as the X_BITEAMWORK_BUILD_SCHEMA.sql will always be the most accurate of the current state of the current release repository.
  8. In the BITeamwork_<version#> folder root, edit the installBITeamwork.[bat|sh] file
    • (Right-click > Edit , if using a Windows OS; Use VIM Editor on *Nix)

    Warning! Pre-Requisite

    Be certain that the Oracle BI environment on which you are installing BITeamwork is currently running and active. The WebLogic Server should be running and available for access and MUST NOT be in Lock & Edit mode (i.e.: Release Configuration).
    • Locate the section labeled Set env variables and UPDATE beneath the file description header when editing the installBITeamwork.[bat|sh] file.

      If using a *Nix OS, you may also need to run the dos2unix command on the installBITeamwork.sh and the /installFiles/createDSandDeploy.py files. You may also need to run the command chmod a+x installBITeamwork.sh to give the script executable rights.

    • Edit the following variables to reflect your Oracle BI environment:
      • OBIEE_FMW_HOME
      • OBIEE_IS_SIMPLE_INSTALL

        If OBIEE 12c, then leave as the default, 0.
        If OBIEE 11g, this will typically be 0 (Default), unless you know for certain that you installed a simple installation, usually done in legacy 11g sandbox environments. In a simple install the /analytics server is usually accessible with the following url on port 7001 instead of 9704, http://<server_name>:7001/analytics

      • OBIEE_BASE_VERSION

        The default value is for any version of OBIEE 11.1.1.6.x as noted by the simple integer 11116. If installing on OBIEE 11.1.1.7.0, change the value to 11117, OBIEE 11.1.1.7.1, change the value to 111171, etc. Try to use the value most representative of your installation of OBIEE. In BITeamwork 3.0, the latest, 1111714xxx, 1111715xxx, 11119, 122100 options were introduced. You may use this as well if you have confirmed that your version of OBIEE is certified with BITeamwork and not other specific option matches your version. Hotfix versions should select the closest matching version option.

      • WEBLOGIC_URL

        The default value here t3://localhost:7001 will work for 99.8% of all installations. If your implementation port has changed from the default 7001 then make the adjustment accordingly.

        REMEMBER: t3:// is the WebLogic Server Protocol. Do NOT change this protocol to HTTP!

      • WEBLOGIC_USERNAME
      • WEBLOGIC_PASSWORD
      • DB_VENDOR

        The default value is set for an Oracle RDBMS as ORACLE. If using MS SQL Server change the value to SQLSERVER.

      • DB_SCHEME_USER_FOR_APP
      • DB_SCHEME_USER_PASSWORD_FOR_APP
      • DB_DRIVER

        NOTE: If using the Oracle BI SampleApp Linux Virtual Machine Image or simply an Oracle Database, the string should appear as oracle.jdbc.OracleDriver
        NOTE: If using a MS SQL Server database as the metadata repository for BITeamwork uncomment the SQL Server Connection Configuration information and comment out the Oracle RDBMS Connection Configuration.

      • DB_URL

        NOTE: If using the Oracle BI SampleApp Linux Virtual Machine Image the string should appear with the service name, for example jdbc:oracle:thin:@localhost:1521/orcl.us.oracle.com or similar depending on the SampleApp version. See this blog post for more information on the difference between connection string types.

        NOTE: If using a MS SQL Server database as the metadata repository for BITeamwork uncomment the SQL Server Connection Configuration information and comment out the Oracle RDBMS Connection Configuration.

      • TEMP_DIR
        • This is a location of a file on the server with temporary space the installation may use for saving configuration files during installation. Required free space ~50MB.
    • Save the file.

    Warning! Simple Installation Type for Oracle BI 11g

    If you are running a demonstration environment based on the Oracle BI 11g "Simple" Installation, you must set the OBIEE_IS_SIMPLE_INSTALL variable in the installBITeamwork.[bat|sh] file to a value of 1 by changing the default value of 0.
  9. Open a command prompt or terminal window and execute the installBITeamwork.[bat|sh] script.
  10. Restart the Oracle BI System Components
    • Open a command prompt or terminal.
    • Navigate to the BI_INSTANCE/bin directory, ex: C:\Oracle\FMW\instances\instance1\bin\
    • Execute the following commands at the prompt:
      • opmnctl stopall
      • opmnctl startall
  11. Open Oracle BI in a new browser. Login and navigate to the Administration page to see the new BITeamwork Administration layout to validate BITeamwork was installed correctly.
  12. Done with the Installation of BITeamwork - Let's move to configuration!
  13. Configuration Steps (Watch the Video)

Next: Post-Installation Configuration Steps

  1. Login to the Oracle BI System and access the BI Administration Page
  2. Configure the Web Services
  3. Sync the Application Roles
  4. Set the Application Manager Directories
  5. Assign any user Security

Check out the Installation Videos and have fun collaborating with BITeamwork.

Provide feedback when you can on our forums.

Just in case there is some rare, off-chance possibility that you'll need to uninstall BITeamwork.

Uninstall Pre-Requisites

  • Backup the BITeamwork Folders under $FMW_HOME/BITeamwork/
  • Backup the $FMW_HOME/instances/instance1/bifoundation/OracleBIPresentationServicesComponent/coreapplication_obips1/msgdb/ folder
  • Export the BITeamwork database repository schema as a backup

How to Uninstall

  1. Navigate to the BITeamwork_<version#> folder used for the installation
    • Although the installation process should not change from version-to-version of BITeamwork, if you have the original BITeamwork software version downloaded it would be most appropriate to use that respective uninstall script.
  2. Navigate to the root folder
  3. In the BITeamwork_<version#> folder root, edit the uninstallBITeamwork.[bat|sh] file
    • (Right-click > Edit , if using a Windows OS; Use VIM Editor on *Nix)

    Warning! Pre-Requisite

    Be certain that the Oracle BI 11g environment on which you are installing BITeamwork is currently running and active. The WebLogic Server should be running and available for access and MUST NOT be in Lock & Edit mode.
    • Locate the section labeled Set env variables and UPDATE beneath the file description header when editing the uninstallBITeamwork.[bat|sh] file.
    • Edit the following variables to reflect your current server environment:
      • OBIEE_FMW_HOME
      • OBIEE_IS_SIMPLE_INSTALL
      • WEBLOGIC_URL
      • WEBLOGIC_USERNAME
      • WEBLOGIC_PASSWORD
    • Save the file.

    Warning! Simple Installation Type for Oracle BI 11g

    If you are running a demonstration environment based on the Oracle BI 11g "Simple" Installation, you must set the OBIEE_IS_SIMPLE_INSTALL variable in the uninstallBITeamwork.[bat|sh] file to a value of 1 by changing the default value of 0.

    Warning! Preserve BITeamwork Application Roles

    Deleting the BITeamwork Application Roles may destroy any references made to users and other Application Roles that may have been assigned. There is an option in the uninstall executable, SHOULD_DELETE_APP_ROLES, if set to false (0) it will leave the Application Roles intact during the uninstall of the BITeamwork application.
  4. Open a command prompt or terminal window and execute the uninstallBITeamwork.[bat|sh] script.
  5. Restart the Oracle BI System Components
    • Open a command prompt or terminal.
    • Navigate to the BI_INSTANCE/bin directory, ex: C:\Oracle\FMW\instances\instance1\bin\
    • Execute the following commands at the prompt:
      • opmnctl stopall
      • opmnctl startall
  6. Verify that BITeamwork has been removed by
    • Logging in to the Business Intelligence application portal and navigating to the Administration page to see the BITeamwork Administration layout has been removed.
    • Verifying the WebLogic Server Deployments tab no longer contains an entry for BITeamwork.
    • Done!

Scaling up the Business Intelligence application involves leveraging the additional memory and processor resources on the existing server by adding additional server based application resources. This provides some level of redundancy on a single physical server. In the case of Oracle BI 11g, this typically involves a single physical (or virtual) server and adding one or more instances of the Oracle BI Server and/or Oracle BI Presentation Services System Components on that machine. Although this does not provide a failover effect, it does allow for the server to leverage the additional Server Component instances in a multi-threaded fashion. This ultimately allows for better usage of the physical server memory and processor resources.

In the case of BITeamwork, no additional requirements or installations steps are required for installing on to a Scaled-Up Oracle BI 11g environment. This is due to the fact that in a Scaled-Up environment, the web-based applications and libraries are not themselves replicated and no new instance of the Managed Server is created as in a Scaled-Out environment. Therefore, the standard BITeamwork installation process should be followed in this scenario.

Expanding the BI Application System so that it scales on to another physical server for high-availability plus failover and overall redundancy is referred to as Scale-Out architecture. This process places the software components comprising the BI Application on two separate physical (or virtual machines). The machines will have separate IP addresses on the network. This process also involves load balancing. This is the recommend operation for organizations that require low disruptions and high up-time of the BI System as it is crucial to daily business operations.

BITeamwork installs easily into a scaled-out environment. If your BI Application is deployed on a scaled-out environment, we'd like to better understand your BI architecture in order to better assist you with this more advanced installation and configuration. Please contact BITeamwork Support for assistance to ensure success.

Updates or Hot Fixes are released to fix or enhance or stabilize BITeamwork.

Distinguishing HotFixes from Updates

BITeamwork updates are released periodically as enhancements requests, bug fixes, and other functionality is implemented into the software product. This is usually once a quarter. A Hot Fix is considered an emergency patch release that may not apply to all customers but may fix a very specific set of functionality. Hot Fix release schedules cannot be predicted and are typically released on a customer-by-customer basis although the Hot Fixes will be made available for download to all customers holding an active Maintenance and Support subscription. Both Hot Fixes and Updates for BITeamwork are made available through the Customer Portal or per request from our Support team.

Major releases are considered to be an "Upgrade" not an "Update". For example, an update release would be from BITeamwork version 1.6 to version 1.7. A general hot fix or patch would be for example: 1.7.001, and usually does not include any updates to the SQL Database repository. A major release would be version 2.0 or version 3.0. We make a big deal about major releases and the process to Upgrade from your existing version to the Upgrade Major Release version will come with its own instructions for upgrading the currently deployed BITeamwork product to that newer version release.

How to Apply an Update or HotFix

  1. Download the Hot Fix or Update from the BITeamwork portal using your customer login credentials
  2. Unzip/Decompress the downloaded update file and transfer the resulting WAR file to the BITeamwork folder existing in your FMW_HOME

    Figure update_1
  3. Open WLS Admin Console
  4. Click on Deployments from Domain Structure navigation pane
  5. Click the Lock & Edit button
  6. Locate the BITeamworkOBI11g (<version#>) and click in the checkbox to select this record

    Figure update_2
  7. Click the Update button to begin the update of this file to the latest version
    You may also choose to stop the old version of BITeamwork at this point by using the "Stop > Immediately" which is okay to do. If you choose to stop the existing deployment you can safely ignore the one step below to Retire the existing application as stopping the deployed application already retires it.
  8. Change the Source Path selection from the existing path to the new WAR file located in the same directory when the Update Application Assistant wizard appears.

    Figure update_3
  9. Select the correct version from the options available in the selection pane

    Figure update_4
  10. Click the Next button
  11. Select the option, Retire the previous version after retire timeout.
  12. Click Finish
  13. Click the Activate Changes button in the Change Center area when returned to the Deployment page in order to complete the operation.
    During this time the update is initializing an deploying based on the same logic as he original BITeamwork installation. Once the Activate Changes action completes you may scan the Deployments list and notice that there are now two (or more) existing BITeamwork applications in the list. If both are set to an "Active" status then the previous version is still being retired. Refresh the page to see the previous version revert to a "Retired" status which means that it is no longer in use. Only the "Active" deployed BITeamwork application is the one that will be referenced.

    Figure update_5
  14. Restart the Oracle BI 11g System Components by using the Enterprise Manager Fusion Control or the opmnctl functionality.

    Figure update_6
  15. Done. Your update or hot fix should now be in place. Begin testing to ensure all data and relevant issues have been resolved or new features currently function as expected. If you have any issues, please report them immediate via Support.
    You may need to refresh each browser (ctrl+F5 or Cmd+R [mac]) when upgrading to see new functionality or fixes as the presentation files have been modified. This is easiest by clearing the browser cache and deleting all cookies and temporary files from the browser.

BITeamwork 2.0 brought the ability to use SQL Server as the underlying metadata repository for the BITeamwork application. The installation scripts handle the configuration of connecting the SQL Server data source to the WebLogic server, however, the following considerations should be taken into account.

Set Mixed Mode Authentication

  • Set the SQL Server system Server Authentication to ("Mixed Mode") SQL Server and Windows Authentication mode for security access via non-centralized login

    Figure sql_server_repo_1
  • BITeamwork uses the default Weblogic SQL Server Type 4 driver. However, the SQL Server JDBC driver is included in the installation files if for some reason you need to use this specific SQL Server JDBC driver one would make changes for the installation file or the JDBC connection once installed by updating the JDBC driver to:
    • com.microsoft.sqlserver.jdbc.SQLServerDriver
      And the URL becomes, jdbc:sqlserver://localhost:1433
      instead of the WebLogic driver
      weblogic.jdbc.sqlserver.SQLServerDriver
      which had a default URL of, jdbc:weblogic:sqlserver://localhost:1433
  • If installing the BITeamwork repository in an MS SQL Server instance the configuration URL will change to:

    jdbc:weblogic:sqlserver://localhost\instancename:1433
    otherwise it will be against the default instance and will appear as jdbc:weblogic:sqlserver://localhost:1433

  • The WebLogic SQL Connection Test Query in the JDBC Data Source for SQL Server is:

    SQL SELECT 1

Update the Installation File Connection Configuration

The installation file provided with the BITeamwork software is set by default to load into a Oracle RDBMS. If you decide to use MS SQL Server to store the BITeamwork metadata instead of Oracle RDBMS, then:

  • Comment out the Oracle based settings for DB_VENDOR.

    Figure sql_server_install_1
  • Comment out the Oracle based settings for DB_DRIVER and DB_URL and use the ones under the section for MS SQL Server.

    Figure sql_server_install_2
  • After making these changes and following the instruction steps for installing BITeamwork you should be good to go.

SQL Server JDBC Issues / Troubleshooting

If you fail to follow the steps and configuration pre-requisites above for MS SQL Server you may fall victim of the following error when running the BITeamwork installation. If the logic below is presented to you then be sure to double-check that you have followed all pre-requisites for MS SQL Server prior to running the installation script and you have verified connectivity to the SQL Server database using mixed mode authentication.

This Exception occurred at Sat Nov 29 01:14:49 UTC 2014. weblogic.application.ModuleException: Problem invoking WLST - Traceback (innermost last): File "C:\tmp\BITeamwork_3.0\InstallFiles\createDSandDeployApp.py", line 320, i n ? File "", line 376, in activate File "", line 1847, in raiseWLSTException WLSTException: Error occured while performing activate : Error while Activating changes. : Use dumpStack() to view the full stacktrace