# Documentation

> Complete documentation for psLens, the PeopleSoft admin dashboard. Installation, configuration, features, alerts, and reports.

---

LLMS index: [llms.txt](/llms.txt)

---

Welcome to the psLens documentation. Pick a starting point below, or use the navigation on the left to jump directly to a topic.

## Choose a Learning Path

<div><a id="td-block-0" class="td-anchor-no-extra-offset"></a></div>
<section class="row td-box td-box--white td-box--height-auto">
<div class="col">
<div class="row">



<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-rocket"></i>
</div>
<h4 class="h3">New to psLens</h4>
<div class="mb-0">
<p>Install SWS, deploy psLens, connect your first PeopleSoft environment, and take a quick tour of the dashboard. About an hour, end to end.</p>

</div>
<p><a href="/docs/getting-started/">Start Here</a></p>
</div>


<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-user-shield"></i>
</div>
<h4 class="h3">Security Administrator</h4>
<div class="mb-0">
<p>Start with the security reports (Full Access Permission Lists, Stale Passwords, Nodes Without Passwords), then review the <a href="/docs/use-cases/security-admins/">Security Admin use case</a> for an audit workflow.</p>

</div>
<p><a href="/docs/reports/security/">Explore Reports</a></p>
</div>


<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-cogs"></i>
</div>
<h4 class="h3">System Administrator / Ops</h4>
<div class="mb-0">
<p>Walk through the alert catalog (Process Scheduler, Integration Broker, and security alerts), then tune thresholds in <a href="/docs/getting-started/configuration/">configuration</a>.</p>

</div>
<p><a href="/docs/alerts/">Explore Alerts</a></p>
</div>


</div>
</div>
</section>


## Quick Links

<div><a id="td-block-1" class="td-anchor-no-extra-offset"></a></div>
<section class="row td-box td-box--light td-box--height-auto">
<div class="col">
<div class="row">



<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-download"></i>
</div>
<h4 class="h3">Installation</h4>
<div class="mb-0">
<p>Docker, bare-metal, systemd, air-gapped: every deployment option with working examples.</p>

</div>
<p><a href="/docs/getting-started/installation/">Install Guide</a></p>
</div>


<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-sliders-h"></i>
</div>
<h4 class="h3">Configuration</h4>
<div class="mb-0">
<p>Full <code>config.yaml</code> reference: databases, alert thresholds, environment variable overrides.</p>

</div>
<p><a href="/docs/getting-started/configuration/">Config Reference</a></p>
</div>


<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-bell"></i>
</div>
<h4 class="h3">Alerts Catalog</h4>
<div class="mb-0">
<p>16 real-time alerts across Process Scheduler, Integration Broker, and security, with tuning guidance.</p>

</div>
<p><a href="/docs/alerts/">View Alerts</a></p>
</div>


</div>
</div>
</section>


<div><a id="td-block-2" class="td-anchor-no-extra-offset"></a></div>
<section class="row td-box td-box--white td-box--height-auto">
<div class="col">
<div class="row">



<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-file-alt"></i>
</div>
<h4 class="h3">Reports Catalog</h4>
<div class="mb-0">
<p>14 on-demand audit reports: security, Integration Broker, process scheduler, and cross-database object comparison.</p>

</div>
<p><a href="/docs/reports/">View Reports</a></p>
</div>


<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-book"></i>
</div>
<h4 class="h3">Reference</h4>
<div class="mb-0">
<p>Complete list of PeopleTools metadata tables psLens queries, organized by category.</p>

</div>
<p><a href="/docs/reference/">PeopleTools Tables</a></p>
</div>


<div class="col-lg-4 mb-5 mb-lg-0 text-center">
<div class="mb-4 h1">
  <i class="fas fa-question-circle"></i>
</div>
<h4 class="h3">FAQ</h4>
<div class="mb-0">
<p>Setup time, PeopleTools versions, security posture, deployment options, and commercial questions.</p>

</div>
<p><a href="/docs/faq/">Read FAQ</a></p>
</div>


</div>
</div>
</section>

---

Section pages:

- [Why psLens](/docs/why-pslens/): See how psLens compares to App Designer, direct SQL, and manual PeopleSoft administration. A browser-based alternative for metadata research, security auditing, and monitoring.
- [Getting Started](/docs/getting-started/): Get started with psLens: install the SWS framework, deploy psLens, and connect it to your PeopleSoft environment in minutes.
- [Use Cases](/docs/use-cases/): See how different PeopleSoft team members use psLens: developers, security administrators, system administrators, and business analysts.
- [Dashboard](/docs/dashboard/): The health overview of all connected databases and active alerts.
- [Monitor](/docs/monitor/): Real-time operations monitoring dashboards for the Process Scheduler and Integration Broker.
- [Security](/docs/security/): Browse and audit PeopleSoft security configuration: permission lists, roles, and users.
- [Objects](/docs/objects/): Search and explore PeopleSoft metadata objects: fields, records, pages, components, queries, Integration Broker nodes, batch processes, and more.
- [Tools](/docs/tools/): Additional developer and operational utilities in psLens.
- [Reports](/docs/reports/): psLens security and audit reports for PeopleSoft: full access analysis, node password checks, web service access reviews, and more.
- [Alerts](/docs/alerts/): psLens real-time alerts for PeopleSoft: monitor long-running processes, process errors, stalled Integration Broker messages, failed logins, and more.
- [Reference](/docs/reference/): psLens reference material: PeopleSoft tables, configuration options, and technical details.
- [Roadmap](/docs/roadmap/): Planned psLens capabilities, with stable phrasing about commitment. No published dates.
- [FAQ](/docs/faq/): Frequently asked questions about psLens: supported PeopleTools versions, security, deployment, and commercial terms.