To publish, list, or delete a standalone Constellation DX component, you require credentials to access the resources on the Pega Platform™ Server.

Before you begin:

  • Ensure that the Allow rule check out access setting under the Security tab has been added to the operator record used for authentication and publication.
  • Ensure you have a valid operator ID in your Pega Platform development instance that you can use to log in to your Pega applications.
  • Ensure you are using Pega Platform 8.7 or a later version.

NOTE:
  • After completing the authentication, you must reauthenticate yourself after the default timeout of 15 minutes. You can change the timeout period by editing the REST API Auth 2.0 Client registration record. The record contains a clientID that matches the configuration contained in the tasks.config.json file of each component.
  • Constellation DX components require you to use the OAuth 2.0 authentication protocol.
  • If you do not want to use the provided client credentials, you can create your own client credentials. If you use a different OAuth 2.0 authentication flow in the client credentials, you must update your tasks.config.json file accordingly. For more information on the various configuration options for the tasks.config.json file, see server-config. The relevant attributes in the server-config section are clientId, clientSecret, grantType, and authService (if you need to integrate Constellation DX Component Builder with your SSO setup). For more information on setting up alternative authentication schemes that can be used with Constellation DX Component Builder, see OAuth 2.0 client registrations.

  1. In Dev Studio, click Records > Security > OAuth 2.0 Client Registration. If the DX-ComponentDev record is visible in the list of instances, you already have a valid client credential. Go to step 7 to revalidate it.
    If the DX-ComponentDev record does not exist, import it as directed in the following steps.
  2. In Dev Studio, click Configure > Application > Distribution > Import.
  3. On the Application: Import wizard tab, click Local file, and then click Choose file.
  4. Navigate to the DX component project's keys folder, select the DX-ComponentDev.zip file, click Open, and click Next.
  5. Select the Enable advanced mode to provide more granular control over the import process checkbox and click Next.
  6. On the Import Wizard File : DX-ComponentDev.zip tab, verify that the DX-COMPONENTDEV instance is selected, and click Next.
    The import process is complete. The DX-ComponentDev record is now present in the list of instances.
  7. Run the following command to initiate authentication:
    npm run authenticate

    A sample set of details to be entered by the user after initiating the authentication

    Authenticating user access
  8. Enter your operator ID and password, and click Log in.
    If the credentials are valid, an authentication success message is displayed.

Result:

You now have authentication to publish, list, or delete standalone Constellation DX components.