Skip to main content


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

Project Explorer properties

Updated on January 13, 2022

The property grid on the Project Explorer can show two types of information: basic properties for each component that the project contains, and project-level properties for deployment, Pega Platform integration, references, and runtime messages.

To switch between the two types of properties shown in the Project Explorer:

  • For component-level properties, highlight the component. (Don't click the link, or the component will open.)
  • For project-level properties, open the project, or click the Information icon beside the project name, as in the following figure:

    Information icon
    The Information icon in Project Manager.

For component-level properties, the properties grid shows high-level information specific to that component, as in the following figure:

The project-level property grid for a specific component, such as an automation.

These component-level properties include the type of project item and a description that you can edit to provide documentation for other developers, so that they can better understand your project components.

The following figure shows the project-level properties that are available in the Project Explorer:

Project properties
Project-level properties on the Property Grid.

The following table describes each section of the project-level properties and its use:

Project-level properties

SectionDescription
DeploymentUse to create and track versions of your project, so you can identify the solutions that you create.
Pega Platform integrationUse to integrate Pega Platform with Assisted Sign-On (ASO) and Start my day services, so that you can sign on to and launch the applications that your Pega Platform users work in every day.
Project referencesUse to add references required by C# scripts, so that you can add functionality to your solutions from .NET, Pega, and public assemblies.
Runtime message definitionsUse to add messages to the Message Manifest service. Messages can be displayed to users, written to logs or applications, or shared with other projects.

Defining project versions with deployment properties

Use deployment properties to create easily identifiable and consistently labeled versions of your project. Automatically increment version numbers to deploy more quickly and to accurately track versions.

When you deploy a project, Robot Studio creates a deployment package file, with the format [project name].pega.

  1. Select the Increment Version checkbox to have each deployment increment the version number.
  2. Enter a Version number for your project.
    Version numbers have two parts: MajorVersion.MinorVersion. For example, 1.3. Both parts must be numeric. If you choose Increment Version, the MinorVersion number is incremented automatically with each new deployment. You must manually update the MajorVersion.

ASO and Start my day integration with Pega Platform

Use the Pega Platform integration properties to shorten daily startup time for your project users, by specifying options for using Assisted Sign-on (ASO) and Start my day services with Pega Platform.

ASO uses your Windows sign-on to enable a single sign-on. Start my day launches the applications that Robot Runtime or Agile Desktop users run every day.

The following table describes each ASO and Start my day option and its use:

Integration options

ASOAllows Pega Platform to integrate with AsoManager.
ASO queueAllows AsoManager activities received from Pega Platform to be queued by the Interaction Framework.
Start my dayAllows Pega Platform to integrate with StartMyDay.
Start my day queueAllows StartMyDay activities received from Pega Platform to be queued by the Interaction Framework.
  1. Select the ASO checkboxes to implement Assisted Sign-on for the project.

    ASO reduces the amount of time required to sign into the applications that Robot Runtime users work with every day.

    • When starting Robot Runtime, you can use an Enter Credentials window to enter and maintain all persisted user ID and password information.
    • You can enter non-persisted or changed information before proceeding, or choose persisted information. Optionally, you can design the automation to open the Enter Credentials window in an automation for credential modifications, which can show all credentials for all applications, or the credentials of one application at a time.
    • When individual applications present their login screen, the user ID and password fields can be automatically filled and the Login button clicked.
    Note: You can configure the Assisted Sign-On component to prevent user IDs and passwords from being stored on the hard drive.
  2. Select the Start my day checkboxes to include Start my day functionality in the project.

    With Start my day properties, you can specify activities that a Pega Robot Runtime or Agile Desktop user sees when launching Runtime or Agile Desktop. This list can include non-Pega programs and URLs, as well as Pega Robot Studio solutions. Users can prioritize the order in which applications are launched using the Manage Applications dialog.

    In addition, each Robot Runtime or Agile Desktop user can add to and remove from the list of processes to be started by Robot Runtime or Agile Desktop . The items on the list are specific to the user.

Managing references used in a project

Shorten development time by making use of existing references that are required for your C# scripts.

  1. Click the More icon to open the Manage references window.

    More icon
    The project references section of project-level properties, highlighting the More icon.

  2. Click the tab for .NET, Pega, or Public to add a reference.

    The Current tab shows the references that are already used in the Project. You can also add references from:

    • .NET Global Assembly Cache
    • Pega (assemblies in the installation folder)
    • PublicAssemblies folder (in AppData)
  3. Select a reference that you want to use and then click Add.
  4. Optional: To remove a reference, select the reference on the Current tab and then click Remove.

Managing Runtime message definitions

Create message definitions to give users important information during Robot Runtime sessions, or to send or record information in applications or logs.

You use Runtime message definitions to define the messages that are used by the Message Manifest service. The Message Manifest controls and stores messages, so that you can standardize the format and presentation of project messaging. The messages that you create are used throughout the project and can be exported to other projects. Message Manifest service methods read from the Message definitions list, and you can display these messages to users, write them to applications or logs, and use them in many other ways.

  1. Click the More icon to open the Message definitions dialog, as shown in the following figure.
    Message definitions
    Figure showing the Message definitions dialog.
  2. Click Add to create a new message definition.
  3. Enter a Code to identify the message definition.
  4. Optional: To show the Code in the message window, click Include code in dialog.
  5. Add a Caption to display as a title for the message window.

    For example, enter Process Complete, as shown in the following figure:

    Message components
    A message in Robot Studio with the various components identified.
  6. Optional: To add an icon to display in the message window, click the Icon drop-down menu and select the icon.
  7. In the Button drop-down list, select the buttons that you want to display in the message window.
  8. In the Default button drop-down list, select the button that should be highlighted when the message is first displayed.
  9. Enter a message in the Message box.
    You can use replaceable parameters in your messages and provide those parameter values at runtime.
  10. To test your message and see if it is displayed correctly, click Test.
  11. Click Submit to save your message and add it to the Message Manifest.

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