Best Practices

We recommend the following best practices when designing your forms.

• Ensure you use Containers appropriately for aesthetic and performance benefits.

  • Use containers to group controls logically.

  • Use Base Form to create a set of repeatable controls at run-time.

  • Use Panel Form to create layouts without generating XML nodes.

  • Use Tabs to group associated controls on the same page with set of related controls separated into sections (Tab).

  • Use limited number of Tabs and Tab to load tabs and forms faster.

• Ensure you use Controls appropriately for performance benefits.

  • Use minimum viable controls per form and avoid overloading controls to load controls and forms faster.

  • Use small file size attachments with Attachment to upload attachments faster.

  • Use small file size images with Image to load images faster.

  • Use predefined options either through the property or through the script instead of populating the options from the server when the number of options is limited with Check Box, Drop-Down, Radio Button, and List to load options faster.

  • Use Drop-Down only the number of options is limited with Data Lookup to load lookups faster.

  • Use Pop-Up to include sub-forms to load forms faster.

  • Use Pop-Up to open forms in a new browser window to improve forms performance.

  • Use lookup definitions configured for limited result set with Data Lookup to load lookups faster.

  • Use 10 records and autocomplete length of 3 or more with Data Lookup to improve data retrieval speed and to load lookups faster.

  • Use Extended Information only when required and with limited fields with Data Lookup and Data Grid to improve data retrieval speed and to load lookups and grids faster.

  • Use Persist Display Value with Data Lookup to cache the display value in the edit mode of forms to load lookups faster.

  • Use parameterized lookups and grids for limited result set with Data Lookup and Data Grid to improve data retrieval speed and to load lookups and grids faster.

  • Use grid definitions configured for limited result set with Data Grid to load grids faster.

  • Use only the required fields to display and persist with Data Grid to improve data retrieval speed and to reduce the size of the instance XML.

  • Use selection (highlight) instead of confirmation (check) with Data Grid to reduce the size of the instance XML.

  • Use selection of record instead of with Data Grid to reduce the size of the instance XML.

• Ensure you use Forms appropriately for aesthetic and performance benefits.

  • Use forms with minimal controls and add or remove controls progressively as the workflow progresses to load forms faster and to improve the usability of forms.

  • Use short Name and XML Node for properties of controls to reduce the size of the instance XML and to improve the data transfer speed between servers and clients.

  • Use short Description and only if required for properties of controls to reduce the size of the definition XML.

  • Use optimized JavaScript code without unnecessary closures to improve script execution.

  • Use asynchronous calls instead of synchronous calls with On Data Change event.

  • Use well-formed JSON instead of XML when exchanging data between servers and clients, and limit the return information to only the required information for performance benefits.

  • Use GET method as appropriate with AJAX calls in scripts and cache the relevant APIs to avoid reloading the APIs on every request to improve script execution.

  • Use queue to handle multiple AJAX calls in scripts and request at once to improve script execution.

• Ensure you use Content Security Policy appropriately. Loading of the External URL for Web API, Embed Page, Images, and so on depends upon the Content Security Policy for the Enterprise Console Web Application.

  • Modify and define the Content Security Policy as per the user requirement. For more details, refer to Content Security Policy documentation on the W3C website.

  • Specify the URLs based on the same domain in the Form Controls. For images, you can use data-URLs.