Your Browser is Out of Date

Nytro.ai uses technology that works best in other browsers.
For a full experience use one of the browsers below
Dell Validated Design for Manufacturing Edge - Design Guide with 5 Independent Software Vendors
Architecture Introduction System Design Accelerated Time to Value High Availability and Disaster Recovery Application Consolidation Cybersecurity Gateways Streaming Data Platform ISV Interoperability Sizing and Scaling Guidance Bill of Materials Additional Tasks
Telit Cinterion tasks
XMPro tasks
Claroty tasks
Litmus tasks
Additional Information References

Telit Cinterion tasks

Home > Edge > Manufacturing Edge > Guides > Dell Validated Design for Manufacturing Edge - Design Guide with 5 Independent Software Vendors > Telit Cinterion tasks

Telit Cinterion tasks

  • This set of additional tasks for Telit Cinterion contains detailed steps and supplementary images to aid in understanding and implementing many of the features discussed throughout the Dell Validated Design for Manufacturing Edge documentation.

    Note: This set of additional tasks is a supplement to the main chapters of the document, focused on detailed steps. For important context and considerations, consult the primary body of the documentation.

    Note: Throughout the following sections, keep in mind that any time a configuration change is needed, it is best practice to first make a backup of the node. Find an overview of backup and restore in the section Backup and restore with Workbench and detailed steps in Accelerate time to value with Telit Cinterion.


    System design tasks


    Download a package

    User has access to Telit Cinterion’s online IoT Portal.
    Packages offer extended functionality to the deviceWISE Edge node software. This task describes how to download a package from Telit Cinterion’s IoT portal for installation on a deviceWISE Edge node.
    1. Log in to Telit Cinterion’s online IoT portal.
    2. On the top menu, click Developer. On the subsequent left menu, click Resources.
    3. Go through the series of options as follows: deviceWISE version > OS/platform > Packages > Generally Available/Pilot Ready/Technology Preview. For example: 22.03.06 > OS Windows > Windows 64-bit > Packages > Generally Available.
    4. Identify packages as needed and click the Download icon to the left of the package name.
    5. Make downloaded packages available to the Workbench host.
    To verify, perform the following steps:
    1. Downloaded packages are ready to be installed on the edge node.
    2. Install the packages using one of the two methods: Install packages on a single node and Install packages on multiple nodes using Groups.

    Install packages on a single node

    • Any packages to install must be available to the deviceWISE Workbench instance. For more information, see Download a package.
    • A node restart is required during this task—ensure the node is in the appropriate state, as processes may be interrupted.
    Note: Installed packages must match the edge node software, both in platform and version.

    Packages offer extended functionality to the deviceWISE Edge node software. This task explains how to load one or more packages onto a single node.

    1. Open Workbench and connect to the edge node.
    2. Expand the node’s menu and navigate to Administration > Packages.
    3. Click the Add button at the bottom.
    4. Go to the packages in the browse window. Select a single package or hold Ctrl to select multiple packages. Click Add.
    5. If there is a platform mismatch between the deviceWISE Edge software and the packages, an error is received.
    6. A pop-up window containing the list of selected packages appears. Click OK to continue.
    7. Click OK again on the subsequent window warning that this action requires a node restart.
    8. Wait while the node restarts. The node will be inaccessible from Workbench. This may take several minutes.
    To verify, perform the following steps:
    1. Expand the node’s menu, and navigate to Administration > Packages.
    2. Confirm that the new packages are present in the list.

    Install packages on multiple nodes using Groups

    • Any packages to install must be available to the deviceWISE Workbench instance. See Download a package.
    • A node restart is required during this task—ensure that all nodes are in the appropriate state, as processes may be interrupted.

    Packages offer extended functionality to the deviceWISE Edge node software. Groups allow edge nodes to be bundled together, and an action executed just once is applied to all the Group’s node. This task explains how to add one or more packages to multiple nodes using Groups.

    Note: Installed packages must match the edge node software, both in platform and version.

    1. To create a Group:
      1. Open Workbench and connect to each edge node.
      2. Click on the Groups tab at the top of Workbench.
      3. Right-click on the Groups menu heading and select New.
      4. Enter the group’s name and click OK.
      Note: Groups are specific to the Workbench instance. Connecting from a different Workbench instance does not show the same Groups.

    2. To add nodes to a Group:
      1. Click on the Nodes tab at the top of Workbench.
      2. Right-click on a node, and select Add to Group, and then the group’s name.
        Figure 276. Menu options to add a node to a group
        Menu options to add a node to a group
      3. Repeat the previous two steps as needed for additional nodes.
    3. To add packages to the Group:
      1. Click on the Groups tab of Workbench.
      2. Click the [+] by the group name to see the list of member nodes.
      3. Right-click on the Group name and select Group Action > Add Packages.
      4. Go to the packages in the browse window. Select a single package or hold Ctrl to select multiple packages. Click Add.
      5. A pop-up window containing the list of selected packages appears. Click OK to continue.
      6. The Status of the package update on each node is displayed in the window.
        1. If a node is offline, the package update fails on that node, and the Retry Failed button can be used to reattempt the update on the failed nodes. If the retry is successful, the Status is updated appropriately.
        2. If a node in the group does not share the OS or platform with the packages being uploaded, a Firmware platform mismatch error window appears.
      7. Click Done to close the Group Package Status window.
    To verify, perform the following steps:
    1. Expand each node’s menu, and go to Administration > Packages.
    2. Confirm that the new packages are present in the list.

    Update deviceWISE Edge software

    • User has access to Telit Cinterion’s online IoT Portal.
    • A node restart is required during this task—ensure that all nodes are in the appropriate state, as processes may be interrupted.
    Note: Update files must match the edge node software platform.

    Updating deviceWISE Edge software using the available update file allows a user to get the newest software version, with new and enhanced features, without losing previous configuration settings. The file required to perform an update when an older version of deviceWISE Edge is already installed is of the deviceWISE update file type (.dwu), and is distinct from the executable or tar file used in a new installation. Because of this, the installation can be performed through Workbench, rather than directly on the node host, as is required at initial installation. This task captures the steps performed for a minor upgrade from v22.03.06 to v22.04.06.

    1. To download the update file and packages, perform the following steps:
      1. Log in to Telit Cinterion’s online IoT Portal.
      2. On the top menu, click Developer. On the subsequent left menu, click Resources.
      3. Navigate through the series of options as follows: [deviceWISE version] > [OS/platform] > [Enterprise Gateway/Asset Gateway]. For example: 22.03.06 > OS Windows > Windows 64-bit > Enterprise Gateway.
      4. Find the .dwu file with Update in the name and click the Download icon to the left of the file name.
      5. Download the new version of any packages required by the edge node. See Download a package for instructions.
      6. Make the downloaded update file and accompanying packages available to the Workbench host.
    2. To execute the update, perform the following steps:
      1. Open Workbench and connect to the edge node.
      2. Expand the node’s menu and navigate to Administration > Node Administration.
      3. Click the Firmware Update button at the bottom and browse to the update file and select it. Click Select.
      4. Wait a minute. An Update Firmware confirmation window appears. Click Install to proceed.
      5. The update file is then transferred to the edge node, and a Progress window appears to indicate the transfer status.
      6. Once the transfer is complete, an Update Firmware window indicates that a node restart is required. Click OK to continue.
    To verify, perform the following steps:
    1. Once the node has restarted and Workbench is reconnected, navigate to the Administration > Node Administration tab.
      1. Confirm the updated version by consulting the Software Release Level field.
      2. Confirm that all settings and configuration are maintained after the update.
    2. Update the packages with the newer version. See Install packages on a single node and Install packages on multiple nodes using Groups for instructions.
    3. The older version of the packages is automatically removed when the new packages are added.

    Send data with MQTT

    deviceWISE OPC UA, MQTT, and JSON packages must be installed.

    This section describes the data flow from industrial IOT devices to deviceWISE Edge gateways and subsequently to SDP for persistent data storage and display.


    Connection to SDP Pravega MQTT Broker

    To prepare the edge node for an SDP MQTT connection, see Prepare the Telit deviceWISE gateways for MQTT connection.

    1. On deviceWISE Workbench from the left pane, expand the node that you want to add a device definition to.
    2. Click Devices. The Devices window appears on the right pane.
    3. From the bottom of the Devices tab, select New. A default Device window appears.
    4. Configure the MQTT connection for the device by entering various values. Make sure to select the appropriate MQTT with TLS connection type, SDP Pravega MQTT broker IP address, SDP certificate file, MQTT port number, and Pravega MQTT broker username and secret key.
      Figure 277. Configuration of MQTT connection
      Configuration of MQTT connection
    5. Click the Validate button to validate the parameters and establish a connection to the device. If the parameters are not correct or if a connection cannot be established, an appropriate reason is displayed.
    6. Use the Save button to save the definition of the device. The device appears in the list of devices for the node, in a Stopped state.
    7. From the Devices tab, select the device.
    8. Right-click to display its pop-up menu, and then select Start or when the device row is selected, select the Start button at the bottom of the panel.

    Connection to IoT devices

    1. From the Workbench left pane, expand the node where you want to define the Client device.
    2. Right-click Devices and then select New. The Device window appears.
    3. Enter the Name of the device. The device name can be up to 64 characters and include letters, numbers, and the underscore character. Spaces are allowed.
    4. Click the Type drop-down menu and select UA Client under OPC. The available device types are determined by the driver packages that are installed on the node.
      To define a device that represents an OPC UA client, set the new device's parameters as shown in the following figure:
      Figure 278. Example OPC UA device configuration
      Device configuration
    5. Click Validate to have the parameters validated and to connect to the server application. If there are problems connecting to the server, an error code is displayed.
    6. Click Save to save the device definition. The device appears in the Devices window list of devices.

      You can now control the device (Start, Stop), access the device's variables by using the Variables window, and build solutions that use the device's resources.


    Create variable groups and define tags in each group

    Variable groups are defined on the node where the device variables are accessible.

    The Variable Group trigger event type and Data trigger event type are similar in that they monitor the change of the value of a device variable (or multiple device variables). The differences include the number of device variables (single or multiple) and the variable value change conditions.

    Variable groups are defined after the devices referenced for the device variables are defined and started.

    Perform the following steps to add a variable group definition to a node:
    1. From the left pane, expand the node that you want to add a variable group definition to.

    2. Select the Devices icon.

      Then select the Variable Groups tab.

      Or, alternatively, select the Variable Groups sub icon.

    3. From the bottom of the Variable Groups tab, select New.

      A new Variable Group window appears. Enter a name for the variable group.

      This is used to identity the variable group in the Variable Group trigger event type.

    4. Select a value for the Priority (ms) parameter.

      This is the frequency that the runtime Device Publisher feature reads the device variables. The units are in milliseconds (ms).
      Figure 279. Variable group
      Variable group

    5. Select the Add button to add device variables.

      The list of devices are the Started devices on this node. Expand the desired device and its internal structure until you can select the individual device variable.
      Figure 280. Add a variable to a variable group
      Add a variable to a variable group
    6. Each variable has a Key, which is available to the Variable Group event type trigger as an event variable. This is set to a default value when the variable is added to the group, but it can be edited. This variable key can be used as a reference ID, or correlation ID, to help identify which variable's value in the group has changed.
    7. Variables can be deleted from this list, as well as moved up and down in the list. The location in the list has no impact on the evaluation of the variable group, rather it is solely for list readability for the user.
      Figure 281. Add variable in variable group
      Add variable in variable group
    8. Use the Save button to save the definition of the variable group. The variable group appears in the list of variable groups for the node, in a Stopped state.
      Figure 282. Variable group
      Variable group
    9. Right-click on variable group and change the variable group to the Started state. The runtime Device Publisher component reads the device variables at the defined priority frequency.
      Figure 283. Variable group view
      Variable group view

    Create a project and a trigger to publish data to the SDP Pravega MQTT broker

    The user can build as many projects as needed for a specific node and define the triggers required within each project. The structure of triggers within a project might be based on the physical qualities of the solution or on the logical functions that the triggers serve.

    Perform the following steps to create a project.

    1. From the Workbench left pane, click and then expand the node that you want to add a project to.

      An expanded tree view of the selected node appears.

    2. Click Projects

      The Projects window appears on the right-hand pane. The list of projects will be empty if no projects have been defined.

    3. From the bottom of the Projects tab, click New.
    4. Enter a name for the project, an optional description, and then click OK. A project name can be up to 64 characters in length and can include letters, numbers, and the underscore character. Spaces are allowed. The project name is added to the Projects tab on the Workbench right hand pane.
    5. Right-click and start the project.
      Figure 284. Project view
      Project view

    Define a Trigger

    This example shows the creation and execution of a simple trigger. The idea and reference material for triggers and components can be obtained at the following link: Defining a trigger

    To define a trigger, perform the following steps:

    1. Click the project where the trigger will reside.

      This example assumes that you will use the project defined in the Projects documentation or in the Create a project and a trigger to publish data to the SDP Pravega MQTT broker section.

    2. Click the New button at the bottom of the righthand pane of the Projects tab to start the definition of a new trigger.

      The New trigger window appears.

    3. Enter SDP-MQTT-Writer for the Name.
    4. Select Variable group for the Trigger Event Type.
    5. Select Variable Group Name as Group1.
    6. Select condition as Value Changed.
      Figure 285. Trigger Event Type configuration
      Trigger Event Type configuration

      For more information on different event types, see the following link: Trigger event type

    7. Click the Settings tab and set the parameters as shown in the following figure:
      Figure 286. Trigger settings
      Trigger settings
    8. From the left pane list of actions, expand the Internal category.
    9. Click the JSON New action and place it in the canvas below the Start block.

      Alternatively, you can drag (click and hold) the action and then position its location and drop (release the mouse button).

    10. Click on JSON encode and enter the following string in JSON Template: 
      {"success":true,
      "datatype":"int32",
      "timestamp":1670600697160,
      "registerId":"E196123C-2C8A-42C7-845F-4BE408243272",
      "value":4185,
      "deviceID":"2131377B-952F-4E37-988A-28E1528C1C28",
      "tagName":"Objects_Telit_500_Variable 1",
      "deviceName":"test",
      "description":"",
      "metadata":{}}
      Note: The above-mentioned JSON is required by the existing SDP configuration. It may change in the future, based on user feedback.

    11. Create JSON output as a local variable, as shown in the following figure.
      Figure 287. JSON template
      JSON template
    12. Click the MQTT Publish action and place it in the canvas below the JSON Encode block.
    13. Double-click on MQTT Publish, and pass the parameters as shown in the following figure:
      Figure 288. MQTT publish detail
      MQTT publish detail
    14. From the toolbar above the left pane, select the End Execution (Success) action and position it on the Canvas below the MQTT Publish action.
      Figure 289. Overall trigger configuration
      Overall trigger configuration
    15. Click on Validate, and if there are any errors, fix them before clicking Save.

    Start triggers for writing data to SDP Pravega streams

    1. Right-click and Start the trigger.
      Figure 290. Project status
      Project status

      The number of Successes shows successfully delivered messages.

    2. To validate the data in SDP Pravega and TimescaleDB, verify the data in SPD in stream view, as shown in the following figure:
      Figure 291. SDP stream view

      SDP stream view

      For further information on how to set up TimescaleDB and InfluxDB in SDP, see the Configure the TimescaleDB sink and Deploy the InfluxDB sink sections.
    3. Verify data in the Grafana data visualization, as shown in the following figure:
      Figure 292. Grafana dashboard

      Grafana dashboard

      For further information on how to visualize data in Grafana, see the SDP Grafana for database queries section.

    Accelerate time to value with Telit Cinterion


    Component export - project

    Exporting allows for the quick replication of components. This task explores exporting a project, but the export functionality is available for many different component types.
    1. Open Workbench and connect to the edge node.
    2. Expand the node’s menu. Navigate to Projects, and expand the Projects menu.
    3. Right-click the project name, and select Export.
    4. In the Select Items to Export pop-up window, choose which subcomponents to export by leaving the default green checkmark. Click on the green checkmark to get a red X for any items that should not be included in the export file.
    5. In the case of a project, triggers and their dependencies, such as SQLite tables, devices, and variable groups are among the subcomponents listed.
      Figure 293. Sample list of items and dependencies when exporting a component
      Sample list of items and dependencies when exporting a component
    6. To choose the export location, click the … next to the File field and navigate to the desired location.
    7. Click Export.
    8. When the export is complete, a Successful Export window appears. Click OK to finish.
    An export file (.dwx) is created, which can be imported into other deviceWISE Edge nodes or customized.

    Component import - project

    An exported component file, as described in Component export - project.
    Importing allows for the quick duplication of components. This task explores importing a project, but the import functionality is available for many different component types.
    1. Open Workbench and connect to the edge node.
    2. Expand the node’s menu.
    3. Right-click Projects, and select Import.
    4. Browse to the export file, and select it. Click Select.
    5. View all components included in the export file. Deselect any components that should not be imported by clicking the green checkmark to get a red X.
      Figure 294. Sample list of items and dependencies when importing a component
      Sample list of items and dependencies when importing a component
      Note: The Restore started state checkbox automatically starts any components that were started at the time of export. Deselect this or ensure that the consequences of any started logic are understood.

    6. Click Import to continue.
    7. A warning appears if there are any naming conflicts in the node’s existing configuration that will be overwritten if the import proceeds. Click Yes to continue.
      Figure 295. Sample warning message
      Sample warning message
      Note: In testing, the existing project named Node-Comm was not fully overwritten by the imported project of the same name. Instead, the components within the imported project that did not already exist in Node-Comm were added to the project, and the existing triggers were unaffected.

    The imported project and its dependent components that were selected for import should now be visible.

    Component export – devices

    Exporting allows for the quick replication of components. This task explores exporting devices, but the export functionality is available for many different component types.

    1. Open Workbench and connect to the edge node.
    2. Expand the node’s menu.
    3. Right-click Devices, and select Export All.
    4. In the Select Items to Export pop-up window, choose which subcomponents to export by leaving the default green checkmark. Click on the green checkmark to get a red X for any items that should not be included in the export file.
      Figure 296. Sample list of items and dependencies when exporting a component
      Sample list of items and dependencies when exporting a component
      1. A device’s dependencies are among the subcomponents listed.
    5. To choose the export location, click the […] next to the File field and navigate to the desired location.
    6. Click Export.
    7. When the export is complete, a Successful Export window appears. Click OK to finish.
    An export file (.dwx) is created, which can be imported into other deviceWISE Edge nodes or customized.

    Component import - devices

    There is an exported component file, as described in Component export – devices.
    Importing allows for the quick duplication of components. This task explores importing devices, but the import functionality is available for many different component types.
    1. Open Workbench and connect to the edge node.
    2. Expand the node’s menu.
    3. Right-click Devices, and select Import.
    4. Browse to the export file, and select it. Click Select.
    5. View all components included in the export file. Deselect any components you do not wish to import by clicking the green checkmark to get a red X.
      Figure 297. Sample list of items and dependencies when importing a component
      Sample list of items and dependencies when importing a component
      Note: The Restore started state checkbox automatically starts any components that were started at the time of export. Deselect this or ensure that the consequences of any started logic are understood.

    6. Click Import to continue.
    7. A warning appears if there are any naming conflicts in the node’s existing configuration that will be overwritten if the import proceeds. Click Yes to continue.
      Figure 298. Sample warning message
      Sample warning message
      Note: In testing, the existing variable named Data was not fully overwritten by the imported variable of the same name. Instead, the tags within the data array structure were altered to meet the imported variable’s structure. The values existing in the variables that were in both arrays were unchanged. See the following two images.

      Figure 299. View of variable Data before import
      View of variable Data before import
      Figure 300. View of variable Data after import
      View of variable Data after import
    The imported devices and their dependent components that were selected for import should now be visible.

    Bulk component import with Groups

    An exported component file (.dwx)
    Importing allows for the quick duplication of components. Groups allow edge nodes to be bundled together, and an action executed once is applied to all the Group’s nodes. This task explains how to add components to multiple nodes using Groups.
    1. To create a Group, open Workbench and connect to each edge node.
    2. Click on the Groups tab at the top of Workbench.
    3. Right-click the Groups menu heading, and select New.
    4. Enter the group’s name and click OK.
      Note: Groups are specific to the Workbench instance. Connecting from a different Workbench instance does not show the same Groups.

    5. To add nodes to a Group, click the Nodes tab at the top of Workbench.
    6. Right-click a node, select Add to Group, and then enter the group’s name.
    7. Repeat the previous two steps as needed for additional nodes.
    8. To import the component into the Group, click the Groups tab of the Workbench.
    9. Click the + by the group name to see the list of member nodes.
    10. Right-click the Group name, and select Group Action > Import.
    11. Navigate to the export file in the browse window. Select the file and click Import. The Status of the import on each node is displayed in the Group Import window.
    12. Click Done to close the window.
    1. Click the Nodes tab of the Workbench.
    2. Expand each node’s menu. Navigate to the imported component and confirm that it is present.

    Component scripting

    Generating deviceWISE configurations through scripts can be a great way to decrease development time and increase maintainability. The general approach for developing such scripts is to first export a component of the type to be replicated, then open that file in a text reader to view all the XML elements. Then, a script can be written that follows the same pattern, but with the desired changes.

    For example, creating a Global Variables device with many variables can be time consuming and is prone to error. Alternately, a script that takes a list of variable properties and converts it into a Global Variable device can be scaled to any size, can be revision tracked, and the output can be thoroughly tested. The following example demonstrates such a script.


    Example XML structure of Global Variables Device

    The XML export of a Global Variables Device is structured as follows: 
    <export> 
         <exportcontent> 
              <exportproperty> 
              <exportitem> 
                   <DeviceDefinition> 
                        <Properties> 
                             <Property> 
                             <Property> 
                             … 
                             <Property>
    One of the <Property> elements is named "Variables" and has a unicode representation of the variables as xml. 
    <Variables> 
         <VariableInfo> 
         <VariableInfo> 
         … 
         <VariableInfo>

    Example Python script for global variables device

    The following Python code recreates the global variables device XML from a list of variables. This could be extended to auto-generate many variables, or generate those variables from a more easily maintained configuration file, such as Excel or CSV.

    Figure 301. Python 3.9 script to create a Global Variable Device from a list of variables
    Python 3.9 script to create a Global Variable Device from a list of variables

    HA and DR


    License server configuration

    License file with pooled licenses obtained from Telit Cinterion support—license server host MAC address must be provided for file creation.
    The license server functionality offers simplicity by allowing all license keys and files to be managed on a single node, and the licenses required by each edge node to be pulled from the available pool of licenses. This task describes how to configure the License Server for use by edge nodes.
    1. Open Workbench, and connect to the edge node.
    2. To import the license file, expand the node’s menu and navigate to Administration > Licenses.
    3. Click the Import button.
    4. In the License File Location pop-up window, navigate to the license file. Select it and click Open.
    5. On the License Import pop-up window, click Yes to confirm the license keys.
    6. Confirm that the list of licenses contains the following three entries:
      1. Pooled Device License
      2. Pooled Gateway License
      3. Pooled HTTP Connection License
        Figure 302. Required pooled licenses for use with a license server
        Required pooled licenses for use with a license server
    7. To configure the license server, go to Administration > License Server.
    8. Set the following parameters:
      1. Lease Duration in Seconds – how long licenses pulled by the client nodes are valid for before the client node must reconnect to the server
      2. Renewal Interval in Seconds - how frequently the client nodes reach out to the server to renew their licenses
      3. For information on these two parameters, see Lease Duration and Renewal Interval.
    9. Click Save.
    10. The other parameters on the tab are used to monitor license usage and the status of connected client nodes—at this point, zero licenses should be in use.
    The license server is now ready for client nodes to connect. The total pooled licenses appear in the denominator of the three license Usage parameters on the Administration > License Server tab (for example, Gateway Usage: 0/250).

    Configure the license client settings for the license server node and any other client nodes, per the following task.


    License client configuration and validation

    • Completed license server configuration, as described in License server configuration.
    • Network connection from the client node to the license server node.
    A license client connects to a license server and uses licenses from the available pool. This task describes how to configure the license client settings on an edge node—the first client to be configured should be the license server node itself.
    1. Open Workbench, and connect to the edge node.
    2. Expand the node’s menu, and navigate to Administration > License Client.
    3. Update the following settings:
      • Enabled: True
      • License Manager Address: <IP address or hostname of license server>
      • License Manager Port: default 8443
      • Preallocated Device Count: <integer, 0–250> (or 0–100 depending on license pool size)
      • Preallocated HTTP Count: <integer, 0–250> (or 0–100 depending on license pool size)
      • See Pooled licenses for more information on preallocated counts.
    4. Click Save and then Test to confirm that the license client can connect to the license server and that the licenses can be pulled.
    1. After a successful test, the Next Sync, Expiration, and Last Sync dates and status on the License Client tab should be updated. The Features box contains a list of licensed features based on what licenses the license server has.
      Figure 303. Sample License Client tab after successful connection to the license server
      Sample License Client tab after successful connection to the license server
    2. Returning to the License Server tab of the license server edge node, the number of connected edge nodes (gateways) and the preallocated license count that each has consumed is visible in the Outstanding License box.
      Figure 304. Sample License Server tab after several successful license client connections
      Sample License Server tab after several successful license client connections

    Repeat the license client configuration as needed for additional client nodes.


    Manual backup using Workbench

    Backing up a node is important for Disaster Recovery and can be used to replicate an existing node. Executing a backup from Workbench is an excellent choice when planning some configuration changes to a node to ensure there is no configuration loss during the process. This task describes the steps to perform a single node backup from Workbench.

    1. Open Workbench, and connect to the edge node.
    2. Right-click the node, and select Back Up.
    3. In the Select Items to Back Up window, choose which components to include in the backup by leaving the default green checkmark. Click on the green checkmark to get a red X to exclude an item from the backup.
      1. Click on the [+] next to an item to see subcomponents.
      Figure 305. Sample list of items and dependencies when creating an edge node backup
      Sample list of items and dependencies when creating an edge node backup
    4. Click on the […] button to browse to the backup location and name the file.
    5. Click Back Up on the Select Items to Back Up window to proceed.
    6. A Successful Backup pop-up window appears when the backup is complete. Click OK.
    A deviceWISE backup file (.dwk) is available for use when restoring a node.
    Note: Ensure that vital backups are stored per the application’s required service level.


    Manual restore using Workbench

    deviceWISE backup file (.dwk)
    Restoring a node is useful after a hardware failure or in duplicating an existing node. This task describes the steps to restore a single node from Workbench.
    1. Open Workbench and connect to the edge node.
    2. Right-click the node, and select Restore.
    3. On the Restore File Location window, browse to the backup location, click the backup file, and click Select.
    4. In the Restore window, choose which components to include in the restoration by leaving the default green checkmark. Click on the green checkmark to get a red X to exclude an item from the backup.
      Note: The Restore started state checkbox automatically starts any components that were started at the time of export. Deselect this or ensure that the consequences of any started logic are understood.

    5. On the Node Restore window, click OK to acknowledge that the restoration may overwrite existing components.
    1. Review the node’s components and configuration.
    2. Confirm restored settings are as expected.
    Note: Packages are not included with a backup. Proceed with package installation, if needed.

    Note: If using hardware licenses, these are included in the restoration. Hardware licenses are MAC address-specific, so if the restored machine is different from the backup machine, a Hardware ID Mismatch occurs. In this case, new licenses must be acquired and installed on the machine.


    Manual backup of multiple nodes using Backup Utility

    • A Windows host for the Backup Utility
    • Access to Telit Cinterion’s online IOT Portal
    Backing up a node is important for Disaster Recovery. Executing a backup from the Backup Utility is an excellent choice to periodically capture the current configuration of multiple nodes, such as prior to pushing out a configuration change to the nodes, using a single interface. This task describes the steps to perform a manual backup of multiple nodes from the deviceWISE Backup Configurator GUI.
    1. To download and install the Backup Utility, log in to Telit Cinterion’s online IoT Portal.
    2. On the top menu, click Developer. On the subsequent left menu, click Resources.
    3. Navigate through the series of options as follows: [deviceWISE version] > Telit > Workbench > deviceWISE Backup.
    4. Click the Download icon to the left of the executable file (.exe) name.
    5. Using Windows File Explorer, navigate to the Backup Utility installation executable on the intended host.
    6. Run the executable and install per the defaults.
    7. If prompted, you may need to install a Java Runtime Environment.
    8. To configure the utility, launch the deviceWISE Backup Configurator (GUI) from the desktop icon or from the Start menu.
    9. At the top of the Configuration tab, fill out the settings:
      1. User: <user with access to targeted node>
      2. Password: <password for user above>
      3. Backup Directory: <directory where backup files are to be stored>
      4. Filename Format: <format to append node and date-time information in the backup file name> See Telit Cinterion’s deviceWISE Backup Utility documentation for details.
      5. Backups to Retain: <Number of backups before oldest backups will be erased>
      6. Backup mode: <Export/Zipped/Both Export and Zipped> (choose to backup node configuration, databases, or both)
      7. For important details on these settings, see Backup Configurator Configuration.
    10. Save.
    11. To connect edge nodes, click the Scan button at the bottom of the deviceWISE Backup Configurator window.
    12. In the Node Scanner pop-up, scan the network for nodes:
      1. Provide a subnet and network mask and allow the utility to scan the network for deviceWISE Edge nodes.
      2. Provide a single IP address or hostname.
    13. Click Scan. Identified nodes populate the lower pane of the deviceWISE Backup Configurator. When done, Close the Node Scanner window.
    14. Save.
    15. To execute the remote backup, click the Backup Now button at the bottom of the deviceWISE Backup Configurator window.
    16. You should see backups being generated—the Last Backup date is updating and the Retained count is updating.
    17. Wait several minutes for this to complete.
    1. Confirm that all backups were generated, per the above instructions.
    2. Navigate to the Backup Directory and confirm the backup files.
    Note: No backups are generated for a node that is not accessible. Two common causes are:

    1. No network connection from the Backup Utility host to the edge node.

    2. The User/Password provided in the Configuration tab are not valid on that node.



    Schedule automatic backup of multiple nodes using Backup Utility

    Backup Utility configuration, as described in Manual backup of multiple nodes using Backup Utility.
    Backing up a node is important for Disaster Recovery. Executing an automated, scheduled backup using the Backup Utility is an excellent choice to periodically capture the current configuration of multiple nodes on a regular basis. This task describes the steps to set up automated scheduled backups of multiple nodes using the Backup Daemon component of the Backup Utility and the Windows Task Scheduler.
    Note: For more information, see Telit Cinterion’s deviceWISE Backup Utility documentation.

    1. To set the schedule, open deviceWISE Backup Configurator, and click the Schedule tab.
    2. Enter a Time for the scheduled backup.
    3. Check the boxes in the Day, Week, and Month sections to achieve the desired backup frequency.
    4. Click Save.
    5. To configure the scheduler, open the Windows Task Scheduler on the Backup Utility host.
    6. In the left menu, right-click the Task Scheduler Library heading, and click New Folder.
    7. Enter the folder name and click OK to save.
    8. With the new folder selected in the left menu, click Create Basic Task… in the Actions menu on the right pane.
    9. Enter a task name and description. Click Next.
    10. Select When the computer starts as the timing option. Click Next.
    11. Select Start a program as the task to perform. Click Next.
    12. For the Program/script parameter, click Browse…, navigate to the deviceWISE Backup Utility installation folder, and select the DWBackupDaemon. Click Open.
      The default deviceWISE Backup Utility installation folder is C:\deviceWISE\Backup.
    13. Add arguments as needed. Click Next.
    14. Confirm the settings, and click Finish to save and close the configuration window.
    15. On the main Task Scheduler window, notice that the task has not yet run.
      Figure 306. Sample status of a scheduled task after creation prior to its first execution
      Sample status of a scheduled task after creation prior to its first execution
    16. Optionally, double-click the task to make additional changes as needed:
      1. In the General tab, select the option to Run whether user is logged on or not and set the Configure for drop-down to the appropriate operating system.
      2. Click OK. If prompted, enter the user's password to save the changes.
    17. Restart the machine to confirm that it runs on startup:
      1. Reboot the Windows host machine.
      2. Open Windows Task Scheduler again.
      3. Check the Last Run Result and the Last Run Time.
    Note: If any changes are made to the Backup Configurator after running the daemon, the Backup Daemon must be restarted.

    Figure 307. Sample warning indicating that the Backup Daemon needs to be restarted
    Sample warning indicating that the Backup Daemon needs to be restarted
    After the backup time scheduled in the deviceWISE Backup Configurator has passed, check that the backups were made:
    1. Open the deviceWISE Backup Configurator. The date of the Last Backup is within a few minutes of the time of the scheduled backup.
    2. Navigate to the specified Backup Directory and confirm the backup files are present.
    Note: The machine hosting the Backup Utility and Daemon must be running for the scheduled backups to occur. The task to start the Backup Daemon must have executed successfully. Also, the Backup Utility host must have network connectivity to each targeted node at the time of the scheduled backup.