Skip to main content

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

Publishing Cosmos DX components

Updated on May 27, 2022

Publish your Cosmos digital experience (DX) components to the Pega Infinity Server so that the component is discoverable as you author in the component palette. As a result, you can use the components while building the UI of your application.

Before you begin:
  • Ensure that you have authentication to access the resources in the Pega Infinity Server to list, publish, or delete components. For more information, see Authenticating Pega Infinity Server user access.

  • Ensure that your default access group is mapped to the application where you want to publish the component. If you do not use your default access group, use the full application URL alias.
  • Ensure that you can access the ruleset in which you want to publish your custom component.
Note: To access the resources in Pega Infinity Server to list, publish, or delete components, you require authentication. For more information, see Authenticating Pega Infinity Server user access.
  1. Open your preferred terminal tool.
  2. Enter npm run publish.
    Note: After you publish the component, Constellation creates the Rule-UI-Component instance with the name of the component on the Pega Infinity Server.
  3. Complete the parameter values:
    1. For the component, enter the name of the component that you want to publish.
    2. For the rulesetName, enter the name of the ruleset.
    3. For the rulesetVersion, enter the version of the ruleset.
      Note: Make sure you unlock the relevant ruleset version before you publish.
    4. For the devBuild, enter the development build that you use for debugging.
    Note: You can also preconfigure the values in a tasks.config.json file.
    For example:
        "components-server-config": {
            "server": "",
            "user": "customcomponentoperator",
            "password": "pwd"
            "rulesetName": "TestPega-C11nGall",
            "rulesetVersion": "01-01-03",
            "sourceOfComponents": "Server",
            "devBuild": false,
  4. Optional: To list your custom components and ensure that your component is displayed on the list, run the npm run list command.
Result: The component publication is complete and application developers can now use the component in the authoring view of App Studio. The component uses the following naming convention:

<organization>_<library>_<component name>

Note: In some cases, the preview of the component might not display in App Studio. However, you can still use the component.

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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us