Versions Compared

Key

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

...

Returns the daily plan orders for workflows scheduled for a number of JS7 ControllerControllers

SYNTAX

Get-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowFolder] <String>] [[-SchedulePath] <String>] [[-ScheduleFolder] <String>] [-Recursive] [[-ControllerId] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [-Late] [-Planned] [-Submitted] [-Finished] [<CommonParameters>]

...

The daily plan orders for workfows workflows of a number of JS7 Controllers are returned.

The following REST Web Service API resources are used:

* /daily_plan/orders

PARAMETERS

OrderId

-OrderId <String>

...

-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan orders should be returned.
Consider that a UTC date has to be provided.

Default: Begin Beginning of the current day as a UTC date

...

-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted in the daily plan information.
A timezone can e.g. be specified like this:

Get-JSDailyPlan JSDailyPlanOrder -Timezone (Get-Timezone -Id 'GMT Standard Time')

All dates in JobScheduler JS7 are UTC and can be converted e.g. to the local time zone like this:

Get-JSDailyPlan JSDailyPlanOrder -Timezone (Get-Timezone)

Default: Dates are returned in UTC.

...

-Planned <SwitchParameter>
Specifies that daily plan orders are returned that did have not yet startbeen submitted.

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

...

-Submitted <SwitchParameter>
Specifies that daily plan orders are returned that are submitted to a Controller for scheduled execution.

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

...

-Finished <SwitchParameter>
Specifies that daily plan orders are returned that did complete.

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

...

PS > $orders = Get-JS7DailyPlanOrder -Failed Submitted -Late

Returns today's daily plan orders that failed or have been submitted but are late, i.e. that did not start at the expected point in time.

...

Returns the daily plan orders for the given indicated workflow.