Deploy and configure the Aggregated Business Calendar solution (Duet Enterprise)

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

Complete the procedures in this article to deploy and configure the Aggregated Business Calendar solution.

Add the solution packages for the Aggregated Business calendar

This section shows how to add the solution package (.wsp) files that comprise the Aggregated Business Calendar feature. The OBAExtensions.wsp file in the Core folder provides the core functionality for the Aggregated Business Calendar feature and is language neutral. You must add the OBAExtensions.wsp file to the SharePoint farm regardless of the language that you want to use for this feature. The remaining twelve .wsp files (see the following table) in the Core folder are files for specific languages which you can add to your farm if you want to use the Aggregated Business Calendar feature on a site that is in a language other than English (United States). For example, to use the Aggregated Business Calendar on an English language site only, you must add the OBAExtensions.wsp file. If you want to use the Aggregated Business Calendar on a French language site only, you must add the OBAExtensions.wsp file and the OBAExtensions.fr-fr.wsp (French language) file.

The following table lists the file names for all language-specific .wsp files.

Table 1 – Language support

Note that the .wsp files in Table 1 are supported only on Microsoft SharePoint Server farms in which Duet Enterprise for Microsoft SharePoint and SAP and the Duet Enterprise 1.0 language pack of the same language have been installed. For information about how to deploy Duet Enterprise, see Deployment (Duet Enterprise).

Before you can deploy a solution package, you must add it to the solution database of a SharePoint Server farm.

To add the OBAExtensions.wsp file by using Windows PowerShell

1. Log on to a server in the SharePoint Server farm as a member of the Administrators group. Verify that you meet the following minimum requirements: See Add-SPShellAdmin.

2. Open the SharePoint 2010 Management Shell.

   1. On the Start menu, click All Programs.

   2. Click Microsoft SharePoint 2010 Products.

   3. Right-click SharePoint 2010 Management Shell and then click Run as administrator.

3. At the Windows PowerShell command prompt, type the following command:

   Add-SPSolution -LiteralPath <SolutionPath>\OBAExtensions.wsp
   

   Where <SolutionPath> is the path of the .wsp file.

   For example, if you copied the .wsp files to c:\solutions, type Add-SPSolution -LiteralPath c:\solutions\OBAExtensions.wsp.

4. Press Enter.

   After successfully adding the solution, the name of the .wsp file and its assigned SolutionID are displayed in the Windows PowerShell command prompt.

   If you do not plan to use the Aggregated Business Calendar Web Part on a site other than an English language site, skip to Verify that solutions are in the solution store. Otherwise, proceed to the next procedure.

To add the language-specific .wsp files by using Windows PowerShell

1. Log on to a server in the SharePoint Server farm as a member of the Administrators group. Verify that you meet the following minimum requirements: See Add-SPShellAdmin.

2. Open the SharePoint 2010 Management Shell.

   1. On the Start menu, click All Programs.

   2. Click Microsoft SharePoint 2010 Products.

   3. Right-click SharePoint 2010 Management Shell and then click Run as administrator.

3. At the Windows PowerShell command prompt, type the following command:

   Add-SPSolution -LiteralPath <SolutionPath>\<WSPfilename.wsp> -Language <LanguageID>
   

   Where

   <SolutionPath> is the path of the .wsp file

   <WSPfilename.wsp> is the full path of the language-specific .wsp file that you want to add (see the “File name” column of Table 1 earlier in this article).

   <LanguageID> is the Language ID of the solution that you are adding. See the “Language ID” column of Table 1.

   For example, if you copied the .wsp files to c:\solutions and you want to install the .wsp file for the Japanese language, type Add-SPSolution -LiteralPath c:\solutions\OBAExtensions.ja-jp.wsp -Language 1041.

4. Press Enter.

   The command prompt displays the Solution ID of the core solution package (OBAExtensions.wsp) and returns the command prompt.

   Tip

   The word True appears in the Deployed column of the command prompt message. This means that the solution has been added to the solution store. It does not mean that the solution has been deployed to a web application. You will deploy solutions to web applications in a later procedure.

5. Repeat steps 3 and 4 for each additional language specific solution you want to add.

The solutions are added to the farm's solution store. To use the solution, follow the procedure in the next section in this article. For more information about how to import solutions, see Adding a solution package.

Verify that solutions are in the solution store

Use this procedure to verify that the solutions were imported to the farm’s solution store.

To verify that the solutions are in the solution store

1. In Central Administration, on the Quick Launch, click System Settings.

2. In the Farm Management section, click Manage farm solutions.

3. On the Solution Management page, verify that the obaextensions.wsp and all language-specific .wsp files that you added) are listed in the Name column. If they are not, add the .wsp files again.

   Note

   The names of the language-specific solutions appear in the form of obaextension.wsp(<LanguageID>) where the LanguageID is the value that you assigned to the –Language parameter when you added the solution. For example, if you used language ID 1031 when you added the German language solution in the previous procedure, it would appear as obaextensions(1031) on the Solution Management page.

The solutions that you imported are not yet deployed. Follow the steps in the next section to deploy them.

Deploy the solution packages

After you have used the Windows PowerShell Add-SPSolution cmdlet to add a solution to the solution store, you must deploy the solution to a Web application before you can access it. You can use the Central Administration Web site or Windows PowerShell to deploy solutions that you added. The result of deploying solutions using Central Administration is the same as deploying them with Windows PowerShell except that the permissions required by these two methods are different. You must be a member of the Farm Administrators group to use the Central Administration web site to deploy solutions. You must be a member of the Administrators group on a computer running SharePoint Server 2010 and have the permissions described in Add-SPShellAdmin to use the Windows PowerShell method.

The Aggregated Business Calendar Feature is not available to activate on sites until you deploy the solutions that you imported. Note that you can deploy these solutions to one or more specific web applications.

We recommend that you deploy the solutions only on site collections that are within web applications that have been enabled for Duet Enterprise if you plan to add an SAP calendar as a data source to the Aggregated Business Calendar Web Part. For more information about how to enable a web application for Duet Enterprise, see Configure secure communications between the SharePoint and SAP environments (Duet Enterprise).

In this section:

• Deploy solutions using Central Administration

• Deploy solutions using Windows PowerShell

Deploy solutions using Central Administration

Follow the procedures in this section to use the Central Administration web site to deploy the solutions.

To deploy the OBAextensions.wsp solution by using Central Administration

1. You must be a member of the Farm Administrators group to perform this procedure.

2. On the Central Administration Home page, in the Quick Launch click System Settings.

3. In the Farm Management section, click Manage farm solutions.

4. On the Solution Management page, click obaextensions.wsp.

5. On the Solution Properties page, click Deploy Solution.

6. On the Deploy Solution page, in the Deploy When section, select one of the following:

   • Now

   • At a specified time. If you select this option, use the date and time boxes to specify a time. We recommend that you select a time when the load on the destination servers is low.

7. Click OK.

   On the Solution Management page, the Deployed To column of the obaextensions.wsp row displays the URLs to which the solution was deployed.

If you do not plan to use the Aggregated Business Calendar Web Part on a site other than an English language site, skip to Verify that the solutions were deployed. Otherwise, proceed to the next procedure.

To deploy a language-specific solution by using Central Administration

1. You must be a member of the Farm Administrators group to perform this procedure.

2. On the Central Administration Home page, click System Settings.

3. In the Farm Management section, click Manage farm solutions.

4. On the Solution Management page, click the name of the language-specific .wsp file that you imported earlier in this article (for example obaextensions.fr-fr.wsp). See Table 1 for the names of the language specific .wsp files.

5. On the Solution Properties page, click Deploy Solution.

6. On the Deploy Solution page, in the Deploy When section, select one of the following:

   • Now

   • At a specified time. If you select this option, use the date and time boxes to specify a time. We recommend that you select a time when the load on the destination servers is low.

7. On the Deploy Solution page, in the Deploy To? section, in the Choose a Web application to deploy this solution list, select the web application to which you want to deploy the solution.

8. Repeat steps 4 through 7 if you want to deploy the solution to additional web applications.

9. Repeat steps 1 through 7 to deploy an additional language-specific solution.

10. Go to Verify that the solutions were deployed.

For information about how to deploy solutions, see Deploying a solution package.

Deploy solutions using Windows PowerShell

In this section:

• Deploy the OBAExtensions.wsp solution using Windows PowerShell

• Deploy a language-specific solution using Windows PowerShell

Deploy the OBAExtensions.wsp solution using Windows PowerShell

To deploy the OBAExtensions.wsp solution using Windows PowerShell

1. Log on to a server in the SharePoint Server farm as a member of the Administrators group. Verify that you meet the following minimum requirements: See Add-SPShellAdmin.

2. Open the SharePoint 2010 Management Shell.

   1. On the Start menu, click All Programs.

   2. Click Microsoft SharePoint 2010 Products.

   3. Right-click SharePoint 2010 Management Shell and then click Run as administrator.

3. At the Windows PowerShell command prompt, type the following command:

   Install-SPSolution -Identity <path>OBAExtensions.wsp -WebApplication <SPWebApplicationPipeBind> -GACDeployment
   

   Where

   <path> specifies the path to the OBAExtensions.wsp file.

   <SPWebApplicationPipeBind> deploys the SharePoint solution for the specified SharePoint Web application.

   The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.

   For example, to deploy the OBAExtensions solution to the http://contoso:82 web application, type Install-SPSolution -Identity OBAExtensions.wsp -WebApplication http://contoso:82 -GACDeployment.

4. Press Enter.

   After a successful deployment, the command prompt is returned. If an error message occurs, read the error message, make the necessary corrections to the syntax and try again.

For more information about how to use Windows PowerShell to deploy solutions, see Install-SPSolution.

Deploy a language-specific solution using Windows PowerShell

Use this procedure to deploy language-specific solutions. Otherwise, if you have not added any language-specific solutions, skip to Verify that the solutions were deployed.

You must globally deploy the language-specific solutions that provided with Feature Pack 1. Therefore, the –WebApplication parameter is not supported.

To deploy a language-specific solution using Windows PowerShell

1. Log on to a server in the SharePoint Server farm as a member of the Administrators group. Verify that you meet the following minimum requirements: See Add-SPShellAdmin.

2. Open the SharePoint 2010 Management Shell.

   1. On the Start menu, click All Programs.

   2. Click Microsoft SharePoint 2010 Products.

   3. Right-click SharePoint 2010 Management Shell and then click Run as administrator.

3. At the Windows PowerShell command prompt, type the following command:

   Install-SPSolution -Identity OBAExtensions.wsp -Language <LanguageID> -GACDeployment
   

   Where

   <LanguageID> is the Language ID of the solution that you are adding. See the “Language ID” column of Table 1.

   For example, to deploy the language specific solution for the French language, type Install-SPSolution -Identity OBAExtensions.wsp -Language 1036 -GACDeployment.

4. Press Enter.

   After a successful deployment, the command prompt is returned. If an error message occurs, read the error message, make the necessary corrections to the syntax and try again.

5. Repeat steps 3 through 4 to deploy additional language-specific solutions. See Table 1 earlier in this article for a list of the language-specific solutions.

Verify that the solutions were deployed

Use this procedure to verify that the solutions were deployed.

To verify that the solutions were deployed

1. You must be a member of the Farm Administrators group to perform this procedure.

2. On the Central Administration Home page, click System Settings.

3. In the Farm Management section, click Manage farm solutions.

4. On the Solution Management page, in the Name column, click the name of the solution that you deployed. For example, obaextensions.wsp.

5. On the Solution Properties page, the entities to which each solution was deployed (either globally deployed or the URLs of the web applications to which the solution is deployed) are listed in the Deployed To row.

6. Click Back to Solutions to return to the Solution Management page.

7. Repeat steps 4 through 6 for any additional solutions that you want to verify.

Prepare the calendar data sources

This section shows the steps that a member of the Windows Administrators group and a member of the SharePoint Farm Administrator group must complete to prepare calendar data sources. Complete these steps for the data sources that you want to add to the Aggregated Business Calendar Web Part before a member of the site Owners group can add them to the Web Part.

After the data sources are prepared, a member of the site Owners group can add up to four calendars of any of the following types to the Aggregated Business Calendar Web Part: SharePoint calendar, Exchange calendar, SAP Business calendar, or custom calendar. For example, a member of the site Owners group can add two SharePoint calendars, one Exchange calendar, and one SAP Business calendar or four SAP business calendars. Any combination of these calendar types is supported.

In this section:

• Prepare to a SharePoint calendar data source

• Prepare an Exchange calendar data source

• Prepare an SAP calendar data source

Prepare to a SharePoint calendar data source

Members of the Windows Administrators group or the Farm Administrators group do not prepare a SharePoint calendar data source. Instead this preparation is done by a member of the site Owners group.

For more information about these prerequisites, see Add and use the Aggregated Business Calendar Web Part (https://go.microsoft.com/fwlink/p/?LinkId=228403).

Prepare an Exchange calendar data source

To prepare an Exchange calendar data source, an Administrator or member of the Administrators group must create a trust relationship between the SharePoint Server farm and Exchange Server. This requires the root authority certificate for the server running Exchange Server.

Get the root authority certificate for the server running Exchange Server

1. Log on as Administrator or member of the Administrators group to a computer on which Microsoft Outlook 2010 has been installed and connected to the Exchange calendar that you want to use.

2. Click Start, and then click Run.

3. In the Open box, type certmgr.msc, and then click OK.

4. In the left pane, expand Trusted Root Certification Authorities, and then click Certificates.

5. In the right pane, in the Issued To column, right-click the certificate used by the Exchange server for secure Email, Client Authentication, and Server Authentication. For example, GTE CyberTrust Global Root. Point to All Tasks, and then click Export.

   Note

   Typically, the Intended Purposes column for this certificate includes the words: secure email, client authentication, server authentication, and code signing.

6. On the Welcome to the Certificate Export Wizard page, click Next.

7. On the Export File Format page, ensure that DER encoded binary X.509 (CER) is selected, and then click Next.

8. On the File to Export page, type a full path to which to save the file, and then click Next.

9. On the Completing the Certificate Export Wizard page, click Finish.

10. Click OK to close The export was successful dialog box.

Create a trust relationship with the server running Exchange Server

1. In the Central Administration web site, on the Quick Launch, click Security.

2. In the General Security section, click Manage trust.

3. In the Manage group of the ribbon, click New.

4. In the Establish Trust Relationship dialog box, in the Name box, type a name for the trust relationship.

5. In the Root Certificate for the trust relationship section, click Browse. Click the root authority certificate that you exported in the previous procedure, and then click Open.

6. In the Establish Trust Relationship dialog box, click OK.

   The trust relationship that you created appears on the Trust Relationships page.

Prepare an SAP calendar data source

Before a member of the site Owners group can add an SAP calendar as a data source to the Aggregated Business Calendar Web Part, a Farm administrator must do the following:

• Verify with the SAP administrator that the services used for time management are running on the SAP system.

• Import the TimeEntry BDC model

• Set permissions on the TimeEntry BDC model

Import the TimeEntry BDC model

You must import the TimeEntry (TimeEntry.xml) BDC model that an SAP administrator provides before a member of the site Owners group can configure an SAP business calendar. An SAP administrator must create this BDC model and provide it in a location for which a SharePoint farm administrator has a minimum of read access. Note that by default, an SAP administrator will provide this model in a .zip file named models.zip. You must extract the BDC model from the .zip file before you perform this procedure.

To import the TimeEntry BDC model

1. In the Central Administration web site, click Application Management.

2. In the Service Applications section, click Manage service applications.

3. Click the Business Data Connectivity Service application that is being used by Duet Enterprise.

4. In the BDC Models group of the ribbon, click Import.

5. On the Import BDC Model page, in the BDC Model section, type the full path to the TimeEntry.xml file.

6. In the File Type section, ensure that Model is selected.

7. Click Import.

8. When the BDC Model was successfully imported page appears, click OK.

9. The model appears in the BDC Model Name column as Time.

   Do not close this page. You will need it for the following procedure.

Set permissions on the TimeEntry BDC model

Use this procedure to set permissions on the TimeEntry BDC model.

To set permissions on the TimeEntry BDC model

1. Select the check-box on the Time row and in the Permissions group of the ribbon, click Set Metadata Store Permissions.

2. On the Set Metadata Store Permissions page, in the top box, enter a user or group to which you want to grant permissions to this model, and then click Add.

3. In the Permissions section, select the check boxes for the permissions to which you want to assign this user or group.

   Note

   At a minimum, you must grant the Execute and Selectable In Clients permissions.

4. Repeat steps 2 through 3 for each additional user or group to which you want to grant permissions to the Time BDC model.

For information about how to add the business calendar to the Aggregated Business Calendar Web Part, see Add and use the Aggregated Business Calendar Web Part (https://go.microsoft.com/fwlink/p/?LinkId=228403).