Subscribe to News feed

Inserting SharePoint List data into a PDF document using a workflow

Posted at: 6:39 PM on 02 September 2009 by Muhimbi

merge

As of version 1.4, our PDF Converter for SharePoint supports the refreshing of MS-Word DocProperties with the associated content stored in a Document Library’s custom columns. In essence this functionality allows custom PDF Documents to be created on the fly.

This article shows how to create a system that allows business users to fill out a holiday request form in SharePoint and automatically file the request in PDF format. This example has been kept simple on purpose, feel free to add additional workflow logic to it.

Before you start, make sure the PDF Converter for SharePoint (v1.4 or newer) has been installed and you have access to a site collection with the appropriate rights to create workflows. Some basic knowledge about creating and configuring document libraries is assumed.

Update: This article mentions several times that this only works with DocProperties in documents saved in pre-Office 2007 based MS-Word documents. As of version 3.0 of the product we also support fields inserted using MS-Word 2007 Quick Parts.

So, with that out of the way let’s get going.
 

Create and configure the Document Library
 

  1. Create a document library named ‘Holiday Requests’.
     
  2. Create the following columns (feel free to create a new Content Type, but it is not necessary for this demo)
     
    1. Column name: Requester, Type: Person or Group
    2. Column name: StartDate, Type: Date and Time
    3. Column name: EndDate, Type: Date and Time
    4. Column name: Reason, Type: Choice, Choices: Holiday, Personal leave, Skiving
    5. Column name: Status, Type: Choice, Choices: Pending, Approved, Denied, You are fired
    6. Column name: Remarks, Type: Multiple Lines of Text
       

  3. In the document library, create a folder named  ‘Approved Requests’.
     

We should now have something that resembles the screenshot below. Note that I have removed some of the default columns from the view.

EmptyDocLib


Create the MS-Word Template
 

Follow the instructions below to create the template or download it from our site.

  1. In the new Document Library create a new Document and immediately save it in MS-Word 2003 format as ‘Holiday Request.doc’. Do not use MS-Word 2007 format initially as it will not allow you to insert DocProperties ‘the MS-Word 2003 way’ (See the list of issues at the end of this article).
     
  2. Close the document.
     
  3. Edit the properties for the document that was just saved and give each field a temporary value. If this is not done then MS-Word 2007 does not allow the DocProperties to be inserted (nice!).
     
  4. Edit the previously saved document and insert a 2x6 table into the document.
     
  5. In the left most column add the name of each of the previously inserted columns. Feel free to use spaces and additional descriptions as this is just text that will be converted as is.
     
  6. In the right most column enter each corresponding DocProperty from MS-Word 2007’s Insert / Quick Part / Field / DocProperty list. (When using MS-Word 2003, use Insert / Field / DocProperty. From memory, I don’t have Word 2003 here).
     
  7. Clear the content of all fields from MS-Word or save the document and clear all fields using SharePoint.
     
  8. If you know how to then make this document the default template for the Document Library. Otherwise leave the document where it is.
     

We now have something that looks like the following document. Note that I have right clicked on each DocProperty and selected Toggle Field Codes in order to visualise them.

WordTemplate 

Create and configure the workflow  

  1. Start SharePoint Designer and open the site collection that contains the ‘Holiday Requests’ library.
     
  2. From the File menu select New > Workflow.
     
  3. On the first screen of the Workflow wizard, specify the following settings:
     
    • Name the workflow ‘Convert Holiday Requests to PDF Format’.
       
    • Select the ‘Holiday Requests’ list.
       
    • Select the 2nd and 3rd checkboxes to make sure the workflow is triggered whenever a document is created or (its status) is updated.
       
    • Click the ‘Next’ button to proceed.

     

We need to create a workflow consisting of 2 steps. As we will be updating the value of a column, we cannot convert the document in the same step as the changed value has not yet been persisted to the Document Library. By moving the ‘Convert to PDF’ action to the 2nd step we ensure the latest changes are available to the PDF Converter.  

Step 1 – Check Status and update if needed.

  1. From the ‘Conditions’ menu select ‘Compare Holiday Requests field’. This inserts the ‘If value equals value condition.
     
  2. Click the first ‘value’ and select ‘Status’.
     
  3. Click the second ‘value’ and select ‘Approved’ from the list.
     
  4. In the ‘Actions’ menu select ‘Set Field in Current Item’.
     
  5. Click ‘field’ and set it to ‘Status’.
     
  6. To mess around with the requester, and to show modified properties are automatically included in the PDF file, set ‘value’ to ‘You are fired’.
      workflow1

Step 2 – Convert to PDF

  1. Insert a new step and name it ‘Convert to PDF’
     
  2. Add a Condition, as described above, to check if the ‘Status’ is now set to ‘You are fired’.
     
  3. From the ‘Actions’ menu select' ‘Convert to PDF’.
     
  4. The following action is inserted:

    Convert this document to this url using the same file name and include / exclude meta data. Store the converted item details in List ID: Variable: List ID, Item ID: Variable: List Item ID.

    Let’s examine what the various options mean:
     
    1. this document:  Specify which document to convert. Click this option and make sure ‘Current Item’ is selected.
       
    2. this url: Specify the location the converted file will be written to. The following options are available:
       
      1. Leave it empty: When no value is specified then the converted document is written to the same folder as where the source file is located.
         
      2. Site Relative URL: By specifying a URL relative to the current site, e.g. ‘subsite/shared documents/PDF Files’, any folder location in the current site collection can be targeted. This is the option we want to use so enter Holiday Requests/Approved Requests.
         
      3. Web Application relative URL: Using a URL that is relative to the entire web application, e.g. ‘/sites/Press Office/Public Documents/To Distribute’, any folder location in any site collection can be targeted.

    3. the same file name: The name of the converted file can be specified here. In our case we’ll leave it empty to make sure we use the same name as the original document.
       
    4. include / exclude meta data: In case of sensitive documents we may want to strip any custom SharePoint columns from the file. Select ‘Include’.
       
    5. Variable: List ID: A new workflow variable named ‘List ID’ is automatically created. After the file has been converted, this variable will contain the ID of the list the converted file was saved to. This can later be fed into another action in order to manipulate this file further.
       
    6. Variable: List Item ID: A new workflow variable named ‘List Item ID’ is automatically created. After the file has been converted, this variable will contain the ID of the item the converted file was saved to. This can later be fed into another action in order to manipulate this file further.
       

  5. Click ‘Finish’ to save and activate the Workflow


workflow2
 

Test The Workflow
 

Test the workflow as follows. Note that MS-Word 2007 can be a bit picky with DocProperties so make sure to save each document in MS-Word 2003 format.

  1. If you have made the document the default template then select ‘New’ in the document library, otherwise copy a new version of the template manually into the library.
     
  2. Specify all properties, either from SharePoint or MS-Word. Don’t set the status to Approved.
     
  3. Save and Close the document if it is still open.
     
  4. Use SharePoint to edit the properties of the document and set the ‘Status’ to ‘Approved’. Update any other properties as well if you wish.
     
  5. Once the workflow has finished you will find a PDF file in the Approved Requests folder.

The generated PDF file now looks as follows. Note that the User ID is inserted rather than the user name. I’ll leave it as a exercise for the reader to retrieve this information and insert the full user name using a DocProperty. ConvertedPDF

 

Please note that the current implementation has some limitations:

  1. DocProperties containing spaces and quotes are not supported: DocProperty field names are not allowed to contains spaces or double quotes (").
     
  2. Custom Formatting in DocProperties is not supported: When a DocProperty contains additional formatting information then this is not automatically applied. For example {DOCPROPERTY DateField \@ "yyyy/MM/dd"}.
     
  3. Doc Properties inserted using MS-Word 2007 'Quick Parts' are not supported: Currently the PDF Converter only supports DocProperties that have been inserted using the 'pre MS-Word 2007' Insert Field -> DocProperty functionality. Please do not use MS-Word 2007's Insert -> Quick Parts -> Document Property.

For full details, see version 1.4’s release notes. We expect to resolve these issues in the next few weeks.

Update: This article mentions several times that this only works with DocProperties in documents saved in pre-Office 2007 based MS-Word documents. As of version 3.0 of the product we also support fields inserted using MS-Word 2007 Quick Parts.

Labels: , , ,

6 Comments:

  • i have a problem with this.
    The document filed is not updating by itself.
    shouldn't be doing that or what?
    please help.
    Thanks

    By Anonymous cricri, At 22 March, 2010 14:07  

  • Hi Cricri,

    Please send an email to support@muhimbi.com and provide additional details about what you have done, what you are trying to achieve and what exactly is not working.

    Please be as specific as possible.

    By Blogger Muhimbi, At 22 March, 2010 14:12  

  • Hi I am also facing same problem as Cricri with Office Word 2003. It doesn't get updated when you save the details. But it shows updated in the sharepoint columns but not in the word 2003 document. If I create the template in Office Word 2007, it works fine. Please help me bogu001@yahoo.com

    By Anonymous Sravan, At 23 November, 2010 23:07  

  • Hi Sravan, which version of the Muhimbi PDF Converter are you using? Are you using doc properties or quick parts?

    By Blogger Muhimbi, At 24 November, 2010 09:19  

  • Is there any way to support repeating data?

    By Anonymous Peter, At 18 September, 2013 03:38  

  • Hi Peter,

    What do you consider to be repeating data? Insert content from multiple list items into a single MS-Word document and convert that to PDF?

    If you wish to discuss in more detail then please email support@muhimbi.com.

    By Blogger Muhimbi, At 18 September, 2013 09:22  

Post a Comment

Subscribe to Post Comments [Atom]

Links to this post:

Create a Link