X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;fp=httemplate%2Fdocs%2Fschema.html;h=0000000000000000000000000000000000000000;hb=160be29a0dc62e79a4fb95d2ab8c0c7e5996760e;hp=2b8b3a1324e9063630007e7a57a8ec26f4842026;hpb=3ef62a0570055da710328937e7f65dbb2c027c62;p=freeside.git diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html deleted file mode 100644 index 2b8b3a132..000000000 --- a/httemplate/docs/schema.html +++ /dev/null @@ -1,424 +0,0 @@ - - Schema reference - - -

Schema reference

- Schema diagram: as a giant .png or dia source (dia homepage). -

agent - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type). -
- agentnum - primary key -
- agent - name of this agent -
- typenum - agent type -
- prog - (unimplemented) -
- freq - (unimplemented) -
-
agent_type - Agent types define groups of packages that you can then assign to particular agents. -
- typenum - primary key -
- atype - name of this agent type -
-
cust_bill - Invoices. Declarations that a customer owes you money. The specific charges are itemized in cust_bill_pkg. -
- invnum - primary key -
- custnum - customer -
- _date -
- charged - amount of this invoice -
- printed - how many times this invoice has been printed automatically -
- closed - books closed flag, empty or `Y' -
-
cust_bill_event - Invoice event history -
- eventnum - primary key -
- invnum - invoice -
- eventpart - event definition -
- _date -
- status -
- statustext -
-
part_bill_event - Invoice event definitions -
- eventpart - primary key -
- payby - CARD, BILL, or COMP -
- event - event name -
- eventcode - event action -
- seconds - how long after the invoice date (cust_bill._date) events of this type are triggered -
- weight - ordering for events with identical seconds -
- plan - eventcode plan -
- plandata - additional plan data -
- disabled - Disabled flag, empty or `Y' -
- taxclass - Texas tax class flag, empty or "none", "access", or "hosting" -
-
cust_bill_pkg - Invoice line items -
- invnum - (multiple) key -
- pkgnum - package or 0 for the special virtual sales tax package -
- setup - setup fee -
- recur - recurring fee -
- sdate - starting date -
- edate - ending date -
-
cust_credit - Credits. The equivalent of a negative cust_bill record. -
- crednum - primary key -
- custnum - customer -
- amount - amount credited -
- _date -
- otaker - order taker -
- reason -
- closed - books closed flag, empty or `Y' -
-
cust_credit_bill - Credit invoice application. Links a credit to an invoice. -
- creditbillnum - primary key -
- crednum - credit being applied -
- invnum - invoice to which credit is applied -
- amount - amount applied -
- _date -
-
cust_main - Customers -
- custnum - primary key -
- agentnum - agent -
- refnum - referral -
- first - name -
- last - name -
- ss - social security number -
- company -
- address1 -
- address2 -
- city -
- county -
- state -
- zip -
- country -
- daytime - phone -
- night - phone -
- fax - phone -
- ship_first -
- ship_last -
- ship_company -
- ship_address1 -
- ship_address2 -
- ship_city -
- ship_county -
- ship_state -
- ship_zip -
- ship_country -
- ship_daytime -
- ship_night -
- ship_fax -
- payby - CARD, BILL, or COMP -
- payinfo - card number, P.O.#, or comp issuer -
- paydate - expiration date -
- payname - billing name (name on card) -
- tax - tax exempt, Y or null -
- otaker - order taker -
- referral_custnum -
- comments -
- (columns in italics are optional) -
cust_main_invoice - Invoice destinations for email invoices. Note that a customer can have many email destinations for their invoice (either literal or via svcnum), but only one postal destination. -
- destnum - primary key -
- custnum - customer -
- dest - Invoice destination. Freeside supports three types of invoice delivery: send directly to a service defined in Freeside, send to an arbitrary email address, or print the invoice to a printer and have someone send it out via snail mail. Freeside determines which method to use based on the contents of the dest field. If the contents are numeric, a svcnum pointing to a valid service is expected in the field. If the contents are a string, a literal email address is expected to be in the field. If the special keyword `POST' is present, the snail mail method is used (which is the default if no cust_main_invoice records exist). Snail mail invoices get their address information from cust_main and are printed with the printer defined in the configuration files. -
-
cust_main_county - Tax rates -
- taxnum - primary key -
- state -
- county -
- country -
- tax - % rate -
- taxclass -
- exempt_amount -
-
cust_tax_exempt - Tax exemption record -
- exemptnum - primary key -
- taxnum - tax rate -
- year -
- month -
- amount -
-
cust_pay - Payments. Money being transferred from a customer. -
- paynum - primary key -
- custnum - customer -
- paid - amount -
- _date -
- payby - CARD, BILL, or COMP -
- payinfo - card number, P.O.#, or comp issuer -
- paybatch - text field for tracking card processor batches -
- closed - books closed flag, empty or `Y' -
-
cust_bill_pay - Applicaton of a payment to a specific invoice. -
- billpaynum -
- invnum - invoice -
- paynum - payment -
- amount -
- _date -
-
cust_pay_batch - Pending batch -
- paybatchnum -
- cardnum -
- exp - card expiration -
- amount -
- invnum - invoice -
- custnum - customer -
- payname - name on card -
- first - name -
- last - name -
- address1 -
- address2 -
- city -
- state -
- zip -
- country -
-
cust_pkg - Customer billing items -
- pkgnum - primary key -
- custnum - customer -
- pkgpart - Package definition -
- setup - date -
- bill - next bill date -
- susp - (past) suspension date -
- expire - (future) cancellation date -
- cancel - (past) cancellation date -
- otaker - order taker -
- manual_flag - If this field is set to 1, disables the automatic unsuspensiond of this package when using the unsuspendauto config file. -
-
cust_refund - Refunds. The transfer of money to a customer; equivalent to a negative cust_pay record. -
- refundnum - primary key -
- custnum - customer -
- refund - amount -
- _date -
- payby - CARD, BILL or COMP -
- payinfo - card number, P.O.#, or comp issuer -
- otaker - order taker -
- closed - books closed flag, empty or `Y' -
-
cust_credit_refund - Applicaton of a refund to a specific credit. -
- creditrefundnum - primary key -
- crednum - credit -
- refundnum - refund -
- amount -
- _date -
-
cust_svc - Customer services -
- svcnum - primary key -
- pkgnum - package -
- svcpart - Service definition -
-
nas - Network Access Server (terminal server) -
- nasnum - primary key -
- nas - NAS name -
- nasip - NAS ip address -
- nasfqdn - NAS fully-qualified domain name -
- last - timestamp indicating the last instant the NAS was in a known state (used by the session monitoring). -
-
part_pkg - Package definitions -
- pkgpart - primary key -
- pkg - package name -
- comment - non-customer visable package comment -
- setup - setup fee expression -
- freq - recurring frequency (months) -
- recur - recurring fee expression -
- setuptax - Setup fee tax exempt flag, empty or `Y' -
- recurtax - Recurring fee tax exempt flag, empty or `Y' -
- plan - price plan -
- plandata - additional price plan data -
- disabled - Disabled flag, empty or `Y' -
-
part_referral - Referral listing -
- refnum - primary key -
- referral - referral -
-
part_svc - Service definitions -
- svcpart - primary key -
- svc - name of this service -
- svcdb - table used for this service: svc_acct, svc_acct_sm, svc_forward, svc_domain, svc_charge or svc_wo -
- disabled - Disabled flag, empty or `Y' - -
-
part_svc_column -
- columnnum - primary key -
- svcpart - Service definition -
- columnname - column name in part_svc.svcdb table -
- columnvalue - default or fixed value for the column -
- columnflag - null, D or F -
-
pkg_svc -
- pkgpart - Package definition -
- svcpart - Service definition -
- quantity - quantity of this service that this package includes -
-
export_svc -
- exportsvcnum - primary key -
- svcpart - Service definition -
- exportnum - Export -
-
part_export - Export to external provisioning -
- exportnum - primary key -
- machine - Machine name -
- exporttype - Export type -
- nodomain - blank or Y: usernames are exported to this service with no domain -
-
part_export_option - provisioning options -
- optionnum - primary key -
- exportnum - Export -
- optionname - option name -
- optionvalue - option value -
-
port - individual port on a nas -
- portnum - primary key -
- ip - IP address of this port -
- nasport - port number on the NAS -
- nasnum - NAS -
-
prepay_credit -
- prepaynum - primary key -
- identifier - text or numeric string used to receive this credit -
- amount - amount of credit -
-
session -
- sessionnum - primary key -
- portnum - Port -
- svcnum - Account -
- login - timestamp indicating the beginning of this user session. -
- logout - timestamp indicating the end of this user session. May be null, which indicates a currently open session. -
- -
svc_acct - Accounts -
- svcnum - primary key -
- username -
- _password -
- sec_phrase - security phrase -
- popnum - Point of Presence -
- uid -
- gid -
- finger - GECOS -
- dir -
- shell -
- quota - (unimplementd) -
- slipip - IP address -
- seconds -
- domsvc -
- radius_Radius_Reply_Attribute - Radius-Reply-Attribute -
- rc_Radius_Check_Attribute - Radius-Check-Attribute -
-
svc_acct_pop - Points of Presence -
- popnum - primary key -
- city -
- state -
- ac - area code -
- exch - exchange -
- loc - rest of number -
-
part_pop_local - Local calling areas -
- localnum - primary key -
- popnum - primary key -
- city -
- state -
- npa - area code -
- nxx - exchange -
-
svc_acct_sm - DEPRECIATED Domain mail aliases -
- svcnum - primary key -
- domsvc - Domain (by svcnum) -
- domuid - Account (by uid) -
- domuser - domuser @ Domain forwards to Account -
-
svc_domain - Domains -
- svcnum - primary key -
- domain -
-
svc_forward - Mail forwarding aliases -
- svcnum - primary key -
- srcsvc - svcnum of the source of this forward -
- dstsvc - svcnum of the destination of this forward -
- dst - foreign destination (email address) - forward not local to freeside -
-
domain_record - Domain zone detail -
- recnum - primary key -
- svcnum - Domain (by svcnum) -
- reczone - zone for this line -
- recaf - address family, usually IN -
- rectype - type for this record (A, MX, etc.) -
- recdata - data for this record -
-
svc_www -
- svcnum - primary key -
- recnum - host -
- usersvc - account -
-
type_pkgs -
- typenum - agent type -
- pkgpart - Package definition -
-
queue - job queue -
- jobnum - primary key -
- job -
- _date -
- status -
- statustext -
- svcnum -
-
queue_arg - job arguments -
- argnum - primary key -
- jobnum - job -
- arg - argument -
-
queue_depend - job dependancies -
- dependnum - primary key -
- jobnum - source jobnum -
- depend_jobnum - dependancy jobnum -
-
radius_usergroup - Link users to RADIUS groups. -
- usergroupnum - primary key -
- svcnum - account -
- groupname -
-
msgcat - i18n message catalog -
- msgnum - primary key -
- msgcode - message code -
- locale - locale -
- msg - Message text -
-