Export (0) Print
Expand All

New-SPExcelDataProvider

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Adds a new safe data provider to Excel Services Application.

New-SPExcelDataProvider -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> -ProviderId <String> -ProviderType <Oledb | Odbc | OdbcDsn> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-WhatIf [<SwitchParameter>]]

The New-SPExcelDataProvider cmdlet adds a data provider to the list of safe data providers in an Excel Services Application Web service application. Excel Services Application refreshes external data connections only if the data provider for a connection is on the list of safe data providers. Excel Services Application includes a set of common data providers on this list. Therefore, using cmdlets to modify safe data providers typically occurs only in custom data connection scenarios.

 

Parameter Required Type Description

ExcelServiceApplication

Required

Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind

Specifies the Excel Services Application Web service application that contains the SPExcelDataProvider list object.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object.

ProviderId

Required

System.String

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

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

ProviderType

Required

Microsoft.Office.Excel.Server.DataProviderType

Specifies the supported type of data provider to add to safe provider list.

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

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 friendly description for the new data provider.

The type must be a valid string; for example, "This is a custom OLEDB provider".

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" | New-SPExcelDataProvider -providerID "CustomOLEDB" -ProviderType OleDb -description "This is a custom OLEDB provider"

This example adds a new custom OLEDB data provider to the list of safe data providers for the Excel Services Application Web service application named MyExcelService.

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

Get-SPExcelServiceApplication | New-SPExcelDataProvider -providerID "CustomOLEDB" -ProviderType OleDb -description "This is a custom OLEDB provider"

This example adds a new custom OLEDB data provider to the list of safe data providers for all Excel Services Application Web service application in the farm.

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