What is the process for developing an interface or channel?

Question

I am new to develpoing an interface. What is a good process to use for developing interfaces in QIE?

Answer 1

A good way to develop an interface is to use the development life cycle graphic and explanation below. Often times when developing an interface the developer may not know all of the configurations that are needed to complete the interface. Given that there are many unknowns to most interfaces developed a good way to get started is to start with the known facts as described below.

Interface Development Life Cycle
Step	Description
Preliminary Fact-gathering	In this step the developer gathers as much information about the new interface as possible. This might include the following items like: the source and destination systems being connected, communication protocols supported by each system (file transfer, socket connection, web service, et cetera), file format being exchanged (CSV, HL7, XML, et cetera), sample messages from the source system, interface specification from destination system, and any known data mappings needed.
Create & Configure Channel	Create a new channel in QIE and setup and configure the channel with the known facts. QIE requires at least the Source and Destination communication protocol and at least one mapping by default. If the Source communication protocol is not known then configure a temporary “data in” folder on the QIE server to use. If the Destination communication protocol is not known then configure QIE to drop the mapped file to a temporary “data out” folder or to discard the file. If there is not at least one known mapping then highlight and delete the blue mapping node (graphic shape) and connect the Source node to the destination node.
Configuring Mappings	Create as many mappings from both the known mapping issues and the destination interface specification document if available as possible.
Testing	Start testing the configuration by creating a message from the Source System and/or using the QIE Testing functionality with the Sample Messages to test the configuration implemented so far.
Evaluating Error(s) & Configuring Additional Changes	Analyze any errors and devise a plan to resolve the errors. Implement the fixes to the errors found in the testing phase and/or add additional new logic that is now available (e.g. Source or Destination communication protocols, new mapping requests et cetera) and retest. Continue this process until configuration is ready for go live.
Promote to Production	After completing the testing and setup of the interface care should be taken to update any changes to the test channel that may be different from production (source and destination communication protocols, database connectivity settings, web service URL’s, and any associated user name and passwords). If the production install of QIE is on a separate server then use the Export and Import functionality available from the Application Menu of QIE to move the specified channel and any associated dependencies to the production box.

 

Comments

this is a great framework for conceptualizing the work necessary to develop and put together an interface.

I would add one comment, which is, that regardless of who is in charge of requesting, developing, designing, or implementing the interface. it is paramount for everyone involved to understand the Goal and/or Purpose of the interface.

When it comes down to making a decision about how to craft the solution. if the team gets stuck, they can always refer back to the original Intent (or goal) of the interface, to help them make a decision and move forward.  

I would also add a step between the testing a promotion to production to present the interface and its results to the "customer" for sign off - to ensure you are delivering something of value to them.