Salesforce Lookup Opportunity

plugins/salesforce-opportunity-information/.codeblocks/block_0.yaml → plugins/salesforce-opportunity-information/.codeblocks/block_0.sh

@@ -1,2 +1,2 @@
-curl --location 'https://<YOUR_DOMAIN>//services/data/v62.0/query?q=SELECT%20AccountId%2C%20Amount%2C%20StageName%2C%20CloseDate%2C%20Id%20FROM%20Opportunity%20WHERE%20Account.Name%20like%20ABC1%20ORDER%20BY%20CloseDate%20DESC%20LIMIT%201' \
+curl --location 'https://<YOUR_DOMAIN>//services/data/v62.0/query?q=SELECT%20AccountId%2C%20Amount%2C%20StageName%2C%20CloseDate%2C%20Id%20FROM%20Opportunity%20WHERE%[20Account.Name](http://20account.name/)%20like%20ABC1%20ORDER%20BY%20CloseDate%20DESC%20LIMIT%201' \
 --header 'Content-Type: application/json'

plugins/salesforce-opportunity-information/README.md

@@ -14,168 +14,46 @@ time_in_minutes: 15
 video: https://youtu.be/NAFlOXKzJ4g
 ---
 
-# Introduction
+# **Introduction:**
 
-Salesforce is a CRM platform, and the "Look Up Opportunity Information in Salesforce" plugin helps you efficiently retrieve Opportunity details from your Salesforce account. By integrating this feature with your bot, users can quickly access and manage Opportunity information, enhancing productivity and organization.
+The **Lookup Opportunity Information** plugin provides instant access to Salesforce opportunity data through the Moveworks AI Assistant. Users can quickly retrieve key deal details, status updates, and pipeline metrics without leaving their conversation interface.
 
-This guide will show you how to add the "Look Up Opportunity Information in Salesforce" feature to your bot using Creator Studio. Let's get started!
+This guide covers the simple setup process to enable opportunity lookups in minutes.
 
-# Prerequisites
+# **Prerequisites :**
 
-- An API Testing Tool
-- Salesforce Connector built in Creator Studio (follow the [Salesforce Authentication](https://developer.moveworks.com/creator-studio/resources/connector/?id=salesforce) guide to create your connector)
+- Access to Agent Studio
 
-# What are we building?
+# **What are we building?**
 
-### **Conversation Design**
+### **Agent Design**
 
 This [purple chat](https://developer.moveworks.com/creator-studio/developer-tools/purple-chat/?conversation=%7B%22startTimestamp%22%3A%2211%3A43+AM%22%2C%22messages%22%3A%5B%7B%22parts%22%3A%5B%7B%22richText%22%3A%22%3Cp%3EI+want+to+look+up+the+opportunity+for+ABC+Co.%3C%2Fp%3E%22%7D%5D%2C%22role%22%3A%22user%22%7D%2C%7B%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22richText%22%3A%22Searching+Salesforce+for+opportunity+%27ABC+Co%27%22%2C%22status%22%3A%22pending%22%7D%2C%7B%22richText%22%3A%22Found+opportunity+%27ABC+Co+Technology+Refresh%27%22%2C%22status%22%3A%22success%22%7D%5D%7D%2C%7B%22richText%22%3A%22Here+are+the+details+for+the+opportunity+with+ABC+Co%3A%3Cbr%3E%3Cb%3EOpportunity+Name%3A%3C%2Fb%3E+ABC+Co+Technology+Refresh%3Cbr%3E%3Cb%3EStage%3A%3C%2Fb%3E+Negotiation%3Cbr%3E%3Cb%3EClose+Date%3A%3C%2Fb%3E+2023-12-15%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%24500%2C000%3Cbr%3EWould+you+like+to+take+any+action+on+this+opportunity+in+Salesforce%3F%22%7D%2C%7B%22citations%22%3A%5B%7B%22citationTitle%22%3A%22ABC+Co+Technology+Refresh%22%2C%22connectorName%22%3A%22salesforce%22%7D%5D%7D%5D%2C%22role%22%3A%22assistant%22%7D%5D%7D) shows the experience we are going to build.
 
-# Creator Studio Components
+# **Installation Steps**
 
-- **Triggers:**
-    1. **Natural Language**
-    2. Identify user queries or commands related to lookup Opportunity information in Salesforce.
-- **Slots:**
-    1. **Account Name:** Query Account Name to look up Opportunity details.
-- **Actions:**
-    1. **Retrieve Opportunity Information:** Look up Opportunity details using the Account Name via Salesforce API.
-- **Guidelines:**
-    1. None.
+While you can create a connector during plugin installation, we recommend creating a connector in **Agent Studio** beforehand to streamline the process. Please follow our [Salesforce Connector](https://developer.moveworks.com/marketplace/package/?id=salesforce&hist=home) Guide to do so. Once completed, follow our plugin installation documentation to install the **Lookup Opportunity Information** plugin in minutes.
 
-# API Research
+## **Required Permissions:**
 
-To build this use case, we will use one **API** to achieve the goal of creating a Salesforce account:
-
-![Screenshot 2025-01-22 at 6.39.57 PM.png](images/Screenshot_2025-01-22_at_6.39.57_PM.png)
-
-## API #1:Query the Opportunity by Name:
-
-The Retrieve [Opportunity information by account name](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm) API retrieves Opportunity details for a given **Account Name** from Salesforce using a SOQL query. This API helps in accessing Opportunity information associated with specific Salesforce accounts.
-
-- **Purpose**: Fetches Opportunity details based on **Account Name**.
-- **Features**: Supports filtering by **Account Name** and returns relevant Opportunity information.
-- **Example**: Queries Salesforce to retrieve Opportunity information for the specified **Account Name**
-
-```yaml
-curl --location 'https://<YOUR_DOMAIN>//services/data/v62.0/query?q=SELECT%20AccountId%2C%20Amount%2C%20StageName%2C%20CloseDate%2C%20Id%20FROM%20Opportunity%20WHERE%20Account.Name%20like%20ABC1%20ORDER%20BY%20CloseDate%20DESC%20LIMIT%201' \
---header 'Content-Type: application/json'
-```
-
-- **<YOUR_DOMAIN>**: Your Salesforce instance domain (e.g., yourcompany.my.salesforce.com).
-- **<ACCOUNT_NAME>**: The name of the account used to look up Opportunity information in Salesforce.
-
-# Steps
-
-## **Step 1: Build HTTP Action**
-
-Define your HTTP Actions for fetching the **Account ID** from Salesforce based on the provided **Account Name**.
-
-1. **In Creator Studio, Create a New Action**:
-
-- Navigate to **Plugins** section > **Actions** tab.
-- Click on **CREATE** to define a new action.
-
-    ![Screenshot 2025-01-07 at 7.14.13 PM.png](images/Screenshot_2025-01-07_at_7.14.13_PM.png)
+- **Read**
+    - Access to the **Opportunity** object.
+    - Access to custom fields used in opportunity reporting.
 
 
-Click on the IMPORT CURL option and paste the following cURL command:
+After configuring the connector, refer to our [plugin installation documentation](https://help.moveworks.com/docs/ai-agent-marketplace-installation) for more details on completing the setup
 
-```yaml
-curl --location 'https://<YOUR_DOMAIN>//services/data/v62.0/query?q=SELECT  AccountId, Amount, StageName, CloseDate, Id FROM Opportunity WHERE Account.Name like 'ABC1' ORDER BY CloseDate DESC LIMIT 1' \
---header 'Authorization: Bearer' \
---header 'Content-Type: application/json'
-```
+# **Appendix**
 
-- Click on Use Existing Connector> select the [Salesforce Connector](https://developer.moveworks.com/creator-studio/resources/connector/?id=salesforce) that you just created > Click on Apply. This will populate the Base URL and the Authorization section of the API Editor.
-- **Query Parameters for Salesforce Opportunity Name Query**
-- **Key ( q )**: Value (SELECT AccountId, Amount, StageName, CloseDate FROM Opportunity WHERE Name='{{Name}}’)
-- This query filters Opportunity records associated with an account based on the **Account Name** and retrieves relevant Opportunity information (such as StageName, Amount, CloseDate etc.), ensuring that only the essential Opportunity details are returned for the specified account
-
-    ![Screenshot 2025-01-29 at 2.47.15 PM.png](images/Screenshot_2025-01-29_at_2.47.15_PM.png)
-
+## API #1:Query the Opportunity by Account Name:
 
-- **Input Variables** :
-
-         Name : Example Value (ABC1).
-
-    ![Screenshot 2025-01-29 at 2.49.43 PM.png](images/Screenshot_2025-01-29_at_2.49.43_PM.png)
-
-- Click on Test to check if the Connector setup was successful and expect a successful response as shown below. You will see the request response on the left side and the generated output schema on the right.
-- If the output schema does not match the API response or fails to populate automatically, kindly click the GENERATE FROM RESPONSE button to refresh and align the schema with the API response.
-
-    ![Screenshot 2025-01-29 at 2.51.05 PM.png](images/Screenshot_2025-01-29_at_2.51.05_PM.png)
-
-- Add the **API Name** and **API Description** as shown below, then click the Save button
-
-    ![imgae1.png](images/imgae1.png)
-
-
-## **Step 2: Build Compound Action**
-
-- Head over to the **Compound Actions** tab and click **CREATE**
-
-    ![Screenshot 2025-01-22 at 5.59.03 PM.png](images/Screenshot_2025-01-22_at_5.59.03_PM.png)
-
-- Give your Compound Action a **Name** and **Description** , then click Next Note: Name only letters, numbers, and underscores. We suggest using snake case or camel case formatting (e.g. Workflow_name or workflowName )
-
-    ![Screenshot 2025-01-22 at 6.51.24 PM.png](images/Screenshot_2025-01-22_at_6.51.24_PM.png)
-
-
-- Click on the Script editor tab. Here you will be able to build your compound action using the YAML syntax.
-- At a high-level, this syntax provides actions (HTTP Request, APIthon Scripts) and workflow logic (switch statements, for each loops, return statements, parallel, try/catch). See the [Compound Action Syntax](https://developer.moveworks.com/creator-studio/reference/compound_actions_syntax/) Reference for more info.
-
-```yaml
-steps:
-  - action:
-      output_key: result
-      action_name: Salesforce_Lookup_Opportunity
-      progress_updates:
-        on_complete: ON_COMPLETE_MESSAGE
-        on_pending: ON_PENDING_MESSAGE
-      input_args:
-        account_name: data.account_name
-  - return:
-      output_mapper:
-        StageName: data.result.records[0].StageName
-        Amount: data.result.records[0].Amount
-        CloseDate: data.result.records[0].CloseDate
-        Name: data.result.records[0].Name
+The Retrieve Opportunity information by account name API retrieves Opportunity details for a given **Account Name** from Salesforce using a SOQL query. This API helps in accessing Opportunity information associated with specific Salesforce accounts.
 
+```bash
+curl --location 'https://<YOUR_DOMAIN>//services/data/v62.0/query?q=SELECT%20AccountId%2C%20Amount%2C%20StageName%2C%20CloseDate%2C%20Id%20FROM%20Opportunity%20WHERE%[20Account.Name](http://20account.name/)%20like%20ABC1%20ORDER%20BY%20CloseDate%20DESC%20LIMIT%201' \
+--header 'Content-Type: application/json'
 ```
 
-- Click on Input fields tab and click the +Add button. Here you will define the slots that you want to collect from users through the conversation and trigger your Workflow with. After defining the input fields, click the Submit button to save your changes.
-
-    ![Screenshot 2025-01-29 at 2.54.59 PM.png](images/Screenshot_2025-01-29_at_2.54.59_PM.png)
-
-
-## **Step 3: Publish Workflow to Plugin**
-
-- Head over to the Compound Action tab and click on the kebab menu ( ︙ )
-- Next, click on Publish Workflow to Plugin
-- First, verify your Plugin **Name** & **Short description** . This is autofilled from the name & description of your compound action.
-
-    ![Screenshot 2025-01-31 at 3.40.45 PM.png](images/Screenshot_2025-01-31_at_3.40.45_PM.png)
-
-
-- Next, consider whether to select the User consent required before execution? checkbox. Enabling this option prompts the user to confirm all slot values before executing the plugin, which is widely regarded as a best practice.
-
-    ![Screenshot 2025-01-31 at 3.41.19 PM.png](images/Screenshot_2025-01-31_at_3.41.19_PM.png)
-
-- Click Next and set up your positive and negative triggering examples. This ensures that the bot triggers your plugin given a relevant utterance.
-    - See our [guide](https://developer.moveworks.com/creator-studio/conversation-design/triggers/natural-language-triggers/#how-to-write-good-triggering-examples) on Triggering
-- Lastly, click Next and set the **Launch Rules** you want your plugin to abide by.
-    - See our [guide](https://developer.moveworks.com/creator-studio/administration/launch-options/) on Launch Rules
-
-## **Step 4: See it in action!**
-
-- After clicking the final Submit button, your plugin will be published to the bot and triggerable based on your **Launch Rules.**
-- You should wait up to **5 minutes** after making changes before trying to test in your bot!
-- If you run into an issue:
-    1. Check our [troubleshooting guides](https://developer.moveworks.com/creator-studio/troubleshooting/support/)
-    2. Understand your issue using Logs
-    3. Reach out to Support
-
-# **Congratulations!**
+**Query Parameters:**
 
-You've just added the "Lookup Opportunity Information" feature inside your Salesforce account to your Copilot! Explore our other guides for more inspiration on what to build next.
+- Account_Name(string) – The name of the Account to search for related contracts in Salesforce.