Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/configuration/images/ER_DE/image1.png
Binary file not shown.
Binary file removed content/configuration/images/ER_DE/image10.png
Binary file not shown.
Binary file removed content/configuration/images/ER_DE/image11.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image12.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image13.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image14.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image15.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image16.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image17.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image18.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image19.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image2.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image20.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image21.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image22.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image23.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image24.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image25.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image26.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image27.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image28.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image29.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image3.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image30.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image31.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image32.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image33.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image34.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image35.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image36.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image37.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image38.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image39.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image4.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image40.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image41.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image42.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image43.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image44.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image45.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image5.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image6.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image7.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image8.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE/image9.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image1.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image10.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image12.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image13.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image14.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image15.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image17.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image18.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image19.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image2.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image22.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image23.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image24.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image25.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image26.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image28.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image29.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image3.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image30.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image31.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image34.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image35.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image36.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image45.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image6.png
Diff not rendered.
Binary file removed content/configuration/images/ER_DE2/image9.png
Diff not rendered.
376 changes: 177 additions & 199 deletions content/configuration/transition_kit_de.md

Large diffs are not rendered by default.

208 changes: 208 additions & 0 deletions content/configuration/transition_kit_maintenance_to_mm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
# Transition Kit - Maintenance app to the Metadata Management app { #mmchg_whats_changed }

## Who is this transition kit for? { #mmchg_audience }

If you configure metadata in DHIS2 and you are used to the Maintenance app, then note that the Metadata Management app replaces it. This page lists what is new, what works differently, and what you still need the Maintenance app for.

- The Metadata Management app is installed from the DHIS2 App Hub.
- It works with DHIS2 version 41 and above.
- It is released continuously. New sections and features arrive often, so update the app from the App Hub before you report something as missing or non-functional.
- The maintenance app is no longer being supported, so plan accordingly

> **Note**
>
> This page covers the differences between the maintenance app and the metadata management app. For full instructions, see [Configure metadata (Metadata Management app)](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/configuring-the-system/metadata-metadata-management-app.html).

## The Metadata Management app { #mmchg_overview }

The left sidebar lists every metadata object you can manage in this app. The overview page shows a card for each object type, with **Add new** and **Manage** buttons.

![Metadata Management app overview page](images/MAINT_MM/mm-overview.png)

## Summary of changes (when compared to the maintenance app) { #mmchg_summary }

| Function | Maintenance app | Metadata Management app | Status |
|---|---|---|---|
| Create metadata | Plus button, bottom right corner | New bottom in top menu | Changed |
| Edit, clone, delete, translate, sharing settings, show details | Options menu on each object | Options menu (**...**) on each object | Same |
| See who created or last updated an object | Only shows dates in details panel | Shows dates and user in details panel | Changed |
| Choose which columns a list shows | Gear icon at top right of list > **Manage columns** | **Manage View** > **Columns** tab | Changed |
| Choose filters to apply to your current view of the metadata | Not available | **Manage View** > **Filters** tab | New |
| Download metadata from a list | Gear icon at top right of list > **Download** | **Download** button above the list | Changed |
| Search across all metadata types at once | Not available | **All metadata** view | New |
| Change sharing, download or delete many objects at once | Not available | Select objects in the list, then use the bar above the list | New |
| Merge duplicate objects | Not available | Merge screen (needs a merge authority) | New |
| Set compulsory data elements for a data set | Data set options menu > **Edit compulsory data elements** | Data set form > **Validation** section | Changed |
| Add many objects to a group, or one object to many groups | Separate **Edit multiple object groups** screen | Edit from the object or from the group | Changed |
| Download a default data entry form as PDF | Data set options menu > **Get PDF for data entry** | Not in the data set options menu | Not available |
| Push reports (push analysis) | Available | Not available | Use the Maintenance app |
| External map layers | Available | Not available, planned to move to the Maps app | Use the Maintenance app |

## What's new { #mmchg_new }

### All metadata view { #mmchg_all_metadata }

Search for a keyword across many metadata types from one screen.

1. In the sidebar, click **Metadata Overview** > **All metadata**.
2. Type a keyword in the search box. Results are grouped by metadata type, with the number of matches.
3. Use the metadata types dropdown to narrow the results.
4. Expand a type to see the first five matches. Click **Load more** to see more.

![All metadata view, searching for "malaria" with the Data Element group expanded](images/MAINT_MM/mm-all-metadata.png)

### Bulk actions: sharing, download and delete { #mmchg_bulk_actions }

Select several objects in a list with the checkboxes. A bar appears above the list with **Update sharing**, **Download**, **Delete** and **Deselect all**.

![Four data elements selected, with the bulk action bar above the list](images/MAINT_MM/mm-bulk-selection-bar.png)

**Update sharing** opens a dialog where you add sharing settings for users, user groups and public access. The changes apply to all selected objects.

![Update sharing dialog for four selected items](images/MAINT_MM/mm-bulk-sharing-dialog.png)

> **Note**
>
> Editing or removing existing sharing settings in bulk is not yet available; however further improvements are planned.

> **Warning**
>
> **Delete** in the bulk bar deletes all selected objects. Deleting metadata cannot be undone. Metadata dependencies, or metadata that has data associated with it, will still give warnings and/or errors when using this option to delete.

### Custom filters on each list { #mmchg_list_filters }

Each list has a search bar (name, code or ID) and filters for that object type. For example, data elements can be filtered by domain type, value type, data set, category combination and data element group.

![Data elements list with search, filters and the New, Download and Manage View buttons](images/MAINT_MM/mm-list-toolbar.png)

You choose which filters to show with **Manage View** > **Filters**.

### Merge duplicate metadata { #mmchg_merge }

Merge combines duplicate objects into one. All references to the source objects move to the target object. The source objects and data can be kept or deleted depending on user selection.

- You can merge the following metadata objects: categories, category combinations, category option combinations, category options, data elements, indicators, indicator types and organisation units.
- Each object type has its own merge authority. For example, category options and categories each have their own seperate merge authority. Without it, the merge page shows an error. In order for a user to perform that merge, assign the user authority to a user role assigned to them.

>**Caution**
>
>It is recommended that a seperate merge role is created to allow for explicit control over who has these authorites.

![Error shown when the user does not have the F_CATEGORY_OPTION_MERGE authority](images/MAINT_MM/mm-merge-authority.png)

> **Warning**
>
> Merging cannot be undone. Back up your database before you merge.

For the full procedure, see [Merge](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/configuring-the-system/metadata-metadata-management-app.html#mm_common_actions_merge).

## What works differently { #mmchg_changed }

### Details panel { #mmchg_details_panel }

Click the details icon (**i**) on a row to open the details panel on the right. It shows the code, who created the object, who last updated it, the ID and the API URL. Click **Edit** to open the object.

![Details panel for a data element, showing Created by, Last updated by and the Edit button](images/MAINT_MM/mm-show-details.png)

### Options menu { #mmchg_options_menu }

Click the options menu (**...**) on a row for **Edit**, **Clone**, **Show details**, **Sharing settings**, **Translate** and **Delete**.

![Options menu on a data element](images/MAINT_MM/mm-row-actions-menu.png)

### Lists: columns, filters and download { #mmchg_lists }

Column and filter settings are under the **Manage View** button above the list.

1. Click **Manage View**.
2. Select the **Columns** tab to choose columns, or the **Filters** tab to choose filters.
3. Move items between the available and selected lists with the arrow buttons. Use the up and down arrows to change the order.
4. Click **Update view**. Click **Reset to default** to go back to the default view.

> **Note**
>
> Your choices only change your own view. They do not edit metadata or affect other users.

![Manage View dialog, Columns tab](images/MAINT_MM/mm-manage-view-columns.png)

![Manage View dialog, Filters tab](images/MAINT_MM/mm-manage-view-filters.png)

**Download** is a separate button above the list. You choose:

- Compression: Zip, Gzip or Uncompressed
- What to include: all objects, only selected objects, or only objects that match the active filters
- Whether to include user sharing settings

![Download dialog for data elements](images/MAINT_MM/mm-download-dialog.png)

### Assigning items with the transfer list { #mmchg_transfer_list }

Many forms use a two-panel list to assign items, for example data elements to a data element group.

- **Show only unassigned items** hides items that already belong to another group.
- Each panel has its own filter box.
- **Add new** opens a form to create a missing item without leaving the current form. **Refresh list** reloads the available items.

![Transfer list in the data element group form](images/MAINT_MM/mm-transfer-list.png)

### Group membership { #mmchg_group_membership }

The Maintenance app had a separate screen for editing groups in bulk. The Metadata Management app does not have this screen. Instead:

- One object into many groups: open the object (for example a data element) and assign it to groups.
- Many objects into one group: open the group (for example a data element group) and assign the members.

### Data set form { #mmchg_data_set_form }

The data set form is split into sections, listed on the left: **Setup**, **Data**, **Periods**, **Validation**, **Organisation Units**, **Form** and **Advanced**. Click a section name to jump to it.

![Data set form with the section list on the left](images/MAINT_MM/mm-data-set-form-sections.png)

The **Validation** section ("Validation and limitations") has:

- the approval workflow for the data set
- the rules for completing a form, for example "Completing requires passing validation"
- the number of days after the period to qualify for on-time submission
- the compulsory data elements, which used to be a separate action in the options menu

![Validation and limitations section of the data set form](images/MAINT_MM/mm-data-set-validation.png)

The data set options menu does not have a **Get PDF for data entry** option.

![Data set options menu](images/MAINT_MM/mm-data-set-actions-menu.png)

### Organisation units { #mmchg_org_units }

The organisation unit list shows the hierarchy. Click the arrow next to an organisation unit to show its children.

![Organisation unit list showing the hierarchy](images/MAINT_MM/mm-org-units-list.png)

To move organisation units:

1. In the sidebar, click **Organisation units** > **Hierarchy operations**.
2. On the left, select the organisation units to move.
3. On the right, select the new parent.
4. Click **Move**. All descendants move with them.

![Move organisation units page](images/MAINT_MM/mm-move-org-units.png)

### Programs and data approval { #mmchg_programs_approval }

Programs and data approval are in the app's sidebar. They are documented separately.

## What you still need the Maintenance app for { #mmchg_maintenance_still_needed }

| Task | Why | What to do |
|---|---|---|
| Push reports | Not available in the Metadata Management app | Keep using the Maintenance app. See [Manage push reports](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/configuring-the-system/metadata-maintenance-app.html#manage_push_report). |
| External map layers | Planned to move to the Maps app | Keep using the Maintenance app until then. See [Manage external map layers](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/configuring-the-system/metadata-maintenance-app.html#manage_external_maplayer). |
| PDF data entry forms | Not in the data set options menu | Keep using the maintenance app. See [Download forms as PDF.](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/configuring-the-system/metadata-maintenance-app.html#download_defaultform_pdf) |

> **Important**
>
> Do not uninstall or hide the Maintenance app if your instance uses any of these.

## Related pages { #mmchg_related }

- [Configure metadata (Metadata Management app)](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/configuring-the-system/metadata-metadata-management-app.html)
- [Configure metadata (Maintenance app)](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/configuring-the-system/metadata-maintenance-app.html)
2 changes: 2 additions & 0 deletions implementation_section_index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Configuration:
- Transition Kits:
- Event Reports to Line Listing: '@github(dhis2/dhis2-docs-implementation, content/configuration/transition_kit_er_to_ll.md, master)'
- Tracker Capture to Capture: '@github(dhis2/dhis2-docs-implementation, content/configuration/transition_kit_tc_to_c.md, master)'
- Data Entry - Legacy to New: '@github(dhis2/dhis2-docs-implementation, content/configuration/transition_kit_de.md, master)'
- Maintenance to Metadata Management: '@github(dhis2/dhis2-docs-implementation, content/configuration/transition_kit_maintenance_to_mm.md, master)'
Data Use:
- Data Visualization: '@github(dhis2/dhis2-docs-implementation, content/data-use/data-visualization.md, master)'
Health:
Expand Down
Loading