diff --git a/docs/contribute/openfn-roadmap.md b/docs/contribute/openfn-roadmap.md index ae92f2053c8..e2b49175d20 100644 --- a/docs/contribute/openfn-roadmap.md +++ b/docs/contribute/openfn-roadmap.md @@ -116,27 +116,26 @@ OpenFn/Lightning is the fully open-source workflow automation platform at the core of the OpenFn Digital Public Good (learn more about the product [here](/documentation#openfn-v2-lightning-)). -| **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | -| --------------------------------------------------------------------- | ------------ | ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. Extend workflow canvas to allow branch merging | Delivered | Q2 '24 | [Issue 2008](https://github.com/OpenFn/lightning/issues/2008) | Allow users to be able to skip steps and also merge two steps to one downstream step in a workflow | -| 2. Implement Generic OAuth credential type | Delivered | Q2 '24 | [Issue 1900](https://github.com/OpenFn/lightning/issues/1900) | Generic OAuth client and credential support for adaptors. Users can configure their own OAuth applications and credentials for OpenFn. | -| 3. Add path params in webhook triggers URL | Delivered | Q2 '24 | [Issue 1954](https://github.com/OpenFn/lightning/issues/1954) | Support path params in wenhook URL for workflows. | -| 4. Automatic GitHub version control | Delivered | Q2 '24 | [Issue 970](https://github.com/OpenFn/lightning/issues/970) | Use GitHub Version Control to track and review changes to your workflow. Sync an OpenFn project and workflows to a specified GitHub repository github and allow users to be able to update OpenFn projects with GitHub versions. | -| 5. Configurable data clips and history retention period | Delivered | Q2 '24 | [Issue 1760](https://github.com/OpenFn/lightning/issues/1760) | Allow project administrators to configure how long they want OpenFn to retain data clips and other artifacts related to a workorders in their projects | -| 6. Enable workflow snapshotting | Delivered | Q3 '24 | [Issue 1680](https://github.com/OpenFn/lightning/issues/1680) | Keep a snapshot of a snapshot based on a run or saved changes of the workflow. Allow users to be able to view snapshot and switch to the latest version of the workflow from a snapshot mode. | -| 7. Enable configurable concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2022) | Allow users to control the limit of concurrent runs per workflow in a project. | -| 8. New workflow triggers (Kafka) | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | Enable a new trigger type that allows users to run workflows based on messages from a Kafka cluster. | -| 9. AI-enabled assitants | Delivered | Q3 '24 | [Issue 2193](https://github.com/OpenFn/lightning/issues/2193) | LLM based AI assitant that supports users with job writing, debugging and co-piloting their workflow design process. | -| 10. Invite new users as collaborators | Delivered | Q3 '24 | [Issue 1835](https://github.com/OpenFn/lightning/issues/1835) | Invite users who do not have OpenFn accounts to projects as collaborators. | -| 11. Allow users to create projects | In dev | Q3 '24 | [Issue 1700](https://github.com/OpenFn/Lightning/issues/1700) | All users to create new projects from their dashboard. | -| 13. Allow users to export workorder history | Shaped | Q3 '24 | [Issue 1698](https://github.com/OpenFn/lightning/issues/1698) | Allow project users to be able to export workorder history. The workorder history contains ALL logs and data clips (Input and Output) associated with runs in a workorder. | -| 12. Control log outputs | Tracked | Q3 '24 | [Issue 1755](https://github.com/OpenFn/Lightning/issues/1755) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | -| 14. Enable manual workflow triggers | Tracked | Q4 '24 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable users to manually trigger workflow with JSON/CSV data as input data clip | -| 15. Project datastores and buffers | Tracked | Q4 '24 | [Issue 2190](https://github.com/OpenFn/lightning/issues/2190) | Allow users to configure a data store or buffer that allows temporary of storage of data that can be used in a workflow. | -| 16. Redesign workflow canvas and inspector interface | Tracked | Q4 '24 | [Issue 2021](https://github.com/OpenFn/lightning/issues/2021) | Make workflow design better to help user build workflow faster and easier. | -| 17. Improved History page filter | Tracked | Q4 '24 | [Issue 1791](https://github.com/OpenFn/lightning/issues/1791) | Extend workorder history page and enable cascading filtering. This is useful for debuging, failure recovery and auditability of the workflow. | -| 18. Enhanced websocket worker Monitoring | Tracked | | [Issue 608](https://github.com/OpenFn/kit/issues/608) | Give users better visibility of what's happening on inside the worker, especially when an error occurs during run execution. | -| 19. Expanded Audit Trail and Node Authentication (ATNA) functionality | Tracked | | [Issue 271](https://github.com/OpenFn/Lightning/issues/271) | Extend audit trail functionality to cover more aspects of ATNA, reference [OpenHIE IOL requirement IOLWF-1](https://guides.ohie.org/arch-spec/openhie-component-specifications-1/openhie-interoperability-layer-iol#openhie-iol-workflow-requirements). | +| **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | +| --------------------------------------------------------------------- | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1. Enable workflow snapshotting | Delivered | Q3 '24 | [Issue 1680](https://github.com/OpenFn/lightning/issues/1680) | Keep a snapshot of a snapshot based on a run or saved changes of the workflow. Allow users to be able to view snapshot and switch to the latest version of the workflow from a snapshot mode. | +| 2. Enable configurable concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2022) | Allow users to control the limit of concurrent runs per workflow in a project. | +| 3. New workflow triggers (Kafka) | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | Enable a new trigger type that allows users to run workflows based on messages from a Kafka cluster. | +| 4. AI-enabled assitants | Delivered | Q3 '24 | [Issue 2193](https://github.com/OpenFn/lightning/issues/2193) | LLM based AI assitant that supports users with job writing, debugging and co-piloting their workflow design process. | +| 5. Invite new users as collaborators | Delivered | Q3 '24 | [Issue 1835](https://github.com/OpenFn/lightning/issues/1835) | Invite users who do not have OpenFn accounts to projects as collaborators. | +| 6. Allow users to create projects | Delivered | Q3 '24 | [Issue 1700](https://github.com/OpenFn/Lightning/issues/1700) | All users to create new projects from their dashboard. | +| 7. Allow users to export workorder history | Delivered | Q3 '24 | [Issue 1698](https://github.com/OpenFn/lightning/issues/1698) | Allow project users to be able to export workorder history. The workorder history contains ALL logs and data clips (Input and Output) associated with runs in a workorder. | +| 8. Project datastores and buffers | Shaped | Q4 '24 | [Issue 2190](https://github.com/OpenFn/lightning/issues/2190) | Allow users to configure a data store or buffer that allows temporary of storage of data that can be used in a workflow. | +| 9. Make User Onboarding better | Shaped | Q4 '24 | [Issue 2523](https://github.com/OpenFn/Lightning/issues/2523) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | +| 10. Snapshots and Audit Trail | Shaped | Q4 '24 | [Issue 2526](https://github.com/OpenFn/Lightning/issues/2526) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | +| 11. Implement Monaco Editor | Tracked | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Implement monaco editor for code editor or log viewing across the platform | +| 12. Allow users to switch between sandbox and production modes | Tracked | Q4 '24 | [Issue 2524](https://github.com/OpenFn/Lightning/issues/2524) and [Issue 2525](https://github.com/OpenFn/Lightning/issues/2525) | Allow users to be able to switch between sandbox and production modes in their projects. | +| 13. Control log outputs | Tracked | Q4 '24 | [Issue 1755](https://github.com/OpenFn/Lightning/issues/1755) | Control what is printed in run logs by specifying log levels and allow users to disable printing console.logs, for data privacy once workflows are handling production data. | +| 14. Enable manual workflow triggers | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Add funtionality that allows users to manually trigger workflow with JSON/CSV data as input data clip | +| 15. Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2021](https://github.com/OpenFn/lightning/issues/2021) | Redesign the workflow canvas and inspector interface to make workflow design better to help user build workflow faster and easier. | +| 16. Improved History page filter | Tracked | Q1 '25 | [Issue 1791](https://github.com/OpenFn/lightning/issues/1791) | Extend workorder history page and enable cascading filtering. This is useful for debuging, failure recovery and auditability of the workflow. | +| 17. Enhanced websocket worker Monitoring | Tracked | Q1 '25 | [Issue 608](https://github.com/OpenFn/kit/issues/608) | Give users better visibility of what's happening on inside the worker, especially when an error occurs during run execution. | +| 18. Expanded Audit Trail and Node Authentication (ATNA) functionality | Tracked | Q1 '25 | [Issue 271](https://github.com/OpenFn/Lightning/issues/271) | Extend audit trail functionality to cover more aspects of ATNA, reference [OpenHIE IOL requirement IOLWF-1](https://guides.ohie.org/arch-spec/openhie-component-specifications-1/openhie-interoperability-layer-iol#openhie-iol-workflow-requirements). | _You can follow Lightning's progress and track delivered features in the [Changelog](https://openfn.github.io/lightning/changelog.html)._ @@ -153,18 +152,18 @@ workflow engine, enable automated workflows that cut across digital systems. | 1. Add "magic" functions to existing, in-demand adaptors | Delivered | Q1 2024 | [Issue 243](https://github.com/OpenFn/adaptors/issues/243) | Add functions, dynamic lists, and shortcuts to fast-track workflow configuration for key adaptors including HTTP, [DHIS2](https://dhis2.org/), [CommCare](https://www.dimagi.com/commcare/), & [OpenMRS](https://openmrs.org/) | | 2. New [`OpenMRS`](https://openmrs.org/) adaptor version | Delivered | Q2 2024 | [See existing adaptor docs](/adaptors/packages/openmrs-readme) | To ensure compliance with OpenMRS v3 | | 3. Enhancements to [`FHIR`](http://www.hl7.org/fhir/) & [`OpenHIM`](http://openhim.org/) adaptors | Delivered | Q3 2024 | See existing adaptors for [FHIR](/adaptors/packages/fhir-docs) and [OpenHIM](/adaptors/packages/openhim-docs) | To rebuild the existing 2021 [OpenFn Instant-OpenHIE reference demo](/documentation/get-started/standards#openhie-standard-architecture) to highlight the exchange of data between existing non-FHIR digital health tools and a HAPI FHIR server. (OpenFn Lightning is OpenHIE-compliant and can be used as a workflow engine for the OpenHIE Interoperability layer - [learn more here](/documentation#openfn-v2-lightning-#standards-and-compliance-matter).) We also want to demonstrate data exchange between existing non-FHIR digital health tools and key components of Google’s [Open Health Stack](https://developers.google.com/open-health-stack) and [Cloud Healthcare API](https://cloud.google.com/healthcare-api/docs/concepts/fhir) | -| 4. Enhancements to the [`OCL`](https://openconceptlab.org/) adaptor | Not started | Q4 2024 | [See existing adaptor docs](/adaptors/packages/ocl-readme) | To ensure that mappings stored in OCLs can be more easily access and processed as inputs in OpenFn/Lightning workflows | +| 4. Enhancements to the [`OCL`](https://openconceptlab.org/) adaptor | Tracked | Q4 2024 | [See existing adaptor docs](/adaptors/packages/ocl-readme) | To ensure that mappings stored in OCLs can be more easily access and processed as inputs in OpenFn/Lightning workflows | +| 5. Implement [MOSIP](https://mosip.io/#1) Adaptor | Tracked | Q1 2025 | [Issue 737](https://github.com/OpenFn/adaptors/issues/737) | Enable OpenFn workflows to integrate with the MOSIP platform for identity management use cases across countries. | +| 6. Implement [OpenCRVS](https://www.opencrvs.org/) Adaptor | Tracked | Q1 2025 | [Issue 736](https://github.com/OpenFn/adaptors/issues/736) | Enable OpenFn workflows to integrate with OpenCRVS for CRVS workflows.| +| 7. Implement [ArcGIS](https://www.arcgis.com/) Adaptor | Tracked | Q1 2025 | [Issue 738](https://github.com/OpenFn/adaptors/issues/738) | Enable Geospatial data management in OpenFn Workflows.| +| 8. Support Personal Access Tokens in DHIS2 | Tracked | Q1 2025 | [Issue 697](https://github.com/OpenFn/adaptors/issues/697) | Extend the DHIS2 Adaptor to support Personal Access Tokens (PAT).| ### Docs Roadmap -| **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | -| ----------------------------------------------------------- | ------------ | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 1. OpenFn and the [OpenHIE](https://ohie.org/) architecture | Delivered | 2024 | [See current docs](/documentation#openfn-v2-lightning-#standards-and-compliance-matter) | New page dedicated to how OpenHIE aligns with OpenHIE architecture; expansion of the existing small section on standards | -| 2. New Lightning User Guidance | In dev | 2024 | To be hosted on docs.openfn.org | New documentation, videos, and other user guidance on how to use OpenFn/Lightning and how to migrate existing OpenFn/platform projects to Lightning (the new OpenFn "v2") | -| 3. Template [FHIR](http://www.hl7.org/fhir/) Workflows | Planned | 2024 | To be hosted on demo.openfn.org | OpenFn can already help achieve FHIR compliance, but we will build and document reference/template workflows to demonstrate how OpenFn/Lightning can automate data exchange, registration, and/or reporting workflows between non-FHIR data systems and FHIR APIs. | -| 4. Template Alerting Workflows | Not started | 2024 | [See OpenHIE docs](https://guides.ohie.org/arch-spec/introduction/alerting-sending-reminders-or-information); to be hosted on demo.openfn.org | To demonstrate how OpenFn can facilitate one-way communication to a client or provider listed in the HIE (from the OpenHIE standard spec) | -| 5. Template Shared Health Record Workflows | Not started | 2024 | [See OpenHIE docs](https://guides.ohie.org/arch-spec/introduction/shared-health-record); to be hosted on demo.openfn.org | To demonstrate how OpenFn can allow external systems to automatically save and retrieve information from the HIE (from the OpenHIE standard spec) | -| 6. Template Aggregate Reporting Workflows | Not started | 2024 | [See OpenHIE docs](https://guides.ohie.org/arch-spec/introduction/aggregate-reporting-workflows); to be hosted on demo.openfn.org | To demonstrate how OpenFn can support aggregate data exchange of health indicators, leveraging the [ADX](https://wiki.ihe.net/index.php/Aggregate_Data_Exchange) data standard | +| **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | +| ----------------------------------------------------------- | ------------ | ------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1. OpenFn and the [OpenHIE](https://ohie.org/) architecture | Delivered | 2024 | [See current docs](/documentation#openfn-v2-lightning-#standards-and-compliance-matter) | New page dedicated to how OpenHIE aligns with OpenHIE architecture; expansion of the existing small section on standards | +| 2. New Lightning User Guidance | In Progress | 2024 | To be hosted on docs.openfn.org | New documentation, videos, and other user guidance on how to use OpenFn/Lightning and how to migrate existing OpenFn/platform projects to Lightning (the new OpenFn "v2") | ## Have questions, feedback or found a bug?