provisioningNiagara-NiagaraNetworkPrototypeView
The Niagara Network Prototype View, which is nearly identical to the ProvisioningNwExt’s Niagara Network Job Builder, is the default view on each reusable job prototype component (NiagaraNetworkJobPrototype).
You use this view to specify and edit a specific provisioning job.
To access this view, expand and double-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 | Value | Description |
|---|---|---|
| Generate an alarm when any step fails or is canceled | check box | 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 | check box | Configures the BatchJobService too raise an alarm when a job completes
with no step failures. |
Steps and stations
| List area | Value | Description |
|---|---|---|
| Provisioning steps to run | text | 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. |
| Stations to include in the job | text | 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). |
The upper left window opens when you click the plus (+) in the Provisioning steps to run pane. The windows provide a brief description for each step. Additional details on each step are available in the "Provisioning steps" section of Chapter 1, as well as in the following table.
| Step | Use this job step to |
|---|---|
| Enable Bootstrap Mode | Enable the bootstrap mode for Supervisor-to-remote device connections.
It creates a one-time provisioning job to set the Supervisor-to-device
Platform and Fox connections to bypass any certificate checks during
the execution of the provisioning job. This step is intended for use
with other provisioning steps that set credentials and configure certificates. Note: Running this step by itself makes no persistent change on the target
stations. |
| Update Connections Using Niagara Network Discovery | Update station connections using the NiagaraNetwork Discovery function. |
| Update Connections Using Provisioning Station’s DHCP Server | Update the station connections using the provisioning station’s DHCP server leases. |
| Update Licenses | Update the licenses on all remote hosts included in the job. When processed by the Supervisor, it gathers information about the licenses installed on each target host, then accesses the online licensing server (in one message) to see if the licenses are up-to-date. If a host’s license is out-of-date, the step updates each licence in the target station’s host, and in the Supervisor’s local license database. Note: If the Supervisor is not configured for Internet connectivity,
only its local license database is used to compare against licenses
installed in the target host(s). If a host’s license is out-of-date,
the step updates the license in the target host(s). The Brand of a license can also be changed. Existing license files will be deleted and the new license will be copied to the platform. License vendor certificates may also be copied to the target platform if needed. |
| Backup Stations | Make an online station backup if the station is running, or
an offline backup if it is idle. Note: Configuring a regularly-scheduled
station backup by adding a provisioning job prototype (using the Niagara Network Prototype View) is a better practice than
setting up a one-time station backup (using the Niagara
Network Job Builder). |
| Copy Local File | Copy a single file from your (local) PC to a given location
on each remote station in the job. You access this step in the New Job Step menu when adding a step in the Niagara Network Job Builder view. This is not available in the Niagara Network Prototype View. |
| Copy Supervisor File | Copy a single file from your Supervisor station’s filesystem to a location in each remote station in the job. |
| Deploy Template | Deploy a component or device template file to each remote station in the job. Each template instance can have custom configurations, inputs, outputs, and relations using the Bulk Deploy Excel spreadsheet. |
| Export Certificate Signing Request | Export a Certificate Signing Request (CSR) from each remote host for external signing. CSRs are part of the certificate setup for establishing trusted secure communications between a supervisor and remote devices. |
| Generate Certificate | Generate and installs a certificate into the User Trust Store on each remote station. This is part of the certificate setup when the Supervisor will be used to sign certificates. |
| Import Signed Certificate | Import a signed certificate for each remote device Use this to import certificates signed externally (initiated from a CSR) into devices containing the original certificate with the matching private key. |
| Install Application Template | Install an application template file to each remote station in the job. Application templates are useful for establishing a complete station in a single deployable container. Provisioning application templates enables installation across a set of stations. Each installation can have custom configurations applied to it. |
| Install Certificate | Install a certificate to the User Trust Store of each remote station in the job so that it can connect to the Supervisor. This is a step you would perform when you initially bring up your NiagaraNetwork, or after a certificate expires and a new one needs to be installed in each station. |
| Install Software | Install software to each remote station in the job. This step
installs new modules not already running on the target device. Note: All software MUST be installed on the device to support all dependencies
required by the deployed station services, networks, templates, and
any other components. |
| Reboot | Restart each remote station in the job. Typically this step is not explicitly needed, but can be used to ensure a system restart after changes have been made to remote devices. |
| Rename Device Station | Rename each device station to match station proxy name. |
| Run Robot | Passes the specifiedProvisioningRobot (custom-created program code) located in the Supervisor station to the ProgramService on each remote station in the job. The remote station’s ProgramService runs the custom code in the station. For more details, see “Run Robot step” in Chapter 1. |
| Security Job Steps | Add security-related job steps This is a convenience step that adds the Platform Credentials, Station User Password, and System Passphrase steps all at once. |
| Set Certificate Alias | Set the certificate alias for the Platform, Fox, and Web services This is typically done after signed certificates have been installed or configured in the User Trust Store on each remote device. |
| Set Platform Credentials | Assign a user name and password for the Platform connection to each remote device in the job. This is used to replace the default Platform credentials. |
| Set Property | Sets or adds a property to an existing component for each station in the job. You can define the component using a slot path ORD or a NEQL query. If necessary, you can set a unique value for each station in the job. |
| Set Station User Password | Set the password of the current station user for each remote station in the job. This is typically used to replace the default Fox user credentials for new devices, but can be used to replace any user password for the user associated with the current Fox connection. |
| Set System Passphrase | Set the system passphrase for each remote station in the job. This is used to replace the default system passphrase for new devices. |
| Set TLS Level | Set the TLS level for the Platform, Fox, and Web services. The TLS level can be customized across a set of remote devices. |
| Set Time | Set the time for each device in the job. System time for a set of remote devices can be updated to match the Supervisor, or a specific time can be pushed down. |
| Setup Reciprocal Connection | Set up the NiagaraNetwork connection from each remote station to the Supervisor. Certain station functionality (alarm reporting, etc.) requires a Fox connection from the remote station to the Supervisor. |
| Sign Certificate | Sign a certificate on each remote station in the job. This is done as part of the certificate setup, where the Supervisor is acting as the signing authority. |
| Upgrade Out-of-date Software | Upgrade out-of-date software on each remote station in the job. This step compares the versions of software installed on the station’s host with the latest versions of the same software in the Supervisor’s software database. If an older version is found on the station, it installs the latest software there. Common software versions across remote devices reduces the risk of errors caused by version incompatibility. |
| Upgrade Templates | Upgrade deployed template instances on each remote station in the job. For more details. see “Upgrade Template step” in Chapter 1. |
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.
Save saves changes to the corresponding job prototype component.