Rendering user-interface elements based on variation metamodels
Embodiments presented herein provide techniques for rendering user-interface elements for an entity type based on a variation metamodel received in response to an API request. When a user invokes a function to access or create an entity, a user interface sends the API request to an API service. The API request identifies the entity type and is associated with context information about the user. The variation metamodel is selected by the API service based on the context information. The user interface receives and parses a response from the API service. The meta model includes metadata describing at least one aspect of a corresponding property of the entity type. Using the metadata as a guide, the user interface renders elements for the properties of the variation schema in a graphical user interface (GUI).
1. A method for rendering an element in a graphical user interface (GUI), the method comprising:
sending an application programming interface (API) request to a server, wherein the API request identifies an entity type and is associated with context information;
receiving a response to the API request including a variation metamodel associated with the context information, the variation metamodel including rules for displaying data included in the response to the API request for the entity type associated with the context information;
parsing the response to identify a property included in the variation metamodel and metadata associated with the property; and
rendering the element for the property in the GUI based on the metadata.
2. The method of claim 1 , wherein the element is an interactive element for triggering an operation, and wherein the metadata specifies that the operation is allowed for the entity type.
3. The method of claim 1 , wherein the element is a field, and wherein the method further comprises:
receiving a value for the property through the field;
determining the value does not satisfy a validation rule in the metadata associated with the property; and
displaying a message in the GUI indicating the value is not allowed for the property.
4. The method of claim 1 , wherein the element is a field, and wherein the method further comprises:
receiving a value for the property in the response;
identifying a format for the property based on the metadata; and
displaying the value in the field in the format.
5. The method of claim 1 , wherein the element is a list of allowed values for the property, and wherein the metadata specifies the allowed values.
6. The method of claim 1 , further comprising:
verifying that the property is marked as enabled in the metadata before rendering the element.
7. The method of claim 1 , wherein the context information identifies a jurisdiction associated with the API request.
8. A system, comprising:
a processor; and
a memory storing one or more applications, which, when executed on the processors perform an operation for rendering an element in a graphical user interface (GUI), the operation comprising:
sending an application programming interface (API) request to a server, wherein the API request identifies an entity type and is associated with context information,
receiving a response to the API request including a variation metamodel associated with the context information,
parsing the response to identify a property included in the variation metamodel and metadata associated with the property, the variation metamodel including rules for displaying data included in the response to the API request for the entity type associated with the context information, and
rendering the element for the property in the GUI based on the metadata.
9. The system of claim 8 , wherein the element is a button for triggering an operation, and wherein the metadata specifies that the operation is allowed for the entity type.
10. The system of claim 8 , wherein the element is a field, and wherein the operation further comprises:
receiving a value for the property through the field;
determining the value does not satisfy a validation rule in the metadata associated with the property; and
displaying a message in the GUI indicating the value is not allowed for the property.
11. The system of claim 8 , wherein the element is a field, and wherein the operation further comprises:
receiving a value for the property in the response;
identifying a format for the property based on the metadata; and
displaying the value in the field in the format.
12. The system of claim 8 , wherein the element is a list of allowed values for the property, and wherein the metadata specifies the allowed values.
13. The system of claim 8 , wherein the operation further comprises:
verifying that the property is marked as enabled in the metadata before rendering the element.
14. The system of claim 8 , wherein the context information identifies a jurisdiction or geographical region and is included in the API request.
15. A non-transitory computer-readable storage medium containing instructions that, when executed by one or more processors, perform an operation for rendering an element in a graphical user interface (GUI), the operation comprising:
sending an application programming interface (API) request to a server, wherein the API request identifies an entity type and is associated with context information;
receiving a response to the API request including a variation metamodel associated with the context information, the variation metamodel including rules for displaying data included in the response to the API request for the entity type associated with the context information;
parsing the response to identify a property included in the variation metamodel and metadata associated with the property; and
rendering the element for the property in the GUI based on the metadata.
16. The non-transitory computer-readable storage medium of claim 15 , wherein the element is a button for triggering an operation, and wherein the metadata specifies that the operation is allowed for the entity type.
17. The non-transitory computer-readable storage medium of claim 15 , wherein the element is a field, and wherein the operation further comprises:
receiving a value for the property through the field;
determining the value does not satisfy a validation rule in the metadata associated with the property; and
displaying a message in the GUI indicating the value is not allowed for the property.
18. The non-transitory computer-readable storage medium of claim 15 , wherein the element is a field, and wherein the operation further comprises:
receiving a value for the property in the response;
identifying a format for the property based on the metadata; and
displaying the value in the field in the format.
19. The non-transitory computer-readable storage medium of claim 15 , wherein the element is a list of allowed values for the property, and wherein the metadata specifies the allowed values.
20. The non-transitory computer-readable storage medium of claim 15 , wherein the operation further comprises:
verifying that the property is marked as enabled in the metadata before rendering the element.