Bizagi Digital Business Platform · The Salesforce connector for Bizagi is available for download...

Bizagi DigitalBusiness PlatformUser Guide

2Copyright copy 2002-2017 Bizagi All rights reserved 2

Table of Contents

Part I Configuring and using theSalesforce Connector 3

PartIConfiguring and using theSalesforce Connector

4Copyright copy 2002-2017 Bizagi All rights reserved

Configuring and using the Salesforce Connector

OverviewThe Salesforce connector for Bizagi is available for download at Bizagi Connectors Xchange

Through this connector you will be able to connect your Bizagi processes to a wwwsalesforcecom

account in order to use Salesforce services API

For more information about this connectors capabilities visit Bizagi Connectors Xchange

Before you startIn order to test and use this connector you will need

1 Bizagi Studio previously installed

2 This connector previously installed via the Connectors Xchange as described at

httphelpbizagicombpmsuiteenindexhtmlConnectors_Xchangehtm or through a manual

installation as described at httphelpbizagicombpmsuiteenindexhtmlConnectors_installhtm

3 An account at wwwsalesforcecom and a registered App (httpsdevelopersalesforcecomsignup)

Configuring the connectorIn order to configure the connector (ie its authentication parameters) follow the steps presented at the

Configuration chapter in httphelpbizagicombpmsuiteenindexhtmlConnectors_installhtm

For this configuration consider the following authentication parameters

middot Authentication method Custom

middot Username The e-mail account username

middot Password The password for the accounts username

middot Token The requested security token for external app access


Note that you will need to grant explicitly that external applications are allowed to use your

Salesforce account as required by Salesforce security policies

You may authorize such access and set up a security token directly at the Personal settings

presented in your Salesforce portal (eg

https[salesforce_server]salesforcecom_uisystemsecurityResetApiTokenEditretURL=2Fui

2Fsetup2FSetup3Fsetupid3DPersonalInfoampsetupid=ResetApiToken )


Using the connectorThis connector features several methods of Salesforce Enterprise API that manages the CRUD for any

type of CRM object

To learn overall howwhere to configure the use of a connector refer to

httphelpbizagicombpmsuiteenindexhtmlConnectors_Studiohtm

When using the connector ensure you consider the following details for each of the available methods

Run CRUD operationAllows you to perform CRUD (Create Retrieve Update and Delete) operations for records in

Salesforce

To configure its inputs consider the following according to the operation to be performed

CreateCreates a Salesforce object by providing its basic information

middot statementType operation to be executed In this case use create

middot objName name of the Salesforce object eg Contact Opportunity Event Lead among

others

middot record JSON with the information of the Salesforce object

RetrieveRetrieves a Salesforce object by providing its id and object name

middot statementType operation to be executed In this case use retrieve



others

middot Id id of the Salesforce object

UpdateUpdates a Salesforce object by providing its basic information

middot statementType operation to be executed In this case use update


others


DeleteDeletes a Salesforce object by providing its id and object name

middot statementType operation to be executed In this case use delete


others

middot Id The id of the target Salesforce object

UpsertUpsert a Salesforce object by providing its id and object name

middot statementType operation to be executed In this case use upsert


others


middot extIdFieldexternal Id of the target object

To execute upsert operations you will need a Salesforce Object with a External Id

1 Log in in your developer account

2 Find the Setup tab on the top left of your screen

3 Click on the Object Manager tab on the top right of your screen

4 Select any Object

5 Go to Fields amp Relationships

6 Click on New and be sure to check the External ID input on Step 2


To configure its outputs when getting started and testing you may map the res parameter of the newly

created object as managed by Salesforce


For more information about this methods use refer to the REST API official documentation at

httpsdevelopersalesforcecomdocsatlasen-usapimetaapi

Create AccountCreate an account directly in Salesforce by providing the basic information of that account

To configure its inputs consider

middot AnnualRevenue Estimated annual revenue of the account

middot Description description of the account

middot Industry Industry associated with the account

middot Name (Mandatory) Name of the account

middot BillingStreet Billing address of the account

middot BillingCity Billing city of the account

middot BillingState Billing state of the account

middot BillingPostalCode Billing postal code of the account

middot BillingCountry Billing country of the account

middot Phone Phone number of the account

Further information such as Fax Number of employees Shipping address and others are useful but

optional as determined by Salesforce


To configure its outputs when getting started and testing you may map the unique Id of the newly





Create ContactCreate a contact directly in Salesforce by providing the basic information of that contact


middot FirstName (Mandatory) The first name of the contact

middot LastName (Mandatory) The last name of the contact

middot Phone The phone number of the contact

middot Email The e-mail address of the contact

Further information such as Salutation Title Mobile phone and others are useful but optional as

determined by Salesforce







Create leadCreate a lead directly in Salesforce by providing the basic information of that lead


middot FirstName (Mandatory) The first name of the lead

middot LastName (Mandatory) The last name of the lead

middot Phone Phone number of the lead

middot AnnualRevenue Annual revenue for the company of the lead

middot Company (Mandatory) The name of the company where the lead works

middot Street Address of the lead

middot City City of the lead

middot State State of the lead

middot PostalCode Postal code of the lead

middot Country Country of the lead

middot Email The e-mail address of the lead

middot Title Title for the lead

Further information such as Website Mobile phone and others are useful but optional as determined

by Salesforce







Get AccountGet the information of an Account stored in Salesforce by providing the identifier of that account


middot id (Mandatory) The unique identifier of the Account


To configure its outputs when getting started and testing you may map




middot Name Name of the account










Get ContactGet the information of a Contact stored in Salesforce by providing the identifier of that contact



middot id (Mandatory) The unique identifier of the Contact



middot FirstName The first name of the contact

middot LastName The last name of the contact





Get LeadGet the information of a Lead stored in Salesforce by providing the identifier of that lead



middot id (Mandatory) The unique identifier of the lead



middot FirstName The first name of the lead

middot LastName The last name of the lead



middot Company The name of the company where the lead works










Update AccountChange the information of an account directly in Salesforce by providing the identifier of that account

















To configure its outputs when getting started and testing you may map the success parameter of the

output




Update ContactChange the information of a contact directly in Salesforce by providing the identifier of that contact











output




Update LeadChange the information of a lead directly in Salesforce by providing the identifier of that lead


middot id (Mandatory) The unique identifier of the Lead














by Salesforce



output




Delete AccountDelete the information of an account by providing its identifier





output




Delete ContactDelete the information of a contact by providing its identifier





output




Delete LeadDelete the information of a lead by providing its identifier





output




Create OpportunityCreate an opportunity directly in Salesforce by providing the basic information of that opportunity


middot AccountId Identifier of the account associated with this opportunity

middot Amount Amount of the opportunity

middot Description Description of the opportunity

middot Name (Mandatory) Name of the opportunity

middot CloseDate (Mandatory) Date when the opportunity is expected to close

middot StageName (Mandatory) Stage of the opportunity

Further information such as Fiscal Quarter Forecast Category and others are useful but optional as








Update OpportunityChange the information of an Opportunity directly in Salesforce by providing the identifier of that

opportunity


middot id (Mandatory) The unique identifier of the Opportunity




middot Name Name of the opportunity

middot CloseDate Date when the opportunity is expected to close

middot StageName Stage of the opportunity





output




Get OpportunityGet the information of an Opportunity stored in Salesforce by providing the identifier of that

opportunity


middot id (Mandatory) The unique identifier of the opportunity







middot IsWon indicates whether the opportunity was won or not






Delete OpportunityDelete the information of an opportunity by providing its identifier






output



Create CaseCreate a case directly in Salesforce by providing the basic information of that case



middot Origin Source of the case suggested values Email Phone and Web

middot Reason The reason why this case is being created

middot Description Description of the case

middot Status Status of the case

middot Subject Subject of the case

middot SuppliedCompany Company name of the case

middot SuppliedEmail Email of the case

middot SuppliedName Name of the case

middot SuppliedPhone Phone number of the case

Further information such as Priority Type and others are useful but optional as determined by

Salesforce







Update CaseChange the information of a Case directly in Salesforce by providing the identifier of that case


middot id (Mandatory) The unique identifier of the Case


middot Reason The reason why this case was created









Salesforce



output




Get CaseGet the information of a Case stored in Salesforce by providing the identifier of that case


middot id (Mandatory) The unique identifier of the case



middot Origin Source of the case












Delete CaseDelete the information of a case by providing its identifier






output



Create CampaignCreate a campaign directly in Salesforce by providing the basic information of that campaign



middot IsActive Indicates whether the campaign is active or not

middot ActualCost Actual cost of the campaign

middot BudgetedCost Budgeted cost of the campaign

middot Name Name of the campaign

middot Description Description of the campaign

middot EndDate Ending date for the campaign

middot StartDate Starting date for the campaign

middot Status Status of the campaign

Further information such as Expected Revenue Number of contacts and others are useful but optional

as determined by Salesforce







Update CampaignChange the information of a Campaign directly in Salesforce by providing the identifier of that

campaign


middot id (Mandatory) The unique identifier of the Campaign













output




Get CampaignGet the information of a Campaign stored in Salesforce by providing the identifier of that campaign


middot id (Mandatory) The unique identifier of the campaign














Delete CampaignDelete the information of a campaign by providing its identifier






output



Create EventCreate an event directly in Salesforce by providing the basic information of that event



middot AccountId Identifier of the account associated with this event

middot IsAllDayEvent Defines whether the event is an all day event or not

middot ActivityDate Date for the event

middot Description Description of the event

middot IsPrivate Defines whether the event is private or not

Further information such as End Datetime Location and others are useful but optional as determined

by Salesforce







Update EventChange the information of an Event directly in Salesforce by providing the identifier of that event


middot id (Mandatory) The unique identifier of the Event







by Salesforce



output




Get EventGet the information of an Event stored in Salesforce by providing the identifier of that event













Delete EventDelete the information of an event by providing its identifier






output



Create TaskCreate a task directly in Salesforce by providing the basic information of that task



middot AccountId Identifier of the account associated with this task

middot Description Description of the task

middot ActivityDate Date for the task

Further information such as Subject Recurrence Interval and others are useful but optional as








Update TaskChange the information of a Task directly in Salesforce by providing the identifier of that task


middot id (Mandatory) The unique identifier of the Task








output




Get TaskGet the information of a Task stored in Salesforce by providing the identifier of that task











Delete TaskDelete the information of a task by providing its identifier






output




2Copyright copy 2002-2017 Bizagi All rights reserved 2

Table of Contents

Part I Configuring and using theSalesforce Connector 3






























type of CRM object





Salesforce





others






others





others





others





others







4 Select any Object


























































by Salesforce











































































output















output




















by Salesforce



output









output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output

































type of CRM object





Salesforce





others






others





others





others





others







4 Select any Object


























































by Salesforce











































































output















output




















by Salesforce



output









output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output






others





others





others





others







4 Select any Object


























































by Salesforce











































































output















output




















by Salesforce



output









output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output



























































by Salesforce











































































output















output




















by Salesforce



output









output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output














































































output















output




















by Salesforce



output









output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output


















output




















by Salesforce



output









output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output























by Salesforce



output









output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output






output









output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output












output









output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output












output









output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output












output





















opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output
























opportunity













output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output






output





opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output








opportunity





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output






















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output
















Salesforce




















Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output























Salesforce



output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output






output



























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output






























output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output























campaign















output


























output












by Salesforce
















by Salesforce



output























output



























output





















output






output


























output












by Salesforce
















by Salesforce



output























output



























output





















output





























output












by Salesforce
















by Salesforce



output























output



























output





















output












by Salesforce
















by Salesforce



output























output



























output





















output



















by Salesforce



output























output



























output





















output






output























output



























output





















output


























output



























output





















output



























output





















output
























output




Bizagi Digital Business Platform · The Salesforce connector for Bizagi is available for download...

Documents

Transcript of Bizagi Digital Business Platform · The Salesforce connector for Bizagi is available for download...