Skip to main content
:ProfileText:
Home Library Learn Samples Downloads Support Community Forums
Microsoft Developer Network > Learn > Courses > Office 2010 Developer Training Course > Office 2010 Services > Office 2010 Service Applications Lab > Exercise 2: Generating Documents using Word Services

Exercise 2: Generating Documents using Word Services

In this exercise you will be adding an Event Receiver to the State Reports document library that will convert all docx files submitted into XPS and PDF files. This is done using Word Services and a scheduled job that converts all registered documents every 15 minutes. To provide feedback to the user you will also be implementing a simple web part that will provide a summary of the jobs submitted to Word Services.

Task 1 – Create the Printable Document Library event receiver

In this task, you will define a List Item Event Receiver that will fire anytime an item a new file is added or updated in the document library. This Event Receiver will start a print job that will convert the added or updated docx file into an XPS and PDF document.

  1. Create a new event receiver item in the PrintableDocumentLibrary item
    1. Right click PrintableDocumentLibrary in the Solution Explorer and select Add -> New Item
    2. In the Add New Item dialog, select the Visual C#\Visual Basic -> SharePoint -> 2010 template category
    3. Select the Event Receiver template
    4. Set the Name to PrintableDocumentReceiver and click Add
    5. In the dialog check the checkboxes by
      1. An item was added
      2. An item was updated

      Figure 11

      Create new Event Receiver

    6. Click Finish to create the Event Receiver
  2. Create a StartJob method that accepts the files to convert and the format and starts a conversion job
    1. Add the following using statement to the file

      C#

      using Microsoft.Office.Word.Server.Conversions;

      Visual Basic

      Imports Microsoft.Office.Word.Server.Conversions

    2. In the PrintableDocumentReceiver class, add the following StartJob method

      C#

      private void StartJob(SPWeb web, SaveFormat format, 
                      string sourceUrl, string targetUrl)
{
}

      Visual Basic

      Private Sub StartJob(ByVal web As SPWeb, ByVal format As SaveFormat, ByVal sourceUrl As String, ByVal targetUrl As String)
End Sub

    3. In the new method, create a ConversionJobSettings object to control how the documents are converted

      C#

      ConversionJobSettings settings = new ConversionJobSettings()
{
    OutputFormat = format,
    UpdateFields = true,
    OutputSaveBehavior = SaveBehavior.AlwaysOverwrite                
};

      Visual Basic

      Dim settings As New ConversionJobSettings() With {.OutputFormat = format, .UpdateFields = True, .OutputSaveBehavior = SaveBehavior.AlwaysOverwrite}

    4. Create a new ConversionJob using the settings and your current user token

      C#

      ConversionJob conversionJob = 
    new ConversionJob(Constants.WordServicesAppName, settings)
{
    SubscriptionId = Constants.SubscriptionId,
    UserToken = web.CurrentUser.UserToken
};

      Visual Basic

      Dim conversionJob As New ConversionJob(Constants.WordServicesAppName, settings) With {.SubscriptionId = Constants.SubscriptionId, .UserToken = web.CurrentUser.UserToken}
      Note:
      The SubscriptionId is a shared Guid that allows the application to find its active jobs.

    5. Add the source and target file urls to the job and then start it

      C#

      conversionJob.AddFile(sourceUrl, targetUrl);
conversionJob.Start();

      Visual Basic

      conversionJob.AddFile(sourceUrl, targetUrl)
conversionJob.Start()
      Note:
      It is possible to add multiple source/target pairs and even choose to convert entire folders or lists. In this case, you are starting one job for each type of conversion.

  3. Implement a PrintDocument method that uses StartJob to convert all docx files to XPS and PDF
    1. Add a new PrintDocument method to the PrintableDocumentReceiver class

      C#

      private void PrintDocument(SPWeb web, string listItemUrl)
{
}

      Visual Basic

      Private Sub PrintDocument(ByVal web As SPWeb, ByVal listItemUrl As String)
End Sub

    2. Wrap all the code in the method with an if statement that checks if the listItemUrl ends with a .docx extension

      C#

      private void PrintDocument(SPWeb web, string listItemUrl)
      {
          if (listItemUrl.EndsWith(".docx"))
    {
    }
      }

      Visual Basic

      Private Sub PrintDocument(ByVal web As SPWeb, ByVal listItemUrl As String)
      If listItemUrl.EndsWith(".docx") Then
End If
      End Sub

    3. Calculate the sourceUrl using the web’s url and the list item’s url

      C#

      string sourceUrl = web.Url + "/" + listItemUrl;

      Visual Basic

      Dim sourceUrl As String = web.Url & "/" & listItemUrl

    4. Calculate the target url by removing the .docx

      C#

      string targetUrl = sourceUrl.Substring(0, sourceUrl.Length - 5);

      Visual Basic

      Dim targetUrl As String = sourceUrl.Substring(0, sourceUrl.Length - 5)

    5. Start a job for XPS and PDF conversion using the StartJob method

      C#

      StartJob(web, SaveFormat.XPS, sourceUrl, targetUrl + ".xps");
StartJob(web, SaveFormat.PDF, sourceUrl, targetUrl + ".pdf");

      Visual Basic

      StartJob(web, SaveFormat.XPS, sourceUrl, targetUrl & ".xps")
StartJob(web, SaveFormat.PDF, sourceUrl, targetUrl & ".pdf")

  4. Implement the ItemAdded and ItemUpdated methods by having them call the PrintDocument method

    C#

    /// <summary>
/// An item was added.
/// </summary>
public override void ItemAdded(SPItemEventProperties properties)
{
    PrintDocument(properties.Web, properties.ListItem.Url);
    base.ItemAdded(properties);
}

/// <summary>
/// An item was updated.
/// </summary>
public override void ItemUpdated(SPItemEventProperties properties)
{
    PrintDocument(properties.Web, properties.ListItem.Url);
    base.ItemUpdated(properties);
}

    Visual Basic

    ''' <summary>
''' An item was added.
''' </summary>
Public Overrides Sub ItemAdded(ByVal properties As SPItemEventProperties)
PrintDocument(properties.Web, properties.ListItem.Url)
MyBase.ItemAdded(properties)
End Sub

''' <summary>
''' An item was updated.
''' </summary>
Public Overrides Sub ItemUpdated(ByVal properties As SPItemEventProperties)
PrintDocument(properties.Web, properties.ListItem.Url)
MyBase.ItemUpdated(properties)
End Sub

Task 2 – Build the PrintingStatus web part

In this task you will create a web part that will monitor the printing jobs started in a Printable Document Library. This web part will show the total number of jobs in action and the number of jobs in each state.

  1. Add a new Visual Web Part to the project
    1. Right click StateReportApplication in the Solution Explorer and click Add -> New Item
    2. In the Add New Item dialog, select the Visual C#\Visual Basic -> SharePoint -> 2010 template category
    3. Select the Visual Web Part template
    4. Set the Name to PrintingStatus and click Add
  2. Design the user interface for the web part
    1. Open the designer by right clicking PrintingStatusUserControl.ascx in the Solution Explorer and clicking View Designer
    2. Click the Source button at the bottom of the designer
    3. At the bottom of the ascx file, add the following markup to define status indicators for the total number of printing jobs, total jobs in progress, and total jobs not started.

      ASPX

      <table>
    <tr>
        <td>Active Printing Jobs</td>
        <td><asp:Label ID="ActiveJobs" runat="server" /></td>
    </tr>
    <tr>
        <td style="padding-left:20px">Jobs In Progress</td>
        <td><asp:Label ID="InProgressJobs" runat="server" /></td>
    </tr>
    <tr>
        <td style="padding-left:20px">Jobs Not Started</td>
        <td><asp:Label ID="NotStartedJobs" runat="server" /></td>
    </tr>

    4. Add the following markup to the end of the file to provide a spacer row and an display of the next scheduled Word Services execution

      ASPX

          <tr><td></td><td></td></tr>    
    <tr>
        <td colspan="2" align="center">Next execution: 
        <asp:Label ID="NextRunTime" runat="server" /></td>
    </tr>
</table>

    5. Switch to the Design view using the button at the bottom of the window and verify it looks like the image below

      Figure 12

      Completed Print Status Design

  3. Implement the web part’s Page_Load method to display information about active jobs
    1. View the web parts code by right clicking the designer and selecting View Code
    2. Add the following using statements to the file

      C#

      using System.Collections.ObjectModel;
using System.Linq;
using Microsoft.Office.Word.Server.Conversions;
using Microsoft.Office.Word.Server.Service;
using Microsoft.SharePoint.Administration;

      Visual Basic

      Imports System.Collections.ObjectModel
Imports System.Linq
Imports Microsoft.Office.Word.Server.Conversions
Imports Microsoft.Office.Word.Server.Service
Imports Microsoft.SharePoint.Administration

    3. In the Page_Load method add the following code to retrieve all active jobs and update the UI

      C#

      ReadOnlyCollection<ConversionJobInfo> activeJobs = 
    ConversionJobStatus.GetAllActiveJobs(
        Constants.WordServicesAppName, Constants.SubscriptionId);
ActiveJobs.Text = activeJobs.Count.ToString();

      Visual Basic

      Dim activeJobs As ReadOnlyCollection(Of ConversionJobInfo) = ConversionJobStatus.GetAllActiveJobs(Constants.WordServicesAppName, Constants.SubscriptionId)
ActiveJobs.Text = activeJobs.Count.ToString()
      Note:
      The SubscriptionId is used to only return jobs started by the event receiver created in the previous task

    4. Traverse through the list of active jobs and find how many documents are in the InProgress or NotStarted state

      C#

      int inProgressJobs = 0;
int notStartedJobs = 0;
foreach (ConversionJobInfo info in activeJobs)
{
    ConversionJobStatus status = 
        new ConversionJobStatus(Constants.WordServicesAppName, 
            info.JobId, null);
    inProgressJobs += status.InProgress;
    notStartedJobs += status.NotStarted;                
}

      Visual Basic

      Dim inProgressJobs As Integer = 0
Dim notStartedJobs As Integer = 0
For Each info As ConversionJobInfo In activeJobs
Dim status As New ConversionJobStatus(Constants.WordServicesAppName, info.JobId, Nothing)
inProgressJobs += status.InProgress
notStartedJobs += status.NotStarted
Next info
      Note:
      The GetAllActiveJobs method gets us information about each active job. You will need to create ConvertsionJobStatus objects to find all the details about the jobs.

    5. Using the total conversions in progress and not started, update the UI

    6. C#

      InProgressJobs.Text = inProgressJobs.ToString();
NotStartedJobs.Text = notStartedJobs.ToString();

      Visual Basic

      InProgressJobs.Text = inProgressJobs.ToString()
NotStartedJobs.Text = notStartedJobs.ToString()

  4. Use the WordService object to retrieve the next schedule run time of the conversion jobs
    1. Add the following code to the end of the Page_Load method to access the WordService object

      C#

      WordService service = SPFarm.Local.Services.GetValue<WordService>();

      Visual Basic

      Dim service As WordService = SPFarm.Local.Services.GetValue(Of WordService)()

    2. Using the JobDefinitions list, retrieve the first schedule job in the collection

      C#

      SPJobDefinition job = service.JobDefinitions.First();

      Visual Basic

      Dim job As SPJobDefinition = service.JobDefinitions.First()

    3. Using the job’s Schedule property, calculate the next occurrence and display it to the screen

      C#

      NextRunTime.Text = 
    job.Schedule.NextOccurrence(DateTime.Now).
        ToShortTimeString();

      Visual Basic

      NextRunTime.Text = job.Schedule.NextOccurrence(Date.Now).ToShortTimeString()

Task 3 – Place the Printing Status web part on the page

In this task, you will update the main site page by adding a Printing Status web part to the page.

  1. Build and deploy the State Report application to SharePoint
    1. Right click StateReportApplication in the Solution Explorer and click Deploy
  2. Add a Printing Status web part to the main page of the site
    1. In Internet Explorer navigate to http://intranet.contoso.com/sites/OfficeServiceApplications
    2. Click Edit Page on the Page ribbon tab
    3. Click Add a Web Part in the right web part zone
    4. In the Web Part pane, choose the Custom category and the PrintingStatus web part
    5. Click Add to add the web part to the page
    6. Once the web part is added, drag it below the existing Generate Report web part and click Stop Editing

      Figure 13

      Completed Printing Status Web Part

Exercise 2 Verification

In order to verify that you have correctly performed all steps of exercise 2, proceed as follows:

Test the Event Handler and Web Part

Test your event handler and web part by generating a new state report and verifying an XPS and PDF file are generated as well by Word Services.

  1. In Internet Explorer navigate to http://intranet.contoso.com/sites/OfficeServiceApplications
  2. Choose AL in the drop down list inside the GenerateReport web part and click Generate Report
  3. Verify that AL shows up in the State Reports list and verify that a printing job shows up in the PrintStatus web part.

    Figure 14

    Printing jobs in progress

  4. Since the job is scheduled in the future, use Central Admin to force it to run now
    1. In another Internet Explorer tab, navigate to http://demo2010a:2010/default.aspx
    2. In the Monitoring section, click the Check job status link

      Figure 15

      Check job status link

    3. In the View drop down, choose Job Definition
    4. In the Job Definition drop down choose Change Job Definition

      Figure 16

      Filter by Job Definition

    5. Page to the right until you find Word Automation Services Timer Job and click it
    6. Click the job in the Scheduled section at the top of the page
    7. On the Edit Timer Job page, click Run Now to force the conversion jobs to execute

      Figure 17

      Run the job now

  5. Verify an XPS and PDF version of the report are in the AL folder
    1. Back in the site tab of Internet Explorer, click the link to the AL folder in the State Reports web part
    2. Verify there are three documents in the folder, a docx, an XPS, and a PDF

      Figure 18

      Printed Report Files

    3. Click the link on the XPS file to view it

      Figure 19

      Printed Report as XPS

< previous | next >

Downloads

Download The Offline Training Kit
Download Hands-on Lab Document (DOCX)
Download Hands-on Lab Source Files

Contents

© 2013 Microsoft. All rights reserved.