Sie sind auf Seite 1von 58

Installation Guide for

Oracle E-Business Suite

Vertex Sales Tax Q Series 4.0


June 2010
For use with Oracle E-Business Suite, version 11.5.x
and Release 12
Supplement to the PL\SQL Programmer's Guide

Copyright and legal notices


Copyright 2010 Vertex Inc. All rights reserved. All materials contained within this documentation are proprietary
to Vertex Inc.
All nonlicensed reproductions or transmissions of this documentation in any form or by any means, electronic,
mechanical, or otherwise, including, but not limited to, photocopying and recording, for any purpose, without the
express written permission of Vertex Inc. are strictly prohibited.
Only Vertex Inc. licensees may reproduce or transmit this documentation within their company or organization (as
noted in their license agreement) by electronic or mechanical means, including photocopying.
Disclaimer
The information contained herein is designed to provide accurate information in regard to the subject matter covered,
and is provided with the understanding that Vertex is not engaged in rendering legal, tax, accounting, or other
professional services. In addition, the product and services taxability status codes in the Vertex software and
documentation are provided as a general interpretation of state laws and do not apply to any specific industry,
company, or transaction. Licensee accepts all responsibility for assignment and verification of appropriate tax status
codes. Information in this documentation is subject to change without notice.
Trademarks
Vertex, Vertex logo, glyph, Where Taxation Meets Innovation, Customer Caf, L Series, O Series, Q Series, and
TaxPlanner are registered trademarks of Vertex Inc. Exchange, Tax Cybrary, Exemption Certificate Manager,
Taxability Mapping Tool, Reporting and Analysis, TaxGIS, Tax Decision Maker, GeoCoder, Sales Tax RateLocator,
Tax Process Assessment, Provision Central Tax Office, Provision Global Tax Office, and Web Collect are
trademarks of Vertex Inc.
Third-party products
Other product and company names mentioned in this documentation may be the trademarks or registered trademarks
of their respective owners. Copies of the licenses for any third-party products included with this Vertex product can
be found on the installation DVD or CD-ROM.
Vertex global headquarters
1041 Old Cassatt Road
Berwyn, PA 19312 USA
Phone: 800.355.3500 or 610.640.4200
Fax: 610.640.2761
www.vertexinc.com
Vertex European headquarters
Vertex Global Tax Solutions, LTD
1 Furzeground Way, Stockley Park
Uxbridge, UB11 1EZ United Kingdom
Phone: +44 (0)20 8622 3053
www.vertexgts.co.uk
Vertex Sarasota office
101 Arthur Andersen Parkway, Suite 340
Sarasota, FL 34232
Phone: 866.829.8324

Contents
Preface ..................................................................................................................... 5
Contacting Vertex ..................................................................................................................... 5
Technical questions ............................................................................................................. 5
Products and services .......................................................................................................... 6
About Sales Tax Q Series.......................................................................................................... 8
Finding the information you need ........................................................................................... 10
About this guide ...................................................................................................................... 11
Purpose .............................................................................................................................. 12
Scope ................................................................................................................................. 12
Audience............................................................................................................................ 12
Organization ...................................................................................................................... 12
Procedure formatting............................................................................................................... 13
What's New in this Guide? ...................................................................................................... 14
June 2010........................................................................................................................... 14

Chapter 1. Overview ............................................................................................ 16


Sales tax compliance ............................................................................................................... 16
What taxes does STQ-PL/SQL calculate? ........................................................................ 16
Operating environment............................................................................................................ 17
System compatibility......................................................................................................... 17
Major tools .............................................................................................................................. 19
Installation......................................................................................................................... 20
Software tools.......................................................................................................................... 21
STQ-PL/SQL Development kit......................................................................................... 21
Utility kit ........................................................................................................................... 23
Tax Professional kit........................................................................................................... 24
Database objects...................................................................................................................... 25
Rate database tables ................................................................................................................ 25
What each record in the database tables contains ............................................................. 26
Maintaining the Rate database objects .............................................................................. 26
History records in the Rate database objects..................................................................... 26
GeoCoder database tables ....................................................................................................... 27
Register database objects ........................................................................................................ 27
What the Register database tables are used for ................................................................. 27
Pre-returns and Post-returns tables.................................................................................... 28
TDM database objects............................................................................................................. 28
How STQ-PL/SQL calculates tax ........................................................................................... 28
Information flow ............................................................................................................... 29

June 2010 z Page 3

Vertex Sales Tax Q Series


Contents

Chapter 2. Installation ......................................................................................... 30


Prerequisites for installing STQ-PL/SQL with Oracle applications ....................................... 30
Oracle software ................................................................................................................. 30
Oracle user privileges........................................................................................................ 31
STQ-PL/SQL with Oracle E-Business Suite on UNIX........................................................... 32
UNIX installation CD-ROMs.................................................................................................. 33
UNIX implementation process overviews ........................................................................ 34
Directory structure............................................................................................................. 36
Installation process flowchart............................................................................................ 37
STQ-PL/SQL kits for the UNIX workstation ......................................................................... 37
Installing the STQ-PL/SQL database objects.................................................................... 38
Installing the Development and Utility kits ...................................................................... 38
Oracle considerations ........................................................................................................ 39
Setting the shared library environmental variables ........................................................... 40
Oracle database objects ..................................................................................................... 40
Register database ID and description ................................................................................ 42
Making and changing connections to database objects..................................................... 44
Populating and updating the Rate database tables ............................................................ 45
Populating and updating the GeoCoder database tables ................................................... 50
Migrating to STQ-PL/SQL 4.0................................................................................................ 55
Streamline your installation .............................................................................................. 56

Index ...................................................................................................................... 57

June 2010 z Page 4

Vertex Sales Tax Q Series


Preface

Preface
This preface contains the following information:

Contacting Vertex, which includes how to contact Vertex about


services and products

About Vertex Sales Tax Q Series products, which includes the list of
guides that Vertex provides

About this guide, which includes its purpose, scope, audience, and
procedure formatting

Contacting Vertex
Use this information to ask questions, purchase products or services, or
contact corporate offices.

Technical questions
If you have technical questions or comments, contact Product Support (use
product code 4720 for fastest response):
Phone: 800-281-1900 (Monday through Friday, 8:15 A.M. to 8:00 P.M.
United States Eastern Time)
Web: www.vertexinc.com/CustomerCafe/
You can help Product Support resolve your issue promptly by having your
Vertex product and release numbers as well as information about your
platform, databases, and vendor package ready before you call.
Also, be sure you have access to the appropriate internal personnel
(technical staff, database administrator, system administrator) if you need
their assistance during your call.

June 2010 z Page 5

Vertex Sales Tax Q Series


Preface z Contacting Vertex

Products and services


If you would like information about obtaining a new license file, contact
the Account Services department:
Phone: 800-355-3500
Fax: 610-640-5892
If you would like information about purchasing Vertex products and
services, contact the Sales department.
Vertex Global headquarters
Phone: 800-355-3500 or 610.640.4200
Fax: 610-640-5892
Web: www.vertexinc.com/ContactUs/web-inquiry-form.asp
Vertex European headquarters
Phone: +44 (0) 20 8622 3053
Fax: +44 (0) 20 8622 3200
Web: www.vertexgts.co.uk

Tax References
Vertex offers a variety of references for tax compliance information as
well as jurisdiction and postal code information. To learn more, refer to the
Indirect Tax Solutions/Tax Reference section of the Web site at
www.vertexinc.com/Solutions/indirect/tax-reference.asp.

Vertex Consulting
Vertex Consulting provides specialized knowledge and experience to help
you configure your Vertex software and ensure that it's integrated correctly
with your host system. We tailor the consulting service to complement
your company's internal resources and skills to address your unique needs.
For more information about the service options available, refer to the
Solutions/Vertex Consulting section of our Web site at
www.vertexinc.com/solutions/consulting/.

June 2010 z Page 6

Vertex Sales Tax Q Series


Preface z Contacting Vertex

Training Solutions
Vertex offers regional classroom training, Web classroom training, and
training at your facility. Vertex Training helps you understand not just how
to use the product, but how to apply it in practical ways that benefit your
company's tax compliance efforts. Vertex courses are CPE accredited and
are led by Certified Technical Trainers. Customers who attend training
classes typically reduce their implementation time by about 50 percent.
For more information on Vertex Training Solutions, refer to the
Support/Training Solutions section of our Web site at
www.vertexinc.com/Support/training/.

Comments about this documentation


If you have questions or comments about this guide or other Vertex
product documentation, send an email to documentation@vertexinc.com.
We are always eager to improve your documentation and we welcome
your feedback.

Vertex corporate offices


Vertex is a privately held company with offices in these locations:
Global headquarters
1041 Old Cassatt Road
Berwyn, PA 19312
USA
Phone: 610.640.4200
Toll-free (United States only):
800.355.3500
Fax: 610.640.2761
www.vertexinc.com/
Sarasota office
101 Arthur Andersen Parkway
Suite 340
Sarasota, FL 34232
USA
Phone: 866.829.8324

European headquarters
Vertex Global Tax Solutions, LTD
1 Furzeground Way, Stockley Park
Uxbridge, UB11 1EZ
United Kingdom
Phone: +44 (0)20 8622 3053
Fax:+44 (0)20 8622 3200
www.vertexgts.co.uk

Tax Returns processing center


40 Shuman Blvd.
Suite 218
Naperville, IL 60563
USA
Phone: 630.328.2600

June 2010 z Page 7

Vertex Sales Tax Q Series


Preface z About Sales Tax Q Series

About Sales Tax Q Series


Vertex Sales Tax Q Series (STQ) assists your company in the tax
compliance process by maintaining tax rates, rules, and regulations and
enabling you to enter special tax considerations for customers, products,
and jurisdictions where you are registered.
STQ simplifies the tax compliance process by:

Interfacing with your host system (using industry standards such as C,


OLE, UNIX, Windows, and client servers)

Using an accurate and extensive tax rate database (Rate database)

Using an accurate and extensive jurisdiction database (Vertex


GeoCoder database)

Sales Tax Q Series


The C version of Vertex Sales Tax Q Series (STQ) can interface to any
operating system that supports ANSI C functions, including UNIX and
Windows. Windows users have the option of interfacing to STQ using
OLE (Object Linking and Embedding) functions.
STQ supports Indexed Sequential Access Method (ISAM) databases and
Relational Database Management Systems (RDBMS).
Sales Tax Q Series EC
The EC version of Vertex Sales Tax Q Series (STQ-EC) calculates sales
and use tax for electronic commerce transactions.
STQ-EC interfaces with your Internet application using both Java and
Extensible Markup Language (XML). The object-oriented STQ-EC
interface accepts data from your electronic commerce application using
Java objects or XML documents and then passes the data into the
calculation engine to provide the sales tax for an online customer.
STQ-EC is available in Java and XML versions. Both versions work with
the C version and the PL/SQL version of STQ calculation engine.

June 2010 z Page 8

Vertex Sales Tax Q Series


Preface z About Sales Tax Q Series

Sales Tax Q Series PL/SQL


The PL/SQL version of Vertex Sales Tax Q Series (STQ-PL/SQL) runs
in a networking computing architecture with STQ-PL/SQL Tax
Calculation that resides on the database server.
Vertex supplies installation media for UNIX environments to install the
Utility kit and installation media for Windows environments to install the
Tax Professional kit.
The Tax Calculation package is designed to run on an Oracle database.

June 2010 z Page 9

Vertex Sales Tax Q Series


Preface z Finding the information you need

Finding the information you need


To help you install your STQ software, integrate STQ with your financial
host system, and use Vertex Tax Decision Maker or Vertex Taxability
Mapping Tool user interfaces to customize STQ to your business, Vertex
provides documentation. Select one of the following documents based on
your needs and version of the STQ software:
For this task

Use this documentation

Implementing the software

Keys to a Successful Implementation

Plan the implementation and set expectations about time required to


implement Vertex software.
Installing the software

C Administrator's Guide

Install and configure STQ to communicate with databases.

EC Administrator's Guide
PL/SQL Programmer's Guide
PL/SQL Installation Guide for Oracle
eBusiness Suite

Building an interface

C Programmer's Guide

Create interface between components of STQ and your host system. PL/SQL Programmer's Guide
EC Programmer's Guide
Setting up taxability information

User's Guide

Set up the Tax Decision Maker (TDM) and Taxability


Mapping Tool (TMT)

Tax Decision Maker Help

Use and maintain these components

Generate TDM reports and definitions of report codes

Looking up GeoCodes

User's Guide

View and verify GeoCodes, address, and tax rate information.

Lookup Help

Note:

Lookup only displays the standard rates. It does not


display tax overrides or tier tax logic.

Converting data

C Programmer's Guide

Convert your existing Vertex Sales Tax L Series COBOL or RPG Sales Tax Conversion Help
III TDM database records into a format that can be imported into an
STQ TDM database.

Importing or exporting data

C Programmer's Guide

Import or export exception information into an STQ TDM database TDM Import-Export Help

June 2010 z Page 10

Vertex Sales Tax Q Series


Preface z About this guide

For this task

Use this documentation

Managing databases

C Administrator's Guide

Create, migrate, and re-index ISAM databases

EC Administrator's Guide

Connect to databases

Sales Tax Utilities Help

Populate to update the Rate, GeoCoder, and TDM databases

Maintaining the Register database

C Programmer's Guide

Transfer, consolidate, and purge information

EC Programmer's Guide

Set up the Register control card

Sales Tax Utilities Help

Generate reports

Testing tax calculation

C Administrator's Guide

Verify that tax can be calculated on sample invoices

EC Administrator's Guide
Sales Tax Utilities Help

Viewing database table changes

C Administrator's Guide

Use the Administration Table Viewer to track changes to your


database.

EC Administrator's Guide

Working with SAP TransLink

SAP TransLink Supplement

Sales Tax Utilities Help

How TransLink integration works with SAP R/3 and Customer


Relationship Management (CRM) applications to provide access to
STQ programs and databases for tax calculation and GeoCode
retrieval.
Working with SoftLink

SoftLink Supplement

How SoftLink integration works with PeopleSoft application to


provide access to STQ programs and databases for tax calculation
and GeoCode retrieval.

Note: The latest product documentation updates are available online in


the Vertex Customer Caf at www.vertexinc.com/CustomerCafe/.
You can also use the Customer Caf to access the online
Knowledge Center, submit a Service Request, or visit the Message
Board where you can communicate with other Vertex users about
tips, tricks, and best practices.

About this guide


This guide is one book in the Vertex Sales Tax Q Series product library.

June 2010 z Page 11

Vertex Sales Tax Q Series


Preface z About this guide

Purpose
This is an introduction to the Vertex Sales Tax Q Series PL/SQL
Installation Guide for Oracle E-Business Suite version 11.5.x and Release
12. This version of Oracle E-Business Suite is pre-packaged with Vertex
scripts that are used to create, migrate, and drop database objects so some
installation tasks are automated for you.
This guide includes migrating information for STQ-PL/SQL 3.3. After
you have migrated, refer to the Vertex Sales Tax Q Series PL/SQL
Programmer's Guide for information about interfacing with your host
system, recording transactions, and performing maintenance tasks.
This guide instructs the site administrator or system implementor how to
install Vertex Sales Tax Q Series PL/SQL for Oracle E-Business Suite and
populate its databases.

Scope
The Vertex Sales Tax Q Series Installation Guide for Oracle e-Business
Suite describes the use of the functions needed to:

Understand the Vertex Sales Tax Q Series Installation Guide for


Oracle e-Business Suite, its components, and the flow of information
through the system

Install STQ-PL/SQL for Oracle E-Business Suite

Interface STQ-PL/SQL with your host system

Audience
To use the Vertex Sales Tax Q Series Installation Guide for Oracle eBusiness Suite, you should be familiar with PL/SQL programming.

Organization
This guide contains the following chapters:

June 2010 z Page 12

Vertex Sales Tax Q Series


Preface z Procedure formatting

Chapter 1. Overview

This chapter introduces you to the Oracle PL/SQL version of Vertex Sales
Tax Q Series (STQ-PL/SQL), its concepts, components, and operating
environment. Its purpose is to help you understand how the system works
with your financial applications or host application.
Chapter 2. Installation

This chapter describes the procedure for installing the PL/SQL version of
Vertex Sales Tax Q Series (STQ-PL/SQL) with Oracle E-Business Suite in
a UNIX environment.

Procedure formatting
Vertex documentation follows some standard conventions in its
descriptions of step-by-step instructions. These conventions make it easy
to see what actions you must take and what you see on the screen.
Data entry fields and command buttons
Text that you see on the screen, such as data entry fields and the names of
command buttons, look like this:
Click OK to save the data in the Address field.
Keys
The names of keys you press look like this:
Press F4 and Enter.
Menu selections
Selections you make from cascading menus look like this:
Select File > Save.
Information you type
Information you type looks like this:
Type setup at the A:\ prompt.
Variable text
Variable text you type looks like this:
Type myfile at the A:\ prompt.

June 2010 z Page 13

Vertex Sales Tax Q Series


Preface z What's New in this Guide?

System messages
Messages from the system look like this:
setup

What's New in this Guide?


This guide contains the following major changes:

June 2010
New data files
For STQ-PL/SQL 4.0, there are new data files and changes to the existing
data files, as follows:

GeoCoder file (geomast4.vdf) is used to update GeoCode data in the


GeoCoder database each month. It is a permanent replacement for the
geomast2 (for 3.3 and 3.4 versions) and geomast (for 3.2 and earlier
versions).

ZIP+4 file (staxzip4.vdf) is a new file, which is used to update the


ZIP+4 data in the GeoCoder database each month. This file is loaded
only if you want to use nine-digit ZIP Code functionality.

Rate update file (seqmast4m.vdf) is a one-time migration file that is


used after upgrading to STQ-PL/SQL 4.0 and migrating the Rate
database. This file updates your Rate database with district rate
effective dates and situs changes, which are effective for STQ-PL/SQL
4.0. If you are upgrading to STQ-PL/SQL 4.0, you must load this file.

Rate file (seqmast4.vdf) is used to update your Rate database each


month. It is a permanent replacement for the seqmast (for 3.4 and
earlier versions).

TMT file (tmtmast4.vdf) is a data file used to update TMT data each
month. It is a permanent replacement for the tmtmast33 (for 3.3 and
3.4 versions) and tmtmast (for 3.2 and earlier versions).

June 2010 z Page 14

Vertex Sales Tax Q Series


Preface z What's New in this Guide?

New data file format


The data files for STQ-PL/SQL 4.0 have a new file format, such as:
geomast4.vdf

Where:
4

is the product version number

.vdf

is the new file extension

All of the data files are now in lower case type so the files can be used by
multiple platforms.

June 2010 z Page 15

Chapter 1

Overview
This chapter introduces you to the Oracle PL/SQL version of Vertex Sales Tax Q
Series (STQ-PL/SQL), its concepts, components, and operating environment. Its
purpose is to help you understand how the system works with your financial
applications or host application.

In this chapter
Sales tax compliance ..................................................................... 16
Operating environment.................................................................. 17
Major tools .................................................................................... 19
Software tools................................................................................ 21
Database objects............................................................................ 25
Rate database tables ...................................................................... 25
GeoCoder database tables ............................................................. 27
Register database objects .............................................................. 27
TDM database objects................................................................... 28
How STQ-PL/SQL calculates tax ................................................. 28

Sales tax compliance


Sales tax compliance is the process of billing, collecting, and remitting the proper
amount of sales and use tax to the proper authorities. It also includes maintaining
documentation and audit trails to justify tax activities to auditors.

What taxes does STQ-PL/SQL calculate?


STQ-PL/SQL calculates the following state and local taxes:

Sales tax

Seller's use tax

Rental tax

Canadian service tax

June 2010 z Page 16

Vertex Sales Tax Q Series


Chapter 1. Overview z Operating environment

STQ-PL/SQL simplifies tax compliance


STQ-PL/SQL simplifies the process of complying with the requirements of taxing
jurisdictions in the United States and Canada by:

Interfacing with your host application on the database server, using a


convenient Oracle PL/SQL package

Using accurate and extensive tax rate data, stored in the Rate database tables.

Using accurate and extensive jurisdiction data, stored in the GeoCoder


database tables.

STQ-PL/SQL was developed to assist your company in tax compliance by


maintaining tax rates, rules, and regulations. It enables you to enter special tax
considerations for customers, products, and jurisdictions where you are registered.

Operating environment
This section describes the flexibility of the STQ-PL/SQL operating environment.

System compatibility
STQ-PL/SQL is designed to run in a networking computing architecture, with
STQ-PL/SQL Tax Calculation resident on the database server.

Your host application


STQ-PL/SQL can interface with Oracle E-Business Suite's financial and
accounting applications, including:

Accounts payable

Order entry

Invoicing

Financial and management reports

This guide refers to these collectively as your host application.

June 2010 z Page 17

Vertex Sales Tax Q Series


Chapter 1. Overview z Operating environment

Types of databases supported


The Tax Calculation package is designed to run on an Oracle database.
Note: For versions of the databases supported by Vertex Sales Tax Q Series,
refer to the directory structure of your Programs & TDM CD-ROM, or
ZIP file. If you have further questions contact Vertex Product Support,
800-281-1900 (Monday through Friday, 8:15 A.M. to 8:00 P.M. United
States Eastern Time).

June 2010 z Page 18

Vertex Sales Tax Q Series


Chapter 1. Overview z Major tools

Major tools
This section describes STQ-PL/SQLs major tools and how you use them.
STQ-PL/SQL provides a software development kit containing the tools your
company needs to achieve multi-state sales, use, and rental tax compliance. STQPL/SQLs tools include:
Tool

Description

Development tools

Contains a Tax Calculation package, a GeoCode Retrieval


package, and demo programs for each of these packages.

Utility tools

Executable files that create and maintain the GeoCoder


database, Rate database, Register database, and Tax
Decision Maker database.

Tax Decision Maker

A program that handles special taxing considerations.

Taxability Mapping Tool (TMT)

A graphical user interface in the TDM used to apply


Vertex-supplied predefined taxability data to your
inventory or product codes.
Note:

TMT data is an optional component of Vertex


Sales Tax Q Series. If you have not purchased
this option and would like more information
about the TMT feature, contact your Vertex sales
representative.

Rate file

The Rate file contains all current and previous tax rates. It
is used to populate and update the Rate database or
database tables. STQ-PL/SQL 4.0 uses seqmast4.vdf.

GeoCoder file

The Vertex GeoCoder file (geomast4.vdf) is a


sequential file that contains GeoCode information for
over 60,000 locations in the United States, its territories
and possessions, and Canada. It is used to populate and
update the GeoCoder database.

ZIP+4 file

The ZIP+4 file (staxzip4.vdf) contains GeoCodes that are


associated with nine-digit ZIP Codes, which enable a
more accurate assignment of GeoCodes for cities,
counties, districts, and Special Purpose Districts.
Special Purpose Districts (SPDs) are local jurisdictions
that do not follow city or county boundaries, such as
municipal transportation authorities (MTAs), hospitals,
and school districts.
Load this file if you want to use the jurisdiction
identification functionality for nine-digit ZIP Codes.
Otherwise, you can continue using the current five-digit
ZIP Code functionality. Vertex updates the STAXZIP file
(staxzip4.vdf) each month.

June 2010 z Page 19

Vertex Sales Tax Q Series


Chapter 1. Overview z Major tools

Tool

Description

Lookup Program

A program that enables you to look up, view, and verify


GeoCode, address, and tax rate information online.

Installation
Here is how your company uses the tools during installation:

The administrator loads the Development tools, the Utility tools, the Tax
Professional tools, and the Rate and GeoCoder files.

The tax professional or accounting staff enters special tax considerations into
the TDM.

Your interface
You write an interface to link your companys host system to STQ-PL/SQL Tax
Calculation package. Your host system and STQ-PL/SQL use the interface to pass
information between them. Use the STQ-PL/SQL package to write the interface.

How STQ-PL/SQL operates with your host system


During operation, your host system passes invoice information through your
PL/SQL interface to a STQ-PL/SQL package, which uses PL/SQL procedures to:

Check tax rates, jurisdictions, and special tax considerations in the STQPL/SQL database objects.

Calculate taxes.

Return tax information to your host system.

Vertex proprietary data


Vertex data and database objects are proprietary. STQ-PL/SQL has state-specific
logic embedded in its software to retrieve information from the database objects
and to apply the appropriate taxes for the various taxing jurisdictions. For this
reason, direct access to Vertexs data files and database objects is not supported.

Your tax compliance system


You use the financial applications on your host system, your interface, and STQPL/SQL tools to complete your companys tax compliance system.

June 2010 z Page 20

Vertex Sales Tax Q Series


Chapter 1. Overview z Software tools

Software tools
This section describes the STQ-PL/SQL software tools and identifies the intended
users.
The following software tools are provided:
Kit

Description

Development kit

This software is intended for the programmer. It is a tool to develop


the interface between your applications and STQ-PL/SQL.

Utility kit

This software is intended for the network administrator responsible


for maintaining the integrity of the network and files on the network.

Tax Professional kit

The Tax Professional kit is intended for the tax professional


responsible for tax compliance in your company. It includes the TDM
and the Lookup program.

STQ-PL/SQL Development kit


The STQ-PL/SQL Development kit is automatically installed with your Oracle EBusiness Suite application. It contains the Tax Calculation package.
Tax Calculation package
The Tax Calculation package processes information in the form of invoices, which
contain one or more line items. The Tax Calculation package uses PL/SQL
procedures to set and retrieve general information about the entire invoice and
specific information about each line item.
The Tax Calculation package can be programmed to:

Retrieve rates and taxability information from the Rate database tables

Write or not write invoice information to the Register database tables

Check the TDM database tables for taxability information for the invoice and
for each line item

The Tax Calculation package then uses the calculation functions to begin the tax
calculation process. The Tax Calculation package calculates taxes on the state,
county, city, and district levels. For states such as Texas, California, and Arizona,
the Tax Calculation package can calculate taxes for an additional local level tax or
can apply varying rates.
After all taxes are calculated for the entire invoice, the results can be written to the
Register database tables.

June 2010 z Page 21

Vertex Sales Tax Q Series


Chapter 1. Overview z Software tools

Who uses the Development kit?


The programmer uses the Development kit to write the interface between the host
application and STQ-PL/SQL to build a tax compliance system.

Operating systems
Vertex supplies installation media for UNIX environments to install the Utility kit.
Also included is installation media for Windows environments to install the Tax
Professional kit.

Overriding the Tax Calculation package


Host applications can override any information that the Tax Calculation package
accesses in the Rate database tables or in the TDM database tables.

June 2010 z Page 22

Vertex Sales Tax Q Series


Chapter 1. Overview z Software tools

Utility kit
This kit contains the maintenance tools to update rate and jurisdiction information
and the Register database tables. It also provides the tools needed to generate
reports and input for the returns preparation. The following files are included:
Component

Description

Register Utilities Program


REGUTIL (UNIX)
REGUTIL.EXE (Windows)

This program is used to maintain the Register database objects, create


reports, import and export files, and purge files. It converts the records for
tax returns processing. This program also enables you to access reports.

Monthly Update Rate Program


RATEUPD (UNIX)
RATEUPD.EXE (Windows)

This program is used to update the rates in the Rate database tables on a
monthly basis. This program reads deliverable location and rate files and
updates them with new information.

Installation Program
qsut.exe (Windows only)

This program places the components of the Utility kit in the directory
specified by the user.

Diagnostic Program
vsttest (UNIX)
vsttest.exe (Windows)

This program tests connections to the STQ-PL/SQL database objects. It also


performs calculations on the cases in the test file. This program contains 20
transactions that test to make certain the system can locate all the appropriate
database objects to calculate tax properly.

Initial Install Rate Program


RATEINS (UNIX)
RATEINS.EXE (Windows)

This program loads rates into the Rate database tables after the installation
has been completed. After the initial installation, the user will update the
database tables using the Monthly Update Programs.

GeoCoder Update Program


LOCUPD (UNIX)
LOCUPD.EXE (Windows)

This program installs GeoCodes in the GeoCoder database tables. It is also


used to completely repopulate the GeoCoder database tables each month
with data supplied by Vertex.

Initial Install TMT Data Program


TMTINS (UNIX)
TMTINS.EXE (Windows)

This program loads TMT data into the TDM database tables.

Monthly Update TMT Data Program


TMTUPD (UNIX)
TMTUPD.EXE (Windows)

This program is used on a monthly basis to update the TMT data in the TDM
database tables.

TDM Import/Export
TDMIE (UNIX)
Tdm Import Export.exe (Windows)

This program is used to import or export exception information to or from a


STQ-PL/SQL TDM database tables.

TDM Conversion
TDMCONV (UNIX)
Tdm Conversion.exe (Windows)

This program converts your existing Vertex Sales Tax L Series RPGIII or
COBOL TDM database records into a format that can be imported into STQPL/SQL TDM database tables.

Note:

Note:

The TMT data is an optional component of Vertex Sales Tax Q


Series. If you have not purchased this option and would like more
information about the TMT feature, contact your Vertex Sales
representative.

The TMT data is an optional component of Vertex Sales Tax Q


Series. If you have not purchased this option and would like more
information about the TMT feature, contact your Vertex Sales
representative.

June 2010 z Page 23

Vertex Sales Tax Q Series


Chapter 1. Overview z Software tools

The Utility kit also includes data files and libraries to support the executable files.

Tax Professional kit


The Tax Professional kit includes the Tax Decision Maker (TDM) and the STQPL/SQL Lookup program.
The TDM is a Windows application that enables your tax department to create and
maintain a series of dialog boxes to process special tax conditions according to
your company's specific tax requirements. The TDM dialog boxes are intended to
direct the tax calculation program on how to collect tax by jurisdiction, product,
customer, or any combination thereof.

What are special tax conditions?


Special tax conditions can include:

Overrides of normal tax rates

Surcharges

Exempt surcharges

Maximum and minimum taxes

Excess tax rates

Who can have special tax conditions?


The TDM enables a tax professional to specify special tax conditions for:

Individual customers

Customer classes

Individual products

Unique tax situations within a jurisdiction

Any combination of the above

What happens during tax calculation?


When processing a transaction, your interface passes the appropriate customer or
product code to the Tax Calculation package. The API then determines if any
special taxing considerations have been established in the TDM database tables.
A complete description of each TDM dialog box can be found in the Vertex Sales
Tax Q Series Users Guide.

June 2010 z Page 24

Vertex Sales Tax Q Series


Chapter 1. Overview z Database objects

Database objects
Run the SQL scripts provided (*ins.sql) to create the following Vertex database
objects:
Database
objects

Description

Rate
database
objects

The Rate database tables contain the rates and rules that are supplied in the Rate
Data File (seqmast4.vdf). STQ-PL/SQL accesses the Rate database objects during
tax calculation to determine the rates and rules that apply. Rates and rules are stored
in the Rate database tables according to GeoCode.

GeoCoder
database
objects

The GeoCoder database tables contain jurisdiction information supplied in the


GeoCoder file. They serve as a cross-reference between address information and
GeoCodes. STQ-PL/SQL accesses the GeoCoder database objects to look up
GeoCodes based on address information.

TDM
database
objects

The TDM database tables contain the taxability exception information and tax rate
overrides entered as special taxing considerations. If you purchase the optional
predefined TMT data, it will be included in the TDM database objects. STQPL/SQL accesses these database objects to retrieve any exceptions to information
found in the Rate database objects.
Note:

Register
database
objects

TMT data is an optional component of Vertex Sales Tax Q Series. If you


have not purchased this option and would like more information about the
TMT feature, contact your Vertex sales representative.

The Register database tables contain an audit trail of invoice data processed by
STQ-PL/SQL.

Each type of database object is described in detail in this section.

Rate database tables


The Rate database tables contain tax rates and other pertinent jurisdictional tax
data for over 60,000 locations in the United States, its territories and possessions,
and Canada.
All states and counties in the United States, all provinces in Canada, and all cities
in both the United States and Canada that are incorporated or levy a sales or use
tax are included in the Rate data.

June 2010 z Page 25

Vertex Sales Tax Q Series


Chapter 1. Overview z Rate database tables

What each record in the database tables contains


Each record in the Rate database tables contains information for a state, county, or
city. This information includes:

The GeoCode for each taxing jurisdiction.

A code indicating whether the jurisdiction levies tax on a ship-to, ship-from, or


order-acceptance basis.

A code indicating whether the tax is administered locally or administered at


the state level.

Maximum tax bases, amounts, and excess rates. Some states include
provisions for maximum tax amounts for cities and counties. In some states,
base dollar amounts are taxed at a standard rate, but the excess is taxed at
another rate.

Codes indicating tax rate overrides. In several states, a city tax overrides or
preempts a county tax. In those instances, a code in the city record prevents
county tax calculation for these cities.

U.S. ZIP Codes and Canadian Postal codes.

Maintaining the Rate database objects


Vertex researches and maintains the information contained in the database tables
by remaining in constant contact with all jurisdictions that levy a tax. Every
month, on a precise schedule, Vertex updates its internal databases and issues a
new Rate Data file to its subscribers. The Rate database tables are updated with
this file.

History records in the Rate database objects


When you initially populate the Rate database tables, they contain up to two rates
for each jurisdiction:

Current rate

Previous rate

When the Rate database tables are updated, new rate information is simply added
to them.
Rate information is never deleted from the Rate database tables so that, over a
period of time, you can accumulate a history of tax rates for your jurisdictions.
The history records are used when processing invoices with previous invoice
dates.

June 2010 z Page 26

Vertex Sales Tax Q Series


Chapter 1. Overview z GeoCoder database tables

GeoCoder database tables


The GeoCoder database tables contain information about jurisdictions that can
levy tax. Jurisdictions are identified by a nine-digit number, called a GeoCode.
The ship-to, ship-from, and order acceptance jurisdictions of each transaction
passed through the Tax Calculation package are assigned a GeoCode so that rates
in the Rate database objects can be accessed.
The database tables contain address information and alternate names for
jurisdictions as well as the GeoCodes used to uniquely identify over 60,000
locations which include every:

State within the United States

County within the United States

City within the United States that is an incorporated city

City within the United States that levies a sales or use tax

United States possession and territory

Province within Canada

City within Canada that is an incorporated city

City within Canada that levies a sales or use tax

Note: For taxing purposes, a city or town must be an incorporated governmental


entity that is identifiable by a geographic boundary, usually a component
of a county.

Register database objects


The Register database tables contain:

Information from your host application sent to the Tax Calculation package

Results calculated by the Tax Calculation package

Rate information from the Rate database tables

Information from the TDM database tables

What the Register database tables are used for


The information in the Register database tables is used to:

Create STQ-PL/SQL management and audit trail reports

Create the import file to use for returns preparation

June 2010 z Page 27

Vertex Sales Tax Q Series


Chapter 1. Overview z TDM database objects

Pre-returns and Post-returns tables


The Register database objects include two tables:
Table

Description

Pre-returns table

This table contains information that has not yet been


processed through the Returns Import file menu option to
download for remittance preparation.

Post-returns table

This table contains information that has been processed


through the Returns Import file menu option.

TDM database objects


The TDM database tables store information entered through the TDM about the
special tax situations for your customers, the products you sell, and the
jurisdictions where you are registered.

How STQ-PL/SQL calculates tax


STQ-PL/SQL uses the following process to calculate tax:
1. Your host system sends invoice information to STQ-PL/SQL.
2. STQ-PL/SQL identifies the taxing jurisdictions using the GeoCode Retrieval
package.
3. The Tax Calculation package determines if the transaction is interstate or
intrastate.
4. STQ-PL/SQL checks for special tax considerations in the TDM database
objects.
5. STQ-PL/SQL retrieves the appropriate tax rates from the Rate database objects
if no special considerations exist in the TDM database objects.
6. STQ-PL/SQL sends all this information to the Tax Calculation package.
7. The Tax Calculation package calculates tax amounts.
8. STQ-PL/SQL returns the tax information to your host system.
9. STQ-PL/SQL writes information to the Register database tables for preparing
Register reports and the Import file.

June 2010 z Page 28

Vertex Sales Tax Q Series


Chapter 1. Overview z How STQ-PL/SQL calculates tax

Information flow
The following figure shows the flow of information through a tax compliance
system that uses STQ-PL/SQL.

Figure 1: Information Flow through the System

Note: If you are an Oracle E-business Suite customer, note that your Oracle
application has its own GeoCode retrieval and assignment process.
Instead of using Vertexs GeoCoder Retrieval package, the Oracle
application extracts GeoCodes from one of Vertexs Monthly Update files,
loads the data, and performs queries to retrieve GeoCode information,
such as the GeoCodes, ZIP Codes, state, county, and city names from
Oracle database tables.

June 2010 z Page 29

Chapter 2

Installation
This chapter describes the procedure for installing the PL/SQL version of Vertex
Sales Tax Q Series (STQ-PL/SQL) with Oracle E-Business Suite in a UNIX
environment. The Oracle E-Business Suite kit contains the STQ-PL/SQL
Packages that set up the STQ-PL/SQL database objects. You must contact Vertex
Product Support to get the remaining STQ-PL/SQL components to complete your
installation.

In this chapter
Prerequisites for installing STQ-PL/SQL with Oracle
applications .................................................................................. 30
STQ-PL/SQL with Oracle E-Business Suite on UNIX................. 32
UNIX installation CD-ROMs........................................................ 33
STQ-PL/SQL kits for the UNIX workstation ............................... 37
Migrating to STQ-PL/SQL 4.0...................................................... 55

Prerequisites for installing STQ-PL/SQL with Oracle


applications
This section describes the prerequisites for installing the PL/SQL version of
Vertex Sales Tax Q Series with Oracle E-Business Suite, version 11.5.x or
Release 12.

Oracle software
You must install the following:

Oracle SQL*Plus on the client workstation.

Oracle Relational Database Management System (RDBMS) release 10.2 or


greater on the server workstation.

June 2010 z Page 30

Vertex Sales Tax Q Series


Chapter 2. Installation z Prerequisites for installing STQ-PL/SQL with Oracle applications

Oracle user privileges


You must have the following Oracle user privileges and/or a DBA or SYSOPER
account to install the STQ-PL/SQL Utility kit and STQ-PL/SQL Development kit
database objects on your Oracle server:

CONNECT ROLE

CONNECT RESOURCE

CREATE PROCEDURE

CREATE SESSION

CREATE TABLE

CREATE TRIGGER

CREATE SEQUENCE

CREATE CLUSTER

CREATE TYPE

CREATE PROCEDURE

CREATE VIEW

CREATE SYNONYM

CREATE ROLE

GRANT ROLE

GRANT RESOURCE

GRANT CONNECT ROLE

GRANT CREATE SESSION

GRANT CREATE TABLE

GRANT CREATE TRIGGER

GRANT CREATE SEQUENCE

GRANT CREATE CLUSTER

GRANT CREATE TYPE

GRANT CREATE PROCEDURE

GRANT CREATE VIEW

GRANT CREATE INDEXTYPE

GRANT CREATE ROLE

GRANT CREATE SYNONYM

June 2010 z Page 31

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL with Oracle E-Business Suite on UNIX

STQ-PL/SQL with Oracle E-Business Suite on UNIX


Components of the STQ-PL/SQL are included with the Oracle E-Business Suite
software. The Vertex components are pre-packaged for you in a single ZIP file
within the Oracle E-Business Suite to simplify the installation process. The prepackaged version automates the script procedures to create tablespace, assign
grants and permissions, and run SQL database objects creation scripts for you.
After installing the database objects from the ZIP file, you must complete the
remaining STQ-PL/SQL installation tasks.
This section describes the software you received to complete your installation. It
also describes the implementation process, directory structure, and installation
procedures for STQ-PL/SQL with Oracle E-Business Suite on UNIX.

June 2010 z Page 32

Vertex Sales Tax Q Series


Chapter 2. Installation z UNIX installation CD-ROMs

UNIX installation CD-ROMs


The first components of Vertex Sales Tax Q Series are found on your Oracle EBusiness Suite CD-ROM. The following table describes the Vertex Sales Tax Q
Series CD-ROMs for UNIX which includes the remaining components, supporting
tools and information:
Programs

Description

Oracle E-Business Suite

The Oracle E-Business Suite CD-ROM contains


installation driver scripts to access the STQPL/SQL packages and DDL needed to create the
empty STQ-PL/SQL database objects.

Programs - hardware and operating system


specific

The Programs CD-ROM contains STQ-PL/SQL


program files. In addition, if you purchased the
STQ-PL/SQL software from Vertex, the
Programs CD-ROM contains your Utility kit.

Programs & TDM - Intel

The Programs & TDM - Intel CD-ROM contains


the Tax Professional and Utility kits, which are
installed on a Windows-based PC.

Data (Update #xxx)

The Data CD-ROM contains the files used to


populate or update the Rate and GeoCoder
database tables. Vertex updates this data every
month to ensure you have up-to-date jurisdiction
and tax rate information. Check with Product
Support or the Customer Caf for the latest
update number.

National Sales Tax RateLocator (Update #xxx)

The National Sales Tax RateLocator CD-ROM


contains a Java-based application for looking up
tax information throughout the United States and
Canada. Vertex updates the RateLocator data
every month to ensure you have up-to-date
jurisdiction and tax rate information. Check with
Product Support for the latest update number.

TDM Taxability Guide (Update #x)

The TDM Taxability Guide is a PDF file that


provides valuable taxability indicators to assist in
making taxability decisions for your products and
services. Check with Product Support for the
latest update number.

Documentation

The Documentation CD-ROM contains PDF files


of the entire Vertex Sales Tax Q Series
documentation set.

June 2010 z Page 33

Vertex Sales Tax Q Series


Chapter 2. Installation z UNIX installation CD-ROMs

UNIX implementation process overviews


New implementations
The following table provides an overview of the process for new implementations.
Vertex recommends that you implement these steps in a test environment first.
Step

Task

For details

1.

Gather and plan.

Refer to the Vertex Keys to a Successful


Implementation booklet.

2.

Design and get ready.

Refer to the Vertex Keys to a Successful


Implementation booklet.

3.

Install the Oracle E-Business Suite CDROM on a UNIX machine in a test


environment.

Refer to the Oracle Receivables Vertex


Quantum Integration Guide.

4.

Execute the script to create the user ID in


the Oracle E-Business Suite and assign the
user to tablespace for STQ-PL/SQL.

Refer to STQ-PL/SQL Kits for the UNIX


workstation (see page 54).

5.

Install the Development and Utility kits


from QSUT.tar on a UNIX machine.

Refer to Installing the Development and


Utility Kits (see page 38).

Note:

Do not install the PL/SQL


Development kit. It was installed
from the Oracle E-Business Suite.

6.

Verify that the proper Oracle Client


Libraries exist and are available.

Refer to Oracle Considerations (see page


39).

7.

Set the shared library environment


variables.

Refer to Setting the Shared Library


Environment Variables (see page 40).

8.

Install the Data files, which contain the files Refer to Installing the data files (see page 55).
used to populate or update the Rate and
GeoCoder database tables.

9.

Assign the Register database ID and


description.

Refer to Assigning a Register database ID


and Description (see page 43).

10.

Populate the Rate database tables.

Refer to Populating and Updating the Rate


database tables (see page 45).

11.

Populate the GeoCoder database tables.

Refer to Populating and Updating the


GeoCoder database tables (see page 50).

12.

Install the Tax Professional and Utility kits


on a Windows PC.

Refer to Installing the Tax Professional and


Utility Kits. (see page 54)

13.

Complete the implementation process.

Refer to the Oracle Receivables Vertex


Quantum Integration Guide for more
information.

14.

Obtain the latest version of the Vertex ZIP


file from the Oracle MetaLink site.

Go to www.oracle.com/support/metalink.

June 2010 z Page 34

Vertex Sales Tax Q Series


Chapter 2. Installation z UNIX installation CD-ROMs

Existing implementations
The following table provides an overview of the process for upgrading from
earlier versions Vertex Sales Tax Q Series with Oracle E-Business Suite. Vertex
recommends that you implement these steps in a test environment first.
Note: Your database objects must be compatible with STQ-PL/SQL 3.3 or 3.4
before upgrading to STQ-PL/SQL 4.0. Refer to the Vertex Sales Tax Q
Series 3.3 Administrator's Guide for more information about upgrading
earlier versions to STQ-PL/SQL 3.3.
Step

Task

For details

1.

Verify your version of Vertex Sales Tax Q


Series software with Product Support to
ensure that you are implementing the latest
release.

Uninstall STQ-PL/SQL from the test


environment.

3.

Install the Tax Professional and Utility kits


on a Windows PC in the test environment.

Refer to Installing the Tax Professional and


Utility Kits. (see page 54)

4.

Install the Oracle E-Business Suite CDROM on a UNIX machine.

Refer to STQ-PL/SQL Kits for the UNIX


workstation (see page 54).

5.

Install the Development and Utility kits


from QSUT.tar on a UNIX machine.

Refer to Installing the Development and


Utility Kits (see page 38).

Note:

Log a web service request from the Vertex


Customer Caf or call Vertex Product
Support at 800-281-1900 (Monday through
Friday, 8:15 A.M. to 8:00 P.M. United
States Eastern Time).

Do not install the PL/SQL


Development kit. It was installed
from the Oracle E-Business Suite.

6.

Install the data files, which include the files Refer to Installing the data files (see page 55).
used to populate or update the Rate and
GeoCoder database tables.

7.

Copy the STQ-PL/SQL database objects


from your production environment to the
test environment.

Call Vertex Product Support at


800-281-1900 (Monday through Friday,
8:15 A.M. to 8:00 P.M. United States
Eastern Time)if your version of STQPL/SQL is earlier than 3.2.

8.

You need to migrate the STQ-PL/SQL


database objects to version 3.3, before
upgrading to STQ-PL/SQL 4.0.

Call Vertex Product Support at


800-281-1900 (Monday through Friday,
8:15 A.M. to 8:00 P.M. United States
Eastern Time) if your version of STQPL/SQL is earlier than 3.2.

June 2010 z Page 35

Vertex Sales Tax Q Series


Chapter 2. Installation z UNIX installation CD-ROMs

Directory structure
The directory structure is created when each kit is installed on your system.
The following table lists the directories that are created by QSUT.tar:
Directory

Descriptions

include

Contains the header files.

lib

Contains the Windows import libraries.

samples

Contains the directories for the C demonstration programs.


Refer to the Vertex Sales Tax Q Series Programmer's Guide for details on
how to compile the demonstration programs.

scripts

Contains the scripts used to maintain each group of STQ-PL/SQL database


objects.
Note:

utils

Do not use these scripts if you are using Oracle E-Business Suite.

Contains the Vertex Sales Tax Q Series executable programs and DLLs. It
also contains the Test Case Input file (vsttest.cdf) used by the Tax
Calculation Test program.

The following table lists the directories that are created by PLSQL.tar.
Directory
samples

scripts

Description
Contains the STQ-PL/SQL GeoCoder and tax demonstration scripts:

locdemo.sql

vstdemo.sql

Contains the scripts used to create and drop PL/SQL objects.


Note:

Do not use these scripts if you are using Oracle E-Business Suite.

Note: Vertex recommends that you create a directory specific to PL/SQL and
untar the PLSQL.tar file in that directory.

June 2010 z Page 36

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Installation process flowchart


The STQ-PL/SQL application is installed in two locations. Most of the STQPL/SQL components are installed on a UNIX workstation and the remaining
components are installed on a Windows workstation.
The following figure shows the process for installing the Oracle E-Business Suite
version of Vertex Sales Tax Q Series-PL/SQL on UNIX.

Figure 2: STQ-PL/SQL installation process flowchart

STQ-PL/SQL kits for the UNIX workstation


Before installing the STQ-PL/SQL kits, contact Vertex Product Support at 800281-1900 (Monday through Friday, 8:15 A.M. to 8:00 P.M. United States Eastern
Time) to verify that you have the appropriate version of Vertex Sales Tax Q
Series-PL/SQL software for your environment.

June 2010 z Page 37

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Installing the STQ-PL/SQL database objects


Oracle E-Business Suite contains an installation driver script for creating the STQPL/SQL package bodies and database objects. Oracle E-Business Suite runs this
installation driver script to check your system for existing versions of STQPL/SQL. If it detects a version of STQ-PL/SQL from 3.3 or later, the application
upgrades the STQ-PL/SQL software to the version contained on the ZIP file. If an
older version is detected, the application will stop and you must upgrade your
STQ-PL/SQL databases to at least 3.3 to proceed.
Note: For details on upgrading versions older than Vertex Sales Tax Q Series
3.3 and receiving the special Rate update files, refer to the Vertex Sales
Tax Q Series 3.3 PL/SQL Programmer's Guide. If you have questions
contact Vertex Product Support at 800-281-1900 (Monday through Friday,
8:15 A.M. to 8:00 P.M. United States Eastern Time).
Complete the following steps to install the STQ-PL/SQL database objects on the
UNIX workstation.
1. Insert the Oracle E-Business Suite CD-ROM into your CD-ROM drive.
2. Follow the screen prompts to complete the installation.
Note: For more information, refer to the Guide to Integrating Oracle Receivables
with Vertex Quantum, Release 11i or the Oracle E-Business Tax: Vertex
Q Series and Taxware Sales/Use Tax System Implementation Guide,
Release 12 for more information. The most recent versions of these
documents can be found on the Oracle Support web site.

Installing the Development and Utility kits


Vertex recommends that you initially install STQ-PL/SQL in a test environment,
especially if you are a current user who is upgrading to a new version.
Refer to your system's man pages or to your system administrator for proper
syntax for the tar and mount commands if you have problems removing the
archives from the CD-ROM.
Complete the following steps to install on a UNIX workstation from the Programs
CD-ROM.
1. Insert the Programs CD-ROM into your CD-ROM drive.
2. If the CD-ROM does not auto-mount, use the mount command to mount it.

June 2010 z Page 38

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Note: Super-user (root) privileges are generally required to use the mount
command. Refer to your system manuals for further information on using
this command.
3. If needed, create a STQ PL/SQL root directory: For example,
mkdir /usr/local/ vertex

4. Change to the STQ PL/SQL root directory: For example,


cd /usr/local/vertex

5. Extract the product tar file, qsut.tar, to the STQ PL/SQL root directory by
executing the following command:
tar -xvf CD/OS/DB/QSUT.tar

where:
is the directory entry of the CD-ROM mount (/mnt/cdrom for example)
is the O/S version subdirectory to be installed (AIX5.3 for example)
DB is the database version subdirectory to be installed (Oracle10.2 for
example)
CD
OS

6. When complete, remove the Programs CD-ROM from the CD-ROM drive.

Oracle considerations
Vertex executables require that the Oracle shared library, libclntsh, be installed
on the client system. This library is included as part of the regular Oracle
installation on some systems; on others, it is an optional step in the installation
process. Before you run any of the utility programs, install the required Oracle
library in $ORACLE_HOME/lib and include this directory in the environment variable
that describes the search path for shared libraries on your system.
The following table lists the library name and environment variable for each
operating system:
Operating system

Library name

Environment variable

AIX

libclntsh.so

LIBPATH

HP-UX for PARISC

libclntsh.sl

LD_LIBRARY_PATH or
SHLIB_PATH

All others (including HP-UX


for Itanium)

libclntsh.so

LD_LIBRARY_PATH

Refer to your Oracle and UNIX system documentation for details on installing
Oracle shared libraries and setting environment variables, respectively.

June 2010 z Page 39

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Setting the shared library environment variables


Complete the following steps to set the environment variables:

If you are not using a csh, sh, ksh, or bash command shell, see your system
documentation for instructions on setting an environment variable and editing
a login script.

This step uses the environment variable that was previously set by your login
script. If this is not the case, set the library path to the recommended default
values before including the STQ-PL/SQL library path.

1. Set the shared library environment variable for the library path.
If you are using a csh, sh, ksh, or bash command shell, enter one of the
appropriate commands to set the library path.
For csh shell, type the following on the command line:
setenv envir_var ${envir_var}:/path/lib

For sh, ksh, or bash shell, type the following on the command line:
envir_var=${envir_var}:/path/lib ; export envir_var

where:
is the environment variable for your UNIX system (LIBPATH for AIX
and LD_LIBRARY_PATH for other UNIX systems).
envir_var

path

is the path where the Development kit or the Utility kit exists.

2. Press Enter.

Oracle database objects


This section discusses Oracle database objects (database tables and indexes). It
tells you how to allocate the appropriate amount of disk space to hold the STQPL/SQL database objects.

June 2010 z Page 40

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

STQ-PL/SQL database disk space allocation


The following table lists the disk space requirements for each STQ-PL/SQL
database:
Database

Space requirement

Rate database

Initial installation of the Rate database requires 50 MB of disk space.


However, since the database is updated monthly with new tax rates, the
disk space requirement is increased by 1 MB annually.

GeoCoder database

The GeoCoder database objects and data require 24 MB of disk space. The
optional ZIP+4 data requires an additional 400 MB of disk space.

TDM database

If you are using the optional Vertex TMT feature, the TDM database
requires 3 MB for the Vertex TMT data. In addition to that, the amount of
disk space required to hold your TDM database depends on the tax
exception information entered for each record. The maximum size for
each record is 2000 bytes.
To determine the amount of disk space required for your TDM database,
consult your tax professional to obtain the number of tax exception
records to be added to the database.

Register database

The amount of disk space required to hold your Register database depends
on the number of transactions that are written to the database. Each
transaction, which corresponds to a single line item on an invoice, requires
1700 bytes of disk space.
To determine the amount of disk space required for your Register
database, consult your tax professional to obtain the number of
transactions to be written to the database.
Vertex recommends that users processing a high volume of transactions
establish procedures to regularly unload and purge the Register database
or dedicate a high-speed, high-capacity server to store the databases.

Oracle database parameter descriptions


The following table lists the connection parameters for the STQ-PL/SQL database
objects:
Parameter Name

Description

Data Source

The name of the Oracle user in whose schema the STQ-PL/SQL tables
reside. This parameter is required if the default tablespace for the User ID
and User Password parameters is not the same tablespace that contains
the STQ-PL/SQL tables.

Server Name

The instance for the Oracle database on the server system.

User ID

Identifies the user as a valid Oracle login.

User Password

The identifier that uniquely identifies the user.

June 2010 z Page 41

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

STQ-PL/SQL database object access privileges


The following table lists the privileges and types of permissions that need to be
granted:
Privilege
Table privileges

Permission

Delete

Insert

Select

Update

Sequence privileges

Select

Procedure and Function privileges

Execute

Register database ID and description


This section describes how to assign a Register database ID and description using
the Register Utilities program.
When you create the Register database objects, you must also assign a Register
database ID and a Register database description.
Register database ID
The Register Database ID is a character string of no more than 25 characters that
identifies a specific set of Register database objects. It is used to track the origin of
the records when two datasets of Register data objects are merged.
Register database description
The Register Database Description is a character string of no more than 100
characters. It is used to identify a specific dataset of Register database objects.

June 2010 z Page 42

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Register Utilities Program


The Register Utilities program is an application that enables you to transfer
records, generate reports, and perform general Register database objects
maintenance.
Note: Vertex highly recommends that you use the Register Utilities program to
maintain your Register database objects. Improper maintenance of the
Register database objects may affect the performance of Vertex Sales Tax
Q Series. For details on maintaining the Register database objects, refer to
the Vertex Sales Tax Q Series Programmer's Guide.
However, for the purposes of this section, the Register Utilities program is
discussed only in terms of how to create identifiers for servers on which the
Register database objects reside.

Assigning a Register database ID and Register database description


Complete the following steps to assign a Register database ID and Register
database description:
1. Run the Register Utilities program, regutil. In UNIX, regutil is located in
the utils subdirectory off the vertex_home directory. In Windows, the default
location of regutil.exe is C:\Program Files\Vertex\QSUT\utils.
2. The program prompts you to enter specific Register database objects
connection parameters. See Oracle database objects (see page 40) for a
description of the parameters you need to specify to connect to the Register
database objects for which you want to assign an identifier. Specify the
parameters, and then press Enter.
3. Select option 6, Create Register DataBase Id, and press Enter.
4. Type the Register database ID, and press Enter.
5. Type the Register database ID description, and press Enter.

June 2010 z Page 43

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Making and changing connections to database objects


Windows users can access the Database Connections dialog box by selecting the
Connect option from the STQ-PL/SQL Utilities program main menu. The
Database Connections dialog box enables you to establish and change connections
to STQ-PL/SQL database objects. The Connect option is intended for users with
multiple STQ-PL/SQL database objects who want to change connection
information or disconnect from certain database objects during a STQ-PL/SQL
Utilities session.
UNIX users can access a text-based program to connect to database objects.
Note: The first time you access the Connect, Update, or Utilities options, you are
prompted to enter connection information for all database objects.
Thereafter, the dialog box displays as necessary for the Update and
Utilities options.

Connecting to database objects


For UNIX users and Windows users who choose to use text-based procedures,
connecting to the STQ database is typically done as part of another procedure,
such as populating or updating database tables. You can also use the diagnostics
program to connect, as shown in this procedure.
In this procedure, all database objects must be in the same schema.
Note: If you are connecting to database objects as a result of clicking the Update
or Utilities button in the STQ-PL/SQL Utilities Main Window, begin this
procedure at Step 3.
Complete the following steps to connect to STQ-PL/SQL database objects:
1. Run the program of your choice, for example, the VST Test Database
Diagnostics program, vsttest. In UNIX, vsttest is located in the utils
subdirectory off the vertex_home directory. In Windows, the default location
of vsttest is C:\Program Files\Vertex\QSUT\utils.
2. Type the number that corresponds to the group of database objects to which
you want to connect, and press Enter.

June 2010 z Page 44

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Note: If all database objects reside in the same data source, type 5, All
Databases, and press Enter.
3. The program prompts you to enter specific database connection parameters.
See Oracle database objects (see page 40) for a description of the parameters
you need to specify to connect to the database objects. Specify the parameters
and press Enter. An asterisk indicates that an active database connection has
been established.
4. Repeat steps 2 and 3 as needed to connect to other groups of database objects.

Changing database objects connections


For UNIX users and Windows users who choose to use text-based procedures,
connecting to the STQ database is typically done as part of another procedure,
such as populating or updating database tables. You can also use the diagnostics
program to connect, as shown in this procedure.
Complete the following steps to change a STQ-PL/SQL database connection:
1. Run the program of your choice. For example, run the VST Test Database
Diagnostics program vsttest. In UNIX, vsttest is located in the utils
subdirectory off the vertex_home directory. In Windows, the default location
of vsttest is C:\Program Files\Vertex\QSUT\utils.
If you are connected to a group of database objects, an asterisk displays next to
the name of the group of database objects.
2. Type the number that corresponds to the database objects you want to change,
and press Enter.
Note: If you want to change the connection parameters for all database objects
to the same connection parameters, type 5, All Databases, and press Enter.
3. The program prompts you to enter specific database objects connection
parameters. See Oracle Database Objects (see page 40) for a description of the
parameters you need to specify to connect to the group of database objects.
Specify the parameters and press Enter. An asterisk indicates that an active
database connection has been established.
4. Repeat steps 2 and 3 as needed to connect to other database objects.

Populating and updating the Rate database tables


This section describes the Rate file format, the application used to populate the
Rate database tables (Rate Install program), and the application used to update the
Rate database tables (Rate Update program).

June 2010 z Page 45

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Rate file
The Rate file contains all current and previous tax rates. It is used to populate and
update the Rate database or database tables. STQ-PL/SQL 4.0 uses seqmast4.vdf.
STQ-PL/SQL 4.0 contains a special Rate update file (seqmast4m.vdf), which
updates your Rate database table with district rate effective dates and situs
changes. If you are upgrading to STQ-PL/SQL 4.0 from STQ-PL/SQL 3.3 or 3.4,
you must apply this one-time special rate file.
These Rate files can be downloaded from www.vertexinc.com/CustomerCafe.

Rate file format


The Rate file contains two components:
Current Rates
This is the current rate information.
History Rates
This is rate information that is no longer in effect. It is kept for backdating
invoices. When you initially install rate data into the Rate tables, it contains one
current rate and one previous rate for each taxing jurisdiction. History records are
created when you update the Rate database tables and increase in number with
each update thereafter. Jurisdictions change the rates used for taxation when
necessary. When rate information changes, it is added to the Rate database tables
with the effective date. The Rate database tables are partially updated each month
with changed rates. The History Rate information is not deleted during an update;
rather, it remains in the Rate database tables for processing invoices dated earlier
than the effective date of the current rate information.

Rate Install program


The Rate Install program is used to populate the Rate database tables. It is
typically used to populate the Rate database tables with tax rates for the first time.
Caution: Do not confuse this program with the Rate Update program, which is
used to update the Rate database tables with new tax rates each
month.

June 2010 z Page 46

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Populating the Rate database tables


Note: The Rate Install program requires exclusive access to STQ-PL/SQL
database objects. All users must disconnect from STQ-PL/SQL database
objects before the population process begins.
Complete the following steps to populate the Rate database tables:
1. If you are registered to receive electronic downloads, download and extract the
data files that you need from www.vertexinc.com/CustomerCafe. Refer to
Extracting your ZIP file (see page 48) for detailed instructions.
Either select seqmast4.vdf from the directory where you extracted your data
updates, or insert the Rate and GeoCoder Data CD-ROM into your CD-ROM
drive.
2. Run the Rate Install program, rateins. In UNIX, rateins is located in the utils
subdirectory off the vertex_home directory. In Windows, the default location
of rateins.exe is C:\Program Files\Vertex\QSUT\utils.
3. Select option 1, Install Rate Database, from the Main Menu, and press Enter.
4. The program prompts you to enter specific database objects connection
parameters. Refer to Oracle Database Objects (see page 40) for a description
of the parameters you need to specify to connect to a group of database
objects. Specify the parameters and press Enter. An asterisk indicates that an
active database connection has been established.
5. Type the path of the directory that contains the Rate file and press Enter.
Note: If you downloaded the data file from the Vertex Customer Caf and
extracted the ZIP file, enter the path of the directory in which you
extracted the file. If you received the Rate file on CD-ROM, enter the path
of your CD-ROM drive. Refer to Installing the data files for more
information.

June 2010 z Page 47

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Extracting your ZIP file


If you download your monthly updates, be aware that monthly updates are
packaged as a ZIP file. This allows Vertex to permit downloads on a wider variety
of operating systems. All versions of Windows that Vertex supports have the
ability to extract from a ZIP file with no additional software.
When you download the ZIP file, create a new directory for it, such as
C:\directory, where directory is the name of a folder you create to hold the ZIP
file. Do not place it in a root directory (for example, at the C:\ drive level). You
may want to note this directory name and location so you can find it later.
If you have an extraction application installed on your computer, you may be able
to double-click the ZIP file to open it and extract the contents. If you do not have
an extraction application installed or if double-clicking the file doesn't work,
complete the following steps to open the ZIP file and extract its contents:
1. Browse to the folder where you saved the update file.
2. Right-click the ZIP file and select Open With > Compressed (zipped) folders.
The ZIP opens and displays your files in a new window.
If you do not have a menu option called Open With when you right-click on the
ZIP file, hold down the Shift key while right-clicking on the ZIP file to make
the correct menu option display.
If you do not have a menu option called Compressed (zipped) folders under the
Open With menu, select Choose Default Program instead. Then click Browse
and navigate to explorer.exe (usually located by default in the Windows folder
of your C drive). Check Always use the selected program to open this kind of
file and then click OK.
3. Select Edit > Select All.
4. Select Edit > Copy to copy the files in the ZIP folder.
5. Browse back to the folder where you opened the file in step 1.
6. Right-click inside the folder and select Paste to copy the files to this folder. If
prompted, overwrite any existing update files in this folder.
7. You can now proceed with the monthly update.

June 2010 z Page 48

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Rate Update program


The Rate Update program performs the following actions:

Reads the records in the Rate file.

Places all current tax rates into the Current Rate component of the Rate
database tables.

Places all previous tax rates into the History Rate component of the Rate
database tables.

Creates automatically the ratelog.txt file in the current directory to record the
changes made to the Rate database tables. This file can be accessed for
viewing or printing with any text reader.

Caution: Before you begin to update the Rate database tables, be sure you
back them up first.

Updating the Rate database tables


Note: The Rate Update program does not require exclusive access to the STQPL/SQL database objects.
Complete the following steps to update the Rate database tables:
1. If you are registered to receive electronic downloads, download and extract the
data files that you need from www.vertexinc.com/CustomerCafe. Refer to
Extracting your ZIP file (see page 48) for detailed instructions.
2. Either select seqmast4.vdf from the directory where you extracted your data
updates, or insert the Rate and GeoCoder Data CD-ROM into your CD-ROM
drive.
3. Run the Rate update program, rateupd. In UNIX, rateupd is located in the
utils subdirectory off the vertex_home directory. In Windows, the default
location of rateupd.exe is C:\Program Files\Vertex\QSUT\utils.
4. Select option 1, Update Rate Database, from the Main Menu, and press Enter.
5. The program prompts you to enter specific database objects connection
parameters. See Oracle Database Objects (see page 40) for a description of the
parameters you need to specify to connect to a group of database objects.
Specify the parameters and press Enter. An asterisk indicates that an active
database connection has been established.
6. Enter the path of the directory that contains the Rate file (seqmast4.vdf) either
by typing the path in the text box or by clicking the ellipsis button and
browsing.

June 2010 z Page 49

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

Note: If you downloaded the data file from the Vertex Customer Caf and
extracted the ZIP file, enter the path of the directory in which you
extracted the file. If you received the Rate file on CD-ROM, enter the path
of your CD-ROM drive. Refer to the Installing the data files for more
information.

Populating and updating the GeoCoder database tables


This section describes the GeoCoder file format and the GeoCoder Update
program, which is the application used to populate the GeoCoder database tables
with jurisdiction information and to update it on a monthly basis.

June 2010 z Page 50

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

GeoCoder file format


The GeoCoder file is the file used to populate and update the GeoCoder database.
It contains GeoCodes for over 60,000 locations in the United States, its territories
and possessions, and Canada.
Occasionally, a GeoCode is added to or removed from the GeoCoder file. This
occurs when a location:

Levies a tax

Becomes an incorporated city

Changes jurisdiction boundaries

When a location meets the above criteria, a GeoCode is assigned to the location
and added to the GeoCoder file. Vertex updates the GeoCoder file monthly.
When you run the monthly update, all existing information in the GeoCoder
database is deleted and replaced by the information in the updated GeoCoder file.
STQ-PL/SQL provides data updates for three versions of the GeoCoder file
(geomast). All three versions will be provided each month. You must select one of
the following files based on your version of STQ-PL/SQL:
Geomast files

Description

geomast

This is the original Vertex GeoCoder file, which has a


file length of 64 characters and can only be read by STQPL/SQL versions 3.2 and earlier.

geomast2

This file replaced geomast in STQ-PL/SQL 3.3 with a new


file length of 74 characters. Geomast2 can only be read by
STQ-PL/SQL versions 3.3 and 3.4.

geomast4.vdf

This file is for STQ-PL/SQL 4.0 and replaces all previous


versions of the geomast files. It contains the release version
number and the Vertex Data File extension (vdf).

June 2010 z Page 51

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

ZIP+4 file
The ZIP+4 file (staxzip4.vdf) contains GeoCodes that are associated with ninedigit ZIP Codes, which enable a more accurate assignment of GeoCodes for cities,
counties, districts, and Special Purpose Districts.
Special Purpose Districts (SPDs) are local jurisdictions that do not follow city or
county boundaries, such as municipal transportation authorities (MTAs), hospitals,
and school districts.
If you want to use the jurisdiction identification functionality for nine-digit ZIP
Codes to identify Special Purpose Districts, load the ZIP+4 file. Loading the
ZIP+4 file is optional. Each month, Vertex updates the ZIP+4 file (staxzip4.vdf).
If you only want to use five-digit ZIP Codes, you do not need to load the ZIP+4
file. You can continue using the current five-digit ZIP Code functionality.

Populating and updating the GeoCoder database for five-digit ZIP


codes
Caution: Before you begin to update the GeoCoder database tables, be sure
you back it up first.
The GeoCoder Update program requires exclusive access to the STQ-PL/SQL
databases during the initial installation and population process. However,
exclusive access to the STQ-PL/SQL databases is not required during the monthly
update processes.
Complete the following steps to populate or update the GeoCoder database tables
for five-digit ZIP codes:
1. If you are registered to receive electronic downloads, download and extract the
data files that you need from www.vertexinc.com/CustomerCafe. Refer to
Extracting your ZIP file (see page 48) for detailed instructions.
2. After you have downloaded your data from
www.vertexinc.com/CustomerCafe, select the GeoCoder file (geomast4.vdf)
from the data file folder where you unzipped the file, or insert the Rate and
GeoCoder Data CD-ROM into your CD-ROM drive.
3. Run the GeoCoder Update program, locupd. In Windows, the default location
of locupd.exe is C:\Program Files\Vertex\QSUT\utils.
4. Select option 1, Update GeoCoder, from the Main Menu, and press Enter.

June 2010 z Page 52

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

5. The program prompts you to enter specific database connection parameters.


See Oracle Database Objects (see page 40)for a description of the parameters
you need to specify to connect to the database objects. Specify the parameters
and press Enter. An asterisk indicates that an active database connection has
been established.
6. Type the path of the directory that contains the GeoCoder file (geomast4.vdf)
either by typing the path in the text box or by clicking the ellipsis button and
browsing.
Note: If you downloaded the data file from the Vertex Customer Caf and
extracted the ZIP file, enter the path of the directory in which you
extracted the file. If you received the GeoCoder file on CD-ROM, enter the
path of your CD-ROM drive. Refer to the Installing the data files for more
information.

Populating and updating the GeoCoder database for nine-digit ZIP


Codes-- text-based procedure
Caution: Before you begin to update the GeoCoder database tables, be sure
you back it up first.
The GeoCoder Update program requires exclusive access to the STQ-PL/SQL
databases during the initial installation and population process. However,
exclusive access to the STQ-PL/SQL databases is not required during the monthly
update process.
Complete the following steps to populate or update the GeoCoder database with
nine-digit ZIP Code data:
1. If you are registered to receive electronic downloads, download and extract the
data files that you need from www.vertexinc.com/CustomerCafe. Refer to
Extracting your ZIP file (see page 48) for detailed instructions.
2. After you have downloaded your data from
www.vertexinc.com/CustomerCafe, either select the ZIP+4 file
(staxzip4.vdf) from the data file folder where you extracted the file, or insert
the Rate and GeoCoder Data CD-ROM into your CD-ROM drive.
3. Run the GeoCoder Update program, locupd. In UNIX, locupd is located in the
utils subdirectory of the vertex_home directory. In Windows, the default
location of locupd.exe is C:\Program Files\Vertex\QSUT\utils.
Note: You need to specify the directory where the files are located when you
populate or update the GeoCoder database.
4. Select option 2, Update ZIP+4 Data in GeoCoder Database, and press Enter.

June 2010 z Page 53

Vertex Sales Tax Q Series


Chapter 2. Installation z STQ-PL/SQL kits for the UNIX workstation

5. The program prompts you to enter specific database connection parameters.


See Oracle Database Objects (see page 40)for a description of the parameters
you need to specify to connect to the database objects. Specify the parameters
and press Enter. An asterisk indicates that an active database connection has
been established.
6. Type the path of the directory that contains the staxzip4.vdf file and press
Enter.
Note: If you downloaded the data file from the Vertex Customer Caf and
extracted the ZIP file, enter the path of the directory in which you
extracted the file. If you received the ZIP+4 file on CD-ROM, enter the
path of your CD-ROM drive.

STQ-PL/SQL kits for the Windows workstation


This section describes the procedures to install the Tax Professional kit and Utility
kit on a Windows workstation.
Installing the Tax Professional and Utility kits
You must install the Tax Professional and Utility kits on a local PC. Vertex
applications for Windows cannot be run remotely.
Vertex recommends that you initially install Vertex Sales Tax Q Series in a test
environment, especially if you are a current user who is upgrading to a new
version.
Complete the following steps to install the Tax Professional and Utility kits on a
Windows workstation:
1. Insert the Programs & TDM - Intel CD-ROM into the CD-ROM drive.
2. Click Start > Run.
3. Click Browse.
4. Navigate to locate the following file:
d:\Windows\Oraclex.X\QSUT.exe

where:
d

is the location of your CD-ROM drive

Oraclex.X

is your version of Oracle

5. Click Open.
6. Click OK.
7. Click Next.

June 2010 z Page 54

Vertex Sales Tax Q Series


Chapter 2. Installation z Migrating to STQ-PL/SQL 4.0

8. When you are prompted to select components, check all of the boxes, then
click Next.
9. Follow the screen prompts to complete this part of the installation.
Installing the data files
If you are registered to receive electronic downloads, download and extract the
data files that you need from www.vertexinc.com/CustomerCafe. Refer to
Extracting your ZIP file (see page 48) for detailed instructions.
If you are not registered to receive electronic downloads, complete the following
steps to install the data files:
1. Insert the Rate and GeoCoder Data CD-ROM into the CD-ROM drive.
2. Copy the seqmast, geomast2, and compress.txt files to the directory where you
want the files to reside.

Migrating to STQ-PL/SQL 4.0


When you are ready to migrate to STQ-PL/SQL 4.0, download the appropriate
Vertex Installation Script patch from the Oracle Web site at:
http://support.oracle.com (to access this site for support you will need a valid log
in account).
The patch file contains the STQ-PL/SQL 4.0 version check patch. STQ-PL/SQL
Version 4.0 has been pre-packaged in the Oracle E-Business Suite so the scripts to
create, migrate, and drop database objects are implemented for you. Refer to
Oracle's Guide to Integrating Oracle Receivables with Vertex Quantum for
additional information.
When you have completed migrating to STQ-PL/SQL 4.0, refer to the Vertex
Sales Tax Q Series PL/SQL Programmer's Guide. It contains information about
interfacing STQ-PL/SQL with your host system, recording transactions, and
performing maintenance on STQ-PL/SQL database objects.

June 2010 z Page 55

Vertex Sales Tax Q Series


Chapter 2. Installation z Migrating to STQ-PL/SQL 4.0

Streamlining your installation


The Vertex Sales Tax Q Series PL/SQL Programmer's Guide is for the standard
version of the software. Some information in the guide is not applicable to STQPL/SQL for the Oracle E-Business Suite.
Note: If you are running STQ-PL/SQL 2.x, 3.0, 3.1, or 3.2, contact Vertex
Product Support for instructions on migrating your STQ-PL/SQL
databases to 3.3 compatibility before upgrading to STQ-PL/SQL 4.0.
If you are installing or upgrading from STQ-PL/SQL 3.3 or 3.4 for the Oracle EBusiness Suite, many processes were automated for you. You do not need to
complete the instructions in:

The "STQ-PL/SQL Database Tables" section in Chapter 2. (In the standard


version of STQ-PL/SQL 4.0, these scripts are used to create the database
objects.)

Note: You may need to use these scripts if the database is corrupted or you are
migrating from an earlier version of STQ PL/SQL.

The instructions in the "Retrieving GeoCodes Electronically using the Tax


Calculation Package" section in Chapter 3.

The instructions in the "GeoCode Retrieval Package" section in Chapter 4.


Oracle has its own GeoCode retrieval process that directly queries the Oracle
AR tables based on user criteria. The assignment process is completed by
using the arvertex.ctl script and running the concurrent program for the Sales
Tax Rate Interface program to load the appropriate Oracle database tables.
Refer to the Guide to Integrating Oracle Receivables with Vertex Quantum,
Release 11i for more information. Oracle R12 uses the oramast file with their
E-Business US Sales and Use Tax Import program. Refer to the Oracle EBusiness Tax: Vertex Q Series and Taxware Sales/Use Tax System
Implementation Guide, Release 12 for more information.

June 2010 z Page 56

Index
A
about database objects 40
access privileges 52
assigning
Register database description 42
Register database ID 42

C
connection to database objects 44
changing 45
conventions, documentation 13

D
database
access privileges 52
changing connections 45
connections 44
objects
about 40
installing 38
supported 18
Development Kit 38
STQ-PL/SQL 21
directory structure
Windows 36
documentation conventions 13

E
environmental variables
setting 40
excess
tax rates 26

G
GeoCoder
caution 52
database
access privileges 52
description 50
populating 52
updating 52
update program
description 52

H
history file, Rate database objects 26
host application, interfacing with 17

installation
process
flowchart 37
STQ-PL/SQL 30
installing
database objects 38
Development Kit 38
STQ-PL/SQL Kits for UNIX 37
Tax Professional Kit 54
Utility Kit 38
interface
writing 20

L
LD_LIBRARY_PATH 39
libclntsh.a 39
libclntsh.sl 39
libclntsh.so 39
LIBPATH 39
library path 40

O
operating
environment 17
Oracle
considerations 39
MetaLink Web site 55
Oracle Receivables/Vertex Quantum Integration
Guide 55, 56

P
Post-Returns Register table 28
Pre-Returns Register table 28
procedure formatting 13

R
rate
data file
description 46
Rate database
caution 49
description 45
update program
description 49
updating 49
Rate database objects
history records 26
install program
description 46
maintaining 26
populating tables

June 2010 z Page 57

Vertex Sales Tax Q Series


Index

under UNIX 46
ratelog.txt
description 49
Register database
purpose of 27
Register database description 42
Register database ID 42
Register database objects
contents 27
tables 28
Register Utilities program 42
rental tax 16
retrieving
rates and taxability 21

S
seller's use tax 16
SEQMAST 46
setting shared library environmental variables 40
SHLIB_PATH 39
special
tax conditions 24
STQ-PL/SQL
benefits 17
concepts 16
database parameters 41
kits for UNIX 37

T
tax
special conditions 24
Tax Calculation Package 21
Tax Decision Maker (TDM)
contents 28
Tax Professional Kit 24
installing 54
taxes calculated 16
typeface 13

U
UNIX
implementation process 34
installation
process flowchart 37
upgrade process
UNIX 34, 35
utility kit 38

V
Vertex Sales Tax Q Series PL/SQL Programmer's
Guide 55

June 2010 z Page 58

Das könnte Ihnen auch gefallen