Documentation Index

Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt

Use this file to discover all available pages before exploring further.

Start-NectarReport

  • Published on Jul 22, 2024
  • 1 minute(s) read
Prev Next

Triggers the processing of a report

Syntax

Start-NectarReport
  -ID  <Int32>
  -TenantName  <String>

Examples

Example 1

Start-NectarReport -ID 31

Triggers the execution of report with ID 31

Get-NectarReport Test | Start-NectarReport
Triggers the execution of any report with 'Test' in the name

Parameters

-ID <Int32>
The numeric ID of the report to start

Parameter Value
Required true
Position 1
Required true
Default Value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.

Parameter Value
Required false
Position 2
Required false
Default Value None
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false