DataVoke Development Best Practices

Naming Conventions

The following naming conventions allow you to easily determine an item's function:  

Hints

  • Record Type Hint - Hints are displayed in PinPoint Search results under the title and are useful when determining the purpose of a record type when searching.
  • View Hint - The view hint is displayed under the title in PinPoint Search results and can help describe the view to other developers.  They are also visible to the user if they hover over the View tab.  
  • Property Hints - These hints are displayed under the Title in the Property Details tab and are useful in determine the property's function.  They are also displayed to the user in form views.   When using properties in Form views it is important to remember how large the form field is going to be in relation to the length of the hint.
  • Action Hints - Action hints are visible under the Action name in the Action & Events tab of the view editor.  Here they are useful in determining the action's function.  They are also visible to the user when they hover over the button on a view.

View Standards

  • Maximized - Views can be maximized in 2 ways.  
    • Set to maximized with a default width of 100% and height of 100%
    • Use the Alter View Settings action.
  • Native Close Button - Its helpful to hide the Native View Close button(s) of your view(s) if there is logic associated with your close action.
  • Remove Unneeded Properties - Removing unnecessary properties from a View helps to optimize download time.

Actions

  • Remove Unneeded Actions - Any unneeded actions should be removed from your views to optimize loading speed.  
  • Comments - Commenting individual actions in an action chain allows you to easily determine what each action is doing within the chain.
  • Close Action Comment - Should include Name or ID of the view that is being closed. - ex: Close the "Select User" view.  
  • Automation Actions  - Using the default macro icon allows you to easily determine which actions are not called from buttons on a view.
  • Troubleshooting - Use message boxes between actions in an action chain to display variables when troubleshooting.

Variables

  • Clearing Variables - Variables should be cleared ('') once they are no longer needed or the user closes the view.
  • Multi-functional Views
  • Using separate variables for background views allows the view to potentially be multi-functional by passing that variable to another View. 
  • Actions added to a background view can be called from other open views for added 'hidden' functionality using variables.
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.