Skip to main content

Getting Started

fusioh-net-lib-oracle is a TypeScript library for interacting with Oracle HCM (Human Capital Management) systems. It provides networking capabilities for REST/SOAP requests, RTK Query services, and BI Publisher integrations.

Features

  • REST API Integration - HTTP-based API calls via axios with token authorization
  • SOAP Requests - XML/SOAP protocol with Web Worker implementation to bypass browser header restrictions
  • RTK Query Services - Redux Toolkit Query services with normalized caching
  • BI Publisher - CRUD operations for Oracle BI Publisher: folders, reports, data models
  • Content Server - File management operations for Oracle WebCenter Content
  • Zod Validation - Runtime schema validation with TypeScript type inference

Quick Start

Installation

npm install @fusioh-tech/fusioh-net-lib-oracle
# or
yarn add @fusioh-tech/fusioh-net-lib-oracle

Basic Setup

import { ConfigHolder, ClientManager } from '@fusioh-tech/fusioh-net-lib-oracle';

// Define your client configuration
const client = {
name: 'my-client',
environments: [
{ name: 'production', url: 'https://my-hcm-instance.oraclecloud.com' },
{ name: 'test', url: 'https://my-hcm-test.oraclecloud.com' },
],
};

// Initialize the ClientManager
const clientManager = new ClientManager({
client,
localModeVariables: { localEnv: 'test' },
});

// Initialize ConfigHolder with your configuration getter
const configHolder = await ConfigHolder.getInstanceV2({
clientManager,
});

Architecture Overview

Core Components

ComponentDescription
ConfigHolderSingleton for managing request configuration. Must be initialized before making requests.
ClientManagerEnvironment/client detection and base URL management. Handles Oracle HCM URL validation.

Request Methods

The library provides three primary approaches for Oracle HCM communication:

  1. REST - Standard HTTP-based API calls via axios
  2. SOAP - XML/SOAP protocol with Web Worker implementation
  3. RTK Query - Redux Toolkit Query services with normalized caching

Next Steps