Book a Demo

Author Topic: Interface Contract tagged values to be stored  (Read 2411 times)

Octavian

  • EA Novice
  • *
  • Posts: 7
  • Karma: +0/-0
    • View Profile
Interface Contract tagged values to be stored
« on: April 26, 2011, 06:23:00 am »
Hey guys! I am designing an element that defines interface contracts between systems. I was curious what you guys think are the tagged values to include.

For example:
- Source
- Target
- Technology Used
- Data Elements Sent
- Data Elements Expected to be Received

Any tips on how to implement interface contracts in SEA? Would be great to store them in CSV and then import them...

Octavian

  • EA Novice
  • *
  • Posts: 7
  • Karma: +0/-0
    • View Profile
Re: Interface Contract tagged values to be stored
« Reply #1 on: April 26, 2011, 06:42:24 am »
Here's a good link:
http://www.agilemodeling.com/artifacts/contractModel.htm

DETAILS:
  • Identifier. A unique identifier, for example EI-1701.

  • Description.  A couple of sentences or a paragraph describing the external system interface.

  • System owner.  The name(s) and contact information of the people who own the system.  Include both the project manager and the technical contact.

  • Type.  The type of interface, e.g., XML, JMS, Java API, flat file transfer, etc

  • Direction. List the direction of the transfer – Outwards, inwards, or bi-directional.  

  • Frequency. Approximately how often this interface is exercised, e.g., once a week, 500 times a day, etc.

  • Timing. Describe when the interface is used, for example 24/7, once a night at 2 a.m., and so on.

  • Transfer rate. List known or required transfer rates, e.g., the file will be 50 megabytes on average or the records will be 125 bytes each.

  • Security.  List known security issues, e.g., is a login required, is the source system protected by a firewall, is a secure socket layer used,

  • Format. Describe in detail the format of any data  transfer.  You may simply reference an XML schema definition, describe a file record layouts, or describe a C API.   The information in this section will vary depending on the interface specifics.

  • Issues.  List any "to dos", concerns to be addressed, and so on.

  • Decisions. List any important decisions made during the development of this interface.
« Last Edit: April 26, 2011, 06:43:53 am by opetrescu »

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Interface Contract tagged values to be stored
« Reply #2 on: April 27, 2011, 05:16:48 pm »
If you are looking for ways to import data into EA you could use the Simple VBA Excel - EA importer as a basis.

Geert