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. :::