6Administering Siebel Server Sync for Microsoft Exchange Server
Administering Siebel Server Sync for Microsoft Exchange Server
This chapter provides information about administering SSSE. It includes the following topics:
Process of Configuring Siebel and PIM Domain Characteristics
Implementing Import-Only Synchronization of Calendar Records
About Setting Calendar and Task Record Synchronization Options
Implementing Opt-In Synchronization for Calendar and Task Records
Skipping Private Calendar or Task Records During Synchronization
Process of Configuring Email Notification of Synchronization Errors
About Administering SSSE
This chapter provides information about the following aspects of administering SSSE:
Setting Siebel and PIM domain properties
Mapping Siebel and PIM domain fields to each other
Mapping Siebel users and PIM users to each other
Setting access levels
Setting initial extract start dates for users
Enabling inbound activity filtering
Maintaining files
Using logs
Moving or deleting Microsoft Exchange mailboxes of SSSE users
Many settings related to domains and mappings are preconfigured in SSSE; you do not have to perform some tasks unless you want to change the default settings. However, you must set user access permissions. All tasks in this chapter are performed from the Administration - PIM Server Integration screen of the Siebel application.
About SSSE Domains
This topic describes the Siebel and PIM domains supported by SSSE. The mapping of a Siebel domain to a PIM domain (such as a Microsoft Exchange Server domain) allows SSSE to synchronize data in these two domains. The supported SSSE domain maps specify how each Siebel and PIM field in a domain is mapped.
The following table shows the SSSE supported Siebel domains, PIM domains, and domain maps. The Siebel domains synchronize Siebel data with Microsoft Exchange Server data. The PIM domains synchronize Microsoft Exchange data with the Siebel database. The current version of SSSE does not support the creation of new Siebel domains.
Domain Map Name | Siebel Domain Name | PIM Domain Name |
---|---|---|
Siebel-Exchange Business Contact Map |
Siebel Business Contact |
Exchange Contact |
Siebel-Exchange Calendar Map |
Siebel Calendar |
Exchange Calendar |
Siebel-Exchange Task Map |
Siebel Task |
Exchange Task |
Changing SSSE Default Values For Synchronization Conflicts
If data in Siebel Business Applications and Microsoft Exchange Server has been modified in such a way that SSSE cannot synchronize the differences, then SSSE resolves the conflict by using the Siebel data.
An example of a synchronization conflict is where the status of a Microsoft Exchange task is set to a value that differs from the value of the corresponding Siebel task item. If the status is updated at approximately the same time, thereby falling within the same synchronization cycle, then SSSE has no way to determine which update has to be applied, and automatically preserves the Siebel data which is synchronized to Microsoft Exchange.
You can change the default behavior of SSSE so that when synchronization conflicts occur,SSSE resolves the conflicts by preserving the Microsoft Exchange data instead of the Siebel data, and synchronizes this data to Siebel CRM. To configure SSSE to use Microsoft Exchange data by default when synchronization conflicts occur, perform the steps in the following procedure.
To change SSSE default values for synchronization conflicts
Log in to your Siebel application as the Siebel administrator.
Navigate to the Administration - Data screen, then the List of Values view.
In the Type field, query for the PIMSI_CONFLICT_WINNER LOV.
Change the value of the Display Value field to PIM Record.
Process of Configuring Siebel and PIM Domain Characteristics
You must set certain characteristics for the Siebel and PIM domains defined for SSSE, for example, you must set the synchronization level for the domain, designate required fields, and specify whether or not record deletions are allowed for the domain.
To configure the Siebel and PIM domains, perform the following tasks:
After the characteristics of Siebel domains and PIM domains are established, you can map domain fields and set field-level synchronization. For information on these tasks, see Mapping Siebel Domain and PIM Domain Fields.
Setting Siebel Domain-Level Synchronization
Domain-level synchronization establishes the highest allowable synchronization setting for all users and groups on the domain. You must set user-level and group-level synchronization to values that are equal to or lower than the domain-level synchronization.
This task is a step in Process of Configuring Siebel and PIM Domain Characteristics.
The following procedure describes how to set domain synchronization.
To set domain synchronization
Navigate to the Administration - PIM Server Integration screen, then the Siebel Domains view.
In the Siebel Domains list, select a record.
In the Domain Sync Support field, select a synchronization level for the domain.
In the topic SSSE Synchronization Options, the first table describes the synchronization levels available for Siebel domains and the second table lists the default synchronization levels for each domain.
Repeat Step 2 and Step 3 for each Siebel domain.
About the Limitation Against Import Only Synchronization Level
You can configure SSSE to allow one-way synchronization of calendar records, from Microsoft Exchange to Siebel Business Applications. For information on configuring import-only synchronization for calendar items, see Implementing Import-Only Synchronization of Calendar Records.
The Import Only synchronization level is not supported for any of the other Siebel domains. The reason for this limitation is that there are potential data integrity problems if data is imported only from Microsoft Exchange to your Siebel application.
This hazard to data integrity arises from the different methods the two systems use to store data. Siebel Business Applications use a relational database, but Exchange Servers maintain data using an individual data store for each Microsoft Exchange user.
As an example of the kind of issue that could arise, a business contact record in a Siebel application can be shared between multiple people in a team. Any update that one user makes to the business contact record in Siebel Business Applications is immediately visible to other users, because all users are accessing a single record in the relational database. However, in Microsoft Exchange, each user has his or her own set of contact records. An update made to one user’s contact record is not reflected in other users’ contact information. If data was only imported from Microsoft Exchange into your Siebel application, then an update made by one user could be lost when another user makes a conflicting update. The following paragraphs describe in more detail how an example business contact record would be handled for different synchronization levels:
When the synchronization level is set to Full Sync, if someone changes synchronized data in either Siebel Business Applications or Microsoft Exchange, then that change is reflected for other users in both applications. For example, one member of a sales team might learn that a business contact’s phone number has changed. All members of the team would soon see the new phone number in both Siebel Business Applications and Microsoft Exchange, regardless of where the change was made. Within a short period of time after a data change occurs, all users are working from the same updated data.
When the synchronization level is set to Export Only, a Siebel data change is reflected for other users in both Siebel Business Applications and Microsoft Exchange, but changes made in Microsoft Exchange are visible only to the user who made the change, until such time as a later data change in Siebel Business Applications overwrites the data in Microsoft Exchange. So, a business contact phone number changed in Siebel Business Applications is visible to all team members, in both applications. However, a phone number changed in Microsoft Exchange is visible only to the team member who changed it, and only until the next synchronization overwrites it with the value from the Siebel database. Again, within a short period of time after a data change occurs, all users are working from the same updated data.
Setting PIM Category Values for Siebel Domains
For each Siebel domain, you can specify a value that a Microsoft Exchange record’s Category field value must match, in order for SSSE to synchronize the record.
This task is a step in Process of Configuring Siebel and PIM Domain Characteristics.
The following procedure describes how to set the PIM Category Value for a domain.
To set the PIM Category Value for a domain
Navigate to the Administration - PIM Server Integration screen, then the Siebel Domains view.
In the Siebel Domains list, select a record.
In the PIM Category Value field, enter the value you want to match against the Category field in Microsoft Exchange records.
Repeat Step 2 and Step 3 for additional domains, as required.
Enabling and Disabling Contact Record Matching
This topic describes how to configure the IgnoreContactMatching parameter, which allows you to enable or disable contact record matching during the SSSE synchronization process.
This task is a step in Process of Configuring Siebel and PIM Domain Characteristics.
Setting the IgnoreContactMatching parameter to FALSE (the default value) enables contact record matching. When contact matching is enabled, SSSE attempts to match a contact record that is being synchronized with existing contact records, and only creates a new contact record if a match is not found.
Setting the IgnoreContactMatching parameter to TRUE disables contact record matching. When contact matching is disabled, SSSE does not check if an existing record matches the synchronized contact record; instead, a new contact record is always created. Disabling contact record matching optimizes the performance of the synchronization process but can result in duplicate contact records being created, which must be resolved manually. For additional information on the IgnoreContactMatching parameter, see About the IgnoreContactMatching Parameter.
The following procedure describes how to enable or disable contact record matching.
To enable or disable contact record matching
Log in to your Siebel application as an administrator and navigate to the Administration - PIM Server Integration screen, then the Configuration view.
Select the Siebel profile.
In the Configuration Parameters list, create a record with the values shown in the following table:
Section Parameter Value Siebel
IgnoreContactMatching
TRUE or FALSE
Setting Required Siebel Domain Fields and Defaults
You can set which Siebel domain fields require a value, and must specify a default value for each required field.
When a user creates a new contact, appointment, or to do record in Siebel Business Applications, the application cannot save the record until all required fields have a value. Similarly, if a user creates a new Microsoft Exchange contact or task record, thenSSSE synchronizes the record only if either the administrator has specified a default value to use when the field is empty, or if the Microsoft Exchange record includes values to synchronize with all Siebel fields that require them.
This task is a step in Process of Configuring Siebel and PIM Domain Characteristics.
The following procedure describes how to specify that a field requires a value, and how to provide a default value for that field.
To set required Siebel domain fields and defaults
Navigate to the Administration - PIM Server Integration screen, then the Siebel Domains view.
In the Siebel Domains list, select the domain for which you want to set required fields.
In the Siebel Domain Fields list, select the field you want to make required.
Select the Required check box.
Note: If Required field is not visible, then to make it visible click Menu and choose Columns Displayed.In the Default Value field, enter the value you want to use as the default value.
Setting Required PIM Domain Fields and Defaults
You can set which PIM domain fields require a value, and must specify a default value for each required field.
When the user creates a new contact, appointment, or to do record in Siebel Business Applications, synchronizes the record with the Exchange Server only if either the administrator has specified a default value to use when the field is empty, or if the Siebel record includes values to synchronize with all Microsoft Exchange fields that require them.
This task is a step in Process of Configuring Siebel and PIM Domain Characteristics.
The following procedure describes how to specify that a PIM field requires a value, and how to provide a default value for that field.
To set required PIM domain fields and defaults
Navigate to the Administration - PIM Server Integration screen, then the PIM Domains view.
In the PIM Domains list, select the domain for which you want to set required fields.
In the PIM Domain Fields list, select the field you want to make required.
Select the Required check box.
Note: If Required field is not visible, then to make it visible click Menu and choose Columns Displayed.In the Default Value field, enter the value you want to use as the default value.
If the Default Value field contains the value Not Set, then the user must enter a string value; no default value is established.
About Allowing or Preventing Record Deletions for a Domain
SSSE includes a setting called Allow Record Deletions for each Siebel domain and each PIM domain. The basic purpose of this setting is to let the administrator govern whether delete operations in one domain will affect the corresponding record in the domain to which it synchronizes. Specifically, the value of the Allow Record Deletions setting affects what happens in the following situations:
What happens to a record in the selected Siebel domain when a corresponding Microsoft Exchange record is deleted.
What happens to corresponding Siebel and Microsoft Exchange records when a user is removed from the Siebel record’s Sync List.
What happens to a PIM record when a corresponding Siebel record is deleted.
The following additional factors can also affect what happens in each of these situations:
Which domain the record belongs to (behavior varies by domain)
The value of the Enable Inbound Activity Filter parameter
The value of the PIM Domain Category Field setting
The removal of a single occurrence of a recurring calendar item is not considered a delete operation and is not affected by the status of the Allow Record Deletions setting. That is, if you delete a single occurrence of a recurring Siebel appointment, then the corresponding occurrence is deleted in Microsoft Exchange at the next synchronization. Similarly, if you delete a single occurrence of a recurring Microsoft Exchange appointment, then the corresponding occurrence is deleted in the Siebel database at the next synchronization.
For information about how the Allow Record Deletions setting affects the Business Contacts domain, see the following table. For information about how the Allow Record Deletions setting affects the Calendar and Tasks domains, see the second table in this topic. For more information on how to specify the Allow Record Deletions setting, see Allowing or Preventing Record Deletions.
Allow Record Deletion Selected? | Delete Operation Originated From | Destination System Behavior | Behavior After Future Record Modification |
---|---|---|---|
Yes |
Siebel |
PIM record is deleted. |
Not applicable |
Yes |
PIM |
User is removed from Sync List for Siebel business contacts record. |
Not applicable |
No |
Siebel |
The value in the Category field of the PIM record is deleted, but the rest of the record is not changed. |
If the PIM record is modified but the Category field remains empty, then the changes are not synchronized. If the PIM record is modified and the Category field is set to a valid value (such as Siebel Contact), then the record is synchronized in such a way that a new record is created in the Siebel database. |
No |
PIM |
For Business Contacts,SSSE deletes its internal mapping between the PIM record and the Siebel record, but the Siebel record is not physically deleted. For domains where synchronization is configured to be bidirectional, the user is removed from the Siebel record’s Sync List. |
For domains where synchronization is configured to be bidirectional, future modifications to the Siebel record are not synchronized for the relevant user unless the user adds himself or herself to the record’s Sync List again. This corresponds to the behavior of previous versions of SSSE. |
The following table shows how the Allow Record Deletions setting affects the Calendar and Tasks domains.
Allow Record Deletion Selected? | Delete Operation Originated From | Inbound Activity Filtering Enabled? | PIM Domain Category Field Status | Destination System Behavior | Behavior After Future Record Modification |
---|---|---|---|---|---|
Yes |
Siebel |
Not applicable |
Not applicable |
Record is physically deleted from PIM. |
No future modification is possible, since both PIM and Siebel records are deleted. |
Yes |
PIM |
Not applicable |
Not applicable |
Record is physically deleted from the Siebel database. |
No future modification is possible, since both PIM and Siebel records are deleted. |
No |
PIM |
Not applicable |
Not applicable |
The Siebel record is not deleted.SSSE deletes its internal mapping between the PIM record and the Siebel record. |
SSSE treats modification of the remaining Siebel record as if it were a new record. This causes the creation of a corresponding PIM record at the next synchronization. |
No |
Siebel |
Yes |
Field is specified (required when inbound activity filtering is enabled) |
The PIM record is not deleted, but its Category field is cleared.SSSE deletes its internal mapping between the PIM record and the Siebel record. |
SSSE treats modification of the remaining PIM record as if it were a new record. Whether or not the modified record synchronizes to Siebel depends on whether the Category field value is acceptable to Inbound Activity Filtering. |
No |
Siebel |
Yes |
Field is not specified (invalid when inbound activity filtering is enabled) |
The PIM record is preserved unchanged.SSSE deletes its internal mapping between the PIM record and the Siebel record. An error message is logged. |
SSSE treats modification of the remaining PIM record as if it were a new record. Whether or not the modified record synchronizes to Siebel depends on whether the Category field value is acceptable to Inbound Activity Filtering. |
No |
Siebel |
No |
Not applicable |
The PIM record is preserved unchanged.SSSE deletes its internal mapping between the PIM record and the Siebel record. |
SSSE treats modification of the remaining PIM record as if it were a new record. This causes the creation of a corresponding Siebel record at the next synchronization. |
Allowing or Preventing Record Deletions
The administrator determines whether or not the act of deleting a record in one domain will delete the corresponding record in the domain to which it synchronizes. For detailed information about this feature, including information about how Sync Lists are affected, see About Allowing or Preventing Record Deletions for a Domain.
This task is a step in Process of Configuring Siebel and PIM Domain Characteristics.The following procedure describes how to set the Allow Record Deletions setting for Siebel domains.
To set Allow Record Deletions for a Siebel domain
Navigate to the Administration - PIM Server Integration screen, then the Siebel Domains view.
In the Siebel Domains list, select one of the following domains:
Siebel Business Contact
Siebel Calendar
Siebel Task
In the Allow Record Deletions field, select or clear the check box as follows:
To allow deletion of a PIM record to cause deletion of the corresponding Siebel record, select the check box.
To prevent deletion of a PIM record from causing deletion of the corresponding Siebel Record, clear the check box.
Repeat Step 2 and Step 3 as required for other Siebel domains.
This change takes effect after you restart the Siebel Server.
The following procedure describes how to set the Allow Record Deletions setting for PIM domains.
To set Allow Record Deletions for a PIM domain
Navigate to the Administration - PIM Server Integration screen, then the PIM Domains view.
In the PIM Domains list, select one of the following domains:
Exchange Calendar
Exchange Contact
Exchange Task
In the Allow Record Deletions field, select or clear the check box as follows:
To allow deletion of a Siebel record to cause deletion of the corresponding PIM record, select the check box.
To prevent deletion of a Siebel record from causing deletion of the corresponding PIM Record, clear the check box.
Repeat Step 2 and Step 3 as required for other PIM domains.
This change takes effect after you restart the Siebel Server.
Mapping Siebel Domain and PIM Domain Fields
The mapping of PIM domains and Siebel domains is preestablished inSSSE and must not be modified. You can, however, configure the mapping of domain fields, set the synchronization level for each mapped field, and specify key fields, which are used to determine if records in the PIM and the Siebel application are the same record. For information on these tasks, see the following topics:
Creating Field Mappings
Administrators can map individual fields between the Siebel and PIM domains. This mapping determines the fields in Siebel Business Applications and Microsoft Exchange Server that are mapped to each other.
Administrators can turn synchronization on or off for each individual mapped field.
The following procedure describes how to create a field mapping.
To create a new field mapping
Navigate to the Administration - PIM Server Integration screen, then the Domain Map view.
In the Domain Map list, select a record.
In the Field Map list, click New, and then fill in the fields for the new record using the following values.
Field | Description |
---|---|
Siebel Field |
Select a Siebel field. |
PIM Field |
Select a PIM field. |
LOV Translation Map |
Select an appropriate List of Values (LOV) translation map. |
Key Field |
Select this check box if you want this field to be a key field. See Setting Key Fields. |
Sync Enabled |
Select this check box if you want this field synchronized. For more information about synchronizing specific fields, see Setting Field-Level Synchronization. |
Related Topics
Mapping Siebel Domain and PIM Domain Fields
Setting Field-Level Synchronization
You can turn synchronization on or off for each individual mapped field by following the procedure in this topic. You do not have to delete field mappings to disable synchronization.
To enable or disable field synchronization
Navigate to the Administration - PIM Server Integration screen, then the Domain Map view.
In the Domain Map list, select a record.
In the Field Map list, select a record.
Select the Sync Enabled check box if you want synchronization enabled for this field. Clear the check box if you want synchronization disabled.
Related Topics
Setting Key Fields
The first timeSSSE synchronizes a particular record,SSSE uses Key fields to determine if a calendar or to do activity record in Siebel Business Applications is the same record as a record in Microsoft Exchange Server. If the values in all key fields of a record match, thenSSSE assumes that the record is the same record, andSSSE synchronizes the record. If all key fields do not match, thenSSSE assumes the record is a unique record.
SSSE does not use key fields to determine whether or not contact records match. For information on how SSSE matches contact records, see About SSSE Contact Record Matching.
The following procedure describes how to set key fields.
To set key fields
Navigate to the Administration - PIM Server Integration screen, then the Domain Map view.
In the Domain Map list, select a record.
In the Field Map list, select a record.
Select the Key Field check box.
Related Topics
Process of Setting SSSE Group and User Access Controls
To allow users to synchronize between Microsoft Exchange Server and Siebel Business Applications, you must map each PIM user to a Siebel user login, and then enable synchronization for the user. Optionally, you can set a synchronization level for each of a user’s Siebel domains (Business Contact or Task). If you do not set the synchronization level for a user, thenSSSE uses the domain synchronization level.
You can also set the synchronization level for a group. A group is any Organization, Position, or User List defined in Siebel Business Applications.
To set SSSE group and user access controls, perform the following tasks:
Setting User-Level Synchronization
User-level synchronization allows you to set the synchronization level separately for each of a user’s Siebel domains except Calendar (Business Contact or Task). You can also use user-level synchronization to give a particular user a different synchronization level from other users.
You cannot set user-level synchronization higher than domain-level synchronization. For example, the user cannot have Full Sync privileges if the overall domain is limited to Export Only. If the domain-level synchronization is set to None, then no users or groups are able to synchronize on that domain.
No user-level synchronization control is available for the Calendar domain. The administrator sets calendar synchronization at the domain level.
This task is a step in Process of Setting SSSE Group and User Access Controls.
In addition to setting each user’s synchronization level, you must enable each user’s synchronization or SSSE cannot synchronize records for that user. For more information about enabling synchronization, see Enabling or Disabling User Synchronization.
The following procedure describes how to set user-level synchronization.
To set user-level synchronization
Navigate to the Administration - PIM Server Integration screen, Sync Access Control, and then the User Level Access Control view.
In the User Level Access Control list, select a record for a particular user.
In the User-Level Access Control list (lower list), click New, and then fill in the fields as shown in the following table.
Field Description Siebel Domain Name
Select Siebel Business Contact or Siebel Task.
Administrator Override
When selected, user-level synchronization is preserved and used for the selected user, even if that user belongs to a group for which an administrator has set a different group synchronization level. Selected by default. It is recommended that you leave this setting as is. For more information about group synchronization levels, see Setting Group-Level Synchronization.
Admin Sync Level
Select Full Sync, Export Only, or None. This sets the maximum synchronization level that can be set for this user and domain.
Allow User Customization
Leave check box cleared. User customization of the synchronization level is not supported in this release of SSSE.
Allow MVG Creation
Select the check box (On).
Visibility Type
Determines whether the data that the user can synchronize is limited to records visible in specified views. The available values for each domain are as follows:
Business Contact Domain. Available Visibility values are All, Sales Rep, or no value (empty). Default value is Sales Rep.
Tasks Domain. Available Visibility values are Personal or no value (empty). Default value is Personal.
For information about the meanings of these Visibility values, see the following table.
Repeat Step 3 for each additional domain where you want to specify user-level access for the selected user.
The following table describes the values you can specify for the Visibility Type field.
Visibility Value Description All
The user can synchronize any of the data that is visible to them in the selected domain and that is set up for synchronization by the Administrator. This Visibility value is available for the Business Contact domain.
Sales Rep
The user can synchronize data in the selected domain based on his or her position. If the data is associated with the user’s position or with a direct report’s position, then the data is visible to the user in the Contacts view, and the user can synchronize that data. For example, if the Sales Team field for a contact record lists anyone who has the same position as the user or one of the user’s direct reports, then the data in that contact record is visible to the user in the My Contacts view. This Visibility value is available for the Business Contacts domain only.
Personal
The user is limited to synchronizing data in the selected Domain that is specifically marked as personal (non-business) data. No other user can view this data, regardless of position. This Visibility value is available for the Task domain only. Data to be synchronized must appear in the user’s My Activities view and must have the Private check box selected. Personal visibility is also appropriate for the Calendar domain, where an administrator must set the synchronization level settings at the domain level, rather than the user level.
Note: The Personal value cannot be used for the Business Contacts domain.(Empty field)
If the Visibility Type field is left blank, then SSSE uses the default Visibility Type for the selected domain.
Related Topics
Setting Group-Level Synchronization
In addition to the ability to set synchronization level by individual user, you can set synchronization level for a group of users. A group is any Organization, Position, or User List defined in Siebel Business Applications.
Group synchronization is a mechanism for setting the user synchronization level for multiple users. After you set synchronization values for the group,SSSE propagates the values to the members of the group, thereby setting the individual user’s synchronization values.
Make sure that the user’s synchronization is enabled or that user cannot synchronize, regardless of the group synchronization level that is set. For more information about enabling synchronization, see Enabling or Disabling User Synchronization.
This task is a step in Process of Setting SSSE Group and User Access Controls.
The following procedure describes how to set group-level synchronization.
To set group-level synchronization
Navigate to the Administration - PIM Server Integration screen, Sync Access Control, and then the Group Access Control view.
In the User Group Access Control list, click New, and then fill in the fields as shown in the following table.
Field Description Party Name
Select the name of a party.
Party Type Code
Automatically set to the correct value.
Siebel Domain Name
Select Siebel Business Contact or Siebel Task.
Admin Sync Level
Select Full Sync, Export Only, or None. This sets the Admin Sync Level for each user in the group.
Allow MVG Creation
Select the check box (On).
Allow User Customization
Leave check box cleared. User customization of the synchronization level is not supported in this release of SSSE.
Status
Is automatically set to Pending, which means that the changes are pending propagation to the users in the group.
Click the Propagate Changes button.
The group settings are propagated to each user who is a member of the group. This overwrites any user settings that might already exist, provided that Administrator Override is not selected for those users. The Status field is cleared, indicating that the changes were successfully propagated.
Mapping Individual Users
To allow synchronization between Siebel Business Applications and a PIM, you must map each Siebel user to a PIM user, and then enable synchronization for the user as described in the following procedure.
This task is a step in Process of Setting SSSE Group and User Access Controls.
To map a Siebel user to a PIM user
Navigate to the Administration - PIM Server Integration screen, Sync Access Control, and then the User Map view.
In the User Map list, click New, and then fill in the fields as shown in the following table.
Field Description Siebel User Login
Enter the user’s Siebel application login.
PIM User Identifier
Enter the user’s Microsoft Exchange Server email address. This entry is in the form user@company.xxx (Example: jbrown@example.com).
Note: This value must also match the email address in the user’s Siebel employee record, with the case matching exactly.PIM Server Type
Select Exchange 2000/2003.
Language
Select a language.
Sync Enabled
Select this check box to enable synchronization for this user.
Mapping Multiple Users
SSSE provides an automated method for mapping multiple users to allow synchronization between Siebel Business Applications and Microsoft Exchange Server. You can use this method to map all employees in a Siebel deployment, for example, or any subset of employees that you can specify by using a predefined query. The Map User button finds and maps Siebel user login names to Exchange email addresses. After you map the users, you must enable synchronization for each user.
This task is a step in Process of Setting SSSE Group and User Access Controls.
The following procedure describes how to map multiple users.
To map multiple users
If you want to map a subset of your deployment’s users, then create a predefined query to specify the users you want to map.
For example, you could create a predefined query that finds all employees in the Sales department in the UK region. For information about creating predefined queries, see Siebel Fundamentals.
If you want to map all of your users, then skip to Step 2 in this procedure.
Navigate to the Administration - PIM Server Integration screen, Sync Access Control, and then the User Map view.
In the User Map list, click Map User.
The PIM Server Integration User Map dialog box appears.
Fill in the fields as shown in the following table, and then click Map Users.
Field Value Business Object Name
Select a business object. (Example: Employee).
Business Object Component
Select a business component. (Example: Employee).
PIM Login Field Name
Email Addr.
Siebel Login Field Name
Login Name.
PIM Server Type
Exchange 2000/2003.
Default Language
Select a language. (Example: English-American).
Predefined Query
Select a predefined query that specifies the set of users whom you want to map. If you want to map all users in the business object, then leave this field blank.
The mapped users appear in the User Map list.
Note: If there are many users, then this process can take some time.From the Edit menu, choose Select All.
From the Edit menu, choose Change Records.
Under 1st Field to Change, in the field called Field, select Sync Enabled.
Under 1st Field to Change, in the Value field, type Y, and then click OK.
The Sync Enabled check box is selected for all of the highlighted records.
Enabling or Disabling User Synchronization
The administrator can enable or disable synchronization for each user individually as described in the following procedure.
This task is a step in Process of Setting SSSE Group and User Access Controls.
To enable or disable user synchronization
Navigate to the Administration - PIM Server Integration screen, Sync Access Control, and then the User Map view.
In the User Map list, select a record.
Select the Sync Enabled check box to enable synchronization for this user. Clear the check box to disable synchronization.
Setting Extract Start Dates for Users
During the initial extract process when Siebel data and Microsoft Exchange Server data for a user is first synchronized, the value of the Extract Start Date parameter determines the date of the oldest appointments and tasks that SSSE synchronizes. The administrator can specify:
An extract start date for an individual user
A system-wide extract start date that applies to all users for whom individual extract start dates are not specified
If you do not specify a system-wide or an individual extract start date, then all of a user’s records are synchronized during the initial extract process.
About the System-Wide Extract Start Date
The system-wide Extract Start Date and Extract Start Date Format parameters are set and amended using Server Manager. For further information, see Modifying Enterprise and Server Component Parameters.
Setting the Extract Start Date for Individual Users
The following procedure describes how to set extract start dates for individual users.
To specify the initial extract start date for an individual user
Navigate to the Administration - PIM Server Integration screen, Sync Access Control, and then the User Map view.
In the User Map list, select a user record.
In the Extract Start Date field, select the date of the oldest appointments and tasks that SSSE is to synchronize.
Implementing Import-Only Synchronization of Calendar Records
This topic describes how to configure SSSE so that only one-way synchronization of calendar items occurs—from Microsoft Exchange to Siebel Business Applications. Calendar items created by a user in Microsoft Outlook are synchronized with Siebel Business Applications, but changes made to the items in the Siebel application are not synchronized back to the user’s Microsoft Outlook calendar.
Follow the procedure below to configure import-only synchronization of calendar items.
To enable import-only synchronization for the Calendar domain
Specify the Full Sync option for the Siebel Calendar domain, as described in Setting Siebel Domain-Level Synchronization.
Navigate to the Administration - PIM Server Integration screen, then the Configuration view.
Select the Siebel profile.
In the Configuration Parameters applet, create a record with the values shown in the following table.
Section Parameter Value Siebel
InboundCalendarOnly
Y
About Setting Calendar and Task Record Synchronization Options
If you enable the Full Sync synchronization option for the Siebel calendar and task domains, thenSSSE automatically synchronizes all new or changed calendar and to do activity records for each user. The following options, however, provide some flexibility in determining whether or not Microsoft Outlook calendar and task records are synchronized with the Siebel application:
Enabling inbound activity filtering. If you enable this option, then SSSE synchronizes only calendar or task records originating in Microsoft Outlook that the user designates for synchronization by placing an appropriate value in a designated Microsoft Exchange field.
Opt-in option. If you enable this option, then SSSE synchronizes only calendar or task records originating in Microsoft Outlook that the user designates for synchronization by placing a defined value in the Category field.
Note: With the Opt-in feature, only a single value is used for filtering inbound calendar and task records. With the inbound activity filtering feature, a number of values can be configured for filtering inbound records.Ignore private records option. If you enable this option, then SSSE does not synchronize any calendar or task records in Microsoft Outlook that have the Private check box selected.
In general, if individuals use the Siebel application to book meetings for other users, or to invite others to meetings, then it is recommended that you implement the Full Sync option without enabling the Opt-in or Ignore private records options, and without enabling inbound activity filtering. For example, in a scenario where call center agents schedule meetings for field sales representatives, it is important that all of an individual sales representative’s appointments (personal and business-related) are synchronized with Siebel Business Applications so that the call center agent is aware of when the sales representative is busy and when available.
If you implement the Full Sync option without enabling the Opt-in or Ignore private records options, and without enabling inbound activity filtering, then you can choose to mask the descriptions and comments associated with private Microsoft Outlook calendar or task records (that is, records that have the Private check box selected) with a configured value. For example, the description for all Microsoft Outlook appointments that have the Private check box selected can be configured to display as Private Appointment or Personal Task when the records are synchronized with Siebel Business Applications. To mask calendar or task record descriptions, create a user property for the relevant business component. For information on creating user properties, see Configuring Siebel Business Applications.
The following topics describe how to configure each of the options available when the Full Sync synchronization level is set for the Calendar and Task domains:
Implementing Opt-In Synchronization for Calendar and Task Records
This topic describes how to configure SSSE to allow users to select which Microsoft Outlook calendar or task records are synchronized with Siebel Business Applications when the Full Sync option is selected for the Siebel Calendar or Task domains.
If you implement the Opt-in feature, then all new or changed Siebel calendar or to-do records are synchronized with Microsoft Outlook, but only calendar and task records in Microsoft Outlook that the user designates for synchronization, by placing an appropriate value in the Category field, are synchronized with Siebel Business Applications. For additional information on designating calendar and task records for synchronization when the Opt-in feature is enabled, see Using Siebel Server Sync for Microsoft Exchange Server.
The following procedure describes how to implement Opt-in synchronization for Microsoft Outlook calendar and task records. You can choose to enable this feature for either calendar or task records, or for both types of records.
To enable opt-in synchronization for calendar or task records
Navigate to the Administration - PIM Server Integration screen, Configuration, and then the PIM Server Integration Configuration view.
Select the Siebel Calendar profile.
In the Configuration Parameters list, create a record with values similar to the following:
Section Parameter Value Calendar
Private Item Behavior
Opt-in
In the PIM Server Integration Configuration list, select the Siebel Task profile.
Repeat Step 3 but specify Task for the Section field.
Navigate to the Administration - Data screen, then the List of Values view.
Create four new records, using values similar to the following:
LOV Type Display Value Language-Independent Code PIMSI_CATEGORY_VALUE
Siebel Calendar
Siebel Calendar
PIMSI_CATEGORY_VALUE
Siebel Task
Siebel Task
TODO_TYPE
Siebel Calendar
Siebel Calendar
TODO_TYPE
Siebel Task
Siebel Task
Click the Clear Cache button.
Navigate to the Administration - PIM Server Integration screen, then the Siebel Domains view:
Select Siebel Calendar, and set the value of the PIM Category Value field to Siebel Calendar.
Select Siebel Task, and set the value of the PIM Category Value field to Siebel Task.
Select the PIM Domains tab:
Select the Exchange Calendar domain, and set the value of the Category Field to Category.
Select the Exchange Task domain, and set the value of the Category Field to Category.
Restart the Siebel Service.
To ensure that when Microsoft Outlook task records are synchronized with Siebel Business Applications they display in a user’s Siebel My To Do list, specify that the task record Display In value is changed to
To Do
andActivities
when the record is synchronized with Siebel Business Applications, by performing the following steps:Create the following business component user property for the Action business component.
Name Value On Field Update Set 2
"Type", "Display", "IIF(LookupValue('TODO_TYPE', 'Siebel Task')=[Type], LookupValue('ACTIVITY_DISPLAY_CODE', 'To Do and Activities'), [Display])"
where:
Siebel Task is the PIM Category Value you have specified for the Siebel Task domain.
For additional information on setting PIM Category values, see Setting PIM Category Values for Siebel Domains.
Recompile the Runtime Repository.
For additional information, see Configuring Siebel Business Applications.
Related Topic
About Setting Calendar and Task Record Synchronization Options
Skipping Private Calendar or Task Records During Synchronization
This topic describes how to configure SSSE so that Microsoft Outlook calendar or task records that have the Private check box selected are not synchronized with Siebel Business Applications when the Full Sync option is implemented for the Calendar or Task domains.
The following procedure describes how to configure SSSE so that all Microsoft Outlook records flagged as Private in the Calendar and Task domains are omitted during the synchronization process. You can choose to implement this option for either the Calendar or Task domain, or for both domains.
To skip private calendar or task records during synchronization
Navigate to the Administration - PIM Server Integration screen, Configuration, and then the PIM Server Integration Configuration view.
Select the Siebel Calendar profile.
In the Configuration Parameters list, create a record using values similar to the following:
Section Parameter Value Calendar
Private Item Behavior
Ignore
In the PIM Server Integration Configuration list, select the Siebel Task profile.
Repeat Step 3 but specify Task for the Section field.
In the PIM Server Integration Configuration list, select the Connector Profile.
In the Configuration Parameters list, create a new record for the Task and Calendar domains as appropriate, using values similar to those shown in the following table:
Section Parameter Value IPM.Task
Private Flag Value
2
IPM.Appointment
Private Flag Value
Private
Select the PIM Domains tab and perform the following steps:
For the Calendar Domain, select Exchange Calendar in the PIM Domains list, and set the value of Private Field to Private.
For the Task domain, select Exchange Task in the PIM Domains list, and set the value of Private Field to Private.
Restart the Siebel Service.
Related Topic
About Setting Calendar and Task Record Synchronization Options
Process of Enabling Inbound Activity Filtering
This topic describes how to enable inbound activity filtering. Inbound activity filtering allows SSSE users to select which calendar and task records to synchronize from Microsoft Exchange to Siebel Business Applications.
To enable inbound activity filtering, perform the following tasks:
Set the EnableInboundActivityFilter server component parameter to TRUE.
For information on the EnableInboundActivityFilter parameter, see Modifying Enterprise and Server Component Parameters.
For the Siebel Calendar and Siebel Task domains, set the default value of the Type field to Not Set, as described in Setting a Default Value for the Type Field.
(Optional) Setting Up Translation Mappings for Inbound Activity Filtering.
Select maps and set LOV values to determine the Microsoft Exchange fields SSSE uses to evaluate which Microsoft Exchange calendar and task records to synchronize with the Siebel database.
Setting a Default Value for the Type Field
To enable inbound activity filtering, you must set the default value of the Type field for the Siebel Calendar and Task domains to Not Set. The following procedure describes how to do this.
This task is a step in Process of Enabling Inbound Activity Filtering.
To set the default value of the Type domain field
Navigate to the Administration - PIM Server Integration screen, then the Siebel Domains view.
In the Siebel Domains list, select the Siebel Calendar record.
In the Siebel Domain Fields list, use standard query techniques to select the record with the Name field set to Type.
In the Default Value field, enter Not Set.
In the Siebel Domains list, select the Siebel task record.
In the Siebel Domain Fields list, use standard query techniques to select the record with the Name field set to Type.
In the Default Value field, enter Not Set.
Setting Up Translation Mappings for Inbound Activity Filtering
If you want your SSSE users to be able to select which calendar and task records to synchronize from Microsoft Exchange to Siebel Business Applications, then you can accomplish this by setting up inbound activity filtering with translation maps that specify which field and which field values to interpret as requests for synchronization. Users request record synchronization by entering one of the specified field values in the specified field in the record. The Exchange field that is inspected is whichever field you map to the Siebel Type field. By default, the Category field in Microsoft Exchange is the field that is mapped to the Siebel Type field.
This task is a step in Process of Enabling Inbound Activity Filtering.
The following procedure describes how to set up translation maps for inbound activity filtering.
To set up translation maps for inbound activity filtering
Navigate to the Administration - PIM Server Integration screen, then the Domain Map view.
In the Domain Map list, select Siebel-Exchange Calendar Map.
In the Field Map list, use standard query techniques to select the record in which Siebel Field has a value of Type.
In the selected record, set LOV Translation Map to Category to Activity Type.
Repeat Step 2 through Step 4, replacing Siebel-Exchange Calendar Map with Siebel-Exchange Task Map.
Navigate to the Administration - PIM Server Integration screen, Configuration, and then the LOV Translation view.
In the LOV Translation list, use standard query techniques to discover whether there is a record that has Name set to Category to Activity Type.
If the record exists, then modify it as required to match the information in the following table.
If the record does not exist, then click New and complete the fields as described in the following table.
Field Value Name
Category to Activity Type
Siebel LIC Type
TODO_TYPE
Siebel Value
Appointment
PIM LIC Type
IMMEDIATE
PIM Value
Specify the Exchange Category value that users will enter to indicate that the calendar or task record is to be synchronized from Microsoft Exchange to the Siebel database.
Siebel Default
Select the check box.
If you want additional Category values to indicate that the calendar or task record is to be synchronized, then repeat Step 7 as required, creating a new record and supplying a new PIM Value each time.
Related Topic
About Setting Calendar and Task Record Synchronization Options
About SSSE Table Maintenance
SSSE stores information about data changes to synchronize in the S_SD_SYNC_INFO table. This information is collected for all users, not just users for whom synchronization has been enabled. Therefore, this table can accumulate a large number of rows in a short time.
SSSE automatically removes rows that are associated with sync-enabled users (users who have synchronization enabled) from the S_SD_SYNC_INFO table when the applicable synchronization takes place.SSSE also automatically removes rows that are associated with users who have never synchronized, on a schedule that is determined by the configuration parameter DispGCCycleCount (Dispatcher Garbage Collection). For more information about setting the DispGCCycleCount configuration parameter, see Modifying Enterprise and Server Component Parameters.
Rows are preserved indefinitely for users who are not currently sync-enabled, but who have synchronized in the past. Preserving these rows allows for correct synchronization if synchronization is later reenabled for one of the users in question. However, if a large number of users have synchronization temporarily disabled, thenSSSE performance can decline as the size of the S_SD_SYNC_INFO table grows.
For best results, it is recommended that you minimize the number of users who have synchronization disabled after previously synchronizing.
If you want to enable synchronization for such users at a later time, then you must create a new User Map record for each such user. When you add a User Map record for a user and enable synchronization for that user again, SSSE automatically performs a new initial extract operation for that user. During this initial extract, Microsoft Exchange contact records are checked for duplication before being added as Siebel records. Microsoft Exchange calendar records are not checked for duplication, so a repeat of an initial extract for a given user is likely to result in duplicate Siebel calendar records. For more information about working with the User Map, see Mapping Individual Users.
About SSSE Log Files
Log files for SSSE reside in the siebsrvr\log
directory, along with log files for other Siebel software modules.
The amount of information that is logged can be tuned by adjusting log level settings. By default, multiple log files are created. For information about how to tune log levels or to consolidate log files, see Modifying SSSE Log File Settings.
The following information, which can be useful during troubleshooting, is logged for the Exchange Connector:
Exchange Connector successfully establishing a connection to the Microsoft Exchange Server
Exchange Connector processing domains for each user, including the number of records extracted for each domain for each user
Exchange Connector detecting a conflict
Other useful information that can be logged includes the following:
PIMSI Engine and PIMSI Dispatcher startup and shutdown information is captured in the log file whose name is of the form siebel.ComputerName.log, where ComputerName is the name of the computer where PIMSI Engine or PIMSI Dispatcher runs.
Several statements are typically logged regarding the beginning and ending of each extract session. This information is captured in log files that have names of the forms PIMSIEngxxxxx.log and PIMSIDispatcherxxxxx.log.
For examples of SSSE log messages, see the following table.
SSSE Event | Example of Log Message for Event |
---|---|
User Extract Session Start |
PIMSIEngSvc PIMSIInformational 3 0000000544a11a80:0 2006-06-27 04:56:10 (ssuserinit.cpp (3347)) BatchMgr: MADAMS: Starting extract for user. |
Extract data from Exchange Start |
PIMSIEngSvc PIMSIInformational 3 0000000544a11a80:0 2006-06-27 04:56:13 (exchangeconnector.cpp (830)) Connector: madams@esexch2.siebel.com: Extracting domain. PIM Domain Id = IPM.Contact. |
Extract data from Exchange End |
PIMSIEngSvc PIMSIInformational 3 0000000544a11a80:0 2006-06-27 04:56:16 (exchangeconnector.cpp (871)) Connector: madams@esexch2.siebel.com: Extracted 0 records. PIM Domain Id = IPM.Contact. |
Extract data from Siebel Start |
PIMSIEngSvc PIMSIInformational 3 0000000544a11a80:0 2006-06-27 04:56:16 (ssuserinit.cpp (4906)) BatchMgr: MADAMS: Starting extraction for Siebel Domain PIMSI Intermediate Business Contact. |
Extract data from Siebel End |
PIMSIEngSvc PIMSIInformational 3 0000000544a11a80:0 2006-06-27 04:56:17 (ssuserinit.cpp (4958)) BatchMgr: MADAMS: Extracted 0 records for Siebel domain PIMSI Intermediate Business Contact. |
Import an Exchange record to Siebel |
PIMSIEngSvc PIMSIDebug 5 0000003744a11a80:0 2006-06-27 06:47:29 (ssuserinit.cpp (1545)) BatchMgr: MADAMS: Pushed row: RowID=05349df89d16844da90998f8cdaedf54000000234ca3, User=madams@esexch2.siebel.com, Domain=IPM.Appointment. |
Export a Siebel record to Exchange |
PIMSIEngSvc PIMSIDebug 5 0000004344a11a80:0 2006-06-27 07:14:31 (ssuserinit.cpp (803)) BatchMgr: RBROWN: Pushed row: RowID=42-5HDSZ, User=RBROWN, Domain=PIMSI Intermediate Business Contact. |
User Extract Session End |
PIMSIEngSvc PIMSIInformational 3 0000004344a11a80:0 2006-06-27 07:15:34 (ssuserinit.cpp (3604)) BatchMgr: RBROWN: Successfully extracted domain All Domains for user RBROWN. |
For information on the SSSE error messages that can occur when a user’s data is synchronized, see Synchronization Error Messages.
About Moving or Deleting Mailboxes for SSSE Users
From time to time, you might have to move users’ Microsoft Exchange mailboxes from one Microsoft Exchange Server to another, or you might have to delete a user’s Microsoft Exchange mailbox.
When you move users’ Microsoft Exchange mailboxes from one Microsoft Exchange Server to another, SSSE automatically detects that the user has been moved to a new Exchange server and no additional steps are required for SSSE to continue to sync the user.
When you delete a user from Exchange, you must also disable that user for synchronization within Siebel CRM.
Skipping Records That Generate Synchronization Errors
When SSSE synchronizes a user’s data during the inbound synchronization process, specific records might fail to synchronize because of record-level errors, for example, parsing or validation errors. In these circumstances, whether or not SSSE continues to synchronize the user’s remaining records and save the user’s sync state for the session depends on how you configure the Always Save Syncstate parameter:
Always Save Syncstate parameter is set to
Y
If the Always Save Syncstate parameter is set to
Y
, then if a record fails to synchronize during the inbound synchronization process because of an error, for example, a required field is missing, SSSE continues to synchronize all of the user’s other records and saves the user’s sync state for the session. During the next synchronization cycle, SSSE does not attempt to synchronize the failed record again (it is skipped), unless the record is updated in the intervening time.
Always Save Syncstate parameter is set to
N
If the Always Save Syncstate parameter is set to
N
, then if a record fails to synchronize during the inbound synchronization process because of an error, the synchronization process stops, and the user’s sync state for the session is not saved. During the next synchronization cycle, SSSE attempts to synchronize all of the user’s records again, but if the error in the original record has not been corrected, then the synchronization process will again stop.
To configure SSSE to specify whether or not a user’s sync state is saved for sessions during which specific records fail to synchronize, perform the following procedure.
To enable record skipping during synchronization
Navigate to the Administration - PIM Server Integration screen, Configuration, and then the PIM Server Integration Configuration view.
In the PIM Server Integration Configuration list, select the Siebel profile.
In the Configuration Parameters list, click New, and then complete the fields as described in the following table.
Field Value Section
SyncState
Parameter
Always Save Syncstate
Value
Enter either
Y
orN
. The default value isY
(invalid records are skipped).If you set the value of the Always Save Syncstate parameter to Y to enable record skipping (recommended), then it is also recommended that you configure SSSE so that the administrator is notified when a record is skipped because of a synchronization error. For information on configuring SSSE so that the administrator is notified by email when synchronization errors occur, see Process of Configuring Email Notification of Synchronization Errors.
Process of Configuring Email Notification of Synchronization Errors
This topic describes how to configure SSSE so that the administrator is notified by email if synchronization errors are generated during an inbound synchronization session. The administrator can then resolve the issue, or notify the user of the problem so that it can be resolved. Email notification is available for synchronization errors generated by the PIMSI Engine.
To configure SSSE so that the administrator receives email notification of synchronization errors, perform the following task: Configuring System Alerts for Email Notification of PIMSI Engine 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, including errors relating to the Web service Exchange Connector.
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
Configure a system alert for the Siebel Enterprise as follows:
Navigate to the Administration - Server Configuration screen, Enterprises, and then the System Alerts view.
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
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.example.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
Define the email body template to be used for PIMSI Engine error notification emails as follows:
Navigate to the Administration - PIM Server Integration screen, Configuration, and then the PIM Server Integration Configuration view.
Select the Exchange Calendar Profile.
In the Configuration Parameters list, create records with values similar to those shown in the following table.
Note: The Domain name you specify must match an existing Domain Identifier field, for example, IPM Task. To view domain identifiers, navigate to the Administration - PIM Server Integration screen, then the PIM Domains view.Section Parameter Value Email Template:Domain Name
MsgBody1
Specify the body of the email with place holders. Place holders are case sensitive.
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 the Administration - PIM Server Integration screen, Siebel Domains, and then the Siebel Domain Fields view.
Email Template:Domain Name
MsgBody2
This parameter allows you to add additional email body text, if required, to the supported place holders described in the previous field.
Set the value of the NOTIFYMSGSIZE parameter to determine the maximum size of error message notifications as follows:
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
At the srvrmgr> prompt, enter the following command:
change param NOTIFYMSGSIZE=nnnn for server servername
where:
nnnn is the maximum notification size
servername is the server for which you are setting the NOTIFYMSGSIZE parameter
If an error message is generated which is larger than the value of the NOTIFYMSGSIZE parameter, then the error notification email includes only the following message:
SSSE Inbound Synch failed for User:Username,Domain:Domain Please see PIMSIEng log
Therefore, if you configure large error message notifications, then increase the maximum notification size by setting the NOTIFYMSGSIZE parameter to a higher value, for example 1024.
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 might 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
Navigate to the Administration - PIM Server Integration screen, Configuration, and then the PIM Server Integration Configuration view.
Select the Exchange Calendar Profile.
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 values shown in the following table exist for the placeholders used in the message body of the email template defined in this example:
Placeholder | Value |
---|---|
Domain |
IPM.Task |
Login |
GABBO |
Subject |
Meeting in the month of March |
Start Date |
3/3/2011 |
End Date |
3/5/2011 |
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/2011 End Date: 3/5/2011 The error Message was: One or more required fields are missing.