New-SPExcelFileLocation
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Adds a new trusted location to Excel Services Application.
Syntax
New-SPExcelFileLocation -Address <String> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AbortOnRefreshOnOpenFail <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>] [-AutomaticVolatileFunctionCacheLifetime <Int32>] [-ChartAndImageSizeMax <Int32>] [-ChartRenderDurationMax <Int32>] [-ConcurrentDataRequestsPerSessionMax <Int32>] [-Confirm [<SwitchParameter>]] [-DefaultWorkbookCalcMode <File | Manual | Auto | AutoDataTables>] [-Description <String>] [-DisplayGranularExtDataErrors <SwitchParameter>] [-ExternalDataAllowed <None | Dcl | DclAndEmbedded>] [-IncludeChildren <SwitchParameter>] [-LocationType <SharePoint | Unc | Http>] [-ManualExtDataCacheLifetime <Int32>] [-NewWorkbookSessionTimeout <Int32>] [-PeriodicExtDataCacheLifetime <Int32>] [-RequestDurationMax <Int32>] [-RESTExternalDataAllowed <SwitchParameter>] [-SessionTimeout <Int32>] [-ShortSessionTimeout <Int32>] [-UdfsAllowed <SwitchParameter>] [-WarnOnDataRefresh <SwitchParameter>] [-WhatIf [<SwitchParameter>]] [-WorkbookSizeMax <Int32>]
Detailed Description
The New-SPExcelFileLocation cmdlet adds a new location to the list of trusted file locations in an Excel Services Application Web service application. Excel Services Application loads only workbooks that are stored in a trusted file location. Properties of trusted file locations control how workbooks can be used when loaded on Excel Services Application. Excel Services Application always enforces the properties defined by the trusted file location from which a workbook was loaded. The properties that the trusted file location uses are determined through comparison of the file path for the workbook with the Address parameter of the trusted file location.
The longest match takes precedence. For example, if http://portal/site/ and http://portal/site/subsite are trusted locations, and you load a workbook from the subsite, the application uses the properties from the subsite trusted location because it has the longest matching address.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Address |
Required |
System.String |
Specifies a Web folder, or file directory from which Excel Services Application can load workbooks. The type must be a valid URL, in the form http://myPortal/myTeam; or a valid UNC path in form, \\server_name\folder_name |
ExcelServiceApplication |
Required |
Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind |
Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation 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. |
AbortOnRefreshOnOpenFail |
Optional |
System.Management.Automation.SwitchParameter |
Specifies that the loading of a Excel Services Application file automatically fails if an automatic data refresh operation fails when the file is opened. The load is failed only if the following conditions are true: - The user has SharePoint Product and Technologies read-only permissions to the file. - The workbook file has data connections that are refreshed automatically when the Excel Services Application file is opened. |
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. |
AutomaticVolatileFunctionCacheLifetime |
Optional |
System.Int32 |
Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. Valid values include: -1 Calculates once when the workbook loads. 0 Always calculates. 1 to 2073600 Caches 1 second to 24 days. The default integer value is 300. The type must be the integers -1 or 0, or an integer value in the range of 1 to 2073600. |
ChartAndImageSizeMax |
Optional |
System.Int32 |
Specifies the maximum size, in megabytes, of a chart or image that can be opened. The default value is 1. The type must be a valid integer greater than 0. |
ConcurrentDataRequestsPerSessionMax |
Optional |
System.Int32 |
Specifies the maximum number of concurrent external data requests allowed in each session. If a session must issue more than this number of requests, additional requests must be queued. The scope of this setting is the logical server. The default value is 5. The type must be a positive integer. |
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 |
DefaultWorkbookCalcMode |
Optional |
Microsoft.Office.Excel.Server.DefaultWorkbookCalcMode |
Specifies the calculation mode of workbooks. Settings other than File override the workbook settings. The default setting is File. The type must be one of the following: File, Manual, Auto, or AutoDataTables. |
Description |
Optional |
System.String |
Specifies a friendly description for the new file location. The type must be a valid string; for example, this is the file location of the monthly sales reports. |
DisplayGranularExtDataErrors |
Optional |
System.Management.Automation.SwitchParameter |
Displays granular error messages for external data failures for files in this location. |
ExternalDataAllowed |
Optional |
Microsoft.Office.Excel.Server.AllowExternalData |
Specifies the type of external data access allowed for workbooks. None specifies that data refresh is disabled. Dcl specifies that data is refreshed only when it uses a connection file in a trusted data connection library. DclandEmbedded specifies that a data connection library can be used but is not required. The scope of this setting is the trusted location. The default value is None. The type must be any of the following settings: None Dcl DclAndEmbedded |
IncludeChildren |
Optional |
System.Management.Automation.SwitchParameter |
Indicates that subordinate URLs, directories and libraries are trusted. For example, if the trusted file location is http://portal, and IncludeChildren is true, http://portal/subSite is also trusted, as is any URL subordinate to the URL specified in Address. |
LocationType |
Optional |
Microsoft.Office.Excel.Server.LocationType |
Specifies the type of location. Location type indicates how Excel Services Application retrieves files from the location specified in Address. The default setting is the SharePoint type. The default value is SharePoint. The type must be one of the following: SharePoint, UNC, or HTTP. |
ManualExtDataCacheLifetime |
Optional |
System.Int32 |
Specifies the time, in seconds, that Excel Services Application waits before it re-issues a manual, or user-initiated, external data request. During this time period, the results from the previous external data request can be returned from an external data cache. The default value is 300. The valid values are any one of the following items: -1 Never refresh after first query.1 to 2073600- Caches 1 second to 24 days. |
NewWorkbookSessionTimeout |
Optional |
System.Int32 |
Specifies the time, in seconds, that a session for a new, unsaved, workbook remains active on Excel Services Application with no user activity. Valid values include the following: -1 Session never expires. 0 Session expires at the end of a single request. 1 to 2073600 Remains active 1 second to 24 days. The default value is 1800. The type must be -1, 0, or an integer in the range of 1 to 2073600. |
PeriodicExtDataCacheLifetime |
Optional |
System.Int32 |
Specifies the time, in seconds, that Excel Services Application waits before it re-issues an on-open or periodic (that is, automatic) external data request. During this time period, the results from the previous external data request can be returned from an external data cache. A value of -1 specifies never to refresh after the first query. The default value is 300. The type must be -1, 0, or integer in the range of 1 to 2073600. |
RequestDurationMax |
Optional |
System.Int32 |
Specifies the maximum duration, in seconds, for a single request in a session. After this time elapses, the request times out. The default value is 300. The type must be -1 (no limit) or an integer in the range of 1 to 2073600. |
RESTExternalDataAllowed |
Optional |
System.Management.Automation.SwitchParameter |
Specifies whether requests from the Representational State Transfer (REST) Application Programming Interface (API) are permitted to refresh external data connections. The RESTExternalDataAllowed parameter has no effect if ExternalDataAllowed parameter is set to None. |
SessionTimeout |
Optional |
System.Int32 |
Specifies the time, in seconds, that a session remains active on Excel Services Application with no user activity. Valid values include the following: -1 Session never expires. 0 session expires at the end of a single request. 1 to 2073600 Remains active 1 second to 24 days. The default value is 300. The type must be -1, 0, or an integer in the range of 1 to 2073600. |
ShortSessionTimeout |
Optional |
System.Int32 |
Specifies the time, in seconds, that a user has to make the initial interaction with a spreadsheet. After this time has elapsed, if the user is not active, the session is closed. The value must always be less than SessionTimeout. If the ShortSessionTimeout value is greater than or equal to SessionTimeout, an error is returned. The default value is 75. The type must be -1 or an integer in the range of 1 to 2073600. |
UdfsAllowed |
Optional |
System.Management.Automation.SwitchParameter |
Specifies that user-defined functions can be called by workbooks that are loaded from the trusted file location that is specified in Address. The default value is False. |
WarnOnDataRefresh |
Optional |
System.Management.Automation.SwitchParameter |
Specifies that a warning is displayed to the user on the first refresh of data for the workbook. The default value is True. |
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 |
WorkbookSizeMax |
Optional |
System.Int32 |
Specifies the maximum size, in megabytes, of a workbook that can be loaded. The default value is 10. The type must be an integer value in the range of 1 to 2000. |
Input Types
Return Types
Example
--------------EXAMPLE 1--------------
Get-SPExcelServiceApplication -identity "MyExcelService" | New-SPExcelFileLocation -address "http://myPortal/myTeam" -includechildren -locationType SharePoint -description "This is my team's site on myPortal." -workbooksizemax 50 -externaldataallowed DclAndEmbedded -WarnOnDataRefresh:$false
This example adds a new trusted file location to the list of trusted file locations that is in the Excel Services Application Web service application named MyExcelService.
This example enables workbooks to load from any child or subfolder that starts with http://myPortal/myTeam. All workbooks loaded from this location must be smaller than 50 megabytes (MB) in size. The workbooks can refresh external data by using connections that are embedded in the workbook file or stored in a data connection library. A warning message that the workbook is attempting to refresh external data will not be displayed.
--------------EXAMPLE 2--------------
Get-SPExcelServiceApplication -identity "MyExcelService" | New-SPExcelFileLocation -address http://myPortal/myTeam/managers -locationType SharePoint -description "This is the manager's subsite for myTeam."
This example adds a new trusted file location to the list of trusted file locations that is in the Excel Services Application Web service application named MyExcelService with a given address and description.