SSIS System Specification

SSIS System Specification
SSIS Fiscal/Worker
Prepared By:
Guy Glirbas, Tom Ammons, Theresa Hill
Project Manager:
Last Updated:
Kate Stolpman
June 30, 2008
SECTION TEN: STATE REPORTING FRAMEWORK
10.0 Introduction
The purpose of this section is to outline the State Reporting framework. This framework is
designed to support the following Fiscal requirements:
•
•
•
State Reporting as well as claiming must share a common GUI look and behavior
Reports will be in grid format so that users can customize the layout of the output
unless the report cannot be made to work as a grid. (Existing CSIS reports should be
reviewed with Functional Analysts to determine if they can be reworked as grid style
reports).
Reports that are similar should be handled with the same report/tab style
This document describes a common structure/behavior for State Reporting. It includes:
•
•
•
•
•
•
•
•
•
•
•
•
Query process
Report/ tab style guidelines
Tables and codes used by all State Reports
Screen layout
Base form with common node container definition and State Report header
information
Common action menu
Common business rules and error messages
State Report header table and common codes
High level map of legacy CSIS reports to SSIS reports.
Common action menu
Report/ tab style guidelines
Query process
The individual State Report specifications include:
•
•
•
•
•
•
•
•
•
•
•
Security requirements
Retention requirements
ValidDefine valid reporting period codes for the State Report type
BusinessDefine business logic for generated reports
Map of legacy CSIS reports to SSIS report/proofing grids
Tree Node definition for error navigation in Data Clean-up
Grid column definitions for individual stored reports/tabs.
Report/tab layout based on style guidelines
Entry forms based on SSIS standards
Define retention requirements
Business rules, how they are implemented, and error messages
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 52 of 116
10.1 Overview
This overview is a high-level description of the process used to create and submit a State
Report. It does not attempt to describe county variations nor detail system responses to
user actions.
10.1.1
State Report Screen
The State Report screen uses the standard tree and grid layout used by SSIS. It
allows users to generate and submit reports, do interactive data correction, and
create a revised report for a period after submitting the original.
Figure 10-1 shows the layout of the TCM CSR screen as an example. It shows the
tree structure, node container grid, and State Report header. Those portions of the
screen are used by all State Reports. The tabs shown in the screen below are specific
to the TCM CSR.
Figure 10-1, State Reporting Screenshot (TCM CSR example)
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 53 of 116
10.1.2
State Report Process
The user starts the State Report by creating the report header via “New [State
Report type]” on the action menu. The State Report header ID field links the report
header to link the various stored individual reports that must be stored for a
particular report period. Figure 10-2 illustrates how the header record is created.
User
System
Select new
[state report ]
Create State Report
screen (header entry
screen (along with
tabs)
State ReportUser
Enter required /
optional fields in
Header entry
screen
Select Save
Validate State
Report Header
all required fields valid?
yes
no
Display error to
user
Save State
Report header
record
Figure 10-2, Creating the State Report Header
Once the State Report header record is saved, the user may do any of the following:
•
•
•
Go to the data clean up style tabs on the State Report screen to do interactive
data correction as detailed in Section 11.
Enter supplemental data such as adjustments, on a data entry style tab.
Generate a set of stored reports in draft status from the State Report header
section of the screen.
These steps may be done in any order and may be done several times before
submitting the State Report data to DHS, as illustrated in Figure 10-3 , on the
following page.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 54 of 116
State Report User
Start new (or go to
existing) State
Report Header
Generate
individual stored
reports (from the
header)
Enter
supplemental
data (from the
tab)
Do data
correction (from
the tab)
Figure 10-3, High-level Workflow
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 55 of 116
10.1.3
Generating stored reports
Typically, the user starts with error correction and then generates a set of stored
reports through several drafts, doing data correction between drafts. Interactive data
correction is done with Data Clean-up Search and is described in Section 11 of the
FISCAL Systems spec.
Clicking the “Generate” button in the header section of the screen causes the system
to create several reports. Each time the user generates the State Report, the system
first clears the existing records before creating the set of reports.
The specific generated reports are detailed in the specification as specified for each
the State Report type (TCM CSR, SEAGR, Title IV-E Abstract, or CMHRS). All
generated reports are stored in the county SSIS database. Some are submitted to
DHS. Others are saved only at the county for audit purposes or to support the
proofing process. See Figure 10-4, below, depicts this basic flow.
User
System
First time generating?
Click Generate
no
Delete current
report records
Yes
State Report User
Create stored
report records and
display on
appropriate tabs
Review
finished?
no
Continue report
preparation
Yes
Select finalize
Set status to
finalized
Select submit
Start data
transfer
Figure 10-4, Generating State Reports
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 56 of 116
10.1.4
Database
The common table for all State Reports is the State Report header record
(STATE_REPORT). Each State Report type has child tables for the individual stored
reports. The STATE_REPORT_ID is carried as a foreign key for each of the child
tables.
The individual State Report specifications define the child tables needed to for submissions
to DHS for reports that need to be stored for the county. The following diagram (
Figure 10-5) is conceptual and illustrates the relationship of the common State
Report “header” table to the various child tables.
Example: this is summarized
data. Only totals go to the state,
but all summarized records are
stored at the county
TCM CSR Statistics
IV-E report 1
TCM CSR Client Summary
IV-E report 2
Example: this is detail of calculations
that are summarized in the TCM CSR
Statistics report. It is stored only at
the county
IV-E report 3
State Report Header Table
TCM CSR Data Entry record
Example: this is an adjust
ment record
CMHRS report 1
SEAGR report 1
CMHRS report 2
SEAGR report 2
Figure 10-5, Generating State Reports
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 57 of 116
10.1.5
Status State Diagram
The following diagram (Figure 10-6) illustrates how a state report header record
progresses from one status to another. The “Generate” button creates the stored
data and is only enabled while a State Report header is in draft status.
If the State Report has been finalized but not submitted, the user may change it
back to draft status. Once in draft, the user can do more data clean up, enter
new/edit existing supplemental data, and generate the State Report again to
incorporate changes in the underlying data.
If the State Report has already been submitted to DHS for a reporting period, the
user may create a report revision for the same period. The revised report will be in
draft status and its revision number will be greater than zero. In this way, both the
report data for the original submission and the revised submission are saved
separately.
New [State Report type]
Draft
Selected by user
Report is read-only w henever status = finalized or
submitted.
Finalized
To edit or delete a finalized report, the user must set it
back to draft.
Selected by user
Submitted
Once submitted, a report status cannot be changed. It
may be deleted only according to retention business
rules.
Figure 10-6, Report Header Status state diagram
10.1.6
Query Method
State Report queries are done with stored procedures. Calculated fields are done
with script unless the calculated field causes performance problems (such as during
sorting in the grid). If performance cannot be improved with the script function,
then an Oracle function may be used.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 58 of 116
10.1.7
Data Entry
Some State Reports require manual entry for adjustments or other supplemental
information. Data entry forms follow SSIS standards/conventions for layout and
labeling. An entry form may be single Visual Module or may be a Node Container
with entries.
The following behavior is common across all state reports:
•
•
•
Adjustments, revenues, and other supplemental entries are incorporated into the
State Report only at the time of the next report “generation”.
The generated reports are not automatically updated to reflect manual entry.
Data entry screens and associated menus are disabled when the State Report
status is finalized or submitted.
The table structure and entry screens for adjustments will be determined by the
requirements of the specific report
10.1.8
Data Transfer
Data is transferred using SWNDX (or another server at a later date). This method
uses the existing Oracle database link in each county to the SWNDX server. By
adding the link name after the table (or using a synonym that does so), data on
another Oracle server can be accessed with the usual SELECT, INSERT, UPDATE, and
DELETE statements. The SWNDX connection is maintained by the SSIS Network
Team and is currently used for online client clearing, nightly offender uploads, online
adoption application submissions, online IV-E data submissions to MAXIS, and online
IV-E eligibility determinations from MAXIS.
Description of the transfer process:
1. The user selects "Submit Report to DHS" action.
2. The SSIS Worker program checks for connectivity to SWNDX. If connectivity is not available,
the following message is displayed and the submission is aborted:, "'This system does not
currently have connectivity to the state server (SWNDX). Please try again later."
3. The SSIS Worker program sets the status code to Submitted (ST_RPT_STATUS_CD=3).
4. The SSIS Worker program fires business rules. DoErrorProvider will have already displayed
applicable error markers. However, when the status code is changed to Submitted
(ST_RPT_STATUS_CD=3) other rules may fire.
5. The SSIS Worker program calls the Save operation. An Oracle trigger fires upon the change
of ST_RPT_STATUS_CD from something other than 3 to 3. The trigger calls a procedure
that inserts, updates, deletes, transforms or whatever else it has to do to copy the report to
SWNDX. If it fails for whatever reason (e.g. network outage, database error) the entire
transaction is not committed and is rolled back, including the change to
ST_RPT_STATUS_CD in the local county database.
6. If the submission cannot be made due to any reason in Steps 2, 3, 4, or 5, the worker
program sets the status back to whatever it was before.
Step 6 is an attempt to keep clean connection between submitting and saving. The technical
advantage to doing the submission within the save is that it's (reasonably) impossible to change
the status to Submitted without it actually being submitted. If the submission failed but the status
remains "Submitted" in memory and displayed in the worker program, the worker could click Save
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 59 of 116
which would cause the submission to be attempted again. Technically, there's nothing wrong
with that, but it could be a little confusing for the worker.
Figure 10-7 illustrates the transfer process outlined above.
Actor: State Report user
: SSIS Worker
-Local
: State Server
Click "Submit Report"
Check for connection
No connection
"Try again later" message
Connection established
Submit confirmation dialog
Confirm continue
Set status to submitted if valid
Save failed message
Save report
Copy report to State
Copy process failed
"Try again later" message
Set status back to finalized
Figure 10-7, High-level data transfer process
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 60 of 116
10.1.9
Report/Tab Styles
This section describes the common report/tab styles and gives examples of each
type. The recommended implementation should be used, unless a specific report
does not fit into one of these styles. (Example: SEGAR Cost Allocation which is a
combination of the Entry and Summary styles).
For each State Report type, the functional analysts will review the individual CSIS
reports to determine if they can be reworked to use a grid.
Note: The “Data Cleanup Search” style is discussed in greater detail in Section 11.
Report/Tab
Style
Description/Example
Implementation
Summary
Summarized data that is stored locally and may be completely
or partially reported to DHS. This report style may display
both calculated and manually entered data.
Data Navigator grid
Generated (Stored)
This style does not contain client specific data.
Example: The TCM-CSR Client Statistical report. All of
the summarized data is stored by the county but only
totals are submitted to the state.
Summary-1
This style is summarized at the client level. It may represent
a one level drill- down one level from a summary style report
in order to identify the information used to calculate the
summarized data.
Data Navigator grid
Generated (Stored)
Example: TCM CSR Client Summary. This report lists
clients that were used to create the TCM-CSR Client
Statistical Report and where they were counted.
It may also be at the level submitted to DHS.
Example: CMHRS Client Summary. This report is
submitted directly to the state and summarizes client
level information.
Detail
Detailed data generated by the report process and submitted
to DHS.
Data Navigator grid
Generated (Stored)
Example: The Title IV-E FFH Abstract
Entry
Information that must be entered by the user for inclusion in
specific state reports or submitted to DHS as a standalone
report.
Examples: SEAGR Revenues, TCM CSR adjustments.
Data Clean-up
Search
SS SSIS Fiscal
List of rejections or inclusions for interactive data correction.
The user may navigate to the listed item and use data clean
up to change the underlying data that caused the record to be
rejected or included.
Last Updated: 06/30/08
SSIS Fiscal System Specification
Data Clean Up
Search (Not
Page 61 of 116
Report/Tab
Style
Description/Example
Implementation
Stored)
Typically data clean up is used for items that were excluded
from a state report due to errors.
Example: TCM CSR Rejected Time).
It could also be items with warnings or no problems at all:
Examples:
•
•
Payment Edit report (warnings only)
Time records included on SEAGR (valid records-no
problems)
This functionality is described in detail in Section 11.
Simple list
List of existing items included in the information for State
Report. It doesDoes not allow interactive data correction.
If defined as a generated report, it is stored. Otherwise, it is
initiated by the user for viewing or printing via search, but is
not stored.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Data Navigator grid
Search (Not
Stored) or
Generated (Stored)
Page 62 of 116
10.2 User Interface
10.2.1
State Report Navigation
State Reports are available from Searches/Logs on the main menu or from “State
Reports” on the Task Panel.
From: Main menu
From: Task Panel
Figure 10-8, State Report navigation
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 63 of 116
10.2.2
State Report Screen Layout
The screen layout is illustrated in the Tree View Structure Diagram (See
State Report
(Virtual)
This node exists but is not visible to users. Its purpose is
to group the state reports for developers
Each State Report Type (TCM CSR, SEAGR, Title IV-E Abstract, CMHRS)
has a node container for all the created reports of that type. This is the root
node in the treeview. The caption for this node is the report type
State Report
Type
State Report
This represents a single report. It contains the next two nodes
on it's screen. (State Report Header and all detail tabs)
This represents the top part of the report screen. It
contains the "header" information for the report (year,
period, status, etc) and also a "Generate" button.
State Report
Header
Tabs/nodes
This represents the bottom half of the screen and displays all the child
nodes as tabs on a page container. A report type may have any
combination of tabs/nodes as sepcified. The node appears as a child node
as well as a page on the page container.
Report and Proofing Grid tabs/nodes
Summary or
Summary-1
Detail
Entry
Data Clean-up
Search
Simple LIst
Figure 10-9 below) and the State Report Screenshot (See Figure 10-10 on the following
page),
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 64 of 116
State Report
(Virtual)
This node exists but is not visible to users. Its purpose is
to group the state reports for developers
Each State Report Type (TCM CSR, SEAGR, Title IV-E Abstract, CMHRS)
has a node container for all the created reports of that type. This is the root
node in the treeview. The caption for this node is the report type
State Report
Type
State Report
This represents a single report. It contains the next two nodes
on it's screen. (State Report Header and all detail tabs)
This represents the top part of the report screen. It
contains the "header" information for the report (year,
period, status, etc) and also a "Generate" button.
State Report
Header
Tabs/nodes
This represents the bottom half of the screen and displays all the child
nodes as tabs on a page container. A report type may have any
combination of tabs/nodes as sepcified. The node appears as a child node
as well as a page on the page container.
Report and Proofing Grid tabs/nodes
Summary or
Summary-1
Detail
Entry
Data Clean-up
Search
Simple LIst
Figure 10-9, Tree View Structure
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 65 of 116
This is the State
Report Type
This grid lists all of the reports for
the State Report type
StateReport Header
Reports created by the clicking the
"Generate" button. These are
defined in the spec for the State
Report Type. Each tab is also a
node underneath the report. (not
shown in this screenshot)
Interactive proofing done
with Data Clean-up Search.
Always initiated by user.
Figure 10-10: State Reporting Screen
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 66 of 116
10.2.3
Action Menu
The following table describes the common action menu for the State Report Header.
There are no action items for creating any of the generated reports. The action items
for data entry for specific State Report types are included in the individual State
report specifications.
Menu Item
Enable/Disable
Result
New [State Report
type]
Always enabled
Creates state report header record.
Finalize [Report type]
Enabled when status =draft
Status on state report header record is
changed from draft to finalized
Submit [Report type] to
DHS
Enabled when status=finalized
If submission is successful, status on the
state report header records is changed
from finalized to submitted.
Otherwise, user is notified of
transmission failure and status doesn’t
change.
Delete
Enabled when status = draft or
when current date is = or
greater than retention date
State report header and all children are
deleted.
Return to Draft
Enabled when status=finalized
Status on state report header record is
changed from finalized to draft.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 67 of 116
10.2.4
State Report Type Node Container
The fixed caption for each report type is constructed as follows as shown in Figure
10-11:
Year + Period code + [“(Revision “ + St_Rpt_Rev_Num + “)” if
St_Rpt_rev_num greater than 0 ]+ Status description
Examples: “2003 Q1 Submitted” or “2003 Q1 (Revision 1) Draft”
Note: The sort order in the screenshots is not in correct. The reports should be in
descending order by year, period, and revision. In other words, the most recent
record should be at the top of the grid.
Figure 10-11, Fixed caption for the report type
The following node container grid is used for all State Reports
Figure 10-12, Node Container Grid
Field List
Column
Heading
Comments
Default
Grid Order
Year
Year of the report
1
1-descending
Period
Code description
2
2-descending
Revision
Indicates if this report is the original
(revision 0) or if it is a subsequent report
for this period. Blank unless Rev # is at
> than 0
3
3-descending
Status
4
Status date
5
Default
Sort Order
Generated
date
Submitted
by
State Report
ID
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 68 of 116
10.2.5
Report Header Visual Module (Entry Form)
One State Report header record is created when the user selects “New” state report
from the action menu. The revision number is calculated by the system.
Figure 10-13: State Report Header (run time)
Field List
Unless otherwise stated, code fields display the code description. All visible system
generated fields are read-only and are not included in the tab order.
Display
Label
Field
Description
N/A
STATE_RPT_ID
N/A
Tab
Order
Required
Not displayed on entry screen
N/A
Sys Gen
COUNTY_CD
County or region for this report.
Not displayed on entry screen
N/A
Sys Gen
Report type
ST_RPT_TYPE_CD
Identifies the report type.
N/A
Sys Gen
Generated
date
ST_RPT_GEN_DT
Date/time that the report was last
generated. . This field is updated
each time the user clicks the
generate button
N/A
Sys Gen
Year
ST_RPT_YEAR
Report year—defaults to current
year.
Alpha
1
Yes
Period
ST_RPT_PERIOD_CD
Identifies the period for this report. Alpha
The selection list is filtered for valid
choices.
2
Yes
Revision
ST_RPT_REV_NUM
Revision number for this report.
The initial report is Revision 0.
This field is incremented when the
user saves a state report for a
year/period that currently exists in
submitted status.
N/A
Sys Gen
Status
ST_RPT_STATUS_CD
Identifies the status of the report.
N/A
Sys Gen
Status date
ST_RPT_STATUS_DT
Date of this status. Updated only
when the status changes.
N/A
Sys Gen
Submitted by
SUMT_STAFF_ID
Name of user who submitted the
state report via the Action menu.
Only the STAFF_ID is stored.
Contact name
ST_RPT_CONTACT_
Name of the person responsible for Alpha
this report.
NAME
Type
Sys Gen
3
No - if
draft
Yes - if
finalized
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 69 of 116
Display
Label
Field
Description
Type
Tab
Order
Required
Phone
ST_CONTACT_PHONE
Contact person’s phone number
Alpha
4
No - if
draft
Yes - if
finalized
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 70 of 116
10.3 Common Business rules
State Report Header
Note: Business rules for the required fields listed in the field list above follow the
standard SSIS error message format “[Fieldname]” is required.
Term: “Reporting period” as used in the common business rules means “Year”
combined with “Period”.
Rule
#
Rule
Implemented
by
Error
Message/Comment
SRF 1
Can only create new State Report
record when either of the following is
true:
Error on save.
[status] [Report type]
already exists for [reporting
period].
“Delete” menu
item disabled
unless delete is
allowed.
Note: The individual report
spec specify the retention
date business rule.
“Generate”
button enabled
only when status
is draft
N/A
•
SRF 2
no report exists for this
reporting period, or
•
status of previous rev for this
reporting period=submitted.
Can delete State Report only when
either of the following is true:
•
•
SRF 3
status = draft, or
current date is = or greater
than the required retention
date for this state report
Can only generate data/initiate query
for a state report when status = draft
SRF 4
Reporting period must be complete to
submit report to DHS
“Submit” menu
item disabled
SRF 5
When regenerating a report display a
message using the warning dialog
box.
“Generate”
button
"Re-generating this report
will remove all generated
report records and reprocess all eligible records.
Do you want to continue?"
SRF 6
When attempting to generate a report
while another state report is currently
running.
“Generate”
button
"Another State Report is
currently generating. Try
again later."
SRF 7
When a report is generated which
does not contain any data"
“Generate”
button
"Generation successful. No
data found"
Data Entry Rules (for adjustments, revenues, and other supplemental information)
Rule
#
Rule
Implemented
by
Message/Comment
SRF 8
Can create new data entry record
only when State Report header status
is draft
New [item] menu
option is disabled
N/A
SRF 9
Can delete a data entry record only
when State Report header record is
draft
Delete menu
option is disabled
N/A
SRF
10
Manually entered data must be
complete and incorporated as
specified for individual State Reports
Error when
attempting to
change status to
This business rule is general
and must be specified in
detail as appropriate for the
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 71 of 116
Rule
#
SS SSIS Fiscal
Rule
Implemented
by
Message/Comment
before status can be finalized.
finalized.
various State Reports. The
error message is specdependent.
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 72 of 116
10.4 State Report Header Table
All state reports use the common State Report header table.
Table name:
STATE_REPORT
Parent table:
Purpose:
This table contains “header” information common to all state reports. It
represents one instance of a State Report type.
Field
Data type/
Length
Description
STATE_RPT_ID
Num
10
Unique identifier for this state report
ST_RPT_TYPE_CD
Varchar2
1
Code to identify the specific state report
ST_RPT_YEAR
Varchar
4
Year of this state report
ST_RPT_PERIOD_CD
Varchar2
Reporting period for this state report
ST_RPT_STATUS_CD
Varchar2
Status of this report
ST_RPT_STATUS_DT
Date
Date that status was set for this report.
ST_RPT_GEN_DT
Date
Date that the report was last generated.
ST_RPT_REV_NUM
Num
3
The revision number for this report. The original report
is Rev 0.
STAFF_ID
Num
10
Staff ID of the worker who submitted the report
ST_RPT_CONTACT_NAME
Varchar2
65
Name of the contact person for this report
ST_CONTACT_PHONE
Varchar2
50
Contact person’s phone number
FROM_CNTY_CD
Char 2
SS SSIS Fiscal
Last Updated: 06/30/08
County/region code for the submitting county
SSIS Fiscal System Specification
Page 73 of 116
10.5 Codes
The following codes are common to all State reports
ST_RPT_TYPE_CD (used by STATE_REPORT)
Code
Description
Sort
Order
1
TCM CSR
1
2
SEAGR
2
3
CMHRS
3
4
Title IV_E Abstract
4
ST_RPT_PERIOD_CD (used by STATE_REPORT)
Code
Description
Sort
Order
Q1
Q1 (Jan 1-Mar 31)
1
Q2
Q2 (Apr 1-Jun 30)
2
Q3
Q3 (Jul 1-Aug 31)
3
Q4
Q4 (Sept 1-Dec 31)
4
S1
S1 (Jan 1-Jun 30)
5
S2
S2 (Jul 1-Dec 31)
6
A
Annual (Jan 1-Dec 31)
7
Note: Valid reporting period codes are
filtered for specific state reports as specified.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 74 of 116
10.6 Map: Legacy CSIS reports to SSIS
10.6.1
Legend
Label
Description
Report/Tab
Name
Name of the report or tab label
Style
Sum = Summary report/tab
Sum-1 = Drill down one level from a summary
Detail = Detail level report
Data Clean-up Search=interactive correction. Not stored
Simple list = list of items only—no navigation to the node
Entry = Adjustment / Manual entry module
Base
The primary module for the report (usually client)
Submit
Is this report exported
Store
Is this data stored locally (duplicated)
10.6.2
TCM-CSR (formerly TCM/FP-CSR)
This report is based on time records for TCM related BRASS services.
Report/
Tab Name
Purpose
Style
Base
Statistics
Unduplicated count of
clients receiving TCM
services by county
staff.
Sum
TCM-CSR report
table from Client
Summary Report
table
Sum-1
Client Summary
Report table (Time
Records)
Sub
●
Store
●
Option to display
Adjustments, as well
as totals
Client
Summary
List of clients included
in the client statistic
calculation and where
they were counted for
current and previous
quarters
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
●
Page 75 of 116
Report/
Tab Name
Purpose
Style
Base
Sub
Store
RTC
List of clients for RTC
workers from another
host county.
Sum-1
Client Summary
Report table
●
●
The printed version is
mailed to the host
county so they can
adjust their TCM-CSR
Report.
The format is similar
to the Client
Summary, but is
grouped by host
county.
Adjustme
nts
Manual input of
additional client
counts for Adult
Mental Health and
VA/DD for current and
previous quarters
Entry
Adjustment
records
Rejected
Time
List of time records
excluded from client
counts along with the
reason the time
record was not used.
Data
Clean up
Search
Time records
CSIS TCM/FP-CSR Legacy Reports
CSIS Legacy report name
SSIS tab label
TCM/FP Client Statistical Report-Calculated (DHS 3150.2)
& TCM/FP Client Statistical Report-Adjusted (DHS 3150.2)
Statistics
TCM/FP - Summary of Clients Included Report (Current
Quarter and Previous Quarter versions)
Client Summary
TCM/FP – Clients for Other Host Sites Report
RTC
TCM/FP - Rejected Time Sheet Records Report
Rejected Time
TCM/FP - Summary of Families Included Report (Current
Quarter and Previous Quarter versions)
N/A-Obsolete
TCM/FP - Rejected Paid and Unpaid Vouchers Report
N/A-Obsolete
TCM/FP – Paid/Unpaid Vouchers – Missing Family Report
N/A-Obsolete
TCM/FP - Time Sheets – Missing Family Report
N/A-Obsolete
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 76 of 116
10.6.3
SEAGR
This report totals time and payments by BRASS Service
Report/Ta
b Name
Purpose
Style
Base
Sub
Store
SEAGR
Report
List of totals by
BRASS Service
Sum
Report table
●
●
Included
Time
Lists time records that
will be included in the
SEAGR Report.
Simple
list
Time record (Staff
activity)
Rejected
Time
Lists time records that
will be rejected from
the SEAGR Report.
Data
Clean up
Search
Time record (Staff
activity)
Included
Payments
Lists payments that
will be included in the
SEAGR Report.
Simple
list
Payments
Rejected
Payments
Lists payments that
will be rejected from
the SEAGR Report.
Data
Clean up
Search
Payments
SEAGR
Adj.
Used to Adjust the
calculated totals by
BRASS Service
Entry
SEAGR
Adjustments
Revenues
Used to enter state,
federal and misc.
revenues for the
quarter.
Entry
SEAGR Revenues
●
●
Cost Alloc.
Used to enter the cost
pool amount, display
total time, and
calculated rates
Entry &
Sum
SEAGR Cost Alloc
●
●
●
●
●
CSIS SEAGR Legacy Reports
CSIS Legacy report name
SSIS tab label
Social Service Expenditures and Grant Reconciliation
(SEAGR) Report (Working Copy, Adjustments, Final and
Annual Including Adjustments versions)
SEAGR Report
Add/Change Adjustments to SEAGR Expense
SEAGR Adj.
Social Service Expenditures and Grant Reconciliation
(SEAGR) Report
Revenues
Supporting Schedule: Social Service Revenues – State,
Federal and Misc. versions
SEAGR - Selected Vouchers & Refunds/Cancellations Report
Included Payments
SEAGR - Rejected Vouchers & Refunds/Cancellations Report
Rejected Payments
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 77 of 116
CSIS Legacy report name
SSIS tab label
SEAGR - Selected Time Sheet Records Report
Included Time
SEAGR – Rejected Time Sheet Records Report
Rejected Time
Quarterly Social Services Cost Allocation Recap
Cost Alloc.
10.6.4
Title IV-E Abstract
This report is based on substitute care payments
Report/
Tab Name
Purpose
Style
Abstract
Summary
Base
Sub
Sum
Store
●
FFH
Abstract
Option to show state
information only or to
include reimbursement
columns
Detail
●
●
Group
Facility
Abstract
Option to show state
information only or to
include reimbursement
columns
Detail
●
●
Supplemental
Reimbursables
Used to include claims
that would not otherwise
be included in the report
process
Entry
●
●
Sum
●
●
●
●
Child
Counts
Recoveries
Used to enter IV-E
recovery amounts
Entry
IV-E
Recoveries
Payment
Errors
Search to help correct
errors with payment
information.
Data
Clean Up
Search
Payments
Placement
Errors
Search to help correct
errors with placement
information.
Data
Clean Up
Search
Placements
Continuous
Placement
Errors
Search to help correct
errors with placement
information.
Data
Clean Up
Search
Continuous
Placements
Client
Count
Detail
Included and excluded
clients
Simple
list
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
●
Page 78 of 116
Report/
Tab Name
Purpose
Style
Base
Client
Placements
History of placement
information
Simple
list
Placement &
Continuous
Placements
Client
Elig/Reim
List of clients IV-E
eligibility and
reimbursibility from
MAXIS.
Simple
list
Client DOC
History of client DOC
assessments, placing
authority, supervision
and ICWA indicator.
Simple
list
Sub
Store
CSIS Title IV-E Abstract Legacy Reports
CSIS Legacy report name
SSIS tab label
Title IV-E Foster Care Program / Supporting
Schedule: Recoveries Detail
Recoveries
Title IV-E Client Period of Care Error List
Continuous Placement Errors
Title IV-E Client Placement Error List
Placement Errors
Title IV-E Voucher and Refund/Cancellation Error
List
Payment Errors
Title IV-E Foster Care Program / Abstract
Summary (2570)
Abstract Summary
Title IV-E Foster Care Program / Supporting
Schedule: Family Foster Home Abstract (2570.2)
local and state versions
FFH Abstract
Title IV-E Foster Care Program / Supporting
Schedule: Group Facility Abstract (2570.3) local
and state versions
Group Facility Abstract
Title IV-E Foster Care Program / Supplemental IV-
Supplemental Reimbursables
E Reimbursables Included this Quarter
Title IV-E Foster Care Program / Supporting
Schedule: SSTS Child Count Ratio
Child Counts
Verification Report: Schedule 2570.5
Client Count Detail
Substitute Care Clients Report
Client Placements
Client IV-E Eligibility List
Client Eligibility
Client DOC Points List
Client DOC
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 79 of 116
10.6.5
CMHRS
This report is based on time records for clients receiving CMHRS services
Report/Tab
Name
Purpose
Style
Base
Sub
CMHRS
Summary
List of client information
Sum-1
Report table
Included
Time
Lists time records that will be
included in the CMHRS Report.
Simple
List
Time record
(Staff activity)
Rejected
Time
Lists time records that will be
rejected from the CMHRS
Report.
Data
Clean Up
Search
Time record
(Staff activity)
Client Proof
List of included clients with
potential errors
Data
Clean Up
Search
Client
Client
Conversions
Shows conversions from SSIS
values to CMHRS values
●
●
sent to DHS.
Client
(It might be possible to
incorporate this information
into the Client Proof)
CSIS CMHRS Legacy Reports
CSIS Legacy report name
SSIS tab label
CMHRS Edit Summary Report (Final and Working copies)
CMHRS Summary
CMHRS Selected Client Warnings Report
Client Data Clean Up
CMHRS Client Conversions Report
Client Conversions
CMHRS – Rejected Time Sheet Records Report
Rejected Time
CMHRS – Selected Time Sheet Records Report
Included Time
SS SSIS Fiscal
Store
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 80 of 116
●
10.7 Design Decisions
Decisions/Assumptions:
1. For counties that are in regions, we will submit state reports by region, using the
“region” county code.
2. Interactive data correction using the Data Clean-up Search screens is always initiated by
the user. No interactive “reports’ are generated.
Issues:
1. Data transfer method. We plan to use SWNDX…more about other options considered
goes into design decisions.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 81 of 116
SECTION ELEVEN: PROOFING REPORTS
11.0 Overview
The purpose of this section is to describe the proofing grid structure, common behavior, and
documentation responsibilities for the designer/developer of specific proofing grids.
The term “Proofing” describes a generic process that allows the user to:
•
•
•
•
Review a list of records rejected/excluded due to errors (Examples: records that
were rejected when creating a state report or a claim submission)
Navigate to any of the rejected or invalid records and correct the information if
appropriate.
Review a list of included records in order to validate them for some purpose
(Example: Review a list of payments with warnings prior to issuing checks).
Change included data so that it would no longer be included.
Proofing is done to support State Reporting, Claiming and the Payment process to verify
that data is correct and/or to correct the data that isn’t. Proofing grids may be standalone
such as the Payment Edit report, or may be presented as part of another screen such as the
State Reporting or Claiming interface. The generic proofing process uses two styles:
1. Data Clean up Search. This is the most common means used for proofing. It
combines standard Search capability with Data Clean-Up functionality. It returns a
list of records meeting the search criteria and allows the user to navigate to the item
or to underlying nodes to modify the data.
2. Simple list (Data Navigator grid): This grid may be used when the user simply needs
to view a list of entities and has no need to navigate to the record for correction.
The remainder of Section 11 assumes that Proofing Grids will use Data-Clean up because it
allows the user to navigate to the underlying data.
11.1 Using Data Clean up Search in the Proofing Process
The user initiates the proofing process by selecting the appropriate tab, reviewing/ selecting
the search criteria, and clicking the “Search” button. Unlike the State Reports generation
process wherein several stored reports may be generated when the user clicks the
“Generate” button, all non-stored proofing grid searches are individually initiated by the
user.
The proofing node itself is a Search Log returning a grid listing items such as a time record
or payment. The data to be corrected may be found in another node and Data Clean up
allows the user to go directly to that node. For example, a proofing grid may return a list of
payments excluded from a report due to errors. The reason for rejection may be
correctable on either the payment itself or on the client.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 82 of 116
Proofing grids (Data Clean-up) may be printed but are not stored.
11.2 Screen Examples
Note: Usually Proofing Grids-Data Cleanup style are on a tab. This screenshot is for the
Payment Edit report and is standalone.
Figure 11-1: Payment Edit Report Showing Preview
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 83 of 116
Figure 11-2 below illustrates how the user may navigate though the records in the grid
while viewing each record in full screen. Once the user double-clicks on an item in the
proofing grid (Payment, in this example), it is displayed full-screen with the next/previous
buttons enabled as well as an index in the action panel.
Clicking the Next/Previous buttons navigates through the payments, updates the n of m
index and updates the Data Clean Up errors for the newly selected record. The user may
also navigate from one record to the next with the following keyboard shortcuts:
•
•
•
Ctrl-Alt Up arrow navigates to the prior payment.
Ctrl-Alt-Down arrow navigates to the next payment.
Ctrl-Alt-Home returns the user to the node container.
Navigation to next and
last record
Indicates where this
record is in the list
Figure 11-2: Payment Batch Edit Report Data Cleanup—Full Screen
11.3 Search Criteria
The search is defined in the individual State Report, Claim or Payment specification. The
user may filter by edit categories. The search may return either included and/or rejected
entities as documented in the individual state report specification.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 84 of 116
11.4 Search Screen Layout
Layout the Search screen in the following order as illustrated in the screen mock-up below:
1. Data selection fields (Optional): User-selected data fields (for example, select a
specific payment batch)
2. Date range (Optional): Use the standard date range selection used by Fiscal
searches/reports
3. Report on (Optional): Depending upon the items being proofed, it may be
appropriate to allow selection of included/excluded records.
4. Include checks for (Required): Edits are grouped into categories so that the user
may define which checks should be done to get the search result. The individual
State Report specification identifies the error/warning category filters and defaults.
Display the category options in a group box titled “Include checks for”. Whenever
possible try to limit the selection to three.
Figure 11-3: Search screen layout
11.5 Refreshing the results grid:
The user must refresh the list of items by clicking the Search button. Errors and warnings
do not automatically refresh when the user clicks off of the node.
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 85 of 116
11.6 Common Error handling
The business rules for proofing-data cleanup grids will go in a stored proc—the error
information will be returned thru a function GetMessageInfo (COMMON_MESSAGE_ ID).
11.6.1
COMMON_MESSAGE Table
Purpose: This table contains messages used by all state reports, payment batch edit, and
claiming.
Data
Type
Field
COMMON_MESSAGE_ID
Number
Length
Description
10
Unique identifier for this message
COMMON_MSG_TYPE_CD Varchar2
2
Description of the “navigate to” node. The
code description is appended to the short
message.
COMMON_MSG_NUM
Varchar2
10
The unique number for this message such as
101, 102, etc.
SHORT_MSG
Varchar2
400
This is the message text.
LONG__MSG
Varchar2
4000
Expanded information about the message
shown in the “help” section of the data clean
up tree.
COMMON_MSG_TYPE_CD (used by COMMON_MESSAGE)
Code
Description
1
Client
2
Payment
3
Placement
4
License
5
Bus Org
6
Time record
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 86 of 116
11.6.2
Short Message Format:
The designer should specify the short message text using the format below. When
displayed, the Common_Msg_Type code description is appended to the beginning of the
message:
Message:
‘fieldname’ Some words…[@ParamName1])…more words
‘fieldname’([@ParamName2]).
For example:
‘Service start date’ ([@SvcStartDt]) must be less than ‘Service end date’
([@SvcEndtDt]).
Displays to the user as:
Payment: ‘Service start date’ (1/11/2006) must be less than ‘Service end date’
(12/31/2005).
In addition, warning messages are preceded by "Warning:"
For example, if the message above is defined as a warning is would display as:
Warning: Payment: ‘Service start date’ (1/11/2006) must be less than ‘Service end
date’ (12/31/2005).
11.6.3
Long Message Format
The designer should specify the long message text using the format below:
Message:
Long message text (Message #'COMMON_MESSAGE.COMMON_MSG_NUM')
Displays to the user as:
The age of the client on the Time record is incorrect for the "Service". (Message
#3003).
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 87 of 116
11.7 Edit documentation format
The standard format for business rules, error message, and navigation information for Data
Clean-up proofing is shown below. The components of the format are as follows:
Category
Identifies the name of the edit category.
This is defined in for the specific proofing
grid and is used for grouping the various
edits.
Description
Text description of the edit
Edit Logic
Description of the edit logic and conditions to which it applies.
Display As
Warning or
Error
Message Type
Description of
COMMON_MSG_
TYPE_CD
# this is just
used in the
documentation
Ref #
Node
Identifies the node associated with the
edit. The user will navigate to this node
in the tree after selecting the short
message in the tree.
Message #
The edit query uses this message #
(COMMON_MSG_NUM to get the correct
message text. This number is included
at the end of the long message.
Short Message
This is the short message including parameters
Example
Illustrates how this error will display when it contains actual data.
Long Message
This is the description text that displays in the “Error Help” section of
the Data Clean up screen. It includes the message number.
Example of Payment edit documented with the format described above:
Category
Substitute Care
Description
Adult Receiving Children’s Substitute Care Services
Ref #
Edit Logic
An adult is receiving children’s substitute care services when all of the following
conditions are true:
•
Payment is client specific
•
Client's age is greater than or equal to 18 on the Service Start Date
•
Service is one of the following:
o
171 - Child Shelter
o
183 - Children's Group Residential Treatment
o
185 - Correctional Facility
o
483 - Children's Residential Treatment
o
475 - Child Acute Care Hospital Inpatient
9.2
Display As
Warning
Node
Client node (face sheet)
Message Type
Client
Message #
102
Short Message
Client: Age ([@ClientAge]) is over age 17 and Service is children’s substitute care
Example
Client: Age (19) is over age 17 and Service is children’s substitute care
Long Message
The Payment is for a children’s substitute care service, but the client may no longer
qualify for that service due to age. (Message #102)
SS SSIS Fiscal
Last Updated: 06/30/08
SSIS Fiscal System Specification
Page 88 of 116
Download PDF
Similar pages