Figure 103. Niagara Network Prototype View
To access this view, expand and click theNiagaraNetworkJobPrototype , or right-click .
As on the Niagara Network Job Builder view, this view has alarm check boxes, three list areas with controls, and buttons at the bottom of the view.
Alarm check boxes
| Alarm check box |
Description |
| Generate an alarm when any step fails or is canceled |
Determines if the BatchJobService is to issue alarms for this provisioning job, and under what circumstances. Alarms use the alarm class specified in the BatchJobService and appear in the alarm console as alerts.
When selected, the BatchJobService raises an alarm whenever a job step fails or is canceled.
|
| Generate an alarm when job completes successfully |
Configures the BatchJobService too raise an alarm when a job completes with no step failures.
|
Steps and Stations
| List Area |
Description |
| Provisioning steps to run |
Provides a one-line summary for each step to be run for each station specified in this job. In most provisioning jobs, you
add one or more steps.
For specific steps, refer to . Steps
|
| Stations to include in the job |
Lists all the stations to be processed by the job. This means each station processes all steps in the (middle pane) Steps for Each Station List. Only stations in the Supervisor’s NiagaraNetwork can be added. For any job, you add one or more stations, and you can also remove and reorder stations (stations are processed
in a top-to-bottom order).
|
Controls
| Control |
Description |
 |
Adds a step. |
 |
Moves the selected step up in the sequence of steps. |
 |
Moves the selected step down in the sequence of steps. |
 |
Removes the selected step. |
 |
View and edit the details of the selected step. |
Buttons
- Run Now dispatches the job to the batch job queue for immediate execution. The view automatically changes to the Niagara Network Job view. This button is enabled when there is at least one job step in either the Initial Steps To Run Once List or Steps for Each Station List, and one station in the Stations List.
- Refresh removes all entries from the three lists.
Steps
Figure 104. The Add Steps Window
The screen captures shows all provisioning job steps to run for each station. This list includes all steps:
- Add Station User (component:AddStationUserStep) – adds a new user to the station.
- Backup Stations (component: BackupStationExt) – makes an online backup of each running station.
- Convert To Perpetual Licence Mode — Converts all the stations' licensing mode from subscription to perpetual
- Copy Supervisor File (component: FileCopyStep) – makes a copy of a
Supervisor file.
- Deploy Template (component: DeployTemplateStep) – deploys a component template to each station using and Excel file.
- Enable Bootstrap Mode (component: EnableBootstrapStep) – creates a one-time provisioning job to connect from the Supervisor to the remote controller using a certificate exemption
for the default self-signed certificate. This step is intended for use with other provisioning steps that set up credentials
and configure certificates. It is useful for provisioning new out-of-the-box devices.
- Export Application Template Configuration — Exports an application template configuration as an xlsx file
- Export Certificate Signing Request (component: ExportCsrJobStep) - generates and exports a CSR for each remote host.
- Import Signed Certificate (component: ImportSignedCertificateJobStep) – imports a signed certificate for each remote host.
- Install a Signed Certificate for an Individual Service (Fox, Web, etc) – Install an Individual Signed Cert Config to onboard/renew a signed certificate for a particular service, like the FoxService or WebService.
- Install a Signed Certificate for Fox/Web/Platform to share – Install a Combined Signed Cert Config to onboard/renew a signed certificate for Fox, Web, and/or Platform to share.
- Install Application Template (component: DeployApplicationStep) – installs an application template on each station using an Excel file.
- Install Certificate (component: InstallCertificateJobStep) – installs a certificate from the supervisor's user trust store to each remote host's user trust store.
- Install Clean Distribution (component: InstallCleanDistStep) – installs the selected clean distribution file to the target platforms.
- Install Software (component: InstallBySpecStep) – installs a software module in one or more remote hosts.
- Reboot (component: RebootJobStep) – reboots the platform host.
- Remove Platform User Remove a user from the platform.
- Remove Property (component: RemovePropertyStep) – removes a property from a component at a defined slot path for each station in the provisioning job.
- Remove Station User (component: RemoveStationUserStep) – removes a named user from the station.
- Rename Device Station (component: RenameStationStep) – renames the station on the remote host to match the name in the supervisor's NiagaraNetwork.
- Run Robot (component: RunRobotStep) – allows you to create custom code to run on each station.
- Security Job Steps is a convenience step that generates three separate sets of credentials in one place and in one sequence. The individual
steps are Set Platform Credentials, Set Station User Password and Set Platform User Password.
- Set Certificate Alias (component: SetCertificateAliasJobStep) – sets the certificate alias used for the remote device's platform, web, and fox services.
- Set Platform Credentials (component: SetPlatformCredentialsJobStep) – adds a new platform user account and removes the default account on the remote device.
- Set Platform User Password (component: SetPlatformUserPasswordJobStep) – changes password for an existing platform user.
- Set Property (component: SetPropertyJobStep) – set or add a property.
- Set Station Connection Credentials (component: SetStationConnectionCredentialsStep) – sets the station credentials used to connect to the remote station.
- Set Station User Password (component: SetStationUserPasswordJobStep) – sets the station user password.
- Set System Passphrase (component: SetSystemPassphraseJobStep) - sets the system passphrase.
- Set TLS Level (component: SetTlsLevelJobStep) – sets the minimum TLS level for the remote device's platform, web, and fox services.
- Set Time (component: SetTimeJobStep) - sets the time on the remote device.
- Setup Reciprocal Connection (component: SetupReciprocalConnectionStep) – sets the connection settings for the "reciprocal" station connection, which is the station proxy in the NiagaraNetwork on the remote station that points back to the
Supervisor.
- Sign Certificate (component: SignCertificateStep) signs a certificate (typically a server certificate) for each remote platform in the job.
- Update Connections Using Niagara Network Discovery (component: NiagaraNetworkDiscoveryStep) – updates station connections using NiagaraNetwork discovery.
- Update Connections Using Provisioning Station’s DHCP Server (component: DhcpDiscoveryStep) – updates station connections using the provisioning station’s DHCP server leases.
- Upgrade Out-of-Date Software (component: SoftwareStationExt) – installs software, upgrades out-of-date software, supports copy supervisor step, and the reboot step.
- Update Template or Application Configuration (component:UpdateConfigurationStep updates the template configuration values of an installed template in each remote station.
- Update Licenses job step (component:UpdateLicensesJobStep – updates software license in each remote host.
- Upgrade Application Template (UpgradeApplicationStep) upgrades the installed application template in each remote host.
- Upgrade Out-of-Date Software (UpgradeOutOfDateStep) compares module versions on the target hosts with the latest versions in the
Supervisor’s software database and installs updates as needed.
- Upgrade Template (component: UpgradeTemplateStep) - upgrades deployed component template instances on each station using and Excel file.
Toolbar for Niagara Network Prototype
| Toolbar Icon and Name |
Description |
Save
|
Saves the changes. |
Undo
|
Reverses the previous command. |
Redo
|
Restores a command action after the Undo command has removed it. |
Multi-selection Mode
|
Enables you to individually select multiple points without holding down the ctrl key. |
Export
|
Exports the current view or object. |