Introduction
The IBM Cúram Data Dictionary is available as part of the Cúram installation process. The Data Dictionary can run on an IBM Cúram application to generate analysis documentation that is specific to that application. Technical users can share the analysis documentation with non-technical users to facilitate technical and business analysis of an IBM Cúram application. The analysis documentation primarily supports fit gap analysis and customization impact analysis that relates to IBM Cúram database tables, code tables, and other components.
Use the analysis documentation to help you to explore the metadata and business functions of an IBM Cúram application and the interactions between them. It supports you in exploring the metadata that is associated with those pages and database tables. In addition, you can see information about related artifact types like Domain Definitions, Code Tables, Message Files, Application Properties, and Workflows.
Please find Important Table Information below –
Users
A user is somebody who is employed by the organization to complete tasks on the system, such as creating and managing cases.
New users must be registered on the system and assigned a security role and a user application view.
External User Applications
Typically, there are users outside the organization with limited access who needs to securely access parts of the Cúram application. These users are considered external users and authentication for these users is completely customizable through the use of the External Access Security hook point provided. As external users are processed differently to internal users, a specific web application is required for external users.
- EXTERNALUSER
- EXTERNALUSERPARTICIPANTLINK
Benefit Product
The business object contains the configuration data for the product delivery case of type benefit product. The benefit product case type determines whether a person or employer meets the eligibility criteria for a benefit. A successful eligibility outcome usually results in the benefit being delivered in the form of a payment. The configuration data that is contained within this business object is stored on the following entities:
- PRODUCT
- PRODUCTCATEGORY
- PRODUCTCONCERNROLE
- PRODUCTAPPEALPROCESS
- APPEALSTAGE
- EVIDENCEMETADATA
- PRODUCTEVIDENCELINK
- TEMPORALEVIDENCEAPPROVALCHECK
- EVIDENCESCREEN
- EVIDENCEAPPROVALCHECK
- ADHOCBONUSCRITERIA
- PDASSESSMENTCONFIGURATION
- CASEAPPROVALCHECK
- DEDUCTIONPRODUCTLINK
- DEDUCTION
- PRODUCTDELIVERYPATTERNINFO
- PRODUCTDELIVERYPATTERN
- PRODUCTPROVISION
- PRODUCTRULESLINK
- PRODUCTTIMECONSTRAINT
- DELIVERYMETHOD
- PROVISIONLOCATION
- MILESTONELINK
- MILESTONECONFIGURATION
- LOCALIZABLETEXT
- TEXTTRANSLATION
- SECURITYIDENTIFIER
Integrated Case
The business object contains the configuration data for an integrated case type. An integrated case is used to manage and consolidate case information for one or more members of the same household or family unit.
The configuration data that is contained within this business object is stored on the following entities:
- ADMININTEGRATEDCASE
- ICASSESSMENTCONFIGURATION
- EVIDENCEMETADATA
- ADMINICEVIDENCELINK
- MILESTONECONFIGURATION
- MILESTONELINK
- LOCALIZABLETEXT
- TEXTTRANSLATION
Liability Product
The business object contains the configuration data for the product delivery case of type liability product. Liabilities are delivered to persons or employers in the form of a bill. For example, a person may be billed for an overpaid benefit or an employer may be billed for employee contributions. The configuration data that is contained within this business object is stored on the following entities:
- PRODUCT
- PRODUCTCATEGORY
- PRODUCTCONCERNROLE
- EVIDENCEMETADATA
- PRODUCTEVIDENCELINK
- TEMPORALEVIDENCEAPPROVALCHECK
- EVIDENCESCREEN
- EVIDENCEAPPROVALCHECK
- CASEAPPROVALCHECK
- PRODUCTDELIVERYPATTERNINFO
- PRODUCTDELIVERYPATTERN
- PROVISIONLOCATION
- PRODUCTPROVISION
- PRODUCTRULESLINK
- PRODUCTTIMECONSTRAINT
- SECURITYIDENTIFIER
- LOCALIZABLETEXT
- TEXTTRANSLATION
Assessment
The business object contains the configuration data for an assessment case type. The purpose of the assessment case type is to perform an initial evaluation to determine whether a person or prospect person potentially is eligible for a benefit. Each assessment case represents a program for which the organization wants to assess potential eligibility.
The configuration data that is contained within this business object is stored on the following entities:
- ASSESSMENTCONFIGURATION
- ASSESSMENTRULESLINK
Screening
The business object contains the configuration data for a screening case type. A screening case type is used to handle a number of specific program assessments which are run to determine which members of a household are potentially eligible for a range of benefits. A screening case type acts as a container for consolidating information. The configuration data that is contained within this business object is stored on the following entities:
- SCREENINGCONFIGURATION
- SCREENINGASSESSMENTCONFIG
- MILESTONECONFIGURATION
- MILESTONELINK
- LOCALIZABLETEXT
- TEXTTRANSLATION
CER Rule Object Propagator
The business object contains the configuration data for the CER rule object propagator. It contains the CER data configuration details.
The configuration data that is contained within this business object is stored on the following entities:
- RULEOBJPROPCONFIGSANDBOX
- LOCALIZABLETEXT
- TEXTTRANSLATION
CER Rule Set Category
The business object contains the configuration data for the CER rule set category. The CER rule set category describes and categorizes CER Rule Sets. The configuration data that is contained within this business object is stored on the following entities:
- CREOLERULESETCATEGORY
- LOCALIZABLETEXT
- TEXTTRANSLATION
Dynamic EvidenceType
The business object contains the configuration data for dynamic evidence types. Dynamic evidence types are the administrative equivalent of non-dynamic evidence types – a logical grouping of related attributes about which an organization wants to record information in respect of a Case, for example, Income Evidence. The configuration data that is contained within this business object is stored on the following entities:
- EVIDENCETYPEDEF
- EVIDENCETYPEDEFINITION
Code Table
The business object contains the configuration data for a code table. Code tables contain codes for items that appear in the drop down fields. A code table is made up of a number of code table items; each code table item represents a selection in a drop down field. The configuration data that is contained within this business object is stored on the following entities:
- CODETABLEHEADER
- CODETABLEITEM
Code Table Hierarchy
The business object contains the configuration data for a code table hierarchy record. A code table hierarchy is where multiple code tables are linked into a number of levels. Any number of code tables can be included in a code table hierarchy. A code table hierarchy allows the values available for selection in the drop-down field for one code table to be determined by the value selected in the drop-down field for another code table. The configuration data that is contained within this business object is stored on the following entity:
- CODETABLEHIERARCHY
Workflow Business Process
The business object contains the configuration data for a workflow process definition. A workflow process is enacted at runtime based on a workflow process definition. A workflow process definition describes the flow of a business process in terms understood by the Cúram Workflow Engine. It defines the activities in the workflow and the transitions between them. It also defines the data that is passed into and out of an activity during the execution of a workflow process instance. The configuration data that is contained within this business object is stored on the following entity:
- PROCESSDEFINITION
Workflow Process Enactment Event Configuration
The business object contains the configuration data for a workflow process enactment event configuration. Events provide a mechanism for loosely-coupled parts of the application to communicate information about state changes in the system. It is possible to start a process in response to an event being raised. This requires the setup of workflow process enactment event configuration data. The configuration specifies the process/processes to start in response to a specific event being raised. Process enactment event configuration is stored on the database and a user interface is supplied to allow the manipulation of this data. The configuration data that is contained within this business object is stored on the following entities:
- PROCENACTMENTEVT
- PROCENACTEVTDATA
Event
The business object contains the configuration data for an event. Events provide a mechanism for loosely-coupled parts of the application to communicate information about state changes in the system. When one module in the application raises an event, one or more other modules receive notification of that event having occurred provided they are registered as listeners for that event. The configuration data that is contained within this business object is stored on the following entities:
- EVENTCLASS
- EVENTTYPE
Application Resource Universal Access (UA)
The business object contains the data for a Cúram Universal Access (UA) stylesheet application resource. It can be used by the system in a variety of ways; some alter the functionality provided by the system and therefore they configure the system to suit an organization’s needs. The configuration data that is contained within this business object is stored on the following entity:
- APPRESOURCE
Application Resource Image
The business object contains the data for an image application resource. It can be used by the system in a variety of ways; some alter the functionality provided by the system and therefore they configure the system to suit an organization’s needs. The configuration data that is contained within this business object is stored on the following entity:
- APPRESOURCE
Application Resource Properties
The business object contains the data for a properties application resource. It can be used by the system in a variety of ways; some alter the functionality provided by the system and therefore they configure the system to suit an organization’s needs. The configuration data that is contained within this business object is stored on the following entity:
- APPRESOURCE
Application Resource Schema
The business object contains the data for an XML Schema Definition (XSD) schema application resource. It can be used by the system in a variety of ways; some alter the functionality provided by the system and therefore they configure the system to suit an organization’s needs. The configuration data that is contained within this business object is stored on the following entity:
- APPRESOURCE
Application Resource XML
The business object contains the data for an XML application resource. It can be used by the system in a variety of ways; some alter the functionality provided by the system and therefore they configure the system to suit an organization’s needs. The configuration data that is contained within this business object is stored on the following entity:
- APPRESOURCE
Microsoft Word Template
The business object contains the configuration data for a Microsoft Word template. A user can create a communication based on an Microsoft Word template and make any necessary modifications to the communication before issuing it. The configuration data that is contained within this business object is stored on the following entities:
- DOCUMENTTEMPLATE
Extensible Stylesheet Language Template
The business object contains the configuration data for a Extensible Stylesheet Language (XSL) template. XSL templates are used to automatically generate bulk communications, often through batch processing. An XSL template includes standard text which will appear on all communications generated from the template. The configuration data that is contained within this business object is stored on the following entities:
- XSLTEMPLATE
- XSLTEMPLATEINST
Security Role
The business object contains the configuration data for a security role. A security role is a configuration used to manage one or more security groups associated to a user. The configuration data that is contained within this business object is stored on the following entities:
- SECURITYROLE
- SECURITYROLEGROUP
Security Group
The business object contains the configuration data for a security group. Security group is a configuration used to manage one or more security identifiers associated to a user. The configuration data that is contained within this business object is stored on the following entities:
- SECURITYGROUP
- SECURITYGROUPSID
Security Identifier
The business object contains the configuration data for security identifiers. Security identifier is a configuration used to manage one or more securable elements of the application associated to a user, for example a method or a field. The configuration data that is contained within this business object is stored on the following entities:
- SECURITYIDENTIFIER
- SECURITYFIDSID
User Interface Pods Configuration
The business object is used to create default views in Pod containers. Pod containers are typically used in ‘Application Views’ or home pages, where the user is presented with a summary of information that is relevant to their day to day job. The configuration describes the physical layout of the container and its content. For example, the configuration may describe a container with 3 columns and 6 available Pods, where 3 Pods are selected by default and displayed across the 3 columns. The configuration data that is contained within this business object is stored on the following entities:
- PAGECONFIG
- USERPAGECONFIG
Service Plan
The business object contains the configuration data for a service plan. Cúram Service Planning is a mechanism by which a social enterprise organization can plan, in an integrated manner, the delivery of services and activities to help a client achieve a specific goal. The type of service plan created by an organization depends upon the specific goal that the plan is intended to achieve. The common types of service plans include Return to Work, Child Protection, and Permanency Plans. The configuration data that is contained within this business object is stored on the following entities:
- SERVICEPLAN
- SERVICEPLANAPPROVALCHECK
- GOAL
- GOALCONTRACTTEXT
- SERVICEPLANGOALLINK
- ADMINICSERVICEPLANLINK
- MILESTONECONFIGURATION
- MILESTONELINK
- PLANTEMPLATESERVICEPLANLINK
- PLANITEM
- OUTCOME
- GOALOUTCOMELINK
- GOODCAUSE
- CONTRACTTEXT
- PLANITEMCONTRACTTEXT
- PLANITEMOUTCOMELINK
- PLANITEMGOODCAUSELINK
- PLANITEMAPPROVALCRITERIALINK
- APPROVALCRITERIA
- SUBGOAL
- GOALSUBGOALLINK
- SUBGOALCONTRACTTEXT
- SUBGOALPLANITEMLINK
- PLANTEMPLATE
- PLANTEMPLATESUBGOAL
- PLANTEMPLATEPLANITEM
- PLANTEMPLATEPLANITEMAPPRCRIT
- PLANTEMPLATEMILESTONE
- SERVICEPLANGROUP
- SERVICEPLANGROUPLINK
- PLANTEMPLATEPLANGROUP
- SUBGOALOUTCOMELINK
- TASKCONFIGURATION
- SECURITYIDENTIFIER
- LOCALIZABLETEXT
- TEXTTRANSLATION
Verification
The business object contains the configuration data for verification. Cúram Verification is the process of checking the accuracy of the information given by clients seeking services from a Social Enterprise organization. The verification of client information can take a number of forms; it can be provided by documents, e.g., birth certificates or bank statements, or by verbal means, e.g., telephone calls. The configuration data that is contained within this business object is stored on the following entities:
- VERIFICATIONCATEGORY
- VERIFICATIONITEM
- VERIFIABLEDATAITEM
- VERIFICATIONITEMUTILIZATION
- VERIFICATIONREQUIREMENT
- DEPENDANTDATAITEM
- VERIFICATIONREQUIREMENTUSAGE
Intelligent Evidence Gathering (IEG) Script
The business object contains the configuration data for an Cúram Intelligent Evidence Gathering (IEG) script. With IEG, information is gathered interactively by displaying a script of questions that a user can provide answers to. Questions are only displayed if they are consistent with the user’s previous answers so that the user is only required to provide answers relevant to his or her needs and situation. The configuration data that is contained within this business object is stored on the following entities:
- IEGSCRIPTINFO
- IEGSCRIPTRELS
- APPRESOURCE
DataStore Schema
The business object contains the data for a datastore schema. Datastore schemas define the structure of entities that can be stored in the application datastore. The configuration data that is contained within this business object is stored on the following entity:
- DATASTORESCHEMA
Evidence Broker
The business object contains the configuration data for the evidence broker. The Cúram Evidence Broker provides a flexible approach to evidence sharing. SEM agencies can configure how they share evidence with other agencies in one way, and configure how they receive evidence broadcast from other agencies in a completely different way. The configuration data that is contained within this business object is stored on the following entities:
- EVIDENCEBROKERCONFIG
- PRODUCTEVIDENCELINK
- ADMINICEVIDENCELINK
Legal Action
The business object contains the configuration data for a legal action. A legal action is a type of case that defines legal processes associated with a case participant, involved with the organization that may include judicial involvement. The configuration data that is contained within this business object is stored on the following entities:
- ADMINLEGALACTION
- ADMINLEGALACTIONLINK
- ADMINLEGALSTATUS
- CASEMULTILEGALSTATUSCONFIG
- LEGALSTATUSCASETYPELINK
- ADMINLEGALACTIONCATEGORY
- LEGALCASETYPELINK
Service Offering
The business object contains the configuration data for a service offering. A service offering represents a service which may be offered by an agency to its clients. The configuration of the service offering defines key information about the service, for example the cost per unit. The configuration data that is contained within this business object is stored on the following entities:
- SERVICEOFFERING
- SERVICERATE
- PAYMENTOPTIONS
- SERVICEDELIVERYCONFIGURATION
- CREOLERULESETLINK
- SOSECURITYRIGHTS
- ABSENCEREASONCONFIGURATION
- SOATTENDANCECONFIGURATION
- SOATTENDANCEPAYMENT
- SOROSTERCONFIGURATION
- SOAPPROVALCRITERION
- CONTRACTTEXTLINK
- CONTRACTTEXT
- SOEVALUATIONCRITERION
- SOPERFORMANCEMEASURELINK
- SOTRAININGREQUIREMENT
- TRAININGSERVICEOFFERING
- SERVICEOFFERINGGROUPLINK
- LOCALIZABLETEXT
- TEXTTRANSLATION
Fund
This business object contains the configuration data for a fund. A fund can have an administrative association to a product or service, and is segmented into a number of fiscal years, each of which can contain its own budget. This allows an agency to define how a fund will be structured over time, and when it will be obligated. The configuration data that is contained within this business object is contained within the following entities:
- PROGRAMFUND
- FUNDCONFIGURATION
- FISCALYEAR
- FUNDFISCALYEAR
- FUNDUSERROLE
- ORGOBJECTLINK
FundingRuleSet
This business object contains the configuration data for a funding rule set. A product or service can have more than one related fund. In this case, rules are required to define the order in which the funds should be used. The configuration data that is contained within this business object is contained within the following entity:
- FUNDEDITEMRULESLINK
Intake Application
The business object contains the configuration data for an intake application. An intake application allows a citizen to apply for programs by submitting an application that contains the required information on personal details, income, expenses, employment, education, and so forth. This information becomes evidence on the client’s case and is used to determine eligibility.
The configuration data that is contained within this business object is stored on the following entities:
- INTAKEAPPLICATIONTYPE
- APPLICATIONCATEGORY
- APPLICATIONCATEGORYLINK
- PDFFORM
- WITHDRAWALREQUESTREASON
- APPLICATIONTYPEPROGRAMLINK
- PROGRAMTYPE
- EXTERNALSYSTEM
- PDFFORMPROGRAMLINK
- SERVICEAREA
- SERVICEAREALINK
- PDFFORMOFFICESERVICEAREALINK
- MAPPINGCONFIGURATION
- PROGRAMOFFICESERVICEAREALINK
- ONLINEPROGRAMGROUP
- ONLINEPROGRAMGROUPLINK
- LOCALIZABLETEXT
- TEXTTRANSLATION
Note: Reference : IBM Documentation Center
Below Security Tables Required to update once you added new facade with operation or new operation in existing facade class.
SECURITYGROUPSID
SECURITYIDENTIFIER
FUNCTIONIDENTIFIER
SECURITYFIDSID