The first step in building your integration project framework is creating your project overview. What many will refer this to be is creating your set of requirements that needs to be achieved.
Goal
The goal of this step is to understand your integration requirements, specifically which use cases need to be satisfied. For an integration, this involves identifying the data elements needing to be exchanged between the systems.
Word of advice: you need to get specific. Too often I hear "the goal is to integrate with XYZ Time and Attendance system". But what does that truly mean?
Does it mean data from payroll needs to be exchanged with XYZ? (new hires, employee changes, organization groups, etc..) If yes, what elements are required:
- Employee name?
- Employee ID?
- Rate?
- Home organization group?
Does it mean data from XYZ Time and Attendance system needs to be exchanged with payroll?
- Is it summarized hours for a pay period or detailed punches?
- Will things like tips, commission, expenses or other dollar amounts be included?
How to achieve your goal
Point being, you need to get detailed during this step to achieve your desired outcome. I'd suggest you do the following:
Identify every data flow/use case that needs to be completed. And think big! I tell people all the time, identify your utopia - your dream scenario of what needs to be accomplished.
For each use case, create a data dictionary of the specific data elements which need to be exchange. Your data dictionary should include:
Field name
Data type (string, integer, decimal, date, etc...)
Standard format (how many decimal places, what date format is used, etc...)?
Is it required or optional?
For each use case, identify the triggers which initiate the need to exchange data.
Is it user initiated by performing a specific action?
Is it a scheduled event which needs to occur daily, weekly, monthly, etc...?