[Home]

Specifying the Scope for Bulk Metadata Operations

You'll use a similar set of options to specify the scope for all bulk metadata retrieval, metadata deployment and metadata removal operations, so it's important that you understand each of the available options to effectively utilize these critical features.

The name of the dialog — as well as some of the context-specific options — will vary based on the operation you've selected, but the majority of the functionality is the same. The common elements are described below, while the options that are available only for specific operations are covered in their respective topics.

Connection — Select the connection for the org against which you want perform bulk metadata operations. The selection defaults to the current module's configured connection. To prevent you from accidentally deploying to another organization, you have to explicitly select another connection (e.g., for your production org).

Click the edit pencil to manage the project's module/connection associations and/or to create new connections. New connections will be added to the drop-down list for selection.

Contents — Select the broad subset of metadata to include in the deployment, retrieval, or removal operation. You can then filter this to a more fine-grained selection.

NOTE: In IntelliJ IDEA, a single project can support multiple modules. Other JetBrains IDEs support a 1:1 project/module relationship, so Module, Module and dependencies, and Project essentially behave the same.

• Module — Includes the metadata for the module from which the operation was initiated.

• Module and dependencies — Includes the metadata for a module from which the operation was initiated and its transitive dependencies.

• Project — Includes the metadata for all modules in the project.

• Context — Includes the metadata for files, directories, and/or modules related to the item(s) selected when you initiated the operation (e.g., a directory in the source tree or a single Apex class).

  NOTE: Illuminated Cloud automatically defaults to this option whenever you use a context menu action to initiate a metadata operation.

• Custom — Displays the metadata for all modules in the project allowing for explicit selection of a subset of that metadata by the user. Illuminated Cloud persists your last custom selections for the connection for each operation (deployment, retrieval, and removal), making it easy for you to see the custom metadata you selected for previous operations and optionally use the same set.

You can also click the edit pencil to change your metadata subscription from here. You can change the type of subscription or the specific contents your current subscription if you’re using a Selected metadata subscription type. The dialog is automatically refreshed to include any changes made to your metadata subscription.

Now that you've chosen the org and broader subset of metadata that you want to perform the operation against, you can use the available options to further refine the metadata you see in the selection tree below. The options are initially pre-selected based on what makes the most sense for the operation you selected to launch this dialog, and the most recent selections for each operation are retained across invocations.

NOTE: If you don’t see the metadata you want to work with, Illuminated Cloud's list of the org's metadata might be stale. Click the Refresh icon to update your view with the latest list of metadata from the selected connection.

• Local Only — Includes the metadata that exists only in the local project (highlighted in green). To add it to the project on the server, you can deploy it.

• Local + Server — Includes the metadata that exists in both places (highlighted in blue). To update the server version from the local version, you can deploy it; to update the local version from the server version, you can retrieve it.

• Server Only — Includes the metadata files that are found only on the organization server (highlighted in red). To include it in your local project, you can retrieve it.

• Subscribed Only — Includes only the metadata for which you’re explicitly subscribed based on the subscription type you selected. (Recommend you keep this checked unless you want to see server only metadata and optionally retrieve unsubscribed metadata into the local project.)

• Subscribed by Parent — Includes the metadata you’re implicitly subscribed to based on any parent-child relationships inherent in your metadata subscription.

[Home]