Export (0) Print
Expand All

Set-SPExcelDataProvider

 

Applies to: SharePoint Server 2013 Enterprise

Topic Last Modified: 2013-12-18

Sets properties of a safe data provider for Excel Services Application.

Set-SPExcelDataProvider [-Identity] <SPExcelDataProviderPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-ProviderId <String>] [-ProviderType <Oledb | Odbc | OdbcDsn>] [-WhatIf [<SwitchParameter>]]

The Set-SPExcelDataProvider cmdlet sets the properties of a data provider that is stored in the list of safe data providers. Excel Services Application refreshes external data connections only if the data provider for that connection is in the list of safe data providers. Excel Services Application include a set of common data providers in this list. Therefore, using cmdlets to modify safe data providers is typically an operation of custom data connection scenarios.

 

Parameter Required Type Description

Identity

Required

Microsoft.Office.Excel.Server.Cmdlet.SPExcelDataProviderPipeBind

Specifies the SPExcelDataProvider object to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SPExcelDataProvider object.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

NoteNote:
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Description

Optional

System.String

Specifies a display description for the data provider.

The type must a valid a string; for example, this is a custom OLEDB provider.

ProviderId

Optional

System.String

Specifies the name of the data provider. This ID should be present in the connection strings generated by this data provider, and the ID must be unique for the data provider type.

The type must a valid name of a provider; for example, CustomOLEDB.

ProviderType

Optional

Microsoft.Office.Excel.Server.DataProviderType

Specifies the supported type of the data provider to set.

The type must be one of the following: OleDb, Odbc, or OdbcDsn.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

--------------EXAMPLE 1--------------

Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataProvider | where {$_.providerID -eq "SQLOLEDB" } | Set-SPExcelDataProvider -Description "This is the Microsoft SQL OLEDB driver (MDAC)"

This example retrieves the SQLOLEDB data provider from the list of safe data providers that is on the Excel Services Application Web service application named MyExcelService, and then adds a display description.

--------------EXAMPLE 2--------------

$provider = Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataProvider | where {$_.providerID -eq "SQLOLEDB" } 
Set-SPExcelDataProvider $provider -Description "The SQLOLEDB provider description has changed."
$provider | format-table

This example retrieves the SQLOLEDB data provider from the list of safe data providers that is on the Excel Services Application Web service application named MyExcelService, as an object, adds a new display description, and then displays the provider output in a Command Prompt window, formatted as a table.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft