The playbook

27 of 27 scenarios

• ButtonsOpen a form in a modal−

  A button on a screen should open another Pega form in a dialog.

  How it goes

  1. The author creates a Local Action rule on the case type, with the form to show.
  2. The author drops the button on a view and sets the Local Action ID, a heading and a type.
  3. On click the component checks it is enabled and has an action id, then reads the heading (typed as a constant, or read from a property with getValue).
  4. It opens the action in the modal container. Pega owns the dialog, the form, validation and submit.

  Calls it uses

  getActionsApi().openLocalActiongetValue

  Pega needs

  A Local Action rule

  await pConn.getActionsApi().openLocalAction('EditDetails', {  containerName: 'modal',  type: 'Express',  actionTitle: heading,  itemKey: value || caseID,});

  Workarounds and traps

  • The component never builds the modal. It only says “open action X in the modal container”.
  • type is one of Case, Stage, Assignment or Express. refreshConditions only applies to Express and is a list of { field, event } pairs.
  • Refresh conditions are accepted loosely: an array, a JSON string, a single object, or just a property name (which becomes { field, event: "Changes" }).
  • A launching flag blocks a second click while the first is opening. It is released when the promise settles, so a failed open can be retried, and a rejected promise is reported instead of vanishing.
  • Pega hides the field itself when its “when” condition fails (visibility === false), so the component simply renders nothing.
  • The record to open on is the button’s value, or the caseID if there is no value.
  • Guard it: pConn?.getActionsApi?.()?.openLocalAction?.(…) so Storybook and older Infinity versions do not throw.
• ButtonsRun a data page when clicked+
• ButtonsSave and close the case+
• ButtonsRecord an audit entry, then open a case+
• ButtonsRefresh or reload what is on screen+
• ButtonsLink buttons and custom colours+
• TablesTable that works in the browser+
• TablesTable for thousands of rows+
• TablesFilters: instant or with a Search button+
• TablesSearch first, show later, and record what was shown+
• TablesMake a column clickable+
• TablesA table and a map that stay in sync+
• Data pagesCalling a data page, and reading what comes back+
• Data pagesSending parameters correctly+
• Data pagesSaving data back+
• Data pagesDropdowns and picklists+
• Data pagesPlot rows on a map+
• WidgetsA page-level search grid+
• WidgetsRotating messages+
• WidgetsShow a case’s attachments+
• WidgetsA booking calendar+
• LayoutsTemplates and their regions+
• LayoutsTabs and accordions that refresh+
• Cross-cuttingErrors that help without leaking+
• Cross-cuttingSettings typed as JSON+
• Cross-cuttingDefensive access and a busy state+
• Cross-cuttingAfter an Infinity upgrade+

• BAD-JSON

  A setting contains invalid JSON and was ignored.

  Usual cause

  Typo in a Columns, Filters or Params setting.

  Fix

  Fix the JSON in App Studio.

• NO-SETTING

  A required setting is missing.

  Usual cause

  Empty Local Action ID, Data Page Name or URL property.

  Fix

  Fill the setting.

• NO-RUNTIME

  Pega runtime (PCore) is not available.

  Usual cause

  Running outside Pega, such as Storybook or tests.

  Fix

  Test inside Pega.

• NOT-SUPPORTED

  Action not supported by this Pega version.

  Usual cause

  An API is missing on this Infinity version.

  Fix

  Check the version and typedefs.

• LOAD-FAILED

  Data could not be loaded.

  Usual cause

  Server error, wrong name or parameter, network.

  Fix

  Run the data page in Dev Studio and read the network tab.

• NO-ACCESS

  No access to this data.

  Usual cause

  HTTP 401 or 403.

  Fix

  Check access group and privileges.

• NOT-FOUND

  Data source not found.

  Usual cause

  HTTP 404, wrong data page name.

  Fix

  Fix the name or deploy the rule.

• BAD-REPLY

  Unexpected response.

  Usual cause

  Reserved; a result field was missing in a result check.

  Fix

  Check the response shape.

• SAVE-FAILED

  Changes could not be saved.

  Usual cause

  saveData failed on a Savable page.

  Fix

  Check Savable mode and access.

• ACTION-FAILED

  Action could not be completed.

  Usual cause

  A case or container action was rejected.

  Fix

  Read the console summary.

• NO-CASE

  Current case or task could not be identified.

  Usual cause

  Button used on a page with no assignment.

  Fix

  Place it on a task screen.

• RENDER-FAILED

  This component could not be displayed.

  Usual cause

  Something threw while drawing; the error boundary caught it.

  Fix

  Fix the setting or data; the rest of the page is unaffected.