View source for Freeside:3:Documentation:Administration

= Exports (provisioning) =

'''Exports''' allow you to provision services to remote machines, databases and APIs.  Some exports, such as ''sqlradius'' and ''sqlradius_withdomain'',  enable a feed for retrieving rating/usage data.

Exports can be added and edited under
: Configuration -> Provisioning, services and packages -> View/edit exports

Most exports place jobs in the job queue for new, modified or deleted services.  Jobs are run by [[Freeside:3:Documentation:Developer/bin/freeside-queued|freeside-queued]].  This daemon needs to be running before exports are acted upon.

Some exports use SSH, SCP or SFTP to communicate with external machines.  See the documentation on [[Freeside:3:Documentation:Administration:SSH_Keys|SSH keys]].

Click on ''Add a new export'' to create a new export.  Select exports from the dropdown to show more information on each export, including available options, setup and usage.

Exports are activated by associating them with one or more '''service definitions'''.

Following is a list of which exports can be associated with each type of service.

==svc_acct==
* [[Freeside:3:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]:  Real-time export to Plesk managed mail service
* acct_sql.pm:  Real-time export of accounts to SQL databases .
* artera_turbo.pm: 
* bsdshell.pm: 
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]:  Real-time export to a CommuniGate Pro mail server
* communigate_pro_singledomain.pm: 
* cpanel.pm:  Real-time export to Cpanel control panel.
* cp.pm:  Real-time export to Critical Path Account Provisioning Protocol
* cyrus.pm:  Real-time export to Cyrus IMAP server
* everyone_net.pm:  Real-time export to Everyone.net outsourced mail service
* infostreet.pm:  Real-time export to InfoStreet streetSmartAPI
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]:  Real-time export to LDAP
* passwdfile.pm:
* radiator.pm:  Real-time export to RADIATOR
* shellcommands.pm: 
* shellcommands_withdomain.pm:  Real-time export via remote SSH (vpopmail, ISPMan)
* sqlmail.pm:  Real-time export to SQL-backed mail server
* sqlradius.pm:  Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)
* sqlradius_withdomain.pm:  Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms
* sysvshell.pm: 
* textradius.pm: 
* vpopmail.pm:  Real-time export to vpopmail text files

==svc_domain==
* bind.pm:  Batch export to BIND named
* bind_slave.pm: Batch export to slave BIND named
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]:  Real-time export to a CommuniGate Pro mail server
* domain_shellcommands.pm:  Run remote commands via SSH, for domains (qmail, ISPMan).
* domain_sql.pm:  Real time export of domains to SQL databases .
* http.pm:  Send an HTTP or HTTPS GET or POST request
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration
* sqlmail.pm:  Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm: 
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]:  Real-time export to a CommuniGate Pro mail server
* forward_shellcommands.pm:  Run remote commands via SSH, for forwards
* postfix.pm:  Postfix text files
* sqlmail.pm:  Real-time export to SQL-backed mail server

==svc_www==
* apache.pm:  Export an Apache httpd.conf file snippet.
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]:  Real-time export to Plesk managed hosting service
* www_shellcommands.pm:  Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)

==svc_broadband==
* nas_wrapper.pm:  A meta-export that triggers other svc_broadband exports.
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]:  Real-time export to Northbound Interface
* router.pm:  Send a command to a router.
* snmp.pm:  Sends SNMP SETs to an SNMP agent.
* trango.pm:  Sends SNMP SETs to a Trango AP.

==svc_phone==
* globalpops_voip.pm:
* grandstream.pm: Grandstream phone and ATA provisioning.   This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.
* indosoft.pm:
* internal_diddb.pm:
* netsapiens.pm:
* phone_shellcommands.pm:
* phone_sqlradius.pm:
* thirdlane.pm:
* [[Freeside:Documentation:Administration:vitelity.pm|vitelity.pm]]: Vitelity provisioning

==svc_external==
* artera_turbo.pm:

==svc_dsl==
* ikano.pm: see [[Freeside:3:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]

= Services =

== Accounts (svc_acct) ==

* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]

== Domains (svc_domain) ==

== Forwards (svc_forward) ==

== Hosting (svc_www) ==

== Broadband (svc_broadband) ==

== Phone (svc_phone) ==

* [[Freeside:Documentation:Administration:Phone devices|Phone devices]]

== External (svc_external) ==

== DSL (svc_dsl) ==

* [[Freeside:3:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]

= Packages =

{{Freeside:3:Documentation:Administration:pkg_category}}

== Price Plans ==

=== Common price plans ===

* flat
* subscription
* prorate
* sqlradacct_hour
* [[voip_cdr]]
* prepaid

=== Wholesale price plans ===

* bulk

* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |
 cdr_termination ]]

=== Other price plans ===

* flat_delayed
* flat_introrate
* prorate_delayed

* base_delayed
* base_rate

* sql_external
* sql_generic

=== Price plans of questionable functionality ===

* flat_comission_cust
* flat_comission_pkg
* flat_comission

* voip_sqlradacct

* sesmon_hour
* sesmon_minute

== Misc ==

* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]

= Resellers =

= Employees =

== Employees ==

Go to Configuration -> Employees -> Employees to view the existing employees and add new ones.  It is highly recommended to add a separate account for each person rather than using role accounts.

* To add a new employee, click on "Add an employee"
* Or to edit an existing group, click on the employee number or name in the list of employees.
* Enter or edit the username, password and name.  If editing an existing employee and no password change is desired, the password fields can be left blank.
* Check the "Disable employee" box to disable this employee.
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.

== Employee groups and access control == 

To setup employee access control or agent/reseller virtualization, you need to setup employee groups.  Go to Configuration -> Employees -> Employee groups to view the existing groups and add new ones.  The system starts with a "Superuser" group which has access to all functionality for the first agent.

* To add a new group, click on "Add an employee group"
* Or to edit an existing group, click on the group number or name in the list of groups.
* Enter or edit the group name.
* In the "Group limited to these agent(s)" section, mark checkboxes next to the agents this employee group should be able to see.  Employees in this group will only see customers of the selected agents in the system and reports.
* In the "Group access rights" section, mark or unmark checkboxes to indicate the access rights this employee group should have.  Rights marked with an "*" are global rights which provide access to global data which is shared among all agents. Their use is not recommended for groups which are limited to a subset of agents.
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.

= Billing =

== Billing events ==
Billing events are the primary mechanism to implement your business rules.  Rules such as resend invoices, retry cards, suspend or cancel accounts for non-payment, etc. are all handled by billing events.

At a high level, follow the following steps to create billing events:
* Add a new Billing Event (Configuration > Billing > Billing events)
* Name the event
* Choose the type of event:
** Package - Packages and associated dates (Including Commissions)
** Invoice - Invoice status and dates
** Customer - Customer Balances and Information
** Batch Payment - Batch payment results
** Statement - Send statement 
* Choose whether to apply to one or all agents
* Choose the frequency for the system to check and see if the event should run.
* Choose appropriate filters.  
* Choose appropriate actions.

The form is dynamic so changing the type of event will change the available filters and actions.

== Daily and Monthly Scripts ==
* The freeside-daily script should be run daily to bill customers and run invoice collection events.
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre>
** If running freeside-daily manually, ensure the <code>TZ</code> variable is set to your timezone with a command such as: <pre>TZ="US/Pacific" freeside-daily fs_daily</pre>
* If any monthly events are enabled, the freeside-monthly script should be run monthly.
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)
* Be sure to include the full path of freeside-daily in your cron job.

== Invoices ==

=== Typeset (LaTeX) invoice templates ===

==== Prerequisites ====

* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.
* Install [http://www.ghostscript.com/ Ghostscript] (gs)
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed

==== Logo setup ====

The <em title="Encapsulated Postscript">EPS</em> logo is for PDF and printed invoices.

* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format.  
** Your graphic artist can create vector image from a bitmap (tracing etc).
** Converting a bitmap such as a JPG can work (the bigger the better), but it may render in lower quality, blurry or with the "jaggies" (especially when actually printed, not just viewed as a PDF)
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
** ("no %%BoundingBox:" error?  Fix with eps2eps)
* Upload the resized logo as the <code>logo.eps</code> configuration option.
* Problems?  Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The <em title="Portable Network Graphic">PNG</em> logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62.  Any logo close to this size should work with the default HTML template.

{{Freeside:3:Documentation:Administration:invoice_layout}}

=== HTML invoice templates ===

* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option. 
{{Freeside:3:Documentation:Administration:invoice_templates|format=html}}

=== Plaintext invoice templates ===

* See the Text::Template documentation for details on the substitution language.
* You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices).
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]

=== Misc ===

==== Manually setting next customer number sequence ====

* With PostgreSQL, to number customers starting at 5000: <pre>SELECT SETVAL(pg_get_serial_sequence('cust_main', 'custnum'), 4999);</pre>
* With MySQL, to number customers starting at 5000: <pre>ALTER TABLE cust_main AUTO_INCREMENT = 5000;</pre>

==== Manually setting next invoice number sequence ====

* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(pg_get_serial_sequence('cust_bill', 'invnum'), 4999);</pre>
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre>

== Payment Receipts ==

The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.

== Credit cards and Electronic checks ==
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.

= Misc =

These things should probably find a home properly filed in a section above.

== Invoicing and Payments ==

* Setting up [[Freeside:3:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]] (default in new installs, highly recommended for older installs upgrading)
* Setting up [[Freeside:3:Documentation:Administration:Texas Tax | Texas Tax]]
* Need to print to Windows printers, and the PDF spool is not for you?  Follow steps 1-4 of  [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].

== Commissions ==

<!-- Superseded by Commissions below... * Setting up [[Freeside:1.9:Documentation:Administration:Referral credits|Referral credits]] -->
* Setting up [[Freeside:3:Documentation:Administration:Commission|Commissions and Referrals]]

== VoIP ==

* Setting up [[Freeside:3:Documentation:Administration:VoIP | VoIP]]
* [[Bulk DID Orders]]

== RADIUS ==

* Setting up [[Freeside:3.0:Documentation:Administration:FreeRadius | FreeRadius]]

== Old / uncommon ==

* Setting up [[Freeside:2.1:Documentation:Administration:Time billing | Time billing]]
* Using a non-standard [[Freeside:2.1:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]
* Setting up [[Freeside:2.1:Documentation:Administration:Slony | Slony replication and failover]] (old - PostgreSQL native replication is a more current solution)

{{ContextSensitiveHelp}}