CoCo Handbook - Stock Module

September 30th, 2007

  • Abstract

    1. The stock module allows you to manage a database of clients, a database of products (shared by the store front) and send different kinds of messages to your customers. It also allows to make invoices, delivery notes, reminders, and receipts in both html as pdf format.
    2. Currently the email features are not implemented, but the framework is present so the overhead is little to actually add those features.
    3. The stock module interfaces with the product database of the Store Module but does not update the stock amounts.
    4. Additional features can be implemented on request.

  • Campaigns

    1. We call promotional actions « campaigns ». Basically you select what customers will receive the mailing, what products will be on that mailing and how the mailing will look. The system will generate pdf documents that contain those mailings. It will put a maximum of 5 clients in one pdf document and will put everything in a zip file if more then one pdf is generated.

  • Invoices & Delivery Notes

    1. If a customer replied to the mailing and placed an order, you can prepare an invoice. You can select all the products of the mailing or manually select those products and quantities that are required. A delivery note is also generated and added as a new page in the pdf document.

  • Reminders

    1. If your customer did not reply within a suitable time, then you can generate a reminder very easily by clicking the button. The system will generate a document that will remind the customer that an invoice was sent at specified date, and for proper form, will include a duplicate of that invoice.

  • Receipts

    1. After payment has been received, you can finalise the transaction and the system will generate a receipt. This receipt will also attach a copy of the invoice, with a big stamp PAID on it.

    Getting started

    • Configuration of the Stock Module

      1. To configure the stock module, log on as admin, then click the menu, and select Stock -> Settings.
      2. The configuration screen will show you a long list of options and many ’save’ buttons. Those buttons are there for your convenience so that you don’t need to scroll down each time if you only want to change a few things.
      3. You should note, however, that all ’save’ buttons save the entire page, and will also force validation of the entire page.

    • Campaign Settings

      1. These settings allow you to tweak the generated pdf document. Note that the page format is A4 and cannot be changed.

    PDF Prolog

    This text will appear on the first page of the mailing. You may use the following codes:

    • %name% Will be changed in the customer’s name
    • %firstname% For the customer’s first name

    PDF Margin Top

    Set the top margin of the mailing. The unit is points (pts)

    PDF Margin Bottom

    Set the bottom margin of the mailing (points)
    WARNING: if you use to big values for top, and bottom margin, then the system will get stuck in an endless loop while trying to make sure that everything is on the pages (header, contents, footer).

    PDF Print Header

    If you are using stationary, then you are better of replying ‘no’ here so that the system will not print out the store address.

    PDF Print Customer Address

    You may choose to not print the customer’s address on each page because you are using a template that already prints those details.

    Download the application     and install via www.yoururl.co.uk/installer.php. The password for the installer should be brown all lower caps but is not working at the moment. The application was built to work with php 4 but I need it to work with php 5.2+ and obviously I need the installer to work. I also need for you to prepare a list of changes you would suggest.

    The project has these specific goals:
    1. CMS
    2. With online shop
    3. With stock control
    4. With invoice management (for customers and suppliers)
    5. With reporting on amounts paid and amounts owing and weekly, monthly, annually totals (spent compared to income)
    6. With sales and contact management.

    Your role should be to:
    1. Make the current version work with php 5.2
    2. Suggest style changes to make the application more accessible
    3. Cost up and make proposals for the above.

    Once completed I intend to open source the project and put up on Sourceforge and build its own website. Links to you will be made available as chief developer and could result in further adoption work.

    I need price and timescale for no. 1 initially and then 2 and 3.

    Many thanks.