Oracle Trading Community Architecture Technical Implementation Guide

Contents

Title and Copyright Information

Send Us Your Comments

Preface

Overview

Introduction

API Overview

      Business Needs Met

      Granular Versus Business Object APIs

Business Events

Granular API Features, Parameters, Attributes and Messages

Major Features and Solution Outline

Standard Parameters and Missing Attributes (PL/SQL API)

Debug Messages (PL/SQL API)

Standard Parameters and Missing Attributes (Java API)

Debug Messages (Java API)

Security of Oracle Human Resources Data

Third Party Data Integration

Party and Party Information API Use

Party APIs

      Create Organization API

      Update Organization API

      Create Person API

      Update Person API

      Create Group API

      Update Group API

Party Information APIs

      Create Credit Ratings

      Update Credit Ratings

Party Contact API Use

Party Contact APIs

      Create Org Contact API

      Update Org Contact API

      Create Org Contact Role API

      Update Org Contact Role API

Person and Organization Information, Location, and Party Site API Use

Person Information APIs

      Create Person Language API

      Update Person Language API

      Create Citizenship API

      Update Citizenship API

      Create Education API

      Update Education API

      Create Employment History API

      Update Employment History API

      Create Work Classes API

      Update Work Classes API

      Create Person Interest API

      Update Person Interest API

Organization Information APIs

      Create Financial Report API

      Update Financial Report API

      Create Financial Number API

      Update Financial Number API

Location APIs

      Create Location API

      Update Location API

Party Site APIs

      Create Party Site API

      Update Party Site API

      Create Party Site Use API

      Update Party Site Use API

Contact Point API Use

Contact Point APIs

      Create Contact Point API

      Update Contact Point API

Relationship and Hierarchy API Use

Relationship Type APIs

      Create Relationship Type API

      Update Relationship Type API

Relationship APIs

      Create Relationship API

      Update Relationship API

Hierarchy Retrieval APIs

      Top Parent Check API

      Parent Child Relationship Check API

      Get Parent Nodes API

      Get Child Nodes API

      Get Top Parent Nodes API

Classification API Use

Classification APIs

      Create Class Category API

      Update Class Category API

      Create Class Code Relation API

      Update Class Code Relation API

      Create Code Assignment API

      Update Code Assignment API

      Create Class Category Use API

      Update Class Category Use API

      Is Valid Category API

Contact Preference API Use

Contact Preference APIs

      Create Contact Preference API

      Update Contact Preference API

Customer Account API Use

Customer Account APIs

      Create Customer Account API (Person or Organization)

      Update Customer Account API

      Create Customer Account Relationship API

      Update Customer Account Relationship API

Customer Account Site API Use

Customer Account Site APIs

      Create Customer Account Site API

      Update Customer Account Site API

      Create Customer Account Site Use API

      Update Customer Account Site Use API

Customer Profile and Customer Account Role API Use

Customer Profile APIs

      Create Customer Profile API

      Update Customer Profile API

      Create Customer Profile Amount API

      Update Customer Profile Amount API

Customer Account Role APIs

      Create Customer Account Role API

      Update Customer Account Role API

      Create Role Responsibility API

      Update Role Responsibility API

Source System Management API Use

Source System Managment APIs

      Create Source System Reference API

      Update Source System Reference API

      Remap Internal Identifier API

Bulk Import API Use

Bulk Import APIs

      Create Import Batch API

      Activate Import Batch API

Address and Tax Validation API Use

Location Service APIs

      Address Validation API

Adapter APIs

      Create Adapter API

      Update Adapter API

      Create Adapter Territory API

      Update Adapter Territory API

Tax Assignment APIs

      Create Location Assignment API

      Update Location Assignment API

Data Quality Management API Use

Data Quality Management Search and Duplicate Identification APIs

      Find Parties API

      Find Persons API

      Find Parties and Details API

      Find Party Sites API

      Find Contacts API

      Find Contact Points API

      Identify Duplicate Parties API

      Identify Duplicate Party Sites API

      Identify Duplicate Contacts API

      Identify Duplicate Contact Points API

      Get Score Details API

      Call API Dynamic API

      Call API Dynamic Names API

Data Quality Management Availability APIs

      Is DQM Match Rule Available API

      Is DQM Index Available API

Data Quality Management Transformation APIs

      Replace Word API

Find Parties Object API

Data Quality Management Merge APIs

      Create Merge Request API

      Get Party Merge Details API

      Get Account Merge Details API

Extensions API Use

Extensions APIs

      Create or Update Organization Profile Extension

      Create or Update Person Profile Extension

      Create or Update Location Extension

      Create or Update Party Site Extension

Formatting API Use

Phone Parsing and Formatting APIs

      Phone Number Parsing API

      Phone Number Formatting API

      Check Mobile Phone Number API

Name and Address Formatting APIs

      Name Formatting API

      Address Formatting API

General Data Formatting API

Sample Granular API Code

Sample Code - Demonstrating the APIs

      Create an Organization

      Create a Location

      Create a Party Site

      Create a Party Site Use

      Create a Contact Point (Phone)

      Create an Organization Contact

      Update a Location Record

      Create a Customer Account

      Create a Customer Account Site

      Create a Customer Account Site Use

      Update a Customer Account Record

      Create an Organization Profile Extensions Record

Business Objects

Business Objects Overview

Customer Account Business Object

Customer Account Contact Business Object

Customer Account Site Business Object

EDI Business Object

EFT Business Object

E-Mail Business Object

Organization Business Object

Organization Contact Business Object

Organization Customer Business Object

P

Person Business Object

Person Customer Business Object

Phone Business Object

SMS Business Object

Telex Business Object

Web Business Object

Contact Person Information Business Structure

Customer Account Site Use Business Structure

Customer Profile Business Structure

Employment History Business Structure

Financial Report Business Structure

Location Business Structure

Business Objects V2

Business Objects V2 Overview

Customer Account V2 Business Object

Customer Account Site Use V2 Business Object

Customer Account Site V2 Business Object

Organization Customer V2 Business Object

Person Customer V2 Business Object

Business Object API Features and Procedures

Business Object APIs Overview

Seeded Business Object APIs

      Source System Management Business Object API

Business Object API Features

Create Business Object API Procedures

Update Business Object API Procedures

Save Business Object API Procedures

Get Business Object API Procedures

      Event Independent Get Procedures

      Event Dependent Get Procedures

Business Object V2 API Procedures

Customer Account V2 Business Object API

      Create Customer Account V2 Business Object API

      Update Customer Account V2 Business Object API

      Save Customer Account V2 Business Object API

      Get Customer Account V2 Business Object API

Customer Account Site V2 Business Object API

      Create Customer Account Site V2 Business Object API

      Update Customer Account Site V2 Business Object API

      Save Customer Account Site V2 Business Object API

      Get Customer Account Site V2 Business Object API

Organization Customer V2 Business Object API

      Create Organization Customer V2 Business Object API

      Update Organization Customer V2 Business Object API

      Save Organization Customer V2 Business Object API

      Get Organization Customer V2 Business Object API

Person Customer V2 Business Object API

      Create Person Customer V2 Business Object API

      Update Person Customer V2 Business Object API

      Save Person Customer V2 Business Object API

      Get Person Customer V2 Business Object API

Business Object API Attributes Information

Business Object API Attributes Information Overview

Customer Account Business Object API

      Create Customer Account Business Object

      Update Customer Account Business Object

      Get Customer Account Business Object

Customer Account Contact Business Object API

      Create Customer Account Contact Business Object

      Update Customer Account Contact Business Object

      Get Customer Account Contact Business Object

Customer Account Site Business Object API

      Create Customer Account Site Business Object

      Update Customer Account Site Business Object

      Get Customer Account Site Business Object

EDI Business Object API

      Create EDI Business Object

      Update EDI Business Object

      Get EDI Business Object

EFT Business Object API

      Create EFT Business Object

      Update EFT Business Object

      Get EFT Business Object

E-Mail Business Object API

      Create E-Mail Business Object

      Update E-Mail Business Object

      Get E-Mail Business Object

Organization Business Object API

      Create Organization Business Object

      Update Organization Business Object

      Get Organization Business Object

Organization Contact Business Object API

      Create Organization Contact Business Object

      Update Organization Contact Business Object

      Get Organization Contact Business Object

Organization Customer Business Object API

      Create Organization Customer Business Object

      Update Organization Customer Business Object

      Get Organization Customer Business Object

Party Site Business Object API

      Create Party Site Business Object

      Update Party Site Business Object

      Get Party Site Business Object

Person Business Object API

      Create Person Business Object

      Update Person Business Object

      Get Person Business Object

Person Customer Business Object API

      Create Person Customer Business Object

      Update Person Customer Business Object

      Get Person Customer Business Object

Phone Business Object API

      Create Phone Business Object

      Update Phone Business Object

      Get Phone Business Object

SMS Business Object API

      Create SMS Business Object

      Update SMS Business Object

      Get SMS Business Object

Telex Business Object API

      Create Telex Business Object

      Update Telex Business Object

      Get Telex Business Object

Web Business Object API

      Create Web Business Object

      Update Web Business Object

      Get Web Business Object

Business Structure Attributes

      Contact Person Information Business Structure Attributes

      Customer Account Site Use Business Structure Attributes

      Customer Profile Business Structure Attributes

      Employment History Business Structure Attributes

      Financial Report Business Structure Attributes

      Location Business Structure Attributes

Granular Entity Attributes

      Bank Account Use Entity Attributes

      Certification Entity Attributes

      Citizenship Entity Attributes

      Classification Entity Attributes

      Contact Preference Entity Attributes

      Credit Rating Entity Attributes

      Customer Account Relationship Entity Attributes

      Customer Profile Amount Entity Attributes

      Education Entity Attributes

      Extension Entity Attributes

      Financial Number Entity Attributes

      Financial Profile Entity Attributes

      Organization Contact Role Entity Attributes

      Party Preference Entity Attributes

      Party Site Use Entity Attributes

      Payment Method Entity Attributes

      Person Interest Entity Attributes

      Person Language Entity Attributes

      Relationship Entity Attributes

      Account Contact Role Entity Attributes

      Source System Information Entity Attributes

      Work Class Entity Attributes

Business Events

Overview

Installation and Setup

Trading Community Architecture Granular Events

Trading Community Architecture Business Object Events

Resource Manager APIs Overview and Features

Resource Manager APIs

Private APIs

Public APIs

Public, published APIs

Parameter Specifications

Standard IN Parameters

Standard OUT Parameters

Parameter Size

Missing Parameter Attributes

Parameter Validations

Invalid Parameters

Version Information

Status Messages

Resource Manager Public APIs

Resource Manager Public Packages

Resource Manager Public APIs

Package JTF_RS_RESOURCE_PUB

Create_Resource

Update_Resource

Package JTF_RS_GROUPS_PUB

Create_Resource_Group

Update_Resource_Group

Package JTF_RS_SALESREPS_PUB

Create_SalesRep

Update_SalesRep

Messages and Notifications

JTF_RS_RESOURCE_PUB

JTF_RS_GROUPS_PUB

JTF_RS_SALESREPS_PUB

Sample Code

JTF_RS_RESOURCE_PUB

JTF_RS_GROUPS_PUB

JTF_RS_SALESREPS_PUB