Added new documentation for "SOQL as Test Step", "Query Builder for Salesforce Testing", and "Test Salesforce Connection" #634
Conversation
New Document for "Use MySQL Addon in NLPs"
…Salesforce Testing", and "Test Salesforce Connection" Added new docs for "SOQL as Test Step", "Query Builder for Salesforce Testing", and "Test Salesforce Connection"
WalkthroughThis update introduces several new documentation pages and makes minor metadata adjustments to existing Salesforce testing documentation. Three new pages are added: one detailing the use of the Query Builder for Salesforce Testing, another on using SOQL queries as test steps, and a third explaining how to test Salesforce connections before authorization. Additionally, a new troubleshooting guide for using the MySQL Addon in NLPs is included. Existing pages receive updates to their order metadata and, in one case, a new NLP (NLP 19) is documented, along with corresponding navigation and contextual link updates. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsSite
User->>DocsSite: Access Salesforce Testing Docs
alt Query Builder
User->>DocsSite: Open "Query Builder for Salesforce Testing"
DocsSite-->>User: Show prerequisites, steps, SOQL example, usage
end
alt SOQL as Test Step
User->>DocsSite: Open "SOQL as Test Step"
DocsSite-->>User: Show prerequisites, step-by-step guide, result handling
end
alt Test Salesforce Connection
User->>DocsSite: Open "Test Salesforce Connection Before Authorization"
DocsSite-->>User: Show connection testing steps and troubleshooting
end
alt MySQL Addon in NLPs
User->>DocsSite: Open "Use MySQL Addon in NLPs"
DocsSite-->>User: Show prerequisites, use cases, SQL examples
end
alt NLP 19
User->>DocsSite: Open "Special NLPs"
DocsSite-->>User: Show NLP 19 documentation and navigation
end
Possibly related PRs
Suggested reviewers
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🔭 Outside diff range comments (1)
src/pages/docs/salesforce-testing/query-builder-for-salesforce-testing.md (1)
61-61:⚠️ Potential issueRemove stray code fence
There's an unpaired triple backtick (\```) at line 61 that opens an empty code block. Delete it to avoid markdown rendering issues.- ```
🧹 Nitpick comments (4)
src/pages/docs/troubleshooting/NLPs/mysql-db-test-cases.md (2)
30-33: Improve image alt text for accessibility
Replace the generic![Addon]alt text with a more descriptive phrase, e.g.:-  + 
8-16: Verify contextual_links match actual headings
After normalizing headings, ensure thecontextual_links.urltargets (e.g.,#prerequisite,#use-cases) correspond exactly to the updated headings.src/pages/docs/salesforce-testing/query-builder-for-salesforce-testing.md (2)
20-20: Remove extraneous horizontal separators
Unintended---lines at 20, 24, and 30 render as unwanted horizontal rules. They should be removed to keep the flow of content.@@ line 20 - --- @@ line 24 - --- @@ line 30 - ---Also applies to: 24-24, 30-30
26-26: Simplify headings by removing bold formatting
Section headings are wrapped in**...**, which is inconsistent with other docs. Use plain markdown headings for clarity and consistency.- ## **Prerequisites** + ## Prerequisites ... - ## **Steps to Use the SOQL Query Builder Tool** + ## Steps to Use the SOQL Query Builder ToolAlso applies to: 32-32
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
src/pages/docs/salesforce-testing/element-repos.md(1 hunks)src/pages/docs/salesforce-testing/error-handling.md(1 hunks)src/pages/docs/salesforce-testing/metadata-connections.md(1 hunks)src/pages/docs/salesforce-testing/query-builder-for-salesforce-testing.md(1 hunks)src/pages/docs/salesforce-testing/sf-test-cases.md(1 hunks)src/pages/docs/salesforce-testing/soql-as-test-step.md(1 hunks)src/pages/docs/salesforce-testing/special-nlps.md(4 hunks)src/pages/docs/salesforce-testing/table-nlps.md(1 hunks)src/pages/docs/salesforce-testing/test-salesforce-connection-before-authorization.md(1 hunks)src/pages/docs/salesforce-testing/user-connections.md(1 hunks)src/pages/docs/troubleshooting/NLPs/mysql-db-test-cases.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
src/pages/docs/salesforce-testing/soql-as-test-step.md
44-44: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
src/pages/docs/troubleshooting/NLPs/mysql-db-test-cases.md
40-40: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
46-46: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
54-54: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
62-62: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
70-70: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
82-82: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
84-84: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
86-86: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
107-107: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
117-117: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
127-127: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
135-135: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
145-145: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
147-147: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
149-149: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
161-161: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
src/pages/docs/salesforce-testing/special-nlps.md
380-380: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: CI
🔇 Additional comments (10)
src/pages/docs/salesforce-testing/table-nlps.md (1)
6-6: Incrementordermetadata to 28.93
The frontmatterordervalue has been updated from 28.91 to 28.93 to maintain sequential navigation after newly added pages.src/pages/docs/salesforce-testing/user-connections.md (1)
6-6: Incrementordermetadata to 28.6
Theordervalue is incremented from 28.5 to 28.6 to keep the page ordering in line with adjacent Salesforce Testing docs.src/pages/docs/salesforce-testing/metadata-connections.md (1)
6-6: Incrementordermetadata to 28.5
Adjusted from 28.4 to 28.5 for consistent sequencing with other Salesforce Testing documentation.src/pages/docs/salesforce-testing/element-repos.md (1)
6-6: Incrementordermetadata to 28.8
Updated from 28.7 to 28.8 to align the document within the overall Salesforce Testing docs order.src/pages/docs/salesforce-testing/sf-test-cases.md (1)
6-6: Incrementordermetadata to 28.7
Theordervalue has been updated from 28.6 to 28.7 to maintain proper navigation sequence.src/pages/docs/salesforce-testing/error-handling.md (1)
6-6: Order metadata update
Theorder: 28.94adjustment aligns this page within the updated Salesforce testing navigation sequence. No content changes detected.src/pages/docs/salesforce-testing/soql-as-test-step.md (1)
6-6: Set page order for new SOQL guide
Theorder: 28.91places this new SOQL step documentation appropriately between related pages.src/pages/docs/salesforce-testing/special-nlps.md (3)
6-6: Order metadata update
Theorder: 28.9bump maintains the sequence of special NLPs in the Salesforce testing docs.
75-77: New NLP 19 contextual link
A link for NLP 19 (#nlp-19) was added. Ensure the target heading exists and matches exactly.Please verify that the added section’s heading uses the same anchor
nlp-19.
116-118: Table entry for NLP 19
The new table row correctly documents NLP 19 with inputs and link. No issues found.
| ## **Prerequisite** | ||
|
|
||
| To begin, set up a MySQL database and configure the necessary tables to store and manage your data effectively. Ensure that the database is accessible from Testsigma, enabling smooth integration and execution of queries within your test automation workflow. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use proper markdown headings instead of emphasized text
Emphasized headings like ## **Prerequisite** and ## **Use Cases** can break anchor links and lint rules (MD036). Convert to plain headings, e.g.:
## Prerequisite
## Use Cases| ``` | ||
| CREATE PROCEDURE GetCustomerDetails(IN cust_id INT) BEGIN SELECT name, email, phone FROM customers WHERE id = cust_id; END; | ||
| ``` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add language identifier to SQL code fences
Fenced code blocks should specify a language for highlighting and linting (MD040). For example:
- ```
+ ```sql
CREATE PROCEDURE GetCustomerDetails(IN cust_id INT) BEGIN SELECT name, ...Apply the same for all other SQL snippets in this file.
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.17.2)</summary>
46-46: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
| --- | ||
| title: "Use MySQL Addon in NLPs" | ||
| metadesc: "Users can execute MySQL queries within NLPs using the MySQL Addon in Testsigma, enabling seamless integration and efficient database operations." | ||
| noindex: false | ||
| order: 23.19 | ||
| page_id: "Use MySQL Addon in NLPs" | ||
| warning: false | ||
| contextual_links: | ||
| - type: section | ||
| name: "Contents" | ||
| - type: link | ||
| name: "Prerequisite" | ||
| url: "#prerequisite" | ||
| - type: link | ||
| name: "Use Cases" | ||
| url: "#use-cases" | ||
|
|
||
| --- | ||
|
|
||
| --- | ||
|
|
||
| Testsigma enables efficient execution of MySQL queries in NLPs using the MySQL Addon. It supports various query types (SELECT, INSERT, UPDATE, DELETE) while maintaining data integrity through a structured approach. | ||
|
|
||
| --- | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consolidate frontmatter and remove extraneous separators
The document currently has multiple YAML delimiters (---) at lines 1, 19–20, and 24, which can break frontmatter parsing. Keep a single --- block at the top (lines 1–17) and remove the extra separators before the main content.
--- a/src/pages/docs/troubleshooting/NLPs/mysql-db-test-cases.md
@@
@@Committable suggestion skipped: line range outside the PR's diff.
| ## **Prerequisites** | ||
|
|
||
| Before you begin, ensure the Salesforce app is connected to Testsigma with a valid metadata connection. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Normalize headings by removing emphasis
Headings like ## **Prerequisites** and ## **Steps to Create SOQL as a Test Step** should be plain markdown (e.g., ## Prerequisites) to generate clean anchors and satisfy MD036.
| ``` | ||
| SELECT Id, Name, Phone, Industry, BillingCity, BillingState | ||
| FROM Account | ||
| WHERE Industry = 'Technology' AND BillingState = 'CA' | ||
| ORDER BY Name | ||
| LIMIT 50 | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add language marker to SOQL snippet
The code fence around the SOQL example lacks a language tag. Specify sql for correct syntax highlighting:
- ```
+ ```sql
SELECT Id, Name, Phone, Industry, BillingCity, BillingState
...
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.17.2)</summary>
44-44: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
| ## **NLP 18:** | ||
|
|
||
| "Store the **recordID** from details page into **variable** [variable-name]" | ||
|
|
||
| Use this NLP to extract the current record ID and stores it in your specified runtime variable name. | ||
|
|
||
| See the GIF below demonstrating how to use this NLP. |
There was a problem hiding this comment.
Fix heading label for the new section
The final section is mis‐labeled as ## **NLP 18:**—it should be ## **NLP 19:** to align with the table and link.
--- a/src/pages/docs/salesforce-testing/special-nlps.md
@@ 380, +380
- ## **NLP 18:**
+ ## **NLP 19:**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## **NLP 18:** | |
| "Store the **recordID** from details page into **variable** [variable-name]" | |
| Use this NLP to extract the current record ID and stores it in your specified runtime variable name. | |
| See the GIF below demonstrating how to use this NLP. | |
| ## **NLP 19:** | |
| "Store the **recordID** from details page into **variable** [variable-name]" | |
| Use this NLP to extract the current record ID and stores it in your specified runtime variable name. | |
| See the GIF below demonstrating how to use this NLP. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
380-380: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
| ## **Steps to Test the Salesforce Connection** | ||
|
|
||
| 1. From the left navigation bar, click on **SF Connections**. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use plain headings for anchor consistency
Change ## **Steps to Test the Salesforce Connection** to ## Steps to Test the Salesforce Connection so that the contextual link #steps-to-test-the-salesforce-connection works as expected.
| --- | ||
| title: "Test Salesforce Connection Before Authorization" | ||
| page_title: "Test Salesforce Connection Before Authorization" | ||
| metadesc: "Test Salesforce connection before authorization in Testsigma" | ||
| noindex: false | ||
| order: 28.4 | ||
| page_id: "Test Salesforce Connection Before Authorization" | ||
| warning: false | ||
| contextual_links: | ||
| - type: section | ||
| name: "Contents" | ||
| - type: link | ||
| name: "Steps to Test the Salesforce Connection" | ||
| url: "#steps-to-test-the-salesforce-connection" | ||
| - type: link | ||
| name: "Troubleshoot" | ||
| url: "#troubleshoot" | ||
| --- | ||
|
|
||
| --- |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consolidate frontmatter and remove extra delimiters
The file shows multiple --- at lines 1, 19, and 20. Retain a single YAML frontmatter block (lines 1–18) and remove the extra --- before the body.
| title: "Query Builder for Salesforce Testsing" | ||
| page_title: "Query Builder for Salesforce Testsing" |
There was a problem hiding this comment.
Fix typo in title, page_title, and page_id
The metadata fields misspell "Testing" as "Testsing", causing rendering and search inconsistencies.
- title: "Query Builder for Salesforce Testsing"
+ title: "Query Builder for Salesforce Testing"
- page_title: "Query Builder for Salesforce Testsing"
+ page_title: "Query Builder for Salesforce Testing"
- page_id: "Query Builder for Salesforce Testsing"
+ page_id: "Query Builder for Salesforce Testing"Also applies to: 7-7
| - type: link | ||
| name: "Steps to use SOQL Query Builder Tool" | ||
| url: "#steps-to-use-soql-query-builder-tool" | ||
| --- |
There was a problem hiding this comment.
Align contextual link name and URL with the actual heading
The contextual_links entry omits "the" in the URL anchor and uses inconsistent capitalization in the name, which will break the in-page navigation.
- - type: link
- name: "Steps to use SOQL Query Builder Tool"
- url: "#steps-to-use-soql-query-builder-tool"
+ - type: link
+ name: "Steps to Use the SOQL Query Builder Tool"
+ url: "#steps-to-use-the-soql-query-builder-tool"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - type: link | |
| name: "Steps to use SOQL Query Builder Tool" | |
| url: "#steps-to-use-soql-query-builder-tool" | |
| --- | |
| - type: link | |
| name: "Steps to Use the SOQL Query Builder Tool" | |
| url: "#steps-to-use-the-soql-query-builder-tool" | |
| --- |
Added new documentation for "SOQL as Test Step", "Query Builder for Salesforce Testing", and "Test Salesforce Connection" as per the ticket: https://testsigma.atlassian.net/browse/IDEA-2302
Summary by CodeRabbit
New Features
Documentation