httemplate/docs/admin.html

   1 <head>
   2   <title>Administration</title>
   3 </head>
   4 <body>
   5   <h1>Administration</h1>
   6 </body>
   7 <ul>
   8   <li>Open up the root of the Freeside document tree in your web
   9   browser.  For example, if you created the Freeside document tree in
  10   /home/httpd/html/freeside, and your web browser's DocumentRoot is
  11   /home/httpd/html, open https://your_host/freeside/. Replace
  12   "your_host" with the name or network address of your web server.
  13   <li>Select <u>Configuration</u> from the main menu and update your configuration values.
  14   <li>Next you must create a service definition.  An example of a service
  15   definition would be a dial-up account or a domain.  First, it is
  16   necessary to create a domain definition.  Click on <u>View/Edit service
  17   definitions</u> and <u>Add a new service definition</u> with <i>Table</i>
  18   <b>svc_domain</b> (and no modifiers).
  19
  20   <li>Now that you have created your first service, you must create a package
  21   including this service which you can sell to customers.  Zero, one, or many
  22   services are bundled into a package.  Click on <u>View/Edit package
  23   definitions</u> and <u>Add a new package definition</u> which includes
  24   quantity <b>1</b> of the svc_domain service you created above.
  25
  26   <li>After you create your first package, then you must define who is
  27   able to sell that package by creating an agent type.  An example of
  28   an agent type would be an internal sales representitive which sells
  29   regular and promotional packages, as opposed to an external sales
  30   representitive which would only sell regular packages of services.  Click on
  31   <u>View/Edit agent types</u> and <u>Add a new agent type</u>.  Allow this
  32   agent type to sell the package you created above.
  33
  34   <li>After creating a new agent type, you must create an agent.  Click on
  35   <u>View/Edit agents</u> and <u>Add a new agent</u>.
  36
  37   <li>Set up at least one Advertising source.  Advertising sources will help
  38   you keep track of how effective your advertising is, tracking where customers
  39   heard of your service offerings.  You must create at least one advertising
  40   source.  If you do not wish to use the referral functionality, simply create
  41   a single advertising source only.  Click on <u>View/Edit advertising
  42   sources</u> and <u>Add a new advertising source</u>.
  43
  44   <li>Click on <u>New Customer</u> and create a new customer for your system
  45   accounts with billing type <b>Complimentary</b>.
  46
  47   <li>From the Customer View screen of the newly created customer, order the
  48   package you defined above.
  49
  50   <li>From the Package View screen of the newly created package, choose
  51   <u>(Provision)</u> to add the customer's service for this new package.
  52
  53   <li>Add your own domain.
  54
  55   <li>Go back to <u>View/Edit service definitions</u> on the main menu, and
  56   <u>Add a new service definition</u> with <i>Table</i> <b>svc_acct</b>.
  57   Select your domain in the <b>domsvc</b> Modifier.  Set <b>Fixed</b> to define
  58   a service locked-in to this domain, or <b>Default</b> to define a service
  59   which may select from among this domain and the customer's domains.
  60
  61   <li><table><tr>
  62     <td> Create at least POP (Point of Presence) by selecting
  63         <u>View/Edit POPs</u> from the main menu.</td>
  64     <th align="left"> OR </th>
  65     <td>If you are not doing dialup, set slipip to fixed and blank for all your
  66         Service Definitions which have Table <b>svc_acct</b>.</td>
  67   </tr></table>
  68
  69   <li>If you are using Freeside to keep track of sales taxes, define tax
  70   information for your locales by clicking on the <u>View/Edit locales and tax
  71   rates</b> on the main menu.
  72
  73   <li>If you would like Freeside to notify your customers when their credit
  74   cards and other billing arrangements are about to expire, arrange for
  75   <b>freeside-expiration-alerter</b> to be run daily by cron or similar
  76   facility.  The message it sends can be configured from the
  77   <u>Configuration</u> choice of the main menu as <u>alerter_template</u>.
  78
  79 </ul>
  80 </body>
  81 </html>