
4.9 : Design and Develop Interfaces
Objective
Design and develop interfaces between applications.
View Lessons LearnedRecommended Best Practices
-
Provider
Update Interface Control Documents to describe flow of data, security, controls, and processes.
-
Shared
Leverage standard interfaces and API to create connections between applications
-
Shared
Coordinate with interface partner to agree on data exchanges, integration methods & test timeframes
-
Provider
Code and unit test Interfaces
-
Shared
Establish batch jobs to execute interfaces and conduct integration testing
4.9 Lessons Learned
- Maintain a detailed network architecture to help troubleshoot interface design and development issues
- Conduct frequent checkpoints with interfacing application developers between customer and provider
- Coordinate early with external interface providers to properly plan testing windows
Stakeholders
Recommended stakeholders, inputs, & outputs may vary by implementation; however, agencies that contributed to this Playbook reported these factors as increasing the likelihood of success.Customer
- Program Manager
- Functional Lead
- Technical Lead/Solution Architect
- Development Team
- Network SME
Provider
- Program Manager
- Functional Lead
- Technical Lead/Solution Architect
- Development Team
- Network SME
Inputs
- Requirements Traceability Matrix (RTM)
- Requirements Fit-Gap Analysis
- Target State Architectural Solution
- Technical Strategy
- Target State Concept of Operations
Outputs
- Interface Control Document