AKC06: External Interfaces

Description:

Provides a detailed list of the external interfaces and data transfers between the application and other applications, hardware devices, or other outside organizations. Typically, these are serial data files received, created, or transmitted from within a batch process or program. Provides the support analyst a detailed list of external interfaces between the application and external environment.  This document identifies the program producing the file, record format name, frequency and relative size in records produced. This is invaluable when there is a problem or change to the interface. If a file is not produced/received, it gives a very good starting point for fault analysis.

Provides understanding of relationships to other application systems and/or outside entities. Provides information such as:

• Organization or Application from which the interface is coming and/or going
• Description of the interface file (Cartridge, Diskette, Tape, FTP, Serial Transmission, Serial Device, or other electronic media)
• Run Frequency
• Job and Step that the interface is input to or originating from
• Location of the Copybook or other reference containing the Record Format of the interface file
• Estimated number of records contained in a typical file or transmission

How is it used?

Provides the support analyst a detailed list of external interfaces between the application and external environment. This could be other applications, files sent to other organizations out side the business, schedules. This document identifies the program producing the file, record format name, frequency and relative size in records produced. This is invaluable when there is a problem or change to the interface. If a file is not produced/received it gives a very good starting point for fault analysis.

Why is it important?

(1) Corresponds to the “Application Dependencies” Content area;
(2) During interviews, TD SME’s expressed concern that in some of the current documentation “Interfaces is completely missing”
(3) Provides understanding of relationships to other application systems and/or outside entities
(4) Provides information such as:

• Organization or Application from which the interface is coming
• Organization or Application to which the interface is going
• Description of the interface file (Cartridge, Diskette, Tape, FTP, Serial Transmission, Serial Device, or other electronic media)
• Run Frequency
• Job and Step that the interface is input to or originating from
• Location of the Copybook or other reference containing the Record Format of the interface file
• Estimated number of records contained in a typical file or transmission