Effective Date: December 5, 2024
Authority: Information Technology Executive Committee (ITEC)
Purpose
To establish a standardized approval process for creating, testing, and publishing TeamDynamix (TD) iPaaS (integration Platform as a Service) flows.
Scope
This document applies to all TD iPaaS flows that involve external connectors, internal flow, and ensures proper authorization, documentation, and testing before deployment to production. Internal (TD to TD) connector flows do not need to go through the external flow approval process; however, all internal flows must be discussed and cataloged so awareness is provided on the data elements being used and how those data elements are being used. Understanding that there is a one-to-many relationship between external connectors and external flows, this process requires all flows using external connectors to go through the external flow approval process. This is due to data security, privacy, and liability of the data elements that can be passed with different flows using the same external connector.
Internal Flow (TD-TD) Documentation Process & Review
- Internal Flow Documentation
- The Internal Flow Designer/Requestor will:
- Create entry in TD iPaaS Internal Flow spreadsheet making sure to complete all requested fields.
- Link to Internal Flow Spreadsheet
- All internal flows will be reviewed on a regular cadence by the Unified Service Management Council
- Notification of the review will be given to a representative of the internal flow. This will include a list of the flows that will be reviewed.
External Flow Approval Process: 1-10 Business Days
- Request and Initial Approval
- The requestor and Portfolio Manager will:
- Work together to start the approval process which includes:
- Complete the TeamDynamix iPaaS External Connector Implementation Form. In the form, the requestor and/or the portfolio manager will describe, in detail, the proposed flow’s functionality and associated data elements.
- iPaaS External Connector Request Form
- Ensure all data-sharing agreements are in place.
- Determine the data classification of the data being shared between systems.
- If existing data-sharing agreements are in place, are all the data elements in the request part of the current data-sharing agreement? If not, a revision of the data-sharing agreement must be completed before the request is approved.
- If there are A.I. components (on either end), the request will need to go through A.I. Governance Council first.
- Unified Service Management Council Approval
- The request will be reviewed, either in council or asynchronously.
- Upon approval, the Portfolio Manager will be notified of the approved request by the council.
- Portfolio Manager Review and Project Council Approval
- The Portfolio Manager will work with the requestor to reevaluate the approved request to ensure it meets the originally described flow and data elements.
- The requestor along with the portfolio manager will present the request to the IT Project Council for final approval. This can be done in council or asynchronously.
- Flow Creation and Testing
- After receiving final approval:
- Authorized, credentialed users may create the flow in TD iPaaS.
- The flow must be thoroughly tested in a non-production environment.
- Publishing
- Once testing is complete and satisfactory, the flow can be published to the production environment.
- Ensure flows are properly documented and tested in accordance with this approved process.
Urgent Requests: Same Day – 1 Business Day
If an external flow request requires a timelier approval due to an urgent or emergency nature, the requestor and Portfolio Manager will follow the process described below. Please note that a more rigorous review may be required following publishing of the external flow(s).
- Go through steps 1-5 above in the External Flow Approval Process
- Noting that the request is urgent and notify the USMC chair of the urgent request.
- The approvals can be carried out asynchronously requesting expedited approval from the responsible councils. This can be done via E-Mail, Teams, or other asynchronous methods.
- USMC Authorized Approver(s)
- Three voting members of the USMC must approve the urgent request
- One of the approvers must be an IT ASE over the TD system
- One of the approvers must be either the IT Governance Director or USMC Chair
- The third approver can be any voting member of the USMC
- Project Council Authorized Approver(s)
- Software Engineering Director or as assigned in their absence.
Policy on Non-Compliance
- Any TD iPaaS flow containing an external connector that has not received IT Project Council approval will be unpublished immediately.
- The publishing user's rights will be evaluated.
- This standards document is a guideline to ensure the secure and efficient management of flows involving external connectors within TD iPaaS. Adherence to this process is mandatory.
- This document takes effect on the date above. Any external and internal flows created prior to that date are approved, however, reviews of those flows will be completed within 12 months of the date of effect of this process.