browsergym-workarena 0.2.1__py3-none-any.whl → 0.3.1__py3-none-any.whl

browsergym/workarena/api/report.py

@@ -0,0 +1,183 @@
+import numpy as np
+
+from ..instance import SNowInstance
+from .utils import table_api_call
+
+
+def create_report(
+    instance: SNowInstance,
+    table: str,
+    filter_hashtag: str,
+    field: str,
+    plot_title: str,
+    filter_field: str = "short_description",
+    random: np.random = None,
+) -> list[str]:
+    """
+    Create a report for for the given table using a filter (str added to the short description).
+    The report is created with a random color palette and colors and a random plot type (pie or bar).
+
+    Parameters:
+    -----------
+    instance: SNowInstance
+        The instance to create the category in
+    table: str
+        The name of the table used to make the plot
+    field: str
+        The field of the table used to make the plot
+    filter_hashtag: str
+        The name of the hashtag to filter the table with
+    plot_title: str
+        The title of the plot
+
+    Returns:
+    --------
+    sys_id: str; sys_id of the report created
+    plot_title: str; The title of the plot
+
+    """
+    # select a random color palette for the plot
+    color_palettes = table_api_call(
+        instance=instance,
+        table="pa_chart_color_schemes",
+        params={
+            "sysparm_fields": "sys_id",
+        },
+        method="GET",
+    )["result"]
+
+    color_palette_sys_id = random.choice(color_palettes)["sys_id"]
+
+    # Get available colors to eventually randomly select from them
+    colors = table_api_call(
+        instance=instance,
+        table="sys_report_color",
+        params={
+            "sysparm_fields": "sys_id",
+        },
+        method="GET",
+    )["result"]
+
+    # Select a random plot type
+    plot_types = ["pie", "bar"]
+    plot_type = random.choice(plot_types)
+
+    report_params = {
+        "show_data_label_position_middle": False,
+        "display_row_lines": False,
+        "is_published": False,
+        "chart_title_y_position": "0",
+        "gauge_autoscale": True,
+        "type": f"{plot_type}",
+        "formatting_configuration": {
+            "table": "incident",
+            "stringFormattingProperties": {},
+            "durationFormattingProperties": {},
+            "dateFormattingProperties": {},
+            "numberFormattingProperties": {},
+        },
+        "apply_alias": False,
+        "chart_border_color": f"{random.choice(colors)['sys_id']}",  # default: "65b30218a9fe3dba0120df8611520d97"
+        "custom_chart_title_position": False,
+        "other_threshold": "-2",
+        "y_axis_title_color": f"{random.choice(colors)['sys_id']}",  # default: "65b30218a9fe3dba0120df8611520d97"
+        "show_legend_border": False,
+        "donut_width_percent": "30",
+        "y_axis_title_size": "12",
+        "legend_border_color": f"{random.choice(colors)['sys_id']}",  # default: "65b30218a9fe3dba0120df8611520d97"
+        "y_axis_label_bold": False,
+        "chart_title_size": "16",
+        "x_axis_label_color": f"{random.choice(colors)['sys_id']}",  # default: "65b30218a9fe3dba0120df8611520d97"
+        "active": True,
+        "source_type": "table",
+        "x_axis_title_bold": True,
+        "x_axis_opposite": False,
+        "chart_height": "450",
+        "legend_border_radius": "0",
+        "field": field,
+        "show_geographical_label": False,
+        "legend_horizontal_alignment": "center",
+        "interval": "year",
+        "show_zero": False,
+        "y_axis_grid_width": "1",
+        "chart_subtitle_size": "14",
+        "x_axis_display_grid": False,
+        "show_chart_total": False,
+        "chart_subtitle_style": "normal",
+        "chart_title_style": "normal",
+        "x_axis_grid_width": "1",
+        "x_axis_label_tilt": "0",
+        "show_chart_title": "report",
+        "title_vertical_alignment": "top",
+        "legend_border_width": "1",
+        "compute_percent": "aggregate",
+        "show_marker": False,
+        "sys_scope": "global",
+        "map": "93b8a3a2d7101200bd4a4ebfae61033a",
+        "use_color_heatmap": False,
+        "use_null_in_trend": False,
+        "y_axis_label_tilt": "0",
+        "table": table,
+        "legend_vertical_alignment": "bottom",
+        "x_axis_label_bold": False,
+        "no_bulk_migration": False,
+        "filter": f"{filter_field}LIKE{filter_hashtag}",
+        "display_column_lines": False,
+        "x_axis_allow_decimals": True,
+        "custom_chart_size": False,
+        "title_horizontal_alignment": "center",
+        "bar_unstack": False,
+        "y_axis_allow_decimals": True,
+        "chart_width": "600",
+        "x_axis_title_size": "12",
+        "y_axis_opposite": False,
+        "y_axis_title_bold": True,
+        "decimal_precision": "2",
+        "y_axis_label_size": "11",
+        "x_axis_grid_color": f"{random.choice(colors)['sys_id']}",
+        "legend_align_columns": True,
+        "field_list": "active,short_description,incident_state,business_duration,calendar_duration,description,caller_id,location,closed_by,impact,cmdb_ci,priority,assigned_to,activity_due,task_effective_number,company,escalation,sys_created_on,closed_at,child_incidents,state,assignment_group,category,number,business_stc",
+        "is_scheduled": False,
+        "others": True,
+        "x_axis_title_color": f"{random.choice(colors)['sys_id']}",  # default: "65b30218a9fe3dba0120df8611520d97"
+        "aggregation_source": "no_override",
+        "chart_title_color": f"{random.choice(colors)['sys_id']}",  # default: "65b30218a9fe3dba0120df8611520d97"
+        "y_axis_grid_dotted": False,
+        "chart_size": "large",
+        "legend_items_left_align": False,
+        "show_chart_data_label": False,
+        "y_axis_grid_color": f"{random.choice(colors)['sys_id']}",
+        "allow_data_label_overlap": False,
+        "chart_border_radius": "0",
+        "title": plot_title,
+        "exp_report_attrs": True,
+        "aggregate": "COUNT",
+        "y_axis_display_grid": True,
+        "score_color": f"{random.choice(colors)['sys_id']}",  # default: "65b30218a9fe3dba0120df8611520d97"
+        "axis_max_color": f"{random.choice(colors)['sys_id']}",  # default: "b0d449b3d7332100fa6c0c12ce610383"
+        "is_real_time": False,
+        "show_empty": False,
+        "direction": "minimize",
+        "display_grid": False,
+        "chart_border_width": "1",
+        "funnel_neck_percent": "30",
+        "show_legend": True,
+        "set_color": "one_color",
+        "color_palette": f"{color_palette_sys_id}",  # default: "65b30218a9fe3dba0120df8611520d97"
+        "x_axis_label_size": "11",
+        "show_chart_border": False,
+        "x_axis_grid_dotted": False,
+        "chart_title_x_position": "0",
+        "pivot_expanded": True,
+    }
+
+    result = table_api_call(
+        instance=instance,
+        table="sys_report",
+        # The cmdb_model_category is the sys_id for the hardware category; computer in this case
+        json=report_params,
+        method="POST",
+        wait_for_record=True,
+    )["result"]
+
+    return result["sys_id"], plot_title

browsergym/workarena/api/requested_items.py

@@ -0,0 +1,63 @@
+import faker
+
+fake = faker.Faker()
+
+from ..instance import SNowInstance
+from .utils import table_api_call
+
+
+def create_requested_item(
+    instance: SNowInstance,
+    user_sys_id: str,
+    system_name: str,
+    quantity: int = 1,
+    short_description: str = None,
+) -> list[str]:
+    """
+    Create a requested item for a given user
+
+    Parameters:
+    -----------
+    instance: SNowInstance
+        The instance to create the requested item in
+    user_sys_id: str
+        The sys_id of the user to request the item for
+    system_name: str
+        The name of the system to request (e.g. "Developer Laptop (Mac)" )
+    quantity: int
+        The quantity of the item to request
+    short_description: str
+        The short description of the item (optional). if not provided, a random one will be generated
+
+    Returns:
+    --------
+    sys_id, number of the requested item
+
+    """
+    if short_description is None:
+        short_description = fake.sentence(4)
+
+    item_sys_id = table_api_call(
+        instance=instance,
+        table="sc_cat_item",
+        params={"sysparm_query": f"sys_name={system_name}", "sysparm_fields": "sys_id"},
+    )["result"][0]["sys_id"]
+
+    item_config = {
+        "requested_for": user_sys_id,
+        "state": "3",
+        "impact": "3",
+        "active": "true",
+        "priority": "4",
+        "short_description": short_description,
+        "urgency": "3",
+        "quantity": str(quantity),
+        "billable": "false",
+        "cat_item": item_sys_id,
+    }
+
+    result = table_api_call(
+        instance=instance, table="sc_req_item", json=item_config, method="POST"
+    )["result"]
+
+    return result["sys_id"], result["number"]

browsergym/workarena/api/user.py

@@ -1,5 +1,5 @@
-import random
 from faker import Faker
+import numpy as np
 import time
 
 fake = Faker()
@@ -14,7 +14,9 @@ def create_user(
     first_name: str = None,
     last_name: str = None,
     user_name: str = None,
-    admin=True,
+    return_full_response: bool = False,
+    user_roles: list[str] = ["admin"],
+    random: np.random = np.random,
 ) -> list[str]:
     """
     Create a user with a random username and password with an admin role
@@ -27,8 +29,8 @@ def create_user(
         The last name of the user, defaults to a random last name
     user_name: str
         The user name of the user, defaults to first_name.last_name
-    admin: bool
-        Whether to give the user admin permissions
+    user_roles: list[str]
+        The roles to assign to the user, defaults to ['admin']
 
     Returns:
     --------
@@ -56,12 +58,12 @@ def create_user(
     user_name = user_response["user_name"]
     user_sys_id = user_response["sys_id"]
 
-    # Get admin role sys_id
-    if admin:
+    # Get role sys_id's
+    for role in user_roles:
         role_sys_id = table_api_call(
             instance=instance,
             table="sys_user_role",
-            params={"sysparm_query": "name=admin", "sysparm_fields": "sys_id"},
+            params={"sysparm_query": f"name={role}", "sysparm_fields": "sys_id"},
             method="GET",
         )["result"][0]["sys_id"]
 
@@ -77,7 +79,8 @@ def create_user(
     set_user_preference(
         instance, "glide.ui.polaris.theme.variant", theme["style.sys_id"], user=user_sys_id
     )
-
+    if return_full_response:
+        return user_response
     return user_name, user_password, user_sys_id
 
 

browsergym/workarena/api/utils.py

@@ -3,6 +3,7 @@ import requests
 from ..instance import SNowInstance
 
 from requests.exceptions import HTTPError
+from time import sleep
 
 # ServiceNow API configuration
 SNOW_API_HEADERS = {"Content-Type": "application/json", "Accept": "application/json"}
@@ -15,12 +16,17 @@ def table_api_call(
     params: dict = {},
     json: dict = {},
     method: str = "GET",
+    wait_for_record: bool = False,
+    max_retries: int = 5,
+    raise_on_wait_expired: bool = True,
 ) -> dict:
     """
     Make a call to the ServiceNow Table API
 
     Parameters:
     -----------
+    instance: SNowInstance
+        The ServiceNow instance to interact with
     table: str
         The name of the table to interact with
     data: dict
@@ -31,6 +37,13 @@ def table_api_call(
         The JSON data to send with the request
     method: str
         The HTTP method to use (GET, POST, PUT, DELETE).
+    wait_for_record: bool
+        If True, will wait up to 2 seconds for the record to be present before returning
+    max_retries: int
+        The number of retries to attempt before failing
+    raise_on_wait_expired: bool
+        If True, will raise an exception if the record is not found after max_retries.
+        Otherwise, will return an empty result.
 
     Returns:
     --------
@@ -49,13 +62,44 @@ def table_api_call(
         params=params,
         json=json,
     )
+    if method == "POST":
+        sys_id = response.json()["result"]["sys_id"]
+        data = {}
+        params = {"sysparm_query": f"sys_id={sys_id}"}
 
-    # Check for HTTP code 200 (fail otherwise)
+    # Check for HTTP success code (fail otherwise)
     response.raise_for_status()
 
+    record_exists = False
+    num_retries = 0
+    if method == "POST" or wait_for_record:
+        while not record_exists:
+            sleep(0.5)
+            get_response = table_api_call(
+                instance=instance,
+                table=table,
+                params=params,
+                json=json,
+                data=data,
+                method="GET",
+            )
+            record_exists = len(get_response["result"]) > 0
+            num_retries += 1
+            if num_retries > max_retries:
+                if raise_on_wait_expired:
+                    raise HTTPError(f"Record not found after {max_retries} retries")
+                else:
+                    return {"result": []}
+            if method == "GET":
+                response = get_response
+
     if method != "DELETE":
-        # Decode the JSON response into a dictionary
-        return response.json()
+        # Decode the JSON response into a dictionary if necessary
+        # When using wait_for_record=True, the response is already a dict as it is a recursive call
+        if type(response) == dict:
+            return response
+        else:
+            return response.json()
     else:
         return response
 

browsergym/workarena/config.py

@@ -66,6 +66,10 @@ ORDER_LOANER_LAPTOP_TASK_CONFIG_PATH = str(
 # Knowledge base that is included with the benchmark
 KB_NAME = "General Knowledge"
 KB_FILEPATH = str(resources.files(data_files).joinpath("setup_files/knowledge/knowledge_base.json"))
+PROTOCOL_KB_NAME = "Company Protocols"
+PROTOCOL_KB_FILEPATH = str(
+    resources.files(data_files).joinpath("setup_files/knowledge/protocols.json")
+)
 
 # Form tasks
 CREATE_CHANGE_REQUEST_CONFIG_PATH = str(
@@ -165,12 +169,25 @@ EXPECTED_CHANGE_REQUEST_COLUMNS_PATH = str(
         "setup_files/lists/expected_change_request_list_columns.json"
     )
 )
+EXPECTED_EXPENSE_LINE_COLUMNS_PATH = str(
+    resources.files(data_files).joinpath(
+        "setup_files/lists/expected_expense_line_list_columns.json"
+    )
+)
 EXPECTED_HARDWARE_COLUMNS_PATH = str(
     resources.files(data_files).joinpath("setup_files/lists/expected_hardware_list_columns.json")
 )
 EXPECTED_INCIDENT_COLUMNS_PATH = str(
     resources.files(data_files).joinpath("setup_files/lists/expected_incident_list_columns.json")
 )
+EXPECTED_PROBLEM_COLUMNS_PATH = str(
+    resources.files(data_files).joinpath("setup_files/lists/expected_problem_list_columns.json")
+)
+EXPECTED_REQUESTED_ITEMS_COLUMNS_PATH = str(
+    resources.files(data_files).joinpath(
+        "setup_files/lists/expected_requested_items_list_columns.json"
+    )
+)
 EXPECTED_SERVICE_CATALOG_COLUMNS_PATH = str(
     resources.files(data_files).joinpath(
         "setup_files/lists/expected_service_catalog_list_columns.json"
@@ -188,6 +205,7 @@ EXPECTED_CHANGE_REQUEST_FORM_FIELDS_PATH = str(
         "setup_files/forms/expected_change_request_form_fields.json"
     )
 )
+
 EXPECTED_HARDWARE_FORM_FIELDS_PATH = str(
     resources.files(data_files).joinpath("setup_files/forms/expected_hardware_form_fields.json")
 )
@@ -200,7 +218,9 @@ EXPECTED_PROBLEM_FORM_FIELDS_PATH = str(
 EXPECTED_USER_FORM_FIELDS_PATH = str(
     resources.files(data_files).joinpath("setup_files/forms/expected_user_form_fields.json")
 )
-
+EXPECTED_REQUEST_ITEM_FORM_FIELDS_PATH = str(
+    resources.files(data_files).joinpath("setup_files/forms/expected_request_item_form_fields.json")
+)
 
 # Report date filter patch flag
 REPORT_PATCH_FLAG = "WORKARENA_DATE_FILTER_PATCH"

browsergym/workarena/data_files/setup_files/forms/expected_incident_form_fields.json

@@ -1 +1 @@
-["comments", "assigned_to", "assignment_group", "caller_id", "category", "caused_by", "rfc", "contact_type", "cmdb_ci", "description", "impact", "knowledge", "number", "hold_reason", "parent_incident", "priority", "problem_id", "close_code", "close_notes", "resolved_at", "resolved_by", "business_service", "service_offering", "short_description", "state", "subcategory", "route_reason", "universal_request", "urgency", "watch_list", "work_notes", "work_notes_list"]
+["comments", "assigned_to", "assignment_group", "caller_id", "category", "caused_by", "rfc", "contact_type", "cmdb_ci", "description", "impact", "knowledge", "number", "hold_reason", "parent_incident", "priority", "problem_id", "close_code", "close_notes", "resolved_at", "resolved_by", "business_service", "service_offering", "short_description", "state", "subcategory", "route_reason", "universal_request", "urgency", "watch_list", "work_notes", "work_notes_list"]

browsergym/workarena/data_files/setup_files/forms/expected_request_item_form_fields.json

@@ -0,0 +1 @@
+["number", "cat_item", "request", "requested_for", "due_date", "configuration_item", "watch_list", "opened_at", "opened_by", "stage", "state", "quantity", "estimated_delivery", "backordered", "order_guide", "comments"]

browsergym/workarena/data_files/setup_files/knowledge/protocols.json

@@ -0,0 +1,46 @@
+[
+    {
+        "item": "Onboarding a new user",
+        "article": "<h2>Onboarding a new user</h2> <p>This document outlines the procedure for onboarding a new user within the company. Proper onboarding ensures that new users have the necessary tools and access to start their roles effectively and efficiently. Follow the steps below to complete the onboarding process.</p> <h2>Steps for Onboarding a New User</h2> <h3>1. Create a User Account</h3> <ol> <li>Access the user creation interface.</li> <li>Enter the required information for the new user.</li> <li>Save the new user account.</li> </ol> <p>You can create a user account <a href='./now/nav/ui/classic/params/target/sys_user_list.do'>here</a>.</p> <h3>2. Order a Laptop</h3> <ol> <li>Access the service catalog.</li> <li>Order an Apple MacBook Pro 15\" laptop for the new user.</li> <li>Confirm the order details and submit the request.</li> </ol> <p>You can order the laptop <a href='./now/nav/ui/classic/params/target/catalog_home.do%3Fsysparm_view%3Dcatalog_default'>here</a>.</p> <h3>3. Create a Hardware Asset</h3> <ol> <li>Access the hardware asset management interface.</li> <li>Create a new hardware asset with the required configuration.</li> <li>Assign the newly created hardware asset to the user.</li> </ol> <p>You can create and assign a hardware asset <a href='./now/nav/ui/classic/params/target/alm_hardware_list.do'>here</a>.</p> <h2>Conclusion</h2> <p>Following these steps will ensure that new users are properly onboarded with the necessary equipment and access rights. For any issues or additional assistance, please contact the IT department.</p> <hr> <p>This document serves as a guide to streamline the user onboarding process, ensuring consistency and efficiency across the organization.</p>"
+    },
+    {
+        "item": "Offboarding a user",
+        "article": "<h1>Offboarding a user</h1> <h2>Introduction</h2> <p>This document outlines the procedure for offboarding a user within the company. Proper offboarding ensures that company assets are secured and that the departing user's access is properly removed. Follow the steps below to complete the offboarding process.</p> <h2>Steps for Offboarding a User</h2> <h3>1. Un-assign Hardware Assets</h3> <ol> <li>Find the user's laptop by looking for the hardware asset assigned to them.</li> <li>Un-assign the laptop by erasing the \"Assigned to\" field.</li> </ol> <p>You can manage hardware assets <a href='./now/nav/ui/classic/params/target/alm_hardware_list.do'>in the hardware asset list</a>.</p> <h3>2. Delete the User Account</h3> <ol> <li>Access the user management interface.</li> <li>Locate and delete the user account.</li> </ol> <p>You can delete the user account <a href='./now/nav/ui/classic/params/target/sys_user_list.do'>here</a>.</p> <h2>Conclusion</h2> <p>Following these steps will ensure that departing users are properly offboarded and that all company assets and access rights are appropriately managed. For any issues or additional assistance, please contact the IT department.</p> <hr> <p>This document serves as a guide to streamline the user offboarding process, ensuring consistency and security across the organization.</p>"
+    },
+    {
+        "item": "Finding the warranty expiration for a user's laptop",
+        "article": "<h1>Finding the Warranty Expiration for a User's Laptop</h1> <h2>Introduction</h2> <p>This document outlines the procedure for finding the warranty expiration date of a user's laptop. Ensuring that the warranty information is up-to-date is crucial for managing hardware assets and planning for replacements or repairs.</p> <h2>Steps to Find the Warranty Expiration Date</h2> <h3>1. Locate the Laptop Assigned to the User</h3> <ol> <li>Find the laptop assigned to the user by looking at the \"Assigned to\" field <a href='./now/nav/ui/classic/params/target/alm_hardware_list.do'>in the hardware asset list</a>.</li> </ol>   <h3>2. Find the Laptop's Warranty Expiration Date</h3> <ol> <li>Once the laptop is located, check the warranty expiration date on the asset details page.</li> </ol> <h2>Conclusion</h2> <p>Following these steps will help you accurately find the warranty expiration date of a user's laptop. For any issues or additional assistance, please contact the IT department.</p> <hr> <p>This document serves as a guide to ensure proper management of hardware warranties within the organization.</p>"
+    },
+    {
+        "item": "Agent Workload Balancing",
+        "article": "<h1>Agent Workload Balancing</h1> <h2>Introduction</h2> <p>Agent Workload Balancing is a process designed to distribute work evenly among agents by re-assigning tasks. The problems to re-distribute all contain specific hashtags in their problem statements. By balancing the workload, we ensure that no single agent is overwhelmed while others have fewer tasks. All problems can be found in the <a href='./now/nav/ui/classic/params/target/problem_list.do'>problem list</a>.</p> <h2>Steps for Agent Workload Balancing</h2> <h3>1. Identify Busiest and Least Busy Users</h3> <ol> <li>Among the problems with descriptions containing the required hashtag, identify the user with the most assigned problems and the user with the least assigned problems.</li> <li>This information can be found in the report named 'Problems with hashtag {hashtag_name}'.</li> </ol> <p>You can access the list of reports <a href='./now/nav/ui/classic/params/target/sys_report_list.do'>here</a>.</p> <h3>2. Find a Low Priority Problem</h3> <ol> <li>Locate a problem with the lowest priority (priority=5) that includes the appropriate hashtag in the problem statement and is assigned to the busiest user.</li> </ol> <p>You can filter <a href='./now/nav/ui/classic/params/target/problem_list.do'>the problem list</a> to find such a problem.</p> <h3>3. Re-assign the Problem</h3> <ol> <li>Re-assign the identified low priority problem to the least busy user.</li> </ol> <h2>Conclusion</h2> <p>Following these steps will help balance the workload among agents by re-assigning low priority problems from the busiest to the least busy user. For any issues or additional assistance, please contact the IT department.</p> <hr> <p>This document serves as a guide to ensure effective workload management among agents within the organization.</p>"
+    },
+    {
+        "item": "Work Assignment: Assign Incidents to Relevant Agents",
+        "article": "<h1>Work Assignment: Assign Incidents to Relevant Agents</h1> <h2>Introduction</h2> <p>This document outlines the process for assigning incidents to relevant agents based on both the category and the priority of the incident. Proper assignment ensures that incidents are handled by the most appropriate agents, leading to quicker and more effective resolutions. Follow these steps to assign incidents correctly.</p> <h2>Steps for Assigning Incidents</h2> <h3>1. Locate the Incident</h3> <ol> <li>Go to the incidents page and search for the incident using the incident number that needs to be assigned.</li> </ol> <p>You can access the incidents page <a href='./now/nav/ui/classic/params/target/incident_list.do'>here</a>.</p> <h3>2. Identify the Incident Category and Priority</h3> <ol> <li>Look at the category and priority of the incident. The category will be one of the following: 'Hardware', 'Software', 'Network', or 'Database'.</li> <li>Assign the incident to the category experts mentioned in the task description. </li> </ol> <h3>3. Assign the Incident</h3> <ol> <li>If applicable, assign the incident to the relevant agent based on the priority of the incident. The priority levels are as follows: <ul> <li><strong>Priority 1 - Critical:</strong> Assign to the 'expert' of the category.</li> <li><strong>Priority 3 - Moderate:</strong> Assign to the 'supporter' of the category.</li> <li><strong>Priority 5 - Planning:</strong> Assign to the 'planner' of the category.</li> </ul> </li> </ol> <h2>Conclusion</h2> <p>By following these steps, you can ensure that incidents are assigned to the most qualified agents based on their category and priority. This approach leads to faster resolution times and improved efficiency in incident management. For any issues or additional assistance, please contact the IT department.</p> <hr> <p>This document serves as a guide to ensure proper assignment of incidents to relevant agents within the organization.</p>"
+    },
+    {
+        "item": "Edit a knowledge article to manage incorrect information",
+        "article": "<h1>Edit a Knowledge Article to Manage Incorrect Information</h1> <h2>Introduction</h2> <p>This document outlines the procedure for editing a knowledge base article that contains incorrect, outdated, or obsolete information. Ensuring that all knowledge articles are accurate and up-to-date is crucial for maintaining the integrity and reliability of the knowledge base.</p> <h2>Steps to Edit a Knowledge Article</h2> <h3>1. Search the Knowledge Base</h3> <ol> <li>Search the knowledge base using the given query.</li> </ol> <p>You can perform the search <a href='./now/nav/ui/classic/params/target/%24knowledge.do'>here</a>.</p> <h3>2. Identify the Correct and Incorrect Articles</h3> <ol> <li>Identify the articles that contain the correct and incorrect information based on what the information should be.</li> </ol> <h3>3. Mark the Incorrect Article</h3> <ol> <li>Add a comment to the article to mark it as 'incorrect' and mention the 'number' of the correct article as per the task description.</li> </ol> <h3>4. Mark the Correct Article</h3> <ol> <li>Add a comment to the article to label it as 'correct' and mention the 'number' of the incorrect article as per the task description to avoid having misguiding people.</li> </ol> <h2>Conclusion</h2> <p>Following these steps will help maintain the accuracy and relevance of the knowledge base by properly marking and referencing articles with correct and incorrect information. For any issues or additional assistance, please contact the IT department.</p> <hr> <p>This document serves as a guide to ensure effective management of information within the knowledge base.</p>"
+    },
+    {
+        "item":"Problem List Cleanup",
+        "article": "<h1>Problem List Cleanup</h1> <h2>Introduction</h2> <p>Problem List Cleanup ensures that the problem list remains organized and free from redundancy. In the <a href='./now/nav/ui/classic/params/target/problem_list.do'>problem list</a>, some problem's \"Problem statement\" field contain a hashtag so we know which problem group they belong to. The problem list cleanup involves identifying problems with duplicated problem statements and marking them as duplicates. </p> <h2>Steps for Problem List Cleanup</h2> <h3>1. Identify Duplicated Problems</h3> <ol> <li>Among the problems with problem statements containing the required hashtag, identify those with duplicated problem statements. This can be done by filtering <a href='/now/nav/ui/classic/params/target/problem_list.do'>the problem list</a> .</li> </ol> <h3>2. Mark Duplicated Problems</h3> <ol> <li>If two problems have the same priority, you can mark either one as a duplicate of the other. Otherwise, mark the lowest priority problem as a duplicate of the highest priority one to keep the highest priority problems open. A problem's priority can range from 1 (Critical) to 5 (Planning), with 1 being the highest priority.</li> <li>Marking a problem as duplicate is done by opening the problem record and Clicking \"Mark Duplicate\".</li> </ol> <h3>3. Additional Handling for Critical Priority Problems</h3> <ol> <li>If you need to mark a priority 1 (Critical priority) problem as a duplicate of another, change the description of this problem to \"Duplicate\" to avoid further confusion.</li> </ol> <h2>Conclusion</h2> <p>Following these steps will help maintain a clean and efficient problem list by properly marking and managing duplicated problems. For any issues or additional assistance, please contact the IT department.</p> <hr> <p>This document serves as a guide to ensure effective problem management within the organization.</p>"
+    },
+    {
+        "item": "Scheduling Your Change Requests",
+        "article": "<h1>Scheduling Your Change Requests</h1> <h2>Introduction</h2> <p>Scheduling change requests is a critical process in managing IT infrastructure and operations. This process involves organizing and prioritizing change requests to ensure they are implemented efficiently and with minimal disruption to ongoing operations. Change requests often include updates, fixes, or enhancements that need to be scheduled within specific time blocks. The following guidelines outline how to create a valid schedule for change requests. As a first step, we note that change requests are grouped by hashtags placed in their short description. In general, creating a schedule is done for change requests that share a given hashtag and by setting the \"Planned start date\" and \"Planned end date\" for these change requests. Make sure to leave empty the \"Actual start date\" and \"Actual end date\" as they should only be filled when the work has started. All change requests can be found <a href='./now/nav/ui/classic/params/target/change_request_list.do'>here</a>. </p> <h2>Scheduling Rules</h2> <h3>1. Time Constraints</h3> <ol> <li>All change requests must be scheduled within the allowed time frame. They should not start before the start of the schedule block and must end before it closes. Moreover, they should not overlap.</li> </ol> <h3>2. Impact Order</h3> <ol> <li>Higher impact change requests must be scheduled before lower impact ones, ensuring the schedule prioritizes more significant changes.</li> </ol> <h3>3. Consecutive Requests</h3> <ol> <li>Generally, there should be no more than one day between consecutive change requests.</li> <li>If the change requests are required to follow a \"tight\" schedule, there should be no more than one hour between consecutive requests.</li> </ol> <h3>4. Duration Compliance</h3> <ol> <li>All change requests must respect the desired durations, which are determined by the risk level: <ul> <li>High risk: 3 days</li> <li>Moderate risk: 2 days</li> <li>Low risk: 1 day</li> </ul> </li> </ol> <h2>Conclusion</h2> <p>Following these guidelines will help you create an efficient and effective schedule for your change requests, minimizing disruptions and prioritizing higher impact changes. For any issues or additional assistance, please contact the IT department.</p> <hr> <p>This document serves as a guide to ensure proper scheduling and management of change requests within the organization.</p>"
+    },
+    {
+        "item": "Managing Your Existing Expenses",
+        "article": "<h1>Managing Your Existing Expenses</h1> <h2>Introduction</h2> <p>Managing your existing expenses is a crucial aspect of maintaining financial accuracy and compliance within the company. This process involves reviewing expense lines to ensure no duplicates remain. Expense lines can be found <a href='./now/nav/ui/classic/params/target/fm_expense_line_list.do'>here</a>. Duplicate expenses can lead to inaccuracies in financial reporting and budget management, making it essential to handle them according to established guidelines. Expense lines normally contain specific hashtags so they can be grouped. The process of filtering the duplicates is done for specific hashtags. </p> <h2>Steps for Managing Expense Duplicates</h2> <h3>1. Identify Duplicate Expenses</h3> <ol> <li>Review expense lines with short descriptions containing the given hashtag.</li> <li>Identify expense lines that have the same short description, which are considered duplicates.</li> </ol> <h3>2. Apply Rules to Handle Duplicates</h3> <ol> <li>Among duplicates, keep only those linked to tasks (e.g., Change Request, Incident) and delete the others.</li> <li>If all duplicates are linked to tasks, or none are linked to tasks, keep only the oldest one.</li> <li>If all duplicates have the same date, keep only the most expensive one.</li> <li>Finally, if all duplicates have the same cost, you can keep any of the expenses.</li> </ol> <h2>Conclusion</h2> <p>Following these guidelines will help you manage your existing expenses effectively, ensuring compliance with company policies and maintaining accurate financial records. For any issues or additional assistance, please contact the finance department.</p> <hr> <p>This document serves as a guide to ensure proper management of expenses within the organization.</p>"
+    },
+    {
+        "item": "Maximizing total investment return",
+        "article": "<h1>Maximizing Total Investment Return</h1><h2>Introduction</h2><p>Investment projects are filed as expense lines and are tagged with project IDs (hashtags) so they can be grouped. Expense lines can be found <a href='./now/nav/ui/classic/params/target/fm_expense_line_list.do'>here</a>. Maximizing total investment return involves reviewing these expense lines and selecting the ones that maximize revenue while fitting within the allowed budget. The investment's returns are specified in their short descriptions and their costs appear in their \"Amount\" field. Depending on the specifics of the task, you may be required to provide different types of information.</p><h2>Steps for Maximizing Total Investment Return</h2><h3>1. Review Expense Lines</h3><ol>    <li>Identify expense lines with short descriptions containing the given hashtag.</li>    <li>Evaluate the returns based on the short description and costs based on the \"Amount\" field to determine their suitability based on the allowed budget.</li></ol><h3>2. Provide Required Information</h3><p>Depending on the task requirements, you may need to provide one or more of the following:</p><ul>    <li><strong>Total Return of Selected Investments Only:</strong> If requested, provide only the total return of the selected investments in the chat.</li>    <li><strong>Selected Investments Only:</strong> If requested, provide the values for the \"Number\" field of the selected investments in the chat.</li>    <li><strong>Selected Investments and Total Return:</strong> If requested, provide the values for the \"Number\" field of the selected investments as well as their total return in the chat.</li>    <li><strong>Investment Lines Cleanup:</strong> If requested, delete the investments that will not be kept so that only the selected investments remain.</li></ul><h2>Conclusion</h2><p>Following these steps will help you allocate investments effectively, ensuring that the selected projects maximize revenue while adhering to the budget constraints. For any issues or additional assistance, please contact the finance department.</p><hr><p>This document serves as a guide to ensure proper management and allocation of investments within the organization.</p>"
+    },
+    {
+        "item": "Dashboard Retrieve Information and Perform Task",
+        "article": "<h1>Dashboard Retrieve Information and Perform Task</h1><h2>Introduction</h2><p>Dashboards consists of either bar plots or pie charts containing important information, generally as a pair of some text and numbers. You would be asked to retrieve some information from the chart, which might be retrieving values such as the maximum and minimum value or requiring standard mathematical calculations such as mean, median, and mode. You may also require to extract the text associated with these values, such as the name of an agent. Once they are retrieved, you would be requested to perform a task using this information. Please note that we round off everything to the next <i>highest</i> integer and treat it as the 'value' for the task. For calculations having more than one possible answer (such as 'mode' or 'most frequent' values), we consider the greatest number as the value or information.</p><h2>Steps for performing dashboard retrieval tasks</h2><h3>1. Retrieve information from the dashboard</h3><ol><li>Go to Reports > View/Run in the all menu. You can go to the page <a href='./now/nav/ui/classic/params/target/report_home.do%3Fjvar_selected_tab%3DmyReports'>here</a> as well.</li><li>Use the hashtag given in the task description to filter out the required dashboard chart and navigate to it.</li><li>Based on the task description, you will be given a 'value' field. This would mention if you need to fetch the minimum or maximum valued information or the mean, median, or the mode.</li><li>In certain cases, the description will also mention if you need to perform the following task by considering 'greater than or equal to' or 'lesser than or equal to' values for the retrieved information.</li></ol><p> This is the retrieved information from the dashboard.</p><h3>2. Perform the task</h3><p>After retrieving the information, you would be given a task to solve. Depending on the task requirements, you may need to perform one or more of the following:</p><ul><li><strong>Create form entries:</strong> Fill forms with the given information. Only fill the fields mentioned in the task description.</li><li><strong>Filter lists:</strong> Filter the lists using the attribute mentioned in the task description and following the retrieved information.</li><li><strong>Order items:</strong> You would need to go to the service catalog and order an item after making some calculations of the quantity as per the task description.</li></ul><p>The following links may be helpful for achieving the above tasks:</p><ul><li>Create <a href='./now/nav/ui/classic/params/target/incident_list.do'>incidents</a>, <a href='./now/nav/ui/classic/params/target/problem_list.do'>problems</a> or <a href='./now/nav/ui/classic/params/target/sc_req_item_list.do'>item requests</a></li><li>Lists: <a href='./now/nav/ui/classic/params/target/alm_asset_list.do'>asset list</a>, <a href='./now/nav/ui/classic/params/target/alm_hardware_list.do'>hardware list</a>, <a href='./now/nav/ui/classic/params/target/incident_list.do'>incident list</a>, <a href='./now/nav/ui/classic/params/target/sys_user_list.do'>user list</a></li> <li><a href='./now/nav/ui/classic/params/target/catalog_home.do%3Fsysparm_view%3Dcatalog_default'>Service catalog</a> for ordering items</li></ul><h2>Conclusion</h2><p>Following these steps will help you achieve the task of retrieving information from a dashboard and using it to solve another task.</p><hr><p>This document serves as a guide to ensure proper management and allocation of investments within the organization.</p>"
+    }
+]

browsergym/workarena/data_files/setup_files/knowledge/test.html

@@ -0,0 +1 @@
+<h2>Dispatching problems</h2>\n<p>Dispatching problems involves taking problems under a given category and re-assigning one low priority from the busiest to the least busy user.To do so, you need to:</p>\n<ul>\n<li> Find the user that has the most problems assigned to them and the one that has the least number of problems assigned to them. This is done by finding the information in the report for the given category, which is named 'Problems for category {category_name}'. The list of reports can be found <a href='./now/nav/ui/classic/params/target/sys_report_list.do'> here </a> </li>\n<li> Find a lowest priority problem (priority=5) of the appropriate category assigned to the user. This can be done by filtering <a href='./now/nav/ui/classic/params/target/problem_list.do'> the problem list </a> </li>\n<li> Assign this problem to the least busy user </li></ul>

browsergym/workarena/data_files/setup_files/lists/expected_asset_list_columns.json

@@ -1,34 +1,12 @@
 [
+    "asset_tag",
     "model.display_name",
     "model_category",
-    "asset_tag",
-    "substatus",
-    "asset_function",
-    "install_status",
     "sys_class_name",
     "assigned_to",
-    "serial_number",
     "location",
-    "vendor",
-    "assigned",
     "company",
-    "cost",
     "department",
-    "display_name",
-    "model",
-    "sys_updated_by",
-    "sys_updated_on",
-    "sys_mod_count",
-    "retirement_date",
-    "retired",
-    "residual",
-    "quantity",
-    "purchase_date",
-    "po_number",
-    "order_date",
-    "delivery_date",
-    "managed_by",
-    "invoice_number",
-    "cost_center",
+    "install_status",
     "warranty_expiration"
 ]

browsergym/workarena/data_files/setup_files/lists/expected_change_request_list_columns.json

@@ -1,48 +1,12 @@
 [
     "number",
     "short_description",
-    "chg_model",
-    "type",
-    "state",
     "risk",
+    "impact",
+    "priority",
+    "assigned_to",
     "start_date",
     "end_date",
-    "requested_by",
-    "assignment_group",
-    "assigned_to",
-    "sys_created_on",
-    "active",
-    "work_end",
-    "work_start",
-    "approval",
-    "approval_history",
-    "approval_set",
-    "backout_plan",
-    "category",
-    "change_plan",
-    "close_code",
-    "close_notes",
-    "closed_at",
-    "closed_by",
-    "cmdb_ci",
-    "conflict_last_run",
-    "conflict_status",
-    "contact_type",
-    "sys_created_by",
-    "delivery_plan",
-    "delivery_task",
-    "description",
-    "task_effective_number",
-    "escalation",
-    "impact",
     "implementation_plan",
-    "justification",
-    "knowledge",
-    "made_sla",
-    "opened_at",
-    "opened_by",
-    "phase",
-    "phase_state",
-    "priority",
-    "reassignment_count"
+    "approval"
 ]

browsergym/workarena/data_files/setup_files/lists/expected_expense_line_list_columns.json

@@ -0,0 +1,12 @@
+[
+    "number",
+    "user",
+    "inherited",
+    "parent",
+    "date",
+    "short_description",
+    "source_id",
+    "amount",
+    "type",
+    "summary_type"
+]