Introduction

This section contains individual per-component compliance information.

Important: Unless otherwise indicated, for all components (whether listed here or not) it can be assumed that the general following general compliance statements apply:
Where you want to reference an application class in your custom code:
  • If the class is External, you are allowed to reference it.
  • If the class is Internal, you are supported in referencing it in your existing code but discouraged from doing so. You should not reference it in new code.
  • If the class is Access Restricted, you are not supported in referencing it.
Where you want to customize an application class in your custom code:
Table 1. Component Compliance Details.

This table lists the components with Non-Modeled APIs.

Component

Details

Cúram Client Development Environment

For further guidelines on how to customize/use this component please refer to the Cúram Web Client Reference Manual.

Please note that files from the CuramCDEJ folder will be copied to temporary build folders during the application build process. The presence of such files outside of the CuramCDEJ folder does not make them available for customization.

Cúram Server Development Environment

This component's Javadoc details all customization points and External APIs. Only classes that are documented in JavaDoc should be referenced from customer code; referencing other classes will produce discouraged warnings or access restricted errors and are not supported1.

The bin directory of this component contains Apache Ant build scripts that must not be modified directly. Updates to these scripts can be made by creating new custom ant scripts and using the Ant inheritance functionality.

The drivers folder of this component contains database drivers used to access the application database. If necessary, these drivers may be replaced with the relevant driver for the database being used, provided the database is a supported database version as specified in the Cúram Supported Prerequisites.

Note: If a problem arises with a driver that has not been shipped in the product (i.e. that has not been tested and verified for use with the application), the customer may be requested to replace the driver with a version that has been tested, while the specific issue is raised with the third party vendor.
Please note that files from the CuramSDEJ folder will be copied to temporary build folders during the application build process. The presence of such files outside of the CuramSDEJ folder does not make them available for customization.

Cúram Administration Suite

Note that from version 6.0.3, the compliance statement for classes in the Cúram Administration Suite is no different from those in any other component. External APIs in the Administration Suite can be wrapped and invoked from custom code.

Persistence Infrastructure

The Persistence Infrastructure cannot be customized. Customers must not place any custom code in Persistence Infrastructure's code packages (curam.util.persistence and all sub-packages). For further information on how to use these APIs please read the Persistence Cookbook.

CER Infrastructure

The compliancy statement for CER Infrastructure can be found in the Cúram Express Rules Reference Manual. CER entities (i.e., any entity whose name is prefixed by the word Creole) should be considered Internal and subject to change, and customers should not update them or query them except via the CER API or DMX files.

Dependency Manager

The Dependency Manager encompasses all server artefacts in the curam.dependency code package and all its sub-packages.

The following components contribute to the Dependency Manager code package:

  • the CER Infrastructure; and
  • the core application.

The Dependency Manager cannot be customized in any way. All Dependency Manager APIs are for internal use only. The compliancy statement for the Dependency Manager can be found in the Cúram Express Rules Reference Manual.

Eligibility and Entitlement Engine API

For guidelines on how to configure and customize this component, please read the Inside Cúram Eligibility and Entitlement Using Cúram Express Rules Guide.

Evidence Generator

The Evidence Generator is application infrastructure that is shipped as part of the Tools directory structure (EGTools). For more information on using the Evidence Generator, see the Cúram Evidence Generator Specification.

DocMaker

No part of the DocMaker tool may be customized.

Pod Infrastructure

Pod Infrastructure is shipped in the widget-inf.jar and widget-utility.jar files. The Pod Infrastructure cannot be customized. Pod-Loaders cannot be customized. For further information on developing Pods see the Cúram Pod Developer's Guide.

Funded Program Management

For guidelines on how to customize this component, please read the Funded Program Management Developer Guide and the component's javadoc..

Cúram Incidents

For guidelines on how to customize any Incident Entities or replacing any Incident implementation please read the Persistence Cookbook and the component's javadoc.

Cúram Citizen Context Viewer

For further guidelines on how to customize this component please refer to the Cúram Citizen Context Viewer Configuration Guide and the component's javadoc.

Cúram Advisor

The following server components are delivered with Cúram Advisor: Advisor.

Cúram Common Intake

The following server components are delivered with Cúram Common Intake: Intake, PCR, CREOLEProgramRRecommendation, ReferralsLite and CPMReferralsLite

Inbox

For guidelines on how to configure and customize this component, please read Part VI of the Cúram Workflow Reference Guide.

Cúram Waitlists

For guidelines on how to customize this component, please read the Cúram Waitlist Customization Guide and the component's javadoc.

IBM Cúram Business Intelligence and Analytics

For guidelines on how to customize this component, please read the Cúram Business Intelligence Reporting Developer Guide

IBM Cúram Social Enterprise Collaboration

The following server components are delivered with Social Enterprise Collaboration: SocialEnterpriseCollaboration, CaseParticipantIndex and ClientAccess.

IBM Cúram Universal Access

For further guidelines on how to customize this component please refer to the Cúram Universal Access Developers Guide and the component's javadoc.

IBM Cúram Outcome Management

The following server components are delivered with Cúram Outcome Management: AssessmentPlanning, AssessmentPlanningCPM, DecisionAssistAssessments and SimpleOutcomeManagement

IBM Cúram Provider Management

For guidelines on how to customize this component, please read the Cúram Provider Management Developer Guide and the component's javadoc.

IBM Cúram Youth Services(CYS)

For guidelines on how to customize any CYS Entities or replacing any CYS implementation please read the Persistence Cookbook and the component's javadoc.

IBM Cúram Child Care (CCC)

For guidelines on how to customize any CCC Entities or replacing any CCC implementation please read the Persistence Cookbook and the component's javadoc.

1 Cúram's cryptographic functionality is not supported for customer use beyond the documented usage in the Cúram Server Developer's Guide and Cúram Security Handbook.