Ajax Tools

Contents

Overview

This package contains a collection of tools for developers working with AJAX toolkit to build s-controls. Included in the package are: A syntax-highlighting editor that can load/save s-controls/apex code directly from your account at salesforce.com; extensive code samples for the toolkit, dojo, and the UI in a handy code browser; a javascript shell with completion and input history -- very handy for trying commands against the API; and a SOQL Explorer for browsing your data schema and building SOQL queries.

How to install

Ajax Tools is listed on AppExchange as a managed package and can be installed into your org by following the steps below:

1. Click on the version of Ajax Tools you would like to install


2. Press the "Get It Now" red button

3. Select "Current Salesforce administrator" and enter your username and password and hit "Continue"

4. Follow the instructions to select the security level and install

5. Once installed, Ajax Tools will show up as an AppExchange application in the pick list at the top right section of the page. Select "Ajax Tools" from this pick list.


Image:ajax_tools_appex.jpg

6. Then click on the "Ajax Tools" tab and "Start AJAX Tools" button.

7. This will open Ajax Tools in a new window.

What is new in 1.0.2

  1. Nineteen Apex Samples
  2. Document browser
  3. Generate sample scontrol from selected query in explorer
  4. Update to API version 9.0
  5. Update to Dojo version 0.4.1


What is new in 0.9.5

  1. Test page for Apex package
  2. Better template wizard
  3. Basic list view template
  4. Check for upgrades
  5. Use +/- icons instead of up/down icon in shell and explorer
  6. Fix IE bug: resize editor frame
  7. Fix IE bug: tab completion in IE
  8. IE bug: picklist not displayed in explorer
  9. Add Apex templates
  10. Display scrollbar for apex/scontrols list
  11. Tooltip for icons

Support

If you need help to install/use Ajax tools, if you found a bug or you have a suggestion, please post a message to the message boards or send us a mail. Thanks.


Keymap

Command Key
Save Ctrl-S
Run Ctrl-;
Shell Ctrl-D
Close dialog Esc
Select all Ctrl-A
Copy Ctrl-C
Cut Ctrl-X
Past Ctrl-V
Undo Ctrl-Z
Find Ctrl-F

Working with Apex

Creating a new Apex package

To create a new Apex package click the new button in the icon bar.



Image:ajax_tools_new_button.jpg

This will bring up a list of templates that can be used to generate Apex package.



Image:ajax_tools_template.jpg

Select the template from the list. This will take you to the template wizard like the one shown below.



Image:ajax_tools_wizard.jpg

Enter the name of the apex package and click next. This will generate a simple apex package and load it in the editor.



Image:ajax_tools_apex_edit_page.jpg


Compiling & Saving Apex code

Click the Save button in the icon bar to compile and save Apex package. You can also press Ctrl-S in the editor to compile and save. If there is an error in the Apex code, then the code is not saved. An error message is displayed in the status bar (bottom of the page).



Image:ajax_tools_apex_error.jpg


Testing Apex code

AJAX tools makes it really easy to test Apex code. It can generate a test page for all WebService methods in your apex package. To invoke WebService methods from test page click the Run icon in the icon bar or press Ctrl-; in the editor.



Image:ajax_tools_test_page.jpg

Enter the parameters for the apex method in the test page form and click invoke button to execute apex code. Result returned from the apex method is displayed at the bottom of the test page.

Working with SControls

TODO

SOQL Explorer

todo

Debug shell

todo

Samples

todo

Todo

  1. More useful templates - editview, quick search, etc
  2. Back up scontrols to document/ajaxtools_backup folder
  3. Save session state/config
  4. Add Apex sample
  5. Fix template syntax and doc how to write a new template
  6. Fix IE bug: tab completions in shell, options in explorer
  7. Provide system info page: version no, api perf, limits etc
  8. Make describe call in explorer async
  9. Make explorer editable
  10. Keep a list of status messages
  11. Show progress bar/icon
  12. Option to generate javascript code for the selected soql in explorer
  13. Format scontrol/apex code
  14. Option to view/copy plain text
  15. Display apex compile errors in-line
  16. Getting started guide/more docs
  17. Ignore case for tab completion in shell
  18. Display apex/scontrols as tab in the open window
  19. Support document editing
  20. Customize key mapping
  21. Go to line number in editor
  22. Support Apex trigger
  23. Support Merge fields in SControl
  24. Warn user if they close editor with unsaved changes
  25. Bug: editor marks page as modified when it is loaded first time
  26. Provide a hot key Ctrl-N to search for scontrol/apex