☰
Navigation :

FoxApp

FOX Application Configuration

The N2SVCD FOX Application is a protocol gateway application which can perform client requests using the FOX protocol. The FOX protocol is the proprietary protocol used for real-time communication by the Oracle NCC VWS nodes.

The following configuration is used to create a FOX Application instance to act as a protocol gateway to all VWS nodes in an NCC installation.

If you need to connect to more than one NCC installation (e.g. if your site has separate Production and Model SMS nodes), then you must configure multiple FOX Application instances (one for each NCC SMS node).

<?xml version="1.0" encoding="utf-8"?>
<n2svcd>
  ...
  <applications>
    ...
    <application name="FOX" module="FoxApp">
      <include><lib>../apps/fox/lib</lib></include>
      <parameters>
        <!-- The db_app_name_smf parameter is NOT USED because client_connections takes priority. -->
        <parameter name="db_app_name_smf" value="DB-PROD-SMF"/>
      </parameters>
      <config>
        <client_connections>
          <client_connection domain_id="1" local_port="4000" remote_port="1500" remote_host="10.42.2.156"/>
          <client_connection domain_id="1" local_port="4001" remote_port="1501" remote_host="10.42.2.156"/>
        </client_connections>
      </config>      
    </application>
    ...
  </application>
  ...
</n2svcd>

Configuration Details

The application element attributes for a FOX Application instance may include the below.

For details of the various parameter types used, refer to Common Configuration.

Parameter Name Type XML Type Description
See: Common Application configuration
See: TCP Application configuration
module String Attribute [Required] FoxApp
include.lib String Element [Required] ../apps/fox/lib
parameters Array Element [Required] As per Common Configuration Application parameters.
"edr_enabled" - - This value is ignored; the FOX Application does not support writing EDRs.
"socket_mode" - - The FOX Application supports only connect (TCP Client).
(Default = connect)
"remote_host" - - This parameter is ignored in the case when the FOX Application reads configuration from a database.
Refer to Connection to VWS Nodes.
"remote_port" - - This parameter is ignored in the case when the FOX Application reads configuration from a database.
Refer to Connection to VWS Nodes.
"db_app_name_smf" String Attribute Name for DBApp instance to query for the VWS (BE) Domain Node configuration.
This DBApp instance must be connected to a database containing the standard NCC domain node definition tables: ccs_domain_nodes, ccs_domain, ccs_domain_type.
Refer to Connection to VWS Nodes.
"client_name" String Attribute The name by which the FOX Client will identify itself when connecting to NCC.
Each client connecting to the NCC BE must use a unique string for this purpose.
(Default = N2FOX-<short-hostname>)
config Object Element Container for extended configuration for this Application instance.
.client_connections Array Element Array of client_connection elements rules for static configurtion of the outbound TCP client connection parameters.

FOX Client Connections

Client connection rules define the parameters of the outbound TCP connections individually.

This mechanism must be used if you wish to statically configure more than one outbound connection.

Each client_connection Object in the config.client_connections Array is configured as follows.

Parameter Name Type XML Type Description
local_host String Attribute As per the parameter of the same name in Common TCP Configuration.
local_port Integer Attribute As per the parameter of the same name in Common TCP Configuration.
remote_host String Attribute As per the parameter of the same name in Common TCP Configuration.
remote_port Integer Attribute As per the parameter of the same name in Common TCP Configuration.
remote_host String Attribute [Required] As per the parameter of the same name in Common TCP Configuration.
remote_port Integer Attribute [Required] As per the parameter of the same name in Common TCP Configuration.
ssl 0 / 1 Attribute As per the parameter of the same name in Common TCP Configuration.
ssl.* String Attribute As per the parameters in Common TCP Configuration.
domain_id Integer Attribute [Required] The numeric domain ID of the VWS to which this connection is made.

Connection to VWS Nodes

At startup, the FoxApp Application will take its connection configuration from one of the following sources:

OPTION 1: If the config.client_connections block is present (even if empty), then this will be used and other configuration sources are ignored.

In this case, the FoxApp will automatically consider the first client_connection entry to be the primary (with priority = 1), the next connection to be the secondary, and so on.

If the client connections are configured with explicit priority, then all must have a priority defined and all priorities must be unique.

OPTION 2: If the db_app_name_smf parameter is present, then the application will fetch configuration by sending a DB-REQUEST message to the indicated database application, and other configuration sources are ignored.

OPTION 3: If the config.client_connections element and the db_app_name_smf parameter are both absent, then the remote_host and remote_port parameters must be present, and a single FOX connection will be used.

In that final case, the num_client_connections must be the default value of 1.

Message Handling

In addition to the common Application management messages, the FoxApp uses the following messages: