Difference between revisions of "Powershell"
(→Output) |
(→Output) |
||
Line 29: | Line 29: | ||
===Output=== | ===Output=== | ||
− | [[#RepositoryConnection|RepositoryConnection[]]] | + | ''[[#RepositoryConnection|RepositoryConnection[]]]'' |
+ | The connections in the report | ||
==Set-XL3Connections== | ==Set-XL3Connections== |
Revision as of 14:05, 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
[hide]- 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
- 4 Data Types
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[] The connections in the report
Set-XL3Connections
Update the connections in the report
Parameters
- -Data (Dictionary<string,byte[]>)
- Report data - can be retrieved using Select-XL3Report
- Connections (RepositoryConnection[])
- Connections to use in the report - connections in the report will be matched by Id and updated to reflect the given Type, Server, Database and Cube
Output
Dictionary<string,byte[]>
The updated report data
Add-XL3Folders
Add a new folder to the repository
Parameters
- -Path (string)
- Path to the folder to add the new folder to
- -Name (string)
- Name of the folder to add
Output
The folder object that has been added
Get-XL3Folders
Remove-XL3Folders
Rename-XL3Folders
Clear-XL3Permissions
Get-XL3Permissions
Remove-XL3Permissions
Set-XL3Permissions
Add-XL3Reports
Get-XL3Reports
Open-XL3Reports
Remove-XL3Reports
Rename-XL3Reports
Select-XL3Reports
Get-XL3Repository
Data Types
RepositoryConnection
public class 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; } }
RepositoryFolder
public class RepositoryFolder { public string Name { get; set; } public string Path { get; set; } public bool? OveridePermissions { get; set; } }