Siebel Server Sync Guide > Administering Siebel Server Sync > Process of Configuring Email Notification of Synchronization Errors >

Configuring System Alerts for Email Notification of PIMSI Engine Synchronization Errors


You can configure SSSE so that the administrator receives email notification of errors generated by the PIMSI Engine during the inbound synchronization process.

To enable email notification of PIMSI Engine errors, you must create a system alert, then define the email body template to be used for error notification messages; this topic describes both of these tasks. This topic also includes an example of defining an email template for PIMSI Engine synchronization errors for the Task domain.

This task is a step in Process of Configuring Email Notification of Synchronization Errors.

To enable email notification of PIMSI Engine errors, perform the following procedure.

To configure system alerts for PIMSI Engine synchronization errors

  1. Configure a system alert for the Siebel Enterprise as follows:
    1. Navigate to Administration - Server Configuration, Enterprises, and then System Alerts.
    2. In the System Alerts list, create a new system alert, specifying values similar to the following:
      Alert Definition Name
      Alias
      Media

      Alertname

      Example: Administrator Email Alerts

      Alertalias

      Example: AdminEmailAlert

      EmailNotification

    3. In the Alert Parameters list, create the following alert parameters, and specify values for the parameters as described.
      Parameter Name
      Value

      SMTPServer

      SMTP server name or IP address through which the email is sent

      Example: mymailserver.company.com

      SMTPServerPort

      Port number of the SMTP server

      Example: 25

      AdminEmailAddress

      A comma delimited email address list of the administrators to be notified

      Example: ssseadmin@sdcexch02.siebel.com

      Fromaddress

      The originating address of the email notification

      Example: ssseadmin@sdcexch02.siebel.com

      DLLName

      ssemailntfy

  2. Define the email body template to be used for PIMSI Engine error notification emails as follows:
    1. Navigate to Administration - PIM Server Integration, Configuration, and then PIM Server Integration Configuration.
    2. Select the Exchange Calendar Profile.
    3. In the Configuration Parameters list, create records with values similar to the following:

      NOTE:  The Domain name you specify must match an existing Domain Identifier field, for example, IPM Task. To view domain identifiers, navigate to Administration - PIM Server Integration, and then PIM Domains.

      Section
      Parameter
      Value

      Email Template:Domain Name

      MsgBody1

      Specify the body of the email with place holders. The supported place holders are:

      • %Domain%. Name of the domain is substituted
      • %login%. Name of the login is substituted
      • %ErrorMessage%. Description of the error
      • [Field Identifier]. Substitutes the value of the Siebel domain field identifier in the parentheses.

        To view the Siebel domain field identifiers, navigate to Administration - PIM Server Integration, Siebel Domains, and then Siebel Domain Fields.

      Email Template:Domain Name

      MsgBody2

      This parameter allows you to add additional email body text, if required, to the supported place holders described above.

  3. To increase the maximum notification size to allow larger email messages, set the Notify Message size to 1024 as follows:
    1. Log in to Server Manager using a command such as the following:

    srvrmgr /u db_user_name /p db_password /e enterprise_server /g gateway_host
    /s server_name

    1. At the srvrmgr> prompt, enter the following command:

    change param NOTIFYMSGSIZE=1024 for server servername

    For information on the Server Manager program, see Siebel System Administration Guide.

    NOTE:  If you do not increase the message size, the system sends a shorter message with fewer details.

For an example of defining an email template for PIMSI Engine synchronization errors for the Task domain, see Example of Defining an Email Body Template for Synchronization Error Notifications.

Example of Defining an Email Body Template for Synchronization Error Notifications

This topic gives one example of defining an email body template for PIMSI Engine synchronization error notifications. You may use this feature differently, depending on your business model.

In the following procedure, an email body template is configured for the Task domain.

To define an email body template for the Task domain

  1. Navigate to Administration - PIM Server Integration, Configuration, and then PIM Server Integration Configuration.
  2. Select the Exchange Calendar Profile.
  3. In the Configuration Parameters list, create records with values similar to the following:
    Section
    Parameter
    Value

    Email Template:IPM.Task

    MsgBody1

    \n SSSE fails to synchronize %Domain% record for the sync enabled user %login%
    \n The record has the following characteristics

    \n Subject: [Subject]
    Start Date: [StartDate]
    End Date: [EndDate]
    \n The error

    NOTE:  The characters \n indicate the start of a new line.

    Email Template:IPM.Task

    MsgBody2

    Message was %ErrorMessage%

Assume the following values exist for the placeholders used in the message body of the email template defined in this example:

  • Domain = IPM.Task
  • Login = GABBO
  • Subject = Meeting in the month of March
  • Start Date = 3/3/2008
  • End Date= 3/5/2008
  • Error Message = One or more required fields are missing.

Then the email message received by the administrator when a synchronization error occurs in the Task domain will read as follows:

SSSE fails to synchronize IPM.Task record for the sync enabled user GABBO
The record has the following characteristics:
Subject: Meeting in the month of March
Start Date: 3/3/2008
End Date: 3/5/2008
The error Message was: One or more required fields are missing.

Siebel Server Sync Guide