Frequently Asked Questions

How do I use feature X/Y/Z in Illuminated Cloud?

Illuminated Cloud extends IntelliJ IDEA's existing functionality to include Force.com development with a particular emphasis on Apex and Visualforce.  As a result, most of Illuminated Cloud's features simply apply IDEA's powerful feature set to these source file types.  This means that the exact same mechanisms for performing an action in Java, Javascript, HTML, CSS, etc., are used to perform the same action in Apex, Visualforce, and other Force.com metadata.  These actions can be performed using keyboard accelerators, menu items, and toolbar buttons.

<soapBox>I'll let my own bias show through a bit here.  Using a development tool like IDEA (or Eclipse, NetBeans, Visual Studio, etc.) without learning and/or using the keymap is akin to buying a 600HP supercar and never taking it out of first gear!  I highly recommend that you take the time to learn the keys, and you'll be amazed at how it changes how you write new code and how you gain an understanding of an existing code base!</soapBox>

The following table lists the actions that are explicitly supported by Illuminated Cloud and the default keymap assignments in Windows, Mac OS X, and Linux:

Category Action  Windows / Linux Mac OS X 
Editing Basic code completion Ctrl + Space Ctrl + Space 
Parameter info (within method call arguments)  Ctrl + P  Cmd + P
 Context infoAlt + QCtrl + Shift + Q
Quick documentation lookup  Ctrl + Q  Ctrl + J 
External doc  Shift + F1 Shift + F1 
Show error or warning at caret Ctrl + F1 Cmd + F1 
Comment/uncomment with line comment  Ctrl + / Cmd + / 
Comment/uncomment with block comment  Ctrl + Shift + / Cmd + Opt + /
Select successively increasing code blocks  Ctrl + W Opt + Up 
Decrease current selection to previous state  Ctrl + Shift + W  Opt + Down 
Reformat code  Ctrl + Alt + L Cmd + Opt + L 
Auto-indent line(s)  Ctrl + Alt + I Cmd + Opt + I 
Cut current line or selected block  Ctrl + X or Shift + Delete Cmd + X 
Copy current line or selected block  Ctrl + C or Ctrl + Insert Cmd + C 
Paste  Ctrl + V or Shift + Insert  Cmd + V
Paste from recent buffers...  Ctrl + Shift + V  Cmd + Shift + V 
Duplicate current line or selected block  Ctrl + D  Cmd + D 
Delete line at caret  Ctrl + Y  Cmd + Delete 
Join lines  Ctrl + Shift + J  Ctrl + Shift + J 
Split lines  Ctrl + Enter  Cmd + Enter
Start new line Shift + Enter  Shift + Enter 
Toggle case for word at caret or selected block  Ctrl + Shift + U  Cmd + Shift + U
Select until code block end/start  Ctrl + Shift + ] / [  Cmd + Shift + ] / [
Delete to word end  Ctrl + Delete  Opt + Delete-right
Delete to word start  Ctrl + Backspace  Opt + Delete
Expand/collapse code block  Ctrl + NumPad+/-  Cmd + +/-
Expand/collapse all  Ctrl + Shift + NumPad+/-  Cmd + Shift + +/- 
Close active editor tab  Ctrl + F4  Cmd + W 
       
 Search/Replace Search everywhere  Double Shift Double Shift
  Find Ctrl + F  Cmd + F 
  Find next F3  Cmd + G
  Find Previous Shift + F3  Cmd + Shift + G
  Replace Ctrl + R  Cmd + R
  Find in path Ctrl + Shift + F  Cmd + Shift + F
  Replace in path Ctrl + Shift + R  Cmd + Shift + R 
 
   
Usage Search Find usages  Alt + F7  Opt + F7
  Find usages in file Ctrl + F7  Cmd + F7  
  Highlight usages in file Ctrl + Shift + F7  Cmd + Shift + F7
  Show usages Ctrl + Alt + F7  Cmd + Opt + F7
       
Compile and RunSelect configuration and run (Apex unit tests)Alt + Shift + F10Ctrl + Opt + R
 Run selected configuration (Apex unit tests)Shift + F10Ctrl + R
 Run context configuration from editorCtrl + Shift + F10 Ctrl + Shift + R 
    
DebuggingStep over F8 F8 
 Step into F7 F7 
 Step out Shift + F8 Shift + F8 
 Run to cursor Alt + F9 Opt + F9 
 Resume program F9 Cmd + Opt + R 
 Toggle breakpoint Ctrl + F8 Cmd + F8 
 View breakpoints Ctrl + Shift + F8 Cmd + Shift + F8 
    
Navigation Go to Apex class/trigger  Ctrl + N  Cmd + O
  Go to Visualforce page/component or metadata file Ctrl + Shift + N  Cmd + Shift + O
  Go to Apex symbol Ctrl + Alt + Shift + N  Cmd + Opt + O
  Go to next/previous editor tab Alt + Right/Left  Ctrl + Left/Right
  Go back to previous tool window F12  F12
  Go to editor (from tool window) Esc  Esc
  Hide active or last active window Shift + Esc Shift + Esc
  Close active run/messages/find/... tab Ctrl + Shift + F4  Cmd + Shift + F4
  Go to line Ctrl + G  Cmd + L 
  Recent files popup Ctrl + E  Cmd + E
  Navigate back/forward Ctrl + Alt + Left/Right  Cmd + Opt + Left/Right
  Navigate to last edit location Ctrl + Shift + Backspace  Cmd + Shift + Delete
  Select current file or symbol in any view Alt + F1  Opt + F1
  Go to declaration Ctrl + B or Ctrl + Click  Cmd + B or Cmd + Click 
  Go to implementation(s) Ctrl + Alt + B  Cmd + Opt + B
  Open quick definition lookup Ctrl + Shift + I  Opt + Space or Cmd + Y
  Go to type declaration Ctrl + Shift + B  Ctrl + Shift + B
  Go to super-method/-class Ctrl + U  Cmd + U
  Go to previous/next member declaration Alt + Up/Down  Ctrl + Up/Down
 Go to related symbolCtrl + Alt + Home Ctrl + Cmd + Up 
  Move to code block end/start Ctrl + ]/[  Cmd + ]/[
  File structure popup Ctrl + F12  Cmd + F12
  Next/previous highlighted error F2 / Shift + F2  F2 / Shift + F2
  Edit source / View source F4 / Ctrl + Enter  F4 / Cmd + Down
  Show navigation bar Alt + Home Opt + Home
  Toggle bookmark F11  F3
  Toggle bookmark with mnemonic Ctrl + F11  Opt + F3
  Go to numbered bookmark Ctrl + #[0-9]  Ctrl + #[0-9]
  Show bookmarks Shift + F11  Cmd + F3
 
   
VCS/Local History  Commit project to VCS  Ctrl + K  Cmd + K
  Update project from VCS Ctrl + T  Cmd + T 
  View recent changes Alt + Shift + C  Opt + Shift + C
  VCS quick popup Alt + BackQuote (`)  Ctrl + V
  Go to next/previous VCS change Ctrl + Alt + Shift + Down/Up  Ctrl + Opt + Shift + Down/Up 
       
General Open tool window  Alt + #[0-9]  Cmd + #[0-9]
 New file Ctrl + Alt + Insert Cmd + N
  Save all Ctrl + S  Cmd + S  
  Synchronize Ctrl + Alt + Y  Cmd + Opt + Y
  Toggle maximizing editor/full screen mode Ctrl + Shift + F12  Ctrl + Cmd + F
  Add to Favorites Alt + Shift + F  Opt + Shift + F
  Open Settings dialog Ctrl + Alt + S  Cmd + ,
  Open Project Structure dialog Ctrl + Alt + Shift + S  Cmd + ;
  Find Action Ctrl + Shift + A  Shift + Cmd + A
  Switch between tabs and tool window Ctrl + Tab  Ctrl + Tab
       
Illuminated Cloud Deploy modified metadata Ctrl + Alt + Shift + F9  Cmd + Opt + Shift + F9
  Deploy all metadata Ctrl + Alt + Shift + F10  Cmd + Opt + Shift + F10 
 Force save Ctrl + Alt + Shift + F12 Cmd + Opt + Shift + F12 
  Retrieve metadata Ctrl + Alt + Shift + Y  Cmd + Opt + Shift + Y 
 Refresh metadata Ctrl + Alt + Shift + R Cmd + Opt + Shift + R 
 Delete metadata Ctrl + Alt + Shift + DCmd + Opt + Shift + D 
 Generate offline symbol table Ctrl + Alt + Shift + GCmd + Opt + Shift + G
 Preview Visualforce page or Lightning app Ctrl + Alt + Shift + P Cmd + Opt + Shift + P 
 Execute anonymous ApexCtrl + Alt + Shift + ACmd + Opt + Shift + A

Execute SOQL queryCtrl + Alt + Shift + QCmd + Opt + Shift + Q
 View Apex logs Ctrl + Alt + Shift + ZCmd + Opt + Shift + Z 
 Configure application-level settings Ctrl + Alt + Shift + ;Cmd + Opt + Shift + ; 
 Configure project-level settingsCtrl + Alt + Shift + ,Cmd + Opt + Shift + .
 Configure module-level settingsCtrl + Alt + Shift + ,Cmd + Opt + Shift + , 

Full descriptions of the default keymaps are available from JetBrains:
To ease the transition for those coming from other IDEs and editors, IDEA includes alternative keymaps that mimic the behavior of tools such as Eclipse, NetBeans, Visual Studio, and Emacs.


I've installed the plugin but nothing has changed in IDEA.  What's wrong?

There are a few reasons this might happen:

Incorrect file type associations

If you've used IntelliJ IDEA to edit Force.com source files prior to installing Illuminated Cloud, it's possible that some of Illuminated Cloud's file extensions are already associated with other file types.

To resolve this issue, open Settings>Editor>File Types and verify that the following file type associations exist, re-establishing them if necessary:
  • Apex Class - *.cls, *.trigger, *.apex, and *.soql
  • Apex Metadata - *-meta.xml
  • SObject Type - *.object
  • Visualforce Page - *.component and *.page
Additionally make sure that the extension *.resource is not associated with any file type.  The easiest way to do this is to try to associate that extension with any existing file type.  IDEA will show any existing association.  In either case, remove either the newly-created association or the existing association.

Illuminated Cloud automatically associates all other Force.com metadata extensions with the XML file type.

Other

If the issue is still not resolved, please log a bug or contact me.


Why isn't completion/navigation/etc. working properly?

There are a few reasons this might happen:

The Offline Symbol Table has never been generated or needs to be regenerated

When new packages are installed in the org, metadata is deployed outside of Illuminated Cloud, or after a Salesforce platform upgrade, the Offline Symbol Table can become stale.

To resolve this issue, (re)generate the Offline Symbol Table from Settings>Illuminated Cloud (connection name)>Generate.

Module dependencies are not configured properly for base packages and extension packages

IDEA's project configuration allows modules to depend on other modules.  Illuminated Cloud uses this information to resolve references, in particular when developing metadata for multiple managed packages in a single development organization.

To resolve this issue, configure the appropriate module dependencies in Project Structure>Project Settings>Modules.  Under the Dependencies tab for the dependent modules, click the + button, then Module Dependency..., and select any dependency modules.  Make sure to click OK or Apply to save the module settings.
Module dependencies
After making these changes, you may want to rebuild caches as described below.

Illuminated Cloud's caches and indices are stale or inconsistent

Both IDEA and Illuminated Cloud use file-based indices and in-memory caches to provide quick access to features such as completion and navigation.  While inconsistency in these caches and indices should be rare, it can happen.  When it does happen, features can behave improperly.

To resolve this issue, you can ask IDEA and Illuminated Cloud to rebuild their caches and indices.  To rebuild only Illuminated Cloud's caches and indices, open Settings>Illuminated Cloud (connection name) and press the Rebuild button.  It is highly recommended that you restart IDEA to ensure that caches and indices are properly rebuilt.

If for some reason this doesn't resolve the issue, you can rebuild all of IDEA's caches and indices using File>Invalidate Caches / Restart....  Note that indexing may take several minutes after IDEA is restarted.


Why aren't my custom objects and/or fields showing up in the Offline Symbol Table stub Apex classes?

Illuminated Cloud builds stub Apex classes for all accessible SObjects in the development organization as part of its Offline Symbol Table.  All accessible SObject fields and relationships are translated into Apex member variables of the appropriate type for use in Apex, SOQL, and SOSL.  Any inaccessible SObject fields and relationships will not be included in the generated stub Apex classes.

To resolve this issue, verify that the missing fields are authorized for the user credentials configured in the Illuminated Cloud connection.  Once the fields are properly authorized for the user, regenerate the Offline Symbol Table.


Why does Offline Symbol Table generation take so long?

In order to create its Offline Symbol Table, Illuminated Cloud uses the Force.com Tooling, Metadata, and Partner APIs to retrieve various subsets of metadata.  The good news is that this is an infrequent operation; the bad news is that it can take a while based on the volume of metadata deployed to your organization, your organization edition/type, the number of installed packages, and the performance of your organization's host instance at the time.

Be assured that I'm always looking for ways to make this operation more efficient!


Offline Symbol Table generation failed.  What do I do now?

Because Offline Symbol Table generation can be a lengthy operation (see above), Illuminated Cloud caches the information for each key step so that it can resume in the case of a failure.  Just try running the operation again and it should quickly resume at the point of failure.  If it continues to fail, please log a bug or contact me.


Why aren't my metadata files deploying and/or retrieving? Why are unwanted metadata files deploying and/or retrieving?

Illuminated Cloud can be configured on a per-module basis for the metadata content that should be associated with each module.  The available options for metadata content selection are:
  • All/Package - If the module is not configured for a development package, all metadata in the local filesystem for the module is deployed and all metadata in the organization is retrieved.  If the module is configured for a specific development package, all metadata in the local filesystem for the module is deployed and only the metadata associated with that package is retrieved.
  • Package.xml - Only the metadata specified in the selected package.xml file is deployed and retrieved.
  • Selected - Only the selected metadata in the tree is deployed and retrieved.  If the set of metadata isn't current, use the Refresh button to update the tree contents with the latest metadata in the organization.
To resolve this issue, verify that the desired option is selected in the Project Structure>Project Settings>Modules>module name>Illuminated Cloud under the General tab.  If the Package.xml option is used and the deployed/retrieved metadata is still not as expected, verify that the package.xml is correct.  If the Selected option is used and the deployed/retrieved metadata is still not as expected, Refresh the metadata tree and verify that the selections are correct.  If the metadata tree contents are not correct after being refreshed, verify that the user associated with the Illuminated Cloud connection is authorized for the missing content.


Why does Illuminated Cloud keep telling me my evaluation period is about to expire/has expired?

Have you purchased a license key for Illuminated Cloud?  If not and you wish to continue using Illuminated Cloud after the 30-day evaluation period, or if you have purchased a license but don't know how to use the provided license key, please follow the instructions for purchase and activation.

If you have followed the instructions for activating Illuminated Cloud and are still being warned about the evaluation period, please log a bug or contact me.


Can I use my Illuminated Cloud license on another machine?

Each registered license for Illuminated Cloud purchased under introductory pricing (June 30, 2015-November 30, 2015) entitles one user to activate Illuminated Cloud on one machine.  Each registered license for Illuminated Cloud purchased under standard pricing (December 1, 2015 and later) entitles one user to activate Illuminated Cloud on two machines.  If you need to use Illuminated Cloud on more than the licensed number of machines, please purchase additional licenses.  If you need to move your Illuminated Cloud license to another machine, you may deactivate the license on the current machine and it will be available to activate on the new machine.  If you do not have access to the original machine or are experiencing other issues deactivating a license, please contact me.


How do I uninstall/remove Illuminated Cloud from IDEA?

I'd certainly like to understand why you want to uninstall or remove Illuminated Cloud from IDEA!  If you're doing so because of a bug or missing feature, please log a bug or enhancement request or contact me with the details using the information below.

If you still want to uninstall Illuminated Cloud from IDEA, follow these steps:
  1. If you have a registered license for Illuminated Cloud, please deactivate the license first so that it is available to be activated elsewhere if desired.  You can deactivate the license in Settings>Illuminated Cloud>About by clicking Deactivate license on this machine.
  2. To uninstall the Illuminated Cloud plugin, open Settings>Plugins and either type Illuminated Cloud into the search box or scroll to Illuminated Cloud in the list of installed plugins.  Select the plugin and click Uninstall plugin in plugin details on the right-hand side.  Click OK and restart IDEA.
If for some reason this process doesn't work properly to uninstall the plugin, you can manually uninstall the plugin:
  1. Make sure that IDEA is not running.
  2. Find IDEA's user configuration directory.
  3. Under that directory find the sub-directory config/plugins.
  4. Under that directory you should find a sub-directory named IlluminatedCloud.  You can either delete this directory or move it outside of the user configuration directory.