Customer Account Invoice Listing Content Managed Webpage Area Login

Contents

  1. Prerequisites
  2. Area Overview
  3. Area Formats
  4. Area Settings
  5. Dependent Configurations
  6. Recomendations

This document describes how a Customer Account Invoice Listing area works when being displayed on a content managed web page within the TOTECS platform. This area is used to display a list of invoices related to a customer account, that has been obtained in real time from an accounting or Enterprise Resource Planning (ERP) system.

Prerequisites

Please ensure that you have read and understand the following topic links before reading on.

Area Overview

The Customer Account Invoice Listing area displays a list of invoices (related to the user's assigned customer account) that have been obtained in real time from an accounting/ERP system, by making a request through the Connector software that has been configured in the TOTECS project.

If the Connector is able to obtain the invoice data from the accounting/ERP system, it will then use 2 formats to display the list of invoices in an area within a tailored content managed web page.

If TOTECS is unable to connect to the configured project's connector, or the connector is unable to obtain the list of invoice data from the accounting/ERP system, then a single format can be tailored to display an error message back the user within the invoice list.

The area can provide the following functions:

  • Display a list of invoices searched within a date range filter.
  • Display a list of invoices searched on matching an invoice ID search term.
  • Display a list of invoices that are only outstanding against the customer account.
  • Paginate the invoice list over several pages, to aid in navigation for users.
  • For each invoice display information such as invoice ID, date, amount, balance.
  • Allow users to select a number of outstanding invoices to make payments against.

The invoice list displayed in the area must be linked to the customer account assigned to the logged in user. If the user is not logged in then the area will not output any data or try to make a request to obtain data from the connector.

Area Formats

The area contains the following formats:

Customer Account Invoice Listing

The format displays once within the area when the list of invoice data has been successfully obtained from the accounting/ERP system via the connector software. The format contains hooks available to display and position the invoice list, as well as provide inputs to allow the list to be filtered, searched on, and navigated through.

Customer Account Invoice Record

This format can display zero-to-many times, based on the number of invoices that were found. Each invoice record format has hooks available to display an invoice's ID, date, amount, balance and hooks to link the invoice to another page for displaying its detail. Each of the invoice record formats are grouped together and placed in a hook available to be placed within the Customer Account Invoice Listing format.

Customer Account Invoice Error Message

The format displays when the invoice data could not be obtained. Use this format to display a meaningful mesage to the user to explain that the connection is down, the accounting/ERP system is under maintainence, or that their customer account does not exist. This format is placed in the invoice records hook instead of the invoice record formats, that can then be embedded in the Customer Account Invoice Listing format. This in effect allows the area to display an error message in the place where the invoice records would normally display, similar to the way the Account Enquiry works within the Trade interface.

Layout of Invoice Formats:

Customer Account Invoice Listing Format

Customer Account Invoice Record Format
Customer Account Invoice Record Format
Customer Account Invoice Record Format
Customer Account Invoice Error Message Format

Embedded Invoice Record Formats: 0 to Many
or a single Customer Account Invoice Error Message format.

Area Settings

Below are the following settings that can be configured through the area's editor when modifying the area in the Web Page Editor, within the Administration Centre.

Setting Label Description
Invoices Per Page: Set a whole number to limit the amount of invoice records that can display in the area at any one given time. Default 20 records.
Invoice Detail Webpage: The web page that users will be redirected to if they click on an element embedded with the invoice detail hook. If the web page is set to the same page that the area belongs to, and the user clicks on an element that contains the invoice detail onclick hook, then the Customer Account Invoice areas on the page will dynamically update and load the invoice detail based on the selected invoice.
Invoice Payment Webpage: The web page that users will be redirected to if they click on the element containing the payment onclick hook. If the web page is set to the same page that the area belongs to, and the user clicks on an element that contains the payment onclick hook, then Customer Account Invoice Payment Form areas on the page will dynamically update to allow the selected invoices to be paid for.
Load Invoices In Date Range: Set the default date range that invoices will be obtained within, when the area is first drawn on the content managed web page. The more recent the date range, the quicker it usually takes for accounting/ERP systems to search for invoices.
Show Only Overdue Invoices: If set to Yes then when the area is first displayed on the content managed web page, only invoices that are unpaid and overdue will be listed in the area.

Dependent Configurations

In order for the the area to display invoice data the following configurations are required to be set up:

  • The user viewing the area must be assigned to a permission Facility Role that has the My Account Invoice permission set to Allow.
  • The user viewing the area must be logged in and assigned to the Content Managed Website interface.
  • The area must be added onto a secure content managed web page. When the web page is loaded for the user the URL must contain the HTTPS protocol and secure domain for the website. If this is not set then users will not be able to filter or update the invoices listed in the area.
  • The Connector software must be installed on a computer, and have an adaptor configured to connect to an accounting/ERP system that supports obtaining customer account invoice data.
  • The TOTECS project must have the Connector settings configured to be able to make connections to the Connector software, and the configured adaptor.

Recomendations

  • Create the area on secured content managed web page to ensure that the invoice data being returned to the user's browser cannot be intercepted, viewed, or stored by external third parties.
  • Make sure that Connector software installed is up to date with the latest version. Older versions may not support the latest standards that TOTECS uses the obtain data from the Connector.
  • Only have one Customer Account Invoice Listing area appear on the web page. This will make the page quicker to load by reducing the amount of times TOTECS has to request, and wait for data to be returned from Connector before displaying the web page to the user.