Skip to content

Commit 1079eff

Browse files
committed
Merge branch 'new-dispatcher' of https://github.com/ServiceNow/workarena into new-dispatcher
2 parents c3f6a54 + 65840d8 commit 1079eff

2 files changed

Lines changed: 8 additions & 22 deletions

File tree

README.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -41,40 +41,26 @@ https://github.com/ServiceNow/WorkArena/assets/2374980/68640f09-7d6f-4eb1-b556-c
4141

4242
## Getting Started
4343

44-
To setup WorkArena, you will need to get your own ServiceNow instance, install our Python package, and upload some data to your instance. Follow the steps below to achieve this.
44+
To setup WorkArena, you will need to gain access to ServiceNow instances and install our Python package locally. Follow the steps below to achieve this.
4545

46-
### a) Create a ServiceNow Developer Instance
46+
### a) Gain Access to ServiceNow Instances
4747

48-
1. Go to https://developer.servicenow.com/ and create an account.
49-
2. Click on `Request an instance` and select the `Washington` release (initializing the instance will take a few minutes)
50-
* **Important note:** ServiceNow will soon release the Zurich version, which will reduce the availability of Washington instances. If you run into an issue where none are available or you cannot select such an instance, please contact massimo.caccia1@servicenow.com.
51-
4. Once the instance is ready, you should see your instance URL and credentials. If not, click _Return to the Developer Portal_, then navigate to _Manage instance password_ and click _Reset instance password_.
52-
5. Change the role of the user to admin in yoyr instance parameters ![image](https://github.com/user-attachments/assets/6f0fbf8e-f40f-411a-84cb-fead93d85f60)
48+
1. Navigate to https://huggingface.co/datasets/ServiceNow/WorkArena-Instances.
49+
2. Fill the form, accept the terms to gain access to the gated repository and wait for approval.
50+
3. Ensure that the machine where you will run WorkArena is [authenticated with Hugging Face](https://huggingface.co/docs/hub/en/datasets-polars-auth) (e.g., via huggingface-cli login or the HUGGING_FACE_HUB_TOKEN environment variable).
5351

54-
6. You should now see your URL and credentials. Based on this information, set the following environment variables:
55-
* `SNOW_INSTANCE_URL`: The URL of your ServiceNow developer instance
56-
* `SNOW_INSTANCE_UNAME`: The username, should be "admin"
57-
* `SNOW_INSTANCE_PWD`: The password, make sure you place the value in quotes "" and be mindful of [escaping special shell characters](https://onlinelinuxtools.com/escape-shell-characters). Running `echo $SNOW_INSTANCE_PWD` should print the correct password.
58-
7. Log into your instance via a browser using the admin credentials. Close any popup that appears on the main screen (e.g., agreeing to analytics).
59-
60-
**Warning:** Feel free to look around the platform, but please make sure you revert any changes (e.g., changes to list views, pinning some menus, etc.) as these changes will be persistent and affect the benchmarking process.
61-
62-
### b) Install WorkArena and Initialize your Instance
52+
### b) Install WorkArena
6353

6454
Run the following command to install WorkArena in the [BrowswerGym](https://github.com/servicenow/browsergym) environment:
6555
```
66-
pip install browsergym
56+
pip install browsergym-workarena
6757
```
6858

6959
Then, install [Playwright](https://github.com/microsoft/playwright):
7060
```
7161
playwright install
7262
```
7363

74-
Finally, run this command in a terminal to upload the benchmark data to your ServiceNow instance:
75-
```
76-
workarena-install
77-
```
7864
Your installation is now complete! 🎉
7965

8066

src/browsergym/workarena/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
INSTANCE_REPO_ID = "ServiceNow/WorkArena-Instances"
1616
INSTANCE_REPO_FILENAME = "instances.json"
1717
INSTANCE_REPO_TYPE = "dataset"
18-
INSTANCE_XOR_SEED = "x3!+-9mi#nhlo%a02$9hna{]" # Required to read passwords
18+
INSTANCE_XOR_SEED = "x3!+-9mi#nhlo%a02$9hna{]"
1919

2020
# Path to the Menu navigation task configuration
2121
ALL_MENU_PATH = str(resources.files(data_files).joinpath("task_configs/all_menu.json"))

0 commit comments

Comments
 (0)