BITeamwork's management console ("Control Panel") is housed within the Oracle BI Administration page. Therefore only a user account having the Business Intelligences System's Administration privileges may access the console.

Not only has BITeamwork's management system been directly embedded in the Oracle BI application, it re-configures the Oracle BI Administration page contents so that they are more accessible based on usage. This allows a better user experience for accessing both the Oracle BI administrative components as well as those for BITeamwork.

This document lists all of the information regarding the BITeamwork Management Console such as how it is accessed, each area of management, how it is embedded in the BI Application, etc.

As mentioned in the Getting Started section above, the BITeamwork management console is located on the Administration Page of the Business Intelligence application. During the installation of BITeamwork, the out-of-the-box configuration for the Oracle BI Administration page will be customized using the BI System's API. The result is the BITeamwork enhanced Administration page which contains several tabs to provide a stronger user experience. The tab marked "BITeamwork" (a.k.a BITeamwork Control Panel) provides access to the core BITeamwork management console.

Access the BITeamwork Control Panel by clicking on the Administration link in the Global Header of the Oracle BI Application.

See the BITeamwork Layout

The Administration Page of Oracle BI, after the installation of BITeamwork is based on an easy access tab user interface. By clicking on a tab, the content within the tab area changes to show information respective to the tab label. The tabs are labeled as seen in the image below and described by number beneath it.


Figure layout_1
  1. General Tab
    • Provides access to basic, and most commonly used features used in the administration of Oracle BI 11g.
  2. Advanced Tab
    • Provides access to the lesser used features of Oracle BI 11g administration
  3. MDSearch Tab
    • Provides access to the MDSearch Metadata Suggestion tool's configuration options.
  4. BITeamwork Tab
    • Provides access to the BITeamwork Management Console enabling the Oracle BI 11g Administrator to configure BITeamwork. The options within the BITeamwork tab are listed on the left-side of the tab content.

    • Figure layout_2

The Company section of the BITeamwork tab provides the central configuration for the BITeamwork licensee and company information such as Company Name and Company Logo.

When a customer purchases a license for the Enterprise Edition BITeamwork the customer receives a unique license key. In order to activate the Enterprise Edition features the license key must be entered in the field labeled License. This is also true for customers testing the product under the 15-day trial once they receive a trial license key from their trial request.


Figure company_1

How to Enter a License Key

After licensing BITeamwork or accepting a 15-day trial the license key you receive must be entered on the Company section of the BITeamwork tab in order to access all Enterprise Edition functionality. In order to do this:

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Company link
  3. Enter the Company Name and Contact Email provided in the license email
  4. Enter a contact phone number in the Phone #
  5. Enter the License Key in the in the License field
  6. Click the Save button

The goal of the Environment Eye is to provide users of Oracle BI 11g with a reference to the environment in which they are currently operating. The Environment Eye provides a banner across the top portion of the Oracle BI 11g application. This provides users with a visual reference so that adjustments are not mistakingly made to the wrong environment as seen in the image below.


Figure environment_eye_1

The Environment Eye banner is controlled by the Administrator by editing the fields in the Environment Eye section and setting the Active Status dropdown value to True.


Figure environment_eye_2

How to Edit the Environment Eye

After licensing BITeamwork or accepting a 15-day trial the license key you receive must be entered on the Company section of the BITeamwork tab in order to access all Enterprise Edition functionality. In order to do this:

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Environment Eye link
  3. Update the fields on the form
  4. Click the Save|Submit button

Description of Edit Fields for Environment Eye

  1. Alias
    • Used to identify the object
  2. Message Text
    • The text that appears on the Environment Eye banner
  3. Background Color
    • The color of the Environment Eye banner
  4. Font (Hex) Color
    • The text color of the Environment Eye banner
  5. Font Size
    • The text size of the Environment Eye banner
  6. Mode
    • The mode/style of the Environment Eye banner (Default is default)
  7. Active Status
    • Determines if the Environment Eye banner is visible in the environment or not

The ability for BITeamwork to work on the BI Server without interference or calls from other servers such as cross-site access a blocking mechanism referred to URI Access is in place. By default the "localhost" and "*" options are configured during installation of BITeamwork. The "localhost" option allows for access of BITeamwork to work on the server on which it is deployed. The "*" (asterisk) option allows for any other URL contacting the BITeamwork REST and URL commands to be called from that location.

On a closed network BI Server, such as a Oracle BI environment not accessible outside of the Intranet, the default settings may remain. However, if the Oracle BI application is accessible via the Intranet consideration to input a a new entry for the publicly accessible DNS should be made. In this case, entries should be made for the Top-Level Domain only.

How to Manage URI Access

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the URI Access link
  3. The following management options are available:
    • Create a new entry by clicking the + Add New URI Code button
    • Edit an existing entry by selecting the Edit button corresponding to the entry from the list
  4. Edit the form fields when creating or editing an entry.
  5. Click the Save button

Figure uri_access_1

How to Create or Edit a Splash Page

  1. Access the URI Access Management option in the BITeamwork Control Panel
  2. Click on the Edit button corresponding to the Splash Page of which you wish to edit
  3. Edit the form fields
  4. Click the Save button.

Figure uri_access_2

Note on URI Access and the Default Settings


URI Access was designed to allow only users from only designated access points to access your BITeamwork solution in your Oracle BI implementation. Although this is a security consideration and not really applied out-of-the-box we still believe there will be a use case for this functionality at which point we will provide guidance. The default URI Access records (i.e.: "*" and "localhost") installed during the BITeamwork installation should not be removed or edited.

A splash page allows the Oracle BI system to announce or otherwise convey information to end users of the system with an obstructive pop-up window displaying a simple or complex message. Splash pages are created by the BITeamwork Administrator. They can be scheduled to display for a certain period of time or manually set to a visible status. The Enterprise Edition version can create and save multiple Splash Page entries. Regardless of the number of Splash Pages created only one splash page can be made visible at any one time.

Splash pages display to everyone accessing the Oracle BI system and appear on the following areas of Oracle BI:

  • Sign-in Page
  • Catalog Page
  • Home Page

Users can dismiss the Splash Page by clicking off of the Splash Page pop-up or prevent the Splash Page from re-appearing again for the day by checking the Please don't show this message again today checkbox and then clicking the Close button.

Below is the BITeamwork Management Console view for editing Splash Pages.

How to Manage Splash Pages

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Splash Page link
  3. The following management options are vailable:
    • Create a new entry by clicking the + Add Splash Page button
    • Edit an existing entry by selecting the Edit button corresponding to the entry from the list
    • Delete an existing entry by selecting the Remove button corresponding to the entry from the list
  4. Edit the form fields when creating or editing an entry.
  5. Click the Save button

Figure splash_page_1

How to Create or Edit a Splash Page

  1. Access the Splash Pages Management option in the BITeamwork Control Panel
  2. Click on the Edit button corresponding to the Splash Page of which you wish to edit
  3. Edit the form fields
  4. Click the Save button.

Figure splash_page_2

Categories are provided as an attribute selection mechanism as end-users create comments within Oracle BI 11g. Ultimately categories can be used to segment or otherwise bucketize comments. The BITeamwork Administrator manages the categories in the BITeamwork Management Console.

How to Manage a Categories

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Categories link
  3. Create a new entry by clicking the + Add Category button
    - or -
    Edit an existing entry by selecting the Edit button corresponding to the entry from the list
  4. Edit the form fields

    The Sort Order field provides the means to order the categories so they appear in a specific sequence when presented to the end users.

  5. Click the Save|Add Category button

NOTE: If the list of records is long you can use the search box to begin typing the name of a potential records to dynamically filter the results.


Figure categories_1

How to Edit a Category

  1. Access the Category Management option in the BITeamwork Control Panel
  2. Click on the Edit button corresponding to the category of which you wish to edit
  3. Edit the form fields
  4. Click the Save button.

Figure categories_2

Comments can become untimely or for some reason become unnecessary. As an administrative feature you are able to remove comments from the system.

Comments are Soft Deleted

BITeamwork uses a concept referred to as Soft Deletion in order to purge/delete comments from the BITeamwork system. This means that the records are not truly removed/deleted from the underlying database repository but rather a flag column is toggled to an "is deleted" state rendering the visibility of comments off.

Figure purger_1

How to Purge Comments

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Manage Comments link
  3. Select a user from the Comments from Users(s) list box or select All Users
  4. Select date range by editing the Date Start and Date Finish fields
  5. Select the type of comments to delete by choosing an options from the Comment Type dropdown

    For example, Choosing Analysis Cell would delete only the cell comments for for the user and date range selected in the form once the Save button is clicked.

  6. Click the Save button to save the configuration

The ability for users to operate the BITeamwork the functionality of BITeamwork such as creating comments, etc. can be restricted on a per user or per Application Role basis. These privileges are separate from the Oracle BI 11g privileges but are controlled from the BITeamwork Management Console.


Figure security_1

How to Add or Remove Privileges

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Manage Privileges link
  3. Select a privilege option from the Privilege dropdown
  4. Select a principal type from the from the Principal Type, User or Application Role
    • Based on the principal type selected a list of principals filtered by that type appear in the left listbox column
  5. Add a principal to an access privilege by moving the principal (i.e.: User(s) or Application Role(s)) from the left column to the right column by clicking on the Add button between the columns
  6. Remove a principal from an access privilege by selecting the principal (i.e.: User(s) or Application Role(s)) from the right column and moving it ot the left column by clicking on the Remove button between the columns
  7. Click the Save button to save the configuration

Note on Populating Security

Application Roles and Users are populated in this section by the Sync Manager. The Sync Manager communicates with the Oracle BI System Web Services and requires an Oracle BI administrator user's credentials to be updated in the Web Service Manager section and then the Sync Manager to be executed.
See Configuring the Oracle BI Web Service and Using Sync Manager

An advanced collaboration feature for BITeamwork is leveraging Social Vendors such as Salesforce Chatter and Yammer. After the basics of creating social vendor application for your organization has been accomplished, along with any pre-requisites, the Social Vendor must be configured in the BITeamwork Management Console so that BITeamwork can make a reference to the social vendor application.


Figure social_1

How to Edit a Social Vendor

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Social Apps link
  3. Select a Social Vendor from the Social Application dropdown
  4. Update the following required fields
    • API URL

      Is the URL for the instance of Social Vendor portal for which you will connect this environment. This is typically the main login url path you use for your company to connect to the social vendor website or the specific security URL assigned to your company. For example, organizations using Salesforce.com have a My Salesforce.com portal URL, which is usually https://mycompanyname.salesforce.com/.

    • API Secret
    • API Key
    • Access Scope

      For Salesforce.com the default value is id api refresh_token which reflects the settings required for the Salesforce.com Administrator to enter for OAuth privileges when they create the Custom App in the Salesforce.com portal.

    • Callback URL
      • This URL must be in the following format http://<server_name>:<port>. For example, https://intranet.obiee.companyxyz.corp or https://intranet.obiee.companyxyz.corp:9704
      • No trailing slash should be entered
      • Salesforce Chatter requires an SSL Callback (Read more)
    • Active Status
    • Test Social Connection

      Usage Note: Although this is not a field that requires editing, it is a link that only works after the social vendor configuration has been completed, the save button pressed, and the page refreshed. If the page is not refreshed the Test Social Connection link is not operational.

  5. Click the Save button to save the configuration

Note on Callback URL

Enter ONLY the Server Name and port in the Callback URL form, i.e.: http[s]://<server_name>[:<host_name>].
FYI, the BITeamwork application dynamically concatenates this URL path at runtime to the one shown below (not entered by you) in order to receive the proper callbacks from the Social Vendor Application.
  • For Yammer
    • https://servername:port/bitw/x/social/yammer/callback
  • For Salesforce.com Chatter
    • https://servername:port/bitw/x/social/chatter/callback

Troubleshooting a Social Vendor Connection Attempt

Below are issues we've seen encountered when configuring or attempting to access this social vendor.
Usually, once the configuration has been successfully completed there is no need to adjust the settings for the Social Vendor for on any continued frequency.
  • Blank Screen in IE after Clicking the Authorize Chatter link in Collaboration Pane
    • This is usually a problem with one of the values entered either on the social vendor site or through BITeamwork's configuration area. Use a different browser such as FireFox or Chrome to see the error message as shown by the Social Vendor.

Maintenance Mode provides an Oracle BI Administrator with the ability to cast a page block description on the BI Application in order to inform users that the BI Application is down or undergoing maintenance. A custom message can also be displayed in order to communicate the maintenance window and effort. The use case for this functionality is to ensure that during migrations or other maintenance window causing efforts that users understand potential risk of loosing data or accessing stale data if accessing the system during a maintenance window.


Figure maintenance_1

How to Edit Maintenance Mode

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Maintenance Mode link
  3. Update form field values
  4. Click the Save|Submit button to save the configuration

Sync Manager provides the ability for BITeamwork to update its core metadata repository with the most recent updates or changes within the Oracle BI environment. This is mainly surrounding Application Roles, User updates, and other metadata aspects of Oracle BI. This area is required as BITeamwork acts as a guest on the Oracle BI system and as such only has access to the most current Oracle BI metadata at server start-up and re-sync.


Figure sync_1

How to Use Sync Manager

  1. Click on the BITeamwork tab on the Administration Page
  2. From the left navigation options click the Sync Manager link
  3. Determine which link or action to conduct
    • Refresh Application Roles
      • Updates the BITeamwork application with the latest recently added Application Roles and Users. An use case for executing this sync would be after adding a new application role via Enterprise Manager or WLST and needing to update BITeamwork privileges. In which case a sync is required so that BITeamwork can reference the newly created Application Role.

The Oracle BI Web Service integration is a key feature of BITeamwork for Oracle BI. Without it many of the features in BITeamwork will not work properly. In order to configure the Web Service for BITeamwork to access a user with all SOAP privileges must be used and that accounts credentials stored in the OBIEE Web Service page from the BITeamwork management console. The WS URL should be the full URL to reach the Oracle BI 11g WSDL, for example: http[s]://<server_name>:9704/analytics-ws/saw.dll/wsdl/v6

Enter the credentials for the user who will act as the power user making calls to Oracle BI on behalf of BITeamwork. The credentials are stored in th BITeamwork repository and encrypted with a high level of algorithm similar to that which is used popular e-commerce systems such as Facebook.com.


Figure ws_config_1

As an insightful feature, BITeamwork pulls metadata and JVM stats from the server on which the BI Server Application is hosted. This information is viewed within the BITeamwork Management Console. Clicking on the Server Information link on the left panel of the BITeamwork Management Console will show the Server Information metadata as well as the version of BITeamwork currently deployed to the BI Server.


Figure server_info_1

Application information regarding BITeamwork is controlled in this section of the BITeamwork Control Panel. Items found in this section would be global configuration settings such as cell comment color and icons, providing attribute values for the location of the Fusion Middleware (FMW) HOME folder, etc. Each of the items is listed below in further detail:


Figure server_app_info_1
  • Cell Comment Icon:
    • URL path for icon to indicate that a cell comment when exists. Icons should be 16px x 16px in dimension. Valid URL syntax examples include:
      • http://mycompany.com/images/icon.png
      • /bitw/images/icons/[fire-small|balloon-small|plus-small].png
    • Default: Blank
  • Cell Comment Color:
    • Determines the background color of a cell comment/annotation on a dashboard report view.
      • Any single hex color code or text color. For example, #FF9900 for a bright orange or pink for the color pink. Text colors are acceptable but hex colors are preferred.
  • SideBar Bkg Color:
    • Determines the background color of a collaboration pane shown in the dashboard.
      • Any single hex color code or text color. For example, #FF9900 for a bright orange or pink for the color pink. Text colors are acceptable but hex colors are preferred.
  • SideBar Logo URL:
    • Provides an image URL that will be shown towards the top of the collaboration pane in the dashboard.
      • Any URL referencing a valid image accessible through the firewall on which the BI System resides will be permitted.
        A refresh of the BITeamwork collaboration pane is required for this change to take affect. Users which have not previously logged in to the BI portal will see the change of the URL once it has been made in the BITeamwork Control Panel. Other users having already accessed the system may require a refresh of BITeamwork or wait until their session times out (one day) in order to see the change.
  • SideBar Logo Position:
    • Determines the position of the image established in the SideBar Logo URL fields.
      • The dropdown menu provides the only relevant options: left, center, right. Center is the default.
  • Default Language:
    • Establishes the default language of the BITeamwork collaboration system. This is a localization override. This means that if there is a valid locale entered in this text field then it will negate any other language localization attempts for users reaching the BI System from another language location.
      • The default is a blank field. A valid two (ex: EN) or five code (ex: EN-US) locale is required.
        If desiring the localization of key terms and messages from the BITeamwork Collaborative BI plug-in to be translated then leave this field blank.
  • Scratch / Temp Dir:
    • This is a directory on the BI System (where BITeamwork is also deployed) which may be accessed to read and write temporary files.
      • An icon to the left of the field indicates whether or not the location is accessible. If the icon is red then the location is either not found on the server or proper read/write permissions are not set. If the icon is green then the location is accessible.
        On a Linux Operating System all paths should start the reference to this physical location with the root directory forward slash (/). On a Windows Operation System use the full drive letter path with the standard back slash (\). After entering the path and saving the form you must refresh the page in order for the icon to change color indicating the accessibility of the directory location entered.
  • FMW HOME Dir:
    • In Oracle BI this location is the Fusion Middleware (FMW) Home directory in which the BI System is installed. Common folders inside of this directory are /user_projects, /Oracle_BI1, and /instances.
      • An icon to the left of the field indicates whether or not the location is accessible. If the icon is red then the location is either not found on the server or proper read/write permissions are not set. If the icon is green then the location is accessible.
        On a Linux Operating System all paths should start the reference to this physical location with the root directory forward slash (/). On a Windows Operation System use the full drive letter path with the standard back slash (\). After entering the path and saving the form you must refresh the page in order for the icon to change color indicating the accessibility of the directory location entered.
  • Cluster Instances:
    • Enter instances by name residing in the BI System architecture separated by a colon (:).
      • This provides BITeamwork with an understanding of the scaling of the BI System and also provides the logic for the dropdown options when viewing the configuration files manager in the BITeamwork Control Panel.
    • Example: instance1:instance2, or instance2:instance3:instance4, or simply, instance1
  • Admin Page Window'd:
    • This option provides the ability to modify the default options of the Oracle BI Administration link for any administrators of the BI System. By setting this value to True, once the page is refreshed, all subsequent clicks on the Administration link in the Oracle BI Global Header will open the Administration page in a new pop-up window. This is similar to the default operation in the legacy version of Oracle BI, Oracle BI 10g.
      • Default value is False.
  • Show Sketch:
    • Determines if the Sketch option is visible to users having access to the BITeamwork collaboration pane when viewing a dashboard. The sketch option is the option which allows a user to mark the screen with an overlay which is toggled via the marker icon .
      • Default value is True.
  • Minimum Comment Length:
    • Determines the smallest number of characters that can be entered in the comment fields to leave a comment or annotation.
      • Default value is 6.
      This feature is very important in non-latin language such as Chinese where a single character could have the same meaning as a full sentence in English.
  • Attribute #1:
    • TBD and Support Usage Only.
  • Attribute #2:
    • TBD and Support Usage Only.
  • Application Active:
    • Default value is True. There is no other option for shutting off the entire BITeamwork application in the current release.

BITeamwork allows administrators visibility into the underlying configuration files which are at the core of OBIEE. These files known simply by their names, NQSConfig.INI and InstanceConifg.xml are available in read only format. By clicking the link on the BITeamwork Control Panel tab, and administrator may copy and paste elsewhere the values of the file or simply use it as a reference.

This is done seamlessly once the administrator enters the appropriate FMW_HOME values in the application manager section. We achieve this perspective without requiring the administrators to log into a terminal window or using an FTP system to access these files.

As of the current release the configuration files are read-only when viewed in the Configuration File Manager.


Figure config_files_1

In the case of a scaled-up or scaled-out architecture the dropdown labeled Select Instance provides the means to predicate the configuration files on which instance's files are to be referenced.

The Support section within the BITeamwork Management Console provides information on how and where to submit product enhancements, support tickets, and accessing BITeamwork forums. Clicking on the the Support link in the left navigation area of the BITeamwork Management Console shows this information. All support and maintenance is a conducted in accordance to our Maintenance and Support Service Level Agreement.


Figure support_1