SPWordAutomationServiceApp - dsccommunity/SharePointDsc GitHub Wiki

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	THe name of the service application
AddToDefault	Write	Boolean	Should the service application be added to the default proxy group?
ApplicationPool	Write	String	The name of the application pool to run the service app in
ConversionProcesses	Write	UInt32	How many conversion processes can be run at once
DatabaseCredentials	Write	PSCredential	If using SQL authentication, the SQL credentials to use to connect to the instance
DatabaseName	Write	String	The name of the database for the service app
DatabaseServer	Write	String	The name of the server that will host the database
DisableBinaryFileScan	Write	Boolean	Should binary file scans be disabled
DisableEmbeddedFonts	Write	Boolean	Should embedded fonts be disabled
Ensure	Write	String	Present to ensure the app exists, absent to ensure that it does not	Present, Absent
JobConversionFrequency	Write	UInt32	How frequently should new jobs be started from the queue (in minutes)
KeepAliveTimeout	Write	UInt32	How long is the keep alive timeout set to for the service app
MaximumConversionAttempts	Write	UInt32	What is the maximum number of attempts to convert a document
MaximumConversionTime	Write	UInt32	What is the maximum time in seconds for a document conversion to be allowed to run
MaximumMemoryUsage	Write	UInt32	What is the maximum amount of memory the service app should use (in MB)
MaximumSyncConversionRequests	Write	UInt32	What is the maximum number of sync conversion requests for the service app
NumberOfConversionsPerProcess	Write	UInt32	How many document conversions should be included in a single process
RecycleThreshold	Write	UInt32	What is the recycle threshold for this service app
SupportedFileFormats	Write	StringArray[]	The list of supported file types	docx, doc, mht, rtf, xml
TimeBeforeConversionIsMonitored	Write	UInt32	How long can a conversion be run before it becomes monitored
UseSQLAuthentication	Write	Boolean	Should SQL Server authentication be used to connect to the database?

Description

Type: Distributed Requires CredSSP: No

The resource is able to provision, unprovision and configure the Word Automation Service Application. All settings that you can configure on the Service Application administration page are configurable using this resource.

Important: When you specify Ensure=Present, the Application Pool and DatabaseName parameters are required. When you specify Ensure=Absent, no other parameters are allowed (with the exception of Name and PsDscRunAsCredential).

The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned.

NOTE: If you don't specify the AddToDefault parameter, the new Word Automation service application won't be added to the default proxy group. Please use "AddToDefault = $true" to make sure it is added to the default proxy group.

Examples

Example 1

This example makes sure the service application exists and has a specific configuration

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPWordAutomationServiceApp WordAutomation
        {
            Name                            = "Word Automation Service Application"
            Ensure                          = "Present"
            ApplicationPool                 = "SharePoint Web Services"
            DatabaseName                    = "WordAutomation_DB"
            DatabaseServer                  = "SQLServer"
            SupportedFileFormats            = "docx", "doc", "mht", "rtf", "xml"
            DisableEmbeddedFonts            = $false
            MaximumMemoryUsage              = 100
            RecycleThreshold                = 100
            DisableBinaryFileScan           = $false
            ConversionProcesses             = 8
            JobConversionFrequency          = 15
            NumberOfConversionsPerProcess   = 12
            TimeBeforeConversionIsMonitored = 5
            MaximumConversionAttempts       = 2
            MaximumSyncConversionRequests   = 25
            KeepAliveTimeout                = 30
            MaximumConversionTime           = 300
            PsDscRunAsCredential            = $SetupAccount
        }
    }
}

Example 2

This example makes sure the service application exists and has a specific configuration. The new service application is also added to the default proxy group.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPWordAutomationServiceApp WordAutomation
        {
            Name                            = "Word Automation Service Application"
            Ensure                          = "Present"
            ApplicationPool                 = "SharePoint Web Services"
            DatabaseName                    = "WordAutomation_DB"
            DatabaseServer                  = "SQLServer"
            SupportedFileFormats            = "docx", "doc", "mht", "rtf", "xml"
            DisableEmbeddedFonts            = $false
            MaximumMemoryUsage              = 100
            RecycleThreshold                = 100
            DisableBinaryFileScan           = $false
            ConversionProcesses             = 8
            JobConversionFrequency          = 15
            NumberOfConversionsPerProcess   = 12
            TimeBeforeConversionIsMonitored = 5
            MaximumConversionAttempts       = 2
            MaximumSyncConversionRequests   = 25
            KeepAliveTimeout                = 30
            MaximumConversionTime           = 300
            AddToDefault                    = $true
            PsDscRunAsCredential            = $SetupAccount
        }
    }
}

Example 3

This example removes a word automation service app

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPWordAutomationServiceApp WordAutomation
        {
            Name                 = "Word Automation Service Application"
            Ensure               = "Absent"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}