System parameters
System parameters are the environment-wide settings of the switch: when the database is backed up, how long CDRs are kept, how the panel looks and logs users in, how calls are rounded, which mail server sends invoices, and how the SIP stack behaves. Each environment has its own set; changes in one never touch another.
Where to find it
Section titled “Where to find it”Open System Management → System Parameters in the left sidebar. The URL is /system_parameters.php. The hub page is available to the root customer; the individual pages require system management rights. The SIP-related pages are reached from System Management → SIP Features.
| Page | What it holds |
|---|---|
| Backup, Data Retention | Backup schedule, how long CDRs, rates, routes and invoices are kept |
| Web Interface, Security | Branding, web address and certificate, MFA, maintenance mode, session timeout, display precision |
| Billing, SMTP Server | Rounding and precision defaults, low-balance retries, the mail server |
| IP Firewall, Network Services | Links to the firewall and listener screens |
| CDRs Options | What is written into account CDRs |
| SIP Features → SIP | SIP, SIP TCP, SIP TLS, media, LRN and HEP tabs |
| SIP Features → STIR/SHAKEN | Attestation and verification connectors, when the module is installed |
Every page has Discard and Save. Changes are written to the database on Save; a failed save shows Cannot update System Parameters. with the reason.
Backup and data retention
Section titled “Backup and data retention”| Field | Meaning |
|---|---|
| Schedule | Never, Daily, Weekly or Monthly database backup |
| Start Time | Time of day for the backup, in the server’s time zone, in half-hour steps |
| Dump Format | SQL Dump (Text), SQL Dump (Binary), SQL Dump (TAR); DB Snapshot in the root environment |
| Generations | How many backup copies are kept, 1 to 15 |
| Compression | gzip, bzip2 or no compression |
| Notify on Success | E-mail after a successful backup. Root environment only |
| Archive All CDRs in, Purge All CDRs in | When CDRs move to the archive and when they are deleted, from 1 day to 5 years |
| Archive Zero CDRs in, Purge Zero CDRs in | The same for zero-duration CDRs, which are usually kept for less time |
| Purge Old Rates in, Purge Old Routes in | When discontinued rates and routes are deleted |
| Purge Old Invoices in | When old invoices are deleted, 1 month to 5 years |
The purge periods must not be shorter than the matching archive periods, and all CDRs must not be purged before zero CDRs are. See Automatic database backup and Archive CDRs.
Web interface and security
Section titled “Web interface and security”Branding sets the Login Text shown on the login page (up to 256 characters), the Title Text of the browser tab, a Login Image (JPG, GIF or PNG, up to 500 KB) and a Favicon (ICO, PNG, SVG or GIF, up to 200 KB). See Branding.
| Field | Meaning |
|---|---|
| Web Address | Hostname of the panel and the API. Changing it reconfigures the environment’s web server |
| SSL Certificate | Certificate from SSL Management used by the panel. Takes up to 5 minutes to apply. See TLS certificates |
| MFA | Disabled, E-Mail Token or Google Authenticator for every web user of the environment. Saving logs you out to verify the new method; existing tokens are invalidated |
| Maintenance Mode, Maintenance Message | Off (Normal); CDRs Update blocks reports for everyone but the root and support users; System Update blocks the whole panel for everyone but the root user and shows the message |
| Total Servers Limit | Web server processes shared by all environments, Auto or 20 to 500. Root environment only |
| Session Timeout | Idle time after which a web user is logged out, Unlimited to 2 hours |
| Default Start Date | Default start of the period in report filters, 1 hour ago to 1 month ago |
| Display Precision | Decimals shown for money in the panel, 0 to 10. Prices are stored with full precision; this only changes the display |
| Default Login Page | All shows the account type selector; Account, Customer or Vendor hides it and makes that portal the default |
| Remote Assistance → Enabled | Lets FlySIP support log in with a pre-shared key for troubleshooting |
Billing and SMTP server
Section titled “Billing and SMTP server”| Field | Meaning |
|---|---|
| On-Net Calls Duration | Round or Round-Up of the billed seconds of calls between your own accounts |
| Balance Allocation Alg. | Incremental or ACD: how much balance is reserved for the next segment of a running call |
| Media Timeout Corr., sec | Seconds subtracted from the duration when a call ends by media timeout |
| Tariffs Cost Precision, Vendors Cost Precision | Default Cost Decimal Precision for new tariffs and vendors, 0 to 20 |
| Default Retry Count, Max Retry Count, Retry Interval (hours) | How often auto-recharge and low-balance notifications are retried. See Low balance notifications |
| Server Address, Server Port | The SMTP server used for invoices, notifications and password recovery. localhost uses the built-in mail agent |
| Connection Mode | Unsecure, TLS or SSL |
| Username, Password | SMTP credentials, if the server needs them |
Test next to the server address sends a test e-mail: enter Send To, Subject and Message and click Send. Unsaved SMTP changes are saved first after a confirmation. The message is queued for the mailer and should arrive within five minutes.
CDR options
Section titled “CDR options”Write Auth Info stores the extended authentication details of each call in the account CDRs: which rule or credentials matched. Enable it when you debug authentication; it increases the size of the CDR table.
SIP, media, LRN and HEP
Section titled “SIP, media, LRN and HEP”Reached from SIP Features → SIP.
| Field | Meaning |
|---|---|
| Realm | Realm sent in digest challenges. Locked once the first account exists, because devices store it |
| User Agent | Value of the User-Agent header in outgoing requests; ${SS_VER} inserts the switch version |
| Pass-Through Headers | Comma-separated SIP headers copied unchanged from the caller’s leg to the vendor’s |
| 2xx Timeout Starts | When Vendor is Tried counts the route’s 2xx timeout from the INVITE; When Vendor Sends 1xx from the first provisional response. See Call timeouts |
| Anonymous in Contact | Send Anonymous as the display name of the Contact header on the outgoing leg |
| On-Net Trusted Domain | Treat on-net calls as coming from a trusted domain for privacy headers |
| Identity Auth Mode | Strict, Relaxed or Mandatory use of asserted identity during authentication |
| Follow Me Mode, Follow Me Timeout | Defaults applied when a user enables Follow Me with a service code: Always, On Unavailable, On Busy, On No Answer or On Unregistered, and 5 to 60 seconds |
SIP TCP and SIP TLS
Section titled “SIP TCP and SIP TLS”Connection Timeout (0.05 to 1 s), Connection Lifetime (0 to 3600 s) and Max Message Time (1 to 10 s) tune TCP transport; Handshake Timeout and Send Timeout (0.05 to 1 s each) tune TLS. Leave the defaults unless a vendor’s TCP or TLS trunk misbehaves.
Media and LRN
Section titled “Media and LRN”Default Media Relay is the relay preselected on new connections and new routing groups. See Media relay.
LRN Server Addresses is an ordered list of number-portability servers. LRN Server Timeout (1 to 32 s) is the wait before the next server is tried, LRN Total Timeout caps the whole lookup, after which the call is routed by the dialled number. Add LRN to RURI puts the routing number into the request URI sent to the vendor. Enabled LRN Cache with LRN Cache Expires in keeps answers from 1 hour to 3 months so that repeated numbers do not cost a query. See LRN dipping and number portability.
Enable sends a copy of all SIP signalling to a capture server such as Homer: Collector as host:port, Local (Source) Port, Transport UDP or TCP, and HEP Version 2 or 3. Version 3 is required for TCP; the panel warns that TCP has known issues on the OpenSIPS front end.
STIR/SHAKEN
Section titled “STIR/SHAKEN”Reached from SIP Features → STIR/SHAKEN when the module is installed. Authentication signs outgoing calls through a Connector: 1CallConnect (with SIP Host and UUID), SIP Redirect (with Host) or Local DB (with the signing Certificate, its public X5U Url, Origid and the Attestation level Full (A), Partial (B) or Gateway (C)). Verification checks incoming calls through SIP Redirect or Local DB with a CA List, in Relaxed or Strict Mode. STIR/SHAKEN counts as enabled for routing groups once the authentication connector is not Off.