diff --git a/src/components/header.jsx b/src/components/header.jsx index e7294f2a..03f4d362 100644 --- a/src/components/header.jsx +++ b/src/components/header.jsx @@ -52,14 +52,14 @@ const Header = () => { > BOOK A DEMO - GET STARTED FREE - + */} Before you begin, ensure that: > 1. An API key exists for your Testsigma account. Refer to the [documentation on generating API keys](https://testsigma.com/docs/configuration/api-keys/). > 2. The test plan run is complete. -> 3. The result ID for the level you want to export is available. Refer to the [documentation on fetching test results at all levels](https://testsigma.com/docs/api/test-results-at-all-levels/). +> 3. The result ID for the level you want to export is available. Refer to [Retrieve the Result IDs](#retrieve-the-result-ids) for test machine and test suite exports, or to the [documentation on fetching test results at all levels](https://testsigma.com/docs/api/test-results-at-all-levels/). > 4. PDF report export is enabled for your account, if you export in PDF format. --- @@ -81,6 +84,46 @@ Report generation is asynchronous. The same endpoint both triggers the report an --- +## **Retrieve the Result IDs** + +The test machine and test suite result IDs are not exposed in the UI. Retrieve them from the network requests that the **Run Results** page sends, then use them in the export endpoint for that level. + +[[info | NOTE:]] +| The test plan run ID is available in the URL of the **Run Results** page. Refer to the [documentation on obtaining the run ID](https://testsigma.com/docs/api/test-plans/#obtaining-the-run-id). + +### **Retrieve the Test Machine Result ID** + +1. Open the completed test plan run on the **Run Results** page. +2. From the view dropdown, select **Test Machines**. +3. Select the test machine you want to export. +4. Open the browser developer tools and go to the **Network** tab. +5. Clear the network log. +6. Reload the page. +7. Select the **Environments** request in the network log. +8. In the **Preview** panel, copy the machine result ID from the response. +  + +9. Use the copied value as **{MACHINE\_RESULT\_ID}** in the export request. + +### **Retrieve the Test Suite Result ID** + +1. Open the completed test plan run on the **Run Results** page. +2. From the view dropdown, select **Test Suites**. +3. Select the test suite you want to export. +4. Open the browser developer tools and go to the **Network** tab. +5. Clear the network log. +6. Reload the page. +7. Select the **Test Suite** request in the network log. +8. In the **Preview** panel, copy the test suite result ID from the response. +  + +9. Use the copied value as **{SUITE\_RESULT\_ID}** in the export request. + +[[info | NOTE:]] +| The test case result ID follows the same pattern at the test case level. Refer to the [documentation on fetching test results at all levels](https://testsigma.com/docs/api/test-results-at-all-levels/) for the response fields at each level. + +--- + ## **API Specification** ### **Export a Test Plan Run Report** diff --git a/src/pages/docs/atto/generative-ai/overview.md b/src/pages/docs/atto/generative-ai/overview.md index 4d013213..a6870605 100644 --- a/src/pages/docs/atto/generative-ai/overview.md +++ b/src/pages/docs/atto/generative-ai/overview.md @@ -41,7 +41,7 @@ Testsigma also integrates seamlessly with tools like Jira, Figma, Xray, and qTes > > 1. From the **Dashboard**, go to **Settings > Preferences**. > 2. Turn on the **Generative AI features** toggle. -  +  [[info | **NOTE**:]] | diff --git a/src/pages/docs/auto-healing/enable-the-auto-healing-feature.md b/src/pages/docs/auto-healing/enable-the-auto-healing-feature.md index d97018be..10529005 100644 --- a/src/pages/docs/auto-healing/enable-the-auto-healing-feature.md +++ b/src/pages/docs/auto-healing/enable-the-auto-healing-feature.md @@ -29,8 +29,8 @@ This article discusses how to enable the auto-healing feature. 1. Navigate to **Settings > Preferences**.  -2. On the **Preferences** page, enable the toggle on the **Auto Healing** widget. -  +2. On the **Preferences** page, enable the toggle on the **Generative AI Autoheal** widget. +  Your tests are ready to execute without manual intervention whenever there are changes in the build. The Auto Healing feature will automatically correct the elements. diff --git a/src/pages/docs/desktop-automation/batch-elements.md b/src/pages/docs/desktop-automation/batch-elements.md index 8039ffe0..5b7e1139 100644 --- a/src/pages/docs/desktop-automation/batch-elements.md +++ b/src/pages/docs/desktop-automation/batch-elements.md @@ -13,69 +13,83 @@ contextual_links: name: "Prerequisites" url: "#prerequisites" - type: link - name: "Interactive Demo" - url: "#interactive-demo" + name: "Steps to Record Elements Using the Batch Tab" + url: "#steps-to-record-elements-using-the-batch-tab" - type: link - name: "Steps to Create Elements Using Batch Element Recorder" - url: "#steps-to-create-elements-using-batch-element-recorder" + name: "Element Recorder Controls" + url: "#element-recorder-controls" +- type: link + name: "Keyboard Shortcuts" + url: "#keyboard-shortcuts" --- --- -The Batch Element Recorder lets you capture all UI elements in a desktop application window at once, without manually selecting each element. Once recorded, the elements are displayed in a hierarchical tree structure for easy viewing and locating while creating test cases. This article discusses how to create multiple elements using Batch Elements Recorder. +Capture every UI element in a desktop application window at once using the **Batch** tab of the Element Recorder. Recorded elements appear in a hierarchical tree along with their properties and can be used while creating test steps. --- > Prerequisites > > Before you begin, ensure that: -> 1. You have referred to the [documentation on creating projects](https://testsigma.com/docs/projects/overview/). -> 2. You have referred to the [docuemntation on creating applications](https://testsigma.com/docs/projects/applications/) in Testsigma. -> 3. You should have the **Testsigma Terminal** installed. -> 4. The **WinTest Automation** folder must exist in the **Testsigma Agent** directory. -> 5. You have a Windows application to test and make sure it’s open on your device. +> 1. A Desktop project and an application exist in Testsigma. See [creating projects](https://testsigma.com/docs/projects/overview/) and [creating applications](https://testsigma.com/docs/projects/applications/). +> 2. **Testsigma Terminal** is installed on your Windows system. +> 3. The **WinTest Automation** folder exists in the **Testsigma Agent** directory. +> 4. The Windows application you want to record is open on your device. --- -## **Interactive Demo** - - - - - - - - ---- - -## **Steps to Create Elements Using Batch Element Recorder** +## **Steps to Record Elements Using the Batch Tab** 1. From the left navigation bar, go to **Create Tests > Elements**. -2. In the Elements list page, click **Record**. - -3. In the **Desktop Element Recorder** dialog, select the **Batch Element Recorder** radio button and click **Launch**. - -4. In the **Select Application** window, select an application and click **Start Recording**. +2. On the Elements list page, click **Record**. +  +3. In the **Select application** window, select the desktop application you want to record against. [[info | **NOTE**:]] -| - To record multiple elements in a desktop application, ensure the application is open on your device. +| Only applications running on your device are listed. Use the search field to filter the list, or click the refresh icon to reload it after opening a new application. -5. The **Batch Element Recorder** automatically captures all elements in the currently open window of the application. +4. Click **Start recording**. + +5. In the Element Recorder, click the **Batch** tab. The recorder captures every element in the currently open window of the application and lists them in a hierarchical tree. +  [[info | **NOTE**:]] -| - When you switch windows within the same application, the recorder captures elements from the new window and clears those recorded from the previous one. +| When you switch windows within the same application, the recorder captures elements from the new window and clears those recorded from the previous one. -6. Once the elements are recorded, select an element name in the recorder and click **Locate Element** to highlight it in the actual application window. +6. Select an element in the tree to view its details in the **Element properties** panel. -[[info | **NOTE**:]] -| - You can use the **Expand All** and **Collapse All** buttons at the top of the recorder to quickly view or hide the full hierarchy of recorded elements. +7. Click **Locate** to highlight the selected element in the application window. -7. Click **Save all elements & Exit**. +8. Click **Save**. The recorded elements are listed under **Create Tests > Elements**. --- +## **Element Recorder Controls** +| Control | Description | +|---|---| +| Selective / Batch | Switches the capture mode. Switch to **Selective** to capture elements one at a time without relaunching the recorder. | +| Expand all / Collapse all | Expands or collapses the full hierarchy of recorded elements. | +| Search | Filters the recorded element tree by name. | +| Element properties | Displays the properties of the selected element, such as Name, Type, Class, AutomationId, and FrameworkId. | +| Locate | Highlights the selected element in the application window. | +| Save | Saves the recorded elements to the Elements list. | +The recorder footer displays a running count of captured elements, such as **78 elements recorded**. +[[info | **Additional Information**:]] +| Batch capture records the full control tree of the window, including containers such as the title bar and tab groups. Use the search field to narrow the tree to the elements you need before saving. + +--- +## **Keyboard Shortcuts** + +| Shortcut | Action | +|---|---| +| Alt+R | Record | +| Alt+S | Stop | +| Ctrl+Shift+F | Freeze | + +--- diff --git a/src/pages/docs/desktop-automation/desktop-projects-and-applications.md b/src/pages/docs/desktop-automation/desktop-projects-and-applications.md index 1f5e01c3..90790178 100644 --- a/src/pages/docs/desktop-automation/desktop-projects-and-applications.md +++ b/src/pages/docs/desktop-automation/desktop-projects-and-applications.md @@ -9,9 +9,6 @@ warning: false contextual_links: - type: section name: "Contents" -- type: link - name: "Interactive Demo" - url: "#interactive-demo" - type: link name: "Steps to Create a Project and an Application" url: "#steps-to-create-a-project-and-an-application" @@ -25,17 +22,6 @@ For more information, refer to the [documentation on creating projects](https:// --- -## **Interactive Demo** - - - - - - - - ---- - ## **Steps to Create a Project and an Application** 1. Navigate to **Project** on the left navigation bar, and click **New Project**. diff --git a/src/pages/docs/desktop-automation/selective-elements.md b/src/pages/docs/desktop-automation/selective-elements.md index 301f81c0..d6e9ce47 100644 --- a/src/pages/docs/desktop-automation/selective-elements.md +++ b/src/pages/docs/desktop-automation/selective-elements.md @@ -13,60 +13,84 @@ contextual_links: name: "Prerequisites" url: "#prerequisites" - type: link - name: "Steps to Create Elements Using Selective Element Recorder" - url: "#steps-to-create-elements-using-selective-element-recorder" + name: "Steps to Record Elements Using the Selective Tab" + url: "#steps-to-record-elements-using-the-selective-tab" +- type: link + name: "Element Recorder Controls" + url: "#element-recorder-controls" +- type: link + name: "Keyboard Shortcuts" + url: "#keyboard-shortcuts" --- --- -The Selective Element Recorder lets you capture specific UI elements in a desktop application by selecting one element at a time. Once recorded, the elements are displayed in a hierarchical tree structure for easy viewing and locating while creating test cases. This article explains how to capture individual elements using the Selective Element Recorder. +Capture UI elements one at a time in a desktop application using the **Selective** tab of the Element Recorder. Recorded elements appear in a hierarchical tree along with their properties and can be used while creating test steps. --- > Prerequisites > > Before you begin, ensure that: -> 1. You have referred to the [documentation on creating projects](https://testsigma.com/docs/projects/overview/). -> 2. You have referred to the [docuemntation on creating applications](https://testsigma.com/docs/projects/applications/) in Testsigma. -> 3. You should have the **Testsigma Terminal** installed. -> 4. The **WinTest Automation** folder must exist in the **Testsigma Agent** directory. -> 5. You have a Windows application to test and make sure it’s open on your device. +> 1. A Desktop project and an application exist in Testsigma. See [creating projects](https://testsigma.com/docs/projects/overview/) and [creating applications](https://testsigma.com/docs/projects/applications/). +> 2. **Testsigma Terminal** is installed on your Windows system. +> 3. The **WinTest Automation** folder exists in the **Testsigma Agent** directory. +> 4. The Windows application you want to record is open on your device. --- -## **Steps to Create Elements Using Selective Element Recorder** - -1. From the left navigation bar, go to **Create Tests > Elements**. +## **Steps to Record Elements Using the Selective Tab** -2. In the Elements list page, click **Record**. +1. From the left navigation bar, go to **Create Tests > Elements**. -3. In the **Desktop Element Recorder** dialog box, select the **Selective Element Recorder** radio button and click **Launch**. +2. On the Elements list page, click **Record**. +  -4. In the **Select Application** window, select an application and click **Start Recording**. +3. In the **Select application** window, select the desktop application you want to record against. [[info | **NOTE**:]] -| - To record an element in a desktop application, make sure the application is open on your device. +| Only applications running on your device are listed. Use the search field to filter the list, or click the refresh icon to reload it after opening a new application. -5. Click the **Record** button in the recorder to start capturing the element. +4. Click **Start recording**. The Element Recorder opens on the **Selective** tab, with the application name displayed in the recorder header. +  -6. Hover over the element in your application until it is highlighted in green, then click on it to capture it. - -7. Once the element is recorded, select an element name in the recorder and click **Locate Element** to highlight it in the actual application window. +5. Hover over an element in the application until it is highlighted in green, then click it to capture it. [[info | **NOTE**:]] -| - You can use the **Expand All** and **Collapse All** buttons at the top of the recorder to quickly view or hide the full hierarchy of recorded elements. - -8. Click **Save Element**. - ---- +| To capture elements that disappear on hover, such as menus and dropdowns, click **Freeze** or press **Ctrl+Shift+F** to hold the current UI state, then click the element. +6. Select a captured element in the tree to view its details in the **Element properties** panel. +7. Click **Locate** to highlight the selected element in the application window. +8. Click **Save**. The recorded elements are listed under **Create Tests > Elements**. +--- +## **Element Recorder Controls** +| Control | Description | +|---|---| +| Selective / Batch | Switches the capture mode. Switch to **Batch** to capture every element in the current window without relaunching the recorder. | +| Pause | Pauses capture. The application stays open and recorded elements are retained. | +| Stop | Ends the recording session. | +| Freeze | Holds the current UI state so transient elements such as menus and dropdowns can be captured. | +| Expand all / Collapse all | Expands or collapses the full hierarchy of recorded elements. | +| Search | Filters the recorded element tree by name. | +| Element properties | Displays the properties of the selected element, such as Name, Type, Class, AutomationId, and FrameworkId. | +| Locate | Highlights the selected element in the application window. | +| Save | Saves the recorded elements to the Elements list. | +The recorder footer displays a running count of captured elements, such as **2 elements recorded**. +--- +## **Keyboard Shortcuts** +| Shortcut | Action | +|---|---| +| Alt+R | Record | +| Alt+S | Stop | +| Ctrl+Shift+F | Freeze | +--- diff --git a/src/pages/docs/desktop-automation/test-cases-for-desktop-automation.md b/src/pages/docs/desktop-automation/test-cases-for-desktop-automation.md index 60770473..81c57687 100644 --- a/src/pages/docs/desktop-automation/test-cases-for-desktop-automation.md +++ b/src/pages/docs/desktop-automation/test-cases-for-desktop-automation.md @@ -13,60 +13,90 @@ contextual_links: name: "Prerequisites" url: "#prerequisites" - type: link - name: "Interactive Demo" - url: "#interactive-demo" + name: "Record Test Steps for a Desktop Application" + url: "#record-test-steps-for-a-desktop-application" - type: link - name: "Steps to Create Test Cases for Desktop Automation" - url: "#steps-to-create-test-cases-for-desktop-automation" + name: "Add Test Steps Manually" + url: "#add-test-steps-manually" +- type: link + name: "Run a Desktop Test Case with Copilot" + url: "#run-a-desktop-test-case-with-copilot" --- --- -Test cases for desktop applications rely on the elements captured through Testsigma Terminal. Once the elements are available, Testsigma automatically suggests relevant actions based on the type of element you select in a test step. This article discusses creating and executing test cases for Desktop Applications in Testsigma. +Create test cases for a desktop application by recording your interactions or by adding steps manually. Recording captures each interaction as a test step and creates the underlying elements as it goes. Testsigma suggests relevant actions based on the type of element used in a step. --- > Prerequisites > > Before you begin, ensure that: -> 1. You have referred to the [documentation on creating projects](https://testsigma.com/docs/projects/overview/). -> 2. You have referred to the [docuemntation on creating applications](https://testsigma.com/docs/projects/applications/) in Testsigma. -> 3. You should have the **Testsigma Terminal** installed. -> 4. The **WinTest Automation** folder must exist in the **Testsigma Agent** directory. -> 5. You have a Windows application to test and make sure it’s open on your device. +> 1. A Desktop project and an application exist. See [Create Projects and Applications](https://testsigma.com/docs/desktop-automation/desktop-projects-and-applications/). +> 2. **Testsigma Terminal** is installed on your Windows system. +> 3. The **WinTest Automation** folder exists in the **Testsigma Agent** directory. +> 4. The Windows application you want to test is open on your device. --- -## **Interactive Demo** +## **Record Test Steps for a Desktop Application** + +1. From the left navigation bar, go to **Create Tests > Test Cases**. + +2. Open the test case you want to record into. + +3. On the test case details page, click **Record** in the **Action Panel**. + +4. In the **Select application** window, select the desktop application you want to record against. +  + +[[info | **NOTE**:]] +| Only applications running on your device are listed. Use the search field to filter the list, or click the refresh icon to reload it after opening a new application. + +5. Click **Start recording**. The Testsigma Recorder opens, the selected application comes to the foreground, and **Open application** is added as the first test step with the application path. + +6. Perform actions in the application. Each interaction is captured as a test step, and the elements involved are created automatically. +  - - - - - - +[[info | **NOTE**:]] +| To record an advanced action on an element, press **Ctrl** and click the element. + +7. Click **Pause** to hold recording without ending the session, or click **Stop** to end it. + +[[info | **Additional Information**:]] +| Elements created during recording are saved under **Create Tests > Elements** and can be reused in other test cases. To capture elements without recording a test case, use the [Selective](https://testsigma.com/docs/desktop-automation/selective-elements/) or [Batch](https://testsigma.com/docs/desktop-automation/batch-elements/) tab of the Element Recorder. --- -## **Steps to Create Test Cases for Desktop Automation** +## **Add Test Steps Manually** -1. From the left navigation bar, go to **Create Tests > Test Cases**. +To add a step manually, click **Actions** from the drop-down on the test case details page, select the required action from the **Actions** overlay, and select a captured desktop element for the step. Testsigma suggests inbuilt actions based on the element type, and you can also use other step types to build the test case. + +--- -2. In the **Test Case Explorer** section, expand the required **Feature** and **Scenario** and click the **+** icon next to the scenario. A dialog box appears. +## **Run a Desktop Test Case with Copilot** -3. In the dialog box, enter the name for your test case and click **Create**. +1. On the test case details page, click **Copilot** in the **Action Panel**. -4. In the **Test Case Details** page, click **Actions** from the drop-down. +2. In the **Copilot** overlay, set the **Set Initial Debug Point** and **Execute from Step** fields, and configure the additional settings if needed. -5. Select the required action from the **Actions** overlay. +3. Click **Launch** and wait for Copilot to start a session. Execution begins on the Windows test machine, and the Copilot panel opens alongside the step results. -6. You can now add test steps by selecting the captured desktop UI elements and choosing the suggested inbuilt actions based on the element type. +4. When execution pauses at a debug point or on a failure, inspect the application and use the execution controls to continue. [[info | **NOTE**:]] -| - You can also use other step types to create and execute the test case. +| The execution status appears at the bottom of the Copilot panel, for example **Execution paused**. + +5. Click **Rec** to record additional steps by performing actions in the application. + +6. Click **Resume** to continue the run. + +  + +### **Execution Controls** -7. Once the test steps are created, click **Run** to execute the test case. This will open an **Ad-Hoc Run** overlay. +**Resume** continues the test from the next execution step without restarting from the beginning. **Rec** records additional steps into the test case during the session. -8. In the **Ad-Hoc Run** overlay, select the test machine, add additional settings if required, and click **Run Now**. +Copilot provides a further set of execution controls, including **Pause**, **Step Over**, **Skip Over**, and **Restart Execution**. --- \ No newline at end of file diff --git a/src/pages/docs/projects/overview.md b/src/pages/docs/projects/overview.md index c51c34be..c9c55065 100644 --- a/src/pages/docs/projects/overview.md +++ b/src/pages/docs/projects/overview.md @@ -78,7 +78,7 @@ The engines available depend on the application type: | Android | Classic | | iOS | Classic | | Mobile Web | Classic | -| Salesforce | Classic | +| Salesforce | Classic and Modern | | REST API | Classic | | Desktop | Classic | | Windows | Classic | diff --git a/src/pages/docs/salesforce-testing/connected-app.md b/src/pages/docs/salesforce-testing/connected-app.md index 82b51619..97ab25f0 100644 --- a/src/pages/docs/salesforce-testing/connected-app.md +++ b/src/pages/docs/salesforce-testing/connected-app.md @@ -1,7 +1,7 @@ --- -title: "Creating a Connected App" -page_title: "Create a Connected App" -metadesc: "A connected app is important to link external applications & the Salesforce ecosystem. This article discusses how to create a connected app in Salesforce." +title: "Creating an External Client App" +page_title: "Create an External Client App" +metadesc: "Create an External Client App in Salesforce to link your Salesforce organization to Testsigma and download metadata. Includes the legacy connected app steps." noindex: false order: 29.2 page_id: "Create Connected Application" @@ -13,90 +13,161 @@ contextual_links: name: "Prerequisites" url: "#prerequisites" - type: link - name: "Steps to Enable Connected Apps" - url: "#steps-to-enable-connected-apps" + name: "Steps to Create an External Client App" + url: "#steps-to-create-an-external-client-app" - type: link - name: "Steps to Create a Connected App" - url: "#steps-to-create-a-connected-app" + name: "Fetch Consumer Details for an External Client App" + url: "#fetch-consumer-details-for-an-external-client-app" - type: link - name: "Fetch Consumer Details" - url: "#fetch-consumer-details" + name: "Steps to Create a Connected App (Legacy)" + url: "#steps-to-create-a-connected-app-legacy" +- type: link + name: "Fetch Consumer Details for a Connected App (Legacy)" + url: "#fetch-consumer-details-for-a-connected-app-legacy" +- type: link + name: "Reset the Security Token" + url: "#reset-the-security-token" --- --- -Creating a connected app is important to link external applications and the Salesforce ecosystem. With a connected app, you can integrate APIs, enable single sign-on (SSO), and build applications. This article discusses how to create a connected app in Salesforce. +Create an External Client App in Salesforce to link your Salesforce organization to Testsigma and download metadata. Salesforce has replaced connected app creation with External Client Apps in newer organizations. This article discusses how to create an External Client App in Salesforce and fetch the consumer details that Testsigma needs. + +[[info | **NOTE**:]] +| If your Salesforce organization still offers a **New Connected App** option, follow [Steps to Create a Connected App (Legacy)](#steps-to-create-a-connected-app-legacy) instead. --- > Prerequisites > -> Before you begin, ensure you have a Salesforce organization setup. +> Before you begin, ensure that: +> 1. A Salesforce organization exists. +> 2. The admin email for the organization is accessible, since the identity verification code and the security token are sent there. --- -## **Steps to Enable Connected Apps** +## **Steps to Create an External Client App** + +1. Log into your Salesforce instance. + +2. On the **Setup** page, enter **App Manager** in the quick finder, and click **App Manager**. + +3. Click **New External Client App** at the top right of the **App Manager** list view. + +4. In the **Basic Information** section, enter the **External Client App Name**, **API Name**, and **Contact Email**. + +[[info | **NOTE**:]] +| Salesforce automatically fills in the **API Name** field. + +5. Set **Distribution State** to **Local**. + +6. Expand the **API (Enable OAuth Settings)** section and select the **Enable OAuth** checkbox. + +7. In the **Callback URL** field, enter the Testsigma callback URL. + +[[info | **NOTE**:]] +| Use this Callback URL: https://salesforce-callback.testsigma.com/authorize/ + +8. Select the required OAuth scopes and move them to the **Selected OAuth Scopes** list using the arrow control. + +[[info | **NOTE**:]] +| The selected scopes are mandatory to connect to your Salesforce organization and download the metadata. + +9. Under **Security**, select **Require Secret for Web Server Flow** and **Require Secret for Refresh Token Flow**. + +[[info | **NOTE**:]] +| Testsigma connects through the standard OAuth web server (authorization code) flow, so you can leave the **Flow Enablement**, **Canvas**, **Mobile App Configuration**, and **Custom Attributes** sections unchanged. + +10. Click **Create**. + +[[info | **NOTE**:]] +| - Wait 10–15 minutes after creating the app before you establish a connection from Testsigma. +| - Some Salesforce editions do not include API access, and connections cannot be created in them. For more information, refer to Salesforce editions with API access. + +--- + +## **Fetch Consumer Details for an External Client App** + +1. Open the External Client App you created and go to the **Settings** tab. + +2. Expand the **OAuth Settings** section. + +3. Click **Consumer Key and Secret**. The **Verify Your Identity** window opens in a new tab. + +4. On the **Verify Your Identity** window, enter the OTP sent to the admin email. Upon verification, Salesforce displays the **Consumer Key** and **Consumer Secret**. + +--- + +## **Steps to Create a Connected App (Legacy)** + +[[info | **NOTE**:]] +| Salesforce has deprecated connected app creation. Follow these steps only if your organization still offers a **New Connected App** option. Otherwise, follow [Steps to Create an External Client App](#steps-to-create-an-external-client-app). 1. Log into your Salesforce instance. 2. On the **Setup** page, enter **Apps** in the quick finder, and click **Settings** under **External Client Apps**.  -3. On the **External Client App Settings** page, under the **Connected Apps** section, enable the **Allow creation of connected apps** toggle. +3. On the **External Client App Settings** page, under the **Connected Apps** section, ensure the **Allow creation of connected apps** toggle is enabled.  -4. On the **Enable Connected Apps Connection?** dialog, click **Enable**. +4. On the **Enable Connected Apps Connection?** dialog, click **Enable**.  ---- - -## **Steps to Create a Connected App** +[[info | **NOTE**:]] +| The dialog appears only the first time the toggle is enabled. If connected apps are already enabled in your organization, continue from the next step. -1. On the **External Client App Settings** page, click **New Connected App**. +5. Click **New Connected App**.  -2. In the **Basic Information** section, enter **Connected App Name**, **API Name**, and **Contact Email**. +6. In the **Basic Information** section, enter the **Connected App Name**, **API Name**, and **Contact Email**.  [[info | **NOTE**:]] -| - Salesforce automatically fills in the **API Name** input field. -| - Other input fields are optional. - -3. In the **API** section, select the **Enable OAuth Settings** checkbox to set **Callback URL** and **Selected OAuth Scopes**. The **Selected OAuth Scopes** are mandatory in the **Connected App** to connect & download the metadata. - - - Use this Callback URL: https://salesforce-callback.testsigma.com/authorize/ +| - Salesforce automatically fills in the **API Name** field. +| - The other fields are optional. +7. In the **API** section, select the **Enable OAuth Settings** checkbox to set the **Callback URL** and **Selected OAuth Scopes**.  -1. Click on **Save**. +[[info | **NOTE**:]] +| The selected scopes are mandatory to connect to your Salesforce organization and download the metadata. Use this Callback URL: https://salesforce-callback.testsigma.com/authorize/ + +8. Click **Save**.  [[info | **NOTE**:]] -| - Please wait for 10 - 15 minutes after creating the app, before trying to establish a connection. -| - A connected app is limited to only a few approvals. The system can revoke the oldest approval when the limit exceeds automatically. As a best practice, you can create a different connected app for each new application connection/connection. -| - Some Salesforce editions do not have API access. Generally, these editions are not used in development or production environments, and it is not possible to create connections within them. -| For more information on these editions, refer to the Salesforce editions with API access. +| - Wait 10–15 minutes after creating the app before you establish a connection from Testsigma. +| - A connected app is limited to a few approvals. When the limit is exceeded, the system can automatically revoke the oldest approval. As a best practice, create a separate connected app for each application connection. +| - Some Salesforce editions do not include API access, and connections cannot be created in them. For more information, refer to Salesforce editions with API access. --- -## **Fetch Consumer Details** +## **Fetch Consumer Details for a Connected App (Legacy)** -1. Edit the connected app and click on **Manage Consumer Details**. This will open a new window. +1. Edit the connected app and click **Manage Consumer Details**. The **Verify Your Identity** window opens in a new tab.  [[info | **NOTE**:]] -| Ensure that none of the checkboxes in the API section are selected. +| Ensure that none of the checkboxes in the **API** section are selected. -2. On the **Verify Your Identity** window, enter OTP sent to the admin email. +2. On the **Verify Your Identity** window, enter the OTP sent to the admin email.  -3. Upon verification, the **Consumer Details** page will be displayed with **Consumer Key** and **Consumer Secret**. +3. Upon verification, the **Consumer Details** page displays the **Consumer Key** and **Consumer Secret**.  -4. For Security Token, go to **My Personal Information > Reset My Security Token** and click on **Reset Security Token**. A new token will be sent to admin mail. Please refer to Salesforce for more information. +--- + +## **Reset the Security Token** + +To get the security token, go to **My Personal Information > Reset My Security Token** and click **Reset Security Token**. Salesforce sends a new token to the admin email. For more information, refer to Salesforce. + +[[info | **NOTE**:]] +| Use the **Consumer Key**, **Consumer Secret**, and the security token when you create a [metadata connection](https://testsigma.com/docs/salesforce-testing/metadata-connections/) or a [user connection](https://testsigma.com/docs/salesforce-testing/user-connections/) in Testsigma. -> Refer to the [documentation on Salesforce troubleshooting](https://testsigma.com/docs/troubleshooting/salesforce-testing/most-common-issues/) guide for the most common issues while creating a connected app. +> Refer to the [documentation on Salesforce troubleshooting](https://testsigma.com/docs/troubleshooting/salesforce-testing/most-common-issues/) guide for the most common issues while setting up an app for the connection. ---- \ No newline at end of file +---
Prerequisites