Automate your Vansah test execution straight from a UiPath workflow. Run a Test Case, then report each step's result (with an optional screenshot) back to Vansah Test Management for Jira, with no manual data entry.
What this does
The UiPath Vansah activity lets you send your automated test results to Vansah Test Management for Jira, right from your workflow. With it you can:
Quick Test - Post an overall result for a Test Case in a single activity.
Start a Test Run against a Work Item, Test Folder, Standard Test Plan, or Advanced Test Plan.
Add a Test Step result (PASSED / FAILED / UNTESTED / N/A) for each step and attach a screenshot or file as evidence.
Example, a login test. Your robot runs a "User Login" Test Case:
Step 1: Enter username and password. The robot fills the fields and posts PASSED.
Step 2: Click Login and land on the dashboard. The dashboard doesn't load, so the robot takes a screenshot of the error and posts FAILED with that screenshot attached. Vansah instantly shows the run with Step 1 passed, and Step 2 failed (plus the evidence), with no manual updates, every time the process runs.
What you'll need before you start
You need | Where to get it |
UiPath Studio (26.0 or later) | Your UiPath installation |
The Vansah.SendResults.Activities package | Add the NuGet feed in UiPath Studio, Manage Packages (see Step 1) |
A Vansah Connect API Token | |
Your Vansah API URL | |
A Space Key and Test Case Key | Your Vansah Space and Test Case (e.g. DEMO, DEMO-C2) |
⚠️ Keep your API token safe. Treat it like a password. Never share it, never paste it into a public page, and never email it. The recommended way to store it is the VANSAH_TOKEN environment variable (see Step 2), so it never appears inside your workflow file.
Step 1: Install the Vansah package
The package is published on NuGet: https://www.nuget.org/packages/Vansah.SendResults.Activities
Option A: UiPath Manage Packages via the NuGet source (recommended)
In UiPath Studio, open your process and go to the Design ribbon, then Manage Packages.
Open the Settings (gear) and make sure the nuget.org package source is added and enabled: https://api.nuget.org/v3/index.json
Go to the All Packages tab and search for Vansah.SendResults.Activities.
Select it, choose the latest version, click Install, then Save.
The Vansah activities now appear in the Activities panel.
Option B: Download the package directly
Go to https://www.nuget.org/packages/Vansah.SendResults.Activities and click Download package (.nupkg).
Place the .nupkg in a local folder, add that folder as a package source in Manage Packages, Settings, then install as in Option A.
Option C: Inspect with NuGet Package Explorer
Open the .nupkg in NuGet Package Explorer if you want to review the package contents, version, and dependencies before installing.
Tip: Option A (the nuget.org source) is the easiest. It always pulls the latest published version and handles dependencies for you.
Step 2: Store your Vansah token securely
The activities read your token from the VANSAH_TOKEN environment variable by default, so you don't have to type it into the workflow.
On the machine (or robot) that will run the process, set a system or user environment variable named VANSAH_TOKEN with your Vansah Connect API token as its value.
Restart UiPath Studio (or the robot) so it picks up the new variable.
Tip: You can also enter the token directly in the Token field of Vansah Start Test Run, but using VANSAH_TOKEN is safer and keeps the secret out of your .xaml file. For production, point that variable at an Orchestrator Credential asset.
Step 3: Add the "Vansah Start Test Run" activity
Drag Vansah Start Test Run into your sequence. This creates the run in Vansah and outputs a Response you'll pass to the step activity.
Configure the core fields
Field | Value |
Space Key | Your Vansah Space Key (e.g. DEMO) |
Test Case Key | The Vansah Test Case (e.g. DEMO-C2) |
Run Type | Work Item, Test Folder, Standard Test Plan, or Advanced Test Plan |
Operation | Set to Activate to actually send to Vansah (defaults to Deactivate as a safety guard) |
API URL | Leave blank to use the default, or enter your region URL |
Token | Leave blank to use VANSAH_TOKEN |
Fill the field for your chosen Run Type
Run Type | Fill in |
Work Item | Work Item Key (e.g. DEMO-2) |
Test Folder | Test Folder Path (e.g. regression/automation/). See Getting the Folder Path of a Test Folder. |
Standard Test Plan | Test Plan Key (e.g. DEMO-P7) plus Iteration (1 to 5) |
Advanced Test Plan | Test Plan Key plus Iteration plus Requirement Type (Work Item or Test Folder). The requirement value comes from Work Item Key or Test Folder Path above. |
Tip: Sprint, Version, Environment, and Script Type are optional and live under Test Run Properties.
Capture the output
Create a variable of type Newtonsoft.Json.Linq.JObject (e.g. VansahTestRun) and set it as the activity's Response output. You'll wire this into every Add Test Step.
Step 4: (Optional) Take a screenshot for evidence
If you want to attach evidence to a step, add UiPath's Take Screenshot activity before your step and store its output in a variable (type IResource).
Step 5: Add the "Vansah Add Test Step" activity
Drag Vansah Add Test Step in after Start Test Run. Repeat it once per step you want to report.
Field | Value |
Test Run Response | The VansahTestRun variable from Step 3. (This carries the API URL, token, and the step's log, so there's no need to re-enter config.) |
Step Number | The step to update (e.g. 1) |
Result | Pick from the dropdown: PASSED, FAILED, UNTESTED, N/A |
Step Result (optional) | Only used if Result is left as "(use Step Result field)". Accepts a variable or expression. |
Actual Result (optional) | A comment or description for the log |
Screenshot (optional) | The IResource from Take Screenshot (Step 4) |
Screenshot Path (optional) | A full file path to attach instead of a resource |
Operation | Set to Activate |
Tip: The Result dropdown always wins. Use the Step Result text field only when you need the value to come from a variable and you've left the dropdown on "(use Step Result field)."
Step 6: Run and verify in Vansah
1. Run your process in UiPath Studio.
2. Watch the Output panel. On success you'll see concise messages like:
a. Test run 42 started (2 step log(s)).
b. Step result updated (passed).
c. Attached screenshot.png to log …
3. Open the Test Case in Vansah. The run and each step result (with any attachments) will be there.
Troubleshooting
Symptom | Likely cause | Fix |
Vansah token not configured. Please set VANSAH_TOKEN environment variable or provide token in activity. | VANSAH_TOKEN not set, or no token entered | Set the VANSAH_TOKEN variable (Step 2) or fill the Token field |
Invalid Vansah token format … JWT should have 3 parts | Wrong value pasted as the token | Copy the full Connect API token from Vansah API Tokens |
Failed to start test run (HTTP 401) | Token invalid or expired, or wrong API URL for your region | Regenerate the token and confirm your region API URL |
Work Item Key is required … (or Test Folder / Test Plan Key) | The field for your selected Run Type is empty | Fill the field that matches your Run Type (Step 3) |
No log found for step N in the Test Run Response | Step number doesn't exist for that Test Case, or the Test Case has no steps | Check the Step Number and that the Test Case has that step |
Updating Step Results in Vansah is Deactivated. Please Activate | Operation is set to Deactivate | Set Operation to Activate |
Screenshot not attached | File path wrong, or resource couldn't be resolved | Check the Screenshot Path or Screenshot input; the Output panel logs a warning |
Test Folder Path is required when Run Type = Test Folder. | When the folder path is not provided. | Check whether the Run Target in Vansah Start Test Run has a Test Folder Path value or linked variables. |