Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Constellation SDKs attributes for 8.7 and 8.8

Updated on December 7, 2022
Note: Attributes with a blank default value are denoted with "" in the sdk-config.json file.

authConfig

Contains the attributes necessary for configuring the Pega InfinityTM server OAuth endpoints.

authConfig attributes in the sdk-config.json file
Attribute nameSDKAttribute data typeRequired/OptionalDefault valueDescription
authServiceAllTextRequiredpega

The authentication service alias to use. 

Accepted values: 

  • pega: Pega authentication service
  • okta: Okta authentication service
iframeLoginUIAllBooleanOptionalfalse

Determines whether to display the hidden iframe when a silent authentication fails.  Otherwise, a separate popup window is opened to display the potential authentication challenge screen. In the Portal mode, the iframe is applied only after the refresh token expires. 

Note: Configure the silentTimeout attribute if enabling the iframeLoginUi attribute.

mashupClientIdAllNumericRequired

""

The Client ID associated with the OAuth 2.0 client registration record for the application's Embedded mode.

The client registration record designates:

  • Type of authentication.
  • Client status: Public or Confidential.
  • Refresh token status: Enabled or Disabled.

The redirect URIs for Public client using the Authorization code grant type are also included in the client registration record. 

For more information about the Embedded mode, see Application modes.

mashupPasswordAllTextRequired""A Base64 encoded value of the password for the user ID. For security reasons, the encoded password is not included in the SDK code.
mashupUserIdentifierAllTextRequiredcustomer@mediaco

The user ID to use to log into the Embedded mode. If an appAlias is not specified, then the default access group within this operator record governs which application is utilized. 

Note: mashupUserIdentifier and mashupPassword are utilized only when the pega authentication service (authService) is used.

portalClientIdAllNumberRequired

17809302101260076926

The Client ID associated with the OAuth 2.0 client registration record for the application's Portal mode.

The client registration record designates:

  • Type of authentication.
  • Client status: Public or Confidential.
  • Refresh token status: Enabled or Disabled.

The redirect URIs for Public client using the Authorization code grant type are also included in the client registration record. 

For more information about the Portal mode, see Application modes.

The identified record should specify to use Public client and the Authorization Code grant flow.  We also recommend that the refresh token also be enabled and the desired timeout intervals within the record be configured.

redirectUriAllURLOptional""

The location (application route) to send the user upon successful authentication. 

By default, the SDK directs the user to the same application route where the authentication is requested. Use this to redirect the user to a different location after authentication.

revokeAllURLOptional""The full path to the Pega Infinity server's OAuth 2.0 token revocation endpoint. See OAuth Authorization Framework for more information.
silentTimeoutAllNumberOptional""

The time duration in milliseconds to wait for silent authentication (within a hidden iframe) to complete

tokenAllURLOptional""The full path to the Pega Infinity server's OAuth 2.0 token endpoint. See OAuth Authorization Framework for more information.

serverConfig

Contains the attributes necessary for configuring Constellation and the content server settings.

serverConfig attributes in the sdk-config.json file
Attribute nameSDKAttribute data typeRequired/OptionalDefault valueDescription
appAliasAllTextRequired""The appAlias to use for the application. Ensure that the application URL pattern fits the authentication type. For more information, see Application URL patterns based on authentication type.
appPortalAllTextRequired""

The Portal to render in the Portal mode. Uses the default portal of the operator’s access group if left blank, denoted with "" in the sdk-config.json file.

excludePortalsAllTextOptional""

The portals to exclude when rendering the application in the Portal mode.

If the default portal for an access group is an entry on this list, then the SDK considers the entire list of portals for the access group and uses the first portal NOT in this excludePortals list. “Developer”, “pxAdminStudio”, “pxExpress”, “pxPredictionStudio”, “pyCaseManager7”, and “pyCaseWorker” are some examples of non-Constellation portals within the default list.

Attempting to load a non-Constellation portal results in a blank screen with a spinning load indicator.

Ensure that the portals specified in this attribute are not the default portals for the access group. Otherwise, it results in the console error “Default portal for current operator ABC is not compatible with SDK…”.

infinityRestServerUrlAllURLRequired

https://localhost:1080/prweb

The full path to the Infinity REST server where your application is installed and running.

IocBootstrapCSSWeb Components onlyURLRequired./assets/css/bootstrap.min.css

The relative path to the Bootstrap CSS file used by some SDK components for overall styling. By default, the application uses the bootstrap.min.css file (minified Bootstrap 4.6.0).

This option is provided for users who might want to experiment with alternate Bootstrap CSS files. However, note that the SDK’s use of Bootstrap CSS is almost exclusively to provide high-level styling for components and does not use several of the detailed stylings available in Bootstrap.

sdkContentServerUrlAllURLRequired""

The path to the SDK content server. Uses window.location.origin to determine the path if left blank, particularly the protocol, host, and port information.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us