Overview

Configuration Overview

Each customer uses the N2FE platform differently. To support this, N2FE allows for the application wide configuration of a number of features. The following configuration files are of relevance when configuring N2FE:

File or Directory Description
/etc/jarvis/n2fe.xml This is the main configuration file for N2FE, and governs how the service will connect to the OC3C/OCNCC database, login security groups, user interface configuration, branding and reCAPTCHA configuration.


This file may be called n2fe-prod.xml or similar if an environment specific N2FE has been installed.

/etc/httpd/conf.d/n2fe.xml This is the main configuration file for Apache in configuring the access for N2FE via Apache. This should be updated to reflect the access rules and restrictions of N2FE within your environment.


This file may be called n2fe-prod.conf or similar if an environment specific N2FE has been installed.


Note that this file should not be removed completely if its configuration is moved to other files (e.g. the ssl.conf file) - N2FE installation updates would recreate this file if it does not exist.

/var/lib/n2fe The base directory for any site specific files required, including branding and internationalisation (language translation) files.


This directory may be called n2fe-prod or similar if an environment specific N2FE has been installed.

/var/lib/n2fe/license.xml The default directory for the N2FE license file. This location may be overridden in the n2fe.xml configuration file.
/var/lib/n2fe/html/branding The directory where all localised branding files are stored. This includes any custom CSS and custom images.
/var/lib/n2fe/html/branding/<brand>/i18n The directory where all translation files for each interface brand are stored.
/usr/share/n2fe The base directory for the N2FE software.


This directory may be called n2fe-prod or similar if an environment specific N2FE has been installed.

/usr/share/n2fe/htdocs/i18n The distribution directory holding all translation files. The files in this directory can be used as the basis for any brand specific translation adjustments required.

n2fe.xml

A core configuration file, n2fe.xml (or the equivalent environment specific version) is responsible for handling most web client interaction for N2FE. It does this via the Jarvis RESTful web services library.

For a full breakdown of the n2fe.xml file, see the Jarvis development and configuration guide. Sections of this file relevant to N2FE are covered in this guide, and are summarized below.

Configuration Sections

Name Description
Application Backend Determines the expected version of NCC to connect to. More Information
Application Logging Control how errors are logged and how errors are sent to the client. More Information
Branding N2FE allows a single N2FE instance to be branded in multiple ways, changing the default N2FE theming depending on how N2FE is accessed. More Information
Display Timezones N2FE allows users to configure what timezone they view and configure data in. The list of selectable timezones can be configured as required. More Information
Flow Renderer N2FE supports two major rendering styles. The style to render flows in is a system-wide configuration option. More Information
Geographic Sources N2FE requires the configuration of which NCC profile tags may be used for the lookup values within caller location node. These must be configured as required. More Information
Inherited Jarvis Security N2FE allows users to configure additional security parameters that protect against a number of cross site scripting attacks. These security features can be configured as required. More Information
Menu Node Suppressed Digits N2FE allows users to configure what exits are available for Menu based nodes. More Information
Presave Backup N2FE supports backing up NCC controls before saving changes. N2FE supports backups via the NCC PI as well as passwordless SSH utilizing the acsDumpControlPlan utility. More Information
Profile Tag Whitelist N2FE supports Flow Nodes that allow the modification of NCC profile tags. The list of selectable profile tags can be configured as required. More Information
Reporting Module N2FE allows for the configuration of a reporting module that will interface with N2FE and NCC reports, giving users a mechanism by which they can generate reports on demand as well as schedule reports for future execution. More Information
Security Groups N2FE allows users to alter the definitions for the application security groups and the SMS templates they map to. More Information
Service Number Options Control which service number profile fields to enable in the N2FE user interface. More Information
SMF User Password Reset Allows SMF Users to change their password through the N2FE interface. More Information
Suppressed Nodes Allows for the additional disabling of node types application wide regardless of NCC/OC3C feature node set assignment. More Information
Table Lookup Profile Blocks The table lookup node may use any of the OCNCC profile blocks, however in most cases only a small subset of these is relevant for this node. The blocks users may access are configured in N2FE. More Information
Translations Allows for customers to override the textual defaults within N2FE, independently for each configured host branding. This will allow customers to attribute their own meanings for text within N2FE such as Control Plan vs. Call Plan. More Information
User Login Restriction Allows for customers to restrict user logins for all user types to specific network interfaces. More Information
Zoom Level Performance Allows for customers to alter the trigger point at which the flow editor defaults to the performant zoomed out view. More Information