Revised: 03/21/2019
Requesting a Custom Interface
Overview
Agencies often have a technology need to integrate OAKS FIN to a third-party application. When this need arises, the agency must follow the applicable process below to ensure proper management as well as to provide the OAKS Steering Committee with proper visibility and ability to make decisions regarding future requests.
New Integration
- When an agency needs an interface, they must send an email to
OBM RACM
and provide answers to the questions below.
- Project Overview and/or Interface Description: (This is a high-level summary and background of the overarching project, justification of interface request, and relevant requirements, both from transactional and data standpoints (if available).)
- Project Schedule and Current State: (This describes the high-level plan/schedule for the project and the current state/phase.)
- Interface/Data Source: (This describes where the data would be coming from as part of the request for OAKS integration)
- Interface/Data Target: (This describes where the data would be consumed as part of the request for OAKS integration)
- Volume/Frequency: (This describes how many requests would be made in a day or during the hours of operation of the interface.)
- Integration Processing Frequency (Batch or Real-Time): (This describes if the response from the interface is driven in real-time on a request/response basis or a scheduled batch process)
- OBM RACM will review the request and determine if this is a new type of interface and if the request is reasonable.
- If new and reasonable, OBM RACM will develop recommendation for the OAKS Steering Committee.
- All new recommended integration requests will be brought before the OAKS Steering Committee.
- OBM RACM will submit the new integration requests in the format of the OAKS Integration Request form. Integration Requests should be sent to the OAKS Integration Services Team by the first Friday of the month to be included in the packet for the monthly meeting.
- The Agency requestor should plan on having a representative attend the OAKS Steering Committee meeting to present the request and field any questions. Standard OAKS Steering Committee voting procedures preside over integration requests.
- OAKS Steering Committee approval is to allow integration work to proceed, not how an integration request is solutioned.
Existing Integration, new to an agency
When an agency has a need for a new interface they should submit an email to
OBM RACM
and justify the request. Include information such as:
- The name of your agency and section of the request.
- Describe in detail the project your agency is planning to use with this interface.
- What is your current volume of data entry into OAKS?
- Provide a project timeline. (i.e., analysis, design, test, go-live, etc.)
- Is the project replacing an existing system? If yes, what is the current system called?
- Will outside resources (contractors) be brought in to produce the work at your agency?
Existing Integration, testing needed
When an agency has a need to test an existing interface they should submit an email to
OBM RACM
and explain the need. Include information such as:
- The name of your agency and section of the request.
- Describe in detail the change that was made that makes this test necessary
- Provide a project timeline