Skip to main content
U.S. flag

An official website of the United States government

Dot gov

The .gov means it’s official.
Federal government websites often end in .gov or .mil. Before sharing sensitive information, make sure you’re on a federal government site.

Https

The site is secure.
The https:// ensures that you are connecting to the official website and that any information you provide is encrypted and transmitted securely.

The Modernization and Migration Management (M3) Playbook has a new look! Explore our new features here.

M3 Playbook > Phase 4: Migration > 4.9 Design and Develop Interfaces

4.9 Design and Develop Interfaces

Technology

Task Activities

  1. Provider

    Create or update Interface Control Documents to describe the functionality including data flow, security and controls, and transfer methods between various legacy systems

  2. Shared

    Leverage standard interfaces and application programming interfaces (APIs) to create connections between applications

  3. Shared

    Coordinate with the interface partner to collaborate and agree on data exchanges, integration methods and unit testing timeframes

  4. Provider

    Code and unit test Interfaces

  5. Shared

    Establish batch jobs to execute interfaces and conduct integration testing

4.9 Best Practices

  • 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

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

Outputs

  • Interface Control Document
Return to top