On this page
|
Legacy SHINES reference document. This page captures a Georgia DHS SHINES interface design as written (vendor spec, typically 2007–2025). It documents the system being replaced, not CRAIG behavior. CRAIG’s current implementation of the same data exchange lives under the craig-exchange API reference and in the design documents. Use this page only when mapping legacy integrations during CRAIG rollout. |
Interface Detailed Design Document
$TARS* Interface*
Georgia Department of Human Resources
Statewide Automated Child Welfare Information System
(SACWIS)
05/06/2007
Version 1.4
Table of Contents
General Design (Functional)
| Req. # | Validated Requirement |
|---|---|
149.23 |
Allow for a request to the child support office of parent’s payment records/history |
167.1 |
Continue to interface with the state’s IV-D system when the child is no longer for child welfare programs but remains eligible under other programs |
549.1 |
Send the Client ID for the child |
549.2 |
Receive the court ordered child support amount |
549.3 |
Receive the child’s name |
549.4 |
Receive the non-custodial parent’s name |
549.5 |
Receive the custodial parent name |
549.6 |
Receive the custodial parent’s address |
549.7 |
Receive the amount disbursed to the custodian/ Foster Care |
549.8 |
Receive the amount collected by Child Support Services |
549.9 |
Receive Vital Records information |
549.1 |
Receive if there is an active child support case |
549.11 |
Receive the absent parent demographic information |
549.12 |
Receive the benefit amount |
The above were the initial requirements collected. Some of them were later invalidated due to changes requested by interface partners and due to constraints in their systems. The following detail design captures the most up-to-date functionality that the interface is designed to perform
Introduction
Document Purpose
The purpose of this document is to give a detailed functional description of how the $TARS interface operates with Georgia SHINES.
Functional Overview
The $TARS application is used to track, record, and report Child Support Services proceedings. The application records child support payments and issues child support checks to custodial parents.
The SHINES - $TARS interface allows Case Managers to focus on the care, placement and activities with families and children. After a child’s IV-E Eligibility Determination is recorded in Georgia SHINES, a referral is made to the Child Support Services (CSS) program leveraging the interface between SHINES and $TARS.
Child Support Referral
Functional Description
Georgia SHINES may send a referral for a child support case to $TARS. The referral will subscribe SHINES to child support payment disbursals as long as the child remains in care. If funds are collected on behalf of a child in DFCS care, some or all of the collected funds will be paid to DFCS to provide for services for that child based on per diems and other calculations. A referral is made on behalf of the child only if per diem exists for the child in the SHINES system. Per Diem is calculated based on the placement type and payment of care of the child. The per diem amount is updated on the SHINES outbound table by removing the decimal as STARS cannot accept decimals. For ex: if the per diem amount is $14.32 then we update our tables as 1432 and STARS picks the amount and places the decimal before the last two digits. We always make sure the last two digits we send are the cents value for ex: if the per diem amount is $14.00, we send 1400 so STARS can update it accordingly.
After a child comes into DFCS custody and is placed in an approved placement, the Case Manager completes a Foster Care Eligibility Application (FCEA) in the Foster Care stage of the case. This eligibility application is then submitted to the assigned Eligibility Specialist for review and IV-E eligibility determination. Following this review, the Eligibility Specialist must confirm the child’s eligibility using the Eligibility Determination Worksheet and document the results of the determination (including, eligibility and reimbursability) using the Eligibility Summary page. Upon documenting the results, the CSUP-SEND indicator in the ELIGIBILITY database table is set to ‘YES’ if the Eligibility Specialist selected the “Yes” radio button to” is this child being referred to child support?”. Once the “Yes” radio button is selected, the per diem is calculated for the child, if the per diem exists for the child then the indicator is set to “Yes” on the page and a row created in the eligibility table. This indicator identifies a child support referral is ready to send to $TARS and a database record is created in the interface outbound tables. Data is collected from these tables by the interface broker and sent to $TARS. Upon receiving the data, the Child Support Services program uses $TARS to perform the necessary business functions in accordance to Georgia State policy. If $TARS has or creates a new Child Support case that involves the collection of child support funds, $TARS will “subscribe” SHINES to payment information so that SHINES will receive child support payment information as it comes in to $TARS.
If the Child Support Referral radio buttons, which default to “No” being selected, are selected to have the “Yes” button selected, then child support referrals are created if not previously created.
$TARS actually tracks referrals and payments in terms of the Non Custodial Parents (NCP) in the case. A referral will be sent for each non custodial parent of a child, instead of just one referral for the child. That referral will be created whether the parent had custody of the child at time of removal or was an absent parent. $TARS will be storing referrals by NCP. So if that NCP already has a case open, the new child will likely be added to the existing $TARS case, as long as the two cases are in the same county. But the interface cannot count on that happening.
A non-custodial parent (NCP) is defined as a principal (PRN) that has a relationship to the PC (primary child) of: Absent Parent(AB), Precond. Adop. Par(AP), Biological Father(BF), Biological Mother(BM), Legal Father(LF), Legal Mother(LM), Putative Mother(PM), Parent(PA), Putative Father(PF), or Primary Caretaker(PK).
Table of Fields From SHINES to $TARS
| Static/ Dynamic | Required (Yes, No) | Data Name | Description | Possible Value | Type | Length |
|---|---|---|---|---|---|---|
Static |
Y |
DFCS County |
County responsible for the child’s case |
Georgia County Name |
||
Static |
Y |
Referral Type |
Indicator of what system is sending this referral to STARS |
Hard Coded value of “SHI” |
||
Static |
Y |
SHINES Case ID |
Case Identifier for SHINES for this combination of NCP and Child |
Number |
16 |
|
Static |
N |
County DFCS Office Number |
Identifier from SHINES for the Office handling the case |
Number |
16 |
|
Dynamic |
N |
Office Name |
County DFCS Office Name |
|||
Static |
Y |
County DFCS Client ID |
This is the CRS ID for this county, NCP and child that SHINES registers |
|||
Dynamic |
N |
Case Manager’s Name |
Primary Case Manager’s Name |
|||
Dynamic |
N |
Case Manager’s Phone Number |
Primary Care Manager’s Phone Number |
|||
Dynamic |
N |
Case Manager’s Fax Number |
Primary Case Manager’s Fax Number |
|||
Dynamic |
N |
Case Manager’s Street Address |
Primary Case Manager’s Street Address (2 lines) |
|||
Dynamic |
N |
Case Manager’s City |
Primary Case Manager’s City |
|||
Static |
N |
Case Manager’s State |
Primary Case Manager’s State |
|||
Dynamic |
N |
Case Manager’s Zip |
Primary Case Manager’s Zip Code |
|||
Dynamic |
Y |
Child’s CRS ID |
Child’s Client Repository System Identifier |
|||
Static |
N |
Child’s Medicaid class of assistance |
Child’s Medicaid Class of Assistance |
‘F11’, ‘F13’, ‘F15’, ‘F22’, ‘F40’, ‘F99’, ‘D02’, ‘P01’, ‘EMA’, ‘SSI’, ‘XXX’ |
||
Dynamic |
N |
Non Custodial Parent (NCP) CRS ID |
NCP Client Repository System Identifier |
|||
Static |
N |
NCP Marital Status |
NCP Marital Status |
‘DI’, ‘MA’, ‘SE’, ‘SI’, ‘WI’ |
||
Static |
N |
NCP SSI Indicator |
Does the NCP receive SSI income? |
‘Y’ or ‘N’ |
||
Dynamic |
N |
NCP Address |
NCP primary address (2 lines) |
|||
Dynamic |
N |
NCP City |
City of the NCP |
|||
Static |
N |
NCP State |
State of the NCP |
|||
Dynamic |
N |
NCP Zip Code |
Zip Code of the NCP |
|||
Dynamic |
N |
NCP Employer Name |
NCP last known employer’s name |
|||
Dynamic |
N |
NCP Employer’s Street Address |
NCP last known employer’s street address |
|||
Dynamic |
N |
NCP Employer’s City |
NCP last known employer’s city |
|||
Static |
N |
NCP Employer’s State |
NCP last known employer’s state |
US State Value |
||
Dynamic |
N |
NCP Employer’s Zip |
NCP last known employer’s zip |
|||
Static |
N |
Child Support Court Ordered Indicator |
Was Child Support Court Ordered? |
‘Y’ or ‘N’ |
||
Dynamic |
N |
Child Per Diem |
Per Diem for this child. Calculation is based on combination of business logic. Please refer to the document: Determining Placement Contracts and Per Diems.doc in share point |
|||
Dynamic |
N |
Per Diem Effective Date |
Effective date of this Per Diem. Please refer to the document: Determining Placement Contracts and Per Diems.doc in share point |
|||
Static |
Y |
Eligibility Type |
010 020 040 050 |
Codes Referenced in above table:
| Race | AA | American Indian/Alaskan Native |
|---|---|---|
Race |
AN |
Asian |
Race |
BK |
Black/African American |
Race |
HP |
Hawaiian/Pacific Islander |
Race |
WT |
White |
Race |
UD |
Unable to Determine |
Marital Status |
SI |
Single, never married |
Marital Status |
MA |
Married |
Marital Status |
SE |
Separated |
Marital Status |
WI |
Widowed |
Marital Status |
UK |
Unknown |
Marital Status |
CH |
Child, not applicable |
Eligibility Type |
010 |
Title IV-E |
Eligibility Type |
020 |
Title IV-B |
Eligibility Type |
040 |
Not Eligible |
Eligibility Type |
030 |
Not Elig - County Pd |
Important Note: One cannot assume that each SHINES referral will result in a new $TARS case. If the Non Custodial Parent already has an open $TARS DFCS case for the same county (but a different child), this SHINES referral will usually be added to the existing $TARS case. Behind the scenes, SHINES will register a CRS id for the DFCS County for each NCP and child combination. The $TARS case will actually be centered around this “artificial” CRS record for the “county_name DFCS” as the custodial parent, so that the DFCS County Office receives the money instead of what was originally the custodial parent prior to removal from home. There is a separate county custodial parent CRS ID because of limits in how much a “normal” custodial parent can receive from child support. SHINES will not know the $TARS case structure. If SHINES sends over three referrals for three children for of a given NCP, $TARS would typically create one case, use the first County CRS ID SHINES sent, and ignore the remaining two. While that does create unused CRS IDs, it allows for flexibility in how many cases $TARS creates.
Receive Child Support Payment/History Information
Functional Description
Upon receiving a child support referral via the SHINES - $TARS interface, the Child Support Services program uses $TARS to perform the necessary business functions in accordance to Georgia State policy.
When the Child Support Services program updates or records a child support payment in $TARS that was from a SHINES referral, $TARS will compile the payment information and send it to SHINES. Upon receiving this payment record, SHINES edits, formats, and stores the following information in the INCOME_AND_RESOURCES database table. The child support amount sent by STARS does not have any decimal values. For ex: if a NCP sends $103.30 as payment for the children then, STARS sends the amount as 10330. SHINES has to calculate the decimal value. STARS have agreed to always send the value for cents. For ex: if the amount paid by the NCP is $103.00 then, STARS will send 10300 as the amount.
Table of Fields from $TARS back to SHINES
| Static/ Dynamic | Required (Yes, No) | Data Name | Description | Possible Value | Type | Length |
|---|---|---|---|---|---|---|
Dynamic |
Y |
County DFCS Office CRS ID |
Client Repository System Identifier for the county DFCS office – custodial parent. |
|||
Dynamic |
Y |
County DFCS Office Number |
Identifier for the DFCS County Office. |
|||
Dynamic |
Y |
NCP Parent’s CRS ID |
Client ID for the Non-Custodial parent making the payment |
|||
Dynamic |
Y |
Date Child Support Received |
Date Child Support income was received. |
|||
Dynamic |
Y |
Amount of Child Support Received |
Amount of Child Support income received. |
|||
Dynamic |
Y |
Check Number |
Number of the check for the payment |
Send Updated Parent Information
Functional Description
When any SHINES user updates the demographic information for either or both parents, SHINES will send the updated information to $TARS. These parents are what $TARS considers the Non-Custodial Parents. In terms of employment information, the initial plan is to limit to changes made through the SHINES application, and to not include information brought down through the SUCCESS interface.
SHINES will actually send a separate update transaction for each child that SHINES has sent a referral for that parent. While some of the data elements are child specific (per diem, child class of assistance) or case manager specific, this interface will NOT be triggered by updates of those fields. The update transaction is only sent when the NCP or its employer information changes. The per diem amount is updated on the SHINES outbound table by removing the decimal as STARS cannot accept decimals. For ex: if the per diem amount is $14.32 then we update our tables as 1432 and STARS picks the amount and places the decimal before the last two digits. We always make sure the last two digits we send are the cents value for ex: if the per diem amount is $14.00, we send 1400 so STARS can update it accordingly.
Table of Fields SHINES sends to $TARS
| Static/ Dynamic | Required (Yes, No) | Required (Yes, No) | Data Name | Data Name | Description | Description | Possible Value | Possible Value | Possible Value | Type | Length |
|---|---|---|---|---|---|---|---|---|---|---|---|
Dynamic |
Y |
Y |
NC Parent’s CRS ID |
NC Parent’s CRS ID |
Client ID for the Non-Custodial parent making the payment |
Client ID for the Non-Custodial parent making the payment |
Numeric |
9 |
|||
Dynamic |
Y |
Y |
NC Parent Address |
NC Parent Address |
Address of the non-custodial parent (2 lines) |
Address of the non-custodial parent (2 lines) |
Two different fields |
Two different fields |
Two different fields |
String |
60 |
Dynamic |
Y |
Y |
NC Parent City |
NC Parent City |
City of the Non-Custodial Parent |
City of the Non-Custodial Parent |
String |
20 |
|||
Static |
Y |
Y |
NC Parent State |
NC Parent State |
State of the Non-Custodial Parent |
State of the Non-Custodial Parent |
String |
2 |
|||
Dynamic |
Y |
Y |
NC Zip Code |
NC Zip Code |
Zip Code of the Non-Custodial parent |
Zip Code of the Non-Custodial parent |
String |
10 |
|||
Dynamic |
N |
N |
NC Employer Name |
NC Employer Name |
Name of last known Employer of Non-Custodial Parent |
Name of last known Employer of Non-Custodial Parent |
String |
80 |
|||
Dynamic |
N |
N |
Employer Address |
Employer Address |
Address of Employer (two lines) |
Address of Employer (two lines) |
String |
46 |
|||
Dynamic |
N |
N |
Employer City |
Employer City |
City of Employer |
City of Employer |
String |
20 |
|||
Static |
N |
N |
Employer State |
Employer State |
State of Employer |
State of Employer |
String |
2 |
|||
Dynamic |
N |
N |
Employer Zip Code |
Employer Zip Code |
Zip Code of Employer |
Zip Code of Employer |
String |
10 |
|||
Dynamic |
Y |
Y |
Child Client ID |
Child Client ID |
CRS ID of the child |
CRS ID of the child |
|||||
Static |
N |
N |
Child COA |
Child COA |
Child’s Medicaid Class of Assistance |
Child’s Medicaid Class of Assistance |
|||||
Dynamic |
N |
N |
Child’s Per Diem |
Child’s Per Diem |
Per Diem amount for the child |
Per Diem amount for the child |
|||||
Dynamic |
N |
N |
Effective Date of Per Diem |
Effective Date of Per Diem |
Effective Date of the child’s Per Diem |
Effective Date of the child’s Per Diem |
|||||
Dynamic |
Y |
Y |
SHINES Case Number |
SHINES Case Number |
ID of the SHINES case |
ID of the SHINES case |
|||||
Static |
Static |
Y |
Y |
Eligibility Type |
Eligibility Type |
010 020 040 050 |
|||||
Note: Remember that one update of the parent information can result in multiple outbound messages – one for each child that has already been referred for that parent.
Codes Referenced in above table:
| Eligibility Type | 010 | Title IV-E |
|---|---|---|
Eligibility Type |
020 |
Title IV-B |
Eligibility Type |
040 |
Not Eligible |
Eligibility Type |
030 |
Not Elig - County Pd |
Send Termination of Parental Rights and Adoption
Functional Description
Child Support Services need to be aware if a parent’s rights have been terminated on a child, or if that child is adopted out. Such changes could result in support payment changes on if the non-custodial parent needs to continue paying child support, and if so, how much. When a Case Manager logs a Termination of Parental Rights on the Legal Actions and Outcome page (Hearing Type of TPR, Outcome of TPR Granted or Action Type of Voluntary Surrender), a message will be created to send to $TARS to let them know of the TPR date. If the Case Manager indicates that the child has had adoption finalized, then a message(s) will be created with the adoption date. A message is created for each NCP **parent that has had a referral sent for that child.
Table of Fields SHINES sends to $TARS
| Static/ Dynamic | Required (Yes, No) | Data Name | Description | Possible Value | Type | Length |
|---|---|---|---|---|---|---|
Dynamic |
Y |
SHINES Case Number |
ID of the SHINES Case |
|||
Dynamic |
Y |
NC Parent’s CRS ID |
Client ID for the Non-Custodial parent |
Numeric |
9 |
|
Dynamic |
Y |
Child Client ID |
CRS ID of the child for whom TPR (or Action Type of Voluntary Surrender ) or adoption was finalized |
Numeric |
9 |
|
Dynamic |
N |
TPR Date |
Date the Termination of Parental Rights was granted |
Date |
||
Dynamic |
N |
Adoption Date |
Date the Adoption was finalized |
Date |
Send Update of Child No Longer In DFCS Care
Functional Description
While a child is in the care of DFCS, some or all of the money collected by Child Support Services can be used by DFCS to pay for services for that child. When the child returns home or otherwise leaves foster care, the amount paid to DFCS may change or be terminated. In order for $TARS to obtain timely information on a child’s return to home or other discharge, SHINES will send a message to $TARS when a Supervisor approves a child’s placement that results in an AFCARS discharge on the Placement page. A message is created for each NCP **parent that has had a referral sent for that child.
Table of Fields SHINES sends to $TARS
| Static/ Dynamic | Required (Yes, No) | Data Name | Description | Possible Value | Type | Length |
|---|---|---|---|---|---|---|
Dynamic |
Y |
Child Client ID |
CRS ID of the child who returned home |
Numeric |
9 |
|
Dynamic |
N |
Non Custodial Parent (NCP) CRS ID |
NCP Client Repository System Identifier |
|||
Dynamic |
Y |
Left Care Date |
Date the child left DFCS care |
Date |
||
Static |
Y |
Reason Code |
Reason code for why child left DFCS care (AFCARS discharge code) |
String |
3 |
|
Dynamic |
Y |
SHINES Case Number |
ID of the SHINES Case |
|||
Dynamic |
Y |
NCP Client ID |
CRS ID of the NCP |
|||
Dynamic |
N |
New Custodian Name |
Name of the person who is now the custodian of the child after discharge |
|||
Dynamic |
N |
New Custodian Address 1 |
Line 1 of Custodian address |
|||
Dynamic |
N |
New Custodian Address 2 |
Line 2 of Custodian address |
|||
Dynamic |
N |
New Custodian City |
City of Custodian |
|||
Static |
N |
New Custodiam State |
State of the custodian |
|||
Dynamic |
N |
New Custodian zip |
Zip Code of the custodian |
|||
Dynamic |
N |
New Custodian Phone |
Phone number of the Custodian |
Design Requirements
| Validated Functional Requirement Number | Conceptual Design Requirement Number | Conceptual Design Requirement |
|---|---|---|
149.23 |
149.23.1 |
Receive child support payment/history information via interface to $TARS system on mainframe. |
549.1 |
549.1.1 |
Send the Client ID for the child |
549.2 |
549.2.1 |
Receive the court ordered child support amount |
549.7 |
549.7.1 |
Receive the amount disbursed to the custodian/ Foster Care |
549.8 |
549.8.1 |
Receive the amount collected by Child Support Services |
549.10 |
549.10.1 |
Receive if there is an active child support case |
549.12 |
549.12.1 |
Receive the benefit amount |
Technical Design
Technical Overview
The $TARS application performs core processing of child support information as a COBOL application on a mainframe hosted at GTA, but the application is maintained by DHR.
SHINES will write outgoing information into separate interfacing tables for child support referral, parent information update, TPR (or Action Type of Voluntary Surrender ) /Adoption updates, and child leaving care updates. The GTA web Methods broker will access those tables directly via JDBC support, convert them into web Methods objects, and then send them to $TARS. The current plan is that the broker will either write records into a file that a $TARS batch process can handle or invoke a CICS program via web service. However, the web Methods broker will handle that transformation and transport for us, so this part of the interface is transparent to SHINES.
The major technical assertion is that the interface will not be synchronous. The end user of SHINES is not waiting on a response from the $TARS system before proceeding to the next step. SHINES will write out the database records for transmittal as soon as the SHINES user activates the appropriate trigger. How often the broker picks up these records is configurable based on business requirements.
SHINES will need to host a web service for the response to some of these transactions. The main web service will be to process incoming Child Support payment information. The GTA web Methods broker will be invoking these SHINES web services when it picks up outgoing responses from the $TARS system. $TARS is currently a batch-oriented architecture on their side. The SHINES side is architected to support that, but more rapid message handling essentially involves a configuration option in the broker, with no code changes need on the SHINES side.
In summary, the outgoing messages will be handled by basic inserts into new database tables to which other applications can subscribe. The SHINES application code writes out messages to the table; therefore, there is no performance impact to the live SHINES application if there are delays relaying a message out to the $TARS application on the mainframe. SHINES will be creating records in real-time. Incoming messages will be processed in real-time via web service invocations that will hook into the SHINES Enterprise Java Bean layer.
Below is an E-R diagram of tables created specifically for this interface:
$TARS Technical Specifications
Hardware/OS: IBM Mainframe
Programming Language: COBOL
Database: DB2
Transactional Monitor: CICS
Physical Location: GTA
Current Interfaces: Batch text files
Protocols: CONNECT:DIRECT, Microsoft Host Transaction Gateway, CICS
Expected Volume of Transactions: Maximum of 220 new cases a day
Child Support Referral
Technical Description
The SHINES application has an Eligibility Summary screen for a client (child). When the Eligibility Specialist selects the “Yes” radio button to make a referral to child support and approves the eligibility, the java conversation needs to be updated to create records in the interface table schema (SACWISIFC) so that the web broker can pick up the referrals.
The key interface table for referrals is CHILDSUP_REF_OUTBOUND. For the child whose summary is approved and whose per diem calculation returns a value, the application needs to create one record for each parent in the case (regardless of the living situation prior to removal). However, $TARS has the unusual requirement that a “virtual” custodial parent be registered with the CRS application on the mainframe (see CRS Interface Detailed Design) for each Non Custodial Parent targeted by $TARS referral per county. To accommodate this requirement, the SHINES application will register a county level CRS record for each referral (each combination of parent and child) and create a row in the AGENCY_CUSTODIAL_PARENTS to keep track of all of the “virtual” county DFCS registered for audit purposes. The first name will be the name of the county, such as “FULTON”, and the last name is “DFCS”. Since Gender, Race, and Ethnicity are required by CRS, SHINES will default to Female, African American, and Non-Latino.
The next step is to actually register the virtual parent with CRS and obtain a CRS ID. The SHINES application will invoke the CRS Registration interface for each parent found in the Foster Care stage upon save/submit of the Eligibility Summary page if referral button was selected. SHINES will create a new county CRS ID, and a new record will be added to the CRS AGENCY_CUSTODIAL_PARENT table. The CHILDSUP_REF_OUTBOUND table can be updated with the returned CRS ID.
The interface broker from GTA (web Methods) will use the JDBC connector to scan the CHILDSUP_REF_OUTBOUND table and send referral messages to $TARS for processing.
Message Description
The message contains the information for creating or checking for *one *$TARS case for each NCP and child. For a given SHINES case, there can be multiple $TARS cases as described above. The message contains information on the child, the non-custodial parent, and the “virtual” DFCS custodial parent. The message contains key demographic values, along with what SHINES has for being the most recent employer. The message contains enough information to search and possibly start a $TARS Child Support case.
Table of Fields from SHINES to $TARS
| Column Name | Domain | Datatype | Null | Definition | Use in Interface |
|---|---|---|---|---|---|
ID_CHILDSUP_REF_OUTBOUND |
ID |
NUMBER(16, 0) |
N |
Unique identifier for a Child Support Referral. For a given case, there will be one referral for each combination of non-custodial parent and child in care. |
Transaction Unique ID – Send to broker and target system |
DT_LAST_UPDATE |
DT_LAST_UPDATE |
DATE |
N |
Date of insert or last update |
Internal tracking of when this row was last updated |
INTERFACE_STATUS |
VARCHAR2(3) |
N |
Status of this record with regards to the interface - Waiting (WTG), NEW, INP (In Process), SNT (Sent), ERR (Error). A record will initially start out as Waiting, until the custodial parent (artificial) has been created in CRS. Once that is obtained, the status will progress to NEW, and be ready for be picked up by the broker. |
Used by the interface broker to determine which records need to be sent, and updated by the broker when a record is sent |
|
DT_PROCESS |
DATE |
Y |
Date sent by the interface (Sent) or errored out (Error) |
Used by the interface broker to indicate when it picked up, sent, or errored out on this transaction |
|
CD_ERROR |
VARCHAR2(10) |
Y |
If there was an error sending this record, an error code as to why is stored here. |
If there was an error in the web broker or interface processing, code is stored here |
|
ID_INITIATOR |
ID |
NUMBER(16, 0) |
N |
ID_INITIATOR references ID_PERSON in the PERSON table. This is the SHINES user that requested the Income information. The user should be in the EMPLOYEE table as well. |
Internal SHINES auditing |
SHINES_LOGON_SHORT |
VARCHAR2(8) |
Y |
This is the 8 character version of the SHINES logon used for interfacing with systems (such as the mainframe) with an 8 character limit. |
Sent in the interface as a virtual “RACF” user |
|
DT_CSUP_REQUESTED |
DATE |
Y |
This is typically the original date that the user first approved an eligibility summary with performing a Child Support request checked for the first time. |
Published by interface broker to target system |
|
ID_CASE |
ID |
NUMBER(16, 0) |
N |
ID of the SHINES case that this is a child support referral for. Internal use. |
Used internally to match the SHINES case this referral is for. |
ID_STAGE |
ID |
NUMBER(16, 0) |
N |
ID of the STAGE from which the child support referral was made. Internal use. |
Used internally. |
ID_CHILD |
ID |
NUMBER(16, 0) |
N |
SHINES ID for the child in care that we are making a referral for. Internal use. |
Used internally. |
NBR_CHILD_CRS_ID |
NUMBER(9, 0) |
N |
This is a nine digit identifier from Georgia’s Client Registration System, a central repository for clients being served by $TARS and other systems. |
Published by interface broker to target system |
|
IND_CHILD_PATERNITY_EST |
VARCHAR2(1) |
Y |
Paternity Established for Child |
Published by interface broker to target system |
|
NBR_PER_DIEM |
NUMBER(6, 2) |
Y |
Daily foster care per diem rate. For children only. Please refer to the document: Determining Placement Contracts and Per Diems.doc in share point |
Published by interface broker to target system |
|
NBR_PER_MONTH |
NUMBER(6, 2) |
Y |
Monthly rate, if applicable. This is possibly used by adoption assistance. Please refer to the document: Determining Placement Contracts and Per Diems.doc in share point |
Published by interface broker to target system |
|
DT_EFF_PER_DIEM |
DATE |
Y |
Effective date of the Per Diem or Per Month associated with this child of the parent that got updated. Please refer to the document: Determining Placement Contracts and Per Diems.doc in share point |
Published by interface broker to target system |
|
IND_CHILD_SUPPORT_ORDER |
VARCHAR2(1) |
Y |
Indicates that child support was court ordered to be paid to DFCS. From FCE_APPLICATION |
Published by interface broker to target system |
|
CD_MED_COA |
VARCHAR2(2) |
Y |
Medicaid Class of Assistance for the child |
Published by interface broker to target system |
|
ID_NONCUST_PARENT |
ID |
NUMBER(16, 0) |
N |
ID from the PERSON table of the Non-Custodial parent (regardless of whether the parent had custody at time of removal). The $TARS referral will be seeking funds from this person, if applicable. |
Used internally |
NBR_NONCUST_CRS_ID |
NUMBER(9, 0) |
N |
The CRS ID of the Non-Custodial parent. This should have been obtained in the Investigation stage. |
Published by interface broker to target system |
|
ADDR_NONCUST_ADDR_ST_LN_1 |
VARCHAR2(25) |
Y |
Street address for non custodial parent |
Published by interface broker to target system |
|
ADDR_NONCUST_ADDR_ST_LN_2 |
VARCHAR2(25) |
Y |
Second line of Street address for non custodial parent |
Published by interface broker to target system |
|
ADDR_NONCUST_ADDR_CITY |
VARCHAR2(20) |
Y |
City of Non Custodial Parent |
Published by interface broker to target system |
|
CD_NONCUST_ADDR_STATE |
VARCHAR2(2) |
Y |
Code representing the state in which the non custodial parent lives |
Published by interface broker to target system |
|
ADDR_NONCUST_ADDR_ZIP |
VARCHAR2(10) |
Y |
Numeric zip code for non custodial parent |
Published by interface broker to target system |
|
TXT_INC_RSRC_DESC |
VARCHAR2(80) |
Y |
Employer Description. This and the following income fields come from the INCOME_AND_RESOURCES table. Use the first record that has no end date and the most recent begin date of type WAGES/SALARY. |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_ST_LN1 |
VARCHAR2(25) |
Y |
Line 1 of the address for the income source |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_ST_LN2 |
VARCHAR2(25) |
Y |
Line 2 of the street address for the income resource. |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_CITY |
VARCHAR2(20) |
Y |
City for the income resource source. |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_STATE |
VARCHAR2(2) |
Y |
State for the Income Resource Source |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_ZIP |
VARCHAR2(10) |
Y |
Zip Code for the income resource source. |
Published by interface broker to target system |
|
IND_SSI_NONCUST |
VARCHAR2(1) |
Y |
Indicator (Y/N) if Non Custodial Parent is receiving SSI income. This is DERIVED from the INCOME_AND_RESOURCES table - if there is an income of type SSI for this person with no end date. |
Published by interface broker to target system |
|
CD_NONCUST_MARITAL_STATUS |
VARCHAR2(2) |
Y |
Code representing the marital status of the non-custodial parent |
Published by interface broker to target system |
|
ID_AGENCY_CUSTODIAL_PARENTS |
ID |
NUMBER(16, 0) |
N |
Primary (artificial) key of the AGENCY_CUSTODIAL_PARENTS. This will uniquely identify an artificial Custodial Parent within SHINES. |
Internal use |
NBR_CUST_CRS_ID |
NUMBER(9, 0) |
Y |
CRS ID of the virtual "custodial parent" associated with the county agency and the child support referral. |
Published by interface broker to target system |
|
CD_COUNTY |
CD_COUNTY |
VARCHAR2(3) |
Y |
County Code for the county that has the child in care. |
Published by interface broker to target system |
ID_OFFICE |
ID |
NUMBER(16, 0) |
Y |
SHINES ID for the DFCS Office handling this case |
Published by interface broker to target system |
NM_OFFICE_NAME |
VARCHAR2(15) |
Y |
Name of DFCS Office. |
Published by interface broker to target system |
|
NM_CASEMANAGER_FIRST |
VARCHAR2(12) |
Y |
Current, valid first name of the case manager. |
Published by interface broker to target system |
|
NM_CASEMANAGER_MIDDLE |
VARCHAR2(12) |
Y |
Current, valid middle name of the case manager |
Published by interface broker to target system |
|
NM_CASEMANAGER_LAST |
VARCHAR2(22) |
Y |
Current, valid last name of the case manager |
Published by interface broker to target system |
|
NBR_CASEMANAGER_PHONE |
VARCHAR2(10) |
Y |
Phone number of the case manager |
Published by interface broker to target system |
|
NBR_CASEMANAGER_FAX |
VARCHAR2(10) |
Y |
Fax number for case manager, if available. |
Published by interface broker to target system |
|
ADDR_CASEMAN_ADDR_ST_LN_1 |
VARCHAR2(25) |
Y |
Street address for DFCS Case Manager - Comes from the CD_MAIL table in SHINES - employee table has Office Id and Office Mail Code. The Office mail code can be used to look up in CD_MAIL, and the office id can be used to go into OFFICE_PHONE to get both the phone and the fax numbers if available. |
Published by interface broker to target system |
|
ADDR_CASEMAN_ADDR_ST_LN_2 |
VARCHAR2(25) |
Y |
Second line of Street address for Case Manager |
Published by interface broker to target system |
|
ADDR_CASEMAN_ADDR_CITY |
VARCHAR2(20) |
Y |
City of Case Manager |
Published by interface broker to target system |
|
CD_CASEMAN_ADDR_STATE |
VARCHAR2(2) |
Y |
Code representing the state for the case manager |
Published by interface broker to target system |
|
ADDR_CASEMAN_ADDR_ZIP |
VARCHAR2(10) |
Y |
Numeric zip code for DFCS case manager |
Published by interface broker to target system |
|
CD_ELIGIBILITY_TYPE |
VARCHAR2(3) |
Y |
ELIGIBILITY TYPE |
Published by interface broker to target system |
Table of Output Fields from $TARS to SHINES
Return Status. Updates outbound table status field, and Eligibility Summary Screen will display that the referral was sent if this is a success status.
Method Narrative
Following this Eligibility Specialists review of the child’s eligibility application, he/she must confirm the child’s eligibility using the Eligibility Determination Worksheet and document the results of the determination (including, eligibility and reimbursability) using the Eligibility Summary page. Upon documenting the results and selecting the “Yes” radio button for Child Support Referral, the CSUP-SEND indicator in the ELIGIBILITY database table is set to ‘YES’ if per diem information exists for the child and rows are created in the outbound interface tables used for the $TARS interface.
SHINES will create a referral outbound record for *each parent *associated with the child. For each parent, SHINES will perform the following actions.
First, SHINES will create a virtual custodial parent representing the DFCS County office by invoking the CRS Registration web service in real time. The results of that invocation, if successful, will be inserted into the AGENCY_CUSTODIAL_PARENTS table. Finally, SHINES will create a row in the CHILDSUP_REF_OUTBOUND data using the same virtual parent id along with information from FCE, Income and Resources, Person, and Person ID tables. This referral record will initially have a status of ‘NEW’ for ready to be picked up by the interface broker. This process will be repeated for each parent associated with the child who has been approved.
The web Methods broker will poll the referral table for outgoing $TARS referrals with a status of ‘NEW’, send them to the $TARS application, and then update interface_status, dt_process, and possibly the CD_ERROR column in the CHILDSUP_REF_OUTBOUND table.
$TARS users review incoming requests, validate information, and collaborate with external agencies to determine child support benefits.
Error Handling
Error codes are written by the web Methods broker into the CD_ERROR field. The broker is responsible for retries, and if needed, emails are sent by the broker to administrators to notify them of problems in this interface.
Field Level Errors
If a field in a record to be extracted has a validation error, that row will be skipped, CD_ERROR and DT_PROCESS updated, and an email should be sent to the application administrators by the broker.
Row Level Errors
The broker should update CD_ERROR and DT_PROCESS if possible. Regardless, the broker should send an email to application administrators
Process Level Errors
The most likely process level errors will be network and other communications errors. The interface broker will handle retries, and send emails to application administrators as needed. The other most common process error would be if the invocation to register the county custodial parent through CRS fails. If that fails, the user will be notified to try again another time and all effects of the save transaction will be rolled back, similar to the processing found in the CRS detailed design.
Triggering/Scheduling
When the Eligibility Specialist documents the results of the child’s eligibility determination and selects the “Yes” radio button to perform a Child Support Referral (and one has not already been made), a record will be created in the CHILDSUP_REF_OUTBOUND table. The interface broker will be configured to scan this table for referrals that are ready to process.
Matching Criteria
$TARS also leverages the Client Repository System (CRS) to manage client information. Therefore, the CRS ID (URN) is the primary identifier for all clients/child’s information sent to $TARS. Transactions will also have a transaction id to match specific responses.
Dependencies
All clients/children CRS identifiers are captured during the Investigation (INV) stage. Therefore, prior to sending information to $TARS, all CRS identifiers must be present for $TARS to understand the client/children information. Also, artificial “DFCS” Custodial parents must be created for each parent in each county.
Related Database Table structures
AGENCY_CUSTODIAL_PARENTS table:
| Column Name | Domain | Datatype | Null | Definition |
|---|---|---|---|---|
ID_AGENCY_CUSTODIAL_PARENTS |
ID |
NUMBER(16, 0) |
N |
Primary (artificial) key of the AGENCY_CUSTODIAL_PARENTS. This will uniquely identify an artificial Custodial Parent within SHINES. |
DT_LAST_UPDATE |
DT_LAST_UPDATE |
DATE |
N |
Date of insert or last update |
CD_COUNTY |
CD_COUNTY |
VARCHAR2(3) |
N |
County Code for the DFCS Office represented by this "person". |
NM_PERSON_LAST |
VARCHAR2(22) |
Y |
Last name of an individual. In this case, last name is 'DFCS'. |
|
NM_PERSON_FIRST |
VARCHAR2(12) |
Y |
First name of an individual. In this case, the value is name of the county, such as 'FULTON'. |
|
NM_PERSON_MIDDLE |
VARCHAR2(12) |
Y |
Middle name of an individual. In this case, 'SHINES' to indicate this artificial person has been registered by SHINES. |
|
CD_PERSON_SEX |
VARCHAR2(1) |
N |
Code representing an individual’s sex. In this case, 'F' for Female. |
|
CD_ETHNICITY |
VARCHAR2(2) |
N |
Contains a code identifying the ethnic background of a person. In this case, it will be 'NH' for Non-Hispanic. |
|
CD_RACE |
VARCHAR2(2) |
N |
Contains a code identifying the race of a person. In this case, it will be 'BK' for Black/African American |
|
NBR_CRS_ID |
CRS Client Identifier |
NUMBER(9, 0) |
Y |
This is a nine digit identifier from Georgia’s Client Registration System, a central repository for clients being served by Medicaid, TANF, Food Stamps, DFCS, and child support cases. This ID serves as a cross-system identifier with external systems. This is a RETURN value for the CRS interface coming back to SHINES. This is the CRS ID associated with this Agency Custodial Virtual Person. |
NBR_NCP_CRS_ID |
CRS Client Identifier |
NUMBER(9, 0) |
Y |
This is the Client Identifier obtained from CRS (Client Repository System) which is used in state of Georgia applications. This particular field is the CRS ID associated with the corresponding Non Custodial Parent, which is a real human being. $TARS associates cases with the non custodial parent making the payment. The interface needs to use the same agency CRS ID for a NCP CRS Id that is in the same county. |
Receive Child Support Payment/History Information
Technical Description
When the Child Support Services program updates or records a child support payment in $TARS, $TARS will send that payment information to SHINES. SHINES will expose a web service interface that the web Methods broker will invoke. Upon being called by the broker, the SHINES web service edits, formats, and stores the following information in the INCOME_AND_RESOURCES database table. Payment information coming to SHINES is a result of the referral message, but not a direct 1-to-1 correlation. The referral process “subscribes” SHINES to the payment information for the non custodial parent, regardless of how many referrals SHINES has sent for that child.
An ID_PARENT field will need to be added to the CHILD_SUPPORT table to store that information being returned, though the JSP page will not display the parent information in the initial release. A future maintenance release may add that functionality.
Message Description
The message contains child support payment information, which includes identifiers for parent and custodial county parent, as well as the amount, check and date of the payment.
Table of Fields from $TARS to SHINES
| Static/ Dynamic | Required (Yes, No) | Data Name | Data Type | Length | Transformation Rules | Validation Rules | Default |
|---|---|---|---|---|---|---|---|
Dynamic |
Y |
County’s CRS ID |
Numeric |
9 |
|||
Dynamic |
Y |
County DFCS Number |
Numeric |
16 |
|||
Dynamic |
Y |
Non-Custodial Parent CRS ID |
Numeric |
9 |
|||
Dynamic |
Y |
Date Child Support Received |
Date |
||||
Dynamic |
Y |
Amount of Child Support Received |
Numeric |
10,2 |
|||
Dynamic |
Y |
Check Number |
Numeric |
Method Narrative
SHINES web service will be invoked by the web Methods broker, and that web service processes the transaction by searching the STAGE_PERSON_LINK table to find all open Foster Care stages (SUB) with that person as a parent. For each stage found, the service will look at the ELIBILITY table record for the child in that stage to see if that child has had a referral made for him to Child Support. Once all referred children in that county for the NCP has been found, the amount of the check will be divided up evenly amongst the children. Finally, the service will create entries in the INCOME_AND_RESOURCES table for each child.
Error Handling
Error codes are written by the web Methods broker into the CD_ERROR field. The broker is responsible for retries, and if needed, emails are sent by the broker to administrators to notify them of problems in this interface.
Field Level Errors
If a field in a record to be extracted has a validation error, that row will be skipped; CD_ERROR and DT_PROCESS updated, and an email should be sent to the application administrators by the broker.
Row Level Errors
The broker should update CD_ERROR and DT_PROCESS if possible. Regardless, the broker should send an email to application administrators
Process Level Errors
The most likely process level errors will be network and other communications errors. The interface broker will handle retries, and send emails to application administrators as needed.
Triggering/Scheduling
$TARS will be in control of when it will send SHINES payment information. The SHINES web service will update the SHINES database in real time.
Matching Criteria
$TARS also leverages the Client Repository System (CRS) to manager client information. Therefore, the CRS ID (URN) is the primary identifier for the county and the NCP information sent from $TARS. Transactions will also have a transaction id to match specific responses to.
Dependencies
All clients/children CRS identifiers are captured during the Investigation (INV) stage. Therefore, prior to sending information to $TARS, all CRS identifiers must be present for $TARS to understand the client/children information. Also, artificial “DFCS” Custodial parents must be created for each parent and county combination.
Send Updated Parent Information
Technical Description
When the Case Manager updates the parent demographic data or the current employer information of a parent in a $TARS case, the SHINES java code will insert a row into the CSUP_PARENT_OUTBOUND table for each child that has been referred with an interface_status of ‘NEW’. The web Methods broker will pick up these records and send them to the $TARS application using JDBC adapter technology.
Message Description
The message contains updated demographic and current employer information for a parent in SHINES, which $TARS refers to as a Non-Custodial Parent.
Table of Fields from SHINES to $TARS
| Attribute/Logical Role name | Domain | Data type | Null | Definition | Use in Interface |
|---|---|---|---|---|---|
ID_CSUP_PARENT_OUTBOUND |
ID |
NUMERIC(16, 0) |
N |
Unique identifier (artificial) of a transaction to update parent information for a child support system. |
Transaction Unique ID – Send to broker and target system |
DT_LAST_UPDATE |
DT_LAST_UPDATE |
DATE |
N |
Date of insert or last update |
Internal tracking of when this row was last updated |
INTERFACE_STATUS |
VARCHAR(3) |
N |
Status of this record with regards to the interface - NEW, INP (In Process), SNT (Sent), ERR (Error). A record will initially have a status of NEW, and be ready for be picked up by the broker. |
Used by the interface broker to determine which records need to be sent, and updated by the broker when a record is sent |
|
DT_PROCESS |
DATE |
Y |
Date sent by the interface (Sent) or errored out (Error) |
Used by the interface broker to indicate when it picked up, sent, or errored out on this transaction |
|
CD_ERROR |
VARCHAR(10) |
Y |
If there was an error sending this record, an error code as to why is stored here. |
If there was an error in the web broker or interface processing, code is stored here |
|
ID_INITIATOR |
ID |
NUMERIC(16, 0) |
N |
ID_INITIATOR references ID_PERSON in the PERSON table. This is the SHINES user that updated the parent information. The user should be in the EMPLOYEE table as well. |
Internal SHINES auditing |
DT_CSUPPAR_REQUESTED |
DATE |
Y |
This is typically the original date that user updated the parent in a child support referral case. |
Published by interface broker to target system |
|
NBR_CHILD_CRS_ID |
NUMERIC(9, 0) |
N |
This is a nine digit identifier from Georgia’s Client Registration System, a central repository for clients being served by $TARS and other systems. This is the child of the referral. |
Published by interface broker to target system |
| Column Name | Domain | Data type | Null | Definition | Use in Interface |
|---|---|---|---|---|---|
ID_CSUP_PARENT_OUTBOUND |
ID |
NUMBER(16, 0) |
N |
Unique identifier (artificial) of a transaction to update parent information for a child support system. |
Transaction Unique ID – Send to broker and target system |
DT_LAST_UPDATE |
DT_LAST_UPDATE |
DATE |
N |
Date of insert or last update |
Internal tracking of when this row was last updated |
INTERFACE_STATUS |
VARCHAR2(3) |
N |
Status of this record with regards to the interface - NEW, INP (In Process), SNT (Sent), ERR (Error). A record will initially have a status of NEW, and be ready for be picked up by the broker. |
Used by the interface broker to determine which records need to be sent, and updated by the broker when a record is sent |
|
DT_PROCESS |
DATE |
Y |
Date sent by the interface (Sent) or error out (Error) |
Used by the interface broker to indicate when it picked up, sent, or error out on this transaction |
|
CD_ERROR |
VARCHAR2(10) |
Y |
If there was an error sending this record, an error code as to why is stored here. |
If there was an error in the web broker or interface processing, code is stored here |
|
ID_INITIATOR |
ID |
NUMBER(16, 0) |
N |
ID_INITIATOR references ID_PERSON in the PERSON table. This is the SHINES user that updated the parent information. The user should be in the EMPLOYEE table as well. |
Internal SHINES auditing |
DT_CSUPPAR_REQUESTED |
DATE |
Y |
This is typically the original date that user updated the parent in a child support referral case. |
Published by interface broker to target system |
|
NBR_CHILD_CRS_ID |
NUMBER(9, 0) |
N |
This is a nine digit identifier from Georgia’s Client Registration System, a central repository for clients being served by $TARS and other systems. This is the child of the referral. |
Published by interface broker to target system |
|
NBR_NONCUST_CRS_ID |
NUMBER(9, 0) |
N |
The CRS ID of the Non-Custodial parent. This should have been obtained in the Investigation stage. |
Published by interface broker to target system |
|
NM_NONCUST_LAST |
VARCHAR2(22) |
Y |
Last name of an individual - Non-Custodial Parent |
Published by interface broker to target system |
|
NM_NONCUST_FIRST |
VARCHAR2(12) |
Y |
First name of an individual - Non Custodial Parent |
Published by interface broker to target system |
|
NM_NONCUST_MIDDLE |
VARCHAR2(12) |
Y |
Middle name of an individual - Non Custodial Parent |
Published by interface broker to target system |
|
NBR_NONCUST_NUMBER |
VARCHAR2(15) |
Y |
This data element contains the Social Security Number for non-custodial parent. |
Published by interface broker to target system |
|
CD_CRS_NONCUST_RACE |
VARCHAR2(1) |
Y |
The single character race code used by CRS, $TARS, and SUCCESS. |
Published by interface broker to target system |
|
DT_NONCUST_DOB |
DATE |
Y |
Non Custodial Parent’s Date of Birth |
Published by interface broker to target system |
|
IND_SSI_NONCUST |
VARCHAR2(1) |
Y |
Indicator (Y/N) if Non Custodial Parent is receiving SSI income. This is DERIVED from the INCOME_AND_RESOURCES table - if there is an income of type SSI for this person with no end date. |
Published by interface broker to target system |
|
ADDR_NONCUST_ADDR_ST_LN_1 |
VARCHAR2(25) |
Y |
Street address for non custodial parent |
Published by interface broker to target system |
|
ADDR_NONCUST_ADDR_ST_LN_2 |
VARCHAR2(25) |
Y |
Second line of Street address for non custodial parent |
Published by interface broker to target system |
|
ADDR_NONCUST_ADDR_CITY |
VARCHAR2(20) |
Y |
City of Non Custodial Parent |
Published by interface broker to target system |
|
CD_NONCUST_ADDR_STATE |
VARCHAR2(2) |
Y |
Code representing the state in which the non custodial parent lives |
Published by interface broker to target system |
|
ADDR_NONCUST_ADDR_ZIP |
VARCHAR2(10) |
Y |
Numeric zip code for non custodial parent |
Published by interface broker to target system |
|
NBR_NONCUST_PHONE |
VARCHAR2(10) |
Y |
Phone number of an individual. |
Published by interface broker to target system |
|
TXT_INC_RSRC_DESC |
VARCHAR2(80) |
Y |
Employer Description. This and the following income fields come from the INCOME_AND_RESOURCES table. Use the first record that has no end date and the most recent begin date of type WAGES/SALARY. |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_ST_LN1 |
VARCHAR2(25) |
Y |
Line 1 of the address for the income source |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_ST_LN2 |
VARCHAR2(25) |
Y |
Line 2 of the street address for the income resource. |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_CITY |
VARCHAR2(20) |
Y |
City for the income resource source. |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_STATE |
VARCHAR2(2) |
Y |
State for the Income Resource Source |
Published by interface broker to target system |
|
TXT_INC_RSRC_SRC_ADDR_ZIP |
VARCHAR2(10) |
Y |
Zip Code for the income resource source. |
Published by interface broker to target system |
|
ID_CASE |
ID |
NUMBER(16, 0) |
N |
The SHINES Case ID. |
Published by interface broker to target system |
NBR_PER_DIEM |
NUMBER(6, 2) |
Y |
Daily foster care per diem rate. For children only. Please refer to the document: Determining Placement Contracts and Per Diems.doc in share point |
Published by interface broker to target system |
|
NBR_PER_MONTH |
NUMBER(6, 2) |
Y |
Monthly rate, if applicable. This is possibly used by adoption assistance. Please refer to the document: Determining Placement Contracts and Per Diems.doc in share point |
Published by interface broker to target system |
|
DT_EFF_PER_DIEM |
DATE |
Y |
Effective date of the Per Diem or Per Month associated with this child of the parent that got updated. Please refer to the document: Determining Placement Contracts and Per Diems.doc in share point |
Published by interface broker to target system |
|
CD_MED_CLASS_ASST |
VARCHAR2(3) |
Y |
Current Medicaid Class of Assistance for the child associated with this update |
Published by interface broker to target system |
|
NM_CASEMAN_LAST |
VARCHAR2(22) |
Y |
Last name of an individual - Case Manager for DFCS |
Published by interface broker to target system |
|
NM_CASEMAN_FIRST |
VARCHAR2(12) |
Y |
First name of an individual - DFCS Case Manager |
Published by interface broker to target system |
|
NM_CASEMAN_MIDDLE |
VARCHAR2(12) |
Y |
Middle name of an individual - DFCS Case Manager |
Published by interface broker to target system |
|
ADDR_CASEMAN_ADDR_ST_LN_1 |
VARCHAR2(25) |
Y |
Street address for DFCS Case Manager - Comes from the CD_MAIL table in SHINES - employee table has Office Id and Office Mail Code. The Office mail code can be used to look up in CD_MAIL, and the office id can be used to go into OFFICE_PHONE to get both the phone and the fax numbers if available. |
Published by interface broker to target system |
|
ADDR_CASEMAN_ADDR_ST_LN_2 |
VARCHAR2(25) |
Y |
Second line of Street address for Case Manager |
Published by interface broker to target system |
|
ADDR_CASEMAN_ADDR_CITY |
VARCHAR2(20) |
Y |
City of Case Manager |
Published by interface broker to target system |
|
CD_CASEMAN_ADDR_STATE |
VARCHAR2(2) |
Y |
Code representing the state for the case manager |
Published by interface broker to target system |
|
ADDR_CASEMAN_ADDR_ZIP |
VARCHAR2(10) |
Y |
Numeric zip code for DFCS case manager |
Published by interface broker to target system |
|
NBR_CASEMAN_PHONE |
VARCHAR2(10) |
Y |
Phone number of an individual. |
Published by interface broker to target system |
|
NBR_CASEMAN_FAX |
VARCHAR2(10) |
Y |
Fax Number for the DFCS Case Manager |
Published by interface broker to target system |
|
CD_ELIGIBILITY_TYPE |
VARCHAR2(3) |
Y |
Eligibility Type |
Published by interface broker to target system |
Method Narrative
When the Case Manager updates the parent demographic data (person screen information including name, address, phone, race, SSN, and DOB) or the current employer information (Income and Resources information including employer name and address) of a parent in a $TARS case, the SHINES java code will insert a row for each referred child in that county into the CSUP_PARENT_OUTBOUND table with an interface_status of ‘NEW’. The unique transaction id is the ID_CSUP_PARENT_OUTBOUND field, which is automatically populated by the insert database trigger. The web Methods broker will scan this table looking for the ‘NEW’ records with the Oracle JDBC adapter, change the status to ‘INP’ for in progress and update the dt_process date. Once the message is delivered to $TARS, the web Methods broker will update the interface_status to ‘SNT’ for sent and update again the dt_process date. While this message contains information on the case manager and the child, changes of this data along will NOT trigger this interface. Only change to the parent or employer information will trigger the interface, but the SHINES application will send the current values of the case manager and child information along with the updated parent/employer data.
Error Handling
Error codes are written by the web Methods broker into the CD_ERROR field. The broker is responsible for retries, and if needed, emails are sent by the broker to administrators to notify them of problems in this interface.
Field Level Errors
If a field in a record to be extracted has a validation error, that row will be skipped; CD_ERROR and DT_PROCESS updated, and an email should be sent to the application administrators by the broker.
Row Level Errors
The broker should update CD_ERROR and DT_PROCESS if possible. Regardless, the broker should send an email to application administrators
Process Level Errors
The most likely process level errors will be network and other communications errors. The interface broker will handle retries, and send emails to application administrators as needed.
Triggering/Scheduling
When the Case Manager updates the parent demographic data or the current employer information of a parent in a $TARS case, the outbound rows are created. web Methods configuration dictates how often this table is scanned.
Send Termination of Parental Rights and Adoption
Technical Description
When a Case Manager logs a Termination of Parental Rights on the Legal Actions and Outcome page (Hearing Type of TPR, Outcome of TPR Granted, or Action Type of Voluntary Surrender) or indicates that the child has had an adoption finalized, the SHINES java code will insert a row into the ADOPT_TPR_OUTBOUND table with an interface_status of ‘NEW’. If TPR has been finalized, then the DT_TPR_FINALIZED field will be populated. If the adoption has been finalized, then the DT_ADOPT_FINALIZED will be populated. The web Methods broker will pick up these records and send them to the $TARS application using JDBC adapter technology. (Note: For Action Type of Voluntary Surrender, the Non-Custodial Parent is determined through the parent relationship defined in the FCC stage person link table and will use either biological or legal parental relationships for both biological and adoptive voluntary surrender types)
Message Description
The message contains the TPR Finalized Date and/or the Adoption Finalized Date for a child and parent (considered the Non-Custodial Parent in $TARS).
Table of Fields from SHINES to $TARS
| Attribute/Logical Role name | Domain | Data type | Null | Definition | Use in Interface |
|---|---|---|---|---|---|
ID_ADOPT_TPR_OUTBOUND |
ID |
NUMERIC(16, 0) |
N |
Unique identifier for Adoption/TPR Outbound record |
Transaction Unique ID – Send to broker and target system |
DT_LAST_UPDATE |
DT_LAST_UPDATE |
DATE |
N |
Date of insert or last update |
Internal tracking of when this row was last updated |
INTERFACE_STATUS |
VARCHAR(3) |
N |
Status of this record with regards to the interface - NEW, INP (In Process), SNT (Sent), ERR (Error). A record will initially have a status of NEW, and be ready for be picked up by the broker. |
Used by the interface broker to determine which records need to be sent, and updated by the broker when a record is sent |
|
DT_PROCESS |
DATE |
Y |
Date sent by the interface (Sent) or error out (Error) |
Used by the interface broker to indicate when it picked up, sent, or error out on this transaction |
|
CD_ERROR |
VARCHAR(10) |
Y |
If there was an error sending this record, an error code as to why is stored here. |
If there was an error in the web broker or interface processing, code is stored here |
|
ID_INITIATOR |
ID |
NUMERIC(16, 0) |
N |
ID_INITIATOR references ID_PERSON in the PERSON table. This is the SHINES user that updated the parent information. The user should be in the EMPLOYEE table as well. |
Internal SHINES auditing |
DT_ADOPTTPR_REQUESTED |
DATE |
Y |
This is typically the original date that user updated case to mark child as adopted or TPR finalized. |
Published by interface broker to target system |
|
NBR_CHILD_CRS_ID |
NUMERIC(9, 0) |
N |
This is a nine digit identifier from Georgia’s Client Registration System, a central repository for clients being served by $TARS and other systems. This is the child of the referral. |
Published by interface broker to target system |
|
NBR_NONCUST_CRS_ID |
NUMERIC(9, 0) |
N |
The CRS ID of the Non-Custodial parent who had rights terminated or child adoption finalized |
Published by interface broker to target system |
|
DT_TPR_FINALIZED |
DATE |
Y |
Date the Termination of Parental Rights was Finalized. Could be NULL if this is an Adoption message. |
Published by interface broker to target system |
|
DT_ADOPT_FINALIZED |
DATE |
Y |
Date Adoption was Finalized. This will be NULL for a TPR only message. |
Published by interface broker to target system |
|
ID_CASE |
ID |
N |
Shines Case Number |
Published by interface broker to target system |
Method Narrative
Java code for the Legal Actions and Outcome page will be updated to look for a TPR hearing with an outcome of granted (or Action Type of Voluntary Surrender) and insert a row into the ADOPT_TPR_OUTBOUND table with an interface status of ‘NEW’ and the hearing date used to populate the DT_TPR_FINALIZED field. The same Java code will also look for Adoption being granted, and insert a row into ADOPT_TPR_OUTBOUND with DT_ADOPT_FINALIZED populated with the hearing date. The unique transaction id is the ID_ADOPT_TPR_OUTBOUND field, which is automatically populated by the insert database trigger. The web Methods broker will scan this table looking for the ‘NEW’ records with the Oracle JDBC adapter, change the status to ‘INP’ for in progress and update the dt_process date. Once the message is delivered to $TARS, the web Methods broker will update the interface_status to ‘SNT’ for sent and update again the dt_process date.
Error Handling
Error codes are written by the web Methods broker into the CD_ERROR field. The broker is responsible for retries, and if needed, emails are sent by the broker to administrators to notify them of problems in this interface.
Field Level Errors
If a field in a record to be extracted has a validation error, that row will be skipped; CD_ERROR and DT_PROCESS updated, and an email should be sent to the application administrators by the broker.
Row Level Errors
The broker should update CD_ERROR and DT_PROCESS if possible. Regardless, the broker should send an email to application administrators
Process Level Errors
The most likely process level errors will be network and other communications errors. The interface broker will handle retries, and send emails to application administrators as needed.
Triggering/Scheduling
$TARS will be in control of when it will send SHINES payment information. The SHINES web service will update the SHINES database in real time.
Send Update of Child No Longer in DFCS Care
Technical Description
When a Supervisor approves a[.line-through]# child’s placement that results in an AFCARS discharge,[.line-through] [.line-through]#the S[.line-through]HINES java code will[.line-through]# insert a row into the CSUP_CHILD#LEFTCARE[.line-through]_OUTBOUND table
When the child legal status has changed to one of the below legal status, a row should be written with interface_status of ‘NEW’ to the CSUP_CHILDLEFTCARE_OUTBOUND table where the field CD_REASON_CODE is populated with one of the values 01-08 based on the below mapping between legal status codes and discharge reasons.
Legal status CD_REASON_CODE
Code
'AFS' 01-Reunification with Parents/Primary Caretakers',
'NAF' 03-Adoption',
'NCT' 04-Emancipation',
'NCD' 08-Death of Child',
‘NCO' 06-Transfer to Another Agency',
'NTT' 06-Transfer to Another Agency',
‘NCE' 04-Emancipation',
'NGP' 05-Guardianship',
'NPC' 01-Reunification with Parents/Primary Caretakers',
'NPR' 02-Living with Relatives',
'CTD' 06-Transfer to Another Agency',
'ILP' 04-'Emancipation'
The placement values in the CSUP_CHILDLEFTCARE_OUTBOUND are populated from the last actual approved placement for the child.
Discharge date is the effective date of the latest legal status.
The web Methods broker will pick up these records and send them to the $TARS application using JDBC adapter technology.
Message Description
The message contains the CRS ID of the child and the date the child returned home.
Table of Fields from SHINES to $TARS
| Column Name | Domain | Data type | Null | Definition | Use in Interface |
|---|---|---|---|---|---|
ID_CSUP_CHLDLFTCARE_OUTBOUND |
ID |
NUMBER(16, 0) |
N |
Unique ID/Transaction ID for outbound child left DFCS care record |
Transaction Unique ID – Send to broker and target system |
DT_LAST_UPDATE |
DT_LAST_UPDATE |
DATE |
N |
Date of insert or last update |
Internal tracking of when this row was last updated |
INTERFACE_STATUS |
VARCHAR2(3) |
N |
Status of this record with regards to the interface - NEW, INP (In Process), SNT (Sent), ERR (Error). A record will initially have a status of NEW, and be ready for be picked up by the broker. |
Used by the interface broker to determine which records need to be sent, and updated by the broker when a record is sent |
|
DT_PROCESS |
DATE |
Y |
Date sent by the interface (Sent) or error out (Error) |
Used by the interface broker to indicate when it picked up, sent, or error out on this transaction |
|
CD_ERROR |
VARCHAR2(10) |
Y |
If there was an error sending this record, an error code as to why is stored here. |
If there was an error in the web broker or interface processing, code is stored here |
|
ID_INITIATOR |
ID |
NUMBER(16, 0) |
N |
ID_INITIATOR references ID_PERSON in the PERSON table. This is the SHINES user that updated the parent information. The user should be in the EMPLOYEE table as well. |
Internal SHINES auditing |
DT_CHILDHOME_REQUESTED |
DATE |
Y |
This is typically the original date that user updated the child in the case as having returned home. |
Published by interface broker to target system |
|
NBR_CHILD_CRS_ID |
NUMBER(9, 0) |
N |
This is a nine digit identifier from Georgia’s Client Registration System, a central repository for clients being served by $TARS and other systems. This is the child of the original referral. |
Published by interface broker to target system |
|
NBR_NCP_CRS_ID |
NUMBER(9, 0) |
N |
The CRS ID of the Non-Custodial parent. This should have been obtained in the Investigation stage. |
Published by interface broker to target system |
|
DT_LEFT_CARE |
DATE |
Y |
The date the child was returned to its own home or otherwise left DFCS care. |
Published by interface broker to target system |
|
CD_REASON_CODE |
VARCHAR2(2) |
Y |
Reason why the child left DFCS foster care. AFCARS Discharge Code from Placement table. |
Published by interface broker to target system |
|
ID_CASE |
ID |
NUMBER(16, 0) |
N |
The SHINES Case ID. |
Published by interface broker to target system |
NM_FULL_NAME |
VARCHAR2(30) |
Y |
Full name of where the child was placed upon discharge. If ID_PLCMT_ADULT is NOT NULL, then use the NM_PERSON_FULL from the associated PERSON record. Otherwise, if ID_RSRC_FACIL is not null, use the NM_RESOURCE from the associated CAPS_RESOURCE record. Otherwise, if ID_RSRC_AGENCY is not null, use the NM_RESOURCE from the associated CAPS_RESOURCE record. |
Published by interface broker to target system |
|
ADDR_PLCMT_CITY |
VARCHAR2(20) |
Y |
Contains the address city information. |
Published by interface broker to target system |
|
ADDR_PLCMT_LN1 |
VARCHAR2(25) |
Y |
Contains the first line of the street address. |
Published by interface broker to target system |
|
ADDR_PLCMT_LN2 |
VARCHAR2(25) |
Y |
Contains the second line of the street address. |
Published by interface broker to target system |
|
ADDR_PLCMT_ST |
VARCHAR2(2) |
Y |
Contains the address state information. |
Published by interface broker to target system |
|
ADDR_PLCMT_ZIP |
VARCHAR2(10) |
Y |
Contains the address zip code information. |
Published by interface broker to target system |
|
NBR_PLCMT_TELEPHONE |
VARCHAR2(10) |
Y |
This field is the phone number of the placement contact. The field is pre populated but is available for overwrite capability. However, the overwrite is not saved to the resource directory. |
Published by interface broker to target system |
Method Narrative
Java code for the #[.line-through]#placement page will be modified to look for a supervisory approval of a placement that is “Return to Own Home”[.line-through].[.line-through]# When that event occurs, the code will insert a row into the#[.line-through]# [.line-through]#CSUP_CHILD[.line-through]LEFTCARE[.line-through]_OUTBOUND table with the DT_RETURN_HOME field populated by the placement date. The unique transaction id is the ID_CSUP_CHLDLFTCARE_OUTBOUND field, which is automatically populated by the insert database trigger. The web Methods broker will scan this table looking for the ‘NEW’ records with the Oracle JDBC adapter, change the status to ‘INP’ for in progress and update the dt_process date. Once the message is delivered to $TARS, the web Methods broker will update the interface_status to ‘SNT’ for sent and update again the dt_process date.
Error Handling
Error codes are written by the web Methods broker into the CD_ERROR field. The broker is responsible for retries, and if needed, emails are sent by the broker to administrators to notify them of problems in this interface.
Field Level Errors
If a field in a record to be extracted has a validation error, that row will be skipped; CD_ERROR and DT_PROCESS updated, and an email should be sent to the application administrators by the broker.
Row Level Errors
The broker should update CD_ERROR and DT_PROCESS if possible. Regardless, the broker should send an email to application administrators
Process Level Errors
The most likely process level errors will be network and other communications errors. The interface broker will handle retries, and send emails to application administrators as needed.
Triggering/Scheduling
When a Supervisor approves a child’s placement of type AFCARS discharge in SHINES,.
Document Change Log
| Date | Author | Change Description |
|---|---|---|
06/27/2012 |
Roshanda Minor |
Added section describing what a Non-Custodial Parent is as defined in SHINES. |
09/08/2009 |
Ashwini Rege |
Per STGAP00014993, Changed the condition for inserting a row in CSUP_CHILDLEFTCARE_OUTBOUND table. |
10/22/2007 |
Michael Chillman |
Added CD_ELIBILTY_TYPE column to Referral and Parental update tables |
10/09/2007 |
Michael Chillman |
Change Address Line to size 25 |
09/26/2007 |
Michael Chillman |
Added note for determining Voluntary Surrender Non-Custodial Parent |
09/18/2007 |
Michael Chillman |
For SIR STGAP00005294 added Action Type of Voluntary Surrender |
09/14/2007 |
Michael Chillman |
Updated requirements |
08/07/2007 |
Kalpana Thirumurthy |
Changed document to include the per diem business logic. |
05/06/2007 |
John Ramspott |
Change to indicate SHINES will register a new virtual county ID with CRS for every individual referral, and not make any attempt. |
04/27/2007 |
John Ramspott |
Major Changes to accommodate $TARS feedback and design changes |
03/02/2007 |
John Ramspott |
Minor changes based on state feedback and peer review |
02/23/2007 |
John Ramspott |
Major changes |
08/25/2006 |
John Ramspott |
Added more detail for technical |
08/01/2006 |
John Ramspott |
Initial Document Creation |
Note: A new row explaining document changes must be added to the Document Change Log for each revision. The Document Change Log must be maintained in reverse chronological order. The most recent changes are on the top of the list.