Limitations and Gotchas

Struggling to bridge the legacy gap? Cedar Hills Group provides specialized PeopleSoft integration consulting to help teams design, build, and optimize their connection strategies.

Even though a Component Interface runs the underlying Component’s business logic, a Component Interface is not the browser UI. Understanding where the CI runtime differs from an interactive PIA session will save you days of debugging silent failures and mysterious crashes.

What Does Not Run (or Runs Differently) in a CI

When a Component is invoked through a Component Interface rather than a browser:

Feature / Event	Behavior Under a Component Interface
`SearchInit` & `SearchSave` PeopleCode	Do NOT fire. When you populate `GetKeys` or `CreateKeys` on a CI and call `.Get()` or `.Create()`, the CI runtime bypasses interactive search page events. If `SearchInit` initializes a Global or Component variable that downstream `RowInit` or `SaveEdit` PeopleCode relies on, your CI will fail unless that initialization is also guarded in `PostBuild` or `RowInit`.
`PageActivate` PeopleCode	Does NOT automatically fire across pages because a CI user does not “tab” between visual pages. Logic written exclusively in `PageActivate` is invisible to a Component Interface.
Dynamic Visual Hiding (`.Visible = False`, `.DisplayOnly = True`)	Ignored by the CI caller. A PeopleCode script can still read and write properties on a CI even if the underlying page field is hidden or grayed out dynamically for online users (unless `FieldEdit`/`SaveEdit` explicitly rejects the change).
Related Display Fields	Not exposed. Display-only related display fields on a page cannot be read as CI properties.
Prompt Table Validation	Always enforced. Setting a property to a value that does not exist in its record-field prompt table logs an `Invalid value` error to `%Session.PSMessages`. Furthermore, if the prompt table uses dynamic keys (`%EditTable` or higher-level buffer fields like `SETID`), you must populate those prerequisite properties first.
Interactive GUI Functions (`WinMessage`, `MessageBox` with >1 button, `DoModal`, `Transfer`)	Unsupported or fatal. Any PeopleCode that stops to wait for user clicks (`DoModal`, multi-button `WinMessage`/`MessageBox`) or transfers the browser to another page (`Transfer`, `TransferPage`) fails when executed inside a CI. Guard them with `If All(%CompIntfcName) Then ...`.

System Variables Under a Component Interface

When PeopleCode executes inside a Component Interface call, PeopleTools populates specific system variables differently from an online browser session:

System Variable	Value Online (PIA)	Value Under a Component Interface
`%CompIntfcName`	`""` (Empty string)	Name of the active Component Interface (e.g., `"USER_PROFILE"`)
`%Component`	Component name (e.g., `"USERMAINT"`)	Component name (e.g., `"USERMAINT"`)
`%Menu`	Menu name (e.g., `"MAINTAIN_SECURITY"`)	`""` (Empty string — CIs do not run through a Menu!)
`%Page`	Current active Page name	`""` (Empty string, or first page in component)

Always use If None(%CompIntfcName) Then to wrap UI-only PeopleCode (Transfer, DoModal, PageActivate-style formatting) so it does not break Component Interface callers:

If None(%CompIntfcName) Then
   /* Online browser user only */
   Transfer( False, MenuName.MAINTAIN_SECURITY, BarName.USE, ItemName.USERMAINT, Page.USER_GENERAL, %Action_UpdateDisplay);
End-If;

In PIA, an administrator can override a Component’s default Search Record at the Menu level. However, a Component Interface wraps the Component definition directly and never passes through a PeopleSoft Menu.

flowchart TD subgraph OnlineFlow["Online PIA Navigation"] User1["Browser User"] --> Menu["Menu Definition
(Search Record Override: SEC_VW)"] Menu --> Comp1["Component
(Base Search Record: EMPL_SRCH)"] end subgraph CIFlow["Component Interface Call"] Caller["CI Caller (%OperatorId)"] --> CIDef["Component Interface"] CIDef --> Comp2["Component
(Always Uses Base Search Record: EMPL_SRCH)"] end

Row-level security is still enforced: The CI’s Get() and Find() methods query the Component’s Search Record using the current runtime user (%OperatorId / %RowSecurityPermissionList). If the Search Record is a security view keyed by OPRID or ROWSECCLASS, the runtime user executing the Application Engine or IB handler must have row-level security access to the target rows, or .Get() will fail with No rows exist for the specified keys (91,50).
Menu-level search record overrides are ignored: Because a CI bypasses the Menu layer, it always uses the Search Record configured on the Component itself.

`InteractiveMode = True` and Field Entry Order

By default, a Component Interface starts with InteractiveMode = False, which queues up all property assignments and runs field validations in batch when .Save() is called.

If the underlying component has FieldChange PeopleCode on Field A that populates or unlocks Field B (or sets %EditTable prompt table values for Field B):

You must set &ci.InteractiveMode = True before setting properties.
You must assign properties in your PeopleCode in the exact same top-to-bottom tab order that a human user keys them on the page.

Pressing Push Buttons via Derived/Work Fields

Many complex PeopleSoft components place business logic behind an online push button (such as a “Calculate”, “Default Values”, or “Go” button bound to DERIVED.BUTTON_FLD FieldChange). How do you “click” a button in a Component Interface?

Expose the derived/work record field bound to that push button as a Property on your Component Interface.
Set &ci.InteractiveMode = True.
Assign the trigger value (typically "Y" or "X") to that property in PeopleCode (e.g., &ci.BUTTON_FLD = "Y"), which immediately fires the button’s FieldChange PeopleCode!

The `EditHistoryItems` Silent Save Trap

When updating effective-dated scrolls (PS_JOB, PS_NAMES, etc.), Pay close attention to the combination of GetHistoryItems and EditHistoryItems:

`GetHistoryItems`	`EditHistoryItems`	Equivalent Online Mode	Behavior on Existing Rows
`False`	`False`	Update/Display	Retrieves current and future rows only. Existing current/history rows are read-only; you must insert a new effective-dated row.
`True`	`False`	Update/Display All	Retrieves all rows (including History), but historical rows are still read-only!
`True`	`True`	Correction	Retrieves all rows and allows modifying existing rows in place.

The Silent Save Trap: If you set GetHistoryItems = True and leave EditHistoryItems = False, and your PeopleCode modifies a field on an existing historical row and calls .Save(), Save() can return True without throwing an error while silently discarding your field change because the row was read-only in Update/Display All mode! Whenever your CI modifies existing effective-dated rows in place, set both GetHistoryItems = True and EditHistoryItems = True.

`DoSaveNow()` and `RemoteCall` COBOL Failures

Some older PeopleSoft components invoke DoSaveNow() inside FieldChange PeopleCode right before calling a synchronous COBOL process via RemoteCall (so the COBOL program can read the newly committed buffer rows from the database).

sequenceDiagram participant Caller as CI PeopleCode participant Buffer as CI Component Buffer participant DB as Database participant COBOL as RemoteCall COBOL Caller->>Buffer: Set Property (fires FieldChange) Note over Buffer: DoSaveNow() is IGNORED inside CI! Buffer->>COBOL: RemoteCall executes COBOL COBOL->>DB: SELECT uncommitted rows DB-->>COBOL: 0 rows found (or stale data) COBOL-->>Buffer: COBOL Error / Silent Failure

Inside a Component Interface, DoSaveNow() is ignored—only the CI’s top-level .Save() method flushes the component buffer to the database. Consequently, if a component relies on DoSaveNow() mid-event before firing a RemoteCall, the COBOL program will not see the uncommitted data in the database tables.

Late-Binding Property Typos Fail Silently on Save

Because every Component Interface variable is declared as Local ApiObject &ci, the PeopleCode compiler cannot verify property names at compile time.

If you misspell a property name in PeopleCode:

/* Typo: OPRD instead of OPRID */
&oChgDeptOprid.OPRD = "VP1";
&bSaved = &oChgDeptOprid.Save();

The compiler saves your PeopleCode without complaint.
At runtime, the invalid property assignment does not throw a PeopleCode exception; it merely appends "This is an invalid property {CHG_DEPT_OPRID.OPRD} (91,15)" to %Session.PSMessages.
Even worse, if no other validation fails, &oChgDeptOprid.Save() still returns True, and your misspelled field is silently never updated!

Defense: Always inspect %Session.PSMessages.Count even when .Save() returns True (as shown in the WAR status check in the Real-World Walkthrough).

Component Changes Corrupt Existing CIs

When a developer removes or renames a Record or Field on a Component—or changes the Component’s Search Record—any Component Interface built over that Component becomes out of sync and displays red X icons in Application Designer:

Corrupted Component Interface in Application Designer showing red X icons on invalid properties

Always run Tools > Validate for Consistency on your Component Interface (or open it in Application Designer, delete the invalid red X nodes, and drag the updated fields from the left pane to the right pane) whenever the underlying Component is modified.

Memory Management: `Local ApiObject` and Resetting to `Null`

Component Interfaces allocate substantial C++ component buffer structures inside the Application Server or PSAESRV process.

Always declare CI variables as Local ApiObject (never Global or Component unless strictly necessary).
When looping over hundreds or thousands of rows in an Application Engine program or IB handler, call &ci.Cancel() and set &ci = Null; after each transaction (or re-instantiate per step) so the Application Server releases the previous component buffer cleanly.

Non-Unique Search Keys and Numeric Key Formatting

Two subtle key-matching bugs frequently trip up .Get() calls:

Non-Unique Search Keys: If a component’s Search Record can return multiple rows for the partial keys you supply, .Get() fails because .Get() requires a single, unique match. Use .Find() to retrieve the matching collection, inspect the items, and call .Get() with the full unique keys.
Numeric Key Formatting: When a key property is numeric or zero-padded character, ensure the value passed to GetKeys matches the exact format stored in the database (Value() vs. zero-padded string).

Previous Real-World Walkthrough: Batch User Profile Load

Next Integration Broker and Production Patterns

Author Profile

Chris Malek

Chris Malek is a PeopleTools® Technical Consultant with over two decades of experience. He is available for consulting engagements.

Work with Chris

Contents

Contents

Limitations and Gotchas

What Does Not Run (or Runs Differently) in a CI

System Variables Under a Component Interface

Row-Level Security and the Menu Search-Record Trap

`InteractiveMode = True` and Field Entry Order

Pressing Push Buttons via Derived/Work Fields

The `EditHistoryItems` Silent Save Trap

`DoSaveNow()` and `RemoteCall` COBOL Failures

Late-Binding Property Typos Fail Silently on Save

Component Changes Corrupt Existing CIs

Memory Management: `Local ApiObject` and Resetting to `Null`

Non-Unique Search Keys and Numeric Key Formatting

psLens Operations & Intelligence

psLens Operations & Intelligence

psLens Operations & Intelligence

psLens Operations & Intelligence

Chris Malek

Subscribe to Updates

PeopleSoft Simple Web Services

PeopleSoft Simple Web Services

PeopleSoft Simple Web Services

PeopleSoft Simple Web Services

Contents

Contents

Limitations and Gotchas

What Does Not Run (or Runs Differently) in a CI

System Variables Under a Component Interface

Row-Level Security and the Menu Search-Record Trap

InteractiveMode = True and Field Entry Order

Pressing Push Buttons via Derived/Work Fields

The EditHistoryItems Silent Save Trap

DoSaveNow() and RemoteCall COBOL Failures

Late-Binding Property Typos Fail Silently on Save

Component Changes Corrupt Existing CIs

Memory Management: Local ApiObject and Resetting to Null

Non-Unique Search Keys and Numeric Key Formatting

psLens Operations & Intelligence

psLens Operations & Intelligence

psLens Operations & Intelligence

psLens Operations & Intelligence

Chris Malek

Subscribe to Updates

PeopleSoft Simple Web Services

PeopleSoft Simple Web Services

PeopleSoft Simple Web Services

PeopleSoft Simple Web Services

`InteractiveMode = True` and Field Entry Order

The `EditHistoryItems` Silent Save Trap

`DoSaveNow()` and `RemoteCall` COBOL Failures

Memory Management: `Local ApiObject` and Resetting to `Null`