Patch Server List v0.1 - User Documentation

This document provides a comprehensive guide on how to effectively use the Patch Server List tool (version 0.1) to view, search, and filter server-related data.

1. Introduction

The Patch Server List is a client-side web application designed to help users quickly access and analyze server information. It organizes data into different tabs, offers a global search, and provides a powerful "Custom View" for detailed filtering and data export.

2. Getting Started

To use the tool, simply open the index.html file in your web browser. The application loads all data from the data.js file and displays it in an interactive interface.

3. Global Live Search

The main search bar at the top of the page allows you to quickly find information across all tabs (Hostnames, Customer Information, IP Addresses).

How to Use:

Type your search term(s) into the input field labeled "Search all tables:".
The results will update in real-time as you type, with a slight delay (debouncing) to ensure smooth performance.
A small feedback message (e.g., "Searching for: 'your search term'") will appear next to the search bar to confirm your active search.
To clear the search and view all data again, click the "Clear Search" button.

Search Logic:

The search is case-insensitive and looks for your terms anywhere within the visible data across all columns of all tables. If you type multiple words (e.g., "prod server"), it will search for both "prod" AND "server" independently within each record.

4. Navigation Tabs

The tool organizes data into four main tabs:

Hostnames: Displays detailed information about individual server hostnames.
Customer Information: Provides data related to various customers.
IP Addresses: Shows a list of IP addresses and associated details.
Custom View: (See Section 6 for detailed usage) This tab allows you to build highly specific filters for the Hostnames data and export the results.

Click on any tab button to switch between the different data views.

5. Configuration Menu (⚙️)

Located in the top-right corner, the gear icon (⚙️) opens a configuration menu with the following options:

Dark Mode:

Toggle the switch to enable or disable dark mode for a more comfortable viewing experience in low-light conditions.
Your preference will be saved in your browser's local storage.

Show All Columns / Hide Some Columns:

This toggle controls the visibility of certain columns in the Hostnames, Customer Information, and IP Addresses tabs.
By default, "Hide Some Columns" is active, which conceals less frequently used columns to provide a cleaner view.
Toggle to "Show All Columns" to reveal all available data fields.

6. Custom View Tab

The "Custom View" tab is a powerful feature designed for in-depth analysis and filtering of the Hostnames data only.

Data Source: This tab exclusively works with the data from the hostnames dataset.
Displayed Columns: The columns displayed in this view are fixed to: Environment, Hostname, DB Hostname, Schema/User, SID, URLs, PingFed/CaCPingFed URLs.

6.1. Applying Multiple Filters

You can add multiple filter rules to narrow down the data. All active filters are applied using "AND" logic, meaning a record must satisfy all conditions to be displayed.

Adding a Filter Rule:

Click the "Add Filter" button. A new filter row will appear.
Select Column: Choose the column you want to filter by from the "Column:" dropdown. This dropdown includes all available columns from the Hostnames data.
Select Condition: Choose a condition from the "Condition:" dropdown:
- contains: Cell value contains the specified text.
- equals: Cell value exactly matches the specified text.
- startsWith: Cell value begins with the specified text.
- endsWith: Cell value ends with the specified text.
- length > (chars): Cell value's character length is greater than the specified number.
- length < (chars): Cell value's character length is less than the specified number.
- length = (chars): Cell value's character length is equal to the specified number.
- is empty: Cell value is empty.
- is not empty: Cell value is not empty.
Enter Value/Length: Provide the text or number for your filter. The input field's label and type will adjust based on your selected condition.
Apply Filters: After setting up your filter(s), click the "Apply Filters" button to see the results.
Feedback: A small message (e.g., "X filters active") will appear next to the "Custom View Filter" heading, indicating the number of active filters.

Removing a Filter Rule:

To remove an individual filter row, click the "X" button at the end of that row.
The display will automatically update after removal.

Clearing All Filters:

Click the "Clear All Filters" button to remove all active filter rules and display the complete Hostnames data again.

6.2. Exporting Data to CSV

You can download the data currently displayed in the "Custom View" tab as a Comma Separated Values (CSV) file.

How to Use:

Apply any filters you desire in the "Custom View" tab to get your desired dataset.
Click the "Export to CSV" button.
Your browser will prompt you to download a file named custom_view_data.csv containing the filtered data.

7. Data Freshness

In the header section, below the main title, you will find a "Data Last Updated:" timestamp. This indicates when the data.js file (which contains all the server information) was last updated.

8. Troubleshooting and Tips

No Results Found: If a search or filter yields no results, the table area will display a "No results found.." message. Try adjusting your search terms or filter conditions.
Performance: For very large datasets, applying complex filters or typing rapidly in the global search might introduce minor delays. The debounce feature helps mitigate this for the global search.
Browser Compatibility: This tool is designed to work with modern web browsers (Chrome, Firefox, Edge, Safari).
Data Source: Remember that all data is loaded from the data.js file. If you need to update the data, you will need to modify that file directly.