Difference between revisions of "Powershell"
(→Installing=) |
(→Get-XL3Connections) |
||
Line 25: | Line 25: | ||
===Parameters=== | ===Parameters=== | ||
− | + | *Data (''Dictionary<string,byte[]>'') | |
− | ''Dictionary<string,byte[]>'' | + | **Report data - can be retrieved using Select-XL3Report |
− | Report data - can be retrieved using Select-XL3Report | ||
===Output=== | ===Output=== |
Revision as of 13:49, 27 October 2022
Available for Version 10.0.144 and above running XLCubedWeb in a role-based SQL Repository running Windows Authentication or on an App Service.
Contents
- 1 Introduction
- 2 Installing
- 3 Methods
- 3.1 Get-XL3Connections
- 3.2 Set-XL3Connections
- 3.3 Add-XL3Folders
- 3.4 Get-XL3Folders
- 3.5 Remove-XL3Folders
- 3.6 Rename-XL3Folders
- 3.7 Clear-XL3Permissions
- 3.8 Get-XL3Permissions
- 3.9 Remove-XL3Permissions
- 3.10 Set-XL3Permissions
- 3.11 Add-XL3Reports
- 3.12 Get-XL3Reports
- 3.13 Open-XL3Reports
- 3.14 Remove-XL3Reports
- 3.15 Rename-XL3Reports
- 3.16 Select-XL3Reports
- 3.17 Get-XL3Repository
Introduction
The PowerShell cmdlet is available by contacting support@xlcubed.com - it helps automate deployment of reports, folders and permissions.
Installing
Extract the supplied zip file, you can then install it by running the following command, either using the extracted folder as the current directory or by passing a full path:
Import-Module '.\XLCubed.PowerShell.dll' -force
All commands take the following parameters:
-BaseUri => The full URL to the XLCubedWeb server, for example: https://someserver/xlcubedweb
-AuthToken => Optional JWT authorisation token to use when accessing an App Service instance of XLCubedWeb
Methods
Get-XL3Connections
Return the connections used by the supplied report
Parameters
- Data (Dictionary<string,byte[]>)
- Report data - can be retrieved using Select-XL3Report
Output
RepositoryConnection[] { public int Id { get; set; } public string Type { get; set; } public string Server { get; set; } public string Database { get; set; } public string Cube { get; set; } }
Set-XL3Connections
Update the connections in the report
Parameters
Data
Dictionary<string,byte[]> Report data - can be retrieved using Select-XL3Report
Output
RepositoryConnection[] { public int Id { get; set; } public string Type { get; set; } public string Server { get; set; } public string Database { get; set; } public string Cube { get; set; } }