Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/kane-ai/features/modules/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/kane-ai/features/modules/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/kane-ai/features/modules/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/kane-ai/features/modules/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/kane-ai/features/modules/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/kane-ai/features/modules/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/kane-ai/features/modules/7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 7 additions & 3 deletions docs/create-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,23 @@ Don't worry if you don't have all the details now; you can always edit or add th
<img loading="lazy" src={require('../assets/images/mobile-app-testing/modules_creation_page.png').default} alt="modules-listing-page" className="doc_img"/>

:::note
Keep in mind Modules can't be deleted but only updated after creation.
Only modules that are **not linked to any test cases** can be deleted. If a module is used in one or more test cases, the delete option is disabled. See [Delete a Module](/support/docs/kane-ai-modules/#delete-a-module).
:::

## 2. Update Module
Modules support duplication, editing and versioning; however, a new version is only triggered when specific fields are edited.
- Add a step by clicking on `Add Step` or update a step through edit icon.
- Click on `update` on top right to save changes.
- In the inline editor, click `Update` to apply your change to the step. The header then shows **Unsaved changes**: click `Save Changes` on the top right to save them, or `Discard` to drop them.
:::note
Only **Test Step** or **Expected Outcome** updation will create a new version of the module.
:::

<img loading="lazy" src={require('../assets/images/mobile-app-testing/modules_page.png').default} alt="module-page" className="doc_img"/>

:::note
For modules authored in KaneAI, steps that use a variable or parameter and If-Else or While Loop blocks cannot be edited, deleted, or reordered from the Modules page. Edit them from the KaneAI test case the module was authored from.
:::

## 3. Module Versions

### Revert to previous Version
Expand All @@ -119,5 +123,5 @@ You will be redirected to the Version Comparison page where you can track change
<img loading="lazy" src={require('../assets/images/mobile-app-testing/modules_version_comparision.png').default} alt="modules-version-comparision" className="doc_img"/>

:::note
Project linking is only added for manual tests in test cases. Hence, modules linked to a particular project are only available to be added in a manual test case. However, for KaneAI test cases, all modules in all projects will be available for selection.
Project linking is only added for manual tests in test cases. Hence, modules linked to a particular project are only available to be added in a manual test case. However, for KaneAI test cases, all modules in all projects will be available for selection. Modules that contain KaneAI instructions, such as variable steps, If-Else blocks, or While Loops, can be imported only into KaneAI test cases. In a manual test case the **Add Module** dialog blocks them from being added.
:::
33 changes: 29 additions & 4 deletions docs/kane-ai-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,14 @@ Create a new test or open an existing one in the KaneAI web agent.

### Step 2: Import the Module

Use either method to access the modules menu:

- Click the **plus (+)** icon in the test interface
- Type a **slash (/)** to invoke the command menu and select **Add Module**
Type a **slash (/)** to invoke the command menu and select **Add Module**.

Browse the list of available modules and select the one you need.

:::note
Modules that contain KaneAI instructions, such as variable steps, If-Else blocks, or While Loops, can be imported only into KaneAI test cases, not into manual test cases in Test Manager. See [Importing Modules into Test Cases](/support/docs/modules-in-manual-testcases/).
:::

<img loading="lazy" src={require('../assets/images/kane-ai/features/modules/6.png').default} alt="import-module" className="doc_img"/>

### Step 3: Execute
Expand All @@ -127,8 +128,26 @@ Click on an existing module from the Module listing page to modify its steps or

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/modules-versioning/image6.png').default} alt="edit-module" className="doc_img img_center"/>

Editing a step opens it inline, where you can change the test step and its expected outcome. **Update** applies the change to the step, and the module header then shows an **Unsaved changes** label. Click **Save Changes** to commit them, or **Discard** to drop them.

When you save changes to a module, a new version is created automatically. See [Versioning and Enhancements](/support/docs/kaneai-modules-versions-and-enhancement/) for details on how version history works.

### Editing Restrictions

Some steps carry a **Read-Only** label on the module's step listing. Editing, deleting, and reordering are all disabled for:

- Steps that create or use a **variable** or **parameter**
- **If-Else** blocks
- **While Loop** blocks

Hovering the edit icon on one of these steps shows *Editing Kane instructions is not allowed*.

<img loading="lazy" src={require('../assets/images/kane-ai/features/modules/editing-restrictions.png').default} alt="A While Loop step marked Read-Only with the edit action disabled" width="1600" height="831" className="doc_img"/>

These steps are part of a larger flow. A variable step feeds values to later steps, and a control flow block carries branches and nested steps that must change together. To modify them, open the test case the module was authored from, make the change there, and save. The module receives a new version automatically. All other steps can be edited, deleted, and reordered as usual.

Modules authored in a KaneAI session also show an **Author Module to Update Test Cases** banner on the Linked Test Cases tab, noting that linked test cases are updated by authoring and validating the module in a KaneAI session.

---

## Delete a Module
Expand All @@ -146,6 +165,12 @@ You can delete modules that are no longer needed from the module listing page.
Only modules that are **not linked to any test cases** can be deleted. If a module is currently used in one or more test cases, the delete option will be disabled. You must first remove the module from all linked test cases before deleting it.
:::

### Deleting Steps Inside a Module

The delete action is disabled for the same steps. Hovering it shows *Deleting Kane instructions is not allowed*. These steps can be deleted only while authoring, in the KaneAI test case the module was authored from. All other steps can be deleted directly.

<img loading="lazy" src={require('../assets/images/kane-ai/features/modules/delete-restrictions.png').default} alt="The delete action disabled on a While Loop step inside a module" width="1600" height="827" className="doc_img"/>

---

## Best Practices
Expand Down
1 change: 1 addition & 0 deletions docs/kaneai-conditional-logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ To add a module inside a branch:

- **Nested conditions are not supported.** You cannot place an If / Else‑If / Else block inside another conditional block.
- **New conditional blocks cannot be created while a test is paused.** The **/** slash command menu and the **+ Add step** option do not offer **Add If-Else** in the Draft state. Conditional blocks that already exist in the test can still be extended while paused.
- **Conditional blocks are read-only on the Modules page.** A module can contain a conditional block, but changes to it must be made in the KaneAI test case it was authored from. Modules containing conditional blocks cannot be added to manual test cases in Test Manager.

## FAQ

Expand Down
4 changes: 3 additions & 1 deletion docs/kaneai-modules-versions-and-enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ For an overview of creating, using, and managing modules, see [Modules](/support

When you edit an existing module (for example, by adding, removing, or modifying a test step), KaneAI automatically increments the version number (e.g., from 1.1 to 1.2). You do not need to manually create versions.

Some steps are locked on the Modules page and must be changed from the test case the module was authored from. See [Editing Restrictions](/support/docs/kane-ai-modules/#editing-restrictions). Editing them there still increments the module version in the same way.

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/modules-versioning/image8.png').default} alt="version-increment" className="doc_img img_center"/>

After a new version is created, test cases that use the module can either:
Expand Down Expand Up @@ -107,7 +109,7 @@ If a module update introduces problems, you can revert to any earlier version.

Reverting creates a new version (it does not delete the intermediate versions), so you maintain a complete audit trail.

<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/modules-versioning/image3.png').default} alt="revert-version" className="doc_img img_center"/>
<img loading="lazy" src={require('../assets/images/kane-ai/knowledge-base/modules-versioning/revert-version.png').default} alt="revert-version" className="doc_img img_center"/>

---

Expand Down
2 changes: 1 addition & 1 deletion docs/kaneai-while-loops.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Once a While Loop has been finalized, you can still change it. The loop itself s
- **Add, remove, or reorder body steps.** Use the edit instruction action on any step inside the loop; the loop updates automatically to reflect the change.
- **Change the condition.** Edit the While Loop step directly. The new condition applies on the next test run.
- **Finalize later.** If you closed the authoring view before clicking **End While**, the loop remains unfinalized. Re‑open the test, add the remaining body steps, and click **End While** when ready.
- **Loops inside modules.** When a While Loop is part of a [module](/support/docs/kane-ai-modules/), any change to the loop condition or body bumps the module version so other tests using that module pick up the new behavior on their next run.
- **Loops inside modules.** When a While Loop is part of a [module](/support/docs/kane-ai-modules/), any change to the loop condition or body creates a new module version. Other tests using that module stay on the version they already reference until they accept the new one. The loop is read-only on the module's Overview tab. Make changes from the test case the module was authored from. Modules containing While Loops cannot be added to manual test cases in Test Manager.

## Nesting Rules

Expand Down
4 changes: 4 additions & 0 deletions docs/manual-test-case-creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ The Test Manager offers a comprehensive Steps section with a rich text editor an

To know more about how to use Modules refer the [Modules doc](/support/docs/create-modules/).

:::note
Modules that contain KaneAI instructions, such as variable steps, If-Else blocks, or While Loops, run only in KaneAI test cases. Selecting one in the **Add Module** dialog leaves **Add in step** disabled. See [Importing Modules into Test Cases](/support/docs/modules-in-manual-testcases/).
:::

#### Add New Step:

To add a new step click on on the `Add Test Step` button.
Expand Down
14 changes: 13 additions & 1 deletion docs/modules-in-manual-testcases.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,23 @@ From there, you'll be able to select and import the specific module you need.
Keep in mind that only modules already linked with your project will be available for import.
:::

:::note
Modules that contain KaneAI instructions run only in KaneAI test cases. This covers steps that create or use a variable or parameter, If-Else blocks, and While Loops.
:::

The **Add Module** dialog lists the modules available to the test case and selects the first one by default. When the selected module contains KaneAI instructions, the dialog shows *This module can't be imported as it contains a few specific KaneAI instructions* and **Add in step** stays disabled. **Edit Module** is locked for the same module.

<img loading="lazy" src={require('../assets/images/kane-ai/features/modules/add-module-kane-instructions.png').default} alt="The Add Module dialog with a module that cannot be imported into a manual test case" width="1600" height="877" className="doc_img"/>

<img loading="lazy" src={require('../assets/images/mobile-app-testing/import_module_in_manual_testcases.png').default} alt="import-module" className="doc_img"/>

Notice that imported modules will appear visually distinct from other individual steps within your test case, making them easy to identify.

You also have the flexibility to edit or delete these modules directly from this view. However, be aware that making changes will create a new version of that module.
You can also edit or delete imported modules directly from this view. Making changes creates a new version of that module.

:::note
**Edit Module** is disabled for modules that contain variables, an If-Else block, or a While Loop. Edit these from the KaneAI test case they were authored from.
:::

:::note
Please note that when a module is updated to a new version, its existing occurrences within your test cases will not be affected. They will remain linked to the previous version. To utilize the latest version of a module, you'll need to manually sync it by clicking the `Sync to latest` button. This allows you to review and confirm changes before they impact your test cases.
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1820,6 +1820,7 @@ module.exports = {
{ type: "doc", id: "manual-test-case-creation", label: "Create and Manage Test Cases" },
{ type: "doc", id: "test-case-versioning", label: "Manage Versions" },
{ type: "doc", id: "create-modules", label: "Modules: Share Test steps" },
{ type: "doc", id: "modules-in-manual-testcases", label: "Importing Modules into Test Cases" },
{ type: "doc", id: "system-and-custom-fields", label: "Manage System & Custom fields" },
{ type: "doc", id: "copy-and-move-support-for-test-cases", label: "Copy & Move Test Cases" },
{ type: "doc", id: "update-fields", label: "Bulk Update Test Case fields" },
Expand Down