Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NAME

New-JobSchedulerHolidays

SYNOPSIS

This cmdlet creates an XML holiday document that can be used to specifiy
non-working days for start time calculation of jobs and orders.

SYNTAX

New-JobSchedulerHolidays -Select <String> -Days <Int32> -Interval <String> [-Weekdays <String[]>] [[-NonWorking
Weekdays] <String[]>] [-FromDate <DateTime>] -ToDate <DateTime> [-HolidayFiles <String[]>] [-OutputFile <String
>] -Append -Force <CommonParameters>

DESCRIPTION

There are some use cases for start time calculation that exceed the
scope of run-time settings offered by JobScheduler:

...

<ultimos>
<day day="1">
<period single_start="05:00" when_holiday="previous_non_holiday"/>
</day>
</ultimos>

PARAMETERS

Select

-Select <String>
Specifies the selection of days that is either counted from the begin or from the end of
the given interval, e.g. a week, a month, a year:

...

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Days

-Days <Int32>
Specifies the number of days starting from or ending with each interval
that are used to calculate the next start date.

...

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Interval

-Interval <String>
Specifies the interval for which start dates are calculated:

...

Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Weekdays

-Weekdays <String[]>
Optionally specifies a list of weekdays for which jobs or job chains are not started, e.g.
due to run-time constraints.

...

Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

NonWorkingWeekdays

-NonWorkingWeekdays <String[]>
Optionally specifies a list of weekdays for which jobs or job chains are not started, e.g.
due to run-time constraints.

...

Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

FromDate

-FromDate <DateTime>
Specifies the lower bound of the date range for which non-working days are calculated.

...

Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

ToDate

-ToDate <DateTime>
Specifies the upper bound of the date range for which non-working days are calculated.

Required? true
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

HolidayFiles

-HolidayFiles <String[]>
Optionally specifies the path and name for a number of global holiday files that are in use by JobScheduler.
Global non-working days from a holiday file are applied to the calculation of the next start date
by this cmdlet without being added to its output.

Required? false
Position? 8
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

OutputFile

-OutputFile <String>
Optionally specifies an output file that contains the resulting XML configuration
for non-working days.

Required? false
Position? 9
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Append

-Append <SwitchParameter>
Optionally specifies the newly calculated non-working days to be appended
to an existing output file that is specified by use of the -OutputFile parameter.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Force

-Force <SwitchParameter>

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

about_jobscheduler

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

...