PCore and PConnect APIs in Constellation DX components

Constellation DX components use the PCore and PConnect public APIs to create, read, update, and delete Pega Infinity data.

Note: To complete the knowledge check and module quiz, you must go through the links mentioned in this topic.

The PCore and PConnect public APIs are comprehensive and cover all use cases required by out-of-the-box Constellation DX components. However, only a subset of these APIs are commonly used to develop your Constellation DX components.

Working with PCore and PConnect public APIs

Note: The following content, referenced from Pega Documentation, is included here to help you better achieve the module learning objectives.

In Constellation applications, the Constellation engine relies on PCore and PConnect public APIs to deliver the application's UI. This approach delivers access to state management, actions, events, and a higher level of abstraction to the DX APIs.

NOTE: For the complete PCore and PConnect documentation, see Using PCore and PConnect Public APIs.

The Constellation orchestration layer is the backbone of the Constellation architecture and contains the PCore and PConnect APIs. The Constellation DX components that are part of the Constellation design system use the PCore and PConnect APIs to connect the Constellation presentational components to the Pega Platform™ Server.

Constellation client architecture — Constellation Client Architecture

Type definitions

Using TypeScript type definitions, the IDE helps you with code completion and provides the functional definition, functional parameters, and return data.

For more information on type definitions, see Using type definitions for PCore and PConnect APIs.

Commonly used PCore APIs

The PCore APIs are global APIs that are available in Constellation architecture-driven applications. These APIs provide information about the application's environment, locale, and other information that is unrelated to a specific UI component.

Use the PCore APIs to obtain access to the publicly available capabilities of the JavaScript Constellation orchestration layer when there is no specific context or when a PConnect context is not available.

The following PCore APIs are frequently used in building your Constellation DX components:

Class	API	Description
Directly accessed	getConstants	Obtains the public constants (containing un-modifiable constant objects) that can be used where specified by PCore.
DataPageUtils	getDataAsync	Obtains results from the specified list type data page.
DataPageUtils	getPageDataAsync	Obtains results from the specified page type data page.
EnvironmentInfo	getTimeZone	Obtains the defined time zone of the application that the user is currently logged into.
RestClient	invokeRestApi	Invokes a specific Pega REST API using a route key.

Commonly used PConnect APIs

The PConnect APIs obtain or update information about each specific instance of a UI component that exists in an application at run time.

Use the PConnect APIs when there is a known context that provides necessary information about the component being rendered from the Constellation JavaScript Engine.

PConnect APIs can also be used to create new instances of UI components and determine how a component's rendering should be updated.

The following PConnect APIs are frequently used in building your Constellation DX components:

Class	API	Description
Directly accessed	createComponent	Creates a component whose type is provided as part of the meta object and uses the other parameters to resolve the properties and obtain the context.
Directly accessed	getCaseInfo	Obtains an entry point to the CaseInfo object that contains the APIs to handle the information related to a case.
Directly accessed	getChildren	Obtains the list of children for the current component.
Directly accessed	getComponentName	Obtains the name of the current component.
Directly accessed	getConfigProps	Obtains the resolved configuration of a component.
Directly accessed	getContextName	Obtains the name of the context under which the current component was rendered.
Directly accessed	getInheritedProps	Obtains the properties that are set in the parent metadata node within the inheritedProps metadata structure.
Directly accessed	getRawMetadata	Obtains the complete metadata of the component in its raw and unresolved format.
Directly accessed	getStateProps	Obtains the properties that are bound to the state of a Store.
Directly accessed	getValue	Obtains the value of the property from the Redux Store.
Directly accessed	hasChildren	Determines whether the current component has children.
Directly accessed	resolveConfigProps	Resolves the input properties and obtains the resolved properties.
ActionsApi	navigateToStep	Navigates to a specific step in the context of a container.
ActionsApi	openLocalAction	Opens the configured local action.
ActionsApi	triggerFieldChange	Runs validations on a specified control and triggers the `FIELD_CHANGE` event.
ActionsApi	updateFieldValue	Dispatches the `SET_PROPERTY` event on a specified control to store a specified value in the Redux Store.
CaseInfo	getClassName	Obtains the name of the case class.
CaseInfo	getID	Obtains the ID of a case that is rendered using the current context.
CaseInfo	getKey	Obtains the key of the case that is rendered using the current context.
ValidationApi	validate	Validates the specified field and updates the state if the validation is successful.

Check your knowledge with the following interaction:

This Topic is available in the following Module:

PCore and PConnect APIs v1

Get help

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Yes

Want to help us improve this content?

Suggest an edit