kane ai variables guide

Author: Aman1905

assets/images/kane-ai/knowledge-base/variables/1.png

@@ -0,0 +1,89 @@
+---
+id: kane-ai-using-variables
+title: KaneAI - Using Variables in Test Cases
+hide_title: false
+sidebar_label: Variables Guide
+description: Learn how to use variables in the KaneAI test cases
+keywords:
+  - lambdatest automation
+  - lambdatest kaneai
+  - kaneai scroll elements
+  - kaneai sidebar scroll
+url: https://www.lambdatest.com/support/docs/kane-ai-using-variables/
+site_name: LambdaTest
+slug: kane-ai-using-variables/
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
+
+<script type="application/ld+json"
+      dangerouslySetInnerHTML={{ __html: JSON.stringify({
+       "@context": "https://schema.org",
+        "@type": "BreadcrumbList",
+        "itemListElement": [{
+          "@type": "ListItem",
+          "position": 1,
+          "name": "Home",
+          "item": "https://www.lambdatest.com"
+        },{
+          "@type": "ListItem",
+          "position": 2,
+          "name": "Support",
+          "item": "https://www.lambdatest.com/support/docs/"
+        },{
+          "@type": "ListItem",
+          "position": 3,
+          "name": "KaneAI Jira Integration",
+          "item": "https://www.lambdatest.com/support/docs/kane-ai-using-variables/"
+        }]
+      })
+    }}
+></script>
+The new variable definition feature in KaneAI allows users to define reusable variables, assign them values, and use those values within test cases. This feature enhances flexibility, readability, and consistency across test cases, making it easier to maintain and modify them.
+
+## Why Use Variables?
+Using variables enables you to:
+- Avoid repetitive entries in test cases.
+- Update values in one place without needing to modify multiple test cases.
+- Increase the reusability and adaptability of test scripts, especially useful for parameters that might change frequently, such as URLs, credentials, or environmental settings.
+
+## Variable Syntax
+To work with variables in KaneAI, you need to follow these syntax rules:
+
+- Variables are defined using the `$` prefix
+- Variable names should follow the `$` symbol without any spaces
+- Example: `$username`, `$phoneNumber`, `$address`
+
+## Creating Variables
+To create a variable:
+
+- Navigate to the "Write a Step" text field
+- Type your instruction using the following format: *create a variable `$variableName`*
+
+Example:
+```bash
+create a variable $phoneNumber
+```
+
+## Using Variables
+To use a previously created variable in any subsequent step or test case, reference the variable using the same `$` syntax. Format: *use the value of `$variableName`*
+
+Example:
+```bash
+use the value of $phoneNumber in the given text field
+```
+<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/variables/1.png').default} alt="kenai-jira integration" className="doc_img"/>
+
+## Best Practices
+### Naming Conventions
+- Use descriptive names for your variables
+- Avoid special characters except for the required $ prefix
+- Use camelCase for multi-word variable names
+
+### Variable Management
+- Create variables at the beginning of your test case when possible
+- Document the purpose of each variable in comments
+- Verify that variables are defined before using them

docs/kane-ai-using-variables.md

@@ -1047,7 +1047,8 @@ module.exports = {
         label: "Knowledge Base",
         items: [
           "kane-ai-command-guide",
-          "kane-ai-web-test-writing-guidelines"
+          "kane-ai-web-test-writing-guidelines",
+          "kane-ai-using-variables"
         ],
       },
       {