Object
   |
   +--Klip
         |
         +--Engines
               |
               +--Engines.SalesforceReports

This object is an advanced feature that is only available in the licensed, commercial version of Klipfolio Dashboard. Contact Klipfolio for further details.

The Engines.SalesforceReports object gives developers access to the CSV reports in Salesforce.com. The report to be used as the Klip's content source must be available for the user's account under the Reports tab of Salesforce.com in a browser.

While both this object and the Engines.Salesforce object provide you with methods to access data from Salesforce.com, note the following differences when considering which engine to use for your Salesforce Klip:

Engines.SalesforceReports

• Does not require the Salesforce extension in Klipfolio Dashboard; therefore, Klips using this object can be added to any Klipfolio Dashboard build after version 5.2.1
• Accesses the CSV reports under the Reports tab in Salesforce.com and does not use the API offered by Salesforce.com
• The Login UI, if required, must be written using the available Klipfolio Dashboard APIs
• Cannot send queries to the Salesforce.com database; therefore, reports must already be available under the Reports tab
• Useful when you simply want to retrieve and display data from any of the available CSV reports under the user's accounts

Engines.Salesforce

• Klipfolio Dashboard must have the Salesforce extension included in the application
• Uses the Force.com API offered by Salesforce to access the data
• Can be (but does not need to be) used in conjunction with the Engines.SalesforceLogin object to set up the login UI
• Can send queries to the Salesforce.com database that are supported by the Force.com API
• Useful when you want to include advanced functionality in your Salesforce Klip, such as the ability to change the status of a record

Since:
5.2.1

---

Properties Summary
String	lastError            Information about the most recent error.
String	lastErrorCode            The latest error code that was returned by the SalesforceReports engine.

   

Function Summary
String	getBaseAddress()            Gets the base address for Salesforce.com.
String	getErrorDetails()            Gets detailed information about the latest error and displays lastError, lastErrorCode and lastErrorDetail with labels in the Debug Window.
String	getReport( ReportURL )            Retrieves a CSV report from the provided URL.
boolean	isLoggedIn()            Checks whether the user is currently logged in.
function	login( <String> username, <String> password )            Logs into Salesforce.com using the specified user name and password.
function	logout()            Logs out of Salesforce.com.

Properties Detail

lastError

String lastError

Information about the most recent error.

Since:
5.2.1

---

lastErrorCode

String lastErrorCode

The latest error code that was returned by the SalesforceReports engine.

Since:
5.2.1

---

Function Detail

getBaseAddress

String getBaseAddress()

Gets the base address for Salesforce.com.

Since:
5.2.1

Returns:
the base URL

---

getErrorDetails

String getErrorDetails()

Gets detailed information about the latest error and displays lastError, lastErrorCode and lastErrorDetail with labels in the Debug Window.

Since:
5.2.1

Returns:
detailed error information

---

getReport

String getReport( ReportURL )

Retrieves a CSV report from the provided URL.

Time frame for the report can be appended to the URL using &quarter_q=duration. For example:

Engines.SalesforceReports.getReport (gReportURL+"&quarter_q=curfy")

The strings for the available duration can be found by going to the generated report in a browser and viewing its page source, under "quarter_q".

Since:
5.2.1

Parameters:
reportURL - the URL from which to retrieve a CSV report

Returns:
a CSV report

---

isLoggedIn

boolean isLoggedIn()

Checks whether the user is currently logged in.

Since:
5.2.1

Returns:
true if logged in; otherwise false

---

login

function login( <String> username, <String> password )

Logs into Salesforce.com using the specified user name and password.

Since:
5.2.1

Parameters:
username - Login username
password - Login password associated with the specified username

Returns:
true on success; otherwise false

---

logout

function logout()

Logs out of Salesforce.com.

Since:
5.2.1

Returns:
true if logged out; otherwise false

---

Overview   Object  Tree  Index  Help			Klipfolio Dashboard API
PREV OBJECT  NEXT OBJECT	FRAMES    NO FRAMES
SUMMARY: PROPERTY | FUNCTION	DETAIL: PROPERTY | FUNCTION

---

© 2011 Klipfolio Inc. All Rights Reserved.