Managing Deployed Connections (Release 3.3-3.6)

Owned by Nina Cardillo
28-Sept-2023
THE connections WIDGET IS AVAILABLE WITH SMARTSERVER 3.3 AND HIGHER. 

For SmartServer 4.0 and higher, see Managing Deployed Connections.

For SmartServer 3.0-3.2, see Defining Datapoint Connections (Release 3.0-3.2). 

For SmartServer 2.9 or prior, see Defining Datapoint Connections (Release 2.9) 

This section describes how to deploy connections that have been created using the Connections widget, or manually. It also describes the information that appears on the DEPLOYED CONNECTIONS view and describes how to remove deployed connections.

This section consists of the following:

Deploying Connections

To deploy connections, perform the following steps:

  1. Open the Connections widget, CONNECTION TEMPLATES tab (default).



  2. Click the Unlock Operations button ().



    The unlocking feature enables the ability to deploy connections.



  3. Click the Action button () for the connection that you want to deploy and select the Deploy action.


    Deploy an individual connection

    Or, to deploy all connections or selected connections, click the Action button () and select the Deploy All action, or the Deploy Selected action if any connections are selected.


    Deploy all connections


    Deploy selected connections

    The connection(s) is deployed. The Status changes on the CONNECTION TEMPLATES display.



  4. Once you have finished deploying connections and are ready to disable operations, click the Lock Operations button ().



    Doing so disables the ability to deploy connections. 

For more information about the DEPLOYED CONNECTIONS display, go to Viewing Deployed Connections.

Redeploying Connections

To redeploy connections, perform the following steps:

  1. Open the Connections widget, CONNECTION TEMPLATES tab (default).



  2. Click the DEPLOYED CONNECTIONS tab.



  3. Click the Unlock Operations button ().



    The unlocking feature enables the ability to redeploy connections.



  4. Click the Action button () for the connections that you want to redeploy and select the Redeploy action.


    Redeploy an individual connection

    Or, to redeploy all connections or too redeploy selected connections, click the Action button () and select the Redeploy All action, or the Redeploy Selected action if any connections are selected.


    Redeploy all connections


    Redeploy selected connections

    The selected connection(s) is redeployed.



  5. Once you have finished redeploying connections and are ready to disable operations, click the Lock Operations button ().



    Doing so disables the ability to redeploy connections. 

For more information about the DEPLOYED CONNECTIONS display, go to Viewing Deployed Connections.

Removing Deployed Connections

To remove deployed connections, perform the following steps:

  1. Open the Connections widget, CONNECTION TEMPLATES tab (default).



  2. Click the DEPLOYED CONNECTIONS tab.



  3. Click the Unlock Operations button ().



    The unlocking feature enables the ability to remove deployed connections.



  4. Click the Action button () for the deployed connection that you want to remove and select the Remove action.


    Remove an individual deployed connection

    Or, to remove all deployed connections or selected deployed connections, click the Action button () and select the Remove All action, or the Remove Selected action if any deployed connections are selected.


    Remove all deployed connections


    Remove selected deployed connections

    The deployed connection(s) is removed.



  5. Once you have finished removing deployed connections and are ready to disable operations, click the Lock Operations button ().



    Doing so disables the ability to remove deployed connections. 

For more information about the DEPLOYED CONNECTIONS display, go to Viewing Deployed Connections.

Viewing Deployed Connections

To view deployed connections, open the Connections widget. 

You can use the Set Filters button () to refine the list of deployed connections that appear on the view.

The Connections widget opens with the CONNECTION TEMPLATES tab selected by default.

Select the DEPLOYED CONNECTIONS tab. 

The DEPLOYED CONNECTIONS tab appears displaying the following information:

  • Pending Connections – displays a count of the number of connections that have been defined but not yet deployed.  

  • Errors – indicates a count of errors in deploying connections followed by a count of the number of errors in parentheses.

  • Contexts – lists contexts that have been applied to the connection.

  • Connection Template – displays the connection template name.

  • Member Count – shows the number of datapoint members in the connection.

    Note: The Member Count on the DEPLOYED CONNECTIONS tab is different from the Member Count on the CONNECTION TEMPLATES tab. For example, if a connection template is defined in the CONNECTION TEMPLATES tab with a relative source datapoint that will match 1 to 5 datapoint instances per context, and a destination datapoint that will match 1 to 5 datapoint instances per context the Member Count in the CONNECTION TEMPLATES tab will be two — one for the source and one for the destination. If 20 area contexts are subsequently applied to the connection template, each of the resulting 20 connections will have two to ten members, depending on the number of matching devices in each context.  The count per connection will be displayed in the DEPLOYED CONNECTIONS tab.

  • Datapoints – lists the datapoints for the connection. See Expanding / Collapsing the Datapoints View to expand connection templates to show all applied contexts and all datapoint members, or collapse connection templates into a single line each. 

  • Status – shows the connection status for the deployed connection as follows:
    • Pending – indicates that a request to deploy a connection is still in process.
    • Deployed – indicates a Pending connection that has been successfully deployed to all requested targets. 
    • Error(s) – indicates an error count on the connection in parentheses

  • Use Presets – displays a read-only text field with the following valid values:

    • Exclusive – indicates to only forward updates with a preset value from a source to the destinations. 

    • Non-exclusive – indicates to forward all updates from a source, with and without preset values, to the destinations. 

    • No – indicates to ignore preset definitions. 

  • Map – displays a read-only text field reporting the mapping function that specifies a transformation to be applied to all source values prior to sending the value to the destinations.

  • Connection ID – shows the unique identifier that is generated by the CMS for the connection.

  • Actions – provides the ability to redeploy, remove, and export a connections.