This chapter provides an overview of the Control Center and discusses how to:
Determine DES status
Administer Scheduler events
Administer email job reports
View the dedup email job report
Administer single email failure and recovery
Administer the single email queue
Administer the frequency email queue
View Dialog Mover status
Maintain dialog services
The Control Center allows you to perform a number of administration tasks on the Online Marketing Dialog Execution Server (DES). These tasks are generally used to correct a problem, or to assist PeopleSoft Customer Connection representatives in troubleshooting your system.
Note. DES Clustering is only supported on WebLogic.
You use the DES status pages to:
Monitor the server and perform DES Scheduler service tasks.
Clear the cache.
Monitor memory usage.
Change debug flags.
View status reports for running single mailers, bulk mailers and frequency mailers.
Page Name |
Object Name |
Navigation |
Usage |
RY_DES_SERVICE |
Marketing, Dialog Monitoring, Server Monitor |
Use to monitor the Dialog Execution Server and to perform DES Scheduler service tasks. |
|
RY_CACHE |
Marketing, Dialog Monitoring, Server Monitor Click the Cache tab. |
Use to clear or refresh the DES cache for troubleshooting purposes. |
|
RY_MEMORY |
Marketing, Dialog Monitoring, Server Monitor Click the Memory Usage tab. |
Use to monitor the DES memory usage for troubleshooting purposes. |
|
RY_DEBUGFLAG |
Marketing, Dialog Monitoring, Server Monitor Click the Debug tab. |
Use to change the DES debug flags. This feature should only be used while troubleshooting your software with a PeopleSoft Customer Connection representative. |
|
RY_MAILCASTER_INFO |
Marketing, Dialog Monitoring, Server Monitor Click the Email Service tab. |
Use to display a running status report for all currently installed single mailers or mailcasters. |
Access the DES Server Monitor page.
When this page is active, the current status of the Dialog Execution Server cluster instances is displayed.
DES Cluster Instances
Displays the running status of the DES instance.
ID |
The identifier for the individual DES instance. |
IP Address |
The network address of the machine running the instance. |
Host Name/Port |
The name or port number of the machine running the instance. |
Status |
The status of the instance: Running or Stopped |
Comment |
A brief description of the instance's status. Options are:
|
Start Time |
The time and date at which the instance was started. |
Last Update |
The time and date of the last time the instance was updated. |
Reload |
The DES updates its status by default every 30 seconds; click this button if you want to get the latest DES instance status manually. |
Scheduler Timer
Manages the execution of dialog jobs, such as triggers and other internal dialog processes. Click Start Timer to start the Scheduler Timer, or Stop Timer to stop it.
Click Timer Status to view the current Scheduler status.
Note. The administrator of WebLogic or WebSphere application servers can stop and restart applications without bringing the server down. PeopleSoft does not recommend doing this with the Dialog Execution Server. If for any reason DES must be stopped and restarted, the server should be recycled by stopping and restarting it.
Access the Cache page.
The Cache page clears cache and memory for troubleshooting purposes. This feature should only be used while troubleshooting your software with a PeopleSoft Customer Connection representative.
Cache Type |
Select the type of cache you want to clear: Audience, Dialog, Profile, or Template. |
Cached Objects |
Displays the cached objects from all of the DES instances in the chosen cache type. |
Reload |
(Dialog cache type only) Click this button to cause DES to reload the specified Dialog data from the database into the DES cache. |
Clear |
(All cache types except Dialog) Click this button to cause DES to clear the specified object from the DES cache. |
Clear all DES Cache |
Click to clear all the Dialog Execution Server caches. |
Clear Extensions Cache |
Click to clear the DES Extensions cache. |
Warning! Using the Clear Cache function can have an effect on system performance due to the fact that it clears all objects that are cached and therefore will take time to restore all these objects. Problems can occur if this command is used during the execution of a Scheduler or Single Mailer request.
Access the Memory Usage page.
The Memory Usage page allows you to monitor memory usage for troubleshooting purposes. You can view memory usage for documents or for all of DES by DES instance.
Memory Category |
Choose a memory category: DES Document Contact displays document memory usage. DES Entire Server displays memory usage for all of DES. |
Reload |
Click to refresh the information displayed in the window. |
DES Instance ID |
Click this link to display the DES memory usage data for the selected instance. |
Access the Debug page.
The Change DES Debug Flags feature should only be used while troubleshooting your software with a PeopleSoft Customer Connection representative. Any changes you make here will remain in effect until they are changed again using this feature, or until the server is restarted.
Flags |
Enter the debug flags you want to send to the DES. |
Send Debug Flag |
Click to send the specified debug flags to the DES. Note. Debug flags apply to all DES instances. |
Access the Email Service page.
The Email Service page displays detailed information (via RMI) about Mailcaster, Frequency Mailer and Single Mailer processes.
Service Type |
Select Frequency Emailer, Single Emailer, or Mailcaster. |
Reload |
Click to reload information about the selected service type from the system. |
Mailcasters
Email Engine ID |
The Instance ID of the Frequency Emailer, Mailcaster, or Single Mailer |
Host Name/Port |
The name and RMI port number of the email engine. |
Status |
The current status of the event. The possible values are:
|
Render Queue Size |
The maximum number of messages on the queue to be rendered |
Render Queued Count |
The current number of messages on the render queue. |
Render Thread Count |
The number of render threads. |
Send Queue Size |
The maximum number of rendered messages to be sent. |
Send Queued Count |
The current number of rendered messages to be sent. |
Total Sent Count |
The total number of messages sent by the thread. |
Send Thread Count |
The current number of send threads. |
Dedup Table Name |
(Mailcaster only) The name of the deduplication table. |
Mail Job ID |
(Mailcaster only) The identifier of the mail job. |
Job Status |
(Mailcaster only) The current status of the mail job. |
Is Small Job |
(Mailcaster only) Whether the mail job is considered a small job (based on the smallJobOnly configuration parameter). |
Message Queued |
(Mailcaster only) The total number of messages in the queue (waiting to be sent) as part of this mail job. |
Message Sent |
(Mailcaster only) The total number of messages already sent as part of this mail job. |
Send Threads
Thread ID |
The Java thread name |
Email Server |
The SMTP server this thread uses to send mail. |
Status |
The status of the send mail thread: Running or Idle. |
Sent Count |
The number of messages sent by this thread. |
The scheduler manages the execution of Online Marketing jobs, such as dialog Date/Time trigger . You can use it to produce a report of schedule events, as well as:
Restarting a failed, skipped, or paused event.
Stopping a queued event.
Drilling down to an individual mail job report.
Page Name |
Object Name |
Navigation |
Usage |
RY_SCHEDULER_EVENT |
Marketing, Dialog Monitoring, Control Center, Scheduler Event Report |
Use to produce a report of scheduled events, stop or restart events, and view individual mail job reports for finished events. |
Access the Scheduler Event Report page.
Event ID |
The unique ID of the scheduled event. If the event has broadcast email associated with it and the Mail Job has finished, you can click on its ID to view the Mail Job Report. The event can be a Trigger execution or a delayed broadcast email event. |
Trigger Name |
The name of the trigger to be executed. Note. For repeating triggers, the first repeat event will appear in the table immediately after the dialog is activated. The second and subsequent times, the event is listed in the table n minutes before its execution time, where n is the wakeup interval of the scheduler. |
Dialog Name |
The name of the dialog associated with the scheduled event. |
Staging Dialog |
Identifies whether this dialog is in staging (test). |
Event Type |
The type of event to be executed by the scheduler. Examples include Execute Trigger and Send E-mails. |
Event Start Date/Time |
The date and time when the event was scheduled to execute. |
Last Modified Date/Time |
The date and time when the event's status was last modified. |
Repeat Number |
The number of times this particular event has repeated. |
Instance ID |
The numerical ID of the DES instance handling this scheduler event. |
Event Status |
The current status of the event. The possible values are: Duplicated: Events in the “Suspended while running” state are changed to duplicated when a paused dialog is restarted. A copy of the “Suspended while running” event is created to avoid conflicts between the restarted event and a possible orphaned mailjob. Failed: the event failed. You should investigate the cause of the failure by checking the server log files. Finished: the event finished normally. If this is a broadcast email event, there will also be an entry in the Mail Job Report. Overlapped: a repeat event was overlapped by a previous repeat event that had not yet completed. Queued: the event is in the queue and ready to be invoked at the Event Start Time. Running: the scheduler is processing the event. Scheduling: the event is being scheduled. Skipped: a repeat event was skipped. Stopped: the event was stopped by the marketer (such as when a dialog is stopped or a milestone is deleted). Stopped while queued: any event stopped using the Control Center Stop button (as opposed to an event stopped by Online Marketing when an entire dialog is stopped). Suspended: the event was suspended by an Online Marketing administrator (dialog is paused or in Broadcast Hold). Suspended while running: this status occurs if an event is running when the dialog is paused. |
Restart |
Click to restart a failed, skipped, or paused event. A confirmation page will be displayed. If the status of the event has changed, you will be informed of this fact and asked if you want to continue the action. |
Stop |
Click to stop a queued job. A confirmation page will be displayed. If the status of the event has changed, you will be informed of this fact and asked if you want to continue the action. |
The Email Job Report shows the status of Mailcaster email jobs, and allows you to restart stopped or failed email jobs.
Page Name |
Object Name |
Navigation |
Usage |
RY_MAIL_JOBS |
Marketing, Dialog Monitoring, Control Center, Email Job Report |
View information about individual mail jobs, and to restart stopped or failed jobs. |
Access the Mail Job Report page.
Mail Job ID |
The identifier of the mail job listed in the PS_RY_BULK_JOB table (an integer value). If the job is a child job and is finished, you can click the Mail Job ID to view more information about the child job. |
Trigger ID |
The identifier of the trigger that scheduled this broadcast email job. |
Activity ID |
The activity ID for this job. Large mailing events are often split into multiple child jobs handled by different bulk mailers. Each child job has the same Activity ID, allowing them to be associated with each other in reports. |
Dialog Name |
The dialog for which this broadcast email job was executed. |
Job Queued Date/Time |
The date and time when the mail job was entered in the queue. |
Last Modified Date/Time |
The date and time when the mail job's status last changed. |
Number of Child Jobs |
The number of smaller jobs into which the main job was divided. |
Parent Job ID |
The identifier of the parent email job. |
Repeat Number |
The number of times a trigger event has occurred. For the first iteration of a repeating trigger event, its Repeat Number is 1. Each subsequent time the event is repeated, its Repeat Number is incremented by one. |
Job Status |
The status of this job. The possible values for parent mailjobs are:
The following status values apply to child or small mailjobs:
Mailjobs can show the following additional statuses:
|
Trigger Name |
The trigger that scheduled this broadcast email job. This is the name given to the trigger in Online Marketing. |
Activity Name |
The name of the action as configured in Online Marketing. |
Message Queued |
The number of email messages that have been processed by the Mailcaster. Until the job finishes running, this number will be different from the number listed in Message Sent, because the messages are sent one at a time to the SMTP server. |
Message Sent |
The number of email messages that have been sent to the mail server. While the job is running this number will be different (lower ) from the number listed in Messages Queued. Once a job has finished the two will often match; however it is not an error if they do not. If any email addresses were rejected by the mailserver then the sent count will be less than the queued count. |
Instance ID |
The numerical ID of the bulk mailer instance handling this job |
The Dedup Email Job Report shows jobs that have been deduplicated and sent to a Mailcaster for mailing. Deduplication refers to the process by which duplicate email addresses are removed from a broadcast mailing list, ensuring that an addressee doesn’t receive the same email more than once. This is particularly important if you are sending a broadcast email to more than one audience (since the same addressee may appear in more than one audience). The deduplication process also removes from the list addresses with Do Not Email specified.
Note. When a large mail job is sent from Online Marketing, it is typically sent by multiple mailcasters. The Online Marketing Dialog Execution Server creates a parent mail job with a status of P_Queued. When mailcasters begin to send the mail they change the status of the parent job to P_Assigning and create child jobs with the status of Running. The Dedup Email Job Report only lists entries for parent email jobs such as these, as well as for small mail jobs.
Page Name |
Object Name |
Navigation |
Usage |
RY_DEDUP_JOBS |
Marketing, Dialog Monitoring, Control Center, Dedup Email Job Report |
Displays a list of mail jobs that have been deduplicated and sent to the mailcaster for mailing. |
|
Dedup Report – Audience |
RY_DEDUP_JOBS |
Click the Audiences tab on the Dedup Report page. |
Displays audience information about mail jobs. |
Access the Dedup Report – Mail Job page.
Mail Job ID |
The numerical job ID assigned to this mail job by Online Marketing. |
Trigger ID |
The trigger ID assigned to this event by Online Marketing. |
Trigger Name |
The name of the trigger associated with the event. |
Activity ID |
The identifier of the activity associated with the mail job. |
Activity Name |
The name of the activity associated with the mail job. |
Dialog Name |
The name of the dialog from which the mail job was sent. |
Job Status |
The current status of the mail job. |
Job Queued Date/Time |
The date and time when the mail job was queued for sending. |
Viewing Dedup Report Audience Information
Access the Dedup Report – Audience page.
Audience Name |
The name of the audience to which the mail job is being sent. This is the audience name configured in Online Marketing. |
Total Audience Count |
The number of members in the audience to which the mail job is being sent. This value is equal to the sum of the Total Do Not Email Count, Total Deduped Count, and Total Emails to be Sent fields. |
Total Do Not Email Count |
The number of audience members who have requested not to be contacted by email. |
Total Deduped Count |
The number of emails removed from this job by the deduplication (dedup). |
Total to be Sent |
The total number of emails in the job that will be sent to audience members. |
Single Email Failure and Recovery allows the administrator to search for and identify single emails that failed to send or were rejected. The administrator can then choose to resend the emails or delete them.
Page Name |
Object Name |
Navigation |
Usage |
RY_SINGLE_MAIL_ERR |
Marketing, Dialog Monitoring, Control Center, Single Email Failure/Recovery |
Use to identify and re-send or delete single emails that failed to send or were rejected. |
Access the Single Email Failure and Recovery page.
Select |
Select the emails you want to recover or delete. |
Detail |
Click to view the Single Email Queue Report for the selected document that failed with the specified error code. |
Document Name |
The name of the document. |
Error Code |
The reason why the email failed or was rejected. Error codes include:
|
Count |
The number of emails with the specified document name that failed with the specified error code. |
Check All/Clear All |
Select the check box to select all the emails in the results list. Clear the check box to clear all the selected emails. |
Recover Selected Emails |
Click to recover the emails you have selected. The emails will change to Queue status, so the Single Mailer will try send them again. |
Delete Selected Emails |
Click to delete from the queue all the emails you have selected. |
The Single Email Queue Report provides the capability to watch the status of an individual email in the queue. You can also delete or recover the queued single emails.
Page Name |
Object Name |
Navigation |
Usage |
RY_SINGLE_MAIL_QUE |
Marketing, Dialog Monitoring, Control Center, Single Emailer Queue Report |
Use to monitor the status of single emails in the mail queue, and to delete or recover selected emails. |
Access the Single Emailer Queue Report page.
Select |
Select an email's check box to mark it for deletion. |
To be sent Date/Time |
The date and time at which the single email is to be sent. |
Last Modified Date/Time |
The date and time when the single email's status was last changed. |
Document Name |
The name of the single email in the queue. |
Email Addresses |
The email address(es) to which the single email is being sent. |
Instance ID |
The instance ID of the particular email service. |
Status |
The current status of the email. The possible values are:
|
Recover |
Click this button to recover a failed single email. The button is available only when the email's status is Failed. |
Check All/Clear All |
Select the check box to select all the emails in the results list, or clear the check box to clear all the selected emails. |
Delete Selected Emails |
Click to delete emails whose Select check box has been selected. |
This section describes how to administer the Frequency Emailer Queue.
Page Name |
Object Name |
Navigation |
Usage |
Frequency Emailer Queue Report |
RY_FREQUE_MAIL_QUE |
Marketing, Dialog Monitoring, Control Center, Frequency Emailer Queue Report |
Use to administer the Frequency Emailer queue. |
Access the Frequency Emailer Queue page.
Select |
Select the check box to select the associated dialog, or clear it to deselect the dialog. |
Dialog Name |
The name of the dialog. |
Document Name |
The name of the email document to be sent. |
Original Email Service Type |
Displays the email service type that originally was to send the mail: Single Mailer or Mailcaster. |
Expiration Date |
The date after which the email expires from the queue and will be discarded. |
Email Address |
The email address to which the email is to be sent. |
Status |
The current status of the email. The possible values are:
|
Error Code |
The reason why the email failed or was rejected. Error codes include:
|
Instance ID |
The instance ID of the particular email service that has reserved the email for sending. |
Start Date/Time |
The date and time when the email was enqueued in the Frequency Email Queue. |
Last Modified Date/Time |
The date and time when the email's status last changed. |
Check All/Clear All |
Select the check box to select all the emails in the list; clear it to clear any selected emails. |
Recover Failed Emails |
Click this button to attempt to recover and requeue any emails with status Failed. |
Delete Selected Emails |
Click this button to delete all the emails you have selected. |
Update Queue |
Click this button to update the email queue, which updates the counts of the email counter. |
Delete All Queued Emails |
Click this button to delete all emails currently in the queue. |
The Dialog Mover Status Report page allows you to view the status of imported and exported dialogs.
Page Name |
Object Name |
Navigation |
Usage |
Dialog Mover Status Report |
RY_DM_STATUS_RPT |
Marketing, Dialog Monitoring, Control Center, Dialog Mover Status Report or Click the Dialog Mover Status Report link on the Dialog Import Status page during a dialog import. |
View the status of the Dialog Mover's dialog import and export process. |
Access the Dialog Mover Status Report page.
Dialog ID |
The original Dialog ID for an exported dialog, or the new Dialog ID for an imported dialog. |
Dialog Name |
The original dialog name for an exported Dialog, or the new Dialog Name for an imported dialog.. |
Process Type |
The action that is being performed: Import or Export. |
Status |
The current status of the import or export. The values are Finished, Running, Failed, Cancelling, and Cancelled. The Cancelling and Cancelled states occur when a user chooses to cancel a running dialog import. |
Cancel |
This button appears only next to dialog imports with the status of Running. Clicking it changes the import's status to Cancelling, after which it will change to Cancelled. |
Refresh |
Click to get the current status of the dialog import process. |
Note. If a dialog import is running, then another dialog of the same name cannot be imported until the first run is finished or cancelled.
The Maintain Dialog Servers page allows you to install new instances of the Standalone Dialog Servers: Mailcaster, WatchDog, and Email Response Processor.
Page Name |
Object Name |
Navigation |
Usage |
RY_INSTANCE |
Marketing, Dialog Monitoring, Control Center, Maintain Dialog Servers |
Install Standalone Dialog Server instances. |
Access the Maintain Dialog Servers page.
Server Name |
The name of the Process Scheduler running the instance. |
Instance Type |
The type of this particular instance: Mail Service, E-mail Response Processor, or WatchDog. |
Service Type |
The service type of this particular instance: For Mail Service, choices are Frequency Emailer, Mailcaster, or Single Emailer; for E-mail Response Processor, choices are Bounce Process or Reply Process. There are no choices for WatchDog. |
Instance |
The number of the specified instance. |
Server Status |
The current status of the server. Status values are Running and Stopped. |
Request Status |
The current status of the request. Values are:
|
Start, Stop |
Click Start to start an instance that is not currently running, or click Stop to stop a running instance. |
Instance Start Time |
The time at which the instance was started. |
Instance Last Update Time |
The time at which the instance's status was last changed. |
Host Name/Port Number |
The host name and port number of the machine running the instance. |
IP Address |
The IP address of the machine running the instance. |
Create a New Instance |
Click this button to create a new instance. |
Refresh |
Click this button to refresh the view. |
Note. You must click the Save button after specifying the new Instance required data, or click the Start or Stop button.