How to download Project or Solution

After the first start of The Welkin Suite IDE, you can see a shell with no opened projects.

The first start

In order to start developing, you need to download your project from Salesforce org. To start the New Project Wizard, navigate to the Main Menu: File ⇒ New ⇒ Project…, or press the Ctrl+Shift+N hotkey.

Downloading new project

Create Project Window

The New Project Wizard determines which type of a project you are going to create, and it gathers basic information, such as the project name and the location, in which all the project files will be stored.

New project window

In this window, you can select a type of a project that you need:

  • Salesforce Analytics — a unique type of projects that helps you to visualize data from different sources in a specific way,
  • Salesforce Project — a universal project that covers all of the basic needs for Salesforce Development,
  • The Welkin Suite Solution — an empty solution with no projects.

By default, all projects are stored in the users Documents\The Welkin Suite\Projects folder, but you can change the location for each project by entering a path manually, or navigating to the required folder by pressing the Browse… button. Please note that a specified location determines the parent folder for a project. The Welkin Suite automatically creates a folder with the same name as the Project, and if you select the Create directory for solution checkbox, it will create a folder for a solution too.

On the screenshot above, the project would be saved in C:\Users\1\Documents\The Welkin Suite\Projects\InternalProjects\Toolbox and as a result, we will have the Toolbox project in the InternalProjects solution.

After entering this information, you need to click the OK button and specify the Salesforce specific information in the Download Project window.

Download Project Window

Entering credentials

In the Download Salesforce Project window, you need to select the environment type (Production / Development or Sandbox) and enter the Salesforce credentials.

Download project window

Salesforce environment, Username, and Password are required fields, while the Security Token is optional — only if you have configured an org to allow logging in without the Security Token, you can omit the Security Token.

If you forget to enter the security token, you will get the error message.

Enter security token error

In addition, you can skip entering credentials and avoid storing them in the IDE by using the OAuth functionality. Check the corresponding checkbox, and you will need only to select an environment type.

Selecting metadata

Once you have filled in all the required information and pressed the Next button, the metadata downloading process begins. At this step, the IDE sends multiple requests to Salesforce to get the available list of supported metadata items for your TWS project. Each request is related to the specific metadata type, and as a result, each response from the server is handled separately. This way, the metadata appears in the list right after the IDE receives the information about it. The progress of the download process for your metadata files is displayed for you to track, thus allowing you to cancel loading of the files for some metadata type if necessary.

Next, you get a window with the list of metadata files that will be pulled from Salesforce. Please select the files you want to download within your project.

The preselected list of metadata types depends on the IDE layout that you use. You can also change the selection of the metadata types or click the button at the top of the window to change the preset: Use admin preset / Use developer preset.

When creating a new project during the metadata components selection step, you can see a list of all managed packages in the Organization, so you can select whatever ones you'd like to include into your TWS project.

NB: If in some of your managed package there are metadata types that the IDE doesn't currently support, these files will be skipped, and if a managed package contains only such files, you will see a notification that this package couldn't be added to your TWS project since no files are supported.

Download project components

NB: You can always go back to this window later, by navigating to the Main Menu: Project ⇒ Project metadata components or from the context menu of the Solution explorer. So no need to worry if you do not select some type of metadata at this stage.

Each of the items on the list of metadata components can be expanded. If you choose to expand, you will see a list of separate files that will be downloaded in terms of a certain metadata type. By default, all of them are checked, but you can deselect those files you don't want to be downloaded at the moment.

Metadata components expanded


This window also features the Subscribe button across each type of metadata components. By clicking this button, you subscribe to any file updates for this metadata type. This means that next time you pull files from your Salesforce org, the new files in the metadata you subscribed for will be downloaded automatically. In addition, this option implies to any metadata that isn't created on your Org yet: you'll automatically get its files after the pull process.

Subscribe to metadata components

Additional options

After you are done selecting the necessary components, click the Next button. At the next step, The Welkin Suite asks you whether you want to synchronize your project structure with the Salesforce org and to apply Ant support.

Project downloading sync options

NB: The ability to sync project structure is available for Sandboxes and Developer orgs only. If you are downloading a Production project, you'll still get this window, but the checkbox won't be selectable.

Downloading the project

Once you choose, click the Next button and the download process is started.

Downloading project

Upon its completion, you will receive the successful message.

Download succeeded

When the project is downloaded, you can start working with it immediately by pressing the Finish button.

Project Loading Process

When a project is downloaded or when you open an existing project in The Welkin Suite, it will perform multiple actions to guarantee the best experience throughout development. Some of them are:

  • it logs in to Salesforce and maintains a permanently opened connection, so it doesn’t have to log in on each build or pull request;
  • it loads the project structure and displays it in the Solution Explorer;
  • it analyzes the code and fills the code completion database;
  • it restores opened files in the editor.

During the loading process, The Welkin Suite will consume more CPU and RAM resources to do this as quickly as possible. Depending on the size of the project, it may require different time from one second for relatively small projects and up to a minute or two for huge projects with thousands of files in them.

In this section:

This also may be useful:

Last modified: 2018/02/14 16:55

footer image