# Component Interfaces

> Browse PeopleSoft Component Interface definitions with items, methods, PeopleCode, and consistency checks.

---

Site [llms.txt](/llms.txt)

---

<div id="pslens-context-panel" class="card border-info mb-4 d-none">
  <div class="card-header bg-light text-info py-2 fw-bold d-flex align-items-center border-bottom border-info-subtle">
    <i class="bi bi-info-circle-fill me-2"></i>
    <span>Tailored Operational Context</span>
  </div>
  <div class="card-body p-0">
    <ul class="list-group list-group-flush">
      <li id="row-db" class="list-group-item d-flex align-items-center justify-content-between py-2 d-none">
        <strong>Target Database:</strong>
        <span id="ctx-db" class="badge bg-secondary font-monospace">&mdash;</span>
      </li>
      <li id="row-type" class="list-group-item d-flex align-items-center justify-content-between py-2 d-none">
        <strong>Context Type:</strong>
        <span id="ctx-type" class="badge bg-light text-dark border font-monospace text-uppercase">&mdash;</span>
      </li>
      <li id="row-severity" class="list-group-item d-flex align-items-center justify-content-between py-2 d-none">
        <strong>Alert Severity:</strong>
        <span id="ctx-severity" class="badge">&mdash;</span>
      </li>
      <li id="row-time" class="list-group-item d-flex align-items-center justify-content-between py-2 d-none">
        <strong>Triggered Time:</strong>
        <span id="ctx-time" class="text-muted small">&mdash;</span>
      </li>
      <li id="row-details" class="list-group-item py-2 d-none">
        <strong id="label-details" class="d-block mb-1">Firing Context:</strong>
        <code id="ctx-details" class="d-block p-2 bg-light border rounded small"
          style="white-space: pre-wrap; word-break: break-all;">&mdash;</code>
      </li>
      <li id="row-sql" class="list-group-item py-2 d-none">
        <div class="d-flex justify-content-between align-items-center mb-1">
          <strong id="label-sql">Contextual SQL:</strong>
          <button id="btn-copy-sql" type="button" class="btn btn-sm btn-outline-secondary py-0 px-2 small">
            <i class="bi bi-clipboard me-1"></i>Copy SQL
          </button>
        </div>
        <pre class="mb-0 p-2 bg-light border rounded small"><code id="ctx-sql" style="white-space: pre-wrap; word-break: break-word;">&mdash;</code></pre>
      </li>
    </ul>
  </div>
</div>

<script>
  (function () {
    const params = new URLSearchParams(window.location.search);
    const metadata = params.get('metadata');
    if (!metadata) return;

    try {
      
      const base64 = metadata.replace(/-/g, '+').replace(/_/g, '/');
      const jsonStr = decodeURIComponent(escape(window.atob(base64)));
      const data = JSON.parse(jsonStr);

      if (data) {
        let hasData = false;

        if (data.db) {
          document.getElementById('ctx-db').textContent = data.db;
          document.getElementById('row-db').classList.remove('d-none');
          hasData = true;
        }

        if (data.type) {
          document.getElementById('ctx-type').textContent = data.type;
          document.getElementById('row-type').classList.remove('d-none');
          hasData = true;
        }

        if (data.severity) {
          const severityBadge = document.getElementById('ctx-severity');
          const severity = data.severity.toLowerCase();
          severityBadge.textContent = severity.toUpperCase();
          if (severity === 'critical') {
            severityBadge.className = 'badge bg-danger';
          } else if (severity === 'warning') {
            severityBadge.className = 'badge bg-warning text-dark';
          } else {
            severityBadge.className = 'badge bg-info';
          }
          document.getElementById('row-severity').classList.remove('d-none');
          hasData = true;
        }

        if (data.t) {
          const date = new Date(data.t * 1000);
          document.getElementById('ctx-time').textContent = date.toLocaleString();
          document.getElementById('row-time').classList.remove('d-none');
          hasData = true;
        }

        if (data.details) {
          document.getElementById('ctx-details').textContent = data.details;

          
          const labelDetails = document.getElementById('label-details');
          if (data.type === 'object') {
            labelDetails.textContent = 'Object Metadata Details:';
          } else if (data.type === 'report') {
            labelDetails.textContent = 'Report Description:';
          } else {
            labelDetails.textContent = 'Firing Context:';
          }

          document.getElementById('row-details').classList.remove('d-none');
          hasData = true;
        }

        if (data.sql) {
          document.getElementById('ctx-sql').textContent = data.sql;
          document.getElementById('row-sql').classList.remove('d-none');
          const copyBtn = document.getElementById('btn-copy-sql');
          if (copyBtn && navigator.clipboard) {
            copyBtn.addEventListener('click', function () {
              navigator.clipboard.writeText(data.sql).then(function () {
                copyBtn.innerHTML = '<i class="bi bi-check2 me-1"></i>Copied';
                setTimeout(function () {
                  copyBtn.innerHTML = '<i class="bi bi-clipboard me-1"></i>Copy SQL';
                }, 2000);
              });
            });
          }
          hasData = true;
        }

        if (hasData) {
          document.getElementById('pslens-context-panel').classList.remove('d-none');
        }
      }
    } catch (e) {
      console.error('Failed to parse operational context metadata:', e);
    }
  })();
</script>

Component Interfaces (CIs) are PeopleSoft's programmatic façade over a component. They expose component properties as get/set properties and component events as callable methods, so integration code can drive the same business logic the UI uses. psLens reads `PSBCDEFN` for the CI header, `PSBCITEM` for the property/key list, and `PSBCMETHODS` for the methods. It also runs two consistency checks against the underlying component to catch the most common breakage: properties that no longer map to a valid record field, and required fields the CI doesn't expose.

## Object Relationships

Component Interfaces expose interactive transaction components for programmatic API access:

- **Wraps Components**: Component Interfaces (`PSBCDEFN`) target an underlying component (`PNLGRPNAME`, `MARKET`) to expose its validation logic.
- **Maps Properties to Record Fields**: CI items (`PSBCITEM`) bind exposed API properties to specific record fields (`PSRECFIELD`) on the component.
- **Secured by Permission Lists**: Permission lists (`PSAUTHBUSCOMP`) grant action-level permissions (Get, Create, Save) on Component Interfaces.

## How psLens Improves Component Interface Inspection

Evaluating Component Interfaces in Application Designer requires opening the CI item tree, cross-referencing record fields on the underlying component, manually scanning for missing required fields, and running **Find In PeopleCode** for calling programs.

psLens automates consistency checks—flagging invalid property bindings and missing required component fields—while displaying methods, properties, referencing PeopleCode, and project membership in one place.

## Search Page

URL: `/componentinterfaces?db={database}`

<figure><img src="/images/screenshots/metadata/component-interfaces-search.png"
			alt="Component Interface search results for USER% showing USERMAINT_SELF, USER_PROFILE and related CIs"><figcaption>
			<p>Component Interface search results for <code>USER%</code></p>
		</figcaption>
</figure>


Wildcard `%` search supported. Each result card shows the underlying component and CI description.

## Detail Page

URL: `/componentinterfaces/{CINAME}?db={database}`

<figure><img src="/images/screenshots/metadata/component-interfaces-detail.png"
			alt="Detail page for USER_PROFILE CI showing properties and items list"><figcaption>
			<p>Component Interface detail page for <code>USER_PROFILE</code></p>
		</figcaption>
</figure>


The main pane shows **Component Interface Properties** (underlying component, market, security access, owner) plus the items list. The sidebar has 6 related-data toggles, including two consistency-check panels unique to CIs.

## Related Data Panels

### Items

<figure><img src="/images/screenshots/metadata/component-interfaces-panel-items.png"
			alt="Items panel listing all 45 CI properties"><figcaption>
			<p>Every CI property with key flag, record/field binding, and standard/custom indicator</p>
		</figcaption>
</figure>


Every CI property (`PSBCITEM`): its record/field binding, key indicator, and whether it's a standard or custom-named property.

### CI Methods

<figure><img src="/images/screenshots/metadata/component-interfaces-panel-methods.png"
			alt="CI Methods panel"><figcaption>
			<p>Standard and user-defined methods on the CI</p>
		</figcaption>
</figure>


Standard methods (Get, Find, Create, Save, Cancel) plus any user-defined methods. Each method links into the matching PeopleCode.

### Invalid Properties Check

<figure><img src="/images/screenshots/metadata/component-interfaces-panel-invalid-props.png"
			alt="Invalid Properties Check panel"><figcaption>
			<p>Items that no longer match a valid record field on the underlying component</p>
		</figcaption>
</figure>


A consistency check. Flags CI items that no longer match a valid record field on the underlying component — the most common failure mode after a record schema change.

### Missing Fields

<figure><img src="/images/screenshots/metadata/component-interfaces-panel-missing-fields.png"
			alt="Missing Fields panel"><figcaption>
			<p>Required fields on the underlying component that the CI does not expose</p>
		</figcaption>
</figure>


A consistency check. Flags fields on the underlying component that are required (key fields, search keys, required-input fields) but are not exposed as CI properties. Helps spot where a CI cannot drive a transaction to completion.

### PeopleCode References

<figure><img src="/images/screenshots/metadata/component-interfaces-panel-pc-references.png"
			alt="PeopleCode References panel"><figcaption>
			<p>PeopleCode programs anywhere in the database that instantiate this CI</p>
		</figcaption>
</figure>


PeopleCode programs anywhere in the database that mention this CI by name. Useful for finding the App Engine, Service Operation handler, or other CI program that drives this interface.

### Included in Projects

<figure><img src="/images/screenshots/metadata/component-interfaces-panel-projects.png"
			alt="Included in Projects panel for the CI"><figcaption>
			<p>App Designer projects that include this CI</p>
		</figcaption>
</figure>


App Designer projects that include this CI.