From 5c396e396d9d36e3f48ddad4b9c100c39cdb8ca0 Mon Sep 17 00:00:00 2001 From: christad92 Date: Wed, 27 Nov 2024 16:52:54 +0000 Subject: [PATCH 1/5] Updated roadmap for November --- docs/contribute/openfn-roadmap.md | 58 ++++++++++++++----------------- 1 file changed, 26 insertions(+), 32 deletions(-) diff --git a/docs/contribute/openfn-roadmap.md b/docs/contribute/openfn-roadmap.md index e2b49175d205..c145567f62ad 100644 --- a/docs/contribute/openfn-roadmap.md +++ b/docs/contribute/openfn-roadmap.md @@ -116,26 +116,22 @@ 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. 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). | +| **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | +| ---------------------------------------------------- | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1. Project datastores and buffers | Delivered | 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. | +| 2. Make User Onboarding better with resources | Delivered | 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. | +| 3. Snapshots and Audit Trail | In dev | 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. | +| 4. Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | +| 5. Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | +| 6. OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | +| 7. Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | +| 8. Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | +| 9. Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | +| 10. Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | +| 11. Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | +| 12. Enable sandbox and production modes | Tracked | Q1 '25 | [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 output and levels | Tracked | Q1 '25 | [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. 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. | _You can follow Lightning's progress and track delivered features in the [Changelog](https://openfn.github.io/lightning/changelog.html)._ @@ -149,21 +145,19 @@ workflow engine, enable automated workflows that cut across digital systems. | **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | | ------------------------------------------------------------------------------------------------- | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 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 | 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).| +| 1. Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | +| 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 | Tracked | Q1 2025 | [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) | Add an adaptor that enables users to integrate with MOSIP 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) | Add an ARCGIS adaptor for users to build weorkflow that manage data sync between source and online maps with 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 Token(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 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") | +| **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | +| ------------------------------ | ------------ | ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1. 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? From 1b6b8ffc909d2dbb4d6b44c55218a5be22de1bc8 Mon Sep 17 00:00:00 2001 From: christad92 Date: Wed, 27 Nov 2024 17:08:08 +0000 Subject: [PATCH 2/5] Changed copy to reflect community updates --- docs/contribute/openfn-roadmap.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/contribute/openfn-roadmap.md b/docs/contribute/openfn-roadmap.md index c145567f62ad..69a93d5d4ff3 100644 --- a/docs/contribute/openfn-roadmap.md +++ b/docs/contribute/openfn-roadmap.md @@ -13,7 +13,7 @@ progress [here](#what-are-we-currently-working-on). ## Our approach to product development At OpenFn, we follow the [Shape Up approach](https://basecamp.com/shapeup) to -help our small engineering team build _meaningul_ products and features faster +help our small engineering team build _meaningful_ products and features faster without compomising on quality. With Shape Up in place, we typcially commit to _projects_ that can be delivered in a 4-6 week period with multiple releases based on QA approval within the building cycle. We also proiritize feedback and @@ -59,28 +59,31 @@ keep track of all new features, changes, and bug fixes in our ## How to **get involved** -We use [Canny](https://openfn.canny.io/feature-requests) to receive, track, -engage and manage new feature requests from the community of users of OpenFn -globally whilst giving users the ability to the upvote their favoritie and -mission critical feature request. +We collect feedback and new feature requests via our +[Community](https://community.openfn.org/c/feature-requests/) site. This allows +OpenFn core team and users to track, engage by upvoting their favorite and +mission critical feature requests. ### Upvote features πŸ‘ -1. Go to [openfn.canny.io](https://openfn.canny.io/feature-requests) +1. Go to the community + [feature request board](https://community.openfn.org/c/feature-requests/) 2. Scroll down or use the filter and search features to see existing feature requests -3. Click on the (^) beside the request to upvote +3. Click on the (Vote) button beside the title of the request to upvote 4. If you want more upvotes for this feature request, share a link to the feature with your network ### Request a new feature πŸ’‘ -1. Go to [openfn.canny.io](https://openfn.canny.io/feature-requests) -2. Provide a very clear, concise and descriptive title for the feature (e.g., +1. Go to the community + [feature request board](https://community.openfn.org/c/feature-requests/) +2. Click on `+ New Topic` to create a new request. +3. Provide a very clear, concise and descriptive title for the feature (e.g., "Make the new workflow button green") -3. Describe the feature request in detail and why it's important to you -4. Share the feature request on the OpenFn community and across your - professional network for upvotes +4. Describe the feature request in detail and why it's important to you. Helpful + if you can add reference images and links. +5. Share the feature request on across your professional network for upvotes :::info Tip @@ -145,7 +148,7 @@ workflow engine, enable automated workflows that cut across digital systems. | **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | | ------------------------------------------------------------------------------------------------- | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | +| 1. Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | | 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 | Tracked | Q1 2025 | [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) | Add an adaptor that enables users to integrate with MOSIP for identity management use cases across countries. | From ae69245905f4a50c36ead6e6d9aef1771aa23eb7 Mon Sep 17 00:00:00 2001 From: christad92 Date: Thu, 28 Nov 2024 08:55:09 +0000 Subject: [PATCH 3/5] Added q3 features --- docs/contribute/openfn-roadmap.md | 39 +++++++++++++++++-------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/docs/contribute/openfn-roadmap.md b/docs/contribute/openfn-roadmap.md index 69a93d5d4ff3..a0eead0a479a 100644 --- a/docs/contribute/openfn-roadmap.md +++ b/docs/contribute/openfn-roadmap.md @@ -119,22 +119,27 @@ 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. Project datastores and buffers | Delivered | 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. | -| 2. Make User Onboarding better with resources | Delivered | 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. | -| 3. Snapshots and Audit Trail | In dev | 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. | -| 4. Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | -| 5. Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | -| 6. OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | -| 7. Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | -| 8. Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | -| 9. Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | -| 10. Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | -| 11. Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | -| 12. Enable sandbox and production modes | Tracked | Q1 '25 | [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 output and levels | Tracked | Q1 '25 | [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. 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. | +| **Feature** | **Status** | **Target Timeline** | **Related Links** | **Description** | +| ----------------------------------------------------- | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1.Workflow snapshots | 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.Configurable run concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2002) | Allow users to control the limit of concurrent runs per workflow in a project. | +| 3.Kafka workflow trigger | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | A new workflow trigger type that creates a new workorder when a Kafka message is received . | +| 4. Allow users to create new projects | Delivered | Q3 '24 | [Issue 1700](https://github.com/OpenFn/lightning/issues/1700) | Allow users to create new projects from the project list page. | +| 4. Export work order history with logs and data clips | 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. | +| 5. Project datastores and buffers | Delivered | 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. | +| 6. Make User Onboarding better with resources | Delivered | 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. | +| 7. Snapshots and Audit Trail | In dev | 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. | +| 8. Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | +| 9. Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | +| 10. OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | +| 11. Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | +| 12. Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | +| 13. Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | +| 14. Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | +| 15. Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | +| 16. Enable sandbox and production modes | Tracked | Q1 '25 | [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. | +| 17. Control log output and levels | Tracked | Q1 '25 | [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. | +| 18. 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. | _You can follow Lightning's progress and track delivered features in the [Changelog](https://openfn.github.io/lightning/changelog.html)._ @@ -160,7 +165,7 @@ workflow engine, enable automated workflows that cut across digital systems. | **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | | ------------------------------ | ------------ | ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. 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") | +| 1. New Lightning User Guidance | In Progress | 2025 | 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? From c932dafdd916c57b72412bea594f1f5c01dedc01 Mon Sep 17 00:00:00 2001 From: christad92 Date: Thu, 28 Nov 2024 08:56:06 +0000 Subject: [PATCH 4/5] minot fix with prettier --- docs/contribute/openfn-roadmap.md | 64 +++++++++++++++---------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/contribute/openfn-roadmap.md b/docs/contribute/openfn-roadmap.md index a0eead0a479a..b8c2a982025e 100644 --- a/docs/contribute/openfn-roadmap.md +++ b/docs/contribute/openfn-roadmap.md @@ -120,26 +120,26 @@ 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.Workflow snapshots | 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.Configurable run concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2002) | Allow users to control the limit of concurrent runs per workflow in a project. | -| 3.Kafka workflow trigger | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | A new workflow trigger type that creates a new workorder when a Kafka message is received . | -| 4. Allow users to create new projects | Delivered | Q3 '24 | [Issue 1700](https://github.com/OpenFn/lightning/issues/1700) | Allow users to create new projects from the project list page. | -| 4. Export work order history with logs and data clips | 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. | -| 5. Project datastores and buffers | Delivered | 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. | -| 6. Make User Onboarding better with resources | Delivered | 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. | -| 7. Snapshots and Audit Trail | In dev | 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. | -| 8. Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | -| 9. Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | -| 10. OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | -| 11. Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | -| 12. Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | -| 13. Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | -| 14. Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | -| 15. Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | -| 16. Enable sandbox and production modes | Tracked | Q1 '25 | [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. | -| 17. Control log output and levels | Tracked | Q1 '25 | [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. | -| 18. 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. | +| ----------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1.Workflow snapshots | 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.Configurable run concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2002) | Allow users to control the limit of concurrent runs per workflow in a project. | +| 3.Kafka workflow trigger | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | A new workflow trigger type that creates a new workorder when a Kafka message is received . | +| 4. Allow users to create new projects | Delivered | Q3 '24 | [Issue 1700](https://github.com/OpenFn/lightning/issues/1700) | Allow users to create new projects from the project list page. | +| 4. Export work order history with logs and data clips | 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. | +| 5. Project datastores and buffers | Delivered | 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. | +| 6. Make User Onboarding better with resources | Delivered | 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. | +| 7. Snapshots and Audit Trail | In dev | 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. | +| 8. Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | +| 9. Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | +| 10. OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | +| 11. Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | +| 12. Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | +| 13. Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | +| 14. Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | +| 15. Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | +| 16. Enable sandbox and production modes | Tracked | Q1 '25 | [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. | +| 17. Control log output and levels | Tracked | Q1 '25 | [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. | +| 18. 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. | _You can follow Lightning's progress and track delivered features in the [Changelog](https://openfn.github.io/lightning/changelog.html)._ @@ -151,21 +151,21 @@ databases, and even raw data files, enabling interoperability with any information system ([read more](/adaptors/)). Adaptors, alongside OpenFn's workflow engine, enable automated workflows that cut across digital systems. -| **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | -| ------------------------------------------------------------------------------------------------- | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | -| 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 | Tracked | Q1 2025 | [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) | Add an adaptor that enables users to integrate with MOSIP 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) | Add an ARCGIS adaptor for users to build weorkflow that manage data sync between source and online maps with 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 Token(PAT). | +| **Feature** | **Status** | **Target Timeline** | **Related Links** | **Description** | +| ------------------------------------------------------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1. Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | +| 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 | Tracked | Q1 2025 | [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) | Add an adaptor that enables users to integrate with MOSIP 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) | Add an ARCGIS adaptor for users to build weorkflow that manage data sync between source and online maps with 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 Token(PAT). | ### Docs Roadmap -| **Feature** | **`Status`** | **Target Timeline** | **Related Links** | **Description** | -| ------------------------------ | ------------ | ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. New Lightning User Guidance | In Progress | 2025 | 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") | +| **Feature** | **Status** | **Target Timeline** | **Related Links** | **Description** | +| ------------------------------ | ----------- | ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1. New Lightning User Guidance | In Progress | 2025 | 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? From 77a39ab991dfde991a2f903784dc222ae7478623 Mon Sep 17 00:00:00 2001 From: Taylor Downs Date: Fri, 29 Nov 2024 15:36:23 +0000 Subject: [PATCH 5/5] remove numbers --- docs/contribute/openfn-roadmap.md | 73 +++++++++++++++---------------- 1 file changed, 35 insertions(+), 38 deletions(-) diff --git a/docs/contribute/openfn-roadmap.md b/docs/contribute/openfn-roadmap.md index b8c2a982025e..4bb21dbb8127 100644 --- a/docs/contribute/openfn-roadmap.md +++ b/docs/contribute/openfn-roadmap.md @@ -46,15 +46,12 @@ immediate roadmap. ### See [**_Now_**](https://github.com/orgs/OpenFn/projects/3/views/1) 🚧 for what's been funded and is currently being built -### See [**_Next_**](https://github.com/orgs/OpenFn/projects/3/views/2) πŸ“ for what's being shaped and _may_ be funded in the next cycle - ### See [**_Epics_**](https://github.com/orgs/OpenFn/projects/3/views/7) πŸ€” for a list of projects that we're considering, roughly-prioritized ### See [**_Bugs_**](https://github.com/orgs/OpenFn/projects/3/views/22) 🐞 for reported bugs -We will update this site periodically (ideally after each cycle, typically -lasting between 2-6 weeks) to reflect our progress on major items. You can also -keep track of all new features, changes, and bug fixes in our +We will update this site monthly to reflect our progress on major items. You can +also keep track of all new features, changes, and bug fixes in real-time via our [Changelog](https://openfn.github.io/lightning/changelog.html). ## How to **get involved** @@ -119,27 +116,27 @@ 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.Workflow snapshots | 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.Configurable run concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2002) | Allow users to control the limit of concurrent runs per workflow in a project. | -| 3.Kafka workflow trigger | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | A new workflow trigger type that creates a new workorder when a Kafka message is received . | -| 4. Allow users to create new projects | Delivered | Q3 '24 | [Issue 1700](https://github.com/OpenFn/lightning/issues/1700) | Allow users to create new projects from the project list page. | -| 4. Export work order history with logs and data clips | 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. | -| 5. Project datastores and buffers | Delivered | 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. | -| 6. Make User Onboarding better with resources | Delivered | 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. | -| 7. Snapshots and Audit Trail | In dev | 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. | -| 8. Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | -| 9. Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | -| 10. OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | -| 11. Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | -| 12. Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | -| 13. Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | -| 14. Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | -| 15. Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | -| 16. Enable sandbox and production modes | Tracked | Q1 '25 | [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. | -| 17. Control log output and levels | Tracked | Q1 '25 | [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. | -| 18. 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. | +| **Feature** | **Status** | **Timeline** | **Link(s)** | **Description** | +| ---------------------------------------------------- | ---------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| β€’ Workflow snapshots | 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. | +| β€’ Configurable run concurrency by workflow | Delivered | Q3 '24 | [Issue 2002](https://github.com/OpenFn/lightning/issues/2002) | Allow users to control the limit of concurrent runs per workflow in a project. | +| β€’ Kafka workflow trigger | Delivered | Q3 '24 | [Issue 1801](https://github.com/OpenFn/lightning/issues/1801) | A new workflow trigger type that creates a new workorder when a Kafka message is received . | +| β€’ Allow users to create new projects | Delivered | Q3 '24 | [Issue 1700](https://github.com/OpenFn/lightning/issues/1700) | Allow users to create new projects from the project list page. | +| β€’ Export work order history with logs and data clips | 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. | +| β€’ Project datastores and buffers | Delivered | 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. | +| β€’ Make User Onboarding better with resources | Delivered | 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. | +| β€’ Snapshots and Audit Trail | In dev | 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. | +| β€’ Enable Save and Sync on Canvas and Inspector | In dev | Q4 '24 | [Issue 2707](https://github.com/OpenFn/lightning/issues/2707) | Make version control more accessible to user by allowing users to save and sync their changes to GitHub via the canvas and inspector. | +| β€’ Make AI Assistant available for all users | In dev | Q4 '24 | [Issue 2613](https://github.com/OpenFn/lightning/issues/2613) | Add AI Assistant to help users build workflows faster and easier. | +| β€’ OpenFn Workflow JSON APIs | Shaped | Q4 '24 | [Issue 2126](https://github.com/OpenFn/Lightning/issues/2126) | Expose API endpoints that allows developers to interact with OpenFn from other platforms or within jobs. e.g create a new workflow with the jobs given a JSON payload. | +| β€’ Manual Runs for Cron jobs | Shaped | Q4 '24 | [Issue 1880](https://github.com/OpenFn/Lightning/issues/1880) | Allow users to manually run cron triggered workflows with a custom cursor and run now button. | +| β€’ Workflow library | Tracked | Q1 '25 | [Issue 2723](https://github.com/OpenFn/lightning/issues/2723) | Create a library of common workflows that users can easily access and clone for use in their projects. | +| β€’ Load local adaptors into lightning | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Enable lightning to use local adaptors to allow developers quickly test adaptors locally without deploying to npm | +| β€’ Allow custom inputs for manual runs | Tracked | Q1 '25 | [Issue 2155](https://github.com/OpenFn/lightning/issues/2155) | Users should be able to trigger a manual run with a custom input data. The input data can a raw JSON, CSV, I/O data clip or dataset from project collections | +| β€’ Redesign workflow canvas and inspector interface | Tracked | Q1 '25 | [Issue 2722](https://github.com/OpenFn/lightning/issues/2722) | Redesign the canvas and inspector to make user experience and workflow building better for users. | +| β€’ Enable sandbox and production modes | Tracked | Q1 '25 | [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. | +| β€’ Control log output and levels | Tracked | Q1 '25 | [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. | +| β€’ 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. | _You can follow Lightning's progress and track delivered features in the [Changelog](https://openfn.github.io/lightning/changelog.html)._ @@ -151,21 +148,21 @@ databases, and even raw data files, enabling interoperability with any information system ([read more](/adaptors/)). Adaptors, alongside OpenFn's workflow engine, enable automated workflows that cut across digital systems. -| **Feature** | **Status** | **Target Timeline** | **Related Links** | **Description** | -| ------------------------------------------------------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | -| 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 | Tracked | Q1 2025 | [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) | Add an adaptor that enables users to integrate with MOSIP 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) | Add an ARCGIS adaptor for users to build weorkflow that manage data sync between source and online maps with 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 Token(PAT). | +| **Feature** | **Status** | **Timeline** | **Link(s)** | **Description** | +| ------------------------------------------------------------------------------------------------ | ---------- | ------------ | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| β€’ Develop an [`OpenLMIS`](https://openlims.org/) adaptor | Delivered | Q3 2024 | [Issue 533](https://github.com/OpenFn/adaptors/issues/533) | Enable users to build workflows that interface with OpenLIMS | +| β€’ 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) | +| β€’ Enhancements to the [`OCL`](https://openconceptlab.org/) adaptor | Tracked | Q1 2025 | [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 | +| β€’ Implement [MOSIP](https://mosip.io/#1) Adaptor | Tracked | Q1 2025 | [Issue 737](https://github.com/OpenFn/adaptors/issues/737) | Add an adaptor that enables users to integrate with MOSIP for identity management use cases across countries. | +| β€’ 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. | +| β€’ Implement [ArcGIS](https://www.arcgis.com/) Adaptor | Tracked | Q1 2025 | [Issue 738](https://github.com/OpenFn/adaptors/issues/738) | Add an ARCGIS adaptor for users to build weorkflow that manage data sync between source and online maps with OpenFn Workflows. | +| β€’ 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 Token(PAT). | ### Docs Roadmap -| **Feature** | **Status** | **Target Timeline** | **Related Links** | **Description** | -| ------------------------------ | ----------- | ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. New Lightning User Guidance | In Progress | 2025 | 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") | +| **Feature** | **Status** | **Timeline** | **Link(s)** | **Description** | +| ----------------------------- | ----------- | ------------ | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| β€’ New Lightning User Guidance | In Progress | 2025 | 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?