How To: Create an Outlook Solution Using Duet Enterprise Outlook Application Designer

Learn how to create a solution that displays the contact details about a sales contact.

Applies to: Duet Enterprise for Microsoft SharePoint and SAP Server 2.0 | Office 2010 | SharePoint Server 2010

In this article
Steps to Create the Sales Contact Display in the Outlook 2010 Business Content Inspector
Building Task Panes (Optional)
Building Actions (Optional)
Designing the Outlook Solution
Building the BCS Solution that Displays Sales Contact Data in Outlook 2010
Preparing Your Solution for Localization
Customizing Your Solution (Optional)
Packaging and Deploying the Outlook Solution

This topic shows you how to create a solution in Microsoft Outlook 2010 that displays the contact details of a sales contact in a task pane when the contact is displayed in the Outlook 2010 Outlook Inspector Window.

The solution also shows how to include an action for the contact external content type that opens the collaboration external list for the customer to which the sales contact is related, and an action that displays a message.

Steps to Create the Sales Contact Display in the Outlook 2010 Business Content Inspector

Use the following steps to create the solution for displaying sales contact information in Outlook 2010 (steps that are marked as optional are included for completeness):

  1. Build task panes (optional).

  2. Build actions (optional).

  3. Design the Outlook 2010 solution.

  4. Localize the solution.

  5. Customize the solution (optional).

  6. Package and deploy the Outlook 2010 solution.

Building Task Panes (Optional)

Microsoft Business Connectivity Services (BCS) provides two external data parts, a Rich List Web Part and an Microsoft InfoPath 2010 Web Part. The Rich List Web Part shows a list of entries from an external system. The InfoPath 2010 Web Part can show any InfoPath 2010 form (even forms with code-behind the form). You can display either of these external data Web Parts or any custom external data part in a task pane. By using Duet Enterprise, you can easily add task panes to your Outlook 2010 solution.

For our example, we will create a contact details form that contains information about the contact, including name, address, email information, and phone numbers.

For detailed instructions on how to create the task panes, see How to: Customize External List Forms Using Microsoft InfoPath (http://msdn.microsoft.com/en-us/library/ee554886.aspx) and Step 7 (Optional): Show External Data Parts in Outlook Task Pane (Layout.xml) (http://msdn.microsoft.com/en-us/library/ff394561.aspx).

Creating the Task Pane Layout File

After you have created the external data parts you want to display in a task pane, the next step is to create a layout file. This XML file defines the controls that are displayed in the task pane, which external content types they should be populated with, and any other custom properties that the control exposes. This is the file that you will upload in the Business Connectivity ServicesSolution Galleries and associate with an external list when designing an Outlook 2010 solution.

There are three ways to build a task pane:

  • Use built-in OBParts.

  • Create custom OBParts by using Visual Studio 2010.

  • Create the layout file manually as described in the following procedure.

To create the task pane layout file

  1. Create an XML file that follows the layout definition described in Sample Duet Enterprise XML Snippet: Layout Definition.

    Note

    The Duet Enterprise layout schema consists of the Business Connectivity Services layout schema and some extra metadata.

  2. If you are creating the XML file in Visual Studio, attach the Duet Enterprise Layout Schema and the BCS Layout schema.

    For more information about layout definitions, see the following resources:

    The following is an example of an XML file that follows the Duet Enterprise layout schema

    <?xml version="1.0" encoding="utf-8" ?>
    <Layout xmlns="http://schemas/oba/2010/Layout"
            Name="ContactDetails"
            Version="1.0.0.0">
              <EntityDependencies>
                <Entity Name="Contact"
                  Namespace="SAP.Office.DuetEnterprise.Account" 
                  Version="1.0.0.0" IsPrimary="true" />
              </EntityDependencies>
        <Container ContainerType="Stack" 
      xmlns="http://schemas.microsoft.com/office/2009/05/BusinessApplications/Layout" 
      xmlns:loc="http://schemas.microsoft.com/office/2009/05/BusinessApplications/Localization">
    <Children>
        <OBPart PartType="Custom" 
            QualifiedTypeName="ContactDetails.Taskpane, AssemblyName, 
            Version=14.0.0.0, Culture=neutral, PublicKeyToken=PublicKeyToken"
            DataSourceName="Context"
            Text="Contact"
            Description="Customer contact">
            <CustomProperties />
            <ActionNames />
         </OBPart>
      </Children>
    </Container>
    </Layout>
    

    Note

    The values for AssemblyName and PublicKeyToken are placeholders that you have to replace.

    The layout in this example has only a single custom Web Part. Your solution can include more custom Web Parts, Rich List Web Parts, or InfoPath Web Parts, if these are required.

  3. Save the file with a .xml extension (for example, ContactDetails.xml).

Create Custom OBParts Using Visual Studio

You can create custom Web Parts that are based on Windows Forms by using Visual Studio 2010. You can use the form designer to design the custom form and also add code to your form.

To create a custom OBPart

  1. Start Visual Studio 2010 by using the Run as Administrator option.

  2. In Visual Studio 2010, on the File menu, click New, and then select New Project.

    In the New Project dialog box, expand the Visual C# node, expand the Windows node, and then select Empty Project.

  3. Name the project Contact Details, and then click OK.

  4. In Solution Explorer, right-click the solution, and then point to Add Reference.

    Add references to the following assemblies (which are installed with Microsoft Office 2010):

    • Microsoft.BusinessData.dll

    • Microsoft.Office.BusinessApplication.RuntimeUi.dll

  5. In Solution Explorer, right-click the solution, point to Add, and then click Windows Form.

  6. In the Add New Item dialog box, expand the Visual C# Items node, select Windows Form, and then click Add.

  7. Design the form. Add fields such as name, customer, and job description.

  8. After you have designed the form, right-click the form in Solution Explorer, and then click View Code.

    Add the following using directives.

    using Microsoft.Office.BusinessApplications.Runtime.UI;
    using Microsoft.BusinessData.Runtime;
    
  9. Change the base class from Form to WinFormsOBPartBase.

    Now you can override the methods of the base class and also add other methods you may need.

  10. Override the OnDataSourceChanged method, which is called when the DataSource property is changed so that you can update your Web Part with the new data.

    The following code provides an example of an overriden OnDataSourceChanged.

    namespace ContactDetails
    {
        public partial class Taskpane : WinFormsOBPartBase
        {
            public Taskpane()
            {
                InitializeComponent();
            }
    
            protected override void 
            OnDataSourceChanged(Microsoft.Office.BusinessApplications.
            Model.DataSourceChangedEventArgs args)
            {
                base.OnDataSourceChanged(args);
    
                IEntityInstance contactInstance = this.DataSource as IEntityInstance;
                entityInstanceReference = contactInstance;
    
                try
                {
                    this.txtFirstName.Text = contactInstance["GivenName"].ToString();
                    this.txtLastName.Text = contactInstance["FamilyName"].ToString();
                    this.txtJobFunctionCode.Text = contactInstance["JobFunctionCode"].ToString();
                    this.txtJobFunction.Text = contactInstance["JobFunction"].ToString();
                    this.txtCustomerCode.Text = contactInstance["CustomerIdDisp"].ToString();
                    this.txtCustomerTitle.Text = contactInstance["CustomerIdDisp"].ToString();
                }
                catch(Exception excep)
                {
                    MessageBox.Show(excep.ToString(), "OBPLoad");
                }
            }
            private IEntityInstance entityInstanceReference = null;
    
        }
    }
    
  11. Change the Visual Studio 2010 project output type from Windows Application to Class Library.

  12. On the Build tab, ensure the target framework is NET Framework 3.5 and the target platform is Any CPU.

  13. On the Signing tab, ensure that the assembly is signed.

  14. Save all files and build the project.

    The custom Web Part is ready to be used in the Outlook 2010 task pane.

  15. Insert the following XML snippet into a task pane layout file.

    <OBPart PartType="Custom" 
            QualifiedTypeName="ContactDetails.Taskpane, $AssemblyName$, 
            Version=14.0.0.0, Culture=neutral, 
            PublicKeyToken=$PublicKeyToken$"
            DataSourceName="Context"
            Text="Contact"
            Description="Customer contact">
            <CustomProperties />
            <ActionNames />
    </OBPart>
    

Building Actions (Optional)

There are two types of actions: URL actions and code method actions. You can open a URL in the browser window by using URL actions. Code method actions can be used to run code and enable advanced scenarios by using the Business Data Connectivity (BDC) service object model.

Both URL actions and code method actions can have parameters passed to them. A parameter can be either a constant parameter or an expression parameter. A constant parameter is a constant value that is passed to the action during run time. When you are using Duet Enterprise, the value can be set while designing the Outlook 2010 solution. Expression parameters refer to a field on the external content type. The value passed to the action by the runtime is the value of that field for the external data item in whose context the action is invoked.

Actions are displayed to the user via the ribbon. For example, the View SAP actions button would appear on the Duet Enterprise tab of the ribbon.

Creating a Code Method Action

After building the code-behind assembly, you can create an XML action file for your code action. This file defines the metadata for the action. URL actions need only this action file. This is the file you will upload to the Business Connectivity ServicesSolution Galleries. You will also associate this file with an external list when you design an Outlook 2010 solution.

To create the class library project

  1. Start Visual Studio 2010 by using the Run as Administrator option.

  2. On the File menu, click New, and then click Project.

  3. In the New Project dialog box, expand the Visual C# node. In the Templates pane, click Class Library.

  4. Name the solution Greetings, and then click OK.

To create the code behind assembly for the code method action

  1. If you need access to the Business Connectivity Services object model, add references to the Business Connectivity Services assemblies: Microsoft.SharePoint and Microsoft.BusinessData.

  2. Write the code that you want to run when the action is invoked.

    The following is a simple code method action that displays a greeting message in a message box.

    namespace Greetings
    {
        /// <summary>
    
        /// The action definition passes in FirstName and LastName for the selected person instance.
        /// </summary>
        public class Greetings
        {
            /// <summary>
            /// The zeroth parameter dafaults to OfficeContext.
            /// First parameter is constant type and a welcome string such as "Hello" or "Hi".
            /// Second and third are expression types and are FirstName and LastName respectively.
            /// </summary>
            /// <param name="actionParams"></param>
            public void SayGreetings(params object[] actionParams)
            {
                string message = null;
                try
                {
                    message = String.Format("{0} {1} {2}!",
                        actionParams[1], actionParams[3], actionParams[2]);
                }
                catch (Exception exception)
                {
                    message = exception.Message;
                }
                MessageBox.Show(message, "GreetingsAction2");
            }
        }
    }
    
  3. Save the project and build it. This assembly can now be used with the metadata as a code method action.

To create the code method XML action file

  1. Create an XML file for the code action. For an XML snippet showing a sample code action, see Sample Duet Enterprise XML Snippet: Code Action.

  2. If you are creating the XML file in Visual Studio 2010, attach the Duet Enterprise Layout Schema. This will give you IntelliSense functionality, and also help you create valid entries.

    For an XML snippet that shows a sample XML layout, see Sample Duet Enterprise XML Snippet: Layout Definition.

  3. Create a CodeMethodAction element with details of the SayGreetings method that you created in the previous step. Also provide the parameters required by that method.

    The following XML snippet shows how the file might look after editing.

    <?xml version="1.0" encoding="utf-8" ?> 
    <Action xmlns="http://schemas/oba/2010/Action" Name="Greetings" Version="1.0.0.0">
    <CodeMethodAction  MethodType="Custom"
     Name="SayGreetings"
     QualifiedTypeName="Greetings.Greetings, AssemblyName, Version=14.0.0.0, Culture=neutral, PublicKeyToken=PublicKeyToken"
     MethodName="SayGreetings">
      <Parameters>
            <ConstantParameter Name="GreetingsString" Value="Greetings" ValueType="System.String"/>
            <ExpressionParameter Name = "FirstName" Expression="GivenName" ValueType="System.String"/>
         <ExpressionParameter Name = "LastName" Expression="FamilyName" ValueType="System.String"/>
      </Parameters>
    </CodeMethodAction>
    </Action>
    

    Note

    The values for AssemblyName and PublicKeyToken are placeholders that you will need to replace.

  4. Save the file with a .xml extension.

Creating the URL Action

The URL actions will enable the user to open a URL in the browser window.

In this procedure you will create a URL action file named CollabOn.xml.

To create a URL action

  1. Create an XML file according to the Duet Enterprise Action schema. For an example of a file that follows this schema see, Sample Duet Enterprise XML Snippet: Code Action.

  2. If you are creating the XML file in Visual Studio 2010, attach the Duet Enterprise Action schema. This will give you IntelliSense functionality, and also help you create valid entries.

    There should be a URLAction element with details of the URL top open, and the parameters expected.

    The following example shows how the file might look after editing.

    <Action xmlns="http://schemas/oba/2010/Action" 
            Name="OpenCustomerExternal List" 
            Version="1.0.0.0">
      <EntityDependencies>
     <Entity Name="Contact" Namespace= "SAP.Office.DuetEnterprise.Account" Version="1.0.0.0" IsPrimary="true" />
      </EntityDependencies>
      <UrlAction Name="OpenExternal List" 
          Url="http://MyServer/_layouts/OBA/CollabSiteRedirect.aspx?
          CustomerId={0}&amp;EntityName=Account&amp;
          EntityNamespace=SAP.Office.DuetEnterprise.Account&amp;
          LobsystemInstance=Account">
       <Parameters>
         <ExpressionParameter Name="Param1" Expression="CustomerId" ValueType="System.String" />
       </Parameters>
     </UrlAction>
    </Action>
    
  3. Save the file with a .xml extension.

Designing the Outlook Solution

After you have created the building blocks (task panes, actions, and supporting assemblies), you can design the Outlook solution by using the Duet EnterpriseOutlook Application Designer. The Outlook 2010 Application Designer lets you work with one or more external lists while offline in Outlook You can also associate task panes and actions with these external lists. The task panes and actions can be reused for multiple solutions. Select the site collection where you want to develop the solution and follow the steps described in the following sections.

Enabling Libraries in the Site Collection

Before you can enable libraries in the site collection, you have to upload the building block files to the site collection. Later in the process, you create a package of building block files to download to Outlook 2010. Then, you enable the libraries on the site collection that stores these building block files.

To enable libraries on the site collection

  1. On the Site Actions menu, click Site Settings.

  2. Under Site Collection Administration, click Site collection features.

    Note

    If the Site collection features option does not appear, then click Go to top level settings under Site Collection Administration. The Site Collection Features option will now appear.

  3. On the Features page, in the Business Connectivity ServicesSolution Galleries, click Activate.

Upload the Building Block Files to the Site Collection

You are now ready to upload the source files to the site collection, starting with the assembly files. The following procedure describes how to upload the building block files to the site collection.

To upload the building block files to the site collection

  1. Click Site Collection Administration on the breadcrumb navigation at the top of the page.

  2. On the Site Settings page, under BCS Solution Galleries, click Application Assemblies.

  3. On the All Documents page, click Add document. Then, in the Upload Document window, click Browse to navigate to the DLL file, and then click OK.

    Note

    Duet Enterprise will not allow you to upload DLL files directly, so ensure that you have renamed *.dll to *.dll.deploy.

  4. On the Site Actions menu, click Site Settings.

  5. On the Site Settings page, under BCS Solution Galleries, click Task Panes.

  6. On the All Documents page, click Add document. Then, in the Upload Document window, click Browse to navigate to the task pane file (for example, ContactDetails.xml), and then click OK.

  7. On the Site Actions menu, click Site Settings.

  8. On the Site Settings page, under BCS Solution Galleries, click Business data actions.

  9. On the All Documents page, click Add document. Then, in the Upload Document window, click Browse to navigate to the action file (for example, CollabOnAction.xml), and then click OK.

    Note

    Ensure that after each building block is uploaded, the Error Message field is marked as OK. Only building blocks with this status can be used later. If the error status displays any message other than OK, you should resolve any associated problems. The most common cause of error messages is badly formed XML.

Building the BCS Solution that Displays Sales Contact Data in Outlook 2010

A Business Connectivity Services solution is a package of downloadable files that enable specific functionality. In this case, the Business Connectivity Services solution contains a collection of files that together enable elements of a Duet Enterprise external list to function offline. It includes external lists, Business Connectivity Services solution task panes, and BCS Data Actions. When you create a Business Connectivity Services solution, the resulting objects are named Business Connectivity Services solution artifacts.

Business Connectivity Services solution artifacts are the files that are required in an Outlook 2010 solution. These include files such as the BCS Client Runtime, OIR.config file, ribbon file, and resource files. The layout files are generated from the task pane building blocks. The action files do not need to be copied, because the metadata that they contain is integrated into the OIR.config file. The supporting assemblies are also copied to the Business Connectivity Services solution artifacts folder in the site.

Overview: Building the BCS Solution that Displays Sales Contact Data in Outlook 2010

Use the following steps to build the Business Connectivity Services solution that displays sales contact data in Outlook 2010.

  1. Create the external lists that you want to take offline in Outlook 2010.

  2. Configure a setting that will make the external list available offline in Outlook 2010.

  3. Add the Business Connectivity Services solution task pane files for the external list.

  4. Add the Business Data action files for the external list.

  5. Generate the Business Connectivity Services solution artifacts.

To create the external lists

  1. Create a Site in the site collection where you have uploaded the building blocks.

  2. Navigate to this site.

  3. Under Site Actions, click More Options.

  4. From the list of installed items, select External List.

  5. In the resulting page, provide a name and select the desired external content type.

    Optionally, repeat the previous steps to create another external list.

To configure an external list for offline availability

  1. Navigate to the site in the site collection where you have uploaded the building blocks.

  2. On the Site Actions menu, click Site Settings.

  3. On the Site Settings page, under Site Actions, click Manage site features.

  4. On the Features page, locate the BCS Solution Design Feature, and then click Activate.

  5. Click Site Settings on the breadcrumb navigation at the top of the page.

  6. On the Site Settings page, under Duet Enterprise Administration, click Outlook Application Designer.

  7. On the Outlook Application Designer page, under External Lists, click the external list you want to use offline.

  8. On the Outlook settings page, under List Settings, click Outlook Client Settings.

  9. In the Edit Outlook settings for this external list dialog box, select the Offline this external list to Outlook check box and Auto generate Outlook forms check box, and then click OK.

    Optionally, repeat the previous steps to configure another external list. You are ready to add the task pane files for the external list.

To add the business data task pane files for the external list

  1. On the Outlook settings page, under Task Panes, click Add from Business Data Task Panes Gallery.

  2. In the Add task pane dialog box that opens, in Select a task pane, choose a task pane from the available task panes.

    Note

    If you do not see any task panes listed, it might mean that your task pane contains an error. Resolve the error to proceed.

  3. In Display properties, type a display name and a tool tip for the task pane. A tool tip is the text that appears when you hover over the task pane in Outlook 2010.

  4. In Default task pane, click Make this the default task pane if you want to make the selected task pane the default task pane.

  5. Click OK.

    Optionally, repeat the previous steps to add more task panes. You are now ready to add the action files for the external list.

To add the business data action files for the external list

  1. On the Outlook settings page, under Business Data actions, click Add from Business Data Actions Gallery.

  2. In the Add business data actions dialog box that opens, in Select a business data action, select an action from the available actions.

    Note

    If you do not see any actions listed, it might mean that your action contains an error. Resolve the error to proceed.

  3. In Display properties, type a display name and a tool tip for the action. The tool tip text appears when you hover over the task pane in Outlook 2010.

  4. Click OK.

  5. In Map business data action parameters, select a field from the list of entity fields.

  6. You can also type in values for constant parameters.

  7. Click OK.

    Optionally, repeat the previous steps to add more action files.

To generate the BCS solution artifacts

  1. On the Outlook settings page, click Back to the Outlook Application Designer page.

  2. Click Generate BCS Solution Artifacts.

  3. Click OK when you get a message that the operation succeeded.

After you have added a task pane or an action, you have the option to edit the settings for that item from the Outlook 2010 Settings page. If you click on the task pane or action name, a page opens where you can edit all the settings you entered while adding the item. If you edit these settings, you will have to follow the steps in the previous procedure again and follow all subsequent steps for the changes to be reflected in the Outlook Solution.

Deleting the Business Data Task Panes or Business Data Actions

After you add a task pane or an action, you have the option to delete that item from the Outlook 2010 Settings page. If you click on the task pane or action name, a page opens where you can delete the item. You will have to follow the steps in Generate the BCS Solution Artifacts again, and follow all subsequent steps for the changes to be reflected in the Outlook solution.

Note

Deleting the item will not remove it from the Building Block Gallery. It removes only the association of the item with this external list.

Preparing Your Solution for Localization

The process of preparing your solution so it can be used in other locales is known as localization. Localization consists of translating resources to a specific language. For more information, see Globalizing and Localizing Applications (http://msdn.microsoft.com/en-us/library/1021kkz0.aspx).

You should include a neutral resource file (one that is not associated with any locale) in your solution if there is a chance that your solution will be downloaded on a client that uses a language other than the ones supported by the resource files that are included in the solution. For more information, see Localizing SharePoint Solutions (http://msdn.microsoft.com/en-us/library/ee696750.aspx).

You create some of the files required for the Outlook 2010 solution by following the steps in Generate the BCS Solution Artifacts. These files can be found in the BCS Solution Artifacts document library. You can see that by default the ribbon and resource files have been generated only for the en-us locale. For other locales, you will have to create the ribbon and resource files and then upload them to this document library. The steps in the following procedure create these files for the Japanese (ja-jp) locale.

To localize for other locales

  1. Under Site Actions, click View All Site Content.

    Under Document Libraries, click BCS Solution Artifacts.

  2. Download the ribbon files named *Ribbon.en-US.xml.

  3. Download the resource file named Resources.en-US.resx.

  4. For each *Ribbon.en-US.xml file, create a corresponding *Ribbon.ja-JP.xml file that replaces the English strings for labels and screen tips with the corresponding localized strings.

  5. Create a Resources.ja-JP.resx file that is identical to Resources.en-US.resx.You can then localize the following strings:

    • Folder Display Name in Outlook (replace the English string with a corresponding localized string)

    • Solution Display Name in Outlook (replace the English string with corresponding localized string)

    • (replace the file name of the English ribbon with the file name of the corresponding localized ribbon)

  6. Upload Resources.ja-JP.resx and *Ribbon.ja-JP.xml to the BCS Solution Artifacts document Library.Repeat these steps to localize to other languages as you want.

Customizing Your Solution (Optional)

At this point, you can optionally customize the Outlook solution by editing the solution manifest file, named OIR.config. Some of the scenarios which cannot be created by using Duet EnterpriseOutlook Application Designer can be created in this way. You can also customize the ribbon and improve its appearance and behavior (look and feel).

We recommend that you skip these customizations in the initial development of your solution. First, create the solution with only the actions and task panes. When the basic functionality works as you expect, extend the solution with one or more of the customizations described in the following sections as needed.

Customizing the Solution Manifest File (OIR.config)

The solution manifest file (OIR.config) is the main file that the Business Connectivity Services client runtime uses to configure your intermediate declarative Outlook solution.

To create a custom view definition in Outlook

  1. Customize the view that is shown for a folder containing external data. Business Connectivity Services provides a command to save the customized view as an Outlook View Definition (.ovd) file, so that it is available to users who install the declarative solution.

    For detailed steps, see Step 6 (Optional): Create Custom Outlook View Definitions (*.ovd) (http://msdn.microsoft.com/en-us/library/ee819848.aspx).

    After you have created the .ovd file, you must update the OIR.config file that contains the details about the view definition.

  2. Add a FolderViewDefinition child element to the Views element in the OIR.config file.

    The following example shows how the Views element might appear after you edit it.

    <Views>
      <FolderViewDefinition Name="ContactView" 
                            ViewName="ContactView" 
                            ViewType="TableView" 
                            IsDefault="true" 
                            ViewFileName="ContactView.ovd" />
    </Views>
    
  3. Upload the Outlook View Definition (*.ovd) files to the BCS Solution Artifacts document library. This will ensure that these files are included in the ClickOnce package that is generated.

To customize Outlook form regions

  1. You can create customized Outlook form regions that show external data by designing new form regions in Outlook.

    For detailed steps about how to create an Outlook form region (*.ofs) file and a form region manifest (FormRegionManifest.xml) file, see Step 5 (Optional): Create the Outlook Form Region (*.ofs) and Form Region Manifest (FormRegionManifest.xml) (http://msdn.microsoft.com/en-us/library/ee819887(v=office.14).aspx).

  2. After you create the .ofs and .xml files, you have to update the OIR.config file with the details of the custom form region. Add a FormRegion child element to the FormRegions element in the OIR.config file.

    The code in the following example shows how the FormRegions element might appear.

    <FormRegions xsl:type="Declarative:DeclarativeFormRegions">
                  FormRegion Name="Contact" InternalName="ContactForm" 
                  FormFileName="formRegionContact.ofs" 
                  ManifestFileName="formRegionContact.manifest.xml" />
    </FormRegions>
    
  3. Upload the Outlook form region (*.ofs) files and form region manifest files to the BCS Solution Artifacts document library. Doing so ensures these files are included in the ClickOnce package.

Customizing the Ribbon

You can use Visual Studio to customize the ribbon. You do not need to edit the OIR.config file to customize the ribbon.

To customize the ribbon

  1. Download the OutlookContact_Ribbon.en-US.xml from the BCS Solution Artifacts document library.

  2. Customize the OutlookContact_Ribbon.en-US.xml file, then reupload the file.

    Make sure to use this customized ribbon as the template for creating localized versions of the ribbon.

For detailed instructions, see the following resources:

Packaging and Deploying the Outlook Solution

After you generate the Business Connectivity Services Solution Artifact, you or other users with the necessary permissions can generate the Business Connectivity Services solution and download the solution in Outlook 2010. The Business Connectivity Services solution has to be generated on the production environment from which you want users to download the solution.

Moving Artifacts to the Production Environment

Move the artifacts to the production environment by doing the following:

  1. Save the site as a template.

  2. Upload the solution to the production environment.

  3. Create a new site in the production environment.

To save the site as a template

  1. On the Site Settings page, under Site Actions, click Save site as template.

  2. Provide the file name, template name and template description as you want. Select the Include Content check box, and then click OK.

  3. Go to the Site Settings page of the top-level site, and under Galleries, click Solutions. Click the template to download the solution package (.wsp) file.

To upload the solution to the production environment

  1. Go to the Site Settings page of the top-level site in the production environment where you want to deploy the Outlook 2010 solution.

    Under Galleries, click Solutions. Click Upload Solution, and then browse to the solution package (.wsp) file saved in the previous step.

  2. After the template is visible in the Solutions Gallery, click it and select Activate on the ribbon.

To create a new site in the production environment

  1. Create a site in the site collection where you have uploaded your solution, and from the Custom category ,choose the template that you have activated.

    Note

    All of the site collection features activated in the development environment where this template was created must be activated in the site collection on the production environment also. If this is not what you want, deactivate the feature in the development site before saving it as a template.

  2. This site will have the BCS Solution Artifacts document library, and you can proceed with generation of the Business Connectivity Services solution.

Generating the BCS Solution for Displaying Sales Contact Data

The procedure in this section describes how to generate the Business Connectivity Services solution for displaying sales contact data so that you can download it and use it in Outlook 2010.

To generate the BCS solution for displaying sales contact data

  1. On the Site Actions menu, click Generate BCS solution.

  2. On the Generate BCS Solution page, in the Certificate category, select a certificate, and then click OK.

    Note

    If the OK button is not available, the farm administrator has not uploaded the necessary certificates to the Trusted Publishers and Trusted Root Certification Authorities stores in the farm. Contact your server administrator for further assistance.

  3. Click OK on the webpage to confirm that the operation succeeded. Duet Enterprise opens the All Documents page, where you can download the solution in Outlook 2010.

  4. In the All Documents page, you can also manage permissions for the solution. This means you can add users who can download the solution in Outlook 2010, or even remove users.

Downloading the BCS Solution in Outlook 2010

The procedure in this section describes how to download the Business Connectivity Services solution that you have created so that you can use it in Outlook 2010.

To download the solution in Outlook 2010

  1. On the Site Actions menu, click Download BCS Solution, and then click Allow.

  2. In the Microsoft Office Customization Installer dialog box, click Close.

    The solution now opens automatically in Outlook 2010.

See Also

Concepts

Sample Duet Enterprise XML Snippet: URL Action

Sample Duet Enterprise XML Snippet: Code Action

Sample Duet Enterprise XML Snippet: Layout Definition