10Setting Up and Using Siebel Outlook Add-In
Setting Up and Using Siebel Outlook Add-In
This chapter describes how to set up and use the Siebel Outlook Add-In deployment option for SSSE. The chapter includes the following topics:
About Siebel Outlook Add-In
The Siebel Outlook Add-In lets users link to Siebel records from Microsoft Outlook calendar appointments, contacts, and tasks using controls in the Microsoft Outlook interface.
The Siebel Outlook Add-In adds the following controls to the Calendar, Contacts, and Tasks views of the user’s Microsoft Outlook interface:
Siebel Options menu
The Siebel Options menu allows you to link a selected Microsoft Outlook item to a record in Siebel Business Applications, to remove existing links, or to access recently created links.
Siebel toolbar
The Siebel toolbar allows you to link the selected Microsoft Outlook item to a record in Siebel Business Applications or to use an existing link to go to a record in Siebel Business Applications.
Right-click menu items
The Siebel right-click menu allows you to link the selected Microsoft Outlook item to a record in Siebel Business Applications or to remove existing links.
Siebel tab in Options dialog box
The Siebel tab in the Options dialog box allows you to setup communication settings in your Siebel application.
Using these controls a user can link Siebel records to Microsoft Outlook calendar, contacts, or task records. After a user links a Siebel record to a Microsoft Outlook record, the user can use the link to navigate from Microsoft Outlook directly to the linked record in Siebel Business Applications. The Microsoft Outlook object you have linked is also synchronized with the Siebel application during the next synchronization cycle. For example, if a user creates a calendar appointment in Microsoft Outlook and then links that appointment to a relevant Opportunity in Siebel Business Applications, then the user can navigate from Microsoft Outlook directly to the Siebel opportunity and, after the next synchronization cycle, the Microsoft Outlook calendar appointment is associated with the Siebel opportunity record as a Siebel opportunity activity.
Siebel Outlook Add-In uses the same permissions as PIMSI Engine for allowing specific users to synchronize calendar, contact, and task data. For more information about setting permissions, see Process of Setting SSSE Group and User Access Controls.
Related Topic
System Requirements for Siebel Outlook Add-In
Deployment of Siebel Outlook Add-In requires the following:
You must install the PIMSI Engine before you deploy Siebel Outlook Add-In to ensure that when you associate a Microsoft Outlook object with a Siebel object, the Microsoft Outlook object is synchronized with the Siebel object. For information about PIMSI Engine, see SSSE Deployment Options.
You must install a supported version of Microsoft Outlook on the computer of each user who uses Siebel Outlook Add-In. For information about supported versions, see Siebel System Requirements and Supported Platforms on Oracle Technology Network.
Note: For Siebel CRM product releases 8.1.1.9 and later and for 8.2.2.2 and later, the system requirements and supported platform certifications are available from the Certification tab on My Oracle Support. For information about the Certification application, see article 1492194.1 (Article ID) on My Oracle Support.
Process of Setting Up Siebel Outlook Add-In
Setting up Siebel Outlook Add-In consists of the following tasks, which you must complete in the order shown. The system administrator performs the first task on the Siebel Enterprise Server and the second task in the Siebel Repository. The third task is required only if your implementation modifies the information that Outlook Add-In makes available. An administrator can perform it wherever there is access to your Siebel application and Enterprise database. Either the administrator or the end user perform the remaining three tasks on the end user’s computer.
To deploy the Siebel Outlook Add-In, complete the following tasks:
Setting Enterprise Server Parameters and Enabling Web Client Automation for Outlook Add-In
To deploy the Siebel Outlook Add-In, you must set the MsgClientAddInEAIUrl Siebel Enterprise Server parameter, and enable Web Client Automation. You can also optionally specify values for the MsgClientAddInCacheRefreshInterval parameter and the MsgClientAddInLinkHistory parameter. This topic describes how to perform these tasks.
This task is a step in Process of Setting Up Siebel Outlook Add-In
About the Messaging Client AddIn EAI Url Parameter
You must set the MsgClientAddInEAIUrl Siebel Enterprise Server parameter, which defines the path to the Siebel EAI object manager. The Add-In Update Agent uses this path to download data from Siebel Business Applications and cache the data on the client's desktop. The EAI Object Manager specified does not have to be on the same computer as the PIMSI Engine, and does not have to be dedicated to the PIMSI Engine. For information about the Add-In Update Agent, see Installing Siebel Outlook Add-In.
About the Messaging Client AddIn Cache Refresh Interval Parameter
You can optionally specify a value for the MsgClientAddInCacheRefreshInterval parameter. The MsgClientAddInCacheRefreshInterval parameter defines how often, in minutes, the Siebel Outlook Add-In refreshes the local cache for all users.
The local cache is used to store the linked Siebel data that is displayed in Microsoft Outlook. Storing a copy of the user’s Siebel data in a local cache improves performance and allows the user to work offline. In determining the refresh interval of the local cache, you must consider the necessity to have current data available against the performance impact of updating this information repeatedly. For information about how individual users can modify the refresh interval values in Outlook, see Setting the Cache Refresh Interval.
About the Messaging Client AddIn Link History Parameter
The MsgClientAddInLinkHistory parameter defines, for all users, the number of days that a recently used link is to be stored on the Quick Links menu. The Quick Links menu allows a user to quickly locate recently used links without having to search through the entire list of links in the Link to Siebel dialog box. For information about how individual users can modify the quick link retention values in Outlook, see Setting the Quick Link Retention Period.
The following procedure describes how to set the Enterprise Server parameters and enable Web Client Automation for Siebel Outlook Add-In.
To set the Enterprise Server parameters and enable Web Client Automation for Outlook Add-In
Log in to the Siebel Enterprise Server host as the administrator.
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
In the Enterprise Servers list, click the appropriate Enterprise Server, and then click the Parameters view tab.
In the Enterprise Parameters list and the accompanying form, select each of the parameters shown in the following table, and enter or modify values and check box settings as required.
Parameter Value Effective Messaging Client AddIn EAI Url
For a description of this parameter, see About the Messaging Client AddIn EAI Url Parameter.
Enter the Siebel EAI path
http://your_host/eai_language-code/At Server Restart
Messaging Client AddIn Cache Refresh Interval
For a description of this parameter, see About the Messaging Client AddIn Cache Refresh Interval Parameter.
Optional. Modify the value of the cache refresh interval in minutes.
At Server Restart
Messaging Client AddIn Link History
For a description of this parameter, see About the Messaging Client AddIn Link History Parameter.
Optional. Modify the number of days to keep quick links.
At Server Restart
Enable Web Client Automation as follows:
Navigate to the Administration - Server Configuration screen, then the Servers view.
In the Servers list, select the appropriate server, then click the Components tab.
Select the appropriate component, for example, Sales Object Manager (ENU).
Click the Parameters tab, then query for the EnableWebClientAutomation parameter.
Change the default value of the EnableWebClientAutomation parameter to True.
Save the record.
Restart the Siebel Server.
(Optional) Setting the Bucket Size User Property for Siebel Outlook Add-In
This topic describes how to set a value for the Bucket Size user property of the Messaging Client Data Service business service. The Bucket Size user property setting determines the number of Siebel data records that the Siebel Add-In Update Agent downloads to each user’s local cache for display in Microsoft Outlook each time the local cache is initialized or refreshed. If the value set for the Bucket Size user property is large, then it can cause timeout errors during the data download process. If you do not set a value for the Bucket Size parameter, then the default value of 2000 is used.
This task is an optional step in Process of Setting Up Siebel Outlook Add-In
The following procedure describes how to set the value of the Bucket Size user property for the Messaging Client Data Service business service. For information about the Add-In Update Agent, see Installing Siebel Outlook Add-In.
To set a value for the Bucket Size user property
Locate the Messaging Client Data Service business service.
Create a modify the Bucket Size business service user property as follows:
Field Description Name
Bucket Size
Value
n
where n is the number of records to be downloaded to each user’s local cache for display in Microsoft Outlook. For example, if Bucket Size is set to 1000, then the Outlook Add In Agent downloads 1000 records at a time to the local cache.
(Optional) Setting Siebel Outlook Add-In Objects and Fields
This topic describes the information that Outlook Add-In ordinarily makes available. If your Siebel implementation does not require all of that information, then you can use the instructions in this topic to have Outlook Add-In omit the information that your users do not require. You can also adjust the order in which Outlook Add-In supplies information from the relevant Siebel fields. For information on adding additional Siebel objects to those that Outlook Add-In provides, see Process of Configuring Custom Objects in Siebel Outlook Add-In.
This task is an optional step in Process of Setting Up Siebel Outlook Add-In.
The following table lists the Siebel objects and fields that Siebel Outlook Add-In makes available from Microsoft Outlook. Outlook Add-In lets you link to Siebel records that have any of the listed Siebel Object types. The data that is contained in the listed Siebel Object Fields is the data that is visible in Siebel Outlook Add-In controls.
| Siebel Object | Siebel Object Fields |
|---|---|
Account |
Id, Name, Location |
Opportunity |
Id, Name, Account |
Project |
Id, Name, Account Name, Project Num |
Service Request |
ID, SR Number, Abstract, Account |
The following procedure describes how to set the Siebel Objects, Siebel Object fields, and field order that Outlook Add-In uses when supplying Siebel data.
To set Siebel Objects and Siebel Object Fields that Outlook Add-In makes available
Log in to your Siebel application as the administrator.
Navigate to the Administration - PIM Server Integration screen, then the Siebel Objects view.
In the PIMCI Siebel Object list, select any object that you do not want Outlook Add-In to make available, and then click Delete.
Repeat this step until the list displays just the objects that you want Outlook Add-In to make available.
In the PIMCI Siebel Object list, select any object for which you want to adjust field settings.
In the Siebel Object Fields list, select the record for any field that you do not want Outlook Add-In to display in its controls, and then click Delete.
Note: Do not delete the Id or Key fields.Repeat this step until the list displays just the fields that you want Outlook Add-In to display in its controls.
In the Siebel Object Fields list, inspect the Field Sequence values for the remaining fields, and enter new values as required to produce the desired sequence.
Note: Field sequence values must be unique. To avoid error messages, enter only values that are not currently assigned to other fields.
Installing Siebel Outlook Add-In
You must install the Siebel Outlook Add-In on each computer where it will be used.
The following procedure installs the Siebel Outlook Add-In dynamic link library (DLL) files and the Add-In Update Agent. The Add-In Update Agent is automatically started when you try to create Outlook-to-Siebel links or when you restart your computer. The Add-In Update Agent is responsible for caching and refreshing Siebel data stored on the user’s computer.
This task is a step in Process of Setting Up Siebel Outlook Add-In.
To install Siebel Outlook Add-In
On the user’s computer, close all Microsoft Outlook windows and all Siebel application windows.
Navigate to the network directory that contains the installation files for your Siebel application and start the installation program
...\Siebel_Outlook_Addin\install.exe.Follow the installation wizard prompts. Accept all default values. You can install to any location on the user’s hard drive.
Initializing Siebel Outlook Add-In
This topic describes how to initialize the communication between Microsoft Outlook and Siebel Business Applications on each computer using the Siebel Outlook Add-In. It also describes how to configure the maximum number of unsuccessful attempts you can make to log in to the Siebel application from Microsoft Outlook Add-In when creating or updating the local cache before you must change the Siebel user name and password in Microsoft Outlook.
This task is a step in Process of Setting Up Siebel Outlook Add-In.
Initializing Siebel Outlook Add-In
The following procedure describes how to initialize Siebel Outlook Add-In.
To initialize Siebel Outlook Add-In
Start Microsoft Outlook on the user’s computer.
Select File, Options, then Add-Ins.
Select the Siebel Outlook Add-in and click on Add-in Options button and enter the following values in the property page:
Siebel Client URL:https://<hostname>:<port>/siebel/app/callcenter/enu
Data Source URL: https://<hostname>:<port>/siebel/app/eai/enu
UserName: The username used to log into the Siebel Web Client, for example FALLEN.
Password: The password associated with that user.
The values in the property page will be stored in Windows registry table in the location HKEY_CURRENT_USER\SOFTWARE\Siebel Systems, Inc.\Siebel Outlook Add-In. Note that these values can also be pre-populated for the user via Group Policy or other systems management software:
Client Parameter Name Registry Name Description Siebel Client URL URL Used as the basis for the URL that will be opened if the user clicks the “Go” button while using the Add-in features. Data Source URL EAIURL The URL of the EAI Manager that will be used to see the local cache with Accounts, Contacts, and other items to be linked to Outlook items. UserName EAIUserId The user’s login name—used to authenticate against the EAI Object Manager to download data for the local cache. Password EAIPassword The user’s password.
Configuring the Maximum Number of Unsuccessful Siebel Login Attempts
If you enter an incorrect Siebel password in Microsoft Outlook when initializing the Siebel Outlook Add-In client, then the client cannot connect to the Siebel application to create or update the local cache. In these circumstances, Siebel Outlook Add-In prompts you to log in to a new Siebel session. If you log in successfully, then the local cache is created or updated. However, if you enter an invalid Siebel password three times in a row (by default, the maximum number of attempts permitted), then you are locked out of your Siebel account until you change the Siebel password in Microsoft Outlook.
To avoid password lockouts, use the following procedure to change the maximum number of unsuccessful attempts you can make to log in to the Siebel application before Siebel Outlook Add-In requires that you manually change the Siebel password in Microsoft Outlook.
To configure the maximum number of unsuccessful Siebel login attempts
In the Windows Registry, navigate to the following entry:
HKEY_CURRENT_USER\Software\Siebel Systems, Inc.\Siebel Outlook Add- In\MaxErrorCount
Change the value of this parameter to the maximum number of Siebel login attempts you want to allow. The default value of the MaxErrorCount parameter is 3.
(Optional) Configuring Siebel Outlook Add-In for Web Single Sign-On Authentication
This topic describes how to enable Web Single Sign-On user authentication for the Siebel Outlook Add-In.
The Siebel Outlook Add-In allows users to link Microsoft Outlook records to records in the Siebel application. If the Siebel application uses Web Single Sign-On (Web SSO) as the user authentication mechanism, then the Siebel Outlook Add-In must also be configured to allow Web SSO authentication when accessing the Siebel application. For detailed information about implementing Web Single Sign-On for Siebel Business Applications, see Siebel Security Guide.
This task is a step in Process of Setting Up Siebel Outlook Add-In.
The following procedure describes how to enable Web SSO for Siebel Outlook Add-In.
To configure Web SSO for Siebel Outlook Add-In
In the Windows Registry of each computer running the Siebel Outlook Add-In client, navigate to the following entry:
[HKEY_CURRENT_USER\Software\Siebel Systems, Inc.\Siebel Outlook Add-In] EnableSSO
Set the value of the EnableSSO parameter to 1.
If the EnableSSO parameter does not exist, then add it.
Testing Siebel Outlook Add-In
Perform the following task to test linking and unlinking between Microsoft Outlook and Siebel Business Applications.
This task is a step in Process of Setting Up Siebel Outlook Add-In.
In Microsoft Outlook, select any calendar, contact, or task record (or create a new record if one does not exist), and then choose Siebel Options, and then Link Selected Item(s).
Select any record in the Siebel application.
If the link is successfully created, then the link appears in the Existing Links list on the Siebel toolbar.
From the Siebel Options menu, choose Unlink Record to remove the link you just created.
If you encounter no errors during linking and unlinking, then the communication between Microsoft Outlook and Siebel Business Applications has been initialized and is working properly.
Related Topic
Setting Siebel Outlook Add-In Options
Siebel Outlook Add-In adds a Siebel tab to the Microsoft Outlook Options dialog box, which lets you change settings that control how Microsoft Outlook communicates with Siebel Business Applications. This topic describes how to set the cache refresh interval and the quick links retention period using options on the Siebel tab.
Setting the Cache Refresh Interval
The Siebel Outlook Add-In stores the linked Siebel data in a local cache file, which is updated periodically by obtaining new data from Siebel Business Applications. By default, the cache is refreshed every three days (4320 minutes). You can change the cache refresh interval by performing the following procedure.
To change the Siebel Outlook Add-In cache refresh interval
In Microsoft Outlook on the user’s computer, choose Tools, and then Options.
In the Options dialog box, click the Siebel tab.
In the Cache Refresh Interval text box, enter the new interval (in minutes).
Click OK to exit the Options dialog box.
Setting the Quick Link Retention Period
Quick Links are retained for a number of days as defined on the Siebel tab of the Microsoft Outlook Options dialog box. By default, Quick Links are retained for 30 days. You can change the Quick Link retention period by performing the following procedure.
To change the Quick Link retention period
In Microsoft Outlook on the user’s computer, choose Tools, and then Options.
In the Options dialog box, click the Siebel tab.
In the Quick Link Retention text box, enter the new interval (in days).
Click OK to exit the Options dialog box.
Process of Configuring Custom Objects in Siebel Outlook Add-In
Siebel Outlook Add-In allows you to link to Siebel Account, Opportunity, Project, and Service Request objects from Microsoft Outlook. This topic describes how to configure Siebel Outlook Add-In so that you can link to additional Siebel objects from within Microsoft Outlook, for example, you can configure Outlook Add-In so that you can link a Siebel Household object from a Microsoft Outlook contact record.
Perform the following tasks in the order shown to configure a custom Siebel object in Siebel Outlook Add-In:
Compile the modified integration objects to generate a new Runtime Repository, then stop the Siebel Server, deploy the new Runtime Repository, and then restart the Siebel Server.
Restart the Siebel Server and test the configuration.
Configuring List of Values
This topic describes how to create the new List of Value (LOV) types required to display the new object you are adding to Siebel Outlook Add-In, and to display the fields that are available for the object. For additional information on LOVs, see Configuring Siebel Business Applications.
This task is a step in Process of Configuring Custom Objects in Siebel Outlook Add-In.
To create the LOV type records
Create LOV records using the information in the following table.
| Type | Display Value | Language Independent Code (LIC) | Description |
|---|---|---|---|
PIMSI_ADDIN_ OBJECT_TYPE |
Household |
Household |
This is the new Siebel object type being added to the Outlook Add-In, for example, Household. The value you specify does not have to be a valid business component name; it is the name that is displayed in the Outlook Add-In. The display value is used to associate the new object type with synchronization-enabled objects. |
LOV_TYPE |
PIMSI_ADDIN_ HOUSEHOLD_ FIELD |
PIMSI_ADDIN_HOUSEHOLD_ FIELD |
This LOV contains a list of the fields available to display for the new object type. Amend the display value and LIC value according to the type of object you are adding. |
PIMSI_ADDIN_ HOUSEHOLD_FIELD |
Row Id |
Id |
Id must be one of the fields available to display. By convention, the Display value is Row Id. |
PIMSI_ADDIN_ HOUSEHOLD_FIELD |
Household Name |
Household Name |
The Display Value is shown at the top of the list of items in the Outlook Add-in dialog box. The LIC value must be the same as the field name in the business component. This LOV Type is multilingual. Create an additional record for each field for each language required. |
PIMSI_ADDIN_ HOUSEHOLD_FIELD |
(additional field name) |
(additional field name) |
Add any additional fields required. |
PIMSI_ASSOC_ TYPE |
Household |
Household |
The LIC value must the same as the business component name. |
PIMSI_FIELD_CLASS |
Household Name |
Household Name |
This record must exist for each field value added. The LIC value must have the same name as the field name. |
Creating a New PIMSI Siebel Object
This topic describes how to create a new PIMSI Siebel object, which is used to define the object and fields available to the Outlook Add-in.
This task is a step in Process of Configuring Custom Objects in Siebel Outlook Add-In.
Follow the procedure to create the new PIMSI Siebel object.
To create the new PIMSI Siebel object
Navigate to the Administration - PIMSI Server Integration screen, then the Siebel Objects view.
In the PIMSI Siebel Object list, create a new object using the values in the following table.
Note: In the following table, replace Household with the name of the PIMSI Siebel object type you are adding to the Outlook Add-In.Parameter Value Description Name
Household
The name of the object as it is to be displayed.
Business Object
Household
A business object for which the entity is defined in Tools, and for which the primary business component is the business component underlying the object being created.
Business Component
Household
The business component that is to retrieve the records for display in the Add-in.
View Mode
Sales Rep
The visibility mode to be used when querying the business component. It is recommended that you do not specify the values All or Organization.
Display Field
Household Name
The field to display in the Current Siebel Links drop-down list and the Quick Links list.
Translation LOV
PIMSI_ADDIN_HOUSEHOLD _FIELD
The multilingual LOV defined in Step 2 in the topic Configuring List of Values for possible display fields.
View Name
My Households View
The name of the view that is displayed when the Go link is selected in Microsoft Outlook.
In choosing the view to display, ensure the following conditions exist:
The view business object must be the same as the business object for this record
The view's visibility applet type must be the same as the view mode specified for this record.
The view's visibility applet must be based on the same business component as that specified for this record.
Applet Name
Households List Applet
The name of the applet that is queried.
In the Siebel Object Fields applet, create a record for each field that is to display in the Siebel Outlook Add-Id using values similar to those shown in the following table.
| Name | Field Sequence | Description |
|---|---|---|
Id |
0 |
The sequence 0 must always be Id |
Household Name |
1 |
List the remaining fields that you want to display in the required sequence order. Each field uses the LIC value from the Translation LOV (in this example, PIMSI_ADDIN_HOUSEHOLD_FIELD). When displayed in the user interface, the display value of the LOV is used for the current user language. |
Updating Integration Objects
This topic describes how to update the PIMSI Integration Object and the PIMSI Intermediate Integration object that SSSE uses for synchronization. Updating these objects allows the PIMSI server components to correctly synchronize data after a user has selected the Siebel object that you have made available in the Siebel Outlook Add-In.
You must update the integration objects of the domain associated with the Microsoft Outlook record. For example, if you are configuring the Siebel Outlook Add-In to link Microsoft Outlook contact records with Siebel Household records, then the two Integration Objects that you must update are the PIMSI Business Contact and the PIMSI Intermediate Business Contact integration objects.
This task is a step in Process of Configuring Custom Objects in Siebel Outlook Add-In.
The following procedure describes how to update the PIMSI Integration Object.
To update the PIMSI Integration object
Query for the relevant Integration Object for the domain being updated, in this example, PIMSI Business Contact.
Create a new Integration Component, or activate an existing component, specifying values similar to those shown in the following table.
Note: In this table, italics indicate that you are supposed to substitute some other value for the value in the field. Values in the table that are not in italics must be entered literally.For information on creating and activating Integration Objects, see Integration Platform Technologies: Siebel Enterprise Application Integration.Attribute Value Description External Name Context
Contact_Household
Specify ParentObjectName_New AddInObject
Name
Contact_Household
Specify the value chosen for the External Name Context attribute.
Parent Integration Component
Contact
The name of the parent Integration Object.
External Name
Household
The name of the Siebel object you are adding to Outlook Add-In.
External Sequence
6
Specify the next available sequence number.
Cardinality
Zero or More
Because Household is not a required field, you can specify either Zero or More for the Cardinality attribute.
XML Container Element
ListOfContact_Household
Specify ListOfNameAttributeValue
XML Sequence
10,006
10,000 plus the External Sequence number specified.
Select the Contact_Household Integration Component, then add a record to the Integration Component User Props applet to indicate that the child (Household) object is to be treated as an MVG.
Name Value MVGAssociation
Y
Create Integration Component Fields for system fields, and for any field that you want to make available in the Outlook Add-in, using values similar to those shown in the following table.
Caution: You must create the first three fields shown in the following table.Attribute Field 1 Field 2 Field 3 Field 4 Name
Household Id
IsPrimaryMVG
operation
Households
Data Type
DTYPE_ID
DTYPE_TEXT
DTYPE_TEXT
DTYPE_TEXT
Len
30
1
30
100
Type
Data
System
System
Data
Ext. Name
Household Id
IsPrimaryMVG
operation
Household Name
Ext. Data Type
DTYPE_TEXT
Ext. Length
100
Ext. Seq.
1
2
3
4
XML Seq.
1
2
3
4
XML Style
Element
Attribute
Attribute
Element
For the Household Name Integration Component field, specify the following user property to indicate that the name of the field in the child business component (in this example, Household) is different to the name in the parent business component (in this example, Contact).
Name Value AssocFieldName
Household Name
For the Household Id Integration Component field, specify the following Integration Component Field user property to indicate that name of the field in the child business component (in this example, Household) is different to the name in the parent business component (in this example, Contact).
Name Value AssocFieldName
Id
Create Integration Component Keys using values similar to those shown in the following table.
Name Key Sequence Number Key Type Status Key
Status Key
User Key:1
1
User Key
For the Status Key Integration Component Key, add the following Integration Component Key fields, using values similar to those shown in the table.
Name Field Name Id
Household Id
Operation
operation
For the User Key: 1 Integration Component Key, add the following Integration Component Key fields, using values similar to those shown in the table.
Name Field Name Household Name
Household Name
The following procedure describes how to update the PIMSI Intermediate Integration Object.
To update the PIMSI Intermediate Integration object
Query for the relevant Intermediate Integration Object for the domain being updated, in this example, PIMSI Intermediate Business Contact.
Create a new Integration Component specifying values similar to those shown in the following table.
For information on creating and activating Integration Objects, see Integration Platform Technologies: Siebel Enterprise Application Integration.
Attribute Value Description External Name Context
HouseholdInfo
Specify AddInObjectNameInfo.
Name
HouseholdInfo
Specify the value chosen for the External Name Context attribute.
Parent Integration Component
BusinessContact
The name of the parent Integration Object.
External Name
HouseholdInfo
Specify AddInObjectNameInfo.
External Sequence
1
This value must be set to 1.
Cardinality
One or More
This value must always be set to One or More.
XML Container Element
ListOfHouseholdInfo
Specify ListOfNameAttributeValue
XML Sequence
1
This value must always be set to 1.
Create Integration Component fields for system fields, and for any field that is to be displayed in the Outlook Add-in, using values similar to those shown in the following table.
Note: You must create the two fields shown in the following table, and can create additional fields as required.Attribute Field 1 Field 2 Name
HouseholdId
HouseholdName
Data Type
DTYPE_TEXT
DTYPE_TEXT
Len
Not applicable
Not applicable
Type
Data
Data
Ext. Name
HouseholdId
HouseholdName
Ext. Seq.
1
2
XML Seq.
1
2
XML Style
Element
Element
When you have modified the PIMSI Integration Objects, compile the modified integration objects to generate a new Runtime Repository, then stop the Siebel Server, deploy the new Runtime Repository, and then restart the Siebel Server.
Updating the Data Maps
This topic describes how to update the Inbound and Outbound Siebel Data Maps to identify the new fields you created for the PIMSI integration objects described in Updating Integration Objects.
This task is a step in Process of Configuring Custom Objects in Siebel Outlook Add-In.
The following procedure describes how to update the Siebel Inbound Data Maps.
To update the Siebel Inbound Data Maps
In your Siebel application, navigate to the Administration - Integration screen, then the Data Map Editor view.
Query for the relevant Inbound Map, in this example, the PIMSI Business Contact Inbound Map.
In the Integration Component Map applet, add a new record for the new entity, using values similar to those shown in the following table.
Attribute Value Description Name
HouseholdInfo_ContactHousehold
Specify the name of the integration object component from the PIMSI intermediate integration object, then the name of the integration object component from the PIMSI integration component.
Source Component Name
HouseholdInfo
Specify the name of the integration object component from the PIMSI intermediate integration object component.
Target Component Name
Contact_Household
Specify the name of the integration object component from the PIMSI integration object component.
In the Integration Field Map applet, add a new record for each field that is to be made available in the Outlook Add-In using values similar to those shown in the following table. In this example, add only two fields, HouseholdName and HouseholdId. You can add additional rows, if required.
Source Expression Target Field Name Description [HouseholdName]
Household Name
The Source Expression must contain an expression. In most cases, the expression is an integration component field name in square brackets. It can be a more complex expression, for example, an IIF(…) expression.
See Configuring Siebel Business Applications for information on building expressions.
[HouseholdId]
Household Id
The Source Expression must contain an expression. In most cases, the expression is an integration component field name in square brackets. It can be a more complex expression, for example, an IIF(…) expression.
See Configuring Siebel Business Applications for information on building expressions.
In the Integration Object Map applet, click the Validate button to verify the mapping.
The following procedure describes how to update the Siebel Outbound Data Maps.
To update the Siebel Outbound Data Maps
In your Siebel application, navigate to the Administration - Integration screen, then the Data Map Editor view.
Query for the relevant Outbound Map, in this example, the PIMSI Business Contact Outbound Map.
In the Integration Component Map applet, add a new record for the new entity, using values similar to those shown in the following table.
Attribute Value Description Name
ContactHousehold_HouseholdInfo
Specify the name of the Integration Object Component from the PIMSI integration object, then the name of the integration object component from the PIMSI intermediate integration component.
Source Component Name
Contact_Household
Specify the name of the integration object component from the PIMSI integration object component.
Target Component Name
HouseholdInfo
Specify the name of the integration object component from the PIMSI intermediate integration object component.
Source Search Specification
IsMVGPrimary=’Y’
Only the primary MVG records can be shown in Outlook Add-In.
In the Integration Field Map applet, add a new record for the Id field, and for each field that is to be made available in the Outlook Add-In, using values similar to those shown in the following table. In this example, add the HouseholdName field. You can add additional rows, if required.
Source Expression Target Field Name Description [Household Name]
HouseholdName
The Source Expression must contain an expression. In most cases, the expression is an integration component field name in square brackets. It can be a more complex expression, for example, an IIF(…) expression.
See Configuring Siebel Business Applications for information on building expressions.
[Household Id]
HouseholdId
The Source Expression must contain an expression. In most cases, the expression is an integration component field name in square brackets. It can be a more complex expression, for example, an IIF(…) expression.
See Configuring Siebel Business Applications for information on building expressions.
In the Integration Object Map applet, click the Validate button to verify the mapping.
Updating the PIMSI Domain Configuration
This topic describes how to update the PIMSI domains to reflect the updated data mappings. You must update the Siebel domain and the PIM domain, then configure the PIM domain to map the Intermediate Integration Component fields to the appropriate fields in Microsoft Exchange.
This task is a step in Process of Configuring Custom Objects in Siebel Outlook Add-In.
The following procedure describes how to update the Siebel Domain.
To update the Siebel domain
Navigate to the Administration - PIM Server Integration screen, then the Siebel Domains view.
Query for the relevant domain, in this example, the Siebel Business Contact domain.
In the Siebel Domain Fields applet, click the Sync Fields button.
Add a new record for the ROW_ID field, and for each of the fields that is to be made available in Outlook Add-In, using values similar to those shown in the following table.
Attribute Field 1 Field 2 Name
Household Id
Households
Field Identifier
HouseholdId
HouseholdName
Field Type
Id
Household Name
Data Type
String
String
Assoc. Type
Household
Household
Related BusComp
Household
Household
Parent
HouseholdInfo
HouseholdInfo
Len.
15
100
Prec.
15
100
Multi-Valued
No
Yes
Read Only
No
Yes
The following procedure describes how to update the PIM Domain.
To update the PIM domain
Navigate to the Administration - PIM Server Integration screen, then the PIM Domains view.
Query for the relevant domain, in this example, the Exchange Contact domain.
In the PIM Domain Fields applet, add a new record for the ROW_ID field, and for each of the fields that is to be made available in Outlook Add-In, using values similar to those shown in the following table.
Name Field Identifier Field Type Data Type Household Id
HouseholdId
Id
Unicode String
Household Name
HouseholdName
Household Name
Unicode String
The following procedure describes how to configure the PIM domain by mapping the Intermediate Integration Component fields to the Microsoft Outlook Exchange fields; this is necessary so that SSSE will query and update the appropriate fields in Microsoft Exchange.
To configure the PIM domain
Navigate to the Administration - PIM Server Integration screen, then the Configuration view.
Query for the relevant PIM domain, in this example, the Exchange Contact domain.
In the Configuration Parameters applet, create records using values similar to those shown in the following table.
Section Parameter Value Description Household Id
PropertySetGUID
{00020329-0000-0000-C000-000000000046}
You must specify the value shown. This is an identifier that indicates the property set where the MAPIPropertyName is placed.
Household Id
MAPIPropertyName
HouseholdId
This is the name of the MAPI property where the value is stored in Microsoft Exchange. This must be unique across all Value fields.
Household Id
SubNamespace
String
You must specify String for this value.
Household Name
PropertySetGUID
{00020329-0000-0000-C000-000000000046}
You must specify the value shown. This is an identifier that indicates the property set where the MAPIPropertyName is placed.
Household Name
MAPIPropertyName
HouseholdName
This is the name of the MAPI property where the value is stored in Microsoft Exchange. This must be unique across all Value fields.
Household Name
SubNamespace
String
You must specify String for this value.
Updating Domain Maps
This topic describes how to update domain maps so as to link the Siebel objects used by the Siebel Outlook Add-In and the integration information used by the synchronization process.
This task is a step in Process of Configuring Custom Objects in Siebel Outlook Add-In.
The following procedure describes how to update the domain maps.
To update domain maps
Navigate to the Administration - PIM Server Integration screen, then the Domain Map view.
In the Domain Map applet, query for the relevant domain map, in this example, the Siebel-Exchange Business Contact Map.
Click the Siebel Objects tab.
Click the New button, and in the Add Siebel Objects list, select the Siebel object created in Creating a New PIMSI Siebel Object.
Click the Field Map tab.
Verify that the correct domain map (in this example, the Siebel-Exchange Business Contact Map) is still selected in the Domain Map applet.
In the Field Map applet, create records with values similar to those shown in the following table.
Siebel Field PIM Field Sync Enabled Key Field Household Id
Household Id
Yes
No
Households
Household Name
Yes
No
Click the Siebel Object Fields tab.
Associate the appropriate Field Maps (in the middle applet) with the Siebel Object Fields (in the lower applet), as indicated in the following table.
Field Map(middle applet) Item to Associate Siebel Object Name(bottom applet) Household Id
Id
Household
Household Name
Household Name
Household
About Using Siebel Outlook Add-In
The Siebel Outlook Add-In adds a Siebel Options menu, a Siebel toolbar, and right-click menu items to the Microsoft Outlook interface. These features let you link to records in Siebel Business Applications. You can also remove links using these controls.
The following information lists the types of Siebel records that you can link to from Microsoft Outlook.
| Microsoft Outlook Record Type | Can Link to These Siebel Record Types |
|---|---|
Calendar |
Account |
Calendar |
Opportunity |
Calendar |
Project |
Calendar |
Service Request |
Task |
Account |
Task |
Opportunity |
Task |
Project |
Task |
Service Request |
Contact |
Account |
Contact |
Opportunity |
Contact |
Project |
Each Microsoft Outlook record can support a single link to each Siebel record type. For example, a Microsoft Outlook contact can link to one Siebel account, one Siebel opportunity, and one Siebel project. If you link to a new Siebel record and a link of that type already exists, then the new link replaces the old link.
You can associate the same Siebel record to multiple Microsoft Outlook records. By selecting multiple Outlook records, and then associating the Siebel records, you can assign the same Siebel record to multiple Outlook records in a single operation.
For more information about using Siebel Outlook Add-In, see:
Linking to Siebel Data from Microsoft Outlook
Perform the following task to link from Microsoft Outlook records to Siebel records.
To link to Siebel data from Microsoft Outlook
In Microsoft Outlook, select one or more calendar appointments, tasks, or contacts.
From the Siebel Options menu, choose Link Selected Item(s).
Note: You can also create links using the Siebel toolbar and the right-click menu.In the Create Siebel Links dialog box, from the Link Type drop-down list, choose a Siebel record type.
Select a record from the list, and then click Add.
When you have defined all of the links, click OK.
The links appear in Current Siebel Links on the Siebel toolbar and also on the Siebel Options, Quick Links list.
Related Topic
Using Outlook Add-In Quick Links
When you link to Siebel data from Microsoft Outlook, the link is automatically added to the Siebel Options, Quick Link list. You can use the Quick Link list to link one of the listed Siebel records to another Microsoft Outlook record, or records. By default, the Quick Link list retains links for 30 days. To change the Quick Link retention period, see Setting the Quick Link Retention Period.
The following procedure describes how to use a Quick Link.
To use a Quick Link
In Microsoft Outlook, select one or more calendar appointments, tasks, or contacts.
From the Siebel Options menu, choose Quick Links, and then choose the desired link.
The selected record is linked to the current Microsoft Outlook record, or records.
Related Topic
Using Outlook Add-In Links
When you link to Siebel data from Microsoft Outlook, the link is automatically added to the Current Siebel Links drop-down list on the Siebel toolbar. This list displays the Siebel links associated with the currently selected Microsoft Outlook record. Selecting a link from the list lets you access the Siebel record from Microsoft Outlook.
Links you create between Microsoft Outlook and Siebel objects are maintained, and the Microsoft Outlook object continues to be synchronized with the Siebel application until you remove the link, as described in Removing Links to Siebel Data.
The following procedure describes how to use a link.
To use a link
In Microsoft Outlook, select one or more calendar appointments, tasks, or contacts.
On the Siebel toolbar, choose a link from the Current Siebel Links drop-down list, and click Go.
The associated record is displayed in the Siebel application.
Related Topic
Removing Links to Siebel Data
This topic describes how to remove individual links or all the links associated with a Microsoft Outlook record.
The following procedure describes how to remove an individual link associated with a Microsoft Outlook record.
To remove individual links associated with a Microsoft Outlook record
In Microsoft Outlook, select a calendar appointment, task, or contact.
From the Siebel Options menu, choose Link Selected Item(s).
In the Create Siebel Links dialog box, under Siebel Links, select a link, and then click Remove.
When you have removed the appropriate links, click OK.
The following procedure describes how to remove all the links associated with a Microsoft Outlook record.
To remove all links associated with a Microsoft Outlook record
In Microsoft Outlook, select one or more calendar appointments, tasks, or contacts.
From the Siebel Options menu, choose Remove Current Link(s).
Note: You can also remove links using the right-click menu.Click Yes in the confirmation dialog box.
All links associated with the selected Microsoft Outlook records are removed.
Related Topic
About Using Outlook Add-In with the Mobile Web Client
Although the Siebel Mobile Web Client uses a local database and file system, and Outlook Add-in only downloads data from a server EAI object manager, and synchronization only runs on the server, not against the Siebel Mobile Web Client database, you can still use Outlook Add-In with the Mobile Web Client.
The following capabilities are available with Outlook Add-In even when your computer is not connected to a network:
You can create or modify Siebel links in Microsoft Outlook, whether Outlook is running in offline mode or connected to the Microsoft Exchange Server, provided that the Siebel records involved are already present in the desktop cache.
The desktop cache is refreshed only when the computer is connected to the Enterprise or Regional Siebel database. For this reason, records that are created in the local Siebel database are not present in the desktop cache until after the local database has been synchronized with the Enterprise or Regional database, and the desktop cache has been refreshed. A background process checks once a minute to determine whether the computer is connected to the Enterprise or Regional Siebel database and whether the refresh interval has passed. If both these conditions are met, then the cache is updated automatically. For information about setting the cache refresh interval, see Setting the Cache Refresh Interval.
If you create items such as Siebel links in Microsoft Outlook while working offline, then those items are cached in an .OST file. The next time you synchronize your offline Microsoft Outlook folders with your Microsoft Exchange Server folders, either automatically or manually, Outlook copies your cached items to the Exchange Server.
If you create an association by means of a Siebel link in Microsoft Outlook (for example, if you link an Outlook contact to a particular Siebel account in your local database), then the association is not visible in the Siebel Mobile Web Client until both of the following events have taken place:
The data in Microsoft Outlook reaches the Microsoft Exchange Server and is synchronized with the Siebel database by SSSE.
The local Siebel database is synchronized with the Enterprise or Regional database
For an example of a Siebel account being associated with a Microsoft Outlook contact record, after these two synchronizations have taken place, the account name appears in the contact record regardless of whether you are using the local database or the Enterprise or Regional database.