StartMyDay properties, methods, and events
Use StartMyDay properties, methods, and events to define automations that run when you launch Runtime.
The StartMyDay feature is a set of tools to automate activities you see when starting Robot Runtime or Agile Desktop. This list can include non‐Pega programs and URLs, as well as Pega Robot Studio solutions. Users can use the Manage Applications dialog to prioritize the order in which applications are launched, to maximize their readiness.
In addition, each Runtime/Agile Desktop user can add to and remove from the list of processes to be started by Runtime/Agile Desktop. The items on the list are specific to the user.
StartMyDay properties
Property | Description |
Enable | Enter True to allow associated applications to integrate with StartMyDay. Enter False if the applications are not integrated with this solution. |
QueueActivity | Enter True if you want the Interaction Framework to queue StartMyDay activities that are received from applications. Enter False if you want to initiate StartMyDay activities that are received from applications upon receipt. |
StartMyDay methods
Method | Description | Parameters | Return type |
AddExeApplication | Use this method to add an executable application to the StartMyDay list. | String friendlyName, String path | Boolean result |
AddWebApplication | Use this method to add a web application to the StartMyDay list. | String friendlyName, String url | Boolean result |
GetApplicationPositionAndSize | Use this method to get the position of the top-left corner of the application and the width and height of the application. The method also returns a True or False value to indicate the success of your request. | String friendlyName | int left, Int top, int width, int height, Boolean result |
GetStartupApplications | Use this method to get a list of the applications designated to be started. | none | List<StartMyDayApplication> Result |
OrganizeApplication | Use this method to set the position and size of a single StartMyDay application to the saved values. | String friendlyName | int left, int top, int width, int height, Boolean result |
OrganizeDesktop | Use this method to set the position and size for all StartMyDay applications to their saved values. This method does not affect applications that are added manually by users or applications that are added using the AddExeApplication or AddWebApplication methods. | none | Boolean result |
ResetState | Use this method to reset all component properties to their initial values. | none | void |
SetApplicationOrder | Use this method to set the ordinal (0-based) position of an application in the list for the Manage Applications window. Reference applications and web applications added using the AddWebApplication method and the FriendlyName property. Reference applications added with the AddExeApplication method using their path. | String friendlyNameOrPath, Int index | Boolean result |
SetApplicationPositionAndSize | Use this method to set the position and size of an application. | String friendlyName, int left, Int top, int width, int height | Boolean result |
ShowDialog | Use this method to display the Manage Applications window. | none | Boolean clickedOK |
ShowStartDialog | This method shows a list of applications that are not started. The user can select one or more applications from the list to start. For more information, see Using the Start Dialog. | none | Boolean clickedOK |
StartApplication | Use this method to start a single application. | friendlyName | Boolean result |
StartApplications | Add one or more applications to the automation block inputs so you can start multiple applications. | String friendlyNames | Boolean result |
StartApplicationList | Use this method to start all of the applications that you include in the string array. This list can include one or more applications. | String[] friendlyNames | Boolean result |
StartMyDay | Use this method to execute StartMyDay functionality. | none | void |
StartMyDay events
Event | Description |
ApplicationOrganized | The system raises this event when the
OrganizeApplication method completes its
work. This event returns the following event arguments:
Name, Adapter,
Left, Top,
Width, and Height. |
ApplicationOrganizing | The system raises this event when the OrganizeApplication method is invoked. This event returns the following event arguments: Name, Adapter, Left, Top, Width, and Height. You can cancel this event by sending a True value to the Cancel port. |
OnStartAdapter | The system raises this event when the application starts. |
Organized | The system raises this event when the OrganizeDesktop method completes its work. |
Organizing | The system raises this event when the OrganizeDesktop method is invoked. You can cancel this event by sending a True value to the Cancel port. |
StartMyDayCompleted | The system raises this event when the StartMyDay component finishes its tasks. |
- Use case: using a StartMyDay service in an automation
The Start My Day feature of Pega Robot Studio has several methods and events you can use to launch the applications and processes you use to begin your workday.
Previous topic MessageManifest methods Next topic Use case: using a StartMyDay service in an automation