{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"title":{"value":"Contents"}},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Panel"}}},"content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"OpenMRS provides ","type":"text"},{"text":"Form","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Field","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"FormField","type":"text","marks":[{"type":"code"}]},{"text":" objects through the API as well as schema creation in the webapp. ","type":"text"},{"text":"FormEntry Module","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25465756"}}]},{"text":", ","type":"text"},{"text":"HTML Form Entry Module","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/docs/pages/25475242"}}]},{"text":" and ","type":"text"},{"text":"XForms Module","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25461826"}}]},{"text":" all utilize the built-in ","type":"text"},{"text":"Form","type":"text","marks":[{"type":"code"}]},{"text":" infrastructure. OpenMRS also provides API calls to store serializable resources or metadata on any given ","type":"text"},{"text":"Form","type":"text","marks":[{"type":"code"}]},{"text":" instance.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Forms","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Fields","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Form Fields","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Schemas","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Form Resources","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Terms To Understand","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"html","parameters":{"macroParams":{"__bodyContent":{"value":"\n

Name: The unique name of the resource, identifying it in some way as owned by a particular module and indicating its purpose. e.g. formentry.xslt or htmlformentry.schema

\n"}},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"html"}}}}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"FormResource objects can be of any ","type":"text"},{"text":"Custom Datatype","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25482391"}}]},{"text":". Only one FormResource will be stored for any combination of ","type":"text"},{"text":"Form","type":"text","marks":[{"type":"em"}]},{"text":" object and ","type":"text"},{"text":"name","type":"text","marks":[{"type":"em"}]},{"text":" (property on the FormResource). In other words, there can only be one ","type":"text"},{"text":"formentry.xslt","type":"text","marks":[{"type":"em"}]},{"text":" FormResource for any given ","type":"text"},{"text":"Form","type":"text","marks":[{"type":"em"}]},{"text":". If ","type":"text"},{"text":"FormService.saveFormResource()","type":"text","marks":[{"type":"code"}]},{"text":" is asked to save a new ","type":"text"},{"text":"formentry.xslt","type":"text","marks":[{"type":"em"}]},{"text":" FormResource on a Form that already has a ","type":"text"},{"text":"formentry.xslt","type":"text","marks":[{"type":"em"}]},{"text":" FormResource, the FormResource already stored in the database will be purged before saving the new one.","type":"text"}]},{"type":"paragraph","content":[{"text":"A FormResource is both a CustomValueDescriptor and a SingleCustomValue. This means that any given FormResource not only holds data but also specifies the kind of data in it, similar to how GlobalProperty objects work in OpenMRS 1.9+. Form edit pages provide a tab to manage FormResource objects on that Form.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"TODO: screenshot(s) of Form Resource management","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Designing Form Resources","type":"text"}]},{"type":"paragraph","content":[{"text":"Working with FormResource objects should follow the same methodology as working with GlobalProperty objects. Following is a unit test from ","type":"text"},{"text":"FormServiceTest","type":"text","marks":[{"type":"code"}]},{"text":" to show how this is done, using a basic DateDatatype:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n@Test\n@Verifies(value = \"should persist a FormResource\", method = \"saveFormResource()\")\npublic void saveFormResource_shouldPersistAFormResource() throws Exception {\n\tForm form = Context.getFormService().getForm(1);\n\tFormResource resource = new FormResource();\n\tresource.setForm(form);\n\tresource.setName(\"Start Date\");\n\tresource.setDatatypeClassname(\"org.openmrs.customdatatype.datatype.DateDatatype\");\n\tDate expected = new SimpleDateFormat(\"yyyy-MM-dd\").parse(\"2011-10-16\");\n\tresource.setValue(expected);\n\t\n\tContext.getFormService().saveFormResource(resource);\n\tInteger resourceId = resource.getFormResourceId();\n\t\n\tContext.clearSession();\n\t\n\tFormResource actual = Context.getFormService().getFormResource(resourceId);\n\tAssert.assertNotNull(actual);\n\tAssert.assertEquals(expected, actual.getValue());\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"API Methods","type":"text"}]},{"type":"paragraph","content":[{"text":"The OpenMRS FormService API must be used to manipulate FormResources. The following API calls are available from ","type":"text"},{"text":"org.openmrs.api.FormService","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"\npublic FormResource getFormResource(Integer formResourceId);\npublic FormResource getFormResourceByUuid(String uuid);\n\n/* usages: */\nFormResource xslt = getFormResource(1);\nFormResource xslt = getFormResourceByUuid(\"1e67efde-fe91-4802-8f8e-ba34d01cc926\");\n","type":"text"}]},{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"Common API retrieval methods for FormResources.","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"\npublic FormResource getFormResource(Form form, String name);\n\n/* usage: */\nFormResource xslt = getFormResource(form, \"formentry.xslt\");\n","type":"text"}]},{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"Saves a FormResource. The ","type":"text"},{"text":"name","type":"text"},{"text":" property of the FormResource must be unique and should refer to a particular service or module claiming ownership of the resource and the use of that resource. Only one resource for each name will ever be saved on a given Form.","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"\npublic FormResource saveFormResource(FormResource formResource);\n","type":"text"}]},{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"Saves a FormResource. The ","type":"text"},{"text":"name","type":"text"},{"text":" property of the FormResource must be unique and should refer to a particular service or module claiming ownership of the resource and the use of that resource. Only one resource for each ","type":"text"},{"text":"name","type":"text"},{"text":" will ever be saved on a given Form.","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"\npublic void purgeFormResource(FormResource formResource);\n","type":"text"}]},{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"Permanently removes a FormResource.","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"\npublic Collection getFormResourcesForForm(Form form);\n","type":"text"}]},{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"Retrieves all FormResources for a given form.","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"\npublic Set getFormResourceOwners(Form form);\n","type":"text"}]},{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"Retrieves all unique owners for resources for a given form.","type":"text"}]}]}],"version":1}

Browser not supported