batchJob-PrototypeJobList

This view provides a table-based history of this batch job and its results. It is available on any reusable provisioning job component (NiagaraNetworkJobPrototype), and is accessed by using the view selector, or by right-clicking the component and selecting Views > Prototype Job List.

Figure 1. Prototype Job List is another view of a NiagaraNetworkJobPrototype component

This view has just one list area, a table with buttons on the right and the bottom. It differs from the Niagara Network Job List (NiagaraNetwork’s ProvisioningNwExt view) in the following ways:

The two retention properties for the associated job prototype component are shown at top, where you can adjust if needed. Setting retention policy is recommended for any job that includes ongoing periodic backups.
The table shows only jobs from the (one) associated job prototype (provisioning job), whereas the Niagara Network Job List table shows all retained provisioning jobs.

Retention Policy

These rules determine what happens to the completed provisioning job.

Retention policy rule	Value	Description
Retain permanently	n/a	Causes all executed batch jobs to remain in the Supervisor’s station job management system until manually disposed of.
Dispose after a specified amount of time	days, hours, and minutes (default 7 days)	Causes executed batch jobs to be deleted after a period of time relative to the job’s end timestamp.
Keep a limited number of executions	number and check box The check box defaults to count only successful executions.	Causes the system to save only the most recent number of executed batch jobs, after which older jobs are deleted. Removing the selection causes the system to include all job attempts.
Policy enforcement frequency	hours, minutes, seconds (default is one hour)	Establishes the periodic frequency at which the job’s retention policy is evaluated and enforced. You can manually invoke the Enforce Retention Policy action on the job component.

Columns

This main area of the Prototype Jobs List shows provisioning jobs that have been sent to run, are running, or are have completed. Any pending jobs do not appear until the job prototype’s linked trigger schedule actually fires.

Column	Value	Description
Start or Started	date and time (read-only)	Displays the date and time that the system submitted the job to the job queue.
End or Ended [step]	date and time	Displays the date and time when the step stopped running. This property is blank if the job is still running.
User	text	Defines the station user that requested the job. This column displays `unknown` if job was triggered by a linked schedule.
Status or State	read-only text:	Displays the current or final state of the job. The first three states appear on the Device Network Job view. `Unknown` —the job is pending execution. `Running` — the job is executing. `Canceling` — request to cancel the job was sent, but has not been processed yet, and the job is still executing. `Success` — job finished successfully, with all steps completed for all stations. `Canceled` — job was canceled before it completed, and is no longer running. `Failed` — at least one step failed in one station; job is no longer running. Each row in the table ends with a details button (>>) and a dispose button (X) . Clicking this button changes the view to the Niagara Network Job view or the Batch Job Step Log File view, which shows all logged messages that are related to this single job. The overall status for the job in other stations, may be different).

Buttons

Button	Value	Description
Submit Job	always enabled	Lets you request that this provisioning job run now. The system adds a new job row at the top of the jobs table, dynamically updating the job status to indicate the job’s progress.
View Log	button enabled when a job row is selected	Opens a popup Job Log window that displays the messages output by the selected job or step.
Job Summary	button always enabled	Changes to the Batch Job Log File View for the job that contains this step.
Cancel or Cancel Job	button enabled only if a job is running	Clicking this button notifies the system to cancel the job when it is safe to do so. Not all job steps can be canceled.
Dispose	button enabled when a job is finished	Clicking this button prompts you to confirm that you want to delete the selected job(s). The deletion includes all associated job files. If you confirm the deletion: The system deletes the job from the JobService (if it is still there and not rolled off as the 11th job, or station restart) The system deletes all associated job files including the batch job log file, batch log step log files, and other files if applicable. For a backup job, this includes deleting the backup .dist file(s). The system removes the job from the Jobs Table in the ProvisioningNwExt’s Niagara Network Job List. You can select multiple jobs to dispose of at the same time.