http://www.freeside.biz/mediawiki/api.php?action=feedcontributions&user=Levinse&feedformat=atomFreeside - User contributions [en]2024-03-28T15:23:14ZUser contributionsMediaWiki 1.27.7http://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian6&diff=6396Freeside:2.1:Documentation:InstallingOnDebian62011-05-09T23:46:31Z<p>Levinse: /* Verify the correct locale is set */</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 6.0 "squeeze"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-squeeze/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
* cpan HTTP::Server::Simple::Mason (the one in the squeeze repo is an older version than required by RT)<br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.4/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.4 main --stop<br />
pg_createcluster --locale en_US 8.4 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql restart<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:2.1:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian6&diff=6395Freeside:2.1:Documentation:InstallingOnDebian62011-05-06T16:05:55Z<p>Levinse: /* Install the Appropriate Packages */</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 6.0 "squeeze"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-squeeze/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
* cpan HTTP::Server::Simple::Mason (the one in the squeeze repo is an older version than required by RT)<br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.4/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.4 main --stop<br />
pg_createcluster --locale en_US 8.4 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.4 restart<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:2.1:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian6&diff=6394Freeside:2.1:Documentation:InstallingOnDebian62011-05-06T16:05:35Z<p>Levinse: /* Install the Appropriate Packages */</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 6.0 "squeeze"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-squeeze/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
* cpan HTTP::Server::Simple::Mason (the one in squeeze is an older version that required by RT)<br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.4/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.4 main --stop<br />
pg_createcluster --locale en_US 8.4 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.4 restart<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:2.1:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian5&diff=6393Freeside:2.1:Documentation:InstallingOnDebian52011-05-06T16:04:46Z<p>Levinse: </p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 5.0 "lenny" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 5.0 "lenny"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-lenny/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.3/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.3 main --stop<br />
pg_createcluster --locale en_US 8.3 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.3 start<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:1.9:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian6&diff=6392Freeside:2.1:Documentation:InstallingOnDebian62011-05-06T16:04:20Z<p>Levinse: /* Install the Appropriate Packages */</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 6.0 "squeeze"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-squeeze/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.4/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.4 main --stop<br />
pg_createcluster --locale en_US 8.4 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.4 restart<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:2.1:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian5&diff=6391Freeside:2.1:Documentation:InstallingOnDebian52011-05-06T16:03:30Z<p>Levinse: </p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 5.0 "lenny" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 5.0 "lenny"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-lenny/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc libhttp-server-simple-mason-perl </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.3/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.3 main --stop<br />
pg_createcluster --locale en_US 8.3 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.3 start<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:1.9:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian6&diff=6390Freeside:2.1:Documentation:InstallingOnDebian62011-05-06T16:03:12Z<p>Levinse: /* Install the Appropriate Packages */</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 6.0 "squeeze"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-squeeze/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc libhttp-server-simple-mason-perl </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.4/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.4 main --stop<br />
pg_createcluster --locale en_US 8.4 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.4 restart<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:2.1:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian6&diff=6389Freeside:2.1:Documentation:InstallingOnDebian62011-05-06T15:37:23Z<p>Levinse: /* Verify the correct locale is set */</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 6.0 "squeeze"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-squeeze/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.4/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.4 main --stop<br />
pg_createcluster --locale en_US 8.4 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.4 restart<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:2.1:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian6&diff=6388Freeside:2.1:Documentation:InstallingOnDebian62011-05-06T15:36:26Z<p>Levinse: </p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 6.0 "squeeze"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-squeeze/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.4/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.4 main --stop<br />
pg_createcluster --locale en_US 8.4 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.4 start<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:2.1:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian6&diff=6387Freeside:2.1:Documentation:InstallingOnDebian62011-05-06T15:36:10Z<p>Levinse: New page: = Notes = Note: All of the commands on this page must be run as root. == Operating System == * Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group. == ...</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 6.0 "squeeze" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 5.0 "lenny"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-squeeze/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.4/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.4 main --stop<br />
pg_createcluster --locale en_US 8.4 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.4 start<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:2.1:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation&diff=6386Freeside:2.1:Documentation2011-05-06T15:11:12Z<p>Levinse: /* Backend Installation */</p>
<hr />
<div>= Note =<br />
<br />
Some documentation links point to the 1.9 documentation until things are fully moved over. The information should still be applicable.<br />
<br />
= Installation and upgrades =<br />
<br />
== Backend Installation ==<br />
<br />
* [[Freeside:2.1:Documentation:Installation|New Installation]]<br />
* [[Freeside:2.1:Documentation:RT Installation|Integrated RT Installation]]<br />
* OS-specific installation guides (source)<br />
** [[Freeside:2.1:Documentation:InstallingOnDebian5|Debian 5.0 "lenny"]]<br />
** [[Freeside:2.1:Documentation:InstallingOnDebian6|Debian 6.0 "squeeze"]]<br />
** [[Freeside:2.1:Documentation:Installation:Ubuntu|Ubuntu 10.4 LTS]]<br />
**[[Freeside:2.1:Documentation:Installation:FreeBSD|FreeBSD 8.1]] - Feedback please!<br />
* OS-specific installation guides (packages)<br />
** (no 2.1 packages yet) <strike>[[Freeside:1.9:Documentation:InstallingUsingAPT|Debian packages]]</strike><br />
** (no 2.1 packages yet) <strike>[[Freeside:1.9:Documentation:InstallingUsingRPM|CentOS/RHEL RPM packages]]</strike><br />
<br />
== Signup and Self-service installation ==<br />
<br />
* [[Freeside:2.1:Documentation:Self-Service Installation|Signup/Self-service Installation]]<br />
<br />
== Distributor guides ==<br />
<br />
* [[Freeside:Documentation:CreatingRPMRepo|Creating your own repository with Freeside RPMs]]<br />
<br />
* [[Freeside:Documentation:MirroringRPMRepo|Creating and using a mirror of the Freeside Internet Services RPM repositories]]<br />
<br />
* [[Freeside:Documentation:RPMBuildSystem|Documentation on the RPM build system]]<br />
<br />
== Upgrading ==<br />
<br />
* [[Freeside:2.1:Documentation:Upgrading|Upgrading from 1.9.X to 2.1.x]]<br />
* [[Freeside:2.1.1:Documentation:Upgrading|Upgrading from 2.1.0 to 2.1.1]]<br />
* [[Freeside:2.1.2:Documentation:Upgrading|Upgrading from 2.1.1 to 2.1.2]]<br />
* [[Freeside:2.1.3:Documentation:Upgrading|Upgrading from 2.1.2 to 2.1.3]]<br />
<br />
= User's Guide =<br />
<br />
* [[Freeside:2.1:Documentation:User|User's Guide]] (help wanted)<br />
* [http://www.sisd.com/~ivan/freeside-slides Training presentation slides]<br />
<br />
= Administrator's Guide =<br />
<br />
* [[Freeside:2.1:Documentation:Administration|Administrator's Guide]]<br />
* [[Freeside:Documentation:DisasterRecovery|Disaster Recovery]]<br />
* [[:Category:Freeside:1.9:Documentation:Template|Templates]] used and their fill in variables.<br />
<br />
= Developer's Guide =<br />
<br />
* [[Freeside:2.1:Documentation:Developer|Developer's Guide]]<br />
<br />
= Accounting Guide =<br />
<br />
*[[Freeside:Documentation:Accounting|Accounting Guide]]<br />
<br />
= Misc =<br />
<br />
* [[Freeside:Documentation:FAQ|Frequently Asked Questions]]<br />
* [[3rd_party_software|Third-party software]]<br />
* [[Freeside:2.1:Documentation:Administration:VoIP:Timed_Rates|New feature: Timed Rates]]<br />
* [[Freeside:2.1:Documentation:Administration:RT_Workflow|RT workflow features]]<br />
* [[Freeside:2.1:Documentation:Administration:Tips_and_Tricks|Tips and Tricks]]<br />
<br />
* [[Freeside:1.9:Documentation|Version 1.9 documentation]] (previous maintenance version)<br />
* [[Freeside:2.3:Documentation|Version 2.3 documentation]] (upcoming development version)<br />
<br />
= Changelog =<br />
<br />
* [[Freeside:2.1:Changelog|2.1 Changelog]]<br />
* [[Freeside:2.1.1:Changelog|2.1.1 Changelog]]<br />
* [[Freeside:2.1.2:Changelog|2.1.2 Changelog]]<br />
* [[Freeside:2.1.3:Changelog|2.1.3 Changelog]]</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian5&diff=6385Freeside:2.1:Documentation:InstallingOnDebian52011-05-05T04:02:40Z<p>Levinse: /* Install the Appropriate Packages */</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 5.0 "lenny" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 5.0 "lenny"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-lenny/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p psmisc </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.3/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.3 main --stop<br />
pg_createcluster --locale en_US 8.3 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.3 start<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:1.9:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian5&diff=6383Freeside:2.1:Documentation:InstallingOnDebian52011-05-03T18:57:31Z<p>Levinse: </p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 5.0 "lenny" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 5.0 "lenny"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-lenny/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl sam2p </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.3/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.3 main --stop<br />
pg_createcluster --locale en_US 8.3 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.3 start<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:1.9:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6382Freeside:2.3:Documentation:Administration:svc dsl:ikano2011-04-29T19:10:55Z<p>Levinse: /* Import Mode */</p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt_address_format and (unless using prospects for something else) prospect_main-alt_address_format.<br />
<br />
USPS validation is extremely useful to have working; if so (unless using prospects for something else) prospect_main-location_required<br />
<br />
= Employee Groups =<br />
<br />
Give the "Qualify Service" ACL to the groups which should be allowed to run DSL qualifications.<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
* Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
* Export Host - not used, may be set to anything<br />
<br />
* Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
* Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
[[Image:Svc dsl-ikano2.png]]<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
# In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
# Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package<br />
<br />
= Import Mode =<br />
<br />
Import Mode may be used in case existing Ikano orders/data need to be imported into Freeside. <br />
<br />
# Perform initial setup as per the rest of the documentation above<br />
# Enable the Import Mode export option on the Ikano export<br />
# For each customer having an Ikano order that needs to be imported:<br />
## Order the Freeside package corresponding to the Ikano package<br />
## Click on the DSL service provisioning, set the Ikano order id, and add the service<br />
## Order data will be synced automatically in real-time. Due to the Ikano API, some fields will not be imported when using this process. For example, the Ikano qualification ID and order address will not be imported.<br />
# Disable the Import Mode export option on the Ikano export and do not enable it again in future<br />
<br />
<br />
''IMPORTANT WARNINGS'':<br />
* Most data validation is disabled when using Import Mode. Therefore, there is a small possibility that invalid data present on Ikano orders may be imported into Freeside.<br />
* As data is synced automatically from Ikano in Import Mode based solely on the order ID entered, it's important to:<br />
** Order the correct Freeside package which corresponds to the Ikano package<br />
** Set the correct Ikano order ID (matching the customer, package, and service address) when provisioning the DSL service<br />
** Set the correct service address on the package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6381Freeside:2.3:Documentation:Administration:svc dsl:ikano2011-04-29T19:09:12Z<p>Levinse: /* Import Mode */</p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt_address_format and (unless using prospects for something else) prospect_main-alt_address_format.<br />
<br />
USPS validation is extremely useful to have working; if so (unless using prospects for something else) prospect_main-location_required<br />
<br />
= Employee Groups =<br />
<br />
Give the "Qualify Service" ACL to the groups which should be allowed to run DSL qualifications.<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
* Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
* Export Host - not used, may be set to anything<br />
<br />
* Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
* Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
[[Image:Svc dsl-ikano2.png]]<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
# In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
# Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package<br />
<br />
= Import Mode =<br />
<br />
Import Mode may be used in case existing Ikano orders/data need to be imported into Freeside. <br />
<br />
# Perform initial setup as per the rest of the documentation above<br />
# Enable the Import Mode export option on the Ikano export<br />
# For each customer having an Ikano order that needs to be imported:<br />
## Order the Freeside package corresponding to the Ikano package, <br />
## Click on the DSL service provisioning, set the Ikano order id and add the service<br />
## Order data will be synced automatically in real-time. Due to the Ikano API, some fields will not be imported when using this process. For example, the Ikano qualification ID and order address will not be imported.<br />
# Disable the Import Mode export option on the Ikano export and do not enable it again in future<br />
<br />
<br />
''IMPORTANT WARNINGS'':<br />
* Most data validation is disabled when using Import Mode. Therefore, there is a small possibility that invalid data present on Ikano orders may be imported into Freeside.<br />
* As data is synced automatically from Ikano in Import Mode based solely on the order ID entered, it's important to:<br />
** Order the correct Freeside package which corresponds to the Ikano package<br />
** Set the correct Ikano order ID (matching the customer, package, and service address) when provisioning the DSL service using Import Mode<br />
** Set the correct service address on the package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6380Freeside:2.3:Documentation:Administration:svc dsl:ikano2011-04-29T19:07:12Z<p>Levinse: </p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt_address_format and (unless using prospects for something else) prospect_main-alt_address_format.<br />
<br />
USPS validation is extremely useful to have working; if so (unless using prospects for something else) prospect_main-location_required<br />
<br />
= Employee Groups =<br />
<br />
Give the "Qualify Service" ACL to the groups which should be allowed to run DSL qualifications.<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
* Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
* Export Host - not used, may be set to anything<br />
<br />
* Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
* Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
[[Image:Svc dsl-ikano2.png]]<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
# In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
# Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package<br />
<br />
= Import Mode =<br />
<br />
Import Mode may be used in case existing Ikano orders/data need to be imported into Freeside. <br />
<br />
# Perform initial setup as per the rest of the documentation above<br />
# Enable the Import Mode export option on the Ikano export<br />
# For each customer having an Ikano order that needs to be imported:<br />
## Order the Freeside package corresponding to the Ikano package, <br />
## Click on the DSL service provisioning, set the Ikano order id and add the service<br />
## Order data will be synced automatically in real-time. Due to the Ikano API, some fields will not be imported when using this process. For example, the Ikano qualification ID and order address will not be imported.<br />
# Disable the Import Mode export option on the Ikano export and do not enable it again in future<br />
<br />
IMPORTANT WARNINGS:<br />
* Most data validation is disabled when using Import Mode. Therefore, there is a small possibility that invalid data present on Ikano orders may be imported into Freeside.<br />
* As data is synced automatically from Ikano in Import Mode based solely on the order ID entered, it's important to:<br />
** Order the correct Freeside package which corresponds to the Ikano package<br />
** Set the correct Ikano order ID (matching the customer, package, and service address) when provisioning the DSL service using Import Mode<br />
** Set the correct service address on the package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Bulk_DID_Orders&diff=6378Bulk DID Orders2011-04-19T23:40:10Z<p>Levinse: </p>
<hr />
<div>= Setup =<br />
* Create an internal_diddb export and an svc_phone service<br />
* Configuration -> Phone -> View/Edit bulk DID vendors: setup your vendors<br />
* The upgrade and setup programs automatically populate LATA and MSA tables with appropriate data<br />
<br />
= Usage =<br />
* Creating an order: Tools -> Bulk DID Orders -> Add a bulk DID Order<br />
* Uploading inventory,:<br />
** From the order browse page (Tools -> Bulk DID Orders), click on Upload Received; or<br />
** From Tools -> Importing -> DIDs<br />
* Confirming an order:<br />
** from the order browse page, by clicking on the Confirm link for any unconfirmed order; or<br />
** by setting the confirmation date when editing an order; or<br />
** when importing DIDs for the order (see above)<br />
* Bulk provisioning DIDs for a customer:<br />
** from the order browse page, for any order for which DIDs have been assigned to a customer and have been uploaded/received and have not yet been provisioned, click on the Provision link<br />
* Canceling an order: from the order browse page, click on the Cancel link<br />
* Viewing DIDs received for an order: from the order browse page, for any orders for which DIDs have been uploaded/received, click on the date under the Received column<br />
* Assigning DIDs which will be received on an order, to a customer (not the same as provisioning them): from the add or edit order pages, click on the radio button beside Customer and enter the customer details<br />
* Viewing orders having DIDs received for a customer but not yet provisioned:<br />
** from the order browse page, click on "Browse all non-stock orders with received unprovisioned DIDs" (displays such DIDs for all customers); or<br />
** from a customer view page, click on the "Browse Received DID Inventory" links in the Services column (displays such DIDs for a particular customer)</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Bulk_DID_Orders&diff=6377Bulk DID Orders2011-04-19T23:39:19Z<p>Levinse: </p>
<hr />
<div>= Setup =<br />
* Create an internal_diddb export and an svc_phone service<br />
* Configuration -> Phone -> View/Edit bulk DID vendors: setup your vendors<br />
* The upgrade and setup programs automatically populate LATA and MSA tables with appropriate data<br />
<br />
= Usage =<br />
* Creating an order: Tools -> Bulk DID Orders -> Add a bulk DID Order<br />
* Uploading inventory,:<br />
** From the order browse page (Tools -> Bulk DID Orders), click on Upload Received; or<br />
** From Tools -> Importing -> DIDs<br />
* Confirming an order:<br />
** from the order browse page, by clicking on the Confirm link for any unconfirmed order; or<br />
** by setting the confirmation date when editing an order; or<br />
** when importing DIDs for the order (see above)<br />
* Provisioning DIDs for a customer:<br />
** from the order browse page, for any order for which DIDs have been assigned to a customer and have been uploaded/received and have not yet been provisioned, click on the Provision link<br />
* Canceling an order: from the order browse page, click on the Cancel link<br />
* Viewing DIDs received for an order: from the order browse page, for any orders for which DIDs have been uploaded/received, click on the date under the Received column<br />
* Assigning DIDs which will be received on an order, to a customer (not the same as provisioning them): from the add or edit order pages, click on the radio button beside Customer and enter the customer details<br />
* Viewing orders having DIDs received for a customer but not yet provisioned:<br />
** from the order browse page, click on "Browse all non-stock orders with received unprovisioned DIDs" (displays such DIDs for all customers); or<br />
** from a customer view page, click on the "Browse Received DID Inventory" links in the Services column (displays such DIDs for a particular customer)</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Voip_cdr&diff=6373Voip cdr2011-04-13T00:18:58Z<p>Levinse: New page: = Region Groups = # Configure a package with the voip_cdr plan # Use the "prefix" rating_method and set min_included to whatever you wish to include for the region group # Create a rate p...</p>
<hr />
<div>= Region Groups =<br />
<br />
# Configure a package with the voip_cdr plan<br />
# Use the "prefix" rating_method and set min_included to whatever you wish to include for the region group<br />
# Create a rate plan with all the prefixes and rates per prefix. Connection charges and included minutes per region may be unsupported when using region groups, so they should probably be set to zero for now.<br />
# Only one region group per rate plan is supported currently. For any regions that need to be included into the group, edit each rate detail and check the "Region Group" box.<br />
# Don't provision more than one svc_phone in the package used with this plan</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:Administration&diff=6372Freeside:2.1:Documentation:Administration2011-04-13T00:04:11Z<p>Levinse: /* Common price plans */</p>
<hr />
<div>= Exports (provisioning) =<br />
<br />
'''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.<br />
<br />
Exports can be added and edited under<br />
: Configuration -> Provisioning, services and packages -> View/edit exports<br />
<br />
Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.<br />
<br />
Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].<br />
<br />
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.<br />
<br />
Exports are activated by associating them with one or more '''service definitions'''.<br />
<br />
Following is a list of which exports can be associated with each type of service.<br />
<br />
==svc_acct==<br />
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service<br />
* acct_sql.pm: Real-time export of accounts to SQL databases .<br />
* artera_turbo.pm: <br />
* bsdshell.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* communigate_pro_singledomain.pm: <br />
* cpanel.pm: Real-time export to Cpanel control panel.<br />
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol<br />
* cyrus.pm: Real-time export to Cyrus IMAP server<br />
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service<br />
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI<br />
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]: Real-time export to LDAP<br />
* passwdfile.pm:<br />
* radiator.pm: Real-time export to RADIATOR<br />
* shellcommands.pm: <br />
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)<br />
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms<br />
* sysvshell.pm: <br />
* textradius.pm: <br />
* vpopmail.pm: Real-time export to vpopmail text files<br />
<br />
==svc_domain==<br />
* bind.pm: Batch export to BIND named<br />
* bind_slave.pm: Batch export to slave BIND named<br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).<br />
* domain_sql.pm: Real time export of domains to SQL databases .<br />
* http.pm: Send an HTTP or HTTPS GET or POST request<br />
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_forward==<br />
* artera_turbo.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* forward_shellcommands.pm: Run remote commands via SSH, for forwards<br />
* postfix.pm: Postfix text files<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_www==<br />
* apache.pm: Export an Apache httpd.conf file snippet.<br />
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service<br />
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)<br />
<br />
==svc_broadband==<br />
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.<br />
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface<br />
* router.pm: Send a command to a router.<br />
* snmp.pm: Sends SNMP SETs to an SNMP agent.<br />
* trango.pm: Sends SNMP SETs to a Trango AP.<br />
<br />
==svc_phone==<br />
* globalpops_voip.pm:<br />
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.<br />
* indosoft.pm:<br />
* internal_diddb.pm:<br />
* netsapiens.pm:<br />
* phone_shellcommands.pm:<br />
* phone_sqlradius.pm:<br />
* thirdlane.pm:<br />
* vitelity.pm:<br />
<br />
==svc_external==<br />
* artera_turbo.pm:<br />
<br />
==svc_dsl==<br />
* ikano.pm: see [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Services =<br />
<br />
== Accounts (svc_acct) ==<br />
<br />
* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]<br />
<br />
== Domains (svc_domain) ==<br />
<br />
== Forwards (svc_forward) ==<br />
<br />
== Hosting (svc_www) ==<br />
<br />
== Broadband (svc_broadband) ==<br />
<br />
== Phone (svc_phone) ==<br />
[[Vitelity]]<br />
<br />
== External (svc_external) ==<br />
<br />
== DSL (svc_dsl) ==<br />
<br />
* [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Packages =<br />
<br />
{{Freeside:1.9:Documentation:Administration:pkg_category}}<br />
<br />
== Price Plans ==<br />
<br />
=== Common price plans ===<br />
<br />
* flat<br />
* subscription<br />
* prorate<br />
* sqlradacct_hour<br />
* [[voip_cdr]]<br />
* prepaid<br />
<br />
=== Wholesale price plans ===<br />
<br />
* bulk<br />
<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |<br />
cdr_termination ]]<br />
<br />
=== Other price plans ===<br />
<br />
* flat_delayed<br />
* flat_introrate<br />
* prorate_delayed<br />
<br />
* base_delayed<br />
* base_rate<br />
<br />
* sql_external<br />
* sql_generic<br />
<br />
=== Price plans of questionable functionality ===<br />
<br />
* flat_comission_cust<br />
* flat_comission_pkg<br />
* flat_comission<br />
<br />
* voip_sqlradacct<br />
<br />
* sesmon_hour<br />
* sesmon_minute<br />
<br />
== Misc ==<br />
<br />
* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]<br />
<br />
= Resellers =<br />
<br />
= Employees =<br />
<br />
== Employees ==<br />
<br />
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.<br />
<br />
* To add a new employee, click on "Add an employee"<br />
* Or to edit an existing group, click on the employee number or name in the list of employees.<br />
* 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.<br />
* Check the "Disable employee" box to disable this employee.<br />
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.<br />
<br />
== Employee groups and access control == <br />
<br />
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.<br />
<br />
* To add a new group, click on "Add an employee group"<br />
* Or to edit an existing group, click on the group number or name in the list of groups.<br />
* Enter or edit the group name.<br />
* 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.<br />
* 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.<br />
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.<br />
<br />
= Billing =<br />
<br />
== Billing events ==<br />
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.<br />
<br />
At a high level, follow the following steps to create billing events:<br />
* Add a new Billing Event (Configuration > Billing > Billing events)<br />
* Name the event<br />
* Choose the type of event:<br />
** Package - Packages and associated dates (Including Commissions)<br />
** Invoice - Invoice status and dates<br />
** Customer - Customer Balances and Information<br />
** Batch Payment - Batch payment results<br />
** Statement - Send statement <br />
* Choose whether to apply to one or all agents<br />
* Choose the frequency for the system to check and see if the event should run.<br />
* Choose appropriate filters. <br />
* Choose appropriate actions.<br />
<br />
The form is dynamic so changing the type of event will change the available filters and actions.<br />
<br />
== Daily and Monthly Scripts ==<br />
* The freeside-daily script should be run daily to bill customers and run invoice collection events.<br />
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre><br />
** 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><br />
* If any monthly events are enabled, the freeside-monthly script should be run monthly.<br />
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)<br />
<br />
== Invoices ==<br />
<br />
=== Typeset (LaTeX) invoice templates ===<br />
<br />
==== Prerequisites ====<br />
<br />
* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.<br />
* Install [http://www.ghostscript.com/ Ghostscript] (gs)<br />
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]<br />
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed<br />
<br />
==== Logo setup ====<br />
<br />
The <em title="Encapsulated Postscript">EPS</em> logo is for PDF and printed invoices.<br />
<br />
* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format. <br />
** Your graphic artist can create vector image from a bitmap (tracing etc).<br />
** 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)<br />
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code><br />
* Upload the resized logo as the <code>logo.eps</code> configuration option.<br />
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code><br />
<br />
The <em title="Portable Network Graphic">PNG</em> logo is for emailed and online invoices.<br />
<br />
Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.<br />
<br />
{{Freeside:1.9:Documentation:Administration:invoice_layout}}<br />
<br />
=== HTML invoice templates ===<br />
<br />
* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option. <br />
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}<br />
<br />
=== Plaintext invoice templates ===<br />
<br />
* See the Text::Template documentation for details on the substitution language.<br />
* 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).<br />
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]<br />
<br />
=== Misc ===<br />
<br />
==== Manually setting next invoice number sequence ====<br />
<br />
* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre><br />
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre><br />
<br />
== Payment Receipts ==<br />
<br />
The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.<br />
<br />
== Credit cards and Electronic checks ==<br />
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]<br />
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]<br />
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.<br />
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.<br />
<br />
= Misc =<br />
<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Texas Tax | Texas Tax]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:VoIP | VoIP]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Time billing | Time billing]]<br />
<!-- Superseded by Commissions below... * Setting up [[Freeside:1.9:Documentation:Administration:Referral credits|Referral credits]] --><br />
* Setting up [[Freeside:2.1:Documentation:Administration:Commission|Commissions and Referrals]]<br />
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Slony | Slony replication and failover]]<br />
* Using a non-standard [[Freeside:2.1:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]<br />
* [[Bulk DID Orders]]<br />
<br />
{{ContextSensitiveHelp}}</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:Administration&diff=6371Freeside:2.1:Documentation:Administration2011-04-13T00:03:59Z<p>Levinse: /* Common price plans */</p>
<hr />
<div>= Exports (provisioning) =<br />
<br />
'''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.<br />
<br />
Exports can be added and edited under<br />
: Configuration -> Provisioning, services and packages -> View/edit exports<br />
<br />
Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.<br />
<br />
Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].<br />
<br />
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.<br />
<br />
Exports are activated by associating them with one or more '''service definitions'''.<br />
<br />
Following is a list of which exports can be associated with each type of service.<br />
<br />
==svc_acct==<br />
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service<br />
* acct_sql.pm: Real-time export of accounts to SQL databases .<br />
* artera_turbo.pm: <br />
* bsdshell.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* communigate_pro_singledomain.pm: <br />
* cpanel.pm: Real-time export to Cpanel control panel.<br />
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol<br />
* cyrus.pm: Real-time export to Cyrus IMAP server<br />
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service<br />
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI<br />
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]: Real-time export to LDAP<br />
* passwdfile.pm:<br />
* radiator.pm: Real-time export to RADIATOR<br />
* shellcommands.pm: <br />
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)<br />
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms<br />
* sysvshell.pm: <br />
* textradius.pm: <br />
* vpopmail.pm: Real-time export to vpopmail text files<br />
<br />
==svc_domain==<br />
* bind.pm: Batch export to BIND named<br />
* bind_slave.pm: Batch export to slave BIND named<br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).<br />
* domain_sql.pm: Real time export of domains to SQL databases .<br />
* http.pm: Send an HTTP or HTTPS GET or POST request<br />
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_forward==<br />
* artera_turbo.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* forward_shellcommands.pm: Run remote commands via SSH, for forwards<br />
* postfix.pm: Postfix text files<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_www==<br />
* apache.pm: Export an Apache httpd.conf file snippet.<br />
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service<br />
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)<br />
<br />
==svc_broadband==<br />
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.<br />
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface<br />
* router.pm: Send a command to a router.<br />
* snmp.pm: Sends SNMP SETs to an SNMP agent.<br />
* trango.pm: Sends SNMP SETs to a Trango AP.<br />
<br />
==svc_phone==<br />
* globalpops_voip.pm:<br />
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.<br />
* indosoft.pm:<br />
* internal_diddb.pm:<br />
* netsapiens.pm:<br />
* phone_shellcommands.pm:<br />
* phone_sqlradius.pm:<br />
* thirdlane.pm:<br />
* vitelity.pm:<br />
<br />
==svc_external==<br />
* artera_turbo.pm:<br />
<br />
==svc_dsl==<br />
* ikano.pm: see [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Services =<br />
<br />
== Accounts (svc_acct) ==<br />
<br />
* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]<br />
<br />
== Domains (svc_domain) ==<br />
<br />
== Forwards (svc_forward) ==<br />
<br />
== Hosting (svc_www) ==<br />
<br />
== Broadband (svc_broadband) ==<br />
<br />
== Phone (svc_phone) ==<br />
[[Vitelity]]<br />
<br />
== External (svc_external) ==<br />
<br />
== DSL (svc_dsl) ==<br />
<br />
* [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Packages =<br />
<br />
{{Freeside:1.9:Documentation:Administration:pkg_category}}<br />
<br />
== Price Plans ==<br />
<br />
=== Common price plans ===<br />
<br />
* flat<br />
* subscription<br />
* prorate<br />
* sqlradacct_hour<br />
* [voip_cdr]<br />
* prepaid<br />
<br />
=== Wholesale price plans ===<br />
<br />
* bulk<br />
<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |<br />
cdr_termination ]]<br />
<br />
=== Other price plans ===<br />
<br />
* flat_delayed<br />
* flat_introrate<br />
* prorate_delayed<br />
<br />
* base_delayed<br />
* base_rate<br />
<br />
* sql_external<br />
* sql_generic<br />
<br />
=== Price plans of questionable functionality ===<br />
<br />
* flat_comission_cust<br />
* flat_comission_pkg<br />
* flat_comission<br />
<br />
* voip_sqlradacct<br />
<br />
* sesmon_hour<br />
* sesmon_minute<br />
<br />
== Misc ==<br />
<br />
* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]<br />
<br />
= Resellers =<br />
<br />
= Employees =<br />
<br />
== Employees ==<br />
<br />
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.<br />
<br />
* To add a new employee, click on "Add an employee"<br />
* Or to edit an existing group, click on the employee number or name in the list of employees.<br />
* 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.<br />
* Check the "Disable employee" box to disable this employee.<br />
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.<br />
<br />
== Employee groups and access control == <br />
<br />
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.<br />
<br />
* To add a new group, click on "Add an employee group"<br />
* Or to edit an existing group, click on the group number or name in the list of groups.<br />
* Enter or edit the group name.<br />
* 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.<br />
* 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.<br />
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.<br />
<br />
= Billing =<br />
<br />
== Billing events ==<br />
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.<br />
<br />
At a high level, follow the following steps to create billing events:<br />
* Add a new Billing Event (Configuration > Billing > Billing events)<br />
* Name the event<br />
* Choose the type of event:<br />
** Package - Packages and associated dates (Including Commissions)<br />
** Invoice - Invoice status and dates<br />
** Customer - Customer Balances and Information<br />
** Batch Payment - Batch payment results<br />
** Statement - Send statement <br />
* Choose whether to apply to one or all agents<br />
* Choose the frequency for the system to check and see if the event should run.<br />
* Choose appropriate filters. <br />
* Choose appropriate actions.<br />
<br />
The form is dynamic so changing the type of event will change the available filters and actions.<br />
<br />
== Daily and Monthly Scripts ==<br />
* The freeside-daily script should be run daily to bill customers and run invoice collection events.<br />
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre><br />
** 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><br />
* If any monthly events are enabled, the freeside-monthly script should be run monthly.<br />
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)<br />
<br />
== Invoices ==<br />
<br />
=== Typeset (LaTeX) invoice templates ===<br />
<br />
==== Prerequisites ====<br />
<br />
* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.<br />
* Install [http://www.ghostscript.com/ Ghostscript] (gs)<br />
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]<br />
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed<br />
<br />
==== Logo setup ====<br />
<br />
The <em title="Encapsulated Postscript">EPS</em> logo is for PDF and printed invoices.<br />
<br />
* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format. <br />
** Your graphic artist can create vector image from a bitmap (tracing etc).<br />
** 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)<br />
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code><br />
* Upload the resized logo as the <code>logo.eps</code> configuration option.<br />
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code><br />
<br />
The <em title="Portable Network Graphic">PNG</em> logo is for emailed and online invoices.<br />
<br />
Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.<br />
<br />
{{Freeside:1.9:Documentation:Administration:invoice_layout}}<br />
<br />
=== HTML invoice templates ===<br />
<br />
* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option. <br />
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}<br />
<br />
=== Plaintext invoice templates ===<br />
<br />
* See the Text::Template documentation for details on the substitution language.<br />
* 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).<br />
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]<br />
<br />
=== Misc ===<br />
<br />
==== Manually setting next invoice number sequence ====<br />
<br />
* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre><br />
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre><br />
<br />
== Payment Receipts ==<br />
<br />
The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.<br />
<br />
== Credit cards and Electronic checks ==<br />
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]<br />
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]<br />
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.<br />
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.<br />
<br />
= Misc =<br />
<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Texas Tax | Texas Tax]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:VoIP | VoIP]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Time billing | Time billing]]<br />
<!-- Superseded by Commissions below... * Setting up [[Freeside:1.9:Documentation:Administration:Referral credits|Referral credits]] --><br />
* Setting up [[Freeside:2.1:Documentation:Administration:Commission|Commissions and Referrals]]<br />
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Slony | Slony replication and failover]]<br />
* Using a non-standard [[Freeside:2.1:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]<br />
* [[Bulk DID Orders]]<br />
<br />
{{ContextSensitiveHelp}}</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Bulk_DID_Orders&diff=6370Bulk DID Orders2011-04-11T23:20:16Z<p>Levinse: New page: * Create an internal_diddb export and an svc_phone service * Configuration -> Phone -> View/Edit bulk DID vendors: setup your vendors * Tools -> Bulk DID Orders -> Add a bulk DID Order * U...</p>
<hr />
<div>* Create an internal_diddb export and an svc_phone service<br />
* Configuration -> Phone -> View/Edit bulk DID vendors: setup your vendors<br />
* Tools -> Bulk DID Orders -> Add a bulk DID Order<br />
* Upload the inventory (by clicking on Upload Received from the Bulk DID Orders browse or from Tools -> Importing -> DIDs)<br />
* Order confirmation may be set via one of three ways: by browsing the bulk DID orders and clicking on the Confirm links for any unconfirmed orders, by editing a bulk DID order, and when importing DIDs for the order (see above).<br />
* Provision DIDs for a customer</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:Administration&diff=6369Freeside:2.1:Documentation:Administration2011-04-11T23:17:26Z<p>Levinse: /* Misc */</p>
<hr />
<div>= Exports (provisioning) =<br />
<br />
'''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.<br />
<br />
Exports can be added and edited under<br />
: Configuration -> Provisioning, services and packages -> View/edit exports<br />
<br />
Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.<br />
<br />
Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].<br />
<br />
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.<br />
<br />
Exports are activated by associating them with one or more '''service definitions'''.<br />
<br />
Following is a list of which exports can be associated with each type of service.<br />
<br />
==svc_acct==<br />
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service<br />
* acct_sql.pm: Real-time export of accounts to SQL databases .<br />
* artera_turbo.pm: <br />
* bsdshell.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* communigate_pro_singledomain.pm: <br />
* cpanel.pm: Real-time export to Cpanel control panel.<br />
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol<br />
* cyrus.pm: Real-time export to Cyrus IMAP server<br />
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service<br />
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI<br />
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]: Real-time export to LDAP<br />
* passwdfile.pm:<br />
* radiator.pm: Real-time export to RADIATOR<br />
* shellcommands.pm: <br />
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)<br />
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms<br />
* sysvshell.pm: <br />
* textradius.pm: <br />
* vpopmail.pm: Real-time export to vpopmail text files<br />
<br />
==svc_domain==<br />
* bind.pm: Batch export to BIND named<br />
* bind_slave.pm: Batch export to slave BIND named<br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).<br />
* domain_sql.pm: Real time export of domains to SQL databases .<br />
* http.pm: Send an HTTP or HTTPS GET or POST request<br />
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_forward==<br />
* artera_turbo.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* forward_shellcommands.pm: Run remote commands via SSH, for forwards<br />
* postfix.pm: Postfix text files<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_www==<br />
* apache.pm: Export an Apache httpd.conf file snippet.<br />
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service<br />
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)<br />
<br />
==svc_broadband==<br />
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.<br />
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface<br />
* router.pm: Send a command to a router.<br />
* snmp.pm: Sends SNMP SETs to an SNMP agent.<br />
* trango.pm: Sends SNMP SETs to a Trango AP.<br />
<br />
==svc_phone==<br />
* globalpops_voip.pm:<br />
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.<br />
* indosoft.pm:<br />
* internal_diddb.pm:<br />
* netsapiens.pm:<br />
* phone_shellcommands.pm:<br />
* phone_sqlradius.pm:<br />
* thirdlane.pm:<br />
* vitelity.pm:<br />
<br />
==svc_external==<br />
* artera_turbo.pm:<br />
<br />
==svc_dsl==<br />
* ikano.pm: see [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Services =<br />
<br />
== Accounts (svc_acct) ==<br />
<br />
* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]<br />
<br />
== Domains (svc_domain) ==<br />
<br />
== Forwards (svc_forward) ==<br />
<br />
== Hosting (svc_www) ==<br />
<br />
== Broadband (svc_broadband) ==<br />
<br />
== Phone (svc_phone) ==<br />
[[Vitelity]]<br />
<br />
== External (svc_external) ==<br />
<br />
== DSL (svc_dsl) ==<br />
<br />
* [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Packages =<br />
<br />
{{Freeside:1.9:Documentation:Administration:pkg_category}}<br />
<br />
== Price Plans ==<br />
<br />
=== Common price plans ===<br />
<br />
* flat<br />
* subscription<br />
* prorate<br />
* sqlradacct_hour<br />
* voip_cdr<br />
* prepaid<br />
<br />
=== Wholesale price plans ===<br />
<br />
* bulk<br />
<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |<br />
cdr_termination ]]<br />
<br />
=== Other price plans ===<br />
<br />
* flat_delayed<br />
* flat_introrate<br />
* prorate_delayed<br />
<br />
* base_delayed<br />
* base_rate<br />
<br />
* sql_external<br />
* sql_generic<br />
<br />
=== Price plans of questionable functionality ===<br />
<br />
* flat_comission_cust<br />
* flat_comission_pkg<br />
* flat_comission<br />
<br />
* voip_sqlradacct<br />
<br />
* sesmon_hour<br />
* sesmon_minute<br />
<br />
== Misc ==<br />
<br />
* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]<br />
<br />
= Resellers =<br />
<br />
= Employees =<br />
<br />
== Employees ==<br />
<br />
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.<br />
<br />
* To add a new employee, click on "Add an employee"<br />
* Or to edit an existing group, click on the employee number or name in the list of employees.<br />
* 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.<br />
* Check the "Disable employee" box to disable this employee.<br />
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.<br />
<br />
== Employee groups and access control == <br />
<br />
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.<br />
<br />
* To add a new group, click on "Add an employee group"<br />
* Or to edit an existing group, click on the group number or name in the list of groups.<br />
* Enter or edit the group name.<br />
* 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.<br />
* 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.<br />
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.<br />
<br />
= Billing =<br />
<br />
== Billing events ==<br />
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.<br />
<br />
At a high level, follow the following steps to create billing events:<br />
* Add a new Billing Event (Configuration > Billing > Billing events)<br />
* Name the event<br />
* Choose the type of event:<br />
** Package - Packages and associated dates (Including Commissions)<br />
** Invoice - Invoice status and dates<br />
** Customer - Customer Balances and Information<br />
** Batch Payment - Batch payment results<br />
** Statement - Send statement <br />
* Choose whether to apply to one or all agents<br />
* Choose the frequency for the system to check and see if the event should run.<br />
* Choose appropriate filters. <br />
* Choose appropriate actions.<br />
<br />
The form is dynamic so changing the type of event will change the available filters and actions.<br />
<br />
== Daily and Monthly Scripts ==<br />
* The freeside-daily script should be run daily to bill customers and run invoice collection events.<br />
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre><br />
** 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><br />
* If any monthly events are enabled, the freeside-monthly script should be run monthly.<br />
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)<br />
<br />
== Invoices ==<br />
<br />
=== Typeset (LaTeX) invoice templates ===<br />
<br />
==== Prerequisites ====<br />
<br />
* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.<br />
* Install [http://www.ghostscript.com/ Ghostscript] (gs)<br />
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]<br />
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed<br />
<br />
==== Logo setup ====<br />
<br />
The <em title="Encapsulated Postscript">EPS</em> logo is for PDF and printed invoices.<br />
<br />
* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format. <br />
** Your graphic artist can create vector image from a bitmap (tracing etc).<br />
** 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)<br />
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code><br />
* Upload the resized logo as the <code>logo.eps</code> configuration option.<br />
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code><br />
<br />
The <em title="Portable Network Graphic">PNG</em> logo is for emailed and online invoices.<br />
<br />
Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.<br />
<br />
{{Freeside:1.9:Documentation:Administration:invoice_layout}}<br />
<br />
=== HTML invoice templates ===<br />
<br />
* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option. <br />
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}<br />
<br />
=== Plaintext invoice templates ===<br />
<br />
* See the Text::Template documentation for details on the substitution language.<br />
* 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).<br />
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]<br />
<br />
=== Misc ===<br />
<br />
==== Manually setting next invoice number sequence ====<br />
<br />
* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre><br />
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre><br />
<br />
== Payment Receipts ==<br />
<br />
The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.<br />
<br />
== Credit cards and Electronic checks ==<br />
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]<br />
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]<br />
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.<br />
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.<br />
<br />
= Misc =<br />
<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Texas Tax | Texas Tax]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:VoIP | VoIP]]<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Time billing | Time billing]]<br />
<!-- Superseded by Commissions below... * Setting up [[Freeside:1.9:Documentation:Administration:Referral credits|Referral credits]] --><br />
* Setting up [[Freeside:2.1:Documentation:Administration:Commission|Commissions and Referrals]]<br />
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].<br />
* Setting up [[Freeside:2.1:Documentation:Administration:Slony | Slony replication and failover]]<br />
* Using a non-standard [[Freeside:2.1:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]<br />
* [[Bulk DID Orders]]<br />
<br />
{{ContextSensitiveHelp}}</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:InstallingOnDebian5&diff=6360Freeside:2.1:Documentation:InstallingOnDebian52011-04-05T22:05:35Z<p>Levinse: /* Install the Appropriate Packages */</p>
<hr />
<div>= Notes =<br />
<br />
Note: All of the commands on this page must be run as root.<br />
<br />
== Operating System ==<br />
* Basic Debian 5.0 "lenny" install - You will not need the desktop applications group.<br />
<br />
== Set the System Locale ==<br />
The locale needs to be set correctly for the database. It is easiest to set it at the beginning of the installation.<br />
<br />
* Set the locale correctly - <br />
** For the US, generate both en_US and en_US.UTF-8, but (IMPORTANT) pick en_US as the default...<br />
dpkg-reconfigure locales<br />
<br />
= Prerequisites =<br />
<br />
== Aptitude & Required Libraries ==<br />
=== Add the freeside repository ===<br />
* Add the following apt source to <code>/etc/apt/sources.list</code> (for Debian 5.0 "lenny"):<br />
<br />
<pre><br />
deb http://freeside.biz/~ivan/freeside-lenny/ ./<br />
</pre><br />
<br />
* Run <code>aptitude update</code>.<br />
<br />
=== Install the Appropriate Packages ===<br />
<br />
* Run this command to install all prerequisites:<br />
<br />
<pre><br />
aptitude install adduser apache2 apache2-mpm-prefork apache2-utils gcc gnupg ghostscript gsfonts gzip latex-xcolor \<br />
less libapache-dbi-perl libapache2-mod-perl2 libapache2-request-perl libapache-session-perl \<br />
libbusiness-creditcard-perl libcache-cache-perl libcache-simple-timedexpiry-perl libchart-perl \<br />
libclass-container-perl libclass-data-inheritable-perl libclass-returnvalue-perl libcolor-scheme-perl \<br />
libcompress-zlib-perl libconvert-binhex-perl libcrypt-passwdmd5-perl libcrypt-ssleay-perl libcss-squish-perl \<br />
libdate-manip-perl libdbd-mysql-perl libdbd-pg-perl libdbi-perl libdbix-dbschema-perl libdbix-searchbuilder-perl \<br />
libdevel-stacktrace-perl libdevel-symdump-perl libdigest-sha1-perl liberror-perl libexception-class-perl \<br />
libfile-counterfile-perl libfile-rsync-perl libfont-afm-perl libfreezethaw-perl libfrontier-rpc-perl \<br />
libgd-gd2-noxpm-perl libgd-graph-perl libgd2-noxpm libhtml-format-perl libhtml-mason-perl libhtml-parser-perl \<br />
libhtml-scrubber-perl libhtml-tagset-perl libhtml-tree-perl libhtml-widgets-selectlayers-perl libio-stringy-perl \<br />
libipc-run-perl libipc-run3-perl libipc-sharelite-perl libjavascript-rpc-perl libjson-perl \<br />
liblingua-en-inflect-perl liblingua-en-nameparse-perl liblocale-gettext-perl liblocale-maketext-fuzzy-perl \<br />
liblocale-maketext-lexicon-perl liblocale-subcountry-perl liblog-dispatch-perl libmailtools-perl libmime-perl \<br />
libmodule-versions-report-perl libnet-daemon-perl libnet-ping-external-perl libnet-scp-perl libnet-ssh-perl \<br />
libnet-whois-raw-perl libnetaddr-ip-perl libnumber-format-perl libpam-modules libpam-runtime libpaper-utils \<br />
libparams-validate-perl libparse-recdescent-perl libpcre3 libpg-perl libplrpc-perl libregexp-common-perl \<br />
libspreadsheet-writeexcel-perl libstring-approx-perl libstring-shellquote-perl libterm-readkey-perl \<br />
libtest-inline-perl libtext-autoformat-perl libtext-charwidth-perl libtext-csv-perl libtext-iconv-perl \<br />
libtext-quoted-perl libtext-reform-perl libtext-template-perl libtext-wrapi18n-perl libtext-wrapper-perl \<br />
libtie-ixhash-perl libtime-duration-perl libtime-modules-perl libtimedate-perl libtree-simple-perl \<br />
libuniversal-require-perl liburi-perl libwant-perl libwww-perl libxml-parser-perl libyaml-perl lmodern make \<br />
perl perl-base perl-modules postgresql postgresql-client rsync slidentd openssh-client openssh-server texlive \<br />
texlive-latex-extra texinfo traceroute ttf-bitstream-vera ttf-dustin ucf zlib1g \<br />
libdatetime-perl libdatetime-format-strptime-perl libfile-slurp-perl libspreadsheet-parseexcel-perl \<br />
libauthen-passphrase-perl libnet-domain-tld-perl libbusiness-us-usps-webtools-perl libxml-simple-perl \<br />
libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-sender-perl \<br />
libemail-sender-transport-smtp-tls-perl libhtml-defang-perl libdatetime-format-natural-perl libcgi-pm-perl \<br />
libfile-sharedir-perl libmodule-versions-report-perl libtext-wikiformat-perl libnet-server-perl \<br />
libhttp-server-simple-perl libhtml-rewriteattributes-perl libmime-types-perl libperlio-eol-perl \<br />
libgnupg-interface-perl libdata-ical-perl libdate-ical-perl libcalendar-simple-perl libdatetime-set-perl \<br />
libhook-lexwrap-perl libhttp-server-simple-mason-perl libxml-rss-perl libipc-run-safehandles-perl libpoe-perl \<br />
libsoap-lite-perl libhtml-tableextract-perl libhtml-element-extended-perl libcam-pdf-perl \<br />
libgd-barcode-perl libnet-openssh-perl </pre><br />
<br />
= Verify the correct locale is set =<br />
<br />
* Check your /etc/postgresql/8.3/main/postgresql.conf for the lc_ lines. If they are set to "= 'en_US.UTF-8'"...<br />
* The postgresql cluster will need to be dropped and re-initialized<br />
pg_dropcluster 8.3 main --stop<br />
pg_createcluster --locale en_US 8.3 main<br />
* Don't forget to restart postgresql<br />
/etc/init.d/postgresql-8.3 start<br />
<br />
= Installation =<br />
<br />
Follow the [[Freeside:1.9:Documentation:Installation#Installation|regular installation instructions]].</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:Documentation:Administration:vitelity.pm&diff=6231Freeside:Documentation:Administration:vitelity.pm2011-01-10T19:29:31Z<p>Levinse: New page: Vitelity Provisioning - DIDs, tollfree, and vfax (both regular and toll-free) * Configure an appropriate export and service definition. Fax must use a separate export (and therefore a sep...</p>
<hr />
<div>Vitelity Provisioning - DIDs, tollfree, and vfax (both regular and toll-free)<br />
<br />
* Configure an appropriate export and service definition. Fax must use a separate export (and therefore a separate service), with the fax checkbox selected<br />
<br />
* The Vitelity fax API is missing features necessary to implement all currently-supported features. Attempting to do either of the below from FS will return an error<br />
** Unprov a fax DID. Use web interface instead.<br />
** Clear the e-mail addresses for a fax DID - once anything is set, e-mails can only be changed, but not removed. Use the web interface for removing.</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:Administration&diff=6230Freeside:2.1:Documentation:Administration2011-01-10T19:27:07Z<p>Levinse: /* Phone (svc_phone) */</p>
<hr />
<div>= Exports (provisioning) =<br />
<br />
'''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.<br />
<br />
Exports can be added and edited under<br />
: Configuration -> Provisioning, services and packages -> View/edit exports<br />
<br />
Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.<br />
<br />
Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].<br />
<br />
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.<br />
<br />
Exports are activated by associating them with one or more '''service definitions'''.<br />
<br />
Following is a list of which exports can be associated with each type of service.<br />
<br />
==svc_acct==<br />
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service<br />
* acct_sql.pm: Real-time export of accounts to SQL databases .<br />
* artera_turbo.pm: <br />
* bsdshell.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* communigate_pro_singledomain.pm: <br />
* cpanel.pm: Real-time export to Cpanel control panel.<br />
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol<br />
* cyrus.pm: Real-time export to Cyrus IMAP server<br />
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service<br />
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI<br />
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]: Real-time export to LDAP<br />
* passwdfile.pm:<br />
* radiator.pm: Real-time export to RADIATOR<br />
* shellcommands.pm: <br />
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)<br />
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms<br />
* sysvshell.pm: <br />
* textradius.pm: <br />
* vpopmail.pm: Real-time export to vpopmail text files<br />
<br />
==svc_domain==<br />
* bind.pm: Batch export to BIND named<br />
* bind_slave.pm: Batch export to slave BIND named<br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).<br />
* domain_sql.pm: Real time export of domains to SQL databases .<br />
* http.pm: Send an HTTP or HTTPS GET or POST request<br />
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_forward==<br />
* artera_turbo.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* forward_shellcommands.pm: Run remote commands via SSH, for forwards<br />
* postfix.pm: Postfix text files<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_www==<br />
* apache.pm: Export an Apache httpd.conf file snippet.<br />
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service<br />
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)<br />
<br />
==svc_broadband==<br />
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.<br />
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface<br />
* router.pm: Send a command to a router.<br />
* snmp.pm: Sends SNMP SETs to an SNMP agent.<br />
* trango.pm: Sends SNMP SETs to a Trango AP.<br />
<br />
==svc_phone==<br />
* globalpops_voip.pm:<br />
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.<br />
* indosoft.pm:<br />
* internal_diddb.pm:<br />
* netsapiens.pm:<br />
* phone_shellcommands.pm:<br />
* phone_sqlradius.pm:<br />
* thirdlane.pm:<br />
* vitelity.pm:<br />
<br />
==svc_external==<br />
* artera_turbo.pm:<br />
<br />
==svc_dsl==<br />
* ikano.pm: see [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Services =<br />
<br />
== Accounts (svc_acct) ==<br />
<br />
* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]<br />
<br />
== Domains (svc_domain) ==<br />
<br />
== Forwards (svc_forward) ==<br />
<br />
== Hosting (svc_www) ==<br />
<br />
== Broadband (svc_broadband) ==<br />
<br />
== Phone (svc_phone) ==<br />
[[Vitelity]]<br />
<br />
== External (svc_external) ==<br />
<br />
== DSL (svc_dsl) ==<br />
<br />
* [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Packages =<br />
<br />
{{Freeside:1.9:Documentation:Administration:pkg_category}}<br />
<br />
== Price Plans ==<br />
<br />
=== Common price plans ===<br />
<br />
* flat<br />
* subscription<br />
* prorate<br />
* sqlradacct_hour<br />
* voip_cdr<br />
* prepaid<br />
<br />
=== Wholesale price plans ===<br />
<br />
* bulk<br />
<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |<br />
cdr_termination ]]<br />
<br />
=== Other price plans ===<br />
<br />
* flat_delayed<br />
* flat_introrate<br />
* prorate_delayed<br />
<br />
* base_delayed<br />
* base_rate<br />
<br />
* sql_external<br />
* sql_generic<br />
<br />
=== Price plans of questionable functionality ===<br />
<br />
* flat_comission_cust<br />
* flat_comission_pkg<br />
* flat_comission<br />
<br />
* voip_sqlradacct<br />
<br />
* sesmon_hour<br />
* sesmon_minute<br />
<br />
== Misc ==<br />
<br />
* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]<br />
<br />
= Resellers =<br />
<br />
= Employees =<br />
<br />
== Employees ==<br />
<br />
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.<br />
<br />
* To add a new employee, click on "Add an employee"<br />
* Or to edit an existing group, click on the employee number or name in the list of employees.<br />
* 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.<br />
* Check the "Disable employee" box to disable this employee.<br />
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.<br />
<br />
== Employee groups and access control == <br />
<br />
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.<br />
<br />
* To add a new group, click on "Add an employee group"<br />
* Or to edit an existing group, click on the group number or name in the list of groups.<br />
* Enter or edit the group name.<br />
* 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.<br />
* 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.<br />
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.<br />
<br />
= Billing =<br />
<br />
== Billing events ==<br />
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.<br />
<br />
At a high level, follow the following steps to create billing events:<br />
* Add a new Billing Event (Configuration > Billing > Billing events)<br />
* Name the event<br />
* Choose the type of event:<br />
** Package - Packages and associated dates (Including Commissions)<br />
** Invoice - Invoice status and dates<br />
** Customer - Customer Balances and Information<br />
** Batch Payment - Batch payment results<br />
** Statement - Send statement <br />
* Choose whether to apply to one or all agents<br />
* Choose the frequency for the system to check and see if the event should run.<br />
* Choose appropriate filters. <br />
* Choose appropriate actions.<br />
<br />
The form is dynamic so changing the type of event will change the available filters and actions.<br />
<br />
== Daily and Monthly Scripts ==<br />
* The freeside-daily script should be run daily to bill customers and run invoice collection events.<br />
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre><br />
** 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><br />
* If any monthly events are enabled, the freeside-monthly script should be run monthly.<br />
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)<br />
<br />
== Invoices ==<br />
<br />
=== Typeset (LaTeX) invoice templates ===<br />
<br />
==== Prerequisites ====<br />
<br />
* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.<br />
* Install [http://www.ghostscript.com/ Ghostscript] (gs)<br />
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]<br />
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed<br />
<br />
==== Logo setup ====<br />
<br />
The <em title="Encapsulated Postscript">EPS</em> logo is for PDF and printed invoices.<br />
<br />
* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format. <br />
** Your graphic artist can create vector image from a bitmap (tracing etc).<br />
** 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)<br />
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code><br />
* Upload the resized logo as the <code>logo.eps</code> configuration option.<br />
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code><br />
<br />
The <em title="Portable Network Graphic">PNG</em> logo is for emailed and online invoices.<br />
<br />
Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.<br />
<br />
{{Freeside:1.9:Documentation:Administration:invoice_layout}}<br />
<br />
=== HTML invoice templates ===<br />
<br />
* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option. <br />
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}<br />
<br />
=== Plaintext invoice templates ===<br />
<br />
* See the Text::Template documentation for details on the substitution language.<br />
* 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).<br />
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]<br />
<br />
=== Misc ===<br />
<br />
==== Manually setting next invoice number sequence ====<br />
<br />
* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre><br />
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre><br />
<br />
== Payment Receipts ==<br />
<br />
The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.<br />
<br />
== Credit cards and Electronic checks ==<br />
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]<br />
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]<br />
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.<br />
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.<br />
<br />
= Misc =<br />
<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]<br />
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]<br />
<!-- Superseded by Commissions below... * Setting up [[Freeside:1.9:Documentation:Administration:Referral credits|Referral credits]] --><br />
* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]<br />
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]<br />
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]<br />
<br />
{{ContextSensitiveHelp}}</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:Self-Service_Installation&diff=6202Freeside:2.1:Documentation:Self-Service Installation2010-12-31T01:28:03Z<p>Levinse: /* Signing up with prepaid cards without customer info */</p>
<hr />
<div>== Introduction ==<br />
<br />
It is recommended to run the self-service interface on a public web server, not the backend Freeside server. The Freeside server will open an SSH connection to one or more web servers to process signups and self-service requests.<br />
<br />
== Backend setup ==<br />
<br />
Go to Configuration -> Settings and click on Edit Configuration<br />
<br />
Find and setup the following:<br />
<br />
* Set the '''signup_server-default_agentnum''' configuration value to a default agent number (i.e. 1).<br />
* Set the '''signup_server-default_refnum''' configuration value to a default advertising source (i.e. 1).<br />
* Set the '''signup_server-payby''' configuration value to the acceptable payment types for signups.<br />
* Set the '''signup_server-realtime''' configuration value to run billing for signups immediately.<br />
<br />
== Prerequisites ==<br />
<br />
=== API access (Perl, PHP, XML-RPC) ===<br />
<br />
* Perl<br />
* [http://openssh.com SSH]<br />
* [http://search.cpan.org/dist/Storable Storable] [[3rd_party_software/Perl#Stroable|3rd_party_software/Perl]]<br />
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]<br />
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite] for access from PHP or via the SOAP or XML-RPC APIs<br />
<br />
=== Signup and self-service pages ===<br />
<br />
In addition to the above:<br />
* A web server that can execute CGIs, such as [http://httpd.apache.org Apache]. SSL is highly recommended.<br />
* [http://search.cpan.org/dist/Text-Template Text::Template]<br />
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]<br />
* [http://search.cpan.org/dist/HTTP-BrowserDetect HTTP::BrowserDetect]<br />
* [http://search.cpan.org/dist/HTML-Parser HTML::Parser]<br />
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]<br />
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]<br />
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")<br />
* [http://search.cpan.org/dist/Number-Format Number::Format]<br />
<br />
== Installing FS::SelfService ==<br />
<br />
* Copy the fs_selfservice/FS-SelfService directory to the public web server<br />
* <code>perl Makefile.PL</code><br />
* <code>make install</code><br />
* <code>mkdir /usr/local/freeside; chown freeside /usr/local/freeside</code><br />
* <code>touch /usr/local/freeside/selfservice_socket; chown freeside /usr/local/freeside/selfservice_socket</code><br />
<br />
* <code>chmod 600 /usr/local/freeside/selfservice_socket</code><br />
'''OR'''<br />
* <code>chown freeside:your-www-group /usr/local/freeside/selfservice_socket; chmod 660 /usr/local/freeside/selfservice_socket</code><br />
<br />
== Installing web interface ==<br />
<br />
* Copy the fs_selfservice/FS-SelfService/cgi/ directory into the web server's document space.<br />
* Enable CGI execution for files with the `.cgi' extenstion. With Apache, for example:<br />
#directory where selfservice .cgi scripts and .html templates are located<br />
<Directory /var/www/selfservice><br />
AddHandler cgi-script .cgi<br />
Options +ExecCGI<br />
</Directory><br />
<br />
* Use [http://httpd.apache.org/docs/1.3/suexec.html suEXEC] or suidperl<br />
'''OR'''<br />
* As per above, <code>chown freeside:your-www-group /usr/local/freeside/selfservice_socket; chmod 660 /usr/local/freeside/selfservice_socket</code><br />
<br />
* Optionally, customize the .html templates.<br />
* Useful "entry points" to link to are:<br />
** signup.cgi - Signup<br />
** selfservice.cgi - Customer self-service<br />
** agent.cgi - Reseller interface<br />
** passwd.cgi - Simple password-changin ginterface<br />
** promocode.html - Promotional code pre-signup<br />
** regcode.html - Registration code pre-signup<br />
** stateselect.html - State selection pre-signup<br />
<br />
== SSH setup ==<br />
<br />
* On your backend Freeside server, generate SSH keys for the "freeside" user with <code>ssh-keygen</code>. Either use a passphrase-less key, or arrange for <code>ssh-agent</code> to provide keys to <code>freeside-selfservice-server</code><br />
* Add a "freeside" user to the public web server<br />
* Append the contents of /home/freeside/.ssh/id_rsa.pub (or id_dsa.pub) on your freeside machine to the /home/freeside/.ssh/authorized_keys file on the public web server.<br />
* As the freeside user, ensure you can SSH from your freeside machine to the public web server, without being prompted for a password.<br />
<br />
== Daemon setup ==<br />
<br />
* Run an instance of <code>freeside-selfservice-server ''user'' ''machine''</code> on the Freeside machine for each external machine.<br />
** ''user'' is an employee username.<br />
** ''machine'' is the name or IP of the public web server.<br />
<br />
== Alternative API access ==<br />
<br />
An alternative method for accessing the XML-RPC self-service API is available. This method is suitable for situations where running the self-service API on the backend in an "embedded" fashion is desirable. It uses fewer resources and is suitable for situations requiring high performance.<br />
<br />
* Turn on the <b>selfservice-xmlrpc</b> config option (in the self-service section).<br />
* Install the POE and SOAP::Lite perl modules.<br />
* <code>/etc/init.d/freeside restart</code><br />
* The server runs on port 8080 and answers requests with any path.<br />
* In client code, use <code>FS.ClientAPI_XMLRPC.methodname</code> instead of <code>FS.SelfService.XMLRPC.methodname</code>. i.e. in freeside.class.php or biz/freeside/SelfService.java<br />
<br />
== Optional ==<br />
<br />
* You can install the files in the fs_selfservice/FS-SelfService/cgi/ directory multiple places in your web server's document space, and customize the .html templates differently for each. You can set the agentnum used for each signup by editing signup.html and including a hidden field with the agentnum: <br />
<INPUT TYPE="hidden" NAME="agentnum" VALUE="3"><br />
<br />
* When linking to signup.cgi, you can include a referring custnum in the URL as follows: http://public.web.server/path/signup.cgi?ref=1542 <br />
<br />
* If you create a /usr/local/freeside/ieak.template file on the external machine, it will be sent to IE users with MIME type application/x-Internet-signup. This file will be processed with Text::Template with the variables listed below available. (an example file is included as fs_selfservice/FS-SelfService/ieak.template) See the section on internet settings files in the IEAK documentation for more information. Also see [http://support.microsoft.com/default.aspx?scid=kb;en-us;170802 Internet Explorer Prompts to Download Files] in the Microsoft Knowledge Base if you have difficulty with IE prompting to download the signup's .ins file instead of processing it.<br />
<br />
* Variable substitutions available in ieak.template and success.html: <br />
** $ac - area code of selected POP <br />
** $exch - exchange of selected POP <br />
** $loc - local part of selected POP <br />
** $username <br />
** $password <br />
** $email_name - first and last name <br />
** $pkg - package name<br />
<br />
== Prepaid card signup without customer info ==<br />
<br />
# Create a template customer - the name/address/telephone numbers will be copied for any customers created via the signup interface (note: this doesn't support multi-agents yet)<br />
# In the global configuration settings, set signup_server-prepaid-template-custnum to the customer number of the newly created template customer<br />
# Ensure that prepaid cards are a valid payment method for the signup interface and generate some cards<br />
# Pass prepaid_shortform=1 to signup.cgi in the URL (e.g. signup.cgi?prepaid_shortform=1); the form which appears should not have billing information fields and should force the prepaid card payment method<br />
<br />
== Misc ==<br />
<br />
* Wholesale package view: see selfservice_server-view-wholesale global configuration setting<br />
<br />
* Restricting login to the self-service for particular services (accounts) only: see selfservice_server-login_svcpart global configuration setting<br />
<br />
* If both settings are enabled, the wholesale package view will separate the add/delete/show of self-service accounts<br />
<br />
* Viewing tickets and replying to them: this may change in future, but for now ensure that the fs_selfservice RT user has appropriate permissions (e.g. ReplyToTicket and ShowTicket) for all queues</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:Self-Service_Installation&diff=6201Freeside:2.1:Documentation:Self-Service Installation2010-12-31T01:24:51Z<p>Levinse: </p>
<hr />
<div>== Introduction ==<br />
<br />
It is recommended to run the self-service interface on a public web server, not the backend Freeside server. The Freeside server will open an SSH connection to one or more web servers to process signups and self-service requests.<br />
<br />
== Backend setup ==<br />
<br />
Go to Configuration -> Settings and click on Edit Configuration<br />
<br />
Find and setup the following:<br />
<br />
* Set the '''signup_server-default_agentnum''' configuration value to a default agent number (i.e. 1).<br />
* Set the '''signup_server-default_refnum''' configuration value to a default advertising source (i.e. 1).<br />
* Set the '''signup_server-payby''' configuration value to the acceptable payment types for signups.<br />
* Set the '''signup_server-realtime''' configuration value to run billing for signups immediately.<br />
<br />
== Prerequisites ==<br />
<br />
=== API access (Perl, PHP, XML-RPC) ===<br />
<br />
* Perl<br />
* [http://openssh.com SSH]<br />
* [http://search.cpan.org/dist/Storable Storable] [[3rd_party_software/Perl#Stroable|3rd_party_software/Perl]]<br />
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]<br />
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite] for access from PHP or via the SOAP or XML-RPC APIs<br />
<br />
=== Signup and self-service pages ===<br />
<br />
In addition to the above:<br />
* A web server that can execute CGIs, such as [http://httpd.apache.org Apache]. SSL is highly recommended.<br />
* [http://search.cpan.org/dist/Text-Template Text::Template]<br />
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]<br />
* [http://search.cpan.org/dist/HTTP-BrowserDetect HTTP::BrowserDetect]<br />
* [http://search.cpan.org/dist/HTML-Parser HTML::Parser]<br />
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]<br />
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]<br />
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")<br />
* [http://search.cpan.org/dist/Number-Format Number::Format]<br />
<br />
== Installing FS::SelfService ==<br />
<br />
* Copy the fs_selfservice/FS-SelfService directory to the public web server<br />
* <code>perl Makefile.PL</code><br />
* <code>make install</code><br />
* <code>mkdir /usr/local/freeside; chown freeside /usr/local/freeside</code><br />
* <code>touch /usr/local/freeside/selfservice_socket; chown freeside /usr/local/freeside/selfservice_socket</code><br />
<br />
* <code>chmod 600 /usr/local/freeside/selfservice_socket</code><br />
'''OR'''<br />
* <code>chown freeside:your-www-group /usr/local/freeside/selfservice_socket; chmod 660 /usr/local/freeside/selfservice_socket</code><br />
<br />
== Installing web interface ==<br />
<br />
* Copy the fs_selfservice/FS-SelfService/cgi/ directory into the web server's document space.<br />
* Enable CGI execution for files with the `.cgi' extenstion. With Apache, for example:<br />
#directory where selfservice .cgi scripts and .html templates are located<br />
<Directory /var/www/selfservice><br />
AddHandler cgi-script .cgi<br />
Options +ExecCGI<br />
</Directory><br />
<br />
* Use [http://httpd.apache.org/docs/1.3/suexec.html suEXEC] or suidperl<br />
'''OR'''<br />
* As per above, <code>chown freeside:your-www-group /usr/local/freeside/selfservice_socket; chmod 660 /usr/local/freeside/selfservice_socket</code><br />
<br />
* Optionally, customize the .html templates.<br />
* Useful "entry points" to link to are:<br />
** signup.cgi - Signup<br />
** selfservice.cgi - Customer self-service<br />
** agent.cgi - Reseller interface<br />
** passwd.cgi - Simple password-changin ginterface<br />
** promocode.html - Promotional code pre-signup<br />
** regcode.html - Registration code pre-signup<br />
** stateselect.html - State selection pre-signup<br />
<br />
== SSH setup ==<br />
<br />
* On your backend Freeside server, generate SSH keys for the "freeside" user with <code>ssh-keygen</code>. Either use a passphrase-less key, or arrange for <code>ssh-agent</code> to provide keys to <code>freeside-selfservice-server</code><br />
* Add a "freeside" user to the public web server<br />
* Append the contents of /home/freeside/.ssh/id_rsa.pub (or id_dsa.pub) on your freeside machine to the /home/freeside/.ssh/authorized_keys file on the public web server.<br />
* As the freeside user, ensure you can SSH from your freeside machine to the public web server, without being prompted for a password.<br />
<br />
== Daemon setup ==<br />
<br />
* Run an instance of <code>freeside-selfservice-server ''user'' ''machine''</code> on the Freeside machine for each external machine.<br />
** ''user'' is an employee username.<br />
** ''machine'' is the name or IP of the public web server.<br />
<br />
== Alternative API access ==<br />
<br />
An alternative method for accessing the XML-RPC self-service API is available. This method is suitable for situations where running the self-service API on the backend in an "embedded" fashion is desirable. It uses fewer resources and is suitable for situations requiring high performance.<br />
<br />
* Turn on the <b>selfservice-xmlrpc</b> config option (in the self-service section).<br />
* Install the POE and SOAP::Lite perl modules.<br />
* <code>/etc/init.d/freeside restart</code><br />
* The server runs on port 8080 and answers requests with any path.<br />
* In client code, use <code>FS.ClientAPI_XMLRPC.methodname</code> instead of <code>FS.SelfService.XMLRPC.methodname</code>. i.e. in freeside.class.php or biz/freeside/SelfService.java<br />
<br />
== Optional ==<br />
<br />
* You can install the files in the fs_selfservice/FS-SelfService/cgi/ directory multiple places in your web server's document space, and customize the .html templates differently for each. You can set the agentnum used for each signup by editing signup.html and including a hidden field with the agentnum: <br />
<INPUT TYPE="hidden" NAME="agentnum" VALUE="3"><br />
<br />
* When linking to signup.cgi, you can include a referring custnum in the URL as follows: http://public.web.server/path/signup.cgi?ref=1542 <br />
<br />
* If you create a /usr/local/freeside/ieak.template file on the external machine, it will be sent to IE users with MIME type application/x-Internet-signup. This file will be processed with Text::Template with the variables listed below available. (an example file is included as fs_selfservice/FS-SelfService/ieak.template) See the section on internet settings files in the IEAK documentation for more information. Also see [http://support.microsoft.com/default.aspx?scid=kb;en-us;170802 Internet Explorer Prompts to Download Files] in the Microsoft Knowledge Base if you have difficulty with IE prompting to download the signup's .ins file instead of processing it.<br />
<br />
* Variable substitutions available in ieak.template and success.html: <br />
** $ac - area code of selected POP <br />
** $exch - exchange of selected POP <br />
** $loc - local part of selected POP <br />
** $username <br />
** $password <br />
** $email_name - first and last name <br />
** $pkg - package name<br />
<br />
== Signing up with prepaid cards without customer info ==<br />
<br />
# Create a template customer - the name/address/telephone numbers will be copied for any customers created via the signup interface (note: this doesn't support multi-agents yet)<br />
# In the global configuration settings, set signup_server-prepaid-template-custnum to the customer number of the newly created template customer<br />
# Ensure that prepaid cards are a valid payment method for the signup interface and generate some cards<br />
# Pass prepaid_shortform=1 to signup.cgi in the URL (e.g. signup.cgi?prepaid_shortform=1); the form which appears should not have billing information fields and should force the prepaid card payment method<br />
<br />
== Misc ==<br />
<br />
* Wholesale package view: see selfservice_server-view-wholesale global configuration setting<br />
<br />
* Restricting login to the self-service for particular services (accounts) only: see selfservice_server-login_svcpart global configuration setting<br />
<br />
* If both settings are enabled, the wholesale package view will separate the add/delete/show of self-service accounts<br />
<br />
* Viewing tickets and replying to them: this may change in future, but for now ensure that the fs_selfservice RT user has appropriate permissions (e.g. ReplyToTicket and ShowTicket) for all queues</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:Self-Service_Installation&diff=6188Freeside:2.1:Documentation:Self-Service Installation2010-12-20T02:51:40Z<p>Levinse: </p>
<hr />
<div>== Introduction ==<br />
<br />
It is recommended to run the self-service interface on a public web server, not the backend Freeside server. The Freeside server will open an SSH connection to one or more web servers to process signups and self-service requests.<br />
<br />
== Backend setup ==<br />
<br />
Go to Configuration -> Settings and click on Edit Configuration<br />
<br />
Find and setup the following:<br />
<br />
* Set the '''signup_server-default_agentnum''' configuration value to a default agent number (i.e. 1).<br />
* Set the '''signup_server-default_refnum''' configuration value to a default advertising source (i.e. 1).<br />
* Set the '''signup_server-payby''' configuration value to the acceptable payment types for signups.<br />
* Set the '''signup_server-realtime''' configuration value to run billing for signups immediately.<br />
<br />
== Prerequisites ==<br />
<br />
=== API access (Perl, PHP, XML-RPC) ===<br />
<br />
* Perl<br />
* [http://openssh.com SSH]<br />
* [http://search.cpan.org/dist/Storable Storable] [[3rd_party_software/Perl#Stroable|3rd_party_software/Perl]]<br />
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]<br />
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite] for access from PHP or via the SOAP or XML-RPC APIs<br />
<br />
=== Signup and self-service pages ===<br />
<br />
In addition to the above:<br />
* A web server that can execute CGIs, such as [http://httpd.apache.org Apache]. SSL is highly recommended.<br />
* [http://search.cpan.org/dist/Text-Template Text::Template]<br />
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]<br />
* [http://search.cpan.org/dist/HTTP-BrowserDetect HTTP::BrowserDetect]<br />
* [http://search.cpan.org/dist/HTML-Parser HTML::Parser]<br />
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]<br />
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]<br />
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")<br />
* [http://search.cpan.org/dist/Number-Format Number::Format]<br />
<br />
== Installing FS::SelfService ==<br />
<br />
* Copy the fs_selfservice/FS-SelfService directory to the public web server<br />
* <code>perl Makefile.PL</code><br />
* <code>make install</code><br />
* <code>mkdir /usr/local/freeside; chown freeside /usr/local/freeside</code><br />
* <code>touch /usr/local/freeside/selfservice_socket; chown freeside /usr/local/freeside/selfservice_socket</code><br />
<br />
* <code>chmod 600 /usr/local/freeside/selfservice_socket</code><br />
'''OR'''<br />
* <code>chown freeside:your-www-group /usr/local/freeside/selfservice_socket; chmod 660 /usr/local/freeside/selfservice_socket</code><br />
<br />
== Installing web interface ==<br />
<br />
* Copy the fs_selfservice/FS-SelfService/cgi/ directory into the web server's document space.<br />
* Enable CGI execution for files with the `.cgi' extenstion. With Apache, for example:<br />
#directory where selfservice .cgi scripts and .html templates are located<br />
<Directory /var/www/selfservice><br />
AddHandler cgi-script .cgi<br />
Options +ExecCGI<br />
</Directory><br />
<br />
* Use [http://httpd.apache.org/docs/1.3/suexec.html suEXEC] or suidperl<br />
'''OR'''<br />
* As per above, <code>chown freeside:your-www-group /usr/local/freeside/selfservice_socket; chmod 660 /usr/local/freeside/selfservice_socket</code><br />
<br />
* Optionally, customize the .html templates.<br />
* Useful "entry points" to link to are:<br />
** signup.cgi - Signup<br />
** selfservice.cgi - Customer self-service<br />
** agent.cgi - Reseller interface<br />
** passwd.cgi - Simple password-changin ginterface<br />
** promocode.html - Promotional code pre-signup<br />
** regcode.html - Registration code pre-signup<br />
** stateselect.html - State selection pre-signup<br />
<br />
== SSH setup ==<br />
<br />
* On your backend Freeside server, generate SSH keys for the "freeside" user with <code>ssh-keygen</code>. Either use a passphrase-less key, or arrange for <code>ssh-agent</code> to provide keys to <code>freeside-selfservice-server</code><br />
* Add a "freeside" user to the public web server<br />
* Append the contents of /home/freeside/.ssh/id_rsa.pub (or id_dsa.pub) on your freeside machine to the /home/freeside/.ssh/authorized_keys file on the public web server.<br />
* As the freeside user, ensure you can SSH from your freeside machine to the public web server, without being prompted for a password.<br />
<br />
== Daemon setup ==<br />
<br />
* Run an instance of <code>freeside-selfservice-server ''user'' ''machine''</code> on the Freeside machine for each external machine.<br />
** ''user'' is an employee username.<br />
** ''machine'' is the name or IP of the public web server.<br />
<br />
== Alternative API access ==<br />
<br />
An alternative method for accessing the XML-RPC self-service API is available. This method is suitable for situations where running the self-service API on the backend in an "embedded" fashion is desirable. It uses fewer resources and is suitable for situations requiring high performance.<br />
<br />
* Turn on the <b>selfservice-xmlrpc</b> config option (in the self-service section).<br />
* Install the POE and SOAP::Lite perl modules.<br />
* <code>/etc/init.d/freeside restart</code><br />
* The server runs on port 8080 and answers requests with any path.<br />
* In client code, use <code>FS.ClientAPI_XMLRPC.methodname</code> instead of <code>FS.SelfService.XMLRPC.methodname</code>. i.e. in freeside.class.php or biz/freeside/SelfService.java<br />
<br />
== Optional ==<br />
<br />
* You can install the files in the fs_selfservice/FS-SelfService/cgi/ directory multiple places in your web server's document space, and customize the .html templates differently for each. You can set the agentnum used for each signup by editing signup.html and including a hidden field with the agentnum: <br />
<INPUT TYPE="hidden" NAME="agentnum" VALUE="3"><br />
<br />
* When linking to signup.cgi, you can include a referring custnum in the URL as follows: http://public.web.server/path/signup.cgi?ref=1542 <br />
<br />
* If you create a /usr/local/freeside/ieak.template file on the external machine, it will be sent to IE users with MIME type application/x-Internet-signup. This file will be processed with Text::Template with the variables listed below available. (an example file is included as fs_selfservice/FS-SelfService/ieak.template) See the section on internet settings files in the IEAK documentation for more information. Also see [http://support.microsoft.com/default.aspx?scid=kb;en-us;170802 Internet Explorer Prompts to Download Files] in the Microsoft Knowledge Base if you have difficulty with IE prompting to download the signup's .ins file instead of processing it.<br />
<br />
* Variable substitutions available in ieak.template and success.html: <br />
** $ac - area code of selected POP <br />
** $exch - exchange of selected POP <br />
** $loc - local part of selected POP <br />
** $username <br />
** $password <br />
** $email_name - first and last name <br />
** $pkg - package name<br />
<br />
<br />
== Misc ==<br />
<br />
* Wholesale package view: see selfservice_server-view-wholesale global configuration setting<br />
<br />
* Restricting login to the self-service for particular services (accounts) only: see selfservice_server-login_svcpart global configuration setting<br />
<br />
* If both settings are enabled, the wholesale package view will separate the add/delete/show of self-service accounts<br />
<br />
* Viewing tickets and replying to them: this may change in future, but for now ensure that the fs_selfservice RT user has appropriate permissions (e.g. ReplyToTicket and ShowTicket) for all queues</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:1.9:Documentation:Administration&diff=6187Freeside:1.9:Documentation:Administration2010-12-20T02:45:55Z<p>Levinse: </p>
<hr />
<div>= Exports (provisioning) =<br />
<br />
'''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.<br />
<br />
Exports can be added and edited under<br />
: Configuration -> Provisioning, services and packages -> View/edit exports<br />
<br />
Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.<br />
<br />
Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].<br />
<br />
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.<br />
<br />
Exports are activated by associating them with one or more '''service definitions'''.<br />
<br />
Following is a list of which exports can be associated with each type of service.<br />
<br />
==svc_acct==<br />
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service<br />
* acct_sql.pm: Real-time export of accounts to SQL databases .<br />
* artera_turbo.pm: <br />
* bsdshell.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* communigate_pro_singledomain.pm: <br />
* cpanel.pm: Real-time export to Cpanel control panel.<br />
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol<br />
* cyrus.pm: Real-time export to Cyrus IMAP server<br />
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service<br />
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI<br />
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]: Real-time export to LDAP<br />
* passwdfile.pm:<br />
* radiator.pm: Real-time export to RADIATOR<br />
* shellcommands.pm: <br />
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)<br />
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms<br />
* sysvshell.pm: <br />
* textradius.pm: <br />
* vpopmail.pm: Real-time export to vpopmail text files<br />
<br />
==svc_domain==<br />
* bind.pm: Batch export to BIND named<br />
* bind_slave.pm: Batch export to slave BIND named<br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).<br />
* domain_sql.pm: Real time export of domains to SQL databases .<br />
* http.pm: Send an HTTP or HTTPS GET or POST request<br />
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_forward==<br />
* artera_turbo.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* forward_shellcommands.pm: Run remote commands via SSH, for forwards<br />
* postfix.pm: Postfix text files<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_www==<br />
* apache.pm: Export an Apache httpd.conf file snippet.<br />
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service<br />
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)<br />
<br />
==svc_broadband==<br />
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.<br />
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface<br />
* router.pm: Send a command to a router.<br />
* snmp.pm: Sends SNMP SETs to an SNMP agent.<br />
* trango.pm: Sends SNMP SETs to a Trango AP.<br />
<br />
==svc_phone==<br />
* globalpops_voip.pm:<br />
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.<br />
* indosoft.pm:<br />
* internal_diddb.pm:<br />
* netsapiens.pm:<br />
* phone_shellcommands.pm:<br />
* phone_sqlradius.pm:<br />
* thirdlane.pm:<br />
* vitelity.pm:<br />
<br />
==svc_external==<br />
* artera_turbo.pm:<br />
<br />
<br />
= Services =<br />
<br />
== Accounts (svc_acct) ==<br />
<br />
* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]<br />
<br />
== Domains (svc_domain) ==<br />
<br />
== Forwards (svc_forward) ==<br />
<br />
== Hosting (svc_www) ==<br />
<br />
== Broadband (svc_broadband) ==<br />
<br />
== Phone (svc_phone) ==<br />
<br />
== External (svc_external) ==<br />
<br />
<br />
= Packages =<br />
<br />
{{Freeside:1.9:Documentation:Administration:pkg_category}}<br />
<br />
== Price Plans ==<br />
<br />
=== Common price plans ===<br />
<br />
* flat<br />
* subscription<br />
* prorate<br />
* sqlradacct_hour<br />
* voip_cdr<br />
* prepaid<br />
<br />
=== Wholesale price plans ===<br />
<br />
* bulk<br />
<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |<br />
cdr_termination ]]<br />
<br />
=== Other price plans ===<br />
<br />
* flat_delayed<br />
* flat_introrate<br />
* prorate_delayed<br />
<br />
* base_delayed<br />
* base_rate<br />
<br />
* sql_external<br />
* sql_generic<br />
<br />
=== Price plans of questionable functionality ===<br />
<br />
* flat_comission_cust<br />
* flat_comission_pkg<br />
* flat_comission<br />
<br />
* voip_sqlradacct<br />
<br />
* sesmon_hour<br />
* sesmon_minute<br />
<br />
== Misc ==<br />
<br />
* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]<br />
<br />
= Resellers =<br />
<br />
= Employees =<br />
<br />
== Employees ==<br />
<br />
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.<br />
<br />
* To add a new employee, click on "Add an employee"<br />
* Or to edit an existing group, click on the employee number or name in the list of employees.<br />
* 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.<br />
* Check the "Disable employee" box to disable this employee.<br />
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.<br />
<br />
== Employee groups and access control == <br />
<br />
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.<br />
<br />
* To add a new group, click on "Add an employee group"<br />
* Or to edit an existing group, click on the group number or name in the list of groups.<br />
* Enter or edit the group name.<br />
* 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.<br />
* 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.<br />
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.<br />
<br />
= Billing =<br />
<br />
== Billing events ==<br />
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.<br />
<br />
At a high level, follow the following steps to create billing events:<br />
* Add a new Billing Event (Configuration > Billing > Billing events)<br />
* Name the event<br />
* Choose the type of event:<br />
** Package - Packages and associated dates (Including Commissions)<br />
** Invoice - Invoice status and dates<br />
** Customer - Customer Balances and Information<br />
** Batch Payment - Batch payment results<br />
** Statement - Send statement <br />
* Choose whether to apply to one or all agents<br />
* Choose the frequency for the system to check and see if the event should run.<br />
* Choose appropriate filters. <br />
* Choose appropriate actions.<br />
<br />
The form is dynamic so changing the type of event will change the available filters and actions.<br />
<br />
== Daily and Monthly Scripts ==<br />
* The freeside-daily script should be run daily to bill customers and run invoice collection events.<br />
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre><br />
** 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><br />
* If any monthly events are enabled, the freeside-monthly script should be run monthly.<br />
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)<br />
<br />
== Invoices ==<br />
<br />
=== Typeset (LaTeX) invoice templates ===<br />
<br />
==== Prerequisites ====<br />
<br />
* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.<br />
* Install [http://www.ghostscript.com/ Ghostscript] (gs)<br />
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]<br />
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed<br />
<br />
==== Logo setup ====<br />
<br />
The <em title="Encapsulated Postscript">EPS</em> logo is for PDF and printed invoices.<br />
<br />
* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format. <br />
** Your graphic artist can create vector image from a bitmap (tracing etc).<br />
** 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)<br />
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code><br />
* Upload the resized logo as the <code>logo.eps</code> configuration option.<br />
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code><br />
<br />
The <em title="Portable Network Graphic">PNG</em> logo is for emailed and online invoices.<br />
<br />
Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.<br />
<br />
{{Freeside:1.9:Documentation:Administration:invoice_layout}}<br />
<br />
=== HTML invoice templates ===<br />
<br />
* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option. <br />
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}<br />
<br />
=== Plaintext invoice templates ===<br />
<br />
* See the Text::Template documentation for details on the substitution language.<br />
* 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).<br />
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]<br />
<br />
=== Misc ===<br />
<br />
==== Manually setting next invoice number sequence ====<br />
<br />
* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre><br />
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre><br />
<br />
== Payment Receipts ==<br />
<br />
The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.<br />
<br />
== Credit cards and Electronic checks ==<br />
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]<br />
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]<br />
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.<br />
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.<br />
<br />
= Misc =<br />
<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]<br />
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]<br />
<!-- Superseded by Commissions below... * Setting up [[Freeside:1.9:Documentation:Administration:Referral credits|Referral credits]] --><br />
* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]<br />
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]<br />
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]<br />
<br />
{{ContextSensitiveHelp}}</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:User&diff=6167Freeside:2.1:Documentation:User2010-12-13T22:24:03Z<p>Levinse: /* DSL */</p>
<hr />
<div>= Introduction =<br />
<br />
== About ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_1.html ?<br />
<br />
AGPL now, and MySQL is also supported<br />
<br />
== Navigation and Preferences ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_2.html<br />
<br />
== Customers, Packages and Services ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_3.html<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_4.html (simple case: single package and service)<br />
<br />
= Customers =<br />
<br />
== Adding customers ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_5.html<br />
<br />
== Searching for customers ==<br />
<br />
<br />
<br />
== Customer view ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_6.html<br />
<br />
=== Actions ===<br />
<br />
==== Edit customer ====<br />
==== Cancel customer ====<br />
==== Refer customer ====<br />
==== View customer's referrals ====<br />
==== Bill now ====<br />
<br />
=== Comments / Notes ===<br />
<br />
==== Comments ====<br />
<br />
==== Notes ====<br />
<br />
=== Tickets ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_7.html<br />
<br />
=== Packages ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_11.html<br />
<br />
==== Qualifications ====<br />
<br />
If you have any qualification-capable services configured, you may perform qualifications using the "New Qualification" link under Packages, and then choosing the "Qualify using" field appropriately and filling out the form.<br />
<br />
Previously-performed qualifications may be viewed from "View Qualifications".<br />
<br />
Notes specific to New Qualification for Ikano:<br />
# An address is always required<br />
# Location Type may be only one of the fixed Ikano values - see their documentation<br />
# Location Kind must always be chosen<br />
# Dry loops - always leave "Service Telephone Number" empty<br />
# Line-share (non dry loops) - always fill in "Service Telephone Number"<br />
<br />
<br />
Notes specific to qualification results / viewing previous qualifications for Ikano:<br />
# The view qualification page will show all possible packages in Freeside which you can order, based on the customer data which was qualified<br />
# You need the "Vendor Qualification #" to create a new Ikano DSL order<br />
<br />
==== Services ====<br />
<br />
===== Accounts =====<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_12.html<br />
<br />
===== Domains =====<br />
===== Mail Forwards =====<br />
===== Virtual hosting =====<br />
===== Broadband =====<br />
===== Phone numbers =====<br />
===== External =====<br />
===== DSL =====<br />
<br />
Ikano-specific notes:<br />
* New Orders<br />
# Get the "Vendor Qualification #" from a previously-performed qualification (see Qualifications above)<br />
# Order one of the qualifying packages shown on the qualification result and set the start date and location on this package appropriately<br />
# When adding the DSL service, the Vendor Qualification Id you copied should be pasted into the appropriate field<br />
# For dry loops, leave the Service Telephone Number blank and choose the "Standalone" Loop Type<br />
# For line-share (non dry-loops), always fill in the Service Telephone Number and choose the "Line-share" Loop Type<br />
* Viewing DSL Orders - click on the service to view all order data, including notes placed on the order by Ikano or you via their web portal<br />
* Canceling DSL Orders<br />
** A NEW order in NEW or PENDING statuses may be canceled immediately - do a normal "Cancel now" on the package<br />
** A NEW order in COMPLETED status may be canceled by expiring the package - do a normal "Cancel later" on the package with a cancel date at least 48 hours in future<br />
* Changing PPPoE password - edit the service and change the password<br />
* Suspending and unsuspending - do a normal Suspend Now or Unsuspend on the package<br />
* Processes not supported currently (use the Ikano web interface for now):<br />
** Canceling NEW orders in any status other than NEW, PENDING, or COMPLETED <br />
** Anything involving CHANGE orders - e.g. changing the package/service, canceling a change/move, performing a move<br />
** Aborting cancellations (unexpiring packages) while a CANCEL order is in NEW or PENDING status<br />
** Syncing an order's disconnect or activation date to the package dates<br />
* Due to Ikano's API, it will not be possible to place notes on an order from Freeside, so this cannot be implemented<br />
<br />
=== Payment history and actions === <br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_13.html<br />
<br />
==== Invoices ====<br />
<br />
Invoices are generated by the system. The charges on each invoice reflect the setup/one-time, recurring and usage charges of that customer's packages. Invoices increase the customer's balance.<br />
<br />
To add new packages or charges to a customer, use the "Order new package" or "One-time charge" links in the Packages section of the Customer View page.<br />
<br />
To generate a pending invoice for a customer, use the "Bill now" link at the top of the Customer View page.<br />
<br />
==== Payments ====<br />
<br />
Payments are money the customer pays. Payments decrease the customer's balance.<br />
<br />
===== Check and Cash payments =====<br />
<br />
* To post a check or cash payment, use the "Enter check payment" or "Enter cash payment" links at the top of the Payment History section of the customer view page.<br />
** Enter the amount of the payment.<br />
** For check payments, enter the check number.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the payment to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the payment to invoice(s) (or refund(s)) manually.<br />
<br />
* Multiple check payments can also be entered in a batch under Tools -> Quick Payment Entry.<br />
<br />
===== Credit card and electronic check (ACH) payments =====<br />
<br />
* Credit card or electronic check payments will be initiated by the system for customers with Billing Type "Credit card (automatic)" or "Electronic Check (automatic)".<br />
<br />
* Payments can be initiated manually by using the "Process credit card payment" or "Process electronic check (ACH) payment" links, in the Payment History section of the customer view page.<br />
** Enter the amount to process (defaults to the customer's current outstanding balance).<br />
** For credit card payments, enter the card number, expiration date, name on card and billing address. If the customer has a card on-file, the masked card number ("4111xxxxxxxx1111") and other information can be left as-is to charge the on-file card.<br />
** For electronic check payments, enter the account number, account type, ABA or routing number, and bank name (other information such as bank state, social security number, or driver's license number may also be required by some payment gateways). If the customer has electronic checking information on-file, the masked account number and other information can be left as-is to charge the on-file bank account.<br />
** Check "Remember this information" to save the payment information on-file.<br />
** Also check "Charge future payments to this credit card/electronic check automatically" to charge the customer automatically in the future.<br />
<br />
* Customers may use the self-service interface to pay by credit card or electronic check themselves.<br />
<br />
===== Payment application =====<br />
<br />
* Payments are applied to a specific invoice (or split between multiple invoices).<br />
* The "(apply)" and "(unapply)" links next to specific payment (in the Payment History section of the customer view page) can be used to change the application of payments to specific invoice(s) and/or refunds(s).<br />
<br />
==== Credits ====<br />
<br />
Credits are adjustments to the amount the customer owes. Credits decrease the customer's balance.<br />
<br />
* To post a credit, use the "Enter credit" link at the top of the Payment History section of the customer view page.<br />
** Enter the amount to credit.<br />
** Select the reason for the credit or enter a new reason.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the credit to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the credit to invoice(s) (or refund(s)) manually.<br />
<br />
* Like payments, credits can be applied to an invoice (or split between multiple invoices). For example, a credit to reverse an incorrect invoice or write off an invoice as bad debt could be applied to that specific invoice.<br />
* Credits can also be applied to refunds to indicate that the credit was refunded to the customer instead.<br />
* The "(apply)" and "(unapply)" links next to specific credits (in the Payment History section of the customer view page) can be used to change the application of credits to specific invoice(s) and/or refunds(s).<br />
<br />
==== Refunds ====<br />
<br />
Refunds are money paid to the customer. Refunds increase the customer's balance.<br />
<br />
===== Check and Cash refunds =====<br />
<br />
* Posting refunds<br />
* Applying and unapplying refunds.<br />
<br />
===== Credit card and electronic check (ACH) refunds =====<br />
<br />
* To refund a specific credit card or electronic check (ACH) payment back to the customer, use the "(refund)" link next to that specific payment (in the Payment History section of the customer view page). This will process a refund for the amount of the payment with the payment gateway.<br />
<br />
= Ticketing =<br />
<br />
Link to RT documentation<br />
<br />
== New ticket ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_8.html<br />
<br />
== Ticketing Main ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_9.html<br />
<br />
== Ticket View ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_10.html<br />
<br />
= Searching and Reporting =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_14.html<br />
<br />
== Customers ==<br />
<br />
* To search for a customer, enter the customer number, name, company name or contact phone number into the "Search customers" box at the top of each page. Name and company are "fuzzy" searches that will attempt to find a close match if no exact match is found.<br />
* Other customer browsing and reporting is available from Reports -> Customers<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search customers" box at the top of each page, or go to Reports -> Customers -> Advanced customer reports<br />
<br />
* To search for a customer by invoice number or service information (such as username, email address, domain or service phone number), use the invoice or service search, then click on the customer or "View this customer" link.<br />
<br />
== Invoices ==<br />
<br />
* To search for an invoice, enter the invoice number into the "Search customers" box at the top of each page.<br />
* Other invoice browsing and reporting is available from Reports -> Invoices<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search invoice" box at the top of each page, or go to Reports -> Invoices -> Advanced invoice reports<br />
<br />
== Packages ==<br />
<br />
* Package browsing and reporting is available from Reports -> Packages<br />
* For advanced reporting with specific criteria, go to Reports -> Packages -> Advanced package reports<br />
<br />
=== FCC Form 477 ===<br />
<br />
==== Prerequisites ====<br />
<br />
* visit Configuration->Settings and set cust_main-require_censustract to Yes<br />
* visit Configuration->Packages->Package report classes and add classes to match the FCCs reporting requirements<br />
* edit your package definitions (Configuration->Packages->Package definitions) to include some report classes<br />
<br />
==== Usage ====<br />
<br />
* visit Reports->Customers->Advanced customer reports to find customers lacking census tract information<br />
* edit customers who lack census information - you should either see a popup asking for census information or it will be automatically filled when you save the customer<br />
* visit Reports->Packages->Advanced package reports to generate reports which may filter by ALL selected "report classes" (logically ANDed)<br />
* visit Reports->Packages->FCC Form 477 packages to generate reports collated by census tract<br />
<br />
==== Additional notes ====<br />
<br />
Once logged into the fcc system, one can offer it one or more files for upload via its html forms. For 'small' systems (fewer than 5000 broadband subscriptions) we support a single file upload. The size restriction is an FCC restriction on the number of lines in the XML file.<br />
<br />
To prepare the report for upload, one must first tag package definitions with appropriate report classes. 'Appropriate' depends on context. For example, if a reporting entity must submit FCC Part IIA then the reporting entity must designate which packages contain 'unswitched UNE loops' and must tag the definitions with a report option which means this. If Part IIA is to be submitted, then each package definition must have the 'voice grade equivalency' for each package (defalt is 0). The global config cust_pkg-show_fcc_voice_grade_equivalent must be enabled to edit this.<br />
<br />
Once the packages are tagged, useful reports may be generated. By visiting Reports->Packages->FCC Form 477 you may choose which 'parts' of the FCC form to generate (since not all parts are meaningful to all companies). In Part IA all download speeds and all upload speeds must be set meaningfully and at least one technology must be set. Part IB is not presently supported. Parts IIA and IIB depend on the ds0 equivalency number. They make use of the report options to calculate the percentage of the whole number of ds0s. All of parts I and II rely on the existance of a company name in the customer record for determining if the package is residential or not. Part III is not supported at this time. Part IV offers free form comments. Parts V and VI depend on parts II and I respectively. Only selection of their generation may be selected (and is ignored if the antecedents are missing).<br />
<br />
After pressing the submit button, the top 'XML file' link represents a file suitable for uploading to the FCC as an XML file as long as fewer than 5000 broadband connections are being reported. Parts V and VI may also be downloaded as CSV files from links adjacent to the section. This (particularly VI) should be useful for larger entities who must perform the upload in parts.<br />
<br />
== Services ==<br />
<br />
* To search for a service such as username, email address, IP address, MAC address, domain or service phone number, enter the search data into the "Search servcies" box at the top of each page.<br />
* Other service browsing and reporting is available from Reports -> Services<br />
<br />
=== Accounts ===<br />
=== Domains ===<br />
=== Mail Forwards ===<br />
=== Virtual hosting ===<br />
=== Broadband ===<br />
=== Phone numbers ===<br />
=== External ===<br />
<br />
== Usage ==<br />
<br />
== Tickets ==<br />
<br />
* To search for a ticket, enter the ticket number, subject, or email address into the "Search tickets" box at the top of each page.<br />
* A fulltext ticket search can also be performed by entering "fulltext:searchstring" where searchstring is the string to search for.<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search tickets" box at the top of each page.<br />
<br />
<br />
== Financial Reports ==<br />
<br />
=== Sales, Credits and Receipts ===<br />
<br />
=== Sales Report ===<br />
<br />
=== Credit Report ===<br />
<br />
=== Payment Report ===<br />
<br />
=== Payment Batch Report ===<br />
<br />
=== A/R Aging ===<br />
<br />
Go to Reports -> Financial -> A/R aging to pull up an aging report<br />
<br />
* Select "All customers" to pull up a report including all customers.<br />
* Select "Customers with a balance" (the default) to pull up a report only including customers with a balance. Optionally enter a number of days to pull up a report only including customers with balances over the specified number of days old.<br />
<br />
=== Prepaid income ===<br />
<br />
=== Sales tax liability ===<br />
<br />
Go to Reports -> Financial -> Sales tax liability to pull up a report of total sales and taxes, for example, to pull up numbers to add to Quickbooks or another accounting package.<br />
<br />
* Enter start and end dates to restrict the search to a specific time period.<br />
* Check "Show tax classes" to break down sales and taxes by tax class.<br />
* Check "Show package classes" to break down sales and taxes by package class.<br />
<br />
* In the resulting sales tax report, all clickable links take you to a detail report of the specific items making up the number reported.<br />
<br />
= Tools =<br />
<br />
== Quick Payment Entry ==<br />
<br />
= Auditing Legacy Data =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_15.html</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:User&diff=6166Freeside:2.1:Documentation:User2010-12-13T22:19:04Z<p>Levinse: /* DSL */</p>
<hr />
<div>= Introduction =<br />
<br />
== About ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_1.html ?<br />
<br />
AGPL now, and MySQL is also supported<br />
<br />
== Navigation and Preferences ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_2.html<br />
<br />
== Customers, Packages and Services ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_3.html<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_4.html (simple case: single package and service)<br />
<br />
= Customers =<br />
<br />
== Adding customers ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_5.html<br />
<br />
== Searching for customers ==<br />
<br />
<br />
<br />
== Customer view ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_6.html<br />
<br />
=== Actions ===<br />
<br />
==== Edit customer ====<br />
==== Cancel customer ====<br />
==== Refer customer ====<br />
==== View customer's referrals ====<br />
==== Bill now ====<br />
<br />
=== Comments / Notes ===<br />
<br />
==== Comments ====<br />
<br />
==== Notes ====<br />
<br />
=== Tickets ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_7.html<br />
<br />
=== Packages ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_11.html<br />
<br />
==== Qualifications ====<br />
<br />
If you have any qualification-capable services configured, you may perform qualifications using the "New Qualification" link under Packages, and then choosing the "Qualify using" field appropriately and filling out the form.<br />
<br />
Previously-performed qualifications may be viewed from "View Qualifications".<br />
<br />
Notes specific to New Qualification for Ikano:<br />
# An address is always required<br />
# Location Type may be only one of the fixed Ikano values - see their documentation<br />
# Location Kind must always be chosen<br />
# Dry loops - always leave "Service Telephone Number" empty<br />
# Line-share (non dry loops) - always fill in "Service Telephone Number"<br />
<br />
<br />
Notes specific to qualification results / viewing previous qualifications for Ikano:<br />
# The view qualification page will show all possible packages in Freeside which you can order, based on the customer data which was qualified<br />
# You need the "Vendor Qualification #" to create a new Ikano DSL order<br />
<br />
==== Services ====<br />
<br />
===== Accounts =====<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_12.html<br />
<br />
===== Domains =====<br />
===== Mail Forwards =====<br />
===== Virtual hosting =====<br />
===== Broadband =====<br />
===== Phone numbers =====<br />
===== External =====<br />
===== DSL =====<br />
<br />
Ikano-specific notes:<br />
* New Orders<br />
# Get the "Vendor Qualification #" from a previously-performed qualification (see Qualifications above)<br />
# Order one of the qualifying packages shown on the qualification result and set the start date and location on this package appropriately<br />
# When adding the DSL service, the Vendor Qualification Id you copied should be pasted into the appropriate field<br />
# For dry loops, leave the Service Telephone Number blank and choose the "Standalone" Loop Type<br />
# For line-share (non dry-loops), always fill in the Service Telephone Number and choose the "Line-share" Loop Type<br />
* Viewing DSL Orders - click on the service to view all order data, including notes placed on the order by Ikano or you via their web portal<br />
* Canceling DSL Orders<br />
** If you have a NEW order in NEW or PENDING statuses, it may be canceled immediately - do a normal "Cancel now" on the package<br />
** If you have a NEW order in COMPLETED status, it may be canceled by expiring the package - do a normal "Cancel later" on the package with a cancel date at least 48 hours in future<br />
* Changing PPPoE password - edit the service and change the password<br />
* Suspending and unsuspending - do a normal Suspend Now or Unsuspend on the package<br />
* See XXX for processes not supported currently<br />
<br />
=== Payment history and actions === <br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_13.html<br />
<br />
==== Invoices ====<br />
<br />
Invoices are generated by the system. The charges on each invoice reflect the setup/one-time, recurring and usage charges of that customer's packages. Invoices increase the customer's balance.<br />
<br />
To add new packages or charges to a customer, use the "Order new package" or "One-time charge" links in the Packages section of the Customer View page.<br />
<br />
To generate a pending invoice for a customer, use the "Bill now" link at the top of the Customer View page.<br />
<br />
==== Payments ====<br />
<br />
Payments are money the customer pays. Payments decrease the customer's balance.<br />
<br />
===== Check and Cash payments =====<br />
<br />
* To post a check or cash payment, use the "Enter check payment" or "Enter cash payment" links at the top of the Payment History section of the customer view page.<br />
** Enter the amount of the payment.<br />
** For check payments, enter the check number.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the payment to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the payment to invoice(s) (or refund(s)) manually.<br />
<br />
* Multiple check payments can also be entered in a batch under Tools -> Quick Payment Entry.<br />
<br />
===== Credit card and electronic check (ACH) payments =====<br />
<br />
* Credit card or electronic check payments will be initiated by the system for customers with Billing Type "Credit card (automatic)" or "Electronic Check (automatic)".<br />
<br />
* Payments can be initiated manually by using the "Process credit card payment" or "Process electronic check (ACH) payment" links, in the Payment History section of the customer view page.<br />
** Enter the amount to process (defaults to the customer's current outstanding balance).<br />
** For credit card payments, enter the card number, expiration date, name on card and billing address. If the customer has a card on-file, the masked card number ("4111xxxxxxxx1111") and other information can be left as-is to charge the on-file card.<br />
** For electronic check payments, enter the account number, account type, ABA or routing number, and bank name (other information such as bank state, social security number, or driver's license number may also be required by some payment gateways). If the customer has electronic checking information on-file, the masked account number and other information can be left as-is to charge the on-file bank account.<br />
** Check "Remember this information" to save the payment information on-file.<br />
** Also check "Charge future payments to this credit card/electronic check automatically" to charge the customer automatically in the future.<br />
<br />
* Customers may use the self-service interface to pay by credit card or electronic check themselves.<br />
<br />
===== Payment application =====<br />
<br />
* Payments are applied to a specific invoice (or split between multiple invoices).<br />
* The "(apply)" and "(unapply)" links next to specific payment (in the Payment History section of the customer view page) can be used to change the application of payments to specific invoice(s) and/or refunds(s).<br />
<br />
==== Credits ====<br />
<br />
Credits are adjustments to the amount the customer owes. Credits decrease the customer's balance.<br />
<br />
* To post a credit, use the "Enter credit" link at the top of the Payment History section of the customer view page.<br />
** Enter the amount to credit.<br />
** Select the reason for the credit or enter a new reason.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the credit to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the credit to invoice(s) (or refund(s)) manually.<br />
<br />
* Like payments, credits can be applied to an invoice (or split between multiple invoices). For example, a credit to reverse an incorrect invoice or write off an invoice as bad debt could be applied to that specific invoice.<br />
* Credits can also be applied to refunds to indicate that the credit was refunded to the customer instead.<br />
* The "(apply)" and "(unapply)" links next to specific credits (in the Payment History section of the customer view page) can be used to change the application of credits to specific invoice(s) and/or refunds(s).<br />
<br />
==== Refunds ====<br />
<br />
Refunds are money paid to the customer. Refunds increase the customer's balance.<br />
<br />
===== Check and Cash refunds =====<br />
<br />
* Posting refunds<br />
* Applying and unapplying refunds.<br />
<br />
===== Credit card and electronic check (ACH) refunds =====<br />
<br />
* To refund a specific credit card or electronic check (ACH) payment back to the customer, use the "(refund)" link next to that specific payment (in the Payment History section of the customer view page). This will process a refund for the amount of the payment with the payment gateway.<br />
<br />
= Ticketing =<br />
<br />
Link to RT documentation<br />
<br />
== New ticket ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_8.html<br />
<br />
== Ticketing Main ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_9.html<br />
<br />
== Ticket View ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_10.html<br />
<br />
= Searching and Reporting =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_14.html<br />
<br />
== Customers ==<br />
<br />
* To search for a customer, enter the customer number, name, company name or contact phone number into the "Search customers" box at the top of each page. Name and company are "fuzzy" searches that will attempt to find a close match if no exact match is found.<br />
* Other customer browsing and reporting is available from Reports -> Customers<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search customers" box at the top of each page, or go to Reports -> Customers -> Advanced customer reports<br />
<br />
* To search for a customer by invoice number or service information (such as username, email address, domain or service phone number), use the invoice or service search, then click on the customer or "View this customer" link.<br />
<br />
== Invoices ==<br />
<br />
* To search for an invoice, enter the invoice number into the "Search customers" box at the top of each page.<br />
* Other invoice browsing and reporting is available from Reports -> Invoices<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search invoice" box at the top of each page, or go to Reports -> Invoices -> Advanced invoice reports<br />
<br />
== Packages ==<br />
<br />
* Package browsing and reporting is available from Reports -> Packages<br />
* For advanced reporting with specific criteria, go to Reports -> Packages -> Advanced package reports<br />
<br />
=== FCC Form 477 ===<br />
<br />
==== Prerequisites ====<br />
<br />
* visit Configuration->Settings and set cust_main-require_censustract to Yes<br />
* visit Configuration->Packages->Package report classes and add classes to match the FCCs reporting requirements<br />
* edit your package definitions (Configuration->Packages->Package definitions) to include some report classes<br />
<br />
==== Usage ====<br />
<br />
* visit Reports->Customers->Advanced customer reports to find customers lacking census tract information<br />
* edit customers who lack census information - you should either see a popup asking for census information or it will be automatically filled when you save the customer<br />
* visit Reports->Packages->Advanced package reports to generate reports which may filter by ALL selected "report classes" (logically ANDed)<br />
* visit Reports->Packages->FCC Form 477 packages to generate reports collated by census tract<br />
<br />
==== Additional notes ====<br />
<br />
Once logged into the fcc system, one can offer it one or more files for upload via its html forms. For 'small' systems (fewer than 5000 broadband subscriptions) we support a single file upload. The size restriction is an FCC restriction on the number of lines in the XML file.<br />
<br />
To prepare the report for upload, one must first tag package definitions with appropriate report classes. 'Appropriate' depends on context. For example, if a reporting entity must submit FCC Part IIA then the reporting entity must designate which packages contain 'unswitched UNE loops' and must tag the definitions with a report option which means this. If Part IIA is to be submitted, then each package definition must have the 'voice grade equivalency' for each package (defalt is 0). The global config cust_pkg-show_fcc_voice_grade_equivalent must be enabled to edit this.<br />
<br />
Once the packages are tagged, useful reports may be generated. By visiting Reports->Packages->FCC Form 477 you may choose which 'parts' of the FCC form to generate (since not all parts are meaningful to all companies). In Part IA all download speeds and all upload speeds must be set meaningfully and at least one technology must be set. Part IB is not presently supported. Parts IIA and IIB depend on the ds0 equivalency number. They make use of the report options to calculate the percentage of the whole number of ds0s. All of parts I and II rely on the existance of a company name in the customer record for determining if the package is residential or not. Part III is not supported at this time. Part IV offers free form comments. Parts V and VI depend on parts II and I respectively. Only selection of their generation may be selected (and is ignored if the antecedents are missing).<br />
<br />
After pressing the submit button, the top 'XML file' link represents a file suitable for uploading to the FCC as an XML file as long as fewer than 5000 broadband connections are being reported. Parts V and VI may also be downloaded as CSV files from links adjacent to the section. This (particularly VI) should be useful for larger entities who must perform the upload in parts.<br />
<br />
== Services ==<br />
<br />
* To search for a service such as username, email address, IP address, MAC address, domain or service phone number, enter the search data into the "Search servcies" box at the top of each page.<br />
* Other service browsing and reporting is available from Reports -> Services<br />
<br />
=== Accounts ===<br />
=== Domains ===<br />
=== Mail Forwards ===<br />
=== Virtual hosting ===<br />
=== Broadband ===<br />
=== Phone numbers ===<br />
=== External ===<br />
<br />
== Usage ==<br />
<br />
== Tickets ==<br />
<br />
* To search for a ticket, enter the ticket number, subject, or email address into the "Search tickets" box at the top of each page.<br />
* A fulltext ticket search can also be performed by entering "fulltext:searchstring" where searchstring is the string to search for.<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search tickets" box at the top of each page.<br />
<br />
<br />
== Financial Reports ==<br />
<br />
=== Sales, Credits and Receipts ===<br />
<br />
=== Sales Report ===<br />
<br />
=== Credit Report ===<br />
<br />
=== Payment Report ===<br />
<br />
=== Payment Batch Report ===<br />
<br />
=== A/R Aging ===<br />
<br />
Go to Reports -> Financial -> A/R aging to pull up an aging report<br />
<br />
* Select "All customers" to pull up a report including all customers.<br />
* Select "Customers with a balance" (the default) to pull up a report only including customers with a balance. Optionally enter a number of days to pull up a report only including customers with balances over the specified number of days old.<br />
<br />
=== Prepaid income ===<br />
<br />
=== Sales tax liability ===<br />
<br />
Go to Reports -> Financial -> Sales tax liability to pull up a report of total sales and taxes, for example, to pull up numbers to add to Quickbooks or another accounting package.<br />
<br />
* Enter start and end dates to restrict the search to a specific time period.<br />
* Check "Show tax classes" to break down sales and taxes by tax class.<br />
* Check "Show package classes" to break down sales and taxes by package class.<br />
<br />
* In the resulting sales tax report, all clickable links take you to a detail report of the specific items making up the number reported.<br />
<br />
= Tools =<br />
<br />
== Quick Payment Entry ==<br />
<br />
= Auditing Legacy Data =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_15.html</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6165Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T22:16:38Z<p>Levinse: </p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
* Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
* Export Host - not used, may be set to anything<br />
<br />
* Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
* Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
[[Image:Svc dsl-ikano2.png]]<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
# In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
# Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6164Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T22:15:49Z<p>Levinse: /* Packages */</p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
* Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
* Export Host - not used, may be set to anything<br />
<br />
* Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
* Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
[[Image:Svc dsl-ikano2.png]]<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
# In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
# Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6163Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T22:15:41Z<p>Levinse: /* Packages */</p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
* Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
* Export Host - not used, may be set to anything<br />
<br />
* Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
* Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
[[Image:Svc dsl-ikano2.png]]<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
# In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
<br />
# Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6162Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T22:15:05Z<p>Levinse: /* Services */</p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
* Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
* Export Host - not used, may be set to anything<br />
<br />
* Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
* Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
[[Image:Svc dsl-ikano2.png]]<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=File:Svc_dsl-ikano2.png&diff=6161File:Svc dsl-ikano2.png2010-12-13T22:14:05Z<p>Levinse: </p>
<hr />
<div></div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6160Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T22:13:44Z<p>Levinse: /* Exports */</p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
* Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
* Export Host - not used, may be set to anything<br />
<br />
* Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
* Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:User&diff=6159Freeside:2.1:Documentation:User2010-12-13T22:12:29Z<p>Levinse: /* DSL */</p>
<hr />
<div>= Introduction =<br />
<br />
== About ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_1.html ?<br />
<br />
AGPL now, and MySQL is also supported<br />
<br />
== Navigation and Preferences ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_2.html<br />
<br />
== Customers, Packages and Services ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_3.html<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_4.html (simple case: single package and service)<br />
<br />
= Customers =<br />
<br />
== Adding customers ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_5.html<br />
<br />
== Searching for customers ==<br />
<br />
<br />
<br />
== Customer view ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_6.html<br />
<br />
=== Actions ===<br />
<br />
==== Edit customer ====<br />
==== Cancel customer ====<br />
==== Refer customer ====<br />
==== View customer's referrals ====<br />
==== Bill now ====<br />
<br />
=== Comments / Notes ===<br />
<br />
==== Comments ====<br />
<br />
==== Notes ====<br />
<br />
=== Tickets ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_7.html<br />
<br />
=== Packages ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_11.html<br />
<br />
==== Qualifications ====<br />
<br />
If you have any qualification-capable services configured, you may perform qualifications using the "New Qualification" link under Packages, and then choosing the "Qualify using" field appropriately and filling out the form.<br />
<br />
Previously-performed qualifications may be viewed from "View Qualifications".<br />
<br />
Notes specific to New Qualification for Ikano:<br />
# An address is always required<br />
# Location Type may be only one of the fixed Ikano values - see their documentation<br />
# Location Kind must always be chosen<br />
# Dry loops - always leave "Service Telephone Number" empty<br />
# Line-share (non dry loops) - always fill in "Service Telephone Number"<br />
<br />
<br />
Notes specific to qualification results / viewing previous qualifications for Ikano:<br />
# The view qualification page will show all possible packages in Freeside which you can order, based on the customer data which was qualified<br />
# You need the "Vendor Qualification #" to create a new Ikano DSL order<br />
<br />
==== Services ====<br />
<br />
===== Accounts =====<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_12.html<br />
<br />
===== Domains =====<br />
===== Mail Forwards =====<br />
===== Virtual hosting =====<br />
===== Broadband =====<br />
===== Phone numbers =====<br />
===== External =====<br />
===== DSL =====<br />
<br />
Ikano-specific notes:<br />
* New Orders<br />
# Get the "Vendor Qualification #" from a previously-performed qualification (see Qualifications above)<br />
# Order one of the qualifying packages shown on the qualification result and set the start date and location on this package appropriately<br />
# When adding the DSL service, the Vendor Qualification Id you copied should be pasted into the appropriate field<br />
# For dry loops, leave the Service Telephone Number blank and choose the "Standalone" Loop Type<br />
# For line-share (non dry-loops), always fill in the Service Telephone Number and choose the "Line-share" Loop Type<br />
* Viewing DSL Orders - click on the service to view all order data<br />
* Canceling DSL Orders<br />
** If you have a NEW order in NEW or PENDING statuses, it may be canceled immediately - do a normal "Cancel now" on the package<br />
** If you have a NEW order in COMPLETED status, it may be canceled by expiring the package - do a normal "Cancel later" on the package with a cancel date at least 48 hours in future<br />
* Changing PPPoE password - edit the service and change the password<br />
* Suspending and unsuspending - do a normal Suspend Now or Unsuspend on the package<br />
* See XXX for processes not supported currently<br />
<br />
=== Payment history and actions === <br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_13.html<br />
<br />
==== Invoices ====<br />
<br />
Invoices are generated by the system. The charges on each invoice reflect the setup/one-time, recurring and usage charges of that customer's packages. Invoices increase the customer's balance.<br />
<br />
To add new packages or charges to a customer, use the "Order new package" or "One-time charge" links in the Packages section of the Customer View page.<br />
<br />
To generate a pending invoice for a customer, use the "Bill now" link at the top of the Customer View page.<br />
<br />
==== Payments ====<br />
<br />
Payments are money the customer pays. Payments decrease the customer's balance.<br />
<br />
===== Check and Cash payments =====<br />
<br />
* To post a check or cash payment, use the "Enter check payment" or "Enter cash payment" links at the top of the Payment History section of the customer view page.<br />
** Enter the amount of the payment.<br />
** For check payments, enter the check number.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the payment to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the payment to invoice(s) (or refund(s)) manually.<br />
<br />
* Multiple check payments can also be entered in a batch under Tools -> Quick Payment Entry.<br />
<br />
===== Credit card and electronic check (ACH) payments =====<br />
<br />
* Credit card or electronic check payments will be initiated by the system for customers with Billing Type "Credit card (automatic)" or "Electronic Check (automatic)".<br />
<br />
* Payments can be initiated manually by using the "Process credit card payment" or "Process electronic check (ACH) payment" links, in the Payment History section of the customer view page.<br />
** Enter the amount to process (defaults to the customer's current outstanding balance).<br />
** For credit card payments, enter the card number, expiration date, name on card and billing address. If the customer has a card on-file, the masked card number ("4111xxxxxxxx1111") and other information can be left as-is to charge the on-file card.<br />
** For electronic check payments, enter the account number, account type, ABA or routing number, and bank name (other information such as bank state, social security number, or driver's license number may also be required by some payment gateways). If the customer has electronic checking information on-file, the masked account number and other information can be left as-is to charge the on-file bank account.<br />
** Check "Remember this information" to save the payment information on-file.<br />
** Also check "Charge future payments to this credit card/electronic check automatically" to charge the customer automatically in the future.<br />
<br />
* Customers may use the self-service interface to pay by credit card or electronic check themselves.<br />
<br />
===== Payment application =====<br />
<br />
* Payments are applied to a specific invoice (or split between multiple invoices).<br />
* The "(apply)" and "(unapply)" links next to specific payment (in the Payment History section of the customer view page) can be used to change the application of payments to specific invoice(s) and/or refunds(s).<br />
<br />
==== Credits ====<br />
<br />
Credits are adjustments to the amount the customer owes. Credits decrease the customer's balance.<br />
<br />
* To post a credit, use the "Enter credit" link at the top of the Payment History section of the customer view page.<br />
** Enter the amount to credit.<br />
** Select the reason for the credit or enter a new reason.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the credit to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the credit to invoice(s) (or refund(s)) manually.<br />
<br />
* Like payments, credits can be applied to an invoice (or split between multiple invoices). For example, a credit to reverse an incorrect invoice or write off an invoice as bad debt could be applied to that specific invoice.<br />
* Credits can also be applied to refunds to indicate that the credit was refunded to the customer instead.<br />
* The "(apply)" and "(unapply)" links next to specific credits (in the Payment History section of the customer view page) can be used to change the application of credits to specific invoice(s) and/or refunds(s).<br />
<br />
==== Refunds ====<br />
<br />
Refunds are money paid to the customer. Refunds increase the customer's balance.<br />
<br />
===== Check and Cash refunds =====<br />
<br />
* Posting refunds<br />
* Applying and unapplying refunds.<br />
<br />
===== Credit card and electronic check (ACH) refunds =====<br />
<br />
* To refund a specific credit card or electronic check (ACH) payment back to the customer, use the "(refund)" link next to that specific payment (in the Payment History section of the customer view page). This will process a refund for the amount of the payment with the payment gateway.<br />
<br />
= Ticketing =<br />
<br />
Link to RT documentation<br />
<br />
== New ticket ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_8.html<br />
<br />
== Ticketing Main ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_9.html<br />
<br />
== Ticket View ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_10.html<br />
<br />
= Searching and Reporting =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_14.html<br />
<br />
== Customers ==<br />
<br />
* To search for a customer, enter the customer number, name, company name or contact phone number into the "Search customers" box at the top of each page. Name and company are "fuzzy" searches that will attempt to find a close match if no exact match is found.<br />
* Other customer browsing and reporting is available from Reports -> Customers<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search customers" box at the top of each page, or go to Reports -> Customers -> Advanced customer reports<br />
<br />
* To search for a customer by invoice number or service information (such as username, email address, domain or service phone number), use the invoice or service search, then click on the customer or "View this customer" link.<br />
<br />
== Invoices ==<br />
<br />
* To search for an invoice, enter the invoice number into the "Search customers" box at the top of each page.<br />
* Other invoice browsing and reporting is available from Reports -> Invoices<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search invoice" box at the top of each page, or go to Reports -> Invoices -> Advanced invoice reports<br />
<br />
== Packages ==<br />
<br />
* Package browsing and reporting is available from Reports -> Packages<br />
* For advanced reporting with specific criteria, go to Reports -> Packages -> Advanced package reports<br />
<br />
=== FCC Form 477 ===<br />
<br />
==== Prerequisites ====<br />
<br />
* visit Configuration->Settings and set cust_main-require_censustract to Yes<br />
* visit Configuration->Packages->Package report classes and add classes to match the FCCs reporting requirements<br />
* edit your package definitions (Configuration->Packages->Package definitions) to include some report classes<br />
<br />
==== Usage ====<br />
<br />
* visit Reports->Customers->Advanced customer reports to find customers lacking census tract information<br />
* edit customers who lack census information - you should either see a popup asking for census information or it will be automatically filled when you save the customer<br />
* visit Reports->Packages->Advanced package reports to generate reports which may filter by ALL selected "report classes" (logically ANDed)<br />
* visit Reports->Packages->FCC Form 477 packages to generate reports collated by census tract<br />
<br />
==== Additional notes ====<br />
<br />
Once logged into the fcc system, one can offer it one or more files for upload via its html forms. For 'small' systems (fewer than 5000 broadband subscriptions) we support a single file upload. The size restriction is an FCC restriction on the number of lines in the XML file.<br />
<br />
To prepare the report for upload, one must first tag package definitions with appropriate report classes. 'Appropriate' depends on context. For example, if a reporting entity must submit FCC Part IIA then the reporting entity must designate which packages contain 'unswitched UNE loops' and must tag the definitions with a report option which means this. If Part IIA is to be submitted, then each package definition must have the 'voice grade equivalency' for each package (defalt is 0). The global config cust_pkg-show_fcc_voice_grade_equivalent must be enabled to edit this.<br />
<br />
Once the packages are tagged, useful reports may be generated. By visiting Reports->Packages->FCC Form 477 you may choose which 'parts' of the FCC form to generate (since not all parts are meaningful to all companies). In Part IA all download speeds and all upload speeds must be set meaningfully and at least one technology must be set. Part IB is not presently supported. Parts IIA and IIB depend on the ds0 equivalency number. They make use of the report options to calculate the percentage of the whole number of ds0s. All of parts I and II rely on the existance of a company name in the customer record for determining if the package is residential or not. Part III is not supported at this time. Part IV offers free form comments. Parts V and VI depend on parts II and I respectively. Only selection of their generation may be selected (and is ignored if the antecedents are missing).<br />
<br />
After pressing the submit button, the top 'XML file' link represents a file suitable for uploading to the FCC as an XML file as long as fewer than 5000 broadband connections are being reported. Parts V and VI may also be downloaded as CSV files from links adjacent to the section. This (particularly VI) should be useful for larger entities who must perform the upload in parts.<br />
<br />
== Services ==<br />
<br />
* To search for a service such as username, email address, IP address, MAC address, domain or service phone number, enter the search data into the "Search servcies" box at the top of each page.<br />
* Other service browsing and reporting is available from Reports -> Services<br />
<br />
=== Accounts ===<br />
=== Domains ===<br />
=== Mail Forwards ===<br />
=== Virtual hosting ===<br />
=== Broadband ===<br />
=== Phone numbers ===<br />
=== External ===<br />
<br />
== Usage ==<br />
<br />
== Tickets ==<br />
<br />
* To search for a ticket, enter the ticket number, subject, or email address into the "Search tickets" box at the top of each page.<br />
* A fulltext ticket search can also be performed by entering "fulltext:searchstring" where searchstring is the string to search for.<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search tickets" box at the top of each page.<br />
<br />
<br />
== Financial Reports ==<br />
<br />
=== Sales, Credits and Receipts ===<br />
<br />
=== Sales Report ===<br />
<br />
=== Credit Report ===<br />
<br />
=== Payment Report ===<br />
<br />
=== Payment Batch Report ===<br />
<br />
=== A/R Aging ===<br />
<br />
Go to Reports -> Financial -> A/R aging to pull up an aging report<br />
<br />
* Select "All customers" to pull up a report including all customers.<br />
* Select "Customers with a balance" (the default) to pull up a report only including customers with a balance. Optionally enter a number of days to pull up a report only including customers with balances over the specified number of days old.<br />
<br />
=== Prepaid income ===<br />
<br />
=== Sales tax liability ===<br />
<br />
Go to Reports -> Financial -> Sales tax liability to pull up a report of total sales and taxes, for example, to pull up numbers to add to Quickbooks or another accounting package.<br />
<br />
* Enter start and end dates to restrict the search to a specific time period.<br />
* Check "Show tax classes" to break down sales and taxes by tax class.<br />
* Check "Show package classes" to break down sales and taxes by package class.<br />
<br />
* In the resulting sales tax report, all clickable links take you to a detail report of the specific items making up the number reported.<br />
<br />
= Tools =<br />
<br />
== Quick Payment Entry ==<br />
<br />
= Auditing Legacy Data =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_15.html</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:User&diff=6158Freeside:2.1:Documentation:User2010-12-13T22:11:22Z<p>Levinse: /* Services */</p>
<hr />
<div>= Introduction =<br />
<br />
== About ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_1.html ?<br />
<br />
AGPL now, and MySQL is also supported<br />
<br />
== Navigation and Preferences ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_2.html<br />
<br />
== Customers, Packages and Services ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_3.html<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_4.html (simple case: single package and service)<br />
<br />
= Customers =<br />
<br />
== Adding customers ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_5.html<br />
<br />
== Searching for customers ==<br />
<br />
<br />
<br />
== Customer view ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_6.html<br />
<br />
=== Actions ===<br />
<br />
==== Edit customer ====<br />
==== Cancel customer ====<br />
==== Refer customer ====<br />
==== View customer's referrals ====<br />
==== Bill now ====<br />
<br />
=== Comments / Notes ===<br />
<br />
==== Comments ====<br />
<br />
==== Notes ====<br />
<br />
=== Tickets ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_7.html<br />
<br />
=== Packages ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_11.html<br />
<br />
==== Qualifications ====<br />
<br />
If you have any qualification-capable services configured, you may perform qualifications using the "New Qualification" link under Packages, and then choosing the "Qualify using" field appropriately and filling out the form.<br />
<br />
Previously-performed qualifications may be viewed from "View Qualifications".<br />
<br />
Notes specific to New Qualification for Ikano:<br />
# An address is always required<br />
# Location Type may be only one of the fixed Ikano values - see their documentation<br />
# Location Kind must always be chosen<br />
# Dry loops - always leave "Service Telephone Number" empty<br />
# Line-share (non dry loops) - always fill in "Service Telephone Number"<br />
<br />
<br />
Notes specific to qualification results / viewing previous qualifications for Ikano:<br />
# The view qualification page will show all possible packages in Freeside which you can order, based on the customer data which was qualified<br />
# You need the "Vendor Qualification #" to create a new Ikano DSL order<br />
<br />
==== Services ====<br />
<br />
===== Accounts =====<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_12.html<br />
<br />
===== Domains =====<br />
===== Mail Forwards =====<br />
===== Virtual hosting =====<br />
===== Broadband =====<br />
===== Phone numbers =====<br />
===== External =====<br />
===== DSL =====<br />
<br />
Ikano-specific notes:<br />
# New Orders<br />
## Get the "Vendor Qualification #" from a previously-performed qualification (see Qualifications above)<br />
## Order one of the qualifying packages shown on the qualification result and set the start date and location on this package appropriately<br />
## When adding the DSL service, the Vendor Qualification Id you copied should be pasted into the appropriate field<br />
## For dry loops, leave the Service Telephone Number blank and choose the "Standalone" Loop Type<br />
## For line-share (non dry-loops), always fill in the Service Telephone Number and choose the "Line-share" Loop Type<br />
# Viewing DSL Orders - click on the service to view all order data<br />
# Canceling DSL Orders<br />
## If you have a NEW order in NEW or PENDING statuses, it may be canceled immediately - do a normal "Cancel now" on the package<br />
## If you have a NEW order in COMPLETED status, it may be canceled by expiring the package - do a normal "Cancel later" on the package with a cancel date at least 48 hours in future<br />
# Changing PPPoE password - edit the service and change the password<br />
# Suspending and unsuspending - do a normal Suspend Now or Unsuspend on the package<br />
# See XXX for processes not supported currently<br />
<br />
=== Payment history and actions === <br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_13.html<br />
<br />
==== Invoices ====<br />
<br />
Invoices are generated by the system. The charges on each invoice reflect the setup/one-time, recurring and usage charges of that customer's packages. Invoices increase the customer's balance.<br />
<br />
To add new packages or charges to a customer, use the "Order new package" or "One-time charge" links in the Packages section of the Customer View page.<br />
<br />
To generate a pending invoice for a customer, use the "Bill now" link at the top of the Customer View page.<br />
<br />
==== Payments ====<br />
<br />
Payments are money the customer pays. Payments decrease the customer's balance.<br />
<br />
===== Check and Cash payments =====<br />
<br />
* To post a check or cash payment, use the "Enter check payment" or "Enter cash payment" links at the top of the Payment History section of the customer view page.<br />
** Enter the amount of the payment.<br />
** For check payments, enter the check number.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the payment to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the payment to invoice(s) (or refund(s)) manually.<br />
<br />
* Multiple check payments can also be entered in a batch under Tools -> Quick Payment Entry.<br />
<br />
===== Credit card and electronic check (ACH) payments =====<br />
<br />
* Credit card or electronic check payments will be initiated by the system for customers with Billing Type "Credit card (automatic)" or "Electronic Check (automatic)".<br />
<br />
* Payments can be initiated manually by using the "Process credit card payment" or "Process electronic check (ACH) payment" links, in the Payment History section of the customer view page.<br />
** Enter the amount to process (defaults to the customer's current outstanding balance).<br />
** For credit card payments, enter the card number, expiration date, name on card and billing address. If the customer has a card on-file, the masked card number ("4111xxxxxxxx1111") and other information can be left as-is to charge the on-file card.<br />
** For electronic check payments, enter the account number, account type, ABA or routing number, and bank name (other information such as bank state, social security number, or driver's license number may also be required by some payment gateways). If the customer has electronic checking information on-file, the masked account number and other information can be left as-is to charge the on-file bank account.<br />
** Check "Remember this information" to save the payment information on-file.<br />
** Also check "Charge future payments to this credit card/electronic check automatically" to charge the customer automatically in the future.<br />
<br />
* Customers may use the self-service interface to pay by credit card or electronic check themselves.<br />
<br />
===== Payment application =====<br />
<br />
* Payments are applied to a specific invoice (or split between multiple invoices).<br />
* The "(apply)" and "(unapply)" links next to specific payment (in the Payment History section of the customer view page) can be used to change the application of payments to specific invoice(s) and/or refunds(s).<br />
<br />
==== Credits ====<br />
<br />
Credits are adjustments to the amount the customer owes. Credits decrease the customer's balance.<br />
<br />
* To post a credit, use the "Enter credit" link at the top of the Payment History section of the customer view page.<br />
** Enter the amount to credit.<br />
** Select the reason for the credit or enter a new reason.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the credit to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the credit to invoice(s) (or refund(s)) manually.<br />
<br />
* Like payments, credits can be applied to an invoice (or split between multiple invoices). For example, a credit to reverse an incorrect invoice or write off an invoice as bad debt could be applied to that specific invoice.<br />
* Credits can also be applied to refunds to indicate that the credit was refunded to the customer instead.<br />
* The "(apply)" and "(unapply)" links next to specific credits (in the Payment History section of the customer view page) can be used to change the application of credits to specific invoice(s) and/or refunds(s).<br />
<br />
==== Refunds ====<br />
<br />
Refunds are money paid to the customer. Refunds increase the customer's balance.<br />
<br />
===== Check and Cash refunds =====<br />
<br />
* Posting refunds<br />
* Applying and unapplying refunds.<br />
<br />
===== Credit card and electronic check (ACH) refunds =====<br />
<br />
* To refund a specific credit card or electronic check (ACH) payment back to the customer, use the "(refund)" link next to that specific payment (in the Payment History section of the customer view page). This will process a refund for the amount of the payment with the payment gateway.<br />
<br />
= Ticketing =<br />
<br />
Link to RT documentation<br />
<br />
== New ticket ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_8.html<br />
<br />
== Ticketing Main ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_9.html<br />
<br />
== Ticket View ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_10.html<br />
<br />
= Searching and Reporting =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_14.html<br />
<br />
== Customers ==<br />
<br />
* To search for a customer, enter the customer number, name, company name or contact phone number into the "Search customers" box at the top of each page. Name and company are "fuzzy" searches that will attempt to find a close match if no exact match is found.<br />
* Other customer browsing and reporting is available from Reports -> Customers<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search customers" box at the top of each page, or go to Reports -> Customers -> Advanced customer reports<br />
<br />
* To search for a customer by invoice number or service information (such as username, email address, domain or service phone number), use the invoice or service search, then click on the customer or "View this customer" link.<br />
<br />
== Invoices ==<br />
<br />
* To search for an invoice, enter the invoice number into the "Search customers" box at the top of each page.<br />
* Other invoice browsing and reporting is available from Reports -> Invoices<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search invoice" box at the top of each page, or go to Reports -> Invoices -> Advanced invoice reports<br />
<br />
== Packages ==<br />
<br />
* Package browsing and reporting is available from Reports -> Packages<br />
* For advanced reporting with specific criteria, go to Reports -> Packages -> Advanced package reports<br />
<br />
=== FCC Form 477 ===<br />
<br />
==== Prerequisites ====<br />
<br />
* visit Configuration->Settings and set cust_main-require_censustract to Yes<br />
* visit Configuration->Packages->Package report classes and add classes to match the FCCs reporting requirements<br />
* edit your package definitions (Configuration->Packages->Package definitions) to include some report classes<br />
<br />
==== Usage ====<br />
<br />
* visit Reports->Customers->Advanced customer reports to find customers lacking census tract information<br />
* edit customers who lack census information - you should either see a popup asking for census information or it will be automatically filled when you save the customer<br />
* visit Reports->Packages->Advanced package reports to generate reports which may filter by ALL selected "report classes" (logically ANDed)<br />
* visit Reports->Packages->FCC Form 477 packages to generate reports collated by census tract<br />
<br />
==== Additional notes ====<br />
<br />
Once logged into the fcc system, one can offer it one or more files for upload via its html forms. For 'small' systems (fewer than 5000 broadband subscriptions) we support a single file upload. The size restriction is an FCC restriction on the number of lines in the XML file.<br />
<br />
To prepare the report for upload, one must first tag package definitions with appropriate report classes. 'Appropriate' depends on context. For example, if a reporting entity must submit FCC Part IIA then the reporting entity must designate which packages contain 'unswitched UNE loops' and must tag the definitions with a report option which means this. If Part IIA is to be submitted, then each package definition must have the 'voice grade equivalency' for each package (defalt is 0). The global config cust_pkg-show_fcc_voice_grade_equivalent must be enabled to edit this.<br />
<br />
Once the packages are tagged, useful reports may be generated. By visiting Reports->Packages->FCC Form 477 you may choose which 'parts' of the FCC form to generate (since not all parts are meaningful to all companies). In Part IA all download speeds and all upload speeds must be set meaningfully and at least one technology must be set. Part IB is not presently supported. Parts IIA and IIB depend on the ds0 equivalency number. They make use of the report options to calculate the percentage of the whole number of ds0s. All of parts I and II rely on the existance of a company name in the customer record for determining if the package is residential or not. Part III is not supported at this time. Part IV offers free form comments. Parts V and VI depend on parts II and I respectively. Only selection of their generation may be selected (and is ignored if the antecedents are missing).<br />
<br />
After pressing the submit button, the top 'XML file' link represents a file suitable for uploading to the FCC as an XML file as long as fewer than 5000 broadband connections are being reported. Parts V and VI may also be downloaded as CSV files from links adjacent to the section. This (particularly VI) should be useful for larger entities who must perform the upload in parts.<br />
<br />
== Services ==<br />
<br />
* To search for a service such as username, email address, IP address, MAC address, domain or service phone number, enter the search data into the "Search servcies" box at the top of each page.<br />
* Other service browsing and reporting is available from Reports -> Services<br />
<br />
=== Accounts ===<br />
=== Domains ===<br />
=== Mail Forwards ===<br />
=== Virtual hosting ===<br />
=== Broadband ===<br />
=== Phone numbers ===<br />
=== External ===<br />
<br />
== Usage ==<br />
<br />
== Tickets ==<br />
<br />
* To search for a ticket, enter the ticket number, subject, or email address into the "Search tickets" box at the top of each page.<br />
* A fulltext ticket search can also be performed by entering "fulltext:searchstring" where searchstring is the string to search for.<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search tickets" box at the top of each page.<br />
<br />
<br />
== Financial Reports ==<br />
<br />
=== Sales, Credits and Receipts ===<br />
<br />
=== Sales Report ===<br />
<br />
=== Credit Report ===<br />
<br />
=== Payment Report ===<br />
<br />
=== Payment Batch Report ===<br />
<br />
=== A/R Aging ===<br />
<br />
Go to Reports -> Financial -> A/R aging to pull up an aging report<br />
<br />
* Select "All customers" to pull up a report including all customers.<br />
* Select "Customers with a balance" (the default) to pull up a report only including customers with a balance. Optionally enter a number of days to pull up a report only including customers with balances over the specified number of days old.<br />
<br />
=== Prepaid income ===<br />
<br />
=== Sales tax liability ===<br />
<br />
Go to Reports -> Financial -> Sales tax liability to pull up a report of total sales and taxes, for example, to pull up numbers to add to Quickbooks or another accounting package.<br />
<br />
* Enter start and end dates to restrict the search to a specific time period.<br />
* Check "Show tax classes" to break down sales and taxes by tax class.<br />
* Check "Show package classes" to break down sales and taxes by package class.<br />
<br />
* In the resulting sales tax report, all clickable links take you to a detail report of the specific items making up the number reported.<br />
<br />
= Tools =<br />
<br />
== Quick Payment Entry ==<br />
<br />
= Auditing Legacy Data =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_15.html</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation:User&diff=6157Freeside:2.1:Documentation:User2010-12-13T21:46:36Z<p>Levinse: /* Packages */</p>
<hr />
<div>= Introduction =<br />
<br />
== About ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_1.html ?<br />
<br />
AGPL now, and MySQL is also supported<br />
<br />
== Navigation and Preferences ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_2.html<br />
<br />
== Customers, Packages and Services ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_3.html<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_4.html (simple case: single package and service)<br />
<br />
= Customers =<br />
<br />
== Adding customers ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_5.html<br />
<br />
== Searching for customers ==<br />
<br />
<br />
<br />
== Customer view ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_6.html<br />
<br />
=== Actions ===<br />
<br />
==== Edit customer ====<br />
==== Cancel customer ====<br />
==== Refer customer ====<br />
==== View customer's referrals ====<br />
==== Bill now ====<br />
<br />
=== Comments / Notes ===<br />
<br />
==== Comments ====<br />
<br />
==== Notes ====<br />
<br />
=== Tickets ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_7.html<br />
<br />
=== Packages ===<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_11.html<br />
<br />
==== Qualifications ====<br />
<br />
If you have any qualification-capable services configured, you may perform qualifications using the "New Qualification" link under Packages, and then choosing the "Qualify using" field appropriately and filling out the form.<br />
<br />
Previously-performed qualifications may be viewed from "View Qualifications".<br />
<br />
Notes specific to New Qualification for Ikano:<br />
# An address is always required<br />
# Location Type may be only one of the fixed Ikano values - see their documentation<br />
# Location Kind must always be chosen<br />
# Dry loops - always leave "Service Telephone Number" empty<br />
# Line-share (non dry loops) - always fill in "Service Telephone Number"<br />
<br />
<br />
Notes specific to qualification results / viewing previous qualifications for Ikano:<br />
# The view qualification page will show all possible packages in Freeside which you can order, based on the customer data which was qualified<br />
# You need the "Vendor Qualification #" to create a new Ikano DSL order<br />
<br />
==== Services ====<br />
<br />
===== Accounts =====<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_12.html<br />
<br />
===== Domains =====<br />
===== Mail Forwards =====<br />
===== Virtual hosting =====<br />
===== Broadband =====<br />
===== Phone numbers =====<br />
===== External =====<br />
<br />
=== Payment history and actions === <br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_13.html<br />
<br />
==== Invoices ====<br />
<br />
Invoices are generated by the system. The charges on each invoice reflect the setup/one-time, recurring and usage charges of that customer's packages. Invoices increase the customer's balance.<br />
<br />
To add new packages or charges to a customer, use the "Order new package" or "One-time charge" links in the Packages section of the Customer View page.<br />
<br />
To generate a pending invoice for a customer, use the "Bill now" link at the top of the Customer View page.<br />
<br />
==== Payments ====<br />
<br />
Payments are money the customer pays. Payments decrease the customer's balance.<br />
<br />
===== Check and Cash payments =====<br />
<br />
* To post a check or cash payment, use the "Enter check payment" or "Enter cash payment" links at the top of the Payment History section of the customer view page.<br />
** Enter the amount of the payment.<br />
** For check payments, enter the check number.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the payment to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the payment to invoice(s) (or refund(s)) manually.<br />
<br />
* Multiple check payments can also be entered in a batch under Tools -> Quick Payment Entry.<br />
<br />
===== Credit card and electronic check (ACH) payments =====<br />
<br />
* Credit card or electronic check payments will be initiated by the system for customers with Billing Type "Credit card (automatic)" or "Electronic Check (automatic)".<br />
<br />
* Payments can be initiated manually by using the "Process credit card payment" or "Process electronic check (ACH) payment" links, in the Payment History section of the customer view page.<br />
** Enter the amount to process (defaults to the customer's current outstanding balance).<br />
** For credit card payments, enter the card number, expiration date, name on card and billing address. If the customer has a card on-file, the masked card number ("4111xxxxxxxx1111") and other information can be left as-is to charge the on-file card.<br />
** For electronic check payments, enter the account number, account type, ABA or routing number, and bank name (other information such as bank state, social security number, or driver's license number may also be required by some payment gateways). If the customer has electronic checking information on-file, the masked account number and other information can be left as-is to charge the on-file bank account.<br />
** Check "Remember this information" to save the payment information on-file.<br />
** Also check "Charge future payments to this credit card/electronic check automatically" to charge the customer automatically in the future.<br />
<br />
* Customers may use the self-service interface to pay by credit card or electronic check themselves.<br />
<br />
===== Payment application =====<br />
<br />
* Payments are applied to a specific invoice (or split between multiple invoices).<br />
* The "(apply)" and "(unapply)" links next to specific payment (in the Payment History section of the customer view page) can be used to change the application of payments to specific invoice(s) and/or refunds(s).<br />
<br />
==== Credits ====<br />
<br />
Credits are adjustments to the amount the customer owes. Credits decrease the customer's balance.<br />
<br />
* To post a credit, use the "Enter credit" link at the top of the Payment History section of the customer view page.<br />
** Enter the amount to credit.<br />
** Select the reason for the credit or enter a new reason.<br />
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the credit to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the credit to invoice(s) (or refund(s)) manually.<br />
<br />
* Like payments, credits can be applied to an invoice (or split between multiple invoices). For example, a credit to reverse an incorrect invoice or write off an invoice as bad debt could be applied to that specific invoice.<br />
* Credits can also be applied to refunds to indicate that the credit was refunded to the customer instead.<br />
* The "(apply)" and "(unapply)" links next to specific credits (in the Payment History section of the customer view page) can be used to change the application of credits to specific invoice(s) and/or refunds(s).<br />
<br />
==== Refunds ====<br />
<br />
Refunds are money paid to the customer. Refunds increase the customer's balance.<br />
<br />
===== Check and Cash refunds =====<br />
<br />
* Posting refunds<br />
* Applying and unapplying refunds.<br />
<br />
===== Credit card and electronic check (ACH) refunds =====<br />
<br />
* To refund a specific credit card or electronic check (ACH) payment back to the customer, use the "(refund)" link next to that specific payment (in the Payment History section of the customer view page). This will process a refund for the amount of the payment with the payment gateway.<br />
<br />
= Ticketing =<br />
<br />
Link to RT documentation<br />
<br />
== New ticket ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_8.html<br />
<br />
== Ticketing Main ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_9.html<br />
<br />
== Ticket View ==<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_10.html<br />
<br />
= Searching and Reporting =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_14.html<br />
<br />
== Customers ==<br />
<br />
* To search for a customer, enter the customer number, name, company name or contact phone number into the "Search customers" box at the top of each page. Name and company are "fuzzy" searches that will attempt to find a close match if no exact match is found.<br />
* Other customer browsing and reporting is available from Reports -> Customers<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search customers" box at the top of each page, or go to Reports -> Customers -> Advanced customer reports<br />
<br />
* To search for a customer by invoice number or service information (such as username, email address, domain or service phone number), use the invoice or service search, then click on the customer or "View this customer" link.<br />
<br />
== Invoices ==<br />
<br />
* To search for an invoice, enter the invoice number into the "Search customers" box at the top of each page.<br />
* Other invoice browsing and reporting is available from Reports -> Invoices<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search invoice" box at the top of each page, or go to Reports -> Invoices -> Advanced invoice reports<br />
<br />
== Packages ==<br />
<br />
* Package browsing and reporting is available from Reports -> Packages<br />
* For advanced reporting with specific criteria, go to Reports -> Packages -> Advanced package reports<br />
<br />
=== FCC Form 477 ===<br />
<br />
==== Prerequisites ====<br />
<br />
* visit Configuration->Settings and set cust_main-require_censustract to Yes<br />
* visit Configuration->Packages->Package report classes and add classes to match the FCCs reporting requirements<br />
* edit your package definitions (Configuration->Packages->Package definitions) to include some report classes<br />
<br />
==== Usage ====<br />
<br />
* visit Reports->Customers->Advanced customer reports to find customers lacking census tract information<br />
* edit customers who lack census information - you should either see a popup asking for census information or it will be automatically filled when you save the customer<br />
* visit Reports->Packages->Advanced package reports to generate reports which may filter by ALL selected "report classes" (logically ANDed)<br />
* visit Reports->Packages->FCC Form 477 packages to generate reports collated by census tract<br />
<br />
==== Additional notes ====<br />
<br />
Once logged into the fcc system, one can offer it one or more files for upload via its html forms. For 'small' systems (fewer than 5000 broadband subscriptions) we support a single file upload. The size restriction is an FCC restriction on the number of lines in the XML file.<br />
<br />
To prepare the report for upload, one must first tag package definitions with appropriate report classes. 'Appropriate' depends on context. For example, if a reporting entity must submit FCC Part IIA then the reporting entity must designate which packages contain 'unswitched UNE loops' and must tag the definitions with a report option which means this. If Part IIA is to be submitted, then each package definition must have the 'voice grade equivalency' for each package (defalt is 0). The global config cust_pkg-show_fcc_voice_grade_equivalent must be enabled to edit this.<br />
<br />
Once the packages are tagged, useful reports may be generated. By visiting Reports->Packages->FCC Form 477 you may choose which 'parts' of the FCC form to generate (since not all parts are meaningful to all companies). In Part IA all download speeds and all upload speeds must be set meaningfully and at least one technology must be set. Part IB is not presently supported. Parts IIA and IIB depend on the ds0 equivalency number. They make use of the report options to calculate the percentage of the whole number of ds0s. All of parts I and II rely on the existance of a company name in the customer record for determining if the package is residential or not. Part III is not supported at this time. Part IV offers free form comments. Parts V and VI depend on parts II and I respectively. Only selection of their generation may be selected (and is ignored if the antecedents are missing).<br />
<br />
After pressing the submit button, the top 'XML file' link represents a file suitable for uploading to the FCC as an XML file as long as fewer than 5000 broadband connections are being reported. Parts V and VI may also be downloaded as CSV files from links adjacent to the section. This (particularly VI) should be useful for larger entities who must perform the upload in parts.<br />
<br />
== Services ==<br />
<br />
* To search for a service such as username, email address, IP address, MAC address, domain or service phone number, enter the search data into the "Search servcies" box at the top of each page.<br />
* Other service browsing and reporting is available from Reports -> Services<br />
<br />
=== Accounts ===<br />
=== Domains ===<br />
=== Mail Forwards ===<br />
=== Virtual hosting ===<br />
=== Broadband ===<br />
=== Phone numbers ===<br />
=== External ===<br />
<br />
== Usage ==<br />
<br />
== Tickets ==<br />
<br />
* To search for a ticket, enter the ticket number, subject, or email address into the "Search tickets" box at the top of each page.<br />
* A fulltext ticket search can also be performed by entering "fulltext:searchstring" where searchstring is the string to search for.<br />
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search tickets" box at the top of each page.<br />
<br />
<br />
== Financial Reports ==<br />
<br />
=== Sales, Credits and Receipts ===<br />
<br />
=== Sales Report ===<br />
<br />
=== Credit Report ===<br />
<br />
=== Payment Report ===<br />
<br />
=== Payment Batch Report ===<br />
<br />
=== A/R Aging ===<br />
<br />
Go to Reports -> Financial -> A/R aging to pull up an aging report<br />
<br />
* Select "All customers" to pull up a report including all customers.<br />
* Select "Customers with a balance" (the default) to pull up a report only including customers with a balance. Optionally enter a number of days to pull up a report only including customers with balances over the specified number of days old.<br />
<br />
=== Prepaid income ===<br />
<br />
=== Sales tax liability ===<br />
<br />
Go to Reports -> Financial -> Sales tax liability to pull up a report of total sales and taxes, for example, to pull up numbers to add to Quickbooks or another accounting package.<br />
<br />
* Enter start and end dates to restrict the search to a specific time period.<br />
* Check "Show tax classes" to break down sales and taxes by tax class.<br />
* Check "Show package classes" to break down sales and taxes by package class.<br />
<br />
* In the resulting sales tax report, all clickable links take you to a detail report of the specific items making up the number reported.<br />
<br />
= Tools =<br />
<br />
== Quick Payment Entry ==<br />
<br />
= Auditing Legacy Data =<br />
<br />
http://www.freeside.biz/~ivan/freeside-slides/html/slide_15.html</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6156Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T20:12:29Z<p>Levinse: </p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
Export Name - note that it's used in several user-visible places, such as on qualifications<br />
<br />
Export Host - not used, may be set to anything<br />
<br />
Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6155Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T19:50:50Z<p>Levinse: </p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
<br />
Export Host - not used, may be set to anything<br />
<br />
Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl syncs data from Ikano to the svc_dsl. It runs synchronously/non-concurrently, meaning that it works with one svc_dsl at a time. It must be run via a cron job as often as needed to update all monitored DSL orders, but not such that it starts again before all monitored orders were updated. Thus, the frequency will vary depending on each Freeside installation's number of monitored Ikano orders.<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6154Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T19:48:21Z<p>Levinse: </p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
= Global Configuration =<br />
<br />
Enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
<br />
Export Host - not used, may be set to anything<br />
<br />
Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl must be run via a cron job as often as needed to update all monitored DSL orders<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6153Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T19:47:48Z<p>Levinse: /* Packages */</p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
Global configuration: enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
<br />
Export Host - not used, may be set to anything<br />
<br />
Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl must be run via a cron job as often as needed to update all monitored DSL orders<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano for the corresponding package</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6152Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T19:47:15Z<p>Levinse: </p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
Global configuration: enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
<br />
Export Host - not used, may be set to anything<br />
<br />
Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl must be run via a cron job as often as needed to update all monitored DSL orders<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6151Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T19:46:39Z<p>Levinse: </p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
Global configuration: enable qual-alt-address-format<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
<br />
Export Host - not used, may be set to anything<br />
<br />
Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl must be run via a cron job as often as needed to update all monitored DSL orders<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:2.3:Documentation:Administration:svc_dsl:ikano&diff=6150Freeside:2.3:Documentation:Administration:svc dsl:ikano2010-12-13T19:46:23Z<p>Levinse: </p>
<hr />
<div>= Introduction =<br />
<br />
Ikano DSL provisioning and qualifications requires installation of Net::Ikano and then configuration of the exports, services, DSL pull cron job, packages, and config option for qualifications. <br />
<br />
<br />
Global configuration: set qual-alt-address-format to Yes.<br />
<br />
<br />
= Exports =<br />
<br />
Create an ikano export - most fields are obvious on the export add page, except:<br />
<br />
<br />
Export Host - not used, may be set to anything<br />
<br />
Check Networks - comma separated list of telco networks to check (refer to Ikano API doc or web interface if you're not sure what these are). Only set this to the telcos you use. Ikano qualifications are slow. Adding extra telco networks to check will result in a performance impact when making each qualification. This field can look similar to "ATT,ATTTAS,VERTAS,VER".<br />
<br />
Debug Mode - generates A LOT of output in the logs - turn it off for production<br />
<br />
<br />
= Services =<br />
<br />
Create a new svc_dsl and attach your export. No other DSL-pulling/qualifying exports may be attached to this service.<br />
<br />
Configure the service similarly to the following screenshot:<br />
<br />
<br />
= DSL pull cron job =<br />
<br />
freeside-pull-dsl must be run via a cron job as often as needed to update all monitored DSL orders<br />
<br />
<br />
= Packages =<br />
<br />
Create one-to-one mappings between each Ikano package you wish to use and each Freeside package as follows:<br />
1. In Ikano's web interface, under Subscription Manager, find each package you wish to use and set its "Unique ID" field to a string which is unique across all packages you'll be setting up<br />
2. Either edit or add a new Freeside package with at least one Ikano svc_dsl service (see above), and set "Vendor Package Id" beside the Ikano export (see above) to the "Unique ID" from Ikano</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:1.9:Documentation:Administration&diff=6149Freeside:1.9:Documentation:Administration2010-12-13T19:31:29Z<p>Levinse: /* svc_dsl */</p>
<hr />
<div>= Exports (provisioning) =<br />
<br />
'''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.<br />
<br />
Exports can be added and edited under<br />
: Configuration -> Provisioning, services and packages -> View/edit exports<br />
<br />
Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.<br />
<br />
Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].<br />
<br />
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.<br />
<br />
Exports are activated by associating them with one or more '''service definitions'''.<br />
<br />
Following is a list of which exports can be associated with each type of service.<br />
<br />
==svc_acct==<br />
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service<br />
* acct_sql.pm: Real-time export of accounts to SQL databases .<br />
* artera_turbo.pm: <br />
* bsdshell.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* communigate_pro_singledomain.pm: <br />
* cpanel.pm: Real-time export to Cpanel control panel.<br />
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol<br />
* cyrus.pm: Real-time export to Cyrus IMAP server<br />
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service<br />
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI<br />
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]: Real-time export to LDAP<br />
* passwdfile.pm:<br />
* radiator.pm: Real-time export to RADIATOR<br />
* shellcommands.pm: <br />
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)<br />
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms<br />
* sysvshell.pm: <br />
* textradius.pm: <br />
* vpopmail.pm: Real-time export to vpopmail text files<br />
<br />
==svc_domain==<br />
* bind.pm: Batch export to BIND named<br />
* bind_slave.pm: Batch export to slave BIND named<br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).<br />
* domain_sql.pm: Real time export of domains to SQL databases .<br />
* http.pm: Send an HTTP or HTTPS GET or POST request<br />
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_forward==<br />
* artera_turbo.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* forward_shellcommands.pm: Run remote commands via SSH, for forwards<br />
* postfix.pm: Postfix text files<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_www==<br />
* apache.pm: Export an Apache httpd.conf file snippet.<br />
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service<br />
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)<br />
<br />
==svc_broadband==<br />
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.<br />
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface<br />
* router.pm: Send a command to a router.<br />
* snmp.pm: Sends SNMP SETs to an SNMP agent.<br />
* trango.pm: Sends SNMP SETs to a Trango AP.<br />
<br />
==svc_phone==<br />
* globalpops_voip.pm:<br />
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.<br />
* indosoft.pm:<br />
* internal_diddb.pm:<br />
* netsapiens.pm:<br />
* phone_shellcommands.pm:<br />
* phone_sqlradius.pm:<br />
* thirdlane.pm:<br />
* vitelity.pm:<br />
<br />
==svc_external==<br />
* artera_turbo.pm:<br />
<br />
==svc_dsl==<br />
* ikano.pm: see [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Services =<br />
<br />
== Accounts (svc_acct) ==<br />
<br />
* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]<br />
<br />
== Domains (svc_domain) ==<br />
<br />
== Forwards (svc_forward) ==<br />
<br />
== Hosting (svc_www) ==<br />
<br />
== Broadband (svc_broadband) ==<br />
<br />
== Phone (svc_phone) ==<br />
<br />
== External (svc_external) ==<br />
<br />
== DSL (svc_dsl) ==<br />
<br />
* [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Packages =<br />
<br />
{{Freeside:1.9:Documentation:Administration:pkg_category}}<br />
<br />
== Price Plans ==<br />
<br />
=== Common price plans ===<br />
<br />
* flat<br />
* subscription<br />
* prorate<br />
* sqlradacct_hour<br />
* voip_cdr<br />
* prepaid<br />
<br />
=== Wholesale price plans ===<br />
<br />
* bulk<br />
<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |<br />
cdr_termination ]]<br />
<br />
=== Other price plans ===<br />
<br />
* flat_delayed<br />
* flat_introrate<br />
* prorate_delayed<br />
<br />
* base_delayed<br />
* base_rate<br />
<br />
* sql_external<br />
* sql_generic<br />
<br />
=== Price plans of questionable functionality ===<br />
<br />
* flat_comission_cust<br />
* flat_comission_pkg<br />
* flat_comission<br />
<br />
* voip_sqlradacct<br />
<br />
* sesmon_hour<br />
* sesmon_minute<br />
<br />
== Misc ==<br />
<br />
* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]<br />
<br />
= Resellers =<br />
<br />
= Employees =<br />
<br />
== Employees ==<br />
<br />
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.<br />
<br />
* To add a new employee, click on "Add an employee"<br />
* Or to edit an existing group, click on the employee number or name in the list of employees.<br />
* 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.<br />
* Check the "Disable employee" box to disable this employee.<br />
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.<br />
<br />
== Employee groups and access control == <br />
<br />
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.<br />
<br />
* To add a new group, click on "Add an employee group"<br />
* Or to edit an existing group, click on the group number or name in the list of groups.<br />
* Enter or edit the group name.<br />
* 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.<br />
* 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.<br />
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.<br />
<br />
= Billing =<br />
<br />
== Billing events ==<br />
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.<br />
<br />
At a high level, follow the following steps to create billing events:<br />
* Add a new Billing Event (Configuration > Billing > Billing events)<br />
* Name the event<br />
* Choose the type of event:<br />
** Package - Packages and associated dates (Including Commissions)<br />
** Invoice - Invoice status and dates<br />
** Customer - Customer Balances and Information<br />
** Batch Payment - Batch payment results<br />
** Statement - Send statement <br />
* Choose whether to apply to one or all agents<br />
* Choose the frequency for the system to check and see if the event should run.<br />
* Choose appropriate filters. <br />
* Choose appropriate actions.<br />
<br />
The form is dynamic so changing the type of event will change the available filters and actions.<br />
<br />
== Daily and Monthly Scripts ==<br />
* The freeside-daily script should be run daily to bill customers and run invoice collection events.<br />
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre><br />
** 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><br />
* If any monthly events are enabled, the freeside-monthly script should be run monthly.<br />
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)<br />
<br />
== Invoices ==<br />
<br />
=== Typeset (LaTeX) invoice templates ===<br />
<br />
==== Prerequisites ====<br />
<br />
* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.<br />
* Install [http://www.ghostscript.com/ Ghostscript] (gs)<br />
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]<br />
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed<br />
<br />
==== Logo setup ====<br />
<br />
The <em title="Encapsulated Postscript">EPS</em> logo is for PDF and printed invoices.<br />
<br />
* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format. <br />
** Your graphic artist can create vector image from a bitmap (tracing etc).<br />
** 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)<br />
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code><br />
* Upload the resized logo as the <code>logo.eps</code> configuration option.<br />
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code><br />
<br />
The <em title="Portable Network Graphic">PNG</em> logo is for emailed and online invoices.<br />
<br />
Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.<br />
<br />
{{Freeside:1.9:Documentation:Administration:invoice_layout}}<br />
<br />
=== HTML invoice templates ===<br />
<br />
* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option. <br />
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}<br />
<br />
=== Plaintext invoice templates ===<br />
<br />
* See the Text::Template documentation for details on the substitution language.<br />
* 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).<br />
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]<br />
<br />
=== Misc ===<br />
<br />
==== Manually setting next invoice number sequence ====<br />
<br />
* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre><br />
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre><br />
<br />
== Payment Receipts ==<br />
<br />
The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.<br />
<br />
== Credit cards and Electronic checks ==<br />
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]<br />
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]<br />
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.<br />
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.<br />
<br />
= Misc =<br />
<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]<br />
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]<br />
<!-- Superseded by Commissions below... * Setting up [[Freeside:1.9:Documentation:Administration:Referral credits|Referral credits]] --><br />
* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]<br />
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]<br />
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]<br />
<br />
{{ContextSensitiveHelp}}</div>Levinsehttp://www.freeside.biz/mediawiki/index.php?title=Freeside:1.9:Documentation:Administration&diff=6148Freeside:1.9:Documentation:Administration2010-12-13T19:31:16Z<p>Levinse: /* DSL (svc_dsl) */</p>
<hr />
<div>= Exports (provisioning) =<br />
<br />
'''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.<br />
<br />
Exports can be added and edited under<br />
: Configuration -> Provisioning, services and packages -> View/edit exports<br />
<br />
Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.<br />
<br />
Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].<br />
<br />
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.<br />
<br />
Exports are activated by associating them with one or more '''service definitions'''.<br />
<br />
Following is a list of which exports can be associated with each type of service.<br />
<br />
==svc_acct==<br />
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service<br />
* acct_sql.pm: Real-time export of accounts to SQL databases .<br />
* artera_turbo.pm: <br />
* bsdshell.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* communigate_pro_singledomain.pm: <br />
* cpanel.pm: Real-time export to Cpanel control panel.<br />
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol<br />
* cyrus.pm: Real-time export to Cyrus IMAP server<br />
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service<br />
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI<br />
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]: Real-time export to LDAP<br />
* passwdfile.pm:<br />
* radiator.pm: Real-time export to RADIATOR<br />
* shellcommands.pm: <br />
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)<br />
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms<br />
* sysvshell.pm: <br />
* textradius.pm: <br />
* vpopmail.pm: Real-time export to vpopmail text files<br />
<br />
==svc_domain==<br />
* bind.pm: Batch export to BIND named<br />
* bind_slave.pm: Batch export to slave BIND named<br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).<br />
* domain_sql.pm: Real time export of domains to SQL databases .<br />
* http.pm: Send an HTTP or HTTPS GET or POST request<br />
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_forward==<br />
* artera_turbo.pm: <br />
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server<br />
* forward_shellcommands.pm: Run remote commands via SSH, for forwards<br />
* postfix.pm: Postfix text files<br />
* sqlmail.pm: Real-time export to SQL-backed mail server<br />
<br />
==svc_www==<br />
* apache.pm: Export an Apache httpd.conf file snippet.<br />
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service<br />
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)<br />
<br />
==svc_broadband==<br />
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.<br />
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface<br />
* router.pm: Send a command to a router.<br />
* snmp.pm: Sends SNMP SETs to an SNMP agent.<br />
* trango.pm: Sends SNMP SETs to a Trango AP.<br />
<br />
==svc_phone==<br />
* globalpops_voip.pm:<br />
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.<br />
* indosoft.pm:<br />
* internal_diddb.pm:<br />
* netsapiens.pm:<br />
* phone_shellcommands.pm:<br />
* phone_sqlradius.pm:<br />
* thirdlane.pm:<br />
* vitelity.pm:<br />
<br />
==svc_external==<br />
* artera_turbo.pm:<br />
<br />
==svc_dsl==<br />
* ikano.pm: see [[Freeside:2.1:Documentation:Administration:svc_dsl:_ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Services =<br />
<br />
== Accounts (svc_acct) ==<br />
<br />
* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]<br />
<br />
== Domains (svc_domain) ==<br />
<br />
== Forwards (svc_forward) ==<br />
<br />
== Hosting (svc_www) ==<br />
<br />
== Broadband (svc_broadband) ==<br />
<br />
== Phone (svc_phone) ==<br />
<br />
== External (svc_external) ==<br />
<br />
== DSL (svc_dsl) ==<br />
<br />
* [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]<br />
<br />
= Packages =<br />
<br />
{{Freeside:1.9:Documentation:Administration:pkg_category}}<br />
<br />
== Price Plans ==<br />
<br />
=== Common price plans ===<br />
<br />
* flat<br />
* subscription<br />
* prorate<br />
* sqlradacct_hour<br />
* voip_cdr<br />
* prepaid<br />
<br />
=== Wholesale price plans ===<br />
<br />
* bulk<br />
<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]<br />
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |<br />
cdr_termination ]]<br />
<br />
=== Other price plans ===<br />
<br />
* flat_delayed<br />
* flat_introrate<br />
* prorate_delayed<br />
<br />
* base_delayed<br />
* base_rate<br />
<br />
* sql_external<br />
* sql_generic<br />
<br />
=== Price plans of questionable functionality ===<br />
<br />
* flat_comission_cust<br />
* flat_comission_pkg<br />
* flat_comission<br />
<br />
* voip_sqlradacct<br />
<br />
* sesmon_hour<br />
* sesmon_minute<br />
<br />
== Misc ==<br />
<br />
* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]<br />
<br />
= Resellers =<br />
<br />
= Employees =<br />
<br />
== Employees ==<br />
<br />
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.<br />
<br />
* To add a new employee, click on "Add an employee"<br />
* Or to edit an existing group, click on the employee number or name in the list of employees.<br />
* 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.<br />
* Check the "Disable employee" box to disable this employee.<br />
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.<br />
<br />
== Employee groups and access control == <br />
<br />
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.<br />
<br />
* To add a new group, click on "Add an employee group"<br />
* Or to edit an existing group, click on the group number or name in the list of groups.<br />
* Enter or edit the group name.<br />
* 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.<br />
* 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.<br />
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.<br />
<br />
= Billing =<br />
<br />
== Billing events ==<br />
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.<br />
<br />
At a high level, follow the following steps to create billing events:<br />
* Add a new Billing Event (Configuration > Billing > Billing events)<br />
* Name the event<br />
* Choose the type of event:<br />
** Package - Packages and associated dates (Including Commissions)<br />
** Invoice - Invoice status and dates<br />
** Customer - Customer Balances and Information<br />
** Batch Payment - Batch payment results<br />
** Statement - Send statement <br />
* Choose whether to apply to one or all agents<br />
* Choose the frequency for the system to check and see if the event should run.<br />
* Choose appropriate filters. <br />
* Choose appropriate actions.<br />
<br />
The form is dynamic so changing the type of event will change the available filters and actions.<br />
<br />
== Daily and Monthly Scripts ==<br />
* The freeside-daily script should be run daily to bill customers and run invoice collection events.<br />
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre><br />
** 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><br />
* If any monthly events are enabled, the freeside-monthly script should be run monthly.<br />
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)<br />
<br />
== Invoices ==<br />
<br />
=== Typeset (LaTeX) invoice templates ===<br />
<br />
==== Prerequisites ====<br />
<br />
* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.<br />
* Install [http://www.ghostscript.com/ Ghostscript] (gs)<br />
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]<br />
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed<br />
<br />
==== Logo setup ====<br />
<br />
The <em title="Encapsulated Postscript">EPS</em> logo is for PDF and printed invoices.<br />
<br />
* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format. <br />
** Your graphic artist can create vector image from a bitmap (tracing etc).<br />
** 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)<br />
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code><br />
* Upload the resized logo as the <code>logo.eps</code> configuration option.<br />
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code><br />
<br />
The <em title="Portable Network Graphic">PNG</em> logo is for emailed and online invoices.<br />
<br />
Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.<br />
<br />
{{Freeside:1.9:Documentation:Administration:invoice_layout}}<br />
<br />
=== HTML invoice templates ===<br />
<br />
* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option. <br />
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}<br />
<br />
=== Plaintext invoice templates ===<br />
<br />
* See the Text::Template documentation for details on the substitution language.<br />
* 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).<br />
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]<br />
<br />
=== Misc ===<br />
<br />
==== Manually setting next invoice number sequence ====<br />
<br />
* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre><br />
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre><br />
<br />
== Payment Receipts ==<br />
<br />
The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.<br />
<br />
== Credit cards and Electronic checks ==<br />
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]<br />
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]<br />
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.<br />
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.<br />
<br />
= Misc =<br />
<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]<br />
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]<br />
<!-- Superseded by Commissions below... * Setting up [[Freeside:1.9:Documentation:Administration:Referral credits|Referral credits]] --><br />
* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]<br />
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].<br />
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]<br />
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]<br />
<br />
{{ContextSensitiveHelp}}</div>Levinse