StartMyDay Properties, Methods, and Events
The following tables describe the properties, methods, and events for the StartMyDay component.
Note: For the StartMyDay component to control an application, you must set properties on the adapter These properties control the name the StartMyDay component displays in dialogs, whether or not the application appears in dialogs, and how the system finds the application when there is a request to organize the desktop. For more information, see StartMyDay Component Overview.
Property |
Description |
Enable 8.0.1086 or later |
Enter True to allow the Pega Platform to integrate with StartMyDay. Enter False if the Pega Platform is not integrated with this solution. If you enter True, see the Pega application documentation for information on how to integrate StartMyDay automations into your application. |
QueueActivity 8.0.1086 or later |
Enter True if you want the Interaction Framework to place into a queue Start My Day activities that are received from the Pega Platform. Enter False if you want to initiate Start My Day activities that are received from the Pega Platform upon receipt. Note: This property has no effect if the Enable property is set to False. |
This |
A reference to the StartMyDay object. |
The StartMyDay component works with the Web, Windows, or Universal Web adapter properties to control the adapter.
Method |
Description |
Parameters |
Return type |
AddExeApplication |
Use this method to add an executable application to the Start My Day list. |
String friendlyName, |
Boolean result |
AddWebApplication |
Use this method to add a web application to the Start My Day list. |
String friendlyName, |
Boolean result |
GetApplicationPositionAndSize 8.0.1086 or later |
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. Note: Be sure to set the StartMyDayControls property on the adapter. Otherwise, the system does not retrieve the application’s position and size. |
String friendlyName |
int left, |
GetStartupApplications |
Use this method to get a list of the applications designated to be started. |
none |
List<StartMyDayApplication> Result |
OrganizeApplication 8.0.1086 or later |
Use this method to set the position and size of a single Start My Day application to the saved values. Note: Be sure to set the StartMyDayControls property on the adapter. Otherwise, the system does not retrieve the application’s position and size. |
String friendlyName |
int left, |
OrganizeDesktop 8.0.1086 or later |
Use this method to set the position and size for all Start My Day 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. Note: Be sure to set the StartMyDayControls property on the adapter. Otherwise, the system does not retrieve the application’s position and size. |
none |
Boolean result |
ResetState |
Use this method to reset all component properties to their initial values. |
none |
void |
SetApplicationOrder 8.0.1086 or later |
Use this method to set the ordinal (0-based) position of an application in the list for the Manage Applications window. Reference adapters and web applications added using the AddWebApplication method and the FriendlyName property. Reference applications added with the AddExeApplication method using their path. |
String
friendlyNameOrPath, |
Boolean result |
SetApplicationPositionAndSize 8.0.1086 or later |
Use this method to set the position and size of an application. Note: You can only call this method for adapters. Also set the StartMyDayControls property on the adapter. Otherwise, the system does not retrieve the application’s position and size. |
String friendlyName, |
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 8.0.1086 or later |
Add one or more than one applications to the connection 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 Start My Day functionality. |
none |
void |
Event |
Description |
ApplicationOrganized 8.0.1086 or later |
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. Note: Be sure to set the StartMyDayControls property on the adapter. Otherwise, the system does not retrieve the application’s position and size. |
ApplicationOrganizing 8.0.1086 or later |
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. Note: Be sure to set the StartMyDayControls property on the adapter. Otherwise, the system does not retrieve the application’s position and size. |
OnStartAdapter |
The system raises this event when the adapter starts. |
Organized 8.0.1086 or later |
The system raises this event when the OrganizeDesktop method completes its work. |
Organizing 8.0.1086 or later |
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. |
Privacy | Trademarks | Terms of Use | Feedback
Updated: 18 June 2020
© 2016 - 2020 Pegasystems Inc. Cambridge, MA All rights reserved.