Differences

This shows you the differences between two versions of the page.

--- other_stuff:document_registry [2024/09/11 15:13] – created Gary Willetts
+++ other_stuff:document_registry [2024/10/22 16:44] (current) – [Adding a document] Gary Willetts
@@ Line 1: / Line 1: @@
 {{indexmenu_n>190}}
 ====== 26.20. Document registry ======
-The document registry is for storing...something very mysterious for Open mSupply. We will divulge the secrets soon...
+The document registry is for storing settings for various forms that are used in Open mSupply.
+===== View the current stored documents =====
+To see a list of the currently stored documents, choose //Special//>//Show document registry...// from the menus. This window will open:
+{{ :other_stuff:pasted:20240911-151514.png?450 |}}
+This shows a list of all the documents currently stored. If the list is long and you want to find a particular document then type something in the //Type here to search// field and the list will show only those documents with what you typed in their //Document type//.
+The number in the bottom left of the window is in the format ''x/y'' where ''x'' is the number of documents displayed in the table and ''y'' is how many documents are stored altogether (i.e. displayed when nothing is entered in the //Type here to search// field.
+===== Deleting a document =====
+Select a document in the list by clicking on it and click on the **Delete** button. After confirmation the document will be deleted and will no longer be available for use.
+===== Adding a document =====
+Click on the **New** button and this window will open:
+{{ :other_stuff:pasted:20240911-151642.png?450 |}}
+  * **Document type:** This is a free text field. Enter something meaningful so you will know later what this document is for.
+  * **Category:** When you click on this field you will be shown another window with a selection of categories to choose from like this:
+{{ :other_stuff:pasted:20241022-163102.png?300 }}
+Highlight one by clicking on it and click the **OK** button to select it.
+  * **Context:** This field may be filled in for you automatically and become read only when you select the **Category** (meaning this categroy does not need ny further context information or clicking on this field will open another window to allow you to select the master list which is the context for the form like this:
+{{ :other_stuff:pasted:20241022-163718.png?400 }}
+Highlight one in the list by clicking on it and click on the **OK** button to select it.
+  * **Name:** This is a free text field. Enter the name of the form as it will appear in Open mSupply.
+  * **Data schema:** Click on the **Upload** button to select the JSON schema file that defines the contents of the form.
+  * **UI schema:** Click on the **Upload** button to select the JSON file that defines the appearance of the form.
+  * **Config:** Click on the **Upload** button to select the JSON file that defines the confguration of the form.
+  * **Data field:** When you click on one of the 3 file fields, this field will show the contents of the files for checking.
+Click on the **OK** button to save your changes or the **Cancel** button to discard them.
+===== Editing a document =====
+Double-click on the document you want to edit in the table and the same window for adding a new document will open but populated with the selected document's details. Edit any of the details as required then click on the **OK** button to save your changes. Click on the **Cancel** button to discard your changes.