Administration Screens Configuration

Overview

The N2ACD Administration screens are configured in part through the administration GUI’s Jarvis configuration file:

n2acd-admin.xml

A core configuration file, n2acd-admin.xml (or the equivalent environment specific version) is responsible for handling the web client interaction for N2ACD’s administration frontend. It does this via the Jarvis RESTful web services library.

For a general breakdown of the n2acd-admin.xml file, see the Jarvis development and configuration guide. For configuration details shared with the flow editor, including application security configuration, see general configuration.

The following sections are specific configuration for the N2ACD administration screens.

Permission Model

The N2ACD administration GUI requires the permission model to be defined in the Jarvis configuration file.

In this file the section:

<config>
    <login>
        <permission_model>internal</permission_model>
    </login>
</config>

is preconfigured in the default deployment. The permission_model must be set to internal. At this stage no other option is supported.

Reports

N2ACD supports scheduled execution of reports loaded into the system using the report management script. To deliver scheduled reports, the N2ACD administration GUI needs to be configured with the correct directory where report scripts will be installed.

In the administration Jarvis configuartion file, locate the dataset_dir with the prefix="reports." configuration:

        <dataset_dir prefix="reports.">/var/lib/n2acd-fe/reports</dataset_dir>

Update the directory configured to be the correct location for reports in the environment being deployed. Note that this configuration change must be done on each N2ACD administration node where the XML configuration is served from.

This configuration must be similarly configured in the flow editor gui to support the direct execution of reports.

ACD Email Configuration

For the delivery of scheduled reports the ACD email configuration must be correctly set up for the deployed environment. In the Jarvis configuration file the default configuration section for report email is declared:

<email>
    <parameter name="really_send_emails" value="0"/>
    <parameter name="smtp_server" value="REPLACE_WITH_SMTP_SERVER_HOST"/>
    <parameter name="smtp_port" value="25"/>
    <parameter name="from_address" value="REPLACE_WITH_FROM_ADDRESS"/>
    <email_template subject = "N2ACD Automated Report: [% report_name %]">
Automated report [% report_name %] generated at [% this_run_datetime %].
[% report_description %]

This report was generated with the following parameters:
[% FOREACH key IN report_parameters.keys %]
[% key %]: [% report_parameters.$key %]
[% END %]

[% IF has_next_run_datetime %]
Next run is scheduled for [% next_run_datetime %].
[% END %]
    </email_template>
</email>

This section of configuration is in the <config> section of the Jarvis configuration file. The following configuration options require setup:

For the email template body and email template subject the following variables will be replaced in either template. Note that the email subject cannot have newlines in the text.

Bulk Imports

This section is in the <config> section of the Jarvis configuration file. All configuration options are optional.

This section of the configuration allows configuration of the behavior of the bulk import functionality for Prefix Mapping sets.

<!--
    Optional configuration for bulk import functions. This is optional if not specified then no limits will be applied.
-->
<bulk_imports>
    <!-- Prefix mapping set entries. -->
    <prefix_mapping>
        <!--
            Configure a requirement that prefix mappings must contain a minimum length. Falling outside this range will fail validation.
        -->
        <min_prefix_mapping_len>4</min_prefix_mapping_len>
        <!--
            Configure a requirement that prefix mappings cannot exceed a max length. Falling outside this range will fail validation.
        -->
        <max_prefix_mapping_len>11</max_prefix_mapping_len>
        <!--
            Configure a requirement that prefix mappings must start with a specific list of prefixes.
            Any prefix mappings that do not start with one of the leading prefixes will fail validation.
        -->
        <supported_leading_prefixes>01,02,03,04</supported_leading_prefixes>
    </prefix_mapping>
</bulk_imports>