rhoconnect-adapters is a ruby library containing a collection of the out-of-box RhoConnect applications for various needs.
With rhoconnect-adapters, you can utilize the pre-built set of RhoConnect applications for popular CRM backends (SalesForce, Oracle CRM On Demand, Sugar CRM, etc.). Also, this library includes support for writing your own RhoConnect CRM applications to extend or customize the default functionality.
Install the 'rhoconnect-adapters' gem by using the following command:
$ [sudo] gem install rhoconnect-adapters
The 'rhoconnect-adapters' command creates pre-built RhoConnect applications. Visit the RhoConnect website for more information.
To create a standard out-of-the-box rhoconnect CRM application use the following command:
$ rhoconnect-adapters crmapp <app_name> <CRM-backend>
Here, the <CRM-backend> parameter specifies the CRM backend that your application will use. Currently, the following CRM backends are supported:
- MsDynamics (for Microsoft Dynamics CRM)
- Salesforce (for Salesforce CRM)
Also, you can generate the application for the following backends but they are not officially supported (initial test and development has been done, but currently there is no on-going test support):
- OracleOnDemand (for Oracle CRM On Demand)
- Sugar (for Sugar CRM)
The generated Rhoconnect CRM application structure will include typical RhoConnect
files (for example, application.rb and settings.yml). It will also create a special vendor directory vendor/\<CRM\-backend\>
containing all support files specific for the corresponding CRM backend.
By default, the Rhoconnect CRM application will be generated with four standard source adapters corresponding to the following CRM objects:
- Account
- Contact
- Lead
- Opportunity
In some cases, it is necessary to generate an application without any standard sources.
For this purpose, use the --bare option to generate just the application's skeleton.
rhoconnect-adapters crmapp <app_name> <CRM-backend> --bare
Once you create your Rhoconnect CRM application, you can generate the desired source adapters based on the CRM objects by typing the following command in your application's directory:
rhoconnect-adapters crmsource <CRM-object-name> <CRM-backend>
Here, <CRM-object-name> must exactly correspond to the name of the CRM object you're trying to build the source adapter for.
All OracleOnDemand-specific settings are located in the vendor/oracle_on_demand/settings directory.
In the file settings.yml you'll find the entries that you must customize before running the app.
These are:
- :oraclecrm_service_url: <oracle_web_services_integration_url> - substitute the default URL with your OracleOnDemand account URL.
For every source adapter based on CRM object there is a corresponding 'vendor/oracle_on_demand/settings/<CRM-object-name>.yml' file containing the descriptions for the OracleOnDemand CRM object. Every CRM object file has the following entries:
Query_Fields: hash of the objects's fields
(each field's element has the value
in a form of the hash with the field's options ,
containing the following data):
Label => <val> - display name of the field
Type => <val> - type of the field data
(textinput, textarea, Picklist, id, etc.)
NonQuery_MappingWS_Fields: object's fields that can not be used
in OracleCRM Queries
(however, Oracle returns them in GetMapping API)
StaticPickList: Normally, all picklist fields are queried
for the allowed values using GetPicklistValues API
However, for certain fields OracleCRM API
returns the error 'not a valid picklist'
This entry is a workaround for this error -
fields's picklist values are statically hard-coded here.
ObjectFields: this one specifies a hash of fields
that are actually references to other objects.
For example, AccountName field for Contact object
is really a reference to the corresponding Account object.'
TitleFields: this setting specifies an array of fields
used in constructing the object's title in the 'Show' page
using the Metadata method. Typically, you will want to put
`name` fields in here.
For the default generated CRM object adapters, this file is pre-filled with information. However, you can customize it by including or excluding options. For custom adapters, you need to fill this file with relevant information. List of object's fields, for example, can be obtained from the Oracle CRM On Demand documentation and then later used to fill the Query_Fields setting. Alternatively, user can customize the adapter and obtain the list of fields using the GetMapping API.
All MsDynamics-specific settings are located in the 'vendor/ms_dynamics/settings' directory. In the file 'settings.yml' you'll find the entries that are necessary to customize before running the app. These are:
- :msdynamics_ticket_url: <msdynamics_web_services_integration_url> - substitute the default URL with your MsDynamics account URL.
For every source adapter based on CRM object there is a corresponding 'vendor/msdynamics/settings/<CRM-object-name>.yml' file containing the descriptions for the MsDynamics object. Every CRM object file has the following entries:
Query_Fields: hash of the objects's fields
(each field's element has the value
in a form of the hash with the field's options ,
containing the following data):
Label => <val> - display name of the field
Type => <val> - type of the field data
(textinput, textarea, Picklist, id, etc.)
AttributeTypePicklists: this is a hash of picklist arrays
for artificially constructed fields
that are really represent some other field's type
for example, `customerid` field can be either
`account` or `contact`. In this case
field `customertype_attrtype` will represent `customerid` field's type
and will take values from the `AttributeTypePicklists`
array for the field `customerid_attrtype`
ObjectFields: this one specifies a hash of fields
that are actually references to other objects.
For example, `account_name` field for Contact object
is really a reference to the corresponding Account object.
TitleFields: this setting specifies an array of fields
used in constructing the object's title in the 'Show' page
using the Metadata method. Typically, you will want to put
`name` fields in here.
For the default generated CRM object adapters, this file is pre-filled with information. However, you can customize it by including or excluding options. For custom adapters, you need to fill this file with relevant information. List of object's fields, for example, can be obtained from the MsDynamics documentation and then later used to fill the Query_Fields setting. Alternatively, user can customize the adapter and obtain the desired list of object's fields using the MsDynamics SOAP API.
All Sugar-specific settings are located in the 'vendor/sugar/settings' directory. In the file 'settings.yml' you'll find the entries that are necessary to customize before running the app. These are:
- :sugarcrm_uri: <oracle_web_services_integration_url> - substitute the default URL with your OracleOnDemand account URL.
- :debug_enabled: <true/false> - enable debug output of the backend HTTP transactions.
For every source adapter based on CRM object there is a corresponding 'vendor/sugar/settings/<CRM-object-name>.yml' file containing the descriptions for the Sugar CRM object. Every CRM object file has the following entries:
Query_Fields: hash of the objects's fields
(each field's element has the value
in a form of the hash with the field's options ,
containing the following data):
Label => <val> - display name of the field
Type => <val> - type of the field data
(textinput, textarea, Picklist, id, etc.)
ObjectFields: this one specifies a hash of fields
that are actually references to other objects.
For example, `account_name` field for Contact object
is really a reference to the corresponding Account object.
TitleFields: this setting specifies an array of fields
used in constructing the object's title in the 'Show' page
using the Metadata method. Typically, you will want to put
`name` fields in here.
For the default generated CRM object adapters, this file is pre-filled with information. However, you can customize it by including or excluding options. For custom adapters, you need to fill this file with relevant information. List of object's fields, for example, can be obtained from the SugarCRM documentation and then later used to fill the Query_Fields setting. Alternatively, user can customize the adapter and obtain the desired list of object's fields using the SugarCRM REST API.
All Salesforce-specific settings are located in the vendor/salesforce/settings directory.
In the file settings.yml you'll find the entries that you must customize before running the app.
These are:
- :salesforce_login_url: <salesforce_soap_login_url> - Currently, this parameter is pre-defined to
https://login.salesforce.com/services/Soap/c/24.0for simple SOAP web service authentication. Rhoconnect-adapters is not usingOAuth2scheme at this point.
For every source adapter based on CRM object there is a corresponding 'vendor/salesforce/settings/<CRM-object-name>.yml' file containing the descriptions for the SalesForce CRM object. Every CRM object file has the following entries:
Query_Fields: hash of the objects's fields
(each field's element has the value
in a form of the hash with the field's options ,
containing the following data):
Label => <val> - display name of the field
Type => <val> - type of the field data
(textinput, textarea, Picklist, datetime, id, etc.)
ObjectFields: this one specifies a hash of fields
that are actually references to other objects.
For example, AccountId field for Contact object
is really a reference to the corresponding Account object.'
TitleFields: this setting specifies an array of fields
used in constructing the object's title in the 'Show' page
using the Metadata method. Typically, you will want to put
`name` fields in here.
For the default generated CRM object adapters, this file is pre-filled with sample information. However, you can customize it by including or excluding
different fields. For custom adapters, you need to fill this file with relevant information. List of object's fields, for example, can be obtained
from the Salesforce documentation and then later used to fill the Query_Fields setting. Alternatively, user can customize the adapter and obtain
the list of fields using the /sobjects/<CRM-object-name>/describe/ API.
If your application's model has a lot of data, when you might wanted to paginate through backend service data instead of fetching everything in one call. RhoConnect API provides
stash_result method to do it.
For example, straightforward way to query data in Salesforce CRM adapter is
:::ruby
def query(params=nil)
@result = {}
fieldquery = ""
@fields.each do |element_name, element_def|
fieldquery << ",#{element_name}"
end
fieldquery[0] = " "
querystr = "SELECT #{fieldquery} FROM #{crm_object}"
requesturl = @resturl + "/query/?q=" + CGI::escape(querystr)
raw_data = RestClient.get(requesturl, @restheaders)
parsed_data = JSON.parse raw_data
if parsed_data['done']
parsed_data["records"].each do |record|
record_hash = {}
@fields.each do |element_name, element_def|
record_hash[element_name] = record[element_name]
end
@result[record['Id']] = record_hash
end
else
# TODO: queryMore
end
@result
end
In the case, if you wanted paginate through backend data the same query method should be rewritten as
:::ruby
def query(params=nil)
fieldquery = ""
@fields.each do |element_name, element_def|
fieldquery << ",#{element_name}"
end
fieldquery[0] = " "
# Paginate into (large) result sets staring with offset = 0 and page_sz = 100
offset, page_sz = 0, 100
loop do
querystr = "SELECT #{fieldquery} from #{crm_object} limit #{page_sz} offset #{offset}"
requesturl = @resturl + "/query/?q=" + CGI::escape(querystr)
raw_data = RestClient.get(requesturl, @restheaders)
parsed_data = JSON.parse raw_data
@result ||= {}
parsed_data["records"].each do |record|
record_hash = {}
@fields.each do |element_name, element_def|
record_hash[element_name] = record[element_name]
end
@result[record['Id']] = record_hash
end
stash_result # => @result is nil now
break if parsed_data['done']
offset += page_sz
end
end
rhoconnect-adapters gem provides reference implementation of paginating in query method for Sugar, Salesforce, and OracleOnDemand adapters.
Once your Rhoconnect application is customized and ready to run, you can start it like any other Rhoconnect app. Type the following command in the CRM application's root directory:
rake rhoconnect:start
Created and maintained by Rhomobile Inc.
Released under the MIT License.