Document to Page Converter Configuration Settings Schema in SharePoint Server 2010 (ECM)

Last modified: May 30, 2008

Applies to: SharePoint Server 2010

The Document to Page Converter Configuration Setting Schema details the information passed to the converter when a document to page conversion is initiated, either from the default document to page conversion interface page, or programmatically by invoking the Add or the UpdateContentFromSourceDocument method.

The document to page conversion infrastructure provides the ability for an administrator to specify configuration settings for a converter per site content type. These configuration settings are then stored as part of that site content type, and passed to the converter when you choose to convert a document of that content type. For more information, see Converter Settings and Content Types in SharePoint Server 2010 (ECM).

The Document to Page Converter Configuration Settings Schema follows.

<RcaTransformation>
  <ConverterSettings 
    SourceDocLibUrl="serverRelativeDocumentLibraryPath" 
    AllocationLimitHint="maximumFileSizeInBytes">
    …
  </ConverterSettings>

  <TransformationContext>
    …
  </TransformationContext>
</RcaTransformation>

Following is a list of the elements in the schema and their definitions.

  • RcaTransformation   Represents the content-type-specific configuration settings and post-processing instructions for a document to page converter.

  • ConverterSettings   Represents the content-type-specific configuration settings for a document to page converter. The ConverterSettings element has the following attributes:

    • SourceDocLibUrl   Represents the server-relative URL of the source document library. This information is provided for the use of the converter in case the document to be converted contains document-relative links.

    • AllocationLimitHint   Represents the maximum file size, in bytes, specified in the converter configuration settings. This element is not included if no file size is specified.

      This information is provided for converters that converted documents of compressed file formats. We strongly recommend that your custom converters respect the file size limitation that is specified.

    In addition, if you specified that the configuration settings page host a custom configuration settings control, the ConverterSettings element contains the XML generated by the control. This can be any valid XML that the control can generate, and that the custom converter can parse. For more information, see Additional Converter Settings Controls in SharePoint Server 2010 (ECM).

  • TransformationContext   Represents context data needed for the post-processing functions of the document to page conversion infrastructure. The converter should not access or change this information.

Show: