Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-SPExcelDataConnectionLibrary

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise 

Sets properties of a data connection library for Excel Services Application.

Set-SPExcelDataConnectionLibrary [-Identity] <SPExcelDCLPipeBind> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-Address <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Excel.Server.Cmdlet.SPExcelDCLPipeBind

Specifies the DataConnectionLibrary object to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection library (for example, DataConnectionLib1); a valid URL, in the form http://server_name; or an instance of a valid SPExcelDCL object.

ExcelServiceApplication

Required

Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind

Specifies the Excel Services Application Web service application that contains 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.

Address

Optional

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.

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 data connection library.

The type must a valid a string; for example, "This is the data connection library where all the connections to the sales data are stored".

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

Detailed Description

The Set-SPExcelDataConnectionLibrary cmdlet sets the properties of a library from which Excel Services Application loads data connection files. Excel Services Application loads data connection files only if they are stored in a data connection library that is on the list of trusted data connection libraries. Data connection libraries constitute a kind of list that contains data connection files. These files contain everything 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 provides an additional layer for data connections so that they can be managed separately from workbooks.

Input Types

Return Types

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

Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.address -eq "http://portal/site/salesDCL" } | Set-SPExcelDataConnectionLibrary -Description "This is the DCL where all the connections to the sales data are stored

This example sets a display description for the entry http://portal/site/salesDCL in the list of trusted data connection libraries (DCLs) that is on the Excel Services Application Web service application named MyExcelService.

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

Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.address -eq "http://portal/site/salesDCL" } | Set-SPExcelDataConnectionLibrary –Address "http://portal/site/salesDCL

This example updates the address of the data connection library for the entry http://portal/test/site/salesDCL to http://portal/site/salesDCL in the list of trusted data connection libraries, which is on the Excel Services Application Web service application named MyExcelService.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.