XLCubed is now FluenceXL. The new wiki can be found here: https://help.fluencexl.com/

Difference between revisions of "Powershell"

(Methods)
(Installing=)
Line 5: Line 5:
 
The PowerShell cmdlet is available by contacting support@xlcubed.com - it helps automate deployment of reports, folders and permissions.
 
The PowerShell cmdlet is available by contacting support@xlcubed.com - it helps automate deployment of reports, folders and permissions.
  
=Installing==
+
=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:
 
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:
Line 16: Line 16:
  
 
  -AuthToken => Optional JWT authorisation token to use when accessing an App Service instance of XLCubedWeb
 
  -AuthToken => Optional JWT authorisation token to use when accessing an App Service instance of XLCubedWeb
 
  
 
=Methods=
 
=Methods=

Revision as of 12:48, 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.

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; }
}

Add-XL3Folders

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