DATA DICTIONARY GATEWAY DATABASE DATA DICTIONARY GATEWAY DATABASE COPYRIGHT NOTICE © DIGITALK Limited 2011 All rights reserved. This Documentation contains proprietary information, which is the property of DIGITALK Limited and is protected by copyright law and international treaties. The information and intellectual property contained herein is confidential between DIGITALK Limited and the customer, and remains the exclusive property of DIGITALK Limited. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form without the prior written consent of DIGITALK Limited. Due to our policy of continued product development, the information contained in this document is subject to change without notice and does not represent a commitment on the part of DIGITALK Limited. Every effort is made to ensure the accuracy of this information. However, DIGITALK Limited cannot warrant that the documentation is error-free, nor can it accept responsibility for errors and omissions. All names, products and services mentioned in this documentation are the trademarks of their respective organizations and are the sole property of their respective owners. If you have any feedback or comments, please report them to us in writing at the following address: DIGITALK Limited Radian Court Davy Avenue Milton Keynes MK5 8PJ U.K. Tel: +44 1908 425000 Fax: +44 1908 425001 E-mail: [email protected] Internet: www.digitalk.com DATA DICTIONARY GATEWAY DATABASE TABLE OF CONTENTS 1 ALARM_LOG......................................................................................................................................................................................1 2 ALEG.................................................................................................................................................................................................1 3 ALEG_LK............................................................................................................................................................................................2 4 AUDIT ................................................................................................................................................................................................2 5 BLEG..................................................................................................................................................................................................3 6 BLEG_LK ............................................................................................................................................................................................4 7 BULK_DATA_TASKS ...........................................................................................................................................................................4 8 CARD.................................................................................................................................................................................................5 9 CARRIER_CLI_MATCHING..................................................................................................................................................................5 10 CARRIER_CLI_RANGES .......................................................................................................................................................................5 11 CARRIER_GROUPS..............................................................................................................................................................................6 12 CCA_ACTIVATE_CHANGES................................................................................................................................................................7 13 CCA_CDR_PEER_FILES........................................................................................................................................................................7 14 CCA_CDR_PEERS ...............................................................................................................................................................................7 15 CCA_DIAMETER_APPLICATIONS.........................................................................................................................................................7 16 CCA_DIAMETER_INTERFACES............................................................................................................................................................8 17 CCA_DIAMETER_PEER_APPLICATIONS................................................................................................................................................8 18 CCA_DIAMETER_PEERS ......................................................................................................................................................................8 19 CCA_ENABLED_PEERS........................................................................................................................................................................9 20 CCA_NODE_LOGGING.......................................................................................................................................................................9 21 CCA_NODES......................................................................................................................................................................................9 22 CCA_OPTS.........................................................................................................................................................................................9 23 CCA_PEER_HOME_NETWORK_RANGES ...........................................................................................................................................10 24 CCA_PEERS......................................................................................................................................................................................10 25 CLOCKING.......................................................................................................................................................................................10 26 CODE_IMPORT_ITEMS......................................................................................................................................................................11 27 CODES.............................................................................................................................................................................................11 28 CONNECT_LOG................................................................................................................................................................................11 29 CURRENT_ALARM_LOG...................................................................................................................................................................11 30 CURRENT_TRAFFIC_LOG..................................................................................................................................................................12 31 DTCDRTOOL_STREAMS....................................................................................................................................................................13 32 EGRESS_RATE_IMPORT_ITEMS.........................................................................................................................................................13 DATA DICTIONARY GATEWAY DATABASE 33 EGRESS_RATE_IMPORT_TEMPLATE...................................................................................................................................................14 34 EGRESS_RATE_IMPORTS...................................................................................................................................................................14 35 EGRESS_RATING_PLAN_ITEMS.........................................................................................................................................................15 36 EGRESS_RATING_PLANS...................................................................................................................................................................15 37 FAILED_LCR_CALL_ATTEMPTS..........................................................................................................................................................16 38 FAULT_LOG.....................................................................................................................................................................................16 39 GPRS_RATE_SHEET_ITEMS................................................................................................................................................................17 40 GPRS_RATE_SHEETS.........................................................................................................................................................................17 41 GPRS_ROAMING_IP_RANGES...........................................................................................................................................................18 42 GPRS_ROAMING_ZONES..................................................................................................................................................................18 43 H323_GATEKEEPER_ALIAS...............................................................................................................................................................18 44 H323_GATEKEEPER_PREFIX..............................................................................................................................................................18 45 H323_TRANSLATION........................................................................................................................................................................18 46 IMPORTED_CODES...........................................................................................................................................................................19 47 INACTIVE_NODE_LOG......................................................................................................................................................................20 48 IP_CARRIER......................................................................................................................................................................................20 49 IP_CARRIER_CODEC.........................................................................................................................................................................22 50 IP_CARRIER_FROM_ADDRESS...........................................................................................................................................................22 51 IP_CARRIER_H323............................................................................................................................................................................23 52 IP_CARRIER_NODE ...........................................................................................................................................................................24 53 IP_CARRIER_SIP................................................................................................................................................................................24 54 IP_CARRIER_STATUS ........................................................................................................................................................................27 55 IP_CARRIER_TO_ADDRESS................................................................................................................................................................28 56 IP_INTERFACE_CARD........................................................................................................................................................................29 57 IP_CARRIER_EMERGENCY_TRANSLATIONS.......................................................................................................................................29 58 ISUP_TRANSLATION.........................................................................................................................................................................29 59 JOB_DEF_ALERT_FILTER....................................................................................................................................................................30 60 JOB_DEF_ALERT_NOTIFIER................................................................................................................................................................31 61 JOB_DEF_ALERT_THRESHOLDS.........................................................................................................................................................31 62 JOB_DEF_ASR_NOTIFIER...................................................................................................................................................................31 63 JOB_GATEWAY_ZONE_LIS T..............................................................................................................................................................32 64 JOB_OPERATOR_GROUP_LK.............................................................................................................................................................32 65 JOB_OPERATOR_GROUPS.................................................................................................................................................................32 DATA DICTIONARY GATEWAY DATABASE 66 JOB_OPERATORS..............................................................................................................................................................................32 67 JOB_ZONE_GROUP...........................................................................................................................................................................33 68 JOB_ZONE_LIST................................................................................................................................................................................33 69 LCR..................................................................................................................................................................................................33 70 LCR_CHOICES..................................................................................................................................................................................36 71 LCR_CODE_CARRIER_STATUS ..........................................................................................................................................................37 72 LCR_CODE_CHANGES.....................................................................................................................................................................37 73 LCR_CODES.....................................................................................................................................................................................37 74 LCR_LK ............................................................................................................................................................................................38 75 LCR_QOS_CATEGORY......................................................................................................................................................................39 76 LCR_QOS_CATEGORY_ZONE ...........................................................................................................................................................39 77 LCR_QOS_PLAN...............................................................................................................................................................................40 78 LCR_IMPORT_TEMPLATES ................................................................................................................................................................40 79 LOCALISATION_CULTURES...............................................................................................................................................................40 80 LOCALISATION_RESOURCES.............................................................................................................................................................40 81 LOG_SETTINGS.................................................................................................................................................................................41 82 MACH_OPTS....................................................................................................................................................................................41 83 MACHINES.......................................................................................................................................................................................42 84 MEMBERSHIP_GROUP_MEMBERS.....................................................................................................................................................44 85 MEMBERSHIP_GROUPS ....................................................................................................................................................................44 86 MEMBERSHIP_PROFILE .....................................................................................................................................................................44 87 MEMBERSHIPS .................................................................................................................................................................................45 88 NETGROUP_AUDIT...........................................................................................................................................................................45 89 NETGROUPS.....................................................................................................................................................................................46 90 NETGROUPS_LK...............................................................................................................................................................................46 91 NETPORTS........................................................................................................................................................................................47 92 NETROUTES.....................................................................................................................................................................................48 93 NICMGR_ADDRESS_MAPPINGS........................................................................................................................................................50 94 NICMGR_ADDRESSES.......................................................................................................................................................................50 95 NICMGR_DISCOVERED_INTERFACES ................................................................................................................................................51 96 NICMGR_INTERFACES......................................................................................................................................................................51 97 NICMGR_MACHINES........................................................................................................................................................................52 98 NICMGR_NETWORK_INTERFACES ....................................................................................................................................................52 DATA DICTIONARY GATEWAY DATABASE 99 NICMGR_NETWORKS.......................................................................................................................................................................53 100 NP_OP_CODES.................................................................................................................................................................................53 101 NP_QUERY_METHODS .....................................................................................................................................................................54 102 PAYPHONE ......................................................................................................................................................................................54 103 PROXY_BILLING_SESSIONS...............................................................................................................................................................54 104 PROXY_BLOCK_OUTPUTS ................................................................................................................................................................55 105 PROXY_BLOCKS...............................................................................................................................................................................55 106 PROXY_CLUSTERS............................................................................................................................................................................55 107 PROXY_DNS_CONFIG.......................................................................................................................................................................56 108 PROXY_FAILED_CDRS ......................................................................................................................................................................56 109 PROXY_FORK_CONDITIONS .............................................................................................................................................................56 110 PROXY_GRAPH_REVISIONS ..............................................................................................................................................................57 111 PROXY_H323_GATEKEEPER_ALIAS...................................................................................................................................................58 112 PROXY_H323_GATEKEEPER_SETTINGS.............................................................................................................................................58 113 PROXY_IP_CARRIER_STATUS ............................................................................................................................................................58 114 PROXY_LOG_LEVELS........................................................................................................................................................................59 115 PROXY_NODES ................................................................................................................................................................................59 116 PROXY_NP_CHOICES .......................................................................................................................................................................60 117 PROXY_NP_CODES..........................................................................................................................................................................60 118 PROXY_NP_NUMBERS ......................................................................................................................................................................61 119 PROXY_NP_PLANS ...........................................................................................................................................................................61 120 PROXY_NP_PREFIXES........................................................................................................................................................................61 121 PROXY_NP_RATING.........................................................................................................................................................................62 122 PROXY_SSL_CERTS...........................................................................................................................................................................62 123 PROXY_TRANSPORT_SSL_CERTS......................................................................................................................................................63 124 PROXY_TRANSPORTS.......................................................................................................................................................................63 125 Q931_TRANSLATION........................................................................................................................................................................63 126 QUEUED_ALERTS .............................................................................................................................................................................64 127 RATE_IMPORT_ITEMS.......................................................................................................................................................................65 128 RATING_CODES...............................................................................................................................................................................66 129 RATING_ZONES................................................................................................................................................................................66 130 REGISTRAR_SERVICE ........................................................................................................................................................................66 131 REGISTRAR_SERVICE_PROPERTIES....................................................................................................................................................68 DATA DICTIONARY GATEWAY DATABASE 132 ROAMING_RATE_SHEET_ITEMS........................................................................................................................................................69 133 ROAMING_RATE_SHEETS.................................................................................................................................................................69 134 ROAMING_ZONE_CODES.................................................................................................................................................................70 135 ROAMING_ZONES............................................................................................................................................................................70 136 ROUTESET........................................................................................................................................................................................70 137 ROUTESET_SSP.................................................................................................................................................................................71 138 ROUTING_SERVERS ..........................................................................................................................................................................71 139 RPT_CONTROL_TYPES......................................................................................................................................................................71 140 RPT_DYNAMIC_PARAMETERS ..........................................................................................................................................................71 141 RPT_FIXED_PARAMETERS.................................................................................................................................................................72 142 RPT_GROUP_REPORTS......................................................................................................................................................................72 143 RPT_GROUPS ...................................................................................................................................................................................72 144 RPT_PARAMETERS............................................................................................................................................................................72 145 RPT_REPORT_PARAMETERS..............................................................................................................................................................72 146 RPT_REPORTS...................................................................................................................................................................................73 147 RPT_STYLE_ITEM_VALUE S................................................................................................................................................................73 148 RPT_STYLE_ITEMS ............................................................................................................................................................................73 149 RPT_STYLES.....................................................................................................................................................................................73 150 RTPPROXY_ADDRESSES....................................................................................................................................................................74 151 RTPPROXY_CLUSTERS ......................................................................................................................................................................74 152 RTPPROXY_NODES...........................................................................................................................................................................74 153 SBC_CLUSTER_NODE_BACKUPS.......................................................................................................................................................75 154 SBC_CLUSTER_NODES.....................................................................................................................................................................75 155 SBC_CLUSTERS ................................................................................................................................................................................75 156 SBC_OPTS........................................................................................................................................................................................75 157 SECURITY_ROLE_PROFILES ...............................................................................................................................................................76 158 SECURITY_ROLES .............................................................................................................................................................................76 159 SIP_PROXY_SERVERS ........................................................................................................................................................................76 160 SIP_TRANSLATION............................................................................................................................................................................77 161 SNMP_MANAGER_EXCLUDED_OIDS ................................................................................................................................................77 162 SNMP_MANAGERS ..........................................................................................................................................................................78 163 SNMP_TRAP_LOG............................................................................................................................................................................78 164 SS7_CARD.......................................................................................................................................................................................79 DATA DICTIONARY GATEWAY DATABASE 165 SS7_CONFIG_ITEMS.........................................................................................................................................................................79 166 SS7_ CONFIGURATION_PACK ...........................................................................................................................................................80 167 SS7_LINK .........................................................................................................................................................................................80 168 SS7_LINKSET....................................................................................................................................................................................80 169 SS7_LINKSET_ASSIGNMENTS............................................................................................................................................................81 170 SS7_MTP_SETTINGS .........................................................................................................................................................................81 171 SS7_NODE .......................................................................................................................................................................................81 172 SS7_PORT ........................................................................................................................................................................................81 173 SS7_ROUTESET.................................................................................................................................................................................82 174 SS7_SOFTWARE...............................................................................................................................................................................82 175 SS7_SSP...........................................................................................................................................................................................82 176 SUPERVISOR_ALERT_GROUPS...........................................................................................................................................................82 177 SUPERVISOR_USER_ALERT_HISTORY.................................................................................................................................................83 178 SYS_CONFIG....................................................................................................................................................................................83 179 SYS_LOG.........................................................................................................................................................................................83 180 TCLASS............................................................................................................................................................................................84 181 TDM_CARRIER.................................................................................................................................................................................84 182 TRACE_LOG.....................................................................................................................................................................................85 183 TRAFFIC_LOG...................................................................................................................................................................................85 184 VERSION_HISTORY...........................................................................................................................................................................86 185 VOICEPORTS....................................................................................................................................................................................86 186 VP_CDR...........................................................................................................................................................................................87 187 VP_CDR_LCR....................................................................................................................................................................................91 188 ZONE_CARRIER_EXCLUSIONS...........................................................................................................................................................91 189 ZONE_IMPORT_ITEMS ......................................................................................................................................................................91 190 ZONES.............................................................................................................................................................................................92 DATA DICTIONARY GATEWAY DATABASE 1 ALARM_LOG This table stores details of all alarms detected on service nodes, and provides details to allow each alarm to be resolved to the port where it originated. Foreign keys are no longer generated because of the "fake netports" used by SIP. COLUMN NAME DATA TYPE DESCRIPTION id int The alarm ID mach_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. port_id int The network port ID writetime datetime The date and time when the alarm was written into the table nos int No Signal: 0. “NOS” signal does exist (no fault condition) 1. “NOS” signal does not exist (fault condition) rai int Remote Alarm Indication: 0. “RAI” signal does exist (no fault condition) 1. “RAI” signal does not exist (fault condition) ais int Alarm in Service: 0. “AIS” signal does exist (no fault condition) 1. “AIS” signal does not exist (fault condition) los int Loss of Synchronisation: 0. “LOS” signal does exist (no fault condition) 1. “LOS” signal does not exist (fault condition) slip int Clocking fault counter. Records the total number of clocking faults (slips) since the system was started fas int Frame alignment error counter. Records the total number of frame alignment errors since the system was started crc int Cyclic Redundancy Check (parity error): 0. “CRC” error signal does exist (no fault condition) 1. “CRC” error signal does not exist (fault condition) layer2 int ISO Layer 2 (datalink error): 0. “LAYER2” signal does exist (fault condition) 1. “LAYER2”signal does not exist (no fault condition) username varchar(50) User name of the operator performing a clear down operation within Supervisor port_type int Whether this is a log of an IP or TDM port. IP ports are not in the database. 0 - TDM 1 - IP 2 ALEG This table stores the tariff sheets used for A-leg carrier rating and billing COLUMN NAME DATA TYPE DESCRIPTION tariff int Holds the tariff ID ddi char(30) Holds the DDI number 1 DATA DICTIONARY GATEWAY DATABASE ddi_group_id uniqueidentifier Holds the DDI Group Id (Access Code Group Id). This references the Primary Agent database, so no foreign key is used. tclass int The time class associated with the tariff opts varchar(200) $ command (dollar command) options that can be applied to this tariff. npanxx char(6) When using the North American Numbering Plan (NANP), this can be used to contain the NPA and NXX parts of the CLI for selecting rates. Valid NPA and NXX values must begin with digits 2-9, and "000" is used as a wildcard for both. Entries will be interpreted as follows: NULL - match any value (default) 000000 - match any value. NPA000 - match specific NPA, but any NXX value. NPANXX - match specific NPA and NXX combination. The most specific rate will be chosen (entries above are listed least-to-most specific) chg_mode int Holds the charge mode used by the rate cli char(30) Not Used ext_chg float Not Used ext_time float Not Used first_chg float The first charge that occurs at the first time interval first_time float The first time interval init_chg float The number of units charged when the incoming call is answered min_chg float The minimum charge that is applied to the card/account notes char(50) Holds miscellaneous information sub_chg float The unit charge that occurs at every subsequent time interval sub_time float The subsequent time interval between unit charges 3 ALEG_LK This table stores the aliases (user defined names) for A-leg carrier rating COLUMN NAME DATA TYPE DESCRIPTION tariff int Holds the table ID name char(50) Holds the table name 4 AUDIT This table holds audit details for changes made to certain database tables. COLUMN NAME DATA TYPE DESCRIPTION audit_id int Unique audit ID assigned to the record action varchar(10) Holds the nature of the change i.e. Insert Delete Update changed_date datetime Holds the date and time that the change was made 2 DATA DICTIONARY GATEWAY DATABASE changed_field varchar(50) Holds the name of the field that was changed changed_table varchar(50) Holds the name of the table that was changed sql_key1 varchar(50) Holds data to identify key fields, allowing the change to be reconciled to a single record sql_key2 varchar(50) Holds data to identify key fields, allowing the change to be reconciled to a single record sql_key3 varchar(50) Holds data to identify key fields, allowing the change to be reconciled to a single record sql_key4 varchar(50) Holds data to identify key fields, allowing the change to be reconciled to a single record sql_key5 varchar(50) Holds data to identify key fields, allowing the change to be reconciled to a single record sql_key6 varchar(50) Holds data to identify key fields, allowing the change to be reconciled to a single record username varchar(30) Holds the username of the operator that made the change value_new varchar(255) Holds the new value value_old varchar(255) Holds the value prior to the change 5 BLEG For Switch, this table stores the tariff sheets used for B-Leg carrier rating if rate plans are not being used. For SBC VoIP peering, this table stores the B-leg sell ratesheets. COLUMN NAME DATA TYPE DESCRIPTION bleg_id bigint The unique identifier for this Bleg record. No external meaning first_chg float The first charge that occurs at the first time interval first_time float The first time interval init_chg float The number of units charged when the incoming call is answered min_chg float The minimum charge that is applied to the card/account notes char(50) Can be used to hold miscellaneous information about the tariff opts varchar(200) $ command (dollar command) options that can be applied to this tariff. sub_chg float The unit charge that occurs at every subsequent time interval sub_time float The subsequent time interval between unit charges tariff int Holds the tariff ID tclass int The time class associated with the tariff zone int Holds the zone ID effective_date datetime Date at which this rate becomes effective, or NULL. margin float Minimum percentage between buy and sell rates for calls to be allowed. Given the sell rate defined by this row, and a buy rate defined by the egress carrier being attempted, it is required that buy.sub_chg/buy.sub_time > sell.sub_chg/sell.sub_time * (sell.margin/100+1). This column is used only if bleg_lk.margin_enabled is set. end_date datetime Date at which this rate is no longer effective, or NULL. is_blocked bit For SBC VoIP Peering, if a call would used this row then reject the call rather than falling back to the next shorter code and looking for another row. 3 DATA DICTIONARY GATEWAY DATABASE 6 BLEG_LK This table stores the aliases (user defined names) for B-leg carrier rating on Switch or B-leg sell rating on SBC VoIP Peering COLUMN NAME DATA TYPE DESCRIPTION tariff int Holds the table name name char(50) Holds the table ID context tinyint Determines whether any alternative interpretation should be put on the rate items within this rate sheet, and whether it should be filtered accordingly. 0 - None (default) 1 - Voice 2 - SMS 3 - MMS customer_rate bit Flag to determine if the rate sheet is used as a customer rate sheet. margin_enabled bit Enforce testing of bleg.margin for rates within this rate sheet. created_date datetime Date that the rate sheet was created updated_date datetime Date that changes were last made to the rate sheet or its items deleted_date datetime Date when the rate sheet was deleted, or NULL if it is Active. state int 0 Active 1 Deleted 0 Active 1 Deleted delete_user_id int The user that deleted the rate sheet, or NULL if it is Active. 7 BULK_DATA_TASKS This table holds information of currently running bulk data tasks from VoIP Peering Manager. COLUMN NAME DATA TYPE DESCRIPTION task_id int The unique identifier for the task user_id int The unique identifier for the membership Id's 1-99 are reserved for Digitalk's internal use. type_id int The type of task being performed. 0 Zone Import 1 Code Import 2 Zone Export 3 Code Export 4 Rate Export 5 Rate Import 6 Rating Plan Import 7 CDR Export 8 Routing Plan Creation 9 Routing Plan Update 10 Routing Plan Export date_started datetime The data and time the task was started status_id int The current status of the task. 0 Awaiting Analysis 1 Analysis In Progress 2 Awaiting Action 4 DATA DICTIONARY GATEWAY DATABASE 3 Action In Progress 4 Completed 5 Cancelled 6 Failed file_path varchar(200) In the case of an exporting task this will hold path to the generated file for download. total_item_count int The number of items the task will be processing. Used when estimating progress of the task processed_item_count int The number of items processed out of the total items. Used when estimating progress of the task. message_log Holds messages for the current job status. Will include warning and error messages. ntext state_action_completed bit A flag to hold whether the current state action (e.g. analysis, import) has been completed. 8 CARD COLUMN NAME DATA TYPE DESCRIPTION slot_id int Slot ID for this Card. node_id int Node ID for this Card. 9 CARRIER_CLI_MATCHING This table contains CLI matching settings for each carrier (TDM and IP). These allow the CLI of a directly connected customer to be checked to determine whether it is present on a list of predefined numbers. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int The carrier ID enable_matching bit Enables CLI Matching on the carrier default_cli matched_clis unmatched_clis The Default CLI. varchar(50) Defines the CLI that will be presented when the "Default CLI" option is selected for "Matched CLIs" or "Unmatched CLIs" tinyint Defines how the outbound CLI will be presented for calls where the callers CLI is present on the matching list. 0 CLI 1 Default CLI 2 Presentation Number Presentation number option is only available on TDM carriers tinyint Defines how the outbound CLI will be presented for calls where the callers CLI is not present on the matching list. 0 CLI 1 Default CLI 2 Presentation Number Presentation number option is only available on TDM carriers 10 CARRIER_CLI_RANGES Contains the ranges of CLIs used for Carrier CLI Matching. These allow the CLI of a directly connected customer to be checked to determine whether it is present on a list of predefined numbers. COLUMN NAME DATA TYPE DESCRIPTION 5 DATA DICTIONARY GATEWAY DATABASE netgroups_lk_id int The group ID range_id tinyint ID of the range range_from varchar(50) Lowest CLI in the range range_to varchar(50) Highest CLI in the range 11 CARRIER_GROUPS A carrier group is a group of netgroups_lks. The netrgroups_lk are effectively interconnects COLUMN NAME DATA TYPE DESCRIPTION carrier_group_id int Unique identifier of this carrier group, with no external meaning. Maximum amount by which this account can be overdrawn. Note that this is a positive postpaid_credit_limit decimal(13,6) number, however it is treated as a negative number, i.e. the constraint credit > postpaid_credit_limit holds. This column is ignored if credit_type is not postpaid. name varchar(50) User-specified name of this carrier group, used for reporting and identification only. type tinyint The type of the carrier 0 None 1 Customer 2 Supplier 3 Bilateral credit decimal(13,6) Amount of money available to this carrier when it is used as an account for the billed leased line service credit_type tinyint When this carrier is used an account for the billed leased line, indicates whether it is prepaid or post-paid. A pre-paid account cannot be used once its balance reaches zero whereas a post-paid account contines to be functional. 0 Prepaid 1 Postpaid 2 NoCreditControl capacity int Maximum number of concurrent calls (both ingress and egress) which are permitted on all interconnects in this carrier group. See also ip_carrier.max_ports. contact_title varchar(5) Contact information for the carrier group contact_first_name varchar(255) Contact information for the carrier group contact_last_name varchar(255) Contact information for the carrier group contact_addr_1 varchar(255) Contact information for the carrier group contact_addr_2 varchar(255) Contact information for the carrier group contact_addr_3 varchar(255) Contact information for the carrier group contact_addr_4 varchar(255) Contact information for the carrier group contact_postcode varchar(255) Contact information for the carrier group contact_country varchar(255) Contact information for the carrier group contact_tel varchar(50) Contact information for the carrier group contact_fax varchar(50) Contact information for the carrier group contact_mobile varchar(50) Contact information for the carrier group contact_email varchar(255) Contact information for the carrier group 6 DATA DICTIONARY GATEWAY DATABASE contact_deposit decimal(13,6) Contact information for the carrier group On SBC VoIP Peering, permit LCR to route calls from an interconnect on this carrier group back to an interconnect on this same carrier group (either the same interconnect or another). allow_circular_routing bit 12 CCA_ACTIVATE_CHANGES Since Credit Control Application nodes do not exist as machines table entries, the Activate Changes instructions are issued via entries in this table, which gives the added benefit of recording the history of times when changes were actioned. Entries older than 14 days are removed by Designer. COLUMN NAME DATA TYPE DESCRIPTION id int Primary Key Identity db_user varchar(256) Database login of user applying the changes nt_user varchar(256) Windows loging of user applying the changes activated datetime Date/time changes were applied. 13 CCA_CDR_PEER_FILES Contains details of the CDR file streams configured on CDRCCA. COLUMN NAME DATA TYPE DESCRIPTION id int Primary Key for the peers type tinyint CDR File Type server tinyint Server sending this file node_id int Primary Key for the Credit Control Nodes. filename varchar(64) File name file_sequence_number int File Sequence number date Datestamp from the file datetime cdr_sequence_number int CDR Sequence number process_complete Whether processing is complete bit 14 CCA_CDR_PEERS CDR Peers. COLUMN NAME DATA TYPE DESCRIPTION id int Primary Key for the peers 15 CCA_DIAMETER_APPLICATIONS Holds the list of enabled Diameter Application DLLs. The table is manually populated. 7 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION id int Unique ID for the record name varchar(50) Name of the application plugin_guid uniqueidentifier Identifier embedded in the DLL used to identify it when it is loaded by the CCA service. 16 CCA_DIAMETER_INTERFACES The Diameter interfaces exposed on each CCA Diameter node COLUMN NAME DATA TYPE DESCRIPTION node_id int Primary Key for the Credit Control Nodes. interface_id tinyint Just numbers the interfaces for primary key purposes. ip_address varchar(45) IPv4 or IPv6 address to expose on this interface. Note that only IPv4 is currently supported. port smallint IP port to expose on this interface protocol tinyint 0 - TCP; 1 - SCTP. Only TCP is currently supported due to the lack of SCTP support on Microsoft Windows. enabled bit Whether this interface is currently enabled 17 CCA_DIAMETER_PEER_APPLICATIONS Holds the list of Diameter applications that are enabled on each Diameter Peer. COLUMN NAME DATA TYPE DESCRIPTION peer_id int application_id int Primary Key for the peers 18 CCA_DIAMETER_PEERS Diameter-specific peer information. Whilst the Diameter protocol specifies that peers should be uniquely identifiable by the Origin-Host AVP, in practice the DIGITALK CCA also verifies the Origin-Realm and Host-IP-Address AVPs against the definitions in this table. COLUMN NAME DATA TYPE DESCRIPTION id int hostname varchar(256) Hostname of the peer realm varchar(64) Realm of the peer ip_address varchar(45) Source IPv4 or IPv6 address for the peer. Currently only IPv4 is supported. port smallint Source port protocol tinyint 0 TCP; 1 SCTP. Currently only TCP is supported because there is no SCTP support on Microsoft Windows. Primary Key for the peers 8 DATA DICTIONARY GATEWAY DATABASE 19 CCA_ENABLED_PEERS Mapping of peers to CCA Nodes COLUMN NAME DATA TYPE DESCRIPTION node_id int Primary Key for the Credit Control Nodes. peer_id int Primary Key for the peers type tinyint CCA Node/Peer Type: 0 - Diameter; 1 - CDR 20 CCA_NODE_LOGGING Defines the levels at which logging components will write to file COLUMN NAME DATA TYPE DESCRIPTION node_id int Primary Key for the Credit Control Nodes. component char(4) The 4-character log code for the component that the logging level is set for. Examples of these can be found in CCA log files. level tinyint This specifies the minimum level of logging that should be written to disk. DEBUG = 0; INFO = 1; WARNING = 2; ERROR = 3; CRITICAL = 4 21 CCA_NODES Defines the configuration for machines running the Credit Control Application. COLUMN NAME DATA TYPE DESCRIPTION id int name varchar(15) Computer Name (used by CCA to resolve the node in this table) type tinyint network_ip varchar(45) Network IP address of the node. This IP Address must be present on the machine for it to start up. hostname varchar(256) Hostname used in Diameter signalling. realm varchar(64) Realm used in Diameter signalling. enabled bit notes varchar(255) Any user-provided comments graceful_shutdown bit Primary Key for the Credit Control Nodes. Type of node: 0 - Diameter processing 1 - CDR processing Whether the node is enabled. If set then the CCA will send Abort-Session-Requests on shutdown (where supported) rather than allowing the sessions to failover 22 CCA_OPTS General and node-specific options for the Credit Control Application. 9 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION name varchar(64) Option name. node_id int Primary Key for the Credit Control Nodes. value varchar(1024) Option values. 23 CCA_PEER_HOME_NETWORK_RANGES Identifies the Home Network SGSN addresses for a particular CCA Peer, to enable detection of roaming. COLUMN NAME DATA TYPE DESCRIPTION id int Unique ID for the record peer_id int cca_peer to which this range belongs range varchar(50) IP Address range, in CIDR notation. 24 CCA_PEERS Peers are clients that are allowed to connect to the DIGITALK CCA. They can either be Diameter peers or CDR peers. COLUMN NAME DATA TYPE DESCRIPTION id int name varchar(50) User-defined name for the peer type tinyint Primary Key for the peers 0 - Diameter Peers; 1 - CDR Peers standard_voice_tariff int The standard voice tariff used for rating requests from this peer for revenue assurance purposes standard_sms_tariff int The standard SMS tariff used for rating requests from this peer for revenue assurance purposes roaming_voice_tariff int The roaming voice tariff used for rating requests from this peer for revenue assurance purposes roaming_sms_tariff int The roaming SMS tariff used for rating requests from this peer for revenue assurance purposes standard_mms_tariff int The standard MMS rate sheet used for peer tariffing. roaming_mms_tariff int The roaming MMS tariff used for rating requests from this peer for revenue assurance purposes gprs_tariff int enabled bit Whether the peer is currently enabled 25 CLOCKING This table stores details of the network ports specified for use as clocking sources, and lists them in their order of precedence. COLUMN NAME machine DATA TYPE DESCRIPTION int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. 10 DATA DICTIONARY GATEWAY DATABASE atmclock varchar(50) Not used netclock varchar(50) Comma separated list of port card Id’s to be used as clocking sources in normal mode The port card ID’s are listed in order of precedence 26 CODE_IMPORT_ITEMS Table for holding raw import data when importing codes. COLUMN NAME DATA TYPE DESCRIPTION item_id int Unique identifer for the item. No external meaning. task_id int The bulk data task of this code import name varchar(50) The name of the code to be imported prefix varchar(40) The dialling prefix of the code to be imported zone varchar(50) The zone to which this code will be imported into. max_length int The number of digits that can be entered before being resolved by the switch 27 CODES This table stores the dialling prefixes supported by the system, mapping them to zones. The table should be clustered sorted by prefix descending, rather than ascending. COLUMN NAME DATA TYPE DESCRIPTION code_id int prefix varchar(40) Holds the dialling prefix for the zone name varchar(50) Holds the name of the dialling code max_digits int Defines the number of digits that can be entered before being resolved by the switch zone int Holds the zone ID 28 CONNECT_LOG This table stores details of who is logged-on, what application they are running and the version. COLUMN NAME DATA TYPE DESCRIPTION spid int SQL process ID app_name varchar(20) Application name (Service) version varchar(15) Version number version_dll varchar(15) DLL Version number connected datetime Date and Time session started 29 CURRENT_ALARM_LOG This table stores details of all alarms detected on service nodes, and provides details to allow each alarm to be resolved to the port where it originated. 11 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION id int The alarm ID mach_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. port_id int The network port ID writetime datetime The date and time when the alarm was written into the table nos int No Signal: 0. “NOS” signal does exist (no fault condition) 1. “NOS” signal does not exist (fault condition) rai int Remote Alarm Indication: 0. “RAI” signal does exist (no fault condition) 1. “RAI” signal does not exist (fault condition) ais int Alarm in Service: 0. “AIS” signal does exist (no fault condition) 1. “AIS” signal does not exist (fault condition) los int Loss of Synchronisation: 0. “LOS” signal does exist (no fault condition) 1. “LOS” signal does not exist (fault condition) slip int Clocking fault counter. Records the total number of clocking faults (slips) since the system was started fas int Frame alignment error counter. Records the total number of frame alignment errors since the system was started crc int Cyclic Redundancy Check (parity error): 0. “CRC” error signal does exist (no fault condition) 1. “CRC” error signal does not exist (fault condition) layer2 int ISO Layer 2 (datalink error): 0. “LAYER2” signal does exist (fault condition) 1. “LAYER2”signal does not exist (no fault condition) username varchar(50) User name of the operator performing a clear down operation within Supervisor port_type int 30 CURRENT_TRAFFIC_LOG This table stores details of all traffic logs on service nodes, and provides details to allow each log to be resolved to the port where it originated. COLUMN NAME DATA TYPE DESCRIPTION id int The log ID mach_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. port_id int The network port ID writetime datetime The date and time when the log was written into the table 12 DATA DICTIONARY GATEWAY DATABASE idle int The number of 'idle' channels blocked int The number of 'blocked' channels incoming int The number of channels with 'incoming' traffic in_ringing int The number of 'incoming ringing' channels in_connected int The number of 'incoming connected' channels outgoing int The number of channels with 'outgoing' traffic out_ringing int The number of 'outgoing ringing' channels out_connected int The number of 'outgoing connected' channels port_type int 0 - TDM 1 - IP g723_bw int Bandwidth used by G.723 Codec. g729_bw int Bandwidth used by G.729 codec. g711_bw int Bandwidth used by G.711 codec. t38_bw int Bandwidth used by T.38 (Fax) codec. 31 DTCDRTOOL_STREAMS Stores the streams created by dtcdrtool and their current read positions in the vp_cdr table. A stream represents a single contiguous sequence of CDRs read from the table, i.e. each stream will receive the full set of CDRs and will continue where it left off last time. COLUMN NAME DATA TYPE DESCRIPTION id int name varchar(126) Name of this stream, as chosen by the user who created it. created datetime Date/time at which this stream as created (using dtcdrtool add), for informational purposes only. first_date datetime Approximate date/time of the CDR indicated by first_cdr (and therefore approximately how long it has been since this stream was last used to download CDRs), for informational purposes only first_cdr bigint Value of vp_cdr.row_timestamp of the next CDR which will be retrieved for this user. This may not point to an actual row, but will uniquely identify a position between two consecutive rows. bigint Value of vp_cdr.row_timestamp of the last CDR which will be retrieved for this user in the current operation. This may not point to an actual row, but will uniquely identify a position between two consecutive rows. If this is equal to first_cdr then the stream does not have a transaction open currently. last_cdr Unique identifier of this stream, with no external meaning 32 EGRESS_RATE_IMPORT_ITEMS Intermediary table containing items that are in the process of being imported from a carrier rate file to an egress rate plan. A custom SP for each import template is required to process this data before it can be imported as codes, zones and rates in a carrier rate plan. COLUMN NAME DATA TYPE DESCRIPTION id int Unique ID for an imported rate item import_id int The ID of the import job to which this item belongs 13 DATA DICTIONARY GATEWAY DATABASE prefix varchar(40) Dialling prefix for this rate zone varchar(50) Zone name for this rate timeclass_name varchar(50) Timeclass name for this rate, as extracted from the file (if present) timeclass_id int Timeclass ID. Must be populated and match an ID in the tclass table before the item can be imported into the rate plan. initial_charge float Initial charge for the rate. first_charge float First charge for the rate. first_period float First period for the rate in seconds. subsequent_charge float Subsequent charge for the rate. subsequent_period float Subsequent period for the rate, in seconds. effective_text varchar(50) The text value of the date at which this rate will become effective. To be parsed and populated into the effective_date column as a UTC datetime. effective_date datetime UTC datetime at which this rate will become effective. Must be valid before the rate can be imported into a carrier rate plan. delete_prefix int Allows the SP to specify, based on its own criteria, that this prefix is to be removed from the zone. Values: 0 - Prefix is to be used to build up a new zone definition along with any other prefixes in this import with the same zone name, replacing the existing definition in the plan (if the plan exists) 1 - Prefix is to be excluded from the zone definition being built up (essentially ignored by the import process) 2 - Prefix is to be added to any existing prefixes in the zone. 3 - Prefix is to be removed from the zone and the remaining prefixes left in place. Templates should only use values 0 and 1 in the same import (intended for full update files), or 2 and 3 (intended for individual prefix modification updates) and not mix the two sets of values. comments A generic comments field from the input file. varchar(255) This can be parsed by the SP to extract whatever additional information it deems necessary to process the update record. 33 EGRESS_RATE_IMPORT_TEMPLATE Contains definitions of templates used for importing carrier egress rates, stored as XML documents. COLUMN NAME DATA TYPE DESCRIPTION id int Template ID name varchar(50) Template name definition text XML document defining this template. 34 EGRESS_RATE_IMPORTS Contains a history of carrier rate plans that have been imported from files. COLUMN NAME DATA TYPE DESCRIPTION id int Unique ID for the import history record template_id int ID of the template used, unless it has been deleted. 14 DATA DICTIONARY GATEWAY DATABASE template_name varchar(50) Name of the template used. started datetime Time that the import was started. filename varchar(260) Name of the file that was imported. rate_plan_id int ID of the Rate Plan that was created or updated by this import completed datetime The time that the import was completed. rate_count int The number of rates that were imported. import_type tinyint Whether the import contains both price and zone definition changes, just price changes, or just zone changes: 0 - Price and Zone Changes 1 - Price Changes Only 2 - Zone Changes Only task_id int import_mode int import_name varchar(50) 0 New 1 Copy 2 Append 35 EGRESS_RATING_PLAN_ITEMS This table stores the rate items used for in plan-based carrier tariffing COLUMN NAME DATA TYPE DESCRIPTION rate_plan_item_id int rate_plan_id int The carrier rate plan to which this item belongs. zone int Holds the zone ID on the carrier rate plan to which this belongs. tclass int The time class associated with this rate. effective_date datetime The UTC time at which this rate becomes valid. end_date datetime The UTC time at which this rate is replaced by a new one for the same zone, timeclass and rate plan. init_chg float The number of units charged when the incoming call is answered first_chg float The first charge that occurs at the first time interval first_time float The first time interval sub_chg float The unit charge that occurs at every subsequent time interval sub_time float The subsequent time interval between unit charges 36 EGRESS_RATING_PLANS COLUMN NAME DATA TYPE DESCRIPTION id int Unique id for this rating plan name varchar(50) Name of the rating plan, must be unique 15 DATA DICTIONARY GATEWAY DATABASE replaced datetime Date that the rating plan was "deleted" (i.e. a new version was created and modified with code or rate changes) created datetime Date this rate plan was created - this is maintained across versions when changes are uploaded template_name varchar(50) Name of the template used to import or last update this plan updated datetime deleted_date datetime state int delete_user_id int Date this version of the rating plan was created 0 Active 1 Deleted 37 FAILED_LCR_CALL_ATTEMPTS Holds details of calls that had LCR failures and the reasons for those failures. COLUMN NAME DATA TYPE DESCRIPTION call_reference_id int Unique id for the call (AREF in CDR tables). writetime Time the record was written to the database. datetime lcr_route_choice int LCR choice position (1-6). leg_type int 1 = B-leg, 2 = C-Leg. netgroup_id int Carrier ID. bnumber varchar(32) Destination dialled (as sent to carrier, i.e. after any translations have been applied). clear_reason int Protocol clearing code for the call. call_connected int Whether the call connected. clear_type int 1 = Forward Clear, 2 = Backward Clear. fail_type int 1 = Call failure, 2 = Percentage Routing retry, 3 = Carrier Timeout, 4 = Number Portability. mach_id int Machine the call was made from. netport_id int Port the call was made on. ts int Timeslot the call was made on. 38 FAULT_LOG This table stores details of faults detected on service nodes, the engineer allocated to the fault and whether the fault has been resolved. Foreign keys are no longer generated because of the "fake netports" used by SIP. COLUMN NAME DATA TYPE DESCRIPTION id int The fault ID int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. mach_id 16 DATA DICTIONARY GATEWAY DATABASE port_id int The network port ID writetime datetime The date and time when the fault was written into the table type int 0 Telephony 1 Atm 2 DB 3 SS7 4 Traffic 5 OC3 state int 0 Low 1 Medium 2 High username varchar(50) User name of the operator performing a clear down operation within Supervisor msg varchar(100) Textual message written by the switch to describe a fault port_type int Whether this is a log of an IP or TDM port. IP ports are not in the database. 0 - TDM 1 - IP 39 GPRS_RATE_SHEET_ITEMS GPRS data rates, used by the CCA COLUMN NAME DATA TYPE DESCRIPTION gprs_rate_sheet_item_id bigint Unique ID for this rate sheet item gprs_rate_sheet_id ID of the GPRS rate sheet to which this rate belongs int gprs_roaming_zone_id int ID of the roaming zone, if roaming apn varchar(64) Access Point Name for this rate, or ‘*’ as a wildcard. roaming bit Whether the rate is a home network or roaming rate. volume int A volume, in kB (1000B) to allow easier price scaling. charge decimal(13,8) The cost of each ‘volume’ used on this rate. This is applied pro-rata. opts varchar(200) Advanced options that apply to this rate 40 GPRS_RATE_SHEETS Holds GPRS Rate Sheets used for Peer Tariffing COLUMN NAME DATA TYPE DESCRIPTION gprs_rate_sheet_id int name varchar(50) state tinyint Current state of the GPRS tariff. 0 - Active 1 - Deleted 2 - Replaced state_changed datetime Date/time the state of this tariff last changed. 17 DATA DICTIONARY GATEWAY DATABASE 41 GPRS_ROAMING_IP_RANGES Roaming zones for GPRS are defined by the IP Addresses of the SGSNs that will be used while roaming within a particular geographic area. This table defines IP Ranges in CIDR notation. See: http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing COLUMN NAME DATA TYPE DESCRIPTION id int gprs_roaming_zone_id int ip_range Primary Key for the GPRS Roaming Zone IP Ranges table The zone that this IP Range is assigned to varchar(18) The IP Address range for this entry, in CIDR notation. 42 GPRS_ROAMING_ZONES Defines rating zones for data services used while roaming outside of the home network. COLUMN NAME DATA TYPE DESCRIPTION gprs_roaming_zone_id int name ID of the zone varchar(50) Name of the zone 43 H323_GATEKEEPER_ALIAS Table listing the aliases to be provided for the H.323 gatekeeper for the node (if H.323 gatekeeper used). COLUMN NAME DATA TYPE DESCRIPTION node_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. alias_id int The position of the alias in the gatekeeper alias list. alias varchar(255) An alias used by this gatekeeper. 44 H323_GATEKEEPER_PREFIX Table listing the prefixes to be provided for the H.323 gatekeeper for the node (if H.323 gatekeeper used). COLUMN NAME DATA TYPE DESCRIPTION node_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. prefix_id int The position of this prefix in the gatekeeper's prefix list. prefix varchar(255) A prefix used by this gatekeeper. 45 H323_TRANSLATION This table holds translation options for calls egressing over H.323. 18 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION h323_translation_id int Primary key for the H323_Translation table. int Setting for the Calling Party Presentation Indicator. 0 - Map from input 1 - Allowed 2 - Restricted 3 - Not Available int Setting for the Calling Party Screening Indicator. 0 - Map from input 1 - User-Provided Not Screened 2 - User-Provided Verified Passed 3 - User-Provided Verified Failed 4 - Network-Provided calling_party_presentation calling_party_screening calling_party_numbering_type int Setting for the Calling Party Numbering Type 0 - Map from input 1 - Unknown 2 - International 3 - National 4 - Network-Specific 5 - Subscriber Number 6 - Abbreviated Number calling_party_numbering_plan int Setting for the Calling Party Numbering Plan. 0 - Map from input 1 - Unknown 2 - ISDN 3 - Data 4 - Telex 5 - National Standard 6 - Private called_party_numbering_type int Setting for the Called Party Numbering Type. 0 - Unknown 1 - International 2 - National 3 - Network-Specific 4 - Subscriber Number 5 - Abbreviated Number 6 - Map from Input called_party_numbering_plan int Setting for the Called Party Numbering Plan. 0 - Unknown 1 - ISDN 2 - Data 3 - Telex 4 - National Standard 5 - Private 6 - Map from Input bearer_type Bearer Type 0 - All Call Types 1 - Speech 64K 2 - Data 64K 3 - 3.1 kHz Audio int 46 IMPORTED_CODES This table stores codes that have been uploaded into supplier rating plans which do not exist in the codes table. COLUMN NAME DATA TYPE DESCRIPTION 19 DATA DICTIONARY GATEWAY DATABASE imported_code_id int The unique identifier for the imported code, has not external use. prefix varchar(40) The dialling prefix for the imported code supplier_zone varchar(50) The associated zone from the supplier rating plan which this code was imported from. rating_plan_id int The supplier rating plan which this code was imported from. create_date datetime The date and time this code was imported 47 INACTIVE_NODE_LOG This table stores a list of inactive service nodes along with notification time COLUMN NAME DATA TYPE DESCRIPTION mach_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. notified datetime Date and time of notification 48 IP_CARRIER Non protocol-specific parts of the carrier profile for a SIP or H323 carrier, or a Registrar Service. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int Carrier ID border_control_address_id int Unique identifier of this address. Note that this ID is passed around internally among applications, therefore a given ID must always refer to a given IP address: do not combine an addition and removal of an IP address into an update of an existing one, rather a new row should be created and the old one deleted. type int Sub-category of IP carrier this row represents. 0 SIP 1 H.323 2 SIP Registrar Service restrict_nodes bit Whether to restrict the nodes that this carrier can operate on. If restricting, ip_carrier_node table should be looked at to determine which nodes are allowed. restrict_codecs bit Whether to restrict the codecs that this carrier can use. If restricting, ip_carrier_codecs should be looked at to determine which codecs are permitted. max_ports int Maximum number of channels on this carrier. NULL/0 indicates no limit. layer_3_qos int dtmf int DTMF Mode 0 RFC2833 1 Inband 2 SIP INFO tones_in varchar(30) CSV list of allowed inbound tones tones_out varchar(30) CSV list of allowed outbound tones 20 DATA DICTIONARY GATEWAY DATABASE slow_start bit dtmf_payload_type int DTMF payload type for codecs on this carrier. Should be 96-127, defaulting to 101. t38_support bit Whether the carrier supports T.38. caller_cng bit On IPT nodes, this enables detection of fax on receipt of CNG tones from the calling party. manipulate_ingress_params bit Whether SIP parameters should be manipulated for ingress calls ingress_originating_address varchar(1024) Originating Address value to set when manipulating ingress SIP calls. Wildcards such as % can be used in the same way as for manipulating outgoing CLI/DDI on a route. ingress_presentation tinyint Presentation/Restriction value to set when manipulating ingress SIP call parameters ingress_screening tinyint Screening value to set when manipulating ingress SIP call parameters ingress_numbering_type tinyint Numbering Type value to set when manipulating ingress SIP call parameters ingress_numbering_plan tinyint Numbering Plan value to set when manipulating ingress SIP call parameters clear_on_rtp_timeout bit Whether to clear the call when an RTP timeout QoS alarm is received. direct_access bit Whether the carrier is direct to a customer PBX. If this is the case, then when the Calling Party Number is Restricted it will be removed from the signalling. rate_limit float When using an SBC, maximum number of egress calls per second which are permitted. Any new calls which exceed this limit will be rejected. If zero, no rate limiting is applied. burst_threshold float When using an SBC, the amount of flexibility permitted in the rate limit, expressed as the number of calls per second over the limit which are allowed temporarily. If zero, a default is calculated based on the rate limit. relay_media bit If set, the SBC will force all calls sent to or received from this carrier to use the media proxy, which means all RTP will come through our network. send_100_for_all_requests bit This column was made obsolete in 258. (Was: Specify whether the SBC should send 100 Trying immediately after carrier resolution when receiving the initial INVITE (rather than waiting for 100 to come back from a MAS).) dtmf_detect bit Whether to detect DTMF and convert to SIP INFO when relaying media via the SBC. SIP-only, obviously. no_tones_with_media bit Whether to skip applying any outgoing progress tones if there is a media connection to the far end. nat_use_rtp_source bit If set, Switch will compare RTP received with SDP media address information. If the RTP comes from a different source, Switch will accept that in preference to the SDP. If this occurs on the A-leg of a "media-less" two stage call, Switch will modify the Bleg Invite SDP to reflect the true media addresses. ingress_destination_address varchar(1024) media_network_id favour_external_media int nicmgr network over which media should travel for this carrier, and the closest point of presence to the carrier. If NULL then the media will use the same network and location as the signalling, i.e. the border control address ID. bit When computing the best routing plan for media for calls egressing to this carrier, the SBC has two options: it can either minimize the distance travelled over the external network, or it can minimize the distance over the internal network. If advanced routing is not being used then these options are the same, but with advanced routing the metrics can be used to decide the most efficient path to take. If this column is set then the route with the smallest advanced routing metric will be selected; if this column is cleared then the route with the closest nicmgr subnets will be selected. 21 DATA DICTIONARY GATEWAY DATABASE 49 IP_CARRIER_CODEC This table represents up to 6 codecs on each IP Carrier profile. COLUMN NAME DATA DESCRIPTION TYPE netgroups_lk_id int Carrier ID order_id int Order of preference int 0 G.711 A-law 1 G.711 u-law 2 G.729A 3 G.729AB 4 G.723.1 5.3kbps 5 G.723.1 6.3kbps framesize int Framesize in ms. Limited to: 10, 20 or 30 for G.711 Codecs 30 for G.723 Codecs 10 for G.729 Codecs vad bit Voice activity detection 0 - Off 1 - On codec Number of voice frames included in each IP packet. G.711 - 1 G.723 - 2 or 3 G.729 - 2, 3 or 4 frames_per_packet int Controls how the SBC behaves when it appears to need to convert between compatible variants of the same codec. Codecs with compatible variants include annex B of G.729, and the bitrate and annex A of G.723; with these variants it is extremely likely that switching between different variants will result in a successful call, however actually converting between variants consumes a lot of resources. The SBC can behave in one of the following ways when presented with an apparent requirement to do this conversion: Disobey restriction: Ignore the restrict codecs setting for this codec and do not transcode. The carrier may see a variant that is not on the restrict codecs list. variants_behaviour tinyint Transcode: Consume the resources necessary to do a full transcode of the call, so that both A-leg and B-leg carriers see the exact codec variant they desire. If transcoding is disabled for the netroute then this option will not be possible and will behave like 'disobey restriction'. Inconsistent signalling/media: Modify the signalling as specified in the codec restriction, but do not transcode the media. If this causes the signalling and media to differ then problems may arise from excessive bandwith usage or alarms from remote networking equipment. 0 Disobey restriction 1 Transcode 2 Inconsistent signalling/media 50 IP_CARRIER_FROM_ADDRESS Valid source IP Addresses and Domains for the IP Carrier's traffic. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int Carrier ID item_id int Position in the list of valid 'from' addresses. Order is unimportant. ip_address_range_from varchar(255) The lowest matching IP address in this range. ip_address_range_to varchar(255) The highest matching IP address in this range. 22 DATA DICTIONARY GATEWAY DATABASE 51 IP_CARRIER_H323 Holds H.323-specific settings for IP Carriers using the protocol. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int Carrier ID validate_call_prefix bit Whether to validate the call prefix call_prefix varchar(255) The call prefix to validate against. Only applies if validate_call_prefix is set. validate_e164_prefix bit call_in_e164_prefix varchar(255) The E.164 Prefix to validate against. Only applies if validate_e164_prefix is set. validate_alias_prefix bit call_in_alias_prefix varchar(255) Prefix to validate validate_ip_address bit Whether the source IP address should be validated gatekeeper_routed bit Obsolete. Used to be whether egress calls should be routed via a Gatekeeper. routing_ip_address varchar(20) The first IP address to use for routing. Other addresses are in the IP Carrier To Address table routing_port int default_tdm_cli varchar(255) The default TDM CLI to assign to inbound H.323 calls egressing over TDM. default_from_address varchar(255) The default From address to assign to outgoing H.323 calls ingressing over TDM Whether to validate the E.164 Prefix Whether the Alias Prefix should be validated The port to use for routing to the first IP address outbound_h425_tunnelling bit Whether to use H.245 Tunnelling on egress calls insert_to_prefix bit Whether to insert a prefix on the Called address to_prefix varchar(255) The prefix to insert if insert_to_prefix is enabled call_completion_timeout int Timeout value for call completion. monitor_call_response bit Whether switch should monitor the number of failures to respond to call setup on this carrier. This does not mean calls that receive a busy or rejected response, just calls that give no response at all. dest_alarm_threshold smallint The number of consecutive failures on the destination address before an alarm is raised. bit Whether Switch should disable individual destination addresses after a number of consecutive failures. CAUTION: Disabling a destination address will mean that calls in progress to that destination will be terminated. disable_dest_threshold smallint The number of failures on a particular destination address before Switch disables the address. If other destination addresses are available on the carrier Switch will continue to use those, otherwise the carrier will be disabled. CAUTION: Disabling a destination address will mean that calls in progress to that destination will be terminated. enable_dest_on_timer bit If this option is selected, Switch will re-enable a destination address (that it has disabled) after the number of minutes specified in the enable_dest_mins column. enable_dest_mins smallint The number of minutes after which Switch will re-enable a destination address that it has disabled, if the enable_dest_on_timer option is selected. disable_dests enable_dest_on_all_disabled bit If there are multiple destination addresses enabled on a carrier, this option specifies that if all of them have been disabled, that all of them should be re-enabled (except 23 DATA DICTIONARY GATEWAY DATABASE the last to be disabled). Otherwise the whole carrier will be disabled. alarm_threshold smallint The number of consecutive failures on this carrier before an alarm is raised. disable_carrier bit Whether Switch should automatically disable the carrier if it gets a certain number of consecutive failures making calls. The total is counted across all destination addresses. CAUTION: Disabling a carrier will mean that outbound calls in progress to it will be terminated as it is assumed that signalling is not available to that carrier. disable_threshold smallint The number of consecutive failures before the carrier is disabled. CAUTION: Disabling a carrier will mean that outbound calls in progress to it will be terminated as it is assumed that signalling is not available to that carrier. enable_on_timer bit Specifies that if Switch has disabled a carrier due to consecutive failures that it should be re-enabled after the number of minutes specified in enable_mins. enable_mins smallint The number of minutes after Switch has disabled a carrier that it should be reenabled. proxy_gk_ip_address IP address or hostname of the H.323 server to which the SBC will register at startup varchar(128) and remain connected to. This is typically also the gateway used for outgoing calls, but does not have to be. If NULL then the SBC will not register with any gatekeeper. proxy_gk_port int UDP port number of the server specified in proxy_gk_ip_address. proxy_gk_time_to_live int Refresh interval of the registration to the H.323 gatekeeper that the SBC is registering with, measured in seconds. This is a protocol suggestion only, the gatekeeper is free to redefine it during initial negotiation. 52 IP_CARRIER_NODE This table represents IP Carriers, that is entries in NETGROUPS_LK which have a type of IP rather than TDM. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int node_id int 53 IP_CARRIER_SIP Holds SIP-specific settings for IP Carriers using the protocol. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int Carrier ID validate_to_uri_prefix bit Whether to validate the Request-URI prefix to_uri_prefix varchar(255) Request-URI prefix for validation, if enabled validate_from_uri bit from_uri varchar(255) From URI to use for validation, if enabled validate_contact_uri bit contact_uri varchar(255) Contact URI to use for validation, if enabled validate_ip_address bit Whether the carrier should be identified by matching the IP Address against the list of addresses in IP Carrier From Addresses. validation_address_type int The address that will be used for IP Address Validation 0 - Via address, ignoring Last Via. Whether to validate the From URI Whether to validate the Contact URI 24 DATA DICTIONARY GATEWAY DATABASE 1 - Via address, including Last Via. 2 - Transport address proxy_address varchar(255) First 'to' address for this carrier. default_tdm_cli varchar(255) Default CLI to use when egressing over TDM for calls that ingress on this carrier default_sip_uri varchar(255) Default SIP From URI to use when egressing over SIP for calls that ingress on TDM insert_to_prefix bit to_prefix varchar(255) Request-URI prefix to insert, if enabled reinvite bit Whether to allow Switch to initiate re-INVITE on this carrier privacy int 0 RFC3261 (Anonymous) 1 Remote-Party-ID 2 RFC3325 (P-Asserted-Identity) hairpin_media bit Whether to hairpin media on this carrier media_bypass bit Whether to allow media to bypass the MAS require_prack bit Whether PRACK is required on this carrier send_options bit Whether enabled carriers should be sent OPTIONS messages to monitor their status. This is likely to give a good indication of whether the carrier will respond to an INVITE. options_period smallint The (minimum) time between sending OPTIONS messages on this carrier. Each Node can only send one OPTIONS message (and wait for the response) at a time, so if there are a lot of carriers it may not be possible to send OPTIONS as often as specified. If multiple destination addresses are specified on the carrier then Switch will rotate between them when sending OPTIONS messages for the carrier. monitor_call_response bit Whether switch should monitor the number of failures to respond to call setup on this carrier. This does not mean calls that receive a busy or rejected response, just calls that give no response at all. alarm_threshold smallint The number of consecutive failures on this carrier before an alarm is raised. This is the sum of failed calls and failed OPTIONS messages. dest_alarm_threshold smallint The number of consecutive failures on the destination address before an alarm is raised. bit Whether Switch should disable individual destination addresses after a number of consecutive failures. CAUTION: Disabling a destination address will mean that calls in progress to that destination will be terminated. disable_dest_threshold smallint The number of failures on a particular destination address before Switch disables the address. This is the sum of call failures and failed OPTIONS messages. If other destination addresses are available on the carrier Switch will continue to use those, otherwise the carrier will be disabled. CAUTION: Disabling a destination address will mean that calls in progress to that destination will be terminated. enable_dest_on_timer bit If this option is selected, Switch will re-enable a destination address (that it has disabled) after the number of minutes specified in the enable_dest_mins column. enable_dest_mins smallint The number of minutes after which Switch will re-enable a destination address that it has disabled, if the enable_dest_on_timer option is selected. disable_dests Whether to insert a prefix on the Request-URI 25 DATA DICTIONARY GATEWAY DATABASE bit Whether Switch should send OPTIONS messages to destination addresses that it has disabled. If any of these messages are responded to then Switch will re-enable the destination address on the carrier. bit If there are multiple destination addresses enabled on a carrier, this option specifies that if all of them have been disabled, that all of them should be re-enabled (except the last to be disabled). Otherwise the whole carrier will be disabled. bit Whether Switch should automatically disable the carrier if it gets a certain number of consecutive failures making calls. The total is counted across all destination addresses and is the sum of call failures and failed OPTIONS messages. CAUTION: Disabling a carrier will mean that outbound calls in progress to it will be terminated as it is assumed that signalling is not available to that carrier. disable_threshold smallint The number of consecutive failures before the carrier is disabled. This is the sum of call failures and failed OPTIONS messages. CAUTION: Disabling a carrier will mean that outbound calls in progress to it will be terminated as it is assumed that signalling is not available to that carrier. enable_on_timer bit Specifies that if Switch has disabled a carrier due to consecutive failures that it should be re-enabled after the number of minutes specified in enable_mins. enable_mins smallint The number of minutes after Switch has disabled a carrier that it should be re-enabled. enable_on_options bit Whether Switch should send OPTIONS messages in the background while the carrier is disabled. If a response is received then Switch will re-enable the carrier. override_options_from bit Whether to override the From address on the OPTIONS message. If not set then the From address will be 'anonymous'. override_from_username varchar(32) The username to use if override_options_from is set. override_options_to bit override_to_username varchar(32) If override_options_to is specified then this is the username that will be added to the Request-URI. prefix_plus_for_intl_egress bit Whether to prefix the destination address with '+' when the Numbering Type of the egress SIP call is International. enum_lookup bit Whether an ENUM DNS Query should be performed on E.164-format numbers SIP enum_domain varchar(64) Domain to use for the ENUM queries enum_primary_dns int Primary DNS Server IP Address to use for ENUM queries. enum_secondary_dns int Secondary DNS Server IP Address to use for ENUM queries. add_reason_header bit Whether to add a Reason header to BYE and CANCEL messages allow_session_expiry bit Whether to allow Session Expiry min_session_expiry int Minimum value for session expiry (seconds) max_session_expiry int Maximum value for session expiry (seconds) session_refresh_preference tinyint The preferred direction in which session timers should be refreshed: 0 - Don't Care (default) 1 - Local enable_dest_on_options enable_dest_on_all_disabled disable_carrier Whether to override the Request-URI on OPTIONS messages. If not set then no username part will be added, which should be fine for most gateways/proxies. 26 DATA DICTIONARY GATEWAY DATABASE 2 - Remote session_refresh_method tinyint The SIP method to use for refreshing session timers: 0 - reINVITE (default) 1 - UPDATE session_refresh_without_remote_support bit Whether to refresh the Session even when the remote party doesn't support it. session_refresh_without_preference bit Whether to refresh the Session when the remote party doesn't express a preference for the direction of refresh. session_terminate_on_timer_expiry bit Whether calls should be terminated on session timer expiry. egress_transport tinyint Preferred IP transport to use for calls made to this carrier: - 0: UDP - 1: TCP - 3: TLS The acceptable transports for calls received from this carrier are any which are enabled on the border control IP address associated with the carrier. Another transport may be used if the preferred choice is not available. add_user_equals_phone bit Whether to insert 'user=phone' into the Request-URI and To: address for egress calls to this carrier. diversion_header_type int Type of diversion header to use for egress. 0 - History-Info 1 - CC-Diversion 2 - Diversion transit_diversion bit Whether to transit existing Diversion headers from ingress to egress. add_cpc_tag bit Whether the CPC Tag should be added. media_bypass_invite_sdp_type tinyint Type of media offer used in SDP when Media Bypass is enabled: 0 - Remote (Default) - Always offer remote media 1 - Remote If Carrier Codec Match - Offer remote media if codecs match (as provisioned on carrier) 2 - Local - Offer local media and examine SDP response local_media_reattempt bit Whether to reattempt SDP offer when media_bypass_invite_sdp_type is not set to "Local". Default is not to. strict_codec_check bit Whether the codec matching should be strict when media_bypass_invite_sdp_type is not set to "Remote". Default is not strict. external_lcr_provider bit VoIP Peering only. This carrier is a SIP device which evaluates routing rules and returns a list of LCR choices as prefixes of the Contact user names in a SIP 3xx response. The LCR tables on the Digitalk VoIP Peering solution must be configured to route to the correct carrier based on these prefixes. info_itx bit Whether to send billing unit indications mid-call using SIP INFO telephony bit Enables support for SIP-T 54 IP_CARRIER_STATUS Holds the status of the carrier on each node. This is used by Switch to report the state to Supervisor, and by Supervisor to apply manual changes to Switch. The table is not populated by Designer, but by Switch as it reports the status via stored procedures. COLUMN NAME DATA TYPE DESCRIPTION 27 DATA DICTIONARY GATEWAY DATABASE netgroups_lk_id int node_id int char The current status of the carrier on the node, as reported by Switch: ? - Unknown 0 - Enabled A - Alarm Raised E - (Error) Disabled (only if disabled by Switch, manual blocks are not reported) D - Disabled by User from Supervisor manual_status char Whether the carrier has been manually disabled by a user from Supervisor. 0 - Enabled D - Disabled F - Force Enabled (re-enables the carrier after it has been disabled automatically by Switch) B - Disable Pending (disables the carrier when it is enabled) node_dest_status String representing the status of the destination addresses on the carrier. Up to 16 addresses can be represented, with the character index matching the Item ID on the ip_carrier_to_address table. The character used indicates status as follows: varchar(16) ? - No information, either an address is not defined in this position or it is not yet used. 0 - No problems reported A - Alarm raised E - Error (Disabled) D - Disabled by User from Supervisor node_status The status of the destination addresses on the carrier as set by the user from Supervisor. Again, the character index corresponds to the item id in the ip_carrier_to_address table. The values used are: space - No address present in DB manual_dest_status varchar(16) 0 - Address can be used D - Disabled by user F - Force back to running after Switch has disabled the address B - Disable from Supervisor awaiting action State F will be reset to 0 after being read by Switch. node_update datetime The date/time that Switch last reported the status of this carrier. NULL if no report. manual_update datetime Date/time that the last manual update was applied from Supervisor. NULL if no update made. 55 IP_CARRIER_TO_ADDRESS List of the destination addresses available on the carrier. Up to 16 addresses are supported. If multiple addresses are defined then Switch will rotate through them when making outbound calls on the carrier. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int Carrier ID item_id tinyint Index of the address for this carrier. Index does not indicate priority and the list is not sorted in any way, but just allows easier identification of changes. address The destination address for this item. Can be either IP address or domain (domain not allowed for H.323 carriers), with optional port. If varchar(255) the port is not supplied then the protocol default will be used (1720 for H.323, 5060 for SIP). e.g. sip.digitalk.com:5060 212.143.12.78 28 DATA DICTIONARY GATEWAY DATABASE 56 IP_INTERFACE_CARD This represents a physical IP interface card in the switch. A servicenode can have up to 4 IP Interface Cards, numbered 00 - 03. Currently the Bearer IP Address 2 and Redundancy columns are not used within Switch or Designer. COLUMN NAME DATA TYPE DESCRIPTION node_id int The machine that this card is installed on. card_id int Card number on the machine. 00 - 03. name varchar(20) The name of this card. port_0_bearer_ip_address varchar(20) The bearer IP address for port 0. port_0_subnet_mask varchar(20) The bearer subnet mask for port 0. port_0_default_gateway varchar(20) The default gateway for port 0. port_1_bearer_ip_address varchar(20) The bearer IP address for port 1. port_1_subnet_mask varchar(20) The bearer subnet mask for port 1. port_1_default_gateway varchar(20) The default gateway for port 1. rtp_port_start int The first port in the RTP port range for this card. media_type int 0 = 100BT 1 = 1000BT redundancy int Redundancy mode 0 - Redundancy 1 - ActiveStandby 57 IP_CARRIER_EMERGENCY_TRANSLATIONS Contains the details of the emergency calls number translations for ingress IP calls. This allows, for example, a user dialling "[email protected]" to be routed to 999 or the appropriate emergency number Currently applicable to SIP Carriers and Registrar Services only. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int Carrier ID from varchar(255) Dialled address to match on to varchar(32) Number to route the call out as. 58 ISUP_TRANSLATION This table holds translation options for calls egressing over ISUP SS7. It should be noted that the translation option values for ISUP are much more restricted than those for ISDN. COLUMN NAME DATA TYPE DESCRIPTION isup_translation_id int Primary key for the ISUP Translation Table int Setting for the Calling Party Presentation Indicator. 0 - Map from input 1 - Allowed 2 - Restricted 3 - Not Available calling_party_presentation 29 DATA DICTIONARY GATEWAY DATABASE calling_party_screening int Setting for the Calling Party Screening Indicator. 0 - Map from input 1 - User-Provided Not Verified 2 - User-Provided Verified Passed 3 - User-Provided Verified Failed 4 - Network-Provided calling_party_nature_of_address int Setting for the Calling Party Nature of Address 0 - Map from Input 1 - Unknown 2 - International 3 - National 5 - Subscriber Number calling_party_numbering_plan int Setting for the Calling Party Numbering Plan. 0 - Map from input 2 - ISDN 3 - Data 4 - Telex 5 - National Standard 6 - Private called_party_nature_of_address int Setting for the Called Party Nature of Address 0 - Unknown 1 - International 2 - National 3 - Network Specific 4 - Subscriber Number 6 - Map from Input called_party_numbering_plan int Setting for the Called Party Numbering Plan. 1 - ISDN 2 - Data 3 - Telex 4 - National Standard 5 - Private 6 - Map from Input int Transmission Medium setting. 0 - All Call Types 1 - Speech 64K 2 - Data 64K 3 - 3.1KHz Audio int The setting for the Satellite Indicator. 0 - Map from Input 1 - No Satellite in Circuit 2 - One Satellite in Circuit 3 - Two Satellites in Circuit int The setting for the Echo Control Device Indicator. 0 - Map from Input 1 - Not Included 2 - Included transmission_medium satellite_indicator echo_control_device_indicator 59 JOB_DEF_ALERT_FILTER Filters for the notification jobs, can be events to include or events to exclude, depending on the job settings. COLUMN NAME DATA TYPE DESCRIPTION alert_job_id int Unique identifier of alert notification trap_oid varchar(40) SNMP OID of the event to filter 30 DATA DICTIONARY GATEWAY DATABASE 60 JOB_DEF_ALERT_NOTIFIER This tables defines which operators will be sent an alert in the case of a predefined system event. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier of alert notifcation operator_group_lk_id int Unique identifier for the operator group supervisor_group_id uniqueidentifier Deprecated from 255 release. See supervisor_alert_groups table. username varchar(30) User name of the operator that created the alert notifcation request changed_date datetime Date and time of notfication request by SQL job last_alert datetime Date and time of last notifcation for the alert request category int Class of alert (System, Fault , Alarm, SNMP) sub_category int Sub category of alert snmp_filtering tinyint SNMP Event Filtering Mode. 0 - All events 1 - All excluding selected 2 - Only selected disabled bit Allows an alerting job to be temporarily disabled. description varchar(255) User-defined text describing the purpose of the alerting job. 61 JOB_DEF_ALERT_THRESHOLDS Currently this table contains a maximum of one record, for all alerting jobs. It defines the maximum number of alerts that can be sent to a single user in a specified period of time. The intention of these settings is to prevent users being flooded by alerts, particularly via SMS, in the event of a major system failure. COLUMN NAME DATA TYPE DESCRIPTION threshold_id int Primary Key for the job_def_alert_thresholds table. alert_job_id int Unique identifier of alert notification. NULL means that the threshold applies per user across all alerting jobs. This is currently expected to be NULL as there is only to be one set of thresholds, applied across all users and alerting jobs. enable_threshold bit Whether this threshold is enabled max_sms_alerts int The maximum number of SMSs that can be sent to each user within the threshold period max_email_alerts int The maximum number of emails that can be sent to each user within the threshold period time_interval The amount of time that each limit applies for. This is a rolling time period. int 62 JOB_DEF_ASR_NOTIFIER This table defines which operators will receive an alert when an ASR monitor falls below the predefined level. COLUMN NAME DATA TYPE DESCRIPTION 31 DATA DICTIONARY GATEWAY DATABASE id int Unique identifier of alert notifcation operator_group_lk_id int Unique identifier for the operator group zone_group_id int Unique identifier for the zone group username varchar(30) User name of the operator that created the ASR alert notifcation request changed_date datetime Date when ASR alert was last modified last_ran datetime Date and time of last notifcation for the ASR alert request interval int Frequency of ASR checking account_type int Defines which CDR table to monitor. Postpaid, prepaid, calling cards, agents, wholesale pullback_mins int Time span of ASR monitoring min_calls int Minimum number of call required to trigger an ASR alert notification min_asr int Minium ASR threshold for notfication type int Type of check to make: 0 - ASR 1 - ACD (Average Call Duration) 63 JOB_GATEWAY_ZONE_LIST This table relates zones to Gateway zone groups and is used by the alerting feature. COLUMN NAME DATA TYPE DESCRIPTION group_id int Unique identifier for the zone group zone_id int Holds the zone ID 64 JOB_OPERATOR_GROUP_LK This table stores the operator group definitions use by the alerting feature. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier for the operator group name varchar(30) The name of the operator group 65 JOB_OPERATOR_GROUPS This table relates operators into specific operator groups. Alerts can sent to groups of operators. COLUMN NAME DATA TYPE DESCRIPTION operator_id int Unique identifier group_lk int Unique identifier for the operator group 66 JOB_OPERATORS This table stores the personal and contact details of the operators who are to receive alerts. 32 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier type int Type of Operator 0 email 1 sms name varchar(30) Name of the operator destination varchar(50) Email address or sms number to send alert notification 67 JOB_ZONE_GROUP This table stores the zone group definitions that is used by the alerting feature. The alerting feature supports a maximum of six zone groups. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier for the zone group name varchar(30) The name of the zone group gateway bit Whether the referenced zones are in the gateway or the top-level agent partition. Old zone groups were based on agent zone names, newer ones (configured in Web Supervisor) are based on the gateway zone IDs. 68 JOB_ZONE_LIST This table relates zones to agent zone groups and is used by the alerting feature. COLUMN NAME DATA TYPE DESCRIPTION group_id int Unique identifier for the zone group zone_name varchar(50) Unique identifier for the zone list entry 69 LCR This table stores the Least Cost Routing (LCR) data for all services. COLUMN NAME DATA TYPE DESCRIPTION lcr int The LCR ID zone int Holds the zone ID tclass int Holds the time class ID retry int Force retry to next carrier if call fails percentage_routing int Enable or disable percentage routing (0=Off, 1 = On) disable_circular_routing bit Prevent the ingress carrier being used for egress. cause01 int Cause value for retry - network out of order cause02 int Cause value for retry - temporary failure cause03 int Cause value for retry - circuit unavailable 33 DATA DICTIONARY GATEWAY DATABASE cause04 int Cause value for retry - protocol error cause05 int Cause value for retry - calls barred cause06 int Cause value for retry - subscriber busy cause07 int Cause value for retry - network congestion cause08 int Cause value for retry - Out Of Order cause09 int Cause value for retry - All Other Clearing Causes cause10 int Carrier timeout setting (seconds) cause11 int Cause value for retry - Call Clearing No Answer cause12 int Cause value for retry - Unspecified Call Clearing No Ans cause13 int Cause value for retry - Unassigned/Unallocated Number route_percentage1 int Percentage Route value route_percentage2 int Percentage Route value route_percentage3 int Percentage Route value route_percentage4 int Percentage Route value route_percentage5 int Percentage Route value route_percentage6 int Percentage Route value group01 int The group ID of the carrier group02 int The group ID of the carrier group03 int The group ID of the carrier group04 int The group ID of the carrier group05 int The group ID of the carrier group06 int The group ID of the carrier oa01 varchar(160) The Originating Address to be routed to the carrier oa02 varchar(160) The Originating Address to be routed to the carrier oa03 varchar(160) The Originating Address to be routed to the carrier oa04 varchar(160) The Originating Address to be routed to the carrier oa05 varchar(160) The Originating Address to be routed to the carrier oa06 varchar(160) The Originating Address to be routed to the carrier da01 varchar(160) The Destination Address to be routed to the carrier da02 varchar(160) The Destination Address to be routed to the carrier da03 varchar(160) The Destination Address to be routed to the carrier da04 varchar(160) The Destination Address to be routed to the carrier da05 varchar(160) The Destination Address to be routed to the carrier da06 varchar(160) The Destination Address to be routed to the carrier np_method01 int Uniquely identifies this query method 34 DATA DICTIONARY GATEWAY DATABASE np_query_type01 int np_method02 int np_query_type02 int np_method03 int np_query_type03 int np_method04 int np_query_type04 int np_method05 int np_query_type05 int np_method06 int np_query_type06 int isup_translation_id_1 int ISUP Translation Settings for carrier choice 1 isup_translation_id_2 int ISUP Translation Settings for carrier choice 2 isup_translation_id_3 int ISUP Translation Settings for carrier choice 3 isup_translation_id_4 int ISUP Translation Settings for carrier choice 4 isup_translation_id_5 int ISUP Translation Settings for carrier choice 5 isup_translation_id_6 int ISUP Translation Settings for carrier choice 6 q931_translation_id_1 int ISDN Translation Settings for carrier choice 1 q931_translation_id_2 int ISDN Translation Settings for carrier choice 2 q931_translation_id_3 int ISDN Translation Settings for carrier choice 3 q931_translation_id_4 int ISDN Translation Settings for carrier choice 4 q931_translation_id_5 int ISDN Translation Settings for carrier choice 5 q931_translation_id_6 int ISDN Translation Settings for carrier choice 6 h323_translation_id_1 int H323 Translation Settings for carrier choice 1 h323_translation_id_2 int H323 Translation Settings for carrier choice 2 h323_translation_id_3 int H323 Translation Settings for carrier choice 3 h323_translation_id_4 int H323 Translation Settings for carrier choice 4 h323_translation_id_5 int H323 Translation Settings for carrier choice 5 h323_translation_id_6 int H323 Translation Settings for carrier choice 6 sip_translation_id_1 int SIP Translation Settings for carrier choice 1 sip_translation_id_2 int SIP Translation Settings for carrier choice 2 sip_translation_id_3 int SIP Translation Settings for carrier choice 3 sip_translation_id_4 int SIP Translation Settings for carrier choice 4 sip_translation_id_5 int SIP Translation Settings for carrier choice 5 sip_translation_id_6 int SIP Translation Settings for carrier choice 6 Uniquely identifies this query method Uniquely identifies this query method Uniquely identifies this query method Uniquely identifies this query method Uniquely identifies this query method 35 DATA DICTIONARY GATEWAY DATABASE use_carrier_num_trans_1 bit Whether to use carrier number translations for carrier choice 1 use_carrier_num_trans_2 bit Whether to use carrier number translations for carrier choice 2 use_carrier_num_trans_3 bit Whether to use carrier number translations for carrier choice 3 use_carrier_num_trans_4 bit Whether to use carrier number translations for carrier choice 4 use_carrier_num_trans_5 bit Whether to use carrier number translations for carrier choice 5 use_carrier_num_trans_6 bit Whether to use carrier number translations for carrier choice 6 reorder_lock bit Whether this entry is locked against automatic re-ordering cost_calculated datetime The date on which the costs for the carriers in this LCR entry were last calculated. cost_effective_date datetime The Effective Date for which the costs for the carriers in this LCR entry were last calculated. cost_call_duration int The average call duration used when the costs for the carriers in this LCR entry were last calculated. 0 means that only subsequent charges, normalised to a per-minute rate, were used. cost01 float The cost evaluated for the 1st carrier choice in the LCR entry. cost02 float The cost evaluated for the 2nd carrier choice in the LCR entry. cost03 float The cost evaluated for the 3rd carrier choice in the LCR entry. cost04 float The cost evaluated for the 4th carrier choice in the LCR entry. cost05 float The cost evaluated for the 5th carrier choice in the LCR entry. cost06 float The cost evaluated for the 6th carrier choice in the LCR entry. 70 LCR_CHOICES For each least code routing (LCR) code, lists the interconnects to be attempted and the order in which to attempt them. This table must not be modified by the end-user. COLUMN NAME DATA TYPE DESCRIPTION lcr_choice_id bigint Unique identifier of this row, no external meaning lcr_code_id bigint References lcr_codes.lcr_code_id, which is the LCR row containing this list of carriers. carrier_order tinyint Relative ordering of this carrier within the LCR row. Rows with a lower number in here will be attempted first. carrier_id int The ID of the interconnect to attempt route_percentage tinyint Defines the percentage of calls which should not use this row (overflow routing). When this row would normally be attempted, the given percentage of calls will 'overflow' to the next attempt instead. reorder_lock bit Whether this entry is locked against automatic re-ordering cost float The cost evaluated for the 1st carrier choice in the LCR entry. tinyint Status of this row as set by the user. See lcr_code_carrier_status for row status as defined by the SBC's automatic quality of service algorithms. 0 Active 3 Blocked 0 Active 3 Blocked status 36 DATA DICTIONARY GATEWAY DATABASE 71 LCR_CODE_CARRIER_STATUS Status of a specific LCR entry when QoS settings have had an effect on the routability to that particular entry. This table is maintained by the SBC and must not be modified. DATA TYPE COLUMN NAME DESCRIPTION lcr_code_carrier_status_id bigint Unique identifier of this row, with no meaning. carrier int Interconnect (netgroups_lk.id) which has been affected on lcr_code_id. lcr_code_id bigint LCR row containing the given interconnect. status tinyint 0 Active 1 Restricted 2 Suspended 3 Blocked period_expiry Time at which this status will automatically be rescinded and the carrier will go back to DateTime being active, in UTC. Rows whose period_expiry is in the past should be ignored and considered active. If status is already active then this is the time after which a subsequent failure will not be considered 'consecutive'. consecutive_failures tinyint Number of times that this lcr_code_id/carrier combination has been set inactive due to QoS failures with very little delay between them. See lcr_lk.maximum_failures. 72 LCR_CODE_CHANGES Queue to notify the SBC(s) of changes made to the lcr_codes or lcr_choices tables. This table must not be modified by the enduser. COLUMN NAME DATA TYPE DESCRIPTION sequence_id bigint Monotonically increasing sequence number of changes which have been made, to ensure modifications are read in the correct order. lcr_code_id bigint Refers to lcr_codes.lcr_code_id. If such a row does not exist then this changes row indicates a deletion. lcr_lk_id int LCR table which has been modified code_id int The number prefix contained in lcr_code_id (which may have been deleted, hence its duplication here). tclass int The timeclass contained in lcr_code_id (which may have been deleted, hence its duplication here). choice_action tinyint Specific action to take on carrier_id. If NULL then no change is to be made. If 0 then any automatic QoS action taken on the lcr_code_id/carrier_id pair should be revoked and the carrier should be reenabled. carrier_id int Interconnect on which to apply choice_action. If choice_action is NULL then this will be NULL too. enqueued_date datetime UTC time at which this row was created. Old rows are automatically deleted. 73 LCR_CODES This table stores the Least Cost Routing (LCR) data for all services. COLUMN NAME DATA TYPE DESCRIPTION 37 DATA DICTIONARY GATEWAY DATABASE lcr_code_id bigint tclass int Holds the time class ID lcr_lk_id int The LCR ID code_id int reorder_lock bit cost_calculated datetime The date on which the costs for the carriers in this LCR entry were last calculated. Whether this entry is locked against automatic re-ordering cost_effective_date datetime The Effective Date for which the costs for the carriers in this LCR entry were last calculated. cost_call_duration int The average call duration used when the costs for the carriers in this LCR entry were last calculated. 0 means that only subsequent charges, normalised to a per-minute rate, were used. 74 LCR_LK This table stores the aliases (user defined names) for each least cost routing table. COLUMN NAME DATA TYPE DESCRIPTION id int The LCR ID lcr_qos_plan_id int Refers to lcr_qos_plan, the quality of service settings to be automatically evaluated by the SBC for all calls using this LCR. name varchar(50) The name of this least cost route cost_calculated datetime The date on which the costs for the whole LCR table were last evaluated. Individual entries may have been re-evaluated more recently than this. cost_effective_date datetime The Effective Date for which the costs for the whole LCR table were last evaluated. Individual entries may have been re-evaluated with a different date to this. cost_call_duration int The call duration used when the costs for the whole LCR table were last evaluated. Individual entries may have been re-evaluated with a different duration to this. type tinyint Type of LCR, determines child tables used: 0 - lcr 1 - lcr_codes, lcr_choices, etc. 0 Designer.exe 1 VoIP Peering Manager 0 Designer.exe 1 Web Designer qos_enforcement bit Whether QoS enforcement is enabled on this LCR updated_date datetime The date that this LCR, or any of its entries, was last updated smallint Bitmask of reasons when, if a call attempt fails, the next listed carrier should be attempted. If the call did not fail for a reason set here then the call will not be retried. Is the sum of none or more of: 1: retry after ringing: any failure response after a non-100 1xx response has already been received. Not recommended except in very special cases. 2: temporary failure: 408,480,481,500,503 4: subscriber busy: 486,600 8: unassigned number: 404,485,604 16: any other failure tinyint The action to take if an LCR code fails one of the QoS criteria defined on the QoS plan for this LCR. 0 no action 1 restrict retry_cause failure_action 38 DATA DICTIONARY GATEWAY DATABASE 2 suspend 3 block restriction_percentage tinyint If failure_action is restrict, the percentage of traffic to continue to send to that code/carrier combination. Zero here is equivalent to suspending the carrier. failure_action_duration int For failure_action restrict or suspend, the duration in seconds for which to apply that action. After this interval is complete, the code/carrier combination will be returned to normal status. maximum_failures tinyint If the failure_action is applied this many times consecutively, i.e. failure_action_duration expires and then within a short amount of time the failure condition is met again, then the code/carrier combination will be blocked permanently and can only be reactivated by operator intervention. valid_statistic_threshold int The minimum number of calls which must be in the history buffer before a threshold is deemed valid . Too few calls stored will skew the averages too much to be used. If set and all LCR choices for a given LCR code are blocked (either manually or automatically) then the call will be made anyway using those blocked choices. If cleared then such a call will fail and be rejected. routing_to_blocked_carriers bit 75 LCR_QOS_CATEGORY Pre-defined rule sets for least cost routing quality of service configuration. COLUMN NAME DATA TYPE DESCRIPTION lcr_qos_category_id int Unique identifier of this row lcr_qos_plan int The QoS plan to which this row belongs name varchar(50) User-specified name of this rule set, with no effect on call processing asr float Minimum answer-seizure ratio to be met, as a percentage. If NULL then ASR enforcement is not part of this rule set. The ASR is defined as (number of calls answered)/(number of calls attempted). acd int Minimum average call duration to be met, in seconds. If NULL then ACD enforcement is not part of this rule set. ACD is defined as (sum of durations of all calls connected) / (number of calls connected) pdd int Maximum average post-dial delay to be met, in seconds. If NULL then APDD enforcement is not part of this rule set. APDD is defined as sum((time first non-100 response was received) - (time INVITE was sent)) / (number of INVITEs sent). 76 LCR_QOS_CATEGORY_ZONE Applies the pre-defined rule sets from lcr_qos_category to specific LCR zones. COLUMN NAME DATA TYPE DESCRIPTION lcr_qos_category_zone_id bigint Unique identifier of this row. lcr_qos_plan int Duplicate of lcr_qos_category.lcr_qos_plan, to make joins easier to write zone int Holds the zone ID lcr_qos_category int The rule set to apply to the given zone. 39 DATA DICTIONARY GATEWAY DATABASE 77 LCR_QOS_PLAN Basic definition of a least cost routing quality of service plan COLUMN NAME DATA TYPE DESCRIPTION lcr_qos_plan_id int Unique identifier of this row name varchar(50) User-specified name of this QoS plan created_date datetime UTC time at which this QoS plan was first created updated_date datetime UTC time at which this QoS plan was last updated 78 LCR_IMPORT_TEMPLATES COLUMN NAME DATA TYPE DESCRIPTION id int name varchar(128) definition text 79 LOCALISATION_CULTURES Stores a list of language cultures used for localisation of text in VoIP Peering Manager COLUMN NAME DATA TYPE DESCRIPTION culture_id int The unqiue id of the cullture with no external meaning culture_code varchar(10) The name of the culture 80 LOCALISATION_RESOURCES Resources used for localisation of text in VoIP Peering Manager COLUMN NAME DATA TYPE DESCRIPTION resource_id bigint Unique id of the resource. Has no external meaning type_id int The type of resource, referring to the section of VoIP Peering Manager the resource applies to. 0 Global 1 Admin 2 Rating 3 Configuration 4 Routing 5 Carrier 6 SBC 7 Reporting key_id int The key used to identify the resource. (Together with the type) culture_id int The localisation culture this resource applies to value text The localised value of the text which will be displayed in VoIP Peering Manager 40 DATA DICTIONARY GATEWAY DATABASE 81 LOG_SETTINGS This table contains both screen and disk logging atributes for all service nodes COLUMN NAME DATA TYPE DESCRIPTION machine int Machine ID num_files int Number of log files to store on disk lines_per_file int Number of lines to be stored in each log file port_mask int The list of ports to log int 0 Start 1 Call Control 2 Database 3 Routing 4 Switching 5 Protocol 6 SQL 7 Voice 8 SS7 9 Atm 10 Debug 11 Complete 12 Suspended 13 Resumed 14 Remote Start 15 Remote Stop 16 Script 17 Fax 18 Text to Speech 19 Voice Recognition 20 Conference 21 User Comment disk_event_mask int 0 Start 1 Call Control 2 Database 3 Routing 4 Switching 5 Protocol 6 SQL 7 Voice 8 SS7 9 Atm 10 Debug 11 Complete 12 Suspended 13 Resumed 14 Remote Start 15 Remote Stop 16 Script 17 Fax 18 Text to Speech 19 Voice Recognition 20 Conference 21 User Comment event_mask 82 MACH_OPTS This table stores details of all Machine (Service Node) options, which have been installed and configured. Machine Options provide a means of customising the operation of the switch on a ‘per customer’ basis. Note: Key names, descriptions and values are detailed in [gateway.cfg.doc]. This document contains confidential information. Contact Digitalk for further details. 41 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. mach_id int key_name varchar(50) The key name for this entry. Default = no entries value varchar(512) The value for this key 83 MACHINES This table stores details for the Machines (Service Nodes). COLUMN NAME DATA TYPE DESCRIPTION machine int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. routing_server_id int ID of the routing server for this node. name The name of this Machine (Service Node). varchar(20) Note: All Digitalk Platforms are shipped with the Service Nodes named DIGITALK_XXX note varchar(255) A free-form note field for this Machine (Service Node) netip varchar(20) The network IP address for this Machine (Service Node) atmip varchar(20) The IP address of the ATM adapter installed in this Machine (Service Node) dirty_data int Flag indicating that the Service Node should update its configuration. This field is monitored by the switch at 10s intervals: 0. No change in configuration 1. Change in configuration (update required) 2. Perform “warm-boot”. This is initiated via an SQL query which causes the switch to reload the stored values in the Least Cost Routing DLL. Note: A “warm-boot” provides a mechanism for re-synchronising an individual Service Node without having to restart the whole platform. use_atm int Flag indicating whether ATM is being used or not: 0. ATM not used 1 ATM used heartbeat datetime A timer signal from the server is written into this field at 30s intervals. cmd int Proprietary information (contact Digitalk for further details) arg_string varchar(50) Proprietary information (contact Digitalk for further details) arg_int int Proprietary information (contact Digitalk for further details) int Defines the type of switching node type using a bitmask based on the following values: VP = 0 ATM = 1 SS7 = 2 OC3 = 4 IP = 8 MAS = 16 type 42 DATA DICTIONARY GATEWAY DATABASE model int The type of switching node as identified by the switch software (Read-only) 1 ISUP SS7 2 IUP SS7 3 Aculab 4 Dialogic 9802 5 Dialogic 5.0.1 6 Dialogic 5.1.1 7 Dialogic cPCI 8 SS7 Server V4 9 Aculab 10 Dialogic 9802 11 Dialogic 5.1.1 12 Dialogic 5.0.1 13 NOT USED 14 Dialogic SR 6.0 FP1 15 Dialogic cPCI FP1 GA37 16 Dialogic HMP 1.3 SU61 17 Dialogic cPCI FP1 GA47 18 Dialogic HMP 1.3 SU78 19 Dialogic cPCI FP1 GA59 20 Dialogic HMP 2.0 SU116 21 Dialogic cPCI FP1 GA75 22 Dialogic HMP 2.0 SU143 23 Dialogic cPCI FP1 GA78 24 SS7 Server 2416 25 Dialogic HMP 3.0 SU152 26 Dialogic cPCI 6.1 SU156 27 Dialogic HMP 3.0 SU174 disabled int Used to take a sevice node in or out of service. ip_core_a_ip_address varchar(20) IP Core IP Address (Port A) ip_core_a_default_gateway varchar(20) IP Core Default Gateway (Port A) ip_core_a_subnet_mask varchar(20) IP Core Subnet Mask (Port A) ip_core_b_ip_address varchar(20) IP Core IP Address (Port A) ip_core_b_default_gateway varchar(20) IP Core Default Gateway (Port A) ip_core_b_subnet_mask varchar(20) IP Core Subnet Mask (Port A) ip_access bit Whether IP Access is configured on the service node or not ip_bearer_channels int The number of IP media channels configured on this node. sip_port int IP port used for SIP signalling. Default 5060. h323_port int IP port used for H.323 signalling. Default 1720. rtp_port_start int Start of RTP port range. Default 16000. use_sip_outbound_proxy bit Whether to use a proxy for outbound SIP. If false, SIP Outbound Proxy IP Address should be null. sip_outbound_proxy_ip_address varchar(20) If Use SIP Outbound Proxy selected, this should contain its IP Address. sip_outbound_proxy_port int The SIP port on the outbound proxy server. use_h323_gatekeeper bit Whether to use an H.323 gatekeeper. use_default_multicast_address bit Whether to use the default multicast address instead of a particular H.323 gatekeeper. h323_gatekeeper_ip_address varchar(20) The IP address of the H.323 gatekeeper, if selected. h323_gatekeeper_port int The H.323 port of the gatekeeper, if one is being used. 43 DATA DICTIONARY GATEWAY DATABASE h323_gatekeeper_max_hops int The maximum number of hops to the gatekeeper h323_gatekeeper_time_to_live int Time to Live for the gatekeeper h323_gatekeeper_service_id int Service ID for the gatekeeper use_ingress_h425_tunnelling bit Whether to use ingress H.245 tunnelling ip_access_signalling_address varchar(20) The signalling IP address for SIP and H.323 on the node ip_splitmedia bit Whether to run in 3PCC mode (Third Party Call Control) ip_signalling_channels int The number of signalling channels configured on the node. version varchar(50) To be populated with the current running version of Switch in future releases. 84 MEMBERSHIP_GROUP_MEMBERS Table holding information of users in membership groups COLUMN NAME DATA TYPE DESCRIPTION group_id int The unique identifier for the group user_id int The unique identifier for the membership Id's 1-99 are reserved for Digitalk's internal use. 85 MEMBERSHIP_GROUPS Holds data for membership groups COLUMN NAME DATA TYPE DESCRIPTION group_id int The unique identifier for the group name varchar(50) The name of the group description varchar(250) A description for the group is_active bit A flag to indicate the current state of the group 86 MEMBERSHIP_PROFILE Profile details for Web Supervisor users. COLUMN NAME DATA TYPE DESCRIPTION profile_id int user_id int profile_name varchar(50) profile_value varchar(800) profile_value_type int 0 Int32 1 String 2 DateTime 3 Boolean 4 Double 44 DATA DICTIONARY GATEWAY DATABASE 87 MEMBERSHIPS Table for holding operator security details COLUMN NAME DATA TYPE DESCRIPTION user_id int The unique identifier for the membership Id's 1-99 are reserved for Digitalk's internal use. role_id int The unique id of the role Id's 1-99 are reserved for Digitalk's internal use. username varchar(80) The name of the membership user last_activity_date datetime The date and time of last activity by this user password_hash nvarchar(128) Encoded password of the user password_format int password_salt nvarchar(128) Randomly generated value used to salt password hashes password_question varchar(150) The password question for validating user without password password_answer_hash nvarchar(128) The password question answer for validating user without password is_active bit Flag indicating current status of user is_locked_out bit Flag indicating whether user is locked out from the application create_date datetime Date user was created last_login_date datetime Date and time of user's last login last_password_change_date datetime Date and time user's password was last changed last_locked_date datetime Date and time the user was last locked out failed_password_attempt_count int Number of consecutive failed password attempts failed_password_attempt_window_start datetime Date and time of first failed login if failed_password_attempt_count is nonzero failed_password_answer_attempt_count int Number of consecutive failed password answer attempts Format used for storing password failed_password_answer_attempt_window_start datetime Date and time of first failed password answer if failed_password_answer_attempt_count is nonzero name varchar(80) The friendly name of the user email varchar(255) sms_number varchar(128) alert_mode tinyint alert_type int comment ntext 88 NETGROUP_AUDIT Stores transaction records for every credit or debit request on a carrier's balance for the billed leased line service. 45 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION id int Primary key of this record, used for indexing only. account int carrier varchar(50) The name of the carrier the credit change was applied adt_date datetime The date and time when the credit was modified, in UTC. amount decimal(13,6) The amount by which the credit was changed. Positive values are credit requests, negative values are debit requests. balance decimal(13,6) The new carrier balance immediately after this credit request was executed. reason varchar(255) User-supplied reason that the credit was changed. username varchar(80) The database login username which applied this change. 89 NETGROUPS This table stores the carrier groups used by the platform. COLUMN NAME DATA TYPE DESCRIPTION id int The group ID mach_id int The unique service node ID (as defined in the MACHINES table) netport_id int The network card ID's associated with this group The unique machine ID (as defined in the NETPORTS table) config char(35) Holds the channels mask for this network port e.g. '1' = enabled. The data is presented in a commaseparated text string. hunting_order int Defines the weighting for the hunting stratergy 90 NETGROUPS_LK This table stores the aliases (user defined names) for the carrier groups. COLUMN NAME DATA TYPE DESCRIPTION id int The group ID a_tariff int Holds the table ID b_tariff int The old-style egress rate for calls made to this carrier. Only an egress tariff or a carrier rate plan can be selected on each carrier at once, not both. disabled int Allows a carrier group to be enabled or disabled. hunting int The hunting strategy defined for the outbound trunk group 0. Lowest available 1. Highest available 2. Random 3. Follow Input name varchar(50) The name of this group 46 DATA DICTIONARY GATEWAY DATABASE type int 0 - TDM Carrier 1 - IP Carrier default_isup_translation_id int The default ISUP translation settings for the carrier default_q931_translation_id int The default Q.931 translation settings for the carrier default_sip_translation_id The default SIP translation settings for the carrier int default_h323_translation_id int The default H.323 translation settings for the carrier. default_egress_oa varchar(1024) The default originating address for egress calls to this carrier. Can be overridden on the route or LCR. default_egress_da varchar(1024) The default destination address for calls to this carrier egress_rate_plan_id int carrier_group_id int relationship_type int The rate plan in use on this carrier. Only a carrier rate plan or an old-style egress tariff can be selected on each carrier at once, not both. 0 Customer 1 Supplier 2 Bilateral 91 NETPORTS This table stores a list of the entire network ports installed in the platform. DATA TYPE DESCRIPTION machine int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. net int The network port ID name varchar(50) The name of the network port note varchar(50) A note field for this network port COLUMN NAME The configuration of the network channels on this port. The data is presented in a 32 character, comma-separated text string: I Inbound O Outbound B Bi-directional 0 Disabled config char(32) tones_in The network tones to be applied on the incoming call to this port. The data is presented in a comma-separated text string: varchar(30) 0 UK Dial Tone 1 EC Dial Tone 2 UK Ring Tone 3 EC Ring Tone tones_out The network tones to be applied on the outgoing call from this port. The data is presented in a comma-separated text string: 0 UK Busy varchar(30) 1 EC Busy 2 UK Unobtainable 3 EC Unobtainable 4 Call Failure 47 DATA DICTIONARY GATEWAY DATABASE type int 0. ISDN (E1) 1. ISDN (T1) 2. Ss7 (E1) 3. Ss7 (T1) ss7_server_id int Defines which SS7 signalling node provides the signalling for the port. cic_offset int Defines the CIC offset routeset int disabled int Used to take a network port in or out of service. ssp_id int - No Longer Used - clear_channel_support bit Used by SS7 to indicate if TS16 (or TS24 on T1) can be used on a H110 link protocol_mode int ISDN Protocol Mode for this Netport 0 - Use Node Default 1 - User Mode 2 - Network Mode int ISDN Line Type for this Netport. 0 - Use Node Default 1 - D4 Framing Type - Extended Superframe (T1 ports only) 2 - Extended Superframe (T1 ports only) 3 - E1 Standard Framing (E1 ports only) 4 - E1 Standard Framing and CRC-4 (E1 ports only) coding_type int ISDN Coding Type for this Netport. 0 - Use Node Default 1 - AMI, Alternate Mark Inversion 2 - B8ZS, Modified AMI for T1 only 3 - HDB3, High Density Bipolar of Order 3, for E1 only protocol ISDN Protocol name for this Netport. Set to NULL or blank to use node default. Values for E1 ports include: '4ESS' 'NI2' '5ESS' 'DMS' 'NTT' 'NET5' varchar(10) 'QSIG' 'DASS2' 'DPNSS' Values for T1 ports include: '4ESS' 'NI2' '5ESS' 'DMS' 'NTT' 'NET5' 'QSIG' line_type 92 NETROUTES This table stores a list of the entire network routes and is used to define the service to be applied to an incoming call. COLUMN NAME DATA TYPE DESCRIPTION id int Primary Key for Netroutes name varchar(50) The network route name 48 DATA DICTIONARY GATEWAY DATABASE int The application type (Service) associated with this route 0 Routing 1 Accounts 2 Leased Line Routing 3 Calling Cards 4 International Callback 5 1xxx Accounts 6 Recharge Accounts 7 User Scripts 8 Announcements 9 Voice Prompt Recorder 10 Two Stage Leased Line Routing 11 Voicemail 12 Billed Leased Line 13 Premium Rate 14 Billed Number Translation 15 Null Application 16 Network Access 17 SAC User Scripts 18 SAC Network Access 19 Broadband Telephony 20 BBT via Proxy 21 BBT User DDI 22 Service Numbers User Scripts 23 IPVO via Proxy 24 IPVO User DDI 25 Resolve From Agent 26 SIP Trunking via Proxy 27 SIP Trunking User DDI 28 SBC VoIP Peering ibearer int The incoming service type: 0 All Call Types 1 Speech 64k 2 Data 64k 3 3.1kHz Audio ida varchar(50) The incoming destination address inoa int The incoming nature of address ioa varchar(50) The incoming originating address igroup int The group ID tclass int Holds the time class ID lcr int The LCR ID ogroup int The group ID oda varchar(1024) The outgoing destination address ooa varchar(1024) The outgoing originating address opts varchar(200) Defines advanced options q931_translation_id int The ISDN Translation options for this route. isup_translation_id int The ISUP Translation options for this route. sip_translation_id int The SIP Translation options for this route. h323_translation_id int The H.323 Translation options for this route. application use_carrier_number_translations bit Whether to use the number translation options from the carrier instead of those defined on the route. emergency_lcr The LCR to be used for emergency calls. Note that this is only applicable when int 49 DATA DICTIONARY GATEWAY DATABASE the route is not already using an LCR. bll_b_tariff int allow_transcoding bit allow_numport bit When zero, the SBC VoIP Peering number portability plans will never be consulted for calls taking this route. 93 NICMGR_ADDRESS_MAPPINGS Joins the nicmgr_addresses table to the nicmgr_interfaces table, i.e. provides the specific IP addresses which should be bound to each NIC on each machine. The nicmgr will behave differently depending on whether a given IP address is listed once or more than once in this table. An address listed once is static: it will be added to the machine by the nicmgr and removed only when the computer is shut down. An address listed more than once is 'floating': each nicmgr which controls an interface on which that address is listed will collaborate with the other nicmgrs to ensure that at most one of them owns the given address at any one time. They will coordinate with each other to ensure that each address is in the best place it can be for the overall functioning of the platform. COLUMN NAME DATA DESCRIPTION TYPE interface int Network interface on which to mount this IP address address int The IP address to mount priority Determines the relative importance of the mapping of this address to the given interface, when compared tinyint with other interfaces on which this address may be mounted. This is only used as a absolute last resort to choose between equivalently suitable machines and should generally be left as the default. persistent bit If set to 1, the nicmgr will remove not this address when it exits. This only applies to static addresses (those with only one row in this table) and is used to tell the nicmgr that it does not own the address. Typically this is used when an IP address has been manually provisioned in Windows but must still be given to the nicmgr. You do not want the manual provisioning to be removed when shutting down the computer, so this flag should be set to 1. 94 NICMGR_ADDRESSES All public and private IP addresses which are to be provisioned for communications outside of the SBC. The internal SBC nodeto-node communication addresses should not be listed here, however the SBC-to-MAS addresses should. Note that adding a row to this table does not, by itself, allow the address to be used - one or more rows must also be added to the nicmgr_address_mappings table in order to specify the machine on which to mount the address or the machines amongst which it will float. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier of this address. Note that this ID is passed around internally among applications, therefore a given ID must always refer to a given IP address: do not combine an addition and removal of an IP address into an update of an existing one, rather a new row should be created and the old one deleted. network int Subnet containing this IP address, which defines which other IP addresses it is able to communicate with. address varchar(50) The actual IP address to use. This must be contained within the subnet defined by the network column. gang int Groups this IP address with others so that if this address has to be moved to a different machine then all others with the same gang also move. Without ganging of addresses then if one address was forced to move the others might not necessarily go with it. In the SBC, for example, if the link from SBC A to the MASes failed then that IP address would flip over but all the external IPs linking to carriers would not also go, because they still work. Ganging allows us to specify that all these 50 DATA DICTIONARY GATEWAY DATABASE addresses should go as one, in a kind of all-or-nothing arrangement. A gang of zero is always different to any other Address (even others in gang zero). Ganging only applies to floating addresses (i.e. those with more than one row in nicmgr_address_mappings). gang_score int Relative importance of this address among others in the same gang. If, for example, we have three networks: A, B and C. Assume A is usable on both the active and standby, B is only on the active, and C is only on the standby. If 90% of the customer base is on network C then clearly we should failover. The gang score expresses this condition, so in the example above you can set A=5, B=5, C=90 and the nicmgr will realise that it really wants to use the standby because 5+90 > 5+5. current_owner int Machine which currently has ownership of this IP address. This may be NULL if no machine on the network owns this address. cluster int Cluster to which this address is currently assigned, if any. The MAS internal address must not be assigned to any cluster. internal_ip For advanced routing. If not empty, then this IP address is different inside the network to how it is varchar(50) seen outside the network. This is typically accomplished using a large-scale NATting router, owned and managed by the customer. If empty then this IP address uses simple routing. internal_netmask varchar(50) For advanced routing. The netmask to go with internal_ip, which controls the local routing tables and when the gateway is used. gateway varchar(50) For advanced routing. The gateway used to access IP addresses which are outside the subnet defined by internal_ip/internal_netmask. metric int The efficiency of using this IP address to route traffic. Higher numbers are considered more costly, and make the SBC less inclined to use this IP address when it has a choice. 95 NICMGR_DISCOVERED_INTERFACES Filled in by the nicmgr when it probes the machine in order to supply to Designer a list of possible network interfaces which can be configured. Typically, configuration of a given interface consists of copying its details from this table into the nicmgr_interfaces table. This table should not be altered by the user, since any changes will be overwritten. COLUMN NAME DATA TYPE DESCRIPTION id int Indicates the result of the nicmgr's matching of the physical interfaces it discovers with those configured in the nicmgr_interfaces table. If a discovered interface corresponds to a configured interface then that relation is reported here, otherwise this column is NULL. machine int The machine on which this interface was discovered mac binary(6) MAC (physical) address of the network interface discovered device_name varchar(255) Name of the network adapter providing this interface, as listed in Control Panel, Network Connections, View|Detail, Device Name column. name up varchar(255) Name of the network interface as it is shown in Control Panel, Network Connections. Note that these icons can be renamed by the user so this should not be considered to be a unique identifier. bit Current connectivity status of this interface: 0: The network cable appears to be disconnected. 1: Everything looks OK. NULL: The nicmgr is not running on this machine, so any status report would be out-of-date. 96 NICMGR_INTERFACES Physical network interfaces on the given machine. Typically there is a one-to-one correspondence between plugs in the back of the machine and rows in this table, however teamed adapters create only one row here for two (or more) ports in the back, and VLAN pseudo-interfaces can be used to create up to 4094 interfaces (and hence rows in this table) out of only one port. 51 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier for this row machine int Computer on which this network interface can be found binary(6) MAC (physical) address of this interface. This is used as a unique identifier to allow the nicmgr to match the configuration specified in this table with the actual interfaces it finds on the machine. If the MAC address alone is not enough to uniquely identify a specific interface (typically due to VLANs) then the device_name column can be used to narrow it down mac Name of the network card holding this interface, which is used as a tie-breaker if the MAC address is not unique. If this column is left blank then it is assumed that the MAC address is unique and device device_name varchar(255) names will not be checked. If it is not blank then it must match the device name of the network adapter to use (which can be seen in Control Panel, Network Connections, View|Detail, Device Name column). This column supports the * and ? wildcards to request less-specific matches. name varchar(255) User-defined name to assign to this interface. When the nicmgr starts and locates this interface, it will rename the given adapter in Control Panel to this name. 97 NICMGR_MACHINES All machines which run the NIC Manager application. A row in this table must be provisioned before the application can be started on a machine. Note that running just a nicmgr on a machine is not generally useful: there will typically be one or more other applications running on the same machine, which are specified by other rows in other tables. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier of this machine. address char(15) IP address used for internal communication between NIC Managers. This is the only address which must be manually provisioned on the machine (i.e. is not listed in the nicmgr_addresses table) and serves the dual purpose of enabling each nicmgr to find its own row in this table on startup (since it knows its own provisioned IP address) and telling other nicmgrs how to reach this one. required_clients Comma-separated list of the names of other applications which must be running on this varchar(255) machine before the nicmgr will consider itself useful. If, for example, the SBC application exits then the nicmgr must realize that this is an important event and relinquish any floating IP addresses so that another nicmgr can take them. name NetBIOS name of the computer. This column is populated by the nicmgr when it first starts and varchar(63) should not be changed manually. It is used by the configuration tool to provide information to the user and has no effect on the correct functioning of the platform. maintenance_mode bit When set, this machine will be put into a semi-functional mode where it is replicating clustered state and generally participating in the cluster, but will never be considered as the potential active server. If this flag is set when the machine is currently active then a failover will immediately happen. 98 NICMGR_NETWORK_INTERFACES Used to associate networks to network interfaces for ease of provisioning the nicmgr_address_mappings table in Designer. Each network can only be assigned to one interface per machine, but each interface can have multiple networks. COLUMN NAME network DATA DESCRIPTION TYPE int Unique identifier of this network. This primary key is used by multiple applications to negotiate between themselves, so it should always remain consistent: if a new network is created and an old network is dismantled do not update an existing row, rather a new row should be created and the old one deleted so that each the id always has a specific meaning. 52 DATA DICTIONARY GATEWAY DATABASE machine int Computer on which this network interface can be found interface int Unique identifier for this row 99 NICMGR_NETWORKS Generalised descriptions of each network to which the whole platform is connected. A network is a global concept which is used to negotiate between machines to determine whether communication is possible between two given IP addresses, i.e. whether there is a physical cable joining the two machines. COLUMN NAME DATA TYPE DESCRIPTION id int name varchar(255) Arbitrary user-defined name of this network. This has no effect on the functioning of the platform. address varchar(50) Base address of the subnet defined by this row. Should be read in conjunction with the netmask column to define the range of IP addresses encompassed by this network netmask varchar(50) Mask portion of the subnet encompassed by this network. See also the address column. gateway Default gateway which will be added to the system routing tables of any machines on which varchar(50) IP addresses on this network are added. If this is NULL then no default gateway will be provisioned and hence it is assumed that all addresses are locally routable. ping_address IP address to ping to ensure that this network is functional. The SBC can determine whether its own internal connections are functional, however it cannot natively tell whether the outside world is reachable. The NIC Manager component will regularly ping this IP address to varchar(50) check that the non-Digitalk components of the network are functioning. This address must be locally routable and must respond to ICMP pings and ARP requests. If this column is NULL then no external device will be checked and it will be assumed that the network is always functional. It is recommended that this column be set to the same value as the gateway. ping_freq int local_address varchar(50) Base address of the local subnet defined by this row. Should be read in conjunction with the local_netmask column to define the range of IP addresses encompassed by the local subnet local_netmask varchar(50) Mask portion of the local subnet. See also the local_address column. Unique identifier of this network. This primary key is used by multiple applications to negotiate between themselves, so it should always remain consistent: if a new network is created and an old network is dismantled do not update an existing row, rather a new row should be created and the old one deleted so that each the id always has a specific meaning. Interval, in seconds, at which to check the the machine specified in ping_address is alive. If this column is zero then pinging is disabled (equivalent to setting ping_address=NULL) IP address from which to send the ARP requests described in ping_address. The ICMP echo requests are always sent from the locally-mounted IP address but ARPs may be sent from the node which is currently standby and hence does not have any mounted IP addresses. If this is ping_source_address varchar(50) NULL then no ARP pings will be sent, only the local indication of link layer status will be used. Setting this to 0.0.0.0 is best, however some gateways and firewall devices will refuse to respond if the IP address is not within the correct subnet. If this is set to a valid IP address, it must be an address reseved specifically for this purpose and not used by any other device on the network. subnet_base When not NULL, this row is an alternate exit point onto a parent network (represented by the referenced row). The address and netmask columns are ignored. int 100 NP_OP_CODES Holds the list of op codes for number portability. COLUMN NAME DATA TYPE DESCRIPTION 53 DATA DICTIONARY GATEWAY DATABASE op_code varchar(6) originating_netgroup_lk int The group ID netgroup_lk The group ID int 101 NP_QUERY_METHODS The number portability query methods table. A network group is created for each ported number and a NP action is applied. If a network group match is found for a ported number then the associated action is applied by the switch. COLUMN NAME DATA TYPE DESCRIPTION id int name varchar(30) A friendly name, used for display purposes only sp_sql varchar(256) The stored procedure that is executed when the assigned network group matches. clearing_reason varchar(6) Uniquely identifies this query method The clearing reason applied to the terminated call 102 PAYPHONE This table holds a list of CLI’s which originate from payphones. COLUMN NAME DATA TYPE DESCRIPTION cli varchar(30) CLI of payphone 103 PROXY_BILLING_SESSIONS Records the charging status of every call which is currently in progress and being billed by an SBC. This table is maintained by the SBC and must not be modified by the user. For performance reasons, this table has no foreign keys. COLUMN NAME DATA TYPE DESCRIPTION id bigint Unique identifier of this billing job, used by the SBC to keep track of it. cluster_id int ID of the SBC which is running this billing job, as in sbc_clusters.id update_sequence int Monotonically increasing counter of the number of operations performed in this billing job. This counter is used to prevent possible double-billing which can happen during an SBC failover if the replication from the old node hadn't quite completed at the time the failure occurred. account int The account from which money is being deducted in this billing job. This is an index into netgroups_lk.id. last_reserved The amount of money which was deducted from the account at the last billing cycle. The SBC will regularly update this table during each billing session by deducting a little bit more money decimal(13,6) from the account each time. Upon a total loss of power to the whole platform, this column can be used to calculate the minimum and maximum possible amount of money that the call might have cost at the time it was interrupted. balance_reserved decimal(13,6) Amount of money so far deducted from the account in order to pay for this call. This will be regularly updated during the call to deduct a bit more money each time. start_balance decimal(13,6) The amount of credit in the carrier's account at the start of the call, used for populating bll_cdr.start_bal when the call completes. last_update datetime Time (in UTC data server time) at which the last billing cycle was run on this call. 54 DATA DICTIONARY GATEWAY DATABASE sbc_id bigint Unique identifier for the session that the SBC is using to run this call. This number can be entered in the SBC's management web site in order to retrieve a complete pcap log of the call thus far. 104 PROXY_BLOCK_OUTPUTS Joins individual blocks into a directed acyclic graph defining the order in which the SBC will perform specific processing actions on each SIP message. This table should not be altered except under the direction of Digitalk support, and even then only with the use of the live software upgrade tool. COLUMN NAME DATA TYPE DESCRIPTION block int The block whose output is being defined. The NULL entry defines which is to be the first block to be called for every request. output_node int Specific index of the output which should be connected up. The number of outputs and conditions under which each output is used are defined by the block itself. dest int Block which should be executed next. revision int Defines the version of the block graph in which this link belongs 105 PROXY_BLOCKS Individual functional processing units to be run on the cluster for the processing of SIP traffic. This table should not be altered except under the direction of Digitalk support, and even then only with the use of the live software upgrade tool. COLUMN DATA TYPE DESCRIPTION NAME id int Unique identifier for this block cluster int Obsolete: use proxy_graph_revisions.cluster instead block Description of the job to execute. This takes the form [modulename:]blockname[(parameters)]. If 'modulename' is omitted then it is assumed that the block is built-in to the SBC executable, otherwise it varchar(255) must be the name of a DLL on the search path. If 'parameters' is omitted then it is equivalent to an empty string; parameters are specific to the block. The blockname defines the specific piece of code to execute. 106 PROXY_CLUSTERS Groups of individual SBC machines which all collaborate to provide the same service. Multiple nodes in the same cluster are, by definition, running with the same configuration settings. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier for this cluster mas_addr int Mounted IP address which will be used by this SBC cluster for all communication to/from Digitalk application servers. current_graph int The revision of the processing graph (and hence the versions of software components) to use for new sessions which are created on the SBC. Existing sessions will continue to use the revision which was current at the time they were created. 55 DATA DICTIONARY GATEWAY DATABASE 107 PROXY_DNS_CONFIG Allows SIP DNS servers and search suffixes to be configured through Designer rather than having to be done locally on the node(s). Configurable on a per-cluster basis. A maximum of 5 items of each type can be configured per-cluster. COLUMN NAME DATA TYPE DESCRIPTION cluster int SBC cluster to which to apply this setting type int 0 - IP address of a DNS server to use for lookups 1 - DNS search suffix to use for lookups priority int Relative significance of this entry. Lower numbers are used first. value varchar(256) Data to apply, as determined by type 108 PROXY_FAILED_CDRS Stores any Call Data Records which could not be written to the database by the SBC. There are two main reasons why it might not be possible for an SBC to write a CDR: loss of network connectivity between the SBC and data server, and a misconfiguration resulting in a schema mismatch between the SBC and database. In the first case, the SBC will store the CDR temporarily on its local hard disk and regularly re-attempt the write. In the second case the write will not be retried (it's unlikely that it would ever succeed) and so a representation of the CDR will be added to this table, where it becomes the operator's responsibility to review the SQL statement, fix any problems with it and run it. COLUMN NAME DATA TYPE DESCRIPTION id int Primary key of this row, with no external meaning. writetime datetime Time (UTC on the data server) at which this row was created. This is likely to be significantly later than the time that the call ended. server varchar(64) Hostname of the data server to which the CDR would have been written. If the CDR was going to be written into the database containing this table then this will be the empty string. db varchar(128) Name of the database to which the CDR would have been written. If the CDR was going to be written into the database containing this table then this will be the empty string. query varchar(7829) A representation of the CDR query string which could not be executed. This is different to the actual query which was attempted because it is not parametric, however it should have the same effect. 109 PROXY_FORK_CONDITIONS Specifically for 'fork' blocks, defines the conditions under which each output nodes it used. A fork block has two output nodes: 0 and 1. For a specific fork block each condition is conceptually executed in turn; if all conditions evaluate to true then output node 1 is taken, otherwise output node 0 is taken. The blockgraphtool can be used to edit fork conditions in a slightly easier to use interface than editing raw SQL. COLUMN NAME DATA TYPE DESCRIPTION block int item The part of the message to extract, i.e. the left hand side of the comparison operator. This may be the name of a SIP header, or a pseudo-header, all of which start with a colon: :method The SIP method from the request. varchar(63) :random Generates a random floating-point number from 0 to 1 and then compares it with the value column, to allow a uniformly-distributed weighted random number of packets to be forked one way or the other. :uri The entire request-URI from the SIP request. :uri-scheme Just the scheme part of :uri (often 'sip' or 'sips'). Defines the fork which is being configured here. 56 DATA DICTIONARY GATEWAY DATABASE :uri-user Just the user part of :uri (the bit after the colon but before the @). :uri-domain Just the domain part of :uri (the bit after the @ but before the port or parameters). :source-network-id The nicmgr network ID (nicmgr_networks) from which this request was received. :source-addr-id The nicmgr local IP address ID (nicmgr_addresses) on which this request was received. :target-network-id The nicmgr network ID to which this request will be sent. This may be 0 if it hasn't been decided yet. :target-addr-id The nicmgr local IP address ID (nicmgr_addresses) on which this request will be sent. This may be 0 if it hasn't been decided yet. :source-address The remote IP address from which this request was received. :source-port The remote port number from which this request was received. :target-address The remote IP address to which this request will be sent. This may be undefined if it hasn't been decided yet. :target-port The remote port number to which this request will be sent. This may be zero if it hasn't been decided yet. :true This condition is always true - effectively the row is ignored :false This condition is always false, which means that the entire fork is false and output node 0 will be taken. Operator used to compare 'item' with 'value'. Some of the pseudo-header items ignore this operator. 0: String equality 1: String glob (supports * and ? wildcards in the value column) 2: Integer equality 3: Signed integer less-than 4: Signed integer less-than-or-equal 5: Subnet containment (i.e. the 'item' is contained in the subnet 'value', which may be specified in CIDR or address/mask format). Attempting to use this operator on items which are not IP addresses may have surprising results. All string comparisons are case-insensitive. Attempting to do an integer comparison on a header which is really a string will result in the parameters being coerced into integers, which usually means they both equal zero. Any value in this column can have 128 added to it in order to negate the condition, i.e. because 4 is less-than-or-equal then 132 is greater-than. condition tinyint value varchar(255) Specific value with which to compare the item, i.e. the right-hand side of the comparison condition. and_group int Permits specification of AND versus OR grouping of conditions. Within a block, conditions with the same and_group are evaluated as if they were AND conditions then the results of the separate groups are combined using OR. For example, given five rows a,b,c,d,e with values of and_group of 0,1,1,1,2 respectively, this expands to a OR (b AND c AND d) OR e. 110 PROXY_GRAPH_REVISIONS Uniquely identifies a version of the processing graph that the SBC will use to handle SIP traffic. Once created, a revision and all its dependent tables are immutable. This table is managed by the live software upgrade tool. COLUMN DATA TYPE NAME DESCRIPTION id int Unique identifier for this revision enabled bit If 1 then this revision and its code will be loaded by the SBC nodes. If sessions are still using a revision which is disabled then they will continue to use it but those sessions will fail if the SBC needs to failover. cluster int SBC to which this revision belongs created smalldatetime Date and time at which this revision was created. This is for informational purposes only. last_used Date and time at which this revision was last enabled. If the revision is currently enabled then this column is ignored. This is used to determine when revisions have not been used for long enough that smalldatetime they can be deleted. Note that this does not refer to the last time that an SBC session used this revision. comment varchar(255) Arbitrary user-supplied notes to describe this revision (typically the version number of the components involved or the reason why the change was made). filter varchar(255) Expression specifying the conditions under which this revision should be used for new requests. The 57 DATA DICTIONARY GATEWAY DATABASE revision specified by proxy_clusters.current_graph is used by default, but any other revision for which enabled=1 can be given a filter which specifies that some specific set of requests should use that revision instead. It is a semicolon-separated list of conditions in the form "keyword[=expression]". Supported keywords are: - subnet: expression is a subnet mask in CIDR form specifying the source IP address of the packet, e.g. subnet=192.168.8.0/24 - log: not a filter, but rather specifies that requests using this revision should log at the greatest possible detail. Does not take an expression, e.g. log type varchar(64) Type of functionality that this revision represents, as a keyword used to confirm that new software revisions are functionally similar to old ones. 111 PROXY_H323_GATEKEEPER_ALIAS Table listing the aliases to be provided for the H.323 gatekeeper for the cluster (if H.323 gatekeeper used). COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. alias_id int The position of the alias in the gatekeeper alias list. alias varchar(255) An alias used by this gatekeeper. 112 PROXY_H323_GATEKEEPER_SETTINGS Table listing any extra values to be added to the registration requests sent from the SBC to register with the gatekeeper associated with the given H.323 carrier. This is used in Designer to provision the calling prefixes, but it can be used for any value in the RRQ ASN.1. COLUMN NAME DATA TYPE DESCRIPTION id int Arbitrary unique index of this row, to allow for editing. Not used as part of the network interaction with the gatekeeper. The unique carrier ID to which these settings will apply. If the carrier is not an H.323 carrier with a border control IP address and a gatekeeper then this row will be ignored. netgroups_lk_id int path ASN.1 path of the setting to apply, rooted at the RegistrationRequest (RRQ) sequence and using the dot (.) character as a path separator. Items in subarrays may either be specified with explicit varchar(255) indices or with the index '0' to mean the next available item. In this notation, the path for setting gatekeeper prefixes is 'terminalType.gateway.protocol.1.voice.supportedPrefixes.0.prefix.e164' value varchar(255) Value to place in the ASN.1 node specified by the path column. 113 PROXY_IP_CARRIER_STATUS Holds the status of the carrier on each SBC cluster. This is used by the SBC to report the state to Supervisor, and by Supervisor to apply manual changes to the SBC. The table is not populated by Designer, but by the SBC as it reports the status. COLUMN NAME DATA TYPE netgroups_lk_id int DESCRIPTION 58 DATA DICTIONARY GATEWAY DATABASE cluster_id int cluster_status manual_status char The current status of the carrier on the node, as reported by the SBC: ? - Unknown 0 - Enabled A - Alarm Raised E - (Error) Disabled (only if disabled by SBC, manual blocks are not reported) D - Disabled by User from Supervisor char Whether the carrier has been manually disabled by a user from Supervisor. 0 - Enabled D - Disabled F - Force Enabled (re-enables the carrier after it has been disabled automatically by the SBC) B - Disable Pending (disables the carrier when it is enabled) String representing the status of the destination addresses on the carrier. Up to 16 addresses can be represented, with the character index matching the Item ID on the ip_carrier_to_address table. The character used indicates status as follows: cluster_dest_status varchar(16) ? - No information, either an address is not defined in this position or it is not yet used. 0 - No problems reported A - Alarm raised E - Error (Disabled) D - Disabled by User from Supervisor The status of the destination addresses on the carrier as set by the user from Supervisor. Again, the character index corresponds to the item id in the ip_carrier_to_address table. The values used are: space - No address present in DB manual_dest_status varchar(16) 0 - Address can be used D - Disabled by user F - Force back to running after the SBC has disabled the address B - Disable from Supervisor awaiting action State F will be reset to 0 after being read by Switch. cluster_update datetime The date/time that the SBC last reported the status of this carrier. NULL if no report. manual_update datetime Date/time that the last manual update was applied from Supervisor. NULL if no update made. 114 PROXY_LOG_LEVELS Defines the amount of logging which will be output by the SBC. Internally the SBC is divided up into operational subunits, each of which is identified by a four character code; these codes are printed in the log files (4th column). This table can be used to control the level of logging written on a per-component basis. COLUMN NAME DATA TYPE DESCRIPTION component char(4) Identifier of the component for which to set the logging level. The empty component name ('') is special: it sets the level for all components which do not have their own row in this table. int Sets the logging level to output. The levels are: 0: debug: All logging. Note that platform performance will be impaired and log files will be difficult to read if many components are set to this level. 1: info: Informational messages and tracking of platform status. There will be no logging written on a per-call basis at this level. This is the default level if there are no rows in this table. 2: warning: Concerns which may turn into problems in the future, and possible misconfigurations. 3: error: Definite problems which should be investigated. 4: critical: The application cannot continue to run. level 115 PROXY_NODES Individual machines which collaborate to form an SBC cluster dealing with SIP traffic. Each machine should be considered to be identical and equally capable of performing its job. 59 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION id tinyint Unique identifier for this machine. cluster int Groups the individual nodes into a single overall functional unit. address IP address used for internal cluster replication between the nodes. Typically this is the same IP address as is used for communication between nicmgrs. Note that this network will take a lot of varchar(50) traffic on a busy platform, so it should be high-speed and low-latency with very low packet loss rates. port smallint TCP port which is used for initial negotiation between the nodes. The cluster will use TCP on this port when it starts up and to locate the other nodes, then it will switch to UDP on a range of ports. This column should not be changed from the default unless multiple nodes are being run on a single machine. Arbitrary status text which is set by the SBC and can be read by Designer and/or Supervisor. The SBC status_report varchar(256) uses it to report information about the cluster's high-availability system, for example active/standby and standby refill status. 116 PROXY_NP_CHOICES SBC VoIP Peering number portability routing egress carrier selection. This table is analogous to lcr_choices - a row from proxy_np_codes is found and used to select an ordered set of rows from this table, which describe the egress interconnects to attempt and the order in which to attempt them. If one interconnect fails then the decision about whether to continue trying is based on proxy_np_plans.retry_cause. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier of this row, with no external meaning. np_codes_id int Value of proxy_np_codes.id for this set of egress interconnect selections. carrier_order tinyint Relative ordering of the rows with the same np_codes_id, describing the order in which the carriers will be attempted. The specific values in this column are not important, only their order relative to each other. Lower numbers will be attempted first. netgroup int Egress interconnect to which to send calls when this choice is attempted. oda Transformation string of the egressing DDI (To user), used if oda_type=2. This is a normal Digitalk match/replace string, with the addition of the following special tokens which may appear in the varchar(1024) replacement portion(s): \o Substitute the proxy_np_numbers.operator_code string \s Substitute the proxy_np_numbers.service_code string \e Substitute the proxy_np_numbers.exchange_code string oda_type tinyint alt_buy_rate bit enabled Where to get the transformation string to apply to the DDI when egressing calls using this row. 0 Use carrier setting 1 Use NP plan setting 2 Use oda If set, use the alternative number specified in the matching proxy_np_rating.rating_code column for calculating the carrier tariffing (supplier rating) rate for calls which egress via this row. See also proxy_np_rating.alt_sell_rate. bit 117 PROXY_NP_CODES SBC VoIP Peering number portability routing table. This table is analogous to lcr_codes - the row with the operator_code matching proxy_np_numbers.operator_code and (optionally) the matching ingress carrier is used to select the egress carriers which will be attempted. 60 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier of this row, with no external meaning. np_plans_id int Number portability plan which must match for this row to be used. operator_code varchar(126) Operator code from proxy_np_numbers.operator_code which must match for this row to be used. Ingress interconnect which must match for this row to be used. This can be NULL, in which case this row will match any ingress interconnect. If there are rows with the same operator_code and both NULL and non-NULL netgroups then the SBC will look for an exactly-matching netgroup first and, if none is found, will default to the row with the NULL netgroup. netgroup int name varchar(50) User-specified name of this row, with no effect on call processing. 118 PROXY_NP_NUMBERS SBC VoIP Peering ported numbers. DDIs found in this table will take a different route through the SBC, as defined by the number portability plan. Note that this table will only be search if the number also matches an entry in proxy_np_prefixes. COLUMN NAME DATA TYPE DESCRIPTION ddi varchar(126) Dialed number to match. The full number must match exactly. operator_code varchar(126) Arbitrary identifier of the route to be taken by calls to this DDI. service_code varchar(126) Arbitrary ancilliary data to be associated with this DDI. exchange_code varchar(126) Arbitrary ancilliary data to be associated with this DDI. 119 PROXY_NP_PLANS SBC VoIP Peering number portability plans, providing the root of the configuration of number portability settings. Typically there is one number portability plan per country. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier of these number portability settings, with no external meaning. name varchar(50) Arbitrary user-specified name of this plan; placed in vp_cdr.lcr_name if this plan is used for a particular call. enabled bit Activates or deactivates this plan. A disabled number portability plan will never match any outgoing calls. oda varchar(1024) Default DDI transformation string used when proxy_np_choices.oda_type=0 for rows using this number portability plan. retry_cause smallint Bitmask of reasons when the next proxy_np_choices row should be used if the first call attempt failed. Uses the same values as lcr_lk.retry_cause. created_date datetime The date and time of creation for this plan 120 PROXY_NP_PREFIXES SBC VoIP Peering number portability DDI prefixes to match in order to use a given number portability plan. The longest matching prefix will select a number portability plan and the whole number will then be further analyzed using the proxy_np_numbers table. A number not matching any prefix will not be subject to number portability. 61 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION prefix varchar(126) DDI prefix to match. np_plans_id int Number portability plan to use if a call is sent with this prefix. 121 PROXY_NP_RATING SBC VoIP Peering number portability configuration to specify alternative billing that should be used when a ported number is encountered. If a number has been ported from provider A to provider B then, although that number appears to be within provider A's block, it may be desirable to rate it as if it belonged to provider B (because that's where the call will ultimately be sent). This table configures the settings controlling that transformation. If no row is found here then the call will be rated using its actual number (i.e. the one that appears to be sending to provider A). COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier of this row, with no external meaning. np_plans_id int References the number portability plan to which these settings relate. operator_code varchar(126) Identifier returned from the proxy_np_numbers.operator_code value when the information in this row should be used. prefix varchar(126) Additional DDI prefix to match for when this row is to be used. np_plans_id and operator_code must match, and then the row with the longest matching dialled number prefix will be taken. name varchar(50) User-specified name for this row, with no purpose for call processing. rating_code Dialled address to use for buy and sell rating. If this row matches then it can be rated as if the varchar(126) dialled address was actually the one listed here, rather than the one dialled. This value will be used for sell rating if alt_sell_rate is set. This value will be used for buy rating if proxy_np_choices.alt_buy_rate is set. If neither flag is set then this value is unused. alt_sell_rate bit 122 PROXY_SSL_CERTS Stores all the certificates and keys required by TLS/SSL transports for SIP in the SBC. The contents of this table must be guarded carefully because it may contain extremely security-sensitive data which, if leaked, would allow arbitrary machines to impersonate your server. COLUMN NAME DATA TYPE DESCRIPTION id int Unique identifier for this certificate. name varchar(64) Arbitrary user-specified description of this certificate. This has no effect on the functioning of the platform. type tinyint Type of certificate specified in cert: 0: Private key. There must be exactly one of these per transport. 1: Certificate. There must be exactly one of these per transport and it must correspond to the private key. 2: Trusted certificate authority. There may be any number of these, including zero. 3: Chained certificate. There may be any number of these, including zero. For definitions of the various terms involved in configuring TLS, see Google. cert image The complete contents of this certification. This must be stored in binary form rather than the (slightly more common) base64-encoded form. 62 DATA DICTIONARY GATEWAY DATABASE 123 PROXY_TRANSPORT_SSL_CERTS Assigns SSL certificates to TLS ports listening on the SBC. In order to function, each TLS port required one certificate and one private key. It may have any number of trusted CAs or chained certificates. COLUMN NAME DATA TYPE DESCRIPTION transport_id int The IP address being configured. cert_id int Key into the table which actually contains the certificate itself. 124 PROXY_TRANSPORTS Defines the SIP behaviour of a specific IP address. The nicmgr only knows about IP addresses; this table tells the SBC what sort of SIP traffic to run on each address. If an address is listed in nicmgr_addresses but not in this table then no ports will be opened for SIP traffic on that address. COLUMN NAME DATA TYPE DESCRIPTION addr int The IP address being configured. udp_port smallint UDP port to open for SIP traffic. If this is NULL then UDP will not be used on this address. Typically port 5060 is used for UDP SIP. tcp_port smallint TCP port to open for SIP traffic. If this is NULL then TCP will not be used on this address. Typically port 5060 is used for TCP SIP. tls_port TLS port to open for SIP traffic. If this is NULL then TLS will not be used on this address. smallint Typically port 5061 is used for TLS SIP. Note that TLS requires more configuration in order to function than UDP or plain TCP. tos tinyint Value to place in the IP ToS byte on all outgoing SIP packets sent from this address. tinyint Type of TLS to use on this IP address/port: 0: SSL v2 1: SSL v3 2: TLS v1 tls_method dos_decrease_per_second real For denial of service detection, the maximum rate at which events can be received from a single remote IP address to this local IP address. If events are received at a consistently higher rate than this then a DoS will be flagged. See the documentation for the DoS detector for a description of events. dos_threshold real For denial of service detection, the point at which a DoS will be flagged from a remote IP address. A larger value here will permit short bursts of traffic as long as the average rate is within the value defined by dos_decrease_per_second. h323_port smallint When populated, H.323 is enabled on the address by the SBC. There can be only one H.323 enabled address per SBC. 125 Q931_TRANSLATION This table holds translation options for calls egressing over ISDN COLUMN NAME DATA TYPE DESCRIPTION q931_translation_id int Primary key for the Q.931 Translation table calling_party_presentation int Setting for the Calling Party Presentation Indicator. 0 - Map from input 63 DATA DICTIONARY GATEWAY DATABASE 1 - Allowed 2 - Restricted 3 - Not Available calling_party_screening int Setting for the Calling Party Screening Indicator. 0 - Map from input 1 - User-Provided Not Screened 2 - User-Provided Verified Passed 3 - User-Provided Verified Failed 4 - Network-Provided calling_party_numbering_type int Setting for the Calling Party Numbering Type 0 - Map from input 1 - Unknown 2 - International 3 - National 4 - Network-Specific 5 - Subscriber Number 6 - Abbreviated Number calling_party_numbering_plan int Setting for the Calling Party Numbering Plan. 0 - Map from input 1 - Unknown 2 - ISDN 3 - Data 4 - Telex 5 - National Standard 6 - Private called_party_numbering_type int Setting for the Called Party Numbering Type. 0 - Unknown 1 - International 2 - National 3 - Network-Specific 4 - Subscriber Number 5 - Abbreviated Number 6 - Map from Input called_party_numbering_plan int Setting for the Called Party Numbering Plan. 0 - Unknown 1 - ISDN 2 - Data 3 - Telex 4 - National Standard 5 - Private 6 - Map from Input bearer_type int iup_presentation_as_oa bit Whether to use the IUP Presentation Address as the Originating Address. This will only apply to calls ingressing from IUP SS7, and only if the Presentation Address is present. 126 QUEUED_ALERTS This table stores a queued list of alerts waiting to be sent by sms or email COLUMN NAME DATA TYPE DESCRIPTION id int Unique Identifier writetime datetime The date and time the alert was queued cat int Source table for the queued alert 0 - Fault Log 1 - System Log 64 DATA DICTIONARY GATEWAY DATABASE 2 - Alarm Log 3 - SNMP Trap Log Subcategory of the queued alert Fault Log: 0 - Low 1 - Medium 2 - High System Log: 0 - Start 1 - Medium 2 - Low Alarm Log: 0 - Green 1 - Blue 2 - Amber 3 - Red SNMP Trap Log: 0 - Unknown Severity 1 - Cleared 2 - Information 3 - Warning 4 - Minor 5 - Major 6 - Critical subcat int note varchar(255) The message to be sent trap_oid varchar(40) For events from the snmp_trap_log, will contain the trap oid. 127 RATE_IMPORT_ITEMS This table stores the tariff sheets for rate imports COLUMN NAME DATA TYPE DESCRIPTION rate_import_item_id bigint The unique identifier for the rate import item. No external meaning task_id int The bulk data task for this rate import first_chg float The first charge that occurs at the first time interval first_time float The first time interval init_chg float The number of units charged when the incoming call is answered min_chg float The minimum charge that is applied to the card/account notes varchar(50) Can be used to hold miscellaneous information about the tariff opts varchar(200) $ command (dollar command) options that can be applied to this tariff. sub_chg float The unit charge that occurs at every subsequent time interval sub_time float The subsequent time interval between unit charges tclass int The time class associated with the tariff zone int Holds the zone ID effective_date datetime margin float Minimum percentage between buy and sell rates for calls to be allowed. Given the sell rate defined by this row, and a buy rate defined by the egress carrier being attempted, it is required that buy.sub_chg/buy.sub_time > sell.sub_chg/sell.sub_time * (sell.margin/100+1). This column is used only if bleg_lk.margin_enabled is set. 65 DATA DICTIONARY GATEWAY DATABASE end_date datetime is_blocked bit For SBC VoIP Peering, if a call would used this row then reject the call rather than falling back to the next shorter code and looking for another row. 128 RATING_CODES This table stores the mappings from dial prefix to zone for carrier egress rate plans. The table should be clustered sorted by prefix descending, rather than ascending. COLUMN NAME DATA TYPE DESCRIPTION rate_plan_id int The carrier rate plan to which this code-zone mapping belongs. prefix varchar(40) Holds the dialling prefix for the zone and plan. zone int Holds the zone ID 129 RATING_ZONES This table stores a list of all carrier zones supported by carrier rate plans. These zones are only used for carrier tariffing, and not routing. COLUMN NAME DATA TYPE DESCRIPTION rate_plan_id int Unique ID for the carrier rate plan to which this zone belongs zone int Holds the zone ID name varchar(50) Holds the name of the zone effective_date datetime The UTC date/time on which this zone becomes valid. A dialling prefix can belong to multiple zones on the rate sheet, but not at the same effective date. end_date The UTC date/time at which this zone will cease to be defined on the rate plan, having been replaced by a new zone. Typically this will be because the carrier has changed the prefixes assigned to a particular zone, or added a new break-out. datetime 130 REGISTRAR_SERVICE A registrar service is a type of IP Carrier that is identified by the SIP realm. This table holds the registrar-service-specific information about the carrier. COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int Carrier ID ingress_netroute_id int Primary Key for Netroutes egress_netroute_id int Primary Key for Netroutes realm varchar(64) The main SIP realm for this service validate_transport_address bit Whether to validate the transport address against the list of from addresses for the carrier allow_additional_auth_realms bit Whether to allow additional authentication realms. Allowed realms are stored in the registrar_service_properties table. 66 DATA DICTIONARY GATEWAY DATABASE restrict_user_agents bit Whether to restrict the user agents that can register. Allowed User Agents are stored in the registrar_service_properties table. reinvite bit Whether to allow Switch to initiate re-INVITE on this carrier privacy tinyint 0 - RFC3261 (Anonymous) 1 - Remote-Party-ID 2 - RFC3325 (P-Asserted-Identity) require_prack bit Whether PRACK is required on this carrier hairpin_media bit Whether to hairpin media on this carrier media_bypass bit Whether to allow media to bypass the MAS require_authentication bit Whether authentication is required for INVITE and REGISTER requests require_registration bit Whether a user must have successfully registered before making a call even_out_registrations bit Whether a random amount of time should be subtracted from the reregistration period in order to spread the registration load even_out_limit tinyint Maximum percentage by which to even out re-registrations when even out is enabled min_registration_time int Minimum number of seconds for re-registration max_registration_time int Maximum number of seconds for re-registration default_registration_time int Default number of seconds for re-registration strict_request_line_checking bit Whether to enforce strict request line checking realm_transformation bit Whether to enable realm transformation (i.e. mapping another realm to this one) realm_to_transform varchar(64) Another realm that can be transformed into this one nat_rport bit Enables NAT detection based on the presence of 'rport' in the Via header nat_source_not_last_via bit Enables NAT detection based on whether the source address is different to the last Via header bit Enables NAT detection based on whether the last Via address is within the private range: 10.0.0.0 to 10.255.255.255 172.16.0.0 to 172.31.255.255 192.168.0.0 to 192.168.255.255 bit Enables NAT detection based on whether the Contact address is within the private range: 10.0.0.0 to 10.255.255.255 172.16.0.0 to 172.31.255.255 192.168.0.0 to 192.168.255.255 nat_sdp_private bit Enables NAT detection based on whether the SDP address is within the private range: 10.0.0.0 to 10.255.255.255 172.16.0.0 to 172.31.255.255 192.168.0.0 to 192.168.255.255 nat_p_behind_nat bit Enables NAT detection based on the presence of the P-Behind-NAT SIP header. nat_pinhole_keep_alive_method tinyint Method to keep NAT pinhole alive: nat_pinhole_keep_alive_period int How often to send a keep-alive. registration_timer_factor int This factor alters the amount of time registrations remains in SBC, allowing 'lazy' UAs a chance to re-register. It is effectively a database optimization nat_last_via_private nat_contact_private 67 DATA DICTIONARY GATEWAY DATABASE in that fewer registrations will be deleted that would otherwise need to be re-inserted shortly thereafter. auth_type tinyint This column specifies whether URIs should be authenticated against account users, or calling cards, or both. Shared = 0 (accounts and cards) Accounts = 1 (accounts only) Cards = 2 (calling cards only) add_reason_header bit Whether to add a Reason header to BYE and CANCEL messages allow_session_expiry bit Whether to allow Session Expiry min_session_expiry int Minimum value for session expiry (seconds) max_session_expiry int Maximum value for session expiry (seconds) session_refresh_preference tinyint The preferred direction in which session timers should be refreshed: 0 - Don't Care (default) 1 - Local 2 - Remote session_refresh_method tinyint The SIP method to use for refreshing session timers: 0 - reINVITE (default) 1 - UPDATE session_refresh_without_remote_support bit Whether to refresh the Session even when the remote party doesn't support it. session_refresh_without_preference bit Whether to refresh the Session when the remote party doesn't express a preference for the direction of refresh. session_terminate_on_timer_expiry bit Whether calls should be terminated on session timer expiry. add_user_equals_phone bit Whether to insert 'user=phone' into the Request-URI and To: address for egress calls to this registrar service. allow_sip_trunking bit Whether SIP Trunking functionality is enabled on this Registrar Service diversion_header_type int Type of diversion header to use for egress. 0 - History-Info 1 - CC-Diversion 2 - Diversion transit_diversion bit Whether to transit existing Diversion headers from ingress to egress. add_cpc_tag bit Whether the CPC Tag should be added. media_bypass_invite_sdp_type tinyint Type of media offer used in SDP when Media Bypass is enabled: 0 - Remote (Default) - Always offer remote media 1 - Remote If Carrier Codec Match - Offer remote media if codecs match (as provisioned on carrier) 2 - Local - Offer local media and examine SDP response local_media_reattempt bit Whether to reattempt SDP offer when media_bypass_invite_sdp_type is not set to "Local". Default is not to. strict_codec_check bit Whether the codec matching should be strict when media_bypass_invite_sdp_type is not set to "Remote". Default is not strict. 131 REGISTRAR_SERVICE_PROPERTIES Contains various advanced properties for the registrar service. COLUMN NAME DATA TYPE DESCRIPTION id int Primary key 68 DATA DICTIONARY GATEWAY DATABASE netgroups_lk_id int Carrier ID type tinyint Property Type: 0 - Unknown 1 - Allowed Authorisation Realm 2 - Allowed User Agent value varchar(255) Value 132 ROAMING_RATE_SHEET_ITEMS Individual rates on a Roaming Rate Sheet COLUMN NAME DATA TYPE DESCRIPTION roaming_rate_sheet_item_id int Rate Sheet Item ID roaming_rate_sheet_id int Rate Sheet ID tclass int Timeclass that this rate applies to from_zone_id int Roaming Zone from which the call was made (0 for all zones, compulsory for inbound calls) to_zone_id int Roaming Zone to which the call was made (0 for all zones) opts varchar(200) Advanced options notes varchar(100) Notes init_chg float Initial Charge first_chg float First Charge first_time float First Period sub_chg float Subsequent Charge sub_time float Subsequent Period min_chg float Minimum Charge 133 ROAMING_RATE_SHEETS Definition of rate sheets used for Roaming calls (inbound and outbound). COLUMN NAME DATA TYPE roaming_rate_sheet_id int name context DESCRIPTION The Rate Sheet ID varchar(50) The name of the rate tinyint Determines whether any alternative interpretation should be put on the rate items within this rate sheet, and whether it should be filtered accordingly. 0 - None (default) 1 - Voice 2 - SMS 3 - MMS 69 DATA DICTIONARY GATEWAY DATABASE 134 ROAMING_ZONE_CODES Mapping from prefixes to Roaming Zones. The Roaming Zone will be determined by the prefix on the location number. The table should be clustered by prefix descending. COLUMN NAME DATA TYPE DESCRIPTION roaming_zone_code_id int Primary Key for Roaming Zone Codes roaming_zone_id int The Roaming Zone to which this Code is mapped prefix varchar(30) The VLR or MSC Address prefix to map max_digits tinyint name varchar(50) The name of this code The number length that this code applies to 135 ROAMING_ZONES Roaming Zones COLUMN NAME DATA TYPE DESCRIPTION roaming_zone_id int name The Roaming Zone ID varchar(50) Name of the Roaming Zone. 136 ROUTESET ** No Longer Used ** (Replaced by high density ss7 tables) This table stores configuration information about the SS7 linkset. It does not store STP interworking configuration settings. COLUMN NAME DATA TYPE DESCRIPTION machine int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. routeset int Unique ID of the routeset name varchar(50) Name of the routeset opc varchar(50) Originating point code dpc varchar(50) Destination point code crc varchar(50) Used to switch Cyclical redundancy check on and off protocol int stp0_name varchar(50) Name of STP 0 stp0_dpc varchar(50) Adjacent destination point code of STP 0 stp1_name varchar(50) Name of STP 1 stp1_dpc varchar(50) Adjacent destination point code of STP 1 is_stp int Specifies the signalling protocol Is the routeset connect to an SSP or STP 70 DATA DICTIONARY GATEWAY DATABASE 137 ROUTESET_SSP ** No Longer Used ** (Replaced by high density ss7 tables) This table stores the linkset configuration for STP interworking. COLUMN NAME DATA TYPE DESCRIPTION routeset_ssp_id int Unique ID of the far end STP machine int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. routeset int ID of the routeset name varchar(50) Name of routeset dpc varchar(50) Far end Destination point code 138 ROUTING_SERVERS Contains the list of routing servers that are available on the platform. COLUMN NAME DATA TYPE DESCRIPTION id int Primary key for the Routing Servers. name varchar(20) Name of the routing server ip_address varchar(50) IP address of the routing server port int Port used by the routing server for communication with platform nodes. 139 RPT_CONTROL_TYPES This table contains a list of the available reporting parameter entry control types. COLUMN NAME DATA TYPE DESCRIPTION control_type varchar(30) Control type control_type_id int Control type identifier 140 RPT_DYNAMIC_PARAMETERS This table contains a list of the reporting parameter input control types. The table holds the input control type (control_type_id) and its population stored procedure. COLUMN NAME DATA TYPE parameter_id DESCRIPTION uniqueidentifier Parameter identifier control_type_id int Control type identifier label varchar(30) Text used for the label when displaying the related control on the report input selection GUI. population_sql varchar(255) The SQL used to build a resultset used to populate the drop down list control 71 DATA DICTIONARY GATEWAY DATABASE 141 RPT_FIXED_PARAMETERS This table contains a list of all of the fixed values used as parameters to reports. The parameter values are fixed and are not linked to control types. COLUMN NAME DATA TYPE DESCRIPTION parameter_id uniqueidentifier Parameter identifier value varchar(50) Holds the value to be used for the parameter 142 RPT_GROUP_REPORTS This table contains the mapping of reports to groups. COLUMN NAME DATA TYPE DESCRIPTION group_id uniqueidentifier Group identifier report_id uniqueidentifier Unique report identifier 143 RPT_GROUPS This table contains a list of the report groups. A report group is used to get a collection of child reports. COLUMN NAME DATA TYPE DESCRIPTION display_order int Determines the order in which the groups are displayed in the reporting GUI group_id uniqueidentifier Group identifier name varchar(50) Name of the group 144 RPT_PARAMETERS This table contains the mapping of parameters to reports. The table also contains the display text for the parameter control. COLUMN NAME DATA TYPE DESCRIPTION parameter_id uniqueidentifier Parameter identifier description varchar(255) Description of parameter name varchar(255) Name of the parameter. This is used when building the query to generate report data. 145 RPT_REPORT_PARAMETERS This table contains mapping of parameters to reports. COLUMN NAME DATA TYPE parameter_id uniqueidentifier Parameter identifier report_id uniqueidentifier Unique report identifier display_description bit DESCRIPTION Determines whether the parameter description is displayed in the reporting UI. 72 DATA DICTIONARY GATEWAY DATABASE display_order int Used to determines the order in which the reports are displayed in the reporting GUI 146 RPT_REPORTS This table contains a list of all reports. The table holds the report description, the name and the stored procedure used to generate the report results. COLUMN NAME DATA TYPE DESCRIPTION report_id uniqueidentifier Unique report identifier description varchar(255) Description of the report. Used in the reporting GUI name varchar(50) Name of the report. Used in the reporting GUI prompt varchar(255) Prompt used in the reporting GUI style_id uniqueidentifier Style identifier stored_proc varchar(255) Name of the stored procedure used to generate the data for the report last_run_user_id int The unique identifier for the membership Id's 1-99 are reserved for Digitalk's internal use. last_run_date datetime UTC Date Time the report was last run If enabled, the user will be offered the option to report directly to file rather than the report UI allow_direct_export bit 147 RPT_STYLE_ITEM_VALUES This table contains a list of values for the style items. COLUMN NAME DATA TYPE DESCRIPTION style_item_id int Style Item identifier style_id uniqueidentifier Style identifier value varchar(50) Value to be used for the given style item 148 RPT_STYLE_ITEMS This table contains a list of style items for a specific style COLUMN NAME DATA TYPE DESCRIPTION name varchar(50) Name of the style item enumerator style_item_id int Style Item identifier 149 RPT_STYLES This table contains a list of styles. COLUMN NAME DATA TYPE style_id DESCRIPTION uniqueidentifier Style identifier 73 DATA DICTIONARY GATEWAY DATABASE name varchar(50) Style name 150 RTPPROXY_ADDRESSES Configures the per-IP address settings which will be applied to each network to which an RTP proxy is connected. Each proxy must be assigned IP addresses in the nicmgr tables for each network to which it is connected, and also have a row in this table providing the RTP-specific configuration to be applied to that address. COLUMN NAME DATA TYPE DESCRIPTION addr_id int Unique identifier of this address. Note that this ID is passed around internally among applications, therefore a given ID must always refer to a given IP address: do not combine an addition and removal of an IP address into an update of an existing one, rather a new row should be created and the old one deleted. rtp_tos tinyint IP ToS byte to put in all outgoing RTP packets sent over this network from this RTP proxy. rtcp_tos tinyint IP ToS byte to put in all outgoing RTCP packets sent over this network from this RTP proxy. 151 RTPPROXY_CLUSTERS Defines the settings for a standalone or clustered media proxy. If standalone, then there will only be one child rtpproxy_node record. COLUMN NAME DATA TYPE DESCRIPTION id int Unique ID for the cluster enabled bit Activate or deactivate this RTP proxy's ability to process calls. If a machine is disabled it will not be available for processing any new calls, but existing calls will run to completion. max_capacity int Maximum number of calls which this machine is capable of processing. This is defined by the CPU speed, network speed and other performance characteristics of the machine. Range of UDP port numbers which may be used for RTP relay. This range must contain at least four rtp_port_range varchar(63) times the max_capacity. It may be specified as a comma-separated list of ranges, e.g. 20003000,8000-9000. Note that a single call requires four consecutive ports aligned to a multiple of four, so small entries such as 8001-8006 will not actually be used because they do not meet these criteria. port smallint TCP port on which this RTP proxy cluster is to listen for commands. password Password needed to authenticate the SBC SIP nodes when they are connecting to this RTP proxy. varchar(63) While this basic security does add an extra layer of protection, deployments should still ensure that all TCP traffic going to RTP proxy machines is blocked at the firewall. 152 RTPPROXY_NODES Defines the settings for each machine which can act as an RTP (media) proxy within the SBC. Every machine involved in the SBC run a nicmgr, and hence have a row in the nicmgr_machines table, but only those which are RTP proxies must have a row here. COLUMN NAME DATA TYPE DESCRIPTION id tinyint Unique identifier for this RTP proxy. It is possible, but not recommended, to run more than one RTP proxy on a single machine. cluster int The cluster to which this node belongs address varchar(50) IP address used for internal cluster replication between the nodes. Typically this is the same IP address as is used for communication between nicmgrs. Note that this network will take a lot of 74 DATA DICTIONARY GATEWAY DATABASE traffic on a busy platform, so it should be high-speed and low-latency with very low packet loss rates. port smallint TCP port which is used for initial negotiation between the nodes. The cluster will use TCP on this port when it starts up and to locate the other nodes, then it will switch to UDP on a range of ports. This column should not be changed from the default unless multiple nodes are being run on a single machine. Arbitrary status text which is set by the RTP Proxy and can be read by Designer and/or Supervisor. status_report varchar(255) The RTP Proxy uses it to report information about the cluster's high-availability system, for example active/standby and standby refill status. 153 SBC_CLUSTER_NODE_BACKUPS Specifies the nodes to which replicated copies of each session running on a given machine are sent. In a typical two-node active/standby configuration this table will contain simply 1->2 and 2->1, however in more complex multi-node clusters this table allows the configuration of ring, star, web, or just about any other topology desired. COLUMN NAME DATA TYPE cluster int source tinyint Node on which the master copy of a session is being processed. dest tinyint Node to which a full backup copy of the entire state of every session running on the source node should be sent. DESCRIPTION 154 SBC_CLUSTER_NODES Defines the nodes in an SBC cluster. COLUMN NAME DATA TYPE DESCRIPTION cluster int Unique ID for the cluster node_id tinyint Unique ID for this node within the cluster nicmgr_id int Unique identifier of this machine. 155 SBC_CLUSTERS Defines the top-level record for clustered and potentially-clustered nodes. COLUMN NAME DATA TYPE DESCRIPTION id int Unique ID for the cluster name varchar(50) Unique name for the cluster. Has no effect on the operation of the cluster or any node within it. activate_changes datetime The time of the last Activate Changes request on the platform. Applied to all SBCs when issued from Designer. 156 SBC_OPTS General global configuration settings applying to all machines and all applications involved in the operation of the SBC. 75 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION cluster int Unique ID for the cluster name varchar(64) Identifier of the option to set. See the separate document listing the available options value varchar(1024) Value to assign to this option. The possible values for a given row are defined by the name column. 157 SECURITY_ROLE_PROFILES Holds specific profile for security roles COLUMN NAME DATA TYPE DESCRIPTION role_id int The unique id of the role Id's 1-99 are reserved for Digitalk's internal use. type_id int The type of permission for the roles profile permission int The permission assigned to the security role value int The state of the permission assigned to the security role 158 SECURITY_ROLES Holds data about operator roles COLUMN NAME DATA TYPE DESCRIPTION The unique id of the role Id's 1-99 are reserved for Digitalk's internal use. role_id int name varchar(50) The name of the role description varchar(250) A description of the role 159 SIP_PROXY_SERVERS SIP Proxy Servers COLUMN NAME DATA TYPE DESCRIPTION server_id int Unique ID for the SIP Proxy Servers table. net_name varchar(30) Network name of the proxy server. mode varchar(12) 'accounts' or 'cards', indicating the mode of operation of the server. local_net_ip varchar(20) IP address used for local communication by the server. public_net_ip varchar(20) IP address used for external/public communication by the server. last_init datetime Time the server was last initialised. last_heartbeat datetime Time the server last sent a heartbeat message. 76 DATA DICTIONARY GATEWAY DATABASE 160 SIP_TRANSLATION This table holds translation options for calls egressing over SIP COLUMN NAME DATA TYPE DESCRIPTION sip_translation_id int Primary key for the SIP Translation table. int Setting for the Calling Party Presentation Indicator. 0 - Map from input 1 - Allowed 2 - Restricted 3 - Not Available int Setting for the Calling Party Screening Indicator. 0 - Map from input 1 - User-Provided Not Verified 2 - User-Provided Verified Passed 3 - User-Provided Verified Failed 4 - Network-Provided calling_party_presentation calling_party_screening calling_party_numbering_type tinyint Setting for the Calling Party Numbering Type 0 - Map from input 1 - Unknown 2 - International 3 - National 4 - Network-Specific 5 - Subscriber Number 6 - Abbreviated Number calling_party_numbering_plan tinyint Setting for the Calling Party Numbering Plan. 0 - Map from input 1 - Unknown 2 - ISDN 3 - Data 4 - Telex 5 - National Standard 6 - Private called_party_numbering_type tinyint Setting for the Called Party Numbering Type. 0 - Unknown 1 - International 2 - National 3 - Network-Specific 4 - Subscriber Number 5 - Abbreviated Number 6 - Map from Input called_party_numbering_plan tinyint Setting for the Called Party Numbering Plan. 0 - Unknown 1 - ISDN 2 - Data 3 - Telex 4 - National Standard 5 - Private 6 - Map from Input 161 SNMP_MANAGER_EXCLUDED_OIDS This table contains a list of the OIDs that are not to be sent to each registered SNMP Manager. This means that events that are not supported by the current version of Supervisor will always be sent if they meet the specified minimum severity. COLUMN NAME DATA TYPE DESCRIPTION 77 DATA DICTIONARY GATEWAY DATABASE manager_id int Primary Key for the SNMP Managers table oid varchar(40) The oid for the SNMP trap that should not be reported to this SNMP manager 162 SNMP_MANAGERS Contains the details of the SNMP managers available on the platform. COLUMN NAME DATA TYPE DESCRIPTION id int Primary Key for the SNMP Managers table name varchar(20) Name of the SNMP manager hostname varchar(64) Hostname or IP Address of the SNMP manager port int community varchar(50) Community of the SNMP Manager trap_protocol int Trap protocol of the SNMP Manager: 0 - v2c trap 1 - v2c inform min_severity tinyint Events with a severity less than this will not be sent. The default is to send events of all severities. 0: All Events 1: Cleared or Higher 2: Info or Higher 3: Warning or Higher 4: Minor, Major or Critical Events 5: Major or Critical Events 6: Critical Events only disabled bit Whether the SNMP Manager is disabled. If disabled, events should not be sent. last_update datetime Last time this manager was modified in Supervisor. Switch uses this to determine when to refresh the excluded OID list. Port used by the SNMP manager 163 SNMP_TRAP_LOG Contains a history of SNMP Trap events that have been logged to the database. COLUMN NAME DATA TYPE DESCRIPTION id int Primary key for the SNMP Trap Log table writetime datetime The time at which the event was written to the database. mach_id int Machine on which the event occurred. This can refer to an entry in the machines, sip_proxy_servers, nicmgr_machines, or other tables depending on the source application. port_id int Port on which the event occurred, if available. This can be an entry in netports, or a "virtual" IP netport. timeslot tinyint The timeslot on which the SNMP event occurred, if available. trap_oid varchar(40) The ID of the SNMP Trap that raised the event. severity tinyint The severity of the event, 0: Unknown - The severity cannot be determined 1: Cleared - A previously-reported error has been corrected and service is restored. 2: Info - Informational message. No action required. 78 DATA DICTIONARY GATEWAY DATABASE 3: Warning - Action may be required, or an important condition occurred which should be logged. 4: Minor - Part of a device has stopped functioning. The device needs attention. 5: Major - A device is completely down or in danger of going down. Attention needs to be paid to this problem immediately. 6: Critical - Numerous devices are affected. Everyone should stop what they are doing and focus on this problem. message varchar(500) Textual description of the SNMP event source_app tinyint The DIGITALK application that was the source of the event 1 - General 2 - Switch 3 - SS7 4 - OC3 5 - DtLogSrv 6 - Web Server 7 - SIP Proxy Server 8 - Huntd open bit Whether the event has been (manually) set as closed. Should be set to 1 when row inserted. status tinyint Status of this alert, set from Supervisor: 0 - Open Initial State 1 - Cleared (Automatically) Alarm cleared by AlarmAutoClear SP 2 - Cleared (Manually) Alarm cleared manually by operator ack varchar(5) Whether the event has been acknowledged by a user in Supervisor. comment varchar(100) User comments can be applied from Supervisor after the alert has been raised. alert_id int Application-specified value, used to link traps together. For example, an alert can be raised with major severity, tagged with an alert ID, then when the alert condition has ended a cleared severity alert is raised and the record for the major alert can be marked as auto-closed. This is all handled by the AddSnmpTrapLog SP. 164 SS7_CARD COLUMN NAME DATA TYPE DESCRIPTION slot_id int node_id int 165 SS7_CONFIG_ITEMS This table holds the individual configuration items for an SS7 config pack. Can have one MPAC config and up to two each (primary and secondary) of MTP, IUP and ISUP. COLUMN NAME DATA TYPE DESCRIPTION ss7_config_item_id int config_pack_id int name varchar(30) executable varchar(255) MPAC, MTP, ISUP or IUP args varchar(255) type int 0. MPAC = software 1. MTP = linkset 2. IUP = routeset 79 DATA DICTIONARY GATEWAY DATABASE 3. ISUP, (+ANSI) = routeset enabled bit Pack items can be enabled or disabled. 166 SS7_CONFIGURATION_PACK This table holds the name of the SS7 configuration pack. COLUMN NAME DATA TYPE DESCRIPTION config_pack_id int name varchar(30) 167 SS7_LINK COLUMN NAME DATA TYPE link_id int node_id int slot_id int Combined with the port id, this is used to identify which physical port the link is connected to. Applies to Drop and Insert Nodes only. ss7_port_id int The ports physical location on the card; must be contigous and is zero indexed. Applies to Drop and Insert Nodes only. name varchar(30) timeslot int linkset_id int machine int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. net int The network port ID slc int DESCRIPTION ds_transmit_slot int ds_receive_slot int 168 SS7_LINKSET COLUMN NAME DATA TYPE DESCRIPTION linkset_id int ss7_config_item_id int node_id int 80 DATA DICTIONARY GATEWAY DATABASE name varchar(30) anpc int is_stp bit Adjacent Node Point Code, ie identifies the node this linkset is connected to. 169 SS7_LINKSET_ASSIGNMENTS COLUMN NAME DATA TYPE DESCRIPTION routeset_id int linkset_id int priority int Determines with the linkset set is the primary or alternative linkset in the routeset. 170 SS7_MTP_SETTINGS COLUMN NAME DATA TYPE DESCRIPTION ss7_config_item_id int node_id int opc int ni int network_type int Defines the type of network we are connected to, ie ITU or ANSI 171 SS7_NODE COLUMN NAME DATA TYPE DESCRIPTION node_id int config_pack_id int type int mated_vp_node_id int 0 = Drop and Insert 1 = H110 Bus The mated VP switch node for an H110 (Direct Signalling) SS7 node. NULL if D'n'I. 172 SS7_PORT COLUMN NAME DATA TYPE DESCRIPTION node_id int slot_id int ss7_port_id int The ports physical location on the card; must be contigous and is zero indexed. crc bit Cyclic redundancy check 81 DATA DICTIONARY GATEWAY DATABASE 173 SS7_ROUTESET COLUMN NAME DATA TYPE DESCRIPTION routeset_id int ss7_config_item_id int dpc int name varchar(30) protocol enum t_Ss7Protcols { nSs7ProtIsup = 0, nSs7ProtIup, nSs7ProtAnsi, nSs7ProtLAST_ITEM, //Bounds check. }; int 174 SS7_SOFTWARE COLUMN NAME DATA TYPE DESCRIPTION node_id int component_id int ss7_config_item_id int name varchar(30) message int Used internally for communication between ss7 and switching nodes. 175 SS7_SSP COLUMN NAME DATA TYPE DESCRIPTION worker_node_id int standby_node_id int ssp_name varchar(20) 176 SUPERVISOR_ALERT_GROUPS Defines the list of Web Supervisor User Groups that an alerting job will notify when a matching system event occurs. COLUMN NAME DATA TYPE DESCRIPTION alert_job_id int Unique identifier of alert notifcation group_id int The unique identifier for the group 82 DATA DICTIONARY GATEWAY DATABASE 177 SUPERVISOR_USER_ALERT_HISTORY This table keeps a history of the alerts sent to each user for the purpose of thresholding. A maximum of one record exists for each user, holding the count for a defined period of time, and they are automatically deleted when no longer useful. COLUMN NAME DATA TYPE DESCRIPTION id int Unique ID for this record start_time The start of each counting period. This is the first time that an alert was sent to this user in the period, datetime allowing for more time-accurate counting than using whole minutes. The next period will start at this time plus the counting period length, which is managed within the alerting SQL. sms_count int email_count int user_id The number of SMSs sent to the user in this counting period The number of emails sent to this user in this counting period. int 178 SYS_CONFIG Holds the various system configuration options. COLUMN NAME DATA TYPE DESCRIPTION key_id int 1. max log files 2. max log lines 3. ms access code digits 4. codes show max digits 5. codes record limit 6. lcr percentage routing check 7. traffic polling method value MAXLOGFILES: "Maximum log files (The maximum number of log files per node. MAXLOGLINES: "Maximum log file lines (The maximum number of lines per log file. MS_ACCESS_CODE_DIGITS: "Access code digits (Defines the length of the most significant part of the access code. CODES_SHOW_MAX_DIGITS: "Show max digits information (Defines whether or not the max digits varchar(50) attribute should be displayed in the codes view. CODES_RECORD_LIMIT: "Record limit for codes (Sets the maximum number of records to read back for the codes screen). LCR_PERCENTAGE_ROUTING_CHECK: "Percentage routing checking - Determines the level of checking to apply to percentage routing values when changing LCR's (0:None,1:Check with warning,2:Check with no warning) 179 SYS_LOG This table stores messages from the 'System Page' of the switch. COLUMN NAME DATA TYPE DESCRIPTION id int The system log ID int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. mach_id 83 DATA DICTIONARY GATEWAY DATABASE writetime datetime The date and time when the log was written into the table type int Start, Stop or initialise msg varchar(100) The logged system message username varchar(50) User name of the operator performing a clear down operation within Supervisor 180 TCLASS This table stores details of time classes supported by the system for routing and carrier tarrifing. The switch reads-in the time class data every 2 minutes and builds a table of priority timescales based on the time of day. This means that a new time class would have to wait a maximum of 2 minutes before being activated. Note: Time classes are activated at the start of a call (not mid-call activated). COLUMN NAME DATA TYPE DESCRIPTION a int Holds the start time expressed in 24-hour format b int Holds the end time expressed in 24-hour format name varchar(50) Holds time class name reserved datetime Hold the reserved date tclass int Holds the time class ID int Holds the type of time class defined: 0. Any day 1. Monday 2. Tuesday 3. Wednesday 4. Thursday 5. Friday 6. Saturday 7. Sundays 8. Weekdays 9. Weekend 10. Reserved Day (calendar date) type 181 TDM_CARRIER COLUMN NAME DATA TYPE DESCRIPTION netgroups_lk_id int The group ID q931_direct_access bit Whether the carrier is direct to a customer PBX. If this is the case, then when the Calling Party Number is Restricted it will be removed from the signalling. manipulate_q931_ingress_params bit Whether ISDN parameters should be manipulated for ingress calls q931_originating_address Originating Address value to set when manipulating ingress ISDN calls. Wildcards varchar(50) such as % can be used in the same way as for manipulating outgoing CLI/DDI on a route. q931_presentation tinyint Presentation/Restriction value to set when manipulating ingress ISDN call parameters q931_screening tinyint Screening value to set when manipulating ingress ISDN call parameters q931_numbering_type tinyint Numbering Type value to set when manipulating ingress ISDN call parameters q931_numbering_plan tinyint Numbering Plan value to set when manipulating ingress ISDN call parameters 84 DATA DICTIONARY GATEWAY DATABASE manipulate_isup_ingress_params bit Whether SS7 parameters should be manipulated for ingress calls isup_originating_address Originating Address value to set when manipulating ingress SS7 calls. Wildcards varchar(50) such as % can be used in the same way as for manipulating outgoing CLI/DDI on a route. isup_presentation tinyint Presentation/Restriction value to set when manipulating ingress SS7 call parameters isup_screening tinyint Screening value to set when manipulating ingress SS7 call parameters isup_nature_of_address tinyint Nature of Address value to set when manipulating ingress SS7 call parameters isup_numbering_plan tinyint Numbering Plan value to set when manipulating ingress SS7 call parameters q931_destination_address varchar(160) isup_destination_address varchar(160) 182 TRACE_LOG This table stores details of all traces carried-out, and provides details to allow each trace to be resolved to the individual port and timeslot where it originated. COLUMN NAME DATA TYPE DESCRIPTION mach_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. port_id int The network port ID id int The log ID trace_ref int Trace session numberNote: This number is automatically allocated by the switch writetime datetime The date and time when the log was written into the table timeslot int The timeslot to which the trace applies type int Defines what is being traced msg varchar(100) Switch derived messages 183 TRAFFIC_LOG This table stores details of all traffic logs on service nodes, and provides details to allow each log to be resolved to the port where it originated. Foreign keys are no longer generated because of the "fake netports" used by SIP. COLUMN NAME DATA TYPE DESCRIPTION id int The log ID mach_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. port_id int The network port ID 85 DATA DICTIONARY GATEWAY DATABASE writetime datetime The date and time when the log was written into the table idle int The 'idle' channels. The nth bit of the value will be set if channel n is in this state. blocked int The 'blocked' channels. The nth bit of the value will be set if channel n is in this state. incoming int The channels with 'incoming' traffic. The nth bit of the value will be set if channel n is in this state. in_ringing int The 'incoming ringing' channels. The nth bit of the value will be set if channel n is in this state. in_connected int The 'incoming connected' channels. The nth bit of the value will be set if channel n is in this state. outgoing int The channels with 'outgoing' traffic. The nth bit of the value will be set if channel n is in this state. out_ringing int The 'outgoing ringing' channels. The nth bit of the value will be set if channel n is in this state. out_connected int The 'outgoing connected' channels. The nth bit of the value will be set if channel n is in this state. port_type int Whether this is a log of an IP or TDM port. IP ports are not in the database. 0 - TDM 1 - IP g723_bw int Current bandwidth in use by G.723 Codecs. g729_bw int Current bandwidth in use by G.729 Codecs. g711_bw int Current bandwidth in use by G.711 Codecs. t38_bw int 184 VERSION_HISTORY Maintains the schema upgrade history for the Gateway database. COLUMN NAME DATA TYPE DESCRIPTION version_id int Version number of this upgrade. sub_id tinyint Point release - not currently used, but may be required at some point upgrade_date datetime Date upgrade was performed. 185 VOICEPORTS This table stores the port configuration settings for all service nodes. COLUMN NAME DATA TYPE DESCRIPTION mach_id int The unique machine ID. The Machine (Service Node) numbers are automatically allocated as each new Service Node is added. Note: the numbers allocated are incremental. Therefore, if service nodes are deleted the numbers appearing in this list will not appear in a contiguous ascending order. netport_id int The network port ID channels int The number of DSP channels on the card: 0 8 Channels 1 16 Channels 2 24 Channels 3 32 Channels name varchar(28) The name of the voice card installed 86 DATA DICTIONARY GATEWAY DATABASE 186 VP_CDR Call Data Records for calls made using the Billed Leased Line service on a Session Border Controller. COLUMN NAME DATA TYPE DESCRIPTION id bigint Primary key of this table, no external meaning row_timestamp rowversion plat_sbc_id bigint Unique identifier generated by the SBC to process this call. This number can be used to retrieve the pcap of the entire call from the SBC's database. plat_cluster int ID of the SBC cluster which processed this call (primary key of proxy_clusters table) plat_build bigint Version number of the billing component of the SBC which rated and generated the CDR for this call. This number can only be interpreted by Digitalk, however larger numbers are newer versions. plat_writetime datetime Time at which this row was written, according to the data server (UTC). This may be a significant amount of time after the call actually ended. plat_transcoded bit Whether a media server transcoding licence was used by this call. sig_connected datetime Time at which this call became connected, i.e. the time at which billing commenced (UTC). sig_end datetime Time at which this call ended, i.e. the time billing ceased (UTC). smallint An internal code indicating the reason why the call ended. This includes reasons why the B-leg call was not attempted and reasons why the call disconnected. In the list of disconnect reasons, even numbers correspond to clearing by the A-leg and odd numbers correspond to clearing by the B-leg. Note that some causes can only apply to one leg or the other, for example the value 41 will never be used because the B-leg does not have credit. 0 Unspecified reason 2 No B-leg ratesheet 4 Insufficient credit 6 No LCR zone 8 No LCR timeclass 10 No LCR carriers 12 Rate limited 14 Carrier max channels reached 16 Carrier disabled 18 Carrier disabled by monitoring 20 Unacceptable Accept header 22 SDP parse error 24 No rtpproxy capacity 26 Call rejected by remote 28 Received BYE 30 Session timer expiry 32 Session refresh rejected 34 No ACK received 36 Usage destruction status code received 38 Dialog destruction status code received 40 Out of credit 42 Carrier monitoring failed 44 Offer/answer mismatch 46 Rating margin too low 48 Codec mismatch tinyint Number contained in the cause field of the last RFC3326 Reason header of protocol Q.850 which was contained in a CANCEL or BYE request sent on this call. If no such protocol feature was used then 0 will be stored here. See ITU recommendation Q.850 for other codes. sig_end_reason sig_q850_reason 87 DATA DICTIONARY GATEWAY DATABASE sell_start_bal decimal(13,6) Amount of credit remaining on the carrier group's account at the start of this call. sell_end_bal Amount of credit remaining on the carrier group's account at the end of this call. Note decimal(13,6) that sell_charge does not equal sell_start_bal - sell_end_bal because multiple calls may be running concurrently. sell_rate varchar(50) Name of the rate sheet which was used for billing this call, i.e. the customer rating price of the call. sell_tclass varchar(50) Name of the time class used for rating this call, i.e. for selecting the customer rating price of the call. sell_zone varchar(50) Name of the numbering zone used for rating this call, i.e. for selecting the customer rating price of the call. The zone is derived from the sell_code. sell_code varchar(40) Number prefix used for rating this call, i.e. for selecting the customer rating price of the call. If there is no number translation on the egress carrier then this will be a prefix of bsig_to. It will always be an item from the codes table. sell_charge decimal(13,6) Total amount of money which was charged to the carrier group's account for the cost of handling this call, i.e. the customer rating price. The duration of this call as used by the tariffing engine, which is the amount of time that sell_quantized_duration decimal(9,3) this call was running rounded up to the next billing increment defined in the B-leg rate sheet. The value is in seconds. buy_rate varchar(50) Name of the rate sheet used for carrier tariffing this call, i.e. the supplier rating price from the egress carrier. buy_tclass varchar(50) Name of the time class used for carrier tariffing this call, i.e. that used for retrieving the supplier rating price from the egress carrier. buy_zone varchar(50) Name of the numbering zone used for carrier tariffing this call, i.e. for selecting the supplier rating price of the call. The zone is derived from the buy_code. varchar(40) Number prefix used for carrier tariffing this call, i.e. for selecting the supplier rating price of the call. If there is no number translation on the egress carrier then this will be a prefix of bsig_to. It will always be an item from either the codes table (for rate sheets) or from the rating_codes table (for rate plans). buy_code The duration of this call as used by the carrier tariffing engine, which is the amount of buy_quantized_duration decimal(9,3) time that this call was running rounded up to the next billing increment defined in the egress carrier's supplier rate sheet/rate plan. The value is in seconds. buy_charge decimal(13,6) Total amount of money that the egress carrier charged the owner of this platform for handling this call. asig_invite datetime Time at which the incoming call request was received on the platform, in UTC. asig_post_dial datetime Time at which the first non-100 response was sent to the incoming initial INVITE, in UTC. Subtracting asig_invite from this will give the post-dial delay. asig_from varchar(126) User part of the From header of the incoming call request. asig_from_host varchar(126) Host part of the From header of the incoming call request. asig_to varchar(126) User part of the To header of the incoming call request. asig_to_host varchar(126) Host part of the To header of the incoming call request. asig_carrier_group varchar(50) Name of the carrier group from which the incoming call was received (carrier_groups.name) asig_netgroup varchar(50) Name of the interconnect from which the incoming call was received (netgroups_lk.name). asig_invite_status smallint The SIP response code sent to the initial INVITE request received from the a-leg. This will be 200 if the call was successfully answered or another status code from chapter 21 of RFC3261 if it was rejected. 88 DATA DICTIONARY GATEWAY DATABASE Transport IP address from which the incoming initial INVITE request was received. This will generally be the IP address of the nearest SIP device to the platform. asig_remote_ip varchar(41) asig_call_id varchar(126) SIP Call-ID header used in the A-leg signalling. tinyint Media codec of the last RTP packet received from the A-leg carrier at the end of the call. If the call did not use media services on the SBC (i.e. medialess/3pcc) then this will be zero. 0 Medialess call 1 RFC2833 2 Non-native codec relayed 3 G.711 mu-law 4 G.711 A-law 5 G.723.1 6 G.729 artp_rx_bandwidth int Average bits per second of the codec payload received on an SBC Media Server from the A-leg carrier over the length of this call. This excludes all headers (RTP, UDP, IP, Ethernet) and excludes any packets which were dropped due to being malformed (see artp_discarded). artp_tx_bandwidth int Average bits per second of the codec payload sent from an SBC Media Server to the Aleg carrier over the length of this call. This excludes all headers (RTP, UDP, IP, Ethernet). artp_avg_jitter_us int Average skew in RTP packet arrival times of the media packets received from the A-leg carrier, in microseconds. This is defined as sum(abs(actual packet arrival time - expected packet arrival time)) / artp_rx_packets. artp_rx_packets int Number of valid RTP packets received on an SBC Media Server from the A-leg carrier over the entire duration of this call. Note that this may be fewer than the number of packets that the remote endpoint sent if there is a lag in the signalling path or if the remote endpoint starts sending RTP before it has negotiated the stream properties. artp_tx_packets int Number of RTP packets sent to the A-leg carrier from an SBC Media Server over the entire duration of this call. int Number of RTP packets which were not received by an SBC Media Server from the A-leg carrier. This is computed by using the RTP sequence numbers to deduce the existence of the gaps, but bugs in the remote endpoint's sequence number generation can cause miscalculation. The number of lost packets is only very loosely correlated with the perceived audio quality of the call, as experienced by an end-user. int Number of RTP packets received by an SBC Media Server from the A-leg carrier which were discarded because they failed one or more validation criteria. Validation includes IP address, UDP port, codec type, and several more. This counter is independent of artp_lost, which counts sequence number gaps, therefore it is possible for a single packet to be counted as both lost and discarded; an unrecognised codec, for example, will be discarded but this discard may then later cause a gap in the sequence numbers which will be counted as a loss. artp_network_quality smallint Estimate of the quality of the networking equipment between the SBC Media Server and the A-leg carrier (including the A-leg carrier itself). This value goes from 0 (no packets received at all) to 10000 (perfect quality, although this is only theoretically obtainable). The specific algorithm used for the calculation is undefined and is subject to change, however it includes both specific data from this call and general standards-compliance information. This number is not intended as a measure of the audio quality experienced by the end-user on the call, but rather as an indication for the network operator when a particular carrier or route has changed behaviour and thus it is worth making a test call on that route to re-assess the actual audio quality. The 'correct' quality is not a specific figure, but will depend on the equipment in use for the route. bsig_invite datetime Time at which the outgoing call request was made from this platform (UTC). If there are multiple calls caused by multiple LCR attempts then this is the start time of the last call. bsig_from varchar(126) User part of the From header of the outgoing call request. bsig_from_host varchar(126) Host part of the From header of the outgoing call request. artp_codec artp_lost artp_discarded 89 DATA DICTIONARY GATEWAY DATABASE bsig_to varchar(126) User part of the To header of the outgoing call request. bsig_to_host varchar(126) Host part of the To header of the outgoing call request. bsig_carrier_group varchar(50) Name of the carrier group to which the outgoing call was sent (carrier_groups.name). If there were multiple LCR attempts, then this is the carrier used for the final attempt. bsig_netgroup varchar(50) Name of the interconnect to which the outgoing call was sent (netgroups_lk.name). bsig_invite_status smallint The SIP response code from the initial INVITE request sent to the B-leg. This will be 200 if the call was successfully answered or another status code from chapter 21 of RFC3261 if it was rejected. bsig_call_id varchar(126) SIP Call-ID header used in the B-leg signalling. brtp_codec tinyint Media codec of the last RTP packet received from the B-leg carrier at the end of the call. If the call did not use media services on the SBC (i.e. medialess/3pcc) then this will be zero. brtp_rx_bandwidth int Average bits per second of the codec payload received on an SBC Media Server from the B-leg carrier over the length of this call. This excludes all headers (RTP, UDP, IP, Ethernet) and excludes any packets which were dropped due to being malformed (see brtp_discarded). brtp_tx_bandwidth int Average bits per second of the codec payload sent from an SBC Media Server to the Bleg carrier over the length of this call. This excludes all headers (RTP, UDP, IP, Ethernet). brtp_avg_jitter_us int Average skew in RTP packet arrival times of the media packets received from the B-leg carrier, in microseconds. This is defined as sum(abs(actual packet arrival time - expected packet arrival time)) / brtp_rx_packets. brtp_rx_packets int Number of valid RTP packets received on an SBC Media Server from the B-leg carrier over the entire duration of this call. Note that this may be fewer than the number of packets that the remote endpoint sent if there is a lag in the signalling path or if the remote endpoint starts sending RTP before it has negotiated the stream properties. brtp_tx_packets int Number of RTP packets sent to the B-leg carrier from an SBC Media Server over the entire duration of this call. int Number of RTP packets which were not received by an SBC Media Server from the B-leg carrier. This is computed by using the RTP sequence numbers to deduce the existence of the gaps, but bugs in the remote endpoint's sequence number generation can cause miscalculation. The number of lost packets is only very loosely correlated with the perceived audio quality of the call, as experienced by an end-user. int Number of RTP packets received by an SBC Media Server from the B-leg carrier which were discarded because they failed one or more validation criteria. Validation includes IP address, UDP port, codec type, and several more. This counter is independent of brtp_lost, which counts sequence number gaps, therefore it is possible for a single packet to be counted as both lost and discarded; an unrecognised codec, for example, will be discarded but this discard may then later cause a gap in the sequence numbers which will be counted as a loss. brtp_network_quality smallint Estimate of the quality of the networking equipment between the SBC Media Server and the B-leg carrier (including the B-leg carrier itself). This value goes from 0 (no packets received at all) to 10000 (perfect quality, although this is only theoretically obtainable). The specific algorithm used for the calculation is undefined and is subject to change, however it includes both specific data from this call and general standards-compliance information. This number is not intended as a measure of the audio quality experienced by the end-user on the call, but rather as an indication for the network operator when a particular carrier or route has changed behaviour and thus it is worth making a test call on that route to re-assess the actual audio quality. The 'correct' quality is not a specific figure, but will depend on the equipment in use for the route. lcr varchar(50) Name of the routing plan used for the egress portion of this call. If this call used direct carrier translation rather than LCR then this will be the name of the netroute used. lcr_zone varchar(50) Name of the numbering zone containing lcr_code. This is not used for routing the call. brtp_lost brtp_discarded 90 DATA DICTIONARY GATEWAY DATABASE lcr_code varchar(40) Portion of the destination number used for choosing the list of carriers on which to attempt the egress call. This will be one of the items in the codes table, and will be a prefix of bsig_to if the egress carrier has no number translations. lcr_tclass varchar(50) Name of the timeclass used for choosing the list of carriers on which to attempt the egress call. This will be an item from tclass.name. tinyint Number of egress call attempts which actually resulted in INVITE requests leaving the SBC. This excludes attempts which did not leave the platform (e.g. because the carrier was automatically or manually blocked, the profit margin was not met, or because no media capacity was available). It includes the final successful attempt (if there was one). lcr_attempts 187 VP_CDR_LCR Contains one row per failed B-leg call attempt caused by LCR. Only call attempts which actually resulted in an INVITE transmitted from the SBC will be included here; call attempts which were aborted internally (e.g. due to margin-based routing) are not included. The final B-leg attempt is described in vp_cdr, not in this table, whether or not the final attempt was successful. For example, if a call required three LCR attempts before it failed then there will be two rows in this table and they will both refer back to the main row in vp_cdr; the bsig_* columns of that row will describe the final call attempt. COLUMN NAME DATA TYPE row_timestamp rowversion cdr bigint Refers to the CDR of the call which caused this LCR attempt. This contains the full information about the call, including all the A-leg information. attempt tinyint LCR attempt number. The specific values used in this column are undefined, only the relative ordering is important; lower numbers were attempted prior to later numbers. DESCRIPTION bsig_carrier_group varchar(50) Name of the carrier group to which the LCR attempt was sent (carrier_groups.name). bsig_netgroup varchar(50) Name of the interconnect to which the LCR attempt was sent (netgroups_lk.name). pdd_ms int bsig_invite_status smallint Post-dial delay encountered by this call attempt, measured in milliseconds. This is defined as (the time at which the first non-100 response was received for the initial INVITE) - (the time at which the initial INVITE was sent from the SBC). The SIP response code from the initial INVITE request sent to the LCR attempt. This will be a status code from chapter 21 of RFC3261. It will never be a success code (i.e. will be >= 300). 188 ZONE_CARRIER_EXCLUSIONS This table stores a list of carriers which should be excluded from specific zones when generating or updating a routing plan based on cost (automatic) COLUMN NAME DATA TYPE DESCRIPTION exclusion_id bigint The unique identifier for the exclusion. No external meaning zone int Holds the zone ID of the zone which will not include the carrier in the routing plan carrier_id int The interconnect for exclusion excluded_date datetime The date the sclusion was created 189 ZONE_IMPORT_ITEMS Table for holding raw import data when importing zones/codes. 91 DATA DICTIONARY GATEWAY DATABASE COLUMN NAME DATA TYPE DESCRIPTION item_id int Unique identifer for the item. No external meaning. task_id int The bulk data task of this code import name varchar(50) The name of the zone zone_id int The zone id if updating an existing zone 190 ZONES This table stores a list of all zones (notional groups of dialling codes) supported by the system e.g. Africa, Europe, France etc. These zones are only used for routing and carrier tariffing. COLUMN NAME DATA TYPE DESCRIPTION zone int Holds the zone ID name varchar(50) Holds the name of the zone 92
