/
DWH Web Services Help Page

DWH Web Services Help Page

Owned by Adam Chang
Last updated: Oct 11, 2023 by Warren Liang

Introduction

Several campus shadow and feeder systems have the need to translate legacy Financial System (FS) data to the new Kuali Financial System (KFS) format. As these systems convert to use the new KFS attributes, they will need to validate and extract KFS data  The Data Warehouse team currently provides programmatic access to validate and extract in the Business Object and Domain Object queries via HTTP Post.

Although this feature provides a simple interface to extract data, a more robust and redundant architecture is needed to support the growing needs of campus systems. As a result, the KFS Data Warehouse team is developing web services interfaces to allow programmatic access to KFS data.

Using the Web Service Interface

This section will provide information for programmers on how to connect and use the web services.

For Java applications a client library is provided in the commons Java library. It is recommended to have the latest version (currently oit-commons-dwh-client-1.0.5.jar) to have the latest services available.

To configure your endpoint using the Java client, there are two endpoints available where the production endpoint is the default.

To override the default production endpoint:

  • create a properties override file on your classpath at location edu/uci/oit/commons/dwh/client/properties/dwhClientApplicationEndpoints.properties
  • override the endpoint with endpoint=${dev} to connect to development web services

Endpoint Configuration

For any applications using oit-commons-dwh-client-1.0.4 and below, the default production endpoint URL will need to be overridden using the override mechanism described and can override the endpoint property directly:

For applications written in a language other than Java, a client can be created using the Web Services WSDL

Configuration Notes

  • DWH_ws.jar seems to be conflicted with cxf-2.1.1.jar (DWH_ws.jar does NOT need CXF.jar)

Web Services Specifications

The web services will provide the following functionality: