RubyForge ActiveSalesforce Project Page
What is ActiveSalesforce? ActiveSalesforce (ASF) is a Ruby on Rails framework connection adapter that provides direct access to managed data via AppExchange Web services API and Rail's ActiveRecord model layer. Standard and custom objects, standard and custom fields are all automatically surfaced as active record attributes, simplifying the creation of applications that use data from those entities. ASF also includes a aware scaffold generator that leverages layout metadata to generate list, show, edit, and new views and a corresponding controller that closely match the look and feel of their native counterparts.

With ActiveSalesforce, developers can extend and create new composite AppExchange applications directly through the Rails framework. To learn more about the AppExchange and how to create and share on demand applications through this service, visit Apex Developer Network.

ActiveSalesforce is an open source project created and managed by the AppExchange developer community. support cannot provide assistance with your use of this code. Developers can find community support available via the message boards at, or the ActiveSalesforce Help forum.

How do I get started
with ActiveSalesforce?
ActiveSalesforce is distribed via RubyGems, and is available via a few simple steps. In addition to requiring Rails, you'll need either a Enterprise Edition or Developer Edition account; if you don't have one already, you can get a free Developer Edition account here.

To get started, install ActiveSalesforce:

For Rails 2.x and later:

$ gem install activerecord-activesalesforce-adapter

For Rails 1.x:

$ gem install activesalesforce

If you haven't already done so, generate your rails app:

$ rails yourappname

For Rails 1.x only: Open the config/environment.rb file to add the required dependancy. At the end of the

" do |config|"
block, add:

require 'activesalesforce'

Next, edit the database.yml file to add your account information.

adapter: activesalesforce
username: salesforce-username
password: salesforce-password

Thats it! You can now generate Rails for all of your AppExchange objects just as you would for a local database table.

NOTE: If you want to access your Salesforce Sandbox account this to your config.yml activesalesforce entries


How do I get started with Rails? There are a number of great resources available to get you up an running quickly with rails. For help getting your rails environment setup, you can visit the wiki's getting started page.