Improve Expression Editor UX To Guide Non-Technical Users

by ADMIN 58 views

Current Limitation

The current Business Intelligence (BI) visual editor's "Declare Variable" popup allows users to input advanced expressions using Ballerina syntax. While this is powerful and flexible for developers familiar with such syntax, it poses a significant usability issue for non-technical or business users who may not understand these constructs.

The Problem with Advanced Syntax

The UI does not provide guidance or suggestions for expression syntax, leaving non-technical users confused or unaware of how to construct such expressions. Furthermore, there's no built-in validation or syntax assistance for spread operations or advanced mappings. This can lead to frustration and potential errors when dealing with object transformations.

The Need for Improvement

To address these issues, we suggest the following improvements to the expression editor UX:

Add Expression Builder UI

Provide a visual way to build expressions by selecting keys and values from existing variables rather than typing raw expressions. This will make it easier for non-technical users to construct expressions without needing to understand advanced syntax.

Benefits of Expression Builder UI

  • Improved Accessibility: The expression builder UI will make it easier for non-technical users to use the BI editor, reducing the barrier to entry.
  • Reduced Confusion: By providing a visual way to build expressions, users will be less likely to get confused by advanced syntax.
  • Increased Productivity: The expression builder UI will save users time and effort by allowing them to build expressions quickly and easily.

Add Syntax Suggestions or Autocomplete

Help users discover supported syntax like spread operators or inline mappings with tooltips or suggestions. This will make it easier for users to learn and use advanced syntax.

Benefits of Syntax Suggestions or Autocomplete

  • Improved Learning: Syntax suggestions or autocomplete will help users learn and understand advanced syntax.
  • Increased Productivity: By providing suggestions or autocomplete, users will be able to build expressions more quickly and easily.
  • Reduced Errors: Syntax suggestions or autocomplete will reduce the likelihood of errors caused by incorrect syntax.

Add Documentation/Help Link

Link to examples or documentation explaining how these expressions work and in what contexts they are valid. This will provide users with a resource to learn and understand advanced syntax.

Benefits of Documentation/Help Link

  • Improved Learning: Documentation or help links will provide users with a resource to learn and understand advanced syntax.
  • Increased Confidence: By providing documentation or help links, users will feel more confident when using advanced syntax.
  • Reduced Support Requests: Documentation or help links will reduce the number of support requests related to advanced syntax.

Restrict Advanced Syntax for Simpler Mode

Optionally allow toggling between “Advanced Mode” and “Guided Mode” to simplify the experience for less technical users. This will provide users with a choice between a more complex and a simpler interface.

Benefits of Restricting Advanced Syntax

  • Improved Accessibility: Restricting advanced syntax will make the BI editor more accessible to non-technical users.
  • Reduced Confusion: By providing a simpler interface, users will be less likely to get confused by advanced syntax.
  • Increased Productivity: The simpler interface will save users time and effort by allowing them to build expressions quickly and easily.

Conclusion

The current BI visual editor's "Declare Variable" popup poses a significant usability issue for non-technical or business users. To address this issue, we suggest the following improvements to the expression editor UX:

  • Add Expression Builder UI
  • Add Syntax Suggestions or Autocomplete
  • Add Documentation/Help Link
  • Restrict Advanced Syntax for Simpler Mode

These improvements will significantly improve the BI editor's accessibility and reduce potential confusion when dealing with object transformations. By providing a more user-friendly interface, we can make the BI editor more accessible to a wider range of users.

Future Development

In the future, we can further improve the expression editor UX by:

  • Providing More Guidance: Provide more guidance and suggestions for users to help them learn and understand advanced syntax.
  • Improving the Expression Builder UI: Improve the expression builder UI to make it more intuitive and user-friendly.
  • Adding More Features: Add more features to the expression editor UX, such as support for more advanced syntax or the ability to save and reuse expressions.

Q: What is the current limitation of the BI visual editor's "Declare Variable" popup?

A: The current limitation is that the "Declare Variable" popup allows users to input advanced expressions using Ballerina syntax, which poses a usability issue for non-technical or business users who may not understand these constructs.

Q: What are the problems with the current UI?

A: The UI does not provide guidance or suggestions for expression syntax, leaving non-technical users confused or unaware of how to construct such expressions. Furthermore, there's no built-in validation or syntax assistance for spread operations or advanced mappings.

Q: What are the suggested improvements to the expression editor UX?

A: The suggested improvements are:

  • Add Expression Builder UI
  • Add Syntax Suggestions or Autocomplete
  • Add Documentation/Help Link
  • Restrict Advanced Syntax for Simpler Mode

Q: What are the benefits of adding an Expression Builder UI?

A: The benefits of adding an Expression Builder UI are:

  • Improved Accessibility: The expression builder UI will make it easier for non-technical users to use the BI editor, reducing the barrier to entry.
  • Reduced Confusion: By providing a visual way to build expressions, users will be less likely to get confused by advanced syntax.
  • Increased Productivity: The expression builder UI will save users time and effort by allowing them to build expressions quickly and easily.

Q: What are the benefits of adding Syntax Suggestions or Autocomplete?

A: The benefits of adding Syntax Suggestions or Autocomplete are:

  • Improved Learning: Syntax suggestions or autocomplete will help users learn and understand advanced syntax.
  • Increased Productivity: By providing suggestions or autocomplete, users will be able to build expressions more quickly and easily.
  • Reduced Errors: Syntax suggestions or autocomplete will reduce the likelihood of errors caused by incorrect syntax.

Q: What are the benefits of adding Documentation/Help Link?

A: The benefits of adding Documentation/Help Link are:

  • Improved Learning: Documentation or help links will provide users with a resource to learn and understand advanced syntax.
  • Increased Confidence: By providing documentation or help links, users will feel more confident when using advanced syntax.
  • Reduced Support Requests: Documentation or help links will reduce the number of support requests related to advanced syntax.

Q: What are the benefits of Restricting Advanced Syntax for Simpler Mode?

A: The benefits of Restricting Advanced Syntax for Simpler Mode are:

  • Improved Accessibility: Restricting advanced syntax will make the BI editor more accessible to non-technical users.
  • Reduced Confusion: By providing a simpler interface, users will be less likely to get confused by advanced syntax.
  • Increased Productivity: The simpler interface will save users time and effort by allowing them to build expressions quickly and easily.

Q: What is the future development plan for the expression editor UX?

A: The future development plan includes:

Providing More Guidance: Provide more guidance and suggestions for users to help them learn and understand advanced syntax.

  • Improving the Expression Builder UI: Improve the expression builder UI to make it more intuitive and user-friendly.
  • Adding More Features: Add more features to the expression editor UX, such as support for more advanced syntax or the ability to save and reuse expressions.

Q: How will the suggested improvements benefit the users?

A: The suggested improvements will benefit the users by making the BI editor more accessible, user-friendly, and productive. The improvements will reduce the barrier to entry for non-technical users, improve learning and understanding of advanced syntax, and increase productivity by saving users time and effort.