---
title: "New-NectarReport"
slug: "new-nectarreport"
updated: 2024-07-22T16:15:47Z
published: 2024-07-22T16:15:47Z
canonical: "support.nectarcorp.com/new-nectarreport"
---

> ## 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.

# New-NectarReport

Creates a new report

## Description

Creates a new report using previously defined widgets from New-NectarReportWidgetConfig

## Syntax

```
New-NectarReport
  -Name  <String>
  -Description  <String>
  -Type  <String>
  -WidgetList  <ArrayList>
  -ReportTimeZone  <String>
  -ScheduleMode  <String>
  -SchedDayOfMonth  <Nullable`1>
  -SchedWeekdays  <String[]>
  -SchedStartDate  <String>
  -SchedEndDate  <String>
  -SchedStartTime  <DateTime>
  -SchedTimeZone  <String>
  -SchedNotifyMethod  <String>
  -SchedEmail  <String[]>
  -SchedEmailSubject  <String>
  -SchedEmailMessage  <String>
  -SchedRepeatEveryNumDays  <Nullable`1>
  -SchedRepeatEveryNumWeeks  <Nullable`1>
  -TenantName  <String>
```

## Examples

### Example 1

```
New-NectarReport -Name 'Test Report -Description 'This is a test report' -WidgetList $WidgetList -Type User
```

Creates a user-level report using a pre-defined set of widgets stored in the $WidgetList variable

## Parameters

**-Name <String>** The name of the report

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

**-Description <String>** A description to go with the report

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

**-Type <String>** The report type (or scope). Select from User or Tenant. User reports are visible only to the creator. Tenant reports are visible to all users.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | User |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-WidgetList <ArrayList>** An arraylist containing the definitions for all the widgets to put in the report. Widgets are defined using New-NectarReportWidget

| Parameter | Value |
| --- | --- |
| Required | true |
| Position | 4 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-ReportTimeZone <String>** The timezone used for report display

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | "Etc/GMT$((Get-TimeZone).BaseUTCOffset.hours)" |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-ScheduleMode <String>** How often to run the report when on a schedule

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

**-SchedDayOfMonth <Nullable`1>** If report is run on a schedule, what day of the month to run the report. Only works with ScheduleMode MONTHLY

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

**-SchedWeekdays <String[]>** The days of the week to run the report. Only works with ScheduleMode WEEKLY

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

**-SchedStartDate <String>** When the report schedule should start

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 9 |
| Required | false |
| Default Value | ((Get-Date).AddDays(1)).ToShortDateString() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-SchedEndDate <String>** When the report schedule should end

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

**-SchedStartTime <DateTime>** The time of day that the report should start processing

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 11 |
| Required | false |
| Default Value | 00:00 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-SchedTimeZone <String>** The timezone the schedule should run on

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 12 |
| Required | false |
| Default Value | "Etc/GMT$((Get-TimeZone).BaseUTCOffset.hours)" |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-SchedNotifyMethod <String>** How to notify users when the report is ready

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 13 |
| Required | false |
| Default Value | NONE |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-SchedEmail <String[]>** One or more email addresses, separated by commas to notify upon report completion. Only usable when SchedNotifyMethod is EMAIL

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

**-SchedEmailSubject <String>** The subject line of the email. Only usable when SchedNotifyMethod is EMAIL

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 15 |
| Required | false |
| Default Value | $Name |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-SchedEmailMessage <String>** The content of the email message. Only usable when SchedNotifyMethod is EMAIL

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

**-SchedRepeatEveryNumDays <Nullable`1>** How often to repeat a daily schedule

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

**-SchedRepeatEveryNumWeeks <Nullable`1>** How often to repeat a weekly schedule

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 18 |
| Required | false |
| Default Value | None |
| 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 | 19 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |