NAME
Add-JobSchedulerEvent
SYNOPSIS
Adds an event to a JobScheduler instance.
SYNTAX
Add-JobSchedulerEvent [-EventClass <String>] -EventId <String> [-ExitCode <Int32>] [-AllowedExitCodes <Int32[]>
] [-Job <String>] [-JobChain <String>] [-Order <String>] [-MasterUrl <Uri>] [-SupervisorUrl <Uri>] [[-Supervi
sorJobChain] <String>] [-ExpirationDate <DateTime>] [-ExpirationCycle <String>] [-ExpirationPeriod <String>] [-No
Expiration] [-Parameters <Hashtable>] <CommonParameters>
DESCRIPTION
Events can be added to a JobScheduler Master or Supervisor instance that implements event handling.
Should the JobScheduler Master or Supervisor not be accessible then events are stored in
the local file %TEMP%\jobscheduler_events.xml for later dequeueing. Subsequent calls to this
cmdlet will dequeue any previously stored events.
PARAMETERS
EventClass
-EventClass <String>
Specifies a common name for a set of events that enable event handlers to process multiple events of the
same class. For example, "daily_closing" could be an event class for jobs that should start once day-time
business processes have drawn to a close.
...
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
EventId
-EventId <String>
An identifier for an event. Allows event handlers to react to events having a particular ID.
...
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
ExitCode
-ExitCode <Int32>
Specifies the exit code that is added to the event. Usually this signals the execution status of a job,
however, you can assign a specific numeric exit code.
...
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
AllowedExitCodes
-AllowedExitCodes <Int32[]>
Specifies a list of exit codes that signal that a job is considered as having run successfully.
This is useful if job scripts provide return values in the form of exit codes and these codes
should not be considered as errors. When adding an event then any exit codes that match one of the
allowed exit codes are set to 0.
...
Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Job
-Job <String>
Specifies the name of the job that is assigned to the event.
...
Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
JobChain
-JobChain <String>
Specifies the name of the job chain that is assigned to the event.
...
Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Order
-Order <String>
Specifies the identifier of the order assigned to the event.
...
Required? false
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
MasterUrl
-MasterUrl <Uri>
Specifies the Job Scheduler Master instance URL.
...
Required? false
Position? 8
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
SupervisorUrl
-SupervisorUrl <Uri>
Specifies a Job Scheduler Supervisor instance URL.
...
Required? false
Position? 9
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
SupervisorJobChain
-SupervisorJobChain <String>
Specifies the path of the job chain in the JobScheduler Master or Supervisor instance that implements the event
processor.
...
Required? false
Position? 10
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
ExpirationDate
-ExpirationDate <DateTime>
Specifies the point in time for which an event automatically expires: this parameter is considered by the
Event Processor. A specific point in time can be specified by use of the ISO date format, i.e. yyyy-MM-dd HH:mm:ss.
The value 'never' ensures that the event does not ever expire.
...
Required? false
Position? 11
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
ExpirationCycle
-ExpirationCycle <String>
Specifies the time for which the event will expire in the current period.
Periods start at 00:00 and end at 24:00. An expiration cycle of 21:00
specifies 9pm of the current cycle for event expiration.
...
Required? false
Position? 12
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
ExpirationPeriod
-ExpirationPeriod <String>
Specifies the duration after which the event will expire in the current period.
Periods start at 00:00 and end at 24:00. An expiration period of 04:00
specifies that the event will expire 4 hours starting from the current point in time.
...
Required? false
Position? 13
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
NoExpiration
-NoExpiration <SwitchParameter>
Specifies that an event will not expire. Such events have to be removed by event action scripts.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Parameters
-Parameters <Hashtable>
Allows additional parameters for event handlers to be specified. Parameters are created using name-value
pairs from a hashmap as e.g. @{'name1'='value1'; 'name2'='value2'}.
...
Required? false
Position? 14
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
RELATED LINKS
about_jobscheduler
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
...