1. Oracle Autonomous Health Framework User's Guide
  2. Installation

Installation

Follow the installation procedures sequentially to install Oracle Health Check Collections Manager.

Note:

Upgrade Oracle Health Check Collections Manager directly from Oracle Autonomous Health Framework.

Configuring Oracle Application Express and Creating a Workspace

Configure Oracle Application Express and create a workspace for the Oracle Health Check Collections Manager application.

Install and Configure Oracle Application Express

  1. Download the latest version of Oracle Application Express.
  2. Install and configure Oracle Application Express. For installation and configuration instructions, see the Oracle Application Express Installation Guide.

Create a Workspace

  1. Log in to Oracle Application Express Administration Services.

    Note:

    The URL used to access Oracle Application Express Administration Services depends on how Oracle Application Express was deployed.

    If Oracle Application Express was configured using Oracle HTTP Server with mod_plsql, use:

    http://host:port/pls/apex/apex_admin

    If Oracle Application Express was configured using the Oracle XML DB HTTP listener with the embedded PL/SQL gateway, use:

    http://host:port/apex/apex_admin

    For example:

    http://dbserver.domain.com:8080/apex/apex_admin

    The default schema user for Oracle Application Express Administration Services is ADMIN.

    The password is the password specified when the Oracle Application Express component was configured in the Oracle Database.

  2. In the Oracle Application Express Administration home page, click Manage Workspaces.
  3. Under Workspace Actions, click Create Workspace.

    The Create Workspace wizard appears.

  4. In Identify Workspace, specify the workspace details:

    • Workspace Name: Enter a unique workspace name, for example, ORAchk_CM_WS.
    • Workspace ID: Leave this field blank to have Oracle Application Express automatically generate the workspace ID. The workspace ID must be a positive integer greater than 100000.
    • Workspace Description: Enter a description for the workspace.
    • Click Next.

    Note:

    Associate the workspace with a database schema.

  5. In Identify Schema, specify whether to reuse an existing database schema or create a new schema.

    The choice depends on whether Oracle Orachk and Oracle Exachk are already configured to upload data to a schema in the database.

    Note:

    Do not use the Oracle Application Express administration schema (ADMIN) as the workspace schema.

    If an existing schema is available:

    • For Re-use existing schema, select Yes.
    • Select the required schema from the list.
    • Click Next.

    If you need to create a new schema:

    • For Re-use existing schema, select No.
    • Enter the schema name and password, for example, ORAchk_admin.
    • Specify the space quota.
    • Click Next.

    Note:

    The minimum space quota should be at least 100 MB to help prevent application import failures.

  6. In Identify Administrator, specify the workspace administrator details:

    • Enter the administrator user name and password.
    • Enter the required personal details.
    • Click Next.
  7. Review your selections and click Create Workspace.

    Oracle Application Express creates the workspace.

Manage the Workspace

After creating the workspace, you can review or modify its configuration.

  1. Click Manage Workspaces.
  2. Under Workspace Reports, click Existing Workspaces.
  3. To edit workspace information, click the workspace name.
  4. Modify the required information and click Apply Changes.
  5. Log out of Oracle Application Express Administration Services.

Log In to the Workspace

Log in to the Oracle Application Express workspace using the workspace name, user name, and password.

  1. Open the Oracle Application Express Admin User Workspace.

    Note:

    The URL used to access the Oracle Health Check Collections Manager application depends on how Oracle Application Express was deployed.

    If Oracle Application Express was configured using Oracle HTTP Server with mod_plsql, use:

    http://host:port/pls/apex/apex_admin

    If Oracle Application Express was configured using the Oracle XML DB HTTP listener with the embedded PL/SQL gateway, use:

    http://host:port/apex/apex_admin

    For example:

    http://dbserver.domain.com:8080/apex/apex_admin
  2. Enter the workspace name, workspace user name, and password.
  3. When you log in for the first time, Oracle Application Express prompts you to change the password.
  4. Log in again using the new password.

Oracle Application Express User Accounts

Oracle Application Express provides three types of user accounts:

User TypeDescription
Workspace AdministratorsCan create and edit user accounts, manage groups, and manage development services within the workspace.
DevelopersCan create and modify applications and database objects.
End UsersDo not have administrative or development privileges. They can access applications that do not use an external authentication scheme. Most Oracle Health Check Collections Manager users belong to this category.

Oracle Health Check Collections Manager also provides specialized roles, such as DBA Managers and DBAs, for managing application users and collections.

To grant non-administrative users access to Oracle Health Check Collections Manager, log in to the Oracle Application Express workspace as an administrator and create the required user accounts.

  1. Log in to the Oracle Application Express workspace as an administrator.
  2. Click the Administration tab.
  3. Click Manage Users and Groups.
  4. Click Create User.

    Create accounts for users who need to authenticate to Oracle Health Check Collections Manager and manage their collections, including application administrators, DBA Managers, and DBAs, as appropriate.

  5. Enter the user details.

    Use a consistent naming convention and specify a unique user name for each account. For example:

    firstname.lastname

    For non-administrative users, retain the default No setting for the following options:

    • User is a developer
    • User is a Workspace Administrator
  6. Assign a temporary password to the user and communicate it securely.

    Oracle Application Express prompts the user to change the temporary password when they log in for the first time.

  7. Click Create User.

Download Oracle Health Check Collections Manager Application

Download the latest Oracle Health Check Collections Manager application package before installing or upgrading the application.

  1. Download the latest Oracle Health Check Collections Manager setup package (CM_PACKAGE.zip) from My Oracle Support note 2550798.1.

    The package contains the following files:

    FileDescription
    Apex5_CollectionManager_App.sqlOracle Health Check Collections Manager application installation file.
    CM_wrapper.sqlWrapper script used during installation.
    CM_UpgradeScript.sqlScript used to upgrade an existing Oracle Health Check Collections Manager installation.
    readme.txtInstallation and usage instructions.
  2. Extract the contents of CM_PACKAGE.zip.
  3. Follow the installation or upgrade instructions provided in readme.txt.

Install Oracle Health Check Collections Manager Application

Install Oracle Health Check Collections Manager by importing the application SQL script into the appropriate Oracle Application Express workspace.

Before installing the application, verify that the workspace parsing schema has the required database privileges.

  1. Verify that the workspace administrator schema owner and the owner of the schema used to import Oracle Health Check Collections Manager have the following privileges:

    • CREATE JOB
    • EXECUTE on the DBMS_RLS package owned by SYS
    • EXECUTE on the UTL_SMTP package owned by SYS, if you plan to use the Oracle Health Check Collections Manager email notification feature

    Oracle Health Check Collections Manager is distributed as an SQL script. Stage the appropriate SQL script on the workstation from which you plan to install the application.

    Note:

    The EXECUTE privilege on UTL_SMTP is required only when you use the Oracle Health Check Collections Manager email notification feature. The application uses the UTL_SMTP package with the RAC13_EMAIL object. If the workspace owner does not have the required privilege, the object can fail to compile. The failure is reported in the Installation Summary. You can ignore the UTL_SMTP compilation issue if you do not plan to use the email notification feature.

  2. Verify that the schema has the required object privileges:

    SELECT GRANTEE, TABLE_NAME, PRIVILEGE
FROM USER_TAB_PRIVS;

    Example output:

    GRANTEE    TABLE_NAME    PRIVILEGE
---------- ------------- ----------
CM_USER    DBMS_RLS      EXECUTE
CM_USER    UTL_SMTP      EXECUTE

    Verify the required system privilege:

    SELECT USERNAME, PRIVILEGE
FROM USER_SYS_PRIVS;

    Example output:

    USERNAME    PRIVILEGE
----------- ----------
CM_USER     CREATE JOB
  3. Log in to the Oracle Application Express workspace.
  4. On the Oracle Application Express Home page, click Application Builder.
  5. Click Import.

  6. Click Choose import file, and select the SQL script appropriate for the Oracle Application Express version you are using.

    For Oracle Application Express 5.x, select:

    Apex5_CollectionManager_App.sql
  7. For File Type, select Database Application or Component Export, as appropriate.
  8. For File Character Set, select Unicode UTF-8.
  9. Click Next.
  10. Click Install Application.
  11. Configure the application installation settings.

    Note:

    Before importing the application, ensure that the parsing schema owner has EXECUTE privileges on the DBMS_RLS and UTL_SMTP packages and the CREATE JOB system privilege. Missing privileges can cause supporting database objects to fail during installation and prevent the application from being installed correctly.

    Configure the following options:

    • Parsing Schema: Select the schema associated with the workspace.
    • Build Status: Retain the default Run and Build Application option.
    • Install As Application: Select the appropriate application ID option.

    When possible, retain the existing application ID to simplify future upgrades.

    The application ID must be unique. Verify that the selected application ID is not already being used by another application or workspace within the Oracle Application Express Administration environment.

  12. Click Install Application.

    Installation can take several minutes to complete.

    Before continuing, verify the following:

    • Application name is correct.
    • Parsing schema is correct.
    • Sufficient free space is allocated for the application.
    • Install Supporting Objects is set to Yes.

    Grant any required privileges to the workspace owner if validation identifies missing privileges.

  13. Click Next.
  14. Review the supporting objects that will be installed, and then click Install.

  15. After the installation completes, review the Installation Summary.

    Check for errors and verify that:

    • Supporting database objects were created successfully.
    • Seed data was installed successfully.
    • No unexpected compilation or privilege errors occurred.
  16. Record the application ID displayed after the application is installed successfully.

    The application ID is used in the URL for accessing Oracle Health Check Collections Manager. Use the application ID when constructing the application URL and provide the correct URL to users who need access to the application.

  17. Click Run Application to open Oracle Health Check Collections Manager.

Log In to Oracle Health Check Collections Manager Application

Log in to Oracle Health Check Collections Manager to access health check results, review system health information, and manage collections based on your assigned privileges.

  1. Enter your user name and password, and then click Login.

    After you log in successfully, the Oracle Health Check Collections Manager Home page appears.

    By default, Oracle Health Check Collections Manager includes sample data to help new users become familiar with the application and its features. The Home page displays this sample data until your own health check data is uploaded to the application.

    When your own data starts streaming into the application through the configured automation and upload functionality, the application automatically hides the sample data. If health check results already exist in the database tables, that data replaces the sample data.

    The Home page contains Oracle JET charts that provide views such as:

    • Checks by Systems
    • Checks by Collection Date

    You can filter the information displayed in the charts by check status:

    • PASS
    • WARNING
    • FAIL

    Hover over a check status and select or deselect it to control which results are displayed.

    Status filtering works together with global filters such as:

    • Data Interval
    • Business Unit
    • System
    • Health Score

    Click a chart series to view detailed information about the corresponding checks for a specific system.

  2. To log in as an end user, obtain the application URL and login credentials from the application administrator.

    End users are non-administrative users with limited application access. They cannot perform administrative tasks unless administrator or developer privileges are explicitly granted.

    An end-user account must exist in the Oracle Application Express workspace where Oracle Health Check Collections Manager is installed.

    Provide end users with one of the following application URLs and the temporary password assigned to their accounts:

    http://hostname:port/apex/f?p=<ApplicationID>

    or:

    http://hostname:port/pls/apex/f?p=<ApplicationID>

    The URLs are interchangeable depending on the Oracle Application Express deployment.

    For example:

    http://dbserver.domain.com:8080/apex/f?p=103

  3. If required, delete the default sample data using either of the following methods:

    • Go to Administration > Delete Old Data, select a date, and then click Delete With Sample Data.
    • Go to Configure Email > Configure Mail Server/Notification/Purge Job, and then click Click To Purge SampleData.
  4. To load the sample data again, go to Configure Email > Configure Mail Server/Notification/Purge Job, and then click Click to Load SampleData.

Apply a Theme

Customize the appearance of Oracle Health Check Collections Manager by applying a theme.

  1. Enter your user name and password, and then click Login.
  2. From the Administration list, select Application Theme Style.

  3. From the Desktop Theme Style list, select one of the following themes:

    • Aubergine
    • Choco-Mint
    • Redwood-Light
    • Vita
    • Vita-Slate
  4. Click Apply Changes to apply the selected theme.