Beruflich Dokumente
Kultur Dokumente
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
Index ...................................................................................................................... 57
Preface
This preface contains the following information:
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.
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/.
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/.
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
C Administrator's Guide
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
Looking up GeoCodes
User's Guide
Lookup Help
Note:
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.
C Programmer's Guide
Import or export exception information into an STQ TDM database TDM Import-Export Help
Managing databases
C Administrator's Guide
EC Administrator's Guide
Connect to databases
C Programmer's Guide
EC Programmer's Guide
Generate reports
C Administrator's Guide
EC Administrator's Guide
Sales Tax Utilities Help
C Administrator's Guide
EC Administrator's Guide
SoftLink Supplement
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:
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:
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.
System messages
Messages from the system look like this:
setup
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:
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).
Where:
4
.vdf
All of the data files are now in lower case type so the files can be used by
multiple platforms.
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
Rental tax
Using accurate and extensive tax rate data, stored in the Rate database tables.
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.
Accounts payable
Order entry
Invoicing
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
Utility tools
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
ZIP+4 file
Tool
Description
Lookup Program
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.
Check tax rates, jurisdictions, and special tax considerations in the STQPL/SQL database objects.
Calculate taxes.
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
Utility kit
Retrieve rates and taxability information from the Rate 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.
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.
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
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 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.
This program loads TMT data into the TDM database tables.
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)
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 Utility kit also includes data files and libraries to support the executable files.
Surcharges
Exempt surcharges
Individual customers
Customer classes
Individual products
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
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
The Register database tables contain an audit trail of invoice data processed by
STQ-PL/SQL.
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.
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.
City within the United States that levies a sales or use tax
Information from your host application sent to the Tax Calculation package
Description
Pre-returns table
Post-returns table
Information flow
The following figure shows the flow of information through a tax compliance
system that uses STQ-PL/SQL.
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.
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
Oracle software
You must install the following:
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
Description
Documentation
Task
For details
1.
2.
3.
4.
5.
Note:
6.
7.
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.
10.
11.
12.
13.
14.
Go to www.oracle.com/support/metalink.
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.
3.
4.
5.
Note:
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.
8.
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
lib
samples
scripts
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
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.
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
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
libclntsh.sl
LD_LIBRARY_PATH or
SHLIB_PATH
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.
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.
Space requirement
Rate database
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.
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
User ID
User Password
Permission
Delete
Insert
Select
Update
Sequence privileges
Select
Execute
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.
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.
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.
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.
Levies a tax
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
geomast2
geomast4.vdf
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.
where:
d
Oraclex.X
5. Click Open.
6. Click OK.
7. Click Next.
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.
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.
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
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