NextGen Healthcare

Vertex O Series 6.0

Implementation

REQUIREMENTS ANALYSIS

Author: Kong Yang

Issue Date: 8.09.2011

1041 OLD CASSATT ROAD

BERWYN, PA 19312

T: 610.640.4200

F: 610.640.2761

VERTEXINC.COM

Version: 1.0

NextGen:
Representative Name:
Representative Title:
Date:
Signature:

1041 OLD CASSATT ROAD

BERWYN, PA 19312

Accepted By:
Vertex, Inc:
Representative Name:
Representative Title:
Date:
Signature:

T: 610.640.4200

F: 610.640.2761

VERTEXINC.COM

TABLE OF CONTENTS
Revision history........................................................................................................................................... 1
Introduction.................................................................................................................................................. 1
Purpose................................................................................................................................................. 1
General.................................................................................................................................................. 1
General Approach................................................................................................................................. 1
Ranking Requirements.......................................................................................................................... 1
Requirements Analysis................................................................................................................................ 2
Tax Processing...................................................................................................................................... 2
Taxability Manager Setup...................................................................................................................... 3
Address Handling.................................................................................................................................. 4
Error Handling....................................................................................................................................... 4
Reporting............................................................................................................................................... 4
Performance.......................................................................................................................................... 5
Security................................................................................................................................................. 5
Data Field Mapping...................................................................................................................................... 5
Design......................................................................................................................................................... 6
Vertex O Series Tax Provider................................................................................................................ 6
Customer code...................................................................................................................................... 8
Address................................................................................................................................................. 8
Tax Category Code................................................................................................................................ 9
Assumptions................................................................................................................................................ 9

February 2016

Page i

NextGen Requirements Analysis

REVISION HISTORY
Name
Kong Yang
Kong Yang

Date
8/5/11
9/15/11

Reason for Change

Initial draft
Update details

Version
1.0 draft 1
1.0 draft 2

INTRODUCTION
PURPOSE
This document evaluates the requirements for tax calculation between Vertex O Series
6.0 and NextGens e-commerce application nopCommerce.
GENERAL
A custom interface between nopCommerce will be developed by Vertex Consulting.
The interface will implement nopCommerce tax provider class and be configurable as a
tax provider through nopCommerce administration page. The interface will allow
nopCommerce to call O Series for tax rates.
Current nopCommerce functionality does not provide ability to post submitted orders to
O Series. nopCommerce source will need to be modified in order to post orders. This
may impact future upgrades of the application.
The custom interface will allow nopCommerce to pass product SKU, tax class, and
customer data to O Series for tax calculation.
GENERAL APPROACH
Ranking Requirements
A level of priority must be associated with each requirement. This allows the project
team and the project sponsors to ensure that all critical business processes are
accommodated during the implementation of the new system. It allows the project team
to focus on those areas that are most important to the organization and it also highlights
where new functionality can add value to the current business to improve business
processes, realize efficiencies or improve reporting. The following table identifies the
codes used in the Rank column of the Requirements Analysis Report:
Rank

February 2016

Explanation

Page 1

NextGen Requirements Analysis

H
M

(High) Mission Critical Requirements are requirements that are mission

critical, necessary for operation and without them the organization could
not function.
M (Medium) High Value Add Requirements are requirements that, if
met, would significantly improve NextGens processes; these
requirements are often current business system processes that are not
mission critical to the organizations business, but if met could provide
significant cost benefit to the organization.
L (Low) Desirable Requirements are requirements that are nice to have
and would add only minor value to NextGens business processes and
may be met through workarounds or changes to business processes.

REQUIREMENTS ANALYSIS
TAX PROCESSING
No.
Requirement
1.01 Ability to process tax
quotes.
1.02 Ability to post invoices to
tax journal.
1.03 Ability to process
merchandise returns

Rank
H

1.04 1 ship-to address per

transaction

1.05 1 ship-from address per

transaction.

1.07 Ability to setup tax

classifications.

February 2016

Alternatives

1.06 Ability to determine which

warehouse to ship from.

Comments
Tax quotes are not
recorded in the
database.

Merchandise returns
will not be processed
through online store.
(will need to issue
negative invoice
using original invoice
date to calculate
proper tax)
Destination address
can be set at the
header level.
Physical origin
address can be set
at header level.
Suggestion: default
to warehouse
shipping majority of
products.

Page 2

NextGen Requirements Analysis

1.08 Ability to setup customer

exemption.

1.09 A single shipping amount

will be passed per invoice.

1.10 Invoices should post to O

Series when order
submitted.
1.11 nopCommerce can only
pass 1 line item at a time to
O Series for tax rate.
1.12 nopCommerce uses
returned tax rate to
calculate tax amount.

Must determine how

to pass customer
data.
Need to determine
how shipping is
passed to Vertex.

M
M

Need to discuss
invoice level
taxation.
This will cause
variances in tax
amounts when
orders are posted to
O Series.

Issues
Design Considerations
Modify nopCommerce source code to use Vertex tax amounts.
Modify nopCommerce source code to pass entire order to Vertex for tax calculation.

TAXABILITY MANAGER SETUP

No.
Requirement
2.01 Setup non-taxable product
codes.
2.02 Setup taxpayer.
2.03 Setup customer
exemptions.

Rank

Comments

Alternatives

H
H
H

Issues
Design Considerations

February 2016

Page 3

NextGen Requirements Analysis

ADDRESS HANDLING
No.
Requirement
3.01 Ability to validate addresses
(ie assign zip+4) and do
address correction.

3.02 Ability to pass zip+4

Rank

Comments
Address validation
will occur on the
Vertex side but
cleansed info will not
be passed back to
online store.
Zip+4 will not be
passed to O Series.

Alternatives

Comments
1. Stop order
process or
2. Continue with
order but
calculate tax
at a later time
3. Esther to
answer??

Alternatives

Issues
Design Considerations
ERROR HANDLING
No.
Requirement
4.01 Should nopCommerce
show error when O Series
is down?

Rank

Issues
Design Considerations
REPORTING
No.
Requirement
5.01 Returns extract will be
generated out of O series.

Rank

Comments

Alternatives

Issues
Design Considerations

February 2016

Page 4

NextGen Requirements Analysis

PERFORMANCE
No.
Requirement
6.01 Ability to process ???
transactions per second.
6.06 ??? transactions per day.

Rank

Comments

Alternatives

Comments

Alternatives

H
H

Issues
Design Considerations
SECURITY
No.
Requirement
7.01 Ability to setup roles in
Vertex O Series and assign
to users.
7.02 Ability to communicate over
https.

Rank
M
M

Issues
Design Considerations

DATA FIELD MAPPING

Vertex O Series
Seller -> Address

nopCommerce
??

Description
Ship from address

Seller -> Company

1000

Identifies the top-level legal entity for which tax

exceptions may exist. The Vertex Central user interfa
used to set up any taxability rules that apply at this le
This should be a parameter that is configurable to da
from the host system based on an individual compan
legal and tax requirements.

Seller -> Company

1005

February 2016

Page 5

NextGen Requirements Analysis

Customer -> Address

Customer

LineItem -> Product

Code

LineItem -> Product

Class

LineItem -> Quantity

LineItem ->
ExtendedPrice

Shipping Address
Mnemonic (SDE Acctg ID
and GCN). James O to
determine where to store in
database.

Ship to address
The customer for the transaction. The customer is
described by the child elements and attributes.

ProductVariant.SKU

A code from the host system that identifies the pro

material, service, or SKU number. You can use the V
Central user interface to map your products to Produ
Categories. If the supplied Product and Product Clas
information is not recognized by the calculation engin
general category indicating TPP is assigned. Require
if no Product Class information is supplied. If both are
supplied, Product information supersedes Product Cl
information.

ProductVariant.TaxCategory

A code used to represent groups or categories of

products or services with similar taxability. You can u
Vertex Central user interface to map your products cl
to Product Class Categories. If the supplied Product
Product Class information is not recognized by the
calculation engine, a general category indicating TPP
assigned. Required (1) if no Product information is
supplied. If both are supplied, Product information
supersedes Product Class information.

The number of units included in the line item based

quantity and not a currency amount. This value is ap
on a line item basis to the quantity level of the produc
This application of tax differs from normal tax calcula
because the tax amount/rate is applied at the quantit
level of the item sold in the transaction and not to the
purchase price. Required (1) if no Extended Price
information is supplied.

ProductVariant.Price

This field specifies the actual price of the line item.

However, if quantity and unit price are supplied, this i
required.

DESIGN
VERTEX O SERIES TAX PROVIDER
Custom class VertexOSeries6TaxProvider will be developed and implement interface
ITaxProvider. This class will send requests (XML) as web service calls to O Series and
pass back a tax rate.

February 2016

Page 6

NextGen Requirements Analysis

Vertex O Series will be added as a tax provider plugin through nopCommerce

administration.

Once the plugin is installed, O Series can be selected as a Tax Provider.

The following are the configuration parameters for VertexOSeries6.

February 2016

Page 7

NextGen Requirements Analysis

CUSTOMER CODE
Mnemonic (SDE Acctg ID and GCN) The following attributes will be added to the
customer attribute object to store GCN and mnemonic values.
private string AttributeNameGCN = "GCN";
private string AttributeNameMnemnic = "Mnemnic";

ADDRESS
The class TaxService.cs will be updated to default to billing address when shipping
address is null. James O updated the file:
var basedOn = _taxSettings.TaxBasedOn;
if (basedOn == TaxBasedOn.ShippingAddress)
{
if (customer == null || customer.ShippingAddress == null)
basedOn = TaxBasedOn.BillingAddress;
}
if (basedOn == TaxBasedOn.BillingAddress)
{

February 2016

Page 8

NextGen Requirements Analysis

if (customer == null || customer.BillingAddress == null)

basedOn = TaxBasedOn.DefaultAddress;

TAX CATEGORY CODE

The current method TaxCategoryId of object CalculateTaxRequest is set to
TaxCategoryID from table Nop_TaxCategory:

Since this is the primary key and can't be manipulated by the user the category name
will be used instead. A new method will need to be added to the CalculateTaxRequest
object to set category name.

ASSUMPTIONS
1. nopCommerce can only pass 1 line item at a time to Vertex O Series for tax
calculation.
2. nopCommerce only uses tax rate from Vertex O Series. The tax rate is then
used to calculate tax through the stores own process. This may cause slight
differences in calculation between online store and O Series.
3. nopCommerce does not pass taxpayer info.
4. nopCommerce can only pass 1 address. Need ability to pass ship from
information in addition to destination address.

February 2016

Page 9