Configuration (ACS)

ACS Configuration holds the runtime parameters of the Auto Configuration Server (ACS). Examples are multi-tenancy, device authentication, Quality of Experience (QoE) monitoring, event delivery, sessions, STUN/XMPP, and data cleanup. The page groups the parameters by area. The source file is acs_configuration.xml.

Where to find parameter descriptions: the system stores a description for each parameter and shows it on the page. You see the group description under the group title. You see the parameter description under the parameter name. For an on/off parameter, the description is the text next to the switch.

When to use it

Use ACS Configuration when you need to:

  • review the current ACS parameters,

  • change one or more parameter values,

  • export the parameters as an XML backup,

  • import many changes from an XML file with a dry-run preview.

Before you start

  • Check the environment name after you sign in.

  • Confirm your role:

    • VIEWER can view the parameters and use Export XML.

    • EDITOR and ADMIN can also change values and use Import XML.

In read-only mode, the Import XML and Save changes buttons are not available.

Page layout

The toolbar shows the time of the last snapshot update and the user who made it. The toolbar contains Export XML, Import XML, Refresh, and Save changes.

Below the toolbar, each parameter group is a card. A group card shows the group title, the group description, and the number of entries. All groups are collapsed when the page opens. Click a group title to expand or collapse the group.

Parameter card

Each parameter in an expanded group has its own card.

Element Meaning

Name

The parameter name.

Description

The purpose of the parameter. For an on/off parameter, the description is next to the switch.

Key

The parameter key in monospace font, for example qoeTruncateInterval. The XML file uses this key.

Type badge

The value type: String, Boolean, Integer, Enum, URL, or Password.

Required

The parameter must have a value.

Locked

You cannot change this parameter.

Secret

The value is hidden. Click the eye icon to show it.

Value field

The current value. The field type depends on the value type.

Default: <value>

The default value of the parameter.

Allowed: <values>, Range, Regex validation

The rules for a valid value.

Updated <time> by <user>

The time of the last change and the user who made it.

The value field depends on the type:

  • Boolean uses a switch.

  • Enum uses a list. Some options show a code and a label, for example 0 and Disabled.

  • Integer uses a number field. The placeholder shows the allowed range.

  • Password and secret values use a hidden field.

  • A schedule parameter uses a cron field. Click the clock icon to select a preset, for example Daily at 02:00.

  • Other types use a text field.

The Cleanup Exclusion Models parameter uses a table of manufacturers and models. Click Add exclusion to add a manufacturer or a single model. The ACS publishes the list of manufacturers and models. If the ACS has not published the list, the table shows no manufacturers.

Change values

  1. Open ACS Configuration.

  2. Click a group title to expand the group.

  3. Change the value in the parameter card.

  4. Check the area under the field. If the value is not valid, a red message explains the problem.

  5. Repeat for other parameters.

  6. Click Save changes, or press Ctrl+S (Cmd+S on macOS).

Expected results:

  • Each card with an unsaved change shows the Changed badge.

  • The group card and the toolbar show the number of changed entries.

  • After the save, the page reloads the values and the Changed badges disappear.

Changed marks an unsaved edit. It does not compare the value with the default value.

If a value is not valid, Save changes does not save anything. The page shows the alert Some entries need attention and expands the groups with errors. Correct the values and save again.

If you leave the page with unsaved changes, the browser asks you to confirm.

Export a snapshot

  1. Click Export XML.

  2. Save the downloaded file.

The file contains all ACS parameters in XML format.

For details, see Export a Snapshot.

Import with dry-run

Use import to change many parameters at the same time. The dry-run shows the result before you apply the file.

  1. Export a snapshot first. See Export a Snapshot.

  2. Click Import XML.

  3. Drag an .xml file to the dialog, or click Choose file. The file must have the <FTACSConfiguration> root element.

  4. Wait for the dry-run to finish. The dry-run starts automatically.

  5. Review the summary: Created, Updated, Deleted, Warnings, and Errors.

  6. Review the list of changes. Click a change to see its full values.

  7. If the dry-run shows errors, correct the file and select it again. You cannot apply a file with errors.

  8. If the dry-run shows warnings, select Apply despite warnings.

  9. Click Apply import.

Expected results:

  • The dialog shows Import applied.

  • The page reloads the parameters.

Import safety checklist

  1. Check the environment name.

  2. Check the selected client type. It must match the file.

  3. Export a snapshot before you change data.

  4. Run Dry-run and review:

    • the errors: you must fix them,

    • the warnings: you must understand them,

    • the create, update, and delete counts.

  5. If you use REPLACE, review the deletions in the dry-run plan. Continue only if you accept them.

  6. Apply the import.

  7. Refresh the page and open the changed entries to check them.

Use an exported file as the base for an import file.

Refresh the snapshot

Click Refresh to load the latest values from the server. Use it after an import or after changes by other users.

Troubleshooting

I do not see Import XML or Save changes

Your role is VIEWER. Ask an administrator for the EDITOR or ADMIN role.

Save changes is not active

You have no unsaved changes. Change a value first.

The save does not work and the page shows Some entries need attention

Some values are not valid. Open the expanded groups and correct the values with a red message.

The page shows No configuration available

The server has no ACS parameters. Click Refresh. If the page is still empty, click Import file.

The import dialog shows Unsupported file

The file is not an XML file. Select an .xml file.

Apply import is not active

The dry-run found errors, or you did not accept the warnings. Correct the file, or select Apply despite warnings.

The Cleanup Exclusion Models table shows no manufacturers

The ACS has not published its product models. Check the ACS status. If the table shows Failed to load the manufacturer catalogue., click Retry.

Related pages