Freeside - User contributions [en]

Category:Freeside:1.7:Documentation:Template

2008-03-03T22:18:49Z

Supaplex:

See below for the list of templates that have fill in values (eg Text::Template or similar)

== See Also ==

* [http://search.cpan.org/perldoc/Text::Template Text::Template Documentation] on [[CPAN]]
* [[Freeside:1.7:Documentation:Administration]]

Freeside:1.7:Documentation:Template:payment receipt email

2008-03-03T22:18:39Z

Supaplex: /* See Also */

[[Category:Freeside:1.7:Documentation:Template]]

This template is emailed to customers when a manual payment is applied. A customer or support rep can initiate this. This applies to '''Process credit card''' and '''Process electronic check ([[ACH]])''' payment links. If the value is set to '''NO''', the template is ignored.

You may configure this template from '''Configuration''', then '''Settings''' then '''payment_receipt_email'''. You can use <code>ctrl-f</code> (or <code>cmd-f</code> on macs) to search on the page.

First, apply a payment to the customer http://420.am/~supaplex/screenshots/post-cash-payment.png
, then they'll receive the payment email like http://420.am/~supaplex/screenshots/received-payment_receipt_email.png

== Defaults ==

On a new install, the checkbox is ticked (enabled).

Default template:

<code>
<pre>
{ $date }

Dear { $name },

This message is to inform you that your payment of ${ $paid } has been
received.

Payment ID: { $paynum }
Date: { $date }
Amount: { $paid }
Type: { $payby } # { $payinfo }

{
if ( $balance > 0 ) {
$OUT .= "Your current balance is now \$$balance.\n\n";
} elsif ( $balance < 0 ) {
$OUT .= 'You have a credit balance of $'. sprintf("%.2f",0-$balance).
".\n".
"Future charges will be deducted from this balance before billing ".
"you again.\n\n";

}
}
Thank you for your business.

</pre>
</code>

== Variables ==

;$date
:The date
;$name
:Customer name
;$paynum
:Freeside payment number
;$paid
:Amount of payment
;$payby
:Payment type (Card, Check, Electronic check, etc.)
;$payinfo
:Masked credit card number or check number
;$balance
:New balance

Freeside:1.7:Documentation:Administration

2008-03-03T22:10:26Z

Supaplex: /* Payment Receipts */

= 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:1.7:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This [[Freeside:1.7:Documentation:backend_service|service]] needs to be running before exports are acted upon.

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==
* 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:
* 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
* 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
* 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
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* 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.
* 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.
* 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_external==
* artera_turbo.pm:

= Services =

* Some rough notes on setting up [[Freeside:1.7:Documentation:Administration:Services:svc_acct|username-based services]]

= Packages =

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

= Resellers =

= Employees =

= Billing =

== Invoice events ==

* Use invoice events to implement your business rules for re-sending invoices and late notices, retrying cards, suspending, etc.
<code>Configuration -> Billing -> View/Edit invoice events</code>
* 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)

== Invoice templates ==

=== 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

=== Content setup ===

* Edit the invoice_latexreturnaddress, invoice_latexfooter, invoice_latexnotes, and invoice_latexsmallfooter configuration options. If you are adventurous, edit invoice_latex as well.

==== Logo setup ====

The EPS 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).
** In a pinch, converting a large detailed bitmap can work. However, it still may not perform well.
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
* Copy the resized logo to <code>/usr/local/etc/freeside/conf.''your_datasrc/logo.eps''</code>
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The PNG logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62. Any logo close to this size should work. The important factor is how your invoices look. This may require some trial and error until it looks good everywhere.

=== HTML invoice templates ===

* Place your logo in PNG format at <code>/usr/local/etc/freeside/conf.''your_datasrc''/logo.png</code>
* Edit the invoice_html configuration option or the <code>/usr/local/etc/freeside/conf.''your_datasrc''/invoice_html</code> file. HTML invoices use Text::Template with <%= and %> delimiters.
* The following configuration options can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: invoice_htmlreturnaddress, and invoice_htmlfooter, invoice_htmlnotes.

=== 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.7:Documentation:Template:invoice_html|invoice_html]]

=== Payment Receipts ===

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

== Credit cards and Electronic checks ==
* [[Freeside:1.7:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.7: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 =

* Setting up [[Freeside:1.7:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]
* Setting up [[Freeside:1.7:Documentation:Administration:Texas Tax | Texas Tax]]
* Setting up [[Freeside:1.7:Documentation:Administration:VoIP | VoIP]]
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].
* Setting up [[Freeside:1.7:Documentation:Administration:Slony | Slony replication and failover]]

{{ContextSensitiveHelp}}

2008-02-27T17:03:35Z

Supaplex:

Pages in this category include the <nowiki>{{ContextSensitiveHelp}}</nowiki> template. Please see [[Template:ContextSensitiveHelp]] for editing guidelines and template use.

Template:ContextSensitiveHelp

2008-02-27T17:01:43Z

Supaplex:

<includeonly><div style="background: #F0F0F0;">This page is part of the [[Freeside]] Context Sensitive Help. Please review the [[:Template:ContextSensitiveHelp#Editing_Guidelines|Editing Guidelines]] before making modifications to this page.</div>[[Category:Context sensitive help]]</includeonly><noinclude>

This template, included by <nowiki>{{ContextSensitiveHelp}}</nowiki> is for inclusion on pages where an installed [[Freeside]] instance may reference the wiki for Context Sensitive Help. This should make it more clear which pages are sensitive to specific changes.

== Editing Guidelines ==

There are a few issues of concern while editing pages containing this template.

=== Topic Names ===

It's especially important to not modify names of topic headers <nowiki>( such as </nowiki><nowiki>== Topic ==</nowiki><nowiki> )</nowiki>. Freeside help relies upon wiki generated <pre style="padding: inherit; border: none; display: inline;"><a name="topic"></a></pre> html anchors.

=== Discuss when in doubt ===

Please do not edit the documentation lightly, just because you have an installation problem. (Thanks Ivan)

Your comments in the Discussion page is still welcome. However, it will only be seen by a fraction of the [[Freeside:Community_Portal|Freeside community]].
</noinclude>

Freeside:1.7:Documentation:Administration

2008-02-27T17:01:16Z

Supaplex:

{{ContextSensitiveHelp}}
= 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:1.7:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This [[Freeside:1.7:Documentation:backend_service|service]] needs to be running before exports are acted upon.

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==
* 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:
* 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
* 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
* 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
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* 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.
* 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.
* 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_external==
* artera_turbo.pm:

= Services =

* Some rough notes on setting up [[Freeside:1.7:Documentation:Administration:Services:svc_acct|username-based services]]

= Packages =

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

= Resellers =

= Employees =

= Billing =

== Invoice events ==

* Use invoice events to implement your business rules for re-sending invoices and late notices, retrying cards, suspending, etc.
<code>Configuration -> Billing -> View/Edit invoice events</code>
* 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)

== Invoice templates ==

=== 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

=== Content setup ===

* Edit the invoice_latexreturnaddress, invoice_latexfooter, invoice_latexnotes, and invoice_latexsmallfooter configuration options. If you are adventurous, edit invoice_latex as well.

==== Logo setup ====

The EPS 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).
** In a pinch, converting a large detailed bitmap can work. However, it still may not perform well.
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
* Copy the resized logo to <code>/usr/local/etc/freeside/conf.''your_datasrc/logo.eps''</code>
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The PNG logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62. Any logo close to this size should work. The important factor is how your invoices look. This may require some trial and error until it looks good everywhere.

=== HTML invoice templates ===

* Place your logo in PNG format at <code>/usr/local/etc/freeside/conf.''your_datasrc''/logo.png</code>
* Edit the invoice_html configuration option or the <code>/usr/local/etc/freeside/conf.''your_datasrc''/invoice_html</code> file. HTML invoices use Text::Template with <%= and %> delimiters.
* The following configuration options can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: invoice_htmlreturnaddress, and invoice_htmlfooter, invoice_htmlnotes.

=== 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).
* In addition, the following variables are available:
** $invnum - invoice number
** $date - as a UNIX timestamp (see Date::Format for conversion functions).
** $page - current page
** $total_pages - total pages
** @address - A six-element array containing the customer name, company, and address.

=== Payment Receipts ===

The [[Freeside:1.7/Configuration/settings/payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.

== Credit cards and Electronic checks ==
* [[Freeside:1.7:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.7: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 =

* Setting up [[Freeside:1.7:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]
* Setting up [[Freeside:1.7:Documentation:Administration:Texas Tax | Texas Tax]]
* Setting up [[Freeside:1.7:Documentation:Administration:VoIP | VoIP]]
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].
* Setting up [[Freeside:1.7:Documentation:Administration:Slony | Slony replication and failover]]