Skip to content

acrosman/electronForce

Repository files navigation

Lint Status CodeQL Status

ElectronForce

ElectronForce is an Electron based Salesforce Org exploration tool using the JSForce library to leverage the Salesforce APIs. Currently it allows you to query and search data, describe objects, review the Organization object, and list all objects in the org.

Quick Start

Right now, while the project is setup to build native applications on Mac, Windows, and Linux, I'm not maintaining builds. So it's a bit developer focused and you'll need to have Node.js installed. Granted this is a largely an API interface so some technical ability is expected but longer-term not the ability to understand JavaScript. Anyway you don't need to know how to use Node just need to have the tools around.

From your terminal:

git clone https://github.com/acrosman/electronForce.git
cd electronForce
npm install
npm start

ElectronForce will allow you to log into your Salesforce Org and interact with some of the APIs. While all of JSForce's supported APIs are listed, only Query, Search, and Describe are currently support.

Log in

Currently only the standard login is supported, not OAuth2, so you likely will need your security token.

In the login fields provide your username, password, and security token. If you are logging into a production or trailhead instance you can use the default login URL. If you are logging into a Sandbox use: https://test.salesforce.com.

ElectronForce Main screen.

The main interface includes the login information, API selector and parameter fields on the left, raw display of the previous API response on the right, and a processed version of the response at the bottom.

Run Query or Search

The SOQL and SOSL Query APIs allow you to run querys and searches using the appropriate Salesforce syntax. When any of the supported APIs are selected appropriate inputs are provided so you can formulate the details of the query. In the screen shot above, a simple Select of Contacts is shown, with a query requesting the record Id and Contact Name.

SELECT Id, Name FROM Contact

At the bottom of the display ElectronForce provides a grid view of the query results:

ElectronForce Search Result Screen..

Note: Contacts shown are from a Salesforce Trailhead not from a production database.

Run Describe

Beyond exploring the data and testing queries, ElectronForce can also allow you to explore the metadata for a specific object provided via the Describe API. Select the Describe API from the selector and enter the name of the object you would like described. ElectronForce will format the resulting structures as an interactive tree view.

ElectronForce Describe Result Screen..

Run Global Describe

Global Describe retreives a list of all object (custom and standard) in your org.

Fetch the Organization Object

All Salesforce Orgs have a single object that describes the org itself. This function gets a list of all the fields on your org's Organization object (so it adds new fields as they are released) and runs a SOQL query to retreive all available data. Note: Not all fields return data via the API.

Disclaimer

This project has no direct association with Salesforce except the use of the APIs provided under the terms of use of their services.

About

A basic Salesforce Org exploration tool written with Electron and JSForce.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages