How to use Salesforce.com Confluence Plugin

Macro Usages

salesforce-account

Displays details for all Salesforce.com account(s) which can be limited by using a set of conditions.

salesforce-account Usage

{salesforce-account:<conditions>}

<conditions> is an optional series of conditions separated by "|",
the list of result accounts will be restricted to those that match these conditions.

Example:
{salesforce-account:Name=GenePoint}
Will only return accounts with the name "GenePoint"

salesforce-account Examples

Lets say you have an Account in SalesForce.com which contains a set of information (Figure 1).


Figure 1.

You can use the following macro:

{salesforce-account:Name=GenePoint}

To display a subset of the details within a Confluence page as an Account Card (Figure 2.)


Figure 2.

salesforce-entity

Displays a list of SalesForce.com entities in a table format, the set of data that is obtained can be restricted by specifying a set of conditions.

salesforce-entity Usage

{salesforce-entity:sObjectName|<conditions>}

<conditions> is an optional series of conditions separated by "|",
the list of result accounts will be restricted to those that match these conditions.

Example:
{salesforce-entity:Account|Name=GenePoint}
Will only return accounts with the name "GenePoint"

salesforce-entity Examples

Lets say you have a Case in SalesForce.com which contains a set of information (Figure 1).


Figure 1.

You can use the following macro:

{salesforce-entity:Case|CaseNumber=00001024|fields=CaseNumber,Subject,Reason,Type,Status,Priority,Origin}

To display a subset of the details (including: CaseNumber, Subject, Reason, Type, Status, Priority and Origin as specified in the macro) within a Confluence page in a table (Figure 2.)


Figure 2.

You can also click each of the rows in the table to open up the actual Case within SalesForce.com (opens in a new window/tab)

salesforce-contact

Displays details for all Salesforce.com contact(s) which can be limited by using a set of conditions.

salesforce-contact Usage

{salesforce-contact:<conditions>}

<conditions> is an optional series of conditions separated by "|", the list of result contacts will be restricted to those that match these conditions.

Example:
{salesforce-contact:FirstName=Josh|LastName=Davis}
Will only return contacts with the first name of "Josh" and last name of "Davis".

salesforce-contact Examples

Lets say you have a Contact in SalesForce.com which contains a set of information (Figure 1).


Figure 1.

You can use the following macro:

{salesforce-contact:FirstName=Josh|LastName=Davis}

To display a subset of the details within a Confluence page as a Contact Card (Figure 2.)


Figure 2.

You can also export the details of the Contact as a VCard (which can be used to import the contact into Microsoft Outlook [Figure 3]) by clicking on the icon in the top right corner of the Contact Card (Figure 2.)


Figure 3.

Reporting Extensions

The reporting extensions will ONLY work when a valid license is installed.
It also requires the Reporting Plugin version 3.2.0 or higher to be installed.

Reporters

salesforce-reporter

Allows reporting of SalesForce.com Objects

salesforce-reporter Usage

{salesforce-reporter:<sobject>|<conditions>}
  {xxx-sort:prefix:subkey|order=[ascending, descending]}
  {xxx-filter:prefix:subkey|extra parameters go here}
{salesforce-reporter}

<sobject> is the SalesForce.com object type, please refer to the [SalesForce Standard Object API|http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_objects_list.htm] for more details on what the available options are.

<conditions> is an optional series of conditions separated by "|",
the list of results will be restricted to those that match these conditions.

Example:
{salesforce-reporter:Account|Name=GenePoint}
{salesforce-reporter}
Will only return accounts with the name "GenePoint"

{salesforce-reporter:Account|Name=like:Gene}
{salesforce-reporter}
Will only return accounts that contain "Gene" somewhere in the name.

salesforce-reporter Examples

{report-block}
{salesforce-reporter:Case}
{text-filter:sf:Status|exclude=Closed}
{salesforce-reporter}
{report-body:injected=true}
{panel}
[%sf:CaseNumber% - %sf:Subject%|%sf:url%] (%sf:Status%)
%sf:Description%
|| Type | %sf:Type% || Reason | %sf:Reason% |
|| Priority | %sf:Priority% || Origin | %sf:Origin% |
{panel}
{report-body}
{report-block}

Displays a list of cards for all Cases which are NOT Closed.

soql-reporter

Allows reporting of SalesForce.com Objects using SOQL

soql-reporter Usage

{soql-reporter:query=<SOQL query>}
  {xxx-sort:prefix:subkey|order=[ascending, descending]}
  {xxx-filter:prefix:subkey|extra parameters go here}
{soql-reporter}

soql-reporter Examples

{report-table}
{soql-reporter:query=SELECT Account.Name, Name,Amount,StageName From Opportunity}
{soql-reporter}
{report-column:title=Account}{report-info:sf:Account.Name}{report-column}
{report-column:title=Opportunity}{report-info:sf:Name}{report-column}
{report-column:title=Amount}{report-info:sf:Amount}{report-column}
{report-column:title=Stage Name}{report-info:sf:StageName}{report-column}
{report-table}

Displays a table with a list of all of the Opportunities, grouped by account, with the opportunity amount and name of the stage of the opportunity.

Suppliers

see Salesforce.com Supplier Version 2 for more information on suppliers

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.