Access to CER Determination Results

IBM Cúram Social Program Management Access to CER Determination Results Document version 1.0 George T Jacob is an architect in the IBM Cúram platform group. He has 15 years of IBM experience and has a year s experience in the Cúram platform. He is a second plateau holder with nine filed, two published and two issued patents. George T Jacob, Platform Architect, IBM Cúram Platform Group. jgeorge@in.ibm.com Suresh Subbaiah is a senior software engineer in the IBM Cúram platform group. He has three years of Cúram product experience and has a strong background in object-oriented architecture, analysis, and software development with technologies such as Java, Java Platform, Enterprise Edition, Ant, and SQL. Suresh Subbaiah, Senior Software Engineer, IBM Cúram Platform Group. sureshs5@in.ibm.com

Copyright International Business Machines Corporation 2014. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Access to CER Determination Results CONTENTS List of Figures... 5 List of Tables... vi Revision History... vii 1. Introduction... 8 1.1. Purpose... 8 1.2. Audience... 8 1.3. Prerequisites... 8 2. Overview... 9 2.1. Sample asset and usage... 9 2.2. Solution approach... 10 2.3. Sample APIs... 11 2.4. Public CER APIs... 12 2.5. Database tables... 13 2.5.1. Existing tables in Cúram... 13 2.5.2. The new table... 13 2.6. Sample XML snippets... 14 3. Setting up development and execution... 18 iii

3.1. Setting up development... 18 3.2. Setting up execution... 18 4. Conclusion... 20 5. Acknowledgements... 20 6. Resources... 20 iv

Access to CER Determination Results LIST OF FIGURES Figure 1: Overall Solution View... 10 5

LIST OF TABLES Table 1:BICREOLECASEDETERMINATION Table... 13 vi

Access to CER Determination Results REVISION HISTORY Date Version Revised By Comments June 12, 2014 1.0 GTJ First released version. vii

1. Introduction 1.1. Purpose This article can help you to access the display rules that are stored as Cúram Express Rules (CER) determination results data in Cúram. The article is accompanied with an asset, or library of APIs, that enables you to more easily access the determination results data. The article outlines the approach and provides instructions for using the accompanying asset. 1.2. Audience This article is intended for a technical audience who wants to develop solutions to extract CER determination data for Business Intelligence. 1.3. Prerequisites An IBM Cúram development environment that is installed with a supported database. You must call the sample APIs accompanying the article from a Cúram batch stream. Before you use this solution, you must develop the batch stream code. For more information about Cúram batch stream programs, see Developing streaming batch programs in the IBM Knowledge Center at http://www- 01.ibm.com/support/knowledgecenter/SS8S5A_6.0.5/com.ibm.curam.na v.doc/kc_welcome-444.html 8

Access to CER Determination Results 2. Overview In Cúram, case eligibility and entitlement is determined by using Cúram Express Rules (CER). CER are responsible for applying rules logic to real-world data for decisions about eligibility and entitlement. The starting point for case eligibility and entitlement is the Product. A Product contains all of the configuration details that specify which CER rules to use for the determination of eligibility and entitlement. Once you configure a Product, its configuration can be used to calculate and store a determination result that is based on the input data. This determination result is used to generate financials, and is retrieved when a caseworker user views eligibility and entitlement details for the case. Decision Display Rules: The decision display rule is used to display information about decisions in the application. For example, a page that displays the calculations performed to determine the amount of income assistance due to a family in need. The information to display is from the display rules XML output or determination results. These results are stored in the Cúram database field CREOLECaseDeterminationData.CREOLESNAPSHOTDATA and are stored in compressed XML format in a BLOB in the Cúram database. You might also want to use the determination results for Business Intelligence and reporting. The CER APIs allow this data to be readable. To access this data, you typically need to write wrapper code that uses CER to retrieve this data. You can follow this guidance and use the sample APIs to extract the determination results with the CER APIs and store them in a table. You can then access the data for Business Intelligence and Reporting. 2.1. Sample asset and usage The sample code that accompanies this article is a set of classes that exposes two primary APIs. These APIs perform the task of reading the compressed determination results and storing it a new table. The extraction can be filtered based either on case decisions dates or determination results date. Before you can use the sample APIs, you must create a new table and develop a new batch program to call the APIs. On executing the newly developed batch program, the API is called and the determination result gets extracted and stored in the table created. 9

2.2. Solution approach The overall solution approach is to extract the compressed XML output from the display rules and store it in a table. The extraction process is through a Cúram Batch process or a Batch Stream process that you must develop. There are two parts to this approach: a) Read the necessary data and extract the determination results. b) Store the extracted data into a new table. Figure 1: Overall Solution View The batch process needs to perform the following tasks: For a specified period, read active determination IDs from the CREOLECASEDETERMINATION table with the corresponding case details from the CASEDECISION table (Caseid, start date, end date) OR read case ids within a specified case decision period. Fetch the display rule XML by using the CER from the CREOLECASEDETERMINATIONDATA table for the corresponding determination ID. Parse and concatenate the XML files. 10

Access to CER Determination Results Populate the preceding details to a new table BICREOLECASEDETERMINATION. 2.3. Sample APIs The batch program can execute the APIs to extract a filtered set of determination results and to store it. The filtering can either be based on the case decision timeline or the active determination timeline. The APIs filter on active determinations for case decisions within a specified period, or active determinations within the applicable period of the determination date. API 1 API 2 The following APIs in the sample code retrieve the required records and stores them in the new BICreoleCaseDetermination table. runextracttool.database.impl.datareadaccesslayerimpl.fetchfilteredc aseanddeterminationswithperiod(casedecisionfromdate,casedecisiontod ate) This API fetches all of the case decisions and active determinations for the provided case decision dates. It retrieves all of the active determination decision results that are associated with the caseid and determinationid. In other words, the API fetches, extracts, the filtered case decision records, and associated active determinations within the period that is specified as input. It checks the CASEDECISON.DECISIONFROMDATE and CASEDECISON.DECISIONTODATE fields to filter. runextracttool.database.impl.datareadaccesslayerimpl.fetchfilteredc aseanddeterminationswithdate(determinationdate) This API fetches all of the active determination results for the input determinationdate. It retrieves all of the active determination decision results and finds the active caseid to get the decisionfrom and decisiontodate. In other words, the API fetches, all of the determination results for the determination IDs whose CREOLECASEDETERMINATION.DETERMINATIONDATETIME value is greater than the determination date that is specified as input. API 3 runextracttool.database.impl. DataWriteAccessLayerImpl. storebideterminationresults(bicreolecasedeterminationde tailslist casedetailslist) This API needs to be invoked by the batch once the determination results are fetched. 11

This API takes the BICreoleCaseDeterminationDetailsList and stores each of the determination result entries from the list to the BICREOLECASEDETERMINATION table. If the record already exits this API updates it or else insert a new record, 2.4. Public CER APIs The following public CER APIs are used in the sample to fetch the determination XML. Step 1: Use this API to get the decision timeline details for a specified determination ID: final Map<CREOLEProductDecisionDisplayCategoryAccessor, Timeline<? extends String>> map = creolecasedeterminationaccessordao.get(determinationid).getdeterminationresult().decisiondetailstimelines(); Step 2: The following sample code retrieves the string format of the timeline XML by using the BoundedInterval.value() from the decision timeline that you retrieved. for (final CREOLEProductDecisionDisplayCategoryAccessor key : map.keyset()) { // Get the timeline of xml values for this display category final Timeline<? extends String> timelinesstring = map.get(key); for (final BoundedInterval<? extends String> boundedinterval : timelinesstring.intervals()) { final String xmlstring = boundedinterval.value(); Step 3: Use this public CER API to get the decision dates for the determination start date and end date in curam.core.sl.infrastructure.assessment.impl.determinationimpl.g etdaterange() 12

Access to CER Determination Results 2.5. Database tables The sample APIs use the following database tables to retrieve the required information and store it in a new table. 2.5.1. Existing tables in Cúram CASEDECISION: To retrieve the case decision details. CREOLECASEDETERMINATION: To fetch the active determination ID for the associated case. CREOLECASEDETERMINATIONDETAILS: To fetch the determination details for the appropriate determination ID. 2.5.2. The new table BICREOLECASEDETERMINATION: To store the extracted data from the CASEDECISION, CREOLECASEDETERMINATION, and CREOLECASEDETERMINATIONDATA tables. The unique index for this table is on the CASEID and CREOLECASEDETERMINATIONID columns. Column Name Table 1:BICREOLECASEDETERMINATION Table BICREOLECASEDETERMINATION ID CASEID CREOLECASEDETERMINATIONID DECISIONFROMDATE Column Type INT NOT NULL BIGINT NOT NULL BIGINT NOT NULL DATE Column Description Primary key auto generated. Identifier of the case that has its eligibility and entitlement determined. The determination ID for the corresponding active determination for that case. Start of period from which the decision applies. DECISIONTODATE DATE End of period to which the decision applies. XMLDATA BLOB Decision details of the determination result. This consists of concatenated XML snippets of the decision details. The timestamp at which the record was EXTRACTEDDATE TIMESTAMP created. VERSIONINFO INT Number of times the record was updated. 13

2.6. Sample XML snippets The sample concatenated decision timelines data in XMLDATA field is as below <DecisionDetails> <HouseholdDecisionDetails> <casemembers> <Item> <concernroleid domain="svr_unbounded_string">9097834197241823232</concernroleid> <concernroletype domain="svr_unbounded_string">rl1</concernroletype> <description domain="svr_unbounded_string">person: test person</description> <employmentstatus domain="svr_unbounded_string">pass</employmentstatus> <isalive domain="svr_boolean">true</isalive> <iscurrent domain="svr_boolean">true</iscurrent> <iseligiblechild domain="svr_boolean">true</iseligiblechild> <isregisteredperson domain="svr_boolean">true</isregisteredperson> <result domain="svr_unbounded_string">included</result> <summarydescription domain="svr_unbounded_string">person: test person - Primary Applicant</summaryDescription> </Item> </casemembers> <householdmembers> <Item> <concernroleid domain="svr_unbounded_string">9097834197241823232</concernroleid> <concernroletype domain="svr_unbounded_string">rl1</concernroletype> <description domain="svr_unbounded_string">person: test person</description> 14

Access to CER Determination Results <employmentstatus domain="svr_unbounded_string">pass</employmentstatus> <isalive domain="svr_boolean">true</isalive> <iscurrent domain="svr_boolean">true</iscurrent> <iseligiblechild domain="svr_boolean">true</iseligiblechild> <isregisteredperson domain="svr_boolean">true</isregisteredperson> <result domain="svr_unbounded_string">included</result> <summarydescription domain="svr_unbounded_string">person: test person - Primary Applicant</summaryDescription> </Item> </householdmembers> </HouseholdDecisionDetails> </DecisionDetails> <DecisionDetails> <IncomeAssistanceProductAssetDecisionDetails> <amountexceedingthreshold> <AmountItem> <amount domain="curam_amount">0</amount> <description domain="svr_unbounded_string">amount Exceeding Threshold</description> </AmountItem> </amountexceedingthreshold> <assetcalculationapplies domain="svr_boolean">false</assetcalculationapplies> <assetcalculationresult domain="svr_unbounded_string">not Applicable</assetCalculationResult> <assetdetailsfordisplay /> <assetthreshold> <AmountItem> 15

<amount domain="curam_amount">5000</amount> <description domain="svr_unbounded_string">asset Threshold for Owned Assets</description> </AmountItem> </assetthreshold> <householdassettotal> <AmountItem> <amount domain="curam_amount">0</amount> <description domain="svr_unbounded_string">total Household Assets Owned</description> </AmountItem> </householdassettotal> <householdassettotalowned> <AmountItem> <amount domain="curam_amount">0</amount> <description domain="svr_unbounded_string">total Household Assets Owned</description> </AmountItem> </householdassettotalowned> </IncomeAssistanceProductAssetDecisionDetails> </DecisionDetails> <DecisionDetails> <IncomeAssistanceProductIncomeDecisionDetails> <amountsubjectedtoincometest domain="curam_amount">0</amountsubjectedtoincometest> <anyincomes domain="svr_boolean">false</anyincomes> <deductionrateonincomeoverlimit domain="svr_double">0.5</deductionrateonincomeoverlimit> <failurereason domain="svr_unbounded_string" /> 16

Access to CER Determination Results <householdmemberswithincome /> <iahouseholdmemberincomesubscreens /> <incomeallowed domain="curam_amount">70</incomeallowed> <incomedeductiononmeanstestedincome domain="curam_amount">0</incomedeductiononmeanstestedincome> <incometestpassed domain="svr_boolean">true</incometestpassed> <maximumincomeallowed> <AmountItem> <amount domain="curam_amount">70</amount> <description domain="svr_unbounded_string">maximum Weekly Income Allowed for a Single Person</description> </AmountItem> </maximumincomeallowed> <maximumrate> <AmountItem> <amount domain="curam_amount">150</amount> <description domain="svr_unbounded_string">maximum Single Person Rate</description> </AmountItem> </maximumrate> <ratepayable domain="curam_amount">150</ratepayable> <result domain="svr_unbounded_string">not Applicable</result> <totalhouseholdincome domain="curam_amount">0</totalhouseholdincome> </IncomeAssistanceProductIncomeDecisionDetails> </DecisionDetails> 17

3. Setting up development and execution 3.1. Setting up development Complete the following steps to set up the environment to develop the batch process and invoke the sample API. Step 1: Copy the accompanying RunExtractTool.jar to any folder. Step 2: Before you develop the batch process, ensure that the project CLASSPATH includes the RunExtractTool.jar along with the following to be present in the CLASSPATH /EJBServer, /EJBServer/tools/lib/javaee.jar, /EJBServer/components/core/lib/core.jar, /EJBServer/components/CREOLEInfrastructure/lib/CREOLEInfrastructure.jar, /CuramSDEJ/lib/guice-2.0.jar, /CuramSDEJ/lib/appinf.jar, /CuramSDEJ/lib/coreinf.jar, /CuramSDEJ Step 3: Create a batch process to invoke the APIs from the sample. For more information about Cúram batch stream programs, see Developing streaming batch programs in the IBM Knowledge Center at http://www- 01.ibm.com/support/knowledgecenter/SS8S5A_6.0.5/com.ibm.curam.nav.doc/kc_ welcome-444.html. 3.2. Setting up execution Complete the following steps to set up the environment to execute the batch process and extract the data to store in the new table. Step 1: Create a SQL Table. Run the following SQL script to create the BICreoleCaseDeterminationTable and to create the unique index: DB2 & H2: CREATE TABLE BICREOLECASEDETERMINATION (BICREOLECASEDETERMINATIONID BIGINT NOT NULL PRIMARY KEY, CASEID BIGINT not null, CREOLECASEDETERMINATIONID BIGINT not null, DECISIONFROMDATE DATE, DECISIONTODATE DATE, XMLDATA BLOB, VERSIONNO INT not null, LASTWRITTEN TIMESTAMP); DB2, Oracle & H2: CREATE UNIQUE INDEX creolecaseidindex ON BICREOLECASEDETERMINATION (CASEID, CREOLECASEDETERMINATIONID); 18

Access to CER Determination Results Step 2: Copy the accompanying RunExtractTool.jar file to the \EJBServer folder. Step 3: Modify the SetEnvironment.bat file and add RunExtractTool.jar to the PRE_CLASSPATH environment variable. For example: set PRE_CLASSPATH=%PRE_CLASSPATH%;%SERVER_DIR%\RunExtractTool.jar Step 4: The following entries must be present in the CLASSPATH to execute this successfully: /EJBServer, /EJBServer/tools/lib/javaee.jar, /EJBServer/components/core/lib/core.jar, /EJBServer/components/CREOLEInfrastructure/lib/CREOLEInfrastructure.jar, /CuramSDEJ/lib/guice-2.0.jar, /CuramSDEJ/lib/appinf.jar, /CuramSDEJ/lib/coreinf.jar, /CuramSDEJ. Step 5: Start the server and login as sysadmin to the Cúram application, navigate to Batch->Processes and search for the newly developed batch process. Run the batch process, ensuring that you use a valid date format yyyymmdd. For example, 20140101. Step 6: Open a command-line prompt and change directory to the installed path where SetEnvironment.bat resides. Execute SetEnvironment.bat Step 7: From command line run the following command: appbuild runbatch Step 8: Validate by executing the following query to see if the data is inserted or updated. select * from BICreolecasedeterminationtable 19

4. Conclusion This article covered an approach to access the case eligibility and entitlement results that are stored as Cúram Express Rules (CER) determination results data in Cúram by using the sample that is provided. The determination results that are made available in the new table can be further enhanced to create a more structured XML format. 5. Acknowledgements The authors would like to thank Eoin Carroll, Lead Software Architect, Cúram Product Development, and Patrick Fagan, Chief Architect, Cúram Platform Group for their assistance and valuable inputs. They also want to thank Claire Whelan, Curam Platform Group for her support on CER APIs, and Aparajita Sengupta, Software Testing, Cúram Platform Group, who tested the sample asset. 6. Resources The IBM Knowledge Center - http://www- 01.ibm.com/support/knowledgecenter/SS8S5A_6.0.5/com.ibm.curam.nav.doc/k c_welcome-444.html The Cúram product page http://www-03.ibm.com/software/products/en/social-programs 20

Access to CER Determination Results Copyright IBM Corporation 2014 IBM United States of America Produced in the United States of America US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PAPER AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes may be made periodically to the information herein; these changes may be incorporated in subsequent versions of the paper. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this paper at any time without notice. Any references in this document to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation 4205 South Miami Boulevard Research Triangle Park, NC 27709 U.S.A. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information is for planning purposes only. The information herein is subject to change before the products described become available. If you are viewing this information softcopy, the photographs and color illustrations may not appear. 21

Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first occurrence in this information with a trademark symbol ( or ), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the web at "Copyright and trademark information" at http://www.ibm.com/legal/copytrade.shtml. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other company, product, or service names may be trademarks or service marks of others. 22