New-SPExcelDataConnectionLibrary
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Adds a new data connection library to Excel Services Application.
Syntax
New-SPExcelDataConnectionLibrary -Address <String> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The New-SPExcelDataConnectionLibrary cmdlet adds a data connection library to the list of trusted data connection libraries for an Excel Services Application Web service application. Excel Services Application loads only data connection files that are stored in a data connection library that is on the list of trusted data connection libraries. Data connection libraries contain data connection files, which contain all the resources that Excel Services Application and the Excel client require to connect to an external data source. Data connection libraries enable you to reuse and share data connections. Data connections can be loaded by using information from the workbook file; however, using a data connection library to load data connections allows data connections to be managed separately from workbooks.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Address |
Required |
System.String |
Specifies the address of the data connection library. The address must be unique in the list of trusted data connection libraries. The type must be a valid URL, in the form http://server_name. |
ExcelServiceApplication |
Required |
Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind |
Specifies the Excel Services Application Web service application that contains the SPExcelDataConnectionLibrary 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. |
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. Note 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 data connection library. 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 |
Input Types
Return Types
Example
--------------EXAMPLE----------------
Get-SPExcelServiceApplication -Identity "MyExcelService" | New-SPExcelDataConnectionLibrary -address "http://portal/site/salesDCL" -description "This is the DCL where all the connections to the sales data are stored."
This example adds a new data connection library (DCL), and then sets its description to the list of trusted data connection libraries that is in the Excel Services Application Web service application named MyExcelService.
Workbooks can use connection files stored in that library to refresh data on the Excel Services Application Web service application.