Development Guide

EDFacts Shared State Solution

Authors: Steven King Date: 19 July 2016 Version: 0.3

Development Guide EDFacts Shared State Solution

Page i

Change History Log

Date Pages Summary of Changes Version Authorized By

5-Jan-2012 Initial Draft v0.1 Steven King

6-Aug-2014 Update staging package generic design, specifically the Post Process procedure design and name; and the email generation. Email now includes the staged table name and the reporting period processed.

v0.2 Steven King

19-July-2016 Adding a new Client Set Up section to the document.

V0.3 Kathleen Browning

Development Guide EDFacts Shared State Solution

Page ii

Table of Contents Table of Figures ......................................................................................................................................................... iv Screen Shots ............................................................................................................................................................... iv Introduction ................................................................................................................................................................. 1

System Overview .................................................................................................................................................... 2 Objectives ................................................................................................................................................................ 3 Scope ........................................................................................................................................................................ 3

Definitions ................................................................................................................................................................... 3 Technologies ................................................................................................................................................................ 3 Relation to the CEDS .................................................................................................................................................. 4 Design Principles ........................................................................................................................................................ 4 Development Plan ...................................................................................................................................................... 5

Client Setup Procedures ........................................................................................................................................ 5 Staging Table Design and Loading ...................................................................................................................... 6

Principles to table design .................................................................................................................................. 6 Generic Stage Loading Package Connection Managers ............................................................................... 6 Generic Stage Loading Package ETL Variables ............................................................................................. 7 Generic Stage Loading Package ETL Flow Design ....................................................................................... 9

Submission Table Load and File Creation ........................................................................................................ 24 Submission Table Design ................................................................................................................................ 24 Generic Submission Package Connection Managers .................................................................................. 24 Generic Submission Package ETL Variables ................................................................................................ 27 Generic Submission Package ETL Flow Design .......................................................................................... 29 Utility Routines ................................................................................................................................................ 54

Generic Package Configurations ........................................................................................................................ 58 Core Connections Package Configuration................................................................................................ 60 Package Specific Package Configuration .................................................................................................. 60

SSIS Package Deployment ................................................................................................................................... 60 SSIS Logging and Event Handling ..................................................................................................................... 60

SSIS_ProcessLog Table .................................................................................................................................... 60 OnPreExecute Event Handler ........................................................................................................................ 61 OnPostExecute Event Handler ....................................................................................................................... 62 OnError Event Handler ................................................................................................................................... 63

Validation Reports Submission Tables ........................................................................................................... 65 Validation Reports Staging Tables .................................................................................................................. 70 System Monitoring and Management ............................................................................................................... 70 Web Management System ................................................................................................................................... 70

Individual Client Configuration ............................................................................................................................. 70 Client Configuration Data Tables ....................................................................................................................... 70

EDFacts_Admin.StateConfig Table ............................................................................................................... 70 EDFacts_Admin.StateCharacteristic Table ................................................................................................... 71 EDFacts_Admin.SubmissionFileCharacteristic Table ................................................................................. 71 EDFacts_Admin.StateCodeTranslation Table .............................................................................................. 72 EDFacts_Admin.SSIS_Configuration Table ................................................................................................. 72

Managing State Code Set Translation Values ................................................................................................... 72 Individual Client Development and Customization Checklist ...................................................................... 74

Managing Client Contributions .............................................................................................................................. 74

Development Guide EDFacts Shared State Solution

Page iii

Standards and Best Practices ................................................................................................................................... 74 Naming conventions ............................................................................................................................................ 74 T-SQL procedure naming and comment conventions .................................................................................... 74

Development Guide EDFacts Shared State Solution

Page iv

Table of Figures

Figure 1: Stage Loading Generic Variable List ....................................................................................... 7

Figure 2: Generic Stage Loading Package Control Flow ...................................................................... 9

Figure 3: Stage Loading, Database Source Data, Typical Data Flow ................................................ 12

Figure 4: Stage Loading, Excel Source Data, Typical Data Flow ....................................................... 15

Figure 5: Submission Loading Generic Package Control Flow ......................................................... 29

Figure 6: Submission Loading, Validate Source Data, Data Flow .................................................... 33

Screen Shots

Screen 1: Stage Loading, Generic Connection Managers ..................................................................... 6

Screen 2: Stage Loading Package, Set Package Defaults, General Information .............................. 10

Screen 3: Stage Loading Package, Set Package Defaults, Parameter Mapping ............................... 11

Screen 4: Stage Loading Package, Set Package Defaults, Result Set ................................................. 11

Screen 5: Stage Loading Package, Delete Previous