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. |
Georgia SHINES Integration Architecture
* _ _$TARS** Interface*
Document History
Document Status
| Date | Status | Name |
|---|---|---|
2/14/2007 |
Draft |
Scott McMahon |
2/23/2007 |
Draft |
Doug Bryden |
4/25/007 |
Draft |
Doug Bryden |
5/17/2007 |
Draft |
Doug Bryden |
5/22/2007 |
Draft |
Doug Bryden |
5/24/2007 |
final |
Doug Bryden |
5/30/2007 |
final |
Doug Bryden |
Outstanding Items
| # | Description | Date Logged | Responsible |
|---|---|---|---|
NONE |
Related Documents
| Document | Details |
|---|---|
$TARS Interface Detail Design |
Non GTA Interface Specification |
GTA/SHINES/$TARS Data Integration Statement of Work |
Statement of Work |
$TARS Requirements final version |
Data mapping doc from Accenture |
Table of Contents
Interface 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 child(ren). After a child’s IV-E Eligibility Determination is recorded in SHINES, a referral is made to the Child Support Services (CSE) program leveraging the interface between SHINES and $TARS.
The integration functionality covers five areas:
SHINES can refer a client to $TARS for Child Support Services.
$TARS sends child support payment history to SHINES .
SHINES sends parent demographic information updates to $TARS.
SHINES notifies $TARS of a termination in parental rights.
SHINES notifies $TARS of a child’s return to home.
Scope
This document is intended to be used as an adjunct document to any other design specification documents for the GA. SHINES and $TARS integration effort being provided by the GTA Development team. Its scope is limited to the activities discussed below and in the rest of the document.
Design Assumptions
The following assumptions were made in the design of the software components specified in this document:
| No. | Assumption or Constraint | Potential Impact |
|---|---|---|
1 |
No archiving of data is carried out by GTA integration services. |
Message delivery failure must be fixed by the sending organization. |
2 |
The system hosting STARS can communicate via standard web services |
Major delay with implementation |
Design Risks
| No. | Risk | Potential Effect on Project Success |
|---|---|---|
1 |
Lack of timely technical specifications needed to connect with each party. |
Delay of development and testing. |
2 |
Lack of volume information may affect the best design. |
Transactions may not be processed at the optimum level. |
Design Requirements
| No. | Requirement | Method for implementation |
|---|---|---|
1 |
GA. SHINES refers cases to Child Support Services ($TARS) for children In the Foster Care stage. |
webMethods Fabric components |
2 |
$TARS provides GA. SHINES payment information for Child Support cases referred to by GA. SHINES |
webMethods Fabric components |
3 |
GA. SHINES updates parental demographic information to $TARS. |
webMethods Fabric components |
4 |
GA. SHINES termination of parental rights information to $TARS. |
webMethods Fabric components |
5 |
GA. SHINES termination of parental rights information to $TARS. |
webMethods Fabric components |
Design Constraints
| No. | Constraint | Impact |
|---|---|---|
1 |
Solution restricted to web services and JDBC |
When $TARS system is down, the solution will not work. |
Security
SUCCESS and SHINES data is currently hosted at the North American Data Center within the existing firewalls. These firewalls provide the level of security required by DHR. No other special security functionality needs to be implemented for this integration project.
Operations Schedule
The $TARS Interface schedule will match the $TARS operations schedule. The $TARS system is available 7am to 7pm business days; Month End and Month Begin do not require system shut down; The system is available on Saturdays, but updates are only done Monday through Friday. Connection retries between GTA and SUCCESS or GTA and SHINES is limited to 2. Time between retries is limited to 2 to 3 seconds.
Hardware Environment
The GA. SHINES and $TARS integration service will be scheduled to execute on both of GTA’s Integration Servers. However, only one Server is scheduled to be active at one time. In the event of a catastrophic server failure, the scheduled service will be manually activated on the other Integration Server.
Scenario: $TARS Child Support Referral
Order of Operations
S1. webMethods Integration Server (IS) polls an outbound data staging table (D1) on the SHINES application database once per hour. All new rows inserted into the table are selected for processing and each rows status flag is updated to indicate processing is in progress. (INTERFACE_STATUS = ‘NEW’ or ‘SND’. Each row’s status flag is updated to indicate processing is in progress.
INTERFACE_STATUS = ‘INP’
DT_PROCESS = current date
DT_INC_REQUESTED = current date the first time a record is sent to SUCCESS.
S2. webMethods IS converts the selected data into a canonical message document (D2) and publishes the document to the webMethods Broker Enterprise Service Bus (ESB).
S3. webMethods IS receives the canonical message document (D2) via document subscription.
S4. webMethods IS translates D2 to D3, populates the RACF username and password variables, and calls a web service hosted by the IBM mainframe to submit data to the $TARS application.
S5. webMethods IS retrieves the results (D4) from the IBM mainframe web service call of S4.
S6. webMethods Integration Server converts D4 into a canonical result message document D5 and publishes the document to the webMethods Broker message queue.
S7. webMethods Integration Server receives canonical result message document D5 via document subscription.
S8. webMethods updates the status flag of the concerned data record to indicate the web service result from S4. (INTERFACE_STATUS = ‘SNT’ and DT_PROCESS = current date).
Error Management
E1. An error encountered communicating with an external partner. An internal webMethods exception is generated and the EIA on-call staff is automatically alerted to investigate. webMethods will attempt to make connections five times before going into an error routine. If possible, webMethods will also update the CD_ERROR field with webMethods error code(s), set the INTERFACE_STATUS field to “ERR” and update the DT_PROCESS field with the current date. webMethods will also send an email with an error message to Shines-Interface@dhr.state.ga.us.
E2. If an internal webMethods error is encountered, webMethods IS will generate an exception and the EIA on-call staff will be notified for investigation.
Data Definitions
D1. Record definition of source table. (SHINES)
| CHILDSUP_REF_OUTBOUND | CHILDSUP_REF_OUTBOUND | CHILDSUP_REF_OUTBOUND |
|---|---|---|
Field Name |
Field Type |
STARS XML |
| ID_CHILDSUP_REF_OUTBOUND | NUMBER(16, 0) | WK_SHINES_NUMBER |
|---|---|---|
DT_LAST_UPDATE |
DATE |
Not used here |
INTERFACE_STATUS |
VARCHAR2(3) |
Updated by webMethods |
DT_PROCESS |
DATE |
Updated by webMethods |
CD_ERROR |
VARCHAR2(10) |
WK_ERROR_CODES |
ID_INITIATOR |
NUMBER(16, 0) |
Not used here. |
SHINES_LOGON_SHORT |
VARCHAR2(8) |
Not used here |
DT_CSUP_REQUESTED |
DATE |
WK_RFRRL_DT |
ID_CASE |
NUMBER(16, 0) |
Not used here. |
ID_STAGE |
NUMBER(16, 0) |
Not used here. |
ID_CHILD |
NUMBER(16, 0) |
Not used here. |
NBR_CHILD_CRS_ID |
NUMBER(9, 0) |
WK_CHILD_IRN |
IND_CHILD_PATERNITY_EST |
VARCHAR2(1) |
WK_PTRNTY_ESTBLSH |
NBR_PER_DIEM |
NUMBER(6, 2) |
Not used here. |
NBR_PER_MONTH |
NUMBER(6, 2) |
WK_MTHLY_PER_DIEM |
DT_EFF_PER_DIEM |
DATE |
WK_PER_DIEM_EFFCTV_DT |
IND_CHILD_SUPPORT_ORDER |
VARCHAR2(1) |
WK_CRTORD_EXIST |
CD_MED_COA |
VARCHAR2(2) |
WK_ASSTNC_CLS |
ID_NONCUST_PARENT |
NUMBER(16, 0) |
Not used here |
NBR_NONCUST_CRS_ID |
NUMBER(9, 0) |
WK_NCP_IRN |
ADDR_NONCUST_ADDR_ST_LN_1 |
VARCHAR2(30) |
WK_NCP_ADDR_1 |
ADDR_NONCUST_ADDR_ST_LN_2 |
VARCHAR2(30) |
WK_NCP_ADDR_2 |
ADDR_NONCUST_ADDR_CITY |
VARCHAR2(20) |
WK_NCP_CITY |
CD_NONCUST_ADDR_STATE |
VARCHAR2(2) |
WK_NCP_ST |
ADDR_NONCUST_ADDR_ZIP |
VARCHAR2(10) |
WK_NCP_ZIP |
TXT_INC_RSRC_DESC |
VARCHAR2(80) |
WK_NCP_LST_EMPL_NAME |
TXT_INC_RSRC_SRC_ADDR_ST_LN1 |
VARCHAR2(30) |
WK_NCP_LST_EMPL_ADDR for line one |
TXT_INC_RSRC_SRC_ADDR_ST_LN2 |
VARCHAR2(30) |
WK_NCP_LST_EMPL_ADDR for line 2 |
TXT_INC_RSRC_SRC_ADDR_CITY |
VARCHAR2(20) |
WK_NCP_LST_EMPL_CITY |
TXT_INC_RSRC_SRC_ADDR_STATE |
VARCHAR2(2) |
WK_NCP_LST_EMPL_ST |
TXT_INC_RSRC_SRC_ADDR_ZIP |
VARCHAR2(10) |
WK_NCP_LST_EMPL_ZIP |
IND_SSI_NONCUST |
VARCHAR2(1) |
WK_NCP_SSI_SW |
CD_NONCUST_MARITAL_STATUS |
VARCHAR2(2) |
WK_PRNTS_MRTL_ST |
ID_AGENCY_CUSTODIAL_PARENTS |
NUMBER(16, 0) |
Not used here |
NBR_CUST_CRS_ID |
NUMBER(9, 0) |
WK_CLIENT_IRN |
CD_COUNTY |
VARCHAR2(3) |
Not used by STARS |
ID_OFFICE |
NUMBER(16, 0) |
WK_OFFICE_NUM |
NM_OFFICE_NAME |
VARCHAR2(15) |
WK_OFFICE_NAME |
NM_CASEMANAGER_FIRST |
VARCHAR2(12) |
WK_CASE_WRKR_NAME FIRST |
NM_CASEMANAGER_MIDDLE |
VARCHAR2(12) |
WK_CASE_WRKR_NAME MIDDLE |
NM_CASEMANAGER_LAST |
VARCHAR2(22) |
WK_CASE_WRKR_NAME LAST |
NBR_CASEMANAGER_PHONE |
VARCHAR2(10) |
WK_CASE_WRKR_PHN_NUM |
NBR_CASEMANAGER_FAX |
VARCHAR2(10) |
WK_CASE_WRKR_FAX |
ADDR_CASEMAN_ADDR_ST_LN_1 |
VARCHAR2(30) |
WK_CASE_WRKR_STR LINE 1 |
ADDR_CASEMAN_ADDR_ST_LN_2 |
VARCHAR2(30) |
WK_CASE_WRKR_STR LINE 2 |
ADDR_CASEMAN_ADDR_CITY |
VARCHAR2(20) |
WK_CASE_WRKR_CITY |
CD_CASEMAN_ADDR_STATE |
VARCHAR2(2) |
WK_CASE_WRKR_STATE |
ADDR_CASEMAN_ADDR_ZIP |
VARCHAR2(10) |
WK_CASE_WRKR_ZIP_CD |
D2. Canonical referral document definition. (GTA)
Internal to webMethods
D3. Web Service data message definition. (GTA)
| Destination XML to STARS | Destination XML to STARS |
|---|---|
Field Name |
XML |
| ID_CHILDSUP_REF_OUTBOUND | WK_SHINES_NUMBER |
|---|---|
‘SHI’ |
WK_RFRRL_TYPE |
CD_MED_COA |
WK_ASSTNC_CLS |
DT_CSUP_REQUESTED |
WK_RFRRL_DT |
ID_OFFICE |
WK_OFFICE_NUM |
NM_OFFICE_NAME |
WK_OFFICE_NAME |
NBR_CUST_CRS_ID |
WK_CLIENT_IRN |
NM_CASEMANAGER_FIRST, |
WK_CASE_WRKR_NAME FIRST |
NM_CASEMANAGER_MIDDLE, |
WK_CASE_WRKR_NAME MIDDLE |
NM_CASEMANAGER_LAST |
WK_CASE_WRKR_NAME LAST |
ADDR_CASEMAN_ADDR_ST_LN_1 |
WK_CASE_WRKR_STR for line 1 |
ADDR_NONCUST_ADDR_ST_LN_2 |
WK_CASE_WRKR_STR for line 2 |
ADDR_CASEMAN_ADDR_CITY |
WK_CASE_WRKR_CITY |
CD_CASEMAN_ADDR_STATE |
WK_CASE_WRKR_STATE |
ADDR_CASEMAN_ADDR_ZIP |
WK_CASE_WRKR_ZIP_CD |
NBR_CASEMANAGER_PHONE |
WK_CASE_WRKR_PHN_NUM |
NBR_CASEMANAGER_FAX |
WK_CASE_WRKR_FAX |
NBR_CHILD_CRS_ID |
WK_CHILD_IRN |
NBR_NONCUST_CRS_ID |
WK_NCP_IRN |
ADDR_NONCUST_ADDR_ST_LN_1 |
WK_NCP_ADDR_1 |
ADDR_NONCUST_ADDR_ST_LN_2 |
WK_NCP_ADDR_2 |
ADDR_NONCUST_ADDR_CITY |
WK_NCP_CITY |
CD_NONCUST_ADDR_STATE |
WK_NCP_ST |
ADDR_NONCUST_ADDR_ZIP |
WK_NCP_ZIP |
IND_SSI_NONCUST |
WK_NCP_SSI_SW |
TXT_INC_RSRC_DESC |
WK_NCP_LST_EMPL_NAME |
TXT_INC_RSRC_SRC_ADDR_ST_LN1 |
WK_NCP_LST_EMPL_ADDR for line 1 |
TXT_INC_RSRC_SRC_ADDR_ST_LN2 |
WK_NCP_LST_EMPL_ADDR for line 2 |
TXT_INC_RSRC_SRC_ADDR_CITY |
WK_NCP_LST_EMPL_CITY |
TXT_INC_RSRC_SRC_ADDR_STATE |
WK_NCP_LST_EMPL_ST |
TXT_INC_RSRC_SRC_ADDR_ZIP |
WK_NCP_LST_EMPL_ZIP |
IND_CHILD_PATERNITY_EST |
WK_PTRNTY_ESTBLSH |
No corresponding SHINES field |
WK_INTRL_IRN |
CD_NONCUST_MARITAL_STATUS |
WK_PRNTS_MRTL_ST |
IND_CHILD_SUPPORT_ORDER |
WK_CRTORD_EXIST |
NBR_PER_MONTH |
WK_MTHLY_PER_DIEM |
DT_EFF_PER_DIEM |
WK_PER_DIEM_EFFCTV_DT |
No corresponding SHINES item |
WK_REC_ID |
CD_ERROR |
-WK_ERROR_CODES |
No corresponding SHINES item |
WK_PROC_RETURN_CODE |
D4. Web Service result message definition. (GTA)
See D3 above.
D5. Canonical result document definition. (GTA)
Internal
Data Element Mapping Specifications
See D1 and D3 above.
Scenario: $TARS Sends Support Payment Updates
Order of Operations
S1. webMethods Integration Server (IS) calls a web service hosted by the IBM mainframe (STARSPaymentUpdate.wsdl) to retrieve payment information data (D1) from the $TARS application.
S2. webMethods IS translates the retrieved data (D1) into a canonical message document (D2) and publishes the document to the webMethods Broker message queue.
S3. webMethods IS receives the canonical message document (D2) via document subscription.
S4. webMethods translates the canonical message document (D2) data into a SHINES web service message (D3) and calls the SHINES web service (SaveReceiveChildSupportPaymentInfoWS.wsdl) to submit the data to the SHINES application.
Error Management
E1. An error encountered communicating with an external partner. An internal webMethods exception is generated and the EIA on-call staff is automatically alerted to investigate. webMethods will attempt to make connections five times before going into an error routine. webMethods will also send an email with an error message to Shines-Interface@dhr.state.ga.us.
E2. If an internal webMethods error is encountered, webMethods IS will generate an exception and the EIA on-call staff will be notified for investigation.
Data Definitions
D1. $TARS web service result message XML definition ($TARS)
| STARS XML Message | STARS XML Message |
|---|---|
Field Name |
XML |
| Custodian’s CRS ID | WB-CUSTDN-IRN |
|---|---|
County Number |
WB-COUNTY-NUM |
NC Parent’s CRS ID |
WB-NCP-IRN |
Date Child Support Received |
WB-CHECK-DATE |
Amount of Child Support Received |
WB-CHECK-AMOUNT |
Check number |
WB-CHECK-NUMBER |
D2. Canonical message document. (GTA EIA)
Internal to webMethods
D3. SHNES web service message XML definition. (SHINES)
| SHINES XML Message | SHINES XML Message |
|---|---|
STARS XML |
SHINES XML |
| WB-CHECK-AMOUNT | amtIncRsrcChildSupportRecd |
|---|---|
WB-CHECK-DATE |
dtIncRsrcChildSupportRecd |
WB-CUSTDN-IRN |
idCrsId" |
WB-CHECK-NUMBER |
txtIncRsrcCheckNumber |
WB-NCP-IRN |
TO BE ADDED BY SHINES |
WB-COUNTY-NUM |
TO BE ADDED BY SHINES |
Data Element Mapping Specifications
See D1 and D3 above
Scenario: Send Updated Parental Demographic to $TARS
Order of Operations
S1. webMethods Integration Server (IS) polls an outbound data staging table (D1) on the SHINES application database once per hour. All new rows inserted into the table are selected for processing and each rows status flag is updated to indicate processing is in progress. (INTERFACE_STATUS = ‘NEW’ or ‘SND’). Each row’s status flag is updated to indicate processing is in progress.
INTERFACE_STATUS = ‘INP’
DT_PROCESS = current date
DT_INC_REQUESTED = current date the first time a record is sent to SUCCESS.
S2. webMethods IS converts the selected data into a canonical message document (D2) and publishes the document to the webMethods Broker Enterprise Service Bus (ESB).
S3. webMethods IS receives the canonical message document (D2) via document subscription.
S4. webMethods IS translates D2 to D3, populates the RACF username and password variables, and calls a web service (SIDG31PI.wsdl) hosted by the IBM mainframe to submit data to the $TARS application.
S5. webMethods IS retrieves the results (D4) from the IBM mainframe web service call of S4.
S6. webMethods Integration Server converts D4 into a canonical result message document D5 and publishes the document to the webMethods Broker message queue.
S7. webMethods Integration Server receives canonical result message document D5 via document subscription.
S8. webMethods updates the status flag of the concerned data record to indicate the web service result from S4. (INTERFACE_STATUS = ‘SNT’ and DT_PROCESS = current date).
Error Management
E1. If the web service is unreachable, the SHINES application will generate an error for standard SHINES error handling procedure. . webMethods will send an email with an error message to .
WebMethods will also update the CD_ERROR field with webMethods error code(s), set the INTERFACE_STATUS field to “ERR” and update the DT_PROCESS field with the current date.
E2. If an internal webMethods error is encountered, webMethods IS will generate an exception and the EIA on-call staff will be notified for investigation.
E3. If a connection error is encountered, webMethods IS will generate an exception and the EIA on-call staff will be notified for investigation.
Data Definitions
D1. Record definition of source table. (SHINES)
| CSUP_PARENT_OUTBOUND | CSUP_PARENT_OUTBOUND | CSUP_PARENT_OUTBOUND |
|---|---|---|
Field Name |
Field Type |
STARS XML |
| ID_CSUP_PARENT_OUTBOUND | NUMBER(16, 0) | WK_SHINES_NUMBER |
|---|---|---|
DT_LAST_UPDATE |
DATE |
Not used here |
INTERFACE_STATUS |
VARCHAR2(3) |
Used by webMethods |
DT_PROCESS |
DATE |
Used by webMethods |
CD_ERROR |
VARCHAR2(10) |
WK_ERROR_CODES (populated on the return) |
ID_INITIATOR |
NUMBER(16, 0) |
Not used here |
DT_CSUPPAR_REQUESTED |
DATE |
Not used by STARS |
NBR_CHILD_CRS_ID |
NUMBER(9, 0) |
WK_CHILD_IRN |
NBR_NONCUST_CRS_ID |
NUMBER(9, 0) |
WK_NCP_IRN |
NM_NONCUST_LAST |
VARCHAR2(22) |
Not used by STARS |
NM_NONCUST_FIRST |
VARCHAR2(12) |
Not used by STARS |
NM_NONCUST_MIDDLE |
VARCHAR2(12) |
Not used by STARS |
NBR_NONCUST_NUMBER |
VARCHAR2(15) |
Not used by STARS |
CD_CRS_NONCUST_RACE |
VARCHAR2(1) |
Not used by STARS |
DT_NONCUST_DOB |
DATE |
Not used by STARS |
IND_SSI_NONCUST |
VARCHAR2(1) |
WK_NCP_SSI_SW |
ADDR_NONCUST_ADDR_ST_LN_1 |
VARCHAR2(30) |
WK_NCP_ADDR_1 |
ADDR_NONCUST_ADDR_ST_LN_2 |
VARCHAR2(30) |
WK_NCP_ADDR_2 |
ADDR_NONCUST_ADDR_CITY |
VARCHAR2(20) |
WK_NCP_CITY |
CD_NONCUST_ADDR_STATE |
VARCHAR2(2) |
WK_NCP_ST |
ADDR_NONCUST_ADDR_ZIP |
VARCHAR2(10) |
WK_NCP_ZIP |
NBR_NONCUST_PHONE |
VARCHAR2(10) |
Not used by STARS |
TXT_INC_RSRC_DESC |
VARCHAR2(80) |
WK_NCP_LST_EMPL_NAME |
TXT_INC_RSRC_SRC_ADDR_ST_LN1 |
VARCHAR2(30) |
WK_NCP_LST_EMPL_ADDR for line 1 |
TXT_INC_RSRC_SRC_ADDR_ST_LN2 |
VARCHAR2(30) |
WK_NCP_LST_EMPL_ADDR for line 2 |
TXT_INC_RSRC_SRC_ADDR_CITY |
VARCHAR2(20) |
WK_NCP_LST_EMPL_CITY |
TXT_INC_RSRC_SRC_ADDR_STATE |
VARCHAR2(2) |
WK_NCP_LST_EMPL_ST |
TXT_INC_RSRC_SRC_ADDR_ZIP |
VARCHAR2(10) |
WK_NCP_LST_EMPL_ZIP |
ID_CASE |
NUMBER(16, 0) |
Not used here |
NBR_PER_DIEM |
NUMBER(6, 2) |
Not used by STARS |
NBR_PER_MONTH |
NUMBER(6, 2) |
WK_MTHLY_PER_DIEM |
DT_EFF_PER_DIEM |
DATE |
WK_PER_DIEM_EFFCTV_DT |
CD_MED_CLASS_ASST |
VARCHAR2(3) |
WK_ASSTNC_CLS |
NM_CASEMAN_LAST |
VARCHAR2(22) |
WK_CASE_WRKR_NAME LAST |
NM_CASEMAN_FIRST |
VARCHAR2(12) |
WK_CASE_WRKR_NAME FIRST |
NM_CASEMAN_MIDDLE |
VARCHAR2(12) |
WK_CASE_WRKR_NAME MIDDLE |
ADDR_CASEMAN_ADDR_ST_LN_1 |
VARCHAR2(30) |
WK_CASE_WRKR_STR LINE ! |
ADDR_CASEMAN_ADDR_ST_LN_2 |
VARCHAR2(30) |
WK_CASE_WRKR_STR LINE 2 |
ADDR_CASEMAN_ADDR_CITY |
VARCHAR2(20) |
WK_CASE_WRKR_CITY |
CD_CASEMAN_ADDR_STATE |
VARCHAR2(2) |
WK_CASE_WRKR_STATE |
ADDR_CASEMAN_ADDR_ZIP |
VARCHAR2(10) |
WK_CASE_WRKR_ZIP |
NBR_CASEMAN_PHONE |
VARCHAR2(10) |
WK_CASE_WRKR_PHN |
NBR_CASEMAN_FAX |
VARCHAR2(10) |
WK_CASE_WRKR_FAX |
D2. Canonical referral document message definition. (GTA)
Internal to webMethods
D3. Web Service data message definition. (GTA)
| Destination XML to STARS | Destination XML to STARS |
|---|---|
Field Name |
XML |
| ID_CSUP_PARENT_OUTBOUND | WK_SHINES_NUMBER |
|---|---|
CD_MED_CLASS_ASST |
WK_ASSTNC_CLS |
NM_CASEMANAGER_FIRST, |
WK_CASE_WRKR_NAME FIRST |
NM_CASEMANAGER_MIDDLE, |
WK_CASE_WRKR_NAME MIDDLE |
NM_CASEMANAGER_LAST |
WK_CASE_WRKR_NAME LAST |
ADDR_CASEMAN_ADDR_ST_LN_1 |
WK_CASE_WRKR_STR LINE 1 |
ADDR_NONCUST_ADDR_ST_LN_2 |
WK_CASE_WRKR_STR LINE 2 |
ADDR_CASEMAN_ADDR_CITY |
WK_CASE_WRKR_CITY |
CD_CASEMAN_ADDR_STATE |
WK_CASE_WRKR_STATE |
ADDR_CASEMAN_ADDR_ZIP |
WK_CASE_WRKR_ZIP |
NBR_CASEMAN_PHONE |
WK_CASE_WRKR_PHN |
NBR_CASEMAN_FAX |
WK_CASE_WRKR_FAX |
NBR_CHILD_CRS_ID |
WK_CHILD_IRN |
NBR_NONCUST_CRS_ID |
WK_NCP_IRN |
ADDR_NONCUST_ADDR_ST_LN_1 |
WK_NCP_ADDR_1 |
ADDR_NONCUST_ADDR_ST_LN_2 |
WK_NCP_ADDR_2 |
ADDR_NONCUST_ADDR_CITY |
WK_NCP_CITY |
CD_NONCUST_ADDR_STATE |
WK_NCP_ST |
ADDR_NONCUST_ADDR_ZIP |
WK_NCP_ZIP |
IND_SSI_NONCUST |
WK_NCP_SSI_SW |
TXT_INC_RSRC_DESC |
WK_NCP_LST_EMPL_NAME |
TXT_INC_RSRC_SRC_ADDR_ST_LN1 |
WK_NCP_LST_EMPL_ADDR LINE 1 |
TXT_INC_RSRC_SRC_ADDR_ST_LN2 |
WK_NCP_LST_EMPL_ADDR LINE 2 |
TXT_INC_RSRC_SRC_ADDR_CITY |
WK_NCP_LST_EMPL_CITY |
TXT_INC_RSRC_SRC_ADDR_STATE |
WK_NCP_LST_EMPL_ST |
TXT_INC_RSRC_SRC_ADDR_ZIP |
WK_NCP_LST_EMPL_ZIP |
NBR_PER_MONTH |
WK_MTHLY_PER_DIEM |
DT_EFF_PER_DIEM |
WK_PER_DIEM_EFFCTV_DT |
No corresponding SHINES |
WK_REC_ID |
CD_ERROR |
WK_ERROR_CODES |
No corresponding SHINES |
WK_PROC_RETURN_CODE |
D4. Web Service result definition. (GTA)
See D4
D5. Canonical result document message definition. (GTA)
Internal to webMethods
Data Element Mapping Specifications
See D1 and D3 above
Scenario: Send Termination of Parental Rights to $TARS
Order of Operations
S1. webMethods Integration Server (IS) polls an outbound data staging table (D1) on the SHINES application database once per hour. All new rows inserted into the table are selected for processing and each rows status flag is updated to indicate processing is in progress. (INTERFACE_STATUS = ‘NEW’ or ‘SND’). Each row’s status flag is updated to indicate processing is in progress.
INTERFACE_STATUS = ‘INP’
DT_PROCESS = current date
DT_INC_REQUESTED = current date the first time a record is sent to SUCCESS.
S2. webMethods IS converts the selected data into a canonical message document (D2) and publishes the document to the webMethods Broker Enterprise Service Bus (ESB).
S3. webMethods IS receives the canonical message document (D2) via document subscription.
S4. webMethods IS translates D2 to D3, populates the RACF username and password variables, and calls a web service (SIDG33PI.wsdl ) hosted by the IBM mainframe to submit data to the $TARS application.
S5. webMethods IS retrieves the results (D4) from the IBM mainframe web service call of S4.
S6. webMethods Integration Server converts D4 into a canonical result message document D5 and publishes the document to the webMethods Broker message queue.
S7. webMethods Integration Server receives canonical result message document D5 via document subscription.
S8. webMethods updates the status flag of the concerned data record to indicate the web service result from S4. (INTERFACE_STATUS = ‘SNT’ and DT_PROCESS = current date).
Error Management
E1. An error encountered communicating with an external partner. An internal webMethods exception is generated and the EIA on-call staff is automatically alerted to investigate. webMethods will attempt to make connections five times before going into an error routine. If possible, webMethods will also update the CD_ERROR field with webMethods error code(s), set the INTERFACE_STATUS field to “ERR” and update the DT_PROCESS field with the current date. webMethods will also send an email with an error message to Shines-Interface@dhr.state.ga.us.
E2. If an internal webMethods error is encountered, webMethods IS will generate an exception and the EIA on-call staff will be notified for investigation.
Data Definitions
D1. Record definition of source table. (SHINES)
| ADOPT_TPR_OUTBOUND | ADOPT_TPR_OUTBOUND | ADOPT_TPR_OUTBOUND |
|---|---|---|
Field Name |
Field Type |
STARS XML |
| ID_ADOPT_TPR_OUTBOUND | NUMERIC(16, 0) | WK_SHINES_NUMBER |
|---|---|---|
DT_LAST_UPDATE |
DATE |
Not used here |
INTERFACE_STATUS |
VARCHAR(3) |
Used by webMethods |
DT_PROCESS |
DATE |
Used by webMethods |
CD_ERROR |
VARCHAR(10) |
WK_ERROR_CODES (populated on the return) |
ID_INITIATOR |
NUMERIC(16, 0) |
Not used here |
DT_ADOPTTPR_REQUESTED |
DATE |
Not used here |
NBR_CHILD_CRS_ID |
NUMERIC(9, 0) |
WK_CHILD_IRN |
NBR_NONCUST_CRS_ID |
NUMERIC(9, 0) |
WK_NCP_IRN |
DT_TPR_FINALIZED |
DATE |
WK_TRMNTN_DT |
DT_ADOPT_FINALIZED |
DATE |
WK_ADPTN_DT |
ID_CASE |
ID |
WK_CASE_NUM |
D2. Canonical referral document message definition. (GTA)
Internal
D3. Web Service data message definition. (GTA)
| Destination XML to STARS | Destination XML to STARS |
|---|---|
SHINES Field Name |
STARS XML |
| ID_CASE | WK_CASE_NUM |
|---|---|
NBR_CHILD_CRS_ID |
WK_CHILD_IRN |
NBR_NONCUST_CRS_ID |
WK_NCP_IRN |
DT_TPR_FINALIZED |
WK_TRMNTN_DT |
DT_ADOPT_FINALIZED |
WK_ADPTN_DT |
Not found on SHINES |
WK_REC_ID |
CD_ERROR |
WK_ERROR_CODES |
Not found on SHINES |
WK_PROC_RETURN_CODE |
D4. Web Service result message definition. (GTA)
See D3 above
D5. Canonical result document message definition. (GTA)
Internal to webMethods
Data Element Mapping Specifications
See D1 and D3 above
Scenario: Send Child Returns Home Update to $TARS
Order of Operations
S1. webMethods Integration Server (IS) polls an outbound data staging table (D1) on the SHINES application database once per hour. All new rows inserted into the table are selected for processing and each rows status flag is updated to indicate processing is in progress. (INTERFACE_STATUS = ‘NEW’ or ‘SND’. Each row’s status flag is updated to indicate processing is in progress.
INTERFACE_STATUS = ‘INP’
DT_PROCESS = current date
DT_INC_REQUESTED = current date the first time a record is sent to SUCCESS.
S2. webMethods IS converts the selected data into a canonical message document (D2) and publishes the document to the webMethods Broker Enterprise Service Bus (ESB).
S3. webMethods IS receives the canonical message document (D2) via document subscription.
S4. webMethods IS translates D2 to D3, populates the RACF username and password variables, and calls a web service (SIDG32PI.wsdl ) hosted by the IBM mainframe to submit data to the $TARS application.
S5. webMethods IS retrieves the results (D4) from the IBM mainframe web service call of S4.
S6. webMethods Integration Server converts D4 into a canonical result message document D5 and publishes the document to the webMethods Broker message queue.
S7. webMethods Integration Server receives canonical result message document D5 via document subscription.
S8. webMethods updates the status flag of the concerned data record to indicate the web service result from S4. (INTERFACE_STATUS = ‘SNT’ and DT_PROCESS = current date).
Error Management
E1. An error encountered communicating with an external partner. An internal webMethods exception is generated and the EIA on-call staff is automatically alerted to investigate. webMethods will attempt to make connections five times before going into an error routine. If possible, webMethods will also update the CD_ERROR field with webMethods error code(s), set the INTERFACE_STATUS field to “ERR” and update the DT_PROCESS field with the current date. webMethods will also send an email with an error message to Shines-Interface@dhr.state.ga.us.
E2. If an internal webMethods error is encountered, webMethods IS will generate an exception and the EIA on-call staff will be notified for investigation.
Data Definitions
D1. Record definition of source table. (SHINES)
| CSUP_CHILDLEFTCARE_OUTBOUND | CSUP_CHILDLEFTCARE_OUTBOUND | CSUP_CHILDLEFTCARE_OUTBOUND |
|---|---|---|
Field Name |
Field Type |
STARS XML |
| ID_CSUP_CHLDLFTCARE_OUTBOUND | NUMBER(16, 0) | WK_SHINES_NUMBER |
|---|---|---|
DT_LAST_UPDATE |
DATE |
Not used here |
INTERFACE_STATUS |
VARCHAR2(3) |
Used by webMethods |
DT_PROCESS |
DATE |
Used by webMethods |
CD_ERROR |
VARCHAR2(10) |
WK_ERROR_CODES (populated on the return) |
ID_INITIATOR |
NUMBER(16, 0) |
Not used here |
DT_CHILDHOME_REQUESTED |
DATE |
Not found on STARS |
NBR_CHILD_CRS_ID |
NUMBER(9, 0) |
WK_CHILD_IRN |
DT_LEFT_CARE |
DATE |
WK_RTRN_HOME_DATE |
CD_REASON_CODE |
VARCHAR2(2) |
WK_AFCAR_DIS_CD |
ID_CASE |
NUMBER(16, 0) |
WK_CASE_NUM |
NM_FULL_NAME |
VARCHAR2(30) |
WK_NEW_CUSTDN_NAME |
ADDR_PLCMT_CITY |
VARCHAR2(20) |
WK_NEW_CUSTDN_CITY |
ADDR_PLCMT_LN1 |
VARCHAR2(30) |
WK_NEW_CUSTDN_ADDR_1 |
ADDR_PLCMT_LN2 |
VARCHAR2(30) |
WK_NEW_CUSTDN_ADDR_2 |
ADDR_PLCMT_ST |
VARCHAR2(2) |
WK_NEW_CUSTDN_ST |
ADDR_PLCMT_ZIP |
VARCHAR2(10) |
WK_NEW_CUSTDN_ZIP |
NBR_PLCMT_TELEPHONE |
VARCHAR2(10) |
WK_NEW_CUSTDN_PH |
D2. Canonical referral document message definition. (GTA)
Internal to webMethods
D3. Web Service data message definition. (GTA)
| Destination XML to STARS | Destination XML to STARS |
|---|---|
SHINES Field Name |
STARS XML |
| ID_CSUP_CHLDLFTCARE_OUTBOUND | WK_SHINES_NUMBER |
|---|---|
NBR_CHILD_CRS_ID |
WK_CHILD_IRN |
DT_LEFT_CARE |
WK_RTRN_HOME_DATE |
NM_FULL_NAME |
WK_NEW_CUSTDN_NAME |
ADDR_PLCMT_LN1 |
WK_NEW_CUSTDN_ADDR_1 |
ADDR_PLCMT_LN2 |
WK_NEW_CUSTDN_ADDR_2 |
ADDR_PLCMT_CITY |
WK_NEW_CUSTDN_CITY |
ADDR_PLCMT_ST |
WK_NEW_CUSTDN_ST |
ADDR_PLCMT_ZIP |
WK_NEW_CUSTDN_ZIP |
NBR_PLCMT_TELEPHONE |
WK_NEW_CUSTDN_PH |
CD_REASON_CODE |
WK_AFCAR_DIS_CD |
CD_ERROR |
WK_ERROR_CODES |
Not found on SHINES |
WK_PROC_RETURN_CODE |
D4. Web Service result message definition. (GTA)
See D3 above
D5. Canonical result document message definition. (GTA)
Internal
Data Element Mapping Specifications
See D1 and D3 above