From 327fb630bbc48d41c92fd72e085d9803531c9d78 Mon Sep 17 00:00:00 2001 From: Rita Zagoni Date: Tue, 24 Sep 2024 11:38:38 +0200 Subject: [PATCH 1/7] edits --- docs/manage-projects/io-data-storage.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/docs/manage-projects/io-data-storage.md b/docs/manage-projects/io-data-storage.md index 113ad9d6b81..fb6eda9b91a 100644 --- a/docs/manage-projects/io-data-storage.md +++ b/docs/manage-projects/io-data-storage.md @@ -6,20 +6,13 @@ In the "Data Storage" section of your Project `Settings`, you can configure what you'd like OpenFn to do with the actual _data_ (`Inputs` and `Outputs`) that are processed (or produced) by your workflow runs. -Users may configure OpenFn to temporarily store data (e.g., forms fetched from -CommCare mobile app) so that transactions can be easily troubleshot and -rectified in case of errors (e.g., destination DHIS2 system is down, or a -database constraint/validation blocks a data import). Data retention periods -have a default time period set by the OpenFn super admin, but can be modified -according to a specific project's requirements. - ### Why would I store input/output data along with run logs? Users may configure OpenFn to temporarily store data (e.g., forms fetched from CommCare mobile app) so that transactions can be easily troubleshooted and rectified in case of errors (e.g., destination DHIS2 system is down, or a database constraint/validation blocks a data import). Data retention periods -have a default time period set by the OpenFn super admin, but can be modified +have a default time period set by the OpenFn instance administrator, but can be modified according to a specific project's requirements. One of the most powerful features of the platform is the ability to "replay" @@ -52,16 +45,16 @@ pipelines. ### Export History -Users can also export all work orders and their associated artefacts (runs, -steps, runsteps, input and output data clips) in a project. Work order +Users can also export all Work Orders and their associated artefacts (runs, +steps, runsteps, input and output data clips) in a project. Work Order history export is managed at a project level and available to all collaborators (viewer, editor, admin, owner) in a project. -#### How to export work order history +#### How to export Work Order history To export Work Order history for your project, open the project and click on `History` on the side menu. On the History page, scroll to the bottom of the -work order history table and click on the cloud icon (see image below). +Work Order history table and click on the cloud icon (see image below). ![History Page](/img/history_page_cloud.png) @@ -77,7 +70,7 @@ email address. For local deployments, OpenFn uses Swoosh as a mailbox service for development purposes and can access the mailbox via http://localhost:4000/dev/mailbox. You -can substitute localhost:4000 to match the port hsoting your OpenFn instance. +can substitute localhost:4000 to match the port hosting your OpenFn instance. ::: @@ -85,7 +78,7 @@ can substitute localhost:4000 to match the port hsoting your OpenFn instance. Users can view all history exports via the `History Exports` page in the project settings. Click on `Settings` on the side menu and click on -`History Exports` to see the list of work order exports in your project. +`History Exports` to see the list of Work Order exports in your project. On the `History Export`s page, you will see the list of exports showing your latest request and previous requests with the other information such as @@ -95,7 +88,7 @@ filename, date of export, user who requested the export and the status. :::caution Configuring storage for exports -OpenFn instance administrators can configure the storage for work order exports for +OpenFn instance administrators can configure the storage for Work Order exports for local deployments. OpenFn currently supports local storage and Google Cloud Storage as destinations for exporting work orders. From bcf3f73047848c298ad842ef352ccf2ebf4e8bf6 Mon Sep 17 00:00:00 2001 From: Rita Zagoni Date: Tue, 24 Sep 2024 11:49:15 +0200 Subject: [PATCH 2/7] clarify history export --- docs/manage-projects/retention-periods.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/manage-projects/retention-periods.md b/docs/manage-projects/retention-periods.md index b5dec471217..f81ad07622c 100644 --- a/docs/manage-projects/retention-periods.md +++ b/docs/manage-projects/retention-periods.md @@ -25,6 +25,7 @@ month or 90-days) to reduce data storage costs or to limit their data footprint. ### What happens when old work orders, runs, logs, or dataclips get removed? -If you've configured any automatic data exports or archiving, you can still -access your history in those CSVs, but all history will be removed from the -OpenFn platform. +You can +[export your work order history and associated data](https://docs.openfn.org/documentation/manage-projects/io-data-storage?_gl=1*1x5ctqh*_gcl_au*MTE3Njc2MDkyMC4xNzI0MjQzMTAwLjY0NTI0ODAyMC4xNzI3MTY5OTM5LjE3MjcxNjk5NDA.#export-history) +and you'll still be able to access your history in those CSVs, but all history +will be removed from the OpenFn platform, and no new history will be saved. From b781738cde7a4f83dba4726c1585558b65f19fd9 Mon Sep 17 00:00:00 2001 From: Ayodele Adeyemo Date: Tue, 24 Sep 2024 16:07:08 +0100 Subject: [PATCH 3/7] Update retention-periods.md Added some more context --- docs/manage-projects/retention-periods.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/manage-projects/retention-periods.md b/docs/manage-projects/retention-periods.md index f81ad07622c..f2928abdab7 100644 --- a/docs/manage-projects/retention-periods.md +++ b/docs/manage-projects/retention-periods.md @@ -25,7 +25,6 @@ month or 90-days) to reduce data storage costs or to limit their data footprint. ### What happens when old work orders, runs, logs, or dataclips get removed? -You can -[export your work order history and associated data](https://docs.openfn.org/documentation/manage-projects/io-data-storage?_gl=1*1x5ctqh*_gcl_au*MTE3Njc2MDkyMC4xNzI0MjQzMTAwLjY0NTI0ODAyMC4xNzI3MTY5OTM5LjE3MjcxNjk5NDA.#export-history) -and you'll still be able to access your history in those CSVs, but all history -will be removed from the OpenFn platform, and no new history will be saved. +All history is removed from OpenFn and cannot be accessible on the platform. If you have previously +requested [work order history exports,](https://docs.openfn.org/documentation/manage-projects/io-data-storage?_gl=1*1x5ctqh*_gcl_au*MTE3Njc2MDkyMC4xNzI0MjQzMTAwLjY0NTI0ODAyMC4xNzI3MTY5OTM5LjE3MjcxNjk5NDA.#export-history) +you'll still be able to access exported CSVs via the history export page in project settings. From fa565ba56e0156312fba139e8ae0e8358e338af0 Mon Sep 17 00:00:00 2001 From: christad92 Date: Tue, 24 Sep 2024 16:10:27 +0100 Subject: [PATCH 4/7] Added prettier --- docs/manage-projects/retention-periods.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/manage-projects/retention-periods.md b/docs/manage-projects/retention-periods.md index f2928abdab7..859fab4aaeb 100644 --- a/docs/manage-projects/retention-periods.md +++ b/docs/manage-projects/retention-periods.md @@ -25,6 +25,8 @@ month or 90-days) to reduce data storage costs or to limit their data footprint. ### What happens when old work orders, runs, logs, or dataclips get removed? -All history is removed from OpenFn and cannot be accessible on the platform. If you have previously -requested [work order history exports,](https://docs.openfn.org/documentation/manage-projects/io-data-storage?_gl=1*1x5ctqh*_gcl_au*MTE3Njc2MDkyMC4xNzI0MjQzMTAwLjY0NTI0ODAyMC4xNzI3MTY5OTM5LjE3MjcxNjk5NDA.#export-history) -you'll still be able to access exported CSVs via the history export page in project settings. +All history is removed from OpenFn and cannot be accessible on the platform. If +you have previously requested +[work order history exports,](https://docs.openfn.org/documentation/manage-projects/io-data-storage?_gl=1*1x5ctqh*_gcl_au*MTE3Njc2MDkyMC4xNzI0MjQzMTAwLjY0NTI0ODAyMC4xNzI3MTY5OTM5LjE3MjcxNjk5NDA.#export-history) +you'll still be able to access exported CSVs via the history export page in +project settings. From 85f23ffc7ad898acf2abc1d11da8f6c3d15864b2 Mon Sep 17 00:00:00 2001 From: christad92 Date: Tue, 24 Sep 2024 16:17:03 +0100 Subject: [PATCH 5/7] Added prettier and fixed cases --- docs/manage-projects/io-data-storage.md | 36 ++++++++++++------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/manage-projects/io-data-storage.md b/docs/manage-projects/io-data-storage.md index fb6eda9b91a..3549c1dae0e 100644 --- a/docs/manage-projects/io-data-storage.md +++ b/docs/manage-projects/io-data-storage.md @@ -12,16 +12,16 @@ Users may configure OpenFn to temporarily store data (e.g., forms fetched from CommCare mobile app) so that transactions can be easily troubleshooted and rectified in case of errors (e.g., destination DHIS2 system is down, or a database constraint/validation blocks a data import). Data retention periods -have a default time period set by the OpenFn instance administrator, but can be modified -according to a specific project's requirements. +have a default time period set by the OpenFn instance administrator, but can be +modified according to a specific project's requirements. One of the most powerful features of the platform is the ability to "replay" -Work Orders. In the scenario where you have a multi-step workflow (e.g., get +work orders. In the scenario where you have a multi-step workflow (e.g., get data from Database, transform & map the data, and import to your Health Information System), this temporary data storage allows OpenFn administrators to -quickly troubleshoot failed Work Orders and "re-try" the workflow from the +quickly troubleshoot failed work orders and "re-try" the workflow from the failed step, rather than re-running the workflow from the very beginning. This -allows administrators to reprocess the failed Work Orders without having to +allows administrators to reprocess the failed work orders without having to fetch (or re-send) the data (Inputs) from a source system. ### Why would I chose to _NOT_ store input/output data? @@ -45,16 +45,16 @@ pipelines. ### Export History -Users can also export all Work Orders and their associated artefacts (runs, -steps, runsteps, input and output data clips) in a project. Work Order -history export is managed at a project level and available to all collaborators (viewer, +Users can also export all work orders and their associated artefacts (runs, +steps, runsteps, input and output data clips) in a project. Work Order history +export is managed at a project level and available to all collaborators (viewer, editor, admin, owner) in a project. -#### How to export Work Order history +#### How to export work order history -To export Work Order history for your project, open the project and click on +To export work order history for your project, open the project and click on `History` on the side menu. On the History page, scroll to the bottom of the -Work Order history table and click on the cloud icon (see image below). +work order history table and click on the cloud icon (see image below). ![History Page](/img/history_page_cloud.png) @@ -63,8 +63,8 @@ If confirmed, a background process will be initiated for the export. ![Confirm export](/img/confirm_export.png) -When the export is complete, an email will be sent to your OpenFn user's associated -email address. +When the export is complete, an email will be sent to your OpenFn user's +associated email address. :::info FOR LOCAL DEPLOYMENTS @@ -76,9 +76,9 @@ can substitute localhost:4000 to match the port hosting your OpenFn instance. #### Managing Exports -Users can view all history exports via the `History Exports` -page in the project settings. Click on `Settings` on the side menu and click on -`History Exports` to see the list of Work Order exports in your project. +Users can view all history exports via the `History Exports` page in the project +settings. Click on `Settings` on the side menu and click on `History Exports` to +see the list of work order exports in your project. On the `History Export`s page, you will see the list of exports showing your latest request and previous requests with the other information such as @@ -88,8 +88,8 @@ filename, date of export, user who requested the export and the status. :::caution Configuring storage for exports -OpenFn instance administrators can configure the storage for Work Order exports for -local deployments. OpenFn currently supports local storage and Google Cloud +OpenFn instance administrators can configure the storage for work order exports +for local deployments. OpenFn currently supports local storage and Google Cloud Storage as destinations for exporting work orders. ::: From ffdf9d092c0494316a5bb10b90bf12af2cdae2c3 Mon Sep 17 00:00:00 2001 From: christad92 Date: Tue, 24 Sep 2024 16:18:13 +0100 Subject: [PATCH 6/7] fixed cases --- docs/manage-projects/io-data-storage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manage-projects/io-data-storage.md b/docs/manage-projects/io-data-storage.md index 3549c1dae0e..a249347567c 100644 --- a/docs/manage-projects/io-data-storage.md +++ b/docs/manage-projects/io-data-storage.md @@ -46,7 +46,7 @@ pipelines. ### Export History Users can also export all work orders and their associated artefacts (runs, -steps, runsteps, input and output data clips) in a project. Work Order history +steps, runsteps, input and output data clips) in a project. Work order history export is managed at a project level and available to all collaborators (viewer, editor, admin, owner) in a project. From 35a56329298d8bed99686baa4b02e3abc3223c3b Mon Sep 17 00:00:00 2001 From: Aleksa Krolls Date: Wed, 25 Sep 2024 17:33:30 +0300 Subject: [PATCH 7/7] update link path --- docs/manage-projects/retention-periods.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manage-projects/retention-periods.md b/docs/manage-projects/retention-periods.md index 859fab4aaeb..a10af2444bc 100644 --- a/docs/manage-projects/retention-periods.md +++ b/docs/manage-projects/retention-periods.md @@ -27,6 +27,6 @@ month or 90-days) to reduce data storage costs or to limit their data footprint. All history is removed from OpenFn and cannot be accessible on the platform. If you have previously requested -[work order history exports,](https://docs.openfn.org/documentation/manage-projects/io-data-storage?_gl=1*1x5ctqh*_gcl_au*MTE3Njc2MDkyMC4xNzI0MjQzMTAwLjY0NTI0ODAyMC4xNzI3MTY5OTM5LjE3MjcxNjk5NDA.#export-history) +[work order history exports,](/documentation/manage-projects/io-data-storage?_gl=1*1x5ctqh*_gcl_au*MTE3Njc2MDkyMC4xNzI0MjQzMTAwLjY0NTI0ODAyMC4xNzI3MTY5OTM5LjE3MjcxNjk5NDA.#export-history) you'll still be able to access exported CSVs via the history export page in project settings.