QuickApp guidelines

The following guidelines will help you maximize the functionality of your QuickApp in the Dynamic API.

You may need to make minor changes to your QuickApp to expose its full functionality in the Dynamic API. With traditional 1010data QuickApps, the response contains everything the browser needs to update all necessary widgets at once and keep the display in sync. With the Dynamic API, that burden moves to the client. Therefore, a request for one widget can trigger changes in other widgets that are not reflected in the response.

In order to handle this difference, we recommend the following guidelines for creating QuickApps to be called by the Dynamic API.

  • Design simple endpoints that require only one widget. Most of the built-in endpoints work this way.
  • Pass in configuration variables once, when you initialize the QuickApp, and do not change them.
  • Pass all required variables for each widget you request so that results do not depend on server-side state.
  • Post all variable changes to the top-level QuickApp (either by name or tag number) and then let the widget status table tell you which widgets were updated. This approach is the most flexible for complicated QuickApps.