Configure to allow Sox tunneling

NoteStarting in Sedona TXS-1.2, the importance of Sox tunneling has diminished in favor of the Sox Gateway and Sedona Tools available under each networked Sedona device. However, in some cases Sox tunneling may still be a desired method to open a networked device. For details related to the Sedona Gateway, see Sox Gateway. For details related to Sedona Tools, see Sedona environment management, with related procedures in JACE workflow and Installing Sedona environment files in a JACE in the Sedona Framework Network Driver Installation section.

You can configure a station with any Sedona Framework network to support “Sox tunneling”. This allows (full) Workbench users to open Sox connections to networked Sedona Framework devices, by “tunneling” through the station. However, if the station host is not licensed for Sox tunneling, you can skip this section. See Workbench and Sedona file requirements for related details.

NoteComplete Sox tunneling details are in the Sedona Framework Sox Tunneling - Engineering Notes document. This procedure provides only a few simple steps to get started, and one connection method.

Add the SoxTunnel service

With the station open in Workbench:

  1. In the Nav tree, expand the station’s Config node to reveal the Services container.

    If a SoxTunnel is already there, skip ahead to Step 4.

  2. Open the nsedona palette in your Workbench palette side bar.

  3. From the nsedona palette, drag (or copy and paste) a SoxTunnel into the station’s Services container. In the popup Name dialog, you can rename the service—or, simply use the default name.

    The service named “SoxTunnel” (or whatever else), is under your Services container, as shown below.



  4. Providing the host is properly licensed for Sox tunneling, the service’s status should be “ok”.

    Typically, only one property may require adjustment: Authenticate with User Service. The default is true.



    Set this to false if the password for the Sedona admin user in devices is “blank”, or if a non-admin user has different credentials for station login.

    Usually this is the only change required, unless networked Sedona Framework devices are not using the default Sox port of 1876. In that case only, set the Port property of the SoxTunnel to match, and Save.

  5. To test the SoxTunnel service, in Workbench:

    1. Expand the SedonaNetwork or SedonaJen6lpNetwork to reveal child Sedona devices.

      NoteIf selecting a “hibernating” type device, you must first issue a “maintenance mode request” (action) on its SedonaJen6lpDevice, and wait for the popup dialog in Workbench before continuing. However, note that currently Sedona Framework support for hibernating devices is not widely available. For related details see About maintenance mode.

    2. Right-click a Sedona device, and select Open Sox - Tunnel Session. An Authentication dialog appears, as shown below.



  6. Enter the Username and password of a User in the Sedona Framework app’s UserService (for example: the frozen admin user), and click OK. A Sox connection is made tunneling through the running station.

    The view space shows the Sedona device’s Nav Container View, with Tools and App nodes, as shown below.



    NoteIf the connection fails, it is likely because your Workbench host does not have the necessary manifest files for all the kits installed in the Sedona Framework device. In the error, examine any “Details” link to see if missing manifests are named. For related details, refer to Sedona Manifest Manager - Engineering Notes. Another possible issue might be a user mismatch between the app's User service and your station login. As shown previously in Step 4, in the JACE station's SoxTunnel service (Config > Services > SoxTunnel), set the “Authenticate with User Service” property to false and Save.

    As shown above, the tunneled Sox connection also appears in the Nav tree root of that host (on parity with the station). You can also work from the Nav tree, expanding and right-clicking, etc. as needed.



    The figure above shows the service folder expanded, with the Sedona Property Sheet of the “plat” component opened in the Workbench view. Click on folders in the App for wire sheet views.

    NoteThe App icon changes to add a star whenever you have unsaved changes—meaning they have not been saved to the device’s non-volatile Flash memory. Right-click the App and select Actions->Save. Otherwise, changes will remain in device RAM only, and be lost upon a reboot or power event.

    You can also use the Sedona Tools when Sox tunnel connected to the device. For related details, see the document Sedona Framework Sedona Tools Guide.