{"type":"doc","content":[{"type":"paragraph","content":[{"text":"To update the metadata in the ","type":"text"},{"text":"distro/configuration","type":"text","marks":[{"type":"em"}]},{"text":" folder (e.g., adding new forms, concepts, etc.), follow these steps:","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Step 1: Stop the Running Instance","type":"text"}]},{"type":"paragraph","content":[{"text":"If your instance is currently running, first bring it down:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"docker compose down","type":"text"}]},{"type":"paragraph","content":[{"text":"This command stops and removes the current containers, ensuring a clean start for your updated metadata.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Step 2: Build the Local Docker Image","type":"text"}]},{"type":"paragraph","content":[{"text":"To reflect the updated metadata in your instance, you'll need to build a local Docker image. Ensure your configuration files follow the ","type":"text"},{"text":"accepted conventions for each configuration","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/mekomsolutions/openmrs-module-initializer?tab=readme-ov-file#supported-domains-and-default-loading-order"}}]},{"text":", as incorrect formats might prevent the metadata from appearing in the instance as expected.","type":"text"}]},{"type":"codeBlock","content":[{"text":"TAG=your-custom-tag docker compose build","type":"text"}]},{"type":"paragraph","content":[{"text":"Replace `your-custom-tag` with any unique tag of your choice. It’s advisable to use a tag not found on Docker Hub (e.g., `qa` or specific release versions) to avoid conflicts.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Step 3: Run the Instance with the Updated Image","type":"text"}]},{"type":"paragraph","content":[{"text":"Next, start your instance using the locally built image:","type":"text"}]},{"type":"codeBlock","content":[{"text":"TAG=your-custom-tag docker compose -f docker-compose.yml up -d","type":"text"}]},{"type":"paragraph","content":[{"text":"Ensure that the `TAG` variable matches the one you used in the previous step. This command launches the instance using your locally built image instead of pulling one from Docker Hub.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Step 4: Wait for the Instance to Start","type":"text"}]},{"type":"paragraph","content":[{"text":"The backend script should start running at this point. To verify if the instance is running, refer to the ","type":"text"},{"text":"step 4 of the dev guide of setting up an instance of O3","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/projects/pages/150930190/Set+Up+an+Instance+of+O3#Step-4.1"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Updating the address template","type":"text"}]},{"type":"paragraph","content":[{"text":"For an example, consider the patient registration which looks like below by default:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":374,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":763,"id":"54c25f90-cbc9-4096-be8c-cbdc7664dd3d","collection":"contentId-185565250","type":"file","height":590}},{"type":"caption","content":[{"text":"Default address template","type":"text"}]}]},{"type":"paragraph","content":[{"text":"To update the address template, go to the ","type":"text"},{"text":"Legacy admin","type":"text","marks":[{"type":"code"}]},{"text":" found under the ","type":"text"},{"text":"System Administration","type":"text","marks":[{"type":"code"}]},{"text":" under the ","type":"text"},{"text":"App Menu","type":"text","marks":[{"type":"code"}]},{"text":". In the legacy admin UI, under the section ","type":"text"},{"text":"Location","type":"text","marks":[{"type":"code"}]},{"text":" section, go to ","type":"text"},{"text":"Manage Address Template","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"Lets change it to have the fields ","type":"text"},{"text":"House number","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Avenue","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Neighbourhood","type":"text","marks":[{"type":"code"}]},{"text":" instead. ","type":"text"}]},{"type":"paragraph","content":[{"text":"To do so, we have to modify the ","type":"text"},{"text":"AddressTemplate","type":"text","marks":[{"type":"code"}]},{"text":" to the following,","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\taddress1\n\t\taddress2\n\t\taddress3 address4\n\t\n\t\n\t\taddress1\n\t\n","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note that since this is done on the legacy admin UI, these changes will disappear when the instance is rebuilt.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"To persist these changes in the instance, create an ","type":"text"},{"text":".xml","type":"text","marks":[{"type":"code"}]},{"text":" file in the ","type":"text"},{"text":"distro/configuration/globalproperties","type":"text","marks":[{"type":"code"}]},{"text":" folder. The above example in the file would look like:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n layout.address.format\n \n <org.openmrs.layout.address.AddressTemplate>\n <nameMappings class="properties">\n <property name="address1" value="Location.address1"/>\n <property name="address2" value="Location.address2"/>\n <property name="address3" value="Location.address3"/>\n <property name="address4" value="Location.address4"/>\n </nameMappings>\n <sizeMappings class="properties">\n <property name="address1" value="10"/>\n <property name="address2" value="40"/>\n <property name="address3" value="40"/>\n <property name="address4" value="40"/>\n </sizeMappings>\n <lineByLineFormat>\n <string>address1</string>\n <string>address2</string>\n <string>address3 address4</string>\n </lineByLineFormat>\n <requiredElements>\\\\n" + " </requiredElements>\\\\n" + " </org.openmrs.layout.address.AddressTemplate>\n \n \n \n","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"<","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":">","type":"text","marks":[{"type":"code"}]},{"text":" symbols should be marked as ","type":"text"},{"text":"<","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":">","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Language Translation of Address Labels","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To change the strings that would display as the labels instead of ","type":"text"},{"text":"address1","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"address2","type":"text","marks":[{"type":"code"}]},{"text":", etc. Add a folder called ","type":"text"},{"text":"messageproperties","type":"text","marks":[{"type":"code"}]},{"text":" to the reference application repository ","type":"text"},{"text":"distro/configuration","type":"text","marks":[{"type":"code"}]},{"text":" folder. Add separate files for each language that you wish to support. Eg:-","type":"text"}]},{"type":"paragraph","content":[{"text":"In a ","type":"text"},{"text":"addresslabel_en.properties","type":"text","marks":[{"type":"code"}]},{"text":" file,","type":"text"}]},{"type":"codeBlock","content":[{"text":"Location.address1=House Number\nLocation.address2=Avenue\nLocation.address3=Street\nLocation.address4=Neighbourhood","type":"text"}]},{"type":"paragraph","content":[{"text":"To add support for french, in a ","type":"text"},{"text":"addresslabel_fr.properties","type":"text","marks":[{"type":"code"}]},{"text":" file,","type":"text"}]},{"type":"codeBlock","content":[{"text":"Location.address1=Numéro de maison\nLocation.address2=Rue\nLocation.address3=Commune\nLocation.address4=Quartier","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"You can name the file anything, as long as the file extension is ","type":"text"},{"text":".properties","type":"text","marks":[{"type":"code"}]},{"text":". In order to see the strings reflected in the instance, you would have to rebuild the instance.","type":"text"}]}]},{"type":"paragraph"}],"version":1}

Browser not supported