htdocs/docs/schema.html

   1 <head>
   2   <title>Schema reference</title>
   3 </head>
   4 <body>
   5   <h1>Schema reference</h1>
   6   <ul>
   7     <li><a name="agent">agent</a> - Agents are resellers of your service.  Agents may be limited to a subset of your full offerings (via their agent type).
   8       <ul>
   9         <li>agentnum - primary key
  10         <li>agent - name of this agent
  11         <li>typenum - <a href="#agent_type">agent type</a>
  12         <li>prog - (unimplemented)
  13         <li>freq - (unimplemented)
  14       </ul>
  15     <li><a name="agent_type">agent_type</a> - Agent types define groups of packages that you can then assign to particular agents.
  16       <ul>
  17         <li>typenum - primary key
  18         <li>atype - name of this agent type
  19       </ul>
  20     <li><a name="cust_bill">cust_bill</a> - Invoices
  21       <ul>
  22         <li>invnum - primary key
  23         <li>custnum - <a href="#cust_main">customer</a>
  24         <li>_date
  25         <li>charged - amount of this invoice
  26         <li>owed - amount still outstanding on this invoice
  27         <li>printed - how many times this invoice has been printed automatically
  28       </ul>
  29     <li><a name="cust_bill_pkg">cust_bill_pkg</a> - Invoice line items
  30       <ul>
  31         <li>invnum - (multiple) key
  32         <li>pkgnum - <a href="#cust_pkg">package</a>
  33         <li>setup - setup fee
  34         <li>recur - recurring fee
  35         <li>sdate - starting date
  36         <li>edate - ending date
  37       </ul>
  38     <li><a name="cust_credit">cust_credit</a> - Credits
  39       <ul>
  40         <li>crednum - primary key
  41         <li>custnum - <a href="#cust_main">customer</a>
  42         <li>amount - amount credited
  43         <li>credited - amount still outstanding (not yet refunded) on this credit
  44         <li>_date
  45         <li>otaker - order taker
  46         <li>reason
  47       </ul>
  48     <li><a name="cust_main">cust_main</a> - Customers
  49       <ul>
  50         <li>custnum - primary key
  51         <li>agentnum - <a href="#agent">agent</a>
  52         <li>refnum - <a href="#part_referral">referral</a>
  53         <li>titlenum - <a href="#part_title">title</a>
  54         <li>first - name
  55         <li>middle - name
  56         <li>last - name
  57         <li>ss - social security number
  58         <li>company
  59         <li>address1
  60         <li>address2
  61         <li>city
  62         <li>county
  63         <li>state
  64         <li>zip
  65         <li>country
  66         <li>daytime - phone
  67         <li>night - phone
  68         <li>fax - phone
  69         <li>payby - CARD, BILL, or COMP
  70         <li>payinfo - card number, P.O.#, or comp issuer
  71         <li>paydate - expiration date
  72         <li>payname - billing name (name on card)
  73         <li>tax - tax exempt, Y or null
  74         <li>otaker - order taker
  75       </ul>
  76     <li><a name="cust_main_invoice">cust_main_invoice</a> - Invoice destinations for email invoices
  77       <ul>
  78         <li>destnum - primary key
  79         <li>custnum - <a href="#cust_main">customer</a>
  80         <li>dest - Invoice destination: If numeric, a <a href="#svc_acct">svcnum</a>, if string, a literal email address, or `POST' to enable mailing (the default if no cust_main_invoice records exist)
  81       </ul>
  82     <li><a name="cust_main_county">cust_main_county</a> - Tax rates
  83       <ul>
  84         <li>taxnum - primary key
  85         <li>state
  86         <li>county
  87         <li>country
  88         <li>tax - % rate
  89       </ul>
  90     <li><a name="cust_pay">cust_pay</a> - Payments
  91       <ul>
  92         <li>paynum - primary key
  93         <li>invnum - <a href="#cust_bill">invoice</a>
  94         <li>paid - amount
  95         <li>_date
  96         <li>payby - CARD, BILL, or COMP
  97         <li>payinfo - card number, P.O.#, or comp issuer
  98         <li>paybatch - text field for tracking card processor batches
  99       </ul>
 100     <li><a name="cust_pay_batch">cust_pay_batch</a> - Pending batch
 101       <ul>
 102         <li>trancode - 77 for charges
 103         <li>cardnum
 104         <li>exp - card expiration
 105         <li>amount
 106         <li>invnum - <a href="#cust_bill">invoice</a>
 107         <li>custnum - <a href="#cust_main">customer</a>
 108         <li>payname - name on card
 109         <li>first - name
 110         <li>last - name
 111         <li>address1
 112         <li>address2
 113         <li>city
 114         <li>state
 115         <li>zip
 116         <li>country
 117       </ul>
 118     <li><a name="cust_pkg">cust_pkg</a> - Customer billing items
 119       <ul>
 120         <li>pkgnum - primary key
 121         <li>custnum - <a href="#cust_main">customer</a>
 122         <li>pkgpart - <a href="#part_pkg">Package definition</a>
 123         <li>setup - date
 124         <li>bill - next bill date
 125         <li>susp - (past) suspension date
 126         <li>expire - (future) cancellation date
 127         <li>cancel - (past) cancellation date
 128         <li>otaker - order taker
 129       </ul>
 130     <li><a name="cust_refund">cust_refund</a> - Refunds
 131       <ul>
 132         <li>refundnum - primary key
 133         <li>crednum - <a href="#cust_credit">credit</a>
 134         <li>refund - amount
 135         <li>_date
 136         <li>payby - CARD, BILL or COMP
 137         <li>payinfo - card number, P.O.#, or comp issuer
 138         <li>otaker - order taker
 139       </ul>
 140     <li><a name="cust_svc">cust_svc</a> - Customer services
 141       <ul>
 142         <li>svcnum - primary key
 143         <li>pkgnum - <a href="#cust_pkg">package</a>
 144         <li>svcpart - <a href="#part_svc">Service definition</a>
 145       </ul>
 146     <li><a name="nas">nas</a> - Network Access Server (terminal server)
 147       <ul>
 148         <li>nasnum - primary key
 149         <li>nas - NAS name
 150         <li>nasip - NAS ip address
 151         <li>nasfqdn - NAS fully-qualified domain name
 152         <li>last - timestamp indicating the last instant the NAS was in a known state (used by the session monitoring).
 153       </ul>
 154     <li><a name="part_pkg">part_pkg</a> - Package definitions
 155       <ul>
 156         <li>pkgpart - primary key
 157         <li>pkg - package name
 158         <li>comment - non-customer visable package comment
 159         <li>setup - setup fee
 160         <li>freq - recurring frequency (months)
 161         <li>recur - recurring fee
 162       </ul>
 163     <li><a name="part_referral">part_referral</a> - Referral listing
 164       <ul>
 165         <li>refnum - primary key
 166         <li>referral - referral
 167       </ul>
 168     <li><a name="part_svc">part_svc</a> - Service definitions
 169       <ul>
 170         <li>svcpart - primary key
 171         <li>svc - name of this service
 172         <li>svcdb - table used for this service: svc_acct, svc_acct_sm, svc_domain, svc_charge or svc_wo
 173         <li><i>table</i>__<i>field</i> - Default or fixed value for <i>field</i> in <i>table</i>
 174         <li><i>table</i>__<i>field</i>_flag - null, D or F
 175       </ul>
 176     <li><a name="part_title">part_title</a> - Personal titles
 177       <ul>
 178         <li>titlenum - primary key
 179         <li>title - personal title (`Dr.' or `Mr.')
 180       </ul>
 181     <li><a name="pkg_svc">pkg_svc</a>
 182       <ul>
 183         <li>pkgpart - <a href="#part_pkg">Package definition</a>
 184         <li>svcpart - <a href="#part_svc">Service definition</a>
 185         <li>quantity - quantity of this service that this package includes
 186       </ul>
 187     <li><a name="port">port</a> - individual port on a <a href="#nas">nas</a>
 188       <ul>
 189         <li>portnum - primary key
 190         <li>ip - IP address of this port
 191         <li>nasport - port number on the NAS
 192         <li>nasnum - <a href="#nas">NAS</a>
 193       </ul>
 194     <li><a name="prepay_credit">prepay_credit</a>
 195       <ul>
 196         <li>prepaynum - primary key
 197         <li>identifier - text or numeric string used to receive this credit
 198         <li>amount - amount of credit
 199       </ul>
 200     <li><a name="session">session</a>
 201       <ul>
 202         <li>sessionnum - primary key
 203         <li>portnum - <a href="#port">Port</a>
 204         <li>svcnum - <a href="#svc_acct">Account</a>
 205         <li>login - timestamp indicating the beginning of this user session.
 206         <li>logout - timestamp indicating the end of this user session.  May be null, which indicates a currently open session.
 207       </ul>
 208
 209     <li><a name="svc_acct">svc_acct</a> - Accounts
 210       <ul>
 211         <li>svcnum - <a href="#cust_svc">primary key</a>
 212         <li>username
 213         <li>_password
 214         <li>popnum - <a href="#svc_acct_pop">Point of Presence</a>
 215         <li>uid
 216         <li>gid
 217         <li>finger - GECOS
 218         <li>dir
 219         <li>shell
 220         <li>quota - (unimplementd)
 221         <li>slipip - IP address
 222         <li>radius_<i>Radius_Attribute</i> - Radius-Attribute
 223       </ul>
 224     <li><a name="svc_acct_pop">svc_acct_pop</a> - Points of Presence
 225       <ul>
 226         <li>popnum - primary key
 227         <li>city
 228         <li>state
 229         <li>ac - area code
 230         <li>exch - exchange
 231         <li>loc - rest of number
 232       </ul>
 233     <li><a name="svc_acct_sm">svc_acct_sm</a> - Domain mail aliases
 234       <ul>
 235         <li>svcnum - <a href="#cust_svc">primary key</a>
 236         <li>domsvc - <a href="#svc_domain">Domain</a> (by svcnum)
 237         <li>domuid - <a href="#svc_acct">Account</a> (by uid)
 238         <li>domuser - domuser @ <a href="#svc_domain">Domain</a> forwards to <a href="#svc_acct">Account</a>
 239       </ul>
 240     <li><a name="svc_domain">svc_domain</a> - Domains
 241       <ul>
 242         <li>svcnum - <a href="#cust_svc">primary key</a>
 243         <li>domain
 244       </ul>
 245     <li><a name="domain_record">domain_record</a> - Domain zone detail
 246       <ul>
 247         <li>recnum - primary key
 248         <li>svcnum - <a href="#svc_domain">Domain</a> (by svcnum)
 249         <li>reczone - zone for this line
 250         <li>recaf - address family, usually <b>IN</b>
 251         <li>rectype - type for this record (<b>A</b>, <b>MX</b>, etc.)
 252         <li>recdata - data for this record
 253       </ul>
 254     <li><a name="svc_www">svc_www</a>
 255        <li>svcnum - <a href="#cust-svc">primary key</a>
 256        <li>recnum - <a href="#domain_record">host</a>
 257        <li>usersvc - <a href="#svc_acct">account</a>
 258      </ul>
 259     <li><a name="type_pkgs">type_pkgs</a>
 260       <ul>
 261         <li>typenum - <a href="#agent_type">agent type</a>
 262         <li>pkgpart - <a href="#part_pkg">Package definition</a>
 263       </ul>
 264   </ul>
 265 </body>