Overview
The ReportFactory Lite APEX Application is a companion application that simplifies the integration of ReportFactory Lite with Oracle APEX. It provides a user-friendly interface for managing report definitions, testing reports, and configuring the reporting engine.
Prerequisites
-
Oracle APEX workspace with application import privileges
-
Oracle APEX version 24.2 or up
-
ReportFactory Lite engine deployed and running
-
Database schema with necessary privileges for DBMS_CRYPTO package
Installation Steps
Step 1: Import the Application
- Login to APEX Workspace
- Access your APEX workspace as a developer or administrator
- Navigate to App Builder
-
Click on App Builder from the main menu
-
Select Import from the available options
- Upload Application File
-
Click Choose File and select
arflite-apex-app.sqlfrom the apex-application folder -
Click Next to proceed
Step 2: Configure Import Settings
- Select Import Type
-
Choose Database Application, Page, or Component Export
-
Click Next
- Install Supporting Objects
-
Select Install Supporting Objects when prompted
-
This will create necessary database objects including PL/SQL packages
- Complete Installation
-
Follow the installation wizard prompts
-
Accept default settings unless specific customization is required
-
Click Install to finalize the process
Step 3: Launch and Configure
- Run Application
-
After successful installation, click Run Application
-
The application will open in a new browser tab
- Login Credentials
-
Use the default credentials provided during installation
-
Change default passwords after first login for security
Initial Configuration
Step 1: Access Settings
- Navigate to Settings
-
Login to the ReportFactory Lite APEX application
-
Click on Settings from the main navigation menu
Step 2: Configure Connection Details
Provide the following configuration parameters:
- Base URL
-
Set the ReportFactory Lite API endpoint
- API Key
-
Enter the API key configured in the ReportFactory Lite application.properties
-
This must match the
app.api-keyvalue
- AES Encryption (Optional)
-
Enable if you configured encryption in ReportFactory Lite
-
Provide encryption key and IV if enabled
-
Must match the values in application.properties
Step 3: Apply Configuration
- Save Settings
-
Click Apply Changes to save the configuration
-
The application will validate the connection to ReportFactory Lite
- Test Connection
-
Use the built-in connection test feature to verify setup
-
Resolve any connection issues before proceeding
Post-Installation Setup
Database Objects Created
The installation creates the following database objects:
-
PL/SQL packages for API integration
-
Tables for report definitions and configuration
-
Views for report management
-
Sequences for primary key generation
Security Configuration
- User Management
-
Configure appropriate user roles and permissions
-
Set up authentication schemes if required
- API Security
-
Ensure API keys are stored securely
-
Use encryption for sensitive data transmission
Verification
Test Basic Functionality
- Access Report Definitions
-
Navigate to Report Definitions from the menu
-
Verify the page loads without errors
- Run “HELLO_WORLD” Test Report
- Try running HELLO_WORLD test report
Troubleshooting
Common Issues
Connection Failed
-
Verify ReportFactory Lite is running and accessible
-
Check firewall settings and network connectivity
-
Confirm API key matches configuration
Import Errors
-
Ensure sufficient privileges for installing supporting objects
-
Check APEX workspace quotas and limits
-
Verify Oracle Database version compatibility
Authentication Issues
-
Reset application passwords if needed
-
Check user authentication schemes
-
Verify database user privileges