Document Converter Definition Schema in SharePoint Server 2010 (ECM)

Last modified: March 08, 2010

Applies to: SharePoint Server 2010

You must include an XML file in your Feature that defines the document converter according to the Document Converter Definition Schema. Following is the schema.

<?xml version="1.0" encoding="utf-8" ?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <DocumentConverter ID="GUID"
    Name="DisplayName"
    App="ExecutableLeafName"
    From="FileExtension"
    To="FileExtension"
    ConverterUIPage="ConverterUIPage.aspx"
    ConverterSpecificSettingsUI="ConverterConfig.aspx"
    ConverterSettingsForContentType="ConverterConfig.ascx"
  />
</Elements>

Following is a list of the elements in the Document Converter Definition Schema and their definitions.

Element   Top-level element in a Feature manifest file that contains feature element declarations.

DocumentConverter   A single document converter. The DocumentConverter element has the following attributes:

  • ID   Required String. Represents the GUID for this document converter.

  • Name   Required String. Represents the display name of the document converter. Microsoft SharePoint Server 2010 displays this name in the user interface.

  • App   Required String. Represents the short name of the document converter executable file.

  • From   Required String. Represents the file name extension of the original file to be passed to the document converter. Do not start the file name extension with a period.

  • To   Required String. Represents the file name extension of the converted copy that the document converter produces. Do not start the file name extension with a period.

  • ConverterUIPage   Optional String. Represents the file name of the .aspx page to display to users to specify conversion options for the selected document. This element is optional. If you do not specify a custom page, SharePoint Server 2010 displays the default page, DocTrans.aspx.

    For document-to-page converters, to display the default document-to-page converter user interface page, set this element to CreatePage.aspx.

    For more information, see Custom Conversion Settings Pages in SharePoint Server 2010 (ECM).

  • ConverterSpecificSettingsUI   Optional String. Represents the file name of an .ascx control to host on an existing converter configuration page. Use the control to add configuration options to the existing page.

    This is a feature primarily used in implementing document-to-page converters. For more information, see Additional Converter Settings Controls in SharePoint Server 2010 (ECM). For more information about document-to-page converters, see Page Publishing Using SharePoint Document Converters (ECM).

  • ConverterSettingsForContentType   Optional String. Represents the file name of the .aspx page to display to enable administrators to set configuration settings for this converter, per site content type.

    This is a feature used primarily in implementing document-to-page converters. To display the default document-to-page converter configuration settings page, set the element to ConverterSettings.aspx.

    For more information, see Custom Converter Configuration Settings Pages in SharePoint Server 2010 (ECM). For more information on document-to-page converters, see Page Publishing Using SharePoint Document Converters (ECM).

Following is an example document converter schema, for a document converter that converts Microsoft Excel 2010 (.xls) files to Microsoft PowerPoint 2010 (.ppt) files.

<?xml version="1.0" encoding="utf-8" ?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <DocumentConverter ID="{3f8ae556-93ec-46de-bcb3-0a89616a20b3}"
    Name="Excel to PowerPoint"
    App="XL2PPT.exe"
    From="xls"
    To="ppt"
    ConverterUIPage="XL2PPT.aspx"
    ConverterSpecificSettingsUI="XL2PPTConfig.aspx"
    ConverterSettingsForContentType="XL2PPTConfig.ascx"
  />
</Elements>
Show: