Show TOC

Creating GWM Outlook Add-In TemplateLocate this document in the navigation structure

Creating a GWM Outlook add-in template.


To create a template using GWM Outlook Add-in wizard, proceed as follows:


  1. Open Microsoft Visual Studio.
  2. Choose New Project from the Starter page.
    The New Project screen appears.
  3. From the Visual C# node under Installed Templates, choose Start of the navigation path GWM  Next navigation step  GWM Outlook 2010 Add-in End of the navigation path or GWM Outlook 2013 Add-in.
    The GWM Outlook Add-in wizard opens. It shows the selected default Microsoft Outlook item, Contacts, at the top of the wizard page.
  4. Select the Microsoft Outlook item for which you want to create a template for your add-in.
    You can create templates for the following Microsoft Outlook items:
    • Contacts

      Select the Contacts item to create a template for it in your add-in.

    • Appointments

      Select the Appointments item to create a template for it in your add-in.

    • Tasks

      Select the Tasks item to create a template for it in your add-in.

    Note The number of steps and activity in the wizard changes according to the selected Microsoft Outlook item you want as a template.
  5. Enter a name for the template, and choose Next. The Select Service page displays.
    A default name, Contacts01, is provided based on the selected default item, Contacts.
    Note Only alphanumeric characters are allowed in the name. A red box in the name field indicates an error.
  6. In the Select Service page, select the System Type from the dropdown as Gateway (NetWeaver Gateway), SMP (SAP Mobile Platform) or Azure (Azure Cloud Services) and then, you can do one of the following:
    • Enter the URL of the OData service in the Service URL field, and click Go. Provide system specific authentication details if prompted.
      The service URL is the path to access the service document of the OData service and is system specific. The format of the service URL is based on the system type selected:
      • Gateway: "http(s)://<Host>:<Port>/<Gateway Service Endpoint>//"
      • SAP Mobile Platform (SMP): "http(s)://<SMPServer>:<Port>/<AppID>" or "http(s)://<SMPServer>:<Port>/<AppID>/<ConnectionName>"
      • Azure: "http(s)://<Host>:<Port>/<ProviderSystemName>/<Gateway Service Endpoint>"
    • Click Browse to open the Browse Services window.

      In the Browse Services window, you can search for the OData service you want. Provide your login credentials and connection settings to connect to the selected system, and choose Connect. Now, search for the service from the list by providing the service name, service description, application name or provider name, and then choose Select Service.

      Only Basic authentication is supported when accessing OData services through SMP, and OAuth authentication in Azure. Ensure that the system status is Connected to see the refreshed list of services under each provider. Otherwise, only services from the last fetch will be shown.

  7. Choose Next. The Select Collection page displays.
    You can navigate and view the details of each collection in the service.
    When you select a collection, all the properties and entries of the selected collection display on the right hand side of the wizard page. The icons for the Create, the Update, and the Delete (CUD) functionality are selected to indicate that they are supported in the selected collection.
    Note There is no indication if a functionality is not supported in the service.
    The selected service name displays at top of the page.
  8. Select the collection you want. The service name displays at top of the page, and the properties in the selected collection are listed.
    A key icon indicates the properties that are set as keys in the list of properties.
  9. Choose Next. The Map Properties page displays.
    The name of the collection containing the properties displays at the top of the page.
  10. Match properties in the collection to their corresponding Microsoft Outlook control (labels) properties. From the left pane in the wizard page, drag and drop a property of the service under SAP Properties, onto the Microsoft Outlook fields on the right.
    The Outlook Properties presented in the wizard are dependent on the selected Microsoft Outlook item for which you are creating the template. Additional fields appear for some properties when you select them.
  11. Choose Next. The Additional Properties page displays.
    In the Additional Properties page, you can add further customization, and view the associations defined in the service for navigation options.
  12. Optionally, select the check box, Custom Tab, and provide a name for a custom tab in the Custom Tab Name field. From the Select Associated Information Tab, optionally select the navigation property check box you want to provide. A default name is specified in the Tab Name. You can change the name.
    By default, the Custom and the Association tabs are automatically selected with default names.

    The wizard creates a tab control for both the custom and associate information tabs, if they are selected. The custom tab will contain the list of properties you want to make available to Microsoft Outlook users of the add-in. This list will allow users to customize the add-in by adding and removing the properties.

    The associated information tab will contain the list of navigational properties you want to make available to Microsoft Outlook users of the add-in. The listed associations will allow users to navigate from property to property

    You can view all the associations in the service.

    Optionally, you can select the following:

    • Enable User to Create New Items and specify the a name for the button you want to enable for users to add items.
    • Create project in a new folder to place the generated content into a new project folder.
  13. Choose Next; the Project summary page displays with the specified template name, the selected the template type, the selected service and collection name.

    All the templates you have created in the project are listed in the Project summary page.

    To edit the settings for a listed template, you can choose, Back. To remove the template from the project, click the X icon, Remove.

    To create another template, choose the + Add Template. The first page of the wizard opens.

  14. Choose Generate Project to generate code and resources for the template or templates into a project.