2022
This setup document is very handy for Developers and Partners
Problem Statement:
While developing a widely used integration template, we often run into user specific customizations. This leads to having the developer create templates for every task in which customizations are made as per end user requirements. This makes the process very lengthy and tedious.
Motive:
This feature of Setup Wizard will enable developers to integrate a few pre-built templates to answer questions/queries and also set up a form like feature which the end user is accustomed to using in respective connectors. This is a one -time configuration and hence once configured , the end user can easily get started, schedule it and forget it.
With the help of Custom Variable creation, the end-user can now answer a few Custom questions and run the workflow as they desire. This automated process is one of a kind making the job easier for Developers and end-users making the system user friendly.
Hence there are 2 views to this Advance Setup Wizard,
1. the PDL developer configuration Setup Wizard - designing Canvas.
2. Client view - Setup Form with dropdowns, which they can select and forget.
Aim:
PDL developer view :
To understand how to create a Form design with Custom Variables using the Canvas , let's consider an example,
Under Opportunity of Salesforce developer instance with Invoice creation of QuickBooks sandbox. (online integration).
Solution :
DBSync Setup wizard is a new feature for automating the mapping process in DBSync Cloud Workflow. It enables the user to define predetermined templates for all their mappings and can enable this Setup Wizard for any workflow process.
Follow the steps:
Once a customer raises a query, the PDL team needs to create the mapping for that process.
Steps:
Login into your DBSync cloud workflow instance
From the left navigation toolbar select template library
A list of pre-built templates will appear on the screen
Select the appropriate PDL from the list for which the mapping needs to be done
For instance: Salesforce to quickbooks bidirectional option(for this case)
A list of connectors will appear on the screen. Select the appropriate connector.
For instance: Salesforce connector.
Connector Settings:
You need to connect to salesforce and establish a connection to the account.
Click the Connect to Salesforce option
A pop-up window will appear asking to login to salesforce account.
Login with appropriate credentials
Once connection is established a pop-up screen will appear confirming the connection
Click on Projects from the left navigation toolbar
Fig 3 : Left Navigation Toolbar
Click on the Pencil icon to edit a particular process
(For Instance: SalesforceQuickbookBidirectional)
Fig 4: List of processes
Click the pencil icon as shown in Fig 5
(For Instance: SFQB_Opportunitytoinvoice)
Fig 5: Process detail
All the workflows under this process is listed.
Click the pencil icon against any workflow which you wish to create a setup wizard.
(For Instance: OpportunityToinvoice)
In the trigger screen, Click the setting icon at the extreme right of the screen.
From the drop-down menu select User Input Form
A pop-window displaying a space to create custom tasks and variables is seen on the screen.
Let’s 1st start by understanding the Query and the ID’s that needs to be created for building out the form ,
SELECT Opportunity.Id,Opportunity.AVSFQB__Primary_Contact__r.FirstName,Opportunity.AVSFQB__Primary_Contact__r.LastName,Opportunity.AVSFQB__Primary_Contact__r.Email,Opportunity.AVSFQB__Quickbooks_Id__c,Opportunity.AccountId,LastModifiedDate,Opportunity.Account.Id,Opportunity.Account.Name,Opportunity.Account.BillingStreet,Opportunity.Account.BillingCity,Opportunity.Account.BillingState,Opportunity.Account.BillingPostalCode,Opportunity.Account.BillingCountry,Opportunity.Account.ShippingStreet,Opportunity.Account.ShippingCity,Opportunity.Account.ShippingState,Opportunity.Account.ShippingPostalCode,Opportunity.Account.ShippingCountry,Opportunity.Account.Fax,Opportunity.Account.Phone,Name,Description,CloseDate ,
(SELECTQuantity,TotalPrice,UnitPrice,Description,Opportunity.owner.FirstName,Opportunity.owner.LastName,Opportunity.Id,Opportunity.CloseDate,PricebookEntry.Name
,PricebookEntry.Product2.ProductCode,PricebookEntry.Product2.Name,PricebookEntry.Product2.Description,PricebookEntry.Product2.Id,PricebookEntry.UnitPrice,PricebookEntry.Product2.AVSFQB__QuickBooks_ItemType__c FROM OpportunityLineItems) ,Opportunity.Account.AVSFQB__Quickbooks_Id__c,Opportunity.AVSFQB__Generate_Object__c FROM Opportunity where Opportunity.AVSFQB__Generate_Object__c = 'Invoice' and Opportunity.Id='$profile.Salesforce.Id'
Breaking down the query into
Source Object – Opportunity
Lookup Object - Account
Opportunity Fields
Account Fields
Inner Query – OpportunityLineItem
OpportunityLineItem fields
Steps:
In this use case we are describing performing the mapping function for automating the functionality of OPPORTUNITY TO INVOICE and providing a pre-built template for the customers to use.
Follow the steps to execute the same:
Log in to Dbsync account
Click on Projects in the left navigation toolbar
Click the Edit icon next to Setup Wizard Training 2 Project
Choose the option Opportunity to invoice
Click the Edit icon next to Opportunity to invoice
Click User Input form under setting tab to create the template
Breaking down the query into
Source Object – Opportunity
Lookup Object - Account
Opportunity Fields
Account Fields
Inner Query – OpportunityLineItem
OpportunityLineItem fields
Steps for Breaking down query:
The below is a screen shot of the use case mentioned above (pre-built template)
There are 4 main radio buttons that need to be utilized to break this query:
Create a User Defined Variable
In the configuration table enter details:
i) Label : Create Job?
ii) ID: Job_mgmt
iii) Default Value: Yes
iv) User Defined:
Check the radio button next to User defined to select this option
Enter details to create two option in the drop-down menu: YES and NO.
The USer defined option is only used to create YES and NO option configuration
v) Click Save
vi) The variable will appear on the main screen as below:
Include a label as the header : Configuration salesforce
Identify the Source object : Opportunity
In this use case the(refer use case input ) : Opportunity is the source object and Account is the look up object
Opportunity : This source object contains Name , ID, Close Date
To insert a Variable icon and create the source object follow steps:
Drag and drop the Variable icon on to the main screen
Click inside the variable box next to (x)
A configuration screen will appear on the extreme left of the main screen
Enter the label name: select source object
The customer will be choosing the source object from the drop down menu.
In this case source object will be : Opportunity
Provide ID: src_obj
Default Value: Opportunity
Select the Radio button Source Table
Refer below image for the commands:
On main screen the following output is seen:
4) Identify the Lookup object : Account
In this use case the(refer use case input ) : Opportunity and Account are the source objects
To insert a Variable icon and create the lookup object follow steps:
Drag and drop the Variable icon on to the main screen
Click inside the variable box next to (x)
3) A configuration screen will appear on the extreme left of the main screen
4) Enter the label name: select lookup object
5) The customer will be choosing the source object from the drop down menu.
6) In this case source object will be : Account
7) Provide ID: lookup_obj
8) Default Value: Account
9) Select the Radio button Source Table
Refer below image for the commands:
On main screen the following output is seen:
5) Select object for line items (Relatable Table)
In this Use case there are line items which need to be built.
(SELECTQuantity,TotalPrice,UnitPrice,Description,Opportunity.owner.FirstName,Opportunity.owner.LastName,Opportunity.Id,Opportunity.CloseDate,PricebookEntry.Name
,PricebookEntry.Product2.ProductCode,PricebookEntry.Product2.Name,PricebookEntry.Product2.Description,PricebookEntry.Product2.Id,PricebookEntry.UnitPrice,PricebookEntry.Product2.AVSFQB__QuickBooks_ItemType__c FROM OpportunityLineItems)
We are creating an opportunity line item due to the inner query mentioned above. These line items are child-like items which are related to the Main source: Opportunity.
This includes items likeQuantity,TotalPrice,UnitPrice,Description etc
This specific line item is received from Relatable table
To insert Relatable table follow steps:
To insert a Variable icon and create the lookup object follow steps:
Drag and drop the Variable icon on to the main screen
Click inside the variable box next to (x)
3) A configuration screen will appear on the extreme left of the main screen
4) Enter the label name: select object for line items
5) The customer will be choosing the source object from the drop down menu.
6) In this case source object will be : Opportunity
7) Provide ID: lineitem_obj
8) Default Value: OpportunityLineItems
9) Select the Radio button Related Table
Refer below image for the commands:
On main screen the following output is seen:
6) Insert label Configuring lineitem object
Quantity,TotalPrice,UnitPrice,Description etc
7) Create two new source Tables :
Pricebook Entry (Source table)
Main screen will appear like below:
Product 2 (Source table)
Main screen will be seen as below:
7) Opportunity fields
Use Case Name,ID,Description,Close date
These fields do not have any attachments to them. Neither an opportunity nor Account because they are object fields under opportunity.
Create Opportunity Fields:
Enter details as below:
Label: Opportunity ID
ID: Opp_ID
Default value: Id
Select object fields radio button : Select src_obj
Follow commands:
Main Screen View:
Repeat same steps for creating:
2) Opportunity name
Mian Screen looks as below:
3) Opportunity Description
4) Opportunity Close date
8) Create Account Fields:
Enter details as below:
Label: Account Name
ID: acc_name
Default value: Name
Select object fields radio button : Select lookup_obj
We need to insert object fields under Lookup object Account.
Repeat for Account Name, Account ID
9) Create Table
Repeat steps:
10) Customer View:
Other Instruction: (Additional information to create new Setup Wizard)
Follow steps below to create new Setup wizard
There are 3 sections under the set-up designer:
a) Text: to create section headers
b) Variable to create dropdowns
c) Table created column wise;
Text Icon:
‘Text’ is used to create Heading for the particular section of the form.
This drag and drop feature generates an editable text field, which the user can place anywhere in the Canvas.The 8 dots next to the Text Icon shows that this button has a drag and drop feature.
To insert a Text Icon:
Drag and drop the Text icon on to the main screen
An editable text area where a label name can be provided will appear on the screen
Click the Pencil icon next to Enter label to provide a label name
Click anywhere on the screen to save the label
A pop-up confirming label creation: Label successfully created will appear on the screen
This text icon is used mainly to add the titles for any function.
Add as many labels as required and place them anywhere on the screen
b) Variable Icon:
Variables are used to create dropdowns from which the end-user can select from the form.
This drag and drop feature creates placeholders to generate Variables with Label and Dropdown .The 8 dots shows that this button has a drag and drop feature.
The user can design the drop down features in 4 ways :
i) User Defined
ii) Source Table
iii) Related Table
iv) Object Fields
To insert a Variable icon:
Drag and drop the Text icon on to the main screen
Click inside the variable box next to (x)
A configuration screen will appear on the extreme left of the main screen
Enter the desired Label name for the variable
Provide an ID
Enter a default value for the variable
Choose from the 4 options (User defined, Source table, Related Table or Object Fields)
Click Save
For Instance:
A) To Create User Defined variable:
Drag and drop the variable icon to the main screen
Click inside the variable box next to (x)
In the configuration table enter details:
i) Label : Create Job?
ii) ID: Job_mgmt
iii) Default Value: Yes
iv) User Defined:
Check the radio button next to User defined to select this option
Enter details to create two option in the drop-down menu: YES and NO.
The USer defined option is only used to create YES and NO option configuration
v) Click Save
vi) The variable will appear on the main screen as below:
B) To Create Source Table variable:
Drag and drop the variable icon to the main screen
Click inside the variable box next to (x)
In the configuration table enter details:
i) Label: Select Source Object
ii) ID: src_obj
iii) Default Value : Opportunity
iv) Check the radio button next to Source Tables defined to select this option
v) Click Save
vi) The variable will appear on the main screen as below:
C) To Create Related Table variable:
Drag and drop the variable icon to the main screen
Click inside the variable box next to (x)
In the configuration table enter details:
i) Label: Select Lookup Object
ii) ID: lookup_obj
iii) Default Value: Opportunity
iv) Check the radio button next to Related Tables defined to select this option
v) All the Source tables create will appear as a choice in the drop-down menu
vi) Select the correct Table
vi) This table is related to the source table
vii) Click Save
viii) The variable will appear on the main screen as below:
D) To Create Object Fields Table variable:
i) Label: Opportunity ID
ii) ID: opp_ID
iii) Default Value: Opportunity Name
iv) Check the radio button next to Object Fields to select this option
v) All the Source tables created and Related tabled will appear as a choice in the drop-down menu
vi) Select the correct Table
vii) Click Save
viii) The variable will appear on the main screen as below:
c) Table Creation
Generates a table with one column when placed on the Canvas.
To insert a Table icon:
i) Drag and drop the Text icon on to the main screen
ii) Click inside the variable box next to (x)
iii) A configuration screen will appear on the extreme left of the main screen
iv) Enter the desired Label name for the table
v) Provide an ID
vi) Enter a default value for the table
vii) Click Save