Skip to content

Commit bb86fea

Browse files
authored
Merge pull request #129 from msupply-foundation/import-cce
Import cce
2 parents ccd8705 + 217ad58 commit bb86fea

6 files changed

Lines changed: 71 additions & 24 deletions

File tree

content/docs/catalogue/assets.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,10 @@ To add a filter to the page, choose the required filter from the drop down. Mult
5959

6060
![Asset filter](/docs/catalogue/images/assets_filter.png)
6161

62-
#### Delete Assets
63-
64-
Assets can be selected and deleted using the toolbar action if you are on the [Open mSupply Central Server](/docs/getting_started/central):
65-
66-
![Assets delete](/docs/catalogue/images/assets_delete.png)
67-
6862
### Importing And Exporting
6963

64+
Importing and deleting of asset catalogue items can only be done on the [Open mSupply Central Server](/docs/getting_started/central).
65+
7066
#### Import
7167

7268
Assets can be imported from a comma-separated-file (csv) file using the `Import` button.
@@ -91,9 +87,15 @@ A list of assets can be exported as a csv file using the `Export` button.
9187

9288
![Assets nav](/docs/catalogue/images/asset_export_button.png)
9389

90+
#### Delete
91+
92+
On the Open mSupply Central Server, there is the option to select and delete asset catalogue items using the toolbar action:
93+
94+
![Assets delete](/docs/catalogue/images/assets_delete.png)
95+
9496
### Managing status log reasons
9597

96-
<div class="note">Status log reasons are managed from the Open mSupply central server. <a href="/docs/getting_started/central">Click here to find out out more</a>.</div>
98+
<div class="note">Status log reasons are managed from the <a href="/docs/getting_started/central">Open mSupply central server</a>.</div>
9799

98100
When users add a new status log against a particular asset, more detail can be provided with a reason associated with the new status. For example, an asset which has been labled `NON_FUNCTIONING` could be assigned a reason of `power supply broken`. These reasons are customisable, and associated with a particular status.
99101

-11.7 KB
Loading

content/docs/coldchain/equipment.md

Lines changed: 62 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -82,34 +82,70 @@ template which can be used to import assets.
8282

8383
![](/docs/coldchain/images/equipment_import_modal.png)
8484

85-
When importing assets from a store, they will be assigned to that store.
85+
Assets are automatically assigned to the logged in store.
8686

87-
<!--
88-
TODO: Add link to central server docs when they are created
89-
-->
90-
91-
When importing assets on the central server, an additional field of `store` will be required which will assign assets to their respective stores.
87+
This differs when importing assets on the Open mSupply Central Server - an additional field of `Store` will be required to assign assets to their respective stores.
9288

9389
Information will need to be entered in the format provided by the csv template in order for Open mSupply to be able to process and upload this data.
9490

95-
| Column | Description | Example | Mandatory |
96-
| :---------------------- | :--------------------------------------------------------------- | :----------------- | :---------------- |
97-
| **Asset Number** | The asset number assigned by the user's organisation | 1 | \* |
98-
| **Catalogue item code** | The Asset Catalogue code - i.e. the kind of asset to be imported | E003/002 | \* |
99-
| **Store** | The code of the Store to which the asset is to be assigned | CMS | \* (central only) |
100-
| **Notes** | General notes about the asset | Kept in EPI office | |
101-
| **Serial Number** | The serial number of that particular asset | 123456789ABC | |
102-
| **Installation date** | The date that the asset was installed at the Store | 2024-01-14 | |
103-
104-
A csv file can be uploaded once it has been created in the example format.
91+
| Column | Description | Example | Mandatory |
92+
| :---------------------- | :----------------------------------------------------------------------------------------- | :------------------------- | :----------------------------- |
93+
| **Store** | The code of the Store to which the asset is to be assigned | CMS | \* (Open mSupply Central only) |
94+
| **Asset Number** | The asset number assigned by the user's organisation | 1 | \* |
95+
| **Catalogue item code** | The [Asset Catalogue code](/docs/catalogue/assets) - i.e. the kind of asset to be imported | E003/002 | \* |
96+
| **Installation date** | The date that the asset was installed at the Store | 14/01/2024 | |
97+
| **Replacement due** | The date that the asset is due for replacement | 14/01/2026 | |
98+
| **Warranty start** | The start date of the asset's warranty | 14/01/2024 | |
99+
| **Warranty end** | The end date of the asset's warranty | 14/01/2025 | |
100+
| **Serial Number** | The serial number of that particular asset | 123456789ABC | |
101+
| **Status** | The asset's [functional status](#status-history) | Functional | |
102+
| **Needs replacement** | Whether the asset needs replacing | TRUE | |
103+
| **Notes** | General notes about the asset | Kept in EPI office | |
104+
| **Asset properties** | Many columns may be also be available here for configured asset properties | energy_source: Electricity | |
105+
106+
When you are ready, drag and drop the csv file into the modal or click on the `Browse files` button to select the file from your computer.
105107

106108
<p align="center">
107109
<img src="/docs/coldchain/images/equipment_import_upload.png" width="750" height="420">
108110
</p>
109111

112+
#### If things go wrong
113+
114+
Sometimes errors occur when importing CCE assets. Here are some common errors you might encounter:
115+
116+
##### Upload Errors
117+
118+
After uploading your CSV file, your data will be validated and displayed to you to review. At this step, if the data in your uploaded file is not valid, you will see an error message and won't be able to continue to the import step.
119+
120+
![](/docs/coldchain/images/cce_import_error.png)
121+
122+
Common mistakes here are uploading a file type other than CSV, or if you included some duplicate asset numbers in your file. You'll see these errors in the `Error message` column.
123+
124+
You can use the `Export` button at the bottom of the upload window to download a CSV file which includes the error messages, to investigate what went wrong.
125+
126+
Once you have corrected the errors, you can go back to the `Upload` tab to upload the corrected file.
127+
128+
##### Upload Warnings
129+
130+
If certain data is missing or incorrect (such as the installation date and other date columns) you'll see a warning message rather than an error. This is because the asset can still be created without these date fields, but it's recommended to include them.
131+
132+
![](/docs/coldchain/images/cce_import_warning.png)
133+
134+
There will be a `Warning` column, which will alert you to which fields are missing or incorrect. You can still proceed with the import with this missing data if you wish.
135+
136+
<div class="note">Sometimes spreadsheet software can reformat dates, into a format we can't process. If your dates are missing on import, check your CSV file and ensure the dates are in DD/MM/YYYY format!</div>
137+
138+
##### Import Errors
139+
140+
The import step is where the new cold chain assets are actually created in the system. If there are any errors at this step, you'll see a message like this:
141+
142+
![](/docs/coldchain/images/cce_failed_to_import.png)
143+
144+
This usually happens when you have an asset in your import file which has the same asset number as an existing asset. You'll see the error message in the `Error message` column. Again, you can export a CSV file with the error messages to investigate what went wrong.
145+
110146
#### Export
111147

112-
A list of assets can be exported as a csv using the `Export` button.
148+
A list of existing assets can be exported as a csv using the `Export` button.
113149

114150
<p align="center">
115151
<img src="/docs/distribution/images/export.png" width="150" height="67">
@@ -187,6 +223,15 @@ The `Details` tab shows the asset properties.
187223

188224
The `Status History` tab shows the history of the functional status of the asset.
189225

226+
Available functional statuses are:
227+
228+
- Functioning
229+
- Functioning but needs attention
230+
- Not functioning
231+
- Not in use
232+
- Unserviceable
233+
- Decommissioned
234+
190235
![Asset logs tab](/docs/coldchain/images/status_logs_tab.png)
191236

192237
#### Documents
95.3 KB
Loading
122 KB
Loading
84.1 KB
Loading

0 commit comments

Comments
 (0)