Css Programmers Guide

8/6/2019 Css Programmers Guide

1/12

Customer Self Service Programmers GuideNovember 2008

Inventory & Distr ibut ion Management Software


2/12

2

Copyright 1998-2009 Alterity, Inc. All rights reserved.

Customer Self Service Programmers Guide: Table of contents

Displayinfo.

Overview

Rev: 11/24/2008

Table of Contents

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Display information customers need . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5


3/12

Customer Self Service Programmers Guide: Overview

Displayinfo.

Overview

3

Redesigning the Customer Self Service module overview

Standard template or your own design

The ACCTivate! Customer Self Service (CSS) module

is designed to provide your customers with important

and timely information about their accounts, orders,

invoices and payments.

Through the download and installation of the module

you are provided with web pages to present this

information to your customers on your website.

These web pages have a standard design. However,

your web designer or web developer can incorporate

your own style into the module so it can look and feel

similar to your existing website.

Requirement guidelines

There are practically no design limitations, but there are

a couple of requirements that you must follow in order

to display information correctly:

1. You must use the Web Class Manager (WC) tags

(i.e. )

correctly by nesting the corresponding database

information within the tags (the following pages will

list each WC tag and the database information that

corresponds to each).

These tags allow information from your ACCTivate!database to display correctly on the web pages

based on the information in your ACCTivate!

database and the customer who is logged into the

module. They will be provided with a live look at

their account status and details.

2. To stylize any of the information within the WC tags nest the WC tags and the database information they

dene between the tags used for formatting and stylizing.

For example, if you want to display the name of your company in a different font, you can code it as follows

with font attributes specic to the appearance you want:

Name

3. Only the and tags can be used on various pages through outthe module to display information. Other tags can only be used on the pages they are designated to in the

template.

For example, tags can only be used on the order details page; when used on

another page the requested information will not be displayed or the user will receive an error message.

The menu page provided with the Customer Self

Service module.

Modify the module to be consistent with the design

of your own website. You can stylize or change any

aspect of the provided pages such as the background

color, images, buttons, font or even the layout.


4/12

Customer Self Service Programmers Guide: Overview

Displayinfo.

Overview

4

4. For information that has multiple results (i.e. orders) use the

tags, so that all orders for the logged in

customer are displayed.

To get the results on the right, the following code is used in a table:

OrderNumber

OrderDate

OrderStatus

Note: Information surrounded by tags must

remain as organized in the template with all the information for

the specic record in individual rows.

But information not nested within tags can be

organized as desired.

The tags are used throughout the template to list the following information:

> Multiple orders and details about each

> Multiple customer payments and details about each

> Multiple invoices and details about each

5. Do not change the lenames or extensions of the provided les. Changing this will cause the module to not

function properly.

6. You can add additional static pages, but only the provided pages can be dynamic and work with the database.

7. After the redesign is complete, either point a link from your existing website to the new Customer Self-Service

module or give your customers a direct link to the new address.

* The CSS module must be run from the same server that your ACCTivate! data resides on.

Design and style changes

You can modify any of the page elements or add any page elements.

> Add and/or change images

> Stylize the fonts (i.e. font face, font size, font color, etc.)

> Change the colors

> Change the layout

> Add a background color or image

> Use different buttons> There are virtually no limits when it comes to the design of the module design the page how you want

and then add in the elements of the CSS module.

When modifying the provided standard template, use tags and style sheets (you can add to the provided external

style sheet or attach your own, add inline styles or embed styles) as appropriate.

If you are reorganizing the structure of the pages simply cut the WC tags and the nested information from the

provided code and paste them where needed.

*Remember: information dened by tags must remain organized as it is in the template.

*Refer to: the lists that follow for the WC tags you can use and the nested information that corresponds to each.

In the orders page of the template the

order details database names (refer to

following pages for a complete list) are

nested within the tags

to display all orders for the logged-in

customer.


5/12

5Customer Self Service Programmers Guide: Display information customers need

Overview

Displayinfo.

Display information customers need

What information do you want your customers to view about their accounts? You are not limited to the information

displayed in the template pages, other pieces can be added.

However, you must use the following WC tags correctly with the corresponding database eld names to

accurately display the information to your customers.

To display any of the following information, nest the database eld names as they are in the list, between the

corresponding WC tags. This will pull the corresponding information from your database and display it on the

web page.

Display company information

The company information to the right can be displayed on any page

and in any manner as long as each is nested as is within

and .

For example, to display the company name the following code is usedin the template:

Name

In the login page of the template all the company information listed in the box above is requested and some of it is

requested in other pages to display it in the header and footer.

Companyinformation

The following information can be

dened within WC@COMPANY tags:

> Name

>Address1> Address2

> City

> State

> Zip

> Phone

> Fax

> EMail


6/12


Overview

Displayinfo.

Display customer information

The information to the right specic to the logged-in

customer can be displayed on any page and in any

manner as long as each is nested as is within

and .

For example, to display the customer name for the

logged-in customer the following code is used in

the template:

Name

Customerinformation

The following information can be dened within

WC@CUSTOMER tags:

> CustID* > ShipToCity

> CompanyName > ShipToState

> Name* > ShipToZip

> Salutation > ShipToCountry

> FirstName > PO

> MiddleName > Taxable

> LastName > TaxPCt

> Sufx > FrtTaxPct

> Address* > TaxPercentText

> Address2* > SchedSubTotal

> Address3 > SchedDiscountAmount

> Address4 > SchedSalesTax

> City* > SchedShippingCharge

> State* > SchedTotalAmount

> Zip* > SubTotal

> Country* > DiscountType

> Phone* > InvoiceDiscountPct

> PhoneDesc > DiscountAmount

> Fax > SalesTax

> FaxDesc > TotalAmount

> Email > Reference

> EmailDesc > TermsCode

> AltPhone > TermsDescription

> AltPhoneDesc > SchedTerms

> Mobile > DiscountAvailable

> MobileDesc > NextInvoiceNumber

> Pager > ContractID

> PagerDesc > JobNumber

> ARAcntId > DeleiveredTo

> TermsCode* > DeliveredBy

> CreditLimit > DeliveryDate

> CreditHold* > DeliveryMiles

> BalDue* > NumberOfPackages

> Status > PackageWeight

> Comment > SalesCategory

> ShipToAddress1 > POPrice

> ShipToAddress2 > OrderNumber

> ShipToAddress3 > VendorPO

> ShipToAddress3 > VendorPOLine

* Database names used in the template. Other names in the

lists can be used as needed.

The customer account page of the template displays

the information in the table (above) for the logged-in

customer through the use of the WC@CUSTOMER code.


7/12


Overview

Displayinfo.

Display information about customer orders

The sales order information to the right specic to the

logged-in customer can be displayed on the orders and

order details page, as long as they are all nested as is

within

and .

To list all orders for the customer the

and

tags are used (refer to pg. 2 (#3) for

an example).

Display details about customer orders

WC@ORDERDETAILS tags

The sales order details to the right specic to the logged-

in customer and the sales order can be displayed on the

order details page

(when an order is selected on the orders page),

as long as they are all nested as is within and .

For example, to display product information for multiple

products of the order the and

tags are used. In the template the

following code displays the product ID for each productlisted:

ProductID

Orderinformation

The following information can be dened

within WC@ORDERS tags:

> OrderNumber* > SoldToAddress1

> Type > SoldToAddress2

> OrderDate* > SoldToAddress3

> OrderStatus* > SoldToAddress4

> StatusDate > SoldToCity

> StatusChangedBy > SoldToState

> Completed > SoldToZip

> ShipVia* > SoldToCountry

> FOB > ShipToOverride

> RequestedShipDate > ShipToAttn

> ShipmentPromisedDate > ShipToDescription

> DontShipBefore > BillAddress*

> DontShipAfter > ShipAddress*

> QuotedDaysToShip > PO*

> SoldToOverride > Discount*

> SoldToName > Sales Tax*

> TotalAmount*

Orderdetails

The following information can be denedwithin WC@ORDERDETAILS tags:

> LineNumber > PriceUnitFactor

> ProductID* > PriceUnitFactorType

> Warehouse > Freight

> Description* > Amount*

> QtyOrdered* > Taxable

> QtyShipped > ProductClass

> QtyPicked > Length

> QtyScheduled > Weight

> QtyInvoiced > VariableLength

> QtyBackordered > VariableWeight

> Completed > Specication

> Unit > Note

> PriceCode > InventoryControlType

> Price* > QtyLotSerial

> PriceUnit

The orders page of the template displays

the information in the table for the

logged-in customer.

The orders details page of the template displays the

information in the table for the logged-in customer.


8/12


Overview

Displayinfo.

WC@INVOICES tags

The tags are used on the order details page to list

the invoice numbers of the invoices for the specic order.

Note: Do not confuse these tags with used on the

invoice details page.

For example, to list the invoice numbers the following code is used in

the template without nested information:

Display customer payment information

The payment information to the right specic to the logged-in

customer can be displayed on the customer payment page, as

long as they are all nested as is within and

.

For example, to display payment information for multiple payments

by the customer the and

tags are used. In the template the following code displays the

reference number (i.e. check number, credit card number) for each

payment listed:

CheckNo

Paymentinformation


dened within WC@PAYMENTS

tags:

> CheckNo

>TxnDate

> CheckAmt

> MOP (method of payment)

The payment information used in the

template. Other information can be

displayed according to your database

information.

The payments page of the template displays the information in the

table for the logged-in customer.


9/12


Overview

Displayinfo.

Display payment details

The payment details information to the right can be displayed on the

payment details page (when a payment is selected on the customer

payments page), as long as they are all nested as is within and .

For example, to display the payment details for all payments

made corresponding to the specic payment reference the

and tags are used.

In the template the following code displays the invoice number for

each payment listed:

InvNo

The payment details information to the right can be displayed in any

manner on the payment details page (when a payment is selected on

the customer payments page), as long as each is nested as is within

and .

For example, to display the payment method, payment reference

number and the date the payment was received the following code is

used in the template:

Type:

Number

Date Received: Date

Paymentdetails


dened within

WC@PAYMENTDETAILS tags:

> InvNo>AmtPaid

The payment detail information used in

the template. Other information can be


information.

Paymentdetails

The following information can bedened within WC@CHECK tags:

> Type

>Number

> Date

>CheckAmt

The header of the payment details page in the template

displays the above information by using the

tags.

Type Number Date


10/12


Overview

Displayinfo.

Display customer invoice information

The invoice information to the right specic to the logged-

in customer can be displayed on the customer invoices

page, as long as they are all nested as is within

and .

For example, to display invoice information for multiple

invoices for the specic customer the

and tags

are used. In the template the following code displays the

invoice number for each invoice listed:

InvNo

Display invoice details

The invoice details to the right can be displayed on the

invoice details page (when a invoice is selected from the

customer invoices page), as long as they are all nested as

is within and

.

For example, to display the invoice details specically

about products on the invoice the

and tags

are used. In the template the following code displays the

quantity of each product listed:

Quantity

Invoiceinformation


within WC@GETINVOICES tags:

> InvNo > SOOrderNo

> InvDate > CustPO

> Terms > InvTotal

> DueDate > InvBal

The invoice information used in the template. Other

information can be displayed according to your

database information.

Invoicedetails


within WC@INVOICEDETAILS tags:

> ProductID

>Quantity

> Description

>Price

>Amount

The invoice details specic to products on the

invoice that are used in the template. Other

information can be displayed according to your

database information.

Note: On the invoice details page of the template

tags are used, but tags

are also used to display other invoice details (refer to pg. 9).


11/12


Overview

Displayinfo.

Display more invoice information

WC@INVOICE tags

The invoice information to the right specic to the logged-in customer

can be displayed in any manner on the invoice details page, as long

as each is nested as is within and.

Note: Do not confuse these tags with used on the

orders details page.

For example, in the template on the invoice details page the

tag is used to display more invoice details.

The following code displays the invoice date of the specic invoice:

InvoiceDate

WC@PACKAGES tags

The invoice information to the right about shipment details can be

displayed in any manner on the invoice details page, as long as each

is nested as is within and .

These tags and the tags list information for

shipments with tracking numbers that have been recorded in the

system.

To also display information for shipments without tracking numbersthat have been recorded in the system use

tags (explained on pg. 10).

The following code displays the tracking number for each shipment

listed:

TrackingNumber

Invoiceinformation


dened within WC@INVOICE tags:

> InvoiceNumber

>InvoiceDate>BillAddress

>ShipAddress

>OrderNumber

>PO

>DeliveryDate

>TermsDescription

>DueDate

>DiscountAvailable

>DiscountDate

The invoice detail information used in

the template. Other information can be


information.

Invoiceinformation


dened within WC@PACKAGES

tags:

> TrackingNumber

>Carrier

>CarrierService

The invoice information used in the

template about shipments that have

tracking numbers provided. Other

information can be displayed according

to your database information.


12/12


Overview

Displayinfo.

WC@NOPACKAGES tags

The invoice information to the right about shipment details can be

displayed in any manner on the invoice details page, as long as each

is nested as is within and

.

These tags and the tags list information for

shipments that do not have tracking numbers recorded in the system.

Note: Information nested within tags and

separate information nested within tags (refer

to pg. 8) can both be coded in the invoice details page.

This will allow information to display whether or not the shipment has

a tracking number recorded in the system.

The following code displays the ship via for each shipment listed:

ShipVia

More WC tags

Included with the module are pages that only appear under certain

circumstances, such as a problem with processing the customers request

(Problem1.htm) or if there is no information for the customer under the

category they request (Missing1.htm).

These pages can be modied as well to match your websites appearance.

> tags are included in the code for

Missing1.htm and dene the following information:

Type (the information that is missing)

Number

> tags are included (without nestedinformation) in the code for Problem1.htm. which can display a

message about the problem that is not allowing the request to

be processed (i.e. Invoice information is not currently

available).

> tags do not have nested information and

display error messages.

Invoiceinformation


dened within WC@NOPACKAGES

tags:

> ShipVia>Carrier

>CarrierService

>TrackingNumber

The invoice information used in the

template about shipments that do not

have tracking numbers provided. Other

information can be displayed according

to your database information.

Css Programmers Guide

Documents

Transcript of Css Programmers Guide